gst/autodetect/gstautoaudiosrc.c

   1 /* GStreamer
   2  * (c) 2005 Ronald S. Bultje <rbultje@ronald.bitfreak.net>
   3  * (c) 2006 Jan Schmidt <thaytan@noraisin.net>
   4  * (c) 2008 Stefan Kost <ensonic@users.sf.net>
   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-autoaudiosrc
  24  * @see_also: autovideosrc, alsasrc, osssrc
  25  *
  26  * autoaudiosrc is an audio source that automatically detects an appropriate
  27  * audio source to use.  It does so by scanning the registry for all elements
  28  * that have <quote>Source</quote> and <quote>Audio</quote> in the class field
  29  * of their element information, and also have a non-zero autoplugging rank.
  30  *
  31  * <refsect2>
  32  * <title>Example launch line</title>
  33  * |[
  34  * gst-launch -v -m autoaudiosrc ! audioconvert ! audioresample ! autoaudiosink
  35  * ]|
  36  * </refsect2>
  37  */
  38
  39 #ifdef HAVE_CONFIG_H
  40 #include "config.h"
  41 #endif
  42
  43 #include <string.h>
  44
  45 #include "gstautoaudiosrc.h"
  46 #include "gstautodetect.h"
  47
  48 /* Properties */
  49 enum
  50 {
  51   PROP_0,
  52   PROP_CAPS,
  53 };
  54
  55 static GstStateChangeReturn
  56 gst_auto_audio_src_change_state (GstElement * element,
  57     GstStateChange transition);
  58 static void gst_auto_audio_src_dispose (GstAutoAudioSrc * src);
  59 static void gst_auto_audio_src_clear_kid (GstAutoAudioSrc * src);
  60 static void gst_auto_audio_src_set_property (GObject * object, guint prop_id,
  61     const GValue * value, GParamSpec * pspec);
  62 static void gst_auto_audio_src_get_property (GObject * object, guint prop_id,
  63     GValue * value, GParamSpec * pspec);
  64
  65 #define gst_auto_audio_src_parent_class parent_class
  66 G_DEFINE_TYPE (GstAutoAudioSrc, gst_auto_audio_src, GST_TYPE_BIN);
  67
  68 static GstStaticPadTemplate src_template = GST_STATIC_PAD_TEMPLATE ("src",
  69     GST_PAD_SRC,
  70     GST_PAD_ALWAYS,
  71     GST_STATIC_CAPS_ANY);
  72
  73 static void
  74 gst_auto_audio_src_class_init (GstAutoAudioSrcClass * klass)
  75 {
  76   GObjectClass *gobject_class;
  77   GstElementClass *eklass;
  78
  79   gobject_class = G_OBJECT_CLASS (klass);
  80   eklass = GST_ELEMENT_CLASS (klass);
  81
  82   gobject_class->dispose = (GObjectFinalizeFunc) gst_auto_audio_src_dispose;
  83   gobject_class->set_property = gst_auto_audio_src_set_property;
  84   gobject_class->get_property = gst_auto_audio_src_get_property;
  85
  86   eklass->change_state = GST_DEBUG_FUNCPTR (gst_auto_audio_src_change_state);
  87
  88   /**
  89    * GstAutoAudioSrc:filter-caps
  90    *
  91    * This property will filter out candidate sinks that can handle the specified
  92    * caps. By default only audio sinks that support raw floating point and
  93    * integer audio are selected.
  94    *
  95    * This property can only be set before the element goes to the READY state.
  96    *
  97    * Since: 0.10.14
  98    **/
  99   g_object_class_install_property (gobject_class, PROP_CAPS,
 100       g_param_spec_boxed ("filter-caps", "Filter caps",
 101           "Filter sink candidates using these caps.", GST_TYPE_CAPS,
 102           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 103
 104   gst_element_class_add_pad_template (eklass,
 105       gst_static_pad_template_get (&src_template));
 106
 107   gst_element_class_set_details_simple (eklass, "Auto audio source",
 108       "Source/Audio",
 109       "Wrapper audio source for automatically detected audio source",
 110       "Jan Schmidt <thaytan@noraisin.net>, "
 111       "Stefan Kost <ensonic@users.sf.net>");
 112 }
 113
 114 static void
 115 gst_auto_audio_src_dispose (GstAutoAudioSrc * src)
 116 {
 117   gst_auto_audio_src_clear_kid (src);
 118
 119   if (src->filter_caps)
 120     gst_caps_unref (src->filter_caps);
 121   src->filter_caps = NULL;
 122
 123   G_OBJECT_CLASS (parent_class)->dispose ((GObject *) src);
 124 }
 125
 126 static void
 127 gst_auto_audio_src_clear_kid (GstAutoAudioSrc * src)
 128 {
 129   if (src->kid) {
 130     gst_element_set_state (src->kid, GST_STATE_NULL);
 131     gst_bin_remove (GST_BIN (src), src->kid);
 132     src->kid = NULL;
 133
 134     /* Don't lose SOURCE flag */
 135     GST_OBJECT_FLAG_SET (src, GST_ELEMENT_IS_SOURCE);
 136   }
 137 }
 138
 139 /*
 140  * Hack to make initial linking work; ideally, this'd work even when
 141  * no target has been assigned to the ghostpad yet.
 142  */
 143 static void
 144 gst_auto_audio_src_reset (GstAutoAudioSrc * src)
 145 {
 146   GstPad *targetpad;
 147
 148   gst_auto_audio_src_clear_kid (src);
 149
 150   /* fakesink placeholder */
 151   src->kid = gst_element_factory_make ("fakesrc", "tempsrc");
 152   gst_bin_add (GST_BIN (src), src->kid);
 153
 154   /* pad */
 155   targetpad = gst_element_get_static_pad (src->kid, "src");
 156   gst_ghost_pad_set_target (GST_GHOST_PAD (src->pad), targetpad);
 157   gst_object_unref (targetpad);
 158 }
 159
 160 static GstStaticCaps raw_caps =
 161     GST_STATIC_CAPS ("audio/x-raw-int; audio/x-raw-float");
 162
 163 static void
 164 gst_auto_audio_src_init (GstAutoAudioSrc * src)
 165 {
 166   src->pad = gst_ghost_pad_new_no_target ("src", GST_PAD_SRC);
 167   gst_element_add_pad (GST_ELEMENT (src), src->pad);
 168
 169   gst_auto_audio_src_reset (src);
 170
 171   /* set the default raw audio caps */
 172   src->filter_caps = gst_static_caps_get (&raw_caps);
 173
 174   /* mark as source */
 175   GST_OBJECT_FLAG_SET (src, GST_ELEMENT_IS_SOURCE);
 176 }
 177
 178 static gboolean
 179 gst_auto_audio_src_factory_filter (GstPluginFeature * feature, gpointer data)
 180 {
 181   guint rank;
 182   const gchar *klass;
 183
 184   /* we only care about element factories */
 185   if (!GST_IS_ELEMENT_FACTORY (feature))
 186     return FALSE;
 187
 188   /* audio sinks */
 189   klass = gst_element_factory_get_klass (GST_ELEMENT_FACTORY (feature));
 190   if (!(strstr (klass, "Source") && strstr (klass, "Audio")))
 191     return FALSE;
 192
 193   /* only select elements with autoplugging rank */
 194   rank = gst_plugin_feature_get_rank (feature);
 195   if (rank < GST_RANK_MARGINAL)
 196     return FALSE;
 197
 198   return TRUE;
 199 }
 200
 201 static gint
 202 gst_auto_audio_src_compare_ranks (GstPluginFeature * f1, GstPluginFeature * f2)
 203 {
 204   gint diff;
 205
 206   diff = gst_plugin_feature_get_rank (f2) - gst_plugin_feature_get_rank (f1);
 207   if (diff != 0)
 208     return diff;
 209   return strcmp (gst_plugin_feature_get_name (f2),
 210       gst_plugin_feature_get_name (f1));
 211 }
 212
 213 static GstElement *
 214 gst_auto_audio_src_create_element_with_pretty_name (GstAutoAudioSrc * src,
 215     GstElementFactory * factory)
 216 {
 217   GstElement *element;
 218   gchar *name, *marker;
 219
 220   marker = g_strdup (GST_OBJECT_NAME (factory));
 221   if (g_str_has_suffix (marker, "src"))
 222     marker[strlen (marker) - 4] = '\0';
 223   if (g_str_has_prefix (marker, "gst"))
 224     g_memmove (marker, marker + 3, strlen (marker + 3) + 1);
 225   name = g_strdup_printf ("%s-actual-src-%s", GST_OBJECT_NAME (src), marker);
 226   g_free (marker);
 227
 228   element = gst_element_factory_create (factory, name);
 229   g_free (name);
 230
 231   return element;
 232 }
 233
 234 static GstElement *
 235 gst_auto_audio_src_find_best (GstAutoAudioSrc * src)
 236 {
 237   GList *list, *item;
 238   GstElement *choice = NULL;
 239   GstMessage *message = NULL;
 240   GSList *errors = NULL;
 241   GstBus *bus = gst_bus_new ();
 242   GstPad *el_pad = NULL;
 243   GstCaps *el_caps = NULL;
 244   gboolean no_match = TRUE;
 245
 246   list = gst_registry_feature_filter (gst_registry_get_default (),
 247       (GstPluginFeatureFilter) gst_auto_audio_src_factory_filter, FALSE, src);
 248   list = g_list_sort (list, (GCompareFunc) gst_auto_audio_src_compare_ranks);
 249
 250   /* We don't treat sound server sources special. Our policy is that sound
 251    * server sources that have a rank must not auto-spawn a daemon under any
 252    * circumstances, so there's nothing for us to worry about here */
 253   GST_LOG_OBJECT (src, "Trying to find usable audio devices ...");
 254
 255   for (item = list; item != NULL; item = item->next) {
 256     GstElementFactory *f = GST_ELEMENT_FACTORY (item->data);
 257     GstElement *el;
 258
 259     if ((el = gst_auto_audio_src_create_element_with_pretty_name (src, f))) {
 260       GstStateChangeReturn ret;
 261
 262       GST_DEBUG_OBJECT (src, "Testing %s", GST_OBJECT_NAME (f));
 263
 264       /* If autoAudioSrc has been provided with filter caps,
 265        * accept only sources that match with the filter caps */
 266       if (src->filter_caps) {
 267         el_pad = gst_element_get_static_pad (GST_ELEMENT (el), "src");
 268         el_caps = gst_pad_get_caps (el_pad, NULL);
 269         gst_object_unref (el_pad);
 270         GST_DEBUG_OBJECT (src,
 271             "Checking caps: %" GST_PTR_FORMAT " vs. %" GST_PTR_FORMAT,
 272             src->filter_caps, el_caps);
 273         no_match = !gst_caps_can_intersect (src->filter_caps, el_caps);
 274         gst_caps_unref (el_caps);
 275
 276         if (no_match) {
 277           GST_DEBUG_OBJECT (src, "Incompatible caps");
 278           gst_object_unref (el);
 279           continue;
 280         } else {
 281           GST_DEBUG_OBJECT (src, "Found compatible caps");
 282         }
 283       }
 284
 285       gst_element_set_bus (el, bus);
 286       ret = gst_element_set_state (el, GST_STATE_READY);
 287       if (ret == GST_STATE_CHANGE_SUCCESS) {
 288         GST_DEBUG_OBJECT (src, "This worked!");
 289         choice = el;
 290         break;
 291       }
 292
 293       /* collect all error messages */
 294       while ((message = gst_bus_pop_filtered (bus, GST_MESSAGE_ERROR))) {
 295         GST_DEBUG_OBJECT (src, "error message %" GST_PTR_FORMAT, message);
 296         errors = g_slist_append (errors, message);
 297       }
 298
 299       gst_element_set_state (el, GST_STATE_NULL);
 300       gst_object_unref (el);
 301     }
 302   }
 303
 304   GST_DEBUG_OBJECT (src, "done trying");
 305   if (!choice) {
 306     if (errors) {
 307       /* FIXME: we forward the first error for now; but later on it might make
 308        * sense to actually analyse them */
 309       gst_message_ref (GST_MESSAGE (errors->data));
 310       GST_DEBUG_OBJECT (src, "reposting message %p", errors->data);
 311       gst_element_post_message (GST_ELEMENT (src), GST_MESSAGE (errors->data));
 312     } else {
 313       /* send warning message to application and use a fakesrc */
 314       GST_ELEMENT_WARNING (src, RESOURCE, NOT_FOUND, (NULL),
 315           ("Failed to find a usable audio source"));
 316       choice = gst_element_factory_make ("fakesrc", "fake-audio-src");
 317       if (g_object_class_find_property (G_OBJECT_GET_CLASS (choice), "sync"))
 318         g_object_set (choice, "sync", TRUE, NULL);
 319       gst_element_set_state (choice, GST_STATE_READY);
 320     }
 321   }
 322   gst_object_unref (bus);
 323   gst_plugin_feature_list_free (list);
 324   g_slist_foreach (errors, (GFunc) gst_mini_object_unref, NULL);
 325   g_slist_free (errors);
 326
 327   return choice;
 328 }
 329
 330 static gboolean
 331 gst_auto_audio_src_detect (GstAutoAudioSrc * src)
 332 {
 333   GstElement *esrc;
 334   GstPad *targetpad;
 335
 336   gst_auto_audio_src_clear_kid (src);
 337
 338   /* find element */
 339   GST_DEBUG_OBJECT (src, "Creating new kid");
 340   if (!(esrc = gst_auto_audio_src_find_best (src)))
 341     goto no_src;
 342
 343   src->kid = esrc;
 344   /* Ensure the child is brought up to the right state to match the parent
 345    * although it's currently always in READY and
 346    * we're always doing NULL->READY. */
 347   if (GST_STATE (src->kid) < GST_STATE (src))
 348     gst_element_set_state (src->kid, GST_STATE (src));
 349
 350   gst_bin_add (GST_BIN (src), esrc);
 351
 352   /* attach ghost pad */
 353   GST_DEBUG_OBJECT (src, "Re-assigning ghostpad");
 354   targetpad = gst_element_get_static_pad (src->kid, "src");
 355   if (!gst_ghost_pad_set_target (GST_GHOST_PAD (src->pad), targetpad))
 356     goto target_failed;
 357
 358   gst_object_unref (targetpad);
 359   GST_DEBUG_OBJECT (src, "done changing auto audio source");
 360
 361   return TRUE;
 362
 363   /* ERRORS */
 364 no_src:
 365   {
 366     GST_ELEMENT_ERROR (src, LIBRARY, INIT, (NULL),
 367         ("Failed to find a supported audio source"));
 368     return FALSE;
 369   }
 370 target_failed:
 371   {
 372     GST_ELEMENT_ERROR (src, LIBRARY, INIT, (NULL),
 373         ("Failed to set target pad"));
 374     gst_object_unref (targetpad);
 375     return FALSE;
 376   }
 377 }
 378
 379 static GstStateChangeReturn
 380 gst_auto_audio_src_change_state (GstElement * element,
 381     GstStateChange transition)
 382 {
 383   GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
 384   GstAutoAudioSrc *src = GST_AUTO_AUDIO_SRC (element);
 385
 386   switch (transition) {
 387     case GST_STATE_CHANGE_NULL_TO_READY:
 388       if (!gst_auto_audio_src_detect (src))
 389         return GST_STATE_CHANGE_FAILURE;
 390       break;
 391     default:
 392       break;
 393   }
 394
 395   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 396   if (ret == GST_STATE_CHANGE_FAILURE)
 397     return ret;
 398
 399   switch (transition) {
 400     case GST_STATE_CHANGE_READY_TO_NULL:
 401       gst_auto_audio_src_reset (src);
 402       break;
 403     default:
 404       break;
 405   }
 406
 407   return ret;
 408 }
 409
 410 static void
 411 gst_auto_audio_src_set_property (GObject * object, guint prop_id,
 412     const GValue * value, GParamSpec * pspec)
 413 {
 414   GstAutoAudioSrc *src = GST_AUTO_AUDIO_SRC (object);
 415
 416   switch (prop_id) {
 417     case PROP_CAPS:
 418       if (src->filter_caps)
 419         gst_caps_unref (src->filter_caps);
 420       src->filter_caps = gst_caps_copy (gst_value_get_caps (value));
 421       break;
 422     default:
 423       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 424       break;
 425   }
 426 }
 427
 428 static void
 429 gst_auto_audio_src_get_property (GObject * object, guint prop_id,
 430     GValue * value, GParamSpec * pspec)
 431 {
 432   GstAutoAudioSrc *src = GST_AUTO_AUDIO_SRC (object);
 433
 434   switch (prop_id) {
 435     case PROP_CAPS:{
 436       gst_value_set_caps (value, src->filter_caps);
 437       break;
 438     }
 439     default:
 440       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 441       break;
 442   }
 443 }