Add libgsttag to the docs.

Original commit message from CVS:
* docs/libs/Makefile.am:
* docs/libs/gst-plugins-base-libs-docs.sgml:
* docs/libs/gst-plugins-base-libs-sections.txt:
* gst-libs/gst/tag/gstid3tag.c: (gst_tag_from_id3_tag):
* gst-libs/gst/tag/gstvorbistag.c:
* gst-libs/gst/tag/tag.h:
* gst-libs/gst/tag/tags.c:
Add libgsttag to the docs.

diff --git a/ChangeLog b/ChangeLog
index 87d2e74..259e984 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,14 @@
+2006-02-05  Tim-Philipp Müller  <tim at centricular dot net>
+
+       * docs/libs/Makefile.am:
+       * docs/libs/gst-plugins-base-libs-docs.sgml:
+       * docs/libs/gst-plugins-base-libs-sections.txt:
+       * gst-libs/gst/tag/gstid3tag.c: (gst_tag_from_id3_tag):
+       * gst-libs/gst/tag/gstvorbistag.c:
+       * gst-libs/gst/tag/tag.h:
+       * gst-libs/gst/tag/tags.c:
+         Add libgsttag to the docs.
+
 2006-02-05  Julien MOUTTE  <julien@moutte.net>
 
        * ext/pango/gsttextoverlay.c: (gst_text_overlay_finalize),

diff --git a/docs/libs/Makefile.am b/docs/libs/Makefile.am
index 6c64e59..c54dbd7 100644 (file)
--- a/docs/libs/Makefile.am
+++ b/docs/libs/Makefile.am
@@ -65,7 +65,8 @@ CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*.c
 SCANOBJ_DEPS = \
        $(top_builddir)/gst-libs/gst/interfaces/libgstinterfaces-@GST_MAJORMINOR@.la \
        $(top_builddir)/gst-libs/gst/audio/libgstaudio-@GST_MAJORMINOR@.la \
-       $(top_builddir)/gst-libs/gst/cdda/libgstcdda-@GST_MAJORMINOR@.la
+       $(top_builddir)/gst-libs/gst/cdda/libgstcdda-@GST_MAJORMINOR@.la \
+       $(top_builddir)/gst-libs/gst/tag/libgsttag-@GST_MAJORMINOR@.la
 
 # Header files to ignore when scanning.
 IGNORE_HFILES = 

diff --git a/docs/libs/gst-plugins-base-libs-docs.sgml b/docs/libs/gst-plugins-base-libs-docs.sgml
index 70bb006..c967827 100644 (file)
--- a/docs/libs/gst-plugins-base-libs-docs.sgml
+++ b/docs/libs/gst-plugins-base-libs-docs.sgml
@@ -13,6 +13,7 @@
 <!ENTITY GstColorBalance SYSTEM "xml/gstcolorbalance.xml">
 <!ENTITY GstMixer SYSTEM "xml/gstmixer.xml">
 <!ENTITY GstRingBuffer SYSTEM "xml/gstringbuffer.xml">
+<!ENTITY GstTag SYSTEM "xml/gsttag.xml">
 <!ENTITY GstTuner SYSTEM "xml/gsttuner.xml">
 <!ENTITY GstXOverlay SYSTEM "xml/gstxoverlay.xml">
 
@@ -67,6 +68,16 @@ This library should be linked to by getting cflags and libs from
     &GstXOverlay;
   </chapter>
 
+  <chapter id="gstreamer-tag">
+    <title>Tag Support Library</title>
+    <para>
+This library should be linked to by getting cflags and libs from
+<filename>gstreamer-plugins-base.pc</filename> and adding
+<filename>-lgsttag-&GST_MAJORMINOR;</filename> to the library flags.
+    </para>
+    &GstTag;
+  </chapter>
+
   <chapter id="gstreamer-cdda">
     <title>CDDA Library</title>
     <para>

diff --git a/docs/libs/gst-plugins-base-libs-sections.txt b/docs/libs/gst-plugins-base-libs-sections.txt
index a979b02..71fc6e8 100644 (file)
--- a/docs/libs/gst-plugins-base-libs-sections.txt
+++ b/docs/libs/gst-plugins-base-libs-sections.txt
@@ -92,6 +92,33 @@ gst_ring_buffer_advance
 </SECTION>
 
 <SECTION>
+<FILE>gsttag</FILE>
+<INCLUDE>gst/tag/tag.h</INCLUDE>
+<SUBSECTION>
+gst_tag_from_vorbis_tag
+gst_tag_to_vorbis_tag
+gst_vorbis_tag_add
+gst_tag_to_vorbis_comments
+<SUBSECTION>
+gst_tag_list_from_vorbiscomment_buffer
+gst_tag_list_to_vorbiscomment_buffer
+<SUBSECTION>
+gst_tag_id3_genre_count
+gst_tag_id3_genre_get
+gst_tag_list_new_from_id3v1
+gst_tag_from_id3_tag
+gst_tag_to_id3_tag
+<SUBSECTION>
+GST_TAG_MUSICBRAINZ_TRACKID
+GST_TAG_MUSICBRAINZ_ARTISTID
+GST_TAG_MUSICBRAINZ_ALBUMID
+GST_TAG_MUSICBRAINZ_ALBUMARTISTID
+GST_TAG_MUSICBRAINZ_TRMID
+GST_TAG_MUSICBRAINZ_SORTNAME
+gst_tag_register_musicbrainz_tags
+</SECTION>
+
+<SECTION>
 <FILE>gsttuner</FILE>
 <INCLUDE>gst/interfaces/tuner.h</INCLUDE>
 GstTuner

