gst/gsttaglist.c

   1 /* GStreamer
   2  * Copyright (C) 2003 Benjamin Otte <in7y118@public.uni-hamburg.de>
   3  *
   4  * gsttaglist.c: tag support (aka metadata)
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  19  * Boston, MA 02110-1301, USA.
  20  */
  21
  22 /**
  23  * SECTION:gsttaglist
  24  * @short_description: List of tags and values used to describe media metadata
  25  *
  26  * List of tags and values used to describe media metadata.
  27  *
  28  * Strings in structures must be ASCII or UTF-8 encoded. Other encodings are
  29  * not allowed. Strings must not be empty or %NULL.
  30  */
  31
  32 #ifdef HAVE_CONFIG_H
  33 #  include "config.h"
  34 #endif
  35
  36 #include "gst_private.h"
  37 #include "math-compat.h"
  38 #include "gst-i18n-lib.h"
  39 #include "gsttaglist.h"
  40 #include "gstinfo.h"
  41 #include "gstvalue.h"
  42 #include "gstbuffer.h"
  43 #include "gstquark.h"
  44 #include "gststructure.h"
  45
  46 #include <gobject/gvaluecollector.h>
  47 #include <string.h>
  48
  49 /* FIXME: add category for tags */
  50 #define GST_CAT_TAGS GST_CAT_DEFAULT
  51
  52 #define GST_TAG_IS_VALID(tag)           (gst_tag_get_info (tag) != NULL)
  53
  54 typedef struct _GstTagListImpl
  55 {
  56   GstTagList taglist;
  57
  58   GstStructure *structure;
  59   GstTagScope scope;
  60 } GstTagListImpl;
  61
  62 #define GST_TAG_LIST_STRUCTURE(taglist)  ((GstTagListImpl*)(taglist))->structure
  63 #define GST_TAG_LIST_SCOPE(taglist)  ((GstTagListImpl*)(taglist))->scope
  64
  65 typedef struct
  66 {
  67   GType type;                   /* type the data is in */
  68
  69   const gchar *nick;            /* translated short description */
  70   const gchar *blurb;           /* translated long description  */
  71
  72   GstTagMergeFunc merge_func;   /* functions to merge the values */
  73   GstTagFlag flag;              /* type of tag */
  74   GQuark name_quark;            /* quark for the name */
  75 }
  76 GstTagInfo;
  77
  78 #define g_value_get_char g_value_get_schar
  79
  80 static GMutex __tag_mutex;
  81 #define TAG_LOCK g_mutex_lock (&__tag_mutex)
  82 #define TAG_UNLOCK g_mutex_unlock (&__tag_mutex)
  83
  84 /* tags hash table: maps tag name string => GstTagInfo */
  85 static GHashTable *__tags;
  86
  87 GType _gst_tag_list_type = 0;
  88 GST_DEFINE_MINI_OBJECT_TYPE (GstTagList, gst_tag_list);
  89
  90 static void __gst_tag_list_free (GstTagList * list);
  91 static GstTagList *__gst_tag_list_copy (const GstTagList * list);
  92
  93 /* FIXME: had code:
  94  *    g_value_register_transform_func (_gst_tag_list_type, G_TYPE_STRING,
  95  *      _gst_structure_transform_to_string);
  96  */
  97 void
  98 _priv_gst_tag_initialize (void)
  99 {
 100   g_mutex_init (&__tag_mutex);
 101
 102   _gst_tag_list_type = gst_tag_list_get_type ();
 103
 104   __tags = g_hash_table_new (g_str_hash, g_str_equal);
 105   gst_tag_register_static (GST_TAG_TITLE, GST_TAG_FLAG_META,
 106       G_TYPE_STRING,
 107       _("title"), _("commonly used title"), gst_tag_merge_strings_with_comma);
 108   gst_tag_register_static (GST_TAG_TITLE_SORTNAME, GST_TAG_FLAG_META,
 109       G_TYPE_STRING,
 110       _("title sortname"), _("commonly used title for sorting purposes"), NULL);
 111   gst_tag_register_static (GST_TAG_ARTIST, GST_TAG_FLAG_META,
 112       G_TYPE_STRING,
 113       _("artist"),
 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,
 117       G_TYPE_STRING,
 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,
 121       G_TYPE_STRING,
 122       _("album"),
 123       _("album containing this data"), gst_tag_merge_strings_with_comma);
 124   gst_tag_register_static (GST_TAG_ALBUM_SORTNAME, GST_TAG_FLAG_META,
 125       G_TYPE_STRING,
 126       _("album sortname"),
 127       _("album containing this data for sorting purposes"), NULL);
 128   gst_tag_register_static (GST_TAG_ALBUM_ARTIST, GST_TAG_FLAG_META,
 129       G_TYPE_STRING,
 130       _("album artist"),
 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,
 134       G_TYPE_STRING,
 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)"),
 142       NULL);
 143   gst_tag_register_static (GST_TAG_GENRE, GST_TAG_FLAG_META,
 144       G_TYPE_STRING,
 145       _("genre"),
 146       _("genre this data belongs to"), gst_tag_merge_strings_with_comma);
 147   gst_tag_register_static (GST_TAG_COMMENT, GST_TAG_FLAG_META,
 148       G_TYPE_STRING,
 149       _("comment"),
 150       _("free text commenting the data"), gst_tag_merge_use_first);
 151   gst_tag_register_static (GST_TAG_EXTENDED_COMMENT, GST_TAG_FLAG_META,
 152       G_TYPE_STRING,
 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,
 157       G_TYPE_UINT,
 158       _("track number"),
 159       _("track number inside a collection"), gst_tag_merge_use_first);
 160   gst_tag_register_static (GST_TAG_TRACK_COUNT, GST_TAG_FLAG_META,
 161       G_TYPE_UINT,
 162       _("track count"),
 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,
 166       G_TYPE_UINT,
 167       _("disc number"),
 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,
 170       G_TYPE_UINT,
 171       _("disc count"),
 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,
 175       G_TYPE_STRING,
 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,
 180       G_TYPE_STRING,
 181       _("homepage"),
 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,
 191       _("ISRC"),
 192       _
 193       ("International Standard Recording Code - see http://www.ifpi.org/isrc/"),
 194       NULL);
 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,
 208       G_TYPE_STRING,
 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,
 216       G_TYPE_STRING,
 217       _("performer"),
 218       _("person(s) performing"), gst_tag_merge_strings_with_comma);
 219   gst_tag_register_static (GST_TAG_COMPOSER, GST_TAG_FLAG_META,
 220       G_TYPE_STRING,
 221       _("composer"),
 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,
 225       G_TYPE_UINT64,
 226       _("duration"), _("length in GStreamer time units (nanoseconds)"), NULL);
 227   gst_tag_register_static (GST_TAG_CODEC, GST_TAG_FLAG_ENCODED,
 228       G_TYPE_STRING,
 229       _("codec"),
 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,
 232       G_TYPE_STRING,
 233       _("video codec"), _("codec the video data is stored in"), NULL);
 234   gst_tag_register_static (GST_TAG_AUDIO_CODEC, GST_TAG_FLAG_ENCODED,
 235       G_TYPE_STRING,
 236       _("audio codec"), _("codec the audio data is stored in"), NULL);
 237   gst_tag_register_static (GST_TAG_SUBTITLE_CODEC, GST_TAG_FLAG_ENCODED,
 238       G_TYPE_STRING,
 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,
 252       G_TYPE_STRING,
 253       _("encoder"), _("encoder used to encode this stream"), NULL);
 254   gst_tag_register_static (GST_TAG_ENCODER_VERSION, GST_TAG_FLAG_ENCODED,
 255       G_TYPE_UINT,
 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"),
 274       NULL);
 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,
 281       GST_TYPE_SAMPLE,
 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)"),
 326       NULL);
 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 "
 330           "in m/s"), NULL);
 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 "
 336           "clockwise"), NULL);
 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 "
 342           "clockwise"), NULL);
 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 */
 345       _("show name"),
 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,
 349       G_TYPE_STRING,
 350       /* TRANSLATORS: 'show sortname' = 'TV/radio/podcast show name as used for sorting purposes' here */
 351       _("show sortname"),
 352       _("Name of the tv/podcast/series show the media is from, for sorting "
 353           "purposes"), NULL);
 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,
 369       _("grouping"),
 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,
 374       _("user rating"),
 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,
 393       G_TYPE_STRING,
 394       _("publisher"),
 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,
 397       G_TYPE_STRING,
 398       _("interpreted-by"),
 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,
 402       G_TYPE_UINT,
 403       _("midi-base-note"), _("Midi note number of the audio track."), NULL);
 404 }
 405
 406 /**
 407  * gst_tag_merge_use_first:
 408  * @dest: (out caller-allocates): uninitialized GValue to store result in
 409  * @src: GValue to copy from
 410  *
 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.
 413  */
 414 void
 415 gst_tag_merge_use_first (GValue * dest, const GValue * src)
 416 {
 417   const GValue *ret = gst_value_list_get_value (src, 0);
 418
 419   g_value_init (dest, G_VALUE_TYPE (ret));
 420   g_value_copy (ret, dest);
 421 }
 422
 423 /**
 424  * gst_tag_merge_strings_with_comma:
 425  * @dest: (out caller-allocates): uninitialized GValue to store result in
 426  * @src: GValue to copy from
 427  *
 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.
 431  */
 432 void
 433 gst_tag_merge_strings_with_comma (GValue * dest, const GValue * src)
 434 {
 435   GString *str;
 436   gint i, count;
 437
 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)));
 445   }
 446
 447   g_value_init (dest, G_TYPE_STRING);
 448   g_value_take_string (dest, str->str);
 449   g_string_free (str, FALSE);
 450 }
 451
 452 static GstTagInfo *
 453 gst_tag_lookup (const gchar * tag_name)
 454 {
 455   GstTagInfo *ret;
 456
 457   TAG_LOCK;
 458   ret = g_hash_table_lookup (__tags, (gpointer) tag_name);
 459   TAG_UNLOCK;
 460
 461   return ret;
 462 }
 463
 464 /**
 465  * gst_tag_register:
 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
 472  *
 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.
 477  *
 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).
 484  *
 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.
 491  *
 492  * Two default merge functions are provided: gst_tag_merge_use_first() and
 493  * gst_tag_merge_strings_with_comma().
 494  */
 495 void
 496 gst_tag_register (const gchar * name, GstTagFlag flag, GType type,
 497     const gchar * nick, const gchar * blurb, GstTagMergeFunc func)
 498 {
 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);
 503
 504   return gst_tag_register_static (g_intern_string (name), flag, type,
 505       g_intern_string (nick), g_intern_string (blurb), func);
 506 }
 507
 508 /**
 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
 516  *
 517  * Registers a new tag type for the use with GStreamer's type system.
 518  *
 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.)
 523  */
 524 void
 525 gst_tag_register_static (const gchar * name, GstTagFlag flag, GType type,
 526     const gchar * nick, const gchar * blurb, GstTagMergeFunc func)
 527 {
 528   GstTagInfo *info;
 529
 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);
 534
 535   info = gst_tag_lookup (name);
 536
 537   if (info) {
 538     g_return_if_fail (info->type == type);
 539     return;
 540   }
 541
 542   info = g_slice_new (GstTagInfo);
 543   info->flag = flag;
 544   info->type = type;
 545   info->name_quark = g_quark_from_static_string (name);
 546   info->nick = nick;
 547   info->blurb = blurb;
 548   info->merge_func = func;
 549
 550   TAG_LOCK;
 551   g_hash_table_insert (__tags, (gpointer) name, info);
 552   TAG_UNLOCK;
 553 }
 554
 555 /**
 556  * gst_tag_exists:
 557  * @tag: name of the tag
 558  *
 559  * Checks if the given type is already registered.
 560  *
 561  * Returns: %TRUE if the type is already registered
 562  */
 563 gboolean
 564 gst_tag_exists (const gchar * tag)
 565 {
 566   g_return_val_if_fail (tag != NULL, FALSE);
 567
 568   return gst_tag_lookup (tag) != NULL;
 569 }
 570
 571 /**
 572  * gst_tag_get_type:
 573  * @tag: the tag
 574  *
 575  * Gets the #GType used for this tag.
 576  *
 577  * Returns: the #GType of this tag
 578  */
 579 GType
 580 gst_tag_get_type (const gchar * tag)
 581 {
 582   GstTagInfo *info;
 583
 584   g_return_val_if_fail (tag != NULL, 0);
 585   info = gst_tag_lookup (tag);
 586   g_return_val_if_fail (info != NULL, 0);
 587
 588   return info->type;
 589 }
 590
 591 /**
 592  * gst_tag_get_nick:
 593  * @tag: the tag
 594  *
 595  * Returns the human-readable name of this tag, You must not change or free
 596  * this string.
 597  *
 598  * Returns: the human-readable name of this tag
 599  */
 600 const gchar *
 601 gst_tag_get_nick (const gchar * tag)
 602 {
 603   GstTagInfo *info;
 604
 605   g_return_val_if_fail (tag != NULL, NULL);
 606   info = gst_tag_lookup (tag);
 607   g_return_val_if_fail (info != NULL, NULL);
 608
 609   return info->nick;
 610 }
 611
 612 /**
 613  * gst_tag_get_description:
 614  * @tag: the tag
 615  *
 616  * Returns the human-readable description of this tag, You must not change or
 617  * free this string.
 618  *
 619  * Returns: the human-readable description of this tag
 620  */
 621 const gchar *
 622 gst_tag_get_description (const gchar * tag)
 623 {
 624   GstTagInfo *info;
 625
 626   g_return_val_if_fail (tag != NULL, NULL);
 627   info = gst_tag_lookup (tag);
 628   g_return_val_if_fail (info != NULL, NULL);
 629
 630   return info->blurb;
 631 }
 632
 633 /**
 634  * gst_tag_get_flag:
 635  * @tag: the tag
 636  *
 637  * Gets the flag of @tag.
 638  *
 639  * Returns: the flag of this tag.
 640  */
 641 GstTagFlag
 642 gst_tag_get_flag (const gchar * tag)
 643 {
 644   GstTagInfo *info;
 645
 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);
 649
 650   return info->flag;
 651 }
 652
 653 /**
 654  * gst_tag_is_fixed:
 655  * @tag: tag to check
 656  *
 657  * Checks if the given tag is fixed. A fixed tag can only contain one value.
 658  * Unfixed tags can contain lists of values.
 659  *
 660  * Returns: %TRUE, if the given tag is fixed.
 661  */
 662 gboolean
 663 gst_tag_is_fixed (const gchar * tag)
 664 {
 665   GstTagInfo *info;
 666
 667   g_return_val_if_fail (tag != NULL, FALSE);
 668   info = gst_tag_lookup (tag);
 669   g_return_val_if_fail (info != NULL, FALSE);
 670
 671   return info->merge_func == NULL;
 672 }
 673
 674 /* takes ownership of the structure */
 675 static GstTagList *
 676 gst_tag_list_new_internal (GstStructure * s)
 677 {
 678   GstTagList *tag_list;
 679
 680   g_assert (s != NULL);
 681
 682   tag_list = (GstTagList *) g_slice_new (GstTagListImpl);
 683
 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);
 687
 688   GST_TAG_LIST_STRUCTURE (tag_list) = s;
 689   GST_TAG_LIST_SCOPE (tag_list) = GST_TAG_SCOPE_STREAM;
 690
 691 #ifdef DEBUG_REFCOUNT
 692   GST_CAT_TRACE (GST_CAT_TAGS, "created taglist %p", tag_list);
 693 #endif
 694
 695   return tag_list;
 696 }
 697
 698 static void
 699 __gst_tag_list_free (GstTagList * list)
 700 {
 701   g_return_if_fail (GST_IS_TAG_LIST (list));
 702
 703 #ifdef DEBUG_REFCOUNT
 704   GST_CAT_TRACE (GST_CAT_TAGS, "freeing taglist %p", list);
 705 #endif
 706
 707   gst_structure_free (GST_TAG_LIST_STRUCTURE (list));
 708
 709   g_slice_free1 (sizeof (GstTagListImpl), list);
 710 }
 711
 712 static GstTagList *
 713 __gst_tag_list_copy (const GstTagList * list)
 714 {
 715   const GstStructure *s;
 716
 717   g_return_val_if_fail (GST_IS_TAG_LIST (list), NULL);
 718
 719   s = GST_TAG_LIST_STRUCTURE (list);
 720   return gst_tag_list_new_internal (gst_structure_copy (s));
 721 }
 722
 723 /**
 724  * gst_tag_list_new_empty:
 725  *
 726  * Creates a new empty GstTagList.
 727  *
 728  * Free-function: gst_tag_list_unref
 729  *
 730  * Returns: (transfer full): An empty tag list
 731  */
 732 GstTagList *
 733 gst_tag_list_new_empty (void)
 734 {
 735   GstStructure *s;
 736   GstTagList *tag_list;
 737
 738   s = gst_structure_new_id_empty (GST_QUARK (TAGLIST));
 739   tag_list = gst_tag_list_new_internal (s);
 740   return tag_list;
 741 }
 742
 743 /**
 744  * gst_tag_list_new:
 745  * @tag: tag
 746  * @...: %NULL-terminated list of values to set
 747  *
 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).
 755  *
 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().
 759  *
 760  * Free-function: gst_tag_list_unref
 761  *
 762  * Returns: (transfer full): a new #GstTagList. Free with gst_tag_list_unref()
 763  *     when no longer needed.
 764  */
 765 GstTagList *
 766 gst_tag_list_new (const gchar * tag, ...)
 767 {
 768   GstTagList *list;
 769   va_list args;
 770
 771   g_return_val_if_fail (tag != NULL, NULL);
 772
 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);
 776   va_end (args);
 777
 778   return list;
 779 }
 780
 781 /**
 782  * gst_tag_list_new_valist:
 783  * @var_args: tag / value pairs to set
 784  *
 785  * Just like gst_tag_list_new(), only that it takes a va_list argument.
 786  * Useful mostly for language bindings.
 787  *
 788  * Free-function: gst_tag_list_unref
 789  *
 790  * Returns: (transfer full): a new #GstTagList. Free with gst_tag_list_unref()
 791  *     when no longer needed.
 792  */
 793 GstTagList *
 794 gst_tag_list_new_valist (va_list var_args)
 795 {
 796   GstTagList *list;
 797   const gchar *tag;
 798
 799   list = gst_tag_list_new_empty ();
 800
 801   tag = va_arg (var_args, gchar *);
 802   gst_tag_list_add_valist (list, GST_TAG_MERGE_APPEND, tag, var_args);
 803
 804   return list;
 805 }
 806
 807 /**
 808  * gst_tag_list_set_scope:
 809  * @list: a #GstTagList
 810  * @scope: new scope for @list
 811  *
 812  * Sets the scope of @list to @scope. By default the scope
 813  * of a taglist is stream scope.
 814  *
 815  */
 816 void
 817 gst_tag_list_set_scope (GstTagList * list, GstTagScope scope)
 818 {
 819   g_return_if_fail (GST_IS_TAG_LIST (list));
 820   g_return_if_fail (gst_tag_list_is_writable (list));
 821
 822   GST_TAG_LIST_SCOPE (list) = scope;
 823 }
 824
 825 /**
 826  * gst_tag_list_get_scope:
 827  * @list: a #GstTagList
 828  *
 829  * Gets the scope of @list.
 830  *
 831  * Returns: The scope of @list
 832  */
 833 GstTagScope
 834 gst_tag_list_get_scope (const GstTagList * list)
 835 {
 836   g_return_val_if_fail (GST_IS_TAG_LIST (list), GST_TAG_SCOPE_STREAM);
 837
 838   return GST_TAG_LIST_SCOPE (list);
 839 }
 840
 841 /**
 842  * gst_tag_list_to_string:
 843  * @list: a #GstTagList
 844  *
 845  * Serializes a tag list to a string.
 846  *
 847  * Returns: a newly-allocated string, or %NULL in case of an error. The
 848  *    string must be freed with g_free() when no longer needed.
 849  */
 850 gchar *
 851 gst_tag_list_to_string (const GstTagList * list)
 852 {
 853   g_return_val_if_fail (GST_IS_TAG_LIST (list), NULL);
 854
 855   return gst_structure_to_string (GST_TAG_LIST_STRUCTURE (list));
 856 }
 857
 858 /**
 859  * gst_tag_list_new_from_string:
 860  * @str: a string created with gst_tag_list_to_string()
 861  *
 862  * Deserializes a tag list.
 863  *
 864  * Returns: a new #GstTagList, or %NULL in case of an error.
 865  */
 866 GstTagList *
 867 gst_tag_list_new_from_string (const gchar * str)
 868 {
 869   GstTagList *tag_list;
 870   GstStructure *s;
 871
 872   g_return_val_if_fail (str != NULL, NULL);
 873   g_return_val_if_fail (g_str_has_prefix (str, "taglist"), NULL);
 874
 875   s = gst_structure_from_string (str, NULL);
 876   if (s == NULL)
 877     return NULL;
 878
 879   tag_list = gst_tag_list_new_internal (s);
 880
 881   return tag_list;
 882 }
 883
 884 /**
 885  * gst_tag_list_n_tags:
 886  * @list: A #GstTagList.
 887  *
 888  * Get the number of tags in @list.
 889  *
 890  * Returns: The number of tags in @list.
 891  */
 892 gint
 893 gst_tag_list_n_tags (const GstTagList * list)
 894 {
 895   g_return_val_if_fail (list != NULL, 0);
 896   g_return_val_if_fail (GST_IS_TAG_LIST (list), 0);
 897
 898   return gst_structure_n_fields (GST_TAG_LIST_STRUCTURE (list));
 899 }
 900
 901 /**
 902  * gst_tag_list_nth_tag_name:
 903  * @list: A #GstTagList.
 904  * @index: the index
 905  *
 906  * Get the name of the tag in @list at @index.
 907  *
 908  * Returns: The name of the tag at @index.
 909  */
 910 const gchar *
 911 gst_tag_list_nth_tag_name (const GstTagList * list, guint index)
 912 {
 913   g_return_val_if_fail (list != NULL, 0);
 914   g_return_val_if_fail (GST_IS_TAG_LIST (list), 0);
 915
 916   return gst_structure_nth_field_name (GST_TAG_LIST_STRUCTURE (list), index);
 917 }
 918
 919 /**
 920  * gst_tag_list_is_empty:
 921  * @list: A #GstTagList.
 922  *
 923  * Checks if the given taglist is empty.
 924  *
 925  * Returns: %TRUE if the taglist is empty, otherwise %FALSE.
 926  */
 927 gboolean
 928 gst_tag_list_is_empty (const GstTagList * list)
 929 {
 930   g_return_val_if_fail (list != NULL, FALSE);
 931   g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
 932
 933   return (gst_structure_n_fields (GST_TAG_LIST_STRUCTURE (list)) == 0);
 934 }
 935
 936 static gboolean
 937 gst_tag_list_fields_equal (const GValue * value1, const GValue * value2)
 938 {
 939   gdouble d1, d2;
 940
 941   if (gst_value_compare (value1, value2) == GST_VALUE_EQUAL)
 942     return TRUE;
 943
 944   /* fields not equal: add some tolerance for doubles, otherwise bail out */
 945   if (!G_VALUE_HOLDS_DOUBLE (value1) || !G_VALUE_HOLDS_DOUBLE (value2))
 946     return FALSE;
 947
 948   d1 = g_value_get_double (value1);
 949   d2 = g_value_get_double (value2);
 950
 951   /* This will only work for 'normal' values and values around 0,
 952    * which should be good enough for our purposes here
 953    * FIXME: maybe add this to gst_value_compare_double() ? */
 954   return (fabs (d1 - d2) < 0.0000001);
 955 }
 956
 957 /**
 958  * gst_tag_list_is_equal:
 959  * @list1: a #GstTagList.
 960  * @list2: a #GstTagList.
 961  *
 962  * Checks if the two given taglists are equal.
 963  *
 964  * Returns: %TRUE if the taglists are equal, otherwise %FALSE
 965  */
 966 gboolean
 967 gst_tag_list_is_equal (const GstTagList * list1, const GstTagList * list2)
 968 {
 969   const GstStructure *s1, *s2;
 970   gint num_fields1, num_fields2, i;
 971
 972   g_return_val_if_fail (GST_IS_TAG_LIST (list1), FALSE);
 973   g_return_val_if_fail (GST_IS_TAG_LIST (list2), FALSE);
 974
 975   /* we don't just use gst_structure_is_equal() here so we can add some
 976    * tolerance for doubles, though maybe we should just add that to
 977    * gst_value_compare_double() as well? */
 978   s1 = GST_TAG_LIST_STRUCTURE (list1);
 979   s2 = GST_TAG_LIST_STRUCTURE (list2);
 980
 981   num_fields1 = gst_structure_n_fields (s1);
 982   num_fields2 = gst_structure_n_fields (s2);
 983
 984   if (num_fields1 != num_fields2)
 985     return FALSE;
 986
 987   for (i = 0; i < num_fields1; i++) {
 988     const GValue *value1, *value2;
 989     const gchar *tag_name;
 990
 991     tag_name = gst_structure_nth_field_name (s1, i);
 992     value1 = gst_structure_get_value (s1, tag_name);
 993     value2 = gst_structure_get_value (s2, tag_name);
 994
 995     if (value2 == NULL)
 996       return FALSE;
 997
 998     if (!gst_tag_list_fields_equal (value1, value2))
 999       return FALSE;
1000   }
1001
1002   return TRUE;
1003 }
1004
1005 typedef struct
1006 {
1007   GstTagList *list;
1008   GstTagMergeMode mode;
1009 }
1010 GstTagCopyData;
1011
1012 static void
1013 gst_tag_list_add_value_internal (GstTagList * tag_list, GstTagMergeMode mode,
1014     const gchar * tag, const GValue * value, GstTagInfo * info)
1015 {
1016   GstStructure *list = GST_TAG_LIST_STRUCTURE (tag_list);
1017   const GValue *value2;
1018   GQuark tag_quark;
1019
1020   if (info == NULL) {
1021     info = gst_tag_lookup (tag);
1022     if (G_UNLIKELY (info == NULL)) {
1023       g_warning ("unknown tag '%s'", tag);
1024       return;
1025     }
1026   }
1027
1028   if (G_UNLIKELY (!G_VALUE_HOLDS (value, info->type) &&
1029           !GST_VALUE_HOLDS_LIST (value))) {
1030     g_warning ("tag '%s' should hold value of type '%s', but value of "
1031         "type '%s' passed", info->nick, g_type_name (info->type),
1032         g_type_name (G_VALUE_TYPE (value)));
1033     return;
1034   }
1035
1036   tag_quark = info->name_quark;
1037
1038   if (info->merge_func
1039       && (value2 = gst_structure_id_get_value (list, tag_quark)) != NULL) {
1040     GValue dest = { 0, };
1041
1042     switch (mode) {
1043       case GST_TAG_MERGE_REPLACE_ALL:
1044       case GST_TAG_MERGE_REPLACE:
1045         gst_structure_id_set_value (list, tag_quark, value);
1046         break;
1047       case GST_TAG_MERGE_PREPEND:
1048         if (GST_VALUE_HOLDS_LIST (value2) && !GST_VALUE_HOLDS_LIST (value))
1049           gst_value_list_prepend_value ((GValue *) value2, value);
1050         else {
1051           gst_value_list_merge (&dest, value, value2);
1052           gst_structure_id_take_value (list, tag_quark, &dest);
1053         }
1054         break;
1055       case GST_TAG_MERGE_APPEND:
1056         if (GST_VALUE_HOLDS_LIST (value2) && !GST_VALUE_HOLDS_LIST (value))
1057           gst_value_list_append_value ((GValue *) value2, value);
1058         else {
1059           gst_value_list_merge (&dest, value2, value);
1060           gst_structure_id_take_value (list, tag_quark, &dest);
1061         }
1062         break;
1063       case GST_TAG_MERGE_KEEP:
1064       case GST_TAG_MERGE_KEEP_ALL:
1065         break;
1066       default:
1067         g_assert_not_reached ();
1068         break;
1069     }
1070   } else {
1071     switch (mode) {
1072       case GST_TAG_MERGE_APPEND:
1073       case GST_TAG_MERGE_KEEP:
1074         if (gst_structure_id_get_value (list, tag_quark) != NULL)
1075           break;
1076         /* fall through */
1077       case GST_TAG_MERGE_REPLACE_ALL:
1078       case GST_TAG_MERGE_REPLACE:
1079       case GST_TAG_MERGE_PREPEND:
1080         gst_structure_id_set_value (list, tag_quark, value);
1081         break;
1082       case GST_TAG_MERGE_KEEP_ALL:
1083         break;
1084       default:
1085         g_assert_not_reached ();
1086         break;
1087     }
1088   }
1089 }
1090
1091 static gboolean
1092 gst_tag_list_copy_foreach (GQuark tag_quark, const GValue * value,
1093     gpointer user_data)
1094 {
1095   GstTagCopyData *copy = (GstTagCopyData *) user_data;
1096   const gchar *tag;
1097
1098   tag = g_quark_to_string (tag_quark);
1099   gst_tag_list_add_value_internal (copy->list, copy->mode, tag, value, NULL);
1100
1101   return TRUE;
1102 }
1103
1104 /**
1105  * gst_tag_list_insert:
1106  * @into: list to merge into
1107  * @from: list to merge from
1108  * @mode: the mode to use
1109  *
1110  * Inserts the tags of the @from list into the first list using the given mode.
1111  */
1112 void
1113 gst_tag_list_insert (GstTagList * into, const GstTagList * from,
1114     GstTagMergeMode mode)
1115 {
1116   GstTagCopyData data;
1117
1118   g_return_if_fail (GST_IS_TAG_LIST (into));
1119   g_return_if_fail (gst_tag_list_is_writable (into));
1120   g_return_if_fail (GST_IS_TAG_LIST (from));
1121   g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
1122
1123   data.list = into;
1124   data.mode = mode;
1125   if (mode == GST_TAG_MERGE_REPLACE_ALL) {
1126     gst_structure_remove_all_fields (GST_TAG_LIST_STRUCTURE (into));
1127   }
1128   gst_structure_foreach (GST_TAG_LIST_STRUCTURE (from),
1129       gst_tag_list_copy_foreach, &data);
1130 }
1131
1132 /**
1133  * gst_tag_list_merge:
1134  * @list1: first list to merge
1135  * @list2: second list to merge
1136  * @mode: the mode to use
1137  *
1138  * Merges the two given lists into a new list. If one of the lists is %NULL, a
1139  * copy of the other is returned. If both lists are %NULL, %NULL is returned.
1140  *
1141  * Free-function: gst_tag_list_unref
1142  *
1143  * Returns: (transfer full): the new list
1144  */
1145 GstTagList *
1146 gst_tag_list_merge (const GstTagList * list1, const GstTagList * list2,
1147     GstTagMergeMode mode)
1148 {
1149   GstTagList *list1_cp;
1150   const GstTagList *list2_cp;
1151
1152   g_return_val_if_fail (list1 == NULL || GST_IS_TAG_LIST (list1), NULL);
1153   g_return_val_if_fail (list2 == NULL || GST_IS_TAG_LIST (list2), NULL);
1154   g_return_val_if_fail (GST_TAG_MODE_IS_VALID (mode), NULL);
1155
1156   /* nothing to merge */
1157   if (!list1 && !list2) {
1158     return NULL;
1159   }
1160
1161   /* create empty list, we need to do this to correctly handling merge modes */
1162   list1_cp = (list1) ? gst_tag_list_copy (list1) : gst_tag_list_new_empty ();
1163   list2_cp = (list2) ? list2 : gst_tag_list_new_empty ();
1164
1165   gst_tag_list_insert (list1_cp, list2_cp, mode);
1166
1167   if (!list2)
1168     gst_tag_list_unref ((GstTagList *) list2_cp);
1169
1170   return list1_cp;
1171 }
1172
1173 /**
1174  * gst_tag_list_get_tag_size:
1175  * @list: a taglist
1176  * @tag: the tag to query
1177  *
1178  * Checks how many value are stored in this tag list for the given tag.
1179  *
1180  * Returns: The number of tags stored
1181  */
1182 guint
1183 gst_tag_list_get_tag_size (const GstTagList * list, const gchar * tag)
1184 {
1185   const GValue *value;
1186
1187   g_return_val_if_fail (GST_IS_TAG_LIST (list), 0);
1188
1189   value = gst_structure_get_value (GST_TAG_LIST_STRUCTURE (list), tag);
1190   if (value == NULL)
1191     return 0;
1192   if (G_VALUE_TYPE (value) != GST_TYPE_LIST)
1193     return 1;
1194
1195   return gst_value_list_get_size (value);
1196 }
1197
1198 /**
1199  * gst_tag_list_add:
1200  * @list: list to set tags in
1201  * @mode: the mode to use
1202  * @tag: tag
1203  * @...: %NULL-terminated list of values to set
1204  *
1205  * Sets the values for the given tags using the specified mode.
1206  */
1207 void
1208 gst_tag_list_add (GstTagList * list, GstTagMergeMode mode, const gchar * tag,
1209     ...)
1210 {
1211   va_list args;
1212
1213   g_return_if_fail (GST_IS_TAG_LIST (list));
1214   g_return_if_fail (gst_tag_list_is_writable (list));
1215   g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
1216   g_return_if_fail (tag != NULL);
1217
1218   va_start (args, tag);
1219   gst_tag_list_add_valist (list, mode, tag, args);
1220   va_end (args);
1221 }
1222
1223 /**
1224  * gst_tag_list_add_values:
1225  * @list: list to set tags in
1226  * @mode: the mode to use
1227  * @tag: tag
1228  * @...: GValues to set
1229  *
1230  * Sets the GValues for the given tags using the specified mode.
1231  */
1232 void
1233 gst_tag_list_add_values (GstTagList * list, GstTagMergeMode mode,
1234     const gchar * tag, ...)
1235 {
1236   va_list args;
1237
1238   g_return_if_fail (GST_IS_TAG_LIST (list));
1239   g_return_if_fail (gst_tag_list_is_writable (list));
1240   g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
1241   g_return_if_fail (tag != NULL);
1242
1243   va_start (args, tag);
1244   gst_tag_list_add_valist_values (list, mode, tag, args);
1245   va_end (args);
1246 }
1247
1248 /**
1249  * gst_tag_list_add_valist:
1250  * @list: list to set tags in
1251  * @mode: the mode to use
1252  * @tag: tag
1253  * @var_args: tag / value pairs to set
1254  *
1255  * Sets the values for the given tags using the specified mode.
1256  */
1257 void
1258 gst_tag_list_add_valist (GstTagList * list, GstTagMergeMode mode,
1259     const gchar * tag, va_list var_args)
1260 {
1261   GstTagInfo *info;
1262   gchar *error = NULL;
1263
1264   g_return_if_fail (GST_IS_TAG_LIST (list));
1265   g_return_if_fail (gst_tag_list_is_writable (list));
1266   g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
1267   g_return_if_fail (tag != NULL);
1268
1269   if (mode == GST_TAG_MERGE_REPLACE_ALL) {
1270     gst_structure_remove_all_fields (GST_TAG_LIST_STRUCTURE (list));
1271   }
1272
1273   while (tag != NULL) {
1274     GValue value = { 0, };
1275
1276     info = gst_tag_lookup (tag);
1277     if (G_UNLIKELY (info == NULL)) {
1278       g_warning ("unknown tag '%s'", tag);
1279       return;
1280     }
1281     G_VALUE_COLLECT_INIT (&value, info->type, var_args, 0, &error);
1282     if (error) {
1283       g_warning ("%s: %s", G_STRLOC, error);
1284       g_free (error);
1285       /* we purposely leak the value here, it might not be
1286        * in a sane state if an error condition occoured
1287        */
1288       return;
1289     }
1290     /* Facilitate GstBuffer -> GstSample transition */
1291     if (G_UNLIKELY (info->type == GST_TYPE_SAMPLE &&
1292             !GST_IS_SAMPLE (value.data[0].v_pointer))) {
1293       g_warning ("Expected GstSample argument for tag '%s'", tag);
1294     } else {
1295       gst_tag_list_add_value_internal (list, mode, tag, &value, info);
1296     }
1297     g_value_unset (&value);
1298     tag = va_arg (var_args, gchar *);
1299   }
1300 }
1301
1302 /**
1303  * gst_tag_list_add_valist_values:
1304  * @list: list to set tags in
1305  * @mode: the mode to use
1306  * @tag: tag
1307  * @var_args: tag / GValue pairs to set
1308  *
1309  * Sets the GValues for the given tags using the specified mode.
1310  */
1311 void
1312 gst_tag_list_add_valist_values (GstTagList * list, GstTagMergeMode mode,
1313     const gchar * tag, va_list var_args)
1314 {
1315   g_return_if_fail (GST_IS_TAG_LIST (list));
1316   g_return_if_fail (gst_tag_list_is_writable (list));
1317   g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
1318   g_return_if_fail (tag != NULL);
1319
1320   if (mode == GST_TAG_MERGE_REPLACE_ALL) {
1321     gst_structure_remove_all_fields (GST_TAG_LIST_STRUCTURE (list));
1322   }
1323
1324   while (tag != NULL) {
1325     GstTagInfo *info;
1326
1327     info = gst_tag_lookup (tag);
1328     if (G_UNLIKELY (info == NULL)) {
1329       g_warning ("unknown tag '%s'", tag);
1330       return;
1331     }
1332     gst_tag_list_add_value_internal (list, mode, tag, va_arg (var_args,
1333             GValue *), info);
1334     tag = va_arg (var_args, gchar *);
1335   }
1336 }
1337
1338 /**
1339  * gst_tag_list_add_value:
1340  * @list: list to set tags in
1341  * @mode: the mode to use
1342  * @tag: tag
1343  * @value: GValue for this tag
1344  *
1345  * Sets the GValue for a given tag using the specified mode.
1346  */
1347 void
1348 gst_tag_list_add_value (GstTagList * list, GstTagMergeMode mode,
1349     const gchar * tag, const GValue * value)
1350 {
1351   g_return_if_fail (GST_IS_TAG_LIST (list));
1352   g_return_if_fail (gst_tag_list_is_writable (list));
1353   g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
1354   g_return_if_fail (tag != NULL);
1355
1356   gst_tag_list_add_value_internal (list, mode, tag, value, NULL);
1357 }
1358
1359 /**
1360  * gst_tag_list_remove_tag:
1361  * @list: list to remove tag from
1362  * @tag: tag to remove
1363  *
1364  * Removes the given tag from the taglist.
1365  */
1366 void
1367 gst_tag_list_remove_tag (GstTagList * list, const gchar * tag)
1368 {
1369   g_return_if_fail (GST_IS_TAG_LIST (list));
1370   g_return_if_fail (tag != NULL);
1371
1372   gst_structure_remove_field (GST_TAG_LIST_STRUCTURE (list), tag);
1373 }
1374
1375 typedef struct
1376 {
1377   GstTagForeachFunc func;
1378   const GstTagList *tag_list;
1379   gpointer data;
1380 }
1381 TagForeachData;
1382
1383 static int
1384 structure_foreach_wrapper (GQuark field_id, const GValue * value,
1385     gpointer user_data)
1386 {
1387   TagForeachData *data = (TagForeachData *) user_data;
1388
1389   data->func (data->tag_list, g_quark_to_string (field_id), data->data);
1390   return TRUE;
1391 }
1392
1393 /**
1394  * gst_tag_list_foreach:
1395  * @list: list to iterate over
1396  * @func: (scope call): function to be called for each tag
1397  * @user_data: (closure): user specified data
1398  *
1399  * Calls the given function for each tag inside the tag list. Note that if there
1400  * is no tag, the function won't be called at all.
1401  */
1402 void
1403 gst_tag_list_foreach (const GstTagList * list, GstTagForeachFunc func,
1404     gpointer user_data)
1405 {
1406   TagForeachData data;
1407
1408   g_return_if_fail (GST_IS_TAG_LIST (list));
1409   g_return_if_fail (func != NULL);
1410
1411   data.func = func;
1412   data.tag_list = list;
1413   data.data = user_data;
1414   gst_structure_foreach (GST_TAG_LIST_STRUCTURE (list),
1415       structure_foreach_wrapper, &data);
1416 }
1417
1418 /**
1419  * gst_tag_list_get_value_index:
1420  * @list: a #GstTagList
1421  * @tag: tag to read out
1422  * @index: number of entry to read out
1423  *
1424  * Gets the value that is at the given index for the given tag in the given
1425  * list.
1426  *
1427  * Returns: (transfer none): The GValue for the specified entry or %NULL if the
1428  *          tag wasn't available or the tag doesn't have as many entries
1429  */
1430 const GValue *
1431 gst_tag_list_get_value_index (const GstTagList * list, const gchar * tag,
1432     guint index)
1433 {
1434   const GValue *value;
1435
1436   g_return_val_if_fail (GST_IS_TAG_LIST (list), NULL);
1437   g_return_val_if_fail (tag != NULL, NULL);
1438
1439   value = gst_structure_get_value (GST_TAG_LIST_STRUCTURE (list), tag);
1440   if (value == NULL)
1441     return NULL;
1442
1443   if (GST_VALUE_HOLDS_LIST (value)) {
1444     if (index >= gst_value_list_get_size (value))
1445       return NULL;
1446     return gst_value_list_get_value (value, index);
1447   } else {
1448     if (index > 0)
1449       return NULL;
1450     return value;
1451   }
1452 }
1453
1454 /**
1455  * gst_tag_list_copy_value:
1456  * @dest: (out caller-allocates): uninitialized #GValue to copy into
1457  * @list: list to get the tag from
1458  * @tag: tag to read out
1459  *
1460  * Copies the contents for the given tag into the value,
1461  * merging multiple values into one if multiple values are associated
1462  * with the tag.
1463  * You must g_value_unset() the value after use.
1464  *
1465  * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1466  *          given list.
1467  */
1468 gboolean
1469 gst_tag_list_copy_value (GValue * dest, const GstTagList * list,
1470     const gchar * tag)
1471 {
1472   const GValue *src;
1473
1474   g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
1475   g_return_val_if_fail (tag != NULL, FALSE);
1476   g_return_val_if_fail (dest != NULL, FALSE);
1477   g_return_val_if_fail (G_VALUE_TYPE (dest) == 0, FALSE);
1478
1479   src = gst_structure_get_value (GST_TAG_LIST_STRUCTURE (list), tag);
1480   if (!src)
1481     return FALSE;
1482
1483   if (G_VALUE_TYPE (src) == GST_TYPE_LIST) {
1484     GstTagInfo *info = gst_tag_lookup (tag);
1485
1486     if (!info)
1487       return FALSE;
1488
1489     /* must be there or lists aren't allowed */
1490     g_assert (info->merge_func);
1491     info->merge_func (dest, src);
1492   } else {
1493     g_value_init (dest, G_VALUE_TYPE (src));
1494     g_value_copy (src, dest);
1495   }
1496   return TRUE;
1497 }
1498
1499 /* FIXME 0.11: this whole merge function business is overdesigned, and the
1500  * _get_foo() API is misleading as well - how many application developers will
1501  * expect gst_tag_list_get_string (list, GST_TAG_ARTIST, &val) might return a
1502  * string with multiple comma-separated artists? _get_foo() should just be
1503  * a convenience wrapper around _get_foo_index (list, tag, 0, &val),
1504  * supplemented by a special _tag_list_get_string_merged() function if needed
1505  * (unless someone can actually think of real use cases where the merge
1506  * function is not 'use first' for non-strings and merge for strings) */
1507
1508 /***** evil macros to get all the gst_tag_list_get_*() functions right *****/
1509
1510 #define TAG_MERGE_FUNCS(name,type,ret)                                  \
1511 gboolean                                                                \
1512 gst_tag_list_get_ ## name (const GstTagList *list, const gchar *tag,    \
1513                            type *value)                                 \
1514 {                                                                       \
1515   GValue v = { 0, };                                                    \
1516                                                                         \
1517   g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);                 \
1518   g_return_val_if_fail (tag != NULL, FALSE);                            \
1519   g_return_val_if_fail (value != NULL, FALSE);                          \
1520                                                                         \
1521   if (!gst_tag_list_copy_value (&v, list, tag))                         \
1522       return FALSE;                                                     \
1523   *value = COPY_FUNC (g_value_get_ ## name (&v));                       \
1524   g_value_unset (&v);                                                   \
1525   return ret;                                                           \
1526 }                                                                       \
1527                                                                         \
1528 gboolean                                                                \
1529 gst_tag_list_get_ ## name ## _index (const GstTagList *list,            \
1530                                      const gchar *tag,                  \
1531                                      guint index, type *value)          \
1532 {                                                                       \
1533   const GValue *v;                                                      \
1534                                                                         \
1535   g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);                 \
1536   g_return_val_if_fail (tag != NULL, FALSE);                            \
1537   g_return_val_if_fail (value != NULL, FALSE);                          \
1538                                                                         \
1539   if ((v = gst_tag_list_get_value_index (list, tag, index)) == NULL)    \
1540       return FALSE;                                                     \
1541   *value = COPY_FUNC (g_value_get_ ## name (v));                        \
1542   return ret;                                                           \
1543 }
1544
1545 #define COPY_FUNC /**/
1546 /**
1547  * gst_tag_list_get_boolean:
1548  * @list: a #GstTagList to get the tag from
1549  * @tag: tag to read out
1550  * @value: (out): location for the result
1551  *
1552  * Copies the contents for the given tag into the value, merging multiple values
1553  * into one if multiple values are associated with the tag.
1554  *
1555  * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1556  *              given list.
1557  */
1558 /**
1559  * gst_tag_list_get_boolean_index:
1560  * @list: a #GstTagList to get the tag from
1561  * @tag: tag to read out
1562  * @index: number of entry to read out
1563  * @value: (out): location for the result
1564  *
1565  * Gets the value that is at the given index for the given tag in the given
1566  * list.
1567  *
1568  * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1569  *              given list.
1570  */
1571 TAG_MERGE_FUNCS (boolean, gboolean, TRUE);
1572 /**
1573  * gst_tag_list_get_int:
1574  * @list: a #GstTagList to get the tag from
1575  * @tag: tag to read out
1576  * @value: (out): location for the result
1577  *
1578  * Copies the contents for the given tag into the value, merging multiple values
1579  * into one if multiple values are associated with the tag.
1580  *
1581  * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1582  *              given list.
1583  */
1584 /**
1585  * gst_tag_list_get_int_index:
1586  * @list: a #GstTagList to get the tag from
1587  * @tag: tag to read out
1588  * @index: number of entry to read out
1589  * @value: (out): location for the result
1590  *
1591  * Gets the value that is at the given index for the given tag in the given
1592  * list.
1593  *
1594  * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1595  *              given list.
1596  */
1597 TAG_MERGE_FUNCS (int, gint, TRUE);
1598 /**
1599  * gst_tag_list_get_uint:
1600  * @list: a #GstTagList to get the tag from
1601  * @tag: tag to read out
1602  * @value: (out): location for the result
1603  *
1604  * Copies the contents for the given tag into the value, merging multiple values
1605  * into one if multiple values are associated with the tag.
1606  *
1607  * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1608  *              given list.
1609  */
1610 /**
1611  * gst_tag_list_get_uint_index:
1612  * @list: a #GstTagList to get the tag from
1613  * @tag: tag to read out
1614  * @index: number of entry to read out
1615  * @value: (out): location for the result
1616  *
1617  * Gets the value that is at the given index for the given tag in the given
1618  * list.
1619  *
1620  * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1621  *              given list.
1622  */
1623 TAG_MERGE_FUNCS (uint, guint, TRUE);
1624 /**
1625  * gst_tag_list_get_int64_index:
1626  * @list: a #GstTagList to get the tag from
1627  * @tag: tag to read out
1628  * @index: number of entry to read out
1629  * @value: (out): location for the result
1630  *
1631  * Gets the value that is at the given index for the given tag in the given
1632  * list.
1633  *
1634  * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1635  *              given list.
1636  */
1637 TAG_MERGE_FUNCS (int64, gint64, TRUE);
1638 /**
1639  * gst_tag_list_get_uint64:
1640  * @list: a #GstTagList to get the tag from
1641  * @tag: tag to read out
1642  * @value: (out): location for the result
1643  *
1644  * Copies the contents for the given tag into the value, merging multiple values
1645  * into one if multiple values are associated with the tag.
1646  *
1647  * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1648  *              given list.
1649  */
1650 /**
1651  * gst_tag_list_get_uint64_index:
1652  * @list: a #GstTagList to get the tag from
1653  * @tag: tag to read out
1654  * @index: number of entry to read out
1655  * @value: (out): location for the result
1656  *
1657  * Gets the value that is at the given index for the given tag in the given
1658  * list.
1659  *
1660  * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1661  *              given list.
1662  */
1663 TAG_MERGE_FUNCS (uint64, guint64, TRUE);
1664 /**
1665  * gst_tag_list_get_float:
1666  * @list: a #GstTagList to get the tag from
1667  * @tag: tag to read out
1668  * @value: (out): location for the result
1669  *
1670  * Copies the contents for the given tag into the value, merging multiple values
1671  * into one if multiple values are associated with the tag.
1672  *
1673  * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1674  *              given list.
1675  */
1676 /**
1677  * gst_tag_list_get_float_index:
1678  * @list: a #GstTagList to get the tag from
1679  * @tag: tag to read out
1680  * @index: number of entry to read out
1681  * @value: (out): location for the result
1682  *
1683  * Gets the value that is at the given index for the given tag in the given
1684  * list.
1685  *
1686  * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1687  *              given list.
1688  */
1689 TAG_MERGE_FUNCS (float, gfloat, TRUE);
1690 /**
1691  * gst_tag_list_get_double:
1692  * @list: a #GstTagList to get the tag from
1693  * @tag: tag to read out
1694  * @value: (out): location for the result
1695  *
1696  * Copies the contents for the given tag into the value, merging multiple values
1697  * into one if multiple values are associated with the tag.
1698  *
1699  * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1700  *              given list.
1701  */
1702 /**
1703  * gst_tag_list_get_double_index:
1704  * @list: a #GstTagList to get the tag from
1705  * @tag: tag to read out
1706  * @index: number of entry to read out
1707  * @value: (out): location for the result
1708  *
1709  * Gets the value that is at the given index for the given tag in the given
1710  * list.
1711  *
1712  * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1713  *              given list.
1714  */
1715 TAG_MERGE_FUNCS (double, gdouble, TRUE);
1716 /**
1717  * gst_tag_list_get_pointer:
1718  * @list: a #GstTagList to get the tag from
1719  * @tag: tag to read out
1720  * @value: (out) (transfer none): location for the result
1721  *
1722  * Copies the contents for the given tag into the value, merging multiple values
1723  * into one if multiple values are associated with the tag.
1724  *
1725  * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1726  *              given list.
1727  */
1728 /**
1729  * gst_tag_list_get_pointer_index:
1730  * @list: a #GstTagList to get the tag from
1731  * @tag: tag to read out
1732  * @index: number of entry to read out
1733  * @value: (out) (transfer none): location for the result
1734  *
1735  * Gets the value that is at the given index for the given tag in the given
1736  * list.
1737  *
1738  * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1739  *              given list.
1740  */
1741 TAG_MERGE_FUNCS (pointer, gpointer, (*value != NULL));
1742
1743 static inline gchar *
1744 _gst_strdup0 (const gchar * s)
1745 {
1746   if (s == NULL || *s == '\0')
1747     return NULL;
1748
1749   return g_strdup (s);
1750 }
1751
1752 #undef COPY_FUNC
1753 #define COPY_FUNC _gst_strdup0
1754
1755 /**
1756  * gst_tag_list_get_string:
1757  * @list: a #GstTagList to get the tag from
1758  * @tag: tag to read out
1759  * @value: (out callee-allocates) (transfer full): location for the result
1760  *
1761  * Copies the contents for the given tag into the value, possibly merging
1762  * multiple values into one if multiple values are associated with the tag.
1763  *
1764  * Use gst_tag_list_get_string_index (list, tag, 0, value) if you want
1765  * to retrieve the first string associated with this tag unmodified.
1766  *
1767  * The resulting string in @value will be in UTF-8 encoding and should be
1768  * freed by the caller using g_free when no longer needed. The
1769  * returned string is also guaranteed to be non-%NULL and non-empty.
1770  *
1771  * Free-function: g_free
1772  *
1773  * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1774  *              given list.
1775  */
1776 /**
1777  * gst_tag_list_get_string_index:
1778  * @list: a #GstTagList to get the tag from
1779  * @tag: tag to read out
1780  * @index: number of entry to read out
1781  * @value: (out callee-allocates) (transfer full): location for the result
1782  *
1783  * Gets the value that is at the given index for the given tag in the given
1784  * list.
1785  *
1786  * The resulting string in @value will be in UTF-8 encoding and should be
1787  * freed by the caller using g_free when no longer needed. The
1788  * returned string is also guaranteed to be non-%NULL and non-empty.
1789  *
1790  * Free-function: g_free
1791  *
1792  * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1793  *              given list.
1794  */
1795 TAG_MERGE_FUNCS (string, gchar *, (*value != NULL));
1796
1797 /*
1798  *FIXME 0.11: Instead of _peek (non-copy) and _get (copy), we could have
1799  *            _get (non-copy) and _dup (copy) for strings, seems more
1800  *            widely used
1801  */
1802 /**
1803  * gst_tag_list_peek_string_index:
1804  * @list: a #GstTagList to get the tag from
1805  * @tag: tag to read out
1806  * @index: number of entry to read out
1807  * @value: (out) (transfer none): location for the result
1808  *
1809  * Peeks at the value that is at the given index for the given tag in the given
1810  * list.
1811  *
1812  * The resulting string in @value will be in UTF-8 encoding and doesn't need
1813  * to be freed by the caller. The returned string is also guaranteed to
1814  * be non-%NULL and non-empty.
1815  *
1816  * Returns: %TRUE, if a value was set, %FALSE if the tag didn't exist in the
1817  *              given list.
1818  */
1819 gboolean
1820 gst_tag_list_peek_string_index (const GstTagList * list,
1821     const gchar * tag, guint index, const gchar ** value)
1822 {
1823   const GValue *v;
1824
1825   g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
1826   g_return_val_if_fail (tag != NULL, FALSE);
1827   g_return_val_if_fail (value != NULL, FALSE);
1828
1829   if ((v = gst_tag_list_get_value_index (list, tag, index)) == NULL)
1830     return FALSE;
1831   *value = g_value_get_string (v);
1832   return *value != NULL && **value != '\0';
1833 }
1834
1835 /**
1836  * gst_tag_list_get_date:
1837  * @list: a #GstTagList to get the tag from
1838  * @tag: tag to read out
1839  * @value: (out callee-allocates) (transfer full): address of a GDate pointer
1840  *     variable to store the result into
1841  *
1842  * Copies the first date for the given tag in the taglist into the variable
1843  * pointed to by @value. Free the date with g_date_free() when it is no longer
1844  * needed.
1845  *
1846  * Free-function: g_date_free
1847  *
1848  * Returns: %TRUE, if a date was copied, %FALSE if the tag didn't exist in the
1849  *              given list or if it was %NULL.
1850  */
1851 gboolean
1852 gst_tag_list_get_date (const GstTagList * list, const gchar * tag,
1853     GDate ** value)
1854 {
1855   GValue v = { 0, };
1856
1857   g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
1858   g_return_val_if_fail (tag != NULL, FALSE);
1859   g_return_val_if_fail (value != NULL, FALSE);
1860
1861   if (!gst_tag_list_copy_value (&v, list, tag))
1862     return FALSE;
1863   *value = (GDate *) g_value_dup_boxed (&v);
1864   g_value_unset (&v);
1865   return (*value != NULL);
1866 }
1867
1868 /**
1869  * gst_tag_list_get_date_index:
1870  * @list: a #GstTagList to get the tag from
1871  * @tag: tag to read out
1872  * @index: number of entry to read out
1873  * @value: (out callee-allocates) (transfer full): location for the result
1874  *
1875  * Gets the date that is at the given index for the given tag in the given
1876  * list and copies it into the variable pointed to by @value. Free the date
1877  * with g_date_free() when it is no longer needed.
1878  *
1879  * Free-function: g_date_free
1880  *
1881  * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1882  *              given list or if it was %NULL.
1883  */
1884 gboolean
1885 gst_tag_list_get_date_index (const GstTagList * list,
1886     const gchar * tag, guint index, GDate ** value)
1887 {
1888   const GValue *v;
1889
1890   g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
1891   g_return_val_if_fail (tag != NULL, FALSE);
1892   g_return_val_if_fail (value != NULL, FALSE);
1893
1894   if ((v = gst_tag_list_get_value_index (list, tag, index)) == NULL)
1895     return FALSE;
1896   *value = (GDate *) g_value_dup_boxed (v);
1897   return (*value != NULL);
1898 }
1899
1900 /**
1901  * gst_tag_list_get_date_time:
1902  * @list: a #GstTagList to get the tag from
1903  * @tag: tag to read out
1904  * @value: (out callee-allocates) (transfer full): address of a #GstDateTime
1905  *     pointer variable to store the result into
1906  *
1907  * Copies the first datetime for the given tag in the taglist into the variable
1908  * pointed to by @value. Unref the date with gst_date_time_unref() when
1909  * it is no longer needed.
1910  *
1911  * Free-function: gst_date_time_unref
1912  *
1913  * Returns: %TRUE, if a datetime was copied, %FALSE if the tag didn't exist in
1914  *              the given list or if it was %NULL.
1915  */
1916 gboolean
1917 gst_tag_list_get_date_time (const GstTagList * list, const gchar * tag,
1918     GstDateTime ** value)
1919 {
1920   GValue v = { 0, };
1921
1922   g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
1923   g_return_val_if_fail (tag != NULL, FALSE);
1924   g_return_val_if_fail (value != NULL, FALSE);
1925
1926   if (!gst_tag_list_copy_value (&v, list, tag))
1927     return FALSE;
1928
1929   *value = (GstDateTime *) g_value_dup_boxed (&v);
1930   g_value_unset (&v);
1931   return (*value != NULL);
1932 }
1933
1934 /**
1935  * gst_tag_list_get_date_time_index:
1936  * @list: a #GstTagList to get the tag from
1937  * @tag: tag to read out
1938  * @index: number of entry to read out
1939  * @value: (out callee-allocates) (transfer full): location for the result
1940  *
1941  * Gets the datetime that is at the given index for the given tag in the given
1942  * list and copies it into the variable pointed to by @value. Unref the datetime
1943  * with gst_date_time_unref() when it is no longer needed.
1944  *
1945  * Free-function: gst_date_time_unref
1946  *
1947  * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the
1948  *              given list or if it was %NULL.
1949  */
1950 gboolean
1951 gst_tag_list_get_date_time_index (const GstTagList * list,
1952     const gchar * tag, guint index, GstDateTime ** value)
1953 {
1954   const GValue *v;
1955
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);
1959
1960   if ((v = gst_tag_list_get_value_index (list, tag, index)) == NULL)
1961     return FALSE;
1962   *value = (GstDateTime *) g_value_dup_boxed (v);
1963   return (*value != NULL);
1964 }
1965
1966 /**
1967  * gst_tag_list_get_sample:
1968  * @list: a #GstTagList to get the tag from
1969  * @tag: tag to read out
1970  * @sample: (out callee-allocates) (transfer full): address of a GstSample
1971  *     pointer variable to store the result into
1972  *
1973  * Copies the first sample for the given tag in the taglist into the variable
1974  * pointed to by @sample. Free the sample with gst_sample_unref() when it is
1975  * no longer needed. You can retrieve the buffer from the sample using
1976  * gst_sample_get_buffer() and the associated caps (if any) with
1977  * gst_sample_get_caps().
1978  *
1979  * Free-function: gst_sample_unref
1980  *
1981  * Returns: %TRUE, if a sample was returned, %FALSE if the tag didn't exist in
1982  *              the given list or if it was %NULL.
1983  */
1984 gboolean
1985 gst_tag_list_get_sample (const GstTagList * list, const gchar * tag,
1986     GstSample ** sample)
1987 {
1988   GValue v = { 0, };
1989
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 (sample != NULL, FALSE);
1993
1994   if (!gst_tag_list_copy_value (&v, list, tag))
1995     return FALSE;
1996   *sample = g_value_dup_boxed (&v);
1997   g_value_unset (&v);
1998   return (*sample != NULL);
1999 }
2000
2001 /**
2002  * gst_tag_list_get_sample_index:
2003  * @list: a #GstTagList to get the tag from
2004  * @tag: tag to read out
2005  * @index: number of entry to read out
2006  * @sample: (out callee-allocates) (transfer full): address of a GstSample
2007  *     pointer variable to store the result into
2008  *
2009  * Gets the sample that is at the given index for the given tag in the given
2010  * list and copies it into the variable pointed to by @sample. Free the sample
2011  * with gst_sample_unref() when it is no longer needed. You can retrieve the
2012  * buffer from the sample using gst_sample_get_buffer() and the associated
2013  * caps (if any) with gst_sample_get_caps().
2014  *
2015  * Free-function: gst_sample_unref
2016  *
2017  * Returns: %TRUE, if a sample was copied, %FALSE if the tag didn't exist in the
2018  *              given list or if it was %NULL.
2019  */
2020 gboolean
2021 gst_tag_list_get_sample_index (const GstTagList * list,
2022     const gchar * tag, guint index, GstSample ** sample)
2023 {
2024   const GValue *v;
2025
2026   g_return_val_if_fail (GST_IS_TAG_LIST (list), FALSE);
2027   g_return_val_if_fail (tag != NULL, FALSE);
2028   g_return_val_if_fail (sample != NULL, FALSE);
2029
2030   if ((v = gst_tag_list_get_value_index (list, tag, index)) == NULL)
2031     return FALSE;
2032   *sample = g_value_dup_boxed (v);
2033   return (*sample != NULL);
2034 }