tag: More photography related tags
[platform/upstream/gstreamer.git] / 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
47 static gpointer
48 gst_tag_register_tags_internal (gpointer unused)
49 {
50 #ifdef ENABLE_NLS
51   GST_DEBUG ("binding text domain %s to locale dir %s", GETTEXT_PACKAGE,
52       LOCALEDIR);
53   bindtextdomain (GETTEXT_PACKAGE, LOCALEDIR);
54   bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
55 #endif
56
57   /* musicbrainz tags */
58   gst_tag_register (GST_TAG_MUSICBRAINZ_TRACKID, GST_TAG_FLAG_META,
59       G_TYPE_STRING, _("track ID"), _("MusicBrainz track ID"), NULL);
60   gst_tag_register (GST_TAG_MUSICBRAINZ_ARTISTID, GST_TAG_FLAG_META,
61       G_TYPE_STRING, _("artist ID"), _("MusicBrainz artist ID"), NULL);
62   gst_tag_register (GST_TAG_MUSICBRAINZ_ALBUMID, GST_TAG_FLAG_META,
63       G_TYPE_STRING, _("album ID"), _("MusicBrainz album ID"), NULL);
64   gst_tag_register (GST_TAG_MUSICBRAINZ_ALBUMARTISTID, GST_TAG_FLAG_META,
65       G_TYPE_STRING,
66       _("album artist ID"), _("MusicBrainz album artist ID"), NULL);
67   gst_tag_register (GST_TAG_MUSICBRAINZ_TRMID, GST_TAG_FLAG_META,
68       G_TYPE_STRING, _("track TRM ID"), _("MusicBrainz TRM ID"), NULL);
69
70   /* CDDA tags */
71   gst_tag_register (GST_TAG_CDDA_CDDB_DISCID, GST_TAG_FLAG_META,
72       G_TYPE_STRING, "discid", "CDDB discid for metadata retrieval",
73       gst_tag_merge_use_first);
74
75   gst_tag_register (GST_TAG_CDDA_CDDB_DISCID_FULL, GST_TAG_FLAG_META,
76       G_TYPE_STRING, "discid full",
77       "CDDB discid for metadata retrieval (full)", gst_tag_merge_use_first);
78
79   gst_tag_register (GST_TAG_CDDA_MUSICBRAINZ_DISCID, GST_TAG_FLAG_META,
80       G_TYPE_STRING, "musicbrainz-discid",
81       "Musicbrainz discid for metadata retrieval", gst_tag_merge_use_first);
82
83   gst_tag_register (GST_TAG_CDDA_MUSICBRAINZ_DISCID_FULL, GST_TAG_FLAG_META,
84       G_TYPE_STRING, "musicbrainz-discid-full",
85       "Musicbrainz discid for metadata retrieval (full)",
86       gst_tag_merge_use_first);
87
88   /* photography tags */
89   gst_tag_register (GST_TAG_CAPTURING_SHUTTER_SPEED, GST_TAG_FLAG_META,
90       GST_TYPE_FRACTION, _("capturing shutter speed"),
91       _("Shutter speed used when capturing an image, in seconds"), NULL);
92
93   gst_tag_register (GST_TAG_CAPTURING_FOCAL_RATIO, GST_TAG_FLAG_META,
94       G_TYPE_DOUBLE, _("capturing focal ratio"),
95       _("Focal ratio (f-number) used when capturing the image"), NULL);
96
97   gst_tag_register (GST_TAG_CAPTURING_FOCAL_LENGTH, GST_TAG_FLAG_META,
98       G_TYPE_DOUBLE, _("capturing focal length"),
99       _("Focal length of the lens used capturing the image, in mm"), NULL);
100
101   gst_tag_register (GST_TAG_CAPTURING_DIGITAL_ZOOM_RATIO, GST_TAG_FLAG_META,
102       G_TYPE_DOUBLE, _("capturing digital zoom ratio"),
103       _("Digital zoom ratio used when capturing an image"), NULL);
104
105   gst_tag_register (GST_TAG_CAPTURING_ISO_SPEED, GST_TAG_FLAG_META,
106       G_TYPE_INT, _("capturing iso speed"),
107       _("The ISO speed used when capturing an image"), NULL);
108
109   gst_tag_register (GST_TAG_CAPTURING_EXPOSURE_PROGRAM, GST_TAG_FLAG_META,
110       G_TYPE_STRING, _("capturing exposure program"),
111       _("The exposure program used when capturing an image"), NULL);
112
113   gst_tag_register (GST_TAG_CAPTURING_EXPOSURE_MODE, GST_TAG_FLAG_META,
114       G_TYPE_STRING, _("capturing exposure mode"),
115       _("The exposure mode used when capturing an image"), NULL);
116
117   gst_tag_register (GST_TAG_CAPTURING_SCENE_CAPTURE_TYPE, GST_TAG_FLAG_META,
118       G_TYPE_STRING, _("capturing scene capture type"),
119       _("The scene capture mode used when capturing an image"), NULL);
120
121   gst_tag_register (GST_TAG_CAPTURING_GAIN_ADJUSTMENT, GST_TAG_FLAG_META,
122       G_TYPE_STRING, _("capturing gain adjustment"),
123       _("The overall gain adjustment applied on an image"), NULL);
124
125   gst_tag_register (GST_TAG_CAPTURING_WHITE_BALANCE, GST_TAG_FLAG_META,
126       G_TYPE_STRING, _("capturing white balance"),
127       _("The white balance mode set when capturing an image"), NULL);
128
129   gst_tag_register (GST_TAG_CAPTURING_CONTRAST, GST_TAG_FLAG_META,
130       G_TYPE_STRING, _("capturing contrast"),
131       _("The direction of contrast processing applied "
132           "when capturing an image"), NULL);
133
134   gst_tag_register (GST_TAG_CAPTURING_SATURATION, GST_TAG_FLAG_META,
135       G_TYPE_STRING, _("capturing saturation"),
136       _("The direction of saturation processing applied when "
137           "capturing an image"), NULL);
138
139   return NULL;
140 }
141
142 /* FIXME 0.11: rename this to gst_tag_init() or gst_tag_register_tags() */
143 /**
144  * gst_tag_register_musicbrainz_tags
145  *
146  * Registers additional musicbrainz-specific tags with the GStreamer tag
147  * system. Plugins and applications that use these tags should call this
148  * function before using them. Can be called multiple times.
149  */
150 void
151 gst_tag_register_musicbrainz_tags (void)
152 {
153   static GOnce mb_once = G_ONCE_INIT;
154
155   g_once (&mb_once, gst_tag_register_tags_internal, NULL);
156 }
157
158 static void
159 register_tag_image_type_enum (GType * id)
160 {
161   static const GEnumValue image_types[] = {
162     {GST_TAG_IMAGE_TYPE_NONE, "GST_TAG_IMAGE_TYPE_NONE", "none"},
163     {GST_TAG_IMAGE_TYPE_UNDEFINED, "GST_TAG_IMAGE_TYPE_UNDEFINED", "undefined"},
164     {GST_TAG_IMAGE_TYPE_FRONT_COVER, "GST_TAG_IMAGE_TYPE_FRONT_COVER",
165         "front-cover"},
166     {GST_TAG_IMAGE_TYPE_BACK_COVER, "GST_TAG_IMAGE_TYPE_BACK_COVER",
167         "back-cover"},
168     {GST_TAG_IMAGE_TYPE_LEAFLET_PAGE, "GST_TAG_IMAGE_TYPE_LEAFLET_PAGE",
169         "leaflet-page"},
170     {GST_TAG_IMAGE_TYPE_MEDIUM, "GST_TAG_IMAGE_TYPE_MEDIUM", "medium"},
171     {GST_TAG_IMAGE_TYPE_LEAD_ARTIST, "GST_TAG_IMAGE_TYPE_LEAD_ARTIST",
172         "lead-artist"},
173     {GST_TAG_IMAGE_TYPE_ARTIST, "GST_TAG_IMAGE_TYPE_ARTIST", "artist"},
174     {GST_TAG_IMAGE_TYPE_CONDUCTOR, "GST_TAG_IMAGE_TYPE_CONDUCTOR", "conductor"},
175     {GST_TAG_IMAGE_TYPE_BAND_ORCHESTRA, "GST_TAG_IMAGE_TYPE_BAND_ORCHESTRA",
176         "band-orchestra"},
177     {GST_TAG_IMAGE_TYPE_COMPOSER, "GST_TAG_IMAGE_TYPE_COMPOSER", "composer"},
178     {GST_TAG_IMAGE_TYPE_LYRICIST, "GST_TAG_IMAGE_TYPE_LYRICIST", "lyricist"},
179     {GST_TAG_IMAGE_TYPE_RECORDING_LOCATION,
180           "GST_TAG_IMAGE_TYPE_RECORDING_LOCATION",
181         "recording-location"},
182     {GST_TAG_IMAGE_TYPE_DURING_RECORDING, "GST_TAG_IMAGE_TYPE_DURING_RECORDING",
183         "during-recording"},
184     {GST_TAG_IMAGE_TYPE_DURING_PERFORMANCE,
185           "GST_TAG_IMAGE_TYPE_DURING_PERFORMANCE",
186         "during-performance"},
187     {GST_TAG_IMAGE_TYPE_VIDEO_CAPTURE, "GST_TAG_IMAGE_TYPE_VIDEO_CAPTURE",
188         "video-capture"},
189     {GST_TAG_IMAGE_TYPE_FISH, "GST_TAG_IMAGE_TYPE_FISH", "fish"},
190     {GST_TAG_IMAGE_TYPE_ILLUSTRATION, "GST_TAG_IMAGE_TYPE_ILLUSTRATION",
191         "illustration"},
192     {GST_TAG_IMAGE_TYPE_BAND_ARTIST_LOGO, "GST_TAG_IMAGE_TYPE_BAND_ARTIST_LOGO",
193         "artist-logo"},
194     {GST_TAG_IMAGE_TYPE_PUBLISHER_STUDIO_LOGO,
195           "GST_TAG_IMAGE_TYPE_PUBLISHER_STUDIO_LOGO",
196         "publisher-studio-logo"},
197     {0, NULL, NULL}
198   };
199
200   *id = g_enum_register_static ("GstTagImageType", image_types);
201
202   /* work around thread-safety issue with class creation in GLib */
203   g_type_class_ref (*id);
204 }
205
206 GType
207 gst_tag_image_type_get_type (void)
208 {
209   static GType id;
210
211   static GOnce once = G_ONCE_INIT;
212
213   g_once (&once, (GThreadFunc) register_tag_image_type_enum, &id);
214   return id;
215 }
216
217 static inline gboolean
218 gst_tag_image_type_is_valid (GstTagImageType type)
219 {
220   GEnumClass *klass;
221
222   gboolean res;
223
224   klass = g_type_class_ref (gst_tag_image_type_get_type ());
225   res = (g_enum_get_value (klass, type) != NULL);
226   g_type_class_unref (klass);
227
228   return res;
229 }
230
231 /**
232  * gst_tag_parse_extended_comment:
233  * @ext_comment: an extended comment string, see #GST_TAG_EXTENDED_COMMENT
234  * @key: return location for the comment description key, or NULL
235  * @lang: return location for the comment ISO-639 language code, or NULL
236  * @value: return location for the actual comment string, or NULL
237  * @fail_if_no_key: whether to fail if strings are not in key=value form
238  *
239  * Convenience function to parse a GST_TAG_EXTENDED_COMMENT string and
240  * separate it into its components.
241  *
242  * If successful, @key, @lang and/or @value will be set to newly allocated
243  * strings that you need to free with g_free() when done. @key and @lang
244  * may also be set to NULL by this function if there is no key or no language
245  * code in the extended comment string.
246  *
247  * Returns: TRUE if the string could be parsed, otherwise FALSE
248  *
249  * Since: 0.10.10
250  */
251 gboolean
252 gst_tag_parse_extended_comment (const gchar * ext_comment, gchar ** key,
253     gchar ** lang, gchar ** value, gboolean fail_if_no_key)
254 {
255   const gchar *div, *bop, *bcl;
256
257   g_return_val_if_fail (ext_comment != NULL, FALSE);
258   g_return_val_if_fail (g_utf8_validate (ext_comment, -1, NULL), FALSE);
259
260   if (key)
261     *key = NULL;
262   if (lang)
263     *lang = NULL;
264
265   div = strchr (ext_comment, '=');
266   bop = strchr (ext_comment, '[');
267   bcl = strchr (ext_comment, ']');
268
269   if (div == NULL) {
270     if (fail_if_no_key)
271       return FALSE;
272     if (value)
273       *value = g_strdup (ext_comment);
274     return TRUE;
275   }
276
277   if (bop != NULL && bop < div) {
278     if (bcl < bop || bcl > div)
279       return FALSE;
280     if (key)
281       *key = g_strndup (ext_comment, bop - ext_comment);
282     if (lang)
283       *lang = g_strndup (bop + 1, bcl - bop - 1);
284   } else {
285     if (key)
286       *key = g_strndup (ext_comment, div - ext_comment);
287   }
288
289   if (value)
290     *value = g_strdup (div + 1);
291
292   return TRUE;
293 }
294
295 /**
296  * gst_tag_freeform_string_to_utf8:
297  * @data: string data
298  * @size: length of string data, or -1 if the string is NUL-terminated
299  * @env_vars: a NULL-terminated string array of environment variable names,
300  *            or NULL
301  *
302  * Convenience function to read a string with unknown character encoding. If
303  * the string is already in UTF-8 encoding, it will be returned right away.
304  * If not it tries to detect byte-order-mark for UTF-16/32 cases and use that.
305  * Otherwise, the environment will be searched for a number of environment
306  * variables (whose names are specified in the NULL-terminated string array
307  * @env_vars) containing a list of character encodings to try/use. If none
308  * are specified, the current locale will be tried. If that also doesn't work,
309  * ISO-8859-1 is assumed (which will almost always succeed).
310  *
311  * Returns: a newly-allocated string in UTF-8 encoding, or NULL
312  *
313  * Since: 0.10.13
314  */
315 gchar *
316 gst_tag_freeform_string_to_utf8 (const gchar * data, gint size,
317     const gchar ** env_vars)
318 {
319   const gchar *cur_loc = NULL;
320
321   gsize bytes_read;
322
323   gchar *utf8 = NULL;
324
325   g_return_val_if_fail (data != NULL, NULL);
326
327   if (size < 0)
328     size = strlen (data);
329
330   /* chop off trailing string terminators to make sure utf8_validate doesn't
331    * get to see them (since that would make the utf8 check fail) */
332   while (size > 0 && data[size - 1] == '\0')
333     --size;
334
335   /* Should we try the charsets specified
336    * via environment variables FIRST ? */
337   if (g_utf8_validate (data, size, NULL)) {
338     utf8 = g_strndup (data, size);
339     GST_LOG ("String '%s' is valid UTF-8 already", utf8);
340     goto beach;
341   }
342
343   /* check for and use byte-order-mark for UTF-16/32 cases */
344   if (size >= 2) {
345     const gchar *c = NULL;
346     gint prefix, ssize;
347
348     if (size >= 4) {
349       prefix = 4;
350       ssize = GST_ROUND_DOWN_4 (size - 4);
351       switch (GST_READ_UINT32_BE (data)) {
352         case 0x0000FEFF:
353           c = "UTF-32BE";
354           break;
355         case 0xFFFE0000:
356           c = "UTF-32LE";
357           break;
358         default:
359           break;
360       }
361     }
362     if (!c) {
363       prefix = 2;
364       ssize = GST_ROUND_DOWN_2 (size - 2);
365       switch (GST_READ_UINT16_BE (data)) {
366         case 0xFEFF:
367           c = "UTF-16BE";
368           break;
369         case 0xFFFE:
370           c = "UTF-16LE";
371           break;
372         default:
373           break;
374       }
375     }
376     if (c) {
377       GST_LOG ("Trying to convert freeform string to UTF-8 from '%s'", c);
378       if ((utf8 =
379               g_convert (data + prefix, ssize, "UTF-8", c, &bytes_read, NULL,
380                   NULL))) {
381         if (bytes_read == ssize)
382           goto beach;
383         g_free (utf8);
384         utf8 = NULL;
385       }
386     }
387   }
388
389   while (env_vars && *env_vars != NULL) {
390     const gchar *env = NULL;
391
392     /* Try charsets specified via the environment */
393     env = g_getenv (*env_vars);
394     if (env != NULL && *env != '\0') {
395       gchar **c, **csets;
396
397       csets = g_strsplit (env, G_SEARCHPATH_SEPARATOR_S, -1);
398
399       for (c = csets; c && *c; ++c) {
400         GST_LOG ("Trying to convert freeform string to UTF-8 from '%s'", *c);
401         if ((utf8 =
402                 g_convert (data, size, "UTF-8", *c, &bytes_read, NULL, NULL))) {
403           if (bytes_read == size) {
404             g_strfreev (csets);
405             goto beach;
406           }
407           g_free (utf8);
408           utf8 = NULL;
409         }
410       }
411
412       g_strfreev (csets);
413     }
414     ++env_vars;
415   }
416
417   /* Try current locale (if not UTF-8) */
418   if (!g_get_charset (&cur_loc)) {
419     GST_LOG ("Trying to convert freeform string using locale ('%s')", cur_loc);
420     if ((utf8 = g_locale_to_utf8 (data, size, &bytes_read, NULL, NULL))) {
421       if (bytes_read == size) {
422         goto beach;
423       }
424       g_free (utf8);
425       utf8 = NULL;
426     }
427   }
428
429   /* Try ISO-8859-1 */
430   GST_LOG ("Trying to convert freeform string using ISO-8859-1 fallback");
431   utf8 = g_convert (data, size, "UTF-8", "ISO-8859-1", &bytes_read, NULL, NULL);
432   if (utf8 != NULL && bytes_read == size) {
433     goto beach;
434   }
435
436   g_free (utf8);
437   return NULL;
438
439 beach:
440
441   g_strchomp (utf8);
442   if (utf8 && utf8[0] != '\0') {
443     GST_LOG ("Returning '%s'", utf8);
444     return utf8;
445   }
446
447   g_free (utf8);
448   return NULL;
449 }
450
451 /**
452  * gst_tag_image_data_to_image_buffer:
453  * @image_data: the (encoded) image
454  * @image_data_len: the length of the encoded image data at @image_data
455  * @image_type: type of the image, or #GST_TAG_IMAGE_TYPE_UNDEFINED. Pass
456  *     #GST_TAG_IMAGE_TYPE_NONE if no image type should be set at all (e.g.
457  *     for preview images)
458  *
459  * Helper function for tag-reading plugins to create a #GstBuffer suitable to
460  * add to a #GstTagList as an image tag (such as #GST_TAG_IMAGE or
461  * #GST_TAG_PREVIEW_IMAGE) from the encoded image data and an (optional) image
462  * type.
463  *
464  * Background: cover art and other images in tags are usually stored as a
465  * blob of binary image data, often accompanied by a MIME type or some other
466  * content type string (e.g. 'png', 'jpeg', 'jpg'). Sometimes there is also an
467  * 'image type' to indicate what kind of image this is (e.g. front cover,
468  * back cover, artist, etc.). The image data may also be an URI to the image
469  * rather than the image itself.
470  *
471  * In GStreamer, image tags are #GstBuffer<!-- -->s containing the raw image
472  * data, with the buffer caps describing the content type of the image
473  * (e.g. image/jpeg, image/png, text/uri-list). The buffer caps may contain
474  * an additional 'image-type' field of #GST_TYPE_TAG_IMAGE_TYPE to describe
475  * the type of image (front cover, back cover etc.). #GST_TAG_PREVIEW_IMAGE
476  * tags should not carry an image type, their type is already indicated via
477  * the special tag name.
478  *
479  * This function will do various checks and typefind the encoded image
480  * data (we can't trust the declared mime type).
481  *
482  * Returns: a newly-allocated image buffer for use in tag lists, or NULL
483  *
484  * Since: 0.10.20
485  */
486 GstBuffer *
487 gst_tag_image_data_to_image_buffer (const guint8 * image_data,
488     guint image_data_len, GstTagImageType image_type)
489 {
490   const gchar *name;
491
492   GstBuffer *image;
493
494   GstCaps *caps;
495
496   g_return_val_if_fail (image_data != NULL, NULL);
497   g_return_val_if_fail (image_data_len > 0, NULL);
498   g_return_val_if_fail (gst_tag_image_type_is_valid (image_type), NULL);
499
500   GST_DEBUG ("image data len: %u bytes", image_data_len);
501
502   /* allocate space for a NUL terminator for an uri too */
503   image = gst_buffer_try_new_and_alloc (image_data_len + 1);
504   if (image == NULL) {
505     GST_WARNING ("failed to allocate buffer of %d for image", image_data_len);
506     return NULL;
507   }
508
509   memcpy (GST_BUFFER_DATA (image), image_data, image_data_len);
510   GST_BUFFER_DATA (image)[image_data_len] = '\0';
511
512   /* Find GStreamer media type, can't trust declared type */
513   caps = gst_type_find_helper_for_buffer (NULL, image, NULL);
514
515   if (caps == NULL)
516     goto no_type;
517
518   GST_DEBUG ("Found GStreamer media type: %" GST_PTR_FORMAT, caps);
519
520   /* sanity check: make sure typefound/declared caps are either URI or image */
521   name = gst_structure_get_name (gst_caps_get_structure (caps, 0));
522
523   if (!g_str_has_prefix (name, "image/") &&
524       !g_str_has_prefix (name, "video/") &&
525       !g_str_equal (name, "text/uri-list")) {
526     GST_DEBUG ("Unexpected image type '%s', ignoring image frame", name);
527     goto error;
528   }
529
530   /* Decrease size by 1 if we don't have an URI list
531    * to keep the original size of the image
532    */
533   if (!g_str_equal (name, "text/uri-list"))
534     GST_BUFFER_SIZE (image) = image_data_len;
535
536   if (image_type != GST_TAG_IMAGE_TYPE_NONE) {
537     GST_LOG ("Setting image type: %d", image_type);
538     caps = gst_caps_make_writable (caps);
539     gst_caps_set_simple (caps, "image-type", GST_TYPE_TAG_IMAGE_TYPE,
540         image_type, NULL);
541   }
542
543   gst_buffer_set_caps (image, caps);
544   gst_caps_unref (caps);
545   return image;
546
547 /* ERRORS */
548 no_type:
549   {
550     GST_DEBUG ("Could not determine GStreamer media type, ignoring image");
551     /* fall through */
552   }
553 error:
554   {
555     if (image)
556       gst_buffer_unref (image);
557     if (caps)
558       gst_caps_unref (caps);
559     return NULL;
560   }
561 }