ext/hal/: Having NULL as UDI previously selected the default sink/src. Change this back but mention it in the debug o...

Original commit message from CVS:
* ext/hal/gsthalaudiosink.c: (do_toggle_element):
* ext/hal/gsthalaudiosrc.c: (do_toggle_element):
Having NULL as UDI previously selected the default sink/src. Change
this back but mention it in the debug output.
* ext/hal/hal.c: (gst_hal_get_alsa_element),
(gst_hal_get_oss_element), (gst_hal_get_string),
(gst_hal_render_bin_from_udi), (gst_hal_get_audio_sink),
(gst_hal_get_audio_src):
* ext/hal/hal.h:
Refactor a bit, check all error conditions, greatly improve debugging
and fix some possible memory leaks. Also implement OSS support
and allow specifying an UDI that points to a real device. For this the
child device which supports ALSA (preferred) or OSS is used.
As a side effect this makes it impossible now to get a alsasink in
halaudiosrc and a alsasrc in halaudiosink.

4 files changed, 277 insertions, 64 deletions

diff --git a/ext/hal/gsthalaudiosink.c b/ext/hal/gsthalaudiosink.c
index 1b941aa0..215926be 100644
--- a/ext/hal/gsthalaudiosink.c
+++ b/ext/hal/gsthalaudiosink.c
@@ -26,8 +26,9 @@
  * HalAudioSink allows access to output of sound devices by specifying the
  * corresponding persistent Unique Device Id (UDI) from the Hardware Abstraction
  * Layer (HAL) in the <link linkend="GstHalAudioSrc--udi">udi</link> property.
- * It currently always embeds alsasink as HAL doesn't support other sound
- * systems yet.
+ * It currently always embeds alsasink or osssink as HAL doesn't support other
+ * sound systems yet. You can also specify the UDI of a device that has ALSA or
+ * OSS subdevices. If both are present ALSA is preferred.
  * </para>
  * <title>Examples</title>
  * <para>
@@ -162,11 +163,10 @@ do_toggle_element (GstHalAudioSink * sink)
   }
 
   GST_DEBUG_OBJECT (sink, "Creating new kid");
