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, gpointer user_data);
  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, gpointer user_data)
 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   return newcaps;
 241 }
 242
 243 static GstPadLinkReturn
 244 gst_osssink_sinkconnect (GstPad *pad, const GstCaps *caps)
 245 {
 246   GstOssSink *osssink = GST_OSSSINK (gst_pad_get_parent (pad));
 247
 248   if (!gst_osselement_parse_caps (GST_OSSELEMENT (osssink), caps))
 249     return GST_PAD_LINK_REFUSED;
 250
 251   if (!gst_osselement_sync_parms (GST_OSSELEMENT (osssink))) {
 252     return GST_PAD_LINK_REFUSED;
 253   }
 254
 255   return GST_PAD_LINK_OK;
 256 }
 257
 258 static inline gint64
 259 gst_osssink_get_delay (GstOssSink *osssink)
 260 {
 261   gint delay = 0;
 262
 263   if (GST_OSSELEMENT (osssink)->fd == -1)
 264     return 0;
 265
 266   if (ioctl (GST_OSSELEMENT (osssink)->fd, SNDCTL_DSP_GETODELAY, &delay) < 0) {
 267     audio_buf_info info;
 268     if (ioctl (GST_OSSELEMENT (osssink)->fd, SNDCTL_DSP_GETOSPACE, &info) < 0) {
 269       delay = 0;
 270     }
 271     else {
 272       delay = (info.fragstotal * info.fragsize) - info.bytes;
 273     }
 274   }
 275   return delay;
 276 }
 277
 278 static GstClockTime
 279 gst_osssink_get_time (GstClock *clock, gpointer data)
 280 {
 281   GstOssSink *osssink = GST_OSSSINK (data);
 282   gint delay;
 283   GstClockTime res;
 284
 285   if (!GST_OSSELEMENT (osssink)->bps)
 286     return 0;
 287
 288   delay = gst_osssink_get_delay (osssink);
 289
 290   /* sometimes delay is bigger than the number of bytes sent to the device,
 291    * which screws up this calculation, we assume that everything is still
 292    * in the device then */
 293   if (((guint64)delay) > osssink->handled) {
 294     delay = osssink->handled;
 295   }
 296   res =  (osssink->handled - delay) * GST_SECOND / GST_OSSELEMENT (osssink)->bps;
 297
 298   return res;
 299 }
 300
 301 static GstClock*
 302 gst_osssink_get_clock (GstElement *element)
 303 {
 304   GstOssSink *osssink;
 305
 306   osssink = GST_OSSSINK (element);
 307
 308   return GST_CLOCK (osssink->provided_clock);
 309 }
 310
 311 static void
 312 gst_osssink_set_clock (GstElement *element, GstClock *clock)
 313 {
 314   GstOssSink *osssink;
 315
 316   osssink = GST_OSSSINK (element);
 317
 318   osssink->clock = clock;
 319 }
 320
 321 static void
 322 gst_osssink_chain (GstPad *pad, GstData *_data)
 323 {
 324   GstBuffer *buf = GST_BUFFER (_data);
 325   GstOssSink *osssink;
 326   GstClockTime buftime;
 327
 328   /* this has to be an audio buffer */
 329   osssink = GST_OSSSINK (gst_pad_get_parent (pad));
 330
 331   if (GST_IS_EVENT (buf)) {
 332     GstEvent *event = GST_EVENT (buf);
 333
 334     switch (GST_EVENT_TYPE (event)) {
 335       case GST_EVENT_EOS:
 336         ioctl (GST_OSSELEMENT (osssink)->fd, SNDCTL_DSP_SYNC);
 337         gst_audio_clock_set_active (GST_AUDIO_CLOCK (osssink->provided_clock), FALSE);
 338         gst_pad_event_default (pad, event);
 339         return;
 340       case GST_EVENT_DISCONTINUOUS:
 341       {
 342         gint64 value;
 343
 344         ioctl (GST_OSSELEMENT (osssink)->fd, SNDCTL_DSP_RESET);
 345         if (gst_event_discont_get_value (event, GST_FORMAT_TIME, &value)) {
 346           if (!gst_clock_handle_discont (osssink->clock, value))
 347             gst_audio_clock_set_active (GST_AUDIO_CLOCK (osssink->provided_clock), FALSE);
 348           osssink->handled = 0;
 349         }
 350         osssink->resync = TRUE;
 351
 352         break;
 353       }
 354       default:
 355         gst_pad_event_default (pad, event);
 356         return;
 357     }
 358     gst_event_unref (event);
 359     return;
 360   }
 361
 362   if (!GST_OSSELEMENT (osssink)->bps) {
 363     gst_buffer_unref (buf);
 364     gst_element_error (GST_ELEMENT (osssink), "capsnego was never performed, unknown data type");
 365     return;
 366   }
 367
 368   buftime = GST_BUFFER_TIMESTAMP (buf);
 369
 370   if (GST_OSSELEMENT (osssink)->fd >= 0) {
 371     if (!osssink->mute) {
 372       guchar *data = GST_BUFFER_DATA (buf);
 373       gint size = GST_BUFFER_SIZE (buf);
 374       gint to_write = 0;
 375
 376       if (osssink->clock) {
 377         gint delay = 0;
 378         gint64 queued;
 379         GstClockTimeDiff jitter;
 380
 381         delay = gst_osssink_get_delay (osssink);
 382         queued = delay * GST_SECOND / GST_OSSELEMENT (osssink)->bps;
 383
 384         if  (osssink->resync && osssink->sync) {
 385           GstClockID id = gst_clock_new_single_shot_id (osssink->clock, buftime - queued);
 386
 387           gst_element_clock_wait (GST_ELEMENT (osssink), id, &jitter);
 388           gst_clock_id_free (id);
 389
 390           if (jitter >= 0) {
 391             gst_clock_handle_discont (osssink->clock, buftime - queued + jitter);
 392             to_write = size;
 393             gst_audio_clock_set_active ((GstAudioClock*)osssink->provided_clock, TRUE);
 394             osssink->resync = FALSE;
 395           }
 396         }
 397         else {
 398           to_write = size;
 399         }
 400       }
 401       /* no clock, try to be as fast as possible */
 402       else {
 403         audio_buf_info ospace;
 404
 405         ioctl (GST_OSSELEMENT (osssink)->fd, SNDCTL_DSP_GETOSPACE, &ospace);
 406
 407         if (ospace.bytes >= size) {
 408           to_write = size;
 409         }
 410       }
 411
 412       while (to_write > 0) {
 413         gint done = write (GST_OSSELEMENT (osssink)->fd, data,
 414                            MIN (to_write, osssink->chunk_size));
 415
 416         if (done == -1) {
 417           if (errno != EINTR)
 418             break;
 419         }
 420         else {
 421           to_write -= done;
 422           data += done;
 423           osssink->handled += done;
 424         }
 425       }
 426     }
 427   }
 428
 429   gst_audio_clock_update_time ((GstAudioClock*)osssink->provided_clock, buftime);
 430
 431   gst_buffer_unref (buf);
 432 }
 433
 434 static const GstFormat*
 435 gst_osssink_get_formats (GstPad *pad)
 436 {
 437   static const GstFormat formats[] = {
 438     GST_FORMAT_TIME,
 439     GST_FORMAT_DEFAULT,
 440     GST_FORMAT_BYTES,
 441     0
 442   };
 443   return formats;
 444 }
 445
 446 static gboolean
 447 gst_osssink_convert (GstPad *pad, GstFormat src_format, gint64 src_value,
 448                      GstFormat *dest_format, gint64 *dest_value)
 449 {
 450   GstOssSink *osssink;
 451
 452   osssink = GST_OSSSINK (gst_pad_get_parent (pad));
 453
 454   return gst_osselement_convert (GST_OSSELEMENT (osssink),
 455                                  src_format, src_value,
 456                                  dest_format, dest_value);
 457 }
 458
 459 static const GstQueryType*
 460 gst_osssink_get_query_types (GstPad *pad)
 461 {
 462   static const GstQueryType query_types[] = {
 463     GST_QUERY_LATENCY,
 464     GST_QUERY_POSITION,
 465     0,
 466   };
 467   return query_types;
 468 }
 469
 470 static gboolean
 471 gst_osssink_sink_query (GstPad *pad, GstQueryType type, GstFormat *format, gint64 *value)
 472 {
 473   gboolean res = TRUE;
 474   GstOssSink *osssink;
 475
 476   osssink = GST_OSSSINK (gst_pad_get_parent (pad));
 477
 478   switch (type) {
 479     case GST_QUERY_LATENCY:
 480       if (!gst_osssink_convert (pad,
 481                                 GST_FORMAT_BYTES, gst_osssink_get_delay (osssink),
 482                                 format, value))
 483       {
 484         res = FALSE;
 485       }
 486       break;
 487     case GST_QUERY_POSITION:
 488       if (!gst_osssink_convert (pad,
 489                                 GST_FORMAT_TIME, gst_clock_get_time (osssink->provided_clock),
 490                                 format, value))
 491       {
 492         res = FALSE;
 493       }
 494       break;
 495     default:
 496       res = gst_pad_query (gst_pad_get_peer (osssink->sinkpad), type, format, value);
 497       break;
 498   }
 499
 500   return res;
 501 }
 502
 503 static gboolean
 504 gst_osssink_query (GstElement *element, GstQueryType type, GstFormat *format, gint64 *value)
 505 {
 506   GstOssSink *osssink = GST_OSSSINK (element);
 507
 508   return gst_osssink_sink_query (osssink->sinkpad, type, format, value);
 509 }
 510
 511 static void
 512 gst_osssink_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
 513 {
 514   GstOssSink *osssink;
 515
 516   osssink = GST_OSSSINK (object);
 517
 518   switch (prop_id) {
 519     case ARG_MUTE:
 520       osssink->mute = g_value_get_boolean (value);
 521       g_object_notify (G_OBJECT (osssink), "mute");
 522       break;
 523     case ARG_FRAGMENT:
 524       GST_OSSELEMENT (osssink)->fragment = g_value_get_int (value);
 525       gst_osselement_sync_parms (GST_OSSELEMENT (osssink));
 526       break;
 527     case ARG_BUFFER_SIZE:
 528       osssink->bufsize = g_value_get_uint (value);
 529       g_object_notify (object, "buffer_size");
 530       break;
 531     case ARG_SYNC:
 532       osssink->sync = g_value_get_boolean (value);
 533       g_object_notify (G_OBJECT (osssink), "sync");
 534       break;
 535     case ARG_CHUNK_SIZE:
 536       osssink->chunk_size = g_value_get_uint (value);
 537       break;
 538     default:
 539       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 540       break;
 541   }
 542 }
 543
 544 static void
 545 gst_osssink_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
 546 {
 547   GstOssSink *osssink;
 548
 549   osssink = GST_OSSSINK (object);
 550
 551   switch (prop_id) {
 552     case ARG_MUTE:
 553       g_value_set_boolean (value, osssink->mute);
 554       break;
 555     case ARG_FRAGMENT:
 556       g_value_set_int (value, GST_OSSELEMENT (osssink)->fragment);
 557       break;
 558     case ARG_BUFFER_SIZE:
 559       g_value_set_uint (value, osssink->bufsize);
 560       break;
 561     case ARG_SYNC:
 562       g_value_set_boolean (value, osssink->sync);
 563       break;
 564     case ARG_CHUNK_SIZE:
 565       g_value_set_uint (value, osssink->chunk_size);
 566       break;
 567     default:
 568       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 569       break;
 570   }
 571 }
 572
 573 static GstElementStateReturn
 574 gst_osssink_change_state (GstElement *element)
 575 {
 576   GstOssSink *osssink;
 577
 578   osssink = GST_OSSSINK (element);
 579
 580   switch (GST_STATE_TRANSITION (element)) {
 581     case GST_STATE_READY_TO_PAUSED:
 582       break;
 583     case GST_STATE_PAUSED_TO_PLAYING:
 584       osssink->resync = TRUE;
 585       break;
 586     case GST_STATE_PLAYING_TO_PAUSED:
 587       if (GST_FLAG_IS_SET (element, GST_OSSSINK_OPEN))
 588         ioctl (GST_OSSELEMENT (osssink)->fd, SNDCTL_DSP_RESET, 0);
 589       gst_audio_clock_set_active (GST_AUDIO_CLOCK (osssink->provided_clock), FALSE);
 590       osssink->resync = TRUE;
 591       break;
 592     case GST_STATE_PAUSED_TO_READY:
 593       if (GST_FLAG_IS_SET (element, GST_OSSSINK_OPEN))
 594         ioctl (GST_OSSELEMENT (osssink)->fd, SNDCTL_DSP_RESET, 0);
 595       gst_osselement_reset (GST_OSSELEMENT (osssink));
 596       break;
 597     default:
 598       break;
 599   }
 600
 601   if (GST_ELEMENT_CLASS (parent_class)->change_state)
 602     return GST_ELEMENT_CLASS (parent_class)->change_state (element);
 603
 604   return GST_STATE_SUCCESS;
 605 }