2 * Copyright (C) 2003 Benjamin Otte <in7y118@public.uni-hamburg.de>
4 * gsttaglist.c: tag support (aka metadata)
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., 51 Franklin St, Fifth Floor,
19 * Boston, MA 02110-1301, USA.
25 * @short_description: List of tags and values used to describe media metadata
27 * List of tags and values used to describe media metadata.
29 * Strings in structures must be ASCII or UTF-8 encoded. Other encodings are
30 * not allowed. Strings must not be empty or %NULL.
37 #include "gst_private.h"
38 #include "math-compat.h"
39 #include "gst-i18n-lib.h"
40 #include "gsttaglist.h"
43 #include "gstbuffer.h"
45 #include "gststructure.h"
47 #include <gobject/gvaluecollector.h>
50 /* FIXME: add category for tags */
51 #define GST_CAT_TAGS GST_CAT_DEFAULT
53 #define GST_TAG_IS_VALID(tag) (gst_tag_get_info (tag) != NULL)
55 typedef struct _GstTagListImpl
59 GstStructure *structure;
63 #define GST_TAG_LIST_STRUCTURE(taglist) ((GstTagListImpl*)(taglist))->structure
64 #define GST_TAG_LIST_SCOPE(taglist) ((GstTagListImpl*)(taglist))->scope
68 GType type; /* type the data is in */
70 const gchar *nick; /* translated short description */
71 const gchar *blurb; /* translated long description */
73 GstTagMergeFunc merge_func; /* functions to merge the values */
74 GstTagFlag flag; /* type of tag */
75 GQuark name_quark; /* quark for the name */
79 #define g_value_get_char g_value_get_schar
81 static GMutex __tag_mutex;
82 #define TAG_LOCK g_mutex_lock (&__tag_mutex)
83 #define TAG_UNLOCK g_mutex_unlock (&__tag_mutex)
85 /* tags hash table: maps tag name string => GstTagInfo */
86 static GHashTable *__tags;
88 GType _gst_tag_list_type = 0;
89 GST_DEFINE_MINI_OBJECT_TYPE (GstTagList, gst_tag_list);
91 static void __gst_tag_list_free (GstTagList * list);
92 static GstTagList *__gst_tag_list_copy (const GstTagList * list);
95 * g_value_register_transform_func (_gst_tag_list_type, G_TYPE_STRING,
96 * _gst_structure_transform_to_string);
99 _priv_gst_tag_initialize (void)
101 g_mutex_init (&__tag_mutex);
103 _gst_tag_list_type = gst_tag_list_get_type ();
105 __tags = g_hash_table_new (g_str_hash, g_str_equal);
106 gst_tag_register_static (GST_TAG_TITLE, GST_TAG_FLAG_META,
108 _("title"), _("commonly used title"), gst_tag_merge_strings_with_comma);
109 gst_tag_register_static (GST_TAG_TITLE_SORTNAME, GST_TAG_FLAG_META,
111 _("title sortname"), _("commonly used title for sorting purposes"), NULL);
112 gst_tag_register_static (GST_TAG_ARTIST, GST_TAG_FLAG_META,
115 _("person(s) responsible for the recording"),
116 gst_tag_merge_strings_with_comma);
117 gst_tag_register_static (GST_TAG_ARTIST_SORTNAME, GST_TAG_FLAG_META,
119 _("artist sortname"),
120 _("person(s) responsible for the recording for sorting purposes"), NULL);
121 gst_tag_register_static (GST_TAG_ALBUM, GST_TAG_FLAG_META,
124 _("album containing this data"), gst_tag_merge_strings_with_comma);
125 gst_tag_register_static (GST_TAG_ALBUM_SORTNAME, GST_TAG_FLAG_META,
128 _("album containing this data for sorting purposes"), NULL);
129 gst_tag_register_static (GST_TAG_ALBUM_ARTIST, GST_TAG_FLAG_META,
132 _("The artist of the entire album, as it should be displayed"),
133 gst_tag_merge_strings_with_comma);
134 gst_tag_register_static (GST_TAG_ALBUM_ARTIST_SORTNAME, GST_TAG_FLAG_META,
136 _("album artist sortname"),
137 _("The artist of the entire album, as it should be sorted"), NULL);
138 gst_tag_register_static (GST_TAG_DATE, GST_TAG_FLAG_META, G_TYPE_DATE,
139 _("date"), _("date the data was created (as a GDate structure)"), NULL);
140 gst_tag_register_static (GST_TAG_DATE_TIME, GST_TAG_FLAG_META,
141 GST_TYPE_DATE_TIME, _("datetime"),
142 _("date and time the data was created (as a GstDateTime structure)"),
144 gst_tag_register_static (GST_TAG_GENRE, GST_TAG_FLAG_META,
147 _("genre this data belongs to"), gst_tag_merge_strings_with_comma);
148 gst_tag_register_static (GST_TAG_COMMENT, GST_TAG_FLAG_META,
151 _("free text commenting the data"), gst_tag_merge_use_first);
152 gst_tag_register_static (GST_TAG_EXTENDED_COMMENT, GST_TAG_FLAG_META,
154 _("extended comment"),
155 _("free text commenting the data in key=value or key[en]=comment form"),
156 gst_tag_merge_use_first);
157 gst_tag_register_static (GST_TAG_TRACK_NUMBER, GST_TAG_FLAG_META,
160 _("track number inside a collection"), gst_tag_merge_use_first);
161 gst_tag_register_static (GST_TAG_TRACK_COUNT, GST_TAG_FLAG_META,
164 _("count of tracks inside collection this track belongs to"),
165 gst_tag_merge_use_first);
166 gst_tag_register_static (GST_TAG_ALBUM_VOLUME_NUMBER, GST_TAG_FLAG_META,
169 _("disc number inside a collection"), gst_tag_merge_use_first);
170 gst_tag_register_static (GST_TAG_ALBUM_VOLUME_COUNT, GST_TAG_FLAG_META,
173 _("count of discs inside collection this disc belongs to"),
174 gst_tag_merge_use_first);
175 gst_tag_register_static (GST_TAG_LOCATION, GST_TAG_FLAG_META,
177 _("location"), _("Origin of media as a URI (location, where the "
178 "original of the file or stream is hosted)"),
179 gst_tag_merge_strings_with_comma);
180 gst_tag_register_static (GST_TAG_HOMEPAGE, GST_TAG_FLAG_META,
183 _("Homepage for this media (i.e. artist or movie homepage)"),
184 gst_tag_merge_strings_with_comma);
185 gst_tag_register_static (GST_TAG_DESCRIPTION, GST_TAG_FLAG_META,
186 G_TYPE_STRING, _("description"),
187 _("short text describing the content of the data"),
188 gst_tag_merge_strings_with_comma);
189 gst_tag_register_static (GST_TAG_VERSION, GST_TAG_FLAG_META, G_TYPE_STRING,
190 _("version"), _("version of this data"), NULL);
191 gst_tag_register_static (GST_TAG_ISRC, GST_TAG_FLAG_META, G_TYPE_STRING,
194 ("International Standard Recording Code - see http://www.ifpi.org/isrc/"),
196 /* FIXME: organization (fix what? tpm) */
197 gst_tag_register_static (GST_TAG_ORGANIZATION, GST_TAG_FLAG_META,
198 G_TYPE_STRING, _("organization"), _("organization"),
199 gst_tag_merge_strings_with_comma);
200 gst_tag_register_static (GST_TAG_COPYRIGHT, GST_TAG_FLAG_META,
201 G_TYPE_STRING, _("copyright"), _("copyright notice of the data"), NULL);
202 gst_tag_register_static (GST_TAG_COPYRIGHT_URI, GST_TAG_FLAG_META,
203 G_TYPE_STRING, _("copyright uri"),
204 _("URI to the copyright notice of the data"), NULL);
205 gst_tag_register_static (GST_TAG_ENCODED_BY, GST_TAG_FLAG_META, G_TYPE_STRING,
206 _("encoded by"), _("name of the encoding person or organization"),
207 gst_tag_merge_strings_with_comma);
208 gst_tag_register_static (GST_TAG_CONTACT, GST_TAG_FLAG_META,
210 _("contact"), _("contact information"), gst_tag_merge_strings_with_comma);
211 gst_tag_register_static (GST_TAG_LICENSE, GST_TAG_FLAG_META,
212 G_TYPE_STRING, _("license"), _("license of data"), NULL);
213 gst_tag_register_static (GST_TAG_LICENSE_URI, GST_TAG_FLAG_META,
214 G_TYPE_STRING, _("license uri"),
215 _("URI to the license of the data"), NULL);
216 gst_tag_register_static (GST_TAG_PERFORMER, GST_TAG_FLAG_META,
219 _("person(s) performing"), gst_tag_merge_strings_with_comma);
220 gst_tag_register_static (GST_TAG_COMPOSER, GST_TAG_FLAG_META,
223 _("person(s) who composed the recording"),
224 gst_tag_merge_strings_with_comma);
225 gst_tag_register_static (GST_TAG_CONDUCTOR, GST_TAG_FLAG_META,
228 _("conductor/performer refinement"), gst_tag_merge_strings_with_comma);
229 gst_tag_register_static (GST_TAG_DURATION, GST_TAG_FLAG_DECODED,
231 _("duration"), _("length in GStreamer time units (nanoseconds)"), NULL);
232 gst_tag_register_static (GST_TAG_CODEC, GST_TAG_FLAG_ENCODED,
235 _("codec the data is stored in"), gst_tag_merge_strings_with_comma);
236 gst_tag_register_static (GST_TAG_VIDEO_CODEC, GST_TAG_FLAG_ENCODED,
238 _("video codec"), _("codec the video data is stored in"), NULL);
239 gst_tag_register_static (GST_TAG_AUDIO_CODEC, GST_TAG_FLAG_ENCODED,
241 _("audio codec"), _("codec the audio data is stored in"), NULL);
242 gst_tag_register_static (GST_TAG_SUBTITLE_CODEC, GST_TAG_FLAG_ENCODED,
244 _("subtitle codec"), _("codec the subtitle data is stored in"), NULL);
245 gst_tag_register_static (GST_TAG_CONTAINER_FORMAT, GST_TAG_FLAG_ENCODED,
246 G_TYPE_STRING, _("container format"),
247 _("container format the data is stored in"), NULL);
248 gst_tag_register_static (GST_TAG_BITRATE, GST_TAG_FLAG_ENCODED,
249 G_TYPE_UINT, _("bitrate"), _("exact or average bitrate in bits/s"), NULL);
250 gst_tag_register_static (GST_TAG_NOMINAL_BITRATE, GST_TAG_FLAG_ENCODED,
251 G_TYPE_UINT, _("nominal bitrate"), _("nominal bitrate in bits/s"), NULL);
252 gst_tag_register_static (GST_TAG_MINIMUM_BITRATE, GST_TAG_FLAG_ENCODED,
253 G_TYPE_UINT, _("minimum bitrate"), _("minimum bitrate in bits/s"), NULL);
254 gst_tag_register_static (GST_TAG_MAXIMUM_BITRATE, GST_TAG_FLAG_ENCODED,
255 G_TYPE_UINT, _("maximum bitrate"), _("maximum bitrate in bits/s"), NULL);
256 gst_tag_register_static (GST_TAG_ENCODER, GST_TAG_FLAG_ENCODED,
258 _("encoder"), _("encoder used to encode this stream"), NULL);
259 gst_tag_register_static (GST_TAG_ENCODER_VERSION, GST_TAG_FLAG_ENCODED,
261 _("encoder version"),
262 _("version of the encoder used to encode this stream"), NULL);
263 gst_tag_register_static (GST_TAG_SERIAL, GST_TAG_FLAG_ENCODED,
264 G_TYPE_UINT, _("serial"), _("serial number of track"), NULL);
265 gst_tag_register_static (GST_TAG_TRACK_GAIN, GST_TAG_FLAG_META,
266 G_TYPE_DOUBLE, _("replaygain track gain"), _("track gain in db"), NULL);
267 gst_tag_register_static (GST_TAG_TRACK_PEAK, GST_TAG_FLAG_META,
268 G_TYPE_DOUBLE, _("replaygain track peak"), _("peak of the track"), NULL);
269 gst_tag_register_static (GST_TAG_ALBUM_GAIN, GST_TAG_FLAG_META,
270 G_TYPE_DOUBLE, _("replaygain album gain"), _("album gain in db"), NULL);
271 gst_tag_register_static (GST_TAG_ALBUM_PEAK, GST_TAG_FLAG_META,
272 G_TYPE_DOUBLE, _("replaygain album peak"), _("peak of the album"), NULL);
273 gst_tag_register_static (GST_TAG_REFERENCE_LEVEL, GST_TAG_FLAG_META,
274 G_TYPE_DOUBLE, _("replaygain reference level"),
275 _("reference level of track and album gain values"), NULL);
276 gst_tag_register_static (GST_TAG_LANGUAGE_CODE, GST_TAG_FLAG_META,
277 G_TYPE_STRING, _("language code"),
278 _("language code for this stream, conforming to ISO-639-1 or ISO-639-2"),
280 gst_tag_register_static (GST_TAG_LANGUAGE_NAME, GST_TAG_FLAG_META,
281 G_TYPE_STRING, _("language name"),
282 _("freeform name of the language this stream is in"), NULL);
283 gst_tag_register_static (GST_TAG_IMAGE, GST_TAG_FLAG_META, GST_TYPE_SAMPLE,
284 _("image"), _("image related to this stream"), gst_tag_merge_use_first);
285 #ifdef TIZEN_PROFILE_TV
286 gst_tag_register_static (GST_TAG_AUDIO_DUALMONO, GST_TAG_FLAG_DECODED, G_TYPE_UINT,
287 _("dualmono audio"), _("dual/mono related to this audio stream"), NULL);
289 gst_tag_register_static (GST_TAG_PREVIEW_IMAGE, GST_TAG_FLAG_META,
291 /* TRANSLATORS: 'preview image' = image that shows a preview of the full image */
292 _("preview image"), _("preview image related to this stream"), NULL);
293 gst_tag_register_static (GST_TAG_ATTACHMENT, GST_TAG_FLAG_META,
294 GST_TYPE_SAMPLE, _("attachment"), _("file attached to this stream"),
295 gst_tag_merge_use_first);
296 gst_tag_register_static (GST_TAG_BEATS_PER_MINUTE, GST_TAG_FLAG_META,
297 G_TYPE_DOUBLE, _("beats per minute"),
298 _("number of beats per minute in audio"), NULL);
299 gst_tag_register_static (GST_TAG_KEYWORDS, GST_TAG_FLAG_META, G_TYPE_STRING,
300 _("keywords"), _("comma separated keywords describing the content"),
301 gst_tag_merge_strings_with_comma);
302 gst_tag_register_static (GST_TAG_GEO_LOCATION_NAME, GST_TAG_FLAG_META,
303 G_TYPE_STRING, _("geo location name"),
304 _("human readable descriptive location of where "
305 "the media has been recorded or produced"), NULL);
306 gst_tag_register_static (GST_TAG_GEO_LOCATION_LATITUDE, GST_TAG_FLAG_META,
307 G_TYPE_DOUBLE, _("geo location latitude"),
308 _("geo latitude location of where the media has been recorded or "
309 "produced in degrees according to WGS84 (zero at the equator, "
310 "negative values for southern latitudes)"), NULL);
311 gst_tag_register_static (GST_TAG_GEO_LOCATION_LONGITUDE, GST_TAG_FLAG_META,
312 G_TYPE_DOUBLE, _("geo location longitude"),
313 _("geo longitude location of where the media has been recorded or "
314 "produced in degrees according to WGS84 (zero at the prime meridian "
315 "in Greenwich/UK, negative values for western longitudes)"), NULL);
316 gst_tag_register_static (GST_TAG_GEO_LOCATION_ELEVATION, GST_TAG_FLAG_META,
317 G_TYPE_DOUBLE, _("geo location elevation"),
318 _("geo elevation of where the media has been recorded or produced in "
319 "meters according to WGS84 (zero is average sea level)"), NULL);
320 gst_tag_register_static (GST_TAG_GEO_LOCATION_COUNTRY, GST_TAG_FLAG_META,
321 G_TYPE_STRING, _("geo location country"),
322 _("country (english name) where the media has been recorded "
323 "or produced"), NULL);
324 gst_tag_register_static (GST_TAG_GEO_LOCATION_CITY, GST_TAG_FLAG_META,
325 G_TYPE_STRING, _("geo location city"),
326 _("city (english name) where the media has been recorded "
327 "or produced"), NULL);
328 gst_tag_register_static (GST_TAG_GEO_LOCATION_SUBLOCATION, GST_TAG_FLAG_META,
329 G_TYPE_STRING, _("geo location sublocation"),
330 _("a location within a city where the media has been produced "
331 "or created (e.g. the neighborhood)"), NULL);
332 gst_tag_register_static (GST_TAG_GEO_LOCATION_HORIZONTAL_ERROR,
333 GST_TAG_FLAG_META, G_TYPE_DOUBLE, _("geo location horizontal error"),
334 _("expected error of the horizontal positioning measures (in meters)"),
336 gst_tag_register_static (GST_TAG_GEO_LOCATION_MOVEMENT_SPEED,
337 GST_TAG_FLAG_META, G_TYPE_DOUBLE, _("geo location movement speed"),
338 _("movement speed of the capturing device while performing the capture "
340 gst_tag_register_static (GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION,
341 GST_TAG_FLAG_META, G_TYPE_DOUBLE, _("geo location movement direction"),
342 _("indicates the movement direction of the device performing the capture"
343 " of a media. It is represented as degrees in floating point "
344 "representation, 0 means the geographic north, and increases "
346 gst_tag_register_static (GST_TAG_GEO_LOCATION_CAPTURE_DIRECTION,
347 GST_TAG_FLAG_META, G_TYPE_DOUBLE, _("geo location capture direction"),
348 _("indicates the direction the device is pointing to when capturing "
349 " a media. It is represented as degrees in floating point "
350 " representation, 0 means the geographic north, and increases "
352 gst_tag_register_static (GST_TAG_SHOW_NAME, GST_TAG_FLAG_META, G_TYPE_STRING,
353 /* TRANSLATORS: 'show name' = 'TV/radio/podcast show name' here */
355 _("Name of the tv/podcast/series show the media is from"),
356 gst_tag_merge_strings_with_comma);
357 gst_tag_register_static (GST_TAG_SHOW_SORTNAME, GST_TAG_FLAG_META,
359 /* TRANSLATORS: 'show sortname' = 'TV/radio/podcast show name as used for sorting purposes' here */
361 _("Name of the tv/podcast/series show the media is from, for sorting "
363 gst_tag_register_static (GST_TAG_SHOW_EPISODE_NUMBER, GST_TAG_FLAG_META,
364 G_TYPE_UINT, _("episode number"),
365 _("The episode number in the season the media is part of"),
366 gst_tag_merge_use_first);
367 gst_tag_register_static (GST_TAG_SHOW_SEASON_NUMBER, GST_TAG_FLAG_META,
368 G_TYPE_UINT, _("season number"),
369 _("The season number of the show the media is part of"),
370 gst_tag_merge_use_first);
371 gst_tag_register_static (GST_TAG_LYRICS, GST_TAG_FLAG_META, G_TYPE_STRING,
372 _("lyrics"), _("The lyrics of the media, commonly used for songs"),
373 gst_tag_merge_strings_with_comma);
374 gst_tag_register_static (GST_TAG_COMPOSER_SORTNAME, GST_TAG_FLAG_META,
375 G_TYPE_STRING, _("composer sortname"),
376 _("person(s) who composed the recording, for sorting purposes"), NULL);
377 gst_tag_register_static (GST_TAG_GROUPING, GST_TAG_FLAG_META, G_TYPE_STRING,
379 _("Groups related media that spans multiple tracks, like the different "
380 "pieces of a concerto. It is a higher level than a track, "
381 "but lower than an album"), NULL);
382 gst_tag_register_static (GST_TAG_USER_RATING, GST_TAG_FLAG_META, G_TYPE_UINT,
384 _("Rating attributed by a user. The higher the rank, "
385 "the more the user likes this media"), NULL);
386 gst_tag_register_static (GST_TAG_DEVICE_MANUFACTURER, GST_TAG_FLAG_META,
387 G_TYPE_STRING, _("device manufacturer"),
388 _("Manufacturer of the device used to create this media"), NULL);
389 gst_tag_register_static (GST_TAG_DEVICE_MODEL, GST_TAG_FLAG_META,
390 G_TYPE_STRING, _("device model"),
391 _("Model of the device used to create this media"), NULL);
392 gst_tag_register_static (GST_TAG_APPLICATION_NAME, GST_TAG_FLAG_META,
393 G_TYPE_STRING, _("application name"),
394 _("Application used to create the media"), NULL);
395 gst_tag_register_static (GST_TAG_APPLICATION_DATA, GST_TAG_FLAG_META,
396 GST_TYPE_SAMPLE, _("application data"),
397 _("Arbitrary application data to be serialized into the media"), NULL);
398 gst_tag_register_static (GST_TAG_IMAGE_ORIENTATION, GST_TAG_FLAG_META,
399 G_TYPE_STRING, _("image orientation"),
400 _("How the image should be rotated or flipped before display"), NULL);
401 gst_tag_register_static (GST_TAG_PUBLISHER, GST_TAG_FLAG_META,
404 _("Name of the label or publisher"), gst_tag_merge_strings_with_comma);
405 gst_tag_register_static (GST_TAG_INTERPRETED_BY, GST_TAG_FLAG_META,
408 _("Information about the people behind a remix and similar "
409 "interpretations"), gst_tag_merge_strings_with_comma);
410 gst_tag_register_static (GST_TAG_MIDI_BASE_NOTE, GST_TAG_FLAG_META,
412 _("midi-base-note"), _("Midi note number of the audio track."), NULL);
413 gst_tag_register_static (GST_TAG_PRIVATE_DATA, GST_TAG_FLAG_META,
415 _("private-data"), _("Private data"), gst_tag_merge_use_first);
420 * gst_tag_merge_use_first:
421 * @dest: (out caller-allocates): uninitialized GValue to store result in
422 * @src: GValue to copy from
424 * This is a convenience function for the func argument of gst_tag_register().
425 * It creates a copy of the first value from the list.
428 gst_tag_merge_use_first (GValue * dest, const GValue * src)
430 const GValue *ret = gst_value_list_get_value (src, 0);
432 g_value_init (dest, G_VALUE_TYPE (ret));
433 g_value_copy (ret, dest);
437 * gst_tag_merge_strings_with_comma:
438 * @dest: (out caller-allocates): uninitialized GValue to store result in
439 * @src: GValue to copy from
441 * This is a convenience function for the func argument of gst_tag_register().
442 * It concatenates all given strings using a comma. The tag must be registered
443 * as a G_TYPE_STRING or this function will fail.
446 gst_tag_merge_strings_with_comma (GValue * dest, const GValue * src)
451 count = gst_value_list_get_size (src);
452 str = g_string_new (g_value_get_string (gst_value_list_get_value (src, 0)));
453 for (i = 1; i < count; i++) {
454 /* separator between two strings */
455 g_string_append (str, _(", "));
456 g_string_append (str,
457 g_value_get_string (gst_value_list_get_value (src, i)));
460 g_value_init (dest, G_TYPE_STRING);
461 g_value_take_string (dest, str->str);
462 g_string_free (str, FALSE);
466 gst_tag_lookup (const gchar * tag_name)
471 ret = g_hash_table_lookup (__tags, (gpointer) tag_name);
478 * gst_tag_register: (skip)
479 * @name: the name or identifier string
480 * @flag: a flag describing the type of tag info
481 * @type: the type this data is in
482 * @nick: human-readable name
483 * @blurb: a human-readable description about this tag
484 * @func: (allow-none): function for merging multiple values of this tag, or %NULL
486 * Registers a new tag type for the use with GStreamer's type system. If a type
487 * with that name is already registered, that one is used.
488 * The old registration may have used a different type however. So don't rely
489 * on your supplied values.
491 * Important: if you do not supply a merge function the implication will be
492 * that there can only be one single value for this tag in a tag list and
493 * any additional values will silently be discarded when being added (unless
494 * #GST_TAG_MERGE_REPLACE, #GST_TAG_MERGE_REPLACE_ALL, or
495 * #GST_TAG_MERGE_PREPEND is used as merge mode, in which case the new
496 * value will replace the old one in the list).
498 * The merge function will be called from gst_tag_list_copy_value() when
499 * it is required that one or more values for a tag be condensed into
500 * one single value. This may happen from gst_tag_list_get_string(),
501 * gst_tag_list_get_int(), gst_tag_list_get_double() etc. What will happen
502 * exactly in that case depends on how the tag was registered and if a
503 * merge function was supplied and if so which one.
505 * Two default merge functions are provided: gst_tag_merge_use_first() and
506 * gst_tag_merge_strings_with_comma().
509 gst_tag_register (const gchar * name, GstTagFlag flag, GType type,
510 const gchar * nick, const gchar * blurb, GstTagMergeFunc func)
512 g_return_if_fail (name != NULL);
513 g_return_if_fail (nick != NULL);
514 g_return_if_fail (blurb != NULL);
515 g_return_if_fail (type != 0 && type != GST_TYPE_LIST);
517 gst_tag_register_static (g_intern_string (name), flag, type,
518 g_intern_string (nick), g_intern_string (blurb), func);
522 * gst_tag_register_static: (skip)
523 * @name: the name or identifier string (string constant)
524 * @flag: a flag describing the type of tag info
525 * @type: the type this data is in
526 * @nick: human-readable name or short description (string constant)
527 * @blurb: a human-readable description for this tag (string constant)
528 * @func: (allow-none): function for merging multiple values of this tag, or %NULL
530 * Registers a new tag type for the use with GStreamer's type system.
532 * Same as gst_tag_register(), but @name, @nick, and @blurb must be
533 * static strings or inlined strings, as they will not be copied. (GStreamer
534 * plugins will be made resident once loaded, so this function can be used
535 * even from dynamically loaded plugins.)
538 gst_tag_register_static (const gchar * name, GstTagFlag flag, GType type,
539 const gchar * nick, const gchar * blurb, GstTagMergeFunc func)
543 g_return_if_fail (name != NULL);
544 g_return_if_fail (nick != NULL);
545 g_return_if_fail (blurb != NULL);
546 g_return_if_fail (type != 0 && type != GST_TYPE_LIST);
548 info = gst_tag_lookup (name);
551 g_return_if_fail (info->type == type);
555 info = g_slice_new (GstTagInfo);
558 info->name_quark = g_quark_from_static_string (name);
561 info->merge_func = func;
564 g_hash_table_insert (__tags, (gpointer) name, info);
570 * @tag: name of the tag
572 * Checks if the given type is already registered.
574 * Returns: %TRUE if the type is already registered
577 gst_tag_exists (const gchar * tag)
579 g_return_val_if_fail (tag != NULL, FALSE);
581 return gst_tag_lookup (tag) != NULL;
588 * Gets the #GType used for this tag.
590 * Returns: the #GType of this tag
593 gst_tag_get_type (const gchar * tag)
597 g_return_val_if_fail (tag != NULL, 0);
598 info = gst_tag_lookup (tag);
599 g_return_val_if_fail (info != NULL, 0);
608 * Returns the human-readable name of this tag, You must not change or free
611 * Returns: (nullable): the human-readable name of this tag
614 gst_tag_get_nick (const gchar * tag)
618 g_return_val_if_fail (tag != NULL, NULL);
619 info = gst_tag_lookup (tag);
621 GST_WARNING ("Unknown tag: %s", tag);
630 * gst_tag_get_description:
633 * Returns the human-readable description of this tag, You must not change or
636 * Returns: (nullable): the human-readable description of this tag
639 gst_tag_get_description (const gchar * tag)
643 g_return_val_if_fail (tag != NULL, NULL);
644 info = gst_tag_lookup (tag);
645 g_return_val_if_fail (info != NULL, NULL);
654 * Gets the flag of @tag.
656 * Returns: the flag of this tag.
659 gst_tag_get_flag (const gchar * tag)
663 g_return_val_if_fail (tag != NULL, GST_TAG_FLAG_UNDEFINED);
664 info = gst_tag_lookup (tag);
665 g_return_val_if_fail (info != NULL, GST_TAG_FLAG_UNDEFINED);
674 * Checks if the given tag is fixed. A fixed tag can only contain one value.
675 * Unfixed tags can contain lists of values.
677 * Returns: %TRUE, if the given tag is fixed.
680 gst_tag_is_fixed (const gchar * tag)
684 g_return_val_if_fail (tag != NULL, FALSE);
685 info = gst_tag_lookup (tag);
686 g_return_val_if_fail (info != NULL, FALSE);
688 return info->merge_func == NULL;
691 /* takes ownership of the structure */
693 gst_tag_list_new_internal (GstStructure * s, GstTagScope scope)
695 GstTagList *tag_list;
697 g_assert (s != NULL);
699 tag_list = (GstTagList *) g_slice_new (GstTagListImpl);
701 gst_mini_object_init (GST_MINI_OBJECT_CAST (tag_list), 0, GST_TYPE_TAG_LIST,
702 (GstMiniObjectCopyFunction) __gst_tag_list_copy, NULL,
703 (GstMiniObjectFreeFunction) __gst_tag_list_free);
705 GST_TAG_LIST_STRUCTURE (tag_list) = s;
706 GST_TAG_LIST_SCOPE (tag_list) = scope;
708 #ifdef DEBUG_REFCOUNT
709 GST_CAT_TRACE (GST_CAT_TAGS, "created taglist %p", tag_list);
716 __gst_tag_list_free (GstTagList * list)
718 g_return_if_fail (GST_IS_TAG_LIST (list));
720 #ifdef DEBUG_REFCOUNT
721 GST_CAT_TRACE (GST_CAT_TAGS, "freeing taglist %p", list);
724 gst_structure_free (GST_TAG_LIST_STRUCTURE (list));
727 memset (list, 0xff, sizeof (GstTagListImpl));
730 g_slice_free1 (sizeof (GstTagListImpl), list);
734 __gst_tag_list_copy (const GstTagList * list)
736 const GstStructure *s;
738 g_return_val_if_fail (GST_IS_TAG_LIST (list), NULL);
740 s = GST_TAG_LIST_STRUCTURE (list);
741 return gst_tag_list_new_internal (gst_structure_copy (s),
742 GST_TAG_LIST_SCOPE (list));
746 * gst_tag_list_new_empty:
748 * Creates a new empty GstTagList.
750 * Free-function: gst_tag_list_unref
752 * Returns: (transfer full): An empty tag list
755 gst_tag_list_new_empty (void)
758 GstTagList *tag_list;
760 s = gst_structure_new_id_empty (GST_QUARK (TAGLIST));
761 tag_list = gst_tag_list_new_internal (s, GST_TAG_SCOPE_STREAM);
768 * @...: %NULL-terminated list of values to set
770 * Creates a new taglist and appends the values for the given tags. It expects
771 * tag-value pairs like gst_tag_list_add(), and a %NULL terminator after the
772 * last pair. The type of the values is implicit and is documented in the API
773 * reference, but can also be queried at runtime with gst_tag_get_type(). It
774 * is an error to pass a value of a type not matching the tag type into this
775 * function. The tag list will make copies of any arguments passed
776 * (e.g. strings, buffers).
778 * After creation you might also want to set a #GstTagScope on the returned
779 * taglist to signal if the contained tags are global or stream tags. By
780 * default stream scope is assumes. See gst_tag_list_set_scope().
782 * Free-function: gst_tag_list_unref
784 * Returns: (transfer full): a new #GstTagList. Free with gst_tag_list_unref()
785 * when no longer needed.
788 gst_tag_list_new (const gchar * tag, ...)
793 g_return_val_if_fail (tag != NULL, NULL);
795 list = gst_tag_list_new_empty ();
796 va_start (args, tag);
797 gst_tag_list_add_valist (list, GST_TAG_MERGE_APPEND, tag, args);
804 * gst_tag_list_new_valist:
805 * @var_args: tag / value pairs to set
807 * Just like gst_tag_list_new(), only that it takes a va_list argument.
808 * Useful mostly for language bindings.
810 * Free-function: gst_tag_list_unref
812 * Returns: (transfer full): a new #GstTagList. Free with gst_tag_list_unref()
813 * when no longer needed.
816 gst_tag_list_new_valist (va_list var_args)
821 list = gst_tag_list_new_empty ();
823 tag = va_arg (var_args, gchar *);
824 gst_tag_list_add_valist (list, GST_TAG_MERGE_APPEND, tag, var_args);
830 * gst_tag_list_set_scope:
831 * @list: a #GstTagList
832 * @scope: new scope for @list
834 * Sets the scope of @list to @scope. By default the scope
835 * of a taglist is stream scope.
839 gst_tag_list_set_scope (GstTagList * list, GstTagScope scope)
841 g_return_if_fail (GST_IS_TAG_LIST (list));
842 g_return_if_fail (gst_tag_list_is_writable (list));
844 GST_TAG_LIST_SCOPE (list) = scope;
848 * gst_tag_list_get_scope:
849 * @list: a #GstTagList
851 * Gets the scope of @list.
853 * Returns: The scope of @list
856 gst_tag_list_get_scope (const GstTagList * list)
858 g_return_val_if_fail (GST_IS_TAG_LIST (list), GST_TAG_SCOPE_STREAM);
860 return GST_TAG_LIST_SCOPE (list);
864 * gst_tag_list_to_string:
865 * @list: a #GstTagList
867 * Serializes a tag list to a string.
869 * Returns: (nullable): a newly-allocated string, or %NULL in case of
870 * an error. The string must be freed with g_free() when no longer
874 gst_tag_list_to_string (const GstTagList * list)
876 g_return_val_if_fail (GST_IS_TAG_LIST (list), NULL);
878 return gst_structure_to_string (GST_TAG_LIST_STRUCTURE (list));
882 * gst_tag_list_new_from_string:
883 * @str: a string created with gst_tag_list_to_string()
885 * Deserializes a tag list.
887 * Returns: (nullable): a new #GstTagList, or %NULL in case of an
891 gst_tag_list_new_from_string (const gchar * str)
893 GstTagList *tag_list;
896 g_return_val_if_fail (str != NULL, NULL);
897 g_return_val_if_fail (g_str_has_prefix (str, "taglist"), NULL);
899 s = gst_structure_from_string (str, NULL);
903 tag_list = gst_tag_list_new_internal (s, GST_TAG_SCOPE_STREAM);
909 * gst_tag_list_n_tags:
910 * @list: A #GstTagList.
912 * Get the number of tags in @list.
914 * Returns: The number of tags in @list.
917 gst_tag_list_n_tags (const GstTagList * list)
919 g_return_val_if_fail (list != NULL, 0);
920 g_return_val_if_fail (GST_IS_TAG_LIST (list), 0);
922 return gst_structure_n_fields (GST_TAG_LIST_STRUCTURE (list));
926 * gst_tag_list_nth_tag_name:
927 * @list: A #GstTagList.
930 * Get the name of the tag in @list at @index.
932 * Returns: The name of the tag at @index.
935 gst_tag_list_nth_tag_name (const GstTagList * list, guint index)
937 g_return_val_if_fail (list != NULL, 0);
938 g_return_val_if_fail (GST_IS_TAG_LIST (list), 0);
940 return gst_structure_nth_field_name (GST_TAG_LIST_STRUCTURE (list), index);
944 * gst_tag_list_is_empty:
945 * @list: A #GstTagList.
947 * Checks if the given taglist is empty.
949 * Returns: %TRUE if the taglist is empty, otherwise %FALSE.
952 gst_tag_list_is_empty (const GstTagList * list)
954 g_return_val_if_fail (list != NULL, FALSE);
955 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
957 return (gst_structure_n_fields (GST_TAG_LIST_STRUCTURE (list)) == 0);
961 gst_tag_list_fields_equal (const GValue * value1, const GValue * value2)
965 if (gst_value_compare (value1, value2) == GST_VALUE_EQUAL)
968 /* fields not equal: add some tolerance for doubles, otherwise bail out */
969 if (!G_VALUE_HOLDS_DOUBLE (value1) || !G_VALUE_HOLDS_DOUBLE (value2))
972 d1 = g_value_get_double (value1);
973 d2 = g_value_get_double (value2);
975 /* This will only work for 'normal' values and values around 0,
976 * which should be good enough for our purposes here
977 * FIXME: maybe add this to gst_value_compare_double() ? */
978 return (fabs (d1 - d2) < 0.0000001);
982 * gst_tag_list_is_equal:
983 * @list1: a #GstTagList.
984 * @list2: a #GstTagList.
986 * Checks if the two given taglists are equal.
988 * Returns: %TRUE if the taglists are equal, otherwise %FALSE
991 gst_tag_list_is_equal (const GstTagList * list1, const GstTagList * list2)
993 const GstStructure *s1, *s2;
994 gint num_fields1, num_fields2, i;
996 g_return_val_if_fail (GST_IS_TAG_LIST (list1), FALSE);
997 g_return_val_if_fail (GST_IS_TAG_LIST (list2), FALSE);
999 /* we don't just use gst_structure_is_equal() here so we can add some
1000 * tolerance for doubles, though maybe we should just add that to
1001 * gst_value_compare_double() as well? */
1002 s1 = GST_TAG_LIST_STRUCTURE (list1);
1003 s2 = GST_TAG_LIST_STRUCTURE (list2);
1005 num_fields1 = gst_structure_n_fields (s1);
1006 num_fields2 = gst_structure_n_fields (s2);
1008 if (num_fields1 != num_fields2)
1011 for (i = 0; i < num_fields1; i++) {
1012 const GValue *value1, *value2;
1013 const gchar *tag_name;
1015 tag_name = gst_structure_nth_field_name (s1, i);
1016 value1 = gst_structure_get_value (s1, tag_name);
1017 value2 = gst_structure_get_value (s2, tag_name);
1022 if (!gst_tag_list_fields_equal (value1, value2))
1032 GstTagMergeMode mode;
1037 gst_tag_list_add_value_internal (GstTagList * tag_list, GstTagMergeMode mode,
1038 const gchar * tag, const GValue * value, GstTagInfo * info)
1040 GstStructure *list = GST_TAG_LIST_STRUCTURE (tag_list);
1041 const GValue *value2;
1045 info = gst_tag_lookup (tag);
1046 if (G_UNLIKELY (info == NULL)) {
1047 g_warning ("unknown tag '%s'", tag);
1052 if (G_UNLIKELY (!G_VALUE_HOLDS (value, info->type) &&
1053 !GST_VALUE_HOLDS_LIST (value))) {
1054 g_warning ("tag '%s' should hold value of type '%s', but value of "
1055 "type '%s' passed", info->nick, g_type_name (info->type),
1056 g_type_name (G_VALUE_TYPE (value)));
1060 tag_quark = info->name_quark;
1062 if (info->merge_func
1063 && (value2 = gst_structure_id_get_value (list, tag_quark)) != NULL) {
1064 GValue dest = { 0, };
1067 case GST_TAG_MERGE_REPLACE_ALL:
1068 case GST_TAG_MERGE_REPLACE:
1069 gst_structure_id_set_value (list, tag_quark, value);
1071 case GST_TAG_MERGE_PREPEND:
1072 if (GST_VALUE_HOLDS_LIST (value2) && !GST_VALUE_HOLDS_LIST (value))
1073 gst_value_list_prepend_value ((GValue *) value2, value);
1075 gst_value_list_merge (&dest, value, value2);
1076 gst_structure_id_take_value (list, tag_quark, &dest);
1079 case GST_TAG_MERGE_APPEND:
1080 if (GST_VALUE_HOLDS_LIST (value2) && !GST_VALUE_HOLDS_LIST (value))
1081 gst_value_list_append_value ((GValue *) value2, value);
1083 gst_value_list_merge (&dest, value2, value);
1084 gst_structure_id_take_value (list, tag_quark, &dest);
1087 case GST_TAG_MERGE_KEEP:
1088 case GST_TAG_MERGE_KEEP_ALL:
1091 g_assert_not_reached ();
1096 case GST_TAG_MERGE_APPEND:
1097 case GST_TAG_MERGE_KEEP:
1098 if (gst_structure_id_get_value (list, tag_quark) != NULL)
1101 case GST_TAG_MERGE_REPLACE_ALL:
1102 case GST_TAG_MERGE_REPLACE:
1103 case GST_TAG_MERGE_PREPEND:
1104 gst_structure_id_set_value (list, tag_quark, value);
1106 case GST_TAG_MERGE_KEEP_ALL:
1109 g_assert_not_reached ();
1116 gst_tag_list_copy_foreach (GQuark tag_quark, const GValue * value,
1119 GstTagCopyData *copy = (GstTagCopyData *) user_data;
1122 tag = g_quark_to_string (tag_quark);
1123 gst_tag_list_add_value_internal (copy->list, copy->mode, tag, value, NULL);
1129 * gst_tag_list_insert:
1130 * @into: list to merge into
1131 * @from: list to merge from
1132 * @mode: the mode to use
1134 * Inserts the tags of the @from list into the first list using the given mode.
1137 gst_tag_list_insert (GstTagList * into, const GstTagList * from,
1138 GstTagMergeMode mode)
1140 GstTagCopyData data;
1142 g_return_if_fail (GST_IS_TAG_LIST (into));
1143 g_return_if_fail (gst_tag_list_is_writable (into));
1144 g_return_if_fail (GST_IS_TAG_LIST (from));
1145 g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
1149 if (mode == GST_TAG_MERGE_REPLACE_ALL) {
1150 gst_structure_remove_all_fields (GST_TAG_LIST_STRUCTURE (into));
1152 gst_structure_foreach (GST_TAG_LIST_STRUCTURE (from),
1153 gst_tag_list_copy_foreach, &data);
1157 * gst_tag_list_merge:
1158 * @list1: (allow-none): first list to merge
1159 * @list2: (allow-none): second list to merge
1160 * @mode: the mode to use
1162 * Merges the two given lists into a new list. If one of the lists is %NULL, a
1163 * copy of the other is returned. If both lists are %NULL, %NULL is returned.
1165 * Free-function: gst_tag_list_unref
1167 * Returns: (transfer full) (nullable): the new list
1170 gst_tag_list_merge (const GstTagList * list1, const GstTagList * list2,
1171 GstTagMergeMode mode)
1173 GstTagList *list1_cp;
1174 const GstTagList *list2_cp;
1176 g_return_val_if_fail (list1 == NULL || GST_IS_TAG_LIST (list1), NULL);
1177 g_return_val_if_fail (list2 == NULL || GST_IS_TAG_LIST (list2), NULL);
1178 g_return_val_if_fail (GST_TAG_MODE_IS_VALID (mode), NULL);
1180 /* nothing to merge */
1181 if (!list1 && !list2) {
1185 /* create empty list, we need to do this to correctly handling merge modes */
1186 list1_cp = (list1) ? gst_tag_list_copy (list1) : gst_tag_list_new_empty ();
1187 list2_cp = (list2) ? list2 : gst_tag_list_new_empty ();
1189 gst_tag_list_insert (list1_cp, list2_cp, mode);
1192 gst_tag_list_unref ((GstTagList *) list2_cp);
1198 * gst_tag_list_get_tag_size:
1200 * @tag: the tag to query
1202 * Checks how many value are stored in this tag list for the given tag.
1204 * Returns: The number of tags stored
1207 gst_tag_list_get_tag_size (const GstTagList * list, const gchar * tag)
1209 const GValue *value;
1211 g_return_val_if_fail (GST_IS_TAG_LIST (list), 0);
1213 value = gst_structure_get_value (GST_TAG_LIST_STRUCTURE (list), tag);
1216 if (G_VALUE_TYPE (value) != GST_TYPE_LIST)
1219 return gst_value_list_get_size (value);
1224 * @list: list to set tags in
1225 * @mode: the mode to use
1227 * @...: %NULL-terminated list of values to set
1229 * Sets the values for the given tags using the specified mode.
1232 gst_tag_list_add (GstTagList * list, GstTagMergeMode mode, const gchar * tag,
1237 g_return_if_fail (GST_IS_TAG_LIST (list));
1238 g_return_if_fail (gst_tag_list_is_writable (list));
1239 g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
1240 g_return_if_fail (tag != NULL);
1242 va_start (args, tag);
1243 gst_tag_list_add_valist (list, mode, tag, args);
1248 * gst_tag_list_add_values:
1249 * @list: list to set tags in
1250 * @mode: the mode to use
1252 * @...: GValues to set
1254 * Sets the GValues for the given tags using the specified mode.
1257 gst_tag_list_add_values (GstTagList * list, GstTagMergeMode mode,
1258 const gchar * tag, ...)
1262 g_return_if_fail (GST_IS_TAG_LIST (list));
1263 g_return_if_fail (gst_tag_list_is_writable (list));
1264 g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
1265 g_return_if_fail (tag != NULL);
1267 va_start (args, tag);
1268 gst_tag_list_add_valist_values (list, mode, tag, args);
1273 * gst_tag_list_add_valist:
1274 * @list: list to set tags in
1275 * @mode: the mode to use
1277 * @var_args: tag / value pairs to set
1279 * Sets the values for the given tags using the specified mode.
1282 gst_tag_list_add_valist (GstTagList * list, GstTagMergeMode mode,
1283 const gchar * tag, va_list var_args)
1286 gchar *error = NULL;
1288 g_return_if_fail (GST_IS_TAG_LIST (list));
1289 g_return_if_fail (gst_tag_list_is_writable (list));
1290 g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
1291 g_return_if_fail (tag != NULL);
1293 if (mode == GST_TAG_MERGE_REPLACE_ALL) {
1294 gst_structure_remove_all_fields (GST_TAG_LIST_STRUCTURE (list));
1297 while (tag != NULL) {
1298 GValue value = { 0, };
1300 info = gst_tag_lookup (tag);
1301 if (G_UNLIKELY (info == NULL)) {
1302 g_warning ("unknown tag '%s'", tag);
1305 G_VALUE_COLLECT_INIT (&value, info->type, var_args, 0, &error);
1307 g_warning ("%s: %s", G_STRLOC, error);
1309 /* we purposely leak the value here, it might not be
1310 * in a sane state if an error condition occurred
1314 /* Facilitate GstBuffer -> GstSample transition */
1315 if (G_UNLIKELY (info->type == GST_TYPE_SAMPLE &&
1316 !GST_IS_SAMPLE (value.data[0].v_pointer))) {
1317 g_warning ("Expected GstSample argument for tag '%s'", tag);
1319 gst_tag_list_add_value_internal (list, mode, tag, &value, info);
1321 g_value_unset (&value);
1322 tag = va_arg (var_args, gchar *);
1327 * gst_tag_list_add_valist_values:
1328 * @list: list to set tags in
1329 * @mode: the mode to use
1331 * @var_args: tag / GValue pairs to set
1333 * Sets the GValues for the given tags using the specified mode.
1336 gst_tag_list_add_valist_values (GstTagList * list, GstTagMergeMode mode,
1337 const gchar * tag, va_list var_args)
1339 g_return_if_fail (GST_IS_TAG_LIST (list));
1340 g_return_if_fail (gst_tag_list_is_writable (list));
1341 g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
1342 g_return_if_fail (tag != NULL);
1344 if (mode == GST_TAG_MERGE_REPLACE_ALL) {
1345 gst_structure_remove_all_fields (GST_TAG_LIST_STRUCTURE (list));
1348 while (tag != NULL) {
1351 info = gst_tag_lookup (tag);
1352 if (G_UNLIKELY (info == NULL)) {
1353 g_warning ("unknown tag '%s'", tag);
1356 gst_tag_list_add_value_internal (list, mode, tag, va_arg (var_args,
1358 tag = va_arg (var_args, gchar *);
1363 * gst_tag_list_add_value:
1364 * @list: list to set tags in
1365 * @mode: the mode to use
1367 * @value: GValue for this tag
1369 * Sets the GValue for a given tag using the specified mode.
1372 gst_tag_list_add_value (GstTagList * list, GstTagMergeMode mode,
1373 const gchar * tag, const GValue * value)
1375 g_return_if_fail (GST_IS_TAG_LIST (list));
1376 g_return_if_fail (gst_tag_list_is_writable (list));
1377 g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
1378 g_return_if_fail (tag != NULL);
1380 gst_tag_list_add_value_internal (list, mode, tag, value, NULL);
1384 * gst_tag_list_remove_tag:
1385 * @list: list to remove tag from
1386 * @tag: tag to remove
1388 * Removes the given tag from the taglist.
1391 gst_tag_list_remove_tag (GstTagList * list, const gchar * tag)
1393 g_return_if_fail (GST_IS_TAG_LIST (list));
1394 g_return_if_fail (gst_tag_list_is_writable (list));
1395 g_return_if_fail (tag != NULL);
1397 gst_structure_remove_field (GST_TAG_LIST_STRUCTURE (list), tag);
1402 GstTagForeachFunc func;
1403 const GstTagList *tag_list;
1409 structure_foreach_wrapper (GQuark field_id, const GValue * value,
1412 TagForeachData *data = (TagForeachData *) user_data;
1414 data->func (data->tag_list, g_quark_to_string (field_id), data->data);
1419 * gst_tag_list_foreach:
1420 * @list: list to iterate over
1421 * @func: (scope call): function to be called for each tag
1422 * @user_data: (closure): user specified data
1424 * Calls the given function for each tag inside the tag list. Note that if there
1425 * is no tag, the function won't be called at all.
1428 gst_tag_list_foreach (const GstTagList * list, GstTagForeachFunc func,
1431 TagForeachData data;
1433 g_return_if_fail (GST_IS_TAG_LIST (list));
1434 g_return_if_fail (func != NULL);
1437 data.tag_list = list;
1438 data.data = user_data;
1439 gst_structure_foreach (GST_TAG_LIST_STRUCTURE (list),
1440 structure_foreach_wrapper, &data);
1444 * gst_tag_list_get_value_index:
1445 * @list: a #GstTagList
1446 * @tag: tag to read out
1447 * @index: number of entry to read out
1449 * Gets the value that is at the given index for the given tag in the given
1452 * Returns: (transfer none) (nullable): The GValue for the specified
1453 * entry or %NULL if the tag wasn't available or the tag
1454 * doesn't have as many entries
1457 gst_tag_list_get_value_index (const GstTagList * list, const gchar * tag,
1460 const GValue *value;
1462 g_return_val_if_fail (GST_IS_TAG_LIST (list), NULL);
1463 g_return_val_if_fail (tag != NULL, NULL);
1465 value = gst_structure_get_value (GST_TAG_LIST_STRUCTURE (list), tag);
1469 if (GST_VALUE_HOLDS_LIST (value)) {
1470 if (index >= gst_value_list_get_size (value))
1472 return gst_value_list_get_value (value, index);
1481 * gst_tag_list_copy_value:
1482 * @dest: (out caller-allocates): uninitialized #GValue to copy into
1483 * @list: list to get the tag from
1484 * @tag: tag to read out
1486 * Copies the contents for the given tag into the value,
1487 * merging multiple values into one if multiple values are associated
1489 * You must g_value_unset() the value after use.
1491 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1495 gst_tag_list_copy_value (GValue * dest, const GstTagList * list,
1500 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
1501 g_return_val_if_fail (tag != NULL, FALSE);
1502 g_return_val_if_fail (dest != NULL, FALSE);
1503 g_return_val_if_fail (G_VALUE_TYPE (dest) == 0, FALSE);
1505 src = gst_structure_get_value (GST_TAG_LIST_STRUCTURE (list), tag);
1509 if (G_VALUE_TYPE (src) == GST_TYPE_LIST) {
1510 GstTagInfo *info = gst_tag_lookup (tag);
1515 /* must be there or lists aren't allowed */
1516 g_assert (info->merge_func);
1517 info->merge_func (dest, src);
1519 g_value_init (dest, G_VALUE_TYPE (src));
1520 g_value_copy (src, dest);
1525 /* FIXME 2.0: this whole merge function business is overdesigned, and the
1526 * _get_foo() API is misleading as well - how many application developers will
1527 * expect gst_tag_list_get_string (list, GST_TAG_ARTIST, &val) might return a
1528 * string with multiple comma-separated artists? _get_foo() should just be
1529 * a convenience wrapper around _get_foo_index (list, tag, 0, &val),
1530 * supplemented by a special _tag_list_get_string_merged() function if needed
1531 * (unless someone can actually think of real use cases where the merge
1532 * function is not 'use first' for non-strings and merge for strings) */
1534 /***** evil macros to get all the gst_tag_list_get_*() functions right *****/
1536 #define TAG_MERGE_FUNCS(name,type,ret) \
1538 gst_tag_list_get_ ## name (const GstTagList *list, const gchar *tag, \
1541 GValue v = { 0, }; \
1543 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE); \
1544 g_return_val_if_fail (tag != NULL, FALSE); \
1545 g_return_val_if_fail (value != NULL, FALSE); \
1547 if (!gst_tag_list_copy_value (&v, list, tag)) \
1549 *value = COPY_FUNC (g_value_get_ ## name (&v)); \
1550 g_value_unset (&v); \
1555 gst_tag_list_get_ ## name ## _index (const GstTagList *list, \
1557 guint index, type *value) \
1561 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE); \
1562 g_return_val_if_fail (tag != NULL, FALSE); \
1563 g_return_val_if_fail (value != NULL, FALSE); \
1565 if ((v = gst_tag_list_get_value_index (list, tag, index)) == NULL) \
1567 *value = COPY_FUNC (g_value_get_ ## name (v)); \
1571 #define COPY_FUNC /**/
1573 * gst_tag_list_get_boolean:
1574 * @list: a #GstTagList to get the tag from
1575 * @tag: tag to read out
1576 * @value: (out): location for the result
1578 * Copies the contents for the given tag into the value, merging multiple values
1579 * into one if multiple values are associated with the tag.
1581 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1585 * gst_tag_list_get_boolean_index:
1586 * @list: a #GstTagList to get the tag from
1587 * @tag: tag to read out
1588 * @index: number of entry to read out
1589 * @value: (out): location for the result
1591 * Gets the value that is at the given index for the given tag in the given
1594 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1597 TAG_MERGE_FUNCS (boolean, gboolean, TRUE);
1599 * gst_tag_list_get_int:
1600 * @list: a #GstTagList to get the tag from
1601 * @tag: tag to read out
1602 * @value: (out): location for the result
1604 * Copies the contents for the given tag into the value, merging multiple values
1605 * into one if multiple values are associated with the tag.
1607 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1611 * gst_tag_list_get_int_index:
1612 * @list: a #GstTagList to get the tag from
1613 * @tag: tag to read out
1614 * @index: number of entry to read out
1615 * @value: (out): location for the result
1617 * Gets the value that is at the given index for the given tag in the given
1620 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1623 TAG_MERGE_FUNCS (int, gint, TRUE);
1625 * gst_tag_list_get_uint:
1626 * @list: a #GstTagList to get the tag from
1627 * @tag: tag to read out
1628 * @value: (out): location for the result
1630 * Copies the contents for the given tag into the value, merging multiple values
1631 * into one if multiple values are associated with the tag.
1633 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1637 * gst_tag_list_get_uint_index:
1638 * @list: a #GstTagList to get the tag from
1639 * @tag: tag to read out
1640 * @index: number of entry to read out
1641 * @value: (out): location for the result
1643 * Gets the value that is at the given index for the given tag in the given
1646 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1649 TAG_MERGE_FUNCS (uint, guint, TRUE);
1651 * gst_tag_list_get_int64:
1652 * @list: a #GstTagList to get the tag from
1653 * @tag: tag to read out
1654 * @value: (out): location for the result
1656 * Copies the contents for the given tag into the value, merging multiple values
1657 * into one if multiple values are associated with the tag.
1659 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1663 * gst_tag_list_get_int64_index:
1664 * @list: a #GstTagList to get the tag from
1665 * @tag: tag to read out
1666 * @index: number of entry to read out
1667 * @value: (out): location for the result
1669 * Gets the value that is at the given index for the given tag in the given
1672 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1675 TAG_MERGE_FUNCS (int64, gint64, TRUE);
1677 * gst_tag_list_get_uint64:
1678 * @list: a #GstTagList to get the tag from
1679 * @tag: tag to read out
1680 * @value: (out): location for the result
1682 * Copies the contents for the given tag into the value, merging multiple values
1683 * into one if multiple values are associated with the tag.
1685 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1689 * gst_tag_list_get_uint64_index:
1690 * @list: a #GstTagList to get the tag from
1691 * @tag: tag to read out
1692 * @index: number of entry to read out
1693 * @value: (out): location for the result
1695 * Gets the value that is at the given index for the given tag in the given
1698 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1701 TAG_MERGE_FUNCS (uint64, guint64, TRUE);
1703 * gst_tag_list_get_float:
1704 * @list: a #GstTagList to get the tag from
1705 * @tag: tag to read out
1706 * @value: (out): location for the result
1708 * Copies the contents for the given tag into the value, merging multiple values
1709 * into one if multiple values are associated with the tag.
1711 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1715 * gst_tag_list_get_float_index:
1716 * @list: a #GstTagList to get the tag from
1717 * @tag: tag to read out
1718 * @index: number of entry to read out
1719 * @value: (out): location for the result
1721 * Gets the value that is at the given index for the given tag in the given
1724 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1727 TAG_MERGE_FUNCS (float, gfloat, TRUE);
1729 * gst_tag_list_get_double:
1730 * @list: a #GstTagList to get the tag from
1731 * @tag: tag to read out
1732 * @value: (out): location for the result
1734 * Copies the contents for the given tag into the value, merging multiple values
1735 * into one if multiple values are associated with the tag.
1737 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1741 * gst_tag_list_get_double_index:
1742 * @list: a #GstTagList to get the tag from
1743 * @tag: tag to read out
1744 * @index: number of entry to read out
1745 * @value: (out): location for the result
1747 * Gets the value that is at the given index for the given tag in the given
1750 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1753 TAG_MERGE_FUNCS (double, gdouble, TRUE);
1755 * gst_tag_list_get_pointer:
1756 * @list: a #GstTagList to get the tag from
1757 * @tag: tag to read out
1758 * @value: (out) (transfer none): location for the result
1760 * Copies the contents for the given tag into the value, merging multiple values
1761 * into one if multiple values are associated with the tag.
1763 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1767 * gst_tag_list_get_pointer_index:
1768 * @list: a #GstTagList to get the tag from
1769 * @tag: tag to read out
1770 * @index: number of entry to read out
1771 * @value: (out) (transfer none): location for the result
1773 * Gets the value that is at the given index for the given tag in the given
1776 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1779 TAG_MERGE_FUNCS (pointer, gpointer, (*value != NULL));
1781 static inline gchar *
1782 _gst_strdup0 (const gchar * s)
1784 if (s == NULL || *s == '\0')
1787 return g_strdup (s);
1791 #define COPY_FUNC _gst_strdup0
1794 * gst_tag_list_get_string:
1795 * @list: a #GstTagList to get the tag from
1796 * @tag: tag to read out
1797 * @value: (out callee-allocates) (transfer full): location for the result
1799 * Copies the contents for the given tag into the value, possibly merging
1800 * multiple values into one if multiple values are associated with the tag.
1802 * Use gst_tag_list_get_string_index (list, tag, 0, value) if you want
1803 * to retrieve the first string associated with this tag unmodified.
1805 * The resulting string in @value will be in UTF-8 encoding and should be
1806 * freed by the caller using g_free when no longer needed. The
1807 * returned string is also guaranteed to be non-%NULL and non-empty.
1809 * Free-function: g_free
1811 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1815 * gst_tag_list_get_string_index:
1816 * @list: a #GstTagList to get the tag from
1817 * @tag: tag to read out
1818 * @index: number of entry to read out
1819 * @value: (out callee-allocates) (transfer full): location for the result
1821 * Gets the value that is at the given index for the given tag in the given
1824 * The resulting string in @value will be in UTF-8 encoding and should be
1825 * freed by the caller using g_free when no longer needed. The
1826 * returned string is also guaranteed to be non-%NULL and non-empty.
1828 * Free-function: g_free
1830 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1833 TAG_MERGE_FUNCS (string, gchar *, (*value != NULL));
1836 *FIXME 2.0: Instead of _peek (non-copy) and _get (copy), we could have
1837 * _get (non-copy) and _dup (copy) for strings, seems more
1841 * gst_tag_list_peek_string_index:
1842 * @list: a #GstTagList to get the tag from
1843 * @tag: tag to read out
1844 * @index: number of entry to read out
1845 * @value: (out) (transfer none): location for the result
1847 * Peeks at the value that is at the given index for the given tag in the given
1850 * The resulting string in @value will be in UTF-8 encoding and doesn't need
1851 * to be freed by the caller. The returned string is also guaranteed to
1852 * be non-%NULL and non-empty.
1854 * Returns: %TRUE, if a value was set, %FALSE if the tag didn't exist in the
1858 gst_tag_list_peek_string_index (const GstTagList * list,
1859 const gchar * tag, guint index, const gchar ** value)
1863 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
1864 g_return_val_if_fail (tag != NULL, FALSE);
1865 g_return_val_if_fail (value != NULL, FALSE);
1867 if ((v = gst_tag_list_get_value_index (list, tag, index)) == NULL)
1869 *value = g_value_get_string (v);
1870 return *value != NULL && **value != '\0';
1874 * gst_tag_list_get_date:
1875 * @list: a #GstTagList to get the tag from
1876 * @tag: tag to read out
1877 * @value: (out callee-allocates) (transfer full): address of a GDate pointer
1878 * variable to store the result into
1880 * Copies the first date for the given tag in the taglist into the variable
1881 * pointed to by @value. Free the date with g_date_free() when it is no longer
1884 * Free-function: g_date_free
1886 * Returns: %TRUE, if a date was copied, %FALSE if the tag didn't exist in the
1887 * given list or if it was %NULL.
1890 gst_tag_list_get_date (const GstTagList * list, const gchar * tag,
1895 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
1896 g_return_val_if_fail (tag != NULL, FALSE);
1897 g_return_val_if_fail (value != NULL, FALSE);
1899 if (!gst_tag_list_copy_value (&v, list, tag))
1901 *value = (GDate *) g_value_dup_boxed (&v);
1903 return (*value != NULL);
1907 * gst_tag_list_get_date_index:
1908 * @list: a #GstTagList to get the tag from
1909 * @tag: tag to read out
1910 * @index: number of entry to read out
1911 * @value: (out callee-allocates) (transfer full): location for the result
1913 * Gets the date that is at the given index for the given tag in the given
1914 * list and copies it into the variable pointed to by @value. Free the date
1915 * with g_date_free() when it is no longer needed.
1917 * Free-function: g_date_free
1919 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1920 * given list or if it was %NULL.
1923 gst_tag_list_get_date_index (const GstTagList * list,
1924 const gchar * tag, guint index, GDate ** value)
1928 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
1929 g_return_val_if_fail (tag != NULL, FALSE);
1930 g_return_val_if_fail (value != NULL, FALSE);
1932 if ((v = gst_tag_list_get_value_index (list, tag, index)) == NULL)
1934 *value = (GDate *) g_value_dup_boxed (v);
1935 return (*value != NULL);
1939 * gst_tag_list_get_date_time:
1940 * @list: a #GstTagList to get the tag from
1941 * @tag: tag to read out
1942 * @value: (out callee-allocates) (transfer full): address of a #GstDateTime
1943 * pointer variable to store the result into
1945 * Copies the first datetime for the given tag in the taglist into the variable
1946 * pointed to by @value. Unref the date with gst_date_time_unref() when
1947 * it is no longer needed.
1949 * Free-function: gst_date_time_unref
1951 * Returns: %TRUE, if a datetime was copied, %FALSE if the tag didn't exist in
1952 * the given list or if it was %NULL.
1955 gst_tag_list_get_date_time (const GstTagList * list, const gchar * tag,
1956 GstDateTime ** value)
1960 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
1961 g_return_val_if_fail (tag != NULL, FALSE);
1962 g_return_val_if_fail (value != NULL, FALSE);
1964 if (!gst_tag_list_copy_value (&v, list, tag))
1967 *value = (GstDateTime *) g_value_dup_boxed (&v);
1969 return (*value != NULL);
1973 * gst_tag_list_get_date_time_index:
1974 * @list: a #GstTagList to get the tag from
1975 * @tag: tag to read out
1976 * @index: number of entry to read out
1977 * @value: (out callee-allocates) (transfer full): location for the result
1979 * Gets the datetime that is at the given index for the given tag in the given
1980 * list and copies it into the variable pointed to by @value. Unref the datetime
1981 * with gst_date_time_unref() when it is no longer needed.
1983 * Free-function: gst_date_time_unref
1985 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1986 * given list or if it was %NULL.
1989 gst_tag_list_get_date_time_index (const GstTagList * list,
1990 const gchar * tag, guint index, GstDateTime ** value)
1994 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
1995 g_return_val_if_fail (tag != NULL, FALSE);
1996 g_return_val_if_fail (value != NULL, FALSE);
1998 if ((v = gst_tag_list_get_value_index (list, tag, index)) == NULL)
2000 *value = (GstDateTime *) g_value_dup_boxed (v);
2001 return (*value != NULL);
2005 * gst_tag_list_get_sample:
2006 * @list: a #GstTagList to get the tag from
2007 * @tag: tag to read out
2008 * @sample: (out callee-allocates) (transfer full): address of a GstSample
2009 * pointer variable to store the result into
2011 * Copies the first sample for the given tag in the taglist into the variable
2012 * pointed to by @sample. Free the sample with gst_sample_unref() when it is
2013 * no longer needed. You can retrieve the buffer from the sample using
2014 * gst_sample_get_buffer() and the associated caps (if any) with
2015 * gst_sample_get_caps().
2017 * Free-function: gst_sample_unref
2019 * Returns: %TRUE, if a sample was returned, %FALSE if the tag didn't exist in
2020 * the given list or if it was %NULL.
2023 gst_tag_list_get_sample (const GstTagList * list, const gchar * tag,
2024 GstSample ** sample)
2028 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
2029 g_return_val_if_fail (tag != NULL, FALSE);
2030 g_return_val_if_fail (sample != NULL, FALSE);
2032 if (!gst_tag_list_copy_value (&v, list, tag))
2034 *sample = g_value_dup_boxed (&v);
2036 return (*sample != NULL);
2040 * gst_tag_list_get_sample_index:
2041 * @list: a #GstTagList to get the tag from
2042 * @tag: tag to read out
2043 * @index: number of entry to read out
2044 * @sample: (out callee-allocates) (transfer full): address of a GstSample
2045 * pointer variable to store the result into
2047 * Gets the sample that is at the given index for the given tag in the given
2048 * list and copies it into the variable pointed to by @sample. Free the sample
2049 * with gst_sample_unref() when it is no longer needed. You can retrieve the
2050 * buffer from the sample using gst_sample_get_buffer() and the associated
2051 * caps (if any) with gst_sample_get_caps().
2053 * Free-function: gst_sample_unref
2055 * Returns: %TRUE, if a sample was copied, %FALSE if the tag didn't exist in the
2056 * given list or if it was %NULL.
2059 gst_tag_list_get_sample_index (const GstTagList * list,
2060 const gchar * tag, guint index, GstSample ** sample)
2064 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
2065 g_return_val_if_fail (tag != NULL, FALSE);
2066 g_return_val_if_fail (sample != NULL, FALSE);
2068 if ((v = gst_tag_list_get_value_index (list, tag, index)) == NULL)
2070 *sample = g_value_dup_boxed (v);
2071 return (*sample != NULL);