/* GStreamer

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

 *

 * gsttaglist.c: tag support (aka metadata)

 *

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

 */

/**

 * SECTION:gsttaglist

 * @short_description: List of tags and values used to describe media metadata

 *

 * List of tags and values used to describe media metadata.

 *

 */

#ifdef HAVE_CONFIG_H

#  include "config.h"

#endif

#include "gst_private.h"

#include "gst-i18n-lib.h"

#include "gsttaglist.h"

#include "gstinfo.h"

#include "gstvalue.h"

#include "gstbuffer.h"

#include <gobject/gvaluecollector.h>

#include <string.h>

#ifdef __SYMBIAN32__

#include <glib_global.h>

#endif

#define GST_TAG_IS_VALID(tag)           (gst_tag_get_info (tag) != NULL)

/* FIXME 0.11: use GParamSpecs or something similar for tag registrations,

 * possibly even gst_tag_register(). Especially value ranges might be

 * useful for some tags. */

typedef struct

{

  GType type;                   /* type the data is in */

  gchar *nick;                  /* translated name */

  gchar *blurb;                 /* translated description of type */

  GstTagMergeFunc merge_func;   /* functions to merge the values */

  GstTagFlag flag;              /* type of tag */

}

GstTagInfo;

static GMutex *__tag_mutex;

static GHashTable *__tags;

#define TAG_LOCK g_mutex_lock (__tag_mutex)

#define TAG_UNLOCK g_mutex_unlock (__tag_mutex)

#ifdef __SYMBIAN32__

EXPORT_C

#endif

GType

gst_tag_list_get_type (void)

{

  static GType _gst_tag_list_type = 0;

  if (G_UNLIKELY (_gst_tag_list_type == 0)) {

    _gst_tag_list_type = g_boxed_type_register_static ("GstTagList",

        (GBoxedCopyFunc) gst_tag_list_copy, (GBoxedFreeFunc) gst_tag_list_free);

#if 0

    g_value_register_transform_func (_gst_tag_list_type, G_TYPE_STRING,

        _gst_structure_transform_to_string);

#endif

  }

  return _gst_tag_list_type;

}

#ifdef __SYMBIAN32__

EXPORT_C

#endif

void

_gst_tag_initialize (void)

