gsttaglist.h 33.5 KB
Newer Older
Benjamin Otte's avatar
Benjamin Otte committed
1 2 3
/* GStreamer
 * Copyright (C) 2003 Benjamin Otte <in7y118@public.uni-hamburg.de>
 *
4
 * gsttaglist.h: Header for tag support
Benjamin Otte's avatar
Benjamin Otte committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */


23 24
#ifndef __GST_TAGLIST_H__
#define __GST_TAGLIST_H__
Benjamin Otte's avatar
Benjamin Otte committed
25

26
#include <gst/gstdatetime.h>
27
#include <gst/gstbuffer.h>
Benjamin Otte's avatar
Benjamin Otte committed
28
#include <gst/gststructure.h>
Andy Wingo Wingo's avatar
Andy Wingo Wingo committed
29
#include <gst/glib-compat.h>
Benjamin Otte's avatar
Benjamin Otte committed
30

31 32
G_BEGIN_DECLS

Wim Taymans's avatar
Wim Taymans committed
33 34 35
/**
 * GstTagMergeMode:
 * @GST_TAG_MERGE_UNDEFINED: undefined merge mode
36
 * @GST_TAG_MERGE_REPLACE_ALL: replace all tags (clear list and append)
Wim Taymans's avatar
Wim Taymans committed
37 38 39 40 41 42 43
 * @GST_TAG_MERGE_REPLACE: replace tags
 * @GST_TAG_MERGE_APPEND: append tags
 * @GST_TAG_MERGE_PREPEND: prepend tags
 * @GST_TAG_MERGE_KEEP: keep existing tags
 * @GST_TAG_MERGE_KEEP_ALL: keep all existing tags
 * @GST_TAG_MERGE_COUNT: the number of merge modes
 *
44
 * The different tag merging modes are basically replace, overwrite and append,
45 46 47 48 49 50
 * but they can be seen from two directions. Given two taglists: (A) the tags
 * already in the element and (B) the ones that are supplied to the element (
 * e.g. via gst_tag_setter_merge_tags() / gst_tag_setter_add_tags() or a
 * %GST_EVENT_TAG), how are these tags merged?
 * In the table below this is shown for the cases that a tag exists in the list
 * (A) or does not exists (!A) and combinations thereof.
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
 *
 * <table frame="all" colsep="1" rowsep="1">
 *   <title>merge mode</title>
 *   <tgroup cols='5' align='left'>
 *     <thead>
 *       <row>
 *         <entry>merge mode</entry>
 *         <entry>A + B</entry>
 *         <entry>A + !B</entry>
 *         <entry>!A + B</entry>
 *         <entry>!A + !B</entry>
 *       </row>
 *     </thead>
 *     <tbody>
 *       <row>
 *         <entry>REPLACE_ALL</entry>
 *         <entry>B</entry>
 *         <entry>-</entry>
 *         <entry>B</entry>
 *         <entry>-</entry>
 *       </row>
 *       <row>
 *         <entry>REPLACE</entry>
 *         <entry>B</entry>
 *         <entry>A</entry>
 *         <entry>B</entry>
 *         <entry>-</entry>
 *       </row>
 *       <row>
 *         <entry>APPEND</entry>
 *         <entry>A, B</entry>
 *         <entry>A</entry>
 *         <entry>B</entry>
 *         <entry>-</entry>
 *       </row>
 *       <row>
 *         <entry>PREPEND</entry>
 *         <entry>B, A</entry>
 *         <entry>A</entry>
 *         <entry>B</entry>
 *         <entry>-</entry>
 *       </row>
 *       <row>
 *         <entry>KEEP</entry>
 *         <entry>A</entry>
 *         <entry>A</entry>
 *         <entry>B</entry>
 *         <entry>-</entry>
 *       </row>
 *       <row>
 *         <entry>KEEP_ALL</entry>
 *         <entry>A</entry>
 *         <entry>A</entry>
 *         <entry>-</entry>
 *         <entry>-</entry>
 *       </row>
 *     </tbody>
 *   </tgroup>
 * </table>
Wim Taymans's avatar
Wim Taymans committed
110
 */
111
typedef enum {
Benjamin Otte's avatar
Benjamin Otte committed
112 113 114 115 116 117 118 119 120
  GST_TAG_MERGE_UNDEFINED,
  GST_TAG_MERGE_REPLACE_ALL,
  GST_TAG_MERGE_REPLACE,
  GST_TAG_MERGE_APPEND,
  GST_TAG_MERGE_PREPEND,
  GST_TAG_MERGE_KEEP,
  GST_TAG_MERGE_KEEP_ALL,
  /* add more */
  GST_TAG_MERGE_COUNT
121
} GstTagMergeMode;
122

Benjamin Otte's avatar
Benjamin Otte committed
123 124
#define GST_TAG_MODE_IS_VALID(mode)     (((mode) > GST_TAG_MERGE_UNDEFINED) && ((mode) < GST_TAG_MERGE_COUNT))

Wim Taymans's avatar
Wim Taymans committed
125 126 127 128 129 130 131 132 133 134
/**
 * GstTagFlag:
 * @GST_TAG_FLAG_UNDEFINED: undefined flag
 * @GST_TAG_FLAG_META: tag is meta data
 * @GST_TAG_FLAG_ENCODED: tag is encoded
 * @GST_TAG_FLAG_DECODED: tag is decoded
 * @GST_TAG_FLAG_COUNT: number of tag flags
 *
 * Extra tag flags used when registering tags.
 */
