a2f4ef2c95b38cf9c422068b8163e6da5b58897a
[platform/upstream/gst-plugins-good.git] / gst / icydemux / gsticydemux.c
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>
5  *
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.
10  *
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.
15  *
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.
20  */
21
22 /**
23  * SECTION:element-icydemux
24  *
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. 
30  *
31  * <refsect2>
32  * <title>Example launch line</title>
33  * |[
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.)
39  * </refsect2>
40  */
41 #ifdef HAVE_CONFIG_H
42 #include "config.h"
43 #endif
44 #include <gst/gst.h>
45 #include <gst/gst-i18n-plugin.h>
46 #include <gst/tag/tag.h>
47
48 #include "gsticydemux.h"
49
50 #include <string.h>
51
52 #define ICY_TYPE_FIND_MAX_SIZE (40*1024)
53
54 GST_DEBUG_CATEGORY_STATIC (icydemux_debug);
55 #define GST_CAT_DEFAULT (icydemux_debug)
56
57 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
58     GST_PAD_SINK,
59     GST_PAD_ALWAYS,
60     GST_STATIC_CAPS ("application/x-icy, metadata-interval = (int)[0, MAX]")
61     );
62
63 static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
64     GST_PAD_SRC,
65     GST_PAD_SOMETIMES,
66     GST_STATIC_CAPS ("ANY")
67     );
68
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);
73
74 static GstFlowReturn gst_icydemux_chain (GstPad * pad, GstBuffer * buf);
75 static gboolean gst_icydemux_handle_event (GstPad * pad, GstEvent * event);
76
77 static gboolean gst_icydemux_add_srcpad (GstICYDemux * icydemux,
78     GstCaps * new_caps);
79 static gboolean gst_icydemux_remove_srcpad (GstICYDemux * icydemux);
80
81 static GstStateChangeReturn gst_icydemux_change_state (GstElement * element,
82     GstStateChange transition);
83 static gboolean gst_icydemux_sink_setcaps (GstPad * pad, GstCaps * caps);
84
85 static void gst_icydemux_send_tag_event (GstICYDemux * icydemux,
86     GstTagList * taglist);
87
88 static GstElementClass *parent_class = NULL;
89
90 GType
91 gst_icydemux_get_type (void)
92 {
93   static GType plugin_type = 0;
94
95   if (!plugin_type) {
96     static const GTypeInfo plugin_info = {
97       sizeof (GstICYDemuxClass),
98       (GBaseInitFunc) gst_icydemux_base_init,
99       NULL,
100       (GClassInitFunc) gst_icydemux_class_init,
101       NULL,
102       NULL,
103       sizeof (GstICYDemux),
104       0,
105       (GInstanceInitFunc) gst_icydemux_init,
106     };
107     plugin_type = g_type_register_static (GST_TYPE_ELEMENT,
108         "GstICYDemux", &plugin_info, 0);
109   }
110   return plugin_type;
111 }
112
113 static void
114 gst_icydemux_base_init (GstICYDemuxClass * klass)
115 {
116   GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
117
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>");
127 }
128
129 static void
130 gst_icydemux_class_init (GstICYDemuxClass * klass)
131 {
132   GObjectClass *gobject_class;
133   GstElementClass *gstelement_class;
134
135   gobject_class = (GObjectClass *) klass;
136   gstelement_class = (GstElementClass *) klass;
137
138   parent_class = g_type_class_ref (GST_TYPE_ELEMENT);
139
140   gobject_class->dispose = gst_icydemux_dispose;
141
142   gstelement_class->change_state = gst_icydemux_change_state;
143
144 }
145
146 static void
147 gst_icydemux_reset (GstICYDemux * icydemux)
148 {
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)
151    */
152   icydemux->meta_interval = -1;
153   icydemux->remaining = 0;
154
155   icydemux->typefinding = TRUE;
156
157   gst_caps_replace (&(icydemux->src_caps), NULL);
158
159   gst_icydemux_remove_srcpad (icydemux);
160
161   if (icydemux->cached_tags) {
162     gst_tag_list_free (icydemux->cached_tags);
163     icydemux->cached_tags = NULL;
164   }
165
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;
171   }
172
173   if (icydemux->meta_adapter) {
174     gst_adapter_clear (icydemux->meta_adapter);
175     g_object_unref (icydemux->meta_adapter);
176     icydemux->meta_adapter = NULL;
177   }
178
179   if (icydemux->typefind_buf) {
180     gst_buffer_unref (icydemux->typefind_buf);
181     icydemux->typefind_buf = NULL;
182   }
183
184   if (icydemux->content_type) {
185     g_free (icydemux->content_type);
186     icydemux->content_type = NULL;
187   }
188 }
189
190 static void
191 gst_icydemux_init (GstICYDemux * icydemux)
192 {
193   GstElementClass *klass = GST_ELEMENT_GET_CLASS (icydemux);
194
195   icydemux->sinkpad =
196       gst_pad_new_from_template (gst_element_class_get_pad_template (klass,
197           "sink"), "sink");
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);
205
206   gst_icydemux_reset (icydemux);
207 }
208
209 static gboolean
210 gst_icydemux_sink_setcaps (GstPad * pad, GstCaps * caps)
211 {
212   GstICYDemux *icydemux = GST_ICYDEMUX (GST_PAD_PARENT (pad));
213   GstStructure *structure = gst_caps_get_structure (caps, 0);
214   const gchar *tmp;
215
216   if (!gst_structure_get_int (structure, "metadata-interval",
217           &icydemux->meta_interval))
218     return FALSE;
219
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);
223
224   /* We have a meta interval, so initialise the rest */
225   icydemux->remaining = icydemux->meta_interval;
226   icydemux->meta_remaining = 0;
227   return TRUE;
228 }
229
230 static void
231 gst_icydemux_dispose (GObject * object)
232 {
233   GstICYDemux *icydemux = GST_ICYDEMUX (object);
234
235   gst_icydemux_reset (icydemux);
236
237   G_OBJECT_CLASS (parent_class)->dispose (object);
238 }
239
240 static gboolean
241 gst_icydemux_add_srcpad (GstICYDemux * icydemux, GstCaps * new_caps)
242 {
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,
248           icydemux->src_caps);
249
250       gst_pad_set_caps (icydemux->srcpad, icydemux->src_caps);
251     }
252   } else {
253     /* Caps never changed */
254     gst_caps_unref (new_caps);
255   }
256
257   if (icydemux->srcpad == NULL) {
258     icydemux->srcpad =
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);
262
263     gst_pad_use_fixed_caps (icydemux->srcpad);
264
265     if (icydemux->src_caps)
266       gst_pad_set_caps (icydemux->srcpad, icydemux->src_caps);
267
268     GST_DEBUG_OBJECT (icydemux, "Adding src pad with caps %" GST_PTR_FORMAT,
269         icydemux->src_caps);
270
271     gst_pad_set_active (icydemux->srcpad, TRUE);
272     if (!(gst_element_add_pad (GST_ELEMENT (icydemux), icydemux->srcpad)))
273       return FALSE;
274     gst_element_no_more_pads (GST_ELEMENT (icydemux));
275   }
276
277   return TRUE;
278 }
279
280 static gboolean
281 gst_icydemux_remove_srcpad (GstICYDemux * icydemux)
282 {
283   gboolean res = TRUE;
284
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;
289   }
290
291   return res;
292 };
293
294 static gchar *
295 gst_icydemux_unicodify (const gchar * str)
296 {
297   const gchar *env_vars[] = { "GST_ICY_TAG_ENCODING",
298     "GST_TAG_ENCODING", NULL
299   };
300
301   return gst_tag_freeform_string_to_utf8 (str, -1, env_vars);
302 }
303
304 static void
305 gst_icydemux_parse_and_send_tags (GstICYDemux * icydemux)
306 {
307   GstTagList *tags = gst_tag_list_new ();
308   const guint8 *data;
309   int length, i;
310   gchar *buffer;
311   gchar **strings;
312   gboolean found_tag = FALSE;
313
314   length = gst_adapter_available (icydemux->meta_adapter);
315
316   data = gst_adapter_peek (icydemux->meta_adapter, length);
317
318   /* Now, copy this to a buffer where we can NULL-terminate it to make things
319    * a bit easier, then do that parsing. */
320   buffer = g_malloc (length + 1);
321   memcpy (buffer, data, length);
322   buffer[length] = 0;
323
324   strings = g_strsplit (buffer, "';", 0);
325
326   for (i = 0; strings[i]; i++) {
327     if (!g_ascii_strncasecmp (strings[i], "StreamTitle=", 12)) {
328       char *title = gst_icydemux_unicodify (strings[i] + 13);
329
330       if (title && *title) {
331         gst_tag_list_add (tags, GST_TAG_MERGE_REPLACE, GST_TAG_TITLE,
332             title, NULL);
333         g_free (title);
334         found_tag = TRUE;
335       }
336     } else if (!g_ascii_strncasecmp (strings[i], "StreamUrl=", 10)) {
337       char *url = gst_icydemux_unicodify (strings[i] + 11);
338
339       if (url) {
340         /* 
341            gst_tag_list_add (tags, GST_TAG_MERGE_REPLACE, GST_TAG_URL, 
342            url, NULL); 
343            found_tag = TRUE;
344          */
345         g_free (url);
346       }
347     }
348   }
349
350   g_strfreev (strings);
351   g_free (buffer);
352   gst_adapter_clear (icydemux->meta_adapter);
353
354   if (found_tag) {
355     if (icydemux->srcpad) {
356       gst_icydemux_send_tag_event (icydemux, tags);
357     } else {
358       if (!icydemux->cached_tags) {
359         icydemux->cached_tags = gst_tag_list_new ();
360       }
361
362       gst_tag_list_insert (icydemux->cached_tags, tags,
363           GST_TAG_MERGE_REPLACE_ALL);
364     }
365   }
366 }
367
368 static gboolean
369 gst_icydemux_handle_event (GstPad * pad, GstEvent * event)
370 {
371   GstICYDemux *icydemux = GST_ICYDEMUX (GST_PAD_PARENT (pad));
372
373   if (icydemux->typefinding) {
374     switch (GST_EVENT_TYPE (event)) {
375       case GST_EVENT_FLUSH_STOP:
376         g_list_foreach (icydemux->cached_events,
377             (GFunc) gst_mini_object_unref, NULL);
378         g_list_free (icydemux->cached_events);
379         icydemux->cached_events = NULL;
380
381         return gst_pad_event_default (pad, event);
382       default:
383         icydemux->cached_events = g_list_append (icydemux->cached_events,
384             event);
385         return TRUE;
386     }
387   } else {
388     return gst_pad_event_default (pad, event);
389   }
390 }
391
392 static void
393 gst_icydemux_send_cached_events (GstICYDemux * icydemux)
394 {
395   GList *l;
396
397   for (l = icydemux->cached_events; l != NULL; l = l->next) {
398     GstEvent *event = GST_EVENT (l->data);
399
400     gst_pad_push_event (icydemux->srcpad, event);
401   }
402   g_list_free (icydemux->cached_events);
403   icydemux->cached_events = NULL;
404 }
405
406 static GstFlowReturn
407 gst_icydemux_typefind_or_forward (GstICYDemux * icydemux, GstBuffer * buf)
408 {
409   if (icydemux->typefinding) {
410     GstBuffer *tf_buf;
411     GstCaps *caps = NULL;
412     GstTypeFindProbability prob;
413
414     /* If we have a content-type from upstream, let's see if we can shortcut
415      * typefinding */
416     if (G_UNLIKELY (icydemux->content_type)) {
417       if (!g_ascii_strcasecmp (icydemux->content_type, "video/nsv")) {
418         GST_DEBUG ("We have a NSV stream");
419         caps = gst_caps_new_simple ("video/x-nsv", NULL);
420       } else {
421         GST_DEBUG ("Upstream Content-Type isn't supported");
422         g_free (icydemux->content_type);
423         icydemux->content_type = NULL;
424       }
425     }
426
427     if (icydemux->typefind_buf) {
428       icydemux->typefind_buf = gst_buffer_join (icydemux->typefind_buf, buf);
429     } else {
430       icydemux->typefind_buf = buf;
431     }
432
433     /* Only typefind if we haven't already got some caps */
434     if (caps == NULL) {
435       caps = gst_type_find_helper_for_buffer (GST_OBJECT (icydemux),
436           icydemux->typefind_buf, &prob);
437
438       if (caps == NULL) {
439         if (GST_BUFFER_SIZE (icydemux->typefind_buf) < ICY_TYPE_FIND_MAX_SIZE) {
440           /* Just break for more data */
441           return GST_FLOW_OK;
442         }
443
444         /* We failed typefind */
445         GST_ELEMENT_ERROR (icydemux, STREAM, TYPE_NOT_FOUND, (NULL),
446             ("No caps found for contents within an ICY stream"));
447         gst_buffer_unref (icydemux->typefind_buf);
448         icydemux->typefind_buf = NULL;
449         return GST_FLOW_ERROR;
450       }
451     }
452
453     if (!gst_icydemux_add_srcpad (icydemux, caps)) {
454       GST_DEBUG_OBJECT (icydemux, "Failed to add srcpad");
455       gst_caps_unref (caps);
456       gst_buffer_unref (icydemux->typefind_buf);
457       icydemux->typefind_buf = NULL;
458       return GST_FLOW_ERROR;
459     }
460     gst_caps_unref (caps);
461
462     if (icydemux->cached_events) {
463       gst_icydemux_send_cached_events (icydemux);
464     }
465
466     if (icydemux->cached_tags) {
467       gst_icydemux_send_tag_event (icydemux, icydemux->cached_tags);
468       icydemux->cached_tags = NULL;
469     }
470
471     /* Move onto streaming: call ourselves recursively with the typefind buffer
472      * to get that forwarded. */
473     icydemux->typefinding = FALSE;
474
475     tf_buf = icydemux->typefind_buf;
476     icydemux->typefind_buf = NULL;
477     return gst_icydemux_typefind_or_forward (icydemux, tf_buf);
478   } else {
479     if (G_UNLIKELY (icydemux->srcpad == NULL)) {
480       gst_buffer_unref (buf);
481       return GST_FLOW_ERROR;
482     }
483
484     buf = gst_buffer_make_metadata_writable (buf);
485     gst_buffer_set_caps (buf, icydemux->src_caps);
486
487     /* Most things don't care, and it's a pain to track (we should preserve a
488      * 0 offset on the first buffer though if it's there, for id3demux etc.) */
489     if (GST_BUFFER_OFFSET (buf) != 0) {
490       GST_BUFFER_OFFSET (buf) = GST_BUFFER_OFFSET_NONE;
491     }
492
493     return gst_pad_push (icydemux->srcpad, buf);
494   }
495 }
496
497 static void
498 gst_icydemux_add_meta (GstICYDemux * icydemux, GstBuffer * buf)
499 {
500   if (!icydemux->meta_adapter)
501     icydemux->meta_adapter = gst_adapter_new ();
502
503   gst_adapter_push (icydemux->meta_adapter, buf);
504 }
505
506 static GstFlowReturn
507 gst_icydemux_chain (GstPad * pad, GstBuffer * buf)
508 {
509   GstICYDemux *icydemux;
510   guint size, chunk, offset;
511   GstBuffer *sub;
512   GstFlowReturn ret = GST_FLOW_OK;
513
514   icydemux = GST_ICYDEMUX (GST_PAD_PARENT (pad));
515
516   if (G_UNLIKELY (icydemux->meta_interval < 0))
517     goto not_negotiated;
518
519   if (icydemux->meta_interval == 0) {
520     ret = gst_icydemux_typefind_or_forward (icydemux, buf);
521     goto done;
522   }
523
524   /* Go through the buffer, chopping it into appropriate chunks. Forward as
525    * tags or buffers, as appropriate
526    */
527   size = GST_BUFFER_SIZE (buf);
528   offset = 0;
529   while (size) {
530     if (icydemux->remaining) {
531       chunk = (size <= icydemux->remaining) ? size : icydemux->remaining;
532       sub = gst_buffer_create_sub (buf, offset, chunk);
533       offset += chunk;
534       icydemux->remaining -= chunk;
535       size -= chunk;
536
537       /* This buffer goes onto typefinding, and/or directly pushed out */
538       ret = gst_icydemux_typefind_or_forward (icydemux, sub);
539       if (ret != GST_FLOW_OK)
540         goto done;
541     } else if (icydemux->meta_remaining) {
542       chunk = (size <= icydemux->meta_remaining) ?
543           size : icydemux->meta_remaining;
544       sub = gst_buffer_create_sub (buf, offset, chunk);
545       gst_icydemux_add_meta (icydemux, sub);
546
547       offset += chunk;
548       icydemux->meta_remaining -= chunk;
549       size -= chunk;
550
551       if (icydemux->meta_remaining == 0) {
552         /* Parse tags from meta_adapter, send off as tag messages */
553         GST_DEBUG_OBJECT (icydemux, "No remaining metadata, parsing for tags");
554         gst_icydemux_parse_and_send_tags (icydemux);
555
556         icydemux->remaining = icydemux->meta_interval;
557       }
558     } else {
559       /* We need to read a single byte (always safe at this point in the loop)
560        * to figure out how many bytes of metadata exist. 
561        * The 'spec' tells us to read 16 * (byte_value) bytes of metadata after
562        * this (zero is common, and means the metadata hasn't changed).
563        */
564       icydemux->meta_remaining = 16 * GST_BUFFER_DATA (buf)[offset];
565       if (icydemux->meta_remaining == 0)
566         icydemux->remaining = icydemux->meta_interval;
567
568       offset += 1;
569       size -= 1;
570     }
571   }
572
573 done:
574   gst_buffer_unref (buf);
575
576   return ret;
577
578   /* ERRORS */
579 not_negotiated:
580   {
581     GST_WARNING_OBJECT (icydemux, "meta_interval not set, buffer probably had "
582         "no caps set. Try enabling iradio-mode on the http source element");
583     gst_buffer_unref (buf);
584     return GST_FLOW_NOT_NEGOTIATED;
585   }
586 }
587
588 static GstStateChangeReturn
589 gst_icydemux_change_state (GstElement * element, GstStateChange transition)
590 {
591   GstStateChangeReturn ret;
592   GstICYDemux *icydemux = GST_ICYDEMUX (element);
593
594   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
595
596   switch (transition) {
597     case GST_STATE_CHANGE_PAUSED_TO_READY:
598       gst_icydemux_reset (icydemux);
599       break;
600     default:
601       break;
602   }
603   return ret;
604 }
605
606 static void
607 gst_icydemux_send_tag_event (GstICYDemux * icydemux, GstTagList * tags)
608 {
609   GstEvent *event;
610
611   gst_element_post_message (GST_ELEMENT (icydemux),
612       gst_message_new_tag (GST_OBJECT (icydemux), gst_tag_list_copy (tags)));
613
614   event = gst_event_new_tag (tags);
615   GST_EVENT_TIMESTAMP (event) = 0;
616
617   GST_DEBUG_OBJECT (icydemux, "Sending tag event on src pad");
618   gst_pad_push_event (icydemux->srcpad, event);
619
620 }
621
622 static gboolean
623 plugin_init (GstPlugin * plugin)
624 {
625   GST_DEBUG_CATEGORY_INIT (icydemux_debug, "icydemux", 0,
626       "GStreamer ICY tag demuxer");
627
628   return gst_element_register (plugin, "icydemux",
629       GST_RANK_PRIMARY, GST_TYPE_ICYDEMUX);
630 }
631
632 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
633     GST_VERSION_MINOR,
634     "icydemux",
635     "Demux ICY tags from a stream",
636     plugin_init, VERSION, GST_LICENSE, GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)