--- /dev/null
+/*
+ * Copyright (C) 2006 James Livingston <doclivingston@gmail.com>
+ *
+ * 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:element-vorbistag
+ * @see_also: #oggdemux, #oggmux, #vorbisparse, #GstTagSetter
+ * @short_description: retags vorbis streams
+ *
+ * <refsect2>
+ * <para>
+ * The vorbistags element can change the tag contained within a raw
+ * vorbis stream. Specifically, it modifies the comments header packet
+ * of the vorbis stream.
+ * </para>
+ * <para>
+ * The element will also process the stream as the #vorbisparse element does
+ * so it can be used when remuxing an Ogg Vorbis stream, without additional
+ * elements.
+ * </para>
+ * <para>
+ * Applications can set the tags to write using the #GstTagSetter interface.
+ * Tags contained withing the vorbis bitstream will be picked up
+ * automatically (and merged according to the merge mode set via the tag
+ * setter interface).
+ * </para>
+ * <title>Example pipelines</title>
+ * <para>
+ * This element is not useful with gst-launch, because it does not support
+ * setting the tags on a #GstTagSetter interface. Conceptually, the element
+ * will usually be used like:
+ * <programlisting>
+ * gst-launch -v filesrc location=foo.ogg ! oggdemux ! vorbistag ! oggmux ! filesink location=bar.ogg
+ * </programlisting>
+ * </para>
+ * </refsect2>
+ */
+
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <glib.h>
+#include <gst/tag/tag.h>
+#include <gst/gsttagsetter.h>
+
+#include <vorbis/codec.h>
+
+#include "vorbistag.h"
+
+
+GST_DEBUG_CATEGORY_EXTERN (vorbisparse_debug);
+#define GST_CAT_DEFAULT vorbisparse_debug
+
+static void gst_vorbis_tag_base_init (gpointer g_class);
+static void gst_vorbis_tag_class_init (GstVorbisTagClass * klass);
+static void gst_vorbis_tag_init (GstVorbisTag * tagger,
+ GstVorbisTagClass * g_class);
+static GstFlowReturn gst_vorbis_tag_parse_packet (GstVorbisParse * parse,
+ GstBuffer * buffer);
+
+#define _do_init(type) \
+ G_STMT_START{ \
+ static const GInterfaceInfo tag_setter_info = { \
+ NULL, \
+ NULL, \
+ NULL \
+ }; \
+ g_type_add_interface_static (type, GST_TYPE_TAG_SETTER, \
+ &tag_setter_info); \
+ }G_STMT_END
+
+GST_BOILERPLATE_FULL (GstVorbisTag, gst_vorbis_tag, GstVorbisParse,
+ GST_TYPE_VORBIS_PARSE, _do_init);
+
+static GstElementDetails vorbis_tag_details = {
+ "VorbisTag",
+ "Formatter/Metadata",
+ "Retags vorbis streams",
+ "James Livingston <doclivingston@gmail.com>"
+};
+
+
+static void
+gst_vorbis_tag_base_init (gpointer g_class)
+{
+ GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
+
+ gst_element_class_set_details (element_class, &vorbis_tag_details);
+}
+
+static void
+gst_vorbis_tag_class_init (GstVorbisTagClass * klass)
+{
+ GstVorbisParseClass *vorbisparse_class = GST_VORBIS_PARSE_CLASS (klass);
+
+ vorbisparse_class->parse_packet = gst_vorbis_tag_parse_packet;
+}
+
+static void
+gst_vorbis_tag_init (GstVorbisTag * tagger, GstVorbisTagClass * g_class)
+{
+ /* nothing to do */
+}
+
+
+static GstFlowReturn
+gst_vorbis_tag_parse_packet (GstVorbisParse * parse, GstBuffer * buffer)
+{
+ GstTagList *old_tags, *new_tags;
+ const GstTagList *user_tags;
+ GstVorbisTag *tagger;
+ gchar *encoder = NULL;
+ GstBuffer *new_buf;
+
+ /* just pass everything except the comments packet */
+ if (GST_BUFFER_SIZE (buffer) >= 1 && GST_BUFFER_DATA (buffer)[0] != 0x03) {
+ return GST_VORBIS_PARSE_CLASS (parent_class)->parse_packet (parse, buffer);
+ }
+
+ tagger = GST_VORBIS_TAG (parse);
+
+ old_tags =
+ gst_tag_list_from_vorbiscomment_buffer (buffer, (guint8 *) "\003vorbis",
+ 7, &encoder);
+ user_tags = gst_tag_setter_get_tag_list (GST_TAG_SETTER (tagger));
+
+ /* build new tag list */
+ new_tags = gst_tag_list_merge (user_tags, old_tags,
+ gst_tag_setter_get_tag_merge_mode (GST_TAG_SETTER (tagger)));
+ gst_tag_list_free (old_tags);
+
+ new_buf =
+ gst_tag_list_to_vorbiscomment_buffer (new_tags, (guint8 *) "\003vorbis",
+ 7, encoder);
+ gst_buffer_stamp (new_buf, buffer);
+
+ gst_tag_list_free (new_tags);
+ g_free (encoder);
+ gst_buffer_unref (buffer);
+
+ return GST_VORBIS_PARSE_CLASS (parent_class)->parse_packet (parse, new_buf);
+}
--- /dev/null
+/* GStreamer
+ *
+ * unit test for vorbisdec
+ *
+ * Copyright (C) <2005> Thomas Vander Stichele <thomas at apestaart dot org>
+ *
+ * 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.
+ */
+
+#include <unistd.h>
+#include <glib.h>
+
+#include <vorbis/codec.h>
+#include <vorbis/vorbisenc.h>
+
+#include <gst/gsttagsetter.h>
+#include <gst/check/gstcheck.h>
+
+/* a valid first header packet */
+guchar identification_header[30] = {
+ 1, /* packet_type */
+ 'v', 'o', 'r', 'b', 'i', 's',
+ 0, 0, 0, 0, /* vorbis_version */
+ 2, /* audio_channels */
+ 0x44, 0xac, 0, 0, /* sample_rate */
+ 0xff, 0xff, 0xff, 0xff, /* bitrate_maximum */
+ 0x00, 0xee, 0x02, 0x00, /* bitrate_nominal */
+ 0xff, 0xff, 0xff, 0xff, /* bitrate_minimum */
+ 0xb8, /* blocksize_0, blocksize_1 */
+ 0x01 /* framing_flag */
+};
+
+guchar artist_comment_header[] = {
+ 3, /* packet_type */
+ 'v', 'o', 'r', 'b', 'i', 's',
+ 2, 0, 0, 0, /* vendor_length */
+ 'm', 'e',
+ 1, 0, 0, 0, /* user_comment_list_length */
+ 9, 0, 0, 0, /* length comment[0] */
+ 'A', 'R', 'T', 'I', 'S', 'T', '=', 'm', 'e',
+ 0x01, /* framing bit */
+};
+
+guchar title_comment_header[] = {
+ 3, /* packet_type */
+ 'v', 'o', 'r', 'b', 'i', 's',
+ 2, 0, 0, 0, /* vendor_length */
+ 'm', 'e',
+ 1, 0, 0, 0, /* user_comment_list_length */
+ 12, 0, 0, 0, /* length comment[0] */
+ 'T', 'I', 'T', 'L', 'E', '=', 'f', 'o', 'o', 'b', 'a', 'r',
+ 0x01, /* framing bit */
+};
+
+guchar empty_comment_header[] = {
+ 3, /* packet_type */
+ 'v', 'o', 'r', 'b', 'i', 's',
+ 2, 0, 0, 0, /* vendor_length */
+ 'm', 'e',
+ 0, 0, 0, 0, /* user_comment_list_length */
+ 0x01, /* framing bit */
+};
+
+
+static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
+ GST_PAD_SINK,
+ GST_PAD_ALWAYS,
+ GST_STATIC_CAPS_ANY);
+static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
+ GST_PAD_SRC,
+ GST_PAD_ALWAYS,
+ GST_STATIC_CAPS_ANY);
+
+GstPad *mysrcpad, *mysinkpad;
+GAsyncQueue *pending_buffers;
+static gulong id;
+
+
+static GstElement *
+setup_vorbistag (void)
+{
+ GstElement *vorbistag;
+
+ GST_DEBUG ("setup_vorbistag");
+ vorbistag = gst_check_setup_element ("vorbistag");
+ mysrcpad = gst_check_setup_src_pad (vorbistag, &srctemplate, NULL);
+ mysinkpad = gst_check_setup_sink_pad (vorbistag, &sinktemplate, NULL);
+
+ return vorbistag;
+}
+
+static void
+cleanup_vorbistag (GstElement * vorbistag)
+{
+ GST_DEBUG ("cleanup_vorbistag");
+ gst_element_set_state (vorbistag, GST_STATE_NULL);
+
+ gst_check_teardown_src_pad (vorbistag);
+ gst_check_teardown_sink_pad (vorbistag);
+ gst_check_teardown_element (vorbistag);
+}
+
+
+static gboolean
+buffer_probe (GstPad * pad, GstBuffer * buffer, gpointer unused)
+{
+ g_async_queue_push (pending_buffers, gst_buffer_ref (buffer));
+ return TRUE;
+}
+
+static void
+start_pipeline (GstElement * element)
+{
+ id = gst_pad_add_buffer_probe (mysinkpad, G_CALLBACK (buffer_probe), NULL);
+
+ pending_buffers = g_async_queue_new ();
+ gst_element_set_state (element, GST_STATE_PLAYING);
+}
+
+static GstBuffer *
+get_buffer (void)
+{
+ return GST_BUFFER (g_async_queue_pop (pending_buffers));
+}
+
+static void
+stop_pipeline (GstElement * element)
+{
+ GstBuffer *buf;
+
+ while ((buf = g_async_queue_try_pop (pending_buffers)))
+ gst_buffer_unref (buf);
+
+ gst_pad_remove_buffer_probe (mysinkpad, (guint) id);
+ id = 0;
+
+ gst_element_set_state (element, GST_STATE_NULL);
+
+ while ((buf = g_async_queue_try_pop (pending_buffers)))
+ gst_buffer_unref (buf);
+
+ g_async_queue_unref (pending_buffers);
+ pending_buffers = NULL;
+}
+
+vorbis_comment vc;
+vorbis_dsp_state vd;
+vorbis_info vi;
+vorbis_block vb;
+
+static GstBuffer *
+_create_codebook_header_buffer (void)
+{
+ GstBuffer *buffer;
+ ogg_packet header;
+ ogg_packet header_comm;
+ ogg_packet header_code;
+
+ vorbis_info_init (&vi);
+ vorbis_encode_setup_vbr (&vi, 1, 44000, 0.5);
+ vorbis_encode_setup_init (&vi);
+ vorbis_analysis_init (&vd, &vi);
+ vorbis_block_init (&vd, &vb);
+ vorbis_comment_init (&vc);
+ vorbis_analysis_headerout (&vd, &vc, &header, &header_comm, &header_code);
+
+ buffer = gst_buffer_new_and_alloc (header_code.bytes);
+ memcpy (GST_BUFFER_DATA (buffer), header_code.packet, header_code.bytes);
+
+ return buffer;
+}
+
+static GstBuffer *
+_create_audio_buffer (void)
+{
+ GstBuffer *buffer;
+ ogg_packet packet;
+ float **vorbis_buffer;
+
+ vorbis_buffer = vorbis_analysis_buffer (&vd, 0);
+ vorbis_analysis_wrote (&vd, 0);
+ vorbis_analysis_blockout (&vd, &vb);
+ vorbis_analysis (&vb, NULL);
+ vorbis_bitrate_addblock (&vb);
+ vorbis_bitrate_flushpacket (&vd, &packet);
+ buffer = gst_buffer_new_and_alloc (packet.bytes);
+ memcpy (GST_BUFFER_DATA (buffer), packet.packet, packet.bytes);
+
+ vorbis_comment_clear (&vc);
+ vorbis_block_clear (&vb);
+ vorbis_dsp_clear (&vd);
+ vorbis_info_clear (&vi);
+
+ return buffer;
+}
+
+
+GST_START_TEST (test_empty_tags_set)
+{
+ GstTagList *tags;
+ GstElement *vorbistag;
+ GstBuffer *inbuffer, *outbuffer;
+
+ vorbistag = setup_vorbistag ();
+
+ tags = gst_tag_list_new ();
+ gst_tag_list_add (tags, GST_TAG_MERGE_REPLACE, GST_TAG_TITLE, "foobar", NULL);
+ gst_tag_setter_merge_tags (GST_TAG_SETTER (vorbistag), tags,
+ GST_TAG_MERGE_REPLACE);
+ gst_tag_setter_set_tag_merge_mode (GST_TAG_SETTER (vorbistag),
+ GST_TAG_MERGE_KEEP_ALL);
+ gst_tag_list_free (tags);
+
+ start_pipeline (vorbistag);
+
+ /* send identification header */
+ inbuffer = gst_buffer_new_and_alloc (sizeof (identification_header));
+ memcpy (GST_BUFFER_DATA (inbuffer), identification_header,
+ sizeof (identification_header));
+ fail_unless_equals_int (gst_pad_push (mysrcpad, inbuffer), GST_FLOW_OK);
+
+ /* send empty comment buffer */
+ inbuffer = gst_buffer_new_and_alloc (sizeof (empty_comment_header));
+ memcpy (GST_BUFFER_DATA (inbuffer), empty_comment_header,
+ sizeof (empty_comment_header));
+ fail_unless_equals_int (gst_pad_push (mysrcpad, inbuffer), GST_FLOW_OK);
+
+ /* send minimal codebook header and audio packers */
+ inbuffer = _create_codebook_header_buffer ();
+ fail_unless_equals_int (gst_pad_push (mysrcpad, inbuffer), GST_FLOW_OK);
+ inbuffer = _create_audio_buffer ();
+ fail_unless_equals_int (gst_pad_push (mysrcpad, inbuffer), GST_FLOW_OK);
+
+
+ /* check identification header is unchanged */
+ outbuffer = get_buffer ();
+ fail_unless_equals_int (GST_BUFFER_SIZE (outbuffer),
+ sizeof (identification_header));
+ fail_unless_equals_int (memcmp (GST_BUFFER_DATA (outbuffer),
+ identification_header, sizeof (identification_header)), 0);
+ gst_buffer_unref (outbuffer);
+
+ /* check comment header is correct */
+ outbuffer = get_buffer ();
+ fail_unless_equals_int (GST_BUFFER_SIZE (outbuffer),
+ sizeof (title_comment_header));
+ fail_unless_equals_int (memcmp (GST_BUFFER_DATA (outbuffer),
+ title_comment_header, sizeof (title_comment_header)), 0);
+ gst_buffer_unref (outbuffer);
+
+ stop_pipeline (vorbistag);
+ cleanup_vorbistag (vorbistag);
+}
+
+GST_END_TEST;
+
+
+GST_START_TEST (test_filled_tags_unset)
+{
+ GstTagList *tags;
+ GstElement *vorbistag;
+ GstBuffer *inbuffer, *outbuffer;
+
+ vorbistag = setup_vorbistag ();
+
+ tags = gst_tag_list_new ();
+ gst_tag_setter_merge_tags (GST_TAG_SETTER (vorbistag), tags,
+ GST_TAG_MERGE_REPLACE);
+ gst_tag_setter_set_tag_merge_mode (GST_TAG_SETTER (vorbistag),
+ GST_TAG_MERGE_KEEP_ALL);
+ gst_tag_list_free (tags);
+
+ start_pipeline (vorbistag);
+
+ /* send identification header */
+ inbuffer = gst_buffer_new_and_alloc (sizeof (identification_header));
+ memcpy (GST_BUFFER_DATA (inbuffer), identification_header,
+ sizeof (identification_header));
+ fail_unless_equals_int (gst_pad_push (mysrcpad, inbuffer), GST_FLOW_OK);
+
+ /* send empty comment buffer */
+ inbuffer = gst_buffer_new_and_alloc (sizeof (title_comment_header));
+ memcpy (GST_BUFFER_DATA (inbuffer), title_comment_header,
+ sizeof (title_comment_header));
+ fail_unless_equals_int (gst_pad_push (mysrcpad, inbuffer), GST_FLOW_OK);
+
+ /* send minimal codebook header and audio packers */
+ inbuffer = _create_codebook_header_buffer ();
+ fail_unless_equals_int (gst_pad_push (mysrcpad, inbuffer), GST_FLOW_OK);
+ inbuffer = _create_audio_buffer ();
+ fail_unless_equals_int (gst_pad_push (mysrcpad, inbuffer), GST_FLOW_OK);
+
+
+ /* check identification header is unchanged */
+ outbuffer = get_buffer ();
+ fail_unless_equals_int (GST_BUFFER_SIZE (outbuffer),
+ sizeof (identification_header));
+ fail_unless_equals_int (memcmp (GST_BUFFER_DATA (outbuffer),
+ identification_header, sizeof (identification_header)), 0);
+ gst_buffer_unref (outbuffer);
+
+ /* check comment header is correct */
+ outbuffer = get_buffer ();
+ fail_unless_equals_int (GST_BUFFER_SIZE (outbuffer),
+ sizeof (empty_comment_header));
+ fail_unless_equals_int (memcmp (GST_BUFFER_DATA (outbuffer),
+ empty_comment_header, sizeof (empty_comment_header)), 0);
+ gst_buffer_unref (outbuffer);
+
+ stop_pipeline (vorbistag);
+ cleanup_vorbistag (vorbistag);
+}
+
+GST_END_TEST;
+
+
+GST_START_TEST (test_filled_tags_change)
+{
+ GstTagList *tags;
+ GstElement *vorbistag;
+ GstBuffer *inbuffer, *outbuffer;
+
+ vorbistag = setup_vorbistag ();
+
+ tags = gst_tag_list_new ();
+ gst_tag_list_add (tags, GST_TAG_MERGE_REPLACE, GST_TAG_TITLE, "foobar", NULL);
+ gst_tag_setter_merge_tags (GST_TAG_SETTER (vorbistag), tags,
+ GST_TAG_MERGE_REPLACE);
+ gst_tag_setter_set_tag_merge_mode (GST_TAG_SETTER (vorbistag),
+ GST_TAG_MERGE_KEEP_ALL);
+ gst_tag_list_free (tags);
+
+ start_pipeline (vorbistag);
+
+ /* send identification header */
+ inbuffer = gst_buffer_new_and_alloc (sizeof (identification_header));
+ memcpy (GST_BUFFER_DATA (inbuffer), identification_header,
+ sizeof (identification_header));
+ fail_unless_equals_int (gst_pad_push (mysrcpad, inbuffer), GST_FLOW_OK);
+
+ /* send empty comment buffer */
+ inbuffer = gst_buffer_new_and_alloc (sizeof (artist_comment_header));
+ memcpy (GST_BUFFER_DATA (inbuffer), artist_comment_header,
+ sizeof (artist_comment_header));
+ fail_unless_equals_int (gst_pad_push (mysrcpad, inbuffer), GST_FLOW_OK);
+
+ /* send minimal codebook header and audio packers */
+ inbuffer = _create_codebook_header_buffer ();
+ fail_unless_equals_int (gst_pad_push (mysrcpad, inbuffer), GST_FLOW_OK);
+ inbuffer = _create_audio_buffer ();
+ fail_unless_equals_int (gst_pad_push (mysrcpad, inbuffer), GST_FLOW_OK);
+
+
+ /* check identification header is unchanged */
+ outbuffer = get_buffer ();
+ fail_unless_equals_int (GST_BUFFER_SIZE (outbuffer),
+ sizeof (identification_header));
+ fail_unless_equals_int (memcmp (GST_BUFFER_DATA (outbuffer),
+ identification_header, sizeof (identification_header)), 0);
+ gst_buffer_unref (outbuffer);
+
+ /* check comment header is correct */
+ outbuffer = get_buffer ();
+ fail_unless_equals_int (GST_BUFFER_SIZE (outbuffer),
+ sizeof (title_comment_header));
+ fail_unless_equals_int (memcmp (GST_BUFFER_DATA (outbuffer),
+ title_comment_header, sizeof (title_comment_header)), 0);
+ gst_buffer_unref (outbuffer);
+
+ stop_pipeline (vorbistag);
+ cleanup_vorbistag (vorbistag);
+}
+
+GST_END_TEST;
+
+
+
+static Suite *
+vorbistag_suite (void)
+{
+ Suite *s = suite_create ("vorbistag");
+ TCase *tc_chain = tcase_create ("general");
+
+ suite_add_tcase (s, tc_chain);
+ tcase_add_test (tc_chain, test_empty_tags_set);
+ tcase_add_test (tc_chain, test_filled_tags_unset);
+ tcase_add_test (tc_chain, test_filled_tags_change);
+
+ return s;
+}
+
+GST_CHECK_MAIN (vorbistag)
projects / platform / upstream / gstreamer.git / commitdiff