135
typedef enum {
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
136 137 138 139 140
  GST_TAG_FLAG_UNDEFINED,
  GST_TAG_FLAG_META,
  GST_TAG_FLAG_ENCODED,
  GST_TAG_FLAG_DECODED,
  GST_TAG_FLAG_COUNT
141
} GstTagFlag;
142

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
143 144
#define GST_TAG_FLAG_IS_VALID(flag)     (((flag) > GST_TAG_FLAG_UNDEFINED) && ((flag) < GST_TAG_FLAG_COUNT))

145 146 147 148
/* FIXME 0.11: Don't typedef GstTagList to be a GstStructure, they're
 *             internally the same but not from an API point of view.
 *             See bug #518934.
 */
Wim Taymans's avatar
Wim Taymans committed
149 150 151 152 153
/**
 * GstTagList:
 *
 * Opaque #GstTagList data structure.
 */
154 155 156
#ifdef _FOOL_GTK_DOC_
typedef struct _GstTagList GstTagList;
#else
157 158 159
#ifdef IN_GOBJECT_INTROSPECTION
typedef struct _GstTagList GstTagList;
#else
Benjamin Otte's avatar
Benjamin Otte committed
160
typedef GstStructure GstTagList;
161
#endif
162
#endif
163

164
#define GST_TAG_LIST(x)       ((GstTagList *) (x))
165
#define GST_IS_TAG_LIST(x)    ((x) != NULL && gst_is_tag_list (GST_TAG_LIST (x)))
166
#define GST_TYPE_TAG_LIST     (gst_tag_list_get_type ())
Benjamin Otte's avatar
Benjamin Otte committed
167

168 169 170 171 172 173 174 175 176
/**
 * GstTagForeachFunc:
 * @list: the #GstTagList
 * @tag: a name of a tag in @list
 * @user_data: user data
 *
 * A function that will be called in gst_tag_list_foreach(). The function may
 * not modify the tag list.
 */
177 178 179
typedef void (*GstTagForeachFunc) (const GstTagList * list,
                                   const gchar      * tag,
                                   gpointer           user_data);
180

Wim Taymans's avatar
Wim Taymans committed
181 182 183 184 185 186 187 188
/**
 * GstTagMergeFunc:
 * @dest: the destination #GValue
 * @src: the source #GValue
 *
 * A function for merging multiple values of a tag used when registering
 * tags.
 */
189
typedef void (* GstTagMergeFunc) (GValue *dest, const GValue *src);
Benjamin Otte's avatar
Benjamin Otte committed
190

191 192
GType        gst_tag_list_get_type (void);

193
/* tag registration */
194 195 196 197 198 199
void         gst_tag_register      (const gchar     * name,
                                    GstTagFlag        flag,
                                    GType             type,
                                    const gchar     * nick,
                                    const gchar     * blurb,
                                    GstTagMergeFunc   func);
Benjamin Otte's avatar
Benjamin Otte committed
200 201

/* some default merging functions */
202 203
void      gst_tag_merge_use_first          (GValue * dest, const GValue * src);
void      gst_tag_merge_strings_with_comma (GValue * dest, const GValue * src);
Benjamin Otte's avatar
Benjamin Otte committed
204 205

/* basic tag support */
206 207 208 209 210 211
gboolean               gst_tag_exists          (const gchar * tag);
GType                  gst_tag_get_type        (const gchar * tag);
G_CONST_RETURN gchar * gst_tag_get_nick        (const gchar * tag);
G_CONST_RETURN gchar * gst_tag_get_description (const gchar * tag);
GstTagFlag             gst_tag_get_flag        (const gchar * tag);
gboolean               gst_tag_is_fixed        (const gchar * tag);
Benjamin Otte's avatar
Benjamin Otte committed
212 213

/* tag lists */
214
GstTagList * gst_tag_list_new               (void);
215 216 217
GstTagList * gst_tag_list_new_full          (const gchar * tag, ...);
GstTagList * gst_tag_list_new_full_valist   (va_list var_args);

218 219
gboolean     gst_is_tag_list                (gconstpointer p);
GstTagList * gst_tag_list_copy              (const GstTagList * list);
220
gboolean     gst_tag_list_is_empty          (const GstTagList * list);
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
void         gst_tag_list_insert            (GstTagList       * into,
                                             const GstTagList * from,
                                             GstTagMergeMode    mode);
GstTagList * gst_tag_list_merge             (const GstTagList * list1,
                                             const GstTagList * list2,
                                             GstTagMergeMode    mode);
void         gst_tag_list_free              (GstTagList       * list);
guint        gst_tag_list_get_tag_size      (const GstTagList * list,
                                             const gchar      * tag);
void         gst_tag_list_add               (GstTagList       * list,
                                             GstTagMergeMode    mode,
                                             const gchar      * tag,
                                             ...) G_GNUC_NULL_TERMINATED;
void         gst_tag_list_add_values        (GstTagList       * list,
                                             GstTagMergeMode    mode,
                                             const gchar      * tag,
                                             ...) G_GNUC_NULL_TERMINATED;
void         gst_tag_list_add_valist        (GstTagList       * list,
                                             GstTagMergeMode    mode,
                                             const gchar      * tag,
                                             va_list        var_args);
void         gst_tag_list_add_valist_values (GstTagList       * list,
                                             GstTagMergeMode    mode,
                                             const gchar      * tag,
                                             va_list            var_args);
246 247 248 249
void         gst_tag_list_add_value         (GstTagList       * list,
                                             GstTagMergeMode    mode,
                                             const gchar      * tag,
                                             const GValue     * value);
250 251 252 253 254
void         gst_tag_list_remove_tag        (GstTagList       * list,
                                             const gchar      * tag);
