2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2005 Wim Taymans <wim@fluendo.com>
5 * gstaudiosrc.c: simple audio src 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., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
25 * @short_description: Simple base class for audio sources
26 * @see_also: #GstAudioBaseSrc, #GstAudioRingBuffer, #GstAudioSrc.
28 * This is the most simple base class for audio sources 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>
42 * <listitem><para>Read samples from the device.</para></listitem>
45 * <term>reset()</term>
46 * <listitem><para>Unblock reads and flush the device.</para></listitem>
49 * <term>delay()</term>
50 * <listitem><para>Get the number of samples in the device but not yet read.
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 #GstAudioBaseSrc using a default implementation of a
65 * #GstAudioRingBuffer that uses threads.
67 * Last reviewed on 2006-09-27 (0.10.12)
72 #include "gstaudiosrc.h"
74 #include "gst/glib-compat-private.h"
76 GST_DEBUG_CATEGORY_STATIC (gst_audio_src_debug);
77 #define GST_CAT_DEFAULT gst_audio_src_debug
79 #define GST_TYPE_AUDIO_SRC_RING_BUFFER \
80 (gst_audio_src_ring_buffer_get_type())
81 #define GST_AUDIO_SRC_RING_BUFFER(obj) \
82 (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_AUDIO_SRC_RING_BUFFER,GstAudioSrcRingBuffer))
83 #define GST_AUDIO_SRC_RING_BUFFER_CLASS(klass) \
84 (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_AUDIO_SRC_RING_BUFFER,GstAudioSrcRingBufferClass))
85 #define GST_AUDIO_SRC_RING_BUFFER_GET_CLASS(obj) \
86 (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_AUDIO_SRC_RING_BUFFER, GstAudioSrcRingBufferClass))
87 #define GST_IS_AUDIO_SRC_RING_BUFFER(obj) \
88 (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_AUDIO_SRC_RING_BUFFER))
89 #define GST_IS_AUDIO_SRC_RING_BUFFER_CLASS(klass)\
90 (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_AUDIO_SRC_RING_BUFFER))
92 typedef struct _GstAudioSrcRingBuffer GstAudioSrcRingBuffer;
93 typedef struct _GstAudioSrcRingBufferClass GstAudioSrcRingBufferClass;
95 #define GST_AUDIO_SRC_RING_BUFFER_GET_COND(buf) (((GstAudioSrcRingBuffer *)buf)->cond)
96 #define GST_AUDIO_SRC_RING_BUFFER_WAIT(buf) (g_cond_wait (GST_AUDIO_SRC_RING_BUFFER_GET_COND (buf), GST_OBJECT_GET_LOCK (buf)))
97 #define GST_AUDIO_SRC_RING_BUFFER_SIGNAL(buf) (g_cond_signal (GST_AUDIO_SRC_RING_BUFFER_GET_COND (buf)))
98 #define GST_AUDIO_SRC_RING_BUFFER_BROADCAST(buf)(g_cond_broadcast (GST_AUDIO_SRC_RING_BUFFER_GET_COND (buf)))
100 struct _GstAudioSrcRingBuffer
102 GstAudioRingBuffer object;
110 struct _GstAudioSrcRingBufferClass
112 GstAudioRingBufferClass parent_class;
115 static void gst_audio_src_ring_buffer_class_init (GstAudioSrcRingBufferClass *
117 static void gst_audio_src_ring_buffer_init (GstAudioSrcRingBuffer * ringbuffer,
118 GstAudioSrcRingBufferClass * klass);
119 static void gst_audio_src_ring_buffer_dispose (GObject * object);
120 static void gst_audio_src_ring_buffer_finalize (GObject * object);
122 static GstAudioRingBufferClass *ring_parent_class = NULL;
124 static gboolean gst_audio_src_ring_buffer_open_device (GstAudioRingBuffer *
126 static gboolean gst_audio_src_ring_buffer_close_device (GstAudioRingBuffer *
128 static gboolean gst_audio_src_ring_buffer_acquire (GstAudioRingBuffer * buf,
129 GstAudioRingBufferSpec * spec);
130 static gboolean gst_audio_src_ring_buffer_release (GstAudioRingBuffer * buf);
131 static gboolean gst_audio_src_ring_buffer_start (GstAudioRingBuffer * buf);
132 static gboolean gst_audio_src_ring_buffer_stop (GstAudioRingBuffer * buf);
133 static guint gst_audio_src_ring_buffer_delay (GstAudioRingBuffer * buf);
135 /* ringbuffer abstract base class */
137 gst_audio_src_ring_buffer_get_type (void)
139 static GType ringbuffer_type = 0;
141 if (!ringbuffer_type) {
142 static const GTypeInfo ringbuffer_info = {
143 sizeof (GstAudioSrcRingBufferClass),
146 (GClassInitFunc) gst_audio_src_ring_buffer_class_init,
149 sizeof (GstAudioSrcRingBuffer),
151 (GInstanceInitFunc) gst_audio_src_ring_buffer_init,
156 g_type_register_static (GST_TYPE_AUDIO_RING_BUFFER,
157 "GstAudioSrcRingBuffer", &ringbuffer_info, 0);
159 return ringbuffer_type;
163 gst_audio_src_ring_buffer_class_init (GstAudioSrcRingBufferClass * klass)
165 GObjectClass *gobject_class;
166 GstAudioRingBufferClass *gstringbuffer_class;
168 gobject_class = (GObjectClass *) klass;
169 gstringbuffer_class = (GstAudioRingBufferClass *) klass;
171 ring_parent_class = g_type_class_peek_parent (klass);
173 gobject_class->dispose = gst_audio_src_ring_buffer_dispose;
174 gobject_class->finalize = gst_audio_src_ring_buffer_finalize;
176 gstringbuffer_class->open_device =
177 GST_DEBUG_FUNCPTR (gst_audio_src_ring_buffer_open_device);
178 gstringbuffer_class->close_device =
179 GST_DEBUG_FUNCPTR (gst_audio_src_ring_buffer_close_device);
180 gstringbuffer_class->acquire =
181 GST_DEBUG_FUNCPTR (gst_audio_src_ring_buffer_acquire);
182 gstringbuffer_class->release =
183 GST_DEBUG_FUNCPTR (gst_audio_src_ring_buffer_release);
184 gstringbuffer_class->start =
185 GST_DEBUG_FUNCPTR (gst_audio_src_ring_buffer_start);
186 gstringbuffer_class->resume =
187 GST_DEBUG_FUNCPTR (gst_audio_src_ring_buffer_start);
188 gstringbuffer_class->stop =
189 GST_DEBUG_FUNCPTR (gst_audio_src_ring_buffer_stop);
191 gstringbuffer_class->delay =
192 GST_DEBUG_FUNCPTR (gst_audio_src_ring_buffer_delay);
195 typedef guint (*ReadFunc) (GstAudioSrc * src, gpointer data, guint length);
197 /* this internal thread does nothing else but read samples from the audio device.
198 * It will read each segment in the ringbuffer and will update the play
200 * The start/stop methods control the thread.
203 audioringbuffer_thread_func (GstAudioRingBuffer * buf)
206 GstAudioSrcClass *csrc;
207 GstAudioSrcRingBuffer *abuf = GST_AUDIO_SRC_RING_BUFFER (buf);
212 src = GST_AUDIO_SRC (GST_OBJECT_PARENT (buf));
213 csrc = GST_AUDIO_SRC_GET_CLASS (src);
215 GST_DEBUG_OBJECT (src, "enter thread");
217 readfunc = csrc->read;
218 if (readfunc == NULL)
221 /* FIXME: maybe we should at least use a custom pointer type here? */
222 g_value_init (&val, G_TYPE_POINTER);
223 g_value_set_pointer (&val, src->thread);
224 message = gst_message_new_stream_status (GST_OBJECT_CAST (buf),
225 GST_STREAM_STATUS_TYPE_ENTER, GST_ELEMENT_CAST (src));
226 gst_message_set_stream_status_object (message, &val);
227 GST_DEBUG_OBJECT (src, "posting ENTER stream status");
228 gst_element_post_message (GST_ELEMENT_CAST (src), message);
235 if (gst_audio_ring_buffer_prepare_read (buf, &readseg, &readptr, &len)) {
240 read = readfunc (src, readptr, left);
241 GST_LOG_OBJECT (src, "transfered %d bytes of %d to segment %d", read,
243 if (read < 0 || read > left) {
244 GST_WARNING_OBJECT (src,
245 "error reading data %d (reason: %s), skipping segment", read,
253 /* we read one segment */
254 gst_audio_ring_buffer_advance (buf, 1);
256 GST_OBJECT_LOCK (abuf);
259 if (G_UNLIKELY (g_atomic_int_get (&buf->state) ==
260 GST_AUDIO_RING_BUFFER_STATE_STARTED)) {
261 GST_OBJECT_UNLOCK (abuf);
264 GST_DEBUG_OBJECT (src, "signal wait");
265 GST_AUDIO_SRC_RING_BUFFER_SIGNAL (buf);
266 GST_DEBUG_OBJECT (src, "wait for action");
267 GST_AUDIO_SRC_RING_BUFFER_WAIT (buf);
268 GST_DEBUG_OBJECT (src, "got signal");
271 GST_DEBUG_OBJECT (src, "continue running");
272 GST_OBJECT_UNLOCK (abuf);
276 /* Will never be reached */
277 g_assert_not_reached ();
283 GST_DEBUG ("no write function, exit thread");
288 GST_OBJECT_UNLOCK (abuf);
289 GST_DEBUG ("stop running, exit thread");
290 message = gst_message_new_stream_status (GST_OBJECT_CAST (buf),
291 GST_STREAM_STATUS_TYPE_LEAVE, GST_ELEMENT_CAST (src));
292 gst_message_set_stream_status_object (message, &val);
293 GST_DEBUG_OBJECT (src, "posting LEAVE stream status");
294 gst_element_post_message (GST_ELEMENT_CAST (src), message);
300 gst_audio_src_ring_buffer_init (GstAudioSrcRingBuffer * ringbuffer,
301 GstAudioSrcRingBufferClass * g_class)
303 ringbuffer->running = FALSE;
304 ringbuffer->queuedseg = 0;
306 ringbuffer->cond = g_cond_new ();
310 gst_audio_src_ring_buffer_dispose (GObject * object)
312 GstAudioSrcRingBuffer *ringbuffer = GST_AUDIO_SRC_RING_BUFFER (object);
314 if (ringbuffer->cond) {
315 g_cond_free (ringbuffer->cond);
316 ringbuffer->cond = NULL;
319 G_OBJECT_CLASS (ring_parent_class)->dispose (object);
323 gst_audio_src_ring_buffer_finalize (GObject * object)
325 G_OBJECT_CLASS (ring_parent_class)->finalize (object);
329 gst_audio_src_ring_buffer_open_device (GstAudioRingBuffer * buf)
332 GstAudioSrcClass *csrc;
333 gboolean result = TRUE;
335 src = GST_AUDIO_SRC (GST_OBJECT_PARENT (buf));
336 csrc = GST_AUDIO_SRC_GET_CLASS (src);
339 result = csrc->open (src);
353 gst_audio_src_ring_buffer_close_device (GstAudioRingBuffer * buf)
356 GstAudioSrcClass *csrc;
357 gboolean result = TRUE;
359 src = GST_AUDIO_SRC (GST_OBJECT_PARENT (buf));
360 csrc = GST_AUDIO_SRC_GET_CLASS (src);
363 result = csrc->close (src);
377 gst_audio_src_ring_buffer_acquire (GstAudioRingBuffer * buf,
378 GstAudioRingBufferSpec * spec)
381 GstAudioSrcClass *csrc;
382 GstAudioSrcRingBuffer *abuf;
383 gboolean result = FALSE;
385 src = GST_AUDIO_SRC (GST_OBJECT_PARENT (buf));
386 csrc = GST_AUDIO_SRC_GET_CLASS (src);
389 result = csrc->prepare (src, spec);
394 buf->size = spec->segtotal * spec->segsize;
395 buf->memory = g_malloc0 (buf->size);
397 abuf = GST_AUDIO_SRC_RING_BUFFER (buf);
398 abuf->running = TRUE;
400 /* FIXME: handle thread creation failure */
401 #if !GLIB_CHECK_VERSION (2, 31, 0)
403 g_thread_create ((GThreadFunc) audioringbuffer_thread_func, buf, TRUE,
406 src->thread = g_thread_try_new ("audiosrc-ringbuffer",
407 (GThreadFunc) audioringbuffer_thread_func, buf, NULL);
410 GST_AUDIO_RING_BUFFER_WAIT (buf);
420 /* function is called with LOCK */
422 gst_audio_src_ring_buffer_release (GstAudioRingBuffer * buf)
425 GstAudioSrcClass *csrc;
426 GstAudioSrcRingBuffer *abuf;
427 gboolean result = FALSE;
429 src = GST_AUDIO_SRC (GST_OBJECT_PARENT (buf));
430 csrc = GST_AUDIO_SRC_GET_CLASS (src);
431 abuf = GST_AUDIO_SRC_RING_BUFFER (buf);
433 abuf->running = FALSE;
434 GST_AUDIO_SRC_RING_BUFFER_SIGNAL (buf);
435 GST_OBJECT_UNLOCK (buf);
437 /* join the thread */
438 g_thread_join (src->thread);
440 GST_OBJECT_LOCK (buf);
442 /* free the buffer */
443 g_free (buf->memory);
447 result = csrc->unprepare (src);
453 gst_audio_src_ring_buffer_start (GstAudioRingBuffer * buf)
455 GST_DEBUG ("start, sending signal");
456 GST_AUDIO_SRC_RING_BUFFER_SIGNAL (buf);
462 gst_audio_src_ring_buffer_stop (GstAudioRingBuffer * buf)
465 GstAudioSrcClass *csrc;
467 src = GST_AUDIO_SRC (GST_OBJECT_PARENT (buf));
468 csrc = GST_AUDIO_SRC_GET_CLASS (src);
470 /* unblock any pending writes to the audio device */
472 GST_DEBUG ("reset...");
474 GST_DEBUG ("reset done");
477 GST_DEBUG ("stop, waiting...");
478 GST_AUDIO_SRC_RING_BUFFER_WAIT (buf);
479 GST_DEBUG ("stoped");
486 gst_audio_src_ring_buffer_delay (GstAudioRingBuffer * buf)
489 GstAudioSrcClass *csrc;
492 src = GST_AUDIO_SRC (GST_OBJECT_PARENT (buf));
493 csrc = GST_AUDIO_SRC_GET_CLASS (src);
496 res = csrc->delay (src);
501 /* AudioSrc signals and args */
514 GST_DEBUG_CATEGORY_INIT (gst_audio_src_debug, "audiosrc", 0, "audiosrc element");
515 #define gst_audio_src_parent_class parent_class
516 G_DEFINE_TYPE_WITH_CODE (GstAudioSrc, gst_audio_src,
517 GST_TYPE_AUDIO_BASE_SRC, _do_init);
519 static GstAudioRingBuffer *gst_audio_src_create_ringbuffer (GstAudioBaseSrc *
523 gst_audio_src_class_init (GstAudioSrcClass * klass)
525 GstAudioBaseSrcClass *gstaudiobasesrc_class;
527 gstaudiobasesrc_class = (GstAudioBaseSrcClass *) klass;
529 gstaudiobasesrc_class->create_ringbuffer =
530 GST_DEBUG_FUNCPTR (gst_audio_src_create_ringbuffer);
532 g_type_class_ref (GST_TYPE_AUDIO_SRC_RING_BUFFER);
536 gst_audio_src_init (GstAudioSrc * audiosrc)
540 static GstAudioRingBuffer *
541 gst_audio_src_create_ringbuffer (GstAudioBaseSrc * src)
543 GstAudioRingBuffer *buffer;
545 GST_DEBUG ("creating ringbuffer");
546 buffer = g_object_new (GST_TYPE_AUDIO_SRC_RING_BUFFER, NULL);
547 GST_DEBUG ("created ringbuffer @%p", buffer);