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.
47 #include <gst/video/video.h>
49 #include "pbutils-marshal.h"
50 #include "pbutils-private.h"
52 GST_DEBUG_CATEGORY_STATIC (discoverer_debug);
53 #define GST_CAT_DEFAULT discoverer_debug
55 static GQuark _CAPS_QUARK;
56 static GQuark _TAGS_QUARK;
57 static GQuark _MISSING_PLUGIN_QUARK;
58 static GQuark _STREAM_TOPOLOGY_QUARK;
59 static GQuark _TOPOLOGY_PAD_QUARK;
71 struct _GstDiscovererPrivate
75 /* allowed time to discover each uri in nanoseconds */
78 /* list of pending URI to process (current excluded) */
83 /* TRUE if processing a URI */
86 /* TRUE if discoverer has been started */
90 GstDiscovererInfo *current_info;
91 GError *current_error;
92 GstStructure *current_topology;
94 /* List of private streams */
99 GstElement *uridecodebin;
102 GType decodebin2_type;
104 /* Custom main context variables */
109 /* reusable queries */
110 GstQuery *seeking_query;
112 /* Handler ids for various callbacks */
114 gulong pad_remove_id;
115 gulong element_added_id;
119 #define DISCO_LOCK(dc) g_mutex_lock (dc->priv->lock);
120 #define DISCO_UNLOCK(dc) g_mutex_unlock (dc->priv->lock);
125 GST_DEBUG_CATEGORY_INIT (discoverer_debug, "discoverer", 0, "Discoverer");
127 _CAPS_QUARK = g_quark_from_static_string ("caps");
128 _TAGS_QUARK = g_quark_from_static_string ("tags");
129 _MISSING_PLUGIN_QUARK = g_quark_from_static_string ("missing-plugin");
130 _STREAM_TOPOLOGY_QUARK = g_quark_from_static_string ("stream-topology");
131 _TOPOLOGY_PAD_QUARK = g_quark_from_static_string ("pad");
134 G_DEFINE_TYPE_EXTENDED (GstDiscoverer, gst_discoverer, G_TYPE_OBJECT, 0,
145 #define DEFAULT_PROP_TIMEOUT 15 * GST_SECOND
153 static guint gst_discoverer_signals[LAST_SIGNAL] = { 0 };
155 static void gst_discoverer_set_timeout (GstDiscoverer * dc,
156 GstClockTime timeout);
157 static gboolean async_timeout_cb (GstDiscoverer * dc);
159 static void discoverer_bus_cb (GstBus * bus, GstMessage * msg,
161 static void uridecodebin_pad_added_cb (GstElement * uridecodebin, GstPad * pad,
163 static void uridecodebin_pad_removed_cb (GstElement * uridecodebin,
164 GstPad * pad, GstDiscoverer * dc);
166 static void gst_discoverer_dispose (GObject * dc);
167 static void gst_discoverer_set_property (GObject * object, guint prop_id,
168 const GValue * value, GParamSpec * pspec);
169 static void gst_discoverer_get_property (GObject * object, guint prop_id,
170 GValue * value, GParamSpec * pspec);
173 gst_discoverer_class_init (GstDiscovererClass * klass)
175 GObjectClass *gobject_class = (GObjectClass *) klass;
177 gobject_class->dispose = gst_discoverer_dispose;
179 gobject_class->set_property = gst_discoverer_set_property;
180 gobject_class->get_property = gst_discoverer_get_property;
182 g_type_class_add_private (klass, sizeof (GstDiscovererPrivate));
186 * GstDiscoverer:timeout
188 * The duration (in nanoseconds) after which the discovery of an individual
191 * If the discovery of a URI times out, the %GST_DISCOVERER_TIMEOUT will be
192 * set on the result flags.
194 g_object_class_install_property (gobject_class, PROP_TIMEOUT,
195 g_param_spec_uint64 ("timeout", "timeout", "Timeout",
196 GST_SECOND, 3600 * GST_SECOND, DEFAULT_PROP_TIMEOUT,
197 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
201 * GstDiscoverer::finished:
202 * @discoverer: the #GstDiscoverer
204 * Will be emitted when all pending URIs have been processed.
206 gst_discoverer_signals[SIGNAL_FINISHED] =
207 g_signal_new ("finished", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
208 G_STRUCT_OFFSET (GstDiscovererClass, finished),
209 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0, G_TYPE_NONE);
212 * GstDiscoverer::starting:
213 * @discoverer: the #GstDiscoverer
215 * Will be emitted when the discover starts analyzing the pending URIs
217 gst_discoverer_signals[SIGNAL_STARTING] =
218 g_signal_new ("starting", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
219 G_STRUCT_OFFSET (GstDiscovererClass, starting),
220 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0, G_TYPE_NONE);
223 * GstDiscoverer::discovered:
224 * @discoverer: the #GstDiscoverer
225 * @info: the results #GstDiscovererInfo
226 * @error: (type GLib.Error): #GError, which will be non-NULL if an error
227 * occurred during discovery
229 * Will be emitted when all information on a URI could be discovered.
231 gst_discoverer_signals[SIGNAL_DISCOVERED] =
232 g_signal_new ("discovered", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
233 G_STRUCT_OFFSET (GstDiscovererClass, discovered),
234 NULL, NULL, pbutils_marshal_VOID__POINTER_BOXED,
235 G_TYPE_NONE, 2, GST_TYPE_DISCOVERER_INFO, GST_TYPE_G_ERROR);
239 uridecodebin_element_added_cb (GstElement * uridecodebin,
240 GstElement * child, GstDiscoverer * dc)
242 GST_DEBUG ("New element added to uridecodebin : %s",
243 GST_ELEMENT_NAME (child));
245 if (G_OBJECT_TYPE (child) == dc->priv->decodebin2_type) {
246 g_object_set (child, "post-stream-topology", TRUE, NULL);
251 gst_discoverer_init (GstDiscoverer * dc)
254 GstFormat format = GST_FORMAT_TIME;
256 dc->priv = G_TYPE_INSTANCE_GET_PRIVATE (dc, GST_TYPE_DISCOVERER,
257 GstDiscovererPrivate);
259 dc->priv->timeout = DEFAULT_PROP_TIMEOUT;
260 dc->priv->async = FALSE;
262 dc->priv->lock = g_mutex_new ();
264 GST_LOG ("Creating pipeline");
265 dc->priv->pipeline = (GstBin *) gst_pipeline_new ("Discoverer");
266 GST_LOG_OBJECT (dc, "Creating uridecodebin");
267 dc->priv->uridecodebin =
268 gst_element_factory_make ("uridecodebin", "discoverer-uri");
269 if (G_UNLIKELY (dc->priv->uridecodebin == NULL)) {
270 GST_ERROR ("Can't create uridecodebin");
273 GST_LOG_OBJECT (dc, "Adding uridecodebin to pipeline");
274 gst_bin_add (dc->priv->pipeline, dc->priv->uridecodebin);
276 dc->priv->pad_added_id =
277 g_signal_connect_object (dc->priv->uridecodebin, "pad-added",
278 G_CALLBACK (uridecodebin_pad_added_cb), dc, 0);
279 dc->priv->pad_remove_id =
280 g_signal_connect_object (dc->priv->uridecodebin, "pad-removed",
281 G_CALLBACK (uridecodebin_pad_removed_cb), dc, 0);
283 GST_LOG_OBJECT (dc, "Getting pipeline bus");
284 dc->priv->bus = gst_pipeline_get_bus ((GstPipeline *) dc->priv->pipeline);
286 dc->priv->bus_cb_id =
287 g_signal_connect_object (dc->priv->bus, "message",
288 G_CALLBACK (discoverer_bus_cb), dc, 0);
290 GST_DEBUG_OBJECT (dc, "Done initializing Discoverer");
292 /* This is ugly. We get the GType of decodebin2 so we can quickly detect
293 * when a decodebin2 is added to uridecodebin so we can set the
294 * post-stream-topology setting to TRUE */
295 dc->priv->element_added_id =
296 g_signal_connect_object (dc->priv->uridecodebin, "element-added",
297 G_CALLBACK (uridecodebin_element_added_cb), dc, 0);
298 tmp = gst_element_factory_make ("decodebin2", NULL);
299 dc->priv->decodebin2_type = G_OBJECT_TYPE (tmp);
300 gst_object_unref (tmp);
303 dc->priv->seeking_query = gst_query_new_seeking (format);
307 discoverer_reset (GstDiscoverer * dc)
309 GST_DEBUG_OBJECT (dc, "Resetting");
311 if (dc->priv->pending_uris) {
312 g_list_foreach (dc->priv->pending_uris, (GFunc) g_free, NULL);
313 g_list_free (dc->priv->pending_uris);
314 dc->priv->pending_uris = NULL;
317 if (dc->priv->pipeline)
318 gst_element_set_state ((GstElement *) dc->priv->pipeline, GST_STATE_NULL);
321 #define DISCONNECT_SIGNAL(o,i) G_STMT_START{ \
322 if ((i) && g_signal_handler_is_connected ((o), (i))) \
323 g_signal_handler_disconnect ((o), (i)); \
328 gst_discoverer_dispose (GObject * obj)
330 GstDiscoverer *dc = (GstDiscoverer *) obj;
332 GST_DEBUG_OBJECT (dc, "Disposing");
334 discoverer_reset (dc);
336 if (G_LIKELY (dc->priv->pipeline)) {
337 /* Workaround for bug #118536 */
338 DISCONNECT_SIGNAL (dc->priv->uridecodebin, dc->priv->pad_added_id);
339 DISCONNECT_SIGNAL (dc->priv->uridecodebin, dc->priv->pad_remove_id);
340 DISCONNECT_SIGNAL (dc->priv->uridecodebin, dc->priv->element_added_id);
341 DISCONNECT_SIGNAL (dc->priv->bus, dc->priv->bus_cb_id);
343 /* pipeline was set to NULL in _reset */
344 gst_object_unref (dc->priv->pipeline);
345 gst_object_unref (dc->priv->bus);
347 dc->priv->pipeline = NULL;
348 dc->priv->uridecodebin = NULL;
349 dc->priv->bus = NULL;
352 gst_discoverer_stop (dc);
354 if (dc->priv->lock) {
355 g_mutex_free (dc->priv->lock);
356 dc->priv->lock = NULL;
359 if (dc->priv->seeking_query) {
360 gst_query_unref (dc->priv->seeking_query);
361 dc->priv->seeking_query = NULL;
364 G_OBJECT_CLASS (gst_discoverer_parent_class)->dispose (obj);
368 gst_discoverer_set_property (GObject * object, guint prop_id,
369 const GValue * value, GParamSpec * pspec)
371 GstDiscoverer *dc = (GstDiscoverer *) object;
375 gst_discoverer_set_timeout (dc, g_value_get_uint64 (value));
378 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
384 gst_discoverer_get_property (GObject * object, guint prop_id,
385 GValue * value, GParamSpec * pspec)
387 GstDiscoverer *dc = (GstDiscoverer *) object;
392 g_value_set_uint64 (value, dc->priv->timeout);
396 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
402 gst_discoverer_set_timeout (GstDiscoverer * dc, GstClockTime timeout)
404 GST_DEBUG_OBJECT (dc, "timeout : %" GST_TIME_FORMAT, GST_TIME_ARGS (timeout));
406 /* FIXME : update current pending timeout if we're running */
408 dc->priv->timeout = timeout;
413 _event_probe (GstPad * pad, GstEvent * event, PrivateStream * ps)
415 if (GST_EVENT_TYPE (event) == GST_EVENT_TAG) {
416 GstTagList *tl = NULL, *tmp;
418 gst_event_parse_tag (event, &tl);
419 GST_DEBUG_OBJECT (pad, "tags %" GST_PTR_FORMAT, tl);
421 /* If preroll is complete, drop these tags - the collected information is
422 * possibly already being processed and adding more tags would be racy */
423 if (G_LIKELY (ps->dc->priv->processing)) {
424 GST_DEBUG_OBJECT (pad, "private stream %p old tags %" GST_PTR_FORMAT, ps,
426 tmp = gst_tag_list_merge (ps->tags, tl, GST_TAG_MERGE_APPEND);
428 gst_tag_list_free (ps->tags);
430 GST_DEBUG_OBJECT (pad, "private stream %p new tags %" GST_PTR_FORMAT, ps,
433 GST_DEBUG_OBJECT (pad, "Dropping tags since preroll is done");
434 DISCO_UNLOCK (ps->dc);
441 is_subtitle_caps (const GstCaps * caps)
443 static GstCaps *subs_caps = NULL;
446 subs_caps = gst_caps_from_string ("text/plain; text/x-pango-markup; "
447 "subpicture/x-pgs; subpicture/x-dvb; application/x-subtitle-unknown; "
448 "application/x-ssa; application/x-ass; subtitle/x-kate; "
449 "application/x-kate; video/x-dvd-subpicture; ");
452 return gst_caps_can_intersect (caps, subs_caps);
456 uridecodebin_pad_added_cb (GstElement * uridecodebin, GstPad * pad,
460 GstPad *sinkpad = NULL;
463 GST_DEBUG_OBJECT (dc, "pad %s:%s", GST_DEBUG_PAD_NAME (pad));
465 ps = g_slice_new0 (PrivateStream);
469 ps->queue = gst_element_factory_make ("queue", NULL);
470 ps->sink = gst_element_factory_make ("fakesink", NULL);
472 if (G_UNLIKELY (ps->queue == NULL || ps->sink == NULL))
475 g_object_set (ps->sink, "silent", TRUE, NULL);
476 g_object_set (ps->queue, "max-size-buffers", 1, "silent", TRUE, NULL);
478 caps = gst_pad_get_caps_reffed (pad);
480 if (is_subtitle_caps (caps)) {
481 /* Subtitle streams are sparse and may not provide any information - don't
482 * wait for data to preroll */
483 g_object_set (ps->sink, "async", FALSE, NULL);
486 gst_caps_unref (caps);
488 gst_bin_add_many (dc->priv->pipeline, ps->queue, ps->sink, NULL);
490 if (!gst_element_link_pads_full (ps->queue, "src", ps->sink, "sink",
491 GST_PAD_LINK_CHECK_NOTHING))
493 if (!gst_element_sync_state_with_parent (ps->sink))
495 if (!gst_element_sync_state_with_parent (ps->queue))
498 sinkpad = gst_element_get_static_pad (ps->queue, "sink");
501 if (gst_pad_link_full (pad, sinkpad,
502 GST_PAD_LINK_CHECK_NOTHING) != GST_PAD_LINK_OK)
504 gst_object_unref (sinkpad);
506 /* Add an event probe */
507 gst_pad_add_event_probe (pad, G_CALLBACK (_event_probe), ps);
510 dc->priv->streams = g_list_append (dc->priv->streams, ps);
513 GST_DEBUG_OBJECT (dc, "Done handling pad");
518 GST_ERROR_OBJECT (dc, "Error while handling pad");
520 gst_object_unref (sinkpad);
522 gst_object_unref (ps->queue);
524 gst_object_unref (ps->sink);
525 g_slice_free (PrivateStream, ps);
530 uridecodebin_pad_removed_cb (GstElement * uridecodebin, GstPad * pad,
537 GST_DEBUG_OBJECT (dc, "pad %s:%s", GST_DEBUG_PAD_NAME (pad));
539 /* Find the PrivateStream */
541 for (tmp = dc->priv->streams; tmp; tmp = tmp->next) {
542 ps = (PrivateStream *) tmp->data;
549 GST_DEBUG ("The removed pad wasn't controlled by us !");
553 dc->priv->streams = g_list_delete_link (dc->priv->streams, tmp);
556 gst_element_set_state (ps->sink, GST_STATE_NULL);
557 gst_element_set_state (ps->queue, GST_STATE_NULL);
558 gst_element_unlink (ps->queue, ps->sink);
560 sinkpad = gst_element_get_static_pad (ps->queue, "sink");
561 gst_pad_unlink (pad, sinkpad);
562 gst_object_unref (sinkpad);
564 /* references removed here */
565 gst_bin_remove_many (dc->priv->pipeline, ps->sink, ps->queue, NULL);
568 gst_tag_list_free (ps->tags);
571 g_slice_free (PrivateStream, ps);
573 GST_DEBUG ("Done handling pad");
576 static GstStructure *
577 collect_stream_information (GstDiscoverer * dc, PrivateStream * ps, guint idx)
583 stname = g_strdup_printf ("stream-%02d", idx);
584 st = gst_structure_empty_new (stname);
588 caps = gst_pad_get_negotiated_caps (ps->pad);
590 GST_WARNING ("Couldn't get negotiated caps from %s:%s",
591 GST_DEBUG_PAD_NAME (ps->pad));
592 caps = gst_pad_get_caps (ps->pad);
595 GST_DEBUG ("Got caps %" GST_PTR_FORMAT, caps);
596 gst_structure_id_set (st, _CAPS_QUARK, GST_TYPE_CAPS, caps, NULL);
598 gst_caps_unref (caps);
601 gst_structure_id_set (st, _TAGS_QUARK, GST_TYPE_STRUCTURE, ps->tags, NULL);
606 /* Parses a set of caps and tags in st and populates a GstDiscovererStreamInfo
607 * structure (parent, if !NULL, otherwise it allocates one)
609 static GstDiscovererStreamInfo *
610 collect_information (GstDiscoverer * dc, const GstStructure * st,
611 GstDiscovererStreamInfo * parent)
614 GstStructure *caps_st, *tags_st;
620 if (!st || !gst_structure_id_has_field (st, _CAPS_QUARK)) {
621 GST_WARNING ("Couldn't find caps !");
625 return (GstDiscovererStreamInfo *)
626 gst_mini_object_new (GST_TYPE_DISCOVERER_STREAM_INFO);
629 gst_structure_id_get (st, _CAPS_QUARK, GST_TYPE_CAPS, &caps, NULL);
630 caps_st = gst_caps_get_structure (caps, 0);
631 name = gst_structure_get_name (caps_st);
633 if (g_str_has_prefix (name, "audio/")) {
634 GstDiscovererAudioInfo *info;
637 info = (GstDiscovererAudioInfo *) parent;
639 info = (GstDiscovererAudioInfo *)
640 gst_mini_object_new (GST_TYPE_DISCOVERER_AUDIO_INFO);
641 info->parent.caps = caps;
644 if (gst_structure_get_int (caps_st, "rate", &tmp))
645 info->sample_rate = (guint) tmp;
647 if (gst_structure_get_int (caps_st, "channels", &tmp))
648 info->channels = (guint) tmp;
650 if (gst_structure_get_int (caps_st, "depth", &tmp))
651 info->depth = (guint) tmp;
653 if (gst_structure_id_has_field (st, _TAGS_QUARK)) {
654 gst_structure_id_get (st, _TAGS_QUARK,
655 GST_TYPE_STRUCTURE, &tags_st, NULL);
656 if (gst_structure_get_uint (tags_st, GST_TAG_BITRATE, &utmp) ||
657 gst_structure_get_uint (tags_st, GST_TAG_NOMINAL_BITRATE, &utmp))
658 info->bitrate = utmp;
660 if (gst_structure_get_uint (tags_st, GST_TAG_MAXIMUM_BITRATE, &utmp))
661 info->max_bitrate = utmp;
663 /* FIXME: Is it worth it to remove the tags we've parsed? */
664 info->parent.tags = gst_tag_list_merge (info->parent.tags,
665 (GstTagList *) tags_st, GST_TAG_MERGE_REPLACE);
667 gst_structure_free (tags_st);
670 if (!info->language && ((GstDiscovererStreamInfo *) info)->tags) {
672 if (gst_tag_list_get_string (((GstDiscovererStreamInfo *) info)->tags,
673 GST_TAG_LANGUAGE_CODE, &language)) {
674 info->language = language;
678 return (GstDiscovererStreamInfo *) info;
680 } else if (g_str_has_prefix (name, "video/") ||
681 g_str_has_prefix (name, "image/")) {
682 GstDiscovererVideoInfo *info;
683 GstVideoFormat format;
686 info = (GstDiscovererVideoInfo *) parent;
688 info = (GstDiscovererVideoInfo *)
689 gst_mini_object_new (GST_TYPE_DISCOVERER_VIDEO_INFO);
690 info->parent.caps = caps;
693 if (gst_video_format_parse_caps (caps, &format, &tmp, &tmp2)) {
694 info->width = (guint) tmp;
695 info->height = (guint) tmp2;
698 if (gst_structure_get_int (caps_st, "depth", &tmp))
699 info->depth = (guint) tmp;
701 if (gst_video_parse_caps_pixel_aspect_ratio (caps, &tmp, &tmp2)) {
703 info->par_denom = tmp2;
706 if (gst_video_parse_caps_framerate (caps, &tmp, &tmp2)) {
707 info->framerate_num = tmp;
708 info->framerate_denom = tmp2;
711 if (gst_video_format_parse_caps_interlaced (caps, &btmp))
712 info->interlaced = btmp;
714 if (gst_structure_id_has_field (st, _TAGS_QUARK)) {
715 gst_structure_id_get (st, _TAGS_QUARK,
716 GST_TYPE_STRUCTURE, &tags_st, NULL);
717 if (gst_structure_get_uint (tags_st, GST_TAG_BITRATE, &utmp) ||
718 gst_structure_get_uint (tags_st, GST_TAG_NOMINAL_BITRATE, &utmp))
719 info->bitrate = utmp;
721 if (gst_structure_get_uint (tags_st, GST_TAG_MAXIMUM_BITRATE, &utmp))
722 info->max_bitrate = utmp;
724 /* FIXME: Is it worth it to remove the tags we've parsed? */
725 info->parent.tags = gst_tag_list_merge (info->parent.tags,
726 (GstTagList *) tags_st, GST_TAG_MERGE_REPLACE);
727 gst_structure_free (tags_st);
730 return (GstDiscovererStreamInfo *) info;
732 } else if (is_subtitle_caps (caps)) {
733 GstDiscovererSubtitleInfo *info;
736 info = (GstDiscovererSubtitleInfo *) parent;
738 info = (GstDiscovererSubtitleInfo *)
739 gst_mini_object_new (GST_TYPE_DISCOVERER_SUBTITLE_INFO);
740 info->parent.caps = caps;
743 if (gst_structure_id_has_field (st, _TAGS_QUARK)) {
744 const gchar *language;
746 gst_structure_id_get (st, _TAGS_QUARK,
747 GST_TYPE_STRUCTURE, &tags_st, NULL);
749 language = gst_structure_get_string (caps_st, GST_TAG_LANGUAGE_CODE);
751 info->language = g_strdup (language);
753 /* FIXME: Is it worth it to remove the tags we've parsed? */
754 info->parent.tags = gst_tag_list_merge (info->parent.tags,
755 (GstTagList *) tags_st, GST_TAG_MERGE_REPLACE);
756 gst_structure_free (tags_st);
760 if (!info->language && ((GstDiscovererStreamInfo *) info)->tags) {
762 if (gst_tag_list_get_string (((GstDiscovererStreamInfo *) info)->tags,
763 GST_TAG_LANGUAGE_CODE, &language)) {
764 info->language = language;
768 return (GstDiscovererStreamInfo *) info;
771 /* None of the above - populate what information we can */
772 GstDiscovererStreamInfo *info;
777 info = (GstDiscovererStreamInfo *)
778 gst_mini_object_new (GST_TYPE_DISCOVERER_STREAM_INFO);
782 if (gst_structure_id_get (st, _TAGS_QUARK,
783 GST_TYPE_STRUCTURE, &tags_st, NULL)) {
784 info->tags = gst_tag_list_merge (info->tags, (GstTagList *) tags_st,
785 GST_TAG_MERGE_REPLACE);
786 gst_structure_free (tags_st);
794 static GstStructure *
795 find_stream_for_node (GstDiscoverer * dc, const GstStructure * topology)
798 GstPad *target_pad = NULL;
799 GstStructure *st = NULL;
804 if (!gst_structure_id_has_field (topology, _TOPOLOGY_PAD_QUARK)) {
805 GST_DEBUG ("Could not find pad for node %" GST_PTR_FORMAT "\n", topology);
809 gst_structure_id_get (topology, _TOPOLOGY_PAD_QUARK,
810 GST_TYPE_PAD, &pad, NULL);
812 if (!dc->priv->streams)
815 for (i = 0, tmp = dc->priv->streams; tmp; tmp = tmp->next, i++) {
816 ps = (PrivateStream *) tmp->data;
818 target_pad = gst_ghost_pad_get_target (GST_GHOST_PAD (ps->pad));
819 gst_object_unref (target_pad);
821 if (target_pad == pad)
826 st = collect_stream_information (dc, ps, i);
828 gst_object_unref (pad);
834 child_is_raw_stream (GstCaps * parent, GstCaps * child)
836 GstStructure *st1, *st2;
837 const gchar *name1, *name2;
839 st1 = gst_caps_get_structure (parent, 0);
840 name1 = gst_structure_get_name (st1);
841 st2 = gst_caps_get_structure (child, 0);
842 name2 = gst_structure_get_name (st2);
844 if ((g_str_has_prefix (name1, "audio/") &&
845 g_str_has_prefix (name2, "audio/x-raw")) ||
846 ((g_str_has_prefix (name1, "video/") ||
847 g_str_has_prefix (name1, "image/")) &&
848 g_str_has_prefix (name2, "video/x-raw"))) {
849 /* child is the "raw" sub-stream corresponding to parent */
853 if (is_subtitle_caps (parent))
859 /* If a parent is non-NULL, collected stream information will be appended to it
860 * (and where the information exists, it will be overriden)
862 static GstDiscovererStreamInfo *
863 parse_stream_topology (GstDiscoverer * dc, const GstStructure * topology,
864 GstDiscovererStreamInfo * parent)
866 GstDiscovererStreamInfo *res = NULL;
867 GstCaps *caps = NULL;
868 const GValue *nval = NULL;
870 GST_DEBUG ("parsing: %" GST_PTR_FORMAT, topology);
872 nval = gst_structure_get_value (topology, "next");
874 if (nval == NULL || GST_VALUE_HOLDS_STRUCTURE (nval)) {
875 GstStructure *st = find_stream_for_node (dc, topology);
876 gboolean add_to_list = TRUE;
879 res = collect_information (dc, st, parent);
880 gst_structure_free (st);
882 /* Didn't find a stream structure, so let's just use the caps we have */
883 res = collect_information (dc, topology, parent);
887 /* FIXME : aggregate with information from main streams */
888 GST_DEBUG ("Coudn't find 'next' ! might be the last entry");
891 const GstStructure *st;
893 st = gst_value_get_structure (nval);
895 GST_DEBUG ("next is a structure %" GST_PTR_FORMAT, st);
900 if (gst_structure_id_get (st, _CAPS_QUARK, GST_TYPE_CAPS, &caps, NULL)) {
901 if (gst_caps_can_intersect (parent->caps, caps)) {
902 /* We sometimes get an extra sub-stream from the parser. If this is
903 * the case, we just replace the parent caps with this stream's caps
904 * since they might contain more information */
905 gst_caps_unref (parent->caps);
908 parse_stream_topology (dc, st, parent);
911 } else if (child_is_raw_stream (parent->caps, caps)) {
912 /* This is the "raw" stream corresponding to the parent. This
913 * contains more information than the parent, tags etc. */
914 parse_stream_topology (dc, st, parent);
916 gst_caps_unref (caps);
919 GstDiscovererStreamInfo *next = parse_stream_topology (dc, st, NULL);
921 next->previous = res;
927 dc->priv->current_info->stream_list =
928 g_list_append (dc->priv->current_info->stream_list, res);
931 } else if (GST_VALUE_HOLDS_LIST (nval)) {
933 GstDiscovererContainerInfo *cont;
936 if (!gst_structure_id_get (topology, _CAPS_QUARK,
937 GST_TYPE_CAPS, &caps, NULL))
938 GST_WARNING ("Couldn't find caps !");
940 len = gst_value_list_get_size (nval);
941 GST_DEBUG ("next is a list of %d entries", len);
943 cont = (GstDiscovererContainerInfo *)
944 gst_mini_object_new (GST_TYPE_DISCOVERER_CONTAINER_INFO);
945 cont->parent.caps = caps;
946 res = (GstDiscovererStreamInfo *) cont;
948 if (gst_structure_id_has_field (topology, _TAGS_QUARK)) {
951 gst_structure_id_get (topology, _TAGS_QUARK,
952 GST_TYPE_STRUCTURE, &tags, NULL);
954 GST_DEBUG ("Merge tags %" GST_PTR_FORMAT, tags);
957 gst_tag_list_merge (cont->parent.tags, (GstTagList *) tags,
958 GST_TAG_MERGE_APPEND);
959 gst_tag_list_free (tags);
960 if (cont->parent.tags)
961 gst_tag_list_free (cont->parent.tags);
962 cont->parent.tags = tmp;
963 GST_DEBUG ("Container info tags %" GST_PTR_FORMAT, tmp);
966 for (i = 0; i < len; i++) {
967 const GValue *subv = gst_value_list_get_value (nval, i);
968 const GstStructure *subst = gst_value_get_structure (subv);
969 GstDiscovererStreamInfo *substream;
971 GST_DEBUG ("%d %" GST_PTR_FORMAT, i, subst);
973 substream = parse_stream_topology (dc, subst, NULL);
975 substream->previous = res;
977 g_list_append (cont->streams,
978 gst_discoverer_stream_info_ref (substream));
985 /* Called when pipeline is pre-rolled */
987 discoverer_collect (GstDiscoverer * dc)
989 GST_DEBUG ("Collecting information");
991 /* Stop the timeout handler if present */
992 if (dc->priv->timeoutid) {
993 g_source_remove (dc->priv->timeoutid);
994 dc->priv->timeoutid = 0;
997 if (dc->priv->streams) {
998 /* FIXME : Make this querying optional */
1000 GstElement *pipeline = (GstElement *) dc->priv->pipeline;
1001 GstFormat format = GST_FORMAT_TIME;
1004 GST_DEBUG ("Attempting to query duration");
1006 if (gst_element_query_duration (pipeline, &format, &dur)) {
1007 if (format == GST_FORMAT_TIME) {
1008 GST_DEBUG ("Got duration %" GST_TIME_FORMAT, GST_TIME_ARGS (dur));
1009 dc->priv->current_info->duration = (guint64) dur;
1013 if (dc->priv->seeking_query) {
1014 if (gst_element_query (pipeline, dc->priv->seeking_query)) {
1017 gst_query_parse_seeking (dc->priv->seeking_query, &format,
1018 &seekable, NULL, NULL);
1019 if (format == GST_FORMAT_TIME) {
1020 GST_DEBUG ("Got seekable %d", seekable);
1021 dc->priv->current_info->seekable = seekable;
1027 if (dc->priv->current_topology)
1028 dc->priv->current_info->stream_info = parse_stream_topology (dc,
1029 dc->priv->current_topology, NULL);
1032 * Images need some special handling. They do not have a duration, have
1033 * caps named image/<foo> (th exception being MJPEG video which is also
1034 * type image/jpeg), and should consist of precisely one stream (actually
1035 * initially there are 2, the image and raw stream, but we squash these
1036 * while parsing the stream topology). At some point, if we find that these
1037 * conditions are not sufficient, we can count the number of decoders and
1038 * parsers in the chain, and if there's more than one decoder, or any
1039 * parser at all, we should not mark this as an image.
1041 if (dc->priv->current_info->duration == 0 &&
1042 dc->priv->current_info->stream_info != NULL &&
1043 dc->priv->current_info->stream_info->next == NULL) {
1045 gst_caps_get_structure (dc->priv->current_info->stream_info->caps, 0);
1047 if (g_str_has_prefix (gst_structure_get_name (st), "image/"))
1048 ((GstDiscovererVideoInfo *) dc->priv->current_info->stream_info)->
1053 if (dc->priv->async) {
1054 GST_DEBUG ("Emitting 'discoverered'");
1055 g_signal_emit (dc, gst_discoverer_signals[SIGNAL_DISCOVERED], 0,
1056 dc->priv->current_info, dc->priv->current_error);
1057 /* Clients get a copy of current_info since it is a boxed type */
1058 gst_discoverer_info_unref (dc->priv->current_info);
1063 get_async_cb (gpointer cb_data, GSource * source, GSourceFunc * func,
1066 *func = (GSourceFunc) async_timeout_cb;
1070 /* Wrapper since GSourceCallbackFuncs don't expect a return value from ref() */
1072 _void_g_object_ref (gpointer object)
1074 g_object_ref (G_OBJECT (object));
1078 handle_current_async (GstDiscoverer * dc)
1081 static GSourceCallbackFuncs cb_funcs = {
1087 /* Attach a timeout to the main context */
1088 source = g_timeout_source_new (dc->priv->timeout / GST_MSECOND);
1089 g_source_set_callback_indirect (source, g_object_ref (dc), &cb_funcs);
1090 dc->priv->timeoutid = g_source_attach (source, dc->priv->ctx);
1091 g_source_unref (source);
1095 /* Returns TRUE if processing should stop */
1097 handle_message (GstDiscoverer * dc, GstMessage * msg)
1099 gboolean done = FALSE;
1101 GST_DEBUG_OBJECT (GST_MESSAGE_SRC (msg), "got a %s message",
1102 GST_MESSAGE_TYPE_NAME (msg));
1104 switch (GST_MESSAGE_TYPE (msg)) {
1105 case GST_MESSAGE_ERROR:{
1109 gst_message_parse_error (msg, &gerr, &debug);
1110 GST_WARNING_OBJECT (GST_MESSAGE_SRC (msg),
1111 "Got an error [debug:%s], [message:%s]", debug, gerr->message);
1112 dc->priv->current_error = gerr;
1115 /* We need to stop */
1118 GST_DEBUG ("Setting result to ERROR");
1119 dc->priv->current_info->result = GST_DISCOVERER_ERROR;
1123 case GST_MESSAGE_EOS:
1124 GST_DEBUG ("Got EOS !");
1128 case GST_MESSAGE_ASYNC_DONE:
1129 if (GST_MESSAGE_SRC (msg) == (GstObject *) dc->priv->pipeline) {
1130 GST_DEBUG ("Finished changing state asynchronously");
1136 case GST_MESSAGE_ELEMENT:
1138 GQuark sttype = gst_structure_get_name_id (msg->structure);
1139 GST_DEBUG_OBJECT (GST_MESSAGE_SRC (msg),
1140 "structure %" GST_PTR_FORMAT, msg->structure);
1141 if (sttype == _MISSING_PLUGIN_QUARK) {
1142 GST_DEBUG_OBJECT (GST_MESSAGE_SRC (msg),
1143 "Setting result to MISSING_PLUGINS");
1144 dc->priv->current_info->result = GST_DISCOVERER_MISSING_PLUGINS;
1145 dc->priv->current_info->misc = gst_structure_copy (msg->structure);
1146 } else if (sttype == _STREAM_TOPOLOGY_QUARK) {
1147 dc->priv->current_topology = gst_structure_copy (msg->structure);
1152 case GST_MESSAGE_TAG:
1154 GstTagList *tl, *tmp;
1156 gst_message_parse_tag (msg, &tl);
1157 GST_DEBUG_OBJECT (GST_MESSAGE_SRC (msg), "Got tags %" GST_PTR_FORMAT, tl);
1158 /* Merge with current tags */
1160 gst_tag_list_merge (dc->priv->current_info->tags, tl,
1161 GST_TAG_MERGE_APPEND);
1162 gst_tag_list_free (tl);
1163 if (dc->priv->current_info->tags)
1164 gst_tag_list_free (dc->priv->current_info->tags);
1165 dc->priv->current_info->tags = tmp;
1166 GST_DEBUG_OBJECT (GST_MESSAGE_SRC (msg), "Current info %p, tags %"
1167 GST_PTR_FORMAT, dc->priv->current_info, tmp);
1180 handle_current_sync (GstDiscoverer * dc)
1183 gdouble deadline = ((gdouble) dc->priv->timeout) / GST_SECOND;
1185 gboolean done = FALSE;
1187 timer = g_timer_new ();
1188 g_timer_start (timer);
1191 /* poll bus with timeout */
1192 /* FIXME : make the timeout more fine-tuned */
1193 if ((msg = gst_bus_timed_pop (dc->priv->bus, GST_SECOND / 2))) {
1194 done = handle_message (dc, msg);
1195 gst_message_unref (msg);
1198 } while (!done && (g_timer_elapsed (timer, NULL) < deadline));
1202 GST_DEBUG ("we timed out! Setting result to TIMEOUT");
1203 dc->priv->current_info->result = GST_DISCOVERER_TIMEOUT;
1208 g_timer_stop (timer);
1209 g_timer_destroy (timer);
1213 _setup_locked (GstDiscoverer * dc)
1215 GstStateChangeReturn ret;
1217 GST_DEBUG ("Setting up");
1219 /* Pop URI off the pending URI list */
1220 dc->priv->current_info =
1221 (GstDiscovererInfo *) gst_mini_object_new (GST_TYPE_DISCOVERER_INFO);
1222 dc->priv->current_info->uri = (gchar *) dc->priv->pending_uris->data;
1223 dc->priv->pending_uris =
1224 g_list_delete_link (dc->priv->pending_uris, dc->priv->pending_uris);
1226 /* set uri on uridecodebin */
1227 g_object_set (dc->priv->uridecodebin, "uri", dc->priv->current_info->uri,
1230 GST_DEBUG ("Current is now %s", dc->priv->current_info->uri);
1232 dc->priv->processing = TRUE;
1234 /* set pipeline to PAUSED */
1236 GST_DEBUG ("Setting pipeline to PAUSED");
1238 gst_element_set_state ((GstElement *) dc->priv->pipeline,
1242 GST_DEBUG_OBJECT (dc, "Pipeline going to PAUSED : %s",
1243 gst_element_state_change_return_get_name (ret));
1247 discoverer_cleanup (GstDiscoverer * dc)
1249 GST_DEBUG ("Cleaning up");
1251 gst_bus_set_flushing (dc->priv->bus, TRUE);
1252 gst_element_set_state ((GstElement *) dc->priv->pipeline, GST_STATE_READY);
1253 gst_bus_set_flushing (dc->priv->bus, FALSE);
1256 if (dc->priv->current_error)
1257 g_error_free (dc->priv->current_error);
1258 dc->priv->current_error = NULL;
1259 if (dc->priv->current_topology) {
1260 gst_structure_free (dc->priv->current_topology);
1261 dc->priv->current_topology = NULL;
1264 dc->priv->current_info = NULL;
1266 /* Try popping the next uri */
1267 if (dc->priv->async) {
1268 if (dc->priv->pending_uris != NULL) {
1272 handle_current_async (dc);
1276 g_signal_emit (dc, gst_discoverer_signals[SIGNAL_FINISHED], 0);
1285 discoverer_bus_cb (GstBus * bus, GstMessage * msg, GstDiscoverer * dc)
1287 if (dc->priv->processing) {
1288 if (handle_message (dc, msg)) {
1289 GST_DEBUG ("Stopping asynchronously");
1290 /* Serialise with _event_probe() */
1292 dc->priv->processing = FALSE;
1294 discoverer_collect (dc);
1295 discoverer_cleanup (dc);
1301 async_timeout_cb (GstDiscoverer * dc)
1303 if (!g_source_is_destroyed (g_main_current_source ())) {
1304 dc->priv->timeoutid = 0;
1305 GST_DEBUG ("Setting result to TIMEOUT");
1306 dc->priv->current_info->result = GST_DISCOVERER_TIMEOUT;
1307 dc->priv->processing = FALSE;
1308 discoverer_collect (dc);
1309 discoverer_cleanup (dc);
1314 /* If there is a pending URI, it will pop it from the list of pending
1315 * URIs and start the discovery on it.
1317 * Returns GST_DISCOVERER_OK if the next URI was popped and is processing,
1318 * else a error flag.
1320 static GstDiscovererResult
1321 start_discovering (GstDiscoverer * dc)
1323 GstDiscovererResult res = GST_DISCOVERER_OK;
1325 GST_DEBUG ("Starting");
1328 if (dc->priv->pending_uris == NULL) {
1329 GST_WARNING ("No URI to process");
1330 res = GST_DISCOVERER_URI_INVALID;
1335 if (dc->priv->current_info != NULL) {
1336 GST_WARNING ("Already processing a file");
1337 res = GST_DISCOVERER_BUSY;
1342 g_signal_emit (dc, gst_discoverer_signals[SIGNAL_STARTING], 0);
1348 if (dc->priv->async)
1349 handle_current_async (dc);
1351 handle_current_sync (dc);
1359 * gst_discoverer_start:
1360 * @discoverer: A #GstDiscoverer
1362 * Allow asynchronous discovering of URIs to take place.
1363 * A #GMainLoop must be available for #GstDiscoverer to properly work in
1364 * asynchronous mode.
1369 gst_discoverer_start (GstDiscoverer * discoverer)
1372 GMainContext *ctx = NULL;
1374 GST_DEBUG_OBJECT (discoverer, "Starting...");
1376 if (discoverer->priv->async) {
1377 GST_DEBUG_OBJECT (discoverer, "We were already started");
1381 discoverer->priv->async = TRUE;
1382 discoverer->priv->running = TRUE;
1384 ctx = g_main_context_get_thread_default ();
1386 /* Connect to bus signals */
1388 ctx = g_main_context_default ();
1390 source = gst_bus_create_watch (discoverer->priv->bus);
1391 g_source_set_callback (source, (GSourceFunc) gst_bus_async_signal_func,
1393 discoverer->priv->sourceid = g_source_attach (source, ctx);
1394 g_source_unref (source);
1395 discoverer->priv->ctx = g_main_context_ref (ctx);
1397 start_discovering (discoverer);
1398 GST_DEBUG_OBJECT (discoverer, "Started");
1402 * gst_discoverer_stop:
1403 * @discoverer: A #GstDiscoverer
1405 * Stop the discovery of any pending URIs and clears the list of
1406 * pending URIS (if any).
1411 gst_discoverer_stop (GstDiscoverer * discoverer)
1413 GST_DEBUG_OBJECT (discoverer, "Stopping...");
1415 if (!discoverer->priv->async) {
1416 GST_DEBUG_OBJECT (discoverer,
1417 "We were already stopped, or running synchronously");
1421 DISCO_LOCK (discoverer);
1422 if (discoverer->priv->processing) {
1423 /* We prevent any further processing by setting the bus to
1424 * flushing and setting the pipeline to READY.
1425 * _reset() will take care of the rest of the cleanup */
1426 if (discoverer->priv->bus)
1427 gst_bus_set_flushing (discoverer->priv->bus, TRUE);
1428 if (discoverer->priv->pipeline)
1429 gst_element_set_state ((GstElement *) discoverer->priv->pipeline,
1432 discoverer->priv->running = FALSE;
1433 DISCO_UNLOCK (discoverer);
1435 /* Remove timeout handler */
1436 if (discoverer->priv->timeoutid) {
1437 g_source_remove (discoverer->priv->timeoutid);
1438 discoverer->priv->timeoutid = 0;
1440 /* Remove signal watch */
1441 if (discoverer->priv->sourceid) {
1442 g_source_remove (discoverer->priv->sourceid);
1443 discoverer->priv->sourceid = 0;
1445 /* Unref main context */
1446 if (discoverer->priv->ctx) {
1447 g_main_context_unref (discoverer->priv->ctx);
1448 discoverer->priv->ctx = NULL;
1450 discoverer_reset (discoverer);
1452 discoverer->priv->async = FALSE;
1454 GST_DEBUG_OBJECT (discoverer, "Stopped");
1458 * gst_discoverer_discover_uri_async:
1459 * @discoverer: A #GstDiscoverer
1460 * @uri: the URI to add.
1462 * Appends the given @uri to the list of URIs to discoverer. The actual
1463 * discovery of the @uri will only take place if gst_discoverer_start() has
1466 * A copy of @uri will be made internally, so the caller can safely g_free()
1469 * Returns: %TRUE if the @uri was succesfully appended to the list of pending
1475 gst_discoverer_discover_uri_async (GstDiscoverer * discoverer,
1480 GST_DEBUG_OBJECT (discoverer, "uri : %s", uri);
1482 DISCO_LOCK (discoverer);
1483 can_run = (discoverer->priv->pending_uris == NULL);
1484 discoverer->priv->pending_uris =
1485 g_list_append (discoverer->priv->pending_uris, g_strdup (uri));
1486 DISCO_UNLOCK (discoverer);
1489 start_discovering (discoverer);
1495 /* Synchronous mode */
1497 * gst_discoverer_discover_uri:
1498 * @discoverer: A #GstDiscoverer
1499 * @uri: The URI to run on.
1500 * @err: (out) (allow-none): If an error occurred, this field will be filled in.
1502 * Synchronously discovers the given @uri.
1504 * A copy of @uri will be made internally, so the caller can safely g_free()
1507 * Returns: (transfer full): the result of the scanning. Can be %NULL if an
1513 gst_discoverer_discover_uri (GstDiscoverer * discoverer, const gchar * uri,
1516 GstDiscovererResult res = 0;
1517 GstDiscovererInfo *info;
1519 GST_DEBUG_OBJECT (discoverer, "uri:%s", uri);
1521 DISCO_LOCK (discoverer);
1522 if (G_UNLIKELY (discoverer->priv->current_info)) {
1523 DISCO_UNLOCK (discoverer);
1524 GST_WARNING_OBJECT (discoverer, "Already handling a uri");
1528 discoverer->priv->pending_uris =
1529 g_list_append (discoverer->priv->pending_uris, g_strdup (uri));
1530 DISCO_UNLOCK (discoverer);
1532 res = start_discovering (discoverer);
1533 discoverer_collect (discoverer);
1537 if (discoverer->priv->current_error)
1538 *err = g_error_copy (discoverer->priv->current_error);
1542 if (res != GST_DISCOVERER_OK) {
1543 GST_DEBUG ("Setting result to %d (was %d)", res,
1544 discoverer->priv->current_info->result);
1545 discoverer->priv->current_info->result = res;
1547 info = discoverer->priv->current_info;
1549 discoverer_cleanup (discoverer);
1555 * gst_discoverer_new:
1556 * @timeout: timeout per file, in nanoseconds. Allowed are values between
1557 * one second (#GST_SECOND) and one hour (3600 * #GST_SECOND)
1558 * @err: a pointer to a #GError. can be %NULL
1560 * Creates a new #GstDiscoverer with the provided timeout.
1562 * Returns: (transfer full): The new #GstDiscoverer.
1563 * If an error occurred when creating the discoverer, @err will be set
1564 * accordingly and %NULL will be returned. If @err is set, the caller must
1565 * free it when no longer needed using g_error_free().
1570 gst_discoverer_new (GstClockTime timeout, GError ** err)
1574 res = g_object_new (GST_TYPE_DISCOVERER, "timeout", timeout, NULL);
1575 if (res->priv->uridecodebin == NULL) {
1577 *err = g_error_new (GST_CORE_ERROR, GST_CORE_ERROR_MISSING_PLUGIN,
1578 "Couldn't create 'uridecodebin' element");
1579 gst_object_unref (res);