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 /* if we have a start time, use offset */
231 if (osssink->offset >= 0LL) {
232 offset = osssink->offset;
235 ioctl (osssink->fd, SNDCTL_DSP_GETODELAY, &delay);
237 return offset + (osssink->handled - delay) * 1000000LL / osssink->bps;
241 gst_osssink_init (GstOssSink *osssink)
243 osssink->sinkpad = gst_pad_new_from_template (
244 GST_PAD_TEMPLATE_GET (osssink_sink_factory), "sink");
245 gst_element_add_pad (GST_ELEMENT (osssink), osssink->sinkpad);
246 gst_pad_set_connect_function (osssink->sinkpad, gst_osssink_sinkconnect);
247 gst_pad_set_bufferpool_function (osssink->sinkpad, gst_osssink_get_bufferpool);
249 gst_pad_set_chain_function (osssink->sinkpad, gst_osssink_chain);
251 osssink->device = g_strdup ("/dev/dsp");
253 osssink->channels = 1;
254 osssink->frequency = 11025;
255 osssink->fragment = 6;
256 /* AFMT_*_BE not available on all OSS includes (e.g. FBSD) */
257 #ifdef WORDS_BIGENDIAN
258 osssink->format = AFMT_S16_BE;
260 osssink->format = AFMT_S16_LE;
261 #endif /* WORDS_BIGENDIAN */
262 /* gst_clock_register (osssink->clock, GST_OBJECT (osssink)); */
263 osssink->bufsize = 4096;
264 osssink->offset = -1LL;
265 osssink->handled = 0LL;
266 /* 6 buffers per chunk by default */
267 osssink->sinkpool = gst_buffer_pool_get_default (osssink->bufsize, 6);
269 osssink->provided_clock = NULL;
270 osssink->provided_clock = GST_CLOCK (gst_oss_clock_new ("ossclock", gst_osssink_get_time, osssink));
272 GST_ELEMENT (osssink)->setclockfunc = gst_osssink_set_clock;
273 GST_ELEMENT (osssink)->getclockfunc = gst_osssink_get_clock;
275 GST_FLAG_SET (osssink, GST_ELEMENT_THREAD_SUGGESTED);
276 GST_FLAG_SET (osssink, GST_ELEMENT_EVENT_AWARE);
279 static GstPadConnectReturn
280 gst_osssink_sinkconnect (GstPad *pad, GstCaps *caps)
282 gint law, endianness, width, depth;
285 GstOssSink *osssink = GST_OSSSINK (gst_pad_get_parent (pad));
287 if (!GST_CAPS_IS_FIXED (caps))
288 return GST_PAD_CONNECT_DELAYED;
290 gst_caps_get_int (caps, "width", &width);
291 gst_caps_get_int (caps, "depth", &depth);
294 return GST_PAD_CONNECT_REFUSED;
296 /* laws 1 and 2 are 1 bps anyway */
299 gst_caps_get_int (caps, "law", &law);
300 gst_caps_get_int (caps, "endianness", &endianness);
301 gst_caps_get_boolean (caps, "signed", &sign);
306 if (endianness == G_LITTLE_ENDIAN)
307 format = AFMT_S16_LE;
308 else if (endianness == G_BIG_ENDIAN)
309 format = AFMT_S16_BE;
312 if (endianness == G_LITTLE_ENDIAN)
313 format = AFMT_U16_LE;
314 else if (endianness == G_BIG_ENDIAN)
315 format = AFMT_U16_BE;
319 else if (width == 8) {
328 } else if (law == 1) {
329 format = AFMT_MU_LAW;
330 } else if (law == 2) {
333 g_critical ("unknown law");
334 return GST_PAD_CONNECT_REFUSED;
338 return GST_PAD_CONNECT_REFUSED;
340 osssink->format = format;
341 gst_caps_get_int (caps, "channels", &osssink->channels);
342 gst_caps_get_int (caps, "rate", &osssink->frequency);
344 osssink->bps *= osssink->channels;
345 osssink->bps *= osssink->frequency;
347 if (!gst_osssink_sync_parms (osssink)) {
348 return GST_PAD_CONNECT_REFUSED;
351 return GST_PAD_CONNECT_OK;
355 gst_osssink_sync_parms (GstOssSink *osssink)
357 audio_buf_info ospace;
360 gint target_channels;
361 gint target_frequency;
364 g_return_val_if_fail (osssink != NULL, FALSE);
365 g_return_val_if_fail (GST_IS_OSSSINK (osssink), FALSE);
367 if (osssink->fd == -1)
370 if (osssink->fragment >> 16)
371 frag = osssink->fragment;
373 frag = 0x7FFF0000 | osssink->fragment;
375 GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: trying to set sound card to %dHz %d bit %s (%08x fragment)",
376 osssink->frequency, osssink->format,
377 (osssink->channels == 2) ? "stereo" : "mono",frag);
379 ioctl (osssink->fd, SNDCTL_DSP_SETFRAGMENT, &frag);
381 ioctl (osssink->fd, SNDCTL_DSP_RESET, 0);
383 target_format = osssink->format;
384 target_channels = osssink->channels;
385 target_frequency = osssink->frequency;
387 ioctl (osssink->fd, SNDCTL_DSP_SETFMT, &osssink->format);
388 ioctl (osssink->fd, SNDCTL_DSP_CHANNELS, &osssink->channels);
389 ioctl (osssink->fd, SNDCTL_DSP_SPEED, &osssink->frequency);
391 ioctl (osssink->fd, SNDCTL_DSP_GETBLKSIZE, &osssink->fragment);
392 ioctl (osssink->fd, SNDCTL_DSP_GETOSPACE, &ospace);
394 GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: set sound card to %dHz %d bit %s (%d bytes buffer, %08x fragment)",
395 osssink->frequency, osssink->format,
396 (osssink->channels == 2) ? "stereo" : "mono", ospace.bytes, osssink->fragment);
398 object = G_OBJECT (osssink);
399 g_object_freeze_notify (object);
400 g_object_notify (object, "channels");
401 g_object_notify (object, "frequency");
402 g_object_notify (object, "fragment");
403 g_object_notify (object, "format");
404 g_object_thaw_notify (object);
406 osssink->fragment_time = (1000000 * osssink->fragment) / osssink->bps;
407 GST_INFO (GST_CAT_PLUGIN_INFO, "fragment time %u %llu\n", osssink->bps, osssink->fragment_time);
409 if (target_format != osssink->format ||
410 target_channels != osssink->channels ||
411 target_frequency != osssink->frequency)
413 g_warning ("could not configure oss with required parameters, enjoy the noise :)");
414 /* we could eventually return FALSE here, or just do some additional tests
415 * to see that the frequencies don't differ too much etc.. */
421 gst_osssink_get_clock (GstElement *element)
425 osssink = GST_OSSSINK (element);
427 return GST_CLOCK (osssink->provided_clock);
431 gst_osssink_set_clock (GstElement *element, GstClock *clock)
435 osssink = GST_OSSSINK (element);
437 osssink->clock = clock;
441 gst_osssink_chain (GstPad *pad, GstBuffer *buf)
444 GstClockTime buftime;
446 /* this has to be an audio buffer */
447 osssink = GST_OSSSINK (gst_pad_get_parent (pad));
449 if (GST_IS_EVENT (buf)) {
450 switch (GST_EVENT_TYPE (buf)) {
452 ioctl (osssink->fd, SNDCTL_DSP_SYNC);
453 gst_pad_event_default (pad, GST_EVENT (buf));
460 buftime = GST_BUFFER_TIMESTAMP (buf);
463 gst_buffer_unref (buf);
464 gst_element_error (GST_ELEMENT (osssink), "capsnego was never performed, unknown data type");
467 if (osssink->fd >= 0) {
468 if (!osssink->mute) {
469 guchar *data = GST_BUFFER_DATA (buf);
470 gint size = GST_BUFFER_SIZE (buf);
471 /* gint frag = osssink->fragment; <-- unused, for reason see above */
473 if (osssink->clock) {
474 /* FIXME, NEW_MEDIA/DISCONT?. Try to get our start point */
475 if (osssink->offset == -1LL && buftime != -1LL) {
476 GST_INFO (GST_CAT_PLUGIN_INFO,
477 "osssink: clock at offset: %lld, new offset %lld at time %lld\n",
478 osssink->offset, buftime, gst_clock_get_time (osssink->clock));
480 osssink->offset = buftime;
481 osssink->handled = 0;
482 gst_element_clock_wait (GST_ELEMENT (osssink), osssink->clock, buftime);
486 /* this doesn't work on BE machines, apparently
488 gint tosend = MIN (size, frag);
489 write (osssink->fd, data, tosend);
492 osssink->handled += tosend;
494 write (osssink->fd, data, size);
495 osssink->handled += size;
497 /* no clock, try to be as fast as possible */
499 audio_buf_info ospace;
501 ioctl (osssink->fd, SNDCTL_DSP_GETOSPACE, &ospace);
503 if (ospace.bytes >= size) {
504 write (osssink->fd, data, size);
506 osssink->handled += size;
510 gst_buffer_unref (buf);
514 gst_osssink_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
518 /* it's not null if we got it, but it might not be ours */
519 g_return_if_fail (GST_IS_OSSSINK (object));
521 osssink = GST_OSSSINK (object);
525 /* disallow changing the device while it is opened
526 get_property("device") should return the right one */
527 if (!GST_FLAG_IS_SET (osssink, GST_OSSSINK_OPEN))
529 g_free (osssink->device);
530 osssink->device = g_strdup (g_value_get_string (value));
531 g_object_notify (object, "device");
535 osssink->mute = g_value_get_boolean (value);
536 g_object_notify (G_OBJECT (osssink), "mute");
539 osssink->format = g_value_get_int (value);
540 gst_osssink_sync_parms (osssink);
543 osssink->channels = g_value_get_enum (value);
544 gst_osssink_sync_parms (osssink);
547 osssink->frequency = g_value_get_int (value);
548 gst_osssink_sync_parms (osssink);
551 osssink->fragment = g_value_get_int (value);
552 gst_osssink_sync_parms (osssink);
554 case ARG_BUFFER_SIZE:
555 if (osssink->bufsize == g_value_get_int (value)) break;
556 osssink->bufsize = g_value_get_int (value);
557 osssink->sinkpool = gst_buffer_pool_get_default (osssink->bufsize, 6);
558 g_object_notify (object, "buffer_size");
566 gst_osssink_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
570 /* it's not null if we got it, but it might not be ours */
571 g_return_if_fail (GST_IS_OSSSINK (object));
573 osssink = GST_OSSSINK (object);
577 g_value_set_string (value, osssink->device);
580 g_value_set_boolean (value, osssink->mute);
583 g_value_set_int (value, osssink->format);
586 g_value_set_enum (value, osssink->channels);
589 g_value_set_int (value, osssink->frequency);
592 g_value_set_int (value, osssink->fragment);
594 case ARG_BUFFER_SIZE:
595 g_value_set_int (value, osssink->bufsize);
603 gst_osssink_open_audio (GstOssSink *sink)
606 g_return_val_if_fail (sink->fd == -1, FALSE);
608 GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: attempting to open sound device");
610 /* first try to open the sound card */
611 sink->fd = open(sink->device, O_WRONLY | O_NONBLOCK);
612 if (errno == EBUSY) {
613 g_warning ("osssink: unable to open the sound device (in use ?)\n");
617 /* re-open the sound device in blocking mode */
619 sink->fd = open(sink->device, O_WRONLY);
621 /* if we have it, set the default parameters and go have fun */
624 ioctl(sink->fd, SNDCTL_DSP_GETCAPS, &caps);
626 GST_INFO(GST_CAT_PLUGIN_INFO, "osssink: Capabilities %08x", caps);
628 if (caps & DSP_CAP_DUPLEX) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: Full duplex");
629 if (caps & DSP_CAP_REALTIME) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: Realtime");
630 if (caps & DSP_CAP_BATCH) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: Batch");
631 if (caps & DSP_CAP_COPROC) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: Has coprocessor");
632 if (caps & DSP_CAP_TRIGGER) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: Trigger");
633 if (caps & DSP_CAP_MMAP) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: Direct access");
636 if (caps & DSP_CAP_MULTI) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: Multiple open");
637 #endif /* DSP_CAP_MULTI */
640 if (caps & DSP_CAP_BIND) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: Channel binding");
641 #endif /* DSP_CAP_BIND */
643 ioctl(sink->fd, SNDCTL_DSP_GETFMTS, &caps);
645 GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: Formats %08x", caps);
646 if (caps & AFMT_MU_LAW) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: MU_LAW");
647 if (caps & AFMT_A_LAW) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: A_LAW");
648 if (caps & AFMT_IMA_ADPCM) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: IMA_ADPCM");
649 if (caps & AFMT_U8) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: U8");
650 if (caps & AFMT_S16_LE) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: S16_LE");
651 if (caps & AFMT_S16_BE) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: S16_BE");
652 if (caps & AFMT_S8) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: S8");
653 if (caps & AFMT_U16_LE) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: U16_LE");
654 if (caps & AFMT_U16_BE) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: U16_BE");
655 if (caps & AFMT_MPEG) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: MPEG");
657 if (caps & AFMT_AC3) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: AC3");
660 GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: opened audio (%s) with fd=%d", sink->device, sink->fd);
661 GST_FLAG_SET (sink, GST_OSSSINK_OPEN);
670 gst_osssink_close_audio (GstOssSink *sink)
672 if (sink->fd < 0) return;
677 GST_FLAG_UNSET (sink, GST_OSSSINK_OPEN);
679 GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: closed sound device");
682 static GstElementStateReturn
683 gst_osssink_change_state (GstElement *element)
687 g_return_val_if_fail (GST_IS_OSSSINK (element), FALSE);
689 osssink = GST_OSSSINK (element);
691 switch (GST_STATE_TRANSITION (element)) {
692 case GST_STATE_NULL_TO_READY:
693 if (!GST_FLAG_IS_SET (element, GST_OSSSINK_OPEN)) {
694 if (!gst_osssink_open_audio (osssink)) {
695 return GST_STATE_FAILURE;
699 case GST_STATE_READY_TO_PAUSED:
700 osssink->offset = -1LL;
702 case GST_STATE_PAUSED_TO_PLAYING:
703 /* gst_clock_adjust (osssink->clock, osssink->offset - gst_clock_get_time (osssink->clock)); */
705 case GST_STATE_PLAYING_TO_PAUSED:
707 if (GST_FLAG_IS_SET (element, GST_OSSSINK_OPEN)) {
710 audio_buf_info ospace;
713 ioctl (osssink->fd, SNDCTL_DSP_GETOSPACE, &ospace);
714 ioctl (osssink->fd, SNDCTL_DSP_RESET, 0);
716 queued = (ospace.fragstotal * ospace.fragsize) - ospace.bytes;
717 time = osssink->offset + (osssink->handled - queued) * 1000000LL / osssink->bps;
719 //gst_clock_adjust (osssink->clock, time - gst_clock_get_time (osssink->clock));
722 ioctl (osssink->fd, SNDCTL_DSP_RESET, 0);
728 case GST_STATE_PAUSED_TO_READY:
729 if (GST_FLAG_IS_SET (element, GST_OSSSINK_OPEN))
730 ioctl (osssink->fd, SNDCTL_DSP_RESET, 0);
732 case GST_STATE_READY_TO_NULL:
733 if (GST_FLAG_IS_SET (element, GST_OSSSINK_OPEN))
734 gst_osssink_close_audio (osssink);
738 if (GST_ELEMENT_CLASS (parent_class)->change_state)
739 return GST_ELEMENT_CLASS (parent_class)->change_state (element);
741 return GST_STATE_SUCCESS;
745 gst_osssink_factory_init (GstPlugin *plugin)
747 GstElementFactory *factory;
749 factory = gst_element_factory_new ("osssink", GST_TYPE_OSSSINK, &gst_osssink_details);
750 g_return_val_if_fail (factory != NULL, FALSE);
752 gst_element_factory_add_pad_template (factory, GST_PAD_TEMPLATE_GET (osssink_sink_factory));
754 gst_plugin_add_feature (plugin, GST_PLUGIN_FEATURE (factory));