void         gst_tag_list_foreach           (const GstTagList * list,
                                             GstTagForeachFunc  func,
                                             gpointer           user_data);
255 256

G_CONST_RETURN GValue *
257 258 259 260 261 262
             gst_tag_list_get_value_index   (const GstTagList * list,
                                             const gchar      * tag,
                                             guint              index);
gboolean     gst_tag_list_copy_value        (GValue           * dest,
                                             const GstTagList * list,
                                             const gchar      * tag);
Benjamin Otte's avatar
Benjamin Otte committed
263 264

/* simplifications (FIXME: do we want them?) */
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
gboolean     gst_tag_list_get_char          (const GstTagList * list,
                                             const gchar      * tag,
                                             gchar            * value);
gboolean     gst_tag_list_get_char_index    (const GstTagList * list,
                                             const gchar      * tag,
                                             guint              index,
                                             gchar            * value);
gboolean     gst_tag_list_get_uchar         (const GstTagList * list,
                                             const gchar      * tag,
                                             guchar           * value);
gboolean     gst_tag_list_get_uchar_index   (const GstTagList * list,
                                             const gchar      * tag,
                                             guint              index,
                                             guchar           * value);
gboolean     gst_tag_list_get_boolean       (const GstTagList * list,
                                             const gchar      * tag,
                                             gboolean         * value);
gboolean     gst_tag_list_get_boolean_index (const GstTagList * list,
                                             const gchar      * tag,
                                             guint              index,
                                             gboolean         * value);
gboolean     gst_tag_list_get_int           (const GstTagList * list,
                                             const gchar      * tag,
                                             gint             * value);
gboolean     gst_tag_list_get_int_index     (const GstTagList * list,
                                             const gchar      * tag,
                                             guint              index,
                                             gint             * value);
gboolean     gst_tag_list_get_uint          (const GstTagList * list,
                                             const gchar      * tag,
                                             guint            * value);
gboolean     gst_tag_list_get_uint_index    (const GstTagList * list,
                                             const gchar      * tag,
                                             guint              index,
                                             guint            * value);
gboolean     gst_tag_list_get_long          (const GstTagList * list,
                                             const gchar      * tag,
                                             glong            * value);
gboolean     gst_tag_list_get_long_index    (const GstTagList * list,
                                             const gchar      * tag,
                                             guint              index,
                                             glong            * value);
gboolean     gst_tag_list_get_ulong         (const GstTagList * list,
                                             const gchar      * tag,
                                             gulong           * value);
gboolean     gst_tag_list_get_ulong_index   (const GstTagList * list,
                                             const gchar      * tag,
                                             guint              index,
                                             gulong           * value);
gboolean     gst_tag_list_get_int64         (const GstTagList * list,
                                             const gchar      * tag,
                                             gint64           * value);
gboolean     gst_tag_list_get_int64_index   (const GstTagList * list,
                                             const gchar      * tag,
                                             guint              index,
                                             gint64           * value);
gboolean     gst_tag_list_get_uint64        (const GstTagList * list,
                                             const gchar      * tag,
                                             guint64          * value);
gboolean     gst_tag_list_get_uint64_index  (const GstTagList * list,
                                             const gchar      * tag,
                                             guint              index,
                                             guint64          * value);
gboolean     gst_tag_list_get_float         (const GstTagList * list,
                                             const gchar      * tag,
                                             gfloat           * value);
gboolean     gst_tag_list_get_float_index   (const GstTagList * list,
                                             const gchar      * tag,
                                             guint              index,
                                             gfloat           * value);
gboolean     gst_tag_list_get_double        (const GstTagList * list,
                                             const gchar      * tag,
                                             gdouble          * value);
gboolean     gst_tag_list_get_double_index  (const GstTagList * list,
                                             const gchar      * tag,
                                             guint              index,
                                             gdouble          * value);
gboolean     gst_tag_list_get_string        (const GstTagList * list,
                                             const gchar      * tag,
                                             gchar           ** value);
gboolean     gst_tag_list_get_string_index  (const GstTagList * list,
                                             const gchar      * tag,
                                             guint              index,
                                             gchar           ** value);
349 350 351 352
gboolean     gst_tag_list_peek_string_index (const GstTagList * list,
                                             const gchar      * tag,
                                             guint              index,
                                             const gchar     ** value);
353 354 355 356 357 358 359 360 361 362 363 364 365 366
gboolean     gst_tag_list_get_pointer       (const GstTagList * list,
                                             const gchar      * tag,
                                             gpointer         * value);
gboolean     gst_tag_list_get_pointer_index (const GstTagList * list,
                                             const gchar      * tag,
                                             guint              index,
                                             gpointer         * value);
gboolean     gst_tag_list_get_date          (const GstTagList * list,
                                             const gchar      * tag,
                                             GDate           ** value);
gboolean     gst_tag_list_get_date_index    (const GstTagList * list,
                                             const gchar      * tag,
                                             guint              index,
                                             GDate           ** value);
367 368 369 370 371 372 373
gboolean     gst_tag_list_get_date_time     (const GstTagList * list,
                                             const gchar      * tag,
                                             GstDateTime     ** value);
gboolean     gst_tag_list_get_date_time_index (const GstTagList * list,
                                             const gchar      * tag,
                                             guint              index,
                                             GstDateTime     ** value);
374 375 376 377 378 379 380
gboolean     gst_tag_list_get_buffer        (const GstTagList * list,
                                             const gchar      * tag,
                                             GstBuffer       ** value);
gboolean     gst_tag_list_get_buffer_index  (const GstTagList * list,
                                             const gchar      * tag,
                                             guint              index,
                                             GstBuffer       ** value);
