2 * Copyright (C) 2009 Edward Hervey <edward.hervey@collabora.co.uk>
3 * 2009 Nokia Corporation
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
15 * You should have received a copy of the GNU Library General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
22 * SECTION:gstdiscoverer
23 * @short_description: Utility for discovering information on URIs.
25 * The #GstDiscoverer is a utility object which allows to get as much
26 * information as possible from one or many URIs.
28 * It provides two APIs, allowing usage in blocking or non-blocking mode.
30 * The blocking mode just requires calling gst_discoverer_discover_uri()
31 * with the URI one wishes to discover.
33 * The non-blocking mode requires a running #GMainLoop in the default
34 * #GMainContext, where one connects to the various signals, appends the
35 * URIs to be processed (through gst_discoverer_discover_uri_async()) and then
36 * asks for the discovery to begin (through gst_discoverer_start()).
38 * All the information is returned in a #GstDiscovererInfo structure.
48 #include "pbutils-marshal.h"
49 #include "pbutils-private.h"
51 #include "gst/glib-compat-private.h"
53 GST_DEBUG_CATEGORY_STATIC (discoverer_debug);
54 #define GST_CAT_DEFAULT discoverer_debug
56 static GQuark _CAPS_QUARK;
57 static GQuark _TAGS_QUARK;
58 static GQuark _MISSING_PLUGIN_QUARK;
59 static GQuark _STREAM_TOPOLOGY_QUARK;
60 static GQuark _TOPOLOGY_PAD_QUARK;
72 struct _GstDiscovererPrivate
76 /* allowed time to discover each uri in nanoseconds */
79 /* list of pending URI to process (current excluded) */
84 /* TRUE if processing a URI */
87 /* TRUE if discoverer has been started */
91 GstDiscovererInfo *current_info;
92 GError *current_error;
93 GstStructure *current_topology;
95 /* List of private streams */
100 GstElement *uridecodebin;
103 GType decodebin2_type;
105 /* Custom main context variables */
110 /* reusable queries */
111 GstQuery *seeking_query;
113 /* Handler ids for various callbacks */
115 gulong pad_remove_id;
116 gulong element_added_id;
120 #define DISCO_LOCK(dc) g_mutex_lock (dc->priv->lock);
121 #define DISCO_UNLOCK(dc) g_mutex_unlock (dc->priv->lock);
126 GST_DEBUG_CATEGORY_INIT (discoverer_debug, "discoverer", 0, "Discoverer");
128 _CAPS_QUARK = g_quark_from_static_string ("caps");
129 _TAGS_QUARK = g_quark_from_static_string ("tags");
130 _MISSING_PLUGIN_QUARK = g_quark_from_static_string ("missing-plugin");
131 _STREAM_TOPOLOGY_QUARK = g_quark_from_static_string ("stream-topology");
132 _TOPOLOGY_PAD_QUARK = g_quark_from_static_string ("pad");
135 G_DEFINE_TYPE_EXTENDED (GstDiscoverer, gst_discoverer, G_TYPE_OBJECT, 0,
146 #define DEFAULT_PROP_TIMEOUT 15 * GST_SECOND
154 static guint gst_discoverer_signals[LAST_SIGNAL] = { 0 };
156 static void gst_discoverer_set_timeout (GstDiscoverer * dc,
157 GstClockTime timeout);
158 static gboolean async_timeout_cb (GstDiscoverer * dc);
160 static void discoverer_bus_cb (GstBus * bus, GstMessage * msg,
162 static void uridecodebin_pad_added_cb (GstElement * uridecodebin, GstPad * pad,
164 static void uridecodebin_pad_removed_cb (GstElement * uridecodebin,
165 GstPad * pad, GstDiscoverer * dc);
167 static void gst_discoverer_dispose (GObject * dc);
168 static void gst_discoverer_set_property (GObject * object, guint prop_id,
169 const GValue * value, GParamSpec * pspec);
170 static void gst_discoverer_get_property (GObject * object, guint prop_id,
171 GValue * value, GParamSpec * pspec);
174 gst_discoverer_class_init (GstDiscovererClass * klass)
176 GObjectClass *gobject_class = (GObjectClass *) klass;
178 gobject_class->dispose = gst_discoverer_dispose;
180 gobject_class->set_property = gst_discoverer_set_property;
181 gobject_class->get_property = gst_discoverer_get_property;
183 g_type_class_add_private (klass, sizeof (GstDiscovererPrivate));
187 * GstDiscoverer:timeout
189 * The duration (in nanoseconds) after which the discovery of an individual
192 * If the discovery of a URI times out, the %GST_DISCOVERER_TIMEOUT will be
193 * set on the result flags.
195 g_object_class_install_property (gobject_class, PROP_TIMEOUT,
196 g_param_spec_uint64 ("timeout", "timeout", "Timeout",
197 GST_SECOND, 3600 * GST_SECOND, DEFAULT_PROP_TIMEOUT,
198 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
202 * GstDiscoverer::finished:
203 * @discoverer: the #GstDiscoverer
205 * Will be emitted when all pending URIs have been processed.
207 gst_discoverer_signals[SIGNAL_FINISHED] =
208 g_signal_new ("finished", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
209 G_STRUCT_OFFSET (GstDiscovererClass, finished),
210 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0, G_TYPE_NONE);
213 * GstDiscoverer::starting:
214 * @discoverer: the #GstDiscoverer
216 * Will be emitted when the discover starts analyzing the pending URIs
218 gst_discoverer_signals[SIGNAL_STARTING] =
219 g_signal_new ("starting", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
220 G_STRUCT_OFFSET (GstDiscovererClass, starting),
221 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0, G_TYPE_NONE);
224 * GstDiscoverer::discovered:
225 * @discoverer: the #GstDiscoverer
226 * @info: the results #GstDiscovererInfo
227 * @error: (type GLib.Error): #GError, which will be non-NULL if an error
228 * occurred during discovery
230 * Will be emitted when all information on a URI could be discovered.
232 gst_discoverer_signals[SIGNAL_DISCOVERED] =
233 g_signal_new ("discovered", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
234 G_STRUCT_OFFSET (GstDiscovererClass, discovered),
235 NULL, NULL, pbutils_marshal_VOID__POINTER_BOXED,
236 G_TYPE_NONE, 2, GST_TYPE_DISCOVERER_INFO, GST_TYPE_G_ERROR);
240 uridecodebin_element_added_cb (GstElement * uridecodebin,
241 GstElement * child, GstDiscoverer * dc)
243 GST_DEBUG ("New element added to uridecodebin : %s",
244 GST_ELEMENT_NAME (child));
246 if (G_OBJECT_TYPE (child) == dc->priv->decodebin2_type) {
247 g_object_set (child, "post-stream-topology", TRUE, NULL);
252 gst_discoverer_init (GstDiscoverer * dc)
255 GstFormat format = GST_FORMAT_TIME;
257 dc->priv = G_TYPE_INSTANCE_GET_PRIVATE (dc, GST_TYPE_DISCOVERER,
258 GstDiscovererPrivate);
260 dc->priv->timeout = DEFAULT_PROP_TIMEOUT;
261 dc->priv->async = FALSE;
263 dc->priv->lock = g_mutex_new ();
265 GST_LOG ("Creating pipeline");
266 dc->priv->pipeline = (GstBin *) gst_pipeline_new ("Discoverer");
267 GST_LOG_OBJECT (dc, "Creating uridecodebin");
268 dc->priv->uridecodebin =
269 gst_element_factory_make ("uridecodebin", "discoverer-uri");
270 if (G_UNLIKELY (dc->priv->uridecodebin == NULL)) {
271 GST_ERROR ("Can't create uridecodebin");
274 GST_LOG_OBJECT (dc, "Adding uridecodebin to pipeline");
275 gst_bin_add (dc->priv->pipeline, dc->priv->uridecodebin);
277 dc->priv->pad_added_id =
278 g_signal_connect_object (dc->priv->uridecodebin, "pad-added",
279 G_CALLBACK (uridecodebin_pad_added_cb), dc, 0);
280 dc->priv->pad_remove_id =
281 g_signal_connect_object (dc->priv->uridecodebin, "pad-removed",
282 G_CALLBACK (uridecodebin_pad_removed_cb), dc, 0);
284 GST_LOG_OBJECT (dc, "Getting pipeline bus");
285 dc->priv->bus = gst_pipeline_get_bus ((GstPipeline *) dc->priv->pipeline);
287 dc->priv->bus_cb_id =
288 g_signal_connect_object (dc->priv->bus, "message",
289 G_CALLBACK (discoverer_bus_cb), dc, 0);
291 GST_DEBUG_OBJECT (dc, "Done initializing Discoverer");
293 /* This is ugly. We get the GType of decodebin2 so we can quickly detect
294 * when a decodebin2 is added to uridecodebin so we can set the
295 * post-stream-topology setting to TRUE */
296 dc->priv->element_added_id =
297 g_signal_connect_object (dc->priv->uridecodebin, "element-added",
298 G_CALLBACK (uridecodebin_element_added_cb), dc, 0);
299 tmp = gst_element_factory_make ("decodebin2", NULL);
300 dc->priv->decodebin2_type = G_OBJECT_TYPE (tmp);
301 gst_object_unref (tmp);
304 dc->priv->seeking_query = gst_query_new_seeking (format);
308 discoverer_reset (GstDiscoverer * dc)
310 GST_DEBUG_OBJECT (dc, "Resetting");
312 if (dc->priv->pending_uris) {
313 g_list_foreach (dc->priv->pending_uris, (GFunc) g_free, NULL);
314 g_list_free (dc->priv->pending_uris);
315 dc->priv->pending_uris = NULL;
318 if (dc->priv->pipeline)
319 gst_element_set_state ((GstElement *) dc->priv->pipeline, GST_STATE_NULL);
322 #define DISCONNECT_SIGNAL(o,i) G_STMT_START{ \
323 if ((i) && g_signal_handler_is_connected ((o), (i))) \
324 g_signal_handler_disconnect ((o), (i)); \
329 gst_discoverer_dispose (GObject * obj)
331 GstDiscoverer *dc = (GstDiscoverer *) obj;
333 GST_DEBUG_OBJECT (dc, "Disposing");
335 discoverer_reset (dc);
337 if (G_LIKELY (dc->priv->pipeline)) {
338 /* Workaround for bug #118536 */
339 DISCONNECT_SIGNAL (dc->priv->uridecodebin, dc->priv->pad_added_id);
340 DISCONNECT_SIGNAL (dc->priv->uridecodebin, dc->priv->pad_remove_id);
341 DISCONNECT_SIGNAL (dc->priv->uridecodebin, dc->priv->element_added_id);
342 DISCONNECT_SIGNAL (dc->priv->bus, dc->priv->bus_cb_id);
344 /* pipeline was set to NULL in _reset */
345 gst_object_unref (dc->priv->pipeline);
346 gst_object_unref (dc->priv->bus);
348 dc->priv->pipeline = NULL;
349 dc->priv->uridecodebin = NULL;
350 dc->priv->bus = NULL;
353 gst_discoverer_stop (dc);
355 if (dc->priv->lock) {
356 g_mutex_free (dc->priv->lock);
357 dc->priv->lock = NULL;
360 if (dc->priv->seeking_query) {
361 gst_query_unref (dc->priv->seeking_query);
362 dc->priv->seeking_query = NULL;
365 G_OBJECT_CLASS (gst_discoverer_parent_class)->dispose (obj);
369 gst_discoverer_set_property (GObject * object, guint prop_id,
370 const GValue * value, GParamSpec * pspec)
372 GstDiscoverer *dc = (GstDiscoverer *) object;
376 gst_discoverer_set_timeout (dc, g_value_get_uint64 (value));
379 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
385 gst_discoverer_get_property (GObject * object, guint prop_id,
386 GValue * value, GParamSpec * pspec)
388 GstDiscoverer *dc = (GstDiscoverer *) object;
393 g_value_set_uint64 (value, dc->priv->timeout);
397 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
403 gst_discoverer_set_timeout (GstDiscoverer * dc, GstClockTime timeout)
405 GST_DEBUG_OBJECT (dc, "timeout : %" GST_TIME_FORMAT, GST_TIME_ARGS (timeout));
407 /* FIXME : update current pending timeout if we're running */
409 dc->priv->timeout = timeout;
414 _event_probe (GstPad * pad, GstEvent * event, PrivateStream * ps)
416 if (GST_EVENT_TYPE (event) == GST_EVENT_TAG) {
417 GstTagList *tl = NULL, *tmp;
419 gst_event_parse_tag (event, &tl);
420 GST_DEBUG_OBJECT (pad, "tags %" GST_PTR_FORMAT, tl);
422 /* If preroll is complete, drop these tags - the collected information is
423 * possibly already being processed and adding more tags would be racy */
424 if (G_LIKELY (ps->dc->priv->processing)) {
425 GST_DEBUG_OBJECT (pad, "private stream %p old tags %" GST_PTR_FORMAT, ps,
427 tmp = gst_tag_list_merge (ps->tags, tl, GST_TAG_MERGE_APPEND);
429 gst_tag_list_free (ps->tags);
431 GST_DEBUG_OBJECT (pad, "private stream %p new tags %" GST_PTR_FORMAT, ps,
434 GST_DEBUG_OBJECT (pad, "Dropping tags since preroll is done");
435 DISCO_UNLOCK (ps->dc);
441 static GstStaticCaps subtitle_caps = GST_STATIC_CAPS ("text/plain; "
442 "text/x-pango-markup; subpicture/x-pgs; subpicture/x-dvb; "
443 "application/x-subtitle-unknown; application/x-ssa; application/x-ass; "
444 "subtitle/x-kate; application/x-kate; video/x-dvd-subpicture");
447 is_subtitle_caps (const GstCaps * caps)
452 subs_caps = gst_static_caps_get (&subtitle_caps);
453 ret = gst_caps_can_intersect (caps, subs_caps);
454 gst_caps_unref (subs_caps);
460 uridecodebin_pad_added_cb (GstElement * uridecodebin, GstPad * pad,
464 GstPad *sinkpad = NULL;
467 GST_DEBUG_OBJECT (dc, "pad %s:%s", GST_DEBUG_PAD_NAME (pad));
469 ps = g_slice_new0 (PrivateStream);
473 ps->queue = gst_element_factory_make ("queue", NULL);
474 ps->sink = gst_element_factory_make ("fakesink", NULL);
476 if (G_UNLIKELY (ps->queue == NULL || ps->sink == NULL))
479 g_object_set (ps->sink, "silent", TRUE, NULL);
480 g_object_set (ps->queue, "max-size-buffers", 1, "silent", TRUE, NULL);
482 caps = gst_pad_get_caps_reffed (pad);
484 if (is_subtitle_caps (caps)) {
485 /* Subtitle streams are sparse and may not provide any information - don't
486 * wait for data to preroll */
487 g_object_set (ps->sink, "async", FALSE, NULL);
490 gst_caps_unref (caps);
492 gst_bin_add_many (dc->priv->pipeline, ps->queue, ps->sink, NULL);
494 if (!gst_element_link_pads_full (ps->queue, "src", ps->sink, "sink",
495 GST_PAD_LINK_CHECK_NOTHING))
497 if (!gst_element_sync_state_with_parent (ps->sink))
499 if (!gst_element_sync_state_with_parent (ps->queue))
502 sinkpad = gst_element_get_static_pad (ps->queue, "sink");
505 if (gst_pad_link_full (pad, sinkpad,
506 GST_PAD_LINK_CHECK_NOTHING) != GST_PAD_LINK_OK)
508 gst_object_unref (sinkpad);
510 /* Add an event probe */
511 gst_pad_add_event_probe (pad, G_CALLBACK (_event_probe), ps);
514 dc->priv->streams = g_list_append (dc->priv->streams, ps);
517 GST_DEBUG_OBJECT (dc, "Done handling pad");
522 GST_ERROR_OBJECT (dc, "Error while handling pad");
524 gst_object_unref (sinkpad);
526 gst_object_unref (ps->queue);
528 gst_object_unref (ps->sink);
529 g_slice_free (PrivateStream, ps);
534 uridecodebin_pad_removed_cb (GstElement * uridecodebin, GstPad * pad,
541 GST_DEBUG_OBJECT (dc, "pad %s:%s", GST_DEBUG_PAD_NAME (pad));
543 /* Find the PrivateStream */
545 for (tmp = dc->priv->streams; tmp; tmp = tmp->next) {
546 ps = (PrivateStream *) tmp->data;
553 GST_DEBUG ("The removed pad wasn't controlled by us !");
557 dc->priv->streams = g_list_delete_link (dc->priv->streams, tmp);
560 gst_element_set_state (ps->sink, GST_STATE_NULL);
561 gst_element_set_state (ps->queue, GST_STATE_NULL);
562 gst_element_unlink (ps->queue, ps->sink);
564 sinkpad = gst_element_get_static_pad (ps->queue, "sink");
565 gst_pad_unlink (pad, sinkpad);
566 gst_object_unref (sinkpad);
568 /* references removed here */
569 gst_bin_remove_many (dc->priv->pipeline, ps->sink, ps->queue, NULL);
572 gst_tag_list_free (ps->tags);
575 g_slice_free (PrivateStream, ps);
577 GST_DEBUG ("Done handling pad");
580 static GstStructure *
581 collect_stream_information (GstDiscoverer * dc, PrivateStream * ps, guint idx)
587 stname = g_strdup_printf ("stream-%02d", idx);
588 st = gst_structure_empty_new (stname);
592 caps = gst_pad_get_negotiated_caps (ps->pad);
594 GST_WARNING ("Couldn't get negotiated caps from %s:%s",
595 GST_DEBUG_PAD_NAME (ps->pad));
596 caps = gst_pad_get_caps (ps->pad);
599 GST_DEBUG ("Got caps %" GST_PTR_FORMAT, caps);
600 gst_structure_id_set (st, _CAPS_QUARK, GST_TYPE_CAPS, caps, NULL);
602 gst_caps_unref (caps);
605 gst_structure_id_set (st, _TAGS_QUARK, GST_TYPE_TAG_LIST, ps->tags, NULL);
610 /* takes ownership of new_tags, may replace *taglist with a new one */
612 gst_discoverer_merge_and_replace_tags (GstTagList ** taglist,
613 GstTagList * new_tags)
615 if (new_tags == NULL)
618 if (*taglist == NULL) {
623 gst_tag_list_insert (*taglist, new_tags, GST_TAG_MERGE_REPLACE);
624 gst_tag_list_free (new_tags);
627 /* Parses a set of caps and tags in st and populates a GstDiscovererStreamInfo
628 * structure (parent, if !NULL, otherwise it allocates one)
630 static GstDiscovererStreamInfo *
631 collect_information (GstDiscoverer * dc, const GstStructure * st,
632 GstDiscovererStreamInfo * parent)
635 GstStructure *caps_st;
641 if (!st || !gst_structure_id_has_field (st, _CAPS_QUARK)) {
642 GST_WARNING ("Couldn't find caps !");
646 return (GstDiscovererStreamInfo *)
647 gst_mini_object_new (GST_TYPE_DISCOVERER_STREAM_INFO);
650 gst_structure_id_get (st, _CAPS_QUARK, GST_TYPE_CAPS, &caps, NULL);
651 caps_st = gst_caps_get_structure (caps, 0);
652 name = gst_structure_get_name (caps_st);
654 if (g_str_has_prefix (name, "audio/")) {
655 GstDiscovererAudioInfo *info;
658 info = (GstDiscovererAudioInfo *) parent;
660 info = (GstDiscovererAudioInfo *)
661 gst_mini_object_new (GST_TYPE_DISCOVERER_AUDIO_INFO);
662 info->parent.caps = caps;
665 if (gst_structure_get_int (caps_st, "rate", &tmp))
666 info->sample_rate = (guint) tmp;
668 if (gst_structure_get_int (caps_st, "channels", &tmp))
669 info->channels = (guint) tmp;
671 if (gst_structure_get_int (caps_st, "depth", &tmp))
672 info->depth = (guint) tmp;
674 if (gst_structure_id_has_field (st, _TAGS_QUARK)) {
675 gst_structure_id_get (st, _TAGS_QUARK, GST_TYPE_TAG_LIST, &tags_st, NULL);
676 if (gst_structure_get_uint (tags_st, GST_TAG_BITRATE, &utmp) ||
677 gst_structure_get_uint (tags_st, GST_TAG_NOMINAL_BITRATE, &utmp))
678 info->bitrate = utmp;
680 if (gst_structure_get_uint (tags_st, GST_TAG_MAXIMUM_BITRATE, &utmp))
681 info->max_bitrate = utmp;
683 /* FIXME: Is it worth it to remove the tags we've parsed? */
684 gst_discoverer_merge_and_replace_tags (&info->parent.tags, tags_st);
687 if (!info->language && ((GstDiscovererStreamInfo *) info)->tags) {
689 if (gst_tag_list_get_string (((GstDiscovererStreamInfo *) info)->tags,
690 GST_TAG_LANGUAGE_CODE, &language)) {
691 info->language = language;
695 return (GstDiscovererStreamInfo *) info;
697 } else if (g_str_has_prefix (name, "video/") ||
698 g_str_has_prefix (name, "image/")) {
699 GstDiscovererVideoInfo *info;
702 info = (GstDiscovererVideoInfo *) parent;
704 info = (GstDiscovererVideoInfo *)
705 gst_mini_object_new (GST_TYPE_DISCOVERER_VIDEO_INFO);
706 info->parent.caps = caps;
709 if (gst_structure_get_int (caps_st, "width", &tmp) &&
710 gst_structure_get_int (caps_st, "height", &tmp2)) {
711 info->width = (guint) tmp;
712 info->height = (guint) tmp2;
715 if (gst_structure_get_int (caps_st, "depth", &tmp))
716 info->depth = (guint) tmp;
718 if (gst_structure_get_fraction (caps_st, "pixel-aspect-ratio", &tmp, &tmp2)) {
720 info->par_denom = tmp2;
726 if (gst_structure_get_fraction (caps_st, "framerate", &tmp, &tmp2)) {
727 info->framerate_num = tmp;
728 info->framerate_denom = tmp2;
731 if (!gst_structure_get_boolean (caps_st, "interlaced", &info->interlaced))
732 info->interlaced = FALSE;
734 if (gst_structure_id_has_field (st, _TAGS_QUARK)) {
735 gst_structure_id_get (st, _TAGS_QUARK, GST_TYPE_TAG_LIST, &tags_st, NULL);
736 if (gst_structure_get_uint (tags_st, GST_TAG_BITRATE, &utmp) ||
737 gst_structure_get_uint (tags_st, GST_TAG_NOMINAL_BITRATE, &utmp))
738 info->bitrate = utmp;
740 if (gst_structure_get_uint (tags_st, GST_TAG_MAXIMUM_BITRATE, &utmp))
741 info->max_bitrate = utmp;
743 /* FIXME: Is it worth it to remove the tags we've parsed? */
744 gst_discoverer_merge_and_replace_tags (&info->parent.tags,
745 (GstTagList *) tags_st);
748 return (GstDiscovererStreamInfo *) info;
750 } else if (is_subtitle_caps (caps)) {
751 GstDiscovererSubtitleInfo *info;
754 info = (GstDiscovererSubtitleInfo *) parent;
756 info = (GstDiscovererSubtitleInfo *)
757 gst_mini_object_new (GST_TYPE_DISCOVERER_SUBTITLE_INFO);
758 info->parent.caps = caps;
761 if (gst_structure_id_has_field (st, _TAGS_QUARK)) {
762 const gchar *language;
764 gst_structure_id_get (st, _TAGS_QUARK, GST_TYPE_TAG_LIST, &tags_st, NULL);
766 language = gst_structure_get_string (caps_st, GST_TAG_LANGUAGE_CODE);
768 info->language = g_strdup (language);
770 /* FIXME: Is it worth it to remove the tags we've parsed? */
771 gst_discoverer_merge_and_replace_tags (&info->parent.tags, tags_st);
774 if (!info->language && ((GstDiscovererStreamInfo *) info)->tags) {
776 if (gst_tag_list_get_string (((GstDiscovererStreamInfo *) info)->tags,
777 GST_TAG_LANGUAGE_CODE, &language)) {
778 info->language = language;
782 return (GstDiscovererStreamInfo *) info;
785 /* None of the above - populate what information we can */
786 GstDiscovererStreamInfo *info;
791 info = (GstDiscovererStreamInfo *)
792 gst_mini_object_new (GST_TYPE_DISCOVERER_STREAM_INFO);
796 if (gst_structure_id_get (st, _TAGS_QUARK,
797 GST_TYPE_TAG_LIST, &tags_st, NULL)) {
798 gst_discoverer_merge_and_replace_tags (&info->tags, tags_st);
806 static GstStructure *
807 find_stream_for_node (GstDiscoverer * dc, const GstStructure * topology)
810 GstPad *target_pad = NULL;
811 GstStructure *st = NULL;
816 if (!gst_structure_id_has_field (topology, _TOPOLOGY_PAD_QUARK)) {
817 GST_DEBUG ("Could not find pad for node %" GST_PTR_FORMAT "\n", topology);
821 gst_structure_id_get (topology, _TOPOLOGY_PAD_QUARK,
822 GST_TYPE_PAD, &pad, NULL);
824 if (!dc->priv->streams) {
825 gst_object_unref (pad);
829 for (i = 0, tmp = dc->priv->streams; tmp; tmp = tmp->next, i++) {
830 ps = (PrivateStream *) tmp->data;
832 target_pad = gst_ghost_pad_get_target (GST_GHOST_PAD (ps->pad));
833 gst_object_unref (target_pad);
835 if (target_pad == pad)
840 st = collect_stream_information (dc, ps, i);
842 gst_object_unref (pad);
848 child_is_raw_stream (GstCaps * parent, GstCaps * child)
850 GstStructure *st1, *st2;
851 const gchar *name1, *name2;
853 st1 = gst_caps_get_structure (parent, 0);
854 name1 = gst_structure_get_name (st1);
855 st2 = gst_caps_get_structure (child, 0);
856 name2 = gst_structure_get_name (st2);
858 if ((g_str_has_prefix (name1, "audio/") &&
859 g_str_has_prefix (name2, "audio/x-raw")) ||
860 ((g_str_has_prefix (name1, "video/") ||
861 g_str_has_prefix (name1, "image/")) &&
862 g_str_has_prefix (name2, "video/x-raw"))) {
863 /* child is the "raw" sub-stream corresponding to parent */
867 if (is_subtitle_caps (parent))
873 /* If a parent is non-NULL, collected stream information will be appended to it
874 * (and where the information exists, it will be overriden)
876 static GstDiscovererStreamInfo *
877 parse_stream_topology (GstDiscoverer * dc, const GstStructure * topology,
878 GstDiscovererStreamInfo * parent)
880 GstDiscovererStreamInfo *res = NULL;
881 GstCaps *caps = NULL;
882 const GValue *nval = NULL;
884 GST_DEBUG ("parsing: %" GST_PTR_FORMAT, topology);
886 nval = gst_structure_get_value (topology, "next");
888 if (nval == NULL || GST_VALUE_HOLDS_STRUCTURE (nval)) {
889 GstStructure *st = find_stream_for_node (dc, topology);
890 gboolean add_to_list = TRUE;
893 res = collect_information (dc, st, parent);
894 gst_structure_free (st);
896 /* Didn't find a stream structure, so let's just use the caps we have */
897 res = collect_information (dc, topology, parent);
901 /* FIXME : aggregate with information from main streams */
902 GST_DEBUG ("Coudn't find 'next' ! might be the last entry");
905 const GstStructure *st;
907 st = gst_value_get_structure (nval);
909 GST_DEBUG ("next is a structure %" GST_PTR_FORMAT, st);
914 if (gst_structure_id_get (st, _CAPS_QUARK, GST_TYPE_CAPS, &caps, NULL)) {
915 if (gst_caps_can_intersect (parent->caps, caps)) {
916 /* We sometimes get an extra sub-stream from the parser. If this is
917 * the case, we just replace the parent caps with this stream's caps
918 * since they might contain more information */
919 gst_caps_replace (&parent->caps, caps);
921 parse_stream_topology (dc, st, parent);
923 } else if (child_is_raw_stream (parent->caps, caps)) {
924 /* This is the "raw" stream corresponding to the parent. This
925 * contains more information than the parent, tags etc. */
926 parse_stream_topology (dc, st, parent);
929 GstDiscovererStreamInfo *next = parse_stream_topology (dc, st, NULL);
931 next->previous = res;
933 gst_caps_unref (caps);
938 dc->priv->current_info->stream_list =
939 g_list_append (dc->priv->current_info->stream_list, res);
942 } else if (GST_VALUE_HOLDS_LIST (nval)) {
944 GstDiscovererContainerInfo *cont;
947 if (!gst_structure_id_get (topology, _CAPS_QUARK,
948 GST_TYPE_CAPS, &caps, NULL))
949 GST_WARNING ("Couldn't find caps !");
951 len = gst_value_list_get_size (nval);
952 GST_DEBUG ("next is a list of %d entries", len);
954 cont = (GstDiscovererContainerInfo *)
955 gst_mini_object_new (GST_TYPE_DISCOVERER_CONTAINER_INFO);
956 cont->parent.caps = caps;
957 res = (GstDiscovererStreamInfo *) cont;
959 if (gst_structure_id_has_field (topology, _TAGS_QUARK)) {
962 gst_structure_id_get (topology, _TAGS_QUARK,
963 GST_TYPE_TAG_LIST, &tags, NULL);
965 GST_DEBUG ("Merge tags %" GST_PTR_FORMAT, tags);
968 gst_tag_list_merge (cont->parent.tags, (GstTagList *) tags,
969 GST_TAG_MERGE_APPEND);
970 gst_tag_list_free (tags);
971 if (cont->parent.tags)
972 gst_tag_list_free (cont->parent.tags);
973 cont->parent.tags = tmp;
974 GST_DEBUG ("Container info tags %" GST_PTR_FORMAT, tmp);
977 for (i = 0; i < len; i++) {
978 const GValue *subv = gst_value_list_get_value (nval, i);
979 const GstStructure *subst = gst_value_get_structure (subv);
980 GstDiscovererStreamInfo *substream;
982 GST_DEBUG ("%d %" GST_PTR_FORMAT, i, subst);
984 substream = parse_stream_topology (dc, subst, NULL);
986 substream->previous = res;
988 g_list_append (cont->streams,
989 gst_discoverer_stream_info_ref (substream));
996 /* Called when pipeline is pre-rolled */
998 discoverer_collect (GstDiscoverer * dc)
1000 GST_DEBUG ("Collecting information");
1002 /* Stop the timeout handler if present */
1003 if (dc->priv->timeoutid) {
1004 g_source_remove (dc->priv->timeoutid);
1005 dc->priv->timeoutid = 0;
1008 if (dc->priv->streams) {
1009 /* FIXME : Make this querying optional */
1011 GstElement *pipeline = (GstElement *) dc->priv->pipeline;
1012 GstFormat format = GST_FORMAT_TIME;
1015 GST_DEBUG ("Attempting to query duration");
1017 if (gst_element_query_duration (pipeline, &format, &dur)) {
1018 if (format == GST_FORMAT_TIME) {
1019 GST_DEBUG ("Got duration %" GST_TIME_FORMAT, GST_TIME_ARGS (dur));
1020 dc->priv->current_info->duration = (guint64) dur;
1024 if (dc->priv->seeking_query) {
1025 if (gst_element_query (pipeline, dc->priv->seeking_query)) {
1028 gst_query_parse_seeking (dc->priv->seeking_query, &format,
1029 &seekable, NULL, NULL);
1030 if (format == GST_FORMAT_TIME) {
1031 GST_DEBUG ("Got seekable %d", seekable);
1032 dc->priv->current_info->seekable = seekable;
1038 if (dc->priv->current_topology)
1039 dc->priv->current_info->stream_info = parse_stream_topology (dc,
1040 dc->priv->current_topology, NULL);
1043 * Images need some special handling. They do not have a duration, have
1044 * caps named image/<foo> (th exception being MJPEG video which is also
1045 * type image/jpeg), and should consist of precisely one stream (actually
1046 * initially there are 2, the image and raw stream, but we squash these
1047 * while parsing the stream topology). At some point, if we find that these
1048 * conditions are not sufficient, we can count the number of decoders and
1049 * parsers in the chain, and if there's more than one decoder, or any
1050 * parser at all, we should not mark this as an image.
1052 if (dc->priv->current_info->duration == 0 &&
1053 dc->priv->current_info->stream_info != NULL &&
1054 dc->priv->current_info->stream_info->next == NULL) {
1056 gst_caps_get_structure (dc->priv->current_info->stream_info->caps, 0);
1058 if (g_str_has_prefix (gst_structure_get_name (st), "image/"))
1059 ((GstDiscovererVideoInfo *) dc->priv->current_info->
1060 stream_info)->is_image = TRUE;
1064 if (dc->priv->async) {
1065 GST_DEBUG ("Emitting 'discoverered'");
1066 g_signal_emit (dc, gst_discoverer_signals[SIGNAL_DISCOVERED], 0,
1067 dc->priv->current_info, dc->priv->current_error);
1068 /* Clients get a copy of current_info since it is a boxed type */
1069 gst_discoverer_info_unref (dc->priv->current_info);
1074 get_async_cb (gpointer cb_data, GSource * source, GSourceFunc * func,
1077 *func = (GSourceFunc) async_timeout_cb;
1081 /* Wrapper since GSourceCallbackFuncs don't expect a return value from ref() */
1083 _void_g_object_ref (gpointer object)
1085 g_object_ref (G_OBJECT (object));
1089 handle_current_async (GstDiscoverer * dc)
1092 static GSourceCallbackFuncs cb_funcs = {
1098 /* Attach a timeout to the main context */
1099 source = g_timeout_source_new (dc->priv->timeout / GST_MSECOND);
1100 g_source_set_callback_indirect (source, g_object_ref (dc), &cb_funcs);
1101 dc->priv->timeoutid = g_source_attach (source, dc->priv->ctx);
1102 g_source_unref (source);
1106 /* Returns TRUE if processing should stop */
1108 handle_message (GstDiscoverer * dc, GstMessage * msg)
1110 gboolean done = FALSE;
1112 GST_DEBUG_OBJECT (GST_MESSAGE_SRC (msg), "got a %s message",
1113 GST_MESSAGE_TYPE_NAME (msg));
1115 switch (GST_MESSAGE_TYPE (msg)) {
1116 case GST_MESSAGE_ERROR:{
1120 gst_message_parse_error (msg, &gerr, &debug);
1121 GST_WARNING_OBJECT (GST_MESSAGE_SRC (msg),
1122 "Got an error [debug:%s], [message:%s]", debug, gerr->message);
1123 dc->priv->current_error = gerr;
1126 /* We need to stop */
1129 GST_DEBUG ("Setting result to ERROR");
1130 dc->priv->current_info->result = GST_DISCOVERER_ERROR;
1134 case GST_MESSAGE_EOS:
1135 GST_DEBUG ("Got EOS !");
1139 case GST_MESSAGE_ASYNC_DONE:
1140 if (GST_MESSAGE_SRC (msg) == (GstObject *) dc->priv->pipeline) {
1141 GST_DEBUG ("Finished changing state asynchronously");
1147 case GST_MESSAGE_ELEMENT:
1149 GQuark sttype = gst_structure_get_name_id (msg->structure);
1150 GST_DEBUG_OBJECT (GST_MESSAGE_SRC (msg),
1151 "structure %" GST_PTR_FORMAT, msg->structure);
1152 if (sttype == _MISSING_PLUGIN_QUARK) {
1153 GST_DEBUG_OBJECT (GST_MESSAGE_SRC (msg),
1154 "Setting result to MISSING_PLUGINS");
1155 dc->priv->current_info->result = GST_DISCOVERER_MISSING_PLUGINS;
1156 dc->priv->current_info->misc = gst_structure_copy (msg->structure);
1157 } else if (sttype == _STREAM_TOPOLOGY_QUARK) {
1158 dc->priv->current_topology = gst_structure_copy (msg->structure);
1163 case GST_MESSAGE_TAG:
1165 GstTagList *tl, *tmp;
1167 gst_message_parse_tag (msg, &tl);
1168 GST_DEBUG_OBJECT (GST_MESSAGE_SRC (msg), "Got tags %" GST_PTR_FORMAT, tl);
1169 /* Merge with current tags */
1171 gst_tag_list_merge (dc->priv->current_info->tags, tl,
1172 GST_TAG_MERGE_APPEND);
1173 gst_tag_list_free (tl);
1174 if (dc->priv->current_info->tags)
1175 gst_tag_list_free (dc->priv->current_info->tags);
1176 dc->priv->current_info->tags = tmp;
1177 GST_DEBUG_OBJECT (GST_MESSAGE_SRC (msg), "Current info %p, tags %"
1178 GST_PTR_FORMAT, dc->priv->current_info, tmp);
1191 handle_current_sync (GstDiscoverer * dc)
1194 gdouble deadline = ((gdouble) dc->priv->timeout) / GST_SECOND;
1196 gboolean done = FALSE;
1198 timer = g_timer_new ();
1199 g_timer_start (timer);
1202 /* poll bus with timeout */
1203 /* FIXME : make the timeout more fine-tuned */
1204 if ((msg = gst_bus_timed_pop (dc->priv->bus, GST_SECOND / 2))) {
1205 done = handle_message (dc, msg);
1206 gst_message_unref (msg);
1208 } while (!done && (g_timer_elapsed (timer, NULL) < deadline));
1212 GST_DEBUG ("we timed out! Setting result to TIMEOUT");
1213 dc->priv->current_info->result = GST_DISCOVERER_TIMEOUT;
1218 g_timer_stop (timer);
1219 g_timer_destroy (timer);
1223 _setup_locked (GstDiscoverer * dc)
1225 GstStateChangeReturn ret;
1227 GST_DEBUG ("Setting up");
1229 /* Pop URI off the pending URI list */
1230 dc->priv->current_info =
1231 (GstDiscovererInfo *) gst_mini_object_new (GST_TYPE_DISCOVERER_INFO);
1232 dc->priv->current_info->uri = (gchar *) dc->priv->pending_uris->data;
1233 dc->priv->pending_uris =
1234 g_list_delete_link (dc->priv->pending_uris, dc->priv->pending_uris);
1236 /* set uri on uridecodebin */
1237 g_object_set (dc->priv->uridecodebin, "uri", dc->priv->current_info->uri,
1240 GST_DEBUG ("Current is now %s", dc->priv->current_info->uri);
1242 dc->priv->processing = TRUE;
1244 /* set pipeline to PAUSED */
1246 GST_DEBUG ("Setting pipeline to PAUSED");
1248 gst_element_set_state ((GstElement *) dc->priv->pipeline,
1252 GST_DEBUG_OBJECT (dc, "Pipeline going to PAUSED : %s",
1253 gst_element_state_change_return_get_name (ret));
1257 discoverer_cleanup (GstDiscoverer * dc)
1259 GST_DEBUG ("Cleaning up");
1261 gst_bus_set_flushing (dc->priv->bus, TRUE);
1262 gst_element_set_state ((GstElement *) dc->priv->pipeline, GST_STATE_READY);
1263 gst_bus_set_flushing (dc->priv->bus, FALSE);
1266 if (dc->priv->current_error)
1267 g_error_free (dc->priv->current_error);
1268 dc->priv->current_error = NULL;
1269 if (dc->priv->current_topology) {
1270 gst_structure_free (dc->priv->current_topology);
1271 dc->priv->current_topology = NULL;
1274 dc->priv->current_info = NULL;
1276 /* Try popping the next uri */
1277 if (dc->priv->async) {
1278 if (dc->priv->pending_uris != NULL) {
1282 handle_current_async (dc);
1286 g_signal_emit (dc, gst_discoverer_signals[SIGNAL_FINISHED], 0);
1295 discoverer_bus_cb (GstBus * bus, GstMessage * msg, GstDiscoverer * dc)
1297 if (dc->priv->processing) {
1298 if (handle_message (dc, msg)) {
1299 GST_DEBUG ("Stopping asynchronously");
1300 /* Serialise with _event_probe() */
1302 dc->priv->processing = FALSE;
1304 discoverer_collect (dc);
1305 discoverer_cleanup (dc);
1311 async_timeout_cb (GstDiscoverer * dc)
1313 if (!g_source_is_destroyed (g_main_current_source ())) {
1314 dc->priv->timeoutid = 0;
1315 GST_DEBUG ("Setting result to TIMEOUT");
1316 dc->priv->current_info->result = GST_DISCOVERER_TIMEOUT;
1317 dc->priv->processing = FALSE;
1318 discoverer_collect (dc);
1319 discoverer_cleanup (dc);
1324 /* If there is a pending URI, it will pop it from the list of pending
1325 * URIs and start the discovery on it.
1327 * Returns GST_DISCOVERER_OK if the next URI was popped and is processing,
1328 * else a error flag.
1330 static GstDiscovererResult
1331 start_discovering (GstDiscoverer * dc)
1333 GstDiscovererResult res = GST_DISCOVERER_OK;
1335 GST_DEBUG ("Starting");
1338 if (dc->priv->pending_uris == NULL) {
1339 GST_WARNING ("No URI to process");
1340 res = GST_DISCOVERER_URI_INVALID;
1345 if (dc->priv->current_info != NULL) {
1346 GST_WARNING ("Already processing a file");
1347 res = GST_DISCOVERER_BUSY;
1352 g_signal_emit (dc, gst_discoverer_signals[SIGNAL_STARTING], 0);
1358 if (dc->priv->async)
1359 handle_current_async (dc);
1361 handle_current_sync (dc);
1369 * gst_discoverer_start:
1370 * @discoverer: A #GstDiscoverer
1372 * Allow asynchronous discovering of URIs to take place.
1373 * A #GMainLoop must be available for #GstDiscoverer to properly work in
1374 * asynchronous mode.
1379 gst_discoverer_start (GstDiscoverer * discoverer)
1382 GMainContext *ctx = NULL;
1384 GST_DEBUG_OBJECT (discoverer, "Starting...");
1386 if (discoverer->priv->async) {
1387 GST_DEBUG_OBJECT (discoverer, "We were already started");
1391 discoverer->priv->async = TRUE;
1392 discoverer->priv->running = TRUE;
1394 ctx = g_main_context_get_thread_default ();
1396 /* Connect to bus signals */
1398 ctx = g_main_context_default ();
1400 source = gst_bus_create_watch (discoverer->priv->bus);
1401 g_source_set_callback (source, (GSourceFunc) gst_bus_async_signal_func,
1403 discoverer->priv->sourceid = g_source_attach (source, ctx);
1404 g_source_unref (source);
1405 discoverer->priv->ctx = g_main_context_ref (ctx);
1407 start_discovering (discoverer);
1408 GST_DEBUG_OBJECT (discoverer, "Started");
1412 * gst_discoverer_stop:
1413 * @discoverer: A #GstDiscoverer
1415 * Stop the discovery of any pending URIs and clears the list of
1416 * pending URIS (if any).
1421 gst_discoverer_stop (GstDiscoverer * discoverer)
1423 GST_DEBUG_OBJECT (discoverer, "Stopping...");
1425 if (!discoverer->priv->async) {
1426 GST_DEBUG_OBJECT (discoverer,
1427 "We were already stopped, or running synchronously");
1431 DISCO_LOCK (discoverer);
1432 if (discoverer->priv->processing) {
1433 /* We prevent any further processing by setting the bus to
1434 * flushing and setting the pipeline to READY.
1435 * _reset() will take care of the rest of the cleanup */
1436 if (discoverer->priv->bus)
1437 gst_bus_set_flushing (discoverer->priv->bus, TRUE);
1438 if (discoverer->priv->pipeline)
1439 gst_element_set_state ((GstElement *) discoverer->priv->pipeline,
1442 discoverer->priv->running = FALSE;
1443 DISCO_UNLOCK (discoverer);
1445 /* Remove timeout handler */
1446 if (discoverer->priv->timeoutid) {
1447 g_source_remove (discoverer->priv->timeoutid);
1448 discoverer->priv->timeoutid = 0;
1450 /* Remove signal watch */
1451 if (discoverer->priv->sourceid) {
1452 g_source_remove (discoverer->priv->sourceid);
1453 discoverer->priv->sourceid = 0;
1455 /* Unref main context */
1456 if (discoverer->priv->ctx) {
1457 g_main_context_unref (discoverer->priv->ctx);
1458 discoverer->priv->ctx = NULL;
1460 discoverer_reset (discoverer);
1462 discoverer->priv->async = FALSE;
1464 GST_DEBUG_OBJECT (discoverer, "Stopped");
1468 * gst_discoverer_discover_uri_async:
1469 * @discoverer: A #GstDiscoverer
1470 * @uri: the URI to add.
1472 * Appends the given @uri to the list of URIs to discoverer. The actual
1473 * discovery of the @uri will only take place if gst_discoverer_start() has
1476 * A copy of @uri will be made internally, so the caller can safely g_free()
1479 * Returns: %TRUE if the @uri was successfully appended to the list of pending
1485 gst_discoverer_discover_uri_async (GstDiscoverer * discoverer,
1490 GST_DEBUG_OBJECT (discoverer, "uri : %s", uri);
1492 DISCO_LOCK (discoverer);
1493 can_run = (discoverer->priv->pending_uris == NULL);
1494 discoverer->priv->pending_uris =
1495 g_list_append (discoverer->priv->pending_uris, g_strdup (uri));
1496 DISCO_UNLOCK (discoverer);
1499 start_discovering (discoverer);
1505 /* Synchronous mode */
1507 * gst_discoverer_discover_uri:
1508 * @discoverer: A #GstDiscoverer
1509 * @uri: The URI to run on.
1510 * @err: (out) (allow-none): If an error occurred, this field will be filled in.
1512 * Synchronously discovers the given @uri.
1514 * A copy of @uri will be made internally, so the caller can safely g_free()
1517 * Returns: (transfer full): the result of the scanning. Can be %NULL if an
1523 gst_discoverer_discover_uri (GstDiscoverer * discoverer, const gchar * uri,
1526 GstDiscovererResult res = 0;
1527 GstDiscovererInfo *info;
1529 GST_DEBUG_OBJECT (discoverer, "uri:%s", uri);
1531 DISCO_LOCK (discoverer);
1532 if (G_UNLIKELY (discoverer->priv->current_info)) {
1533 DISCO_UNLOCK (discoverer);
1534 GST_WARNING_OBJECT (discoverer, "Already handling a uri");
1538 discoverer->priv->pending_uris =
1539 g_list_append (discoverer->priv->pending_uris, g_strdup (uri));
1540 DISCO_UNLOCK (discoverer);
1542 res = start_discovering (discoverer);
1543 discoverer_collect (discoverer);
1547 if (discoverer->priv->current_error)
1548 *err = g_error_copy (discoverer->priv->current_error);
1552 if (res != GST_DISCOVERER_OK) {
1553 GST_DEBUG ("Setting result to %d (was %d)", res,
1554 discoverer->priv->current_info->result);
1555 discoverer->priv->current_info->result = res;
1557 info = discoverer->priv->current_info;
1559 discoverer_cleanup (discoverer);
1565 * gst_discoverer_new:
1566 * @timeout: timeout per file, in nanoseconds. Allowed are values between
1567 * one second (#GST_SECOND) and one hour (3600 * #GST_SECOND)
1568 * @err: a pointer to a #GError. can be %NULL
1570 * Creates a new #GstDiscoverer with the provided timeout.
1572 * Returns: (transfer full): The new #GstDiscoverer.
1573 * If an error occurred when creating the discoverer, @err will be set
1574 * accordingly and %NULL will be returned. If @err is set, the caller must
1575 * free it when no longer needed using g_error_free().
1580 gst_discoverer_new (GstClockTime timeout, GError ** err)
1584 res = g_object_new (GST_TYPE_DISCOVERER, "timeout", timeout, NULL);
1585 if (res->priv->uridecodebin == NULL) {
1587 *err = g_error_new (GST_CORE_ERROR, GST_CORE_ERROR_MISSING_PLUGIN,
1588 "Couldn't create 'uridecodebin' element");
1589 gst_object_unref (res);