gst-libs/gst/tag/tags.c

   1 /* GStreamer non-core tag registration and tag utility functions
   2  * Copyright (C) 2005 Ross Burton <ross@burtonini.com>
   3  * Copyright (C) 2006-2008 Tim-Philipp Müller <tim centricular net>
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Library General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Library General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 #ifdef HAVE_CONFIG_H
  22 #include "config.h"
  23 #endif
  24
  25 #include <gst/gst-i18n-plugin.h>
  26 #include <gst/base/gsttypefindhelper.h>
  27 #include <gst/gst.h>
  28 #include "tag.h"
  29
  30 #include <string.h>
  31
  32 /**
  33  * SECTION:gsttag
  34  * @short_description: additional tag definitions for plugins and applications
  35  * @see_also: #GstTagList
  36  *
  37  * <refsect2>
  38  * <para>
  39  * Contains additional standardized GStreamer tag definitions for plugins
  40  * and applications, and functions to register them with the GStreamer
  41  * tag system.
  42  * </para>
  43  * </refsect2>
  44  */
  45
  46 #ifndef GST_DISABLE_GST_DEBUG
  47 #define GST_CAT_DEFAULT gst_tag_ensure_debug_category()
  48
  49 static GstDebugCategory *
  50 gst_tag_ensure_debug_category (void)
  51 {
  52   static gsize cat_gonce = 0;
  53
  54   if (g_once_init_enter (&cat_gonce)) {
  55     GstDebugCategory *cat = NULL;
  56
  57     GST_DEBUG_CATEGORY_INIT (cat, "tag-tags", 0, "GstTag helper functions");
  58
  59     g_once_init_leave (&cat_gonce, (gsize) cat);
  60   }
  61
  62   return (GstDebugCategory *) cat_gonce;
  63 }
  64 #endif /* GST_DISABLE_GST_DEBUG */
  65
  66 static gpointer
  67 gst_tag_register_tags_internal (gpointer unused)
  68 {
  69 #ifdef ENABLE_NLS
  70   GST_DEBUG ("binding text domain %s to locale dir %s", GETTEXT_PACKAGE,
  71       LOCALEDIR);
  72   bindtextdomain (GETTEXT_PACKAGE, LOCALEDIR);
  73   bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
  74 #endif
  75
  76   /* musicbrainz tags */
  77   gst_tag_register (GST_TAG_MUSICBRAINZ_TRACKID, GST_TAG_FLAG_META,
  78       G_TYPE_STRING, _("track ID"), _("MusicBrainz track ID"), NULL);
  79   gst_tag_register (GST_TAG_MUSICBRAINZ_ARTISTID, GST_TAG_FLAG_META,
  80       G_TYPE_STRING, _("artist ID"), _("MusicBrainz artist ID"), NULL);
  81   gst_tag_register (GST_TAG_MUSICBRAINZ_ALBUMID, GST_TAG_FLAG_META,
  82       G_TYPE_STRING, _("album ID"), _("MusicBrainz album ID"), NULL);
  83   gst_tag_register (GST_TAG_MUSICBRAINZ_ALBUMARTISTID, GST_TAG_FLAG_META,
  84       G_TYPE_STRING,
  85       _("album artist ID"), _("MusicBrainz album artist ID"), NULL);
  86   gst_tag_register (GST_TAG_MUSICBRAINZ_TRMID, GST_TAG_FLAG_META,
  87       G_TYPE_STRING, _("track TRM ID"), _("MusicBrainz TRM ID"), NULL);
  88
  89   /* CDDA tags */
  90   gst_tag_register (GST_TAG_CDDA_CDDB_DISCID, GST_TAG_FLAG_META,
  91       G_TYPE_STRING, "discid", "CDDB discid for metadata retrieval",
  92       gst_tag_merge_use_first);
  93
  94   gst_tag_register (GST_TAG_CDDA_CDDB_DISCID_FULL, GST_TAG_FLAG_META,
  95       G_TYPE_STRING, "discid full",
  96       "CDDB discid for metadata retrieval (full)", gst_tag_merge_use_first);
  97
  98   gst_tag_register (GST_TAG_CDDA_MUSICBRAINZ_DISCID, GST_TAG_FLAG_META,
  99       G_TYPE_STRING, "musicbrainz-discid",
 100       "Musicbrainz discid for metadata retrieval", gst_tag_merge_use_first);
 101
 102   gst_tag_register (GST_TAG_CDDA_MUSICBRAINZ_DISCID_FULL, GST_TAG_FLAG_META,
 103       G_TYPE_STRING, "musicbrainz-discid-full",
 104       "Musicbrainz discid for metadata retrieval (full)",
 105       gst_tag_merge_use_first);
 106
 107   /* photography tags */
 108   gst_tag_register (GST_TAG_CAPTURING_SHUTTER_SPEED, GST_TAG_FLAG_META,
 109       GST_TYPE_FRACTION, _("capturing shutter speed"),
 110       _("Shutter speed used when capturing an image, in seconds"), NULL);
 111
 112   gst_tag_register (GST_TAG_CAPTURING_FOCAL_RATIO, GST_TAG_FLAG_META,
 113       G_TYPE_DOUBLE, _("capturing focal ratio"),
 114       _("Focal ratio (f-number) used when capturing the image"), NULL);
 115
 116   gst_tag_register (GST_TAG_CAPTURING_FOCAL_LENGTH, GST_TAG_FLAG_META,
 117       G_TYPE_DOUBLE, _("capturing focal length"),
 118       _("Focal length of the lens used capturing the image, in mm"), NULL);
 119
 120   gst_tag_register (GST_TAG_CAPTURING_DIGITAL_ZOOM_RATIO, GST_TAG_FLAG_META,
 121       G_TYPE_DOUBLE, _("capturing digital zoom ratio"),
 122       _("Digital zoom ratio used when capturing an image"), NULL);
 123
 124   gst_tag_register (GST_TAG_CAPTURING_ISO_SPEED, GST_TAG_FLAG_META,
 125       G_TYPE_INT, _("capturing iso speed"),
 126       _("The ISO speed used when capturing an image"), NULL);
 127
 128   gst_tag_register (GST_TAG_CAPTURING_EXPOSURE_PROGRAM, GST_TAG_FLAG_META,
 129       G_TYPE_STRING, _("capturing exposure program"),
 130       _("The exposure program used when capturing an image"), NULL);
 131
 132   gst_tag_register (GST_TAG_CAPTURING_EXPOSURE_MODE, GST_TAG_FLAG_META,
 133       G_TYPE_STRING, _("capturing exposure mode"),
 134       _("The exposure mode used when capturing an image"), NULL);
 135
 136   gst_tag_register (GST_TAG_CAPTURING_EXPOSURE_COMPENSATION, GST_TAG_FLAG_META,
 137       G_TYPE_DOUBLE, _("capturing exposure compensation"),
 138       _("The exposure compensation used when capturing an image"), NULL);
 139
 140   gst_tag_register (GST_TAG_CAPTURING_SCENE_CAPTURE_TYPE, GST_TAG_FLAG_META,
 141       G_TYPE_STRING, _("capturing scene capture type"),
 142       _("The scene capture mode used when capturing an image"), NULL);
 143
 144   gst_tag_register (GST_TAG_CAPTURING_GAIN_ADJUSTMENT, GST_TAG_FLAG_META,
 145       G_TYPE_STRING, _("capturing gain adjustment"),
 146       _("The overall gain adjustment applied on an image"), NULL);
 147
 148   gst_tag_register (GST_TAG_CAPTURING_WHITE_BALANCE, GST_TAG_FLAG_META,
 149       G_TYPE_STRING, _("capturing white balance"),
 150       _("The white balance mode set when capturing an image"), NULL);
 151
 152   gst_tag_register (GST_TAG_CAPTURING_CONTRAST, GST_TAG_FLAG_META,
 153       G_TYPE_STRING, _("capturing contrast"),
 154       _("The direction of contrast processing applied "
 155           "when capturing an image"), NULL);
 156
 157   gst_tag_register (GST_TAG_CAPTURING_SATURATION, GST_TAG_FLAG_META,
 158       G_TYPE_STRING, _("capturing saturation"),
 159       _("The direction of saturation processing applied when "
 160           "capturing an image"), NULL);
 161
 162   gst_tag_register (GST_TAG_CAPTURING_SHARPNESS, GST_TAG_FLAG_META,
 163       G_TYPE_STRING, _("capturing sharpness"),
 164       _("The direction of sharpness processing applied "
 165           "when capturing an image"), NULL);
 166
 167   gst_tag_register (GST_TAG_CAPTURING_FLASH_FIRED, GST_TAG_FLAG_META,
 168       G_TYPE_BOOLEAN, _("capturing flash fired"),
 169       _("If the flash fired while capturing an image"), NULL);
 170
 171   gst_tag_register (GST_TAG_CAPTURING_FLASH_MODE, GST_TAG_FLAG_META,
 172       G_TYPE_STRING, _("capturing flash mode"),
 173       _("The selected flash mode while capturing an image"), NULL);
 174
 175   gst_tag_register (GST_TAG_CAPTURING_METERING_MODE, GST_TAG_FLAG_META,
 176       G_TYPE_STRING, _("capturing metering mode"),
 177       _("The metering mode used while determining exposure for capturing an"
 178           " image"), NULL);
 179
 180   gst_tag_register (GST_TAG_CAPTURING_SOURCE, GST_TAG_FLAG_META,
 181       G_TYPE_STRING, _("capturing source"),
 182       _("The source or type of device used for the capture"), NULL);
 183
 184   gst_tag_register (GST_TAG_IMAGE_HORIZONTAL_PPI, GST_TAG_FLAG_META,
 185       G_TYPE_DOUBLE, _("image horizontal ppi"),
 186       _("Media (image/video) intended horizontal pixel density in ppi"), NULL);
 187
 188   gst_tag_register (GST_TAG_IMAGE_VERTICAL_PPI, GST_TAG_FLAG_META,
 189       G_TYPE_DOUBLE, _("image vertical ppi"),
 190       _("Media (image/video) intended vertical pixel density in ppi"), NULL);
 191
 192   return NULL;
 193 }
 194
 195 /* FIXME 0.11: rename this to gst_tag_init() or gst_tag_register_tags() */
 196 /**
 197  * gst_tag_register_musicbrainz_tags
 198  *
 199  * Registers additional musicbrainz-specific tags with the GStreamer tag
 200  * system. Plugins and applications that use these tags should call this
 201  * function before using them. Can be called multiple times.
 202  */
 203 void
 204 gst_tag_register_musicbrainz_tags (void)
 205 {
 206   static GOnce mb_once = G_ONCE_INIT;
 207
 208   g_once (&mb_once, gst_tag_register_tags_internal, NULL);
 209 }
 210
 211 static void
 212 register_tag_image_type_enum (GType * id)
 213 {
 214   static const GEnumValue image_types[] = {
 215     {GST_TAG_IMAGE_TYPE_NONE, "GST_TAG_IMAGE_TYPE_NONE", "none"},
 216     {GST_TAG_IMAGE_TYPE_UNDEFINED, "GST_TAG_IMAGE_TYPE_UNDEFINED", "undefined"},
 217     {GST_TAG_IMAGE_TYPE_FRONT_COVER, "GST_TAG_IMAGE_TYPE_FRONT_COVER",
 218         "front-cover"},
 219     {GST_TAG_IMAGE_TYPE_BACK_COVER, "GST_TAG_IMAGE_TYPE_BACK_COVER",
 220         "back-cover"},
 221     {GST_TAG_IMAGE_TYPE_LEAFLET_PAGE, "GST_TAG_IMAGE_TYPE_LEAFLET_PAGE",
 222         "leaflet-page"},
 223     {GST_TAG_IMAGE_TYPE_MEDIUM, "GST_TAG_IMAGE_TYPE_MEDIUM", "medium"},
 224     {GST_TAG_IMAGE_TYPE_LEAD_ARTIST, "GST_TAG_IMAGE_TYPE_LEAD_ARTIST",
 225         "lead-artist"},
 226     {GST_TAG_IMAGE_TYPE_ARTIST, "GST_TAG_IMAGE_TYPE_ARTIST", "artist"},
 227     {GST_TAG_IMAGE_TYPE_CONDUCTOR, "GST_TAG_IMAGE_TYPE_CONDUCTOR", "conductor"},
 228     {GST_TAG_IMAGE_TYPE_BAND_ORCHESTRA, "GST_TAG_IMAGE_TYPE_BAND_ORCHESTRA",
 229         "band-orchestra"},
 230     {GST_TAG_IMAGE_TYPE_COMPOSER, "GST_TAG_IMAGE_TYPE_COMPOSER", "composer"},
 231     {GST_TAG_IMAGE_TYPE_LYRICIST, "GST_TAG_IMAGE_TYPE_LYRICIST", "lyricist"},
 232     {GST_TAG_IMAGE_TYPE_RECORDING_LOCATION,
 233           "GST_TAG_IMAGE_TYPE_RECORDING_LOCATION",
 234         "recording-location"},
 235     {GST_TAG_IMAGE_TYPE_DURING_RECORDING, "GST_TAG_IMAGE_TYPE_DURING_RECORDING",
 236         "during-recording"},
 237     {GST_TAG_IMAGE_TYPE_DURING_PERFORMANCE,
 238           "GST_TAG_IMAGE_TYPE_DURING_PERFORMANCE",
 239         "during-performance"},
 240     {GST_TAG_IMAGE_TYPE_VIDEO_CAPTURE, "GST_TAG_IMAGE_TYPE_VIDEO_CAPTURE",
 241         "video-capture"},
 242     {GST_TAG_IMAGE_TYPE_FISH, "GST_TAG_IMAGE_TYPE_FISH", "fish"},
 243     {GST_TAG_IMAGE_TYPE_ILLUSTRATION, "GST_TAG_IMAGE_TYPE_ILLUSTRATION",
 244         "illustration"},
 245     {GST_TAG_IMAGE_TYPE_BAND_ARTIST_LOGO, "GST_TAG_IMAGE_TYPE_BAND_ARTIST_LOGO",
 246         "artist-logo"},
 247     {GST_TAG_IMAGE_TYPE_PUBLISHER_STUDIO_LOGO,
 248           "GST_TAG_IMAGE_TYPE_PUBLISHER_STUDIO_LOGO",
 249         "publisher-studio-logo"},
 250     {0, NULL, NULL}
 251   };
 252
 253   *id = g_enum_register_static ("GstTagImageType", image_types);
 254
 255   /* work around thread-safety issue with class creation in GLib */
 256   g_type_class_ref (*id);
 257 }
 258
 259 GType
 260 gst_tag_image_type_get_type (void)
 261 {
 262   static GType id;
 263
 264   static GOnce once = G_ONCE_INIT;
 265
 266   g_once (&once, (GThreadFunc) register_tag_image_type_enum, &id);
 267   return id;
 268 }
 269
 270 static inline gboolean
 271 gst_tag_image_type_is_valid (GstTagImageType type)
 272 {
 273   GEnumClass *klass;
 274
 275   gboolean res;
 276
 277   klass = g_type_class_ref (gst_tag_image_type_get_type ());
 278   res = (g_enum_get_value (klass, type) != NULL);
 279   g_type_class_unref (klass);
 280
 281   return res;
 282 }
 283
 284 /**
 285  * gst_tag_parse_extended_comment:
 286  * @ext_comment: an extended comment string, see #GST_TAG_EXTENDED_COMMENT
 287  * @key: return location for the comment description key, or NULL
 288  * @lang: return location for the comment ISO-639 language code, or NULL
 289  * @value: return location for the actual comment string, or NULL
 290  * @fail_if_no_key: whether to fail if strings are not in key=value form
 291  *
 292  * Convenience function to parse a GST_TAG_EXTENDED_COMMENT string and
 293  * separate it into its components.
 294  *
 295  * If successful, @key, @lang and/or @value will be set to newly allocated
 296  * strings that you need to free with g_free() when done. @key and @lang
 297  * may also be set to NULL by this function if there is no key or no language
 298  * code in the extended comment string.
 299  *
 300  * Returns: TRUE if the string could be parsed, otherwise FALSE
 301  *
 302  * Since: 0.10.10
 303  */
 304 gboolean
 305 gst_tag_parse_extended_comment (const gchar * ext_comment, gchar ** key,
 306     gchar ** lang, gchar ** value, gboolean fail_if_no_key)
 307 {
 308   const gchar *div, *bop, *bcl;
 309
 310   g_return_val_if_fail (ext_comment != NULL, FALSE);
 311   g_return_val_if_fail (g_utf8_validate (ext_comment, -1, NULL), FALSE);
 312
 313   if (key)
 314     *key = NULL;
 315   if (lang)
 316     *lang = NULL;
 317
 318   div = strchr (ext_comment, '=');
 319   bop = strchr (ext_comment, '[');
 320   bcl = strchr (ext_comment, ']');
 321
 322   if (div == NULL) {
 323     if (fail_if_no_key)
 324       return FALSE;
 325     if (value)
 326       *value = g_strdup (ext_comment);
 327     return TRUE;
 328   }
 329
 330   if (bop != NULL && bop < div) {
 331     if (bcl < bop || bcl > div)
 332       return FALSE;
 333     if (key)
 334       *key = g_strndup (ext_comment, bop - ext_comment);
 335     if (lang)
 336       *lang = g_strndup (bop + 1, bcl - bop - 1);
 337   } else {
 338     if (key)
 339       *key = g_strndup (ext_comment, div - ext_comment);
 340   }
 341
 342   if (value)
 343     *value = g_strdup (div + 1);
 344
 345   return TRUE;
 346 }
 347
 348 /**
 349  * gst_tag_freeform_string_to_utf8:
 350  * @data: string data
 351  * @size: length of string data, or -1 if the string is NUL-terminated
 352  * @env_vars: a NULL-terminated string array of environment variable names,
 353  *            or NULL
 354  *
 355  * Convenience function to read a string with unknown character encoding. If
 356  * the string is already in UTF-8 encoding, it will be returned right away.
 357  * If not it tries to detect byte-order-mark for UTF-16/32 cases and use that.
 358  * Otherwise, the environment will be searched for a number of environment
 359  * variables (whose names are specified in the NULL-terminated string array
 360  * @env_vars) containing a list of character encodings to try/use. If none
 361  * are specified, the current locale will be tried. If that also doesn't work,
 362  * WINDOWS-1252/ISO-8859-1 is assumed (which will almost always succeed).
 363  *
 364  * Returns: a newly-allocated string in UTF-8 encoding, or NULL
 365  *
 366  * Since: 0.10.13
 367  */
 368 gchar *
 369 gst_tag_freeform_string_to_utf8 (const gchar * data, gint size,
 370     const gchar ** env_vars)
 371 {
 372   const gchar *cur_loc = NULL;
 373
 374   gsize bytes_read;
 375
 376   gchar *utf8 = NULL;
 377
 378   g_return_val_if_fail (data != NULL, NULL);
 379
 380   if (size < 0)
 381     size = strlen (data);
 382
 383   /* chop off trailing string terminators to make sure utf8_validate doesn't
 384    * get to see them (since that would make the utf8 check fail) */
 385   while (size > 0 && data[size - 1] == '\0')
 386     --size;
 387
 388   /* Should we try the charsets specified
 389    * via environment variables FIRST ? */
 390   if (g_utf8_validate (data, size, NULL)) {
 391     utf8 = g_strndup (data, size);
 392     GST_LOG ("String '%s' is valid UTF-8 already", utf8);
 393     goto beach;
 394   }
 395
 396   /* check for and use byte-order-mark for UTF-16/32 cases */
 397   if (size >= 2) {
 398     const gchar *c = NULL;
 399     gint prefix, ssize;
 400
 401     if (size >= 4) {
 402       prefix = 4;
 403       ssize = GST_ROUND_DOWN_4 (size - 4);
 404       switch (GST_READ_UINT32_BE (data)) {
 405         case 0x0000FEFF:
 406           c = "UTF-32BE";
 407           break;
 408         case 0xFFFE0000:
 409           c = "UTF-32LE";
 410           break;
 411         default:
 412           break;
 413       }
 414     }
 415     if (!c) {
 416       prefix = 2;
 417       ssize = GST_ROUND_DOWN_2 (size - 2);
 418       switch (GST_READ_UINT16_BE (data)) {
 419         case 0xFEFF:
 420           c = "UTF-16BE";
 421           break;
 422         case 0xFFFE:
 423           c = "UTF-16LE";
 424           break;
 425         default:
 426           break;
 427       }
 428     }
 429     if (c) {
 430       GST_LOG ("Trying to convert freeform string to UTF-8 from '%s'", c);
 431       if ((utf8 =
 432               g_convert (data + prefix, ssize, "UTF-8", c, &bytes_read, NULL,
 433                   NULL))) {
 434         if (bytes_read == ssize)
 435           goto beach;
 436         g_free (utf8);
 437         utf8 = NULL;
 438       }
 439     }
 440   }
 441
 442   while (env_vars && *env_vars != NULL) {
 443     const gchar *env = NULL;
 444
 445     /* Try charsets specified via the environment */
 446     env = g_getenv (*env_vars);
 447     if (env != NULL && *env != '\0') {
 448       gchar **c, **csets;
 449
 450       csets = g_strsplit (env, G_SEARCHPATH_SEPARATOR_S, -1);
 451
 452       for (c = csets; c && *c; ++c) {
 453         GST_LOG ("Trying to convert freeform string to UTF-8 from '%s'", *c);
 454         if ((utf8 =
 455                 g_convert (data, size, "UTF-8", *c, &bytes_read, NULL, NULL))) {
 456           if (bytes_read == size) {
 457             g_strfreev (csets);
 458             goto beach;
 459           }
 460           g_free (utf8);
 461           utf8 = NULL;
 462         }
 463       }
 464
 465       g_strfreev (csets);
 466     }
 467     ++env_vars;
 468   }
 469
 470   /* Try current locale (if not UTF-8) */
 471   if (!g_get_charset (&cur_loc)) {
 472     GST_LOG ("Trying to convert freeform string using locale ('%s')", cur_loc);
 473     if ((utf8 = g_locale_to_utf8 (data, size, &bytes_read, NULL, NULL))) {
 474       if (bytes_read == size) {
 475         goto beach;
 476       }
 477       g_free (utf8);
 478       utf8 = NULL;
 479     }
 480   }
 481
 482   /* Try Windows-1252 (which is a superset of ISO 8859-1 that uses a control
 483    * character range in ISO 8859-1 for more printable characters) */
 484   {
 485     GError *err = NULL;
 486
 487     GST_LOG ("Trying to convert freeform string using Windows-1252/ISO-8859-1 "
 488         "fallback");
 489     utf8 = g_convert (data, size, "UTF-8", "WINDOWS-1252", &bytes_read, NULL,
 490         &err);
 491     if (err != NULL) {
 492       /* fallback in case iconv implementation doesn't support windows-1252
 493        * for some reason */
 494       if (err->code == G_CONVERT_ERROR_NO_CONVERSION) {
 495         utf8 = g_convert (data, size, "UTF-8", "ISO-8859-1", &bytes_read,
 496             NULL, NULL);
 497       }
 498       g_error_free (err);
 499     }
 500
 501     if (utf8 != NULL && bytes_read == size)
 502       goto beach;
 503   }
 504
 505   g_free (utf8);
 506   return NULL;
 507
 508 beach:
 509
 510   g_strchomp (utf8);
 511   if (utf8 && utf8[0] != '\0') {
 512     GST_LOG ("Returning '%s'", utf8);
 513     return utf8;
 514   }
 515
 516   g_free (utf8);
 517   return NULL;
 518 }
 519
 520 /**
 521  * gst_tag_image_data_to_image_buffer:
 522  * @image_data: the (encoded) image
 523  * @image_data_len: the length of the encoded image data at @image_data
 524  * @image_type: type of the image, or #GST_TAG_IMAGE_TYPE_UNDEFINED. Pass
 525  *     #GST_TAG_IMAGE_TYPE_NONE if no image type should be set at all (e.g.
 526  *     for preview images)
 527  *
 528  * Helper function for tag-reading plugins to create a #GstBuffer suitable to
 529  * add to a #GstTagList as an image tag (such as #GST_TAG_IMAGE or
 530  * #GST_TAG_PREVIEW_IMAGE) from the encoded image data and an (optional) image
 531  * type.
 532  *
 533  * Background: cover art and other images in tags are usually stored as a
 534  * blob of binary image data, often accompanied by a MIME type or some other
 535  * content type string (e.g. 'png', 'jpeg', 'jpg'). Sometimes there is also an
 536  * 'image type' to indicate what kind of image this is (e.g. front cover,
 537  * back cover, artist, etc.). The image data may also be an URI to the image
 538  * rather than the image itself.
 539  *
 540  * In GStreamer, image tags are #GstBuffer<!-- -->s containing the raw image
 541  * data, with the buffer caps describing the content type of the image
 542  * (e.g. image/jpeg, image/png, text/uri-list). The buffer caps may contain
 543  * an additional 'image-type' field of #GST_TYPE_TAG_IMAGE_TYPE to describe
 544  * the type of image (front cover, back cover etc.). #GST_TAG_PREVIEW_IMAGE
 545  * tags should not carry an image type, their type is already indicated via
 546  * the special tag name.
 547  *
 548  * This function will do various checks and typefind the encoded image
 549  * data (we can't trust the declared mime type).
 550  *
 551  * Returns: a newly-allocated image buffer for use in tag lists, or NULL
 552  *
 553  * Since: 0.10.20
 554  */
 555 GstBuffer *
 556 gst_tag_image_data_to_image_buffer (const guint8 * image_data,
 557     guint image_data_len, GstTagImageType image_type)
 558 {
 559   const gchar *name;
 560   GstBuffer *image;
 561   GstCaps *caps;
 562   guint8 *data;
 563
 564   g_return_val_if_fail (image_data != NULL, NULL);
 565   g_return_val_if_fail (image_data_len > 0, NULL);
 566   g_return_val_if_fail (gst_tag_image_type_is_valid (image_type), NULL);
 567
 568   GST_DEBUG ("image data len: %u bytes", image_data_len);
 569
 570   /* allocate space for a NUL terminator for an uri too */
 571   image = gst_buffer_new_and_alloc (image_data_len + 1);
 572   if (image == NULL)
 573     goto alloc_failed;
 574
 575   data = gst_buffer_map (image, NULL, NULL, GST_MAP_WRITE);
 576   memcpy (data, image_data, image_data_len);
 577   data[image_data_len] = '\0';
 578   gst_buffer_unmap (image, data, image_data_len + 1);
 579
 580   /* Find GStreamer media type, can't trust declared type */
 581   caps = gst_type_find_helper_for_buffer (NULL, image, NULL);
 582
 583   if (caps == NULL)
 584     goto no_type;
 585
 586   GST_DEBUG ("Found GStreamer media type: %" GST_PTR_FORMAT, caps);
 587
 588   /* sanity check: make sure typefound/declared caps are either URI or image */
 589   name = gst_structure_get_name (gst_caps_get_structure (caps, 0));
 590
 591   if (!g_str_has_prefix (name, "image/") &&
 592       !g_str_has_prefix (name, "video/") &&
 593       !g_str_equal (name, "text/uri-list")) {
 594     GST_DEBUG ("Unexpected image type '%s', ignoring image frame", name);
 595     goto error;
 596   }
 597
 598   /* Decrease size by 1 if we don't have an URI list
 599    * to keep the original size of the image
 600    */
 601   if (!g_str_equal (name, "text/uri-list"))
 602     gst_buffer_set_size (image, image_data_len);
 603
 604   if (image_type != GST_TAG_IMAGE_TYPE_NONE) {
 605     GST_LOG ("Setting image type: %d", image_type);
 606     caps = gst_caps_make_writable (caps);
 607     gst_caps_set_simple (caps, "image-type", GST_TYPE_TAG_IMAGE_TYPE,
 608         image_type, NULL);
 609   }
 610
 611   gst_buffer_set_caps (image, caps);
 612   gst_caps_unref (caps);
 613   return image;
 614
 615 /* ERRORS */
 616 no_type:
 617   {
 618     GST_DEBUG ("Could not determine GStreamer media type, ignoring image");
 619     /* fall through */
 620   }
 621 error:
 622   {
 623     if (image)
 624       gst_buffer_unref (image);
 625     if (caps)
 626       gst_caps_unref (caps);
 627     return NULL;
 628   }
 629 alloc_failed:
 630   {
 631     GST_WARNING ("failed to allocate buffer of %d for image", image_data_len);
 632     gst_buffer_unref (image);
 633     return NULL;
 634   }
 635
 636 }