gst/gsttaglist.h

   1 /* GStreamer
   2  * Copyright (C) 2003 Benjamin Otte <in7y118@public.uni-hamburg.de>
   3  *
   4  * gsttaglist.h: Header for tag support
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  19  * Boston, MA 02110-1301, USA.
  20  */
  21
  22
  23 #ifndef __GST_TAGLIST_H__
  24 #define __GST_TAGLIST_H__
  25
  26 #include <gst/gstdatetime.h>
  27 #include <gst/gstsample.h>
  28 #include <gst/gstbuffer.h>
  29 #include <gst/glib-compat.h>
  30
  31 G_BEGIN_DECLS
  32
  33 /**
  34  * GstTagMergeMode:
  35  * @GST_TAG_MERGE_UNDEFINED: undefined merge mode
  36  * @GST_TAG_MERGE_REPLACE_ALL: replace all tags (clear list and append)
  37  * @GST_TAG_MERGE_REPLACE: replace tags
  38  * @GST_TAG_MERGE_APPEND: append tags
  39  * @GST_TAG_MERGE_PREPEND: prepend tags
  40  * @GST_TAG_MERGE_KEEP: keep existing tags
  41  * @GST_TAG_MERGE_KEEP_ALL: keep all existing tags
  42  * @GST_TAG_MERGE_COUNT: the number of merge modes
  43  *
  44  * The different tag merging modes are basically replace, overwrite and append,
  45  * but they can be seen from two directions. Given two taglists: (A) the tags
  46  * already in the element and (B) the ones that are supplied to the element (
  47  * e.g. via gst_tag_setter_merge_tags() / gst_tag_setter_add_tags() or a
  48  * %GST_EVENT_TAG), how are these tags merged?
  49  * In the table below this is shown for the cases that a tag exists in the list
  50  * (A) or does not exists (!A) and combinations thereof.
  51  *
  52  * <table frame="all" colsep="1" rowsep="1">
  53  *   <title>merge mode</title>
  54  *   <tgroup cols='5' align='left'>
  55  *     <thead>
  56  *       <row>
  57  *         <entry>merge mode</entry>
  58  *         <entry>A + B</entry>
  59  *         <entry>A + !B</entry>
  60  *         <entry>!A + B</entry>
  61  *         <entry>!A + !B</entry>
  62  *       </row>
  63  *     </thead>
  64  *     <tbody>
  65  *       <row>
  66  *         <entry>REPLACE_ALL</entry>
  67  *         <entry>B</entry>
  68  *         <entry>-</entry>
  69  *         <entry>B</entry>
  70  *         <entry>-</entry>
  71  *       </row>
  72  *       <row>
  73  *         <entry>REPLACE</entry>
  74  *         <entry>B</entry>
  75  *         <entry>A</entry>
  76  *         <entry>B</entry>
  77  *         <entry>-</entry>
  78  *       </row>
  79  *       <row>
  80  *         <entry>APPEND</entry>
  81  *         <entry>A, B</entry>
  82  *         <entry>A</entry>
  83  *         <entry>B</entry>
  84  *         <entry>-</entry>
  85  *       </row>
  86  *       <row>
  87  *         <entry>PREPEND</entry>
  88  *         <entry>B, A</entry>
  89  *         <entry>A</entry>
  90  *         <entry>B</entry>
  91  *         <entry>-</entry>
  92  *       </row>
  93  *       <row>
  94  *         <entry>KEEP</entry>
  95  *         <entry>A</entry>
  96  *         <entry>A</entry>
  97  *         <entry>B</entry>
  98  *         <entry>-</entry>
  99  *       </row>
 100  *       <row>
 101  *         <entry>KEEP_ALL</entry>
 102  *         <entry>A</entry>
 103  *         <entry>A</entry>
 104  *         <entry>-</entry>
 105  *         <entry>-</entry>
 106  *       </row>
 107  *     </tbody>
 108  *   </tgroup>
 109  * </table>
 110  */
 111 typedef enum {
 112   GST_TAG_MERGE_UNDEFINED,
 113   GST_TAG_MERGE_REPLACE_ALL,
 114   GST_TAG_MERGE_REPLACE,
 115   GST_TAG_MERGE_APPEND,
 116   GST_TAG_MERGE_PREPEND,
 117   GST_TAG_MERGE_KEEP,
 118   GST_TAG_MERGE_KEEP_ALL,
 119   /* add more */
 120   GST_TAG_MERGE_COUNT
 121 } GstTagMergeMode;
 122
 123 #define GST_TAG_MODE_IS_VALID(mode)     (((mode) > GST_TAG_MERGE_UNDEFINED) && ((mode) < GST_TAG_MERGE_COUNT))
 124
 125 /**
 126  * GstTagFlag:
 127  * @GST_TAG_FLAG_UNDEFINED: undefined flag
 128  * @GST_TAG_FLAG_META: tag is meta data
 129  * @GST_TAG_FLAG_ENCODED: tag is encoded
 130  * @GST_TAG_FLAG_DECODED: tag is decoded
 131  * @GST_TAG_FLAG_COUNT: number of tag flags
 132  *
 133  * Extra tag flags used when registering tags.
 134  */
 135 /* FIXME: these are not really flags .. */
 136 typedef enum {
 137   GST_TAG_FLAG_UNDEFINED,
 138   GST_TAG_FLAG_META,
 139   GST_TAG_FLAG_ENCODED,
 140   GST_TAG_FLAG_DECODED,
 141   GST_TAG_FLAG_COUNT
 142 } GstTagFlag;
 143
 144 #define GST_TAG_FLAG_IS_VALID(flag)     (((flag) > GST_TAG_FLAG_UNDEFINED) && ((flag) < GST_TAG_FLAG_COUNT))
 145
 146 /**
 147  * GstTagList:
 148  * @mini_object: the parent type
 149  *
 150  * Object describing tags / metadata.
 151  */
 152 typedef struct _GstTagList GstTagList;
 153 struct _GstTagList {
 154   GstMiniObject mini_object;
 155 };
 156
 157 #define GST_TAG_LIST(x)       ((GstTagList *) (x))
 158 #define GST_TYPE_TAG_LIST     (gst_tag_list_get_type ())
 159 #define GST_IS_TAG_LIST(obj)  (GST_IS_MINI_OBJECT_TYPE((obj), GST_TYPE_TAG_LIST))
 160
 161 /**
 162  * GstTagForeachFunc:
 163  * @list: the #GstTagList
 164  * @tag: a name of a tag in @list
 165  * @user_data: user data
 166  *
 167  * A function that will be called in gst_tag_list_foreach(). The function may
 168  * not modify the tag list.
 169  */
 170 typedef void (*GstTagForeachFunc) (const GstTagList * list,
 171                                    const gchar      * tag,
 172                                    gpointer           user_data);
 173
 174 /**
 175  * GstTagMergeFunc:
 176  * @dest: the destination #GValue
 177  * @src: the source #GValue
 178  *
 179  * A function for merging multiple values of a tag used when registering
 180  * tags.
 181  */
 182 typedef void (* GstTagMergeFunc) (GValue *dest, const GValue *src);
 183
 184 GType        gst_tag_list_get_type (void);
 185
 186 /* tag registration */
 187 void         gst_tag_register      (const gchar     * name,
 188                                     GstTagFlag        flag,
 189                                     GType             type,
 190                                     const gchar     * nick,
 191                                     const gchar     * blurb,
 192                                     GstTagMergeFunc   func);
 193
 194 void         gst_tag_register_static (const gchar   * name,
 195                                       GstTagFlag      flag,
 196                                       GType           type,
 197                                       const gchar   * nick,
 198                                       const gchar   * blurb,
 199                                       GstTagMergeFunc func);
 200
 201 /* some default merging functions */
 202 void      gst_tag_merge_use_first          (GValue * dest, const GValue * src);
 203 void      gst_tag_merge_strings_with_comma (GValue * dest, const GValue * src);
 204
 205 /* basic tag support */
 206 gboolean               gst_tag_exists          (const gchar * tag);
 207 GType                  gst_tag_get_type        (const gchar * tag);
 208 const gchar *          gst_tag_get_nick        (const gchar * tag);
 209 const gchar *          gst_tag_get_description (const gchar * tag);
 210 GstTagFlag             gst_tag_get_flag        (const gchar * tag);
 211 gboolean               gst_tag_is_fixed        (const gchar * tag);
 212
 213 /* tag lists */
 214
 215 /**
 216  * GstTagScope:
 217  * @GST_TAG_SCOPE_STREAM: tags specific to this single stream
 218  * @GST_TAG_SCOPE_GLOBAL: global tags for the complete medium
 219  *
 220  * GstTagScope specifies if a taglist applies to the complete
 221  * medium or only to one single stream.
 222  */
 223 typedef enum {
 224   GST_TAG_SCOPE_STREAM,
 225   GST_TAG_SCOPE_GLOBAL
 226 } GstTagScope;
 227
 228 GstTagList * gst_tag_list_new_empty         (void) G_GNUC_MALLOC;
 229 GstTagList * gst_tag_list_new               (const gchar * tag, ...) G_GNUC_MALLOC;
 230 GstTagList * gst_tag_list_new_valist        (va_list var_args) G_GNUC_MALLOC;
 231
 232 void         gst_tag_list_set_scope         (GstTagList * list, GstTagScope scope);
 233 GstTagScope  gst_tag_list_get_scope         (const GstTagList * list);
 234
 235 gchar      * gst_tag_list_to_string         (const GstTagList * list) G_GNUC_MALLOC;
 236 GstTagList * gst_tag_list_new_from_string   (const gchar      * str) G_GNUC_MALLOC;
 237
 238 gint         gst_tag_list_n_tags            (const GstTagList * list);
 239 const gchar* gst_tag_list_nth_tag_name      (const GstTagList * list, guint index);
 240 gboolean     gst_tag_list_is_empty          (const GstTagList * list);
 241 gboolean     gst_tag_list_is_equal          (const GstTagList * list1,
 242                                              const GstTagList * list2);
 243 void         gst_tag_list_insert            (GstTagList       * into,
 244                                              const GstTagList * from,
 245                                              GstTagMergeMode    mode);
 246 GstTagList * gst_tag_list_merge             (const GstTagList * list1,
 247                                              const GstTagList * list2,
 248                                              GstTagMergeMode    mode) G_GNUC_MALLOC;
 249 guint        gst_tag_list_get_tag_size      (const GstTagList * list,
 250                                              const gchar      * tag);
 251 void         gst_tag_list_add               (GstTagList       * list,
 252                                              GstTagMergeMode    mode,
 253                                              const gchar      * tag,
 254                                              ...) G_GNUC_NULL_TERMINATED;
 255 void         gst_tag_list_add_values        (GstTagList       * list,
 256                                              GstTagMergeMode    mode,
 257                                              const gchar      * tag,
 258                                              ...) G_GNUC_NULL_TERMINATED;
 259 void         gst_tag_list_add_valist        (GstTagList       * list,
 260                                              GstTagMergeMode    mode,
 261                                              const gchar      * tag,
 262                                              va_list        var_args);
 263 void         gst_tag_list_add_valist_values (GstTagList       * list,
 264                                              GstTagMergeMode    mode,
 265                                              const gchar      * tag,
 266                                              va_list            var_args);
 267 void         gst_tag_list_add_value         (GstTagList       * list,
 268                                              GstTagMergeMode    mode,
 269                                              const gchar      * tag,
 270                                              const GValue     * value);
 271 void         gst_tag_list_remove_tag        (GstTagList       * list,
 272                                              const gchar      * tag);
 273 void         gst_tag_list_foreach           (const GstTagList * list,
 274                                              GstTagForeachFunc  func,
 275                                              gpointer           user_data);
 276
 277 const GValue *
 278              gst_tag_list_get_value_index   (const GstTagList * list,
 279                                              const gchar      * tag,
 280                                              guint              index);
 281 gboolean     gst_tag_list_copy_value        (GValue           * dest,
 282                                              const GstTagList * list,
 283                                              const gchar      * tag);
 284
 285 /* simplifications (FIXME: do we want them?) */
 286 gboolean     gst_tag_list_get_boolean       (const GstTagList * list,
 287                                              const gchar      * tag,
 288                                              gboolean         * value);
 289 gboolean     gst_tag_list_get_boolean_index (const GstTagList * list,
 290                                              const gchar      * tag,
 291                                              guint              index,
 292                                              gboolean         * value);
 293 gboolean     gst_tag_list_get_int           (const GstTagList * list,
 294                                              const gchar      * tag,
 295                                              gint             * value);
 296 gboolean     gst_tag_list_get_int_index     (const GstTagList * list,
 297                                              const gchar      * tag,
 298                                              guint              index,
 299                                              gint             * value);
 300 gboolean     gst_tag_list_get_uint          (const GstTagList * list,
 301                                              const gchar      * tag,
 302                                              guint            * value);
 303 gboolean     gst_tag_list_get_uint_index    (const GstTagList * list,
 304                                              const gchar      * tag,
 305                                              guint              index,
 306                                              guint            * value);
 307 gboolean     gst_tag_list_get_int64         (const GstTagList * list,
 308                                              const gchar      * tag,
 309                                              gint64           * value);
 310 gboolean     gst_tag_list_get_int64_index   (const GstTagList * list,
 311                                              const gchar      * tag,
 312                                              guint              index,
 313                                              gint64           * value);
 314 gboolean     gst_tag_list_get_uint64        (const GstTagList * list,
 315                                              const gchar      * tag,
 316                                              guint64          * value);
 317 gboolean     gst_tag_list_get_uint64_index  (const GstTagList * list,
 318                                              const gchar      * tag,
 319                                              guint              index,
 320                                              guint64          * value);
 321 gboolean     gst_tag_list_get_float         (const GstTagList * list,
 322                                              const gchar      * tag,
 323                                              gfloat           * value);
 324 gboolean     gst_tag_list_get_float_index   (const GstTagList * list,
 325                                              const gchar      * tag,
 326                                              guint              index,
 327                                              gfloat           * value);
 328 gboolean     gst_tag_list_get_double        (const GstTagList * list,
 329                                              const gchar      * tag,
 330                                              gdouble          * value);
 331 gboolean     gst_tag_list_get_double_index  (const GstTagList * list,
 332                                              const gchar      * tag,
 333                                              guint              index,
 334                                              gdouble          * value);
 335 gboolean     gst_tag_list_get_string        (const GstTagList * list,
 336                                              const gchar      * tag,
 337                                              gchar           ** value);
 338 gboolean     gst_tag_list_get_string_index  (const GstTagList * list,
 339                                              const gchar      * tag,
 340                                              guint              index,
 341                                              gchar           ** value);
 342 gboolean     gst_tag_list_peek_string_index (const GstTagList * list,
 343                                              const gchar      * tag,
 344                                              guint              index,
 345                                              const gchar     ** value);
 346 gboolean     gst_tag_list_get_pointer       (const GstTagList * list,
 347                                              const gchar      * tag,
 348                                              gpointer         * value);
 349 gboolean     gst_tag_list_get_pointer_index (const GstTagList * list,
 350                                              const gchar      * tag,
 351                                              guint              index,
 352                                              gpointer         * value);
 353 gboolean     gst_tag_list_get_date          (const GstTagList * list,
 354                                              const gchar      * tag,
 355                                              GDate           ** value);
 356 gboolean     gst_tag_list_get_date_index    (const GstTagList * list,
 357                                              const gchar      * tag,
 358                                              guint              index,
 359                                              GDate           ** value);
 360 gboolean     gst_tag_list_get_date_time     (const GstTagList * list,
 361                                              const gchar      * tag,
 362                                              GstDateTime     ** value);
 363 gboolean     gst_tag_list_get_date_time_index (const GstTagList * list,
 364                                              const gchar      * tag,
 365                                              guint              index,
 366                                              GstDateTime     ** value);
 367 gboolean     gst_tag_list_get_sample        (const GstTagList * list,
 368                                              const gchar      * tag,
 369                                              GstSample       ** sample);
 370 gboolean     gst_tag_list_get_sample_index  (const GstTagList * list,
 371                                              const gchar      * tag,
 372                                              guint              index,
 373                                              GstSample       ** sample);
 374
 375 /* refcounting */
 376 /**
 377  * gst_tag_list_ref:
 378  * @taglist: the #GstTagList to reference
 379  *
 380  * Add a reference to a #GstTagList mini object.
 381  *
 382  * From this point on, until the caller calls gst_tag_list_unref() or
 383  * gst_tag_list_make_writable(), it is guaranteed that the taglist object will
 384  * not change. To use a #GstTagList object, you must always have a refcount on
 385  * it -- either the one made implicitly by e.g. gst_tag_list_new(), or via
 386  * taking one explicitly with this function.
 387  *
 388  * Returns: the same #GstTagList mini object.
 389  */
 390 #ifdef _FOOL_GTK_DOC_
 391 G_INLINE_FUNC GstTagList * gst_tag_list_ref (GstTagList * taglist);
 392 #endif
 393
 394 static inline GstTagList *
 395 gst_tag_list_ref (GstTagList * taglist)
 396 {
 397   return (GstTagList *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (taglist));
 398 }
 399
 400 /**
 401  * gst_tag_list_unref:
 402  * @taglist: a #GstTagList.
 403  *
 404  * Unref a #GstTagList, and and free all its memory when the refcount reaches 0.
 405  */
 406 #ifdef _FOOL_GTK_DOC_
 407 G_INLINE_FUNC void gst_tag_list_unref (GstTagList * taglist);
 408 #endif
 409
 410 static inline void
 411 gst_tag_list_unref (GstTagList * taglist)
 412 {
 413   gst_mini_object_unref (GST_MINI_OBJECT_CAST (taglist));
 414 }
 415
 416 /**
 417  * gst_tag_list_copy:
 418  * @taglist: a #GstTagList.
 419  *
 420  * Creates a new #GstTagList as a copy of the old @taglist. The new taglist
 421  * will have a refcount of 1, owned by the caller, and will be writable as
 422  * a result.
 423  *
 424  * Note that this function is the semantic equivalent of a gst_tag_list_ref()
 425  * followed by a gst_tag_list_make_writable(). If you only want to hold on to a
 426  * reference to the data, you should use gst_tag_list_ref().
 427  *
 428  * When you are finished with the taglist, call gst_tag_list_unref() on it.
 429  *
 430  * Returns: the new #GstTagList
 431  */
 432 #ifdef _FOOL_GTK_DOC_
 433 G_INLINE_FUNC GstTagList * gst_tag_list_copy (const GstTagList * taglist);
 434 #endif
 435
 436 static inline GstTagList *
 437 gst_tag_list_copy (const GstTagList * taglist)
 438 {
 439   return GST_TAG_LIST (gst_mini_object_copy (GST_MINI_OBJECT_CAST (taglist)));
 440 }
 441
 442 /**
 443  * gst_tag_list_is_writable:
 444  * @taglist: a #GstTagList
 445  *
 446  * Tests if you can safely modify @taglist. It is only safe to modify taglist
 447  * when there is only one owner of the taglist - ie, the refcount is 1.
 448  */
 449 #define gst_tag_list_is_writable(taglist)    gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (taglist))
 450
 451 /**
 452  * gst_tag_list_make_writable:
 453  * @taglist: (transfer full): a #GstTagList
 454  *
 455  * Returns a writable copy of @taglist.
 456  *
 457  * If there is only one reference count on @taglist, the caller must be the
 458  * owner, and so this function will return the taglist object unchanged. If on
 459  * the other hand there is more than one reference on the object, a new taglist
 460  * object will be returned (which will be a copy of @taglist). The caller's
 461  * reference on @taglist will be removed, and instead the caller will own a
 462  * reference to the returned object.
 463  *
 464  * In short, this function unrefs the taglist in the argument and refs the
 465  * taglist that it returns. Don't access the argument after calling this
 466  * function. See also: gst_tag_list_ref().
 467  *
 468  * Returns: (transfer full): a writable taglist which may or may not be the
 469  *     same as @taglist
 470  */
 471 #define gst_tag_list_make_writable(taglist)   GST_TAG_LIST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (taglist)))
 472
 473 /* GStreamer core tags */
 474 /**
 475  * GST_TAG_TITLE:
 476  *
 477  * commonly used title (string)
 478  *
 479  * The title as it should be displayed, e.g. 'The Doll House'
 480  */
 481 #define GST_TAG_TITLE                  "title"
 482 /**
 483  * GST_TAG_TITLE_SORTNAME:
 484  *
 485  * commonly used title, as used for sorting (string)
 486  *
 487  * The title as it should be sorted, e.g. 'Doll House, The'
 488  */
 489 #define GST_TAG_TITLE_SORTNAME         "title-sortname"
 490 /**
 491  * GST_TAG_ARTIST:
 492  *
 493  * person(s) responsible for the recording (string)
 494  *
 495  * The artist name as it should be displayed, e.g. 'Jimi Hendrix' or
 496  * 'The Guitar Heroes'
 497  */
 498 #define GST_TAG_ARTIST                 "artist"
 499 /**
 500  * GST_TAG_ARTIST_SORTNAME:
 501  *
 502  * person(s) responsible for the recording, as used for sorting (string)
 503  *
 504  * The artist name as it should be sorted, e.g. 'Hendrix, Jimi' or
 505  * 'Guitar Heroes, The'
 506  */
 507 #define GST_TAG_ARTIST_SORTNAME        "artist-sortname"
 508 /**
 509  * GST_TAG_ALBUM:
 510  *
 511  * album containing this data (string)
 512  *
 513  * The album name as it should be displayed, e.g. 'The Jazz Guitar'
 514  */
 515 #define GST_TAG_ALBUM                  "album"
 516 /**
 517  * GST_TAG_ALBUM_SORTNAME:
 518  *
 519  * album containing this data, as used for sorting (string)
 520  *
 521  * The album name as it should be sorted, e.g. 'Jazz Guitar, The'
 522  */
 523 #define GST_TAG_ALBUM_SORTNAME         "album-sortname"
 524 /**
 525  * GST_TAG_ALBUM_ARTIST:
 526  *
 527  * The artist of the entire album, as it should be displayed.
 528  */
 529 #define GST_TAG_ALBUM_ARTIST           "album-artist"
 530 /**
 531  * GST_TAG_ALBUM_ARTIST_SORTNAME:
 532  *
 533  * The artist of the entire album, as it should be sorted.
 534  */
 535 #define GST_TAG_ALBUM_ARTIST_SORTNAME  "album-artist-sortname"
 536 /**
 537  * GST_TAG_COMPOSER:
 538  *
 539  * person(s) who composed the recording (string)
 540  */
 541 #define GST_TAG_COMPOSER               "composer"
 542 /**
 543  * GST_TAG_DATE:
 544  *
 545  * date the data was created (#GDate structure)
 546  */
 547 #define GST_TAG_DATE                   "date"
 548 /**
 549  * GST_TAG_DATE_TIME:
 550  *
 551  * date and time the data was created (#GstDateTime structure)
 552  */
 553 #define GST_TAG_DATE_TIME              "datetime"
 554 /**
 555  * GST_TAG_GENRE:
 556  *
 557  * genre this data belongs to (string)
 558  */
 559 #define GST_TAG_GENRE                  "genre"
 560 /**
 561  * GST_TAG_COMMENT:
 562  *
 563  * free text commenting the data (string)
 564  */
 565 #define GST_TAG_COMMENT                "comment"
 566 /**
 567  * GST_TAG_EXTENDED_COMMENT:
 568  *
 569  * key/value text commenting the data (string)
 570  *
 571  * Must be in the form of 'key=comment' or
 572  * 'key[lc]=comment' where 'lc' is an ISO-639
 573  * language code.
 574  *
 575  * This tag is used for unknown Vorbis comment tags,
 576  * unknown APE tags and certain ID3v2 comment fields.
 577  */
 578 #define GST_TAG_EXTENDED_COMMENT       "extended-comment"
 579 /**
 580  * GST_TAG_TRACK_NUMBER:
 581  *
 582  * track number inside a collection (unsigned integer)
 583  */
 584 #define GST_TAG_TRACK_NUMBER           "track-number"
 585 /**
 586  * GST_TAG_TRACK_COUNT:
 587  *
 588  * count of tracks inside collection this track belongs to (unsigned integer)
 589  */
 590 #define GST_TAG_TRACK_COUNT            "track-count"
 591 /**
 592  * GST_TAG_ALBUM_VOLUME_NUMBER:
 593  *
 594  * disc number inside a collection (unsigned integer)
 595  */
 596 #define GST_TAG_ALBUM_VOLUME_NUMBER    "album-disc-number"
 597 /**
 598  * GST_TAG_ALBUM_VOLUME_COUNT:
 599  *
 600  * count of discs inside collection this disc belongs to (unsigned integer)
 601  */
 602 #define GST_TAG_ALBUM_VOLUME_COUNT    "album-disc-count"
 603 /**
 604  * GST_TAG_LOCATION:
 605  *
 606  * Origin of media as a URI (location, where the original of the file or stream
 607  * is hosted) (string)
 608  */
 609 #define GST_TAG_LOCATION               "location"
 610 /**
 611  * GST_TAG_HOMEPAGE:
 612  *
 613  * Homepage for this media (i.e. artist or movie homepage) (string)
 614  */
 615 #define GST_TAG_HOMEPAGE               "homepage"
 616 /**
 617  * GST_TAG_DESCRIPTION:
 618  *
 619  * short text describing the content of the data (string)
 620  */
 621 #define GST_TAG_DESCRIPTION            "description"
 622 /**
 623  * GST_TAG_VERSION:
 624  *
 625  * version of this data (string)
 626  */
 627 #define GST_TAG_VERSION                "version"
 628 /**
 629  * GST_TAG_ISRC:
 630  *
 631  * International Standard Recording Code - see http://www.ifpi.org/isrc/ (string)
 632  */
 633 #define GST_TAG_ISRC                   "isrc"
 634 /**
 635  * GST_TAG_ORGANIZATION:
 636  *
 637  * organization (string)
 638  */
 639 #define GST_TAG_ORGANIZATION           "organization"
 640 /**
 641  * GST_TAG_COPYRIGHT:
 642  *
 643  * copyright notice of the data (string)
 644  */
 645 #define GST_TAG_COPYRIGHT              "copyright"
 646 /**
 647  * GST_TAG_COPYRIGHT_URI:
 648  *
 649  * URI to location where copyright details can be found (string)
 650  */
 651 #define GST_TAG_COPYRIGHT_URI          "copyright-uri"
 652 /**
 653  * GST_TAG_ENCODED_BY:
 654  *
 655  * name of the person or organisation that encoded the file. May contain a
 656  * copyright message if the person or organisation also holds the copyright
 657  * (string)
 658  *
 659  * Note: do not use this field to describe the encoding application. Use
 660  * #GST_TAG_APPLICATION_NAME or #GST_TAG_COMMENT for that.
 661  */
 662 #define GST_TAG_ENCODED_BY             "encoded-by"
 663 /**
 664  * GST_TAG_CONTACT:
 665  *
 666  * contact information (string)
 667  */
 668 #define GST_TAG_CONTACT                "contact"
 669 /**
 670  * GST_TAG_LICENSE:
 671  *
 672  * license of data (string)
 673  */
 674 #define GST_TAG_LICENSE                "license"
 675 /**
 676  * GST_TAG_LICENSE_URI:
 677  *
 678  * URI to location where license details can be found (string)
 679  */
 680 #define GST_TAG_LICENSE_URI            "license-uri"
 681 /**
 682  * GST_TAG_PERFORMER:
 683  *
 684  * person(s) performing (string)
 685  */
 686 #define GST_TAG_PERFORMER              "performer"
 687 /**
 688  * GST_TAG_DURATION:
 689  *
 690  * length in GStreamer time units (nanoseconds) (unsigned 64-bit integer)
 691  */
 692 #define GST_TAG_DURATION               "duration"
 693 /**
 694  * GST_TAG_CODEC:
 695  *
 696  * codec the data is stored in (string)
 697  */
 698 #define GST_TAG_CODEC                  "codec"
 699 /**
 700  * GST_TAG_VIDEO_CODEC:
 701  *
 702  * codec the video data is stored in (string)
 703  */
 704 #define GST_TAG_VIDEO_CODEC            "video-codec"
 705 /**
 706  * GST_TAG_AUDIO_CODEC:
 707  *
 708  * codec the audio data is stored in (string)
 709  */
 710 #define GST_TAG_AUDIO_CODEC            "audio-codec"
 711 /**
 712  * GST_TAG_SUBTITLE_CODEC:
 713  *
 714  * codec/format the subtitle data is stored in (string)
 715  */
 716 #define GST_TAG_SUBTITLE_CODEC         "subtitle-codec"
 717 /**
 718  * GST_TAG_CONTAINER_FORMAT:
 719  *
 720  * container format the data is stored in (string)
 721  */
 722 #define GST_TAG_CONTAINER_FORMAT       "container-format"
 723 /**
 724  * GST_TAG_BITRATE:
 725  *
 726  * exact or average bitrate in bits/s (unsigned integer)
 727  */
 728 #define GST_TAG_BITRATE                "bitrate"
 729 /**
 730  * GST_TAG_NOMINAL_BITRATE:
 731  *
 732  * nominal bitrate in bits/s (unsigned integer). The actual bitrate might be
 733  * different from this target bitrate.
 734  */
 735 #define GST_TAG_NOMINAL_BITRATE        "nominal-bitrate"
 736 /**
 737  * GST_TAG_MINIMUM_BITRATE:
 738  *
 739  * minimum bitrate in bits/s (unsigned integer)
 740  */
 741 #define GST_TAG_MINIMUM_BITRATE        "minimum-bitrate"
 742 /**
 743  * GST_TAG_MAXIMUM_BITRATE:
 744  *
 745  * maximum bitrate in bits/s (unsigned integer)
 746  */
 747 #define GST_TAG_MAXIMUM_BITRATE        "maximum-bitrate"
 748 /**
 749  * GST_TAG_SERIAL:
 750  *
 751  * serial number of track (unsigned integer)
 752  */
 753 #define GST_TAG_SERIAL                 "serial"
 754 /**
 755  * GST_TAG_ENCODER:
 756  *
 757  * encoder used to encode this stream (string)
 758  */
 759 #define GST_TAG_ENCODER                "encoder"
 760 /**
 761  * GST_TAG_ENCODER_VERSION:
 762  *
 763  * version of the encoder used to encode this stream (unsigned integer)
 764  */
 765 #define GST_TAG_ENCODER_VERSION        "encoder-version"
 766 /**
 767  * GST_TAG_TRACK_GAIN:
 768  *
 769  * track gain in db (double)
 770  */
 771 #define GST_TAG_TRACK_GAIN             "replaygain-track-gain"
 772 /**
 773  * GST_TAG_TRACK_PEAK:
 774  *
 775  * peak of the track (double)
 776  */
 777 #define GST_TAG_TRACK_PEAK             "replaygain-track-peak"
 778 /**
 779  * GST_TAG_ALBUM_GAIN:
 780  *
 781  * album gain in db (double)
 782  */
 783 #define GST_TAG_ALBUM_GAIN             "replaygain-album-gain"
 784 /**
 785  * GST_TAG_ALBUM_PEAK:
 786  *
 787  * peak of the album (double)
 788  */
 789 #define GST_TAG_ALBUM_PEAK             "replaygain-album-peak"
 790 /**
 791  * GST_TAG_REFERENCE_LEVEL:
 792  *
 793  * reference level of track and album gain values (double)
 794  */
 795 #define GST_TAG_REFERENCE_LEVEL        "replaygain-reference-level"
 796 /**
 797  * GST_TAG_LANGUAGE_CODE:
 798  *
 799  * ISO-639-2 or ISO-639-1 code for the language the content is in (string)
 800  *
 801  * There is utility API in libgsttag in gst-plugins-base to obtain a translated
 802  * language name from the language code: gst_tag_get_language_name()
 803  */
 804 #define GST_TAG_LANGUAGE_CODE          "language-code"
 805 /**
 806  * GST_TAG_LANGUAGE_NAME:
 807  *
 808  * Name of the language the content is in (string)
 809  *
 810  * Free-form name of the language the content is in, if a language code
 811  * is not available. This tag should not be set in addition to a language
 812  * code. It is undefined what language or locale the language name is in.
 813  */
 814 #define GST_TAG_LANGUAGE_NAME          "language-name"
 815 /**
 816  * GST_TAG_IMAGE:
 817  *
 818  * image (sample) (sample taglist should specify the content type and preferably
 819  * also set "image-type" field as #GstTagImageType)
 820  */
 821 #define GST_TAG_IMAGE                  "image"
 822 /**
 823  * GST_TAG_PREVIEW_IMAGE:
 824  *
 825  * image that is meant for preview purposes, e.g. small icon-sized version
 826  * (sample) (sample taglist should specify the content type)
 827  */
 828 #define GST_TAG_PREVIEW_IMAGE          "preview-image"
 829
 830 /**
 831  * GST_TAG_ATTACHMENT:
 832  *
 833  * generic file attachment (sample) (sample taglist should specify the content
 834  * type and if possible set "filename" to the file name of the
 835  * attachment)
 836  */
 837 #define GST_TAG_ATTACHMENT             "attachment"
 838
 839 /**
 840  * GST_TAG_BEATS_PER_MINUTE:
 841  *
 842  * number of beats per minute in audio (double)
 843  */
 844 #define GST_TAG_BEATS_PER_MINUTE       "beats-per-minute"
 845
 846 /**
 847  * GST_TAG_KEYWORDS:
 848  *
 849  * comma separated keywords describing the content (string).
 850  */
 851 #define GST_TAG_KEYWORDS               "keywords"
 852
 853 /**
 854  * GST_TAG_GEO_LOCATION_NAME:
 855  *
 856  * human readable descriptive location of where the media has been recorded or
 857  * produced. (string).
 858  */
 859 #define GST_TAG_GEO_LOCATION_NAME               "geo-location-name"
 860
 861 /**
 862  * GST_TAG_GEO_LOCATION_LATITUDE:
 863  *
 864  * geo latitude location of where the media has been recorded or produced in
 865  * degrees according to WGS84 (zero at the equator, negative values for southern
 866  * latitudes) (double).
 867  */
 868 #define GST_TAG_GEO_LOCATION_LATITUDE               "geo-location-latitude"
 869
 870 /**
 871  * GST_TAG_GEO_LOCATION_LONGITUDE:
 872  *
 873  * geo longitude location of where the media has been recorded or produced in
 874  * degrees according to WGS84 (zero at the prime meridian in Greenwich/UK,
 875  * negative values for western longitudes). (double).
 876  */
 877 #define GST_TAG_GEO_LOCATION_LONGITUDE               "geo-location-longitude"
 878
 879 /**
 880  * GST_TAG_GEO_LOCATION_ELEVATION:
 881  *
 882  * geo elevation of where the media has been recorded or produced in meters
 883  * according to WGS84 (zero is average sea level) (double).
 884  */
 885 #define GST_TAG_GEO_LOCATION_ELEVATION               "geo-location-elevation"
 886 /**
 887  * GST_TAG_GEO_LOCATION_COUNTRY:
 888  *
 889  * The country (english name) where the media has been produced (string).
 890  */
 891 #define GST_TAG_GEO_LOCATION_COUNTRY                 "geo-location-country"
 892 /**
 893  * GST_TAG_GEO_LOCATION_CITY:
 894  *
 895  * The city (english name) where the media has been produced (string).
 896  */
 897 #define GST_TAG_GEO_LOCATION_CITY                    "geo-location-city"
 898 /**
 899  * GST_TAG_GEO_LOCATION_SUBLOCATION:
 900  *
 901  * A location 'smaller' than GST_TAG_GEO_LOCATION_CITY that specifies better
 902  * where the media has been produced. (e.g. the neighborhood) (string).
 903  *
 904  * This tag has been added as this is how it is handled/named in XMP's
 905  * Iptc4xmpcore schema.
 906  */
 907 #define GST_TAG_GEO_LOCATION_SUBLOCATION             "geo-location-sublocation"
 908 /**
 909  * GST_TAG_GEO_LOCATION_HORIZONTAL_ERROR:
 910  *
 911  * Represents the expected error on the horizontal positioning in
 912  * meters (double).
 913  */
 914 #define GST_TAG_GEO_LOCATION_HORIZONTAL_ERROR   "geo-location-horizontal-error"
 915 /**
 916  * GST_TAG_GEO_LOCATION_MOVEMENT_SPEED:
 917  *
 918  * Speed of the capturing device when performing the capture.
 919  * Represented in m/s. (double)
 920  *
 921  * See also #GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION
 922  */
 923 #define GST_TAG_GEO_LOCATION_MOVEMENT_SPEED       "geo-location-movement-speed"
 924 /**
 925  * GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION:
 926  *
 927  * Indicates the movement direction of the device performing the capture
 928  * of a media. It is represented as degrees in floating point representation,
 929  * 0 means the geographic north, and increases clockwise (double from 0 to 360)
 930  *
 931  * See also #GST_TAG_GEO_LOCATION_CAPTURE_DIRECTION
 932  */
 933 #define GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION "geo-location-movement-direction"
 934 /**
 935  * GST_TAG_GEO_LOCATION_CAPTURE_DIRECTION:
 936  *
 937  * Indicates the direction the device is pointing to when capturing
 938  * a media. It is represented as degrees in floating point representation,
 939  * 0 means the geographic north, and increases clockwise (double from 0 to 360)
 940  *
 941  * See also #GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION
 942  */
 943 #define GST_TAG_GEO_LOCATION_CAPTURE_DIRECTION  "geo-location-capture-direction"
 944 /**
 945  * GST_TAG_SHOW_NAME:
 946  *
 947  * Name of the show, used for displaying (string)
 948  */
 949 #define GST_TAG_SHOW_NAME                         "show-name"
 950 /**
 951  * GST_TAG_SHOW_SORTNAME:
 952  *
 953  * Name of the show, used for sorting (string)
 954  */
 955 #define GST_TAG_SHOW_SORTNAME                     "show-sortname"
 956 /**
 957  * GST_TAG_SHOW_EPISODE_NUMBER:
 958  *
 959  * Number of the episode within a season/show (unsigned integer)
 960  */
 961 #define GST_TAG_SHOW_EPISODE_NUMBER               "show-episode-number"
 962 /**
 963  * GST_TAG_SHOW_SEASON_NUMBER:
 964  *
 965  * Number of the season of a show/series (unsigned integer)
 966  */
 967 #define GST_TAG_SHOW_SEASON_NUMBER                "show-season-number"
 968 /**
 969  * GST_TAG_LYRICS:
 970  *
 971  * The lyrics of the media (string)
 972  */
 973 #define GST_TAG_LYRICS                            "lyrics"
 974 /**
 975  * GST_TAG_COMPOSER_SORTNAME:
 976  *
 977  * The composer's name, used for sorting (string)
 978  */
 979 #define GST_TAG_COMPOSER_SORTNAME                 "composer-sortname"
 980 /**
 981  * GST_TAG_GROUPING:
 982  *
 983  * Groups together media that are related and spans multiple tracks. An
 984  * example are multiple pieces of a concerto. (string)
 985  */
 986 #define GST_TAG_GROUPING                          "grouping"
 987 /**
 988  * GST_TAG_USER_RATING:
 989  *
 990  * Rating attributed by a person (likely the application user).
 991  * The higher the value, the more the user likes this media
 992  * (unsigned int from 0 to 100)
 993  */
 994 #define GST_TAG_USER_RATING                       "user-rating"
 995 /**
 996  * GST_TAG_DEVICE_MANUFACTURER:
 997  *
 998  * Manufacturer of the device used to create the media (string)
 999  */
