sys/oss/gstosssink.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wim.taymans@chello.be>
   4  *
   5  * gstosssink.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 #ifdef HAVE_CONFIG_H
  24 #include "config.h"
  25 #endif
  26 #include <sys/ioctl.h>
  27 #include <sys/soundcard.h>
  28 #include <errno.h>
  29 #include <unistd.h>
  30
  31 #include "gstosssink.h"
  32
  33 /* elementfactory information */
  34 static GstElementDetails gst_osssink_details = GST_ELEMENT_DETAILS (
  35   "Audio Sink (OSS)",
  36   "Sink/Audio",
  37   "Output to a sound card via OSS",
  38   "Erik Walthinsen <omega@cse.ogi.edu>, "
  39   "Wim Taymans <wim.taymans@chello.be>"
  40 );
  41
  42 static void                     gst_osssink_base_init           (gpointer g_class);
  43 static void                     gst_osssink_class_init          (GstOssSinkClass *klass);
  44 static void                     gst_osssink_init                (GstOssSink *osssink);
  45 static void                     gst_osssink_dispose             (GObject *object);
  46
  47 static GstElementStateReturn    gst_osssink_change_state        (GstElement *element);
  48 static void                     gst_osssink_set_clock           (GstElement *element, GstClock *clock);
  49 static GstClock*                gst_osssink_get_clock           (GstElement *element);
  50 static GstClockTime             gst_osssink_get_time            (GstClock *clock, gpointer data);
  51
  52 static const GstFormat*         gst_osssink_get_formats         (GstPad *pad);
  53 static gboolean                 gst_osssink_convert             (GstPad *pad, GstFormat src_format, gint64 src_value,
  54                                                                  GstFormat *dest_format, gint64 *dest_value);
  55 static const GstQueryType*      gst_osssink_get_query_types     (GstPad *pad);
  56 static gboolean                 gst_osssink_query               (GstElement *element, GstQueryType type,
  57                                                                  GstFormat *format, gint64 *value);
  58 static gboolean                 gst_osssink_sink_query          (GstPad *pad, GstQueryType type,
  59                                                                  GstFormat *format, gint64 *value);
  60
  61 static GstCaps *                gst_osssink_sink_fixate         (GstPad *pad, const GstCaps *caps);
  62 static GstPadLinkReturn         gst_osssink_sinkconnect         (GstPad *pad, const GstCaps *caps);
  63
  64 static void                     gst_osssink_set_property        (GObject *object, guint prop_id, const GValue *value,
  65                                                                  GParamSpec *pspec);
  66 static void                     gst_osssink_get_property        (GObject *object, guint prop_id, GValue *value,
  67                                                                  GParamSpec *pspec);
  68
  69 static void                     gst_osssink_chain               (GstPad *pad,GstData *_data);
  70
  71 /* OssSink signals and args */
  72 enum {
  73   SIGNAL_HANDOFF,
  74   LAST_SIGNAL
  75 };
  76
  77 enum {
  78   ARG_0,
  79   ARG_MUTE,
  80   ARG_FRAGMENT,
  81   ARG_BUFFER_SIZE,
  82   ARG_SYNC,
  83   ARG_CHUNK_SIZE,
  84   /* FILL ME */
  85 };
  86
  87 static GstStaticPadTemplate osssink_sink_factory =
  88 GST_STATIC_PAD_TEMPLATE (
  89   "sink",
  90   GST_PAD_SINK,
  91   GST_PAD_ALWAYS,
  92   GST_STATIC_CAPS ("audio/x-raw-int, "
  93       "endianness = (int) BYTE_ORDER, "
  94       "signed = (boolean) { TRUE, FALSE }, "
  95       "width = (int) { 8, 16 }, "
  96       "depth = (int) { 8, 16 }, "
  97       "rate = (int) [ 1000, 48000 ], "
  98       "channels = (int) [ 1, 2 ]"
  99   )
 100 );
 101
 102 static GstElementClass *parent_class = NULL;
 103 static guint gst_osssink_signals[LAST_SIGNAL] = { 0 };
 104
 105 GType
 106 gst_osssink_get_type (void)
 107 {
 108   static GType osssink_type = 0;
 109
 110   if (!osssink_type) {
 111     static const GTypeInfo osssink_info = {
 112       sizeof(GstOssSinkClass),
 113       gst_osssink_base_init,
 114       NULL,
 115       (GClassInitFunc)gst_osssink_class_init,
 116       NULL,
 117       NULL,
 118       sizeof(GstOssSink),
 119       0,
 120       (GInstanceInitFunc)gst_osssink_init,
 121     };
 122     osssink_type = g_type_register_static (GST_TYPE_OSSELEMENT, "GstOssSink", &osssink_info, 0);
 123   }
 124
 125   return osssink_type;
 126 }
 127
 128 static void
 129 gst_osssink_dispose (GObject *object)
 130 {
 131   GstOssSink *osssink = (GstOssSink *) object;
 132
 133   gst_object_unparent (GST_OBJECT (osssink->provided_clock));
 134
 135   G_OBJECT_CLASS (parent_class)->dispose (object);
 136 }
 137
 138 static void
 139 gst_osssink_base_init (gpointer g_class)
 140 {
 141   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
 142
 143   gst_element_class_set_details (element_class, &gst_osssink_details);
 144   gst_element_class_add_pad_template (element_class, gst_static_pad_template_get (&osssink_sink_factory));
 145 }
 146 static void
 147 gst_osssink_class_init (GstOssSinkClass *klass)
 148 {
 149   GObjectClass *gobject_class;
 150   GstElementClass *gstelement_class;
 151
 152   gobject_class = (GObjectClass*)klass;
 153   gstelement_class = (GstElementClass*)klass;
 154
 155   parent_class = g_type_class_ref(GST_TYPE_OSSELEMENT);
 156
 157   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_MUTE,
 158     g_param_spec_boolean ("mute", "Mute", "Mute the audio",
 159                           FALSE, G_PARAM_READWRITE));
 160   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_SYNC,
 161     g_param_spec_boolean ("sync", "Sync", "If syncing on timestamps should be enabled",
 162                           TRUE, G_PARAM_READWRITE));
 163   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_FRAGMENT,
 164     g_param_spec_int ("fragment", "Fragment",
 165                       "The fragment as 0xMMMMSSSS (MMMM = total fragments, 2^SSSS = fragment size)",
 166                       0, G_MAXINT, 6, G_PARAM_READWRITE));
 167   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_BUFFER_SIZE,
 168     g_param_spec_uint ("buffer_size", "Buffer size", "Size of buffers in osssink's bufferpool (bytes)",
 169                        0, G_MAXINT, 4096, G_PARAM_READWRITE));
 170   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_CHUNK_SIZE,
 171     g_param_spec_uint ("chunk_size", "Chunk size", "Write data in chunk sized buffers",
 172                        0, G_MAXUINT, 4096, G_PARAM_READWRITE));
 173
 174   gst_osssink_signals[SIGNAL_HANDOFF] =
 175     g_signal_new ("handoff", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
 176                   G_STRUCT_OFFSET (GstOssSinkClass, handoff), NULL, NULL,
 177                   g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
 178
 179   gobject_class->set_property = gst_osssink_set_property;
 180   gobject_class->get_property = gst_osssink_get_property;
 181   gobject_class->dispose      = gst_osssink_dispose;
 182
 183   gstelement_class->change_state = GST_DEBUG_FUNCPTR (gst_osssink_change_state);
 184   gstelement_class->query        = GST_DEBUG_FUNCPTR (gst_osssink_query);
 185   gstelement_class->set_clock    = gst_osssink_set_clock;
 186   gstelement_class->get_clock    = gst_osssink_get_clock;
 187
 188 }
 189
 190 static void
 191 gst_osssink_init (GstOssSink *osssink)
 192 {
 193   osssink->sinkpad = gst_pad_new_from_template (
 194                   gst_static_pad_template_get (&osssink_sink_factory), "sink");
 195   gst_element_add_pad (GST_ELEMENT (osssink), osssink->sinkpad);
 196   gst_pad_set_link_function (osssink->sinkpad, gst_osssink_sinkconnect);
 197   gst_pad_set_fixate_function (osssink->sinkpad, gst_osssink_sink_fixate);
 198   gst_pad_set_convert_function (osssink->sinkpad, gst_osssink_convert);
 199   gst_pad_set_query_function (osssink->sinkpad, gst_osssink_sink_query);
 200   gst_pad_set_query_type_function (osssink->sinkpad, gst_osssink_get_query_types);
 201   gst_pad_set_formats_function (osssink->sinkpad, gst_osssink_get_formats);
 202
 203   gst_pad_set_chain_function (osssink->sinkpad, gst_osssink_chain);
 204
 205   osssink->bufsize = 4096;
 206   osssink->chunk_size = 4096;
 207   osssink->resync = FALSE;
 208   osssink->mute = FALSE;
 209   osssink->sync = TRUE;
 210   osssink->provided_clock = gst_audio_clock_new ("ossclock", gst_osssink_get_time, osssink);
 211   gst_object_set_parent (GST_OBJECT (osssink->provided_clock), GST_OBJECT (osssink));
 212   osssink->handled = 0;
 213
 214   GST_FLAG_SET (osssink, GST_ELEMENT_THREAD_SUGGESTED);
 215   GST_FLAG_SET (osssink, GST_ELEMENT_EVENT_AWARE);
 216 }
 217
 218 static GstCaps *
 219 gst_osssink_sink_fixate (GstPad *pad, const GstCaps *caps)
 220 {
 221   GstCaps *newcaps;
 222   GstStructure *structure;
 223
 224   structure = gst_structure_copy(gst_caps_get_structure (caps, 0));
 225   newcaps = gst_caps_new_full (structure, NULL);
 226
 227   if (gst_caps_structure_fixate_field_nearest_int (structure, "rate", 44100)) {
 228     return newcaps;
 229   }
 230   if (gst_caps_structure_fixate_field_nearest_int (structure, "depth", 16)) {
 231     return newcaps;
 232   }
 233   if (gst_caps_structure_fixate_field_nearest_int (structure, "width", 16)) {
 234     return newcaps;
 235   }
 236   if (gst_caps_structure_fixate_field_nearest_int (structure, "channels", 2)) {
 237     return newcaps;
 238   }
 239
 240   gst_caps_free (newcaps);
 241
 242   return NULL;
 243 }
 244
 245 static GstPadLinkReturn
 246 gst_osssink_sinkconnect (GstPad *pad, const GstCaps *caps)
 247 {
 248   GstOssSink *osssink = GST_OSSSINK (gst_pad_get_parent (pad));
 249
 250   if (!gst_osselement_parse_caps (GST_OSSELEMENT (osssink), caps))
 251     return GST_PAD_LINK_REFUSED;
 252
 253   if (!gst_osselement_sync_parms (GST_OSSELEMENT (osssink))) {
 254     return GST_PAD_LINK_REFUSED;
 255   }
 256
 257   return GST_PAD_LINK_OK;
 258 }
 259
 260 static inline gint64
 261 gst_osssink_get_delay (GstOssSink *osssink)
 262 {
 263   gint delay = 0;
 264
 265   if (GST_OSSELEMENT (osssink)->fd == -1)
 266     return 0;
 267
 268   if (ioctl (GST_OSSELEMENT (osssink)->fd, SNDCTL_DSP_GETODELAY, &delay) < 0) {
 269     audio_buf_info info;
 270     if (ioctl (GST_OSSELEMENT (osssink)->fd, SNDCTL_DSP_GETOSPACE, &info) < 0) {
 271       delay = 0;
 272     }
 273     else {
 274       delay = (info.fragstotal * info.fragsize) - info.bytes;
 275     }
 276   }
 277   return delay;
 278 }
 279
 280 static GstClockTime
 281 gst_osssink_get_time (GstClock *clock, gpointer data)
 282 {
 283   GstOssSink *osssink = GST_OSSSINK (data);
 284   gint delay;
 285   GstClockTime res;
 286
 287   if (!GST_OSSELEMENT (osssink)->bps)
 288     return 0;
 289
 290   delay = gst_osssink_get_delay (osssink);
 291
 292   /* sometimes delay is bigger than the number of bytes sent to the device,
 293    * which screws up this calculation, we assume that everything is still
 294    * in the device then */
 295   if (((guint64)delay) > osssink->handled) {
 296     delay = osssink->handled;
 297   }
 298   res =  (osssink->handled - delay) * GST_SECOND / GST_OSSELEMENT (osssink)->bps;
 299
 300   return res;
 301 }
 302
 303 static GstClock*
 304 gst_osssink_get_clock (GstElement *element)
 305 {
 306   GstOssSink *osssink;
 307
 308   osssink = GST_OSSSINK (element);
 309
 310   return GST_CLOCK (osssink->provided_clock);
 311 }
 312
 313 static void
 314 gst_osssink_set_clock (GstElement *element, GstClock *clock)
 315 {
 316   GstOssSink *osssink;
 317
 318   osssink = GST_OSSSINK (element);
 319
 320   osssink->clock = clock;
 321 }
 322
 323 static void
 324 gst_osssink_chain (GstPad *pad, GstData *_data)
 325 {
 326   GstBuffer *buf = GST_BUFFER (_data);
 327   GstOssSink *osssink;
 328   GstClockTime buftime;
 329
 330   /* this has to be an audio buffer */
 331   osssink = GST_OSSSINK (gst_pad_get_parent (pad));
 332
 333   if (GST_IS_EVENT (buf)) {
 334     GstEvent *event = GST_EVENT (buf);
 335
 336     switch (GST_EVENT_TYPE (event)) {
 337       case GST_EVENT_EOS:
 338         ioctl (GST_OSSELEMENT (osssink)->fd, SNDCTL_DSP_SYNC);
 339         gst_audio_clock_set_active (GST_AUDIO_CLOCK (osssink->provided_clock), FALSE);
 340         gst_pad_event_default (pad, event);
 341         return;
 342       case GST_EVENT_DISCONTINUOUS:
 343       {
 344         gint64 value;
 345
 346         ioctl (GST_OSSELEMENT (osssink)->fd, SNDCTL_DSP_RESET);
 347         if (gst_event_discont_get_value (event, GST_FORMAT_TIME, &value)) {
 348           if (!gst_clock_handle_discont (osssink->clock, value))
 349             gst_audio_clock_set_active (GST_AUDIO_CLOCK (osssink->provided_clock), FALSE);
 350           osssink->handled = 0;
 351         }
 352         osssink->resync = TRUE;
 353
 354         break;
 355       }
 356       default:
 357         gst_pad_event_default (pad, event);
 358         return;
 359     }
 360     gst_event_unref (event);
 361     return;
 362   }
 363
 364   if (!GST_OSSELEMENT (osssink)->bps) {
 365     gst_buffer_unref (buf);
 366     gst_element_error (GST_ELEMENT (osssink), "capsnego was never performed, unknown data type");
 367     return;
 368   }
 369
 370   buftime = GST_BUFFER_TIMESTAMP (buf);
 371
 372   if (GST_OSSELEMENT (osssink)->fd >= 0) {
 373     if (!osssink->mute) {
 374       guchar *data = GST_BUFFER_DATA (buf);
 375       gint size = GST_BUFFER_SIZE (buf);
 376       gint to_write = 0;
 377
 378       if (osssink->clock) {
 379         gint delay = 0;
 380         gint64 queued;
 381         GstClockTimeDiff jitter;
 382
 383         delay = gst_osssink_get_delay (osssink);
 384         queued = delay * GST_SECOND / GST_OSSELEMENT (osssink)->bps;
 385
 386         if  (osssink->resync && osssink->sync) {
 387           GstClockID id = gst_clock_new_single_shot_id (osssink->clock, buftime - queued);
 388
 389           gst_element_clock_wait (GST_ELEMENT (osssink), id, &jitter);
 390           gst_clock_id_free (id);
 391
 392           if (jitter >= 0) {
 393             gst_clock_handle_discont (osssink->clock, buftime - queued + jitter);
 394             to_write = size;
 395             gst_audio_clock_set_active ((GstAudioClock*)osssink->provided_clock, TRUE);
 396             osssink->resync = FALSE;
 397           }
 398         }
 399         else {
 400           to_write = size;
 401         }
 402       }
 403       /* no clock, try to be as fast as possible */
 404       else {
 405         audio_buf_info ospace;
 406
 407         ioctl (GST_OSSELEMENT (osssink)->fd, SNDCTL_DSP_GETOSPACE, &ospace);
 408
 409         if (ospace.bytes >= size) {
 410           to_write = size;
 411         }
 412       }
 413
 414       while (to_write > 0) {
 415         gint done = write (GST_OSSELEMENT (osssink)->fd, data,
 416                            MIN (to_write, osssink->chunk_size));
 417
 418         if (done == -1) {
 419           if (errno != EINTR)
 420             break;
 421         }
 422         else {
 423           to_write -= done;
 424           data += done;
 425           osssink->handled += done;
 426         }
 427       }
 428     }
 429   }
 430
 431   gst_audio_clock_update_time ((GstAudioClock*)osssink->provided_clock, buftime);
 432
 433   gst_buffer_unref (buf);
 434 }
 435
 436 static const GstFormat*
 437 gst_osssink_get_formats (GstPad *pad)
 438 {
 439   static const GstFormat formats[] = {
 440     GST_FORMAT_TIME,
 441     GST_FORMAT_DEFAULT,
 442     GST_FORMAT_BYTES,
 443     0
 444   };
 445   return formats;
 446 }
 447
 448 static gboolean
 449 gst_osssink_convert (GstPad *pad, GstFormat src_format, gint64 src_value,
 450                      GstFormat *dest_format, gint64 *dest_value)
 451 {
 452   GstOssSink *osssink;
 453
 454   osssink = GST_OSSSINK (gst_pad_get_parent (pad));
 455
 456   return gst_osselement_convert (GST_OSSELEMENT (osssink),
 457                                  src_format, src_value,
 458                                  dest_format, dest_value);
 459 }
 460
 461 static const GstQueryType*
 462 gst_osssink_get_query_types (GstPad *pad)
 463 {
 464   static const GstQueryType query_types[] = {
 465     GST_QUERY_LATENCY,
 466     GST_QUERY_POSITION,
 467     0,
 468   };
 469   return query_types;
 470 }
 471
 472 static gboolean
 473 gst_osssink_sink_query (GstPad *pad, GstQueryType type, GstFormat *format, gint64 *value)
 474 {
 475   gboolean res = TRUE;
 476   GstOssSink *osssink;
 477
 478   osssink = GST_OSSSINK (gst_pad_get_parent (pad));
 479
 480   switch (type) {
 481     case GST_QUERY_LATENCY:
 482       if (!gst_osssink_convert (pad,
 483                                 GST_FORMAT_BYTES, gst_osssink_get_delay (osssink),
 484                                 format, value))
 485       {
 486         res = FALSE;
 487       }
 488       break;
 489     case GST_QUERY_POSITION:
 490       if (!gst_osssink_convert (pad,
 491                                 GST_FORMAT_TIME, gst_clock_get_time (osssink->provided_clock),
 492                                 format, value))
 493       {
 494         res = FALSE;
 495       }
 496       break;
 497     default:
 498       res = gst_pad_query (gst_pad_get_peer (osssink->sinkpad), type, format, value);
 499       break;
 500   }
 501
 502   return res;
 503 }
 504
 505 static gboolean
 506 gst_osssink_query (GstElement *element, GstQueryType type, GstFormat *format, gint64 *value)
 507 {
 508   GstOssSink *osssink = GST_OSSSINK (element);
 509
 510   return gst_osssink_sink_query (osssink->sinkpad, type, format, value);
 511 }
 512
 513 static void
 514 gst_osssink_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
 515 {
 516   GstOssSink *osssink;
 517
 518   osssink = GST_OSSSINK (object);
 519
 520   switch (prop_id) {
 521     case ARG_MUTE:
 522       osssink->mute = g_value_get_boolean (value);
 523       g_object_notify (G_OBJECT (osssink), "mute");
 524       break;
 525     case ARG_FRAGMENT:
 526       GST_OSSELEMENT (osssink)->fragment = g_value_get_int (value);
 527       gst_osselement_sync_parms (GST_OSSELEMENT (osssink));
 528       break;
 529     case ARG_BUFFER_SIZE:
 530       osssink->bufsize = g_value_get_uint (value);
 531       g_object_notify (object, "buffer_size");
 532       break;
 533     case ARG_SYNC:
 534       osssink->sync = g_value_get_boolean (value);
 535       g_object_notify (G_OBJECT (osssink), "sync");
 536       break;
 537     case ARG_CHUNK_SIZE:
 538       osssink->chunk_size = g_value_get_uint (value);
 539       break;
 540     default:
 541       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 542       break;
 543   }
 544 }
 545
 546 static void
 547 gst_osssink_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
 548 {
 549   GstOssSink *osssink;
 550
 551   osssink = GST_OSSSINK (object);
 552
 553   switch (prop_id) {
 554     case ARG_MUTE:
 555       g_value_set_boolean (value, osssink->mute);
 556       break;
 557     case ARG_FRAGMENT:
 558       g_value_set_int (value, GST_OSSELEMENT (osssink)->fragment);
 559       break;
 560     case ARG_BUFFER_SIZE:
 561       g_value_set_uint (value, osssink->bufsize);
 562       break;
 563     case ARG_SYNC:
 564       g_value_set_boolean (value, osssink->sync);
 565       break;
 566     case ARG_CHUNK_SIZE:
 567       g_value_set_uint (value, osssink->chunk_size);
 568       break;
 569     default:
 570       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 571       break;
 572   }
 573 }
 574
 575 static GstElementStateReturn
 576 gst_osssink_change_state (GstElement *element)
 577 {
 578   GstOssSink *osssink;
 579
 580   osssink = GST_OSSSINK (element);
 581
 582   switch (GST_STATE_TRANSITION (element)) {
 583     case GST_STATE_READY_TO_PAUSED:
 584       break;
 585     case GST_STATE_PAUSED_TO_PLAYING:
 586       osssink->resync = TRUE;
 587       break;
 588     case GST_STATE_PLAYING_TO_PAUSED:
 589       if (GST_FLAG_IS_SET (element, GST_OSSSINK_OPEN))
 590         ioctl (GST_OSSELEMENT (osssink)->fd, SNDCTL_DSP_RESET, 0);
 591       gst_audio_clock_set_active (GST_AUDIO_CLOCK (osssink->provided_clock), FALSE);
 592       osssink->resync = TRUE;
 593       break;
 594     case GST_STATE_PAUSED_TO_READY:
 595       if (GST_FLAG_IS_SET (element, GST_OSSSINK_OPEN))
 596         ioctl (GST_OSSELEMENT (osssink)->fd, SNDCTL_DSP_RESET, 0);
 597       gst_osselement_reset (GST_OSSELEMENT (osssink));
 598       break;
 599     default:
 600       break;
 601   }
 602
 603   if (GST_ELEMENT_CLASS (parent_class)->change_state)
 604     return GST_ELEMENT_CLASS (parent_class)->change_state (element);
 605
 606   return GST_STATE_SUCCESS;
 607 }