Benjamin Otte's avatar
Benjamin Otte committed
381

382
/* GStreamer core tags */
Stefan Kost's avatar
Stefan Kost committed
383 384 385
/**
 * GST_TAG_TITLE:
 *
386
 * commonly used title (string)
387 388
 *
 * The title as it should be displayed, e.g. 'The Doll House'
Stefan Kost's avatar
Stefan Kost committed
389
 */
390
#define GST_TAG_TITLE                  "title"
391 392 393 394 395 396 397 398 399 400
/**
 * GST_TAG_TITLE_SORTNAME:
 *
 * commonly used title, as used for sorting (string)
 *
 * The title as it should be sorted, e.g. 'Doll House, The'
 *
 * Since: 0.10.15
 */
#define GST_TAG_TITLE_SORTNAME         "title-sortname"
Stefan Kost's avatar
Stefan Kost committed
401 402 403
/**
 * GST_TAG_ARTIST:
 *
404
 * person(s) responsible for the recording (string)
405 406 407
 *
 * The artist name as it should be displayed, e.g. 'Jimi Hendrix' or
 * 'The Guitar Heroes'
Stefan Kost's avatar
Stefan Kost committed
408
 */
409
#define GST_TAG_ARTIST                 "artist"
410 411 412 413 414 415 416 417 418 419 420 421
/**
 * GST_TAG_ARTIST_SORTNAME:
 *
 * person(s) responsible for the recording, as used for sorting (string)
 *
 * The artist name as it should be sorted, e.g. 'Hendrix, Jimi' or
 * 'Guitar Heroes, The'
 *
 * Since: 0.10.15
 */
/* FIXME 0.11: change to "artist-sortname" */
#define GST_TAG_ARTIST_SORTNAME        "musicbrainz-sortname"
Stefan Kost's avatar
Stefan Kost committed
422 423 424
/**
 * GST_TAG_ALBUM:
 *
425
 * album containing this data (string)
426 427
 *
 * The album name as it should be displayed, e.g. 'The Jazz Guitar'
Stefan Kost's avatar
Stefan Kost committed
428
 */
429
#define GST_TAG_ALBUM                  "album"
430 431 432 433 434 435 436 437 438 439
/**
 * GST_TAG_ALBUM_SORTNAME:
 *
 * album containing this data, as used for sorting (string)
 *
 * The album name as it should be sorted, e.g. 'Jazz Guitar, The'
 *
 * Since: 0.10.15
 */
#define GST_TAG_ALBUM_SORTNAME         "album-sortname"
440
/**
Thiago Santos's avatar
Thiago Santos committed
441
 * GST_TAG_ALBUM_ARTIST:
442 443 444 445 446 447 448
 *
 * The artist of the entire album, as it should be displayed.
 *
 * Since: 0.10.25
 */
#define GST_TAG_ALBUM_ARTIST           "album-artist"
/**
Thiago Santos's avatar
Thiago Santos committed
449
 * GST_TAG_ALBUM_ARTIST_SORTNAME:
450 451 452 453 454 455
 *
 * The artist of the entire album, as it should be sorted.
 *
 * Since: 0.10.25
 */
#define GST_TAG_ALBUM_ARTIST_SORTNAME  "album-artist-sortname"
456 457 458 459 460 461 462 463
/**
 * GST_TAG_COMPOSER:
 *
 * person(s) who composed the recording (string)
 *
 * Since: 0.10.15
 */
#define GST_TAG_COMPOSER               "composer"
Stefan Kost's avatar
Stefan Kost committed
464 465 466
/**
 * GST_TAG_DATE:
 *
467
 * date the data was created (#GDate structure)
Stefan Kost's avatar
Stefan Kost committed
468
 */
469
#define GST_TAG_DATE                   "date"
470 471
/**
 * GST_TAG_DATE_TIME:
472
 *
473 474 475 476 477
 * date and time the data was created (#GstDateTime structure)
 *
 * Since: 0.10.31
 */
#define GST_TAG_DATE_TIME              "datetime"
Stefan Kost's avatar
Stefan Kost committed
478 479 480
/**
 * GST_TAG_GENRE:
 *
481
 * genre this data belongs to (string)
Stefan Kost's avatar
Stefan Kost committed
482
 */
483
#define GST_TAG_GENRE                  "genre"
Stefan Kost's avatar
Stefan Kost committed
484 485 486
/**
 * GST_TAG_COMMENT:
 *
487
 * free text commenting the data (string)
Stefan Kost's avatar
Stefan Kost committed
488
 */
489
#define GST_TAG_COMMENT                "comment"
490 491 492 493 494 495 496 497 498 499 500 501 502 503
/**
 * GST_TAG_EXTENDED_COMMENT:
 *
 * key/value text commenting the data (string)
 *
 * Must be in the form of 'key=comment' or
 * 'key[lc]=comment' where 'lc' is an ISO-639
 * language code.
 *
 * This tag is used for unknown Vorbis comment tags,
 * unknown APE tags and certain ID3v2 comment fields.
 *
 * Since: 0.10.10
 */
504
#define GST_TAG_EXTENDED_COMMENT       "extended-comment"
Stefan Kost's avatar
Stefan Kost committed
505 506 507
/**
 * GST_TAG_TRACK_NUMBER:
 *
508
 * track number inside a collection (unsigned integer)
Stefan Kost's avatar
Stefan Kost committed
509
 */
510
#define GST_TAG_TRACK_NUMBER           "track-number"
Stefan Kost's avatar
Stefan Kost committed
511 512 513
/**
 * GST_TAG_TRACK_COUNT:
 *
514
 * count of tracks inside collection this track belongs to (unsigned integer)
Stefan Kost's avatar
Stefan Kost committed
515
 */