-  if (!sink->udi) {
-    GST_ELEMENT_ERROR (sink, LIBRARY, SETTINGS, (NULL),
-        ("No UDI set for device"));
-    return FALSE;
-  } else if (!(sink->kid = gst_hal_get_audio_sink (sink->udi))) {
+  if (!sink->udi)
+    GST_INFO_OBJECT (sink, "No UDI set for device, using default one");
+
+  if (!(sink->kid = gst_hal_get_audio_sink (sink->udi))) {
     GST_ELEMENT_ERROR (sink, LIBRARY, SETTINGS, (NULL),
         ("Failed to render audio sink from Hal"));
     return FALSE;
diff --git a/ext/hal/gsthalaudiosrc.c b/ext/hal/gsthalaudiosrc.c
index ed887544..b745bef1 100644
--- a/ext/hal/gsthalaudiosrc.c
+++ b/ext/hal/gsthalaudiosrc.c
@@ -27,8 +27,9 @@
  * HalAudioSrc allows access to input of sound devices by specifying the
  * corresponding persistent Unique Device Id (UDI) from the Hardware Abstraction
  * Layer (HAL) in the <link linkend="GstHalAudioSrc--udi">udi</link> property.
- * It currently always embeds alsasrc as HAL doesn't support other sound systems
- * yet.
+ * It currently always embeds alsasrc or osssrc as HAL doesn't support other
+ * sound systems yet. You can also specify the UDI of a device that has ALSA or
+ * OSS subdevices. If both are present ALSA is preferred.
  * </para>
  * <title>Examples</title>
  * <para>
@@ -164,11 +165,10 @@ do_toggle_element (GstHalAudioSrc * src)
   }
 
   GST_DEBUG_OBJECT (src, "Creating new kid");
-  if (!src->udi) {
-    GST_ELEMENT_ERROR (src, LIBRARY, SETTINGS, (NULL),
-        ("No UDI set for device"));
-    return FALSE;
-  } else if (!(src->kid = gst_hal_get_audio_src (src->udi))) {
+  if (!src->udi)
+    GST_INFO_OBJECT (src, "No UDI set for device, using default one");
+
+  if (!(src->kid = gst_hal_get_audio_src (src->udi))) {
     GST_ELEMENT_ERROR (src, LIBRARY, SETTINGS, (NULL),
         ("Failed to render audio source from Hal"));
     return FALSE;
diff --git a/ext/hal/hal.c b/ext/hal/hal.c
index 57da8425..3f68da93 100644
--- a/ext/hal/hal.c
+++ b/ext/hal/hal.c
@@ -1,6 +1,7 @@
 /* GStreamer
  * Copyright (C) <2002> Thomas Vander Stichele <thomas@apestaart.org>
  * Copyright (C) <2006> Jürg Billeter <j@bitron.ch>
+ * Copyright (C) <2007> Sebastian Dröge <slomo@circular-chaos.org>
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public
@@ -30,12 +31,175 @@
 #include <glib.h>
 #include "hal.h"
 
+GST_DEBUG_CATEGORY_EXTERN (hal_debug);
 
-/* external functions */
+#define GST_CAT_DEFAULT hal_debug
+
+/**
+ * gst_hal_get_alsa_element:
+ * @ctx: a #LibHalContext which should be used for querying HAL.
+ * @udi: a #gchar corresponding to the UDI you want to get.
+ * @device_type: a #GstHalDeviceType specifying the wanted device type.
+ *
+ * Get Hal UDI @udi's string value.
+ *
+ * Returns: a newly allocated #gchar string containing the appropriate pipeline
+ * for UDI @udi, or NULL in the case of an error..
+ */
+static gchar *
+gst_hal_get_alsa_element (LibHalContext * ctx, const gchar * udi,
+    GstHalDeviceType device_type)
+{
+  char *type, *element = NULL, *string = NULL;
+  DBusError error;
+
+  dbus_error_init (&error);
+
+  if (!libhal_device_query_capability (ctx, udi, "alsa", &error)) {
+    if (dbus_error_is_set (&error)) {
+      GST_DEBUG ("Failed querying %s for alsa capability: %s: %s",
+          udi, error.name, error.message);
+      LIBHAL_FREE_DBUS_ERROR (&error);
+    } else {
+      GST_DEBUG ("UDI %s has no alsa capability", udi);
+    }
+    return NULL;
+  }
+
+  type = libhal_device_get_property_string (ctx, udi, "alsa.type", &error);
+
+  if (dbus_error_is_set (&error)) {
+    GST_DEBUG ("UDI %s has alsa capabilities but no alsa.type property: %s, %s",
+        udi, error.name, error.message);
+    LIBHAL_FREE_DBUS_ERROR (&error);
+    return NULL;
+  } else if (!type) {
+    GST_DEBUG ("UDI %s has empty alsa.type property", udi);
+    return NULL;
+  }
+
+  if (strcmp (type, "playback") == 0 && device_type == GST_HAL_AUDIOSINK)
+    element = "alsasink";
+  else if (strcmp (type, "capture") == 0 && device_type == GST_HAL_AUDIOSRC)
+    element = "alsasrc";
+
+  libhal_free_string (type);
+
+  if (element) {
+    int card, device;
+
+    card = libhal_device_get_property_int (ctx, udi, "alsa.card", &error);
+    if (dbus_error_is_set (&error)) {
+      GST_DEBUG ("UDI %s has no alsa.card property: %s: %s", udi, error.name,
+          error.message);
+      LIBHAL_FREE_DBUS_ERROR (&error);
+      return NULL;
+    } else if (card == -1) {
+      GST_DEBUG ("UDI %s has no alsa.card property", udi);
+      return NULL;
+    }
+
+    device = libhal_device_get_property_int (ctx, udi, "alsa.device", &error);
+    if (dbus_error_is_set (&error)) {
+      GST_DEBUG ("UDI %s has no alsa.device property: %s: %s", udi, error.name,
+          error.message);
+      LIBHAL_FREE_DBUS_ERROR (&error);
+      return NULL;
+    } else if (device == -1) {
+      GST_DEBUG ("UDI %s has no alsa.device property", udi);
+      return NULL;
+    }
+
+    if (device == 0) {
+      /* handle default device specially to use
+       * dmix, dsnoop, and softvol if appropriate */
+      string = g_strdup_printf ("%s device=default:%d", element, card);
+    } else {
+      string =
+          g_strdup_printf ("%s device=plughw:%d,%d", element, card, device);
+    }
+  }
+
+  return string;
+}
+
+/**
+ * gst_hal_get_oss_element:
+ * @ctx: a #LibHalContext which should be used for querying HAL.
+ * @udi: a #gchar corresponding to the UDI you want to get.
+ * @device_type: a #GstHalDeviceType specifying the wanted device type.
+ *
+ * Get Hal UDI @udi's string value.
+ *
+ * Returns: a newly allocated #gchar string containing the appropriate pipeline
+ * for UDI @udi, or NULL in the case of an error..
+ */
+static gchar *
+gst_hal_get_oss_element (LibHalContext * ctx, const gchar * udi,
+    GstHalDeviceType device_type)
+{
+  char *type, *element = NULL, *string = NULL;
+  DBusError error;
+
+  dbus_error_init (&error);
+
+  if (!libhal_device_query_capability (ctx, udi, "oss", &error)) {
+    if (dbus_error_is_set (&error)) {
+      GST_DEBUG ("Failed querying %s for oss capability: %s: %s", udi,
+          error.name, error.message);
+      LIBHAL_FREE_DBUS_ERROR (&error);
+    } else {
+      GST_DEBUG ("UDI %s has no oss capability", udi);
+    }
+    return NULL;
+  }
+
+  type = libhal_device_get_property_string (ctx, udi, "oss.type", &error);
+  if (dbus_error_is_set (&error)) {
+    GST_DEBUG ("UDI %s has oss capabilities but no oss.type property: %s, %s",
+        udi, error.name, error.message);
+    LIBHAL_FREE_DBUS_ERROR (&error);
+    return NULL;
+  } else if (!type) {
+    GST_DEBUG ("UDI %s has empty oss.type property", udi);
+    return NULL;
+  }
+
+  if (strcmp (type, "pcm") == 0) {
+    if (device_type == GST_HAL_AUDIOSINK)
+      element = "osssink";
+    else if (device_type == GST_HAL_AUDIOSRC)
+      element = "osssrc";
+  }
+  libhal_free_string (type);
+
+  if (element) {
+    char *device = NULL;
+
+    device =
+        libhal_device_get_property_string (ctx, udi, "oss.device_file", &error);
+    if (dbus_error_is_set (&error)) {
+      GST_DEBUG
+          ("UDI %s has oss capabilities but no oss.device_file property: %s, %s",
+          udi, error.name, error.message);
+      LIBHAL_FREE_DBUS_ERROR (&error);
+      return NULL;
+    } else if (!device) {
+      GST_DEBUG ("UDI %s has empty oss.device_file property", udi);
+      return NULL;
+    }
+
+    string = g_strdup_printf ("%s device=%s", element, device);
+    libhal_free_string (device);
+  }
+
+  return string;
+}
 
 /**
  * gst_hal_get_string:
- * @key: a #gchar corresponding to the key you want to get.
+ * @udi: a #gchar corresponding to the UDI you want to get.
+ * @device_type: a #GstHalDeviceType specifying the wanted device type.
  *
  * Get Hal UDI @udi's string value.
  *
@@ -43,12 +207,11 @@
  * for UDI @udi, or NULL in the case of an error..
  */
 static gchar *
-gst_hal_get_string (const gchar * udi)
+gst_hal_get_string (const gchar * udi, GstHalDeviceType device_type)
 {
-  DBusConnection *connection;
   DBusError error;
   LibHalContext *ctx;
-  char *string;
+  char *string = NULL;
 
   /* Don't query HAL for NULL UDIs. Passing NULL as UDI to HAL gives
    * an assertion failure in D-Bus when running with
@@ -58,69 +221,104 @@ gst_hal_get_string (const gchar * udi)
 
   dbus_error_init (&error);
 
-  connection = dbus_bus_get (DBUS_BUS_SYSTEM, &error);
-  g_return_val_if_fail (connection != NULL, NULL);
-
   ctx = libhal_ctx_new ();
+  /* Should only happen on OOM */
   g_return_val_if_fail (ctx != NULL, NULL);
 
-  libhal_ctx_set_dbus_connection (ctx, connection);
-  libhal_ctx_init (ctx, &error);
+  if (!libhal_ctx_set_dbus_connection (ctx, dbus_bus_get (DBUS_BUS_SYSTEM,
+              &error))) {
+    GST_DEBUG ("Unable to set DBus connection: %s: %s", error.name,
+        error.message);
+    LIBHAL_FREE_DBUS_ERROR (&error);
+    goto ctx_free;
+  }
 
-  string = NULL;
+  if (!libhal_ctx_init (ctx, &error)) {
+    GST_DEBUG ("Unable to set init HAL context: %s: %s", error.name,
+        error.message);
+    LIBHAL_FREE_DBUS_ERROR (&error);
+    goto ctx_free;
+  }
 
-  if (libhal_device_query_capability (ctx, udi, "alsa", &error)) {
-    char *type, *element = NULL;
+  /* Now first check if UDI is an alsa device, then oss and then
+   * check the childs of the given device. If there are alsa and oss
+   * children the first alsa one is used. */
 
-    type = libhal_device_get_property_string (ctx, udi, "alsa.type", &error);
-    if (type != NULL && strcmp (type, "playback") == 0) {
-      element = "alsasink";
-    } else if (type != NULL && strcmp (type, "capture") == 0) {
-      element = "alsasrc";
+  string = gst_hal_get_alsa_element (ctx, udi, device_type);
+
+  if (!string)
+    string = gst_hal_get_oss_element (ctx, udi, device_type);
+
+  if (!string) {
+    int num_childs;
+    char **childs = NULL;
+
+    /* now try if one of the direct subdevices supports ALSA or OSS */
+    childs =
+        libhal_manager_find_device_string_match (ctx, "info.parent", udi,
+        &num_childs, &error);
+    if (dbus_error_is_set (&error)) {
+      GST_DEBUG ("Unable to retrieve childs of %s: %s: %s", udi, error.name,
+          error.message);
+      LIBHAL_FREE_DBUS_ERROR (&error);
+      goto ctx_shutdown;
     }
-    if (element) {
-      int card, device;
-
-      card = libhal_device_get_property_int (ctx, udi, "alsa.card", &error);
-      device = libhal_device_get_property_int (ctx, udi, "alsa.device", &error);
-      if (device == 0) {
-        /* handle default device specially to use
-         * dmix, dsnoop, and softvol if appropriate */
-        string = g_strdup_printf ("%s device=default:%d", element, card);
-      } else {
-        string =
-            g_strdup_printf ("%s device=plughw:%d,%d", element, card, device);
+
+    if (childs && num_childs > 0) {
+      int i;
+      char *alsa_string = NULL, *oss_string = NULL;
+
+      for (i = 0; i < num_childs && !alsa_string; i++) {
+        alsa_string = gst_hal_get_alsa_element (ctx, childs[i], device_type);
+
+        if (!oss_string)
+          oss_string = gst_hal_get_oss_element (ctx, childs[i], device_type);
+      }
+
+      if (alsa_string) {
+        string = alsa_string;
+        g_free (oss_string);
+      } else if (oss_string) {
+        string = oss_string;
       }
     }
+    libhal_free_string_array (childs);
   }
 
-  libhal_ctx_shutdown (ctx, &error);
-  libhal_ctx_free (ctx);
+ctx_shutdown:
+  if (!libhal_ctx_shutdown (ctx, &error)) {
+    GST_DEBUG ("Closing connection to HAL failed: %s: %s", error.name,
+        error.message);
+    LIBHAL_FREE_DBUS_ERROR (&error);
+  }
 
-  dbus_error_free (&error);
+ctx_free:
+  libhal_ctx_free (ctx);
 
   if (string == NULL) {
-    GST_WARNING ("Problem parsing HAL ALSA capabilities for udi %s", udi);
+    GST_WARNING ("Problem finding a HAL audio device for udi %s", udi);
   }
 
   return string;
 }
 
+/* external functions */
+
 /**
  * gst_hal_render_bin_from_udi:
- * @key: a #gchar string corresponding to a Hal UDI.
+ * @udi: a #gchar string corresponding to a Hal UDI.
  *
  * Render bin from Hal UDI @udi.
  *
  * Returns: a #GstElement containing the rendered bin.
  */
 GstElement *
-gst_hal_render_bin_from_udi (const gchar * udi)
+gst_hal_render_bin_from_udi (const gchar * udi, GstHalDeviceType type)
 {
   GstElement *bin = NULL;
   gchar *value;
 
-  value = gst_hal_get_string (udi);
+  value = gst_hal_get_string (udi, type);
   if (value)
     bin = gst_parse_bin_from_description (value, TRUE, NULL);
   g_free (value);
@@ -129,10 +327,12 @@ gst_hal_render_bin_from_udi (const gchar * udi)
 
 /**
  * gst_hal_get_audio_sink:
+ * @udi: a #gchar string corresponding to a Hal UDI.
  *
  * Render audio output bin from GStreamer Hal UDI.
- * If no device with the specified UDI exists, the default audio sink for the
- * platform is used (typically osssink or sunaudiosink).
+ * If no device with the specified UDI exists or @udi is NULL,
+ * the default audio sink for the  platform is used
+ * (typically alsasink, osssink or sunaudiosink).
  *
  * Returns: a #GstElement containing the audio output bin, or NULL if
  * everything failed.
@@ -140,14 +340,16 @@ gst_hal_render_bin_from_udi (const gchar * udi)
 GstElement *
 gst_hal_get_audio_sink (const gchar * udi)
 {
-  GstElement *ret = gst_hal_render_bin_from_udi (udi);
+  GstElement *ret = NULL;
+
+  if (udi)
+    ret = gst_hal_render_bin_from_udi (udi, GST_HAL_AUDIOSINK);
 
   if (!ret) {
     ret = gst_element_factory_make (DEFAULT_AUDIOSINK, NULL);
 
     if (!ret)
-      g_warning ("No Hal default audio sink key and %s doesn't work",
-          DEFAULT_AUDIOSINK);
+      GST_ERROR ("Hal audio sink and %s don't work", DEFAULT_AUDIOSINK);
   }
 
   return ret;
@@ -155,10 +357,12 @@ gst_hal_get_audio_sink (const gchar * udi)
 
 /**
  * gst_hal_get_audio_src:
+ * @udi: a #gchar string corresponding to a Hal UDI.
  *
  * Render audio acquisition bin from GStreamer Hal UDI.
- * If no device with the specified UDI exists, the default audio source for the
- * plaform is used (typically osssrc or sunaudiosrc).
+ * If no device with the specified UDI exists or @udi is NULL,
+ * the default audio source for the  plaform is used
+ * (typically alsasrc, osssrc or sunaudiosrc).
  *
  * Returns: a #GstElement containing the audio source bin, or NULL if
  * everything failed.
@@ -166,14 +370,16 @@ gst_hal_get_audio_sink (const gchar * udi)
 GstElement *
 gst_hal_get_audio_src (const gchar * udi)
 {
-  GstElement *ret = gst_hal_render_bin_from_udi (udi);
+  GstElement *ret = NULL;
+
+  if (udi)
+    ret = gst_hal_render_bin_from_udi (udi, GST_HAL_AUDIOSRC);
 
   if (!ret) {
     ret = gst_element_factory_make (DEFAULT_AUDIOSRC, NULL);
 
     if (!ret)
-      g_warning ("No Hal default audio src key and %s doesn't work",
-          DEFAULT_AUDIOSRC);
+      GST_ERROR ("Hal audio src and %s don't work", DEFAULT_AUDIOSRC);
   }
 
   return ret;
diff --git a/ext/hal/hal.h b/ext/hal/hal.h
index 3d5bb05b..9cc5aed3 100644
--- a/ext/hal/hal.h
+++ b/ext/hal/hal.h
@@ -31,10 +31,17 @@
 
 G_BEGIN_DECLS
 
-GstElement *    gst_hal_render_bin_from_udi (const gchar *udi);
+typedef enum
+{
+  GST_HAL_AUDIOSINK,
+  GST_HAL_AUDIOSRC
+} GstHalDeviceType;
 
-GstElement *    gst_hal_get_audio_sink (const gchar *udi);
-GstElement *    gst_hal_get_audio_src  (const gchar *udi);
+GstElement *gst_hal_render_bin_from_udi (const gchar * udi,
+    GstHalDeviceType type);
+
+GstElement *gst_hal_get_audio_sink (const gchar * udi);
+GstElement *gst_hal_get_audio_src (const gchar * udi);
 
 G_END_DECLS