gst-libs/gst/audio/mixerutils.c

   1 /* GStreamer
   2  * Copyright (C) 2003-2004 Ronald Bultje <rbultje@ronald.bitfreak.net>
   3  * Copyright (C) 2005-2006 Tim-Philipp Müller <tim centricular net>
   4  *
   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.
   9  *
  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.
  14  *
  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.
  19  */
  20
  21 /**
  22  * SECTION:gstaudiomixerutils
  23  * @short_description:  utility functions to find available audio mixers
  24  *                      from the plugin registry
  25  *
  26  * <refsect2>
  27  * <para>
  28  * Provides some utility functions to detect available audio mixers
  29  * on the system.
  30  * </para>
  31  * </refsect2>
  32  */
  33
  34 #ifdef HAVE_CONFIG_H
  35 #include "config.h"
  36 #endif
  37
  38 #include "mixerutils.h"
  39
  40 #include <string.h>
  41
  42 static void
  43 gst_audio_mixer_filter_do_filter (GstAudioMixerFilterFunc filter_func,
  44     GstElementFactory * factory,
  45     GstElement ** p_element, GList ** p_collection, gpointer user_data)
  46 {
  47   /* so, the element is a mixer, let's see if the caller wants it */
  48   if (filter_func != NULL) {
  49     if (filter_func (GST_MIXER (*p_element), user_data) == TRUE) {
  50       *p_collection = g_list_prepend (*p_collection, *p_element);
  51       /* do not set state back to NULL here on purpose, caller
  52        * might want to keep the mixer open */
  53       *p_element = NULL;
  54     }
  55   } else {
  56     gst_element_set_state (*p_element, GST_STATE_NULL);
  57     *p_collection = g_list_prepend (*p_collection, *p_element);
  58     *p_element = NULL;
  59   }
  60
  61   /* create new element for further probing if the old one was cleared */
  62   if (*p_element == NULL) {
  63     *p_element = gst_element_factory_create (factory, NULL);
  64   }
  65 }
  66
  67 static gboolean
  68 gst_audio_mixer_filter_check_element (GstElement * element)
  69 {
  70   GstStateChangeReturn ret;
  71
  72   /* open device (only then we can know for sure whether it is a mixer) */
  73   gst_element_set_state (element, GST_STATE_READY);
  74   ret = gst_element_get_state (element, NULL, NULL, 1 * GST_SECOND);
  75   if (ret != GST_STATE_CHANGE_SUCCESS) {
  76     GST_DEBUG ("could not open device / set element to READY");
  77     gst_element_set_state (element, GST_STATE_NULL);
  78     return FALSE;
  79   }
  80
  81   /* is this device a mixer? */
  82   if (!GST_IS_MIXER (element)) {
  83     GST_DEBUG ("element is not a mixer");
  84     gst_element_set_state (element, GST_STATE_NULL);
  85     return FALSE;
  86   }
  87
  88   /* any tracks? */
  89   if (!gst_mixer_list_tracks (GST_MIXER (element))) {
  90     GST_DEBUG ("element is a mixer, but has no tracks");
  91     gst_element_set_state (element, GST_STATE_NULL);
  92     return FALSE;
  93   }
  94
  95   GST_DEBUG ("element is a mixer with mixer tracks");
  96   return TRUE;
  97 }
  98
  99 static void
 100 gst_audio_mixer_filter_probe_feature (GstAudioMixerFilterFunc filter_func,
 101     GstElementFactory * factory,
 102     GList ** p_collection, gboolean first, gpointer user_data)
 103 {
 104   GstElement *element;
 105
 106   GST_DEBUG ("probing %s ...", gst_element_factory_get_longname (factory));
 107
 108   /* create element */
 109   element = gst_element_factory_create (factory, NULL);
 110
 111   if (element == NULL) {
 112     GST_DEBUG ("could not create element from factory");
 113     return;
 114   }
 115
 116   GST_DEBUG ("created element %s (%p)", GST_ELEMENT_NAME (element), element);
 117
 118 #if 0
 119   if (GST_IS_PROPERTY_PROBE (element)) {
 120     GstPropertyProbe *probe;
 121     const GParamSpec *devspec;
 122
 123     probe = GST_PROPERTY_PROBE (element);
 124
 125     GST_DEBUG ("probing available devices ...");
 126     if ((devspec = gst_property_probe_get_property (probe, "device"))) {
 127       GValueArray *array;
 128
 129       if ((array = gst_property_probe_probe_and_get_values (probe, devspec))) {
 130         guint n;
 131
 132         GST_DEBUG ("there are %d available devices", array->n_values);
 133
 134         /* set all devices and test for mixer */
 135         for (n = 0; n < array->n_values; n++) {
 136           GValue *device;
 137
 138           /* set this device */
 139           device = g_value_array_get_nth (array, n);
 140           g_object_set_property (G_OBJECT (element), "device", device);
 141
 142           GST_DEBUG ("trying device %s ..", g_value_get_string (device));
 143
 144           if (gst_audio_mixer_filter_check_element (element)) {
 145             gst_audio_mixer_filter_do_filter (filter_func, factory, &element,
 146                 p_collection, user_data);
 147
 148             if (first && *p_collection != NULL) {
 149               GST_DEBUG ("Stopping after first found mixer, as requested");
 150               break;
 151             }
 152           }
 153         }
 154         g_value_array_free (array);
 155       }
 156     }
 157   } else
 158 #endif
 159   {
 160     GST_DEBUG ("element does not support the property probe interface");
 161
 162     if (gst_audio_mixer_filter_check_element (element)) {
 163       gst_audio_mixer_filter_do_filter (filter_func, factory, &element,
 164           p_collection, user_data);
 165     }
 166   }
 167
 168   if (element) {
 169     gst_element_set_state (element, GST_STATE_NULL);
 170     gst_object_unref (element);
 171   }
 172 }
 173
 174 static gint
 175 element_factory_rank_compare_func (gconstpointer a, gconstpointer b)
 176 {
 177   gint rank_a = gst_plugin_feature_get_rank (GST_PLUGIN_FEATURE (a));
 178   gint rank_b = gst_plugin_feature_get_rank (GST_PLUGIN_FEATURE (b));
 179
 180   /* make order chosen in the end more determinable */
 181   if (rank_a == rank_b) {
 182     const gchar *name_a = GST_OBJECT_NAME (GST_PLUGIN_FEATURE (a));
 183     const gchar *name_b = GST_OBJECT_NAME (GST_PLUGIN_FEATURE (b));
 184
 185     return g_ascii_strcasecmp (name_a, name_b);
 186   }
 187
 188   return rank_b - rank_a;
 189 }
 190
 191 /**
 192  * gst_audio_default_registry_mixer_filter:
 193  * @filter_func: filter function, or #NULL
 194  * @first: set to #TRUE if you only want the first suitable mixer element
 195  * @user_data: user data to pass to the filter function
 196  *
 197  * Utility function to find audio mixer elements.
 198  *
 199  * Will traverse the default plugin registry in order of plugin rank and
 200  * find usable audio mixer elements. The caller may optionally fine-tune
 201  * the selection by specifying a filter function.
 202  *
 203  * Returns: a #GList of audio mixer #GstElement<!-- -->s. You must free each
 204  *          element in the list by setting it to NULL state and calling
 205  *          gst_object_unref(). After that the list itself should be freed
 206  *          using g_list_free().
 207  *
 208  * Since: 0.10.2
 209  */
 210 GList *
 211 gst_audio_default_registry_mixer_filter (GstAudioMixerFilterFunc filter_func,
 212     gboolean first, gpointer data)
 213 {
 214   GList *mixer_list = NULL;
 215   GList *feature_list;
 216   GList *walk;
 217
 218   /* go through all elements of a certain class and check whether
 219    * they implement a mixer. If so, add it to the list. */
 220   feature_list = gst_registry_get_feature_list (gst_registry_get_default (),
 221       GST_TYPE_ELEMENT_FACTORY);
 222
 223   feature_list = g_list_sort (feature_list, element_factory_rank_compare_func);
 224
 225   for (walk = feature_list; walk != NULL; walk = walk->next) {
 226     GstElementFactory *factory;
 227     const gchar *klass;
 228
 229     factory = GST_ELEMENT_FACTORY (walk->data);
 230
 231     /* check category */
 232     klass = gst_element_factory_get_klass (factory);
 233     if (strcmp (klass, "Generic/Audio") == 0) {
 234       gst_audio_mixer_filter_probe_feature (filter_func, factory,
 235           &mixer_list, first, data);
 236     }
 237
 238     if (first && mixer_list != NULL) {
 239       GST_DEBUG ("Stopping after first found mixer, as requested");
 240       break;
 241     }
 242   }
 243
 244   gst_plugin_feature_list_free (feature_list);
 245
 246   return g_list_reverse (mixer_list);
 247 }