2 * Copyright (C) 2003 Benjamin Otte <in7y118@public.uni-hamburg.de>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 #ifndef __GST_TAG_TAG_H__
22 #define __GST_TAG_TAG_H__
31 * GST_TAG_MUSICBRAINZ_TRACKID
33 * MusicBrainz track ID
35 #define GST_TAG_MUSICBRAINZ_TRACKID "musicbrainz-trackid"
37 * GST_TAG_MUSICBRAINZ_ARTISTID
39 * MusicBrainz artist ID
41 #define GST_TAG_MUSICBRAINZ_ARTISTID "musicbrainz-artistid"
43 * GST_TAG_MUSICBRAINZ_ALBUMID
45 * MusicBrainz album ID
47 #define GST_TAG_MUSICBRAINZ_ALBUMID "musicbrainz-albumid"
49 * GST_TAG_MUSICBRAINZ_ALBUMARTISTID
51 * MusicBrainz album artist ID
53 #define GST_TAG_MUSICBRAINZ_ALBUMARTISTID "musicbrainz-albumartistid"
55 * GST_TAG_MUSICBRAINZ_TRMID
57 * MusicBrainz track TRM ID
59 #define GST_TAG_MUSICBRAINZ_TRMID "musicbrainz-trmid"
61 /* FIXME 0.11: remove GST_TAG_MUSICBRAINZ_SORTNAME */
62 #ifndef GST_DISABLE_DEPRECATED
64 * GST_TAG_MUSICBRAINZ_SORTNAME
66 * MusicBrainz artist sort name
68 * Deprecated. Use GST_TAG_ARTIST_SORTNAME instead.
70 #define GST_TAG_MUSICBRAINZ_SORTNAME GST_TAG_ARTIST_SORTNAME
76 * Annodex CMML stream element tag
78 #define GST_TAG_CMML_STREAM "cmml-stream"
82 * Annodex CMML head element tag
85 #define GST_TAG_CMML_HEAD "cmml-head"
89 * Annodex CMML clip element tag
91 #define GST_TAG_CMML_CLIP "cmml-clip"
96 * GST_TAG_CDDA_CDDB_DISCID:
98 * CDDB disc id in its short form (e.g. 'aa063d0f')
100 #define GST_TAG_CDDA_CDDB_DISCID "discid"
103 * GST_TAG_CDDA_CDDB_DISCID_FULL:
105 * CDDB disc id including all details
107 #define GST_TAG_CDDA_CDDB_DISCID_FULL "discid-full"
110 * GST_TAG_CDDA_MUSICBRAINZ_DISCID:
112 * Musicbrainz disc id (e.g. 'ahg7JUcfR3vCYBphSDIogOOWrr0-')
114 #define GST_TAG_CDDA_MUSICBRAINZ_DISCID "musicbrainz-discid"
117 * GST_TAG_CDDA_MUSICBRAINZ_DISCID_FULL:
119 * Musicbrainz disc id details
121 #define GST_TAG_CDDA_MUSICBRAINZ_DISCID_FULL "musicbrainz-discid-full"
124 * GST_TAG_CAPTURING_SHUTTER_SPEED:
126 * Shutter speed used when capturing an image, in seconds. (fraction)
130 #define GST_TAG_CAPTURING_SHUTTER_SPEED "capturing-shutter-speed"
133 * GST_TAG_CAPTURING_FOCAL_RATIO:
135 * Focal ratio (f-number) used when capturing an image. (double)
137 * The value stored is the denominator of the focal ratio (f-number).
138 * For example, if this tag value is 2, the focal ratio is f/2.
142 #define GST_TAG_CAPTURING_FOCAL_RATIO "capturing-focal-ratio"
145 * GST_TAG_CAPTURING_FOCAL_LENGTH:
147 * Focal length used when capturing an image, in mm. (double)
151 #define GST_TAG_CAPTURING_FOCAL_LENGTH "capturing-focal-length"
154 * GST_TAG_CAPTURING_DIGITAL_ZOOM_RATIO:
156 * Digital zoom ratio used when capturing an image. (double)
160 #define GST_TAG_CAPTURING_DIGITAL_ZOOM_RATIO "capturing-digital-zoom-ratio"
163 * GST_TAG_CAPTURING_ISO_SPEED:
165 * ISO speed used when capturing an image. (integer)
169 #define GST_TAG_CAPTURING_ISO_SPEED "capturing-iso-speed"
172 * GST_TAG_CAPTURING_EXPOSURE_PROGRAM:
174 * Type of exposure control used when capturing an image. (string)
176 * The allowed values are:
179 * "normal" - automatically controlled
180 * "aperture-priority" - user selects aperture value
181 * "shutter-priority" - user selects shutter speed
182 * "creative" - biased towards depth of field
183 * "action" - biased towards fast shutter speed
184 * "portrait" - closeup, leaving background out of focus
185 * "landscape" - landscape photos, background in focus
189 #define GST_TAG_CAPTURING_EXPOSURE_PROGRAM "capturing-exposure-program"
192 * GST_TAG_CAPTURING_EXPOSURE_MODE:
194 * Exposure mode used when capturing an image. (string)
196 * The allowed values are:
203 #define GST_TAG_CAPTURING_EXPOSURE_MODE "capturing-exposure-mode"
206 * GST_TAG_CAPTURING_EXPOSURE_COMPENSATION:
208 * Exposure compensation using when capturing an image in EV. (double)
212 #define GST_TAG_CAPTURING_EXPOSURE_COMPENSATION "capturing-exposure-compensation"
215 * GST_TAG_CAPTURING_SCENE_CAPTURE_TYPE:
217 * Scene mode used when capturing an image. (string)
219 * The allowed values are:
227 #define GST_TAG_CAPTURING_SCENE_CAPTURE_TYPE "capturing-scene-capture-type"
230 * GST_TAG_CAPTURING_GAIN_ADJUSTMENT:
232 * Gain adjustment applied to an image. (string)
234 * The allowed values are:
243 #define GST_TAG_CAPTURING_GAIN_ADJUSTMENT "capturing-gain-adjustment"
246 * GST_TAG_CAPTURING_WHITE_BALANCE:
248 * White balance mode used when capturing an image. (string)
250 * The allowed values are:
257 * "fluorescent h" (newer daylight-calibrated fluorescents)
262 #define GST_TAG_CAPTURING_WHITE_BALANCE "capturing-white-balance"
265 * GST_TAG_CAPTURING_CONTRAST:
267 * Direction of contrast processing applied when capturing an image. (string)
269 * The allowed values are:
276 #define GST_TAG_CAPTURING_CONTRAST "capturing-contrast"
279 * GST_TAG_CAPTURING_SATURATION:
281 * Direction of saturation processing applied when capturing an image. (string)
283 * The allowed values are:
290 #define GST_TAG_CAPTURING_SATURATION "capturing-saturation"
293 * GST_TAG_CAPTURING_SHARPNESS:
295 * Direction of sharpness processing applied when capturing an image. (string)
297 * The allowed values are:
304 #define GST_TAG_CAPTURING_SHARPNESS "capturing-sharpness"
307 * GST_TAG_CAPTURING_FLASH_FIRED:
309 * If flash was fired during the capture of an image. (boolean)
311 * Note that if this tag isn't present, it should not be assumed that
312 * the flash did not fire. It should be treated as unknown.
316 #define GST_TAG_CAPTURING_FLASH_FIRED "capturing-flash-fired"
319 * GST_TAG_CAPTURING_FLASH_MODE:
321 * The flash mode selected during the capture of an image. (string)
323 * The allowed values are:
330 #define GST_TAG_CAPTURING_FLASH_MODE "capturing-flash-mode"
333 * GST_TAG_CAPTURING_METERING_MODE:
335 * Defines the way a camera determines the exposure. (string)
337 * The allowed values are:
340 * "center-weighted-average"
349 #define GST_TAG_CAPTURING_METERING_MODE "capturing-metering-mode"
352 * GST_TAG_CAPTURING_SOURCE:
354 * Indicates the source of capture. The device/medium used to do the
357 * Allowed values are:
358 * "dsc" (= digital still camera)
359 * "transparent-scanner"
365 #define GST_TAG_CAPTURING_SOURCE "capturing-source"
368 * GST_TAG_IMAGE_HORIZONTAL_PPI:
370 * Media (image/video) intended horizontal pixel density in ppi. (double)
374 #define GST_TAG_IMAGE_HORIZONTAL_PPI "image-horizontal-ppi"
376 * GST_TAG_IMAGE_VERTICAL_PPI:
378 * Media (image/video) intended vertical pixel density in ppi. (double)
382 #define GST_TAG_IMAGE_VERTICAL_PPI "image-vertical-ppi"
385 /* additional information for image tags */
389 * @GST_TAG_IMAGE_TYPE_NONE : No image type. Can be used to
390 * tell functions such as gst_tag_image_data_to_image_buffer() that no
391 * image type should be set. (Since: 0.10.20)
392 * @GST_TAG_IMAGE_TYPE_UNDEFINED : Undefined/other image type
393 * @GST_TAG_IMAGE_TYPE_FRONT_COVER : Cover (front)
394 * @GST_TAG_IMAGE_TYPE_BACK_COVER : Cover (back)
395 * @GST_TAG_IMAGE_TYPE_LEAFLET_PAGE : Leaflet page
396 * @GST_TAG_IMAGE_TYPE_MEDIUM : Medium (e.g. label side of CD)
397 * @GST_TAG_IMAGE_TYPE_LEAD_ARTIST : Lead artist/lead performer/soloist
398 * @GST_TAG_IMAGE_TYPE_ARTIST : Artist/performer
399 * @GST_TAG_IMAGE_TYPE_CONDUCTOR : Conductor
400 * @GST_TAG_IMAGE_TYPE_BAND_ORCHESTRA : Band/orchestra
401 * @GST_TAG_IMAGE_TYPE_COMPOSER : Composer
402 * @GST_TAG_IMAGE_TYPE_LYRICIST : Lyricist/text writer
403 * @GST_TAG_IMAGE_TYPE_RECORDING_LOCATION : Recording location
404 * @GST_TAG_IMAGE_TYPE_DURING_RECORDING : During recording
405 * @GST_TAG_IMAGE_TYPE_DURING_PERFORMANCE : During performance
406 * @GST_TAG_IMAGE_TYPE_VIDEO_CAPTURE : Movie/video screen capture
407 * @GST_TAG_IMAGE_TYPE_FISH : A fish as funny as the ID3v2 spec
408 * @GST_TAG_IMAGE_TYPE_ILLUSTRATION : Illustration
409 * @GST_TAG_IMAGE_TYPE_BAND_ARTIST_LOGO : Band/artist logotype
410 * @GST_TAG_IMAGE_TYPE_PUBLISHER_STUDIO_LOGO : Publisher/studio logotype
412 * Type of image contained in an image tag (specified as field in
413 * the image buffer's caps structure)
417 /* Note: keep in sync with register_tag_image_type_enum() */
419 GST_TAG_IMAGE_TYPE_NONE = -1,
420 GST_TAG_IMAGE_TYPE_UNDEFINED = 0,
421 GST_TAG_IMAGE_TYPE_FRONT_COVER,
422 GST_TAG_IMAGE_TYPE_BACK_COVER,
423 GST_TAG_IMAGE_TYPE_LEAFLET_PAGE,
424 GST_TAG_IMAGE_TYPE_MEDIUM,
425 GST_TAG_IMAGE_TYPE_LEAD_ARTIST,
426 GST_TAG_IMAGE_TYPE_ARTIST,
427 GST_TAG_IMAGE_TYPE_CONDUCTOR,
428 GST_TAG_IMAGE_TYPE_BAND_ORCHESTRA,
429 GST_TAG_IMAGE_TYPE_COMPOSER,
430 GST_TAG_IMAGE_TYPE_LYRICIST,
431 GST_TAG_IMAGE_TYPE_RECORDING_LOCATION,
432 GST_TAG_IMAGE_TYPE_DURING_RECORDING,
433 GST_TAG_IMAGE_TYPE_DURING_PERFORMANCE,
434 GST_TAG_IMAGE_TYPE_VIDEO_CAPTURE,
435 GST_TAG_IMAGE_TYPE_FISH,
436 GST_TAG_IMAGE_TYPE_ILLUSTRATION,
437 GST_TAG_IMAGE_TYPE_BAND_ARTIST_LOGO,
438 GST_TAG_IMAGE_TYPE_PUBLISHER_STUDIO_LOGO
441 #define GST_TYPE_TAG_IMAGE_TYPE (gst_tag_image_type_get_type ())
442 GType gst_tag_image_type_get_type (void);
445 /* functions for vorbis comment manipulation */
447 G_CONST_RETURN gchar * gst_tag_from_vorbis_tag (const gchar * vorbis_tag);
448 G_CONST_RETURN gchar * gst_tag_to_vorbis_tag (const gchar * gst_tag);
449 void gst_vorbis_tag_add (GstTagList * list,
451 const gchar * value);
453 GList * gst_tag_to_vorbis_comments (const GstTagList * list,
456 /* functions to convert GstBuffers with vorbiscomment contents to GstTagLists and back */
457 GstTagList * gst_tag_list_from_vorbiscomment_buffer (const GstBuffer * buffer,
458 const guint8 * id_data,
459 const guint id_data_length,
460 gchar ** vendor_string);
461 GstBuffer * gst_tag_list_to_vorbiscomment_buffer (const GstTagList * list,
462 const guint8 * id_data,
463 const guint id_data_length,
464 const gchar * vendor_string);
466 /* functions for ID3 tag manipulation */
468 guint gst_tag_id3_genre_count (void);
469 G_CONST_RETURN gchar * gst_tag_id3_genre_get (const guint id);
470 GstTagList * gst_tag_list_new_from_id3v1 (const guint8 * data);
472 G_CONST_RETURN gchar * gst_tag_from_id3_tag (const gchar * id3_tag);
473 G_CONST_RETURN gchar * gst_tag_from_id3_user_tag (const gchar * type,
474 const gchar * id3_user_tag);
475 G_CONST_RETURN gchar * gst_tag_to_id3_tag (const gchar * gst_tag);
477 gboolean gst_tag_list_add_id3_image (GstTagList * tag_list,
478 const guint8 * image_data,
479 guint image_data_len,
480 guint id3_picture_type);
482 /* functions to convert GstBuffers with xmp packets contents to GstTagLists and back */
483 GstTagList * gst_tag_list_from_xmp_buffer (const GstBuffer * buffer);
484 GstBuffer * gst_tag_list_to_xmp_buffer (const GstTagList * list,
486 GstBuffer * gst_tag_list_to_xmp_buffer_full (const GstTagList * list,
487 gboolean read_only, const gchar ** schemas);
488 const gchar** gst_tag_xmp_list_schemas (void);
490 /* functions related to exif */
491 GstBuffer * gst_tag_list_to_exif_buffer (const GstTagList * taglist,
493 guint32 base_offset);
495 GstBuffer * gst_tag_list_to_exif_buffer_with_tiff_header (const GstTagList * taglist);
497 GstTagList * gst_tag_list_from_exif_buffer (const GstBuffer * buffer,
499 guint32 base_offset);
501 GstTagList * gst_tag_list_from_exif_buffer_with_tiff_header (
502 const GstBuffer * buffer);
504 /* other tag-related functions */
506 gboolean gst_tag_parse_extended_comment (const gchar * ext_comment,
510 gboolean fail_if_no_key);
512 gchar * gst_tag_freeform_string_to_utf8 (const gchar * data,
514 const gchar ** env_vars);
516 GstBuffer * gst_tag_image_data_to_image_buffer (const guint8 * image_data,
517 guint image_data_len,
518 GstTagImageType image_type);
520 /* FIXME 0.11: get rid of this awkward register/init function, see tags.c */
521 void gst_tag_register_musicbrainz_tags (void);
524 /* language tag related functions */
526 gchar ** gst_tag_get_language_codes (void);
528 const gchar * gst_tag_get_language_name (const gchar * language_code);
530 const gchar * gst_tag_get_language_code_iso_639_1 (const gchar * lang_code);
532 const gchar * gst_tag_get_language_code_iso_639_2B (const gchar * lang_code);
534 const gchar * gst_tag_get_language_code_iso_639_2T (const gchar * lang_code);
537 * gst_tag_get_language_code:
538 * @lang_code: ISO-639 language code (e.g. "deu" or "ger" or "de")
540 * Convenience macro wrapping gst_tag_get_language_code_iso_639_1().
544 #define gst_tag_get_language_code(lang_code) \
545 gst_tag_get_language_code_iso_639_1(lang_code)
549 #endif /* __GST_TAG_TAG_H__ */