516
#define GST_TAG_TRACK_COUNT            "track-count"
Stefan Kost's avatar
Stefan Kost committed
517 518 519
/**
 * GST_TAG_ALBUM_VOLUME_NUMBER:
 *
520
 * disc number inside a collection (unsigned integer)
Stefan Kost's avatar
Stefan Kost committed
521
 */
522
#define GST_TAG_ALBUM_VOLUME_NUMBER    "album-disc-number"
Stefan Kost's avatar
Stefan Kost committed
523 524 525
/**
 * GST_TAG_ALBUM_VOLUME_COUNT:
 *
526
 * count of discs inside collection this disc belongs to (unsigned integer)
Stefan Kost's avatar
Stefan Kost committed
527
 */
528
#define GST_TAG_ALBUM_VOLUME_COUNT    "album-disc-count"
Stefan Kost's avatar
Stefan Kost committed
529 530 531
/**
 * GST_TAG_LOCATION:
 *
532 533
 * Origin of media as a URI (location, where the original of the file or stream
 * is hosted) (string)
Stefan Kost's avatar
Stefan Kost committed
534
 */
535
#define GST_TAG_LOCATION               "location"
536 537 538 539 540 541 542 543
/**
 * GST_TAG_HOMEPAGE:
 *
 * Homepage for this media (i.e. artist or movie homepage) (string)
 *
 * Since: 0.10.23
 */
#define GST_TAG_HOMEPAGE               "homepage"
Stefan Kost's avatar
Stefan Kost committed
544 545 546
/**
 * GST_TAG_DESCRIPTION:
 *
547
 * short text describing the content of the data (string)
Stefan Kost's avatar
Stefan Kost committed
548
 */
549
#define GST_TAG_DESCRIPTION            "description"
Stefan Kost's avatar
Stefan Kost committed
550 551 552
/**
 * GST_TAG_VERSION:
 *
553
 * version of this data (string)
Stefan Kost's avatar
Stefan Kost committed
554
 */
555
#define GST_TAG_VERSION                "version"
Stefan Kost's avatar
Stefan Kost committed
556 557 558
/**
 * GST_TAG_ISRC:
 *
559
 * International Standard Recording Code - see http://www.ifpi.org/isrc/ (string)
Stefan Kost's avatar
Stefan Kost committed
560
 */
561
#define GST_TAG_ISRC                   "isrc"
Stefan Kost's avatar
Stefan Kost committed
562 563 564
/**
 * GST_TAG_ORGANIZATION:
 *
565
 * organization (string)
Stefan Kost's avatar
Stefan Kost committed
566
 */
567
#define GST_TAG_ORGANIZATION           "organization"
Stefan Kost's avatar
Stefan Kost committed
568 569 570
/**
 * GST_TAG_COPYRIGHT:
 *
571
 * copyright notice of the data (string)
Stefan Kost's avatar
Stefan Kost committed
572
 */
573
#define GST_TAG_COPYRIGHT              "copyright"
574 575 576 577 578 579 580 581
/**
 * GST_TAG_COPYRIGHT_URI:
 *
 * URI to location where copyright details can be found (string)
 *
 * Since: 0.10.14
 */
#define GST_TAG_COPYRIGHT_URI          "copyright-uri"
582 583 584 585 586 587 588 589 590 591 592 593 594
/**
 * GST_TAG_ENCODED_BY:
 *
 * name of the person or organisation that encoded the file. May contain a
 * copyright message if the person or organisation also holds the copyright
 * (string)
 *
 * Note: do not use this field to describe the encoding application. Use
 * #GST_TAG_APPLICATION_NAME or #GST_TAG_COMMENT for that.
 *
 * Since: 0.10.33
 */
#define GST_TAG_ENCODED_BY             "encoded-by"
Stefan Kost's avatar
Stefan Kost committed
595 596 597
/**
 * GST_TAG_CONTACT:
 *
598
 * contact information (string)
Stefan Kost's avatar
Stefan Kost committed
599
 */
600
#define GST_TAG_CONTACT                "contact"
Stefan Kost's avatar
Stefan Kost committed
601 602 603
/**
 * GST_TAG_LICENSE:
 *
604
 * license of data (string)
Stefan Kost's avatar
Stefan Kost committed
605
 */
606
#define GST_TAG_LICENSE                "license"
607 608 609 610 611 612 613 614
/**
 * GST_TAG_LICENSE_URI:
 *
 * URI to location where license details can be found (string)
 *
 * Since: 0.10.14
 */
#define GST_TAG_LICENSE_URI            "license-uri"
Stefan Kost's avatar
Stefan Kost committed
615 616 617
/**
 * GST_TAG_PERFORMER:
 *
618
 * person(s) performing (string)
Stefan Kost's avatar
Stefan Kost committed
619
 */
620
#define GST_TAG_PERFORMER              "performer"
Stefan Kost's avatar
Stefan Kost committed
621 622 623
/**
 * GST_TAG_DURATION:
 *
624
 * length in GStreamer time units (nanoseconds) (unsigned 64-bit integer)
Stefan Kost's avatar
Stefan Kost committed
625
 */
626
#define GST_TAG_DURATION               "duration"
Stefan Kost's avatar
Stefan Kost committed
627 628 629
/**
 * GST_TAG_CODEC:
 *
630
 * codec the data is stored in (string)
Stefan Kost's avatar
Stefan Kost committed
631
 */
632
#define GST_TAG_CODEC                  "codec"
Stefan Kost's avatar
Stefan Kost committed
633 634 635
/**
 * GST_TAG_VIDEO_CODEC:
 *
636
 * codec the video data is stored in (string)
Stefan Kost's avatar
Stefan Kost committed
637
 */
