taglist: add gst_tag_list_peek_string_index to avoid a copy
[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/gstbuffer.h>
27 #include <gst/gststructure.h>
28 #include <gst/glib-compat.h>
29
30 G_BEGIN_DECLS
31
32 /**
33  * GstTagMergeMode:
34  * @GST_TAG_MERGE_UNDEFINED: undefined merge mode
35  * @GST_TAG_MERGE_REPLACE_ALL: replace all tags (clear list and append)
36  * @GST_TAG_MERGE_REPLACE: replace tags
37  * @GST_TAG_MERGE_APPEND: append tags
38  * @GST_TAG_MERGE_PREPEND: prepend tags
39  * @GST_TAG_MERGE_KEEP: keep existing tags
40  * @GST_TAG_MERGE_KEEP_ALL: keep all existing tags
41  * @GST_TAG_MERGE_COUNT: the number of merge modes
42  *
43  * The different tag merging modes are basically replace, overwrite and append,
44  * but they can be seen from two directions. Given two taglists: (A) the tags
45  * already in the element and (B) the ones that are supplied to the element (
46  * e.g. via gst_tag_setter_merge_tags() / gst_tag_setter_add_tags() or a
47  * %GST_EVENT_TAG), how are these tags merged?
48  * In the table below this is shown for the cases that a tag exists in the list
49  * (A) or does not exists (!A) and combinations thereof.
50  *
51  * <table frame="all" colsep="1" rowsep="1">
52  *   <title>merge mode</title>
53  *   <tgroup cols='5' align='left'>
54  *     <thead>
55  *       <row>
56  *         <entry>merge mode</entry>
57  *         <entry>A + B</entry>
58  *         <entry>A + !B</entry>
59  *         <entry>!A + B</entry>
60  *         <entry>!A + !B</entry>
61  *       </row>
62  *     </thead>
63  *     <tbody>
64  *       <row>
65  *         <entry>REPLACE_ALL</entry>
66  *         <entry>B</entry>
67  *         <entry>-</entry>
68  *         <entry>B</entry>
69  *         <entry>-</entry>
70  *       </row>
71  *       <row>
72  *         <entry>REPLACE</entry>
73  *         <entry>B</entry>
74  *         <entry>A</entry>
75  *         <entry>B</entry>
76  *         <entry>-</entry>
77  *       </row>
78  *       <row>
79  *         <entry>APPEND</entry>
80  *         <entry>A, B</entry>
81  *         <entry>A</entry>
82  *         <entry>B</entry>
83  *         <entry>-</entry>
84  *       </row>
85  *       <row>
86  *         <entry>PREPEND</entry>
87  *         <entry>B, A</entry>
88  *         <entry>A</entry>
89  *         <entry>B</entry>
90  *         <entry>-</entry>
91  *       </row>
92  *       <row>
93  *         <entry>KEEP</entry>
94  *         <entry>A</entry>
95  *         <entry>A</entry>
96  *         <entry>B</entry>
97  *         <entry>-</entry>
98  *       </row>
99  *       <row>
100  *         <entry>KEEP_ALL</entry>
101  *         <entry>A</entry>
102  *         <entry>A</entry>
103  *         <entry>-</entry>
104  *         <entry>-</entry>
105  *       </row>
106  *     </tbody>
107  *   </tgroup>
108  * </table>
109  */
110 typedef enum {
111   GST_TAG_MERGE_UNDEFINED,
112   GST_TAG_MERGE_REPLACE_ALL,
113   GST_TAG_MERGE_REPLACE,
114   GST_TAG_MERGE_APPEND,
115   GST_TAG_MERGE_PREPEND,
116   GST_TAG_MERGE_KEEP,
117   GST_TAG_MERGE_KEEP_ALL,
118   /* add more */
119   GST_TAG_MERGE_COUNT
120 } GstTagMergeMode;
121
122 #define GST_TAG_MODE_IS_VALID(mode)     (((mode) > GST_TAG_MERGE_UNDEFINED) && ((mode) < GST_TAG_MERGE_COUNT))
123
124 /**
125  * GstTagFlag:
126  * @GST_TAG_FLAG_UNDEFINED: undefined flag
127  * @GST_TAG_FLAG_META: tag is meta data
128  * @GST_TAG_FLAG_ENCODED: tag is encoded
129  * @GST_TAG_FLAG_DECODED: tag is decoded
130  * @GST_TAG_FLAG_COUNT: number of tag flags
131  *
132  * Extra tag flags used when registering tags.
133  */
134 typedef enum {
135   GST_TAG_FLAG_UNDEFINED,
136   GST_TAG_FLAG_META,
137   GST_TAG_FLAG_ENCODED,
138   GST_TAG_FLAG_DECODED,
139   GST_TAG_FLAG_COUNT
140 } GstTagFlag;
141
142 #define GST_TAG_FLAG_IS_VALID(flag)     (((flag) > GST_TAG_FLAG_UNDEFINED) && ((flag) < GST_TAG_FLAG_COUNT))
143
144 /* FIXME 0.11: Don't typedef GstTagList to be a GstStructure, they're
145  *             internally the same but not from an API point of view.
146  *             See bug #518934.
147  */
148 /**
149  * GstTagList:
150  *
151  * Opaque #GstTagList data structure.
152  */
153 #ifdef _FOOL_GTK_DOC_
154 typedef struct _GstTagList GstTagList;
155 #else
156 #ifdef IN_GOBJECT_INTROSPECTION
157 typedef struct _GstTagList GstTagList;
158 #else
159 typedef GstStructure GstTagList;
160 #endif
161 #endif
162
163 #define GST_TAG_LIST(x)       ((GstTagList *) (x))
164 #define GST_IS_TAG_LIST(x)    ((x) != NULL && gst_is_tag_list (GST_TAG_LIST (x)))
165 #define GST_TYPE_TAG_LIST     (gst_tag_list_get_type ())
166
167 /**
168  * GstTagForeachFunc:
169  * @list: the #GstTagList
170  * @tag: a name of a tag in @list
171  * @user_data: user data
172  *
173  * A function that will be called in gst_tag_list_foreach(). The function may
174  * not modify the tag list.
175  */
176 typedef void (*GstTagForeachFunc) (const GstTagList * list,
177                                    const gchar      * tag,
178                                    gpointer           user_data);
179
180 /**
181  * GstTagMergeFunc:
182  * @dest: the destination #GValue
183  * @src: the source #GValue
184  *
185  * A function for merging multiple values of a tag used when registering
186  * tags.
187  */
188 typedef void (* GstTagMergeFunc) (GValue *dest, const GValue *src);
189
190 GType        gst_tag_list_get_type (void);
191
192 /* tag registration */
193 void         gst_tag_register      (const gchar     * name,
194                                     GstTagFlag        flag,
195                                     GType             type,
196                                     const gchar     * nick,
197                                     const gchar     * blurb,
198                                     GstTagMergeFunc   func);
199
200 /* some default merging functions */
201 void      gst_tag_merge_use_first          (GValue * dest, const GValue * src);
202 void      gst_tag_merge_strings_with_comma (GValue * dest, const GValue * src);
203
204 /* basic tag support */
205 gboolean               gst_tag_exists          (const gchar * tag);
206 GType                  gst_tag_get_type        (const gchar * tag);
207 G_CONST_RETURN gchar * gst_tag_get_nick        (const gchar * tag);
208 G_CONST_RETURN gchar * gst_tag_get_description (const gchar * tag);
209 GstTagFlag             gst_tag_get_flag        (const gchar * tag);
210 gboolean               gst_tag_is_fixed        (const gchar * tag);
211
212 /* tag lists */
213 GstTagList * gst_tag_list_new               (void);
214 GstTagList * gst_tag_list_new_full          (const gchar * tag, ...);
215 GstTagList * gst_tag_list_new_full_valist   (va_list var_args);
216
217 gboolean     gst_is_tag_list                (gconstpointer p);
218 GstTagList * gst_tag_list_copy              (const GstTagList * list);
219 gboolean     gst_tag_list_is_empty          (const GstTagList * list);
220 void         gst_tag_list_insert            (GstTagList       * into,
221                                              const GstTagList * from,
222                                              GstTagMergeMode    mode);
223 GstTagList * gst_tag_list_merge             (const GstTagList * list1,
224                                              const GstTagList * list2,
225                                              GstTagMergeMode    mode);
226 void         gst_tag_list_free              (GstTagList       * list);
227 guint        gst_tag_list_get_tag_size      (const GstTagList * list,
228                                              const gchar      * tag);
229 void         gst_tag_list_add               (GstTagList       * list,
230                                              GstTagMergeMode    mode,
231                                              const gchar      * tag,
232                                              ...) G_GNUC_NULL_TERMINATED;
233 void         gst_tag_list_add_values        (GstTagList       * list,
234                                              GstTagMergeMode    mode,
235                                              const gchar      * tag,
236                                              ...) G_GNUC_NULL_TERMINATED;
237 void         gst_tag_list_add_valist        (GstTagList       * list,
238                                              GstTagMergeMode    mode,
239                                              const gchar      * tag,
240                                              va_list        var_args);
241 void         gst_tag_list_add_valist_values (GstTagList       * list,
242                                              GstTagMergeMode    mode,
243                                              const gchar      * tag,
244                                              va_list            var_args);
245 void         gst_tag_list_add_value         (GstTagList       * list,
246                                              GstTagMergeMode    mode,
247                                              const gchar      * tag,
248                                              const GValue     * value);
249 void         gst_tag_list_remove_tag        (GstTagList       * list,
250                                              const gchar      * tag);
251 void         gst_tag_list_foreach           (const GstTagList * list,
252                                              GstTagForeachFunc  func,
253                                              gpointer           user_data);
254
255 G_CONST_RETURN GValue *
256              gst_tag_list_get_value_index   (const GstTagList * list,
257                                              const gchar      * tag,
258                                              guint              index);
259 gboolean     gst_tag_list_copy_value        (GValue           * dest,
260                                              const GstTagList * list,
261                                              const gchar      * tag);
262
263 /* simplifications (FIXME: do we want them?) */
264 gboolean     gst_tag_list_get_char          (const GstTagList * list,
265                                              const gchar      * tag,
266                                              gchar            * value);
267 gboolean     gst_tag_list_get_char_index    (const GstTagList * list,
268                                              const gchar      * tag,
269                                              guint              index,
270                                              gchar            * value);
271 gboolean     gst_tag_list_get_uchar         (const GstTagList * list,
272                                              const gchar      * tag,
273                                              guchar           * value);
274 gboolean     gst_tag_list_get_uchar_index   (const GstTagList * list,
275                                              const gchar      * tag,
276                                              guint              index,
277                                              guchar           * value);
278 gboolean     gst_tag_list_get_boolean       (const GstTagList * list,
279                                              const gchar      * tag,
280                                              gboolean         * value);
281 gboolean     gst_tag_list_get_boolean_index (const GstTagList * list,
282                                              const gchar      * tag,
283                                              guint              index,
284                                              gboolean         * value);
285 gboolean     gst_tag_list_get_int           (const GstTagList * list,
286                                              const gchar      * tag,
287                                              gint             * value);
288 gboolean     gst_tag_list_get_int_index     (const GstTagList * list,
289                                              const gchar      * tag,
290                                              guint              index,
291                                              gint             * value);
292 gboolean     gst_tag_list_get_uint          (const GstTagList * list,
293                                              const gchar      * tag,
294                                              guint            * value);
295 gboolean     gst_tag_list_get_uint_index    (const GstTagList * list,
296                                              const gchar      * tag,
297                                              guint              index,
298                                              guint            * value);
299 gboolean     gst_tag_list_get_long          (const GstTagList * list,
300                                              const gchar      * tag,
301                                              glong            * value);
302 gboolean     gst_tag_list_get_long_index    (const GstTagList * list,
303                                              const gchar      * tag,
304                                              guint              index,
305                                              glong            * value);
306 gboolean     gst_tag_list_get_ulong         (const GstTagList * list,
307                                              const gchar      * tag,
308                                              gulong           * value);
309 gboolean     gst_tag_list_get_ulong_index   (const GstTagList * list,
310                                              const gchar      * tag,
311                                              guint              index,
312                                              gulong           * value);
313 gboolean     gst_tag_list_get_int64         (const GstTagList * list,
314                                              const gchar      * tag,
315                                              gint64           * value);
316 gboolean     gst_tag_list_get_int64_index   (const GstTagList * list,
317                                              const gchar      * tag,
318                                              guint              index,
319                                              gint64           * value);
320 gboolean     gst_tag_list_get_uint64        (const GstTagList * list,
321                                              const gchar      * tag,
322                                              guint64          * value);
323 gboolean     gst_tag_list_get_uint64_index  (const GstTagList * list,
324                                              const gchar      * tag,
325                                              guint              index,
326                                              guint64          * value);
327 gboolean     gst_tag_list_get_float         (const GstTagList * list,
328                                              const gchar      * tag,
329                                              gfloat           * value);
330 gboolean     gst_tag_list_get_float_index   (const GstTagList * list,
331                                              const gchar      * tag,
332                                              guint              index,
333                                              gfloat           * value);
334 gboolean     gst_tag_list_get_double        (const GstTagList * list,
335                                              const gchar      * tag,
336                                              gdouble          * value);
337 gboolean     gst_tag_list_get_double_index  (const GstTagList * list,
338                                              const gchar      * tag,
339                                              guint              index,
340                                              gdouble          * value);
341 gboolean     gst_tag_list_get_string        (const GstTagList * list,
342                                              const gchar      * tag,
343                                              gchar           ** value);
344 gboolean     gst_tag_list_get_string_index  (const GstTagList * list,
345                                              const gchar      * tag,
346                                              guint              index,
347                                              gchar           ** value);
348 gboolean     gst_tag_list_peek_string_index (const GstTagList * list,
349                                              const gchar      * tag,
350                                              guint              index,
351                                              const gchar     ** value);
352 gboolean     gst_tag_list_get_pointer       (const GstTagList * list,
353                                              const gchar      * tag,
354                                              gpointer         * value);
355 gboolean     gst_tag_list_get_pointer_index (const GstTagList * list,
356                                              const gchar      * tag,
357                                              guint              index,
358                                              gpointer         * value);
359 gboolean     gst_tag_list_get_date          (const GstTagList * list,
360                                              const gchar      * tag,
361                                              GDate           ** value);
362 gboolean     gst_tag_list_get_date_index    (const GstTagList * list,
363                                              const gchar      * tag,
364                                              guint              index,
365                                              GDate           ** value);
366 gboolean     gst_tag_list_get_buffer        (const GstTagList * list,
367                                              const gchar      * tag,
368                                              GstBuffer       ** value);
369 gboolean     gst_tag_list_get_buffer_index  (const GstTagList * list,
370                                              const gchar      * tag,
371                                              guint              index,
372                                              GstBuffer       ** value);
373
374 /* GStreamer core tags */
375 /**
376  * GST_TAG_TITLE:
377  *
378  * commonly used title (string)
379  *
380  * The title as it should be displayed, e.g. 'The Doll House'
381  */
382 #define GST_TAG_TITLE                  "title"
383 /**
384  * GST_TAG_TITLE_SORTNAME:
385  *
386  * commonly used title, as used for sorting (string)
387  *
388  * The title as it should be sorted, e.g. 'Doll House, The'
389  *
390  * Since: 0.10.15
391  */
392 #define GST_TAG_TITLE_SORTNAME         "title-sortname"
393 /**
394  * GST_TAG_ARTIST:
395  *
396  * person(s) responsible for the recording (string)
397  *
398  * The artist name as it should be displayed, e.g. 'Jimi Hendrix' or
399  * 'The Guitar Heroes'
400  */
401 #define GST_TAG_ARTIST                 "artist"
402 /**
403  * GST_TAG_ARTIST_SORTNAME:
404  *
405  * person(s) responsible for the recording, as used for sorting (string)
406  *
407  * The artist name as it should be sorted, e.g. 'Hendrix, Jimi' or
408  * 'Guitar Heroes, The'
409  *
410  * Since: 0.10.15
411  */
412 /* FIXME 0.11: change to "artist-sortname" */
413 #define GST_TAG_ARTIST_SORTNAME        "musicbrainz-sortname"
414 /**
415  * GST_TAG_ALBUM:
416  *
417  * album containing this data (string)
418  *
419  * The album name as it should be displayed, e.g. 'The Jazz Guitar'
420  */
421 #define GST_TAG_ALBUM                  "album"
422 /**
423  * GST_TAG_ALBUM_SORTNAME:
424  *
425  * album containing this data, as used for sorting (string)
426  *
427  * The album name as it should be sorted, e.g. 'Jazz Guitar, The'
428  *
429  * Since: 0.10.15
430  */
431 #define GST_TAG_ALBUM_SORTNAME         "album-sortname"
432 /**
433  * GST_TAG_ALBUM_ARTIST:
434  *
435  * The artist of the entire album, as it should be displayed.
436  *
437  * Since: 0.10.25
438  */
439 #define GST_TAG_ALBUM_ARTIST           "album-artist"
440 /**
441  * GST_TAG_ALBUM_ARTIST_SORTNAME:
442  *
443  * The artist of the entire album, as it should be sorted.
444  *
445  * Since: 0.10.25
446  */
447 #define GST_TAG_ALBUM_ARTIST_SORTNAME  "album-artist-sortname"
448 /**
449  * GST_TAG_COMPOSER:
450  *
451  * person(s) who composed the recording (string)
452  *
453  * Since: 0.10.15
454  */
455 #define GST_TAG_COMPOSER               "composer"
456 /**
457  * GST_TAG_DATE:
458  *
459  * date the data was created (#GDate structure)
460  */
461 #define GST_TAG_DATE                   "date"
462 /**
463  * GST_TAG_GENRE:
464  *
465  * genre this data belongs to (string)
466  */
467 #define GST_TAG_GENRE                  "genre"
468 /**
469  * GST_TAG_COMMENT:
470  *
471  * free text commenting the data (string)
472  */
473 #define GST_TAG_COMMENT                "comment"
474 /**
475  * GST_TAG_EXTENDED_COMMENT:
476  *
477  * key/value text commenting the data (string)
478  *
479  * Must be in the form of 'key=comment' or
480  * 'key[lc]=comment' where 'lc' is an ISO-639
481  * language code.
482  *
483  * This tag is used for unknown Vorbis comment tags,
484  * unknown APE tags and certain ID3v2 comment fields.
485  *
486  * Since: 0.10.10
487  */
488 #define GST_TAG_EXTENDED_COMMENT       "extended-comment"
489 /**
490  * GST_TAG_TRACK_NUMBER:
491  *
492  * track number inside a collection (unsigned integer)
493  */
494 #define GST_TAG_TRACK_NUMBER           "track-number"
495 /**
496  * GST_TAG_TRACK_COUNT:
497  *
498  * count of tracks inside collection this track belongs to (unsigned integer)
499  */
500 #define GST_TAG_TRACK_COUNT            "track-count"
501 /**
502  * GST_TAG_ALBUM_VOLUME_NUMBER:
503  *
504  * disc number inside a collection (unsigned integer)
505  */
506 #define GST_TAG_ALBUM_VOLUME_NUMBER    "album-disc-number"
507 /**
508  * GST_TAG_ALBUM_VOLUME_COUNT:
509  *
510  * count of discs inside collection this disc belongs to (unsigned integer)
511  */
512 #define GST_TAG_ALBUM_VOLUME_COUNT    "album-disc-count"
513 /**
514  * GST_TAG_LOCATION:
515  *
516  * Origin of media as a URI (location, where the original of the file or stream
517  * is hosted) (string)
518  */
519 #define GST_TAG_LOCATION               "location"
520 /**
521  * GST_TAG_HOMEPAGE:
522  *
523  * Homepage for this media (i.e. artist or movie homepage) (string)
524  *
525  * Since: 0.10.23
526  */
527 #define GST_TAG_HOMEPAGE               "homepage"
528 /**
529  * GST_TAG_DESCRIPTION:
530  *
531  * short text describing the content of the data (string)
532  */
533 #define GST_TAG_DESCRIPTION            "description"
534 /**
535  * GST_TAG_VERSION:
536  *
537  * version of this data (string)
538  */
539 #define GST_TAG_VERSION                "version"
540 /**
541  * GST_TAG_ISRC:
542  *
543  * International Standard Recording Code - see http://www.ifpi.org/isrc/ (string)
544  */
545 #define GST_TAG_ISRC                   "isrc"
546 /**
547  * GST_TAG_ORGANIZATION:
548  *
549  * organization (string)
550  */
551 #define GST_TAG_ORGANIZATION           "organization"
552 /**
553  * GST_TAG_COPYRIGHT:
554  *
555  * copyright notice of the data (string)
556  */
557 #define GST_TAG_COPYRIGHT              "copyright"
558 /**
559  * GST_TAG_COPYRIGHT_URI:
560  *
561  * URI to location where copyright details can be found (string)
562  *
563  * Since: 0.10.14
564  */
565 #define GST_TAG_COPYRIGHT_URI          "copyright-uri"
566 /**
567  * GST_TAG_CONTACT:
568  *
569  * contact information (string)
570  */
571 #define GST_TAG_CONTACT                "contact"
572 /**
573  * GST_TAG_LICENSE:
574  *
575  * license of data (string)
576  */
577 #define GST_TAG_LICENSE                "license"
578 /**
579  * GST_TAG_LICENSE_URI:
580  *
581  * URI to location where license details can be found (string)
582  *
583  * Since: 0.10.14
584  */
585 #define GST_TAG_LICENSE_URI            "license-uri"
586 /**
587  * GST_TAG_PERFORMER:
588  *
589  * person(s) performing (string)
590  */
591 #define GST_TAG_PERFORMER              "performer"
592 /**
593  * GST_TAG_DURATION:
594  *
595  * length in GStreamer time units (nanoseconds) (unsigned 64-bit integer)
596  */
597 #define GST_TAG_DURATION               "duration"
598 /**
599  * GST_TAG_CODEC:
600  *
601  * codec the data is stored in (string)
602  */
603 #define GST_TAG_CODEC                  "codec"
604 /**
605  * GST_TAG_VIDEO_CODEC:
606  *
607  * codec the video data is stored in (string)
608  */
609 #define GST_TAG_VIDEO_CODEC            "video-codec"
610 /**
611  * GST_TAG_AUDIO_CODEC:
612  *
613  * codec the audio data is stored in (string)
614  */
615 #define GST_TAG_AUDIO_CODEC            "audio-codec"
616 /**
617  * GST_TAG_SUBTITLE_CODEC:
618  *
619  * codec/format the subtitle data is stored in (string)
620  *
621  * Since: 0.10.23
622  */
623 #define GST_TAG_SUBTITLE_CODEC         "subtitle-codec"
624 /**
625  * GST_TAG_CONTAINER_FORMAT:
626  *
627  * container format the data is stored in (string)
628  *
629  * Since: 0.10.24
630  */
631 #define GST_TAG_CONTAINER_FORMAT       "container-format"
632 /**
633  * GST_TAG_BITRATE:
634  *
635  * exact or average bitrate in bits/s (unsigned integer)
636  */
637 #define GST_TAG_BITRATE                "bitrate"
638 /**
639  * GST_TAG_NOMINAL_BITRATE:
640  *
641  * nominal bitrate in bits/s (unsigned integer)
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  * Language code (ISO-639-1) (string) of the content
710  */
711 #define GST_TAG_LANGUAGE_CODE          "language-code"
712 /**
713  * GST_TAG_IMAGE:
714  *
715  * image (buffer) (buffer caps should specify the content type and preferably
716  * also set "image-type" field as #GstTagImageType)
717  *
718  * Since: 0.10.6
719  */
720 #define GST_TAG_IMAGE                  "image"
721 /**
722  * GST_TAG_PREVIEW_IMAGE:
723  *
724  * image that is meant for preview purposes, e.g. small icon-sized version
725  * (buffer) (buffer caps should specify the content type)
726  *
727  * Since: 0.10.7
728  */
729 #define GST_TAG_PREVIEW_IMAGE          "preview-image"
730
731 /**
732  * GST_TAG_ATTACHMENT:
733  *
734  * generic file attachment (buffer) (buffer caps should specify the content
735  * type and if possible set "filename" to the file name of the
736  * attachment)
737  *
738  * Since: 0.10.21
739  */
740 #define GST_TAG_ATTACHMENT             "attachment"
741
742 /**
743  * GST_TAG_BEATS_PER_MINUTE:
744  *
745  * number of beats per minute in audio (double)
746  *
747  * Since: 0.10.12
748  */
749 #define GST_TAG_BEATS_PER_MINUTE       "beats-per-minute"
750
751 /**
752  * GST_TAG_KEYWORDS:
753  *
754  * comma separated keywords describing the content (string).
755  *
756  * Since: 0.10.21
757  */
758 #define GST_TAG_KEYWORDS               "keywords"
759
760 /**
761  * GST_TAG_GEO_LOCATION_NAME:
762  *
763  * human readable descriptive location of where the media has been recorded or
764  * produced. (string).
765  *
766  * Since: 0.10.21
767  */
768 #define GST_TAG_GEO_LOCATION_NAME               "geo-location-name"
769
770 /**
771  * GST_TAG_GEO_LOCATION_LATITUDE:
772  *
773  * geo latitude location of where the media has been recorded or produced in
774  * degrees according to WGS84 (zero at the equator, negative values for southern
775  * latitudes) (double).
776  *
777  * Since: 0.10.21
778  */
779 #define GST_TAG_GEO_LOCATION_LATITUDE               "geo-location-latitude"
780
781 /**
782  * GST_TAG_GEO_LOCATION_LONGITUDE:
783  *
784  * geo longitude location of where the media has been recorded or produced in
785  * degrees according to WGS84 (zero at the prime meridian in Greenwich/UK,
786  * negative values for western longitudes). (double).
787  *
788  * Since: 0.10.21
789  */
790 #define GST_TAG_GEO_LOCATION_LONGITUDE               "geo-location-longitude"
791
792 /**
793  * GST_TAG_GEO_LOCATION_ELEVATION:
794  *
795  * geo elevation of where the media has been recorded or produced in meters
796  * according to WGS84 (zero is average sea level) (double).
797  *
798  * Since: 0.10.21
799  */
800 #define GST_TAG_GEO_LOCATION_ELEVATION               "geo-location-elevation"
801 /**
802  * GST_TAG_GEO_LOCATION_COUNTRY:
803  *
804  * The country (english name) where the media has been produced (string).
805  *
806  * Since: 0.10.29
807  */
808 #define GST_TAG_GEO_LOCATION_COUNTRY                 "geo-location-country"
809 /**
810  * GST_TAG_GEO_LOCATION_CITY:
811  *
812  * The city (english name) where the media has been produced (string).
813  *
814  * Since: 0.10.29
815  */
816 #define GST_TAG_GEO_LOCATION_CITY                    "geo-location-city"
817 /**
818  * GST_TAG_GEO_LOCATION_SUBLOCATION:
819  *
820  * A location 'smaller' than GST_TAG_GEO_LOCATION_CITY that specifies better
821  * where the media has been produced. (e.g. the neighborhood) (string).
822  *
823  * This tag has been added as this is how it is handled/named in XMP's
824  * Iptc4xmpcore schema.
825  *
826  * Since: 0.10.29
827  */
828 #define GST_TAG_GEO_LOCATION_SUBLOCATION             "geo-location-sublocation"
829 /**
830  * GST_TAG_GEO_LOCATION_MOVEMENT_SPEED:
831  *
832  * Speed of the capturing device when performing the capture.
833  * Represented in m/s. (double)
834  *
835  * See also #GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION
836  *
837  * Since 0.10.30
838  */
839 #define GST_TAG_GEO_LOCATION_MOVEMENT_SPEED       "geo-location-movement-speed"
840 /**
841  * GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION:
842  *
843  * Indicates the movement direction of the device performing the capture
844  * of a media. It is represented as degrees in floating point representation,
845  * 0 means the geographic north, and increases clockwise (double from 0 to 360)
846  *
847  * See also #GST_TAG_GEO_LOCATION_CAPTURE_DIRECTION
848  *
849  * Since: 0.10.30
850  */
851 #define GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION "geo-location-movement-direction"
852 /**
853  * GST_TAG_GEO_LOCATION_CAPTURE_DIRECTION:
854  *
855  * Indicates the direction the device is pointing to when capturing
856  * a media. It is represented as degrees in floating point representation,
857  * 0 means the geographic north, and increases clockwise (double from 0 to 360)
858  *
859  * See also #GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION
860  *
861  * Since: 0.10.30
862  */
863 #define GST_TAG_GEO_LOCATION_CAPTURE_DIRECTION  "geo-location-capture-direction"
864 /**
865  * GST_TAG_SHOW_NAME:
866  *
867  * Name of the show, used for displaying (string)
868  *
869  * Since: 0.10.26
870  */
871 #define GST_TAG_SHOW_NAME                         "show-name"
872 /**
873  * GST_TAG_SHOW_SORTNAME:
874  *
875  * Name of the show, used for sorting (string)
876  *
877  * Since: 0.10.26
878  */
879 #define GST_TAG_SHOW_SORTNAME                     "show-sortname"
880 /**
881  * GST_TAG_SHOW_EPISODE_NUMBER:
882  *
883  * Number of the episode within a season/show (unsigned integer)
884  *
885  * Since: 0.10.26
886  */
887 #define GST_TAG_SHOW_EPISODE_NUMBER               "show-episode-number"
888 /**
889  * GST_TAG_SHOW_SEASON_NUMBER:
890  *
891  * Number of the season of a show/series (unsigned integer)
892  *
893  * Since: 0.10.26
894  */
895 #define GST_TAG_SHOW_SEASON_NUMBER                "show-season-number"
896 /**
897  * GST_TAG_LYRICS:
898  *
899  * The lyrics of the media (string)
900  *
901  * Since: 0.10.26
902  */
903 #define GST_TAG_LYRICS                            "lyrics"
904 /**
905  * GST_TAG_COMPOSER_SORTNAME:
906  *
907  * The composer's name, used for sorting (string)
908  *
909  * Since: 0.10.26
910  */
911 #define GST_TAG_COMPOSER_SORTNAME                 "composer-sortname"
912 /**
913  * GST_TAG_GROUPING:
914  *
915  * Groups together media that are related and spans multiple tracks. An
916  * example are multiple pieces of a concerto. (string)
917  *
918  * Since: 0.10.26
919  */
920 #define GST_TAG_GROUPING                          "grouping"
921 /**
922  * GST_TAG_USER_RATING:
923  *
924  * Rating attributed by a person (likely the application user).
925  * The higher the value, the more the user likes this media
926  * (unsigned int from 0 to 100)
927  *
928  * Since: 0.10.29
929  */
930 #define GST_TAG_USER_RATING                       "user-rating"
931 /**
932  * GST_TAG_DEVICE_MANUFACTURER:
933  *
934  * Manufacturer of the device used to create the media (string)
935  *
936  * Since: 0.10.30
937  */
938 #define GST_TAG_DEVICE_MANUFACTURER               "device-manufacturer"
939 /**
940  * GST_TAG_DEVICE_MODEL:
941  *
942  * Model of the device used to create the media (string)
943  *
944  * Since: 0.10.30
945  */
946 #define GST_TAG_DEVICE_MODEL                      "device-model"
947
948 G_END_DECLS
949
950 #endif /* __GST_TAGLIST_H__ */