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_pad_template (element_class,
119 gst_static_pad_template_get (&src_factory));
120 gst_element_class_add_pad_template (element_class,
121 gst_static_pad_template_get (&sink_factory));
122 gst_element_class_set_details_simple (element_class, "ICY tag demuxer",
123 "Codec/Demuxer/Metadata",
124 "Read and output ICY tags while demuxing the contents",
125 "Jan Schmidt <thaytan@mad.scientist.com>, "
126 "Michael Smith <msmith@fluendo.com>");
130 gst_icydemux_class_init (GstICYDemuxClass * klass)
132 GObjectClass *gobject_class;
133 GstElementClass *gstelement_class;
135 gobject_class = (GObjectClass *) klass;
136 gstelement_class = (GstElementClass *) klass;
138 parent_class = g_type_class_ref (GST_TYPE_ELEMENT);
140 gobject_class->dispose = gst_icydemux_dispose;
142 gstelement_class->change_state = gst_icydemux_change_state;
147 gst_icydemux_reset (GstICYDemux * icydemux)
149 /* Unknown at the moment (this is a fatal error if don't have a value by the
150 * time we get to our chain function)
152 icydemux->meta_interval = -1;
153 icydemux->remaining = 0;
155 icydemux->typefinding = TRUE;
157 gst_caps_replace (&(icydemux->src_caps), NULL);
159 gst_icydemux_remove_srcpad (icydemux);
161 if (icydemux->cached_tags) {
162 gst_tag_list_free (icydemux->cached_tags);
163 icydemux->cached_tags = NULL;
166 if (icydemux->cached_events) {
167 g_list_foreach (icydemux->cached_events,
168 (GFunc) gst_mini_object_unref, NULL);
169 g_list_free (icydemux->cached_events);
170 icydemux->cached_events = NULL;
173 if (icydemux->meta_adapter) {
174 gst_adapter_clear (icydemux->meta_adapter);
175 g_object_unref (icydemux->meta_adapter);
176 icydemux->meta_adapter = NULL;
179 if (icydemux->typefind_buf) {
180 gst_buffer_unref (icydemux->typefind_buf);
181 icydemux->typefind_buf = NULL;
184 if (icydemux->content_type) {
185 g_free (icydemux->content_type);
186 icydemux->content_type = NULL;
191 gst_icydemux_init (GstICYDemux * icydemux)
193 GstElementClass *klass = GST_ELEMENT_GET_CLASS (icydemux);
196 gst_pad_new_from_template (gst_element_class_get_pad_template (klass,
198 gst_pad_set_chain_function (icydemux->sinkpad,
199 GST_DEBUG_FUNCPTR (gst_icydemux_chain));
200 gst_pad_set_event_function (icydemux->sinkpad,
201 GST_DEBUG_FUNCPTR (gst_icydemux_handle_event));
202 gst_pad_set_setcaps_function (icydemux->sinkpad,
203 GST_DEBUG_FUNCPTR (gst_icydemux_sink_setcaps));
204 gst_element_add_pad (GST_ELEMENT (icydemux), icydemux->sinkpad);
206 gst_icydemux_reset (icydemux);
210 gst_icydemux_sink_setcaps (GstPad * pad, GstCaps * caps)
212 GstICYDemux *icydemux = GST_ICYDEMUX (GST_PAD_PARENT (pad));
213 GstStructure *structure = gst_caps_get_structure (caps, 0);
216 if (!gst_structure_get_int (structure, "metadata-interval",
217 &icydemux->meta_interval))
220 /* If incoming caps have the HTTP Content-Type, copy that over */
221 if ((tmp = gst_structure_get_string (structure, "content-type")))
222 icydemux->content_type = g_strdup (tmp);
224 /* We have a meta interval, so initialise the rest */
225 icydemux->remaining = icydemux->meta_interval;
226 icydemux->meta_remaining = 0;
231 gst_icydemux_dispose (GObject * object)
233 GstICYDemux *icydemux = GST_ICYDEMUX (object);
235 gst_icydemux_reset (icydemux);
237 G_OBJECT_CLASS (parent_class)->dispose (object);
241 gst_icydemux_add_srcpad (GstICYDemux * icydemux, GstCaps * new_caps)
243 if (icydemux->src_caps == NULL ||
244 !gst_caps_is_equal (new_caps, icydemux->src_caps)) {
245 gst_caps_replace (&(icydemux->src_caps), new_caps);
246 if (icydemux->srcpad != NULL) {
247 GST_DEBUG_OBJECT (icydemux, "Changing src pad caps to %" GST_PTR_FORMAT,
250 gst_pad_set_caps (icydemux->srcpad, icydemux->src_caps);
253 /* Caps never changed */
254 gst_caps_unref (new_caps);
257 if (icydemux->srcpad == NULL) {
259 gst_pad_new_from_template (gst_element_class_get_pad_template
260 (GST_ELEMENT_GET_CLASS (icydemux), "src"), "src");
261 g_return_val_if_fail (icydemux->srcpad != NULL, FALSE);
263 gst_pad_use_fixed_caps (icydemux->srcpad);
265 if (icydemux->src_caps)
266 gst_pad_set_caps (icydemux->srcpad, icydemux->src_caps);
268 GST_DEBUG_OBJECT (icydemux, "Adding src pad with caps %" GST_PTR_FORMAT,
271 gst_pad_set_active (icydemux->srcpad, TRUE);
272 if (!(gst_element_add_pad (GST_ELEMENT (icydemux), icydemux->srcpad)))
274 gst_element_no_more_pads (GST_ELEMENT (icydemux));
281 gst_icydemux_remove_srcpad (GstICYDemux * icydemux)
285 if (icydemux->srcpad != NULL) {
286 res = gst_element_remove_pad (GST_ELEMENT (icydemux), icydemux->srcpad);
287 g_return_val_if_fail (res != FALSE, FALSE);
288 icydemux->srcpad = NULL;
295 gst_icydemux_unicodify (const gchar * str)
297 const gchar *env_vars[] = { "GST_ICY_TAG_ENCODING",
298 "GST_TAG_ENCODING", NULL
301 return gst_tag_freeform_string_to_utf8 (str, -1, env_vars);
304 /* takes ownership of tag list */
306 gst_icydemux_tag_found (GstICYDemux * icydemux, GstTagList * tags)
308 /* send the tag event if we have finished typefinding and have a src pad */
309 if (icydemux->srcpad)
310 return gst_icydemux_send_tag_event (icydemux, tags);
312 /* if we haven't a source pad yet, cache the tags */
313 if (!icydemux->cached_tags) {
314 icydemux->cached_tags = tags;
316 gst_tag_list_insert (icydemux->cached_tags, tags,
317 GST_TAG_MERGE_REPLACE_ALL);
318 gst_tag_list_free (tags);
325 gst_icydemux_parse_and_send_tags (GstICYDemux * icydemux)
333 length = gst_adapter_available (icydemux->meta_adapter);
335 data = gst_adapter_peek (icydemux->meta_adapter, length);
337 /* Now, copy this to a buffer where we can NULL-terminate it to make things
338 * a bit easier, then do that parsing. */
339 buffer = g_strndup ((const gchar *) data, length);
341 tags = gst_tag_list_new ();
342 strings = g_strsplit (buffer, "';", 0);
344 for (i = 0; strings[i]; i++) {
345 if (!g_ascii_strncasecmp (strings[i], "StreamTitle=", 12)) {
346 char *title = gst_icydemux_unicodify (strings[i] + 13);
348 if (title && *title) {
349 gst_tag_list_add (tags, GST_TAG_MERGE_REPLACE, GST_TAG_TITLE,
353 } else if (!g_ascii_strncasecmp (strings[i], "StreamUrl=", 10)) {
354 char *url = gst_icydemux_unicodify (strings[i] + 11);
357 gst_tag_list_add (tags, GST_TAG_MERGE_REPLACE, GST_TAG_HOMEPAGE,
364 g_strfreev (strings);
366 gst_adapter_clear (icydemux->meta_adapter);
368 if (!gst_tag_list_is_empty (tags))
369 gst_icydemux_tag_found (icydemux, tags);
371 gst_tag_list_free (tags);
375 gst_icydemux_handle_event (GstPad * pad, GstEvent * event)
377 GstICYDemux *icydemux = GST_ICYDEMUX (GST_PAD_PARENT (pad));
380 if (GST_EVENT_TYPE (event) == GST_EVENT_TAG) {
383 gst_event_parse_tag (event, &tags);
384 result = gst_icydemux_tag_found (icydemux, gst_tag_list_copy (tags));
385 gst_event_unref (event);
389 if (icydemux->typefinding) {
390 switch (GST_EVENT_TYPE (event)) {
391 case GST_EVENT_FLUSH_STOP:
392 g_list_foreach (icydemux->cached_events,
393 (GFunc) gst_mini_object_unref, NULL);
394 g_list_free (icydemux->cached_events);
395 icydemux->cached_events = NULL;
397 return gst_pad_event_default (pad, event);
399 icydemux->cached_events = g_list_append (icydemux->cached_events,
404 return gst_pad_event_default (pad, event);
409 gst_icydemux_send_cached_events (GstICYDemux * icydemux)
413 for (l = icydemux->cached_events; l != NULL; l = l->next) {
414 GstEvent *event = GST_EVENT (l->data);
416 gst_pad_push_event (icydemux->srcpad, event);
418 g_list_free (icydemux->cached_events);
419 icydemux->cached_events = NULL;
423 gst_icydemux_typefind_or_forward (GstICYDemux * icydemux, GstBuffer * buf)
425 if (icydemux->typefinding) {
427 GstCaps *caps = NULL;
428 GstTypeFindProbability prob;
430 /* If we have a content-type from upstream, let's see if we can shortcut
432 if (G_UNLIKELY (icydemux->content_type)) {
433 if (!g_ascii_strcasecmp (icydemux->content_type, "video/nsv")) {
434 GST_DEBUG ("We have a NSV stream");
435 caps = gst_caps_new_simple ("video/x-nsv", NULL);
437 GST_DEBUG ("Upstream Content-Type isn't supported");
438 g_free (icydemux->content_type);
439 icydemux->content_type = NULL;
443 if (icydemux->typefind_buf) {
444 icydemux->typefind_buf = gst_buffer_join (icydemux->typefind_buf, buf);
446 icydemux->typefind_buf = buf;
449 /* Only typefind if we haven't already got some caps */
451 caps = gst_type_find_helper_for_buffer (GST_OBJECT (icydemux),
452 icydemux->typefind_buf, &prob);
455 if (GST_BUFFER_SIZE (icydemux->typefind_buf) < ICY_TYPE_FIND_MAX_SIZE) {
456 /* Just break for more data */
460 /* We failed typefind */
461 GST_ELEMENT_ERROR (icydemux, STREAM, TYPE_NOT_FOUND, (NULL),
462 ("No caps found for contents within an ICY stream"));
463 gst_buffer_unref (icydemux->typefind_buf);
464 icydemux->typefind_buf = NULL;
465 return GST_FLOW_ERROR;
469 if (!gst_icydemux_add_srcpad (icydemux, caps)) {
470 GST_DEBUG_OBJECT (icydemux, "Failed to add srcpad");
471 gst_caps_unref (caps);
472 gst_buffer_unref (icydemux->typefind_buf);
473 icydemux->typefind_buf = NULL;
474 return GST_FLOW_ERROR;
476 gst_caps_unref (caps);
478 if (icydemux->cached_events) {
479 gst_icydemux_send_cached_events (icydemux);
482 if (icydemux->cached_tags) {
483 gst_icydemux_send_tag_event (icydemux, icydemux->cached_tags);
484 icydemux->cached_tags = NULL;
487 /* Move onto streaming: call ourselves recursively with the typefind buffer
488 * to get that forwarded. */
489 icydemux->typefinding = FALSE;
491 tf_buf = icydemux->typefind_buf;
492 icydemux->typefind_buf = NULL;
493 return gst_icydemux_typefind_or_forward (icydemux, tf_buf);
495 if (G_UNLIKELY (icydemux->srcpad == NULL)) {
496 gst_buffer_unref (buf);
497 return GST_FLOW_ERROR;
500 buf = gst_buffer_make_metadata_writable (buf);
501 gst_buffer_set_caps (buf, icydemux->src_caps);
503 /* Most things don't care, and it's a pain to track (we should preserve a
504 * 0 offset on the first buffer though if it's there, for id3demux etc.) */
505 if (GST_BUFFER_OFFSET (buf) != 0) {
506 GST_BUFFER_OFFSET (buf) = GST_BUFFER_OFFSET_NONE;
509 return gst_pad_push (icydemux->srcpad, buf);
514 gst_icydemux_add_meta (GstICYDemux * icydemux, GstBuffer * buf)
516 if (!icydemux->meta_adapter)
517 icydemux->meta_adapter = gst_adapter_new ();
519 gst_adapter_push (icydemux->meta_adapter, buf);
523 gst_icydemux_chain (GstPad * pad, GstBuffer * buf)
525 GstICYDemux *icydemux;
526 guint size, chunk, offset;
528 GstFlowReturn ret = GST_FLOW_OK;
530 icydemux = GST_ICYDEMUX (GST_PAD_PARENT (pad));
532 if (G_UNLIKELY (icydemux->meta_interval < 0))
535 if (icydemux->meta_interval == 0) {
536 ret = gst_icydemux_typefind_or_forward (icydemux, buf);
540 /* Go through the buffer, chopping it into appropriate chunks. Forward as
541 * tags or buffers, as appropriate
543 size = GST_BUFFER_SIZE (buf);
546 if (icydemux->remaining) {
547 chunk = (size <= icydemux->remaining) ? size : icydemux->remaining;
548 sub = gst_buffer_create_sub (buf, offset, chunk);
550 icydemux->remaining -= chunk;
553 /* This buffer goes onto typefinding, and/or directly pushed out */
554 ret = gst_icydemux_typefind_or_forward (icydemux, sub);
555 if (ret != GST_FLOW_OK)
557 } else if (icydemux->meta_remaining) {
558 chunk = (size <= icydemux->meta_remaining) ?
559 size : icydemux->meta_remaining;
560 sub = gst_buffer_create_sub (buf, offset, chunk);
561 gst_icydemux_add_meta (icydemux, sub);
564 icydemux->meta_remaining -= chunk;
567 if (icydemux->meta_remaining == 0) {
568 /* Parse tags from meta_adapter, send off as tag messages */
569 GST_DEBUG_OBJECT (icydemux, "No remaining metadata, parsing for tags");
570 gst_icydemux_parse_and_send_tags (icydemux);
572 icydemux->remaining = icydemux->meta_interval;
575 /* We need to read a single byte (always safe at this point in the loop)
576 * to figure out how many bytes of metadata exist.
577 * The 'spec' tells us to read 16 * (byte_value) bytes of metadata after
578 * this (zero is common, and means the metadata hasn't changed).
580 icydemux->meta_remaining = 16 * GST_BUFFER_DATA (buf)[offset];
581 if (icydemux->meta_remaining == 0)
582 icydemux->remaining = icydemux->meta_interval;
590 gst_buffer_unref (buf);
597 GST_WARNING_OBJECT (icydemux, "meta_interval not set, buffer probably had "
598 "no caps set. Try enabling iradio-mode on the http source element");
599 gst_buffer_unref (buf);
600 return GST_FLOW_NOT_NEGOTIATED;
604 static GstStateChangeReturn
605 gst_icydemux_change_state (GstElement * element, GstStateChange transition)
607 GstStateChangeReturn ret;
608 GstICYDemux *icydemux = GST_ICYDEMUX (element);
610 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
612 switch (transition) {
613 case GST_STATE_CHANGE_PAUSED_TO_READY:
614 gst_icydemux_reset (icydemux);
622 /* takes ownership of tag list */
624 gst_icydemux_send_tag_event (GstICYDemux * icydemux, GstTagList * tags)
628 gst_element_post_message (GST_ELEMENT (icydemux),
629 gst_message_new_tag (GST_OBJECT (icydemux), gst_tag_list_copy (tags)));
631 event = gst_event_new_tag (tags);
632 GST_EVENT_TIMESTAMP (event) = 0;
634 GST_DEBUG_OBJECT (icydemux, "Sending tag event on src pad");
635 return gst_pad_push_event (icydemux->srcpad, event);
640 plugin_init (GstPlugin * plugin)
642 GST_DEBUG_CATEGORY_INIT (icydemux_debug, "icydemux", 0,
643 "GStreamer ICY tag demuxer");
645 return gst_element_register (plugin, "icydemux",
646 GST_RANK_PRIMARY, GST_TYPE_ICYDEMUX);
649 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
652 "Demux ICY tags from a stream",
653 plugin_init, VERSION, GST_LICENSE, GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)