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