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