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.
23 #include <sys/ioctl.h>
24 #include <sys/soundcard.h>
26 #include <gstosssink.h>
28 /* elementfactory information */
29 static GstElementDetails gst_osssink_details = {
33 "Output to a sound card via OSS",
35 "Erik Walthinsen <omega@cse.ogi.edu>, "
36 "Wim Taymans <wim.taymans@chello.be>",
40 static void gst_osssink_class_init (GstOssSinkClass *klass);
41 static void gst_osssink_init (GstOssSink *osssink);
42 static void gst_osssink_dispose (GObject *object);
43 static void gst_osssink_finalize (GObject *object);
45 static GstElementStateReturn gst_osssink_change_state (GstElement *element);
46 static void gst_osssink_set_clock (GstElement *element, GstClock *clock);
47 static GstClock* gst_osssink_get_clock (GstElement *element);
48 static GstClockTime gst_osssink_get_time (GstClock *clock, gpointer data);
50 static const GstFormat* gst_osssink_get_formats (GstPad *pad);
51 static gboolean gst_osssink_convert (GstPad *pad, GstFormat src_format, gint64 src_value,
52 GstFormat *dest_format, gint64 *dest_value);
53 static const GstQueryType* gst_osssink_get_query_types (GstPad *pad);
54 static gboolean gst_osssink_query (GstElement *element, GstQueryType type,
55 GstFormat *format, gint64 *value);
56 static gboolean gst_osssink_sink_query (GstPad *pad, GstQueryType type,
57 GstFormat *format, gint64 *value);
59 static GstPadLinkReturn gst_osssink_sinkconnect (GstPad *pad, GstCaps *caps);
61 static void gst_osssink_set_property (GObject *object, guint prop_id, const GValue *value,
63 static void gst_osssink_get_property (GObject *object, guint prop_id, GValue *value,
66 static void gst_osssink_chain (GstPad *pad,GstBuffer *buf);
68 /* OssSink signals and args */
84 GST_PAD_TEMPLATE_FACTORY (osssink_sink_factory,
91 "format", GST_PROPS_STRING ("int"), /* hack */
92 "law", GST_PROPS_INT (0),
93 "endianness", GST_PROPS_INT (G_BYTE_ORDER),
94 "signed", GST_PROPS_LIST (
95 GST_PROPS_BOOLEAN (FALSE),
96 GST_PROPS_BOOLEAN (TRUE)
98 "width", GST_PROPS_LIST (
102 "depth", GST_PROPS_LIST (
106 "rate", GST_PROPS_INT_RANGE (1000, 48000),
107 "channels", GST_PROPS_INT_RANGE (1, 2)
111 static GstElementClass *parent_class = NULL;
112 static guint gst_osssink_signals[LAST_SIGNAL] = { 0 };
115 gst_osssink_get_type (void)
117 static GType osssink_type = 0;
120 static const GTypeInfo osssink_info = {
121 sizeof(GstOssSinkClass),
124 (GClassInitFunc)gst_osssink_class_init,
129 (GInstanceInitFunc)gst_osssink_init,
131 osssink_type = g_type_register_static (GST_TYPE_ELEMENT, "GstOssSink", &osssink_info, 0);
137 static GstBufferPool*
138 gst_osssink_get_bufferpool (GstPad *pad)
142 oss = GST_OSSSINK (gst_pad_get_parent(pad));
144 /* 6 buffers per chunk by default */
146 oss->sinkpool = gst_buffer_pool_get_default (oss->bufsize, 6);
148 return oss->sinkpool;
152 gst_osssink_dispose (GObject *object)
154 GstOssSink *osssink = (GstOssSink *) object;
156 gst_object_unparent (GST_OBJECT (osssink->provided_clock));
158 G_OBJECT_CLASS (parent_class)->dispose (object);
162 gst_osssink_finalize (GObject *object)
164 GstOssSink *osssink = (GstOssSink *) object;
166 g_free (osssink->common.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", "The device to use for output",
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 the audio",
187 TRUE, G_PARAM_READWRITE));
188 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_SYNC,
189 g_param_spec_boolean ("sync", "Sync", "If syncing on timestamps should be enabled",
190 TRUE, G_PARAM_READWRITE));
191 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_FRAGMENT,
192 g_param_spec_int ("fragment", "Fragment",
193 "The fragment as 0xMMMMSSSS (MMMM = total fragments, 2^SSSS = fragment size)",
194 0, G_MAXINT, 6, G_PARAM_READWRITE));
195 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_BUFFER_SIZE,
196 g_param_spec_int ("buffer_size", "Buffer size", "The buffer size",
197 0, G_MAXINT, 4096, G_PARAM_READWRITE));
199 gst_osssink_signals[SIGNAL_HANDOFF] =
200 g_signal_new ("handoff", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
201 G_STRUCT_OFFSET (GstOssSinkClass, handoff), NULL, NULL,
202 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
204 gobject_class->set_property = gst_osssink_set_property;
205 gobject_class->get_property = gst_osssink_get_property;
206 gobject_class->dispose = gst_osssink_dispose;
207 gobject_class->finalize = gst_osssink_finalize;
209 gstelement_class->change_state = GST_DEBUG_FUNCPTR (gst_osssink_change_state);
210 gstelement_class->query = GST_DEBUG_FUNCPTR (gst_osssink_query);
211 gstelement_class->set_clock = gst_osssink_set_clock;
212 gstelement_class->get_clock = gst_osssink_get_clock;
217 gst_osssink_init (GstOssSink *osssink)
219 osssink->sinkpad = gst_pad_new_from_template (
220 GST_PAD_TEMPLATE_GET (osssink_sink_factory), "sink");
221 gst_element_add_pad (GST_ELEMENT (osssink), osssink->sinkpad);
222 gst_pad_set_link_function (osssink->sinkpad, gst_osssink_sinkconnect);
223 gst_pad_set_bufferpool_function (osssink->sinkpad, gst_osssink_get_bufferpool);
224 gst_pad_set_convert_function (osssink->sinkpad, gst_osssink_convert);
225 gst_pad_set_query_function (osssink->sinkpad, gst_osssink_sink_query);
226 gst_pad_set_query_type_function (osssink->sinkpad, gst_osssink_get_query_types);
227 gst_pad_set_formats_function (osssink->sinkpad, gst_osssink_get_formats);
229 gst_pad_set_chain_function (osssink->sinkpad, gst_osssink_chain);
231 gst_osscommon_init (&osssink->common);
233 osssink->bufsize = 4096;
234 osssink->resync = FALSE;
235 osssink->sync = TRUE;
236 osssink->sinkpool = NULL;
237 osssink->provided_clock = GST_CLOCK (gst_oss_clock_new ("ossclock", gst_osssink_get_time, osssink));
238 gst_object_set_parent (GST_OBJECT (osssink->provided_clock), GST_OBJECT (osssink));
239 osssink->handled = 0;
241 GST_FLAG_SET (osssink, GST_ELEMENT_THREAD_SUGGESTED);
242 GST_FLAG_SET (osssink, GST_ELEMENT_EVENT_AWARE);
246 static GstPadLinkReturn
247 gst_osssink_sinkconnect (GstPad *pad, GstCaps *caps)
249 GstOssSink *osssink = GST_OSSSINK (gst_pad_get_parent (pad));
251 if (!GST_CAPS_IS_FIXED (caps))
252 return GST_PAD_LINK_DELAYED;
254 if (!gst_osscommon_parse_caps (&osssink->common, caps))
255 return GST_PAD_LINK_REFUSED;
257 if (!gst_osscommon_sync_parms (&osssink->common)) {
258 return GST_PAD_LINK_REFUSED;
261 return GST_PAD_LINK_OK;
265 gst_osssink_get_delay (GstOssSink *osssink)
269 if (osssink->common.fd == -1)
272 if (ioctl (osssink->common.fd, SNDCTL_DSP_GETODELAY, &delay) < 0) {
274 if (ioctl (osssink->common.fd, SNDCTL_DSP_GETOSPACE, &info) < 0) {
278 delay = (info.fragstotal * info.fragsize) - info.bytes;
285 gst_osssink_get_time (GstClock *clock, gpointer data)
287 GstOssSink *osssink = GST_OSSSINK (data);
291 if (!osssink->common.bps)
294 delay = gst_osssink_get_delay (osssink);
296 /* sometimes delay is bigger than the number of bytes sent to the device,
297 * which screws up this calculation, we assume that everything is still
298 * in the device then */
299 if (((guint64)delay) > osssink->handled) {
300 delay = osssink->handled;
302 res = (osssink->handled - delay) * GST_SECOND / osssink->common.bps;
308 gst_osssink_get_clock (GstElement *element)
312 osssink = GST_OSSSINK (element);
314 return GST_CLOCK (osssink->provided_clock);
318 gst_osssink_set_clock (GstElement *element, GstClock *clock)
322 osssink = GST_OSSSINK (element);
324 osssink->clock = clock;
328 gst_osssink_chain (GstPad *pad, GstBuffer *buf)
331 GstClockTime buftime;
333 /* this has to be an audio buffer */
334 osssink = GST_OSSSINK (gst_pad_get_parent (pad));
336 if (GST_IS_EVENT (buf)) {
337 GstEvent *event = GST_EVENT (buf);
339 switch (GST_EVENT_TYPE (event)) {
341 ioctl (osssink->common.fd, SNDCTL_DSP_SYNC);
342 gst_oss_clock_set_active (osssink->provided_clock, FALSE);
343 gst_pad_event_default (pad, event);
345 case GST_EVENT_NEW_MEDIA:
346 g_print ("new media\n");
348 case GST_EVENT_DISCONTINUOUS:
352 ioctl (osssink->common.fd, SNDCTL_DSP_RESET);
353 if (gst_event_discont_get_value (event, GST_FORMAT_TIME, &value)) {
354 if (!gst_clock_handle_discont (osssink->clock, value))
355 gst_oss_clock_set_active (osssink->provided_clock, FALSE);
356 osssink->handled = 0;
358 osssink->resync = TRUE;
362 gst_pad_event_default (pad, event);
365 gst_event_unref (event);
369 if (!osssink->common.bps) {
370 gst_buffer_unref (buf);
371 gst_element_error (GST_ELEMENT (osssink), "capsnego was never performed, unknown data type");
375 buftime = GST_BUFFER_TIMESTAMP (buf);
377 if (osssink->common.fd >= 0) {
378 if (!osssink->mute) {
379 guchar *data = GST_BUFFER_DATA (buf);
380 gint size = GST_BUFFER_SIZE (buf);
382 if (osssink->clock) {
385 GstClockTimeDiff jitter;
387 delay = gst_osssink_get_delay (osssink);
388 queued = delay * GST_SECOND / osssink->common.bps;
390 if (osssink->resync && osssink->sync) {
391 GstClockID id = gst_clock_new_single_shot_id (osssink->clock, buftime - queued);
393 gst_element_clock_wait (GST_ELEMENT (osssink), id, &jitter);
394 gst_clock_id_free (id);
397 gst_clock_handle_discont (osssink->clock, buftime - queued + jitter);
398 write (osssink->common.fd, data, size);
399 gst_oss_clock_set_active (osssink->provided_clock, TRUE);
400 osssink->resync = FALSE;
401 osssink->handled += size;
405 write (osssink->common.fd, data, size);
406 osssink->handled += size;
409 /* no clock, try to be as fast as possible */
411 audio_buf_info ospace;
413 ioctl (osssink->common.fd, SNDCTL_DSP_GETOSPACE, &ospace);
415 if (ospace.bytes >= size) {
416 write (osssink->common.fd, data, size);
421 gst_buffer_unref (buf);
424 static const GstFormat*
425 gst_osssink_get_formats (GstPad *pad)
427 static const GstFormat formats[] = {
437 gst_osssink_convert (GstPad *pad, GstFormat src_format, gint64 src_value,
438 GstFormat *dest_format, gint64 *dest_value)
442 osssink = GST_OSSSINK (gst_pad_get_parent (pad));
444 return gst_osscommon_convert (&osssink->common, src_format, src_value,
445 dest_format, dest_value);
448 static const GstQueryType*
449 gst_osssink_get_query_types (GstPad *pad)
451 static const GstQueryType query_types[] = {
460 gst_osssink_sink_query (GstPad *pad, GstQueryType type, GstFormat *format, gint64 *value)
465 osssink = GST_OSSSINK (gst_pad_get_parent (pad));
468 case GST_QUERY_LATENCY:
469 if (!gst_osssink_convert (pad,
470 GST_FORMAT_BYTES, gst_osssink_get_delay (osssink),
476 case GST_QUERY_POSITION:
477 if (!gst_osssink_convert (pad,
478 GST_FORMAT_TIME, gst_clock_get_time (osssink->provided_clock),
485 res = gst_pad_query (gst_pad_get_peer (osssink->sinkpad), type, format, value);
493 gst_osssink_query (GstElement *element, GstQueryType type, GstFormat *format, gint64 *value)
495 GstOssSink *osssink = GST_OSSSINK (element);
497 return gst_osssink_sink_query (osssink->sinkpad, type, format, value);
501 gst_osssink_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
505 osssink = GST_OSSSINK (object);
509 /* disallow changing the device while it is opened
510 get_property("device") should return the right one */
511 if (!GST_FLAG_IS_SET (osssink, GST_OSSSINK_OPEN))
513 g_free (osssink->common.device);
514 osssink->common.device = g_strdup (g_value_get_string (value));
515 g_object_notify (object, "device");
519 osssink->mute = g_value_get_boolean (value);
520 g_object_notify (G_OBJECT (osssink), "mute");
523 osssink->common.fragment = g_value_get_int (value);
524 gst_osscommon_sync_parms (&osssink->common);
526 case ARG_BUFFER_SIZE:
527 if (osssink->bufsize == g_value_get_int (value)) break;
528 osssink->bufsize = g_value_get_int (value);
529 osssink->sinkpool = gst_buffer_pool_get_default (osssink->bufsize, 6);
530 g_object_notify (object, "buffer_size");
533 osssink->sync = g_value_get_boolean (value);
534 g_object_notify (G_OBJECT (osssink), "sync");
537 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
543 gst_osssink_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
547 osssink = GST_OSSSINK (object);
551 g_value_set_string (value, osssink->common.device);
554 g_value_set_boolean (value, osssink->mute);
557 g_value_set_int (value, osssink->common.fragment);
559 case ARG_BUFFER_SIZE:
560 g_value_set_int (value, osssink->bufsize);
563 g_value_set_boolean (value, osssink->sync);
566 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
571 static GstElementStateReturn
572 gst_osssink_change_state (GstElement *element)
576 osssink = GST_OSSSINK (element);
578 switch (GST_STATE_TRANSITION (element)) {
579 case GST_STATE_NULL_TO_READY:
580 if (!GST_FLAG_IS_SET (element, GST_OSSSINK_OPEN)) {
583 if (!gst_osscommon_open_audio (&osssink->common, GST_OSSCOMMON_WRITE, &error)) {
584 gst_element_error (GST_ELEMENT (osssink), error);
586 return GST_STATE_FAILURE;
588 GST_FLAG_SET (element, GST_OSSSINK_OPEN);
591 case GST_STATE_READY_TO_PAUSED:
593 case GST_STATE_PAUSED_TO_PLAYING:
594 osssink->resync = TRUE;
596 case GST_STATE_PLAYING_TO_PAUSED:
598 if (GST_FLAG_IS_SET (element, GST_OSSSINK_OPEN))
599 ioctl (osssink->common.fd, SNDCTL_DSP_RESET, 0);
600 gst_oss_clock_set_active (osssink->provided_clock, FALSE);
601 osssink->resync = TRUE;
604 case GST_STATE_PAUSED_TO_READY:
605 if (GST_FLAG_IS_SET (element, GST_OSSSINK_OPEN))
606 ioctl (osssink->common.fd, SNDCTL_DSP_RESET, 0);
607 gst_osscommon_reset (&osssink->common);
609 case GST_STATE_READY_TO_NULL:
610 if (GST_FLAG_IS_SET (element, GST_OSSSINK_OPEN)) {
611 gst_osscommon_close_audio (&osssink->common);
612 GST_FLAG_UNSET (osssink, GST_OSSSINK_OPEN);
614 GST_INFO (GST_CAT_PLUGIN_INFO, "osssink: closed sound device");
619 if (GST_ELEMENT_CLASS (parent_class)->change_state)
620 return GST_ELEMENT_CLASS (parent_class)->change_state (element);
622 return GST_STATE_SUCCESS;
626 gst_osssink_factory_init (GstPlugin *plugin)
628 GstElementFactory *factory;
630 factory = gst_element_factory_new ("osssink", GST_TYPE_OSSSINK, &gst_osssink_details);
631 g_return_val_if_fail (factory != NULL, FALSE);
633 gst_element_factory_add_pad_template (factory, GST_PAD_TEMPLATE_GET (osssink_sink_factory));
635 gst_plugin_add_feature (plugin, GST_PLUGIN_FEATURE (factory));