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 * @short_description: Simple base class for audio sinks
26 * @see_also: #GstAudioBaseSink, #GstAudioRingBuffer, #GstAudioSink.
28 * This is the most simple base class for audio sinks that only requires
29 * subclasses to implement a set of simple functions:
34 * <listitem><para>Open the device.</para></listitem>
37 * <term>prepare()</term>
38 * <listitem><para>Configure the device with the specified format.</para></listitem>
41 * <term>write()</term>
42 * <listitem><para>Write samples to the device.</para></listitem>
45 * <term>reset()</term>
46 * <listitem><para>Unblock writes and flush the device.</para></listitem>
49 * <term>delay()</term>
50 * <listitem><para>Get the number of samples written but not yet played
51 * by the device.</para></listitem>
54 * <term>unprepare()</term>
55 * <listitem><para>Undo operations done by prepare.</para></listitem>
58 * <term>close()</term>
59 * <listitem><para>Close the device.</para></listitem>
63 * All scheduling of samples and timestamps is done in this base class
64 * together with #GstAudioBaseSink using a default implementation of a
65 * #GstAudioRingBuffer that uses threads.
67 * Last reviewed on 2006-09-27 (0.10.12)
72 #include "gstaudiosink.h"
74 GST_DEBUG_CATEGORY_STATIC (gst_audio_sink_debug);
75 #define GST_CAT_DEFAULT gst_audio_sink_debug
77 #define GST_TYPE_AUDIO_SINK_RING_BUFFER \
78 (gst_audio_sink_ring_buffer_get_type())
79 #define GST_AUDIO_SINK_RING_BUFFER(obj) \
80 (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_AUDIO_SINK_RING_BUFFER,GstAudioSinkRingBuffer))
81 #define GST_AUDIO_SINK_RING_BUFFER_CLASS(klass) \
82 (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_AUDIO_SINK_RING_BUFFER,GstAudioSinkRingBufferClass))
83 #define GST_AUDIO_SINK_RING_BUFFER_GET_CLASS(obj) \
84 (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_AUDIO_SINK_RING_BUFFER, GstAudioSinkRingBufferClass))
85 #define GST_AUDIO_SINK_RING_BUFFER_CAST(obj) \
86 ((GstAudioSinkRingBuffer *)obj)
87 #define GST_IS_AUDIO_SINK_RING_BUFFER(obj) \
88 (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_AUDIO_SINK_RING_BUFFER))
89 #define GST_IS_AUDIO_SINK_RING_BUFFER_CLASS(klass)\
90 (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_AUDIO_SINK_RING_BUFFER))
92 typedef struct _GstAudioSinkRingBuffer GstAudioSinkRingBuffer;
93 typedef struct _GstAudioSinkRingBufferClass GstAudioSinkRingBufferClass;
95 #define GST_AUDIO_SINK_RING_BUFFER_GET_COND(buf) (&(((GstAudioSinkRingBuffer *)buf)->cond))
96 #define GST_AUDIO_SINK_RING_BUFFER_WAIT(buf) (g_cond_wait (GST_AUDIO_SINK_RING_BUFFER_GET_COND (buf), GST_OBJECT_GET_LOCK (buf)))
97 #define GST_AUDIO_SINK_RING_BUFFER_SIGNAL(buf) (g_cond_signal (GST_AUDIO_SINK_RING_BUFFER_GET_COND (buf)))
98 #define GST_AUDIO_SINK_RING_BUFFER_BROADCAST(buf)(g_cond_broadcast (GST_AUDIO_SINK_RING_BUFFER_GET_COND (buf)))
100 struct _GstAudioSinkRingBuffer
102 GstAudioRingBuffer object;
110 struct _GstAudioSinkRingBufferClass
112 GstAudioRingBufferClass parent_class;
115 static void gst_audio_sink_ring_buffer_class_init (GstAudioSinkRingBufferClass *
117 static void gst_audio_sink_ring_buffer_init (GstAudioSinkRingBuffer *
118 ringbuffer, GstAudioSinkRingBufferClass * klass);
119 static void gst_audio_sink_ring_buffer_dispose (GObject * object);
120 static void gst_audio_sink_ring_buffer_finalize (GObject * object);
122 static GstAudioRingBufferClass *ring_parent_class = NULL;
124 static gboolean gst_audio_sink_ring_buffer_open_device (GstAudioRingBuffer *
126 static gboolean gst_audio_sink_ring_buffer_close_device (GstAudioRingBuffer *
128 static gboolean gst_audio_sink_ring_buffer_acquire (GstAudioRingBuffer * buf,
129 GstAudioRingBufferSpec * spec);
130 static gboolean gst_audio_sink_ring_buffer_release (GstAudioRingBuffer * buf);
131 static gboolean gst_audio_sink_ring_buffer_start (GstAudioRingBuffer * buf);
132 static gboolean gst_audio_sink_ring_buffer_pause (GstAudioRingBuffer * buf);
133 static gboolean gst_audio_sink_ring_buffer_stop (GstAudioRingBuffer * buf);
134 static guint gst_audio_sink_ring_buffer_delay (GstAudioRingBuffer * buf);
135 static gboolean gst_audio_sink_ring_buffer_activate (GstAudioRingBuffer * buf,
138 /* ringbuffer abstract base class */
140 gst_audio_sink_ring_buffer_get_type (void)
142 static GType ringbuffer_type = 0;
144 if (!ringbuffer_type) {
145 static const GTypeInfo ringbuffer_info = {
146 sizeof (GstAudioSinkRingBufferClass),
149 (GClassInitFunc) gst_audio_sink_ring_buffer_class_init,
152 sizeof (GstAudioSinkRingBuffer),
154 (GInstanceInitFunc) gst_audio_sink_ring_buffer_init,
159 g_type_register_static (GST_TYPE_AUDIO_RING_BUFFER,
160 "GstAudioSinkRingBuffer", &ringbuffer_info, 0);
162 return ringbuffer_type;
166 gst_audio_sink_ring_buffer_class_init (GstAudioSinkRingBufferClass * klass)
168 GObjectClass *gobject_class;
169 GstAudioRingBufferClass *gstringbuffer_class;
171 gobject_class = (GObjectClass *) klass;
172 gstringbuffer_class = (GstAudioRingBufferClass *) klass;
174 ring_parent_class = g_type_class_peek_parent (klass);
176 gobject_class->dispose = gst_audio_sink_ring_buffer_dispose;
177 gobject_class->finalize = gst_audio_sink_ring_buffer_finalize;
179 gstringbuffer_class->open_device =
180 GST_DEBUG_FUNCPTR (gst_audio_sink_ring_buffer_open_device);
181 gstringbuffer_class->close_device =
182 GST_DEBUG_FUNCPTR (gst_audio_sink_ring_buffer_close_device);
183 gstringbuffer_class->acquire =
184 GST_DEBUG_FUNCPTR (gst_audio_sink_ring_buffer_acquire);
185 gstringbuffer_class->release =
186 GST_DEBUG_FUNCPTR (gst_audio_sink_ring_buffer_release);
187 gstringbuffer_class->start =
188 GST_DEBUG_FUNCPTR (gst_audio_sink_ring_buffer_start);
189 gstringbuffer_class->pause =
190 GST_DEBUG_FUNCPTR (gst_audio_sink_ring_buffer_pause);
191 gstringbuffer_class->resume =
192 GST_DEBUG_FUNCPTR (gst_audio_sink_ring_buffer_start);
193 gstringbuffer_class->stop =
194 GST_DEBUG_FUNCPTR (gst_audio_sink_ring_buffer_stop);
196 gstringbuffer_class->delay =
197 GST_DEBUG_FUNCPTR (gst_audio_sink_ring_buffer_delay);
198 gstringbuffer_class->activate =
199 GST_DEBUG_FUNCPTR (gst_audio_sink_ring_buffer_activate);
202 typedef gint (*WriteFunc) (GstAudioSink * sink, gpointer data, guint length);
204 /* this internal thread does nothing else but write samples to the audio device.
205 * It will write each segment in the ringbuffer and will update the play
207 * The start/stop methods control the thread.
210 audioringbuffer_thread_func (GstAudioRingBuffer * buf)
213 GstAudioSinkClass *csink;
214 GstAudioSinkRingBuffer *abuf = GST_AUDIO_SINK_RING_BUFFER_CAST (buf);
219 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
220 csink = GST_AUDIO_SINK_GET_CLASS (sink);
222 GST_DEBUG_OBJECT (sink, "enter thread");
224 GST_OBJECT_LOCK (abuf);
225 GST_DEBUG_OBJECT (sink, "signal wait");
226 GST_AUDIO_SINK_RING_BUFFER_SIGNAL (buf);
227 GST_OBJECT_UNLOCK (abuf);
229 writefunc = csink->write;
230 if (writefunc == NULL)
233 message = gst_message_new_stream_status (GST_OBJECT_CAST (buf),
234 GST_STREAM_STATUS_TYPE_ENTER, GST_ELEMENT_CAST (sink));
235 g_value_init (&val, GST_TYPE_G_THREAD);
236 g_value_set_boxed (&val, sink->thread);
237 gst_message_set_stream_status_object (message, &val);
238 g_value_unset (&val);
239 GST_DEBUG_OBJECT (sink, "posting ENTER stream status");
240 gst_element_post_message (GST_ELEMENT_CAST (sink), message);
247 /* buffer must be started */
248 if (gst_audio_ring_buffer_prepare_read (buf, &readseg, &readptr, &len)) {
253 written = writefunc (sink, readptr, left);
254 GST_LOG_OBJECT (sink, "transfered %d bytes of %d from segment %d",
255 written, left, readseg);
256 if (written < 0 || written > left) {
257 /* might not be critical, it e.g. happens when aborting playback */
258 GST_WARNING_OBJECT (sink,
259 "error writing data in %s (reason: %s), skipping segment (left: %d, written: %d)",
260 GST_DEBUG_FUNCPTR_NAME (writefunc),
261 (errno > 1 ? g_strerror (errno) : "unknown"), left, written);
268 /* clear written samples */
269 gst_audio_ring_buffer_clear (buf, readseg);
271 /* we wrote one segment */
272 gst_audio_ring_buffer_advance (buf, 1);
274 GST_OBJECT_LOCK (abuf);
277 if (G_UNLIKELY (g_atomic_int_get (&buf->state) ==
278 GST_AUDIO_RING_BUFFER_STATE_STARTED)) {
279 GST_OBJECT_UNLOCK (abuf);
282 GST_DEBUG_OBJECT (sink, "signal wait");
283 GST_AUDIO_SINK_RING_BUFFER_SIGNAL (buf);
284 GST_DEBUG_OBJECT (sink, "wait for action");
285 GST_AUDIO_SINK_RING_BUFFER_WAIT (buf);
286 GST_DEBUG_OBJECT (sink, "got signal");
289 GST_DEBUG_OBJECT (sink, "continue running");
290 GST_OBJECT_UNLOCK (abuf);
294 /* Will never be reached */
295 g_assert_not_reached ();
301 GST_DEBUG_OBJECT (sink, "no write function, exit thread");
306 GST_OBJECT_UNLOCK (abuf);
307 GST_DEBUG_OBJECT (sink, "stop running, exit thread");
308 message = gst_message_new_stream_status (GST_OBJECT_CAST (buf),
309 GST_STREAM_STATUS_TYPE_LEAVE, GST_ELEMENT_CAST (sink));
310 g_value_init (&val, GST_TYPE_G_THREAD);
311 g_value_set_boxed (&val, sink->thread);
312 gst_message_set_stream_status_object (message, &val);
313 g_value_unset (&val);
314 GST_DEBUG_OBJECT (sink, "posting LEAVE stream status");
315 gst_element_post_message (GST_ELEMENT_CAST (sink), message);
321 gst_audio_sink_ring_buffer_init (GstAudioSinkRingBuffer * ringbuffer,
322 GstAudioSinkRingBufferClass * g_class)
324 ringbuffer->running = FALSE;
325 ringbuffer->queuedseg = 0;
327 g_cond_init (&ringbuffer->cond);
331 gst_audio_sink_ring_buffer_dispose (GObject * object)
333 G_OBJECT_CLASS (ring_parent_class)->dispose (object);
337 gst_audio_sink_ring_buffer_finalize (GObject * object)
339 GstAudioSinkRingBuffer *ringbuffer = GST_AUDIO_SINK_RING_BUFFER_CAST (object);
341 g_cond_clear (&ringbuffer->cond);
343 G_OBJECT_CLASS (ring_parent_class)->finalize (object);
347 gst_audio_sink_ring_buffer_open_device (GstAudioRingBuffer * buf)
350 GstAudioSinkClass *csink;
351 gboolean result = TRUE;
353 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
354 csink = GST_AUDIO_SINK_GET_CLASS (sink);
357 result = csink->open (sink);
366 GST_DEBUG_OBJECT (sink, "could not open device");
372 gst_audio_sink_ring_buffer_close_device (GstAudioRingBuffer * buf)
375 GstAudioSinkClass *csink;
376 gboolean result = TRUE;
378 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
379 csink = GST_AUDIO_SINK_GET_CLASS (sink);
382 result = csink->close (sink);
385 goto could_not_close;
391 GST_DEBUG_OBJECT (sink, "could not close device");
397 gst_audio_sink_ring_buffer_acquire (GstAudioRingBuffer * buf,
398 GstAudioRingBufferSpec * spec)
401 GstAudioSinkClass *csink;
402 gboolean result = FALSE;
404 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
405 csink = GST_AUDIO_SINK_GET_CLASS (sink);
408 result = csink->prepare (sink, spec);
410 goto could_not_prepare;
412 /* set latency to one more segment as we need some headroom */
413 spec->seglatency = spec->segtotal + 1;
415 buf->size = spec->segtotal * spec->segsize;
416 buf->memory = g_malloc0 (buf->size);
423 GST_DEBUG_OBJECT (sink, "could not prepare device");
429 gst_audio_sink_ring_buffer_activate (GstAudioRingBuffer * buf, gboolean active)
432 GstAudioSinkRingBuffer *abuf;
433 GError *error = NULL;
435 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
436 abuf = GST_AUDIO_SINK_RING_BUFFER_CAST (buf);
439 abuf->running = TRUE;
441 GST_DEBUG_OBJECT (sink, "starting thread");
443 sink->thread = g_thread_try_new ("audiosink-ringbuffer",
444 (GThreadFunc) audioringbuffer_thread_func, buf, &error);
446 if (!sink->thread || error != NULL)
449 GST_DEBUG_OBJECT (sink, "waiting for thread");
450 /* the object lock is taken */
451 GST_AUDIO_SINK_RING_BUFFER_WAIT (buf);
452 GST_DEBUG_OBJECT (sink, "thread is started");
454 abuf->running = FALSE;
455 GST_DEBUG_OBJECT (sink, "signal wait");
456 GST_AUDIO_SINK_RING_BUFFER_SIGNAL (buf);
458 GST_OBJECT_UNLOCK (buf);
460 /* join the thread */
461 g_thread_join (sink->thread);
463 GST_OBJECT_LOCK (buf);
471 GST_ERROR_OBJECT (sink, "could not create thread %s", error->message);
473 GST_ERROR_OBJECT (sink, "could not create thread for unknown reason");
478 /* function is called with LOCK */
480 gst_audio_sink_ring_buffer_release (GstAudioRingBuffer * buf)
483 GstAudioSinkClass *csink;
484 gboolean result = FALSE;
486 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
487 csink = GST_AUDIO_SINK_GET_CLASS (sink);
489 /* free the buffer */
490 g_free (buf->memory);
493 if (csink->unprepare)
494 result = csink->unprepare (sink);
497 goto could_not_unprepare;
499 GST_DEBUG_OBJECT (sink, "unprepared");
505 GST_DEBUG_OBJECT (sink, "could not unprepare device");
511 gst_audio_sink_ring_buffer_start (GstAudioRingBuffer * buf)
515 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
517 GST_DEBUG_OBJECT (sink, "start, sending signal");
518 GST_AUDIO_SINK_RING_BUFFER_SIGNAL (buf);
524 gst_audio_sink_ring_buffer_pause (GstAudioRingBuffer * buf)
527 GstAudioSinkClass *csink;
529 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
530 csink = GST_AUDIO_SINK_GET_CLASS (sink);
532 /* unblock any pending writes to the audio device */
534 GST_DEBUG_OBJECT (sink, "reset...");
536 GST_DEBUG_OBJECT (sink, "reset done");
543 gst_audio_sink_ring_buffer_stop (GstAudioRingBuffer * buf)
546 GstAudioSinkClass *csink;
548 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
549 csink = GST_AUDIO_SINK_GET_CLASS (sink);
551 /* unblock any pending writes to the audio device */
553 GST_DEBUG_OBJECT (sink, "reset...");
555 GST_DEBUG_OBJECT (sink, "reset done");
559 GST_DEBUG_OBJECT (sink, "stop, waiting...");
560 GST_AUDIO_SINK_RING_BUFFER_WAIT (buf);
561 GST_DEBUG_OBJECT (sink, "stopped");
569 gst_audio_sink_ring_buffer_delay (GstAudioRingBuffer * buf)
572 GstAudioSinkClass *csink;
575 sink = GST_AUDIO_SINK (GST_OBJECT_PARENT (buf));
576 csink = GST_AUDIO_SINK_GET_CLASS (sink);
579 res = csink->delay (sink);
584 /* AudioSink signals and args */
597 GST_DEBUG_CATEGORY_INIT (gst_audio_sink_debug, "audiosink", 0, "audiosink element");
598 #define gst_audio_sink_parent_class parent_class
599 G_DEFINE_TYPE_WITH_CODE (GstAudioSink, gst_audio_sink,
600 GST_TYPE_AUDIO_BASE_SINK, _do_init);
602 static GstAudioRingBuffer *gst_audio_sink_create_ringbuffer (GstAudioBaseSink *
606 gst_audio_sink_class_init (GstAudioSinkClass * klass)
608 GstAudioBaseSinkClass *gstaudiobasesink_class;
610 gstaudiobasesink_class = (GstAudioBaseSinkClass *) klass;
612 gstaudiobasesink_class->create_ringbuffer =
613 GST_DEBUG_FUNCPTR (gst_audio_sink_create_ringbuffer);
615 g_type_class_ref (GST_TYPE_AUDIO_SINK_RING_BUFFER);
619 gst_audio_sink_init (GstAudioSink * audiosink)
623 static GstAudioRingBuffer *
624 gst_audio_sink_create_ringbuffer (GstAudioBaseSink * sink)
626 GstAudioRingBuffer *buffer;
628 GST_DEBUG_OBJECT (sink, "creating ringbuffer");
629 buffer = g_object_new (GST_TYPE_AUDIO_SINK_RING_BUFFER, NULL);
630 GST_DEBUG_OBJECT (sink, "created ringbuffer @%p", buffer);