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);
 202 GstTagList * gst_tag_list_new               (const gchar * tag, ...);
 203 GstTagList * gst_tag_list_new_valist        (va_list var_args);
 204
 205 gchar      * gst_tag_list_to_string         (const GstTagList * list);
 206 GstTagList * gst_tag_list_new_from_string   (const gchar      * str);
 207
 208 gboolean     gst_is_tag_list                (gconstpointer p);
 209 GstTagList * gst_tag_list_copy              (const GstTagList * list);
 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);
 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_long          (const GstTagList * list,
 293                                              const gchar      * tag,
 294                                              glong            * value);
 295 gboolean     gst_tag_list_get_long_index    (const GstTagList * list,
 296                                              const gchar      * tag,
 297                                              guint              index,
 298                                              glong            * value);
 299 gboolean     gst_tag_list_get_ulong         (const GstTagList * list,
 300                                              const gchar      * tag,
 301                                              gulong           * value);
 302 gboolean     gst_tag_list_get_ulong_index   (const GstTagList * list,
 303                                              const gchar      * tag,
 304                                              guint              index,
 305                                              gulong           * value);
 306 gboolean     gst_tag_list_get_int64         (const GstTagList * list,
 307                                              const gchar      * tag,
 308                                              gint64           * value);
 309 gboolean     gst_tag_list_get_int64_index   (const GstTagList * list,
 310                                              const gchar      * tag,
 311                                              guint              index,
 312                                              gint64           * value);
 313 gboolean     gst_tag_list_get_uint64        (const GstTagList * list,
 314                                              const gchar      * tag,
 315                                              guint64          * value);
 316 gboolean     gst_tag_list_get_uint64_index  (const GstTagList * list,
 317                                              const gchar      * tag,
 318                                              guint              index,
 319                                              guint64          * value);
 320 gboolean     gst_tag_list_get_float         (const GstTagList * list,
 321                                              const gchar      * tag,
 322                                              gfloat           * value);
 323 gboolean     gst_tag_list_get_float_index   (const GstTagList * list,
 324                                              const gchar      * tag,
 325                                              guint              index,
 326                                              gfloat           * value);
 327 gboolean     gst_tag_list_get_double        (const GstTagList * list,
 328                                              const gchar      * tag,
 329                                              gdouble          * value);
 330 gboolean     gst_tag_list_get_double_index  (const GstTagList * list,
 331                                              const gchar      * tag,
 332                                              guint              index,
 333                                              gdouble          * value);
 334 gboolean     gst_tag_list_get_string        (const GstTagList * list,
 335                                              const gchar      * tag,
 336                                              gchar           ** value);
 337 gboolean     gst_tag_list_get_string_index  (const GstTagList * list,
 338                                              const gchar      * tag,
 339                                              guint              index,
 340                                              gchar           ** value);
 341 gboolean     gst_tag_list_peek_string_index (const GstTagList * list,
 342                                              const gchar      * tag,
 343                                              guint              index,
 344                                              const gchar     ** value);
 345 gboolean     gst_tag_list_get_pointer       (const GstTagList * list,
 346                                              const gchar      * tag,
 347                                              gpointer         * value);
 348 gboolean     gst_tag_list_get_pointer_index (const GstTagList * list,
 349                                              const gchar      * tag,
 350                                              guint              index,
 351                                              gpointer         * value);
 352 gboolean     gst_tag_list_get_date          (const GstTagList * list,
 353                                              const gchar      * tag,
 354                                              GDate           ** value);
 355 gboolean     gst_tag_list_get_date_index    (const GstTagList * list,
 356                                              const gchar      * tag,
 357                                              guint              index,
 358                                              GDate           ** value);
 359 gboolean     gst_tag_list_get_date_time     (const GstTagList * list,
 360                                              const gchar      * tag,
 361                                              GstDateTime     ** value);
 362 gboolean     gst_tag_list_get_date_time_index (const GstTagList * list,
 363                                              const gchar      * tag,
 364                                              guint              index,
 365                                              GstDateTime     ** value);
 366 gboolean     gst_tag_list_get_buffer        (const GstTagList * list,
 367                                              const gchar      * tag,
 368                                              GstBuffer       ** value);
 369 gboolean     gst_tag_list_get_buffer_index  (const GstTagList * list,
 370                                              const gchar      * tag,
 371                                              guint              index,
 372                                              GstBuffer       ** value);
 373
 374 /* GStreamer core tags */
 375 /**
 376  * GST_TAG_TITLE:
 377  *
 378  * commonly used title (string)
 379  *
 380  * The title as it should be displayed, e.g. 'The Doll House'
 381  */
 382 #define GST_TAG_TITLE                  "title"
 383 /**
 384  * GST_TAG_TITLE_SORTNAME:
 385  *
 386  * commonly used title, as used for sorting (string)
 387  *
 388  * The title as it should be sorted, e.g. 'Doll House, The'
 389  *
 390  * Since: 0.10.15
 391  */
 392 #define GST_TAG_TITLE_SORTNAME         "title-sortname"
 393 /**
 394  * GST_TAG_ARTIST:
 395  *
 396  * person(s) responsible for the recording (string)
 397  *
 398  * The artist name as it should be displayed, e.g. 'Jimi Hendrix' or
 399  * 'The Guitar Heroes'
 400  */
 401 #define GST_TAG_ARTIST                 "artist"
 402 /**
 403  * GST_TAG_ARTIST_SORTNAME:
 404  *
 405  * person(s) responsible for the recording, as used for sorting (string)
 406  *
 407  * The artist name as it should be sorted, e.g. 'Hendrix, Jimi' or
 408  * 'Guitar Heroes, The'
 409  *
 410  * Since: 0.10.15
 411  */
 412 #define GST_TAG_ARTIST_SORTNAME        "artist-sortname"
 413 /**
 414  * GST_TAG_ALBUM:
 415  *
 416  * album containing this data (string)
 417  *
 418  * The album name as it should be displayed, e.g. 'The Jazz Guitar'
 419  */
 420 #define GST_TAG_ALBUM                  "album"
 421 /**
 422  * GST_TAG_ALBUM_SORTNAME:
 423  *
 424  * album containing this data, as used for sorting (string)
 425  *
 426  * The album name as it should be sorted, e.g. 'Jazz Guitar, The'
 427  *
 428  * Since: 0.10.15
 429  */
 430 #define GST_TAG_ALBUM_SORTNAME         "album-sortname"
 431 /**
 432  * GST_TAG_ALBUM_ARTIST:
 433  *
 434  * The artist of the entire album, as it should be displayed.
 435  *
 436  * Since: 0.10.25
 437  */
 438 #define GST_TAG_ALBUM_ARTIST           "album-artist"
 439 /**
 440  * GST_TAG_ALBUM_ARTIST_SORTNAME:
 441  *
 442  * The artist of the entire album, as it should be sorted.
 443  *
 444  * Since: 0.10.25
 445  */
 446 #define GST_TAG_ALBUM_ARTIST_SORTNAME  "album-artist-sortname"
 447 /**
 448  * GST_TAG_COMPOSER:
 449  *
 450  * person(s) who composed the recording (string)
 451  *
 452  * Since: 0.10.15
 453  */
 454 #define GST_TAG_COMPOSER               "composer"
 455 /**
 456  * GST_TAG_DATE:
 457  *
 458  * date the data was created (#GDate structure)
 459  */
 460 #define GST_TAG_DATE                   "date"
 461 /**
 462  * GST_TAG_DATE_TIME:
 463  *
 464  * date and time the data was created (#GstDateTime structure)
 465  *
 466  * Since: 0.10.31
 467  */
 468 #define GST_TAG_DATE_TIME              "datetime"
 469 /**
 470  * GST_TAG_GENRE:
 471  *
 472  * genre this data belongs to (string)
 473  */
 474 #define GST_TAG_GENRE                  "genre"
 475 /**
 476  * GST_TAG_COMMENT:
 477  *
 478  * free text commenting the data (string)
 479  */
 480 #define GST_TAG_COMMENT                "comment"
 481 /**
 482  * GST_TAG_EXTENDED_COMMENT:
 483  *
 484  * key/value text commenting the data (string)
 485  *
 486  * Must be in the form of 'key=comment' or
 487  * 'key[lc]=comment' where 'lc' is an ISO-639
 488  * language code.
 489  *
 490  * This tag is used for unknown Vorbis comment tags,
 491  * unknown APE tags and certain ID3v2 comment fields.
 492  *
 493  * Since: 0.10.10
 494  */
 495 #define GST_TAG_EXTENDED_COMMENT       "extended-comment"
 496 /**
 497  * GST_TAG_TRACK_NUMBER:
 498  *
 499  * track number inside a collection (unsigned integer)
 500  */
 501 #define GST_TAG_TRACK_NUMBER           "track-number"
 502 /**
 503  * GST_TAG_TRACK_COUNT:
 504  *
 505  * count of tracks inside collection this track belongs to (unsigned integer)
 506  */
 507 #define GST_TAG_TRACK_COUNT            "track-count"
 508 /**
 509  * GST_TAG_ALBUM_VOLUME_NUMBER:
 510  *
 511  * disc number inside a collection (unsigned integer)
 512  */
 513 #define GST_TAG_ALBUM_VOLUME_NUMBER    "album-disc-number"
 514 /**
 515  * GST_TAG_ALBUM_VOLUME_COUNT:
 516  *
 517  * count of discs inside collection this disc belongs to (unsigned integer)
 518  */
 519 #define GST_TAG_ALBUM_VOLUME_COUNT    "album-disc-count"
 520 /**
 521  * GST_TAG_LOCATION:
 522  *
 523  * Origin of media as a URI (location, where the original of the file or stream
 524  * is hosted) (string)
 525  */
 526 #define GST_TAG_LOCATION               "location"
 527 /**
 528  * GST_TAG_HOMEPAGE:
 529  *
 530  * Homepage for this media (i.e. artist or movie homepage) (string)
 531  *
 532  * Since: 0.10.23
 533  */
 534 #define GST_TAG_HOMEPAGE               "homepage"
 535 /**
 536  * GST_TAG_DESCRIPTION:
 537  *
 538  * short text describing the content of the data (string)
 539  */
 540 #define GST_TAG_DESCRIPTION            "description"
 541 /**
 542  * GST_TAG_VERSION:
 543  *
 544  * version of this data (string)
 545  */
 546 #define GST_TAG_VERSION                "version"
 547 /**
 548  * GST_TAG_ISRC:
 549  *
 550  * International Standard Recording Code - see http://www.ifpi.org/isrc/ (string)
 551  */
 552 #define GST_TAG_ISRC                   "isrc"
 553 /**
 554  * GST_TAG_ORGANIZATION:
 555  *
 556  * organization (string)
 557  */
 558 #define GST_TAG_ORGANIZATION           "organization"
 559 /**
 560  * GST_TAG_COPYRIGHT:
 561  *
 562  * copyright notice of the data (string)
 563  */
 564 #define GST_TAG_COPYRIGHT              "copyright"
 565 /**
 566  * GST_TAG_COPYRIGHT_URI:
 567  *
 568  * URI to location where copyright details can be found (string)
 569  *
 570  * Since: 0.10.14
 571  */
 572 #define GST_TAG_COPYRIGHT_URI          "copyright-uri"
 573 /**
 574  * GST_TAG_ENCODED_BY:
 575  *
 576  * name of the person or organisation that encoded the file. May contain a
 577  * copyright message if the person or organisation also holds the copyright
 578  * (string)
 579  *
 580  * Note: do not use this field to describe the encoding application. Use
 581  * #GST_TAG_APPLICATION_NAME or #GST_TAG_COMMENT for that.
 582  *
 583  * Since: 0.10.33
 584  */
 585 #define GST_TAG_ENCODED_BY             "encoded-by"
 586 /**
 587  * GST_TAG_CONTACT:
 588  *
 589  * contact information (string)
 590  */
 591 #define GST_TAG_CONTACT                "contact"
 592 /**
 593  * GST_TAG_LICENSE:
 594  *
 595  * license of data (string)
 596  */
 597 #define GST_TAG_LICENSE                "license"
 598 /**
 599  * GST_TAG_LICENSE_URI:
 600  *
 601  * URI to location where license details can be found (string)
 602  *
 603  * Since: 0.10.14
 604  */
 605 #define GST_TAG_LICENSE_URI            "license-uri"
 606 /**
 607  * GST_TAG_PERFORMER:
 608  *
 609  * person(s) performing (string)
 610  */
 611 #define GST_TAG_PERFORMER              "performer"
 612 /**
 613  * GST_TAG_DURATION:
 614  *
 615  * length in GStreamer time units (nanoseconds) (unsigned 64-bit integer)
 616  */
 617 #define GST_TAG_DURATION               "duration"
 618 /**
 619  * GST_TAG_CODEC:
 620  *
 621  * codec the data is stored in (string)
 622  */
 623 #define GST_TAG_CODEC                  "codec"
 624 /**
 625  * GST_TAG_VIDEO_CODEC:
 626  *
 627  * codec the video data is stored in (string)
 628  */
 629 #define GST_TAG_VIDEO_CODEC            "video-codec"
 630 /**
 631  * GST_TAG_AUDIO_CODEC:
 632  *
 633  * codec the audio data is stored in (string)
 634  */
 635 #define GST_TAG_AUDIO_CODEC            "audio-codec"
 636 /**
 637  * GST_TAG_SUBTITLE_CODEC:
 638  *
 639  * codec/format the subtitle data is stored in (string)
 640  *
 641  * Since: 0.10.23
 642  */
 643 #define GST_TAG_SUBTITLE_CODEC         "subtitle-codec"
 644 /**
 645  * GST_TAG_CONTAINER_FORMAT:
 646  *
 647  * container format the data is stored in (string)
 648  *
 649  * Since: 0.10.24
 650  */
 651 #define GST_TAG_CONTAINER_FORMAT       "container-format"
 652 /**
 653  * GST_TAG_BITRATE:
 654  *
 655  * exact or average bitrate in bits/s (unsigned integer)
 656  */
 657 #define GST_TAG_BITRATE                "bitrate"
 658 /**
 659  * GST_TAG_NOMINAL_BITRATE:
 660  *
 661  * nominal bitrate in bits/s (unsigned integer). The actual bitrate might be
 662  * different from this target bitrate.
 663  */
 664 #define GST_TAG_NOMINAL_BITRATE        "nominal-bitrate"
 665 /**
 666  * GST_TAG_MINIMUM_BITRATE:
 667  *
 668  * minimum bitrate in bits/s (unsigned integer)
 669  */
 670 #define GST_TAG_MINIMUM_BITRATE        "minimum-bitrate"
 671 /**
 672  * GST_TAG_MAXIMUM_BITRATE:
 673  *
 674  * maximum bitrate in bits/s (unsigned integer)
 675  */
 676 #define GST_TAG_MAXIMUM_BITRATE        "maximum-bitrate"
 677 /**
 678  * GST_TAG_SERIAL:
 679  *
 680  * serial number of track (unsigned integer)
 681  */
 682 #define GST_TAG_SERIAL                 "serial"
 683 /**
 684  * GST_TAG_ENCODER:
 685  *
 686  * encoder used to encode this stream (string)
 687  */
 688 #define GST_TAG_ENCODER                "encoder"
 689 /**
 690  * GST_TAG_ENCODER_VERSION:
 691  *
 692  * version of the encoder used to encode this stream (unsigned integer)
 693  */
 694 #define GST_TAG_ENCODER_VERSION        "encoder-version"
 695 /**
 696  * GST_TAG_TRACK_GAIN:
 697  *
 698  * track gain in db (double)
 699  */
 700 #define GST_TAG_TRACK_GAIN             "replaygain-track-gain"
 701 /**
 702  * GST_TAG_TRACK_PEAK:
 703  *
 704  * peak of the track (double)
 705  */
 706 #define GST_TAG_TRACK_PEAK             "replaygain-track-peak"
 707 /**
 708  * GST_TAG_ALBUM_GAIN:
 709  *
 710  * album gain in db (double)
 711  */
 712 #define GST_TAG_ALBUM_GAIN             "replaygain-album-gain"
 713 /**
 714  * GST_TAG_ALBUM_PEAK:
 715  *
 716  * peak of the album (double)
 717  */
 718 #define GST_TAG_ALBUM_PEAK             "replaygain-album-peak"
 719 /**
 720  * GST_TAG_REFERENCE_LEVEL:
 721  *
 722  * reference level of track and album gain values (double)
 723  *
 724  * Since: 0.10.12
 725  */
 726 #define GST_TAG_REFERENCE_LEVEL        "replaygain-reference-level"
 727 /**
 728  * GST_TAG_LANGUAGE_CODE:
 729  *
 730  * Language code (ISO-639-1) (string) of the content
 731  */
 732 #define GST_TAG_LANGUAGE_CODE          "language-code"
 733 /**
 734  * GST_TAG_IMAGE:
 735  *
 736  * image (buffer) (buffer caps should specify the content type and preferably
 737  * also set "image-type" field as #GstTagImageType)
 738  *
 739  * Since: 0.10.6
 740  */
 741 #define GST_TAG_IMAGE                  "image"
 742 /**
 743  * GST_TAG_PREVIEW_IMAGE:
 744  *
 745  * image that is meant for preview purposes, e.g. small icon-sized version
 746  * (buffer) (buffer caps should specify the content type)
 747  *
 748  * Since: 0.10.7
 749  */
 750 #define GST_TAG_PREVIEW_IMAGE          "preview-image"
 751
 752 /**
 753  * GST_TAG_ATTACHMENT:
 754  *
 755  * generic file attachment (buffer) (buffer caps should specify the content
 756  * type and if possible set "filename" to the file name of the
 757  * attachment)
 758  *
 759  * Since: 0.10.21
 760  */
 761 #define GST_TAG_ATTACHMENT             "attachment"
 762
 763 /**
 764  * GST_TAG_BEATS_PER_MINUTE:
 765  *
 766  * number of beats per minute in audio (double)
 767  *
 768  * Since: 0.10.12
 769  */
 770 #define GST_TAG_BEATS_PER_MINUTE       "beats-per-minute"
 771
 772 /**
 773  * GST_TAG_KEYWORDS:
 774  *
 775  * comma separated keywords describing the content (string).
 776  *
 777  * Since: 0.10.21
 778  */
 779 #define GST_TAG_KEYWORDS               "keywords"
 780
 781 /**
 782  * GST_TAG_GEO_LOCATION_NAME:
 783  *
 784  * human readable descriptive location of where the media has been recorded or
 785  * produced. (string).
 786  *
 787  * Since: 0.10.21
 788  */
 789 #define GST_TAG_GEO_LOCATION_NAME               "geo-location-name"
 790
 791 /**
 792  * GST_TAG_GEO_LOCATION_LATITUDE:
 793  *
 794  * geo latitude location of where the media has been recorded or produced in
 795  * degrees according to WGS84 (zero at the equator, negative values for southern
 796  * latitudes) (double).
 797  *
 798  * Since: 0.10.21
 799  */
 800 #define GST_TAG_GEO_LOCATION_LATITUDE               "geo-location-latitude"
 801
 802 /**
 803  * GST_TAG_GEO_LOCATION_LONGITUDE:
 804  *
 805  * geo longitude location of where the media has been recorded or produced in
 806  * degrees according to WGS84 (zero at the prime meridian in Greenwich/UK,
 807  * negative values for western longitudes). (double).
 808  *
 809  * Since: 0.10.21
 810  */
 811 #define GST_TAG_GEO_LOCATION_LONGITUDE               "geo-location-longitude"
 812
 813 /**
 814  * GST_TAG_GEO_LOCATION_ELEVATION:
 815  *
 816  * geo elevation of where the media has been recorded or produced in meters
 817  * according to WGS84 (zero is average sea level) (double).
 818  *
 819  * Since: 0.10.21
 820  */
 821 #define GST_TAG_GEO_LOCATION_ELEVATION               "geo-location-elevation"
 822 /**
 823  * GST_TAG_GEO_LOCATION_COUNTRY:
 824  *
 825  * The country (english name) where the media has been produced (string).
 826  *
 827  * Since: 0.10.29
 828  */
 829 #define GST_TAG_GEO_LOCATION_COUNTRY                 "geo-location-country"
 830 /**
 831  * GST_TAG_GEO_LOCATION_CITY:
 832  *
 833  * The city (english name) where the media has been produced (string).
 834  *
 835  * Since: 0.10.29
 836  */
 837 #define GST_TAG_GEO_LOCATION_CITY                    "geo-location-city"
 838 /**
 839  * GST_TAG_GEO_LOCATION_SUBLOCATION:
 840  *
 841  * A location 'smaller' than GST_TAG_GEO_LOCATION_CITY that specifies better
 842  * where the media has been produced. (e.g. the neighborhood) (string).
 843  *
 844  * This tag has been added as this is how it is handled/named in XMP's
 845  * Iptc4xmpcore schema.
 846  *
 847  * Since: 0.10.29
 848  */
 849 #define GST_TAG_GEO_LOCATION_SUBLOCATION             "geo-location-sublocation"
 850 /**
 851  * GST_TAG_GEO_LOCATION_HORIZONTAL_ERROR:
 852  *
 853  * Represents the expected error on the horizontal positioning in
 854  * meters (double).
 855  *
 856  * Since: 0.10.31
 857  */
 858 #define GST_TAG_GEO_LOCATION_HORIZONTAL_ERROR   "geo-location-horizontal-error"
 859 /**
 860  * GST_TAG_GEO_LOCATION_MOVEMENT_SPEED:
 861  *
 862  * Speed of the capturing device when performing the capture.
 863  * Represented in m/s. (double)
 864  *
 865  * See also #GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION
 866  *
 867  * Since 0.10.30
 868  */
 869 #define GST_TAG_GEO_LOCATION_MOVEMENT_SPEED       "geo-location-movement-speed"
 870 /**
 871  * GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION:
 872  *
 873  * Indicates the movement direction of the device performing the capture
 874  * of a media. It is represented as degrees in floating point representation,
 875  * 0 means the geographic north, and increases clockwise (double from 0 to 360)
 876  *
 877  * See also #GST_TAG_GEO_LOCATION_CAPTURE_DIRECTION
 878  *
 879  * Since: 0.10.30
 880  */
 881 #define GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION "geo-location-movement-direction"
 882 /**
 883  * GST_TAG_GEO_LOCATION_CAPTURE_DIRECTION:
 884  *
 885  * Indicates the direction the device is pointing to when capturing
 886  * a media. It is represented as degrees in floating point representation,
 887  * 0 means the geographic north, and increases clockwise (double from 0 to 360)
 888  *
 889  * See also #GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION
 890  *
 891  * Since: 0.10.30
 892  */
 893 #define GST_TAG_GEO_LOCATION_CAPTURE_DIRECTION  "geo-location-capture-direction"
 894 /**
 895  * GST_TAG_SHOW_NAME:
 896  *
 897  * Name of the show, used for displaying (string)
 898  *
 899  * Since: 0.10.26
 900  */
 901 #define GST_TAG_SHOW_NAME                         "show-name"
 902 /**
 903  * GST_TAG_SHOW_SORTNAME:
 904  *
 905  * Name of the show, used for sorting (string)
 906  *
 907  * Since: 0.10.26
 908  */
 909 #define GST_TAG_SHOW_SORTNAME                     "show-sortname"
 910 /**
 911  * GST_TAG_SHOW_EPISODE_NUMBER:
 912  *
 913  * Number of the episode within a season/show (unsigned integer)
 914  *
 915  * Since: 0.10.26
 916  */
 917 #define GST_TAG_SHOW_EPISODE_NUMBER               "show-episode-number"
 918 /**
 919  * GST_TAG_SHOW_SEASON_NUMBER:
 920  *
 921  * Number of the season of a show/series (unsigned integer)
 922  *
 923  * Since: 0.10.26
 924  */
 925 #define GST_TAG_SHOW_SEASON_NUMBER                "show-season-number"
 926 /**
 927  * GST_TAG_LYRICS:
 928  *
 929  * The lyrics of the media (string)
 930  *
 931  * Since: 0.10.26
 932  */
 933 #define GST_TAG_LYRICS                            "lyrics"
 934 /**
 935  * GST_TAG_COMPOSER_SORTNAME:
 936  *
 937  * The composer's name, used for sorting (string)
 938  *
 939  * Since: 0.10.26
 940  */
 941 #define GST_TAG_COMPOSER_SORTNAME                 "composer-sortname"
 942 /**
 943  * GST_TAG_GROUPING:
 944  *
 945  * Groups together media that are related and spans multiple tracks. An
 946  * example are multiple pieces of a concerto. (string)
 947  *
 948  * Since: 0.10.26
 949  */
 950 #define GST_TAG_GROUPING                          "grouping"
 951 /**
 952  * GST_TAG_USER_RATING:
 953  *
 954  * Rating attributed by a person (likely the application user).
 955  * The higher the value, the more the user likes this media
 956  * (unsigned int from 0 to 100)
 957  *
 958  * Since: 0.10.29
 959  */
 960 #define GST_TAG_USER_RATING                       "user-rating"
 961 /**
 962  * GST_TAG_DEVICE_MANUFACTURER:
 963  *
 964  * Manufacturer of the device used to create the media (string)
 965  *
 966  * Since: 0.10.30
 967  */
 968 #define GST_TAG_DEVICE_MANUFACTURER               "device-manufacturer"
 969 /**
 970  * GST_TAG_DEVICE_MODEL:
 971  *
 972  * Model of the device used to create the media (string)
 973  *
 974  * Since: 0.10.30
 975  */
 976 #define GST_TAG_DEVICE_MODEL                      "device-model"
 977 /**
 978  * GST_TAG_APPLICATION_NAME:
 979  *
 980  * Name of the application used to create the media (string)
 981  *
 982  * Since: 0.10.31
 983  */
 984 #define GST_TAG_APPLICATION_NAME                  "application-name"
 985 /**
 986  * GST_TAG_APPLICATION_DATA:
 987  *
 988  * Arbitrary application data (buffer)
 989  *
 990  * Some formats allow application's to add their own arbitrary data
 991  * into files. This data is application's dependent.
 992  *
 993  * Since: 0.10.31
 994  */
 995 #define GST_TAG_APPLICATION_DATA          "application-data"
 996 /**
 997  * GST_TAG_IMAGE_ORIENTATION:
 998  *
 999  * Represents the 'Orientation' tag from EXIF. Defines how the image
1000  * should be rotated and mirrored for display. (string)
1001  *
1002  * This tag has a predefined set of allowed values:
1003  *   "rotate-0"
1004  *   "rotate-90"
1005  *   "rotate-180"
1006  *   "rotate-270"
1007  *   "flip-rotate-0"
1008  *   "flip-rotate-90"
1009  *   "flip-rotate-180"
1010  *   "flip-rotate-270"
1011  *
1012  * The naming is adopted according to a possible transformation to perform
1013  * on the image to fix its orientation, obviously equivalent operations will
1014  * yield the same result.
1015  *
1016  * Rotations indicated by the values are in clockwise direction and
1017  * 'flip' means an horizontal mirroring.
1018  *
1019  * Since: 0.10.30
1020  */
1021 #define GST_TAG_IMAGE_ORIENTATION            "image-orientation"
1022
1023 G_END_DECLS
1024
1025 #endif /* __GST_TAGLIST_H__ */