sys/oss4/oss4-sink.c

   1 /* GStreamer OSS4 audio sink
   2  * Copyright (C) 2007-2008 Tim-Philipp Müller <tim centricular net>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19 /**
  20  * SECTION:element-oss4sink
  21  *
  22  * This element lets you output sound using the Open Sound System (OSS)
  23  * version 4.
  24  *
  25  * Note that you should almost always use generic audio conversion elements
  26  * like audioconvert and audioresample in front of an audiosink to make sure
  27  * your pipeline works under all circumstances (those conversion elements will
  28  * act in passthrough-mode if no conversion is necessary).
  29  *
  30  * <refsect2>
  31  * <title>Example pipelines</title>
  32  * |[
  33  * gst-launch -v audiotestsrc ! audioconvert ! volume volume=0.1 ! oss4sink
  34  * ]| will output a sine wave (continuous beep sound) to your sound card (with
  35  * a very low volume as precaution).
  36  * |[
  37  * gst-launch -v filesrc location=music.ogg ! decodebin ! audioconvert ! audioresample ! oss4sink
  38  * ]| will play an Ogg/Vorbis audio file and output it using the Open Sound System
  39  * version 4.
  40  * </refsect2>
  41  *
  42  * Since: 0.10.7
  43  */
  44
  45 /* TODO: - add "volume" property for stream volume control and intercept tags
  46  *         to set stream title
  47  */
  48
  49 #ifdef HAVE_CONFIG_H
  50 #include "config.h"
  51 #endif
  52
  53 #include <sys/types.h>
  54 #include <sys/stat.h>
  55 #include <sys/ioctl.h>
  56 #include <fcntl.h>
  57 #include <errno.h>
  58 #include <unistd.h>
  59 #include <string.h>
  60
  61 #include <gst/gst-i18n-plugin.h>
  62
  63 #define NO_LEGACY_MIXER
  64 #include "oss4-audio.h"
  65 #include "oss4-sink.h"
  66 #include "oss4-property-probe.h"
  67 #include "oss4-soundcard.h"
  68
  69 GST_DEBUG_CATEGORY_EXTERN (oss4sink_debug);
  70 #define GST_CAT_DEFAULT oss4sink_debug
  71
  72 static void gst_oss4_sink_init_interfaces (GType type);
  73 static void gst_oss4_sink_dispose (GObject * object);
  74 static void gst_oss4_sink_finalise (GObject * object);
  75
  76 static void gst_oss4_sink_get_property (GObject * object, guint prop_id,
  77     GValue * value, GParamSpec * pspec);
  78 static void gst_oss4_sink_set_property (GObject * object, guint prop_id,
  79     const GValue * value, GParamSpec * pspec);
  80
  81 static GstCaps *gst_oss4_sink_getcaps (GstBaseSink * bsink);
  82 static gboolean gst_oss4_sink_open (GstAudioSink * asink,
  83     gboolean silent_errors);
  84 static gboolean gst_oss4_sink_open_func (GstAudioSink * asink);
  85 static gboolean gst_oss4_sink_close (GstAudioSink * asink);
  86 static gboolean gst_oss4_sink_prepare (GstAudioSink * asink,
  87     GstRingBufferSpec * spec);
  88 static gboolean gst_oss4_sink_unprepare (GstAudioSink * asink);
  89 static guint gst_oss4_sink_write (GstAudioSink * asink, gpointer data,
  90     guint length);
  91 static guint gst_oss4_sink_delay (GstAudioSink * asink);
  92 static void gst_oss4_sink_reset (GstAudioSink * asink);
  93
  94 #define DEFAULT_DEVICE      NULL
  95 #define DEFAULT_DEVICE_NAME NULL
  96
  97 enum
  98 {
  99   PROP_0,
 100   PROP_DEVICE,
 101   PROP_DEVICE_NAME
 102 };
 103
 104 GST_BOILERPLATE_FULL (GstOss4Sink, gst_oss4_sink, GstAudioSink,
 105     GST_TYPE_AUDIO_SINK, gst_oss4_sink_init_interfaces);
 106
 107 static void
 108 gst_oss4_sink_dispose (GObject * object)
 109 {
 110   GstOss4Sink *osssink = GST_OSS4_SINK (object);
 111
 112   if (osssink->probed_caps) {
 113     gst_caps_unref (osssink->probed_caps);
 114     osssink->probed_caps = NULL;
 115   }
 116
 117   G_OBJECT_CLASS (parent_class)->dispose (object);
 118 }
 119
 120 static void
 121 gst_oss4_sink_base_init (gpointer g_class)
 122 {
 123   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
 124   GstPadTemplate *templ;
 125
 126   gst_element_class_set_details_simple (element_class,
 127       "OSS v4 Audio Sink", "Sink/Audio",
 128       "Output to a sound card via OSS version 4",
 129       "Tim-Philipp Müller <tim centricular net>");
 130
 131   templ = gst_pad_template_new ("sink", GST_PAD_SINK, GST_PAD_ALWAYS,
 132       gst_oss4_audio_get_template_caps ());
 133   gst_element_class_add_pad_template (element_class, templ);
 134 }
 135
 136 static void
 137 gst_oss4_sink_class_init (GstOss4SinkClass * klass)
 138 {
 139   GstAudioSinkClass *audiosink_class = (GstAudioSinkClass *) klass;
 140   GstBaseSinkClass *basesink_class = (GstBaseSinkClass *) klass;
 141   GObjectClass *gobject_class = (GObjectClass *) klass;
 142
 143   gobject_class->dispose = GST_DEBUG_FUNCPTR (gst_oss4_sink_dispose);
 144   gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_oss4_sink_finalise);
 145   gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_oss4_sink_get_property);
 146   gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_oss4_sink_set_property);
 147
 148   g_object_class_install_property (gobject_class, PROP_DEVICE,
 149       g_param_spec_string ("device", "Device",
 150           "OSS4 device (e.g. /dev/oss/hdaudio0/pcm0 or /dev/dspN) "
 151           "(NULL = use first available playback device)",
 152           DEFAULT_DEVICE, G_PARAM_READWRITE));
 153
 154   g_object_class_install_property (gobject_class, PROP_DEVICE_NAME,
 155       g_param_spec_string ("device-name", "Device name",
 156           "Human-readable name of the sound device", DEFAULT_DEVICE_NAME,
 157           G_PARAM_READABLE));
 158
 159   basesink_class->get_caps = GST_DEBUG_FUNCPTR (gst_oss4_sink_getcaps);
 160
 161   audiosink_class->open = GST_DEBUG_FUNCPTR (gst_oss4_sink_open_func);
 162   audiosink_class->close = GST_DEBUG_FUNCPTR (gst_oss4_sink_close);
 163   audiosink_class->prepare = GST_DEBUG_FUNCPTR (gst_oss4_sink_prepare);
 164   audiosink_class->unprepare = GST_DEBUG_FUNCPTR (gst_oss4_sink_unprepare);
 165   audiosink_class->write = GST_DEBUG_FUNCPTR (gst_oss4_sink_write);
 166   audiosink_class->delay = GST_DEBUG_FUNCPTR (gst_oss4_sink_delay);
 167   audiosink_class->reset = GST_DEBUG_FUNCPTR (gst_oss4_sink_reset);
 168 }
 169
 170 static void
 171 gst_oss4_sink_init (GstOss4Sink * osssink, GstOss4SinkClass * klass)
 172 {
 173   const gchar *device;
 174
 175   device = g_getenv ("AUDIODEV");
 176   if (device == NULL)
 177     device = DEFAULT_DEVICE;
 178   osssink->device = g_strdup (device);
 179   osssink->fd = -1;
 180   osssink->bytes_per_sample = 0;
 181   osssink->probed_caps = NULL;
 182   osssink->device_name = NULL;
 183 }
 184
 185 static void
 186 gst_oss4_sink_finalise (GObject * object)
 187 {
 188   GstOss4Sink *osssink = GST_OSS4_SINK (object);
 189
 190   g_free (osssink->device);
 191   osssink->device = NULL;
 192
 193   g_list_free (osssink->property_probe_list);
 194   osssink->property_probe_list = NULL;
 195
 196   G_OBJECT_CLASS (parent_class)->finalize (object);
 197 }
 198
 199 static void
 200 gst_oss4_sink_set_property (GObject * object, guint prop_id,
 201     const GValue * value, GParamSpec * pspec)
 202 {
 203   GstOss4Sink *oss = GST_OSS4_SINK (object);
 204
 205   switch (prop_id) {
 206     case PROP_DEVICE:
 207       GST_OBJECT_LOCK (oss);
 208       if (oss->fd == -1) {
 209         g_free (oss->device);
 210         oss->device = g_value_dup_string (value);
 211         if (oss->probed_caps) {
 212           gst_caps_unref (oss->probed_caps);
 213           oss->probed_caps = NULL;
 214         }
 215         g_free (oss->device_name);
 216         oss->device_name = NULL;
 217       } else {
 218         g_warning ("%s: can't change \"device\" property while audio sink "
 219             "is open", GST_OBJECT_NAME (oss));
 220       }
 221       GST_OBJECT_UNLOCK (oss);
 222       break;
 223     default:
 224       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 225       break;
 226   }
 227 }
 228
 229 static void
 230 gst_oss4_sink_get_property (GObject * object, guint prop_id,
 231     GValue * value, GParamSpec * pspec)
 232 {
 233   GstOss4Sink *oss = GST_OSS4_SINK (object);
 234
 235   switch (prop_id) {
 236     case PROP_DEVICE:
 237       GST_OBJECT_LOCK (oss);
 238       g_value_set_string (value, oss->device);
 239       GST_OBJECT_UNLOCK (oss);
 240       break;
 241     case PROP_DEVICE_NAME:
 242       GST_OBJECT_LOCK (oss);
 243       if (oss->fd == -1 && oss->device != NULL) {
 244         /* If device is set, try to retrieve the name even if we're not open */
 245         if (gst_oss4_sink_open (GST_AUDIO_SINK (oss), TRUE)) {
 246           g_value_set_string (value, oss->device_name);
 247           gst_oss4_sink_close (GST_AUDIO_SINK (oss));
 248         } else {
 249           gchar *name = NULL;
 250
 251           gst_oss4_property_probe_find_device_name_nofd (GST_OBJECT (oss),
 252               oss->device, &name);
 253           g_value_set_string (value, name);
 254           g_free (name);
 255         }
 256       } else {
 257         g_value_set_string (value, oss->device_name);
 258       }
 259       GST_OBJECT_UNLOCK (oss);
 260       break;
 261     default:
 262       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 263       break;
 264   }
 265 }
 266
 267 static GstCaps *
 268 gst_oss4_sink_getcaps (GstBaseSink * bsink)
 269 {
 270   GstOss4Sink *oss;
 271   GstCaps *caps;
 272
 273   oss = GST_OSS4_SINK (bsink);
 274
 275   if (oss->fd == -1) {
 276     caps = gst_caps_copy (gst_oss4_audio_get_template_caps ());
 277   } else if (oss->probed_caps) {
 278     caps = gst_caps_copy (oss->probed_caps);
 279   } else {
 280     caps = gst_oss4_audio_probe_caps (GST_OBJECT (oss), oss->fd);
 281     if (caps != NULL && !gst_caps_is_empty (caps)) {
 282       oss->probed_caps = gst_caps_copy (caps);
 283     }
 284   }
 285
 286   return caps;
 287 }
 288
 289 /* note: we must not take the object lock here unless we fix up get_property */
 290 static gboolean
 291 gst_oss4_sink_open (GstAudioSink * asink, gboolean silent_errors)
 292 {
 293   GstOss4Sink *oss;
 294   gchar *device;
 295   int mode;
 296
 297   oss = GST_OSS4_SINK (asink);
 298
 299   if (oss->device)
 300     device = g_strdup (oss->device);
 301   else
 302     device = gst_oss4_audio_find_device (GST_OBJECT_CAST (oss));
 303
 304   /* desperate times, desperate measures */
 305   if (device == NULL)
 306     device = g_strdup ("/dev/dsp0");
 307
 308   GST_INFO_OBJECT (oss, "Trying to open OSS4 device '%s'", device);
 309
 310   /* we open in non-blocking mode even if we don't really want to do writes
 311    * non-blocking because we can't be sure that this is really a genuine
 312    * OSS4 device with well-behaved drivers etc. We really don't want to
 313    * hang forever under any circumstances. */
 314   oss->fd = open (device, O_WRONLY | O_NONBLOCK, 0);
 315   if (oss->fd == -1) {
 316     switch (errno) {
 317       case EBUSY:
 318         goto busy;
 319       case EACCES:
 320         goto no_permission;
 321       default:
 322         goto open_failed;
 323     }
 324   }
 325
 326   GST_INFO_OBJECT (oss, "Opened device '%s'", device);
 327
 328   /* Make sure it's OSS4. If it's old OSS, let osssink handle it */
 329   if (!gst_oss4_audio_check_version (GST_OBJECT_CAST (oss), oss->fd))
 330     goto legacy_oss;
 331
 332   /* now remove the non-blocking flag. */
 333   mode = fcntl (oss->fd, F_GETFL);
 334   mode &= ~O_NONBLOCK;
 335   if (fcntl (oss->fd, F_SETFL, mode) < 0) {
 336     /* some drivers do no support unsetting the non-blocking flag, try to
 337      * close/open the device then. This is racy but we error out properly. */
 338     GST_WARNING_OBJECT (oss, "failed to unset O_NONBLOCK (buggy driver?), "
 339         "will try to re-open device now");
 340     gst_oss4_sink_close (asink);
 341     if ((oss->fd = open (device, O_WRONLY, 0)) == -1)
 342       goto non_block;
 343   }
 344
 345   oss->open_device = device;
 346
 347   /* not using ENGINEINFO here because it sometimes returns a different and
 348    * less useful name than AUDIOINFO for the same device */
 349   if (!gst_oss4_property_probe_find_device_name (GST_OBJECT (oss), oss->fd,
 350           oss->open_device, &oss->device_name)) {
 351     oss->device_name = NULL;
 352   }
 353
 354   /* list output routings, for informational purposes only so far */
 355   {
 356     oss_mixer_enuminfo routings = { 0, };
 357     guint i;
 358
 359     if (ioctl (oss->fd, SNDCTL_DSP_GET_PLAYTGT_NAMES, &routings) != -1) {
 360       GST_LOG_OBJECT (oss, "%u output routings (static list: %d)",
 361           routings.nvalues, !!(routings.version == 0));
 362       for (i = 0; i < routings.nvalues; ++i) {
 363         GST_LOG_OBJECT (oss, "  output routing %d: %s", i,
 364             &routings.strings[routings.strindex[i]]);
 365       }
 366     }
 367   }
 368
 369   return TRUE;
 370
 371   /* ERRORS */
 372 busy:
 373   {
 374     if (!silent_errors) {
 375       GST_ELEMENT_ERROR (oss, RESOURCE, BUSY,
 376           (_("Could not open audio device for playback. "
 377                   "Device is being used by another application.")), (NULL));
 378     }
 379     g_free (device);
 380     return FALSE;
 381   }
 382 no_permission:
 383   {
 384     if (!silent_errors) {
 385       GST_ELEMENT_ERROR (oss, RESOURCE, OPEN_WRITE,
 386           (_("Could not open audio device for playback. "
 387                   "You don't have permission to open the device.")),
 388           GST_ERROR_SYSTEM);
 389     }
 390     g_free (device);
 391     return FALSE;
 392   }
 393 open_failed:
 394   {
 395     if (!silent_errors) {
 396       GST_ELEMENT_ERROR (oss, RESOURCE, OPEN_WRITE,
 397           (_("Could not open audio device for playback.")), GST_ERROR_SYSTEM);
 398     }
 399     g_free (device);
 400     return FALSE;
 401   }
 402 legacy_oss:
 403   {
 404     if (!silent_errors) {
 405       GST_ELEMENT_ERROR (oss, RESOURCE, OPEN_WRITE,
 406           (_("Could not open audio device for playback. "
 407                   "This version of the Open Sound System is not supported by this "
 408                   "element.")), ("Try the 'osssink' element instead"));
 409     }
 410     gst_oss4_sink_close (asink);
 411     g_free (device);
 412     return FALSE;
 413   }
 414 non_block:
 415   {
 416     if (!silent_errors) {
 417       GST_ELEMENT_ERROR (oss, RESOURCE, SETTINGS, (NULL),
 418           ("Unable to set device %s into non-blocking mode: %s",
 419               oss->device, g_strerror (errno)));
 420     }
 421     g_free (device);
 422     return FALSE;
 423   }
 424 }
 425
 426 static gboolean
 427 gst_oss4_sink_open_func (GstAudioSink * asink)
 428 {
 429   return gst_oss4_sink_open (asink, FALSE);
 430 }
 431
 432 static gboolean
 433 gst_oss4_sink_close (GstAudioSink * asink)
 434 {
 435   GstOss4Sink *oss = GST_OSS4_SINK (asink);
 436
 437   if (oss->fd != -1) {
 438     GST_DEBUG_OBJECT (oss, "closing device");
 439     close (oss->fd);
 440     oss->fd = -1;
 441   }
 442
 443   oss->bytes_per_sample = 0;
 444   /* we keep the probed caps cached, at least until the device changes */
 445
 446   g_free (oss->open_device);
 447   oss->open_device = NULL;
 448
 449   g_free (oss->device_name);
 450   oss->device_name = NULL;
 451
 452   if (oss->probed_caps) {
 453     gst_caps_unref (oss->probed_caps);
 454     oss->probed_caps = NULL;
 455   }
 456
 457   return TRUE;
 458 }
 459
 460 static gboolean
 461 gst_oss4_sink_prepare (GstAudioSink * asink, GstRingBufferSpec * spec)
 462 {
 463   GstOss4Sink *oss;
 464
 465   oss = GST_OSS4_SINK (asink);
 466
 467   if (!gst_oss4_audio_set_format (GST_OBJECT_CAST (oss), oss->fd, spec)) {
 468     GST_WARNING_OBJECT (oss, "Couldn't set requested format %" GST_PTR_FORMAT,
 469         spec->caps);
 470     return FALSE;
 471   }
 472
 473   oss->bytes_per_sample = spec->bytes_per_sample;
 474   return TRUE;
 475 }
 476
 477 static gboolean
 478 gst_oss4_sink_unprepare (GstAudioSink * asink)
 479 {
 480   /* could do a SNDCTL_DSP_HALT, but the OSS manual recommends a close/open,
 481    * since HALT won't properly reset some devices, apparently */
 482
 483   if (!gst_oss4_sink_close (asink))
 484     goto couldnt_close;
 485
 486   if (!gst_oss4_sink_open_func (asink))
 487     goto couldnt_reopen;
 488
 489   return TRUE;
 490
 491   /* ERRORS */
 492 couldnt_close:
 493   {
 494     GST_DEBUG_OBJECT (asink, "Couldn't close the audio device");
 495     return FALSE;
 496   }
 497 couldnt_reopen:
 498   {
 499     GST_DEBUG_OBJECT (asink, "Couldn't reopen the audio device");
 500     return FALSE;
 501   }
 502 }
 503
 504 static guint
 505 gst_oss4_sink_write (GstAudioSink * asink, gpointer data, guint length)
 506 {
 507   GstOss4Sink *oss;
 508   int n;
 509
 510   oss = GST_OSS4_SINK_CAST (asink);
 511
 512   n = write (oss->fd, data, length);
 513   GST_LOG_OBJECT (asink, "wrote %d/%d samples, %d bytes",
 514       n / oss->bytes_per_sample, length / oss->bytes_per_sample, n);
 515
 516   if (G_UNLIKELY (n < 0)) {
 517     switch (errno) {
 518       case ENOTSUP:
 519       case EACCES:{
 520         /* This is the most likely cause, I think */
 521         GST_ELEMENT_ERROR (asink, RESOURCE, WRITE,
 522             (_("Playback is not supported by this audio device.")),
 523             ("write: %s (device: %s) (maybe this is an input-only device?)",
 524                 g_strerror (errno), oss->open_device));
 525         break;
 526       }
 527       default:{
 528         GST_ELEMENT_ERROR (asink, RESOURCE, WRITE,
 529             (_("Audio playback error.")),
 530             ("write: %s (device: %s)", g_strerror (errno), oss->open_device));
 531         break;
 532       }
 533     }
 534   }
 535
 536   return n;
 537 }
 538
 539 static guint
 540 gst_oss4_sink_delay (GstAudioSink * asink)
 541 {
 542   GstOss4Sink *oss;
 543   gint delay = -1;
 544
 545   oss = GST_OSS4_SINK_CAST (asink);
 546
 547   if (ioctl (oss->fd, SNDCTL_DSP_GETODELAY, &delay) < 0 || delay < 0) {
 548     GST_LOG_OBJECT (oss, "GETODELAY failed");
 549     return 0;
 550   }
 551
 552   return delay / oss->bytes_per_sample;
 553 }
 554
 555 static void
 556 gst_oss4_sink_reset (GstAudioSink * asink)
 557 {
 558   /* There's nothing we can do here really: OSS can't handle access to the
 559    * same device/fd from multiple threads and might deadlock or blow up in
 560    * other ways if we try an ioctl SNDCTL_DSP_HALT or similar */
 561 }
 562
 563 static void
 564 gst_oss4_sink_init_interfaces (GType type)
 565 {
 566   gst_oss4_add_property_probe_interface (type);
 567 }