2 * Copyright (C) 2003 Benjamin Otte <in7y118@public.uni-hamburg.de>
4 * gsttaglist.h: Header for tag support
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.
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.
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.
23 #ifndef __GST_TAGLIST_H__
24 #define __GST_TAGLIST_H__
26 #include <gst/gststructure.h>
27 #include <gst/glib-compat.h>
33 * @GST_TAG_MERGE_UNDEFINED: undefined merge mode
34 * @GST_TAG_MERGE_REPLACE_ALL: replace all tags (clear list and append)
35 * @GST_TAG_MERGE_REPLACE: replace tags
36 * @GST_TAG_MERGE_APPEND: append tags
37 * @GST_TAG_MERGE_PREPEND: prepend tags
38 * @GST_TAG_MERGE_KEEP: keep existing tags
39 * @GST_TAG_MERGE_KEEP_ALL: keep all existing tags
40 * @GST_TAG_MERGE_COUNT: the number of merge modes
42 * The different tag merging modes are basically replace, overwrite and append,
43 * but they can be seen from two directions. Given two taglists: (A) the tags
44 * already in the element and (B) the ones that are supplied to the element (
45 * e.g. via gst_tag_setter_merge_tags() / gst_tag_setter_add_tags() or a
46 * %GST_EVENT_TAG), how are these tags merged?
47 * In the table below this is shown for the cases that a tag exists in the list
48 * (A) or does not exists (!A) and combinations thereof.
50 * <table frame="all" colsep="1" rowsep="1">
51 * <title>merge mode</title>
52 * <tgroup cols='5' align='left'>
55 * <entry>merge mode</entry>
56 * <entry>A + B</entry>
57 * <entry>A + !B</entry>
58 * <entry>!A + B</entry>
59 * <entry>!A + !B</entry>
64 * <entry>REPLACE_ALL</entry>
71 * <entry>REPLACE</entry>
78 * <entry>APPEND</entry>
85 * <entry>PREPEND</entry>
99 * <entry>KEEP_ALL</entry>
110 GST_TAG_MERGE_UNDEFINED,
111 GST_TAG_MERGE_REPLACE_ALL,
112 GST_TAG_MERGE_REPLACE,
113 GST_TAG_MERGE_APPEND,
114 GST_TAG_MERGE_PREPEND,
116 GST_TAG_MERGE_KEEP_ALL,
121 #define GST_TAG_MODE_IS_VALID(mode) (((mode) > GST_TAG_MERGE_UNDEFINED) && ((mode) < GST_TAG_MERGE_COUNT))
125 * @GST_TAG_FLAG_UNDEFINED: undefined flag
126 * @GST_TAG_FLAG_META: tag is meta data
127 * @GST_TAG_FLAG_ENCODED: tag is encoded
128 * @GST_TAG_FLAG_DECODED: tag is decoded
129 * @GST_TAG_FLAG_COUNT: number of tag flags
131 * Extra tag flags used when registering tags.
134 GST_TAG_FLAG_UNDEFINED,
136 GST_TAG_FLAG_ENCODED,
137 GST_TAG_FLAG_DECODED,
141 #define GST_TAG_FLAG_IS_VALID(flag) (((flag) > GST_TAG_FLAG_UNDEFINED) && ((flag) < GST_TAG_FLAG_COUNT))
146 * Opaque #GstTagList data structure.
148 typedef GstStructure GstTagList;
149 #define GST_TAG_LIST(x) ((GstTagList *) (x))
150 #define GST_IS_TAG_LIST(x) ((x) != NULL && gst_is_tag_list (GST_TAG_LIST (x)))
151 #define GST_TYPE_TAG_LIST (gst_tag_list_get_type ())
155 * @list: the #GstTagList
156 * @tag: a name of a tag in @list
157 * @user_data: user data
159 * A function that will be called in gst_tag_list_foreach(). The function may
160 * not modify the tag list.
162 typedef void (*GstTagForeachFunc) (const GstTagList * list,
168 * @dest: the destination #GValue
169 * @src: the source #GValue
171 * A function for merging multiple values of a tag used when registering
174 typedef void (* GstTagMergeFunc) (GValue *dest, const GValue *src);
176 GType gst_tag_list_get_type (void);
178 /* tag registration */
179 void gst_tag_register (const gchar * name,
184 GstTagMergeFunc func);
186 /* some default merging functions */
187 void gst_tag_merge_use_first (GValue * dest, const GValue * src);
188 void gst_tag_merge_strings_with_comma (GValue * dest, const GValue * src);
190 /* basic tag support */
191 gboolean gst_tag_exists (const gchar * tag);
192 GType gst_tag_get_type (const gchar * tag);
193 G_CONST_RETURN gchar * gst_tag_get_nick (const gchar * tag);
194 G_CONST_RETURN gchar * gst_tag_get_description (const gchar * tag);
195 GstTagFlag gst_tag_get_flag (const gchar * tag);
196 gboolean gst_tag_is_fixed (const gchar * tag);
199 GstTagList * gst_tag_list_new (void);
200 gboolean gst_is_tag_list (gconstpointer p);
201 GstTagList * gst_tag_list_copy (const GstTagList * list);
202 gboolean gst_tag_list_is_empty (const GstTagList * list);
203 void gst_tag_list_insert (GstTagList * into,
204 const GstTagList * from,
205 GstTagMergeMode mode);
206 GstTagList * gst_tag_list_merge (const GstTagList * list1,
207 const GstTagList * list2,
208 GstTagMergeMode mode);
209 void gst_tag_list_free (GstTagList * list);
210 guint gst_tag_list_get_tag_size (const GstTagList * list,
212 void gst_tag_list_add (GstTagList * list,
213 GstTagMergeMode mode,
215 ...) G_GNUC_NULL_TERMINATED;
216 void gst_tag_list_add_values (GstTagList * list,
217 GstTagMergeMode mode,
219 ...) G_GNUC_NULL_TERMINATED;
220 void gst_tag_list_add_valist (GstTagList * list,
221 GstTagMergeMode mode,
224 void gst_tag_list_add_valist_values (GstTagList * list,
225 GstTagMergeMode mode,
228 void gst_tag_list_remove_tag (GstTagList * list,
230 void gst_tag_list_foreach (const GstTagList * list,
231 GstTagForeachFunc func,
234 G_CONST_RETURN GValue *
235 gst_tag_list_get_value_index (const GstTagList * list,
238 gboolean gst_tag_list_copy_value (GValue * dest,
239 const GstTagList * list,
242 /* simplifications (FIXME: do we want them?) */
243 gboolean gst_tag_list_get_char (const GstTagList * list,
246 gboolean gst_tag_list_get_char_index (const GstTagList * list,
250 gboolean gst_tag_list_get_uchar (const GstTagList * list,
253 gboolean gst_tag_list_get_uchar_index (const GstTagList * list,
257 gboolean gst_tag_list_get_boolean (const GstTagList * list,
260 gboolean gst_tag_list_get_boolean_index (const GstTagList * list,
264 gboolean gst_tag_list_get_int (const GstTagList * list,
267 gboolean gst_tag_list_get_int_index (const GstTagList * list,
271 gboolean gst_tag_list_get_uint (const GstTagList * list,
274 gboolean gst_tag_list_get_uint_index (const GstTagList * list,
278 gboolean gst_tag_list_get_long (const GstTagList * list,
281 gboolean gst_tag_list_get_long_index (const GstTagList * list,
285 gboolean gst_tag_list_get_ulong (const GstTagList * list,
288 gboolean gst_tag_list_get_ulong_index (const GstTagList * list,
292 gboolean gst_tag_list_get_int64 (const GstTagList * list,
295 gboolean gst_tag_list_get_int64_index (const GstTagList * list,
299 gboolean gst_tag_list_get_uint64 (const GstTagList * list,
302 gboolean gst_tag_list_get_uint64_index (const GstTagList * list,
306 gboolean gst_tag_list_get_float (const GstTagList * list,
309 gboolean gst_tag_list_get_float_index (const GstTagList * list,
313 gboolean gst_tag_list_get_double (const GstTagList * list,
316 gboolean gst_tag_list_get_double_index (const GstTagList * list,
320 gboolean gst_tag_list_get_string (const GstTagList * list,
323 gboolean gst_tag_list_get_string_index (const GstTagList * list,
327 gboolean gst_tag_list_get_pointer (const GstTagList * list,
330 gboolean gst_tag_list_get_pointer_index (const GstTagList * list,
334 gboolean gst_tag_list_get_date (const GstTagList * list,
337 gboolean gst_tag_list_get_date_index (const GstTagList * list,
342 /* GStreamer core tags */
346 * commonly used title (string)
348 * The title as it should be displayed, e.g. 'The Doll House'
350 #define GST_TAG_TITLE "title"
352 * GST_TAG_TITLE_SORTNAME:
354 * commonly used title, as used for sorting (string)
356 * The title as it should be sorted, e.g. 'Doll House, The'
360 #define GST_TAG_TITLE_SORTNAME "title-sortname"
364 * person(s) responsible for the recording (string)
366 * The artist name as it should be displayed, e.g. 'Jimi Hendrix' or
367 * 'The Guitar Heroes'
369 #define GST_TAG_ARTIST "artist"
371 * GST_TAG_ARTIST_SORTNAME:
373 * person(s) responsible for the recording, as used for sorting (string)
375 * The artist name as it should be sorted, e.g. 'Hendrix, Jimi' or
376 * 'Guitar Heroes, The'
380 /* FIXME 0.11: change to "artist-sortname" */
381 #define GST_TAG_ARTIST_SORTNAME "musicbrainz-sortname"
385 * album containing this data (string)
387 * The album name as it should be displayed, e.g. 'The Jazz Guitar'
389 #define GST_TAG_ALBUM "album"
391 * GST_TAG_ALBUM_SORTNAME:
393 * album containing this data, as used for sorting (string)
395 * The album name as it should be sorted, e.g. 'Jazz Guitar, The'
399 #define GST_TAG_ALBUM_SORTNAME "album-sortname"
403 * person(s) who composed the recording (string)
407 #define GST_TAG_COMPOSER "composer"
411 * date the data was created (#GDate structure)
413 #define GST_TAG_DATE "date"
417 * genre this data belongs to (string)
419 #define GST_TAG_GENRE "genre"
423 * free text commenting the data (string)
425 #define GST_TAG_COMMENT "comment"
427 * GST_TAG_EXTENDED_COMMENT:
429 * key/value text commenting the data (string)
431 * Must be in the form of 'key=comment' or
432 * 'key[lc]=comment' where 'lc' is an ISO-639
435 * This tag is used for unknown Vorbis comment tags,
436 * unknown APE tags and certain ID3v2 comment fields.
440 #define GST_TAG_EXTENDED_COMMENT "extended-comment"
442 * GST_TAG_TRACK_NUMBER:
444 * track number inside a collection (unsigned integer)
446 #define GST_TAG_TRACK_NUMBER "track-number"
448 * GST_TAG_TRACK_COUNT:
450 * count of tracks inside collection this track belongs to (unsigned integer)
452 #define GST_TAG_TRACK_COUNT "track-count"
454 * GST_TAG_ALBUM_VOLUME_NUMBER:
456 * disc number inside a collection (unsigned integer)
458 #define GST_TAG_ALBUM_VOLUME_NUMBER "album-disc-number"
460 * GST_TAG_ALBUM_VOLUME_COUNT:
462 * count of discs inside collection this disc belongs to (unsigned integer)
464 #define GST_TAG_ALBUM_VOLUME_COUNT "album-disc-count"
468 * Origin of media as a URI (location, where the original of the file or stream
469 * is hosted) (string)
471 #define GST_TAG_LOCATION "location"
473 * GST_TAG_DESCRIPTION:
475 * short text describing the content of the data (string)
477 #define GST_TAG_DESCRIPTION "description"
481 * version of this data (string)
483 #define GST_TAG_VERSION "version"
487 * International Standard Recording Code - see http://www.ifpi.org/isrc/ (string)
489 #define GST_TAG_ISRC "isrc"
491 * GST_TAG_ORGANIZATION:
493 * organization (string)
495 #define GST_TAG_ORGANIZATION "organization"
499 * copyright notice of the data (string)
501 #define GST_TAG_COPYRIGHT "copyright"
503 * GST_TAG_COPYRIGHT_URI:
505 * URI to location where copyright details can be found (string)
509 #define GST_TAG_COPYRIGHT_URI "copyright-uri"
513 * contact information (string)
515 #define GST_TAG_CONTACT "contact"
519 * license of data (string)
521 #define GST_TAG_LICENSE "license"
523 * GST_TAG_LICENSE_URI:
525 * URI to location where license details can be found (string)
529 #define GST_TAG_LICENSE_URI "license-uri"
533 * person(s) performing (string)
535 #define GST_TAG_PERFORMER "performer"
539 * length in GStreamer time units (nanoseconds) (unsigned 64-bit integer)
541 #define GST_TAG_DURATION "duration"
545 * codec the data is stored in (string)
547 #define GST_TAG_CODEC "codec"
549 * GST_TAG_VIDEO_CODEC:
551 * codec the video data is stored in (string)
553 #define GST_TAG_VIDEO_CODEC "video-codec"
555 * GST_TAG_AUDIO_CODEC:
557 * codec the audio data is stored in (string)
559 #define GST_TAG_AUDIO_CODEC "audio-codec"
563 * exact or average bitrate in bits/s (unsigned integer)
565 #define GST_TAG_BITRATE "bitrate"
567 * GST_TAG_NOMINAL_BITRATE:
569 * nominal bitrate in bits/s (unsigned integer)
571 #define GST_TAG_NOMINAL_BITRATE "nominal-bitrate"
573 * GST_TAG_MINIMUM_BITRATE:
575 * minimum bitrate in bits/s (unsigned integer)
577 #define GST_TAG_MINIMUM_BITRATE "minimum-bitrate"
579 * GST_TAG_MAXIMUM_BITRATE:
581 * maximum bitrate in bits/s (unsigned integer)
583 #define GST_TAG_MAXIMUM_BITRATE "maximum-bitrate"
587 * serial number of track (unsigned integer)
589 #define GST_TAG_SERIAL "serial"
593 * encoder used to encode this stream (string)
595 #define GST_TAG_ENCODER "encoder"
597 * GST_TAG_ENCODER_VERSION:
599 * version of the encoder used to encode this stream (unsigned integer)
601 #define GST_TAG_ENCODER_VERSION "encoder-version"
603 * GST_TAG_TRACK_GAIN:
605 * track gain in db (double)
607 #define GST_TAG_TRACK_GAIN "replaygain-track-gain"
609 * GST_TAG_TRACK_PEAK:
611 * peak of the track (double)
613 #define GST_TAG_TRACK_PEAK "replaygain-track-peak"
615 * GST_TAG_ALBUM_GAIN:
617 * album gain in db (double)
619 #define GST_TAG_ALBUM_GAIN "replaygain-album-gain"
621 * GST_TAG_ALBUM_PEAK:
623 * peak of the album (double)
625 #define GST_TAG_ALBUM_PEAK "replaygain-album-peak"
627 * GST_TAG_REFERENCE_LEVEL:
629 * reference level of track and album gain values (double)
633 #define GST_TAG_REFERENCE_LEVEL "replaygain-reference-level"
635 * GST_TAG_LANGUAGE_CODE:
637 * Language code (ISO-639-1) (string) of the content
639 #define GST_TAG_LANGUAGE_CODE "language-code"
643 * image (buffer) (buffer caps should specify the content type and preferably
644 * also set "image-type" field as #GstTagImageType)
648 #define GST_TAG_IMAGE "image"
650 * GST_TAG_PREVIEW_IMAGE:
652 * image that is meant for preview purposes, e.g. small icon-sized version
653 * (buffer) (buffer caps should specify the content type)
657 #define GST_TAG_PREVIEW_IMAGE "preview-image"
660 * GST_TAG_ATTACHMENT:
662 * generic file attachment (buffer) (buffer caps should specify the content
663 * type and if possible set "filename" to the file name of the
668 #define GST_TAG_ATTACHMENT "attachment"
671 * GST_TAG_BEATS_PER_MINUTE:
673 * number of beats per minute in audio (double)
677 #define GST_TAG_BEATS_PER_MINUTE "beats-per-minute"
682 * comma separated keywords describing the content (string).
686 #define GST_TAG_KEYWORDS "keywords"
689 * GST_TAG_GEO_LOCATION_NAME:
691 * human readable descriptive location of where the media has been recorded or
692 * produced. (string).
696 #define GST_TAG_GEO_LOCATION_NAME "geo-location-name"
699 * GST_TAG_GEO_LOCATION_LATITUDE:
701 * geo latitude location of where the media has been recorded or produced in
702 * degrees according to WGS84 (zero at the equator, negative values for southern
703 * latitudes) (double).
707 #define GST_TAG_GEO_LOCATION_LATITUDE "geo-location-latitude"
710 * GST_TAG_GEO_LOCATION_LONGITUDE:
712 * geo longitude location of where the media has been recorded or produced in
713 * degrees according to WGS84 (zero at the prime meridian in Greenwich/UK,
714 * negative values for western longitudes). (double).
718 #define GST_TAG_GEO_LOCATION_LONGITUDE "geo-location-longitude"
721 * GST_TAG_GEO_LOCATION_ELEVATION:
723 * geo elevation of where the media has been recorded or produced in meters
724 * according to WGS84 (zero is average sea level) (double).
728 #define GST_TAG_GEO_LOCATION_ELEVATION "geo-location-elevation"
732 #endif /* __GST_TAGLIST_H__ */