2 * (c) 2005 Ronald S. Bultje <rbultje@ronald.bitfreak.net>
3 * (c) 2006 Jan Schmidt <thaytan@noraisin.net>
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:element-autoaudiosink
23 * @see_also: autovideosink, alsasink, osssink
25 * autoaudiosink is an audio sink that automatically detects an appropriate
26 * audio sink to use. It does so by scanning the registry for all elements
27 * that have <quote>Sink</quote> and <quote>Audio</quote> in the class field
28 * of their element information, and also have a non-zero autoplugging rank.
31 * <title>Example launch line</title>
33 * gst-launch -v -m audiotestsrc ! audioconvert ! audioresample ! autoaudiosink
44 #include "gstautoaudiosink.h"
45 #include "gstautodetect.h"
47 #define DEFAULT_TS_OFFSET 0
57 static GstStateChangeReturn
58 gst_auto_audio_sink_change_state (GstElement * element,
59 GstStateChange transition);
60 static void gst_auto_audio_sink_dispose (GstAutoAudioSink * sink);
61 static void gst_auto_audio_sink_clear_kid (GstAutoAudioSink * sink);
62 static void gst_auto_audio_sink_set_property (GObject * object, guint prop_id,
63 const GValue * value, GParamSpec * pspec);
64 static void gst_auto_audio_sink_get_property (GObject * object, guint prop_id,
65 GValue * value, GParamSpec * pspec);
67 #define gst_auto_audio_sink_parent_class parent_class
68 G_DEFINE_TYPE (GstAutoAudioSink, gst_auto_audio_sink, GST_TYPE_BIN);
70 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
76 gst_auto_audio_sink_class_init (GstAutoAudioSinkClass * klass)
78 GObjectClass *gobject_class;
79 GstElementClass *eklass;
81 gobject_class = G_OBJECT_CLASS (klass);
82 eklass = GST_ELEMENT_CLASS (klass);
84 gobject_class->dispose = (GObjectFinalizeFunc) gst_auto_audio_sink_dispose;
85 gobject_class->set_property = gst_auto_audio_sink_set_property;
86 gobject_class->get_property = gst_auto_audio_sink_get_property;
88 eklass->change_state = GST_DEBUG_FUNCPTR (gst_auto_audio_sink_change_state);
91 * GstAutoAudioSink:filter-caps
93 * This property will filter out candidate sinks that can handle the specified
94 * caps. By default only audio sinks that support raw floating point and
95 * integer audio are selected.
97 * This property can only be set before the element goes to the READY state.
101 g_object_class_install_property (gobject_class, PROP_CAPS,
102 g_param_spec_boxed ("filter-caps", "Filter caps",
103 "Filter sink candidates using these caps.", GST_TYPE_CAPS,
104 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
106 g_object_class_install_property (gobject_class, PROP_TS_OFFSET,
107 g_param_spec_int64 ("ts-offset", "TS Offset",
108 "Timestamp offset in nanoseconds", G_MININT64, G_MAXINT64,
109 DEFAULT_TS_OFFSET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
111 gst_element_class_add_pad_template (eklass,
112 gst_static_pad_template_get (&sink_template));
114 gst_element_class_set_static_metadata (eklass, "Auto audio sink",
116 "Wrapper audio sink for automatically detected audio sink",
117 "Jan Schmidt <thaytan@noraisin.net>");
121 gst_auto_audio_sink_dispose (GstAutoAudioSink * sink)
123 gst_auto_audio_sink_clear_kid (sink);
125 if (sink->filter_caps)
126 gst_caps_unref (sink->filter_caps);
127 sink->filter_caps = NULL;
129 G_OBJECT_CLASS (parent_class)->dispose ((GObject *) sink);
133 gst_auto_audio_sink_clear_kid (GstAutoAudioSink * sink)
136 gst_element_set_state (sink->kid, GST_STATE_NULL);
137 gst_bin_remove (GST_BIN (sink), sink->kid);
139 /* Don't lose the SINK flag */
140 GST_OBJECT_FLAG_SET (sink, GST_ELEMENT_FLAG_SINK);
145 * Hack to make initial linking work; ideally, this'd work even when
146 * no target has been assigned to the ghostpad yet.
149 gst_auto_audio_sink_reset (GstAutoAudioSink * sink)
153 gst_auto_audio_sink_clear_kid (sink);
155 /* fakesink placeholder */
156 sink->kid = gst_element_factory_make ("fakesink", "tempsink");
157 gst_bin_add (GST_BIN (sink), sink->kid);
160 targetpad = gst_element_get_static_pad (sink->kid, "sink");
161 gst_ghost_pad_set_target (GST_GHOST_PAD (sink->pad), targetpad);
162 gst_object_unref (targetpad);
165 static GstStaticCaps raw_caps = GST_STATIC_CAPS ("audio/x-raw");
168 gst_auto_audio_sink_init (GstAutoAudioSink * sink)
170 sink->pad = gst_ghost_pad_new_no_target ("sink", GST_PAD_SINK);
171 gst_element_add_pad (GST_ELEMENT (sink), sink->pad);
173 gst_auto_audio_sink_reset (sink);
175 /* set the default raw audio caps */
176 sink->filter_caps = gst_static_caps_get (&raw_caps);
177 sink->ts_offset = DEFAULT_TS_OFFSET;
180 GST_OBJECT_FLAG_SET (sink, GST_ELEMENT_FLAG_SINK);
184 gst_auto_audio_sink_factory_filter (GstPluginFeature * feature, gpointer data)
189 /* we only care about element factories */
190 if (!GST_IS_ELEMENT_FACTORY (feature))
194 klass = gst_element_factory_get_klass (GST_ELEMENT_FACTORY (feature));
195 if (!(strstr (klass, "Sink") && strstr (klass, "Audio")))
198 /* only select elements with autoplugging rank */
199 rank = gst_plugin_feature_get_rank (feature);
200 if (rank < GST_RANK_MARGINAL)
207 gst_auto_audio_sink_compare_ranks (GstPluginFeature * f1, GstPluginFeature * f2)
211 diff = gst_plugin_feature_get_rank (f2) - gst_plugin_feature_get_rank (f1);
214 return strcmp (gst_plugin_feature_get_name (f2),
215 gst_plugin_feature_get_name (f1));
219 gst_auto_audio_sink_create_element_with_pretty_name (GstAutoAudioSink * sink,
220 GstElementFactory * factory)
223 gchar *name, *marker;
225 marker = g_strdup (GST_OBJECT_NAME (factory));
226 if (g_str_has_suffix (marker, "sink"))
227 marker[strlen (marker) - 4] = '\0';
228 if (g_str_has_prefix (marker, "gst"))
229 g_memmove (marker, marker + 3, strlen (marker + 3) + 1);
230 name = g_strdup_printf ("%s-actual-sink-%s", GST_OBJECT_NAME (sink), marker);
233 element = gst_element_factory_create (factory, name);
240 gst_auto_audio_sink_find_best (GstAutoAudioSink * sink)
243 GstElement *choice = NULL;
244 GstMessage *message = NULL;
245 GSList *errors = NULL;
246 GstBus *bus = gst_bus_new ();
247 GstPad *el_pad = NULL;
248 GstCaps *el_caps = NULL;
249 gboolean no_match = TRUE;
251 list = gst_registry_feature_filter (gst_registry_get (),
252 (GstPluginFeatureFilter) gst_auto_audio_sink_factory_filter, FALSE, sink);
253 list = g_list_sort (list, (GCompareFunc) gst_auto_audio_sink_compare_ranks);
255 /* We don't treat sound server sinks special. Our policy is that sound
256 * server sinks that have a rank must not auto-spawn a daemon under any
257 * circumstances, so there's nothing for us to worry about here */
258 GST_LOG_OBJECT (sink, "Trying to find usable audio devices ...");
260 for (item = list; item != NULL; item = item->next) {
261 GstElementFactory *f = GST_ELEMENT_FACTORY (item->data);
264 if ((el = gst_auto_audio_sink_create_element_with_pretty_name (sink, f))) {
265 GstStateChangeReturn ret;
267 GST_DEBUG_OBJECT (sink, "Testing %s", GST_OBJECT_NAME (f));
269 /* If autoaudiosink has been provided with filter caps,
270 * accept only sinks that match with the filter caps */
271 if (sink->filter_caps) {
272 el_pad = gst_element_get_static_pad (GST_ELEMENT (el), "sink");
273 el_caps = gst_pad_query_caps (el_pad, NULL);
274 gst_object_unref (el_pad);
275 GST_DEBUG_OBJECT (sink,
276 "Checking caps: %" GST_PTR_FORMAT " vs. %" GST_PTR_FORMAT,
277 sink->filter_caps, el_caps);
278 no_match = !gst_caps_can_intersect (sink->filter_caps, el_caps);
279 gst_caps_unref (el_caps);
282 GST_DEBUG_OBJECT (sink, "Incompatible caps");
283 gst_object_unref (el);
286 GST_DEBUG_OBJECT (sink, "Found compatible caps");
290 gst_element_set_bus (el, bus);
291 ret = gst_element_set_state (el, GST_STATE_READY);
292 if (ret == GST_STATE_CHANGE_SUCCESS) {
293 GST_DEBUG_OBJECT (sink, "This worked!");
298 /* collect all error messages */
299 while ((message = gst_bus_pop_filtered (bus, GST_MESSAGE_ERROR))) {
300 GST_DEBUG_OBJECT (sink, "error message %" GST_PTR_FORMAT, message);
301 errors = g_slist_append (errors, message);
304 gst_element_set_state (el, GST_STATE_NULL);
305 gst_object_unref (el);
309 GST_DEBUG_OBJECT (sink, "done trying");
312 /* FIXME: we forward the first error for now; but later on it might make
313 * sense to actually analyse them */
314 gst_message_ref (GST_MESSAGE (errors->data));
315 GST_DEBUG_OBJECT (sink, "reposting message %p", errors->data);
316 gst_element_post_message (GST_ELEMENT (sink), GST_MESSAGE (errors->data));
318 /* send warning message to application and use a fakesink */
319 GST_ELEMENT_WARNING (sink, RESOURCE, NOT_FOUND, (NULL),
320 ("Failed to find a usable audio sink"));
321 choice = gst_element_factory_make ("fakesink", "fake-audio-sink");
322 if (g_object_class_find_property (G_OBJECT_GET_CLASS (choice), "sync"))
323 g_object_set (choice, "sync", TRUE, NULL);
324 gst_element_set_state (choice, GST_STATE_READY);
327 gst_object_unref (bus);
328 gst_plugin_feature_list_free (list);
329 g_slist_foreach (errors, (GFunc) gst_mini_object_unref, NULL);
330 g_slist_free (errors);
336 gst_auto_audio_sink_detect (GstAutoAudioSink * sink)
341 gst_auto_audio_sink_clear_kid (sink);
344 GST_DEBUG_OBJECT (sink, "Creating new kid");
345 if (!(esink = gst_auto_audio_sink_find_best (sink)))
348 g_object_set (G_OBJECT (esink), "ts-offset", sink->ts_offset, NULL);
351 /* Ensure the child is brought up to the right state to match the parent
352 * although it's currently always in READY and
353 * we're always doing NULL->READY. */
354 if (GST_STATE (sink->kid) < GST_STATE (sink))
355 gst_element_set_state (sink->kid, GST_STATE (sink));
357 gst_bin_add (GST_BIN (sink), esink);
359 /* attach ghost pad */
360 GST_DEBUG_OBJECT (sink, "Re-assigning ghostpad");
361 targetpad = gst_element_get_static_pad (sink->kid, "sink");
362 if (!gst_ghost_pad_set_target (GST_GHOST_PAD (sink->pad), targetpad))
365 gst_object_unref (targetpad);
366 GST_DEBUG_OBJECT (sink, "done changing auto audio sink");
373 GST_ELEMENT_ERROR (sink, LIBRARY, INIT, (NULL),
374 ("Failed to find a supported audio sink"));
379 GST_ELEMENT_ERROR (sink, LIBRARY, INIT, (NULL),
380 ("Failed to set target pad"));
381 gst_object_unref (targetpad);
386 static GstStateChangeReturn
387 gst_auto_audio_sink_change_state (GstElement * element,
388 GstStateChange transition)
390 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
391 GstAutoAudioSink *sink = GST_AUTO_AUDIO_SINK (element);
393 switch (transition) {
394 case GST_STATE_CHANGE_NULL_TO_READY:
395 if (!gst_auto_audio_sink_detect (sink))
396 return GST_STATE_CHANGE_FAILURE;
402 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
403 if (ret == GST_STATE_CHANGE_FAILURE)
406 switch (transition) {
407 case GST_STATE_CHANGE_READY_TO_NULL:
408 gst_auto_audio_sink_reset (sink);
418 gst_auto_audio_sink_set_property (GObject * object, guint prop_id,
419 const GValue * value, GParamSpec * pspec)
421 GstAutoAudioSink *sink = GST_AUTO_AUDIO_SINK (object);
425 if (sink->filter_caps)
426 gst_caps_unref (sink->filter_caps);
427 sink->filter_caps = gst_caps_copy (gst_value_get_caps (value));
430 sink->ts_offset = g_value_get_int64 (value);
432 g_object_set_property (G_OBJECT (sink->kid), pspec->name, value);
435 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
441 gst_auto_audio_sink_get_property (GObject * object, guint prop_id,
442 GValue * value, GParamSpec * pspec)
444 GstAutoAudioSink *sink = GST_AUTO_AUDIO_SINK (object);
448 gst_value_set_caps (value, sink->filter_caps);
452 g_value_set_int64 (value, sink->ts_offset);
455 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);