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.
24 * @short_description: List of tags and values used to describe media metadata
26 * List of tags and values used to describe media metadata.
28 * Strings in structures must be ASCII or UTF-8 encoded. Other encodings are
29 * not allowed. Strings must not be empty or %NULL.
36 #include "gst_private.h"
37 #include "math-compat.h"
38 #include "gst-i18n-lib.h"
39 #include "gsttaglist.h"
42 #include "gstbuffer.h"
44 #include "gststructure.h"
46 #include <gobject/gvaluecollector.h>
49 /* FIXME: add category for tags */
50 #define GST_CAT_TAGS GST_CAT_DEFAULT
52 #define GST_TAG_IS_VALID(tag) (gst_tag_get_info (tag) != NULL)
54 typedef struct _GstTagListImpl
58 GstStructure *structure;
62 #define GST_TAG_LIST_STRUCTURE(taglist) ((GstTagListImpl*)(taglist))->structure
63 #define GST_TAG_LIST_SCOPE(taglist) ((GstTagListImpl*)(taglist))->scope
67 GType type; /* type the data is in */
69 const gchar *nick; /* translated short description */
70 const gchar *blurb; /* translated long description */
72 GstTagMergeFunc merge_func; /* functions to merge the values */
73 GstTagFlag flag; /* type of tag */
74 GQuark name_quark; /* quark for the name */
78 #define g_value_get_char g_value_get_schar
80 static GMutex __tag_mutex;
81 #define TAG_LOCK g_mutex_lock (&__tag_mutex)
82 #define TAG_UNLOCK g_mutex_unlock (&__tag_mutex)
84 /* tags hash table: maps tag name string => GstTagInfo */
85 static GHashTable *__tags;
87 GType _gst_tag_list_type = 0;
88 GST_DEFINE_MINI_OBJECT_TYPE (GstTagList, gst_tag_list);
90 static void __gst_tag_list_free (GstTagList * list);
91 static GstTagList *__gst_tag_list_copy (const GstTagList * list);
94 * g_value_register_transform_func (_gst_tag_list_type, G_TYPE_STRING,
95 * _gst_structure_transform_to_string);
98 _priv_gst_tag_initialize (void)
100 g_mutex_init (&__tag_mutex);
102 _gst_tag_list_type = gst_tag_list_get_type ();
104 __tags = g_hash_table_new (g_str_hash, g_str_equal);
105 gst_tag_register_static (GST_TAG_TITLE, GST_TAG_FLAG_META,
107 _("title"), _("commonly used title"), gst_tag_merge_strings_with_comma);
108 gst_tag_register_static (GST_TAG_TITLE_SORTNAME, GST_TAG_FLAG_META,
110 _("title sortname"), _("commonly used title for sorting purposes"), NULL);
111 gst_tag_register_static (GST_TAG_ARTIST, GST_TAG_FLAG_META,
114 _("person(s) responsible for the recording"),
115 gst_tag_merge_strings_with_comma);
116 gst_tag_register_static (GST_TAG_ARTIST_SORTNAME, GST_TAG_FLAG_META,
118 _("artist sortname"),
119 _("person(s) responsible for the recording for sorting purposes"), NULL);
120 gst_tag_register_static (GST_TAG_ALBUM, GST_TAG_FLAG_META,
123 _("album containing this data"), gst_tag_merge_strings_with_comma);
124 gst_tag_register_static (GST_TAG_ALBUM_SORTNAME, GST_TAG_FLAG_META,
127 _("album containing this data for sorting purposes"), NULL);
128 gst_tag_register_static (GST_TAG_ALBUM_ARTIST, GST_TAG_FLAG_META,
131 _("The artist of the entire album, as it should be displayed"),
132 gst_tag_merge_strings_with_comma);
133 gst_tag_register_static (GST_TAG_ALBUM_ARTIST_SORTNAME, GST_TAG_FLAG_META,
135 _("album artist sortname"),
136 _("The artist of the entire album, as it should be sorted"), NULL);
137 gst_tag_register_static (GST_TAG_DATE, GST_TAG_FLAG_META, G_TYPE_DATE,
138 _("date"), _("date the data was created (as a GDate structure)"), NULL);
139 gst_tag_register_static (GST_TAG_DATE_TIME, GST_TAG_FLAG_META,
140 GST_TYPE_DATE_TIME, _("datetime"),
141 _("date and time the data was created (as a GstDateTime structure)"),
143 gst_tag_register_static (GST_TAG_GENRE, GST_TAG_FLAG_META,
146 _("genre this data belongs to"), gst_tag_merge_strings_with_comma);
147 gst_tag_register_static (GST_TAG_COMMENT, GST_TAG_FLAG_META,
150 _("free text commenting the data"), gst_tag_merge_use_first);
151 gst_tag_register_static (GST_TAG_EXTENDED_COMMENT, GST_TAG_FLAG_META,
153 _("extended comment"),
154 _("free text commenting the data in key=value or key[en]=comment form"),
155 gst_tag_merge_use_first);
156 gst_tag_register_static (GST_TAG_TRACK_NUMBER, GST_TAG_FLAG_META,
159 _("track number inside a collection"), gst_tag_merge_use_first);
160 gst_tag_register_static (GST_TAG_TRACK_COUNT, GST_TAG_FLAG_META,
163 _("count of tracks inside collection this track belongs to"),
164 gst_tag_merge_use_first);
165 gst_tag_register_static (GST_TAG_ALBUM_VOLUME_NUMBER, GST_TAG_FLAG_META,
168 _("disc number inside a collection"), gst_tag_merge_use_first);
169 gst_tag_register_static (GST_TAG_ALBUM_VOLUME_COUNT, GST_TAG_FLAG_META,
172 _("count of discs inside collection this disc belongs to"),
173 gst_tag_merge_use_first);
174 gst_tag_register_static (GST_TAG_LOCATION, GST_TAG_FLAG_META,
176 _("location"), _("Origin of media as a URI (location, where the "
177 "original of the file or stream is hosted)"),
178 gst_tag_merge_strings_with_comma);
179 gst_tag_register_static (GST_TAG_HOMEPAGE, GST_TAG_FLAG_META,
182 _("Homepage for this media (i.e. artist or movie homepage)"),
183 gst_tag_merge_strings_with_comma);
184 gst_tag_register_static (GST_TAG_DESCRIPTION, GST_TAG_FLAG_META,
185 G_TYPE_STRING, _("description"),
186 _("short text describing the content of the data"),
187 gst_tag_merge_strings_with_comma);
188 gst_tag_register_static (GST_TAG_VERSION, GST_TAG_FLAG_META, G_TYPE_STRING,
189 _("version"), _("version of this data"), NULL);
190 gst_tag_register_static (GST_TAG_ISRC, GST_TAG_FLAG_META, G_TYPE_STRING,
193 ("International Standard Recording Code - see http://www.ifpi.org/isrc/"),
195 /* FIXME: organization (fix what? tpm) */
196 gst_tag_register_static (GST_TAG_ORGANIZATION, GST_TAG_FLAG_META,
197 G_TYPE_STRING, _("organization"), _("organization"),
198 gst_tag_merge_strings_with_comma);
199 gst_tag_register_static (GST_TAG_COPYRIGHT, GST_TAG_FLAG_META,
200 G_TYPE_STRING, _("copyright"), _("copyright notice of the data"), NULL);
201 gst_tag_register_static (GST_TAG_COPYRIGHT_URI, GST_TAG_FLAG_META,
202 G_TYPE_STRING, _("copyright uri"),
203 _("URI to the copyright notice of the data"), NULL);
204 gst_tag_register_static (GST_TAG_ENCODED_BY, GST_TAG_FLAG_META, G_TYPE_STRING,
205 _("encoded by"), _("name of the encoding person or organization"),
206 gst_tag_merge_strings_with_comma);
207 gst_tag_register_static (GST_TAG_CONTACT, GST_TAG_FLAG_META,
209 _("contact"), _("contact information"), gst_tag_merge_strings_with_comma);
210 gst_tag_register_static (GST_TAG_LICENSE, GST_TAG_FLAG_META,
211 G_TYPE_STRING, _("license"), _("license of data"), NULL);
212 gst_tag_register_static (GST_TAG_LICENSE_URI, GST_TAG_FLAG_META,
213 G_TYPE_STRING, _("license uri"),
214 _("URI to the license of the data"), NULL);
215 gst_tag_register_static (GST_TAG_PERFORMER, GST_TAG_FLAG_META,
218 _("person(s) performing"), gst_tag_merge_strings_with_comma);
219 gst_tag_register_static (GST_TAG_COMPOSER, GST_TAG_FLAG_META,
222 _("person(s) who composed the recording"),
223 gst_tag_merge_strings_with_comma);
224 gst_tag_register_static (GST_TAG_DURATION, GST_TAG_FLAG_DECODED,
226 _("duration"), _("length in GStreamer time units (nanoseconds)"), NULL);
227 gst_tag_register_static (GST_TAG_CODEC, GST_TAG_FLAG_ENCODED,
230 _("codec the data is stored in"), gst_tag_merge_strings_with_comma);
231 gst_tag_register_static (GST_TAG_VIDEO_CODEC, GST_TAG_FLAG_ENCODED,
233 _("video codec"), _("codec the video data is stored in"), NULL);
234 gst_tag_register_static (GST_TAG_AUDIO_CODEC, GST_TAG_FLAG_ENCODED,
236 _("audio codec"), _("codec the audio data is stored in"), NULL);
237 gst_tag_register_static (GST_TAG_SUBTITLE_CODEC, GST_TAG_FLAG_ENCODED,
239 _("subtitle codec"), _("codec the subtitle data is stored in"), NULL);
240 gst_tag_register_static (GST_TAG_CONTAINER_FORMAT, GST_TAG_FLAG_ENCODED,
241 G_TYPE_STRING, _("container format"),
242 _("container format the data is stored in"), NULL);
243 gst_tag_register_static (GST_TAG_BITRATE, GST_TAG_FLAG_ENCODED,
244 G_TYPE_UINT, _("bitrate"), _("exact or average bitrate in bits/s"), NULL);
245 gst_tag_register_static (GST_TAG_NOMINAL_BITRATE, GST_TAG_FLAG_ENCODED,
246 G_TYPE_UINT, _("nominal bitrate"), _("nominal bitrate in bits/s"), NULL);
247 gst_tag_register_static (GST_TAG_MINIMUM_BITRATE, GST_TAG_FLAG_ENCODED,
248 G_TYPE_UINT, _("minimum bitrate"), _("minimum bitrate in bits/s"), NULL);
249 gst_tag_register_static (GST_TAG_MAXIMUM_BITRATE, GST_TAG_FLAG_ENCODED,
250 G_TYPE_UINT, _("maximum bitrate"), _("maximum bitrate in bits/s"), NULL);
251 gst_tag_register_static (GST_TAG_ENCODER, GST_TAG_FLAG_ENCODED,
253 _("encoder"), _("encoder used to encode this stream"), NULL);
254 gst_tag_register_static (GST_TAG_ENCODER_VERSION, GST_TAG_FLAG_ENCODED,
256 _("encoder version"),
257 _("version of the encoder used to encode this stream"), NULL);
258 gst_tag_register_static (GST_TAG_SERIAL, GST_TAG_FLAG_ENCODED,
259 G_TYPE_UINT, _("serial"), _("serial number of track"), NULL);
260 gst_tag_register_static (GST_TAG_TRACK_GAIN, GST_TAG_FLAG_META,
261 G_TYPE_DOUBLE, _("replaygain track gain"), _("track gain in db"), NULL);
262 gst_tag_register_static (GST_TAG_TRACK_PEAK, GST_TAG_FLAG_META,
263 G_TYPE_DOUBLE, _("replaygain track peak"), _("peak of the track"), NULL);
264 gst_tag_register_static (GST_TAG_ALBUM_GAIN, GST_TAG_FLAG_META,
265 G_TYPE_DOUBLE, _("replaygain album gain"), _("album gain in db"), NULL);
266 gst_tag_register_static (GST_TAG_ALBUM_PEAK, GST_TAG_FLAG_META,
267 G_TYPE_DOUBLE, _("replaygain album peak"), _("peak of the album"), NULL);
268 gst_tag_register_static (GST_TAG_REFERENCE_LEVEL, GST_TAG_FLAG_META,
269 G_TYPE_DOUBLE, _("replaygain reference level"),
270 _("reference level of track and album gain values"), NULL);
271 gst_tag_register_static (GST_TAG_LANGUAGE_CODE, GST_TAG_FLAG_META,
272 G_TYPE_STRING, _("language code"),
273 _("language code for this stream, conforming to ISO-639-1 or ISO-639-2"),
275 gst_tag_register_static (GST_TAG_LANGUAGE_NAME, GST_TAG_FLAG_META,
276 G_TYPE_STRING, _("language name"),
277 _("freeform name of the language this stream is in"), NULL);
278 gst_tag_register_static (GST_TAG_IMAGE, GST_TAG_FLAG_META, GST_TYPE_SAMPLE,
279 _("image"), _("image related to this stream"), gst_tag_merge_use_first);
280 gst_tag_register_static (GST_TAG_PREVIEW_IMAGE, GST_TAG_FLAG_META,
282 /* TRANSLATORS: 'preview image' = image that shows a preview of the full image */
283 _("preview image"), _("preview image related to this stream"), NULL);
284 gst_tag_register_static (GST_TAG_ATTACHMENT, GST_TAG_FLAG_META,
285 GST_TYPE_SAMPLE, _("attachment"), _("file attached to this stream"),
286 gst_tag_merge_use_first);
287 gst_tag_register_static (GST_TAG_BEATS_PER_MINUTE, GST_TAG_FLAG_META,
288 G_TYPE_DOUBLE, _("beats per minute"),
289 _("number of beats per minute in audio"), NULL);
290 gst_tag_register_static (GST_TAG_KEYWORDS, GST_TAG_FLAG_META, G_TYPE_STRING,
291 _("keywords"), _("comma separated keywords describing the content"),
292 gst_tag_merge_strings_with_comma);
293 gst_tag_register_static (GST_TAG_GEO_LOCATION_NAME, GST_TAG_FLAG_META,
294 G_TYPE_STRING, _("geo location name"),
295 _("human readable descriptive location of where "
296 "the media has been recorded or produced"), NULL);
297 gst_tag_register_static (GST_TAG_GEO_LOCATION_LATITUDE, GST_TAG_FLAG_META,
298 G_TYPE_DOUBLE, _("geo location latitude"),
299 _("geo latitude location of where the media has been recorded or "
300 "produced in degrees according to WGS84 (zero at the equator, "
301 "negative values for southern latitudes)"), NULL);
302 gst_tag_register_static (GST_TAG_GEO_LOCATION_LONGITUDE, GST_TAG_FLAG_META,
303 G_TYPE_DOUBLE, _("geo location longitude"),
304 _("geo longitude location of where the media has been recorded or "
305 "produced in degrees according to WGS84 (zero at the prime meridian "
306 "in Greenwich/UK, negative values for western longitudes)"), NULL);
307 gst_tag_register_static (GST_TAG_GEO_LOCATION_ELEVATION, GST_TAG_FLAG_META,
308 G_TYPE_DOUBLE, _("geo location elevation"),
309 _("geo elevation of where the media has been recorded or produced in "
310 "meters according to WGS84 (zero is average sea level)"), NULL);
311 gst_tag_register_static (GST_TAG_GEO_LOCATION_COUNTRY, GST_TAG_FLAG_META,
312 G_TYPE_STRING, _("geo location country"),
313 _("country (english name) where the media has been recorded "
314 "or produced"), NULL);
315 gst_tag_register_static (GST_TAG_GEO_LOCATION_CITY, GST_TAG_FLAG_META,
316 G_TYPE_STRING, _("geo location city"),
317 _("city (english name) where the media has been recorded "
318 "or produced"), NULL);
319 gst_tag_register_static (GST_TAG_GEO_LOCATION_SUBLOCATION, GST_TAG_FLAG_META,
320 G_TYPE_STRING, _("geo location sublocation"),
321 _("a location within a city where the media has been produced "
322 "or created (e.g. the neighborhood)"), NULL);
323 gst_tag_register_static (GST_TAG_GEO_LOCATION_HORIZONTAL_ERROR,
324 GST_TAG_FLAG_META, G_TYPE_DOUBLE, _("geo location horizontal error"),
325 _("expected error of the horizontal positioning measures (in meters)"),
327 gst_tag_register_static (GST_TAG_GEO_LOCATION_MOVEMENT_SPEED,
328 GST_TAG_FLAG_META, G_TYPE_DOUBLE, _("geo location movement speed"),
329 _("movement speed of the capturing device while performing the capture "
331 gst_tag_register_static (GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION,
332 GST_TAG_FLAG_META, G_TYPE_DOUBLE, _("geo location movement direction"),
333 _("indicates the movement direction of the device performing the capture"
334 " of a media. It is represented as degrees in floating point "
335 "representation, 0 means the geographic north, and increases "
337 gst_tag_register_static (GST_TAG_GEO_LOCATION_CAPTURE_DIRECTION,
338 GST_TAG_FLAG_META, G_TYPE_DOUBLE, _("geo location capture direction"),
339 _("indicates the direction the device is pointing to when capturing "
340 " a media. It is represented as degrees in floating point "
341 " representation, 0 means the geographic north, and increases "
343 gst_tag_register_static (GST_TAG_SHOW_NAME, GST_TAG_FLAG_META, G_TYPE_STRING,
344 /* TRANSLATORS: 'show name' = 'TV/radio/podcast show name' here */
346 _("Name of the tv/podcast/series show the media is from"),
347 gst_tag_merge_strings_with_comma);
348 gst_tag_register_static (GST_TAG_SHOW_SORTNAME, GST_TAG_FLAG_META,
350 /* TRANSLATORS: 'show sortname' = 'TV/radio/podcast show name as used for sorting purposes' here */
352 _("Name of the tv/podcast/series show the media is from, for sorting "
354 gst_tag_register_static (GST_TAG_SHOW_EPISODE_NUMBER, GST_TAG_FLAG_META,
355 G_TYPE_UINT, _("episode number"),
356 _("The episode number in the season the media is part of"),
357 gst_tag_merge_use_first);
358 gst_tag_register_static (GST_TAG_SHOW_SEASON_NUMBER, GST_TAG_FLAG_META,
359 G_TYPE_UINT, _("season number"),
360 _("The season number of the show the media is part of"),
361 gst_tag_merge_use_first);
362 gst_tag_register_static (GST_TAG_LYRICS, GST_TAG_FLAG_META, G_TYPE_STRING,
363 _("lyrics"), _("The lyrics of the media, commonly used for songs"),
364 gst_tag_merge_strings_with_comma);
365 gst_tag_register_static (GST_TAG_COMPOSER_SORTNAME, GST_TAG_FLAG_META,
366 G_TYPE_STRING, _("composer sortname"),
367 _("person(s) who composed the recording, for sorting purposes"), NULL);
368 gst_tag_register_static (GST_TAG_GROUPING, GST_TAG_FLAG_META, G_TYPE_STRING,
370 _("Groups related media that spans multiple tracks, like the different "
371 "pieces of a concerto. It is a higher level than a track, "
372 "but lower than an album"), NULL);
373 gst_tag_register_static (GST_TAG_USER_RATING, GST_TAG_FLAG_META, G_TYPE_UINT,
375 _("Rating attributed by a user. The higher the rank, "
376 "the more the user likes this media"), NULL);
377 gst_tag_register_static (GST_TAG_DEVICE_MANUFACTURER, GST_TAG_FLAG_META,
378 G_TYPE_STRING, _("device manufacturer"),
379 _("Manufacturer of the device used to create this media"), NULL);
380 gst_tag_register_static (GST_TAG_DEVICE_MODEL, GST_TAG_FLAG_META,
381 G_TYPE_STRING, _("device model"),
382 _("Model of the device used to create this media"), NULL);
383 gst_tag_register_static (GST_TAG_APPLICATION_NAME, GST_TAG_FLAG_META,
384 G_TYPE_STRING, _("application name"),
385 _("Application used to create the media"), NULL);
386 gst_tag_register_static (GST_TAG_APPLICATION_DATA, GST_TAG_FLAG_META,
387 GST_TYPE_SAMPLE, _("application data"),
388 _("Arbitrary application data to be serialized into the media"), NULL);
389 gst_tag_register_static (GST_TAG_IMAGE_ORIENTATION, GST_TAG_FLAG_META,
390 G_TYPE_STRING, _("image orientation"),
391 _("How the image should be rotated or flipped before display"), NULL);
392 gst_tag_register_static (GST_TAG_PUBLISHER, GST_TAG_FLAG_META,
395 _("Name of the label or publisher"), gst_tag_merge_strings_with_comma);
396 gst_tag_register_static (GST_TAG_INTERPRETED_BY, GST_TAG_FLAG_META,
399 _("Information about the people behind a remix and similar "
400 "interpretations"), gst_tag_merge_strings_with_comma);
401 gst_tag_register_static (GST_TAG_MIDI_BASE_NOTE, GST_TAG_FLAG_META,
403 _("midi-base-note"), _("Midi note number of the audio track."), NULL);
407 * gst_tag_merge_use_first:
408 * @dest: (out caller-allocates): uninitialized GValue to store result in
409 * @src: GValue to copy from
411 * This is a convenience function for the func argument of gst_tag_register().
412 * It creates a copy of the first value from the list.
415 gst_tag_merge_use_first (GValue * dest, const GValue * src)
417 const GValue *ret = gst_value_list_get_value (src, 0);
419 g_value_init (dest, G_VALUE_TYPE (ret));
420 g_value_copy (ret, dest);
424 * gst_tag_merge_strings_with_comma:
425 * @dest: (out caller-allocates): uninitialized GValue to store result in
426 * @src: GValue to copy from
428 * This is a convenience function for the func argument of gst_tag_register().
429 * It concatenates all given strings using a comma. The tag must be registered
430 * as a G_TYPE_STRING or this function will fail.
433 gst_tag_merge_strings_with_comma (GValue * dest, const GValue * src)
438 count = gst_value_list_get_size (src);
439 str = g_string_new (g_value_get_string (gst_value_list_get_value (src, 0)));
440 for (i = 1; i < count; i++) {
441 /* separator between two strings */
442 g_string_append (str, _(", "));
443 g_string_append (str,
444 g_value_get_string (gst_value_list_get_value (src, i)));
447 g_value_init (dest, G_TYPE_STRING);
448 g_value_take_string (dest, str->str);
449 g_string_free (str, FALSE);
453 gst_tag_lookup (const gchar * tag_name)
458 ret = g_hash_table_lookup (__tags, (gpointer) tag_name);
466 * @name: the name or identifier string
467 * @flag: a flag describing the type of tag info
468 * @type: the type this data is in
469 * @nick: human-readable name
470 * @blurb: a human-readable description about this tag
471 * @func: (allow-none): function for merging multiple values of this tag, or %NULL
473 * Registers a new tag type for the use with GStreamer's type system. If a type
474 * with that name is already registered, that one is used.
475 * The old registration may have used a different type however. So don't rely
476 * on your supplied values.
478 * Important: if you do not supply a merge function the implication will be
479 * that there can only be one single value for this tag in a tag list and
480 * any additional values will silently be discarded when being added (unless
481 * #GST_TAG_MERGE_REPLACE, #GST_TAG_MERGE_REPLACE_ALL, or
482 * #GST_TAG_MERGE_PREPEND is used as merge mode, in which case the new
483 * value will replace the old one in the list).
485 * The merge function will be called from gst_tag_list_copy_value() when
486 * it is required that one or more values for a tag be condensed into
487 * one single value. This may happen from gst_tag_list_get_string(),
488 * gst_tag_list_get_int(), gst_tag_list_get_double() etc. What will happen
489 * exactly in that case depends on how the tag was registered and if a
490 * merge function was supplied and if so which one.
492 * Two default merge functions are provided: gst_tag_merge_use_first() and
493 * gst_tag_merge_strings_with_comma().
496 gst_tag_register (const gchar * name, GstTagFlag flag, GType type,
497 const gchar * nick, const gchar * blurb, GstTagMergeFunc func)
499 g_return_if_fail (name != NULL);
500 g_return_if_fail (nick != NULL);
501 g_return_if_fail (blurb != NULL);
502 g_return_if_fail (type != 0 && type != GST_TYPE_LIST);
504 return gst_tag_register_static (g_intern_string (name), flag, type,
505 g_intern_string (nick), g_intern_string (blurb), func);
509 * gst_tag_register_static:
510 * @name: the name or identifier string (string constant)
511 * @flag: a flag describing the type of tag info
512 * @type: the type this data is in
513 * @nick: human-readable name or short description (string constant)
514 * @blurb: a human-readable description for this tag (string constant)
515 * @func: (allow-none): function for merging multiple values of this tag, or %NULL
517 * Registers a new tag type for the use with GStreamer's type system.
519 * Same as gst_tag_register(), but @name, @nick, and @blurb must be
520 * static strings or inlined strings, as they will not be copied. (GStreamer
521 * plugins will be made resident once loaded, so this function can be used
522 * even from dynamically loaded plugins.)
525 gst_tag_register_static (const gchar * name, GstTagFlag flag, GType type,
526 const gchar * nick, const gchar * blurb, GstTagMergeFunc func)
530 g_return_if_fail (name != NULL);
531 g_return_if_fail (nick != NULL);
532 g_return_if_fail (blurb != NULL);
533 g_return_if_fail (type != 0 && type != GST_TYPE_LIST);
535 info = gst_tag_lookup (name);
538 g_return_if_fail (info->type == type);
542 info = g_slice_new (GstTagInfo);
545 info->name_quark = g_quark_from_static_string (name);
548 info->merge_func = func;
551 g_hash_table_insert (__tags, (gpointer) name, info);
557 * @tag: name of the tag
559 * Checks if the given type is already registered.
561 * Returns: %TRUE if the type is already registered
564 gst_tag_exists (const gchar * tag)
566 g_return_val_if_fail (tag != NULL, FALSE);
568 return gst_tag_lookup (tag) != NULL;
575 * Gets the #GType used for this tag.
577 * Returns: the #GType of this tag
580 gst_tag_get_type (const gchar * tag)
584 g_return_val_if_fail (tag != NULL, 0);
585 info = gst_tag_lookup (tag);
586 g_return_val_if_fail (info != NULL, 0);
595 * Returns the human-readable name of this tag, You must not change or free
598 * Returns: the human-readable name of this tag
601 gst_tag_get_nick (const gchar * tag)
605 g_return_val_if_fail (tag != NULL, NULL);
606 info = gst_tag_lookup (tag);
607 g_return_val_if_fail (info != NULL, NULL);
613 * gst_tag_get_description:
616 * Returns the human-readable description of this tag, You must not change or
619 * Returns: the human-readable description of this tag
622 gst_tag_get_description (const gchar * tag)
626 g_return_val_if_fail (tag != NULL, NULL);
627 info = gst_tag_lookup (tag);
628 g_return_val_if_fail (info != NULL, NULL);
637 * Gets the flag of @tag.
639 * Returns: the flag of this tag.
642 gst_tag_get_flag (const gchar * tag)
646 g_return_val_if_fail (tag != NULL, GST_TAG_FLAG_UNDEFINED);
647 info = gst_tag_lookup (tag);
648 g_return_val_if_fail (info != NULL, GST_TAG_FLAG_UNDEFINED);
657 * Checks if the given tag is fixed. A fixed tag can only contain one value.
658 * Unfixed tags can contain lists of values.
660 * Returns: %TRUE, if the given tag is fixed.
663 gst_tag_is_fixed (const gchar * tag)
667 g_return_val_if_fail (tag != NULL, FALSE);
668 info = gst_tag_lookup (tag);
669 g_return_val_if_fail (info != NULL, FALSE);
671 return info->merge_func == NULL;
674 /* takes ownership of the structure */
676 gst_tag_list_new_internal (GstStructure * s)
678 GstTagList *tag_list;
680 g_assert (s != NULL);
682 tag_list = (GstTagList *) g_slice_new (GstTagListImpl);
684 gst_mini_object_init (GST_MINI_OBJECT_CAST (tag_list), 0, GST_TYPE_TAG_LIST,
685 (GstMiniObjectCopyFunction) __gst_tag_list_copy, NULL,
686 (GstMiniObjectFreeFunction) __gst_tag_list_free);
688 GST_TAG_LIST_STRUCTURE (tag_list) = s;
689 GST_TAG_LIST_SCOPE (tag_list) = GST_TAG_SCOPE_STREAM;
691 #ifdef DEBUG_REFCOUNT
692 GST_CAT_TRACE (GST_CAT_TAGS, "created taglist %p", tag_list);
699 __gst_tag_list_free (GstTagList * list)
701 g_return_if_fail (GST_IS_TAG_LIST (list));
703 #ifdef DEBUG_REFCOUNT
704 GST_CAT_TRACE (GST_CAT_TAGS, "freeing taglist %p", list);
707 gst_structure_free (GST_TAG_LIST_STRUCTURE (list));
709 g_slice_free1 (sizeof (GstTagListImpl), list);
713 __gst_tag_list_copy (const GstTagList * list)
715 const GstStructure *s;
717 g_return_val_if_fail (GST_IS_TAG_LIST (list), NULL);
719 s = GST_TAG_LIST_STRUCTURE (list);
720 return gst_tag_list_new_internal (gst_structure_copy (s));
724 * gst_tag_list_new_empty:
726 * Creates a new empty GstTagList.
728 * Free-function: gst_tag_list_unref
730 * Returns: (transfer full): An empty tag list
733 gst_tag_list_new_empty (void)
736 GstTagList *tag_list;
738 s = gst_structure_new_id_empty (GST_QUARK (TAGLIST));
739 tag_list = gst_tag_list_new_internal (s);
746 * @...: %NULL-terminated list of values to set
748 * Creates a new taglist and appends the values for the given tags. It expects
749 * tag-value pairs like gst_tag_list_add(), and a %NULL terminator after the
750 * last pair. The type of the values is implicit and is documented in the API
751 * reference, but can also be queried at runtime with gst_tag_get_type(). It
752 * is an error to pass a value of a type not matching the tag type into this
753 * function. The tag list will make copies of any arguments passed
754 * (e.g. strings, buffers).
756 * After creation you might also want to set a #GstTagScope on the returned
757 * taglist to signal if the contained tags are global or stream tags. By
758 * default stream scope is assumes. See gst_tag_list_set_scope().
760 * Free-function: gst_tag_list_unref
762 * Returns: (transfer full): a new #GstTagList. Free with gst_tag_list_unref()
763 * when no longer needed.
766 gst_tag_list_new (const gchar * tag, ...)
771 g_return_val_if_fail (tag != NULL, NULL);
773 list = gst_tag_list_new_empty ();
774 va_start (args, tag);
775 gst_tag_list_add_valist (list, GST_TAG_MERGE_APPEND, tag, args);
782 * gst_tag_list_new_valist:
783 * @var_args: tag / value pairs to set
785 * Just like gst_tag_list_new(), only that it takes a va_list argument.
786 * Useful mostly for language bindings.
788 * Free-function: gst_tag_list_unref
790 * Returns: (transfer full): a new #GstTagList. Free with gst_tag_list_unref()
791 * when no longer needed.
794 gst_tag_list_new_valist (va_list var_args)
799 list = gst_tag_list_new_empty ();
801 tag = va_arg (var_args, gchar *);
802 gst_tag_list_add_valist (list, GST_TAG_MERGE_APPEND, tag, var_args);
808 * gst_tag_list_set_scope:
809 * @list: a #GstTagList
810 * @scope: new scope for @list
812 * Sets the scope of @list to @scope. By default the scope
813 * of a taglist is stream scope.
817 gst_tag_list_set_scope (GstTagList * list, GstTagScope scope)
819 g_return_if_fail (GST_IS_TAG_LIST (list));
820 g_return_if_fail (gst_tag_list_is_writable (list));
822 GST_TAG_LIST_SCOPE (list) = scope;
826 * gst_tag_list_get_scope:
827 * @list: a #GstTagList
829 * Gets the scope of @list.
831 * Returns: The scope of @list
834 gst_tag_list_get_scope (const GstTagList * list)
836 g_return_val_if_fail (GST_IS_TAG_LIST (list), GST_TAG_SCOPE_STREAM);
838 return GST_TAG_LIST_SCOPE (list);
842 * gst_tag_list_to_string:
843 * @list: a #GstTagList
845 * Serializes a tag list to a string.
847 * Returns: (nullable): a newly-allocated string, or %NULL in case of
848 * an error. The string must be freed with g_free() when no longer
852 gst_tag_list_to_string (const GstTagList * list)
854 g_return_val_if_fail (GST_IS_TAG_LIST (list), NULL);
856 return gst_structure_to_string (GST_TAG_LIST_STRUCTURE (list));
860 * gst_tag_list_new_from_string:
861 * @str: a string created with gst_tag_list_to_string()
863 * Deserializes a tag list.
865 * Returns: (nullable): a new #GstTagList, or %NULL in case of an
869 gst_tag_list_new_from_string (const gchar * str)
871 GstTagList *tag_list;
874 g_return_val_if_fail (str != NULL, NULL);
875 g_return_val_if_fail (g_str_has_prefix (str, "taglist"), NULL);
877 s = gst_structure_from_string (str, NULL);
881 tag_list = gst_tag_list_new_internal (s);
887 * gst_tag_list_n_tags:
888 * @list: A #GstTagList.
890 * Get the number of tags in @list.
892 * Returns: The number of tags in @list.
895 gst_tag_list_n_tags (const GstTagList * list)
897 g_return_val_if_fail (list != NULL, 0);
898 g_return_val_if_fail (GST_IS_TAG_LIST (list), 0);
900 return gst_structure_n_fields (GST_TAG_LIST_STRUCTURE (list));
904 * gst_tag_list_nth_tag_name:
905 * @list: A #GstTagList.
908 * Get the name of the tag in @list at @index.
910 * Returns: The name of the tag at @index.
913 gst_tag_list_nth_tag_name (const GstTagList * list, guint index)
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_nth_field_name (GST_TAG_LIST_STRUCTURE (list), index);
922 * gst_tag_list_is_empty:
923 * @list: A #GstTagList.
925 * Checks if the given taglist is empty.
927 * Returns: %TRUE if the taglist is empty, otherwise %FALSE.
930 gst_tag_list_is_empty (const GstTagList * list)
932 g_return_val_if_fail (list != NULL, FALSE);
933 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
935 return (gst_structure_n_fields (GST_TAG_LIST_STRUCTURE (list)) == 0);
939 gst_tag_list_fields_equal (const GValue * value1, const GValue * value2)
943 if (gst_value_compare (value1, value2) == GST_VALUE_EQUAL)
946 /* fields not equal: add some tolerance for doubles, otherwise bail out */
947 if (!G_VALUE_HOLDS_DOUBLE (value1) || !G_VALUE_HOLDS_DOUBLE (value2))
950 d1 = g_value_get_double (value1);
951 d2 = g_value_get_double (value2);
953 /* This will only work for 'normal' values and values around 0,
954 * which should be good enough for our purposes here
955 * FIXME: maybe add this to gst_value_compare_double() ? */
956 return (fabs (d1 - d2) < 0.0000001);
960 * gst_tag_list_is_equal:
961 * @list1: a #GstTagList.
962 * @list2: a #GstTagList.
964 * Checks if the two given taglists are equal.
966 * Returns: %TRUE if the taglists are equal, otherwise %FALSE
969 gst_tag_list_is_equal (const GstTagList * list1, const GstTagList * list2)
971 const GstStructure *s1, *s2;
972 gint num_fields1, num_fields2, i;
974 g_return_val_if_fail (GST_IS_TAG_LIST (list1), FALSE);
975 g_return_val_if_fail (GST_IS_TAG_LIST (list2), FALSE);
977 /* we don't just use gst_structure_is_equal() here so we can add some
978 * tolerance for doubles, though maybe we should just add that to
979 * gst_value_compare_double() as well? */
980 s1 = GST_TAG_LIST_STRUCTURE (list1);
981 s2 = GST_TAG_LIST_STRUCTURE (list2);
983 num_fields1 = gst_structure_n_fields (s1);
984 num_fields2 = gst_structure_n_fields (s2);
986 if (num_fields1 != num_fields2)
989 for (i = 0; i < num_fields1; i++) {
990 const GValue *value1, *value2;
991 const gchar *tag_name;
993 tag_name = gst_structure_nth_field_name (s1, i);
994 value1 = gst_structure_get_value (s1, tag_name);
995 value2 = gst_structure_get_value (s2, tag_name);
1000 if (!gst_tag_list_fields_equal (value1, value2))
1010 GstTagMergeMode mode;
1015 gst_tag_list_add_value_internal (GstTagList * tag_list, GstTagMergeMode mode,
1016 const gchar * tag, const GValue * value, GstTagInfo * info)
1018 GstStructure *list = GST_TAG_LIST_STRUCTURE (tag_list);
1019 const GValue *value2;
1023 info = gst_tag_lookup (tag);
1024 if (G_UNLIKELY (info == NULL)) {
1025 g_warning ("unknown tag '%s'", tag);
1030 if (G_UNLIKELY (!G_VALUE_HOLDS (value, info->type) &&
1031 !GST_VALUE_HOLDS_LIST (value))) {
1032 g_warning ("tag '%s' should hold value of type '%s', but value of "
1033 "type '%s' passed", info->nick, g_type_name (info->type),
1034 g_type_name (G_VALUE_TYPE (value)));
1038 tag_quark = info->name_quark;
1040 if (info->merge_func
1041 && (value2 = gst_structure_id_get_value (list, tag_quark)) != NULL) {
1042 GValue dest = { 0, };
1045 case GST_TAG_MERGE_REPLACE_ALL:
1046 case GST_TAG_MERGE_REPLACE:
1047 gst_structure_id_set_value (list, tag_quark, value);
1049 case GST_TAG_MERGE_PREPEND:
1050 if (GST_VALUE_HOLDS_LIST (value2) && !GST_VALUE_HOLDS_LIST (value))
1051 gst_value_list_prepend_value ((GValue *) value2, value);
1053 gst_value_list_merge (&dest, value, value2);
1054 gst_structure_id_take_value (list, tag_quark, &dest);
1057 case GST_TAG_MERGE_APPEND:
1058 if (GST_VALUE_HOLDS_LIST (value2) && !GST_VALUE_HOLDS_LIST (value))
1059 gst_value_list_append_value ((GValue *) value2, value);
1061 gst_value_list_merge (&dest, value2, value);
1062 gst_structure_id_take_value (list, tag_quark, &dest);
1065 case GST_TAG_MERGE_KEEP:
1066 case GST_TAG_MERGE_KEEP_ALL:
1069 g_assert_not_reached ();
1074 case GST_TAG_MERGE_APPEND:
1075 case GST_TAG_MERGE_KEEP:
1076 if (gst_structure_id_get_value (list, tag_quark) != NULL)
1079 case GST_TAG_MERGE_REPLACE_ALL:
1080 case GST_TAG_MERGE_REPLACE:
1081 case GST_TAG_MERGE_PREPEND:
1082 gst_structure_id_set_value (list, tag_quark, value);
1084 case GST_TAG_MERGE_KEEP_ALL:
1087 g_assert_not_reached ();
1094 gst_tag_list_copy_foreach (GQuark tag_quark, const GValue * value,
1097 GstTagCopyData *copy = (GstTagCopyData *) user_data;
1100 tag = g_quark_to_string (tag_quark);
1101 gst_tag_list_add_value_internal (copy->list, copy->mode, tag, value, NULL);
1107 * gst_tag_list_insert:
1108 * @into: list to merge into
1109 * @from: list to merge from
1110 * @mode: the mode to use
1112 * Inserts the tags of the @from list into the first list using the given mode.
1115 gst_tag_list_insert (GstTagList * into, const GstTagList * from,
1116 GstTagMergeMode mode)
1118 GstTagCopyData data;
1120 g_return_if_fail (GST_IS_TAG_LIST (into));
1121 g_return_if_fail (gst_tag_list_is_writable (into));
1122 g_return_if_fail (GST_IS_TAG_LIST (from));
1123 g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
1127 if (mode == GST_TAG_MERGE_REPLACE_ALL) {
1128 gst_structure_remove_all_fields (GST_TAG_LIST_STRUCTURE (into));
1130 gst_structure_foreach (GST_TAG_LIST_STRUCTURE (from),
1131 gst_tag_list_copy_foreach, &data);
1135 * gst_tag_list_merge:
1136 * @list1: first list to merge
1137 * @list2: second list to merge
1138 * @mode: the mode to use
1140 * Merges the two given lists into a new list. If one of the lists is %NULL, a
1141 * copy of the other is returned. If both lists are %NULL, %NULL is returned.
1143 * Free-function: gst_tag_list_unref
1145 * Returns: (transfer full) (nullable): the new list
1148 gst_tag_list_merge (const GstTagList * list1, const GstTagList * list2,
1149 GstTagMergeMode mode)
1151 GstTagList *list1_cp;
1152 const GstTagList *list2_cp;
1154 g_return_val_if_fail (list1 == NULL || GST_IS_TAG_LIST (list1), NULL);
1155 g_return_val_if_fail (list2 == NULL || GST_IS_TAG_LIST (list2), NULL);
1156 g_return_val_if_fail (GST_TAG_MODE_IS_VALID (mode), NULL);
1158 /* nothing to merge */
1159 if (!list1 && !list2) {
1163 /* create empty list, we need to do this to correctly handling merge modes */
1164 list1_cp = (list1) ? gst_tag_list_copy (list1) : gst_tag_list_new_empty ();
1165 list2_cp = (list2) ? list2 : gst_tag_list_new_empty ();
1167 gst_tag_list_insert (list1_cp, list2_cp, mode);
1170 gst_tag_list_unref ((GstTagList *) list2_cp);
1176 * gst_tag_list_get_tag_size:
1178 * @tag: the tag to query
1180 * Checks how many value are stored in this tag list for the given tag.
1182 * Returns: The number of tags stored
1185 gst_tag_list_get_tag_size (const GstTagList * list, const gchar * tag)
1187 const GValue *value;
1189 g_return_val_if_fail (GST_IS_TAG_LIST (list), 0);
1191 value = gst_structure_get_value (GST_TAG_LIST_STRUCTURE (list), tag);
1194 if (G_VALUE_TYPE (value) != GST_TYPE_LIST)
1197 return gst_value_list_get_size (value);
1202 * @list: list to set tags in
1203 * @mode: the mode to use
1205 * @...: %NULL-terminated list of values to set
1207 * Sets the values for the given tags using the specified mode.
1210 gst_tag_list_add (GstTagList * list, GstTagMergeMode mode, const gchar * tag,
1215 g_return_if_fail (GST_IS_TAG_LIST (list));
1216 g_return_if_fail (gst_tag_list_is_writable (list));
1217 g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
1218 g_return_if_fail (tag != NULL);
1220 va_start (args, tag);
1221 gst_tag_list_add_valist (list, mode, tag, args);
1226 * gst_tag_list_add_values:
1227 * @list: list to set tags in
1228 * @mode: the mode to use
1230 * @...: GValues to set
1232 * Sets the GValues for the given tags using the specified mode.
1235 gst_tag_list_add_values (GstTagList * list, GstTagMergeMode mode,
1236 const gchar * tag, ...)
1240 g_return_if_fail (GST_IS_TAG_LIST (list));
1241 g_return_if_fail (gst_tag_list_is_writable (list));
1242 g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
1243 g_return_if_fail (tag != NULL);
1245 va_start (args, tag);
1246 gst_tag_list_add_valist_values (list, mode, tag, args);
1251 * gst_tag_list_add_valist:
1252 * @list: list to set tags in
1253 * @mode: the mode to use
1255 * @var_args: tag / value pairs to set
1257 * Sets the values for the given tags using the specified mode.
1260 gst_tag_list_add_valist (GstTagList * list, GstTagMergeMode mode,
1261 const gchar * tag, va_list var_args)
1264 gchar *error = NULL;
1266 g_return_if_fail (GST_IS_TAG_LIST (list));
1267 g_return_if_fail (gst_tag_list_is_writable (list));
1268 g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
1269 g_return_if_fail (tag != NULL);
1271 if (mode == GST_TAG_MERGE_REPLACE_ALL) {
1272 gst_structure_remove_all_fields (GST_TAG_LIST_STRUCTURE (list));
1275 while (tag != NULL) {
1276 GValue value = { 0, };
1278 info = gst_tag_lookup (tag);
1279 if (G_UNLIKELY (info == NULL)) {
1280 g_warning ("unknown tag '%s'", tag);
1283 G_VALUE_COLLECT_INIT (&value, info->type, var_args, 0, &error);
1285 g_warning ("%s: %s", G_STRLOC, error);
1287 /* we purposely leak the value here, it might not be
1288 * in a sane state if an error condition occoured
1292 /* Facilitate GstBuffer -> GstSample transition */
1293 if (G_UNLIKELY (info->type == GST_TYPE_SAMPLE &&
1294 !GST_IS_SAMPLE (value.data[0].v_pointer))) {
1295 g_warning ("Expected GstSample argument for tag '%s'", tag);
1297 gst_tag_list_add_value_internal (list, mode, tag, &value, info);
1299 g_value_unset (&value);
1300 tag = va_arg (var_args, gchar *);
1305 * gst_tag_list_add_valist_values:
1306 * @list: list to set tags in
1307 * @mode: the mode to use
1309 * @var_args: tag / GValue pairs to set
1311 * Sets the GValues for the given tags using the specified mode.
1314 gst_tag_list_add_valist_values (GstTagList * list, GstTagMergeMode mode,
1315 const gchar * tag, va_list var_args)
1317 g_return_if_fail (GST_IS_TAG_LIST (list));
1318 g_return_if_fail (gst_tag_list_is_writable (list));
1319 g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
1320 g_return_if_fail (tag != NULL);
1322 if (mode == GST_TAG_MERGE_REPLACE_ALL) {
1323 gst_structure_remove_all_fields (GST_TAG_LIST_STRUCTURE (list));
1326 while (tag != NULL) {
1329 info = gst_tag_lookup (tag);
1330 if (G_UNLIKELY (info == NULL)) {
1331 g_warning ("unknown tag '%s'", tag);
1334 gst_tag_list_add_value_internal (list, mode, tag, va_arg (var_args,
1336 tag = va_arg (var_args, gchar *);
1341 * gst_tag_list_add_value:
1342 * @list: list to set tags in
1343 * @mode: the mode to use
1345 * @value: GValue for this tag
1347 * Sets the GValue for a given tag using the specified mode.
1350 gst_tag_list_add_value (GstTagList * list, GstTagMergeMode mode,
1351 const gchar * tag, const GValue * value)
1353 g_return_if_fail (GST_IS_TAG_LIST (list));
1354 g_return_if_fail (gst_tag_list_is_writable (list));
1355 g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
1356 g_return_if_fail (tag != NULL);
1358 gst_tag_list_add_value_internal (list, mode, tag, value, NULL);
1362 * gst_tag_list_remove_tag:
1363 * @list: list to remove tag from
1364 * @tag: tag to remove
1366 * Removes the given tag from the taglist.
1369 gst_tag_list_remove_tag (GstTagList * list, const gchar * tag)
1371 g_return_if_fail (GST_IS_TAG_LIST (list));
1372 g_return_if_fail (tag != NULL);
1374 gst_structure_remove_field (GST_TAG_LIST_STRUCTURE (list), tag);
1379 GstTagForeachFunc func;
1380 const GstTagList *tag_list;
1386 structure_foreach_wrapper (GQuark field_id, const GValue * value,
1389 TagForeachData *data = (TagForeachData *) user_data;
1391 data->func (data->tag_list, g_quark_to_string (field_id), data->data);
1396 * gst_tag_list_foreach:
1397 * @list: list to iterate over
1398 * @func: (scope call): function to be called for each tag
1399 * @user_data: (closure): user specified data
1401 * Calls the given function for each tag inside the tag list. Note that if there
1402 * is no tag, the function won't be called at all.
1405 gst_tag_list_foreach (const GstTagList * list, GstTagForeachFunc func,
1408 TagForeachData data;
1410 g_return_if_fail (GST_IS_TAG_LIST (list));
1411 g_return_if_fail (func != NULL);
1414 data.tag_list = list;
1415 data.data = user_data;
1416 gst_structure_foreach (GST_TAG_LIST_STRUCTURE (list),
1417 structure_foreach_wrapper, &data);
1421 * gst_tag_list_get_value_index:
1422 * @list: a #GstTagList
1423 * @tag: tag to read out
1424 * @index: number of entry to read out
1426 * Gets the value that is at the given index for the given tag in the given
1429 * Returns: (transfer none) (nullable): The GValue for the specified
1430 * entry or %NULL if the tag wasn't available or the tag
1431 * doesn't have as many entries
1434 gst_tag_list_get_value_index (const GstTagList * list, const gchar * tag,
1437 const GValue *value;
1439 g_return_val_if_fail (GST_IS_TAG_LIST (list), NULL);
1440 g_return_val_if_fail (tag != NULL, NULL);
1442 value = gst_structure_get_value (GST_TAG_LIST_STRUCTURE (list), tag);
1446 if (GST_VALUE_HOLDS_LIST (value)) {
1447 if (index >= gst_value_list_get_size (value))
1449 return gst_value_list_get_value (value, index);
1458 * gst_tag_list_copy_value:
1459 * @dest: (out caller-allocates): uninitialized #GValue to copy into
1460 * @list: list to get the tag from
1461 * @tag: tag to read out
1463 * Copies the contents for the given tag into the value,
1464 * merging multiple values into one if multiple values are associated
1466 * You must g_value_unset() the value after use.
1468 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1472 gst_tag_list_copy_value (GValue * dest, const GstTagList * list,
1477 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
1478 g_return_val_if_fail (tag != NULL, FALSE);
1479 g_return_val_if_fail (dest != NULL, FALSE);
1480 g_return_val_if_fail (G_VALUE_TYPE (dest) == 0, FALSE);
1482 src = gst_structure_get_value (GST_TAG_LIST_STRUCTURE (list), tag);
1486 if (G_VALUE_TYPE (src) == GST_TYPE_LIST) {
1487 GstTagInfo *info = gst_tag_lookup (tag);
1492 /* must be there or lists aren't allowed */
1493 g_assert (info->merge_func);
1494 info->merge_func (dest, src);
1496 g_value_init (dest, G_VALUE_TYPE (src));
1497 g_value_copy (src, dest);
1502 /* FIXME 0.11: this whole merge function business is overdesigned, and the
1503 * _get_foo() API is misleading as well - how many application developers will
1504 * expect gst_tag_list_get_string (list, GST_TAG_ARTIST, &val) might return a
1505 * string with multiple comma-separated artists? _get_foo() should just be
1506 * a convenience wrapper around _get_foo_index (list, tag, 0, &val),
1507 * supplemented by a special _tag_list_get_string_merged() function if needed
1508 * (unless someone can actually think of real use cases where the merge
1509 * function is not 'use first' for non-strings and merge for strings) */
1511 /***** evil macros to get all the gst_tag_list_get_*() functions right *****/
1513 #define TAG_MERGE_FUNCS(name,type,ret) \
1515 gst_tag_list_get_ ## name (const GstTagList *list, const gchar *tag, \
1518 GValue v = { 0, }; \
1520 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE); \
1521 g_return_val_if_fail (tag != NULL, FALSE); \
1522 g_return_val_if_fail (value != NULL, FALSE); \
1524 if (!gst_tag_list_copy_value (&v, list, tag)) \
1526 *value = COPY_FUNC (g_value_get_ ## name (&v)); \
1527 g_value_unset (&v); \
1532 gst_tag_list_get_ ## name ## _index (const GstTagList *list, \
1534 guint index, type *value) \
1538 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE); \
1539 g_return_val_if_fail (tag != NULL, FALSE); \
1540 g_return_val_if_fail (value != NULL, FALSE); \
1542 if ((v = gst_tag_list_get_value_index (list, tag, index)) == NULL) \
1544 *value = COPY_FUNC (g_value_get_ ## name (v)); \
1548 #define COPY_FUNC /**/
1550 * gst_tag_list_get_boolean:
1551 * @list: a #GstTagList to get the tag from
1552 * @tag: tag to read out
1553 * @value: (out): location for the result
1555 * Copies the contents for the given tag into the value, merging multiple values
1556 * into one if multiple values are associated with the tag.
1558 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1562 * gst_tag_list_get_boolean_index:
1563 * @list: a #GstTagList to get the tag from
1564 * @tag: tag to read out
1565 * @index: number of entry to read out
1566 * @value: (out): location for the result
1568 * Gets the value that is at the given index for the given tag in the given
1571 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1574 TAG_MERGE_FUNCS (boolean, gboolean, TRUE);
1576 * gst_tag_list_get_int:
1577 * @list: a #GstTagList to get the tag from
1578 * @tag: tag to read out
1579 * @value: (out): location for the result
1581 * Copies the contents for the given tag into the value, merging multiple values
1582 * into one if multiple values are associated with the tag.
1584 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1588 * gst_tag_list_get_int_index:
1589 * @list: a #GstTagList to get the tag from
1590 * @tag: tag to read out
1591 * @index: number of entry to read out
1592 * @value: (out): location for the result
1594 * Gets the value that is at the given index for the given tag in the given
1597 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1600 TAG_MERGE_FUNCS (int, gint, TRUE);
1602 * gst_tag_list_get_uint:
1603 * @list: a #GstTagList to get the tag from
1604 * @tag: tag to read out
1605 * @value: (out): location for the result
1607 * Copies the contents for the given tag into the value, merging multiple values
1608 * into one if multiple values are associated with the tag.
1610 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1614 * gst_tag_list_get_uint_index:
1615 * @list: a #GstTagList to get the tag from
1616 * @tag: tag to read out
1617 * @index: number of entry to read out
1618 * @value: (out): location for the result
1620 * Gets the value that is at the given index for the given tag in the given
1623 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1626 TAG_MERGE_FUNCS (uint, guint, TRUE);
1628 * gst_tag_list_get_int64_index:
1629 * @list: a #GstTagList to get the tag from
1630 * @tag: tag to read out
1631 * @index: number of entry to read out
1632 * @value: (out): location for the result
1634 * Gets the value that is at the given index for the given tag in the given
1637 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1640 TAG_MERGE_FUNCS (int64, gint64, TRUE);
1642 * gst_tag_list_get_uint64:
1643 * @list: a #GstTagList to get the tag from
1644 * @tag: tag to read out
1645 * @value: (out): location for the result
1647 * Copies the contents for the given tag into the value, merging multiple values
1648 * into one if multiple values are associated with the tag.
1650 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1654 * gst_tag_list_get_uint64_index:
1655 * @list: a #GstTagList to get the tag from
1656 * @tag: tag to read out
1657 * @index: number of entry to read out
1658 * @value: (out): location for the result
1660 * Gets the value that is at the given index for the given tag in the given
1663 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1666 TAG_MERGE_FUNCS (uint64, guint64, TRUE);
1668 * gst_tag_list_get_float:
1669 * @list: a #GstTagList to get the tag from
1670 * @tag: tag to read out
1671 * @value: (out): location for the result
1673 * Copies the contents for the given tag into the value, merging multiple values
1674 * into one if multiple values are associated with the tag.
1676 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1680 * gst_tag_list_get_float_index:
1681 * @list: a #GstTagList to get the tag from
1682 * @tag: tag to read out
1683 * @index: number of entry to read out
1684 * @value: (out): location for the result
1686 * Gets the value that is at the given index for the given tag in the given
1689 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1692 TAG_MERGE_FUNCS (float, gfloat, TRUE);
1694 * gst_tag_list_get_double:
1695 * @list: a #GstTagList to get the tag from
1696 * @tag: tag to read out
1697 * @value: (out): location for the result
1699 * Copies the contents for the given tag into the value, merging multiple values
1700 * into one if multiple values are associated with the tag.
1702 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1706 * gst_tag_list_get_double_index:
1707 * @list: a #GstTagList to get the tag from
1708 * @tag: tag to read out
1709 * @index: number of entry to read out
1710 * @value: (out): location for the result
1712 * Gets the value that is at the given index for the given tag in the given
1715 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1718 TAG_MERGE_FUNCS (double, gdouble, TRUE);
1720 * gst_tag_list_get_pointer:
1721 * @list: a #GstTagList to get the tag from
1722 * @tag: tag to read out
1723 * @value: (out) (transfer none): location for the result
1725 * Copies the contents for the given tag into the value, merging multiple values
1726 * into one if multiple values are associated with the tag.
1728 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1732 * gst_tag_list_get_pointer_index:
1733 * @list: a #GstTagList to get the tag from
1734 * @tag: tag to read out
1735 * @index: number of entry to read out
1736 * @value: (out) (transfer none): location for the result
1738 * Gets the value that is at the given index for the given tag in the given
1741 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1744 TAG_MERGE_FUNCS (pointer, gpointer, (*value != NULL));
1746 static inline gchar *
1747 _gst_strdup0 (const gchar * s)
1749 if (s == NULL || *s == '\0')
1752 return g_strdup (s);
1756 #define COPY_FUNC _gst_strdup0
1759 * gst_tag_list_get_string:
1760 * @list: a #GstTagList to get the tag from
1761 * @tag: tag to read out
1762 * @value: (out callee-allocates) (transfer full): location for the result
1764 * Copies the contents for the given tag into the value, possibly merging
1765 * multiple values into one if multiple values are associated with the tag.
1767 * Use gst_tag_list_get_string_index (list, tag, 0, value) if you want
1768 * to retrieve the first string associated with this tag unmodified.
1770 * The resulting string in @value will be in UTF-8 encoding and should be
1771 * freed by the caller using g_free when no longer needed. The
1772 * returned string is also guaranteed to be non-%NULL and non-empty.
1774 * Free-function: g_free
1776 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1780 * gst_tag_list_get_string_index:
1781 * @list: a #GstTagList to get the tag from
1782 * @tag: tag to read out
1783 * @index: number of entry to read out
1784 * @value: (out callee-allocates) (transfer full): location for the result
1786 * Gets the value that is at the given index for the given tag in the given
1789 * The resulting string in @value will be in UTF-8 encoding and should be
1790 * freed by the caller using g_free when no longer needed. The
1791 * returned string is also guaranteed to be non-%NULL and non-empty.
1793 * Free-function: g_free
1795 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1798 TAG_MERGE_FUNCS (string, gchar *, (*value != NULL));
1801 *FIXME 0.11: Instead of _peek (non-copy) and _get (copy), we could have
1802 * _get (non-copy) and _dup (copy) for strings, seems more
1806 * gst_tag_list_peek_string_index:
1807 * @list: a #GstTagList to get the tag from
1808 * @tag: tag to read out
1809 * @index: number of entry to read out
1810 * @value: (out) (transfer none): location for the result
1812 * Peeks at the value that is at the given index for the given tag in the given
1815 * The resulting string in @value will be in UTF-8 encoding and doesn't need
1816 * to be freed by the caller. The returned string is also guaranteed to
1817 * be non-%NULL and non-empty.
1819 * Returns: %TRUE, if a value was set, %FALSE if the tag didn't exist in the
1823 gst_tag_list_peek_string_index (const GstTagList * list,
1824 const gchar * tag, guint index, const gchar ** value)
1828 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
1829 g_return_val_if_fail (tag != NULL, FALSE);
1830 g_return_val_if_fail (value != NULL, FALSE);
1832 if ((v = gst_tag_list_get_value_index (list, tag, index)) == NULL)
1834 *value = g_value_get_string (v);
1835 return *value != NULL && **value != '\0';
1839 * gst_tag_list_get_date:
1840 * @list: a #GstTagList to get the tag from
1841 * @tag: tag to read out
1842 * @value: (out callee-allocates) (transfer full): address of a GDate pointer
1843 * variable to store the result into
1845 * Copies the first date for the given tag in the taglist into the variable
1846 * pointed to by @value. Free the date with g_date_free() when it is no longer
1849 * Free-function: g_date_free
1851 * Returns: %TRUE, if a date was copied, %FALSE if the tag didn't exist in the
1852 * given list or if it was %NULL.
1855 gst_tag_list_get_date (const GstTagList * list, const gchar * tag,
1860 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
1861 g_return_val_if_fail (tag != NULL, FALSE);
1862 g_return_val_if_fail (value != NULL, FALSE);
1864 if (!gst_tag_list_copy_value (&v, list, tag))
1866 *value = (GDate *) g_value_dup_boxed (&v);
1868 return (*value != NULL);
1872 * gst_tag_list_get_date_index:
1873 * @list: a #GstTagList to get the tag from
1874 * @tag: tag to read out
1875 * @index: number of entry to read out
1876 * @value: (out callee-allocates) (transfer full): location for the result
1878 * Gets the date that is at the given index for the given tag in the given
1879 * list and copies it into the variable pointed to by @value. Free the date
1880 * with g_date_free() when it is no longer needed.
1882 * Free-function: g_date_free
1884 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1885 * given list or if it was %NULL.
1888 gst_tag_list_get_date_index (const GstTagList * list,
1889 const gchar * tag, guint index, GDate ** value)
1893 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
1894 g_return_val_if_fail (tag != NULL, FALSE);
1895 g_return_val_if_fail (value != NULL, FALSE);
1897 if ((v = gst_tag_list_get_value_index (list, tag, index)) == NULL)
1899 *value = (GDate *) g_value_dup_boxed (v);
1900 return (*value != NULL);
1904 * gst_tag_list_get_date_time:
1905 * @list: a #GstTagList to get the tag from
1906 * @tag: tag to read out
1907 * @value: (out callee-allocates) (transfer full): address of a #GstDateTime
1908 * pointer variable to store the result into
1910 * Copies the first datetime for the given tag in the taglist into the variable
1911 * pointed to by @value. Unref the date with gst_date_time_unref() when
1912 * it is no longer needed.
1914 * Free-function: gst_date_time_unref
1916 * Returns: %TRUE, if a datetime was copied, %FALSE if the tag didn't exist in
1917 * the given list or if it was %NULL.
1920 gst_tag_list_get_date_time (const GstTagList * list, const gchar * tag,
1921 GstDateTime ** value)
1925 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
1926 g_return_val_if_fail (tag != NULL, FALSE);
1927 g_return_val_if_fail (value != NULL, FALSE);
1929 if (!gst_tag_list_copy_value (&v, list, tag))
1932 *value = (GstDateTime *) g_value_dup_boxed (&v);
1934 return (*value != NULL);
1938 * gst_tag_list_get_date_time_index:
1939 * @list: a #GstTagList to get the tag from
1940 * @tag: tag to read out
1941 * @index: number of entry to read out
1942 * @value: (out callee-allocates) (transfer full): location for the result
1944 * Gets the datetime that is at the given index for the given tag in the given
1945 * list and copies it into the variable pointed to by @value. Unref the datetime
1946 * with gst_date_time_unref() when it is no longer needed.
1948 * Free-function: gst_date_time_unref
1950 * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1951 * given list or if it was %NULL.
1954 gst_tag_list_get_date_time_index (const GstTagList * list,
1955 const gchar * tag, guint index, GstDateTime ** value)
1959 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
1960 g_return_val_if_fail (tag != NULL, FALSE);
1961 g_return_val_if_fail (value != NULL, FALSE);
1963 if ((v = gst_tag_list_get_value_index (list, tag, index)) == NULL)
1965 *value = (GstDateTime *) g_value_dup_boxed (v);
1966 return (*value != NULL);
1970 * gst_tag_list_get_sample:
1971 * @list: a #GstTagList to get the tag from
1972 * @tag: tag to read out
1973 * @sample: (out callee-allocates) (transfer full): address of a GstSample
1974 * pointer variable to store the result into
1976 * Copies the first sample for the given tag in the taglist into the variable
1977 * pointed to by @sample. Free the sample with gst_sample_unref() when it is
1978 * no longer needed. You can retrieve the buffer from the sample using
1979 * gst_sample_get_buffer() and the associated caps (if any) with
1980 * gst_sample_get_caps().
1982 * Free-function: gst_sample_unref
1984 * Returns: %TRUE, if a sample was returned, %FALSE if the tag didn't exist in
1985 * the given list or if it was %NULL.
1988 gst_tag_list_get_sample (const GstTagList * list, const gchar * tag,
1989 GstSample ** sample)
1993 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
1994 g_return_val_if_fail (tag != NULL, FALSE);
1995 g_return_val_if_fail (sample != NULL, FALSE);
1997 if (!gst_tag_list_copy_value (&v, list, tag))
1999 *sample = g_value_dup_boxed (&v);
2001 return (*sample != NULL);
2005 * gst_tag_list_get_sample_index:
2006 * @list: a #GstTagList to get the tag from
2007 * @tag: tag to read out
2008 * @index: number of entry to read out
2009 * @sample: (out callee-allocates) (transfer full): address of a GstSample
2010 * pointer variable to store the result into
2012 * Gets the sample that is at the given index for the given tag in the given
2013 * list and copies it into the variable pointed to by @sample. Free the sample
2014 * with gst_sample_unref() when it is no longer needed. You can retrieve the
2015 * buffer from the sample using gst_sample_get_buffer() and the associated
2016 * caps (if any) with gst_sample_get_caps().
2018 * Free-function: gst_sample_unref
2020 * Returns: %TRUE, if a sample was copied, %FALSE if the tag didn't exist in the
2021 * given list or if it was %NULL.
2024 gst_tag_list_get_sample_index (const GstTagList * list,
2025 const gchar * tag, guint index, GstSample ** sample)
2029 g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
2030 g_return_val_if_fail (tag != NULL, FALSE);
2031 g_return_val_if_fail (sample != NULL, FALSE);
2033 if ((v = gst_tag_list_get_value_index (list, tag, index)) == NULL)
2035 *sample = g_value_dup_boxed (v);
2036 return (*sample != NULL);