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