638
#define GST_TAG_VIDEO_CODEC            "video-codec"
Stefan Kost's avatar
Stefan Kost committed
639 640 641
/**
 * GST_TAG_AUDIO_CODEC:
 *
642
 * codec the audio data is stored in (string)
Stefan Kost's avatar
Stefan Kost committed
643
 */
644
#define GST_TAG_AUDIO_CODEC            "audio-codec"
645 646 647 648 649 650 651 652
/**
 * GST_TAG_SUBTITLE_CODEC:
 *
 * codec/format the subtitle data is stored in (string)
 *
 * Since: 0.10.23
 */
#define GST_TAG_SUBTITLE_CODEC         "subtitle-codec"
653 654 655 656 657 658 659 660
/**
 * GST_TAG_CONTAINER_FORMAT:
 *
 * container format the data is stored in (string)
 *
 * Since: 0.10.24
 */
#define GST_TAG_CONTAINER_FORMAT       "container-format"
Stefan Kost's avatar
Stefan Kost committed
661 662 663
/**
 * GST_TAG_BITRATE:
 *
664
 * exact or average bitrate in bits/s (unsigned integer)
Stefan Kost's avatar
Stefan Kost committed
665
 */
666
#define GST_TAG_BITRATE                "bitrate"
Stefan Kost's avatar
Stefan Kost committed
667 668 669
/**
 * GST_TAG_NOMINAL_BITRATE:
 *
670 671
 * nominal bitrate in bits/s (unsigned integer). The actual bitrate might be
 * different from this target bitrate.
Stefan Kost's avatar
Stefan Kost committed
672
 */
673
#define GST_TAG_NOMINAL_BITRATE        "nominal-bitrate"
Stefan Kost's avatar
Stefan Kost committed
674 675 676
/**
 * GST_TAG_MINIMUM_BITRATE:
 *
677
 * minimum bitrate in bits/s (unsigned integer)
Stefan Kost's avatar
Stefan Kost committed
678
 */
679
#define GST_TAG_MINIMUM_BITRATE        "minimum-bitrate"
Stefan Kost's avatar
Stefan Kost committed
680 681 682
/**
 * GST_TAG_MAXIMUM_BITRATE:
 *
683
 * maximum bitrate in bits/s (unsigned integer)
Stefan Kost's avatar
Stefan Kost committed
684
 */
685
#define GST_TAG_MAXIMUM_BITRATE        "maximum-bitrate"
Stefan Kost's avatar
Stefan Kost committed
686 687 688
/**
 * GST_TAG_SERIAL:
 *
689
 * serial number of track (unsigned integer)
Stefan Kost's avatar
Stefan Kost committed
690
 */
691
#define GST_TAG_SERIAL                 "serial"
Stefan Kost's avatar
Stefan Kost committed
692 693 694
/**
 * GST_TAG_ENCODER:
 *
695
 * encoder used to encode this stream (string)
Stefan Kost's avatar
Stefan Kost committed
696
 */
697
#define GST_TAG_ENCODER                "encoder"
Stefan Kost's avatar
Stefan Kost committed
698 699 700
/**
 * GST_TAG_ENCODER_VERSION:
 *
701
 * version of the encoder used to encode this stream (unsigned integer)
Stefan Kost's avatar
Stefan Kost committed
702
 */
703
#define GST_TAG_ENCODER_VERSION        "encoder-version"
Stefan Kost's avatar
Stefan Kost committed
704 705 706
/**
 * GST_TAG_TRACK_GAIN:
 *
707
 * track gain in db (double)
Stefan Kost's avatar
Stefan Kost committed
708
 */
709
#define GST_TAG_TRACK_GAIN             "replaygain-track-gain"
Stefan Kost's avatar
Stefan Kost committed
710 711 712
/**
 * GST_TAG_TRACK_PEAK:
 *
713
 * peak of the track (double)
Stefan Kost's avatar
Stefan Kost committed
714
 */
715
#define GST_TAG_TRACK_PEAK             "replaygain-track-peak"
Stefan Kost's avatar
Stefan Kost committed
716 717 718
/**
 * GST_TAG_ALBUM_GAIN:
 *
719
 * album gain in db (double)
Stefan Kost's avatar
Stefan Kost committed
720
 */
721
#define GST_TAG_ALBUM_GAIN             "replaygain-album-gain"
Stefan Kost's avatar
Stefan Kost committed
722 723 724
/**
 * GST_TAG_ALBUM_PEAK:
 *
725
 * peak of the album (double)
Stefan Kost's avatar
Stefan Kost committed
726
 */
727
#define GST_TAG_ALBUM_PEAK             "replaygain-album-peak"
728 729 730 731 732 733 734 735
/**
 * GST_TAG_REFERENCE_LEVEL:
 *
 * reference level of track and album gain values (double)
 *
 * Since: 0.10.12
 */
#define GST_TAG_REFERENCE_LEVEL        "replaygain-reference-level"
736 737 738
/**
 * GST_TAG_LANGUAGE_CODE:
 *
739
 * Language code (ISO-639-1) (string) of the content
740
 */
741
#define GST_TAG_LANGUAGE_CODE          "language-code"
742 743 744
/**
 * GST_TAG_IMAGE:
 *
745 746
 * image (buffer) (buffer caps should specify the content type and preferably
 * also set "image-type" field as #GstTagImageType)
747 748 749
 *
 * Since: 0.10.6
 */
