1 /* -*- Mode: C; tab-width: 2; indent-tabs-mode: t; c-basic-offset: 2 -*- */
2 /* Copyright 2005 Jan Schmidt <thaytan@mad.scientist.com>
3 * 2006 Michael Smith <msmith@fluendo.com>
4 * Copyright (C) 2003-2004 Benjamin Otte <otte@gnome.org>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
23 * SECTION:element-icydemux
25 * icydemux accepts data streams with ICY metadata at known intervals, as
26 * transmitted from an upstream element (usually read as response headers from
27 * an HTTP stream). The mime type of the data between the tag blocks is
28 * detected using typefind functions, and the appropriate output mime type set
29 * on outgoing buffers.
32 * <title>Example launch line</title>
34 * gst-launch souphttpsrc location=http://some.server/ iradio-mode=true ! icydemux ! fakesink -t
35 * ]| This pipeline should read any available ICY tag information and output it.
36 * The contents of the stream should be detected, and the appropriate mime
37 * type set on buffers produced from icydemux. (Using gnomevfssrc, neonhttpsrc
38 * or giosrc instead of souphttpsrc should also work.)
45 #include <gst/gst-i18n-plugin.h>
46 #include <gst/tag/tag.h>
48 #include "gsticydemux.h"
52 #define ICY_TYPE_FIND_MAX_SIZE (40*1024)
54 GST_DEBUG_CATEGORY_STATIC (icydemux_debug);
55 #define GST_CAT_DEFAULT (icydemux_debug)
57 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
60 GST_STATIC_CAPS ("application/x-icy, metadata-interval = (int)[0, MAX]")
63 static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
66 GST_STATIC_CAPS ("ANY")
69 static void gst_icydemux_class_init (GstICYDemuxClass * klass);
70 static void gst_icydemux_base_init (GstICYDemuxClass * klass);
71 static void gst_icydemux_init (GstICYDemux * icydemux);
72 static void gst_icydemux_dispose (GObject * object);
74 static GstFlowReturn gst_icydemux_chain (GstPad * pad, GstBuffer * buf);
75 static gboolean gst_icydemux_handle_event (GstPad * pad, GstEvent * event);
77 static gboolean gst_icydemux_add_srcpad (GstICYDemux * icydemux,
79 static gboolean gst_icydemux_remove_srcpad (GstICYDemux * icydemux);
81 static GstStateChangeReturn gst_icydemux_change_state (GstElement * element,
82 GstStateChange transition);
83 static gboolean gst_icydemux_sink_setcaps (GstPad * pad, GstCaps * caps);
85 static gboolean gst_icydemux_send_tag_event (GstICYDemux * icydemux,
86 GstTagList * taglist);
88 static GstElementClass *parent_class = NULL;
91 gst_icydemux_get_type (void)
93 static GType plugin_type = 0;
96 static const GTypeInfo plugin_info = {
97 sizeof (GstICYDemuxClass),
98 (GBaseInitFunc) gst_icydemux_base_init,
100 (GClassInitFunc) gst_icydemux_class_init,
103 sizeof (GstICYDemux),
105 (GInstanceInitFunc) gst_icydemux_init,
107 plugin_type = g_type_register_static (GST_TYPE_ELEMENT,
108 "GstICYDemux", &plugin_info, 0);
114 gst_icydemux_base_init (GstICYDemuxClass * klass)
116 GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
118 gst_element_class_add_static_pad_template (element_class, &src_factory);
119 gst_element_class_add_static_pad_template (element_class, &sink_factory);
120 gst_element_class_set_details_simple (element_class, "ICY tag demuxer",
121 "Codec/Demuxer/Metadata",
122 "Read and output ICY tags while demuxing the contents",
123 "Jan Schmidt <thaytan@mad.scientist.com>, "
124 "Michael Smith <msmith@fluendo.com>");
128 gst_icydemux_class_init (GstICYDemuxClass * klass)
130 GObjectClass *gobject_class;
131 GstElementClass *gstelement_class;
133 gobject_class = (GObjectClass *) klass;
134 gstelement_class = (GstElementClass *) klass;
136 parent_class = g_type_class_ref (GST_TYPE_ELEMENT);
138 gobject_class->dispose = gst_icydemux_dispose;
140 gstelement_class->change_state = gst_icydemux_change_state;
145 gst_icydemux_reset (GstICYDemux * icydemux)
147 /* Unknown at the moment (this is a fatal error if don't have a value by the
148 * time we get to our chain function)
150 icydemux->meta_interval = -1;
151 icydemux->remaining = 0;
153 icydemux->typefinding = TRUE;
155 gst_caps_replace (&(icydemux->src_caps), NULL);
157 gst_icydemux_remove_srcpad (icydemux);
159 if (icydemux->cached_tags) {
160 gst_tag_list_free (icydemux->cached_tags);
161 icydemux->cached_tags = NULL;
164 if (icydemux->cached_events) {
165 g_list_foreach (icydemux->cached_events,
166 (GFunc) gst_mini_object_unref, NULL);
167 g_list_free (icydemux->cached_events);
168 icydemux->cached_events = NULL;
171 if (icydemux->meta_adapter) {
172 gst_adapter_clear (icydemux->meta_adapter);
173 g_object_unref (icydemux->meta_adapter);
174 icydemux->meta_adapter = NULL;
177 if (icydemux->typefind_buf) {
178 gst_buffer_unref (icydemux->typefind_buf);
179 icydemux->typefind_buf = NULL;
182 if (icydemux->content_type) {
183 g_free (icydemux->content_type);
184 icydemux->content_type = NULL;
189 gst_icydemux_init (GstICYDemux * icydemux)
191 GstElementClass *klass = GST_ELEMENT_GET_CLASS (icydemux);
194 gst_pad_new_from_template (gst_element_class_get_pad_template (klass,
196 gst_pad_set_chain_function (icydemux->sinkpad,
197 GST_DEBUG_FUNCPTR (gst_icydemux_chain));
198 gst_pad_set_event_function (icydemux->sinkpad,
199 GST_DEBUG_FUNCPTR (gst_icydemux_handle_event));
200 gst_pad_set_setcaps_function (icydemux->sinkpad,
201 GST_DEBUG_FUNCPTR (gst_icydemux_sink_setcaps));
202 gst_element_add_pad (GST_ELEMENT (icydemux), icydemux->sinkpad);
204 gst_icydemux_reset (icydemux);
208 gst_icydemux_sink_setcaps (GstPad * pad, GstCaps * caps)
210 GstICYDemux *icydemux = GST_ICYDEMUX (GST_PAD_PARENT (pad));
211 GstStructure *structure = gst_caps_get_structure (caps, 0);
214 if (!gst_structure_get_int (structure, "metadata-interval",
215 &icydemux->meta_interval))
218 /* If incoming caps have the HTTP Content-Type, copy that over */
219 if ((tmp = gst_structure_get_string (structure, "content-type")))
220 icydemux->content_type = g_strdup (tmp);
222 /* We have a meta interval, so initialise the rest */
223 icydemux->remaining = icydemux->meta_interval;
224 icydemux->meta_remaining = 0;
229 gst_icydemux_dispose (GObject * object)
231 GstICYDemux *icydemux = GST_ICYDEMUX (object);
233 gst_icydemux_reset (icydemux);
235 G_OBJECT_CLASS (parent_class)->dispose (object);
239 gst_icydemux_add_srcpad (GstICYDemux * icydemux, GstCaps * new_caps)
241 if (icydemux->src_caps == NULL ||
242 !gst_caps_is_equal (new_caps, icydemux->src_caps)) {
243 gst_caps_replace (&(icydemux->src_caps), new_caps);
244 if (icydemux->srcpad != NULL) {
245 GST_DEBUG_OBJECT (icydemux, "Changing src pad caps to %" GST_PTR_FORMAT,
248 gst_pad_set_caps (icydemux->srcpad, icydemux->src_caps);
251 /* Caps never changed */
252 gst_caps_unref (new_caps);
255 if (icydemux->srcpad == NULL) {
257 gst_pad_new_from_template (gst_element_class_get_pad_template
258 (GST_ELEMENT_GET_CLASS (icydemux), "src"), "src");
259 g_return_val_if_fail (icydemux->srcpad != NULL, FALSE);
261 gst_pad_use_fixed_caps (icydemux->srcpad);
263 if (icydemux->src_caps)
264 gst_pad_set_caps (icydemux->srcpad, icydemux->src_caps);
266 GST_DEBUG_OBJECT (icydemux, "Adding src pad with caps %" GST_PTR_FORMAT,
269 gst_pad_set_active (icydemux->srcpad, TRUE);
270 if (!(gst_element_add_pad (GST_ELEMENT (icydemux), icydemux->srcpad)))
272 gst_element_no_more_pads (GST_ELEMENT (icydemux));
279 gst_icydemux_remove_srcpad (GstICYDemux * icydemux)
283 if (icydemux->srcpad != NULL) {
284 res = gst_element_remove_pad (GST_ELEMENT (icydemux), icydemux->srcpad);
285 g_return_val_if_fail (res != FALSE, FALSE);
286 icydemux->srcpad = NULL;
293 gst_icydemux_unicodify (const gchar * str)
295 const gchar *env_vars[] = { "GST_ICY_TAG_ENCODING",
296 "GST_TAG_ENCODING", NULL
299 return gst_tag_freeform_string_to_utf8 (str, -1, env_vars);
302 /* takes ownership of tag list */
304 gst_icydemux_tag_found (GstICYDemux * icydemux, GstTagList * tags)
306 /* send the tag event if we have finished typefinding and have a src pad */
307 if (icydemux->srcpad)
308 return gst_icydemux_send_tag_event (icydemux, tags);
310 /* if we haven't a source pad yet, cache the tags */
311 if (!icydemux->cached_tags) {
312 icydemux->cached_tags = tags;
314 gst_tag_list_insert (icydemux->cached_tags, tags,
315 GST_TAG_MERGE_REPLACE_ALL);
316 gst_tag_list_free (tags);
323 gst_icydemux_parse_and_send_tags (GstICYDemux * icydemux)
331 length = gst_adapter_available (icydemux->meta_adapter);
333 data = gst_adapter_peek (icydemux->meta_adapter, length);
335 /* Now, copy this to a buffer where we can NULL-terminate it to make things
336 * a bit easier, then do that parsing. */
337 buffer = g_strndup ((const gchar *) data, length);
339 tags = gst_tag_list_new ();
340 strings = g_strsplit (buffer, "';", 0);
342 for (i = 0; strings[i]; i++) {
343 if (!g_ascii_strncasecmp (strings[i], "StreamTitle=", 12)) {
344 char *title = gst_icydemux_unicodify (strings[i] + 13);
346 if (title && *title) {
347 gst_tag_list_add (tags, GST_TAG_MERGE_REPLACE, GST_TAG_TITLE,
351 } else if (!g_ascii_strncasecmp (strings[i], "StreamUrl=", 10)) {
352 char *url = gst_icydemux_unicodify (strings[i] + 11);
355 gst_tag_list_add (tags, GST_TAG_MERGE_REPLACE, GST_TAG_HOMEPAGE,
362 g_strfreev (strings);
364 gst_adapter_clear (icydemux->meta_adapter);
366 if (!gst_tag_list_is_empty (tags))
367 gst_icydemux_tag_found (icydemux, tags);
369 gst_tag_list_free (tags);
373 gst_icydemux_handle_event (GstPad * pad, GstEvent * event)
375 GstICYDemux *icydemux = GST_ICYDEMUX (GST_PAD_PARENT (pad));
378 if (GST_EVENT_TYPE (event) == GST_EVENT_TAG) {
381 gst_event_parse_tag (event, &tags);
382 result = gst_icydemux_tag_found (icydemux, gst_tag_list_copy (tags));
383 gst_event_unref (event);
387 if (icydemux->typefinding) {
388 switch (GST_EVENT_TYPE (event)) {
389 case GST_EVENT_FLUSH_STOP:
390 g_list_foreach (icydemux->cached_events,
391 (GFunc) gst_mini_object_unref, NULL);
392 g_list_free (icydemux->cached_events);
393 icydemux->cached_events = NULL;
395 return gst_pad_event_default (pad, event);
397 icydemux->cached_events = g_list_append (icydemux->cached_events,
402 return gst_pad_event_default (pad, event);
407 gst_icydemux_send_cached_events (GstICYDemux * icydemux)
411 for (l = icydemux->cached_events; l != NULL; l = l->next) {
412 GstEvent *event = GST_EVENT (l->data);
414 gst_pad_push_event (icydemux->srcpad, event);
416 g_list_free (icydemux->cached_events);
417 icydemux->cached_events = NULL;
421 gst_icydemux_typefind_or_forward (GstICYDemux * icydemux, GstBuffer * buf)
423 if (icydemux->typefinding) {
425 GstCaps *caps = NULL;
426 GstTypeFindProbability prob;
428 /* If we have a content-type from upstream, let's see if we can shortcut
430 if (G_UNLIKELY (icydemux->content_type)) {
431 if (!g_ascii_strcasecmp (icydemux->content_type, "video/nsv")) {
432 GST_DEBUG ("We have a NSV stream");
433 caps = gst_caps_new_simple ("video/x-nsv", NULL);
435 GST_DEBUG ("Upstream Content-Type isn't supported");
436 g_free (icydemux->content_type);
437 icydemux->content_type = NULL;
441 if (icydemux->typefind_buf) {
442 icydemux->typefind_buf = gst_buffer_join (icydemux->typefind_buf, buf);
444 icydemux->typefind_buf = buf;
447 /* Only typefind if we haven't already got some caps */
449 caps = gst_type_find_helper_for_buffer (GST_OBJECT (icydemux),
450 icydemux->typefind_buf, &prob);
453 if (GST_BUFFER_SIZE (icydemux->typefind_buf) < ICY_TYPE_FIND_MAX_SIZE) {
454 /* Just break for more data */
458 /* We failed typefind */
459 GST_ELEMENT_ERROR (icydemux, STREAM, TYPE_NOT_FOUND, (NULL),
460 ("No caps found for contents within an ICY stream"));
461 gst_buffer_unref (icydemux->typefind_buf);
462 icydemux->typefind_buf = NULL;
463 return GST_FLOW_ERROR;
467 if (!gst_icydemux_add_srcpad (icydemux, caps)) {
468 GST_DEBUG_OBJECT (icydemux, "Failed to add srcpad");
469 gst_caps_unref (caps);
470 gst_buffer_unref (icydemux->typefind_buf);
471 icydemux->typefind_buf = NULL;
472 return GST_FLOW_ERROR;
474 gst_caps_unref (caps);
476 if (icydemux->cached_events) {
477 gst_icydemux_send_cached_events (icydemux);
480 if (icydemux->cached_tags) {
481 gst_icydemux_send_tag_event (icydemux, icydemux->cached_tags);
482 icydemux->cached_tags = NULL;
485 /* Move onto streaming: call ourselves recursively with the typefind buffer
486 * to get that forwarded. */
487 icydemux->typefinding = FALSE;
489 tf_buf = icydemux->typefind_buf;
490 icydemux->typefind_buf = NULL;
491 return gst_icydemux_typefind_or_forward (icydemux, tf_buf);
493 if (G_UNLIKELY (icydemux->srcpad == NULL)) {
494 gst_buffer_unref (buf);
495 return GST_FLOW_ERROR;
498 buf = gst_buffer_make_metadata_writable (buf);
499 gst_buffer_set_caps (buf, icydemux->src_caps);
501 /* Most things don't care, and it's a pain to track (we should preserve a
502 * 0 offset on the first buffer though if it's there, for id3demux etc.) */
503 if (GST_BUFFER_OFFSET (buf) != 0) {
504 GST_BUFFER_OFFSET (buf) = GST_BUFFER_OFFSET_NONE;
507 return gst_pad_push (icydemux->srcpad, buf);
512 gst_icydemux_add_meta (GstICYDemux * icydemux, GstBuffer * buf)
514 if (!icydemux->meta_adapter)
515 icydemux->meta_adapter = gst_adapter_new ();
517 gst_adapter_push (icydemux->meta_adapter, buf);
521 gst_icydemux_chain (GstPad * pad, GstBuffer * buf)
523 GstICYDemux *icydemux;
524 guint size, chunk, offset;
526 GstFlowReturn ret = GST_FLOW_OK;
528 icydemux = GST_ICYDEMUX (GST_PAD_PARENT (pad));
530 if (G_UNLIKELY (icydemux->meta_interval < 0))
533 if (icydemux->meta_interval == 0) {
534 ret = gst_icydemux_typefind_or_forward (icydemux, buf);
538 /* Go through the buffer, chopping it into appropriate chunks. Forward as
539 * tags or buffers, as appropriate
541 size = GST_BUFFER_SIZE (buf);
544 if (icydemux->remaining) {
545 chunk = (size <= icydemux->remaining) ? size : icydemux->remaining;
546 sub = gst_buffer_create_sub (buf, offset, chunk);
548 icydemux->remaining -= chunk;
551 /* This buffer goes onto typefinding, and/or directly pushed out */
552 ret = gst_icydemux_typefind_or_forward (icydemux, sub);
553 if (ret != GST_FLOW_OK)
555 } else if (icydemux->meta_remaining) {
556 chunk = (size <= icydemux->meta_remaining) ?
557 size : icydemux->meta_remaining;
558 sub = gst_buffer_create_sub (buf, offset, chunk);
559 gst_icydemux_add_meta (icydemux, sub);
562 icydemux->meta_remaining -= chunk;
565 if (icydemux->meta_remaining == 0) {
566 /* Parse tags from meta_adapter, send off as tag messages */
567 GST_DEBUG_OBJECT (icydemux, "No remaining metadata, parsing for tags");
568 gst_icydemux_parse_and_send_tags (icydemux);
570 icydemux->remaining = icydemux->meta_interval;
573 /* We need to read a single byte (always safe at this point in the loop)
574 * to figure out how many bytes of metadata exist.
575 * The 'spec' tells us to read 16 * (byte_value) bytes of metadata after
576 * this (zero is common, and means the metadata hasn't changed).
578 icydemux->meta_remaining = 16 * GST_BUFFER_DATA (buf)[offset];
579 if (icydemux->meta_remaining == 0)
580 icydemux->remaining = icydemux->meta_interval;
588 gst_buffer_unref (buf);
595 GST_WARNING_OBJECT (icydemux, "meta_interval not set, buffer probably had "
596 "no caps set. Try enabling iradio-mode on the http source element");
597 gst_buffer_unref (buf);
598 return GST_FLOW_NOT_NEGOTIATED;
602 static GstStateChangeReturn
603 gst_icydemux_change_state (GstElement * element, GstStateChange transition)
605 GstStateChangeReturn ret;
606 GstICYDemux *icydemux = GST_ICYDEMUX (element);
608 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
610 switch (transition) {
611 case GST_STATE_CHANGE_PAUSED_TO_READY:
612 gst_icydemux_reset (icydemux);
620 /* takes ownership of tag list */
622 gst_icydemux_send_tag_event (GstICYDemux * icydemux, GstTagList * tags)
626 gst_element_post_message (GST_ELEMENT (icydemux),
627 gst_message_new_tag (GST_OBJECT (icydemux), gst_tag_list_copy (tags)));
629 event = gst_event_new_tag (tags);
630 GST_EVENT_TIMESTAMP (event) = 0;
632 GST_DEBUG_OBJECT (icydemux, "Sending tag event on src pad");
633 return gst_pad_push_event (icydemux->srcpad, event);
638 plugin_init (GstPlugin * plugin)
640 GST_DEBUG_CATEGORY_INIT (icydemux_debug, "icydemux", 0,
641 "GStreamer ICY tag demuxer");
643 return gst_element_register (plugin, "icydemux",
644 GST_RANK_PRIMARY, GST_TYPE_ICYDEMUX);
647 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
650 "Demux ICY tags from a stream",
651 plugin_init, VERSION, GST_LICENSE, GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)