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