diff --git a/gst-libs/gst/tag/gstid3tag.c b/gst-libs/gst/tag/gstid3tag.c
index 419c31a..6ee79b0 100644 (file)
--- a/gst-libs/gst/tag/gstid3tag.c
+++ b/gst-libs/gst/tag/gstid3tag.c
@@ -209,11 +209,15 @@ gst_tag_from_id3_tag (const gchar * id3_tag)
 
   while (tag_matches[i].gstreamer_tag != NULL) {
     if (strncmp (id3_tag, tag_matches[i].original_tag, 5) == 0) {
-      break;
+      return tag_matches[i].gstreamer_tag;
     }
     i++;
   }
-  return tag_matches[i].gstreamer_tag;
+
+  GST_INFO ("Cannot map ID3v2 tag '%c%c%c%c' to GStreamer tag",
+      id3_tag[0], id3_tag[1], id3_tag[2], id3_tag[3]);
+
+  return NULL;
 }
 
 /**

diff --git a/gst-libs/gst/tag/gstvorbistag.c b/gst-libs/gst/tag/gstvorbistag.c
index 548d2d2..3866b5a 100644 (file)
--- a/gst-libs/gst/tag/gstvorbistag.c
+++ b/gst-libs/gst/tag/gstvorbistag.c
@@ -222,8 +222,8 @@ gst_vorbis_tag_add (GstTagList * list, const gchar * tag, const gchar * value)
  * @buffer: buffer to convert
  * @id_data: identification data at start of stream
  * @id_data_length: length of identification data
- * @ vendor_string: pointer to a string that should take the vendor string of this
- *                  vorbis comment or NULL if you don't need it.
+ * @vendor_string: pointer to a string that should take the vendor string
+ *                 of this vorbis comment or NULL if you don't need it.
  *
  * Creates a new tag list that contains the information parsed out of a 
  * vorbiscomment packet.
@@ -390,10 +390,10 @@ write_one_tag (const GstTagList * list, const gchar * tag, gpointer user_data)
 
 /**
  * gst_tag_list_to_vorbiscomment_buffer:
- * @buffer: tag list to convert
+ * @list: tag list to convert
  * @id_data: identification data at start of stream
  * @id_data_length: length of identification data
- * @ vendor_string: string that describes the vendor string or NULL
+ * @vendor_string: string that describes the vendor string or NULL
  *
  * Creates a new vorbiscomment buffer from a tag list.
  *

diff --git a/gst-libs/gst/tag/tag.h b/gst-libs/gst/tag/tag.h
index c9e18e6..3276440 100644 (file)
--- a/gst-libs/gst/tag/tag.h
+++ b/gst-libs/gst/tag/tag.h
@@ -92,7 +92,7 @@ guint                   gst_tag_id3_genre_count                 (void);
 G_CONST_RETURN gchar *  gst_tag_id3_genre_get                   (const guint            id);
 GstTagList *            gst_tag_list_new_from_id3v1             (const guint8 *         data);
 
-G_CONST_RETURN gchar *  gst_tag_from_id3_tag                    (const gchar *          vorbis_tag);
+G_CONST_RETURN gchar *  gst_tag_from_id3_tag                    (const gchar *          id3_tag);
 G_CONST_RETURN gchar *  gst_tag_to_id3_tag                      (const gchar *          gst_tag);
 
 void gst_tag_register_musicbrainz_tags (void);

diff --git a/gst-libs/gst/tag/tags.c b/gst-libs/gst/tag/tags.c
index 41d1ad0..c8b32d8 100644 (file)
--- a/gst-libs/gst/tag/tags.c
+++ b/gst-libs/gst/tag/tags.c
@@ -27,6 +27,22 @@
 #include <gst/gst.h>
 #include "tag.h"
 
+/**
+ * SECTION:gsttag
+ * @short_description: Tag Support Library
+ * @see_also: #GstTagList
+ * 
+ * <refsect2>
+ * <para>
+ * Contains additional standardized GStreamer tag definitions and
+ * various utility functions for plugins to parse or create different
+ * types of tags. Also provides mappings from and to other tag identifiers
+ * to the GStreamer tag identifier.
+ * </para>
+ * </refsect2>
+ */
+
+
 static gpointer
 gst_tag_register_musicbrainz_tags_internal (gpointer unused)
 {
@@ -54,6 +70,13 @@ gst_tag_register_musicbrainz_tags_internal (gpointer unused)
   return NULL;
 }
 
+/**
+ * gst_tag_register_musicbrainz_tags
+ *
+ * Registers additional musicbrainz-specific tags with the GStreamer tag
+ * system. Plugins and applications that use these tags should call this
+ * function before using them. Can be called multiple times.
+ */
 void
 gst_tag_register_musicbrainz_tags (void)
 {