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 gst_tag_register_static (GST_TAG_PREVIEW_IMAGE, GST_TAG_FLAG_META,
287 /* TRANSLATORS: 'preview image' = image that shows a preview of the full image */
288 _("preview image"), _("preview image related to this stream"), NULL);
289 gst_tag_register_static (GST_TAG_ATTACHMENT, GST_TAG_FLAG_META,
290 GST_TYPE_SAMPLE, _("attachment"), _("file attached to this stream"),
291 gst_tag_merge_use_first);
292 gst_tag_register_static (GST_TAG_BEATS_PER_MINUTE, GST_TAG_FLAG_META,
293 G_TYPE_DOUBLE, _("beats per minute"),
294 _("number of beats per minute in audio"), NULL);
295 gst_tag_register_static (GST_TAG_KEYWORDS, GST_TAG_FLAG_META, G_TYPE_STRING,
296 _("keywords"), _("comma separated keywords describing the content"),
297 gst_tag_merge_strings_with_comma);
298 gst_tag_register_static (GST_TAG_GEO_LOCATION_NAME, GST_TAG_FLAG_META,
299 G_TYPE_STRING, _("geo location name"),
300 _("human readable descriptive location of where "
301 "the media has been recorded or produced"), NULL);
302 gst_tag_register_static (GST_TAG_GEO_LOCATION_LATITUDE, GST_TAG_FLAG_META,
303 G_TYPE_DOUBLE, _("geo location latitude"),
304 _("geo latitude location of where the media has been recorded or "
305 "produced in degrees according to WGS84 (zero at the equator, "
306 "negative values for southern latitudes)"), NULL);
307 gst_tag_register_static (GST_TAG_GEO_LOCATION_LONGITUDE, GST_TAG_FLAG_META,
308 G_TYPE_DOUBLE, _("geo location longitude"),
309 _("geo longitude location of where the media has been recorded or "
310 "produced in degrees according to WGS84 (zero at the prime meridian "
311 "in Greenwich/UK, negative values for western longitudes)"), NULL);
312 gst_tag_register_static (GST_TAG_GEO_LOCATION_ELEVATION, GST_TAG_FLAG_META,
313 G_TYPE_DOUBLE, _("geo location elevation"),
314 _("geo elevation of where the media has been recorded or produced in "
315 "meters according to WGS84 (zero is average sea level)"), NULL);
316 gst_tag_register_static (GST_TAG_GEO_LOCATION_COUNTRY, GST_TAG_FLAG_META,
317 G_TYPE_STRING, _("geo location country"),
318 _("country (english name) where the media has been recorded "
319 "or produced"), NULL);
320 gst_tag_register_static (GST_TAG_GEO_LOCATION_CITY, GST_TAG_FLAG_META,
321 G_TYPE_STRING, _("geo location city"),
322 _("city (english name) where the media has been recorded "
323 "or produced"), NULL);
324 gst_tag_register_static (GST_TAG_GEO_LOCATION_SUBLOCATION, GST_TAG_FLAG_META,
325 G_TYPE_STRING, _("geo location sublocation"),
326 _("a location within a city where the media has been produced "
327 "or created (e.g. the neighborhood)"), NULL);
328 gst_tag_register_static (GST_TAG_GEO_LOCATION_HORIZONTAL_ERROR,
329 GST_TAG_FLAG_META, G_TYPE_DOUBLE, _("geo location horizontal error"),
330 _("expected error of the horizontal positioning measures (in meters)"),
332 gst_tag_register_static (GST_TAG_GEO_LOCATION_MOVEMENT_SPEED,
333 GST_TAG_FLAG_META, G_TYPE_DOUBLE, _("geo location movement speed"),
334 _("movement speed of the capturing device while performing the capture "
336 gst_tag_register_static (GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION,
337 GST_TAG_FLAG_META, G_TYPE_DOUBLE, _("geo location movement direction"),
338 _("indicates the movement direction of the device performing the capture"
339 " of a media. It is represented as degrees in floating point "
340 "representation, 0 means the geographic north, and increases "
342 gst_tag_register_static (GST_TAG_GEO_LOCATION_CAPTURE_DIRECTION,
343 GST_TAG_FLAG_META, G_TYPE_DOUBLE, _("geo location capture direction"),
344 _("indicates the direction the device is pointing to when capturing "
345 " a media. It is represented as degrees in floating point "
346 " representation, 0 means the geographic north, and increases "
348 gst_tag_register_static (GST_TAG_SHOW_NAME, GST_TAG_FLAG_META, G_TYPE_STRING,
349 /* TRANSLATORS: 'show name' = 'TV/radio/podcast show name' here */
351 _("Name of the tv/podcast/series show the media is from"),
352 gst_tag_merge_strings_with_comma);
353 gst_tag_register_static (GST_TAG_SHOW_SORTNAME, GST_TAG_FLAG_META,
355 /* TRANSLATORS: 'show sortname' = 'TV/radio/podcast show name as used for sorting purposes' here */
357 _("Name of the tv/podcast/series show the media is from, for sorting "
359 gst_tag_register_static (GST_TAG_SHOW_EPISODE_NUMBER, GST_TAG_FLAG_META,
360 G_TYPE_UINT, _("episode number"),
361 _("The episode number in the season the media is part of"),
362 gst_tag_merge_use_first);
363 gst_tag_register_static (GST_TAG_SHOW_SEASON_NUMBER, GST_TAG_FLAG_META,
364 G_TYPE_UINT, _("season number"),
365 _("The season number of the show the media is part of"),
366 gst_tag_merge_use_first);
367 gst_tag_register_static (GST_TAG_LYRICS, GST_TAG_FLAG_META, G_TYPE_STRING,
368 _("lyrics"), _("The lyrics of the media, commonly used for songs"),
369 gst_tag_merge_strings_with_comma);
370 gst_tag_register_static (GST_TAG_COMPOSER_SORTNAME, GST_TAG_FLAG_META,
371 G_TYPE_STRING, _("composer sortname"),
372 _("person(s) who composed the recording, for sorting purposes"), NULL);
373 gst_tag_register_static (GST_TAG_GROUPING, GST_TAG_FLAG_META, G_TYPE_STRING,
375 _("Groups related media that spans multiple tracks, like the different "
376 "pieces of a concerto. It is a higher level than a track, "
377 "but lower than an album"), NULL);
378 gst_tag_register_static (GST_TAG_USER_RATING, GST_TAG_FLAG_META, G_TYPE_UINT,
380 _("Rating attributed by a user. The higher the rank, "
381 "the more the user likes this media"), NULL);
382 gst_tag_register_static (GST_TAG_DEVICE_MANUFACTURER, GST_TAG_FLAG_META,
383 G_TYPE_STRING, _("device manufacturer"),
384 _("Manufacturer of the device used to create this media"), NULL);
385 gst_tag_register_static (GST_TAG_DEVICE_MODEL, GST_TAG_FLAG_META,
386 G_TYPE_STRING, _("device model"),
387 _("Model of the device used to create this media"), NULL);
388 gst_tag_register_static (GST_TAG_APPLICATION_NAME, GST_TAG_FLAG_META,
389 G_TYPE_STRING, _("application name"),
390 _("Application used to create the media"), NULL);
391 gst_tag_register_static (GST_TAG_APPLICATION_DATA, GST_TAG_FLAG_META,
392 GST_TYPE_SAMPLE, _("application data"),
393 _("Arbitrary application data to be serialized into the media"), NULL);
394 gst_tag_register_static (GST_TAG_IMAGE_ORIENTATION, GST_TAG_FLAG_META,
395 G_TYPE_STRING, _("image orientation"),
396 _("How the image should be rotated or flipped before display"), NULL);
397 gst_tag_register_static (GST_TAG_PUBLISHER, GST_TAG_FLAG_META,
400 _("Name of the label or publisher"), gst_tag_merge_strings_with_comma);
401 gst_tag_register_static (GST_TAG_INTERPRETED_BY, GST_TAG_FLAG_META,
404 _("Information about the people behind a remix and similar "
405 "interpretations"), gst_tag_merge_strings_with_comma);
406 gst_tag_register_static (GST_TAG_MIDI_BASE_NOTE, GST_TAG_FLAG_META,
408 _("midi-base-note"), _("Midi note number of the audio track."), NULL);
409 gst_tag_register_static (GST_TAG_PRIVATE_DATA, GST_TAG_FLAG_META,
411 _("private-data"), _("Private data"), gst_tag_merge_use_first);
416 * gst_tag_merge_use_first:
417 * @dest: (out caller-allocates): uninitialized GValue to store result in
418 * @src: GValue to copy from
420 * This is a convenience function for the func argument of gst_tag_register().
421 * It creates a copy of the first value from the list.
424 gst_tag_merge_use_first (GValue * dest, const GValue * src)
426 const GValue *ret = gst_value_list_get_value (src, 0);
428 g_value_init (dest, G_VALUE_TYPE (ret));
429 g_value_copy (ret, dest);
433 * gst_tag_merge_strings_with_comma:
434 * @dest: (out caller-allocates): uninitialized GValue to store result in
435 * @src: GValue to copy from
437 * This is a convenience function for the func argument of gst_tag_register().
438 * It concatenates all given strings using a comma. The tag must be registered
439 * as a G_TYPE_STRING or this function will fail.
442 gst_tag_merge_strings_with_comma (GValue * dest, const GValue * src)
447 count = gst_value_list_get_size (src);
448 str = g_string_new (g_value_get_string (gst_value_list_get_value (src, 0)));
449 for (i = 1; i < count; i++) {
450 /* separator between two strings */
451 g_string_append (str, _(", "));
452 g_string_append (str,
453 g_value_get_string (gst_value_list_get_value (src, i)));
456 g_value_init (dest, G_TYPE_STRING);
457 g_value_take_string (dest, str->str);
458 g_string_free (str, FALSE);
462 gst_tag_lookup (const gchar * tag_name)
467 ret = g_hash_table_lookup (__tags, (gpointer) tag_name);
474 * gst_tag_register: (skip)
475 * @name: the name or identifier string
476 * @flag: a flag describing the type of tag info
477 * @type: the type this data is in
478 * @nick: human-readable name
479 * @blurb: a human-readable description about this tag
480 * @func: (allow-none): function for merging multiple values of this tag, or %NULL
482 * Registers a new tag type for the use with GStreamer's type system. If a type
483 * with that name is already registered, that one is used.
484 * The old registration may have used a different type however. So don't rely
485 * on your supplied values.
487 * Important: if you do not supply a merge function the implication will be
488 * that there can only be one single value for this tag in a tag list and
489 * any additional values will silently be discarded when being added (unless
490 * #GST_TAG_MERGE_REPLACE, #GST_TAG_MERGE_REPLACE_ALL, or
491 * #GST_TAG_MERGE_PREPEND is used as merge mode, in which case the new
492 * value will replace the old one in the list).
494 * The merge function will be called from gst_tag_list_copy_value() when
495 * it is required that one or more values for a tag be condensed into
496 * one single value. This may happen from gst_tag_list_get_string(),
497 * gst_tag_list_get_int(), gst_tag_list_get_double() etc. What will happen
498 * exactly in that case depends on how the tag was registered and if a
499 * merge function was supplied and if so which one.
501 * Two default merge functions are provided: gst_tag_merge_use_first() and
502 * gst_tag_merge_strings_with_comma().
505 gst_tag_register (const gchar * name, GstTagFlag flag, GType type,
506 const gchar * nick, const gchar * blurb, GstTagMergeFunc func)
508 g_return_if_fail (name != NULL);
509 g_return_if_fail (nick != NULL);
510 g_return_if_fail (blurb != NULL);
511 g_return_if_fail (type != 0 && type != GST_TYPE_LIST);
513 gst_tag_register_static (g_intern_string (name), flag, type,
514 g_intern_string (nick), g_intern_string (blurb), func);
518 * gst_tag_register_static: (skip)
519 * @name: the name or identifier string (string constant)
520 * @flag: a flag describing the type of tag info
521 * @type: the type this data is in
522 * @nick: human-readable name or short description (string constant)
523 * @blurb: a human-readable description for this tag (string constant)
524 * @func: (allow-none): function for merging multiple values of this tag, or %NULL
526 * Registers a new tag type for the use with GStreamer's type system.
528 * Same as gst_tag_register(), but @name, @nick, and @blurb must be
529 * static strings or inlined strings, as they will not be copied. (GStreamer
530 * plugins will be made resident once loaded, so this function can be used
531 * even from dynamically loaded plugins.)
534 gst_tag_register_static (const gchar * name, GstTagFlag flag, GType type,
535 const gchar * nick, const gchar * blurb, GstTagMergeFunc func)
539 g_return_if_fail (name != NULL);
540 g_return_if_fail (nick != NULL);
541 g_return_if_fail (blurb != NULL);
542 g_return_if_fail (type != 0 && type != GST_TYPE_LIST);
544 info = gst_tag_lookup (name);
547 g_return_if_fail (info->type == type);
551 info = g_slice_new (GstTagInfo);
554 info->name_quark = g_quark_from_static_string (name);
557 info->merge_func = func;
560 g_hash_table_insert (__tags, (gpointer) name, info);
566 * @tag: name of the tag
568 * Checks if the given type is already registered.
570 * Returns: %TRUE if the type is already registered
573 gst_tag_exists (const gchar * tag)
575 g_return_val_if_fail (tag != NULL, FALSE);
577 return gst_tag_lookup (tag) != NULL;
584 * Gets the #GType used for this tag.
586 * Returns: the #GType of this tag
589 gst_tag_get_type (const gchar * tag)
593 g_return_val_if_fail (tag != NULL, 0);
594 info = gst_tag_lookup (tag);
595 g_return_val_if_fail (info != NULL, 0);
604 * Returns the human-readable name of this tag, You must not change or free
607 * Returns: (nullable): the human-readable name of this tag
610 gst_tag_get_nick (const gchar * tag)
614 g_return_val_if_fail (tag != NULL, NULL);
615 info = gst_tag_lookup (tag);
617 GST_WARNING ("Unknown tag: %s", tag);
626 * gst_tag_get_description:
629 * Returns the human-readable description of this tag, You must not change or
632 * Returns: (nullable): the human-readable description of this tag
635 gst_tag_get_description (const gchar * tag)
639 g_return_val_if_fail (tag != NULL, NULL);
640 info = gst_tag_lookup (tag);
641 g_return_val_if_fail (info != NULL, NULL);
650 * Gets the flag of @tag.
652 * Returns: the flag of this tag.
655 gst_tag_get_flag (const gchar * tag)
659 g_return_val_if_fail (tag != NULL, GST_TAG_FLAG_UNDEFINED);
660 info = gst_tag_lookup (tag);
661 g_return_val_if_fail (info != NULL, GST_TAG_FLAG_UNDEFINED);
670 * Checks if the given tag is fixed. A fixed tag can only contain one value.
671 * Unfixed tags can contain lists of values.
673 * Returns: %TRUE, if the given tag is fixed.
676 gst_tag_is_fixed (const gchar * tag)
680 g_return_val_if_fail (tag != NULL, FALSE);
681 info = gst_tag_lookup (tag);
682 g_return_val_if_fail (info != NULL, FALSE);
684 return info->merge_func == NULL;
687 /* takes ownership of the structure */
689 gst_tag_list_new_internal (GstStructure * s, GstTagScope scope)
691 GstTagList *tag_list;
693 g_assert (s != NULL);
695 tag_list = (GstTagList *) g_slice_new (GstTagListImpl);
697 gst_mini_object_init (GST_MINI_OBJECT_CAST (tag_list), 0, GST_TYPE_TAG_LIST,
698 (GstMiniObjectCopyFunction) __gst_tag_list_copy, NULL,
699 (GstMiniObjectFreeFunction) __gst_tag_list_free);
701 GST_TAG_LIST_STRUCTURE (tag_list) = s;
702 GST_TAG_LIST_SCOPE (tag_list) = scope;
704 #ifdef DEBUG_REFCOUNT
705 GST_CAT_TRACE (GST_CAT_TAGS, "created taglist %p", tag_list);
712 __gst_tag_list_free (GstTagList * list)
714 g_return_if_fail (GST_IS_TAG_LIST (list));
716 #ifdef DEBUG_REFCOUNT
717 GST_CAT_TRACE (GST_CAT_TAGS, "freeing taglist %p", list);
720 gst_structure_free (GST_TAG_LIST_STRUCTURE (list));
723 memset (list, 0xff, sizeof (GstTagListImpl));
726 g_slice_free1 (sizeof (GstTagListImpl), list);
730 __gst_tag_list_copy (const GstTagList * list)
732 const GstStructure *s;
734 g_return_val_if_fail (GST_IS_TAG_LIST (list), NULL);
736 s = GST_TAG_LIST_STRUCTURE (list);
737 return gst_tag_list_new_internal (gst_structure_copy (s),
738 GST_TAG_LIST_SCOPE (list));
742 * gst_tag_list_new_empty:
744 * Creates a new empty GstTagList.
746 * Free-function: gst_tag_list_unref
748 * Returns: (transfer full): An empty tag list
751 gst_tag_list_new_empty (void)
754 GstTagList *tag_list;
756 s = gst_structure_new_id_empty (GST_QUARK (TAGLIST));
757 tag_list = gst_tag_list_new_internal (s, GST_TAG_SCOPE_STREAM);
764 * @...: %NULL-terminated list of values to set
766 * Creates a new taglist and appends the values for the given tags. It expects
767 * tag-value pairs like gst_tag_list_add(), and a %NULL terminator after the
768 * last pair. The type of the values is implicit and is documented in the API
769 * reference, but can also be queried at runtime with gst_tag_get_type(). It
770 * is an error to pass a value of a type not matching the tag type into this
771 * function. The tag list will make copies of any arguments passed
772 * (e.g. strings, buffers).
774 * After creation you might also want to set a #GstTagScope on the returned
775 * taglist to signal if the contained tags are global or stream tags. By
776 * default stream scope is assumes. See gst_tag_list_set_scope().
778 * Free-function: gst_tag_list_unref
780 * Returns: (transfer full): a new #GstTagList. Free with gst_tag_list_unref()
781 * when no longer needed.
784 gst_tag_list_new (const gchar * tag, ...)
789 g_return_val_if_fail (tag != NULL, NULL);
791 list = gst_tag_list_new_empty ();
792 va_start (args, tag);
793 gst_tag_list_add_valist (list, GST_TAG_MERGE_APPEND, tag, args);
800 * gst_tag_list_new_valist:
801 * @var_args: tag / value pairs to set
803 * Just like gst_tag_list_new(), only that it takes a va_list argument.
804 * Useful mostly for language bindings.
806 * Free-function: gst_tag_list_unref
808 * Returns: (transfer full): a new #GstTagList. Free with gst_tag_list_unref()
809 * when no longer needed.
812 gst_tag_list_new_valist (va_list var_args)
817 list = gst_tag_list_new_empty ();
819 tag = va_arg (var_args, gchar *);
820 gst_tag_list_add_valist (list, GST_TAG_MERGE_APPEND, tag, var_args);
826 * gst_tag_list_set_scope:
827 * @list: a #GstTagList
828 * @scope: new scope for @list
830 * Sets the scope of @list to @scope. By default the scope
831 * of a taglist is stream scope.
835 gst_tag_list_set_scope (GstTagList * list, GstTagScope scope)
837 g_return_if_fail (GST_IS_TAG_LIST (list));
838 g_return_if_fail (gst_tag_list_is_writable (list));
840 GST_TAG_LIST_SCOPE (list) = scope;
844 * gst_tag_list_get_scope:
845 * @list: a #GstTagList
847 * Gets the scope of @list.
849 * Returns: The scope of @list
852 gst_tag_list_get_scope (const GstTagList * list)
854 g_return_val_if_fail (GST_IS_TAG_LIST (list), GST_TAG_SCOPE_STREAM);
856 return GST_TAG_LIST_SCOPE (list);
860 * gst_tag_list_to_string:
861 * @list: a #GstTagList
863 * Serializes a tag list to a string.
865 * Returns: (nullable): a newly-allocated string, or %NULL in case of
866 * an error. The string must be freed with g_free() when no longer
870 gst_tag_list_to_string (const GstTagList * list)
872 g_return_val_if_fail (GST_IS_TAG_LIST (list), NULL);
874 return gst_structure_to_string (GST_TAG_LIST_STRUCTURE (list));
878 * gst_tag_list_new_from_string:
879 * @str: a string created with gst_tag_list_to_string()
881 * Deserializes a tag list.
883 * Returns: (nullable): a new #GstTagList, or %NULL in case of an
887 gst_tag_list_new_from_string (const gchar * str)
889 GstTagList *tag_list;
892 g_return_val_if_fail (str != NULL, NULL);
893 g_return_val_if_fail (g_str_has_prefix (str, "taglist"), NULL);
895 s = gst_structure_from_string (str, NULL);
899 tag_list = gst_tag_list_new_internal (s, GST_TAG_SCOPE_STREAM);
905 * gst_tag_list_n_tags:
906 * @list: A #GstTagList.
908 * Get the number of tags in @list.
910 * Returns: The number of tags in @list.
913 gst_tag_list_n_tags (const GstTagList * list)
915 g_return_val_if_fail (list != NULL, 0);
916 g_return_val_if_fail (GST_IS_TAG_LIST (list), 0);
918 return gst_structure_n_fields (GST_TAG_LIST_STRUCTURE (list));
922 * gst_tag_list_nth_tag_name:
923 * @list: A #GstTagList.
926 * Get the name of the tag in @list at @index.
928 * Returns: The name of the tag at @index.
931 gst_tag_list_nth_tag_name (const GstTagList * list, guint index)
933 g_return_val_if_fail (list != NULL, 0);
934 g_return_val_if_fail (GST_IS_TAG_LIST (list), 0);
936 return gst_structure_nth_field_name (GST_TAG_LIST_STRUCTURE (list), index);
940 * gst_tag_list_is_empty:
941 * @list: A #GstTagList.
943 * Checks if the given taglist is empty.
945 * Returns: %TRUE if the taglist is empty, otherwise %FALSE.
948 gst_tag_list_is_empty (const GstTagList * list)
950 g_return_val_if_fail (list != NULL, FALSE);
951 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
953 return (gst_structure_n_fields (GST_TAG_LIST_STRUCTURE (list)) == 0);
957 gst_tag_list_fields_equal (const GValue * value1, const GValue * value2)
961 if (gst_value_compare (value1, value2) == GST_VALUE_EQUAL)
964 /* fields not equal: add some tolerance for doubles, otherwise bail out */
965 if (!G_VALUE_HOLDS_DOUBLE (value1) || !G_VALUE_HOLDS_DOUBLE (value2))
968 d1 = g_value_get_double (value1);
969 d2 = g_value_get_double (value2);
971 /* This will only work for 'normal' values and values around 0,
972 * which should be good enough for our purposes here
973 * FIXME: maybe add this to gst_value_compare_double() ? */
974 return (fabs (d1 - d2) < 0.0000001);
978 * gst_tag_list_is_equal:
979 * @list1: a #GstTagList.
980 * @list2: a #GstTagList.
982 * Checks if the two given taglists are equal.
984 * Returns: %TRUE if the taglists are equal, otherwise %FALSE
987 gst_tag_list_is_equal (const GstTagList * list1, const GstTagList * list2)
989 const GstStructure *s1, *s2;
990 gint num_fields1, num_fields2, i;
992 g_return_val_if_fail (GST_IS_TAG_LIST (list1), FALSE);
993 g_return_val_if_fail (GST_IS_TAG_LIST (list2), FALSE);
995 /* we don't just use gst_structure_is_equal() here so we can add some
996 * tolerance for doubles, though maybe we should just add that to
997 * gst_value_compare_double() as well? */
998 s1 = GST_TAG_LIST_STRUCTURE (list1);
999 s2 = GST_TAG_LIST_STRUCTURE (list2);
1001 num_fields1 = gst_structure_n_fields (s1);
1002 num_fields2 = gst_structure_n_fields (s2);
1004 if (num_fields1 != num_fields2)
1007 for (i = 0; i < num_fields1; i++) {
1008 const GValue *value1, *value2;
1009 const gchar *tag_name;
1011 tag_name = gst_structure_nth_field_name (s1, i);
1012 value1 = gst_structure_get_value (s1, tag_name);
1013 value2 = gst_structure_get_value (s2, tag_name);
1018 if (!gst_tag_list_fields_equal (value1, value2))
1028 GstTagMergeMode mode;
1033 gst_tag_list_add_value_internal (GstTagList * tag_list, GstTagMergeMode mode,
1034 const gchar * tag, const GValue * value, GstTagInfo * info)
1036 GstStructure *list = GST_TAG_LIST_STRUCTURE (tag_list);
1037 const GValue *value2;
1041 info = gst_tag_lookup (tag);
1042 if (G_UNLIKELY (info == NULL)) {
1043 g_warning ("unknown tag '%s'", tag);
1048 if (G_UNLIKELY (!G_VALUE_HOLDS (value, info->type) &&
1049 !GST_VALUE_HOLDS_LIST (value))) {
1050 g_warning ("tag '%s' should hold value of type '%s', but value of "
1051 "type '%s' passed", info->nick, g_type_name (info->type),
1052 g_type_name (G_VALUE_TYPE (value)));
1056 tag_quark = info->name_quark;
1058 if (info->merge_func
1059 && (value2 = gst_structure_id_get_value (list, tag_quark)) != NULL) {
1060 GValue dest = { 0, };
1063 case GST_TAG_MERGE_REPLACE_ALL:
1064 case GST_TAG_MERGE_REPLACE:
1065 gst_structure_id_set_value (list, tag_quark, value);
1067 case GST_TAG_MERGE_PREPEND:
1068 if (GST_VALUE_HOLDS_LIST (value2) && !GST_VALUE_HOLDS_LIST (value))
1069 gst_value_list_prepend_value ((GValue *) value2, value);
1071 gst_value_list_merge (&dest, value, value2);
1072 gst_structure_id_take_value (list, tag_quark, &dest);
1075 case GST_TAG_MERGE_APPEND:
1076 if (GST_VALUE_HOLDS_LIST (value2) && !GST_VALUE_HOLDS_LIST (value))
1077 gst_value_list_append_value ((GValue *) value2, value);
1079 gst_value_list_merge (&dest, value2, value);
1080 gst_structure_id_take_value (list, tag_quark, &dest);
1083 case GST_TAG_MERGE_KEEP:
1084 case GST_TAG_MERGE_KEEP_ALL:
1087 g_assert_not_reached ();
1092 case GST_TAG_MERGE_APPEND:
1093 case GST_TAG_MERGE_KEEP:
1094 if (gst_structure_id_get_value (list, tag_quark) != NULL)
1097 case GST_TAG_MERGE_REPLACE_ALL:
1098 case GST_TAG_MERGE_REPLACE:
1099 case GST_TAG_MERGE_PREPEND:
1100 gst_structure_id_set_value (list, tag_quark, value);
1102 case GST_TAG_MERGE_KEEP_ALL:
1105 g_assert_not_reached ();
1112 gst_tag_list_copy_foreach (GQuark tag_quark, const GValue * value,
1115 GstTagCopyData *copy = (GstTagCopyData *) user_data;
1118 tag = g_quark_to_string (tag_quark);
1119 gst_tag_list_add_value_internal (copy->list, copy->mode, tag, value, NULL);
1125 * gst_tag_list_insert:
1126 * @into: list to merge into
1127 * @from: list to merge from
1128 * @mode: the mode to use
1130 * Inserts the tags of the @from list into the first list using the given mode.
1133 gst_tag_list_insert (GstTagList * into, const GstTagList * from,
1134 GstTagMergeMode mode)
1136 GstTagCopyData data;
1138 g_return_if_fail (GST_IS_TAG_LIST (into));
1139 g_return_if_fail (gst_tag_list_is_writable (into));
1140 g_return_if_fail (GST_IS_TAG_LIST (from));
1141 g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
1145 if (mode == GST_TAG_MERGE_REPLACE_ALL) {
1146 gst_structure_remove_all_fields (GST_TAG_LIST_STRUCTURE (into));
1148 gst_structure_foreach (GST_TAG_LIST_STRUCTURE (from),
1149 gst_tag_list_copy_foreach, &data);
1153 * gst_tag_list_merge:
1154 * @list1: (allow-none): first list to merge
1155 * @list2: (allow-none): second list to merge
1156 * @mode: the mode to use
1158 * Merges the two given lists into a new list. If one of the lists is %NULL, a
1159 * copy of the other is returned. If both lists are %NULL, %NULL is returned.
1161 * Free-function: gst_tag_list_unref
1163 * Returns: (transfer full) (nullable): the new list
1166 gst_tag_list_merge (const GstTagList * list1, const GstTagList * list2,
1167 GstTagMergeMode mode)
1169 GstTagList *list1_cp;
1170 const GstTagList *list2_cp;
1172 g_return_val_if_fail (list1 == NULL || GST_IS_TAG_LIST (list1), NULL);
1173 g_return_val_if_fail (list2 == NULL || GST_IS_TAG_LIST (list2), NULL);
1174 g_return_val_if_fail (GST_TAG_MODE_IS_VALID (mode), NULL);
1176 /* nothing to merge */
1177 if (!list1 && !list2) {
1181 /* create empty list, we need to do this to correctly handling merge modes */
1182 list1_cp = (list1) ? gst_tag_list_copy (list1) : gst_tag_list_new_empty ();
1183 list2_cp = (list2) ? list2 : gst_tag_list_new_empty ();
1185 gst_tag_list_insert (list1_cp, list2_cp, mode);
1188 gst_tag_list_unref ((GstTagList *) list2_cp);
1194 * gst_tag_list_get_tag_size:
1196 * @tag: the tag to query
1198 * Checks how many value are stored in this tag list for the given tag.
1200 * Returns: The number of tags stored
1203 gst_tag_list_get_tag_size (const GstTagList * list, const gchar * tag)
1205 const GValue *value;
1207 g_return_val_if_fail (GST_IS_TAG_LIST (list), 0);
1209 value = gst_structure_get_value (GST_TAG_LIST_STRUCTURE (list), tag);
1212 if (G_VALUE_TYPE (value) != GST_TYPE_LIST)
1215 return gst_value_list_get_size (value);
1220 * @list: list to set tags in
1221 * @mode: the mode to use
1223 * @...: %NULL-terminated list of values to set
1225 * Sets the values for the given tags using the specified mode.
1228 gst_tag_list_add (GstTagList * list, GstTagMergeMode mode, const gchar * tag,
1233 g_return_if_fail (GST_IS_TAG_LIST (list));
1234 g_return_if_fail (gst_tag_list_is_writable (list));
1235 g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
1236 g_return_if_fail (tag != NULL);
1238 va_start (args, tag);
1239 gst_tag_list_add_valist (list, mode, tag, args);
1244 * gst_tag_list_add_values:
1245 * @list: list to set tags in
1246 * @mode: the mode to use
1248 * @...: GValues to set
1250 * Sets the GValues for the given tags using the specified mode.
1253 gst_tag_list_add_values (GstTagList * list, GstTagMergeMode mode,
1254 const gchar * tag, ...)
1258 g_return_if_fail (GST_IS_TAG_LIST (list));
1259 g_return_if_fail (gst_tag_list_is_writable (list));
1260 g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
1261 g_return_if_fail (tag != NULL);
1263 va_start (args, tag);
1264 gst_tag_list_add_valist_values (list, mode, tag, args);
1269 * gst_tag_list_add_valist:
1270 * @list: list to set tags in
1271 * @mode: the mode to use
1273 * @var_args: tag / value pairs to set
1275 * Sets the values for the given tags using the specified mode.
1278 gst_tag_list_add_valist (GstTagList * list, GstTagMergeMode mode,
1279 const gchar * tag, va_list var_args)
1282 gchar *error = NULL;
1284 g_return_if_fail (GST_IS_TAG_LIST (list));
1285 g_return_if_fail (gst_tag_list_is_writable (list));
1286 g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
1287 g_return_if_fail (tag != NULL);
1289 if (mode == GST_TAG_MERGE_REPLACE_ALL) {
1290 gst_structure_remove_all_fields (GST_TAG_LIST_STRUCTURE (list));
1293 while (tag != NULL) {
1294 GValue value = { 0, };
1296 info = gst_tag_lookup (tag);
1297 if (G_UNLIKELY (info == NULL)) {
1298 g_warning ("unknown tag '%s'", tag);
1301 G_VALUE_COLLECT_INIT (&value, info->type, var_args, 0, &error);
1303 g_warning ("%s: %s", G_STRLOC, error);
1305 /* we purposely leak the value here, it might not be
1306 * in a sane state if an error condition occurred
1310 /* Facilitate GstBuffer -> GstSample transition */
1311 if (G_UNLIKELY (info->type == GST_TYPE_SAMPLE &&
1312 !GST_IS_SAMPLE (value.data[0].v_pointer))) {
1313 g_warning ("Expected GstSample argument for tag '%s'", tag);
1315 gst_tag_list_add_value_internal (list, mode, tag, &value, info);
1317 g_value_unset (&value);
1318 tag = va_arg (var_args, gchar *);
1323 * gst_tag_list_add_valist_values:
1324 * @list: list to set tags in
1325 * @mode: the mode to use
1327 * @var_args: tag / GValue pairs to set
1329 * Sets the GValues for the given tags using the specified mode.
1332 gst_tag_list_add_valist_values (GstTagList * list, GstTagMergeMode mode,
1333 const gchar * tag, va_list var_args)
1335 g_return_if_fail (GST_IS_TAG_LIST (list));
1336 g_return_if_fail (gst_tag_list_is_writable (list));
1337 g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
1338 g_return_if_fail (tag != NULL);
1340 if (mode == GST_TAG_MERGE_REPLACE_ALL) {
1341 gst_structure_remove_all_fields (GST_TAG_LIST_STRUCTURE (list));
1344 while (tag != NULL) {
1347 info = gst_tag_lookup (tag);
1348 if (G_UNLIKELY (info == NULL)) {
1349 g_warning ("unknown tag '%s'", tag);
1352 gst_tag_list_add_value_internal (list, mode, tag, va_arg (var_args,
1354 tag = va_arg (var_args, gchar *);
1359 * gst_tag_list_add_value:
1360 * @list: list to set tags in
1361 * @mode: the mode to use
1363 * @value: GValue for this tag
1365 * Sets the GValue for a given tag using the specified mode.
1368 gst_tag_list_add_value (GstTagList * list, GstTagMergeMode mode,
1369 const gchar * tag, const GValue * value)
1371 g_return_if_fail (GST_IS_TAG_LIST (list));
1372 g_return_if_fail (gst_tag_list_is_writable (list));
1373 g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
1374 g_return_if_fail (tag != NULL);
1376 gst_tag_list_add_value_internal (list, mode, tag, value, NULL);
1380 * gst_tag_list_remove_tag:
1381 * @list: list to remove tag from
1382 * @tag: tag to remove
1384 * Removes the given tag from the taglist.
1387 gst_tag_list_remove_tag (GstTagList * list, const gchar * tag)
1389 g_return_if_fail (GST_IS_TAG_LIST (list));
1390 g_return_if_fail (gst_tag_list_is_writable (list));
1391 g_return_if_fail (tag != NULL);
1393 gst_structure_remove_field (GST_TAG_LIST_STRUCTURE (list), tag);
1398 GstTagForeachFunc func;
1399 const GstTagList *tag_list;
1405 structure_foreach_wrapper (GQuark field_id, const GValue * value,
1408 TagForeachData *data = (TagForeachData *) user_data;
1410 data->func (data->tag_list, g_quark_to_string (field_id), data->data);
1415 * gst_tag_list_foreach:
1416 * @list: list to iterate over
1417 * @func: (scope call): function to be called for each tag
1418 * @user_data: (closure): user specified data
1420 * Calls the given function for each tag inside the tag list. Note that if there
1421 * is no tag, the function won't be called at all.
1424 gst_tag_list_foreach (const GstTagList * list, GstTagForeachFunc func,
1427 TagForeachData data;
1429 g_return_if_fail (GST_IS_TAG_LIST (list));
1430 g_return_if_fail (func != NULL);
1433 data.tag_list = list;
1434 data.data = user_data;
1435 gst_structure_foreach (GST_TAG_LIST_STRUCTURE (list),
1436 structure_foreach_wrapper, &data);
1440 * gst_tag_list_get_value_index:
1441 * @list: a #GstTagList
1442 * @tag: tag to read out
1443 * @index: number of entry to read out
1445 * Gets the value that is at the given index for the given tag in the given
1448 * Returns: (transfer none) (nullable): The GValue for the specified
1449 * entry or %NULL if the tag wasn't available or the tag
1450 * doesn't have as many entries
1453 gst_tag_list_get_value_index (const GstTagList * list, const gchar * tag,
1456 const GValue *value;
1458 g_return_val_if_fail (GST_IS_TAG_LIST (list), NULL);
1459 g_return_val_if_fail (tag != NULL, NULL);
1461 value = gst_structure_get_value (GST_TAG_LIST_STRUCTURE (list), tag);
1465 if (GST_VALUE_HOLDS_LIST (value)) {
1466 if (index >= gst_value_list_get_size (value))
1468 return gst_value_list_get_value (value, index);
1477 * gst_tag_list_copy_value:
1478 * @dest: (out caller-allocates): uninitialized #GValue to copy into
1479 * @list: list to get the tag from
1480 * @tag: tag to read out
1482 * Copies the contents for the given tag into the value,
1483 * merging multiple values into one if multiple values are associated
1485 * You must g_value_unset() the value after use.
1487 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1491 gst_tag_list_copy_value (GValue * dest, const GstTagList * list,
1496 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
1497 g_return_val_if_fail (tag != NULL, FALSE);
1498 g_return_val_if_fail (dest != NULL, FALSE);
1499 g_return_val_if_fail (G_VALUE_TYPE (dest) == 0, FALSE);
1501 src = gst_structure_get_value (GST_TAG_LIST_STRUCTURE (list), tag);
1505 if (G_VALUE_TYPE (src) == GST_TYPE_LIST) {
1506 GstTagInfo *info = gst_tag_lookup (tag);
1511 /* must be there or lists aren't allowed */
1512 g_assert (info->merge_func);
1513 info->merge_func (dest, src);
1515 g_value_init (dest, G_VALUE_TYPE (src));
1516 g_value_copy (src, dest);
1521 /* FIXME 2.0: this whole merge function business is overdesigned, and the
1522 * _get_foo() API is misleading as well - how many application developers will
1523 * expect gst_tag_list_get_string (list, GST_TAG_ARTIST, &val) might return a
1524 * string with multiple comma-separated artists? _get_foo() should just be
1525 * a convenience wrapper around _get_foo_index (list, tag, 0, &val),
1526 * supplemented by a special _tag_list_get_string_merged() function if needed
1527 * (unless someone can actually think of real use cases where the merge
1528 * function is not 'use first' for non-strings and merge for strings) */
1530 /***** evil macros to get all the gst_tag_list_get_*() functions right *****/
1532 #define TAG_MERGE_FUNCS(name,type,ret) \
1534 gst_tag_list_get_ ## name (const GstTagList *list, const gchar *tag, \
1537 GValue v = { 0, }; \
1539 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE); \
1540 g_return_val_if_fail (tag != NULL, FALSE); \
1541 g_return_val_if_fail (value != NULL, FALSE); \
1543 if (!gst_tag_list_copy_value (&v, list, tag)) \
1545 *value = COPY_FUNC (g_value_get_ ## name (&v)); \
1546 g_value_unset (&v); \
1551 gst_tag_list_get_ ## name ## _index (const GstTagList *list, \
1553 guint index, type *value) \
1557 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE); \
1558 g_return_val_if_fail (tag != NULL, FALSE); \
1559 g_return_val_if_fail (value != NULL, FALSE); \
1561 if ((v = gst_tag_list_get_value_index (list, tag, index)) == NULL) \
1563 *value = COPY_FUNC (g_value_get_ ## name (v)); \
1567 #define COPY_FUNC /**/
1569 * gst_tag_list_get_boolean:
1570 * @list: a #GstTagList to get the tag from
1571 * @tag: tag to read out
1572 * @value: (out): location for the result
1574 * Copies the contents for the given tag into the value, merging multiple values
1575 * into one if multiple values are associated with the tag.
1577 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1581 * gst_tag_list_get_boolean_index:
1582 * @list: a #GstTagList to get the tag from
1583 * @tag: tag to read out
1584 * @index: number of entry to read out
1585 * @value: (out): location for the result
1587 * Gets the value that is at the given index for the given tag in the given
1590 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1593 TAG_MERGE_FUNCS (boolean, gboolean, TRUE);
1595 * gst_tag_list_get_int:
1596 * @list: a #GstTagList to get the tag from
1597 * @tag: tag to read out
1598 * @value: (out): location for the result
1600 * Copies the contents for the given tag into the value, merging multiple values
1601 * into one if multiple values are associated with the tag.
1603 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1607 * gst_tag_list_get_int_index:
1608 * @list: a #GstTagList to get the tag from
1609 * @tag: tag to read out
1610 * @index: number of entry to read out
1611 * @value: (out): location for the result
1613 * Gets the value that is at the given index for the given tag in the given
1616 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1619 TAG_MERGE_FUNCS (int, gint, TRUE);
1621 * gst_tag_list_get_uint:
1622 * @list: a #GstTagList to get the tag from
1623 * @tag: tag to read out
1624 * @value: (out): location for the result
1626 * Copies the contents for the given tag into the value, merging multiple values
1627 * into one if multiple values are associated with the tag.
1629 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1633 * gst_tag_list_get_uint_index:
1634 * @list: a #GstTagList to get the tag from
1635 * @tag: tag to read out
1636 * @index: number of entry to read out
1637 * @value: (out): location for the result
1639 * Gets the value that is at the given index for the given tag in the given
1642 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1645 TAG_MERGE_FUNCS (uint, guint, TRUE);
1647 * gst_tag_list_get_int64:
1648 * @list: a #GstTagList to get the tag from
1649 * @tag: tag to read out
1650 * @value: (out): location for the result
1652 * Copies the contents for the given tag into the value, merging multiple values
1653 * into one if multiple values are associated with the tag.
1655 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1659 * gst_tag_list_get_int64_index:
1660 * @list: a #GstTagList to get the tag from
1661 * @tag: tag to read out
1662 * @index: number of entry to read out
1663 * @value: (out): location for the result
1665 * Gets the value that is at the given index for the given tag in the given
1668 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1671 TAG_MERGE_FUNCS (int64, gint64, TRUE);
1673 * gst_tag_list_get_uint64:
1674 * @list: a #GstTagList to get the tag from
1675 * @tag: tag to read out
1676 * @value: (out): location for the result
1678 * Copies the contents for the given tag into the value, merging multiple values
1679 * into one if multiple values are associated with the tag.
1681 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1685 * gst_tag_list_get_uint64_index:
1686 * @list: a #GstTagList to get the tag from
1687 * @tag: tag to read out
1688 * @index: number of entry to read out
1689 * @value: (out): location for the result
1691 * Gets the value that is at the given index for the given tag in the given
1694 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1697 TAG_MERGE_FUNCS (uint64, guint64, TRUE);
1699 * gst_tag_list_get_float:
1700 * @list: a #GstTagList to get the tag from
1701 * @tag: tag to read out
1702 * @value: (out): location for the result
1704 * Copies the contents for the given tag into the value, merging multiple values
1705 * into one if multiple values are associated with the tag.
1707 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1711 * gst_tag_list_get_float_index:
1712 * @list: a #GstTagList to get the tag from
1713 * @tag: tag to read out
1714 * @index: number of entry to read out
1715 * @value: (out): location for the result
1717 * Gets the value that is at the given index for the given tag in the given
1720 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1723 TAG_MERGE_FUNCS (float, gfloat, TRUE);
1725 * gst_tag_list_get_double:
1726 * @list: a #GstTagList to get the tag from
1727 * @tag: tag to read out
1728 * @value: (out): location for the result
1730 * Copies the contents for the given tag into the value, merging multiple values
1731 * into one if multiple values are associated with the tag.
1733 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1737 * gst_tag_list_get_double_index:
1738 * @list: a #GstTagList to get the tag from
1739 * @tag: tag to read out
1740 * @index: number of entry to read out
1741 * @value: (out): location for the result
1743 * Gets the value that is at the given index for the given tag in the given
1746 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1749 TAG_MERGE_FUNCS (double, gdouble, TRUE);
1751 * gst_tag_list_get_pointer:
1752 * @list: a #GstTagList to get the tag from
1753 * @tag: tag to read out
1754 * @value: (out) (transfer none): location for the result
1756 * Copies the contents for the given tag into the value, merging multiple values
1757 * into one if multiple values are associated with the tag.
1759 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1763 * gst_tag_list_get_pointer_index:
1764 * @list: a #GstTagList to get the tag from
1765 * @tag: tag to read out
1766 * @index: number of entry to read out
1767 * @value: (out) (transfer none): location for the result
1769 * Gets the value that is at the given index for the given tag in the given
1772 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1775 TAG_MERGE_FUNCS (pointer, gpointer, (*value != NULL));
1777 static inline gchar *
1778 _gst_strdup0 (const gchar * s)
1780 if (s == NULL || *s == '\0')
1783 return g_strdup (s);
1787 #define COPY_FUNC _gst_strdup0
1790 * gst_tag_list_get_string:
1791 * @list: a #GstTagList to get the tag from
1792 * @tag: tag to read out
1793 * @value: (out callee-allocates) (transfer full): location for the result
1795 * Copies the contents for the given tag into the value, possibly merging
1796 * multiple values into one if multiple values are associated with the tag.
1798 * Use gst_tag_list_get_string_index (list, tag, 0, value) if you want
1799 * to retrieve the first string associated with this tag unmodified.
1801 * The resulting string in @value will be in UTF-8 encoding and should be
1802 * freed by the caller using g_free when no longer needed. The
1803 * returned string is also guaranteed to be non-%NULL and non-empty.
1805 * Free-function: g_free
1807 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1811 * gst_tag_list_get_string_index:
1812 * @list: a #GstTagList to get the tag from
1813 * @tag: tag to read out
1814 * @index: number of entry to read out
1815 * @value: (out callee-allocates) (transfer full): location for the result
1817 * Gets the value that is at the given index for the given tag in the given
1820 * The resulting string in @value will be in UTF-8 encoding and should be
1821 * freed by the caller using g_free when no longer needed. The
1822 * returned string is also guaranteed to be non-%NULL and non-empty.
1824 * Free-function: g_free
1826 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1829 TAG_MERGE_FUNCS (string, gchar *, (*value != NULL));
1832 *FIXME 2.0: Instead of _peek (non-copy) and _get (copy), we could have
1833 * _get (non-copy) and _dup (copy) for strings, seems more
1837 * gst_tag_list_peek_string_index:
1838 * @list: a #GstTagList to get the tag from
1839 * @tag: tag to read out
1840 * @index: number of entry to read out
1841 * @value: (out) (transfer none): location for the result
1843 * Peeks at the value that is at the given index for the given tag in the given
1846 * The resulting string in @value will be in UTF-8 encoding and doesn't need
1847 * to be freed by the caller. The returned string is also guaranteed to
1848 * be non-%NULL and non-empty.
1850 * Returns: %TRUE, if a value was set, %FALSE if the tag didn't exist in the
1854 gst_tag_list_peek_string_index (const GstTagList * list,
1855 const gchar * tag, guint index, const gchar ** value)
1859 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
1860 g_return_val_if_fail (tag != NULL, FALSE);
1861 g_return_val_if_fail (value != NULL, FALSE);
1863 if ((v = gst_tag_list_get_value_index (list, tag, index)) == NULL)
1865 *value = g_value_get_string (v);
1866 return *value != NULL && **value != '\0';
1870 * gst_tag_list_get_date:
1871 * @list: a #GstTagList to get the tag from
1872 * @tag: tag to read out
1873 * @value: (out callee-allocates) (transfer full): address of a GDate pointer
1874 * variable to store the result into
1876 * Copies the first date for the given tag in the taglist into the variable
1877 * pointed to by @value. Free the date with g_date_free() when it is no longer
1880 * Free-function: g_date_free
1882 * Returns: %TRUE, if a date was copied, %FALSE if the tag didn't exist in the
1883 * given list or if it was %NULL.
1886 gst_tag_list_get_date (const GstTagList * list, const gchar * tag,
1891 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
1892 g_return_val_if_fail (tag != NULL, FALSE);
1893 g_return_val_if_fail (value != NULL, FALSE);
1895 if (!gst_tag_list_copy_value (&v, list, tag))
1897 *value = (GDate *) g_value_dup_boxed (&v);
1899 return (*value != NULL);
1903 * gst_tag_list_get_date_index:
1904 * @list: a #GstTagList to get the tag from
1905 * @tag: tag to read out
1906 * @index: number of entry to read out
1907 * @value: (out callee-allocates) (transfer full): location for the result
1909 * Gets the date that is at the given index for the given tag in the given
1910 * list and copies it into the variable pointed to by @value. Free the date
1911 * with g_date_free() when it is no longer needed.
1913 * Free-function: g_date_free
1915 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1916 * given list or if it was %NULL.
1919 gst_tag_list_get_date_index (const GstTagList * list,
1920 const gchar * tag, guint index, GDate ** value)
1924 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
1925 g_return_val_if_fail (tag != NULL, FALSE);
1926 g_return_val_if_fail (value != NULL, FALSE);
1928 if ((v = gst_tag_list_get_value_index (list, tag, index)) == NULL)
1930 *value = (GDate *) g_value_dup_boxed (v);
1931 return (*value != NULL);
1935 * gst_tag_list_get_date_time:
1936 * @list: a #GstTagList to get the tag from
1937 * @tag: tag to read out
1938 * @value: (out callee-allocates) (transfer full): address of a #GstDateTime
1939 * pointer variable to store the result into
1941 * Copies the first datetime for the given tag in the taglist into the variable
1942 * pointed to by @value. Unref the date with gst_date_time_unref() when
1943 * it is no longer needed.
1945 * Free-function: gst_date_time_unref
1947 * Returns: %TRUE, if a datetime was copied, %FALSE if the tag didn't exist in
1948 * the given list or if it was %NULL.
1951 gst_tag_list_get_date_time (const GstTagList * list, const gchar * tag,
1952 GstDateTime ** value)
1956 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
1957 g_return_val_if_fail (tag != NULL, FALSE);
1958 g_return_val_if_fail (value != NULL, FALSE);
1960 if (!gst_tag_list_copy_value (&v, list, tag))
1963 *value = (GstDateTime *) g_value_dup_boxed (&v);
1965 return (*value != NULL);
1969 * gst_tag_list_get_date_time_index:
1970 * @list: a #GstTagList to get the tag from
1971 * @tag: tag to read out
1972 * @index: number of entry to read out
1973 * @value: (out callee-allocates) (transfer full): location for the result
1975 * Gets the datetime that is at the given index for the given tag in the given
1976 * list and copies it into the variable pointed to by @value. Unref the datetime
1977 * with gst_date_time_unref() when it is no longer needed.
1979 * Free-function: gst_date_time_unref
1981 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1982 * given list or if it was %NULL.
1985 gst_tag_list_get_date_time_index (const GstTagList * list,
1986 const gchar * tag, guint index, GstDateTime ** value)
1990 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
1991 g_return_val_if_fail (tag != NULL, FALSE);
1992 g_return_val_if_fail (value != NULL, FALSE);
1994 if ((v = gst_tag_list_get_value_index (list, tag, index)) == NULL)
1996 *value = (GstDateTime *) g_value_dup_boxed (v);
1997 return (*value != NULL);
2001 * gst_tag_list_get_sample:
2002 * @list: a #GstTagList to get the tag from
2003 * @tag: tag to read out
2004 * @sample: (out callee-allocates) (transfer full): address of a GstSample
2005 * pointer variable to store the result into
2007 * Copies the first sample for the given tag in the taglist into the variable
2008 * pointed to by @sample. Free the sample with gst_sample_unref() when it is
2009 * no longer needed. You can retrieve the buffer from the sample using
2010 * gst_sample_get_buffer() and the associated caps (if any) with
2011 * gst_sample_get_caps().
2013 * Free-function: gst_sample_unref
2015 * Returns: %TRUE, if a sample was returned, %FALSE if the tag didn't exist in
2016 * the given list or if it was %NULL.
2019 gst_tag_list_get_sample (const GstTagList * list, const gchar * tag,
2020 GstSample ** sample)
2024 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
2025 g_return_val_if_fail (tag != NULL, FALSE);
2026 g_return_val_if_fail (sample != NULL, FALSE);
2028 if (!gst_tag_list_copy_value (&v, list, tag))
2030 *sample = g_value_dup_boxed (&v);
2032 return (*sample != NULL);
2036 * gst_tag_list_get_sample_index:
2037 * @list: a #GstTagList to get the tag from
2038 * @tag: tag to read out
2039 * @index: number of entry to read out
2040 * @sample: (out callee-allocates) (transfer full): address of a GstSample
2041 * pointer variable to store the result into
2043 * Gets the sample that is at the given index for the given tag in the given
2044 * list and copies it into the variable pointed to by @sample. Free the sample
2045 * with gst_sample_unref() when it is no longer needed. You can retrieve the
2046 * buffer from the sample using gst_sample_get_buffer() and the associated
2047 * caps (if any) with gst_sample_get_caps().
2049 * Free-function: gst_sample_unref
2051 * Returns: %TRUE, if a sample was copied, %FALSE if the tag didn't exist in the
2052 * given list or if it was %NULL.
2055 gst_tag_list_get_sample_index (const GstTagList * list,
2056 const gchar * tag, guint index, GstSample ** sample)
2060 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
2061 g_return_val_if_fail (tag != NULL, FALSE);
2062 g_return_val_if_fail (sample != NULL, FALSE);
2064 if ((v = gst_tag_list_get_value_index (list, tag, index)) == NULL)
2066 *sample = g_value_dup_boxed (v);
2067 return (*sample != NULL);