ext/hal/gsthalaudiosink.c

   1 /* GStreamer
   2  * (c) 2005 Ronald S. Bultje <rbultje@ronald.bitfreak.net>
   3  * (c) 2006 Jürg Billeter <j@bitron.ch>
   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:element-halaudiosink
  23  *
  24  * HalAudioSink allows access to output of sound devices by specifying the
  25  * corresponding persistent Unique Device Id (UDI) from the Hardware Abstraction
  26  * Layer (HAL) in the #GstHalAudioSink:udi property.
  27  * It currently always embeds alsasink or osssink as HAL doesn't support other
  28  * sound systems yet. You can also specify the UDI of a device that has ALSA or
  29  * OSS subdevices. If both are present ALSA is preferred.
  30  *
  31  * <refsect2>
  32  * <title>Examples</title>
  33  * |[
  34  * hal-find-by-property --key alsa.type --string playback
  35  * ]| list the UDIs of all your ALSA output devices
  36  * |[
  37  * gst-launch -v audiotestsrc ! halaudiosink udi=/org/freedesktop/Hal/devices/pci_8086_27d8_alsa_playback_0
  38  * ]| test your soundcard by playing a test signal on the specified sound device.
  39  * </refsect2>
  40  */
  41
  42 #ifdef HAVE_CONFIG_H
  43 #include "config.h"
  44 #endif
  45
  46 #include "gsthalelements.h"
  47 #include "gsthalaudiosink.h"
  48
  49 static void gst_hal_audio_sink_dispose (GObject * object);
  50 static GstStateChangeReturn
  51 gst_hal_audio_sink_change_state (GstElement * element,
  52     GstStateChange transition);
  53
  54 enum
  55 {
  56   PROP_0,
  57   PROP_UDI
  58 };
  59
  60 GST_BOILERPLATE (GstHalAudioSink, gst_hal_audio_sink, GstBin, GST_TYPE_BIN);
  61
  62 static void gst_hal_audio_sink_set_property (GObject * object, guint prop_id,
  63     const GValue * value, GParamSpec * pspec);
  64 static void gst_hal_audio_sink_get_property (GObject * object, guint prop_id,
  65     GValue * value, GParamSpec * pspec);
  66
  67 static void
  68 gst_hal_audio_sink_base_init (gpointer klass)
  69 {
  70   GstElementClass *eklass = GST_ELEMENT_CLASS (klass);
  71
  72   static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
  73       GST_PAD_SINK,
  74       GST_PAD_ALWAYS,
  75       GST_STATIC_CAPS_ANY);
  76
  77   gst_element_class_add_pad_template (eklass,
  78       gst_static_pad_template_get (&sink_template));
  79   gst_element_class_set_details_simple (eklass, "HAL audio sink",
  80       "Sink/Audio",
  81       "Audio sink for sound device access via HAL",
  82       "Jürg Billeter <j@bitron.ch>");
  83 }
  84
  85 static void
  86 gst_hal_audio_sink_class_init (GstHalAudioSinkClass * klass)
  87 {
  88   GObjectClass *oklass = G_OBJECT_CLASS (klass);
  89   GstElementClass *eklass = GST_ELEMENT_CLASS (klass);
  90
  91   oklass->set_property = gst_hal_audio_sink_set_property;
  92   oklass->get_property = gst_hal_audio_sink_get_property;
  93   oklass->dispose = gst_hal_audio_sink_dispose;
  94   eklass->change_state = gst_hal_audio_sink_change_state;
  95
  96   g_object_class_install_property (oklass, PROP_UDI,
  97       g_param_spec_string ("udi",
  98           "UDI", "Unique Device Id", NULL,
  99           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 100 }
 101
 102 /*
 103  * Hack to make negotiation work.
 104  */
 105
 106 static void
 107 gst_hal_audio_sink_reset (GstHalAudioSink * sink)
 108 {
 109   GstPad *targetpad;
 110
 111   /* fakesink */
 112   if (sink->kid) {
 113     gst_element_set_state (sink->kid, GST_STATE_NULL);
 114     gst_bin_remove (GST_BIN (sink), sink->kid);
 115   }
 116   sink->kid = gst_element_factory_make ("fakesink", "testsink");
 117   gst_bin_add (GST_BIN (sink), sink->kid);
 118
 119   targetpad = gst_element_get_static_pad (sink->kid, "sink");
 120   gst_ghost_pad_set_target (GST_GHOST_PAD (sink->pad), targetpad);
 121   gst_object_unref (targetpad);
 122 }
 123
 124 static void
 125 gst_hal_audio_sink_init (GstHalAudioSink * sink, GstHalAudioSinkClass * g_class)
 126 {
 127   sink->pad = gst_ghost_pad_new_no_target ("sink", GST_PAD_SINK);
 128   gst_element_add_pad (GST_ELEMENT (sink), sink->pad);
 129
 130   gst_hal_audio_sink_reset (sink);
 131 }
 132
 133 static void
 134 gst_hal_audio_sink_dispose (GObject * object)
 135 {
 136   GstHalAudioSink *sink = GST_HAL_AUDIO_SINK (object);
 137
 138   if (sink->udi) {
 139     g_free (sink->udi);
 140     sink->udi = NULL;
 141   }
 142
 143   GST_CALL_PARENT (G_OBJECT_CLASS, dispose, (object));
 144 }
 145
 146 static gboolean
 147 do_toggle_element (GstHalAudioSink * sink)
 148 {
 149   GstPad *targetpad;
 150
 151   /* kill old element */
 152   if (sink->kid) {
 153     GST_DEBUG_OBJECT (sink, "Removing old kid");
 154     gst_element_set_state (sink->kid, GST_STATE_NULL);
 155     gst_bin_remove (GST_BIN (sink), sink->kid);
 156     sink->kid = NULL;
 157   }
 158
 159   GST_DEBUG_OBJECT (sink, "Creating new kid");
 160   if (!sink->udi)
 161     GST_INFO_OBJECT (sink, "No UDI set for device, using default one");
 162
 163   if (!(sink->kid = gst_hal_get_audio_sink (sink->udi))) {
 164     GST_ELEMENT_ERROR (sink, LIBRARY, SETTINGS, (NULL),
 165         ("Failed to render audio sink from Hal"));
 166     return FALSE;
 167   }
 168   gst_element_set_state (sink->kid, GST_STATE (sink));
 169   gst_bin_add (GST_BIN (sink), sink->kid);
 170
 171   /* re-attach ghostpad */
 172   GST_DEBUG_OBJECT (sink, "Creating new ghostpad");
 173   targetpad = gst_element_get_static_pad (sink->kid, "sink");
 174   gst_ghost_pad_set_target (GST_GHOST_PAD (sink->pad), targetpad);
 175   gst_object_unref (targetpad);
 176   GST_DEBUG_OBJECT (sink, "done changing hal audio sink");
 177
 178   return TRUE;
 179 }
 180
 181 static void
 182 gst_hal_audio_sink_set_property (GObject * object, guint prop_id,
 183     const GValue * value, GParamSpec * pspec)
 184 {
 185   GstHalAudioSink *this = GST_HAL_AUDIO_SINK (object);
 186
 187   GST_OBJECT_LOCK (this);
 188
 189   switch (prop_id) {
 190     case PROP_UDI:
 191       if (this->udi)
 192         g_free (this->udi);
 193       this->udi = g_value_dup_string (value);
 194       break;
 195     default:
 196       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 197       break;
 198   }
 199
 200   GST_OBJECT_UNLOCK (this);
 201 }
 202
 203 static void
 204 gst_hal_audio_sink_get_property (GObject * object, guint prop_id,
 205     GValue * value, GParamSpec * pspec)
 206 {
 207   GstHalAudioSink *this = GST_HAL_AUDIO_SINK (object);
 208
 209   GST_OBJECT_LOCK (this);
 210
 211   switch (prop_id) {
 212     case PROP_UDI:
 213       g_value_set_string (value, this->udi);
 214       break;
 215     default:
 216       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 217       break;
 218   }
 219
 220   GST_OBJECT_UNLOCK (this);
 221 }
 222
 223 static GstStateChangeReturn
 224 gst_hal_audio_sink_change_state (GstElement * element,
 225     GstStateChange transition)
 226 {
 227   GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
 228   GstHalAudioSink *sink = GST_HAL_AUDIO_SINK (element);
 229
 230   switch (transition) {
 231     case GST_STATE_CHANGE_NULL_TO_READY:
 232       if (!do_toggle_element (sink))
 233         return GST_STATE_CHANGE_FAILURE;
 234       break;
 235     default:
 236       break;
 237   }
 238
 239   ret = GST_CALL_PARENT_WITH_DEFAULT (GST_ELEMENT_CLASS, change_state,
 240       (element, transition), GST_STATE_CHANGE_SUCCESS);
 241
 242   switch (transition) {
 243     case GST_STATE_CHANGE_READY_TO_NULL:
 244       gst_hal_audio_sink_reset (sink);
 245       break;
 246     default:
 247       break;
 248   }
 249
 250   return ret;
 251 }