/* GStreamer * Copyright (C) 2003 Benjamin Otte * Copyright (C) 2006-2011 Tim-Philipp Müller * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Library General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Library General Public License for more details. * * You should have received a copy of the GNU Library General Public * License along with this library; if not, write to the * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, * Boston, MA 02110-1301, USA. */ #ifndef __GST_TAG_TAG_H__ #define __GST_TAG_TAG_H__ #include #include #include #include #include #include G_BEGIN_DECLS /* Tag names */ /** * GST_TAG_MUSICBRAINZ_TRACKID: * * MusicBrainz track ID */ #define GST_TAG_MUSICBRAINZ_TRACKID "musicbrainz-trackid" /** * GST_TAG_MUSICBRAINZ_ARTISTID: * * MusicBrainz artist ID */ #define GST_TAG_MUSICBRAINZ_ARTISTID "musicbrainz-artistid" /** * GST_TAG_MUSICBRAINZ_ALBUMID: * * MusicBrainz album ID */ #define GST_TAG_MUSICBRAINZ_ALBUMID "musicbrainz-albumid" /** * GST_TAG_MUSICBRAINZ_ALBUMARTISTID: * * MusicBrainz album artist ID */ #define GST_TAG_MUSICBRAINZ_ALBUMARTISTID "musicbrainz-albumartistid" /** * GST_TAG_MUSICBRAINZ_RELEASEGROUPID: * * MusicBrainz Release Group ID * * Since: 1.18 */ #define GST_TAG_MUSICBRAINZ_RELEASEGROUPID "musicbrainz-releasegroupid" /** * GST_TAG_MUSICBRAINZ_RELEASETRACKID: * * MusicBrainz Release Track ID * * Since: 1.18 */ #define GST_TAG_MUSICBRAINZ_RELEASETRACKID "musicbrainz-releasetrackid" /** * GST_TAG_MUSICBRAINZ_TRMID: * * MusicBrainz track TRM ID */ #define GST_TAG_MUSICBRAINZ_TRMID "musicbrainz-trmid" /** * GST_TAG_ACOUSTID_ID: * * AcoustID Identifier * * Since: 1.18 */ #define GST_TAG_ACOUSTID_ID "acoustid-id" /** * GST_TAG_ACOUSTID_FINGERPRINT: * * AcoustID Fingerprint (Chromaprint) * * Since: 1.18 */ /* * FIXME 2.0: Using "chromaprint-fingerprint" for backwards compatibility with the * old custom tag from the chromaprint plugin but should change this to * "acoustid-fingerprint" in 2.0 for consistency. */ #define GST_TAG_ACOUSTID_FINGERPRINT "chromaprint-fingerprint" /** * GST_TAG_CMML_STREAM: * * Annodex CMML stream element tag */ #define GST_TAG_CMML_STREAM "cmml-stream" /** * GST_TAG_CMML_HEAD: * * Annodex CMML head element tag */ #define GST_TAG_CMML_HEAD "cmml-head" /** * GST_TAG_CMML_CLIP: * * Annodex CMML clip element tag */ #define GST_TAG_CMML_CLIP "cmml-clip" /** * GST_TAG_MUSICAL_KEY: * * Musical key in which the sound starts. It is represented as a string * with a maximum length of three characters. The ground keys are * represented with "A","B","C","D","E", "F" and "G" and halfkeys * represented with "b" and "#". Minor is represented as "m" (e.g. "Dbm"). * Off key is represented with an "o" only. * This notation might be extended in the future to support non-minor/major * keys. * * Since: 1.2 */ #define GST_TAG_MUSICAL_KEY "musical-key" /* CDDA tags */ /** * GST_TAG_CDDA_CDDB_DISCID: * * CDDB disc id in its short form (e.g. 'aa063d0f') */ #define GST_TAG_CDDA_CDDB_DISCID "discid" /** * GST_TAG_CDDA_CDDB_DISCID_FULL: * * CDDB disc id including all details */ #define GST_TAG_CDDA_CDDB_DISCID_FULL "discid-full" /** * GST_TAG_CDDA_MUSICBRAINZ_DISCID: * * Musicbrainz disc id (e.g. 'ahg7JUcfR3vCYBphSDIogOOWrr0-') */ #define GST_TAG_CDDA_MUSICBRAINZ_DISCID "musicbrainz-discid" /** * GST_TAG_CDDA_MUSICBRAINZ_DISCID_FULL: * * Musicbrainz disc id details */ #define GST_TAG_CDDA_MUSICBRAINZ_DISCID_FULL "musicbrainz-discid-full" /** * GST_TAG_CAPTURING_SHUTTER_SPEED: * * Shutter speed used when capturing an image, in seconds. (fraction) */ #define GST_TAG_CAPTURING_SHUTTER_SPEED "capturing-shutter-speed" /** * GST_TAG_CAPTURING_FOCAL_RATIO: * * Focal ratio (f-number) used when capturing an image. (double) * * The value stored is the denominator of the focal ratio (f-number). * For example, if this tag value is 2, the focal ratio is f/2. */ #define GST_TAG_CAPTURING_FOCAL_RATIO "capturing-focal-ratio" /** * GST_TAG_CAPTURING_FOCAL_LENGTH: * * Focal length used when capturing an image, in mm. (double) */ #define GST_TAG_CAPTURING_FOCAL_LENGTH "capturing-focal-length" /** * GST_TAG_CAPTURING_FOCAL_LENGTH_35_MM: * * 35 mm equivalent focal length used when capturing an image, in mm. (double) * * Since: 1.10 */ #define GST_TAG_CAPTURING_FOCAL_LENGTH_35_MM "capturing-focal-length-35mm" /** * GST_TAG_CAPTURING_DIGITAL_ZOOM_RATIO: * * Digital zoom ratio used when capturing an image. (double) */ #define GST_TAG_CAPTURING_DIGITAL_ZOOM_RATIO "capturing-digital-zoom-ratio" /** * GST_TAG_CAPTURING_ISO_SPEED: * * ISO speed used when capturing an image. (integer) */ #define GST_TAG_CAPTURING_ISO_SPEED "capturing-iso-speed" /** * GST_TAG_CAPTURING_EXPOSURE_PROGRAM: * * Type of exposure control used when capturing an image. (string) * * The allowed values are: * "undefined" * "manual" * "normal" - automatically controlled * "aperture-priority" - user selects aperture value * "shutter-priority" - user selects shutter speed * "creative" - biased towards depth of field * "action" - biased towards fast shutter speed * "portrait" - closeup, leaving background out of focus * "landscape" - landscape photos, background in focus */ #define GST_TAG_CAPTURING_EXPOSURE_PROGRAM "capturing-exposure-program" /** * GST_TAG_CAPTURING_EXPOSURE_MODE: * * Exposure mode used when capturing an image. (string) * * The allowed values are: * "auto-exposure" * "manual-exposure" * "auto-bracket" */ #define GST_TAG_CAPTURING_EXPOSURE_MODE "capturing-exposure-mode" /** * GST_TAG_CAPTURING_EXPOSURE_COMPENSATION: * * Exposure compensation using when capturing an image in EV. (double) */ #define GST_TAG_CAPTURING_EXPOSURE_COMPENSATION "capturing-exposure-compensation" /** * GST_TAG_CAPTURING_SCENE_CAPTURE_TYPE: * * Scene mode used when capturing an image. (string) * * The allowed values are: * "standard" * "landscape" * "portrait" * "night-scene" */ #define GST_TAG_CAPTURING_SCENE_CAPTURE_TYPE "capturing-scene-capture-type" /** * GST_TAG_CAPTURING_GAIN_ADJUSTMENT: * * Gain adjustment applied to an image. (string) * * The allowed values are: * "none" * "low-gain-up" * "high-gain-up" * "low-gain-down" * "high-gain-down" */ #define GST_TAG_CAPTURING_GAIN_ADJUSTMENT "capturing-gain-adjustment" /** * GST_TAG_CAPTURING_WHITE_BALANCE: * * White balance mode used when capturing an image. (string) * * The allowed values are: * "auto" * "manual" * "daylight" * "cloudy" * "tungsten" * "fluorescent" * "fluorescent h" (newer daylight-calibrated fluorescents) * "flash" */ #define GST_TAG_CAPTURING_WHITE_BALANCE "capturing-white-balance" /** * GST_TAG_CAPTURING_CONTRAST: * * Direction of contrast processing applied when capturing an image. (string) * * The allowed values are: * "normal" * "soft" * "hard" */ #define GST_TAG_CAPTURING_CONTRAST "capturing-contrast" /** * GST_TAG_CAPTURING_SATURATION: * * Direction of saturation processing applied when capturing an image. (string) * * The allowed values are: * "normal" * "low-saturation" * "high-saturation" */ #define GST_TAG_CAPTURING_SATURATION "capturing-saturation" /** * GST_TAG_CAPTURING_SHARPNESS: * * Direction of sharpness processing applied when capturing an image. (string) * * The allowed values are: * "normal" * "soft" * "hard" */ #define GST_TAG_CAPTURING_SHARPNESS "capturing-sharpness" /** * GST_TAG_CAPTURING_FLASH_FIRED: * * If flash was fired during the capture of an image. (boolean) * * Note that if this tag isn't present, it should not be assumed that * the flash did not fire. It should be treated as unknown. */ #define GST_TAG_CAPTURING_FLASH_FIRED "capturing-flash-fired" /** * GST_TAG_CAPTURING_FLASH_MODE: * * The flash mode selected during the capture of an image. (string) * * The allowed values are: * "auto" * "always" * "never" */ #define GST_TAG_CAPTURING_FLASH_MODE "capturing-flash-mode" /** * GST_TAG_CAPTURING_METERING_MODE: * * Defines the way a camera determines the exposure. (string) * * The allowed values are: * "unknown" * "average" * "center-weighted-average" * "spot" * "multi-spot" * "pattern" * "partial" * "other" */ #define GST_TAG_CAPTURING_METERING_MODE "capturing-metering-mode" /** * GST_TAG_CAPTURING_SOURCE: * * Indicates the source of capture. The device/medium used to do the * capture. (string) * * Allowed values are: * "dsc" (= digital still camera) * "transparent-scanner" * "reflex-scanner" * "other" */ #define GST_TAG_CAPTURING_SOURCE "capturing-source" /** * GST_TAG_IMAGE_HORIZONTAL_PPI: * * Media (image/video) intended horizontal pixel density in ppi. (double) */ #define GST_TAG_IMAGE_HORIZONTAL_PPI "image-horizontal-ppi" /** * GST_TAG_IMAGE_VERTICAL_PPI: * * Media (image/video) intended vertical pixel density in ppi. (double) */ #define GST_TAG_IMAGE_VERTICAL_PPI "image-vertical-ppi" /* additional information for image tags */ /** * GstTagImageType: * @GST_TAG_IMAGE_TYPE_NONE : No image type. Can be used to * tell functions such as gst_tag_image_data_to_image_sample() that no * image type should be set. * @GST_TAG_IMAGE_TYPE_UNDEFINED : Undefined/other image type * @GST_TAG_IMAGE_TYPE_FRONT_COVER : Cover (front) * @GST_TAG_IMAGE_TYPE_BACK_COVER : Cover (back) * @GST_TAG_IMAGE_TYPE_LEAFLET_PAGE : Leaflet page * @GST_TAG_IMAGE_TYPE_MEDIUM : Medium (e.g. label side of CD) * @GST_TAG_IMAGE_TYPE_LEAD_ARTIST : Lead artist/lead performer/soloist * @GST_TAG_IMAGE_TYPE_ARTIST : Artist/performer * @GST_TAG_IMAGE_TYPE_CONDUCTOR : Conductor * @GST_TAG_IMAGE_TYPE_BAND_ORCHESTRA : Band/orchestra * @GST_TAG_IMAGE_TYPE_COMPOSER : Composer * @GST_TAG_IMAGE_TYPE_LYRICIST : Lyricist/text writer * @GST_TAG_IMAGE_TYPE_RECORDING_LOCATION : Recording location * @GST_TAG_IMAGE_TYPE_DURING_RECORDING : During recording * @GST_TAG_IMAGE_TYPE_DURING_PERFORMANCE : During performance * @GST_TAG_IMAGE_TYPE_VIDEO_CAPTURE : Movie/video screen capture * @GST_TAG_IMAGE_TYPE_FISH : A fish as funny as the ID3v2 spec * @GST_TAG_IMAGE_TYPE_ILLUSTRATION : Illustration * @GST_TAG_IMAGE_TYPE_BAND_ARTIST_LOGO : Band/artist logotype * @GST_TAG_IMAGE_TYPE_PUBLISHER_STUDIO_LOGO : Publisher/studio logotype * * Type of image contained in an image tag (specified as "image-type" field in * the info structure in the image's #GstSample) */ /* Note: keep in sync with register_tag_image_type_enum() */ typedef enum { GST_TAG_IMAGE_TYPE_NONE = -1, GST_TAG_IMAGE_TYPE_UNDEFINED = 0, GST_TAG_IMAGE_TYPE_FRONT_COVER, GST_TAG_IMAGE_TYPE_BACK_COVER, GST_TAG_IMAGE_TYPE_LEAFLET_PAGE, GST_TAG_IMAGE_TYPE_MEDIUM, GST_TAG_IMAGE_TYPE_LEAD_ARTIST, GST_TAG_IMAGE_TYPE_ARTIST, GST_TAG_IMAGE_TYPE_CONDUCTOR, GST_TAG_IMAGE_TYPE_BAND_ORCHESTRA, GST_TAG_IMAGE_TYPE_COMPOSER, GST_TAG_IMAGE_TYPE_LYRICIST, GST_TAG_IMAGE_TYPE_RECORDING_LOCATION, GST_TAG_IMAGE_TYPE_DURING_RECORDING, GST_TAG_IMAGE_TYPE_DURING_PERFORMANCE, GST_TAG_IMAGE_TYPE_VIDEO_CAPTURE, GST_TAG_IMAGE_TYPE_FISH, GST_TAG_IMAGE_TYPE_ILLUSTRATION, GST_TAG_IMAGE_TYPE_BAND_ARTIST_LOGO, GST_TAG_IMAGE_TYPE_PUBLISHER_STUDIO_LOGO } GstTagImageType; /** * GST_TAG_ID3V2_HEADER_SIZE: * * ID3V2 header size considered minimum input for some functions such as * gst_tag_list_from_id3v2_tag() and gst_tag_get_id3v2_tag_size() for example. */ #define GST_TAG_ID3V2_HEADER_SIZE 10 /* functions for vorbis comment manipulation */ GST_TAG_API const gchar * gst_tag_from_vorbis_tag (const gchar * vorbis_tag); GST_TAG_API const gchar * gst_tag_to_vorbis_tag (const gchar * gst_tag); GST_TAG_API void gst_vorbis_tag_add (GstTagList * list, const gchar * tag, const gchar * value); GST_TAG_API GList * gst_tag_to_vorbis_comments (const GstTagList * list, const gchar * tag); /* functions to convert GstBuffers with vorbiscomment contents to GstTagLists and back */ GST_TAG_API GstTagList * gst_tag_list_from_vorbiscomment (const guint8 * data, gsize size, const guint8 * id_data, const guint id_data_length, gchar ** vendor_string); GST_TAG_API GstTagList * gst_tag_list_from_vorbiscomment_buffer (GstBuffer * buffer, const guint8 * id_data, const guint id_data_length, gchar ** vendor_string); GST_TAG_API GstBuffer * gst_tag_list_to_vorbiscomment_buffer (const GstTagList * list, const guint8 * id_data, const guint id_data_length, const gchar * vendor_string); /* functions for ID3 tag manipulation */ /* FIXME 0.11: inconsistent API naming: gst_tag_list_new_from_id3v1(), gst_tag_list_from_*_buffer(), * gst_tag_list_from_id3v2_tag(). Also, note gst.tag.list_xyz() namespace vs. gst.tag_list_xyz(), * which is a bit confusing and possibly doesn't map too well */ GST_TAG_API guint gst_tag_id3_genre_count (void); GST_TAG_API const gchar * gst_tag_id3_genre_get (const guint id); GST_TAG_API GstTagList * gst_tag_list_new_from_id3v1 (const guint8 * data); GST_TAG_API const gchar * gst_tag_from_id3_tag (const gchar * id3_tag); GST_TAG_API const gchar * gst_tag_from_id3_user_tag (const gchar * type, const gchar * id3_user_tag); GST_TAG_API const gchar * gst_tag_to_id3_tag (const gchar * gst_tag); GST_TAG_API gboolean gst_tag_list_add_id3_image (GstTagList * tag_list, const guint8 * image_data, guint image_data_len, guint id3_picture_type); GST_TAG_API GstTagList * gst_tag_list_from_id3v2_tag (GstBuffer * buffer); GST_TAG_API guint gst_tag_get_id3v2_tag_size (GstBuffer * buffer); /* functions to convert GstBuffers with xmp packets contents to GstTagLists and back */ GST_TAG_API GstTagList * gst_tag_list_from_xmp_buffer (GstBuffer * buffer); GST_TAG_API GstBuffer * gst_tag_list_to_xmp_buffer (const GstTagList * list, gboolean read_only, const gchar ** schemas); GST_TAG_API const gchar** gst_tag_xmp_list_schemas (void); /* functions related to exif */ GST_TAG_API GstBuffer * gst_tag_list_to_exif_buffer (const GstTagList * taglist, gint byte_order, guint32 base_offset); GST_TAG_API GstBuffer * gst_tag_list_to_exif_buffer_with_tiff_header (const GstTagList * taglist); GST_TAG_API GstTagList * gst_tag_list_from_exif_buffer (GstBuffer * buffer, gint byte_order, guint32 base_offset); GST_TAG_API GstTagList * gst_tag_list_from_exif_buffer_with_tiff_header ( GstBuffer * buffer); /* other tag-related functions */ GST_TAG_API gboolean gst_tag_parse_extended_comment (const gchar * ext_comment, gchar ** key, gchar ** lang, gchar ** value, gboolean fail_if_no_key); GST_TAG_API gchar * gst_tag_freeform_string_to_utf8 (const gchar * data, gint size, const gchar ** env_vars); GST_TAG_API GstSample * gst_tag_image_data_to_image_sample (const guint8 * image_data, guint image_data_len, GstTagImageType image_type); /* FIXME 0.11: get rid of this awkward register/init function, see tags.c */ GST_TAG_API void gst_tag_register_musicbrainz_tags (void); /* language tag related functions */ GST_TAG_API gchar ** gst_tag_get_language_codes (void); GST_TAG_API const gchar * gst_tag_get_language_name (const gchar * language_code); GST_TAG_API const gchar * gst_tag_get_language_code_iso_639_1 (const gchar * lang_code); GST_TAG_API const gchar * gst_tag_get_language_code_iso_639_2B (const gchar * lang_code); GST_TAG_API const gchar * gst_tag_get_language_code_iso_639_2T (const gchar * lang_code); GST_TAG_API gboolean gst_tag_check_language_code (const gchar * lang_code); /** * gst_tag_get_language_code: * @lang_code: ISO-639 language code (e.g. "deu" or "ger" or "de") * * Convenience macro wrapping gst_tag_get_language_code_iso_639_1(). */ #define gst_tag_get_language_code(lang_code) \ gst_tag_get_language_code_iso_639_1(lang_code) /* functions to deal with (mostly) Creative Commons licenses */ /** * GstTagLicenseFlags: * @GST_TAG_LICENSE_PERMITS_REPRODUCTION: making multiple copies * is allowed * @GST_TAG_LICENSE_PERMITS_DISTRIBUTION: distribution, public display * and public performance are allowed * @GST_TAG_LICENSE_PERMITS_DERIVATIVE_WORKS: distribution of derivative * works is allowed * @GST_TAG_LICENSE_PERMITS_SHARING: commercial derivatives are allowed, * but only non-commercial distribution is allowed * @GST_TAG_LICENSE_REQUIRES_NOTICE: copyright and license notices * must be kept intact * @GST_TAG_LICENSE_REQUIRES_ATTRIBUTION: credit must be given to * copyright holder and/or author * @GST_TAG_LICENSE_REQUIRES_SHARE_ALIKE: derivative works must be * licensed under the same terms or compatible terms as the original work * @GST_TAG_LICENSE_REQUIRES_SOURCE_CODE: source code (the preferred * form for making modifications) must be provided when exercising some * rights granted by the license * @GST_TAG_LICENSE_REQUIRES_COPYLEFT: derivative and combined works * must be licensed under specified terms, similar to those of the original * work * @GST_TAG_LICENSE_REQUIRES_LESSER_COPYLEFT: derivative works must be * licensed under specified terms, with at least the same conditions as * the original work; combinations with the work may be licensed under * different terms * @GST_TAG_LICENSE_PROHIBITS_COMMERCIAL_USE: exercising rights for * commercial purposes is prohibited * @GST_TAG_LICENSE_PROHIBITS_HIGH_INCOME_NATION_USE: use in a * non-developing country is prohibited * @GST_TAG_LICENSE_CREATIVE_COMMONS_LICENSE: this license was created * by the Creative Commons project * @GST_TAG_LICENSE_FREE_SOFTWARE_FOUNDATION_LICENSE: this license was * created by the Free Software Foundation (FSF) * * See http://creativecommons.org/ns for more information. */ typedef enum { GST_TAG_LICENSE_PERMITS_REPRODUCTION = (1 << 0), GST_TAG_LICENSE_PERMITS_DISTRIBUTION = (1 << 1), GST_TAG_LICENSE_PERMITS_DERIVATIVE_WORKS = (1 << 2), GST_TAG_LICENSE_PERMITS_SHARING = (1 << 3), GST_TAG_LICENSE_REQUIRES_NOTICE = (1 << 8), GST_TAG_LICENSE_REQUIRES_ATTRIBUTION = (1 << 9), GST_TAG_LICENSE_REQUIRES_SHARE_ALIKE = (1 << 10), GST_TAG_LICENSE_REQUIRES_SOURCE_CODE = (1 << 11), GST_TAG_LICENSE_REQUIRES_COPYLEFT = (1 << 12), GST_TAG_LICENSE_REQUIRES_LESSER_COPYLEFT = (1 << 13), GST_TAG_LICENSE_PROHIBITS_COMMERCIAL_USE = (1 << 16), GST_TAG_LICENSE_PROHIBITS_HIGH_INCOME_NATION_USE = (1 << 17), GST_TAG_LICENSE_CREATIVE_COMMONS_LICENSE = (1 << 24), GST_TAG_LICENSE_FREE_SOFTWARE_FOUNDATION_LICENSE = (1 << 25) } GstTagLicenseFlags; GST_TAG_API gchar ** gst_tag_get_licenses (void); GST_TAG_API GstTagLicenseFlags gst_tag_get_license_flags (const gchar * license_ref); GST_TAG_API const gchar * gst_tag_get_license_nick (const gchar * license_ref); GST_TAG_API const gchar * gst_tag_get_license_title (const gchar * license_ref); GST_TAG_API const gchar * gst_tag_get_license_version (const gchar * license_ref); GST_TAG_API const gchar * gst_tag_get_license_description (const gchar * license_ref); GST_TAG_API const gchar * gst_tag_get_license_jurisdiction (const gchar * license_ref); G_END_DECLS #endif /* __GST_TAG_TAG_H__ */