2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2005 Wim Taymans <wim@fluendo.com>
5 * gstaudiosink.c: simple audio sink base class
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., 51 Franklin St, Fifth Floor,
20 * Boston, MA 02110-1301, USA.
24 * SECTION:gstaudiosink
25 * @title: GstAudioSink
26 * @short_description: Simple base class for audio sinks
27 * @see_also: #GstAudioBaseSink, #GstAudioRingBuffer, #GstAudioSink.
29 * This is the most simple base class for audio sinks that only requires
30 * subclasses to implement a set of simple functions:
32 * * `open()` :Open the device.
34 * * `prepare()` :Configure the device with the specified format.
36 * * `write()` :Write samples to the device.
38 * * `reset()` :Unblock writes and flush the device.
40 * * `delay()` :Get the number of samples written but not yet played
43 * * `unprepare()` :Undo operations done by prepare.
45 * * `close()` :Close the device.
47 * All scheduling of samples and timestamps is done in this base class
48 * together with #GstAudioBaseSink using a default implementation of a
49 * #GstAudioRingBuffer that uses threads.
57 #include <gst/audio/audio.h>
58 #include "gstaudiosink.h"
59 #include "gstaudioutilsprivate.h"
61 GST_DEBUG_CATEGORY_STATIC (gst_audio_sink_debug);
62 #define GST_CAT_DEFAULT gst_audio_sink_debug
64 #define GST_TYPE_AUDIO_SINK_RING_BUFFER \
65 (gst_audio_sink_ring_buffer_get_type())
66 #define GST_AUDIO_SINK_RING_BUFFER(obj) \
67 (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_AUDIO_SINK_RING_BUFFER,GstAudioSinkRingBuffer))
68 #define GST_AUDIO_SINK_RING_BUFFER_CLASS(klass) \
69 (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_AUDIO_SINK_RING_BUFFER,GstAudioSinkRingBufferClass))
70 #define GST_AUDIO_SINK_RING_BUFFER_GET_CLASS(obj) \
71 (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_AUDIO_SINK_RING_BUFFER, GstAudioSinkRingBufferClass))
72 #define GST_AUDIO_SINK_RING_BUFFER_CAST(obj) \
73 ((GstAudioSinkRingBuffer *)obj)
74 #define GST_IS_AUDIO_SINK_RING_BUFFER(obj) \
75 (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_AUDIO_SINK_RING_BUFFER))
76 #define GST_IS_AUDIO_SINK_RING_BUFFER_CLASS(klass)\
77 (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_AUDIO_SINK_RING_BUFFER))
79 typedef struct _GstAudioSinkRingBuffer GstAudioSinkRingBuffer;
80 typedef struct _GstAudioSinkRingBufferClass GstAudioSinkRingBufferClass;
82 #define GST_AUDIO_SINK_RING_BUFFER_GET_COND(buf) (&(((GstAudioSinkRingBuffer *)buf)->cond))
83 #define GST_AUDIO_SINK_RING_BUFFER_WAIT(buf) (g_cond_wait (GST_AUDIO_SINK_RING_BUFFER_GET_COND (buf), GST_OBJECT_GET_LOCK (buf)))
84 #define GST_AUDIO_SINK_RING_BUFFER_SIGNAL(buf) (g_cond_signal (GST_AUDIO_SINK_RING_BUFFER_GET_COND (buf)))
85 #define GST_AUDIO_SINK_RING_BUFFER_BROADCAST(buf)(g_cond_broadcast (GST_AUDIO_SINK_RING_BUFFER_GET_COND (buf)))
87 struct _GstAudioSinkRingBuffer
89 GstAudioRingBuffer object;
97 struct _GstAudioSinkRingBufferClass
99 GstAudioRingBufferClass parent_class;
102 static void gst_audio_sink_ring_buffer_class_init (GstAudioSinkRingBufferClass *
104 static void gst_audio_sink_ring_buffer_init (GstAudioSinkRingBuffer *
105 ringbuffer, GstAudioSinkRingBufferClass * klass);
106 static void gst_audio_sink_ring_buffer_dispose (GObject * object);
107 static void gst_audio_sink_ring_buffer_finalize (GObject * object);
109 static GstAudioRingBufferClass *ring_parent_class = NULL;
111 static gboolean gst_audio_sink_ring_buffer_open_device (GstAudioRingBuffer *
113 static gboolean gst_audio_sink_ring_buffer_close_device (GstAudioRingBuffer *
115 static gboolean gst_audio_sink_ring_buffer_acquire (GstAudioRingBuffer * buf,
116 GstAudioRingBufferSpec * spec);
117 static gboolean gst_audio_sink_ring_buffer_release (GstAudioRingBuffer * buf);
118 static gboolean gst_audio_sink_ring_buffer_start (GstAudioRingBuffer * buf);
119 static gboolean gst_audio_sink_ring_buffer_pause (GstAudioRingBuffer * buf);
120 static gboolean gst_audio_sink_ring_buffer_resume (GstAudioRingBuffer * buf);
121 static gboolean gst_audio_sink_ring_buffer_stop (GstAudioRingBuffer * buf);
122 static guint gst_audio_sink_ring_buffer_delay (GstAudioRingBuffer * buf);
123 static gboolean gst_audio_sink_ring_buffer_activate (GstAudioRingBuffer * buf,
125 static void gst_audio_sink_ring_buffer_clear_all (GstAudioRingBuffer * buf);
127 /* ringbuffer abstract base class */
129 gst_audio_sink_ring_buffer_get_type (void)
131 static GType ringbuffer_type = 0;
133 if (!ringbuffer_type) {
134 static const GTypeInfo ringbuffer_info = {
135 sizeof (GstAudioSinkRingBufferClass),
138 (GClassInitFunc) gst_audio_sink_ring_buffer_class_init,
141 sizeof (GstAudioSinkRingBuffer),
143 (GInstanceInitFunc) gst_audio_sink_ring_buffer_init,
148 g_type_register_static (GST_TYPE_AUDIO_RING_BUFFER,
149 "GstAudioSinkRingBuffer", &ringbuffer_info, 0);
151 return ringbuffer_type;
155 gst_audio_sink_ring_buffer_class_init (GstAudioSinkRingBufferClass * klass)
157 GObjectClass *gobject_class;
158 GstAudioRingBufferClass *gstringbuffer_class;
160 gobject_class = (GObjectClass *) klass;
161 gstringbuffer_class = (GstAudioRingBufferClass *) klass;
163 ring_parent_class = g_type_class_peek_parent (klass);
165 gobject_class->dispose = gst_audio_sink_ring_buffer_dispose;
166 gobject_class->finalize = gst_audio_sink_ring_buffer_finalize;
168 gstringbuffer_class->open_device =
169 GST_DEBUG_FUNCPTR (gst_audio_sink_ring_buffer_open_device);
170 gstringbuffer_class->close_device =
171 GST_DEBUG_FUNCPTR (gst_audio_sink_ring_buffer_close_device);
172 gstringbuffer_class->acquire =
173 GST_DEBUG_FUNCPTR (gst_audio_sink_ring_buffer_acquire);
174 gstringbuffer_class->release =
175 GST_DEBUG_FUNCPTR (gst_audio_sink_ring_buffer_release);
176 gstringbuffer_class->start =
177 GST_DEBUG_FUNCPTR (gst_audio_sink_ring_buffer_start);
178 gstringbuffer_class->pause =
179 GST_DEBUG_FUNCPTR (gst_audio_sink_ring_buffer_pause);
180 gstringbuffer_class->resume =
181 GST_DEBUG_FUNCPTR (gst_audio_sink_ring_buffer_resume);
182 gstringbuffer_class->stop =
183 GST_DEBUG_FUNCPTR (gst_audio_sink_ring_buffer_stop);
184 gstringbuffer_class->delay =
185 GST_DEBUG_FUNCPTR (gst_audio_sink_ring_buffer_delay);
186 gstringbuffer_class->activate =
187 GST_DEBUG_FUNCPTR (gst_audio_sink_ring_buffer_activate);
188 gstringbuffer_class->clear_all =
189 GST_DEBUG_FUNCPTR (gst_audio_sink_ring_buffer_clear_all);
192 typedef gint (*WriteFunc) (GstAudioSink * sink, gpointer data, guint length);
194 /* this internal thread does nothing else but write samples to the audio device.
195 * It will write each segment in the ringbuffer and will update the play
197 * The start/stop methods control the thread.
200 audioringbuffer_thread_func (GstAudioRingBuffer * buf)
203 GstAudioSinkClass *csink;
204 GstAudioSinkRingBuffer *abuf = GST_AUDIO_SINK_RING_BUFFER_CAST (buf);
209 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
210 csink = GST_AUDIO_SINK_GET_CLASS (sink);
212 GST_DEBUG_OBJECT (sink, "enter thread");
214 GST_OBJECT_LOCK (abuf);
215 GST_DEBUG_OBJECT (sink, "signal wait");
216 GST_AUDIO_SINK_RING_BUFFER_SIGNAL (buf);
217 GST_OBJECT_UNLOCK (abuf);
219 writefunc = csink->write;
220 if (writefunc == NULL)
223 if (G_UNLIKELY (!__gst_audio_set_thread_priority ()))
224 GST_WARNING_OBJECT (sink, "failed to set thread priority");
226 message = gst_message_new_stream_status (GST_OBJECT_CAST (buf),
227 GST_STREAM_STATUS_TYPE_ENTER, GST_ELEMENT_CAST (sink));
228 g_value_init (&val, GST_TYPE_G_THREAD);
229 g_value_set_boxed (&val, g_thread_self ());
230 gst_message_set_stream_status_object (message, &val);
231 g_value_unset (&val);
232 GST_DEBUG_OBJECT (sink, "posting ENTER stream status");
233 gst_element_post_message (GST_ELEMENT_CAST (sink), message);
240 /* buffer must be started */
241 if (gst_audio_ring_buffer_prepare_read (buf, &readseg, &readptr, &len)) {
246 written = writefunc (sink, readptr, left);
247 GST_LOG_OBJECT (sink, "transferred %d bytes of %d from segment %d",
248 written, left, readseg);
249 if (written < 0 || written > left) {
250 /* might not be critical, it e.g. happens when aborting playback */
251 GST_WARNING_OBJECT (sink,
252 "error writing data in %s (reason: %s), skipping segment (left: %d, written: %d)",
253 GST_DEBUG_FUNCPTR_NAME (writefunc),
254 (errno > 1 ? g_strerror (errno) : "unknown"), left, written);
261 /* clear written samples */
262 gst_audio_ring_buffer_clear (buf, readseg);
264 /* we wrote one segment */
265 gst_audio_ring_buffer_advance (buf, 1);
267 GST_OBJECT_LOCK (abuf);
270 if (G_UNLIKELY (g_atomic_int_get (&buf->state) ==
271 GST_AUDIO_RING_BUFFER_STATE_STARTED)) {
272 GST_OBJECT_UNLOCK (abuf);
275 GST_DEBUG_OBJECT (sink, "signal wait");
276 GST_AUDIO_SINK_RING_BUFFER_SIGNAL (buf);
277 GST_DEBUG_OBJECT (sink, "wait for action");
278 GST_AUDIO_SINK_RING_BUFFER_WAIT (buf);
279 GST_DEBUG_OBJECT (sink, "got signal");
282 GST_DEBUG_OBJECT (sink, "continue running");
283 GST_OBJECT_UNLOCK (abuf);
287 /* Will never be reached */
288 g_assert_not_reached ();
294 GST_DEBUG_OBJECT (sink, "no write function, exit thread");
299 GST_OBJECT_UNLOCK (abuf);
300 GST_DEBUG_OBJECT (sink, "stop running, exit thread");
301 message = gst_message_new_stream_status (GST_OBJECT_CAST (buf),
302 GST_STREAM_STATUS_TYPE_LEAVE, GST_ELEMENT_CAST (sink));
303 g_value_init (&val, GST_TYPE_G_THREAD);
304 g_value_set_boxed (&val, g_thread_self ());
305 gst_message_set_stream_status_object (message, &val);
306 g_value_unset (&val);
307 GST_DEBUG_OBJECT (sink, "posting LEAVE stream status");
308 gst_element_post_message (GST_ELEMENT_CAST (sink), message);
314 gst_audio_sink_ring_buffer_init (GstAudioSinkRingBuffer * ringbuffer,
315 GstAudioSinkRingBufferClass * g_class)
317 ringbuffer->running = FALSE;
318 ringbuffer->queuedseg = 0;
320 g_cond_init (&ringbuffer->cond);
324 gst_audio_sink_ring_buffer_dispose (GObject * object)
326 G_OBJECT_CLASS (ring_parent_class)->dispose (object);
330 gst_audio_sink_ring_buffer_finalize (GObject * object)
332 GstAudioSinkRingBuffer *ringbuffer = GST_AUDIO_SINK_RING_BUFFER_CAST (object);
334 g_cond_clear (&ringbuffer->cond);
336 G_OBJECT_CLASS (ring_parent_class)->finalize (object);
340 gst_audio_sink_ring_buffer_open_device (GstAudioRingBuffer * buf)
343 GstAudioSinkClass *csink;
344 gboolean result = TRUE;
346 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
347 csink = GST_AUDIO_SINK_GET_CLASS (sink);
350 result = csink->open (sink);
359 GST_DEBUG_OBJECT (sink, "could not open device");
365 gst_audio_sink_ring_buffer_close_device (GstAudioRingBuffer * buf)
368 GstAudioSinkClass *csink;
369 gboolean result = TRUE;
371 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
372 csink = GST_AUDIO_SINK_GET_CLASS (sink);
375 result = csink->close (sink);
378 goto could_not_close;
384 GST_DEBUG_OBJECT (sink, "could not close device");
390 gst_audio_sink_ring_buffer_acquire (GstAudioRingBuffer * buf,
391 GstAudioRingBufferSpec * spec)
394 GstAudioSinkClass *csink;
395 gboolean result = FALSE;
397 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
398 csink = GST_AUDIO_SINK_GET_CLASS (sink);
401 result = csink->prepare (sink, spec);
403 goto could_not_prepare;
405 /* set latency to one more segment as we need some headroom */
406 spec->seglatency = spec->segtotal + 1;
408 buf->size = spec->segtotal * spec->segsize;
410 buf->memory = g_malloc (buf->size);
412 if (buf->spec.type == GST_AUDIO_RING_BUFFER_FORMAT_TYPE_RAW) {
413 gst_audio_format_fill_silence (buf->spec.info.finfo, buf->memory,
416 /* FIXME, non-raw formats get 0 as the empty sample */
417 memset (buf->memory, 0, buf->size);
426 GST_DEBUG_OBJECT (sink, "could not prepare device");
432 gst_audio_sink_ring_buffer_activate (GstAudioRingBuffer * buf, gboolean active)
435 GstAudioSinkRingBuffer *abuf;
436 GError *error = NULL;
438 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
439 abuf = GST_AUDIO_SINK_RING_BUFFER_CAST (buf);
442 abuf->running = TRUE;
444 GST_DEBUG_OBJECT (sink, "starting thread");
446 sink->thread = g_thread_try_new ("audiosink-ringbuffer",
447 (GThreadFunc) audioringbuffer_thread_func, buf, &error);
449 if (!sink->thread || error != NULL)
452 GST_DEBUG_OBJECT (sink, "waiting for thread");
453 /* the object lock is taken */
454 GST_AUDIO_SINK_RING_BUFFER_WAIT (buf);
455 GST_DEBUG_OBJECT (sink, "thread is started");
457 abuf->running = FALSE;
458 GST_DEBUG_OBJECT (sink, "signal wait");
459 GST_AUDIO_SINK_RING_BUFFER_SIGNAL (buf);
461 GST_OBJECT_UNLOCK (buf);
463 /* join the thread */
464 g_thread_join (sink->thread);
466 GST_OBJECT_LOCK (buf);
474 GST_ERROR_OBJECT (sink, "could not create thread %s", error->message);
476 GST_ERROR_OBJECT (sink, "could not create thread for unknown reason");
477 g_clear_error (&error);
482 /* function is called with LOCK */
484 gst_audio_sink_ring_buffer_release (GstAudioRingBuffer * buf)
487 GstAudioSinkClass *csink;
488 gboolean result = FALSE;
490 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
491 csink = GST_AUDIO_SINK_GET_CLASS (sink);
493 /* free the buffer */
494 g_free (buf->memory);
497 if (csink->unprepare)
498 result = csink->unprepare (sink);
501 goto could_not_unprepare;
503 GST_DEBUG_OBJECT (sink, "unprepared");
509 GST_DEBUG_OBJECT (sink, "could not unprepare device");
515 gst_audio_sink_ring_buffer_start (GstAudioRingBuffer * buf)
519 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
521 GST_DEBUG_OBJECT (sink, "start, sending signal");
522 GST_AUDIO_SINK_RING_BUFFER_SIGNAL (buf);
528 gst_audio_sink_ring_buffer_pause (GstAudioRingBuffer * buf)
531 GstAudioSinkClass *csink;
533 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
534 csink = GST_AUDIO_SINK_GET_CLASS (sink);
536 /* unblock any pending writes to the audio device */
538 GST_DEBUG_OBJECT (sink, "pause...");
540 GST_DEBUG_OBJECT (sink, "pause done");
541 } else if (csink->reset) {
542 /* fallback to reset for audio sinks that don't provide pause */
543 GST_DEBUG_OBJECT (sink, "reset...");
545 GST_DEBUG_OBJECT (sink, "reset done");
551 gst_audio_sink_ring_buffer_resume (GstAudioRingBuffer * buf)
554 GstAudioSinkClass *csink;
556 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
557 csink = GST_AUDIO_SINK_GET_CLASS (sink);
560 GST_DEBUG_OBJECT (sink, "resume...");
561 csink->resume (sink);
562 GST_DEBUG_OBJECT (sink, "resume done");
565 gst_audio_sink_ring_buffer_start (buf);
571 gst_audio_sink_ring_buffer_stop (GstAudioRingBuffer * buf)
574 GstAudioSinkClass *csink;
576 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
577 csink = GST_AUDIO_SINK_GET_CLASS (sink);
579 /* unblock any pending writes to the audio device */
581 GST_DEBUG_OBJECT (sink, "stop...");
583 GST_DEBUG_OBJECT (sink, "stop done");
584 } else if (csink->reset) {
585 /* fallback to reset for audio sinks that don't provide stop */
586 GST_DEBUG_OBJECT (sink, "reset...");
588 GST_DEBUG_OBJECT (sink, "reset done");
592 GST_DEBUG_OBJECT (sink, "stop, waiting...");
593 GST_AUDIO_SINK_RING_BUFFER_WAIT (buf);
594 GST_DEBUG_OBJECT (sink, "stopped");
602 gst_audio_sink_ring_buffer_delay (GstAudioRingBuffer * buf)
605 GstAudioSinkClass *csink;
608 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
609 csink = GST_AUDIO_SINK_GET_CLASS (sink);
612 res = csink->delay (sink);
618 gst_audio_sink_ring_buffer_clear_all (GstAudioRingBuffer * buf)
621 GstAudioSinkClass *csink;
623 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
624 csink = GST_AUDIO_SINK_GET_CLASS (sink);
626 if (csink->extension->clear_all) {
627 GST_DEBUG_OBJECT (sink, "clear all");
628 csink->extension->clear_all (sink);
631 /* chain up to the parent implementation */
632 ring_parent_class->clear_all (buf);
635 /* AudioSink signals and args */
648 GST_DEBUG_CATEGORY_INIT (gst_audio_sink_debug, "audiosink", 0, "audiosink element"); \
649 g_type_add_class_private (g_define_type_id, \
650 sizeof (GstAudioSinkClassExtension));
651 #define gst_audio_sink_parent_class parent_class
652 G_DEFINE_TYPE_WITH_CODE (GstAudioSink, gst_audio_sink,
653 GST_TYPE_AUDIO_BASE_SINK, _do_init);
655 static GstAudioRingBuffer *gst_audio_sink_create_ringbuffer (GstAudioBaseSink *
659 gst_audio_sink_class_init (GstAudioSinkClass * klass)
661 GstAudioBaseSinkClass *gstaudiobasesink_class;
663 gstaudiobasesink_class = (GstAudioBaseSinkClass *) klass;
665 gstaudiobasesink_class->create_ringbuffer =
666 GST_DEBUG_FUNCPTR (gst_audio_sink_create_ringbuffer);
668 g_type_class_ref (GST_TYPE_AUDIO_SINK_RING_BUFFER);
670 klass->extension = G_TYPE_CLASS_GET_PRIVATE (klass,
671 GST_TYPE_AUDIO_SINK, GstAudioSinkClassExtension);
675 gst_audio_sink_init (GstAudioSink * audiosink)
679 static GstAudioRingBuffer *
680 gst_audio_sink_create_ringbuffer (GstAudioBaseSink * sink)
682 GstAudioRingBuffer *buffer;
684 GST_DEBUG_OBJECT (sink, "creating ringbuffer");
685 buffer = g_object_new (GST_TYPE_AUDIO_SINK_RING_BUFFER, NULL);
686 GST_DEBUG_OBJECT (sink, "created ringbuffer @%p", buffer);