/* GStreamer

 * Copyright (C) 2003 Benjamin Otte <in7y118@public.uni-hamburg.de>

 *

 * 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., 59 Temple Place - Suite 330,

 * Boston, MA 02111-1307, USA.

 */

#ifndef __GST_TAG_TAG_H__

#define __GST_TAG_TAG_H__

#include <gst/gst.h>

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_TRMID

 *

 * MusicBrainz track TRM ID

 */

#define GST_TAG_MUSICBRAINZ_TRMID	"musicbrainz-trmid"

/* FIXME 0.11: remove GST_TAG_MUSICBRAINZ_SORTNAME */

#ifndef GST_DISABLE_DEPRECATED

/**

 * GST_TAG_MUSICBRAINZ_SORTNAME

 *

 * MusicBrainz artist sort name

 *

 * Deprecated.  Use GST_TAG_ARTIST_SORTNAME instead.

 */

#define GST_TAG_MUSICBRAINZ_SORTNAME	GST_TAG_ARTIST_SORTNAME

#endif

/**

 * 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"

/* 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"

/* 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_buffer() that no

 *      image type should be set. (Since: 0.10.20)

 * @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 field in

 * the image buffer's caps structure)

 *

 * Since: 0.10.9

 */

/* 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;

#define GST_TYPE_TAG_IMAGE_TYPE  (gst_tag_image_type_get_type ())

/* functions for vorbis comment manipulation */

#ifdef __SYMBIAN32__

IMPORT_C

#endif

G_CONST_RETURN gchar *  gst_tag_from_vorbis_tag                 (const gchar *          vorbis_tag);

#ifdef __SYMBIAN32__

IMPORT_C

#endif

G_CONST_RETURN gchar *  gst_tag_to_vorbis_tag                   (const gchar *          gst_tag);

#ifdef __SYMBIAN32__

IMPORT_C

#endif

void                    gst_vorbis_tag_add                      (GstTagList *           list, 

                                                                 const gchar *          tag, 

                                                                 const gchar *          value);

#ifdef __SYMBIAN32__

IMPORT_C

#endif

GList *                 gst_tag_to_vorbis_comments              (const GstTagList *     list, 

                                                                 const gchar *          tag);

/* functions to convert GstBuffers with vorbiscomment contents to GstTagLists and back */

#ifdef __SYMBIAN32__

IMPORT_C

#endif

GstTagList *            gst_tag_list_from_vorbiscomment_buffer  (const GstBuffer *      buffer,

                                                                 const guint8 *         id_data,

                                                                 const guint            id_data_length,

                                                                 gchar **               vendor_string);

#ifdef __SYMBIAN32__

IMPORT_C

#endif

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 */

#ifdef __SYMBIAN32__

IMPORT_C

#endif

guint                   gst_tag_id3_genre_count                 (void);

#ifdef __SYMBIAN32__

IMPORT_C

#endif

G_CONST_RETURN gchar *  gst_tag_id3_genre_get                   (const guint            id);

#ifdef __SYMBIAN32__

IMPORT_C

#endif

GstTagList *            gst_tag_list_new_from_id3v1             (const guint8 *         data);

#ifdef __SYMBIAN32__

IMPORT_C

#endif

G_CONST_RETURN gchar *  gst_tag_from_id3_tag                    (const gchar *          id3_tag);

#ifdef __SYMBIAN32__

IMPORT_C

#endif

G_CONST_RETURN gchar *  gst_tag_from_id3_user_tag               (const gchar *          type,

                                                                 const gchar *          id3_user_tag);

#ifdef __SYMBIAN32__

IMPORT_C

#endif

G_CONST_RETURN gchar *  gst_tag_to_id3_tag                      (const gchar *          gst_tag);

#ifdef __SYMBIAN32__

IMPORT_C

#endif

gboolean                gst_tag_list_add_id3_image (GstTagList   * tag_list,

                                                    const guint8 * image_data,

                                                    guint          image_data_len,

                                                    guint          id3_picture_type);

/* other tag-related functions */

#ifdef __SYMBIAN32__

IMPORT_C

#endif

gboolean                gst_tag_parse_extended_comment (const gchar  * ext_comment,

                                                        gchar       ** key,

                                                        gchar       ** lang,

                                                        gchar       ** value,

                                                        gboolean       fail_if_no_key);

#ifdef __SYMBIAN32__

IMPORT_C

#endif

gchar                 * gst_tag_freeform_string_to_utf8 (const gchar  * data,

                                                         gint           size,

                                                         const gchar ** env_vars);

#ifdef __SYMBIAN32__

IMPORT_C

#endif

GstBuffer             * gst_tag_image_data_to_image_buffer (const guint8   * image_data,

                                                            guint            image_data_len,

                                                            GstTagImageType  image_type);

/* FIXME 0.11: replace with a more general gst_tag_library_init() */

#ifdef __SYMBIAN32__

IMPORT_C

#endif

void                    gst_tag_register_musicbrainz_tags (void);

G_END_DECLS

#endif /* __GST_TAG_TAG_H__ */