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