1000 #define GST_TAG_DEVICE_MANUFACTURER               "device-manufacturer"
1001 /**
1002  * GST_TAG_DEVICE_MODEL:
1003  *
1004  * Model of the device used to create the media (string)
1005  */
1006 #define GST_TAG_DEVICE_MODEL                      "device-model"
1007 /**
1008  * GST_TAG_APPLICATION_NAME:
1009  *
1010  * Name of the application used to create the media (string)
1011  */
1012 #define GST_TAG_APPLICATION_NAME                  "application-name"
1013 /**
1014  * GST_TAG_APPLICATION_DATA:
1015  *
1016  * Arbitrary application data (sample)
1017  *
1018  * Some formats allow applications to add their own arbitrary data
1019  * into files. This data is application dependent.
1020  */
1021 #define GST_TAG_APPLICATION_DATA          "application-data"
1022 /**
1023  * GST_TAG_IMAGE_ORIENTATION:
1024  *
1025  * Represents the 'Orientation' tag from EXIF. Defines how the image
1026  * should be rotated and mirrored for display. (string)
1027  *
1028  * This tag has a predefined set of allowed values:
1029  *   "rotate-0"
1030  *   "rotate-90"
1031  *   "rotate-180"
1032  *   "rotate-270"
1033  *   "flip-rotate-0"
1034  *   "flip-rotate-90"
1035  *   "flip-rotate-180"
1036  *   "flip-rotate-270"
1037  *
1038  * The naming is adopted according to a possible transformation to perform
1039  * on the image to fix its orientation, obviously equivalent operations will
1040  * yield the same result.
1041  *
1042  * Rotations indicated by the values are in clockwise direction and
1043  * 'flip' means an horizontal mirroring.
1044  */
1045 #define GST_TAG_IMAGE_ORIENTATION            "image-orientation"
1046 /**
1047  * GST_TAG_PUBLISHER:
1048  *
1049  * Name of the label or publisher (string)
1050  *
1051  * Since: 1.2
1052  */
1053 #define GST_TAG_PUBLISHER                         "publisher"
1054 /**
1055  * GST_TAG_INTERPRETED_BY:
1056  *
1057  * Information about the people behind a remix and similar
1058  * interpretations of another existing piece (string)
1059  *
1060  * Since: 1.2
1061  */
1062 #define GST_TAG_INTERPRETED_BY                    "interpreted-by"
1063 /**
1064  * GST_TAG_MIDI_BASE_NOTE:
1065  *
1066  * <ulink url="http://en.wikipedia.org/wiki/Note#Note_designation_in_accordance_with_octave_name">Midi note number</ulink>
1067  * of the audio track. This is useful for sample instruments and in particular
1068  * for multi-samples.
1069  *
1070  * Since: 1.3
1071  */
1072 #define GST_TAG_MIDI_BASE_NOTE                    "midi-base-note"
1073
1074 G_END_DECLS
1075
1076 #endif /* __GST_TAGLIST_H__ */