{

  __tag_mutex = g_mutex_new ();

  __tags = g_hash_table_new (g_direct_hash, g_direct_equal);

  gst_tag_register (GST_TAG_TITLE, GST_TAG_FLAG_META,

      G_TYPE_STRING,

      _("title"), _("commonly used title"), gst_tag_merge_strings_with_comma);

  gst_tag_register (GST_TAG_TITLE_SORTNAME, GST_TAG_FLAG_META,

      G_TYPE_STRING,

      _("title sortname"), _("commonly used title for sorting purposes"), NULL);

  gst_tag_register (GST_TAG_ARTIST, GST_TAG_FLAG_META,

      G_TYPE_STRING,

      _("artist"),

      _("person(s) responsible for the recording"),

      gst_tag_merge_strings_with_comma);

  gst_tag_register (GST_TAG_ARTIST_SORTNAME, GST_TAG_FLAG_META,

      G_TYPE_STRING,

      _("artist sortname"),

      _("person(s) responsible for the recording for sorting purposes"), NULL);

  gst_tag_register (GST_TAG_ALBUM, GST_TAG_FLAG_META,

      G_TYPE_STRING,

      _("album"),

      _("album containing this data"), gst_tag_merge_strings_with_comma);

  gst_tag_register (GST_TAG_ALBUM_SORTNAME, GST_TAG_FLAG_META,

      G_TYPE_STRING,

      _("album sortname"),

      _("album containing this data for sorting purposes"), NULL);

  gst_tag_register (GST_TAG_DATE, GST_TAG_FLAG_META, GST_TYPE_DATE,

      _("date"), _("date the data was created (as a GDate structure)"), NULL);

  gst_tag_register (GST_TAG_GENRE, GST_TAG_FLAG_META,

      G_TYPE_STRING,

      _("genre"),

      _("genre this data belongs to"), gst_tag_merge_strings_with_comma);

  gst_tag_register (GST_TAG_COMMENT, GST_TAG_FLAG_META,

      G_TYPE_STRING,

      _("comment"),

      _("free text commenting the data"), gst_tag_merge_use_first);

  gst_tag_register (GST_TAG_EXTENDED_COMMENT, GST_TAG_FLAG_META,

      G_TYPE_STRING,

      _("extended comment"),

      _("free text commenting the data in key=value or key[en]=comment form"),

      gst_tag_merge_use_first);

  gst_tag_register (GST_TAG_TRACK_NUMBER, GST_TAG_FLAG_META,

      G_TYPE_UINT,

      _("track number"),

      _("track number inside a collection"), gst_tag_merge_use_first);

  gst_tag_register (GST_TAG_TRACK_COUNT, GST_TAG_FLAG_META,

      G_TYPE_UINT,

      _("track count"),

      _("count of tracks inside collection this track belongs to"),

      gst_tag_merge_use_first);

  gst_tag_register (GST_TAG_ALBUM_VOLUME_NUMBER, GST_TAG_FLAG_META,

      G_TYPE_UINT,

      _("disc number"),

      _("disc number inside a collection"), gst_tag_merge_use_first);

  gst_tag_register (GST_TAG_ALBUM_VOLUME_COUNT, GST_TAG_FLAG_META,

      G_TYPE_UINT,

      _("disc count"),

      _("count of discs inside collection this disc belongs to"),

      gst_tag_merge_use_first);

  gst_tag_register (GST_TAG_LOCATION, GST_TAG_FLAG_META,

      G_TYPE_STRING,

      _("location"),

      gst_tag_merge_strings_with_comma);

      G_TYPE_STRING,

      gst_tag_merge_strings_with_comma);

      _

      ("International Standard Recording Code - see http://www.ifpi.org/isrc/"),

      NULL);

  gst_tag_register (GST_TAG_ORGANIZATION, GST_TAG_FLAG_META, G_TYPE_STRING, _("organization"), _("organization"),       /* FIXME */

      gst_tag_merge_strings_with_comma);

  gst_tag_register (GST_TAG_COPYRIGHT, GST_TAG_FLAG_META,

      G_TYPE_STRING, _("copyright"), _("copyright notice of the data"), NULL);

  gst_tag_register (GST_TAG_COPYRIGHT_URI, GST_TAG_FLAG_META,

      G_TYPE_STRING, _("copyright uri"),

      _("URI to the copyright notice of the data"), NULL);

  gst_tag_register (GST_TAG_CONTACT, GST_TAG_FLAG_META,

      G_TYPE_STRING,

      _("contact"), _("contact information"), gst_tag_merge_strings_with_comma);

  gst_tag_register (GST_TAG_LICENSE, GST_TAG_FLAG_META,

      G_TYPE_STRING, _("license"), _("license of data"), NULL);

  gst_tag_register (GST_TAG_LICENSE_URI, GST_TAG_FLAG_META,

      G_TYPE_STRING, _("license uri"),

      _("URI to the license of the data"), NULL);

  gst_tag_register (GST_TAG_PERFORMER, GST_TAG_FLAG_META,

      G_TYPE_STRING,

      _("performer"),

      _("person(s) performing"), gst_tag_merge_strings_with_comma);

  gst_tag_register (GST_TAG_COMPOSER, GST_TAG_FLAG_META,

      G_TYPE_STRING,

      _("composer"),

      _("person(s) who composed the recording"),

      gst_tag_merge_strings_with_comma);

  gst_tag_register (GST_TAG_DURATION, GST_TAG_FLAG_DECODED,

      G_TYPE_UINT64,

      _("duration"), _("length in GStreamer time units (nanoseconds)"), NULL);

  gst_tag_register (GST_TAG_CODEC, GST_TAG_FLAG_ENCODED,

      G_TYPE_STRING,

      _("codec"),

      _("codec the data is stored in"), gst_tag_merge_strings_with_comma);

  gst_tag_register (GST_TAG_VIDEO_CODEC, GST_TAG_FLAG_ENCODED,

      G_TYPE_STRING,

      _("video codec"), _("codec the video data is stored in"), NULL);

  gst_tag_register (GST_TAG_AUDIO_CODEC, GST_TAG_FLAG_ENCODED,

      G_TYPE_STRING,

      _("audio codec"), _("codec the audio data is stored in"), NULL);

  gst_tag_register (GST_TAG_BITRATE, GST_TAG_FLAG_ENCODED,

      G_TYPE_UINT, _("bitrate"), _("exact or average bitrate in bits/s"), NULL);

  gst_tag_register (GST_TAG_NOMINAL_BITRATE, GST_TAG_FLAG_ENCODED,

      G_TYPE_UINT, _("nominal bitrate"), _("nominal bitrate in bits/s"), NULL);

  gst_tag_register (GST_TAG_MINIMUM_BITRATE, GST_TAG_FLAG_ENCODED,

      G_TYPE_UINT, _("minimum bitrate"), _("minimum bitrate in bits/s"), NULL);

  gst_tag_register (GST_TAG_MAXIMUM_BITRATE, GST_TAG_FLAG_ENCODED,

      G_TYPE_UINT, _("maximum bitrate"), _("maximum bitrate in bits/s"), NULL);

  gst_tag_register (GST_TAG_ENCODER, GST_TAG_FLAG_ENCODED,

      G_TYPE_STRING,

      _("encoder"), _("encoder used to encode this stream"), NULL);

  gst_tag_register (GST_TAG_ENCODER_VERSION, GST_TAG_FLAG_ENCODED,

      G_TYPE_UINT,

      _("encoder version"),

      _("version of the encoder used to encode this stream"), NULL);

  gst_tag_register (GST_TAG_SERIAL, GST_TAG_FLAG_ENCODED,

      G_TYPE_UINT, _("serial"), _("serial number of track"), NULL);

  gst_tag_register (GST_TAG_TRACK_GAIN, GST_TAG_FLAG_META,

      G_TYPE_DOUBLE, _("replaygain track gain"), _("track gain in db"), NULL);

  gst_tag_register (GST_TAG_TRACK_PEAK, GST_TAG_FLAG_META,

      G_TYPE_DOUBLE, _("replaygain track peak"), _("peak of the track"), NULL);

  gst_tag_register (GST_TAG_ALBUM_GAIN, GST_TAG_FLAG_META,

      G_TYPE_DOUBLE, _("replaygain album gain"), _("album gain in db"), NULL);

  gst_tag_register (GST_TAG_ALBUM_PEAK, GST_TAG_FLAG_META,

      G_TYPE_DOUBLE, _("replaygain album peak"), _("peak of the album"), NULL);

  gst_tag_register (GST_TAG_REFERENCE_LEVEL, GST_TAG_FLAG_META,

      G_TYPE_DOUBLE, _("replaygain reference level"),

      _("reference level of track and album gain values"), NULL);

  gst_tag_register (GST_TAG_LANGUAGE_CODE, GST_TAG_FLAG_META, G_TYPE_STRING,

      _("language code"),

      _("language code for this stream, conforming to ISO-639-1"), NULL);

  gst_tag_register (GST_TAG_IMAGE, GST_TAG_FLAG_META, GST_TYPE_BUFFER,

      _("image"), _("image related to this stream"), gst_tag_merge_use_first);

  gst_tag_register (GST_TAG_PREVIEW_IMAGE, GST_TAG_FLAG_META, GST_TYPE_BUFFER,

      _("preview image"), _("preview image related to this stream"), NULL);

  gst_tag_register (GST_TAG_BEATS_PER_MINUTE, GST_TAG_FLAG_META, G_TYPE_DOUBLE,

      _("beats per minute"), _("number of beats per minute in audio"), NULL);

}

