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