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