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