2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wim.taymans@chello.be>
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.
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.
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.
24 #include <sys/types.h>
26 #include <sys/ioctl.h>
28 #include <sys/soundcard.h>
32 #include <gstosssink.h>
34 static GstElementDetails gst_osssink_details = {
37 "Output to a sound card via OSS",
39 "Erik Walthinsen <omega@cse.ogi.edu>, "
40 "Wim Taymans <wim.taymans@chello.be>",
44 static void gst_osssink_class_init (GstOssSinkClass *klass);
45 static void gst_osssink_init (GstOssSink *osssink);
46 static void gst_osssink_finalize (GObject *object);
48 static gboolean gst_osssink_open_audio (GstOssSink *sink);
49 static void gst_osssink_close_audio (GstOssSink *sink);
50 static gboolean gst_osssink_sync_parms (GstOssSink *osssink);
51 static GstElementStateReturn gst_osssink_change_state (GstElement *element);
52 static void gst_osssink_set_clock (GstElement *element, GstClock *clock);
53 static GstClock* gst_osssink_get_clock (GstElement *element);
55 static GstPadConnectReturn gst_osssink_sinkconnect (GstPad *pad, GstCaps *caps);
57 static void gst_osssink_set_property (GObject *object, guint prop_id, const GValue *value,
59 static void gst_osssink_get_property (GObject *object, guint prop_id, GValue *value,
62 static void gst_osssink_chain (GstPad *pad,GstBuffer *buf);
64 /* OssSink signals and args */
82 GST_PAD_TEMPLATE_FACTORY (osssink_sink_factory,
89 "format", GST_PROPS_STRING ("int"), /* hack */
90 "law", GST_PROPS_INT (0),
91 "endianness", GST_PROPS_INT (G_BYTE_ORDER),
92 "signed", GST_PROPS_LIST (
93 GST_PROPS_BOOLEAN (FALSE),
94 GST_PROPS_BOOLEAN (TRUE)
96 "width", GST_PROPS_LIST (
100 "depth", GST_PROPS_LIST (
104 "rate", GST_PROPS_INT_RANGE (1000, 48000),
105 "channels", GST_PROPS_INT_RANGE (1, 2)
109 #define GST_TYPE_OSSSINK_CHANNELS (gst_osssink_channels_get_type())
111 gst_osssink_channels_get_type(void) {
112 static GType osssink_channels_type = 0;
113 static GEnumValue osssink_channels[] = {
119 if (!osssink_channels_type) {
120 osssink_channels_type = g_enum_register_static("GstAudiosinkChannels", osssink_channels);
122 return osssink_channels_type;
126 static GstElementClass *parent_class = NULL;
127 static guint gst_osssink_signals[LAST_SIGNAL] = { 0 };
130 gst_osssink_get_type (void)
132 static GType osssink_type = 0;
135 static const GTypeInfo osssink_info = {
136 sizeof(GstOssSinkClass),
139 (GClassInitFunc)gst_osssink_class_init,
144 (GInstanceInitFunc)gst_osssink_init,
146 osssink_type = g_type_register_static (GST_TYPE_ELEMENT, "GstOssSink", &osssink_info, 0);
152 static GstBufferPool*
153 gst_osssink_get_bufferpool (GstPad *pad)
157 oss = GST_OSSSINK (gst_pad_get_parent(pad));
159 return oss->sinkpool;
163 gst_osssink_finalize (GObject *object)
165 GstOssSink *osssink = (GstOssSink *) object;
167 g_free (osssink->device);
169 G_OBJECT_CLASS (parent_class)->finalize (object);
173 gst_osssink_class_init (GstOssSinkClass *klass)
175 GObjectClass *gobject_class;
176 GstElementClass *gstelement_class;
178 gobject_class = (GObjectClass*)klass;
179 gstelement_class = (GstElementClass*)klass;
181 parent_class = g_type_class_ref(GST_TYPE_ELEMENT);
183 g_object_class_install_property(G_OBJECT_CLASS(klass), ARG_DEVICE,
184 g_param_spec_string("device","device","device",
185 "/dev/dsp",G_PARAM_READWRITE)); /* CHECKME! */
186 g_object_class_install_property(G_OBJECT_CLASS(klass), ARG_MUTE,
187 g_param_spec_boolean("mute","mute","mute",
188 TRUE,G_PARAM_READWRITE));
190 /* it would be nice to show format in symbolic form, oh well */
191 g_object_class_install_property(G_OBJECT_CLASS(klass), ARG_FORMAT,
192 g_param_spec_int ("format","format","format",
193 0, G_MAXINT, AFMT_S16_LE, G_PARAM_READWRITE));
195 g_object_class_install_property(G_OBJECT_CLASS(klass), ARG_CHANNELS,
196 g_param_spec_enum("channels","channels","channels",
197 GST_TYPE_OSSSINK_CHANNELS,2,G_PARAM_READWRITE));
198 g_object_class_install_property(G_OBJECT_CLASS(klass), ARG_FREQUENCY,
199 g_param_spec_int("frequency","frequency","frequency",
200 0,G_MAXINT,44100,G_PARAM_READWRITE));
201 g_object_class_install_property(G_OBJECT_CLASS(klass), ARG_FRAGMENT,
202 g_param_spec_int("fragment","fragment","fragment",
203 0,G_MAXINT,6,G_PARAM_READWRITE));
204 g_object_class_install_property(G_OBJECT_CLASS(klass), ARG_BUFFER_SIZE,
205 g_param_spec_int("buffer_size","buffer_size","buffer_size",
206 0,G_MAXINT,4096,G_PARAM_READWRITE));
208 gst_osssink_signals[SIGNAL_HANDOFF] =
209 g_signal_new("handoff",G_TYPE_FROM_CLASS(klass), G_SIGNAL_RUN_LAST,
210 G_STRUCT_OFFSET(GstOssSinkClass,handoff), NULL, NULL,
211 g_cclosure_marshal_VOID__VOID,G_TYPE_NONE,0);
213 gobject_class->set_property = gst_osssink_set_property;
214 gobject_class->get_property = gst_osssink_get_property;
215 gobject_class->finalize = gst_osssink_finalize;
217 gstelement_class->change_state = GST_DEBUG_FUNCPTR (gst_osssink_change_state);
221 gst_osssink_get_time (GstClock *clock, gpointer data)
223 GstOssSink *osssink = GST_OSSSINK (data);
230 ioctl (osssink->fd, SNDCTL_DSP_GETODELAY, &delay);
232 /* sometimes delay is bigger than the number of bytes sent to the device, which screws
233 * up this calculation, we assume that everything is still in the device then */
234 if (delay > osssink->handled) {
235 res = osssink->offset;
238 res = osssink->offset + (osssink->handled - delay) * 1000000LL / osssink->bps;
242 g_print ("from osssink: %lld %lld %d %lld %d\n", res, osssink->offset, delay, osssink->handled,
250 gst_osssink_init (GstOssSink *osssink)
252 osssink->sinkpad = gst_pad_new_from_template (
253 GST_PAD_TEMPLATE_GET (osssink_sink_factory), "sink");
254 gst_element_add_pad (GST_ELEMENT (osssink), osssink->sinkpad);
255 gst_pad_set_connect_function (osssink->sinkpad, gst_osssink_sinkconnect);
256 gst_pad_set_bufferpool_function (osssink->sinkpad, gst_osssink_get_bufferpool);
258 gst_pad_set_chain_function (osssink->sinkpad, gst_osssink_chain);
260 osssink->device = g_strdup ("/dev/dsp");
262 osssink->channels = 1;
263 osssink->frequency = 11025;
264 osssink->fragment = 6;
265 /* AFMT_*_BE not available on all OSS includes (e.g. FBSD) */
266 #ifdef WORDS_BIGENDIAN
267 osssink->format = AFMT_S16_BE;
269 osssink->format = AFMT_S16_LE;
270 #endif /* WORDS_BIGENDIAN */
271 /* gst_clock_register (osssink->clock, GST_OBJECT (osssink)); */
272 osssink->bufsize = 4096;
274 osssink->offset = 0LL;
275 osssink->handled = 0LL;
276 /* 6 buffers per chunk by default */
277 osssink->sinkpool = gst_buffer_pool_get_default (osssink->bufsize, 6);
279 osssink->provided_clock = NULL;
280 osssink->provided_clock = GST_CLOCK (gst_oss_clock_new ("ossclock", gst_osssink_get_time, osssink));
282 GST_ELEMENT (osssink)->setclockfunc = gst_osssink_set_clock;
283 GST_ELEMENT (osssink)->getclockfunc = gst_osssink_get_clock;
285 GST_FLAG_SET (osssink, GST_ELEMENT_THREAD_SUGGESTED);
286 GST_FLAG_SET (osssink, GST_ELEMENT_EVENT_AWARE);
289 static GstPadConnectReturn
290 gst_osssink_sinkconnect (GstPad *pad, GstCaps *caps)
292 gint law, endianness, width, depth;
295 GstOssSink *osssink = GST_OSSSINK (gst_pad_get_parent (pad));
297 if (!GST_CAPS_IS_FIXED (caps))
298 return GST_PAD_CONNECT_DELAYED;
300 gst_caps_get_int (caps, "width", &width);
301 gst_caps_get_int (caps, "depth", &depth);
304 return GST_PAD_CONNECT_REFUSED;
306 /* laws 1 and 2 are 1 bps anyway */
309 gst_caps_get_int (caps, "law", &law);
310 gst_caps_get_int (caps, "endianness", &endianness);
311 gst_caps_get_boolean (caps, "signed", &sign);
316 if (endianness == G_LITTLE_ENDIAN)
317 format = AFMT_S16_LE;
318 else if (endianness == G_BIG_ENDIAN)
319 format = AFMT_S16_BE;
322 if (endianness == G_LITTLE_ENDIAN)
323 format = AFMT_U16_LE;
324 else if (endianness == G_BIG_ENDIAN)
325 format = AFMT_U16_BE;
329 else if (width == 8) {
338 } else if (law == 1) {
339 format = AFMT_MU_LAW;
340 } else if (law == 2) {
343 g_critical ("unknown law");
344 return GST_PAD_CONNECT_REFUSED;
348 return GST_PAD_CONNECT_REFUSED;
350 osssink->format = format;
351 gst_caps_get_int (caps, "channels", &osssink->channels);
352 gst_caps_get_int (caps, "rate", &osssink->frequency);
354 osssink->bps *= osssink->channels;
355 osssink->bps *= osssink->frequency;
357 if (!gst_osssink_sync_parms (osssink)) {
358 return GST_PAD_CONNECT_REFUSED;
361 return GST_PAD_CONNECT_OK;
365 gst_osssink_sync_parms (GstOssSink *osssink)
367 audio_buf_info ospace;
370 gint target_channels;
371 gint target_frequency;
374 g_return_val_if_fail (osssink != NULL, FALSE);
375 g_return_val_if_fail (GST_IS_OSSSINK (osssink), FALSE);
377 if (osssink->fd == -1)
380 if (osssink->fragment >> 16)
381 frag = osssink->fragment;
383 frag = 0x7FFF0000 | osssink->fragment;
385 GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: trying to set sound card to %dHz %d bit %s (%08x fragment)",
386 osssink->frequency, osssink->format,
387 (osssink->channels == 2) ? "stereo" : "mono",frag);
389 ioctl (osssink->fd, SNDCTL_DSP_SETFRAGMENT, &frag);
391 ioctl (osssink->fd, SNDCTL_DSP_RESET, 0);
393 target_format = osssink->format;
394 target_channels = osssink->channels;
395 target_frequency = osssink->frequency;
397 ioctl (osssink->fd, SNDCTL_DSP_SETFMT, &osssink->format);
398 ioctl (osssink->fd, SNDCTL_DSP_CHANNELS, &osssink->channels);
399 ioctl (osssink->fd, SNDCTL_DSP_SPEED, &osssink->frequency);
401 ioctl (osssink->fd, SNDCTL_DSP_GETBLKSIZE, &osssink->fragment);
402 ioctl (osssink->fd, SNDCTL_DSP_GETOSPACE, &ospace);
404 GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: set sound card to %dHz %d bit %s (%d bytes buffer, %08x fragment)",
405 osssink->frequency, osssink->format,
406 (osssink->channels == 2) ? "stereo" : "mono", ospace.bytes, osssink->fragment);
408 object = G_OBJECT (osssink);
409 g_object_freeze_notify (object);
410 g_object_notify (object, "channels");
411 g_object_notify (object, "frequency");
412 g_object_notify (object, "fragment");
413 g_object_notify (object, "format");
414 g_object_thaw_notify (object);
416 osssink->fragment_time = (1000000 * osssink->fragment) / osssink->bps;
417 GST_INFO (GST_CAT_PLUGIN_INFO, "fragment time %u %llu\n", osssink->bps, osssink->fragment_time);
419 if (target_format != osssink->format ||
420 target_channels != osssink->channels ||
421 target_frequency != osssink->frequency)
423 g_warning ("could not configure oss with required parameters, enjoy the noise :)");
424 /* we could eventually return FALSE here, or just do some additional tests
425 * to see that the frequencies don't differ too much etc.. */
431 gst_osssink_get_clock (GstElement *element)
435 osssink = GST_OSSSINK (element);
437 return GST_CLOCK (osssink->provided_clock);
441 gst_osssink_set_clock (GstElement *element, GstClock *clock)
445 osssink = GST_OSSSINK (element);
447 osssink->clock = clock;
451 gst_osssink_chain (GstPad *pad, GstBuffer *buf)
454 GstClockTime buftime;
456 /* this has to be an audio buffer */
457 osssink = GST_OSSSINK (gst_pad_get_parent (pad));
459 if (GST_IS_EVENT (buf)) {
460 switch (GST_EVENT_TYPE (buf)) {
462 ioctl (osssink->fd, SNDCTL_DSP_SYNC);
463 gst_pad_event_default (pad, GST_EVENT (buf));
470 buftime = GST_BUFFER_TIMESTAMP (buf);
473 gst_buffer_unref (buf);
474 gst_element_error (GST_ELEMENT (osssink), "capsnego was never performed, unknown data type");
477 if (osssink->fd >= 0) {
478 if (!osssink->mute) {
479 guchar *data = GST_BUFFER_DATA (buf);
480 gint size = GST_BUFFER_SIZE (buf);
481 /* gint frag = osssink->fragment; <-- unused, for reason see above */
483 if (osssink->clock) {
484 /* FIXME, NEW_MEDIA/DISCONT?. Try to get our start point */
485 if (!osssink->have_offset && buftime != -1LL) {
486 GST_INFO (GST_CAT_PLUGIN_INFO,
487 "osssink: clock at offset: %lld, new offset %lld at time %lld\n",
488 osssink->offset, buftime, gst_clock_get_time (osssink->clock));
490 osssink->offset = buftime;
491 osssink->have_offset = TRUE;
492 osssink->handled = 0;
493 gst_element_clock_wait (GST_ELEMENT (osssink), osssink->clock, buftime);
497 /* this doesn't work on BE machines, apparently
499 gint tosend = MIN (size, frag);
500 write (osssink->fd, data, tosend);
503 osssink->handled += tosend;
505 write (osssink->fd, data, size);
506 osssink->handled += size;
508 /* no clock, try to be as fast as possible */
510 audio_buf_info ospace;
512 ioctl (osssink->fd, SNDCTL_DSP_GETOSPACE, &ospace);
514 if (ospace.bytes >= size) {
515 write (osssink->fd, data, size);
517 osssink->handled += size;
521 gst_buffer_unref (buf);
525 gst_osssink_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
529 /* it's not null if we got it, but it might not be ours */
530 g_return_if_fail (GST_IS_OSSSINK (object));
532 osssink = GST_OSSSINK (object);
536 /* disallow changing the device while it is opened
537 get_property("device") should return the right one */
538 if (!GST_FLAG_IS_SET (osssink, GST_OSSSINK_OPEN))
540 g_free (osssink->device);
541 osssink->device = g_strdup (g_value_get_string (value));
542 g_object_notify (object, "device");
546 osssink->mute = g_value_get_boolean (value);
547 g_object_notify (G_OBJECT (osssink), "mute");
550 osssink->format = g_value_get_int (value);
551 gst_osssink_sync_parms (osssink);
554 osssink->channels = g_value_get_enum (value);
555 gst_osssink_sync_parms (osssink);
558 osssink->frequency = g_value_get_int (value);
559 gst_osssink_sync_parms (osssink);
562 osssink->fragment = g_value_get_int (value);
563 gst_osssink_sync_parms (osssink);
565 case ARG_BUFFER_SIZE:
566 if (osssink->bufsize == g_value_get_int (value)) break;
567 osssink->bufsize = g_value_get_int (value);
568 osssink->sinkpool = gst_buffer_pool_get_default (osssink->bufsize, 6);
569 g_object_notify (object, "buffer_size");
577 gst_osssink_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
581 /* it's not null if we got it, but it might not be ours */
582 g_return_if_fail (GST_IS_OSSSINK (object));
584 osssink = GST_OSSSINK (object);
588 g_value_set_string (value, osssink->device);
591 g_value_set_boolean (value, osssink->mute);
594 g_value_set_int (value, osssink->format);
597 g_value_set_enum (value, osssink->channels);
600 g_value_set_int (value, osssink->frequency);
603 g_value_set_int (value, osssink->fragment);
605 case ARG_BUFFER_SIZE:
606 g_value_set_int (value, osssink->bufsize);
614 gst_osssink_open_audio (GstOssSink *sink)
617 g_return_val_if_fail (sink->fd == -1, FALSE);
619 GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: attempting to open sound device");
621 /* first try to open the sound card */
622 sink->fd = open(sink->device, O_WRONLY | O_NONBLOCK);
623 if (errno == EBUSY) {
624 g_warning ("osssink: unable to open the sound device (in use ?)\n");
628 /* re-open the sound device in blocking mode */
630 sink->fd = open(sink->device, O_WRONLY);
632 /* if we have it, set the default parameters and go have fun */
635 ioctl(sink->fd, SNDCTL_DSP_GETCAPS, &caps);
637 GST_INFO(GST_CAT_PLUGIN_INFO, "osssink: Capabilities %08x", caps);
639 if (caps & DSP_CAP_DUPLEX) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: Full duplex");
640 if (caps & DSP_CAP_REALTIME) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: Realtime");
641 if (caps & DSP_CAP_BATCH) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: Batch");
642 if (caps & DSP_CAP_COPROC) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: Has coprocessor");
643 if (caps & DSP_CAP_TRIGGER) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: Trigger");
644 if (caps & DSP_CAP_MMAP) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: Direct access");
647 if (caps & DSP_CAP_MULTI) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: Multiple open");
648 #endif /* DSP_CAP_MULTI */
651 if (caps & DSP_CAP_BIND) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: Channel binding");
652 #endif /* DSP_CAP_BIND */
654 ioctl(sink->fd, SNDCTL_DSP_GETFMTS, &caps);
656 GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: Formats %08x", caps);
657 if (caps & AFMT_MU_LAW) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: MU_LAW");
658 if (caps & AFMT_A_LAW) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: A_LAW");
659 if (caps & AFMT_IMA_ADPCM) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: IMA_ADPCM");
660 if (caps & AFMT_U8) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: U8");
661 if (caps & AFMT_S16_LE) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: S16_LE");
662 if (caps & AFMT_S16_BE) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: S16_BE");
663 if (caps & AFMT_S8) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: S8");
664 if (caps & AFMT_U16_LE) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: U16_LE");
665 if (caps & AFMT_U16_BE) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: U16_BE");
666 if (caps & AFMT_MPEG) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: MPEG");
668 if (caps & AFMT_AC3) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: AC3");
671 GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: opened audio (%s) with fd=%d", sink->device, sink->fd);
672 GST_FLAG_SET (sink, GST_OSSSINK_OPEN);
681 gst_osssink_close_audio (GstOssSink *sink)
683 if (sink->fd < 0) return;
688 GST_FLAG_UNSET (sink, GST_OSSSINK_OPEN);
690 GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: closed sound device");
693 static GstElementStateReturn
694 gst_osssink_change_state (GstElement *element)
698 g_return_val_if_fail (GST_IS_OSSSINK (element), FALSE);
700 osssink = GST_OSSSINK (element);
702 switch (GST_STATE_TRANSITION (element)) {
703 case GST_STATE_NULL_TO_READY:
704 if (!GST_FLAG_IS_SET (element, GST_OSSSINK_OPEN)) {
705 if (!gst_osssink_open_audio (osssink)) {
706 return GST_STATE_FAILURE;
710 case GST_STATE_READY_TO_PAUSED:
711 osssink->offset = 0LL;
712 osssink->have_offset = FALSE;
713 osssink->handled = 0LL;
715 case GST_STATE_PAUSED_TO_PLAYING:
717 case GST_STATE_PLAYING_TO_PAUSED:
719 if (GST_FLAG_IS_SET (element, GST_OSSSINK_OPEN))
720 ioctl (osssink->fd, SNDCTL_DSP_RESET, 0);
723 case GST_STATE_PAUSED_TO_READY:
724 if (GST_FLAG_IS_SET (element, GST_OSSSINK_OPEN))
725 ioctl (osssink->fd, SNDCTL_DSP_RESET, 0);
727 case GST_STATE_READY_TO_NULL:
728 if (GST_FLAG_IS_SET (element, GST_OSSSINK_OPEN))
729 gst_osssink_close_audio (osssink);
733 if (GST_ELEMENT_CLASS (parent_class)->change_state)
734 return GST_ELEMENT_CLASS (parent_class)->change_state (element);
736 return GST_STATE_SUCCESS;
740 gst_osssink_factory_init (GstPlugin *plugin)
742 GstElementFactory *factory;
744 factory = gst_element_factory_new ("osssink", GST_TYPE_OSSSINK, &gst_osssink_details);
745 g_return_val_if_fail (factory != NULL, FALSE);
747 gst_element_factory_add_pad_template (factory, GST_PAD_TEMPLATE_GET (osssink_sink_factory));
749 gst_plugin_add_feature (plugin, GST_PLUGIN_FEATURE (factory));