/**

 * gst_tag_merge_use_first:

 * @dest: uninitialized GValue to store result in

 * @src: GValue to copy from

 *

 * This is a convenience function for the func argument of gst_tag_register().

 * It creates a copy of the first value from the list.

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

void

gst_tag_merge_use_first (GValue * dest, const GValue * src)

{

  const GValue *ret = gst_value_list_get_value (src, 0);

  g_value_init (dest, G_VALUE_TYPE (ret));

  g_value_copy (ret, dest);

}

/**

 * gst_tag_merge_strings_with_comma:

 * @dest: uninitialized GValue to store result in

 * @src: GValue to copy from

 *

 * This is a convenience function for the func argument of gst_tag_register().

 * It concatenates all given strings using a comma. The tag must be registered

 * as a G_TYPE_STRING or this function will fail.

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

void

gst_tag_merge_strings_with_comma (GValue * dest, const GValue * src)

{

  GString *str;

  gint i, count;

  count = gst_value_list_get_size (src);

  str = g_string_new (g_value_get_string (gst_value_list_get_value (src, 0)));

  for (i = 1; i < count; i++) {

    /* seperator between two string */

    str = g_string_append (str, _(", "));

    str =

        g_string_append (str, g_value_get_string (gst_value_list_get_value (src,

                1)));

  }

  g_value_init (dest, G_TYPE_STRING);

  g_string_free (str, FALSE);

}

