sys/oss/gstosssrc.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   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 #ifdef HAVE_CONFIG_H
  24 #include "config.h"
  25 #endif
  26 #include <sys/types.h>
  27 #include <sys/stat.h>
  28 #include <fcntl.h>
  29 #include <sys/soundcard.h>
  30 #include <sys/ioctl.h>
  31 #include <errno.h>
  32 #include <unistd.h>
  33 #include <string.h>
  34
  35 #include <gstosssrc.h>
  36 #include <gstosselement.h>
  37 #include <gst/audio/audioclock.h>
  38
  39 /* elementfactory information */
  40 static GstElementDetails gst_osssrc_details =
  41 GST_ELEMENT_DETAILS ("Audio Source (OSS)",
  42     "Source/Audio",
  43     "Read from the sound card",
  44     "Erik Walthinsen <omega@cse.ogi.edu>");
  45
  46
  47 /* OssSrc signals and args */
  48 enum
  49 {
  50   /* FILL ME */
  51   LAST_SIGNAL
  52 };
  53
  54 enum
  55 {
  56   ARG_0,
  57   ARG_BUFFERSIZE,
  58   ARG_FRAGMENT,
  59 };
  60
  61 static GstStaticPadTemplate osssrc_src_factory = GST_STATIC_PAD_TEMPLATE ("src",
  62     GST_PAD_SRC,
  63     GST_PAD_ALWAYS,
  64     GST_STATIC_CAPS ("audio/x-raw-int, "
  65         "endianness = (int) BYTE_ORDER, "
  66         "signed = (boolean) { TRUE, FALSE }, "
  67         "width = (int) { 8, 16 }, "
  68         "depth = (int) { 8, 16 }, "
  69         "rate = (int) [ 1000, 48000 ], " "channels = (int) [ 1, 2 ]")
  70     );
  71
  72 static void gst_osssrc_base_init (gpointer g_class);
  73 static void gst_osssrc_class_init (GstOssSrcClass * klass);
  74 static void gst_osssrc_init (GstOssSrc * osssrc);
  75 static void gst_osssrc_dispose (GObject * object);
  76
  77 static GstPadLinkReturn gst_osssrc_srcconnect (GstPad * pad,
  78     const GstCaps * caps);
  79 static const GstFormat *gst_osssrc_get_formats (GstPad * pad);
  80 static gboolean gst_osssrc_convert (GstPad * pad,
  81     GstFormat src_format, gint64 src_value,
  82     GstFormat * dest_format, gint64 * dest_value);
  83
  84 static void gst_osssrc_set_property (GObject * object, guint prop_id,
  85     const GValue * value, GParamSpec * pspec);
  86 static void gst_osssrc_get_property (GObject * object, guint prop_id,
  87     GValue * value, GParamSpec * pspec);
  88 static GstElementStateReturn gst_osssrc_change_state (GstElement * element);
  89
  90 static void gst_osssrc_set_clock (GstElement * element, GstClock * clock);
  91 static GstClock *gst_osssrc_get_clock (GstElement * element);
  92 static GstClockTime gst_osssrc_get_time (GstClock * clock, gpointer data);
  93
  94 static const GstEventMask *gst_osssrc_get_event_masks (GstPad * pad);
  95 static gboolean gst_osssrc_src_event (GstPad * pad, GstEvent * event);
  96 static gboolean gst_osssrc_send_event (GstElement * element, GstEvent * event);
  97 static const GstQueryType *gst_osssrc_get_query_types (GstPad * pad);
  98 static gboolean gst_osssrc_src_query (GstPad * pad, GstQueryType type,
  99     GstFormat * format, gint64 * value);
 100
 101 static GstData *gst_osssrc_get (GstPad * pad);
 102
 103 static GstElementClass *parent_class = NULL;
 104
 105 /*static guint gst_osssrc_signals[LAST_SIGNAL] = { 0 }; */
 106
 107 GType
 108 gst_osssrc_get_type (void)
 109 {
 110   static GType osssrc_type = 0;
 111
 112   if (!osssrc_type) {
 113     static const GTypeInfo osssrc_info = {
 114       sizeof (GstOssSrcClass),
 115       gst_osssrc_base_init,
 116       NULL,
 117       (GClassInitFunc) gst_osssrc_class_init,
 118       NULL,
 119       NULL,
 120       sizeof (GstOssSrc),
 121       0,
 122       (GInstanceInitFunc) gst_osssrc_init,
 123     };
 124     osssrc_type =
 125         g_type_register_static (GST_TYPE_OSSELEMENT, "GstOssSrc", &osssrc_info,
 126         0);
 127   }
 128   return osssrc_type;
 129 }
 130
 131 static void
 132 gst_osssrc_base_init (gpointer g_class)
 133 {
 134   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
 135
 136   gst_element_class_set_details (element_class, &gst_osssrc_details);
 137   gst_element_class_add_pad_template (element_class,
 138       gst_static_pad_template_get (&osssrc_src_factory));
 139 }
 140 static void
 141 gst_osssrc_class_init (GstOssSrcClass * klass)
 142 {
 143   GObjectClass *gobject_class;
 144   GstElementClass *gstelement_class;
 145
 146   gobject_class = (GObjectClass *) klass;
 147   gstelement_class = (GstElementClass *) klass;
 148
 149   parent_class = g_type_class_ref (GST_TYPE_OSSELEMENT);
 150
 151   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_BUFFERSIZE,
 152       g_param_spec_ulong ("buffersize", "Buffer Size",
 153           "The size of the buffers with samples", 0, G_MAXULONG, 0,
 154           G_PARAM_READWRITE));
 155   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_FRAGMENT,
 156       g_param_spec_int ("fragment", "Fragment",
 157           "The fragment as 0xMMMMSSSS (MMMM = total fragments, 2^SSSS = fragment size)",
 158           0, G_MAXINT, 6, G_PARAM_READWRITE));
 159
 160   gobject_class->set_property = gst_osssrc_set_property;
 161   gobject_class->get_property = gst_osssrc_get_property;
 162   gobject_class->dispose = gst_osssrc_dispose;
 163
 164   gstelement_class->change_state = gst_osssrc_change_state;
 165   gstelement_class->send_event = gst_osssrc_send_event;
 166
 167   gstelement_class->set_clock = gst_osssrc_set_clock;
 168   gstelement_class->get_clock = gst_osssrc_get_clock;
 169 }
 170
 171 static void
 172 gst_osssrc_init (GstOssSrc * osssrc)
 173 {
 174   osssrc->srcpad =
 175       gst_pad_new_from_template (gst_static_pad_template_get
 176       (&osssrc_src_factory), "src");
 177   gst_pad_set_get_function (osssrc->srcpad, gst_osssrc_get);
 178   gst_pad_set_link_function (osssrc->srcpad, gst_osssrc_srcconnect);
 179   gst_pad_set_convert_function (osssrc->srcpad, gst_osssrc_convert);
 180   gst_pad_set_formats_function (osssrc->srcpad, gst_osssrc_get_formats);
 181   gst_pad_set_event_function (osssrc->srcpad, gst_osssrc_src_event);
 182   gst_pad_set_event_mask_function (osssrc->srcpad, gst_osssrc_get_event_masks);
 183   gst_pad_set_query_function (osssrc->srcpad, gst_osssrc_src_query);
 184   gst_pad_set_query_type_function (osssrc->srcpad, gst_osssrc_get_query_types);
 185
 186
 187   gst_element_add_pad (GST_ELEMENT (osssrc), osssrc->srcpad);
 188
 189   osssrc->buffersize = 4096;
 190   osssrc->curoffset = 0;
 191
 192   osssrc->provided_clock =
 193       gst_audio_clock_new ("ossclock", gst_osssrc_get_time, osssrc);
 194   gst_object_set_parent (GST_OBJECT (osssrc->provided_clock),
 195       GST_OBJECT (osssrc));
 196
 197   osssrc->clock = NULL;
 198 }
 199
 200 static void
 201 gst_osssrc_dispose (GObject * object)
 202 {
 203   GstOssSrc *osssrc = (GstOssSrc *) object;
 204
 205   gst_object_unparent (GST_OBJECT (osssrc->provided_clock));
 206
 207   G_OBJECT_CLASS (parent_class)->dispose (object);
 208 }
 209
 210 static GstPadLinkReturn
 211 gst_osssrc_srcconnect (GstPad * pad, const GstCaps * caps)
 212 {
 213   GstOssSrc *src;
 214
 215   src = GST_OSSSRC (gst_pad_get_parent (pad));
 216
 217   if (!gst_osselement_parse_caps (GST_OSSELEMENT (src), caps))
 218     return GST_PAD_LINK_REFUSED;
 219
 220   if (!gst_osselement_sync_parms (GST_OSSELEMENT (src)))
 221     return GST_PAD_LINK_REFUSED;
 222
 223   return GST_PAD_LINK_OK;
 224 }
 225
 226 static gboolean
 227 gst_osssrc_negotiate (GstPad * pad)
 228 {
 229   GstOssSrc *src;
 230   GstCaps *allowed;
 231
 232   src = GST_OSSSRC (gst_pad_get_parent (pad));
 233
 234   allowed = gst_pad_get_allowed_caps (pad);
 235
 236   if (!gst_osselement_merge_fixed_caps (GST_OSSELEMENT (src), allowed))
 237     return FALSE;
 238
 239   if (!gst_osselement_sync_parms (GST_OSSELEMENT (src)))
 240     return FALSE;
 241
 242   /* set caps on src pad */
 243   if (gst_pad_try_set_caps (src->srcpad,
 244           gst_caps_new_simple ("audio/x-raw-int",
 245               "endianness", G_TYPE_INT, GST_OSSELEMENT (src)->endianness,
 246               "signed", G_TYPE_BOOLEAN, GST_OSSELEMENT (src)->sign,
 247               "width", G_TYPE_INT, GST_OSSELEMENT (src)->width,
 248               "depth", G_TYPE_INT, GST_OSSELEMENT (src)->depth,
 249               "rate", G_TYPE_INT, GST_OSSELEMENT (src)->rate,
 250               "channels", G_TYPE_INT, GST_OSSELEMENT (src)->channels,
 251               NULL)) <= 0) {
 252     return FALSE;
 253   }
 254   return TRUE;
 255 }
 256
 257 static GstClockTime
 258 gst_osssrc_get_time (GstClock * clock, gpointer data)
 259 {
 260   GstOssSrc *osssrc = GST_OSSSRC (data);
 261   audio_buf_info info;
 262
 263   if (!GST_OSSELEMENT (osssrc)->bps)
 264     return 0;
 265
 266   if (ioctl (GST_OSSELEMENT (osssrc)->fd, SNDCTL_DSP_GETISPACE, &info) < 0)
 267     return 0;
 268
 269   return (osssrc->curoffset +
 270       info.bytes) * GST_SECOND / GST_OSSELEMENT (osssrc)->bps;
 271 }
 272
 273 static GstClock *
 274 gst_osssrc_get_clock (GstElement * element)
 275 {
 276   GstOssSrc *osssrc;
 277
 278   osssrc = GST_OSSSRC (element);
 279
 280   return GST_CLOCK (osssrc->provided_clock);
 281 }
 282
 283 static void
 284 gst_osssrc_set_clock (GstElement * element, GstClock * clock)
 285 {
 286   GstOssSrc *osssrc;
 287
 288   osssrc = GST_OSSSRC (element);
 289
 290   osssrc->clock = clock;
 291 }
 292
 293 static GstData *
 294 gst_osssrc_get (GstPad * pad)
 295 {
 296   GstOssSrc *src;
 297   GstBuffer *buf;
 298   glong readbytes;
 299
 300   src = GST_OSSSRC (gst_pad_get_parent (pad));
 301
 302   GST_DEBUG ("attempting to read something from the soundcard");
 303
 304   if (src->need_eos) {
 305     src->need_eos = FALSE;
 306     return GST_DATA (gst_event_new (GST_EVENT_EOS));
 307   }
 308
 309   buf = gst_buffer_new_and_alloc (src->buffersize);
 310
 311   if (!GST_PAD_CAPS (pad)) {
 312     /* nothing was negotiated, we can decide on a format */
 313     if (!gst_osssrc_negotiate (pad)) {
 314       gst_buffer_unref (buf);
 315       GST_ELEMENT_ERROR (src, CORE, NEGOTIATION, (NULL), (NULL));
 316       return GST_DATA (gst_event_new (GST_EVENT_INTERRUPT));
 317     }
 318   }
 319   if (GST_OSSELEMENT (src)->bps == 0) {
 320     gst_buffer_unref (buf);
 321     GST_ELEMENT_ERROR (src, CORE, NEGOTIATION, (NULL),
 322         ("format wasn't negotiated before chain function"));
 323     return GST_DATA (gst_event_new (GST_EVENT_INTERRUPT));
 324   }
 325
 326   readbytes = read (GST_OSSELEMENT (src)->fd, GST_BUFFER_DATA (buf),
 327       src->buffersize);
 328   if (readbytes < 0) {
 329     gst_buffer_unref (buf);
 330     GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL), GST_ERROR_SYSTEM);
 331     return GST_DATA (gst_event_new (GST_EVENT_INTERRUPT));
 332   }
 333
 334   if (readbytes == 0) {
 335     gst_buffer_unref (buf);
 336     gst_element_set_eos (GST_ELEMENT (src));
 337     return GST_DATA (gst_event_new (GST_EVENT_INTERRUPT));
 338   }
 339
 340   GST_BUFFER_SIZE (buf) = readbytes;
 341   GST_BUFFER_OFFSET (buf) = src->curoffset;
 342
 343   /* FIXME: we are falsely assuming that we are the master clock here */
 344   GST_BUFFER_TIMESTAMP (buf) =
 345       src->curoffset * GST_SECOND / GST_OSSELEMENT (src)->bps;
 346   GST_BUFFER_DURATION (buf) =
 347       (GST_SECOND * GST_BUFFER_SIZE (buf)) / (GST_OSSELEMENT (src)->bps *
 348       GST_OSSELEMENT (src)->rate);
 349
 350   src->curoffset += readbytes;
 351
 352   GST_DEBUG ("pushed buffer from soundcard of %ld bytes, timestamp %"
 353       G_GINT64_FORMAT, readbytes, GST_BUFFER_TIMESTAMP (buf));
 354
 355   return GST_DATA (buf);
 356 }
 357
 358 static void
 359 gst_osssrc_set_property (GObject * object, guint prop_id, const GValue * value,
 360     GParamSpec * pspec)
 361 {
 362   GstOssSrc *src;
 363
 364   src = GST_OSSSRC (object);
 365
 366   switch (prop_id) {
 367     case ARG_BUFFERSIZE:
 368       src->buffersize = g_value_get_ulong (value);
 369       break;
 370     case ARG_FRAGMENT:
 371       GST_OSSELEMENT (src)->fragment = g_value_get_int (value);
 372       gst_osselement_sync_parms (GST_OSSELEMENT (src));
 373       break;
 374     default:
 375       break;
 376   }
 377 }
 378
 379 static void
 380 gst_osssrc_get_property (GObject * object, guint prop_id, GValue * value,
 381     GParamSpec * pspec)
 382 {
 383   GstOssSrc *src;
 384
 385   src = GST_OSSSRC (object);
 386
 387   switch (prop_id) {
 388     case ARG_BUFFERSIZE:
 389       g_value_set_ulong (value, src->buffersize);
 390       break;
 391     case ARG_FRAGMENT:
 392       g_value_set_int (value, GST_OSSELEMENT (src)->fragment);
 393       break;
 394     default:
 395       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 396       break;
 397   }
 398 }
 399
 400 static GstElementStateReturn
 401 gst_osssrc_change_state (GstElement * element)
 402 {
 403   GstOssSrc *osssrc = GST_OSSSRC (element);
 404
 405   GST_DEBUG ("osssrc: state change");
 406
 407   switch (GST_STATE_TRANSITION (element)) {
 408     case GST_STATE_READY_TO_PAUSED:
 409       osssrc->curoffset = 0;
 410       break;
 411     case GST_STATE_PAUSED_TO_PLAYING:
 412       gst_audio_clock_set_active (GST_AUDIO_CLOCK (osssrc->provided_clock),
 413           TRUE);
 414       break;
 415     case GST_STATE_PLAYING_TO_PAUSED:
 416       gst_audio_clock_set_active (GST_AUDIO_CLOCK (osssrc->provided_clock),
 417           FALSE);
 418       break;
 419     case GST_STATE_PAUSED_TO_READY:
 420       if (GST_FLAG_IS_SET (element, GST_OSSSRC_OPEN))
 421         ioctl (GST_OSSELEMENT (osssrc)->fd, SNDCTL_DSP_RESET, 0);
 422       break;
 423     default:
 424       break;
 425   }
 426
 427   if (GST_ELEMENT_CLASS (parent_class)->change_state)
 428     return GST_ELEMENT_CLASS (parent_class)->change_state (element);
 429
 430   return GST_STATE_SUCCESS;
 431 }
 432
 433 static const GstFormat *
 434 gst_osssrc_get_formats (GstPad * pad)
 435 {
 436   static const GstFormat formats[] = {
 437     GST_FORMAT_TIME,
 438     GST_FORMAT_DEFAULT,
 439     GST_FORMAT_BYTES,
 440     0
 441   };
 442   return formats;
 443 }
 444
 445 static gboolean
 446 gst_osssrc_convert (GstPad * pad, GstFormat src_format, gint64 src_value,
 447     GstFormat * dest_format, gint64 * dest_value)
 448 {
 449   GstOssSrc *osssrc;
 450
 451   osssrc = GST_OSSSRC (gst_pad_get_parent (pad));
 452
 453   return gst_osselement_convert (GST_OSSELEMENT (osssrc), src_format, src_value,
 454       dest_format, dest_value);
 455 }
 456
 457 static const GstEventMask *
 458 gst_osssrc_get_event_masks (GstPad * pad)
 459 {
 460   static const GstEventMask gst_osssrc_src_event_masks[] = {
 461     {GST_EVENT_EOS, 0},
 462     {GST_EVENT_SIZE, 0},
 463     {0,}
 464   };
 465   return gst_osssrc_src_event_masks;
 466 }
 467
 468 static gboolean
 469 gst_osssrc_src_event (GstPad * pad, GstEvent * event)
 470 {
 471   GstOssSrc *osssrc;
 472   gboolean retval = FALSE;
 473
 474   osssrc = GST_OSSSRC (gst_pad_get_parent (pad));
 475
 476   switch (GST_EVENT_TYPE (event)) {
 477     case GST_EVENT_EOS:
 478       osssrc->need_eos = TRUE;
 479       retval = TRUE;
 480       break;
 481     case GST_EVENT_SIZE:
 482     {
 483       GstFormat format;
 484       gint64 value;
 485
 486       format = GST_FORMAT_BYTES;
 487
 488       /* convert to bytes */
 489       if (gst_osselement_convert (GST_OSSELEMENT (osssrc),
 490               GST_EVENT_SIZE_FORMAT (event),
 491               GST_EVENT_SIZE_VALUE (event), &format, &value)) {
 492         osssrc->buffersize = GST_EVENT_SIZE_VALUE (event);
 493         g_object_notify (G_OBJECT (osssrc), "buffersize");
 494         retval = TRUE;
 495       }
 496     }
 497     default:
 498       break;
 499   }
 500   gst_event_unref (event);
 501   return retval;
 502 }
 503
 504 static gboolean
 505 gst_osssrc_send_event (GstElement * element, GstEvent * event)
 506 {
 507   GstOssSrc *osssrc = GST_OSSSRC (element);
 508
 509   return gst_osssrc_src_event (osssrc->srcpad, event);
 510 }
 511
 512 static const GstQueryType *
 513 gst_osssrc_get_query_types (GstPad * pad)
 514 {
 515   static const GstQueryType query_types[] = {
 516     GST_QUERY_POSITION,
 517     0,
 518   };
 519   return query_types;
 520 }
 521
 522 static gboolean
 523 gst_osssrc_src_query (GstPad * pad, GstQueryType type, GstFormat * format,
 524     gint64 * value)
 525 {
 526   gboolean res = FALSE;
 527   GstOssSrc *osssrc;
 528
 529   osssrc = GST_OSSSRC (gst_pad_get_parent (pad));
 530
 531   switch (type) {
 532     case GST_QUERY_POSITION:
 533       res = gst_osselement_convert (GST_OSSELEMENT (osssrc),
 534           GST_FORMAT_BYTES, osssrc->curoffset, format, value);
 535       break;
 536     default:
 537       break;
 538   }
 539   return res;
 540 }