750
#define GST_TAG_IMAGE                  "image"
751 752 753
/**
 * GST_TAG_PREVIEW_IMAGE:
 *
754 755
 * image that is meant for preview purposes, e.g. small icon-sized version
 * (buffer) (buffer caps should specify the content type)
756 757 758
 *
 * Since: 0.10.7
 */
759
#define GST_TAG_PREVIEW_IMAGE          "preview-image"
760 761 762 763 764 765 766 767 768 769 770 771

/**
 * GST_TAG_ATTACHMENT:
 *
 * generic file attachment (buffer) (buffer caps should specify the content
 * type and if possible set "filename" to the file name of the
 * attachment)
 *
 * Since: 0.10.21
 */
#define GST_TAG_ATTACHMENT             "attachment"

772 773 774
/**
 * GST_TAG_BEATS_PER_MINUTE:
 *
775
 * number of beats per minute in audio (double)
776
 *
777
 * Since: 0.10.12
778 779
 */
#define GST_TAG_BEATS_PER_MINUTE       "beats-per-minute"
Benjamin Otte's avatar
Benjamin Otte committed
780

781 782 783
/**
 * GST_TAG_KEYWORDS:
 *
784
 * comma separated keywords describing the content (string).
785 786 787 788 789
 *
 * Since: 0.10.21
 */
#define GST_TAG_KEYWORDS               "keywords"

790 791 792 793 794 795
/**
 * GST_TAG_GEO_LOCATION_NAME:
 *
 * human readable descriptive location of where the media has been recorded or
 * produced. (string).
 *
796
 * Since: 0.10.21
797 798 799 800 801 802 803 804 805 806
 */
#define GST_TAG_GEO_LOCATION_NAME               "geo-location-name"

/**
 * GST_TAG_GEO_LOCATION_LATITUDE:
 *
 * geo latitude location of where the media has been recorded or produced in
 * degrees according to WGS84 (zero at the equator, negative values for southern
 * latitudes) (double).
 *
807
 * Since: 0.10.21
808 809 810 811 812 813 814 815 816 817
 */
#define GST_TAG_GEO_LOCATION_LATITUDE               "geo-location-latitude"

/**
 * GST_TAG_GEO_LOCATION_LONGITUDE:
 *
 * geo longitude location of where the media has been recorded or produced in
 * degrees according to WGS84 (zero at the prime meridian in Greenwich/UK,
 * negative values for western longitudes). (double).
 *
818
 * Since: 0.10.21
819 820 821 822 823 824 825 826 827
 */
#define GST_TAG_GEO_LOCATION_LONGITUDE               "geo-location-longitude"

/**
 * GST_TAG_GEO_LOCATION_ELEVATION:
 *
 * geo elevation of where the media has been recorded or produced in meters
 * according to WGS84 (zero is average sea level) (double).
 *
828
 * Since: 0.10.21
829
 */
830
#define GST_TAG_GEO_LOCATION_ELEVATION               "geo-location-elevation"
831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858
/**
 * GST_TAG_GEO_LOCATION_COUNTRY:
 *
 * The country (english name) where the media has been produced (string).
 *
 * Since: 0.10.29
 */
#define GST_TAG_GEO_LOCATION_COUNTRY                 "geo-location-country"
/**
 * GST_TAG_GEO_LOCATION_CITY:
 *
 * The city (english name) where the media has been produced (string).
 *
 * Since: 0.10.29
 */
#define GST_TAG_GEO_LOCATION_CITY                    "geo-location-city"
/**
 * GST_TAG_GEO_LOCATION_SUBLOCATION:
 *
 * A location 'smaller' than GST_TAG_GEO_LOCATION_CITY that specifies better
 * where the media has been produced. (e.g. the neighborhood) (string).
 *
 * This tag has been added as this is how it is handled/named in XMP's
 * Iptc4xmpcore schema.
 *
 * Since: 0.10.29
 */
#define GST_TAG_GEO_LOCATION_SUBLOCATION             "geo-location-sublocation"
859 860 861 862 863 864 865 866 867
/**
 * GST_TAG_GEO_LOCATION_HORIZONTAL_ERROR:
 *
 * Represents the expected error on the horizontal positioning in
 * meters (double).
 *
 * Since: 0.10.31
 */
#define GST_TAG_GEO_LOCATION_HORIZONTAL_ERROR   "geo-location-horizontal-error"
868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902
/**
 * GST_TAG_GEO_LOCATION_MOVEMENT_SPEED:
 *
 * Speed of the capturing device when performing the capture.
 * Represented in m/s. (double)
 *
 * See also #GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION
 *
 * Since 0.10.30
 */
#define GST_TAG_GEO_LOCATION_MOVEMENT_SPEED       "geo-location-movement-speed"
/**
 * GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION:
 *
 * Indicates the movement direction of the device performing the capture
 * of a media. It is represented as degrees in floating point representation,
 * 0 means the geographic north, and increases clockwise (double from 0 to 360)
 *
 * See also #GST_TAG_GEO_LOCATION_CAPTURE_DIRECTION
 *
 * Since: 0.10.30
 */
#define GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION "geo-location-movement-direction"
/**
 * GST_TAG_GEO_LOCATION_CAPTURE_DIRECTION:
 *
 * Indicates the direction the device is pointing to when capturing
 * a media. It is represented as degrees in floating point representation,
 * 0 means the geographic north, and increases clockwise (double from 0 to 360)
 *
 * See also #GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION
 *
 * Since: 0.10.30
 */