static GstTagInfo *

gst_tag_lookup (GQuark entry)

{

  GstTagInfo *ret;

  TAG_LOCK;

  ret = g_hash_table_lookup (__tags, GUINT_TO_POINTER (entry));

  TAG_UNLOCK;

  return ret;

}

/**

 * gst_tag_register:

 * @name: the name or identifier string

 * @flag: a flag describing the type of tag info

 * @type: the type this data is in

 * @nick: human-readable name

 * @blurb: a human-readable description about this tag

 * @func: function for merging multiple values of this tag, or NULL

 *

 * Registers a new tag type for the use with GStreamer's type system. If a type

 * with that name is already registered, that one is used.

 * The old registration may have used a different type however. So don't rely

 * on your supplied values.

 *

 * Important: if you do not supply a merge function the implication will be

 * that there can only be one single value for this tag in a tag list and

 * any additional values will silenty be discarded when being added (unless

 * #GST_TAG_MERGE_REPLACE, #GST_TAG_MERGE_REPLACE_ALL, or

 * #GST_TAG_MERGE_PREPEND is used as merge mode, in which case the new

 * value will replace the old one in the list).

 *

 * The merge function will be called from gst_tag_list_copy_value() when

 * it is required that one or more values for a tag be condensed into

 * one single value. This may happen from gst_tag_list_get_string(),

 * gst_tag_list_get_int(), gst_tag_list_get_double() etc. What will happen

 * exactly in that case depends on how the tag was registered and if a

 * merge function was supplied and if so which one.

 *

 * Two default merge functions are provided: gst_tag_merge_use_first() and

 * gst_tag_merge_strings_with_commas().

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

void

gst_tag_register (const gchar * name, GstTagFlag flag, GType type,

    const gchar * nick, const gchar * blurb, GstTagMergeFunc func)

{

  GQuark key;

  GstTagInfo *info;

  g_return_if_fail (name != NULL);

  g_return_if_fail (nick != NULL);

  g_return_if_fail (blurb != NULL);

  g_return_if_fail (type != 0 && type != GST_TYPE_LIST);

  key = g_quark_from_string (name);

  info = gst_tag_lookup (key);

  if (info) {

    g_return_if_fail (info->type == type);

    return;

  }

  info = g_new (GstTagInfo, 1);

  info->flag = flag;

  info->type = type;

  info->nick = g_strdup (nick);

  info->blurb = g_strdup (blurb);

  info->merge_func = func;

  TAG_LOCK;

  g_hash_table_insert (__tags, GUINT_TO_POINTER (key), info);

  TAG_UNLOCK;

}

/**

 * gst_tag_exists:

 * @tag: name of the tag

 *

 * Checks if the given type is already registered.

 *

 * Returns: TRUE if the type is already registered

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

gboolean

gst_tag_exists (const gchar * tag)

{

  g_return_val_if_fail (tag != NULL, FALSE);

  return gst_tag_lookup (g_quark_from_string (tag)) != NULL;

}

/**

 * gst_tag_get_type:

 * @tag: the tag

 *

 * Gets the #GType used for this tag.

 *

 * Returns: the #GType of this tag

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

GType

gst_tag_get_type (const gchar * tag)

{

  GstTagInfo *info;

  g_return_val_if_fail (tag != NULL, 0);

  info = gst_tag_lookup (g_quark_from_string (tag));

  g_return_val_if_fail (info != NULL, 0);

  return info->type;

}

/**

 * gst_tag_get_nick

 * @tag: the tag

 *

 * Returns the human-readable name of this tag, You must not change or free

 * this string.

 *

 * Returns: the human-readable name of this tag

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

const gchar *

gst_tag_get_nick (const gchar * tag)

{

  GstTagInfo *info;

  g_return_val_if_fail (tag != NULL, NULL);

  info = gst_tag_lookup (g_quark_from_string (tag));

  g_return_val_if_fail (info != NULL, NULL);

  return info->nick;

}

/**

 * gst_tag_get_description:

 * @tag: the tag

 *

 * Returns the human-readable description of this tag, You must not change or

 * free this string.

 *

 * Returns: the human-readable description of this tag

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

const gchar *

gst_tag_get_description (const gchar * tag)

{

  GstTagInfo *info;

  g_return_val_if_fail (tag != NULL, NULL);

  info = gst_tag_lookup (g_quark_from_string (tag));

  g_return_val_if_fail (info != NULL, NULL);

  return info->blurb;

}

/**