sys/oss/gstosssrc.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *               2000,2005 Wim Taymans <wim@fluendo.com>
   4  *
   5  * gstosssrc.c:
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 /**
  24  * SECTION:element-osssrc
  25  * @short_description: record sound from your sound card using OSS
  26  *
  27  * <refsect2>
  28  * <para>
  29  * This element lets you record sound using the Open Sound System (OSS).
  30  * </para>
  31  * <title>Example pipelines</title>
  32  * <para>
  33  * <programlisting>
  34  * gst-launch -v osssrc ! audioconvert ! vorbisenc ! oggmux ! filesink location=mymusic.ogg
  35  * </programlisting>
  36  * will record sound from your sound card using OSS and encode it to an
  37  * Ogg/Vorbis file (this will only work if your mixer settings are right
  38  * and the right inputs enabled etc.)
  39  * </para>
  40  * </refsect2>
  41  */
  42
  43 #ifdef HAVE_CONFIG_H
  44 #include "config.h"
  45 #endif
  46
  47 #include <sys/ioctl.h>
  48 #include <fcntl.h>
  49 #include <errno.h>
  50 #include <unistd.h>
  51 #include <string.h>
  52
  53 #ifdef HAVE_OSS_INCLUDE_IN_SYS
  54 # include <sys/soundcard.h>
  55 #else
  56 # ifdef HAVE_OSS_INCLUDE_IN_ROOT
  57 #  include <soundcard.h>
  58 # else
  59 #  ifdef HAVE_OSS_INCLUDE_IN_MACHINE
  60 #   include <machine/soundcard.h>
  61 #  else
  62 #   error "What to include?"
  63 #  endif /* HAVE_OSS_INCLUDE_IN_MACHINE */
  64 # endif /* HAVE_OSS_INCLUDE_IN_ROOT */
  65 #endif /* HAVE_OSS_INCLUDE_IN_SYS */
  66
  67 #include "gstosssrc.h"
  68 #include "common.h"
  69
  70 GST_DEBUG_CATEGORY_EXTERN (oss_debug);
  71 #define GST_CAT_DEFAULT oss_debug
  72
  73 static const GstElementDetails gst_oss_src_details =
  74 GST_ELEMENT_DETAILS ("Audio Source (OSS)",
  75     "Source/Audio",
  76     "Capture from a sound card via OSS",
  77     "Erik Walthinsen <omega@cse.ogi.edu>, " "Wim Taymans <wim@fluendo.com>");
  78
  79 #define DEFAULT_DEVICE          "/dev/dsp"
  80 #define DEFAULT_DEVICE_NAME     ""
  81
  82 enum
  83 {
  84   PROP_0,
  85   PROP_DEVICE,
  86   PROP_DEVICE_NAME,
  87 };
  88
  89 GST_BOILERPLATE_WITH_INTERFACE (GstOssSrc, gst_oss_src, GstAudioSrc,
  90     GST_TYPE_AUDIO_SRC, GstMixer, GST_TYPE_MIXER, gst_oss_src_mixer);
  91
  92 GST_IMPLEMENT_OSS_MIXER_METHODS (GstOssSrc, gst_oss_src_mixer);
  93
  94 static void gst_oss_src_get_property (GObject * object, guint prop_id,
  95     GValue * value, GParamSpec * pspec);
  96 static void gst_oss_src_set_property (GObject * object, guint prop_id,
  97     const GValue * value, GParamSpec * pspec);
  98
  99 static void gst_oss_src_dispose (GObject * object);
 100
 101 static GstCaps *gst_oss_src_getcaps (GstBaseSrc * bsrc);
 102
 103 static gboolean gst_oss_src_open (GstAudioSrc * asrc);
 104 static gboolean gst_oss_src_close (GstAudioSrc * asrc);
 105 static gboolean gst_oss_src_prepare (GstAudioSrc * asrc,
 106     GstRingBufferSpec * spec);
 107 static gboolean gst_oss_src_unprepare (GstAudioSrc * asrc);
 108 static guint gst_oss_src_read (GstAudioSrc * asrc, gpointer data, guint length);
 109 static guint gst_oss_src_delay (GstAudioSrc * asrc);
 110 static void gst_oss_src_reset (GstAudioSrc * asrc);
 111
 112
 113
 114 static GstStaticPadTemplate osssrc_src_factory = GST_STATIC_PAD_TEMPLATE ("src",
 115     GST_PAD_SRC,
 116     GST_PAD_ALWAYS,
 117     GST_STATIC_CAPS ("audio/x-raw-int, "
 118         "endianness = (int) { " G_STRINGIFY (G_BYTE_ORDER) " }, "
 119         "signed = (boolean) { TRUE, FALSE }, "
 120         "width = (int) 16, "
 121         "depth = (int) 16, "
 122         "rate = (int) [ 1, MAX ], " "channels = (int) [ 1, 2 ]; "
 123         "audio/x-raw-int, "
 124         "signed = (boolean) { TRUE, FALSE }, "
 125         "width = (int) 8, "
 126         "depth = (int) 8, "
 127         "rate = (int) [ 1, MAX ], " "channels = (int) [ 1, 2 ]")
 128     );
 129
 130
 131 static void
 132 gst_oss_src_dispose (GObject * object)
 133 {
 134   G_OBJECT_CLASS (parent_class)->dispose (object);
 135 }
 136
 137 static void
 138 gst_oss_src_base_init (gpointer g_class)
 139 {
 140   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
 141
 142   gst_element_class_set_details (element_class, &gst_oss_src_details);
 143
 144   gst_element_class_add_pad_template (element_class,
 145       gst_static_pad_template_get (&osssrc_src_factory));
 146 }
 147 static void
 148 gst_oss_src_class_init (GstOssSrcClass * klass)
 149 {
 150   GObjectClass *gobject_class;
 151   GstElementClass *gstelement_class;
 152   GstBaseSrcClass *gstbasesrc_class;
 153   GstBaseAudioSrcClass *gstbaseaudiosrc_class;
 154   GstAudioSrcClass *gstaudiosrc_class;
 155
 156   gobject_class = (GObjectClass *) klass;
 157   gstelement_class = (GstElementClass *) klass;
 158   gstbasesrc_class = (GstBaseSrcClass *) klass;
 159   gstbaseaudiosrc_class = (GstBaseAudioSrcClass *) klass;
 160   gstaudiosrc_class = (GstAudioSrcClass *) klass;
 161
 162   gobject_class->dispose = GST_DEBUG_FUNCPTR (gst_oss_src_dispose);
 163   gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_oss_src_get_property);
 164   gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_oss_src_set_property);
 165
 166   gstbasesrc_class->get_caps = GST_DEBUG_FUNCPTR (gst_oss_src_getcaps);
 167
 168   gstaudiosrc_class->open = GST_DEBUG_FUNCPTR (gst_oss_src_open);
 169   gstaudiosrc_class->prepare = GST_DEBUG_FUNCPTR (gst_oss_src_prepare);
 170   gstaudiosrc_class->unprepare = GST_DEBUG_FUNCPTR (gst_oss_src_unprepare);
 171   gstaudiosrc_class->close = GST_DEBUG_FUNCPTR (gst_oss_src_close);
 172   gstaudiosrc_class->read = GST_DEBUG_FUNCPTR (gst_oss_src_read);
 173   gstaudiosrc_class->delay = GST_DEBUG_FUNCPTR (gst_oss_src_delay);
 174   gstaudiosrc_class->reset = GST_DEBUG_FUNCPTR (gst_oss_src_reset);
 175
 176   g_object_class_install_property (gobject_class, PROP_DEVICE,
 177       g_param_spec_string ("device", "Device",
 178           "OSS device (usually /dev/dspN)", DEFAULT_DEVICE, G_PARAM_READWRITE));
 179
 180   g_object_class_install_property (gobject_class, PROP_DEVICE_NAME,
 181       g_param_spec_string ("device-name", "Device name",
 182           "Human-readable name of the sound device", DEFAULT_DEVICE_NAME,
 183           G_PARAM_READABLE));
 184 }
 185
 186 static void
 187 gst_oss_src_set_property (GObject * object, guint prop_id,
 188     const GValue * value, GParamSpec * pspec)
 189 {
 190   GstOssSrc *src;
 191
 192   src = GST_OSS_SRC (object);
 193
 194   switch (prop_id) {
 195     case PROP_DEVICE:
 196       if (src->device)
 197         g_free (src->device);
 198       src->device = g_value_dup_string (value);
 199       break;
 200     default:
 201       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 202       break;
 203   }
 204 }
 205
 206 static void
 207 gst_oss_src_get_property (GObject * object, guint prop_id,
 208     GValue * value, GParamSpec * pspec)
 209 {
 210   GstOssSrc *src;
 211
 212   src = GST_OSS_SRC (object);
 213
 214   switch (prop_id) {
 215     case PROP_DEVICE:
 216       g_value_set_string (value, src->device);
 217       break;
 218     case PROP_DEVICE_NAME:
 219       g_value_set_string (value, src->device_name);
 220       break;
 221     default:
 222       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 223       break;
 224   }
 225 }
 226
 227 static void
 228 gst_oss_src_init (GstOssSrc * osssrc, GstOssSrcClass * g_class)
 229 {
 230   GST_DEBUG ("initializing osssrc");
 231
 232   osssrc->fd = -1;
 233   osssrc->device = g_strdup (DEFAULT_DEVICE);
 234   osssrc->device_name = g_strdup (DEFAULT_DEVICE_NAME);
 235 }
 236
 237 static GstCaps *
 238 gst_oss_src_getcaps (GstBaseSrc * bsrc)
 239 {
 240   GstOssSrc *osssrc;
 241   GstCaps *caps;
 242
 243   osssrc = GST_OSS_SRC (bsrc);
 244
 245   if (osssrc->fd == -1) {
 246     caps = gst_caps_copy (gst_pad_get_pad_template_caps (GST_BASE_SRC_PAD
 247             (bsrc)));
 248   } else {
 249     caps = gst_oss_helper_probe_caps (osssrc->fd);
 250   }
 251
 252   return caps;
 253 }
 254
 255 static gint
 256 ilog2 (gint x)
 257 {
 258   /* well... hacker's delight explains... */
 259   x = x | (x >> 1);
 260   x = x | (x >> 2);
 261   x = x | (x >> 4);
 262   x = x | (x >> 8);
 263   x = x | (x >> 16);
 264   x = x - ((x >> 1) & 0x55555555);
 265   x = (x & 0x33333333) + ((x >> 2) & 0x33333333);
 266   x = (x + (x >> 4)) & 0x0f0f0f0f;
 267   x = x + (x >> 8);
 268   x = x + (x >> 16);
 269   return (x & 0x0000003f) - 1;
 270 }
 271
 272 static gint
 273 gst_oss_src_get_format (GstBufferFormat fmt)
 274 {
 275   gint result;
 276
 277   switch (fmt) {
 278     case GST_MU_LAW:
 279       result = AFMT_MU_LAW;
 280       break;
 281     case GST_A_LAW:
 282       result = AFMT_A_LAW;
 283       break;
 284     case GST_IMA_ADPCM:
 285       result = AFMT_IMA_ADPCM;
 286       break;
 287     case GST_U8:
 288       result = AFMT_U8;
 289       break;
 290     case GST_S16_LE:
 291       result = AFMT_S16_LE;
 292       break;
 293     case GST_S16_BE:
 294       result = AFMT_S16_BE;
 295       break;
 296     case GST_S8:
 297       result = AFMT_S8;
 298       break;
 299     case GST_U16_LE:
 300       result = AFMT_U16_LE;
 301       break;
 302     case GST_U16_BE:
 303       result = AFMT_U16_BE;
 304       break;
 305     case GST_MPEG:
 306       result = AFMT_MPEG;
 307       break;
 308     default:
 309       result = 0;
 310       break;
 311   }
 312   return result;
 313 }
 314
 315 static gboolean
 316 gst_oss_src_open (GstAudioSrc * asrc)
 317 {
 318   GstOssSrc *oss;
 319   int mode;
 320
 321   oss = GST_OSS_SRC (asrc);
 322
 323   mode = O_RDONLY;
 324   mode |= O_NONBLOCK;
 325
 326   oss->fd = open (oss->device, mode, 0);
 327   if (oss->fd == -1)
 328     goto open_failed;
 329
 330   if (!oss->mixer) {
 331     oss->mixer = gst_ossmixer_new ("/dev/mixer", GST_OSS_MIXER_CAPTURE);
 332
 333     if (oss->mixer) {
 334       g_free (oss->device_name);
 335       oss->device_name = g_strdup (oss->mixer->cardname);
 336     }
 337   }
 338   return TRUE;
 339
 340 open_failed:
 341   {
 342     GST_ELEMENT_ERROR (oss, RESOURCE, OPEN_READ,
 343         ("Unable to open device %s for recording: %s",
 344             oss->device, g_strerror (errno)), (NULL));
 345     return FALSE;
 346   }
 347 }
 348
 349 static gboolean
 350 gst_oss_src_close (GstAudioSrc * asrc)
 351 {
 352   GstOssSrc *oss;
 353
 354   oss = GST_OSS_SRC (asrc);
 355
 356   close (oss->fd);
 357
 358   if (oss->mixer) {
 359     gst_ossmixer_free (oss->mixer);
 360     oss->mixer = NULL;
 361   }
 362
 363   return TRUE;
 364 }
 365
 366 static gboolean
 367 gst_oss_src_prepare (GstAudioSrc * asrc, GstRingBufferSpec * spec)
 368 {
 369   GstOssSrc *oss;
 370   struct audio_buf_info info;
 371   int mode;
 372   int fmt, tmp;
 373
 374   oss = GST_OSS_SRC (asrc);
 375
 376   mode = fcntl (oss->fd, F_GETFL);
 377   mode &= ~O_NONBLOCK;
 378   if (fcntl (oss->fd, F_SETFL, mode) == -1)
 379     goto non_block;
 380
 381   fmt = gst_oss_src_get_format (spec->format);
 382   if (fmt == 0)
 383     goto wrong_format;
 384
 385   tmp = ilog2 (spec->segsize);
 386   tmp = ((spec->segtotal & 0x7fff) << 16) | tmp;
 387   GST_DEBUG_OBJECT (oss, "set segsize: %d, segtotal: %d, value: %08x",
 388       spec->segsize, spec->segtotal, tmp);
 389
 390   SET_PARAM (oss, SNDCTL_DSP_SETFRAGMENT, tmp, "SETFRAGMENT");
 391
 392   SET_PARAM (oss, SNDCTL_DSP_RESET, 0, "RESET");
 393
 394   SET_PARAM (oss, SNDCTL_DSP_SETFMT, fmt, "SETFMT");
 395   if (spec->channels == 2)
 396     SET_PARAM (oss, SNDCTL_DSP_STEREO, 1, "STEREO");
 397   SET_PARAM (oss, SNDCTL_DSP_CHANNELS, spec->channels, "CHANNELS");
 398   SET_PARAM (oss, SNDCTL_DSP_SPEED, spec->rate, "SPEED");
 399
 400   GET_PARAM (oss, SNDCTL_DSP_GETISPACE, &info, "GETISPACE");
 401
 402   spec->segsize = info.fragsize;
 403   spec->segtotal = info.fragstotal;
 404
 405   if (spec->width != 16 && spec->width != 8)
 406     goto dodgy_width;
 407
 408   spec->bytes_per_sample = (spec->width / 8) * spec->channels;
 409   oss->bytes_per_sample = (spec->width / 8) * spec->channels;
 410   memset (spec->silence_sample, 0, spec->bytes_per_sample);
 411
 412   GST_DEBUG_OBJECT (oss, "got segsize: %d, segtotal: %d, value: %08x",
 413       spec->segsize, spec->segtotal, tmp);
 414
 415   return TRUE;
 416
 417 non_block:
 418   {
 419     GST_ELEMENT_ERROR (oss, RESOURCE, OPEN_READ,
 420         ("Unable to set device %s in non blocking mode: %s",
 421             oss->device, g_strerror (errno)), (NULL));
 422     return FALSE;
 423   }
 424 wrong_format:
 425   {
 426     GST_ELEMENT_ERROR (oss, RESOURCE, OPEN_READ,
 427         ("Unable to get format %d", spec->format), (NULL));
 428     return FALSE;
 429   }
 430 dodgy_width:
 431   {
 432     GST_ELEMENT_ERROR (oss, RESOURCE, OPEN_READ,
 433         ("Unexpected width %d", spec->width), (NULL));
 434     return FALSE;
 435   }
 436 }
 437
 438 static gboolean
 439 gst_oss_src_unprepare (GstAudioSrc * asrc)
 440 {
 441   /* could do a SNDCTL_DSP_RESET, but the OSS manual recommends a close/open */
 442
 443   if (!gst_oss_src_close (asrc))
 444     goto couldnt_close;
 445
 446   if (!gst_oss_src_open (asrc))
 447     goto couldnt_reopen;
 448
 449   return TRUE;
 450
 451 couldnt_close:
 452   {
 453     GST_DEBUG_OBJECT (asrc, "Could not close the audio device");
 454     return FALSE;
 455   }
 456 couldnt_reopen:
 457   {
 458     GST_DEBUG_OBJECT (asrc, "Could not reopen the audio device");
 459     return FALSE;
 460   }
 461 }
 462
 463 static guint
 464 gst_oss_src_read (GstAudioSrc * asrc, gpointer data, guint length)
 465 {
 466   return read (GST_OSS_SRC (asrc)->fd, data, length);
 467 }
 468
 469 static guint
 470 gst_oss_src_delay (GstAudioSrc * asrc)
 471 {
 472   GstOssSrc *oss;
 473   gint delay = 0;
 474   gint ret;
 475
 476   oss = GST_OSS_SRC (asrc);
 477
 478 #ifdef SNDCTL_DSP_GETODELAY
 479   ret = ioctl (oss->fd, SNDCTL_DSP_GETODELAY, &delay);
 480 #else
 481   ret = -1;
 482 #endif
 483   if (ret < 0) {
 484     audio_buf_info info;
 485
 486     ret = ioctl (oss->fd, SNDCTL_DSP_GETOSPACE, &info);
 487
 488     delay = (ret < 0 ? 0 : (info.fragstotal * info.fragsize) - info.bytes);
 489   }
 490   return delay / oss->bytes_per_sample;
 491 }
 492
 493 static void
 494 gst_oss_src_reset (GstAudioSrc * asrc)
 495 {
 496   GstOssSrc *oss;
 497
 498   //gint ret;
 499
 500   oss = GST_OSS_SRC (asrc);
 501
 502   /* deadlocks on my machine... */
 503   //ret = ioctl (oss->fd, SNDCTL_DSP_RESET, 0);
 504 }