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: #GstBaseAudioSrc, #GstRingBuffer, #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 #GstBaseAudioSrc using a default implementation of a
65 * #GstRingBuffer that uses threads.
67 * Last reviewed on 2006-09-27 (0.10.12)
72 #include "gstaudiosrc.h"
74 GST_DEBUG_CATEGORY_STATIC (gst_audio_src_debug);
75 #define GST_CAT_DEFAULT gst_audio_src_debug
77 #define GST_TYPE_AUDIORING_BUFFER \
78 (gst_audioringbuffer_get_type())
79 #define GST_AUDIORING_BUFFER(obj) \
80 (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_AUDIORING_BUFFER,GstAudioRingBuffer))
81 #define GST_AUDIORING_BUFFER_CLASS(klass) \
82 (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_AUDIORING_BUFFER,GstAudioRingBufferClass))
83 #define GST_AUDIORING_BUFFER_GET_CLASS(obj) \
84 (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_AUDIORING_BUFFER, GstAudioRingBufferClass))
85 #define GST_IS_AUDIORING_BUFFER(obj) \
86 (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_AUDIORING_BUFFER))
87 #define GST_IS_AUDIORING_BUFFER_CLASS(klass)\
88 (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_AUDIORING_BUFFER))
90 typedef struct _GstAudioRingBuffer GstAudioRingBuffer;
91 typedef struct _GstAudioRingBufferClass GstAudioRingBufferClass;
93 #define GST_AUDIORING_BUFFER_GET_COND(buf) (((GstAudioRingBuffer *)buf)->cond)
94 #define GST_AUDIORING_BUFFER_WAIT(buf) (g_cond_wait (GST_AUDIORING_BUFFER_GET_COND (buf), GST_OBJECT_GET_LOCK (buf)))
95 #define GST_AUDIORING_BUFFER_SIGNAL(buf) (g_cond_signal (GST_AUDIORING_BUFFER_GET_COND (buf)))
96 #define GST_AUDIORING_BUFFER_BROADCAST(buf)(g_cond_broadcast (GST_AUDIORING_BUFFER_GET_COND (buf)))
98 struct _GstAudioRingBuffer
100 GstRingBuffer object;
108 struct _GstAudioRingBufferClass
110 GstRingBufferClass parent_class;
113 static void gst_audioringbuffer_class_init (GstAudioRingBufferClass * klass);
114 static void gst_audioringbuffer_init (GstAudioRingBuffer * ringbuffer,
115 GstAudioRingBufferClass * klass);
116 static void gst_audioringbuffer_dispose (GObject * object);
117 static void gst_audioringbuffer_finalize (GObject * object);
119 static GstRingBufferClass *ring_parent_class = NULL;
121 static gboolean gst_audioringbuffer_open_device (GstRingBuffer * buf);
122 static gboolean gst_audioringbuffer_close_device (GstRingBuffer * buf);
123 static gboolean gst_audioringbuffer_acquire (GstRingBuffer * buf,
124 GstRingBufferSpec * spec);
125 static gboolean gst_audioringbuffer_release (GstRingBuffer * buf);
126 static gboolean gst_audioringbuffer_start (GstRingBuffer * buf);
127 static gboolean gst_audioringbuffer_stop (GstRingBuffer * buf);
128 static guint gst_audioringbuffer_delay (GstRingBuffer * buf);
130 /* ringbuffer abstract base class */
132 gst_audioringbuffer_get_type (void)
134 static GType ringbuffer_type = 0;
136 if (!ringbuffer_type) {
137 static const GTypeInfo ringbuffer_info = {
138 sizeof (GstAudioRingBufferClass),
141 (GClassInitFunc) gst_audioringbuffer_class_init,
144 sizeof (GstAudioRingBuffer),
146 (GInstanceInitFunc) gst_audioringbuffer_init,
151 g_type_register_static (GST_TYPE_RING_BUFFER, "GstAudioSrcRingBuffer",
152 &ringbuffer_info, 0);
154 return ringbuffer_type;
158 gst_audioringbuffer_class_init (GstAudioRingBufferClass * klass)
160 GObjectClass *gobject_class;
161 GstRingBufferClass *gstringbuffer_class;
163 gobject_class = (GObjectClass *) klass;
164 gstringbuffer_class = (GstRingBufferClass *) klass;
166 ring_parent_class = g_type_class_peek_parent (klass);
168 gobject_class->dispose = gst_audioringbuffer_dispose;
169 gobject_class->finalize = gst_audioringbuffer_finalize;
171 gstringbuffer_class->open_device =
172 GST_DEBUG_FUNCPTR (gst_audioringbuffer_open_device);
173 gstringbuffer_class->close_device =
174 GST_DEBUG_FUNCPTR (gst_audioringbuffer_close_device);
175 gstringbuffer_class->acquire =
176 GST_DEBUG_FUNCPTR (gst_audioringbuffer_acquire);
177 gstringbuffer_class->release =
178 GST_DEBUG_FUNCPTR (gst_audioringbuffer_release);
179 gstringbuffer_class->start = GST_DEBUG_FUNCPTR (gst_audioringbuffer_start);
180 gstringbuffer_class->resume = GST_DEBUG_FUNCPTR (gst_audioringbuffer_start);
181 gstringbuffer_class->stop = GST_DEBUG_FUNCPTR (gst_audioringbuffer_stop);
183 gstringbuffer_class->delay = GST_DEBUG_FUNCPTR (gst_audioringbuffer_delay);
186 typedef guint (*ReadFunc) (GstAudioSrc * src, gpointer data, guint length);
188 /* this internal thread does nothing else but read samples from the audio device.
189 * It will read each segment in the ringbuffer and will update the play
191 * The start/stop methods control the thread.
194 audioringbuffer_thread_func (GstRingBuffer * buf)
197 GstAudioSrcClass *csrc;
198 GstAudioRingBuffer *abuf = GST_AUDIORING_BUFFER (buf);
203 src = GST_AUDIO_SRC (GST_OBJECT_PARENT (buf));
204 csrc = GST_AUDIO_SRC_GET_CLASS (src);
206 GST_DEBUG_OBJECT (src, "enter thread");
208 readfunc = csrc->read;
209 if (readfunc == NULL)
212 /* FIXME: maybe we should at least use a custom pointer type here? */
213 g_value_init (&val, G_TYPE_POINTER);
214 g_value_set_pointer (&val, src->thread);
215 message = gst_message_new_stream_status (GST_OBJECT_CAST (buf),
216 GST_STREAM_STATUS_TYPE_ENTER, GST_ELEMENT_CAST (src));
217 gst_message_set_stream_status_object (message, &val);
218 GST_DEBUG_OBJECT (src, "posting ENTER stream status");
219 gst_element_post_message (GST_ELEMENT_CAST (src), message);
226 if (gst_ring_buffer_prepare_read (buf, &readseg, &readptr, &len)) {
231 read = readfunc (src, readptr, left);
232 GST_LOG_OBJECT (src, "transfered %d bytes of %d to segment %d", read,
234 if (read < 0 || read > left) {
235 GST_WARNING_OBJECT (src,
236 "error reading data %d (reason: %s), skipping segment", read,
244 /* we read one segment */
245 gst_ring_buffer_advance (buf, 1);
247 GST_OBJECT_LOCK (abuf);
250 if (G_UNLIKELY (g_atomic_int_get (&buf->state) ==
251 GST_RING_BUFFER_STATE_STARTED)) {
252 GST_OBJECT_UNLOCK (abuf);
255 GST_DEBUG_OBJECT (src, "signal wait");
256 GST_AUDIORING_BUFFER_SIGNAL (buf);
257 GST_DEBUG_OBJECT (src, "wait for action");
258 GST_AUDIORING_BUFFER_WAIT (buf);
259 GST_DEBUG_OBJECT (src, "got signal");
262 GST_DEBUG_OBJECT (src, "continue running");
263 GST_OBJECT_UNLOCK (abuf);
267 /* Will never be reached */
268 g_assert_not_reached ();
274 GST_DEBUG ("no write function, exit thread");
279 GST_OBJECT_UNLOCK (abuf);
280 GST_DEBUG ("stop running, exit thread");
281 message = gst_message_new_stream_status (GST_OBJECT_CAST (buf),
282 GST_STREAM_STATUS_TYPE_LEAVE, GST_ELEMENT_CAST (src));
283 gst_message_set_stream_status_object (message, &val);
284 GST_DEBUG_OBJECT (src, "posting LEAVE stream status");
285 gst_element_post_message (GST_ELEMENT_CAST (src), message);
291 gst_audioringbuffer_init (GstAudioRingBuffer * ringbuffer,
292 GstAudioRingBufferClass * g_class)
294 ringbuffer->running = FALSE;
295 ringbuffer->queuedseg = 0;
297 ringbuffer->cond = g_cond_new ();
301 gst_audioringbuffer_dispose (GObject * object)
303 GstAudioRingBuffer *ringbuffer = GST_AUDIORING_BUFFER (object);
305 if (ringbuffer->cond) {
306 g_cond_free (ringbuffer->cond);
307 ringbuffer->cond = NULL;
310 G_OBJECT_CLASS (ring_parent_class)->dispose (object);
314 gst_audioringbuffer_finalize (GObject * object)
316 G_OBJECT_CLASS (ring_parent_class)->finalize (object);
320 gst_audioringbuffer_open_device (GstRingBuffer * buf)
323 GstAudioSrcClass *csrc;
324 gboolean result = TRUE;
326 src = GST_AUDIO_SRC (GST_OBJECT_PARENT (buf));
327 csrc = GST_AUDIO_SRC_GET_CLASS (src);
330 result = csrc->open (src);
344 gst_audioringbuffer_close_device (GstRingBuffer * buf)
347 GstAudioSrcClass *csrc;
348 gboolean result = TRUE;
350 src = GST_AUDIO_SRC (GST_OBJECT_PARENT (buf));
351 csrc = GST_AUDIO_SRC_GET_CLASS (src);
354 result = csrc->close (src);
368 gst_audioringbuffer_acquire (GstRingBuffer * buf, GstRingBufferSpec * spec)
371 GstAudioSrcClass *csrc;
372 GstAudioRingBuffer *abuf;
373 gboolean result = FALSE;
375 src = GST_AUDIO_SRC (GST_OBJECT_PARENT (buf));
376 csrc = GST_AUDIO_SRC_GET_CLASS (src);
379 result = csrc->prepare (src, spec);
384 buf->size = spec->segtotal * spec->segsize;
385 buf->memory = g_malloc0 (buf->size);
387 abuf = GST_AUDIORING_BUFFER (buf);
388 abuf->running = TRUE;
391 g_thread_create ((GThreadFunc) audioringbuffer_thread_func, buf, TRUE,
393 GST_AUDIORING_BUFFER_WAIT (buf);
403 /* function is called with LOCK */
405 gst_audioringbuffer_release (GstRingBuffer * buf)
408 GstAudioSrcClass *csrc;
409 GstAudioRingBuffer *abuf;
410 gboolean result = FALSE;
412 src = GST_AUDIO_SRC (GST_OBJECT_PARENT (buf));
413 csrc = GST_AUDIO_SRC_GET_CLASS (src);
414 abuf = GST_AUDIORING_BUFFER (buf);
416 abuf->running = FALSE;
417 GST_AUDIORING_BUFFER_SIGNAL (buf);
418 GST_OBJECT_UNLOCK (buf);
420 /* join the thread */
421 g_thread_join (src->thread);
423 GST_OBJECT_LOCK (buf);
425 /* free the buffer */
426 g_free (buf->memory);
430 result = csrc->unprepare (src);
436 gst_audioringbuffer_start (GstRingBuffer * buf)
438 GST_DEBUG ("start, sending signal");
439 GST_AUDIORING_BUFFER_SIGNAL (buf);
445 gst_audioringbuffer_stop (GstRingBuffer * buf)
448 GstAudioSrcClass *csrc;
450 src = GST_AUDIO_SRC (GST_OBJECT_PARENT (buf));
451 csrc = GST_AUDIO_SRC_GET_CLASS (src);
453 /* unblock any pending writes to the audio device */
455 GST_DEBUG ("reset...");
457 GST_DEBUG ("reset done");
460 GST_DEBUG ("stop, waiting...");
461 GST_AUDIORING_BUFFER_WAIT (buf);
462 GST_DEBUG ("stoped");
469 gst_audioringbuffer_delay (GstRingBuffer * buf)
472 GstAudioSrcClass *csrc;
475 src = GST_AUDIO_SRC (GST_OBJECT_PARENT (buf));
476 csrc = GST_AUDIO_SRC_GET_CLASS (src);
479 res = csrc->delay (src);
484 /* AudioSrc signals and args */
497 GST_DEBUG_CATEGORY_INIT (gst_audio_src_debug, "audiosrc", 0, "audiosrc element");
498 #define gst_audio_src_parent_class parent_class
499 G_DEFINE_TYPE_WITH_CODE (GstAudioSrc, gst_audio_src,
500 GST_TYPE_BASE_AUDIO_SRC, _do_init);
502 static GstRingBuffer *gst_audio_src_create_ringbuffer (GstBaseAudioSrc * src);
505 gst_audio_src_class_init (GstAudioSrcClass * klass)
507 GstBaseAudioSrcClass *gstbaseaudiosrc_class;
509 gstbaseaudiosrc_class = (GstBaseAudioSrcClass *) klass;
511 gstbaseaudiosrc_class->create_ringbuffer =
512 GST_DEBUG_FUNCPTR (gst_audio_src_create_ringbuffer);
514 g_type_class_ref (GST_TYPE_AUDIORING_BUFFER);
518 gst_audio_src_init (GstAudioSrc * audiosrc)
522 static GstRingBuffer *
523 gst_audio_src_create_ringbuffer (GstBaseAudioSrc * src)
525 GstRingBuffer *buffer;
527 GST_DEBUG ("creating ringbuffer");
528 buffer = g_object_new (GST_TYPE_AUDIORING_BUFFER, NULL);
529 GST_DEBUG ("created ringbuffer @%p", buffer);