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);
210 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
211 csink = GST_AUDIO_SINK_GET_CLASS (sink);
213 GST_DEBUG_OBJECT (sink, "enter thread");
215 GST_OBJECT_LOCK (abuf);
216 GST_DEBUG_OBJECT (sink, "signal wait");
217 GST_AUDIO_SINK_RING_BUFFER_SIGNAL (buf);
218 GST_OBJECT_UNLOCK (abuf);
220 writefunc = csink->write;
221 if (writefunc == NULL)
224 if (G_UNLIKELY (!__gst_audio_set_thread_priority (&handle)))
225 GST_WARNING_OBJECT (sink, "failed to set thread priority");
227 message = gst_message_new_stream_status (GST_OBJECT_CAST (buf),
228 GST_STREAM_STATUS_TYPE_ENTER, GST_ELEMENT_CAST (sink));
229 g_value_init (&val, GST_TYPE_G_THREAD);
230 g_value_set_boxed (&val, g_thread_self ());
231 gst_message_set_stream_status_object (message, &val);
232 g_value_unset (&val);
233 GST_DEBUG_OBJECT (sink, "posting ENTER stream status");
234 gst_element_post_message (GST_ELEMENT_CAST (sink), message);
241 /* buffer must be started */
242 if (gst_audio_ring_buffer_prepare_read (buf, &readseg, &readptr, &len)) {
247 written = writefunc (sink, readptr, left);
248 GST_LOG_OBJECT (sink, "transferred %d bytes of %d from segment %d",
249 written, left, readseg);
250 if (written < 0 || written > left) {
251 /* might not be critical, it e.g. happens when aborting playback */
252 GST_WARNING_OBJECT (sink,
253 "error writing data in %s (reason: %s), skipping segment (left: %d, written: %d)",
254 GST_DEBUG_FUNCPTR_NAME (writefunc),
255 (errno > 1 ? g_strerror (errno) : "unknown"), left, written);
262 /* clear written samples */
263 gst_audio_ring_buffer_clear (buf, readseg);
265 /* we wrote one segment */
266 gst_audio_ring_buffer_advance (buf, 1);
268 GST_OBJECT_LOCK (abuf);
271 if (G_UNLIKELY (g_atomic_int_get (&buf->state) ==
272 GST_AUDIO_RING_BUFFER_STATE_STARTED)) {
273 GST_OBJECT_UNLOCK (abuf);
276 GST_DEBUG_OBJECT (sink, "signal wait");
277 GST_AUDIO_SINK_RING_BUFFER_SIGNAL (buf);
278 GST_DEBUG_OBJECT (sink, "wait for action");
279 GST_AUDIO_SINK_RING_BUFFER_WAIT (buf);
280 GST_DEBUG_OBJECT (sink, "got signal");
283 GST_DEBUG_OBJECT (sink, "continue running");
284 GST_OBJECT_UNLOCK (abuf);
288 /* Will never be reached */
289 g_assert_not_reached ();
295 GST_DEBUG_OBJECT (sink, "no write function, exit thread");
300 GST_OBJECT_UNLOCK (abuf);
301 GST_DEBUG_OBJECT (sink, "stop running, exit thread");
302 message = gst_message_new_stream_status (GST_OBJECT_CAST (buf),
303 GST_STREAM_STATUS_TYPE_LEAVE, GST_ELEMENT_CAST (sink));
304 g_value_init (&val, GST_TYPE_G_THREAD);
305 g_value_set_boxed (&val, g_thread_self ());
306 gst_message_set_stream_status_object (message, &val);
307 g_value_unset (&val);
308 GST_DEBUG_OBJECT (sink, "posting LEAVE stream status");
309 gst_element_post_message (GST_ELEMENT_CAST (sink), message);
311 if (G_UNLIKELY (!__gst_audio_restore_thread_priority (handle)))
312 GST_WARNING_OBJECT (sink, "failed to restore thread priority");
318 gst_audio_sink_ring_buffer_init (GstAudioSinkRingBuffer * ringbuffer,
319 GstAudioSinkRingBufferClass * g_class)
321 ringbuffer->running = FALSE;
322 ringbuffer->queuedseg = 0;
324 g_cond_init (&ringbuffer->cond);
328 gst_audio_sink_ring_buffer_dispose (GObject * object)
330 G_OBJECT_CLASS (ring_parent_class)->dispose (object);
334 gst_audio_sink_ring_buffer_finalize (GObject * object)
336 GstAudioSinkRingBuffer *ringbuffer = GST_AUDIO_SINK_RING_BUFFER_CAST (object);
338 g_cond_clear (&ringbuffer->cond);
340 G_OBJECT_CLASS (ring_parent_class)->finalize (object);
344 gst_audio_sink_ring_buffer_open_device (GstAudioRingBuffer * buf)
347 GstAudioSinkClass *csink;
348 gboolean result = TRUE;
350 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
351 csink = GST_AUDIO_SINK_GET_CLASS (sink);
354 result = csink->open (sink);
363 GST_DEBUG_OBJECT (sink, "could not open device");
369 gst_audio_sink_ring_buffer_close_device (GstAudioRingBuffer * buf)
372 GstAudioSinkClass *csink;
373 gboolean result = TRUE;
375 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
376 csink = GST_AUDIO_SINK_GET_CLASS (sink);
379 result = csink->close (sink);
382 goto could_not_close;
388 GST_DEBUG_OBJECT (sink, "could not close device");
394 gst_audio_sink_ring_buffer_acquire (GstAudioRingBuffer * buf,
395 GstAudioRingBufferSpec * spec)
398 GstAudioSinkClass *csink;
399 gboolean result = FALSE;
401 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
402 csink = GST_AUDIO_SINK_GET_CLASS (sink);
405 result = csink->prepare (sink, spec);
407 goto could_not_prepare;
409 /* set latency to one more segment as we need some headroom */
410 spec->seglatency = spec->segtotal + 1;
412 buf->size = spec->segtotal * spec->segsize;
414 buf->memory = g_malloc (buf->size);
416 if (buf->spec.type == GST_AUDIO_RING_BUFFER_FORMAT_TYPE_RAW) {
417 gst_audio_format_fill_silence (buf->spec.info.finfo, buf->memory,
420 /* FIXME, non-raw formats get 0 as the empty sample */
421 memset (buf->memory, 0, buf->size);
430 GST_DEBUG_OBJECT (sink, "could not prepare device");
436 gst_audio_sink_ring_buffer_activate (GstAudioRingBuffer * buf, gboolean active)
439 GstAudioSinkRingBuffer *abuf;
440 GError *error = NULL;
442 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
443 abuf = GST_AUDIO_SINK_RING_BUFFER_CAST (buf);
446 abuf->running = TRUE;
448 GST_DEBUG_OBJECT (sink, "starting thread");
450 sink->thread = g_thread_try_new ("audiosink-ringbuffer",
451 (GThreadFunc) audioringbuffer_thread_func, buf, &error);
453 if (!sink->thread || error != NULL)
456 GST_DEBUG_OBJECT (sink, "waiting for thread");
457 /* the object lock is taken */
458 GST_AUDIO_SINK_RING_BUFFER_WAIT (buf);
459 GST_DEBUG_OBJECT (sink, "thread is started");
461 abuf->running = FALSE;
462 GST_DEBUG_OBJECT (sink, "signal wait");
463 GST_AUDIO_SINK_RING_BUFFER_SIGNAL (buf);
465 GST_OBJECT_UNLOCK (buf);
467 /* join the thread */
468 g_thread_join (sink->thread);
470 GST_OBJECT_LOCK (buf);
478 GST_ERROR_OBJECT (sink, "could not create thread %s", error->message);
480 GST_ERROR_OBJECT (sink, "could not create thread for unknown reason");
481 g_clear_error (&error);
486 /* function is called with LOCK */
488 gst_audio_sink_ring_buffer_release (GstAudioRingBuffer * buf)
491 GstAudioSinkClass *csink;
492 gboolean result = FALSE;
494 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
495 csink = GST_AUDIO_SINK_GET_CLASS (sink);
497 /* free the buffer */
498 g_free (buf->memory);
501 if (csink->unprepare)
502 result = csink->unprepare (sink);
505 goto could_not_unprepare;
507 GST_DEBUG_OBJECT (sink, "unprepared");
513 GST_DEBUG_OBJECT (sink, "could not unprepare device");
519 gst_audio_sink_ring_buffer_start (GstAudioRingBuffer * buf)
523 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
525 GST_DEBUG_OBJECT (sink, "start, sending signal");
526 GST_AUDIO_SINK_RING_BUFFER_SIGNAL (buf);
532 gst_audio_sink_ring_buffer_pause (GstAudioRingBuffer * buf)
535 GstAudioSinkClass *csink;
537 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
538 csink = GST_AUDIO_SINK_GET_CLASS (sink);
540 /* unblock any pending writes to the audio device */
542 GST_DEBUG_OBJECT (sink, "pause...");
544 GST_DEBUG_OBJECT (sink, "pause done");
545 } else if (csink->reset) {
546 /* fallback to reset for audio sinks that don't provide pause */
547 GST_DEBUG_OBJECT (sink, "reset...");
549 GST_DEBUG_OBJECT (sink, "reset done");
555 gst_audio_sink_ring_buffer_resume (GstAudioRingBuffer * buf)
558 GstAudioSinkClass *csink;
560 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
561 csink = GST_AUDIO_SINK_GET_CLASS (sink);
564 GST_DEBUG_OBJECT (sink, "resume...");
565 csink->resume (sink);
566 GST_DEBUG_OBJECT (sink, "resume done");
569 gst_audio_sink_ring_buffer_start (buf);
575 gst_audio_sink_ring_buffer_stop (GstAudioRingBuffer * buf)
578 GstAudioSinkClass *csink;
580 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
581 csink = GST_AUDIO_SINK_GET_CLASS (sink);
583 /* unblock any pending writes to the audio device */
585 GST_DEBUG_OBJECT (sink, "stop...");
587 GST_DEBUG_OBJECT (sink, "stop done");
588 } else if (csink->reset) {
589 /* fallback to reset for audio sinks that don't provide stop */
590 GST_DEBUG_OBJECT (sink, "reset...");
592 GST_DEBUG_OBJECT (sink, "reset done");
596 GST_DEBUG_OBJECT (sink, "stop, waiting...");
597 GST_AUDIO_SINK_RING_BUFFER_WAIT (buf);
598 GST_DEBUG_OBJECT (sink, "stopped");
606 gst_audio_sink_ring_buffer_delay (GstAudioRingBuffer * buf)
609 GstAudioSinkClass *csink;
612 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
613 csink = GST_AUDIO_SINK_GET_CLASS (sink);
616 res = csink->delay (sink);
622 gst_audio_sink_ring_buffer_clear_all (GstAudioRingBuffer * buf)
625 GstAudioSinkClass *csink;
627 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
628 csink = GST_AUDIO_SINK_GET_CLASS (sink);
630 if (csink->extension->clear_all) {
631 GST_DEBUG_OBJECT (sink, "clear all");
632 csink->extension->clear_all (sink);
635 /* chain up to the parent implementation */
636 ring_parent_class->clear_all (buf);
639 /* AudioSink signals and args */
652 GST_DEBUG_CATEGORY_INIT (gst_audio_sink_debug, "audiosink", 0, "audiosink element"); \
653 g_type_add_class_private (g_define_type_id, \
654 sizeof (GstAudioSinkClassExtension));
655 #define gst_audio_sink_parent_class parent_class
656 G_DEFINE_TYPE_WITH_CODE (GstAudioSink, gst_audio_sink,
657 GST_TYPE_AUDIO_BASE_SINK, _do_init);
659 static GstAudioRingBuffer *gst_audio_sink_create_ringbuffer (GstAudioBaseSink *
663 gst_audio_sink_class_init (GstAudioSinkClass * klass)
665 GstAudioBaseSinkClass *gstaudiobasesink_class;
667 gstaudiobasesink_class = (GstAudioBaseSinkClass *) klass;
669 gstaudiobasesink_class->create_ringbuffer =
670 GST_DEBUG_FUNCPTR (gst_audio_sink_create_ringbuffer);
672 g_type_class_ref (GST_TYPE_AUDIO_SINK_RING_BUFFER);
674 klass->extension = G_TYPE_CLASS_GET_PRIVATE (klass,
675 GST_TYPE_AUDIO_SINK, GstAudioSinkClassExtension);
679 gst_audio_sink_init (GstAudioSink * audiosink)
683 static GstAudioRingBuffer *
684 gst_audio_sink_create_ringbuffer (GstAudioBaseSink * sink)
686 GstAudioRingBuffer *buffer;
688 GST_DEBUG_OBJECT (sink, "creating ringbuffer");
689 buffer = g_object_new (GST_TYPE_AUDIO_SINK_RING_BUFFER, NULL);
690 GST_DEBUG_OBJECT (sink, "created ringbuffer @%p", buffer);