#define GST_TAG_GEO_LOCATION_CAPTURE_DIRECTION  "geo-location-capture-direction"
Thiago Santos's avatar
Thiago Santos committed
903
/**
Thiago Santos's avatar
Thiago Santos committed
904
 * GST_TAG_SHOW_NAME:
Thiago Santos's avatar
Thiago Santos committed
905
 *
906
 * Name of the show, used for displaying (string)
Thiago Santos's avatar
Thiago Santos committed
907 908 909 910 911
 *
 * Since: 0.10.26
 */
#define GST_TAG_SHOW_NAME                         "show-name"
/**
Thiago Santos's avatar
Thiago Santos committed
912
 * GST_TAG_SHOW_SORTNAME:
Thiago Santos's avatar
Thiago Santos committed
913
 *
914
 * Name of the show, used for sorting (string)
Thiago Santos's avatar
Thiago Santos committed
915 916 917 918 919
 *
 * Since: 0.10.26
 */
#define GST_TAG_SHOW_SORTNAME                     "show-sortname"
/**
Thiago Santos's avatar
Thiago Santos committed
920
 * GST_TAG_SHOW_EPISODE_NUMBER:
Thiago Santos's avatar
Thiago Santos committed
921
 *
922
 * Number of the episode within a season/show (unsigned integer)
Thiago Santos's avatar
Thiago Santos committed
923 924 925 926 927
 *
 * Since: 0.10.26
 */
#define GST_TAG_SHOW_EPISODE_NUMBER               "show-episode-number"
/**
Thiago Santos's avatar
Thiago Santos committed
928
 * GST_TAG_SHOW_SEASON_NUMBER:
Thiago Santos's avatar
Thiago Santos committed
929
 *
930
 * Number of the season of a show/series (unsigned integer)
Thiago Santos's avatar
Thiago Santos committed
931 932 933 934 935
 *
 * Since: 0.10.26
 */
#define GST_TAG_SHOW_SEASON_NUMBER                "show-season-number"
/**
Thiago Santos's avatar
Thiago Santos committed
936
 * GST_TAG_LYRICS:
Thiago Santos's avatar
Thiago Santos committed
937
 *
938
 * The lyrics of the media (string)
Thiago Santos's avatar
Thiago Santos committed
939 940 941 942 943
 *
 * Since: 0.10.26
 */
#define GST_TAG_LYRICS                            "lyrics"
/**
Thiago Santos's avatar
Thiago Santos committed
944
 * GST_TAG_COMPOSER_SORTNAME:
Thiago Santos's avatar
Thiago Santos committed
945
 *
946
 * The composer's name, used for sorting (string)
Thiago Santos's avatar
Thiago Santos committed
947 948 949 950 951
 *
 * Since: 0.10.26
 */
#define GST_TAG_COMPOSER_SORTNAME                 "composer-sortname"
/**
Thiago Santos's avatar
Thiago Santos committed
952
 * GST_TAG_GROUPING:
Thiago Santos's avatar
Thiago Santos committed
953 954
 *
 * Groups together media that are related and spans multiple tracks. An
955
 * example are multiple pieces of a concerto. (string)
Thiago Santos's avatar
Thiago Santos committed
956 957 958 959
 *
 * Since: 0.10.26
 */
#define GST_TAG_GROUPING                          "grouping"
960
/**
Thiago Santos's avatar
Thiago Santos committed
961
 * GST_TAG_USER_RATING:
962 963 964 965 966 967 968 969
 *
 * Rating attributed by a person (likely the application user).
 * The higher the value, the more the user likes this media
 * (unsigned int from 0 to 100)
 *
 * Since: 0.10.29
 */
#define GST_TAG_USER_RATING                       "user-rating"
970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985
/**
 * GST_TAG_DEVICE_MANUFACTURER:
 *
 * Manufacturer of the device used to create the media (string)
 *
 * Since: 0.10.30
 */
#define GST_TAG_DEVICE_MANUFACTURER               "device-manufacturer"
/**
 * GST_TAG_DEVICE_MODEL:
 *
 * Model of the device used to create the media (string)
 *
 * Since: 0.10.30
 */
#define GST_TAG_DEVICE_MODEL                      "device-model"
986 987 988 989 990 991 992 993
/**
 * GST_TAG_APPLICATION_NAME:
 *
 * Name of the application used to create the media (string)
 *
 * Since: 0.10.31
 */
#define GST_TAG_APPLICATION_NAME                  "application-name"
994 995 996 997 998 999 1000 1001 1002 1003 1004
/**
 * GST_TAG_APPLICATION_DATA:
 *
 * Arbitrary application data (buffer)
 *
 * Some formats allow application's to add their own arbitrary data
 * into files. This data is application's dependent.
 *
 * Since: 0.10.31
 */
#define GST_TAG_APPLICATION_DATA          "application-data"
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
/**
 * GST_TAG_IMAGE_ORIENTATION:
 *
 * Represents the 'Orientation' tag from EXIF. Defines how the image
 * should be rotated and mirrored for display. (string)
 *
 * This tag has a predefined set of allowed values:
 *   "rotate-0"
 *   "rotate-90"
 *   "rotate-180"
 *   "rotate-270"
 *   "flip-rotate-0"
 *   "flip-rotate-90"
 *   "flip-rotate-180"
 *   "flip-rotate-270"
 *
 * The naming is adopted according to a possible transformation to perform
 * on the image to fix its orientation, obviously equivalent operations will
 * yield the same result.
 *
 * Rotations indicated by the values are in clockwise direction and
 * 'flip' means an horizontal mirroring.
 *
 * Since: 0.10.30
 */
#define GST_TAG_IMAGE_ORIENTATION            "image-orientation"
1031

Benjamin Otte's avatar
Benjamin Otte committed
1032
G_END_DECLS
1033

1034
#endif /* __GST_TAGLIST_H__ */