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);
54 static GstPadConnectReturn gst_osssink_sinkconnect (GstPad *pad, GstCaps *caps);
56 static void gst_osssink_set_property (GObject *object, guint prop_id, const GValue *value,
58 static void gst_osssink_get_property (GObject *object, guint prop_id, GValue *value,
61 static void gst_osssink_chain (GstPad *pad,GstBuffer *buf);
63 /* OssSink signals and args */
81 GST_PADTEMPLATE_FACTORY (osssink_sink_factory,
88 "format", GST_PROPS_STRING ("int"), /* hack */
89 "law", GST_PROPS_INT (0),
90 "endianness", GST_PROPS_INT (G_BYTE_ORDER),
91 "signed", GST_PROPS_LIST (
92 GST_PROPS_BOOLEAN (FALSE),
93 GST_PROPS_BOOLEAN (TRUE)
95 "width", GST_PROPS_LIST (
99 "depth", GST_PROPS_LIST (
103 "rate", GST_PROPS_INT_RANGE (1000, 48000),
104 "channels", GST_PROPS_INT_RANGE (1, 2)
108 #define GST_TYPE_OSSSINK_CHANNELS (gst_osssink_channels_get_type())
110 gst_osssink_channels_get_type(void) {
111 static GType osssink_channels_type = 0;
112 static GEnumValue osssink_channels[] = {
118 if (!osssink_channels_type) {
119 osssink_channels_type = g_enum_register_static("GstAudiosinkChannels", osssink_channels);
121 return osssink_channels_type;
125 static GstElementClass *parent_class = NULL;
126 static guint gst_osssink_signals[LAST_SIGNAL] = { 0 };
129 gst_osssink_get_type (void)
131 static GType osssink_type = 0;
134 static const GTypeInfo osssink_info = {
135 sizeof(GstOssSinkClass),
138 (GClassInitFunc)gst_osssink_class_init,
143 (GInstanceInitFunc)gst_osssink_init,
145 osssink_type = g_type_register_static (GST_TYPE_ELEMENT, "GstOssSink", &osssink_info, 0);
151 static GstBufferPool*
152 gst_osssink_get_bufferpool (GstPad *pad)
156 oss = GST_OSSSINK (gst_pad_get_parent(pad));
158 return oss->sinkpool;
162 gst_osssink_finalize (GObject *object)
164 GstOssSink *osssink = (GstOssSink *) object;
166 g_free (osssink->device);
168 G_OBJECT_CLASS (parent_class)->finalize (object);
172 gst_osssink_class_init (GstOssSinkClass *klass)
174 GObjectClass *gobject_class;
175 GstElementClass *gstelement_class;
177 gobject_class = (GObjectClass*)klass;
178 gstelement_class = (GstElementClass*)klass;
180 parent_class = g_type_class_ref(GST_TYPE_ELEMENT);
182 g_object_class_install_property(G_OBJECT_CLASS(klass), ARG_DEVICE,
183 g_param_spec_string("device","device","device",
184 "/dev/dsp",G_PARAM_READWRITE)); /* CHECKME! */
185 g_object_class_install_property(G_OBJECT_CLASS(klass), ARG_MUTE,
186 g_param_spec_boolean("mute","mute","mute",
187 TRUE,G_PARAM_READWRITE));
189 /* it would be nice to show format in symbolic form, oh well */
190 g_object_class_install_property(G_OBJECT_CLASS(klass), ARG_FORMAT,
191 g_param_spec_int ("format","format","format",
192 0, G_MAXINT, AFMT_S16_LE, G_PARAM_READWRITE));
194 g_object_class_install_property(G_OBJECT_CLASS(klass), ARG_CHANNELS,
195 g_param_spec_enum("channels","channels","channels",
196 GST_TYPE_OSSSINK_CHANNELS,2,G_PARAM_READWRITE));
197 g_object_class_install_property(G_OBJECT_CLASS(klass), ARG_FREQUENCY,
198 g_param_spec_int("frequency","frequency","frequency",
199 0,G_MAXINT,44100,G_PARAM_READWRITE));
200 g_object_class_install_property(G_OBJECT_CLASS(klass), ARG_FRAGMENT,
201 g_param_spec_int("fragment","fragment","fragment",
202 0,G_MAXINT,6,G_PARAM_READWRITE));
203 g_object_class_install_property(G_OBJECT_CLASS(klass), ARG_BUFFER_SIZE,
204 g_param_spec_int("buffer_size","buffer_size","buffer_size",
205 0,G_MAXINT,4096,G_PARAM_READWRITE));
207 gst_osssink_signals[SIGNAL_HANDOFF] =
208 g_signal_new("handoff",G_TYPE_FROM_CLASS(klass), G_SIGNAL_RUN_LAST,
209 G_STRUCT_OFFSET(GstOssSinkClass,handoff), NULL, NULL,
210 g_cclosure_marshal_VOID__VOID,G_TYPE_NONE,0);
212 gobject_class->set_property = gst_osssink_set_property;
213 gobject_class->get_property = gst_osssink_get_property;
214 gobject_class->finalize = gst_osssink_finalize;
216 gstelement_class->change_state = gst_osssink_change_state;
220 gst_osssink_init (GstOssSink *osssink)
222 osssink->sinkpad = gst_pad_new_from_template (
223 GST_PADTEMPLATE_GET (osssink_sink_factory), "sink");
224 gst_element_add_pad (GST_ELEMENT (osssink), osssink->sinkpad);
225 gst_pad_set_connect_function (osssink->sinkpad, gst_osssink_sinkconnect);
226 gst_pad_set_bufferpool_function (osssink->sinkpad, gst_osssink_get_bufferpool);
228 gst_pad_set_chain_function (osssink->sinkpad, gst_osssink_chain);
230 osssink->device = g_strdup ("/dev/dsp");
232 osssink->channels = 1;
233 osssink->frequency = 11025;
234 osssink->fragment = 6;
235 /* AFMT_*_BE not available on all OSS includes (e.g. FBSD) */
236 #ifdef WORDS_BIGENDIAN
237 osssink->format = AFMT_S16_BE;
239 osssink->format = AFMT_S16_LE;
240 #endif /* WORDS_BIGENDIAN */
241 /* gst_clock_register (osssink->clock, GST_OBJECT (osssink)); */
242 osssink->bufsize = 4096;
243 osssink->offset = 0LL;
244 /* 6 buffers per chunk by default */
245 osssink->sinkpool = gst_buffer_pool_get_default (osssink->bufsize, 6);
247 osssink->provided_clock = GST_CLOCK (gst_oss_clock_new ("OssClock", GST_ELEMENT (osssink)));
249 GST_ELEMENT (osssink)->setclockfunc = gst_osssink_set_clock;
250 GST_ELEMENT (osssink)->getclockfunc = gst_osssink_get_clock;
252 GST_FLAG_SET (osssink, GST_ELEMENT_THREAD_SUGGESTED);
255 static GstPadConnectReturn
256 gst_osssink_sinkconnect (GstPad *pad, GstCaps *caps)
258 gint law, endianness, width, depth;
261 GstOssSink *osssink = GST_OSSSINK (gst_pad_get_parent (pad));
263 if (!GST_CAPS_IS_FIXED (caps))
264 return GST_PAD_CONNECT_DELAYED;
266 width = gst_caps_get_int (caps, "width");
267 depth = gst_caps_get_int (caps, "depth");
270 return GST_PAD_CONNECT_REFUSED;
272 /* laws 1 and 2 are 1 bps anyway */
275 law = gst_caps_get_int (caps, "law");
276 endianness = gst_caps_get_int (caps, "endianness");
277 sign = gst_caps_get_boolean (caps, "signed");
282 if (endianness == G_LITTLE_ENDIAN)
283 format = AFMT_S16_LE;
284 else if (endianness == G_BIG_ENDIAN)
285 format = AFMT_S16_BE;
288 if (endianness == G_LITTLE_ENDIAN)
289 format = AFMT_U16_LE;
290 else if (endianness == G_BIG_ENDIAN)
291 format = AFMT_U16_BE;
295 else if (width == 8) {
304 } else if (law == 1) {
305 format = AFMT_MU_LAW;
306 } else if (law == 2) {
309 g_critical ("unknown law");
310 return GST_PAD_CONNECT_REFUSED;
314 return GST_PAD_CONNECT_REFUSED;
316 osssink->format = format;
317 osssink->channels = gst_caps_get_int (caps, "channels");
318 osssink->frequency = gst_caps_get_int (caps, "rate");
320 osssink->bps *= osssink->channels;
321 osssink->bps *= osssink->frequency;
323 if (!gst_osssink_sync_parms (osssink)) {
324 return GST_PAD_CONNECT_REFUSED;
327 return GST_PAD_CONNECT_OK;
331 gst_osssink_sync_parms (GstOssSink *osssink)
333 audio_buf_info ospace;
336 gint target_channels;
337 gint target_frequency;
340 g_return_val_if_fail (osssink != NULL, FALSE);
341 g_return_val_if_fail (GST_IS_OSSSINK (osssink), FALSE);
343 if (osssink->fd == -1)
346 if (osssink->fragment >> 16)
347 frag = osssink->fragment;
349 frag = 0x7FFF0000 | osssink->fragment;
351 GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: trying to set sound card to %dHz %d bit %s (%08x fragment)",
352 osssink->frequency, osssink->format,
353 (osssink->channels == 2) ? "stereo" : "mono",frag);
355 ioctl (osssink->fd, SNDCTL_DSP_SETFRAGMENT, &frag);
357 ioctl (osssink->fd, SNDCTL_DSP_RESET, 0);
359 target_format = osssink->format;
360 target_channels = osssink->channels;
361 target_frequency = osssink->frequency;
363 ioctl (osssink->fd, SNDCTL_DSP_SETFMT, &osssink->format);
364 ioctl (osssink->fd, SNDCTL_DSP_CHANNELS, &osssink->channels);
365 ioctl (osssink->fd, SNDCTL_DSP_SPEED, &osssink->frequency);
367 ioctl (osssink->fd, SNDCTL_DSP_GETBLKSIZE, &osssink->fragment);
368 ioctl (osssink->fd, SNDCTL_DSP_GETOSPACE, &ospace);
370 GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: set sound card to %dHz %d bit %s (%d bytes buffer, %08x fragment)",
371 osssink->frequency, osssink->format,
372 (osssink->channels == 2) ? "stereo" : "mono", ospace.bytes, osssink->fragment);
374 object = G_OBJECT (osssink);
375 g_object_freeze_notify (object);
376 g_object_notify (object, "channels");
377 g_object_notify (object, "frequency");
378 g_object_notify (object, "fragment");
379 g_object_notify (object, "format");
380 g_object_thaw_notify (object);
382 osssink->fragment_time = (1000000 * osssink->fragment) / osssink->bps;
383 GST_INFO (GST_CAT_PLUGIN_INFO, "fragment time %u %llu\n", osssink->bps, osssink->fragment_time);
385 if (target_format != osssink->format ||
386 target_channels != osssink->channels ||
387 target_frequency != osssink->frequency)
389 g_warning ("could not configure oss with required parameters, enjoy the noise :)");
390 /* we could eventually return FALSE here, or just do some additional tests
391 * to see that the frequencies don't differ too much etc.. */
397 gst_osssink_set_clock (GstElement *element, GstClock *clock)
401 osssink = GST_OSSSINK (element);
403 osssink->clock = clock;
407 gst_osssink_get_clock (GstElement *element)
411 osssink = GST_OSSSINK (element);
413 return osssink->provided_clock;
417 gst_osssink_chain (GstPad *pad, GstBuffer *buf)
420 GstClockTime buftime;
422 /* this has to be an audio buffer */
423 osssink = GST_OSSSINK (gst_pad_get_parent (pad));
425 buftime = GST_BUFFER_TIMESTAMP (buf);
428 gst_buffer_unref (buf);
429 gst_element_error (GST_ELEMENT (osssink), "capsnego was never performed, unknown data type");
432 if (osssink->fd >= 0) {
433 if (!osssink->mute) {
434 guchar *data = GST_BUFFER_DATA (buf);
435 gint size = GST_BUFFER_SIZE (buf);
437 if (osssink->clock) {
438 if (osssink->clock == osssink->provided_clock) {
440 gint granularity, granularity_time;
442 audio_buf_info ospace;
445 /* FIXME, NEW_MEDIA/DISCONT?. Try to get our start point */
446 if (osssink->offset == 0LL && buftime != -1LL) {
447 /* gst_oss_clock_set_base (GST_OSS_CLOCK (osssink->clock), buftime); */
448 osssink->offset = buftime;
451 ioctl (osssink->fd, SNDCTL_DSP_GETOSPACE, &ospace);
452 ioctl (osssink->fd, SNDCTL_DSP_GETOPTR, &optr);
454 queued = (ospace.fragstotal * ospace.fragsize) - ospace.bytes;
455 time = osssink->offset + (optr.bytes) * 1000000LL / osssink->bps;
457 GST_DEBUG (GST_CAT_PLUGIN_INFO, "sync %llu %llu %d", buftime, time, queued);
459 granularity = ospace.fragsize;
460 /* granularity = size; */
461 granularity_time = granularity * osssink->fragment_time / ospace.fragsize;
464 write (osssink->fd, data, MIN (size, granularity));
467 time += granularity_time;
468 gst_clock_set_time (osssink->provided_clock, time);
472 gst_element_clock_wait (GST_ELEMENT (osssink), osssink->clock, buftime);
474 write (osssink->fd, data, size);
478 audio_buf_info ospace;
480 ioctl (osssink->fd, SNDCTL_DSP_GETOSPACE, &ospace);
482 if (ospace.bytes >= size) {
483 write (osssink->fd, data, size);
488 gst_buffer_unref (buf);
492 gst_osssink_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
496 /* it's not null if we got it, but it might not be ours */
497 g_return_if_fail (GST_IS_OSSSINK (object));
499 osssink = GST_OSSSINK (object);
503 /* disallow changing the device while it is opened
504 get_property("device") should return the right one */
505 if (!GST_FLAG_IS_SET (osssink, GST_OSSSINK_OPEN))
507 g_free (osssink->device);
508 osssink->device = g_strdup (g_value_get_string (value));
509 g_object_notify (object, "device");
513 osssink->mute = g_value_get_boolean (value);
514 g_object_notify (G_OBJECT (osssink), "mute");
517 osssink->format = g_value_get_int (value);
518 gst_osssink_sync_parms (osssink);
521 osssink->channels = g_value_get_enum (value);
522 gst_osssink_sync_parms (osssink);
525 osssink->frequency = g_value_get_int (value);
526 gst_osssink_sync_parms (osssink);
529 osssink->fragment = g_value_get_int (value);
530 gst_osssink_sync_parms (osssink);
532 case ARG_BUFFER_SIZE:
533 if (osssink->bufsize == g_value_get_int (value)) break;
534 osssink->bufsize = g_value_get_int (value);
535 osssink->sinkpool = gst_buffer_pool_get_default (osssink->bufsize, 6);
536 g_object_notify (object, "buffer_size");
544 gst_osssink_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
548 /* it's not null if we got it, but it might not be ours */
549 g_return_if_fail (GST_IS_OSSSINK (object));
551 osssink = GST_OSSSINK (object);
555 g_value_set_string (value, osssink->device);
558 g_value_set_boolean (value, osssink->mute);
561 g_value_set_int (value, osssink->format);
564 g_value_set_enum (value, osssink->channels);
567 g_value_set_int (value, osssink->frequency);
570 g_value_set_int (value, osssink->fragment);
572 case ARG_BUFFER_SIZE:
573 g_value_set_int (value, osssink->bufsize);
581 gst_osssink_open_audio (GstOssSink *sink)
584 g_return_val_if_fail (sink->fd == -1, FALSE);
586 GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: attempting to open sound device");
588 /* first try to open the sound card */
589 sink->fd = open(sink->device, O_WRONLY | O_NONBLOCK);
590 if (errno == EBUSY) {
591 g_warning ("osssink: unable to open the sound device (in use ?)\n");
595 /* re-open the sound device in blocking mode */
597 sink->fd = open(sink->device, O_WRONLY);
599 /* if we have it, set the default parameters and go have fun */
602 ioctl(sink->fd, SNDCTL_DSP_GETCAPS, &caps);
604 GST_INFO(GST_CAT_PLUGIN_INFO, "osssink: Capabilities %08x", caps);
606 if (caps & DSP_CAP_DUPLEX) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: Full duplex");
607 if (caps & DSP_CAP_REALTIME) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: Realtime");
608 if (caps & DSP_CAP_BATCH) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: Batch");
609 if (caps & DSP_CAP_COPROC) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: Has coprocessor");
610 if (caps & DSP_CAP_TRIGGER) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: Trigger");
611 if (caps & DSP_CAP_MMAP) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: Direct access");
614 if (caps & DSP_CAP_MULTI) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: Multiple open");
615 #endif /* DSP_CAP_MULTI */
618 if (caps & DSP_CAP_BIND) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: Channel binding");
619 #endif /* DSP_CAP_BIND */
621 ioctl(sink->fd, SNDCTL_DSP_GETFMTS, &caps);
623 GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: Formats %08x", caps);
624 if (caps & AFMT_MU_LAW) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: MU_LAW");
625 if (caps & AFMT_A_LAW) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: A_LAW");
626 if (caps & AFMT_IMA_ADPCM) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: IMA_ADPCM");
627 if (caps & AFMT_U8) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: U8");
628 if (caps & AFMT_S16_LE) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: S16_LE");
629 if (caps & AFMT_S16_BE) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: S16_BE");
630 if (caps & AFMT_S8) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: S8");
631 if (caps & AFMT_U16_LE) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: U16_LE");
632 if (caps & AFMT_U16_BE) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: U16_BE");
633 if (caps & AFMT_MPEG) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: MPEG");
635 if (caps & AFMT_AC3) GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: AC3");
638 GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: opened audio (%s) with fd=%d", sink->device, sink->fd);
639 GST_FLAG_SET (sink, GST_OSSSINK_OPEN);
648 gst_osssink_close_audio (GstOssSink *sink)
650 if (sink->fd < 0) return;
655 GST_FLAG_UNSET (sink, GST_OSSSINK_OPEN);
657 GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: closed sound device");
660 static GstElementStateReturn
661 gst_osssink_change_state (GstElement *element)
665 g_return_val_if_fail (GST_IS_OSSSINK (element), FALSE);
667 osssink = GST_OSSSINK (element);
669 switch (GST_STATE_TRANSITION (element)) {
670 case GST_STATE_NULL_TO_READY:
671 if (!GST_FLAG_IS_SET (element, GST_OSSSINK_OPEN)) {
672 if (!gst_osssink_open_audio (osssink)) {
673 return GST_STATE_FAILURE;
677 case GST_STATE_READY_TO_PAUSED:
679 case GST_STATE_PAUSED_TO_PLAYING:
680 gst_oss_clock_set_update (GST_OSS_CLOCK (osssink->provided_clock), TRUE);
682 case GST_STATE_PLAYING_TO_PAUSED:
684 if (GST_FLAG_IS_SET (element, GST_OSSSINK_OPEN)) {
687 audio_buf_info ospace;
691 ioctl (osssink->fd, SNDCTL_DSP_GETOSPACE, &ospace);
692 ioctl (osssink->fd, SNDCTL_DSP_GETOPTR, &optr);
694 queued = (ospace.fragstotal * ospace.fragsize) - ospace.bytes;
695 time = (optr.bytes + queued) * 1000000LL / osssink->bps;
696 ioctl (osssink->fd, SNDCTL_DSP_RESET, 0);
698 gst_oss_clock_set_update (GST_OSS_CLOCK (osssink->provided_clock), FALSE);
699 gst_clock_set_time (osssink->provided_clock, time);
702 ioctl (osssink->fd, SNDCTL_DSP_RESET, 0);
703 gst_oss_clock_set_update (GST_OSS_CLOCK (osssink->provided_clock), FALSE);
709 case GST_STATE_PAUSED_TO_READY:
710 if (GST_FLAG_IS_SET (element, GST_OSSSINK_OPEN))
711 ioctl (osssink->fd, SNDCTL_DSP_RESET, 0);
713 case GST_STATE_READY_TO_NULL:
714 if (GST_FLAG_IS_SET (element, GST_OSSSINK_OPEN))
715 gst_osssink_close_audio (osssink);
719 if (GST_ELEMENT_CLASS (parent_class)->change_state)
720 return GST_ELEMENT_CLASS (parent_class)->change_state (element);
722 return GST_STATE_SUCCESS;
726 gst_osssink_factory_init (GstPlugin *plugin)
728 GstElementFactory *factory;
730 factory = gst_elementfactory_new ("osssink", GST_TYPE_OSSSINK, &gst_osssink_details);
731 g_return_val_if_fail (factory != NULL, FALSE);
733 gst_elementfactory_add_padtemplate (factory, GST_PADTEMPLATE_GET (osssink_sink_factory));
735 gst_plugin_add_feature (plugin, GST_PLUGIN_FEATURE (factory));