2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
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.
23 //#define DEBUG_ENABLED
24 //#define STATUS_ENABLED
26 #define STATUS(A) GST_DEBUG(GST_CAT_DATAFLOW, A, GST_ELEMENT_NAME(queue))
34 #include "gst_private.h"
37 #include "gstscheduler.h"
39 GstElementDetails gst_queue_details = {
44 "Erik Walthinsen <omega@cse.ogi.edu>",
49 /* Queue signals and args */
70 static void gst_queue_class_init (GstQueueClass *klass);
71 static void gst_queue_init (GstQueue *queue);
73 static void gst_queue_set_property (GObject *object, guint prop_id,
74 const GValue *value, GParamSpec *pspec);
75 static void gst_queue_get_property (GObject *object, guint prop_id,
76 GValue *value, GParamSpec *pspec);
78 static GstPadNegotiateReturn gst_queue_handle_negotiate_src (GstPad *pad, GstCaps **caps, gpointer *data);
79 static GstPadNegotiateReturn gst_queue_handle_negotiate_sink (GstPad *pad, GstCaps **caps, gpointer *data);
80 static void gst_queue_chain (GstPad *pad, GstBuffer *buf);
81 static GstBuffer * gst_queue_get (GstPad *pad);
82 static GstBufferPool* gst_queue_get_bufferpool (GstPad *pad);
84 static void gst_queue_locked_flush (GstQueue *queue);
85 static void gst_queue_flush (GstQueue *queue);
87 static GstElementStateReturn gst_queue_change_state (GstElement *element);
90 #define GST_TYPE_QUEUE_LEAKY (queue_leaky_get_type())
92 queue_leaky_get_type(void) {
93 static GType queue_leaky_type = 0;
94 static GEnumValue queue_leaky[] = {
95 { GST_QUEUE_NO_LEAK, "0", "Not Leaky" },
96 { GST_QUEUE_LEAK_UPSTREAM, "1", "Leaky on Upstream" },
97 { GST_QUEUE_LEAK_DOWNSTREAM, "2", "Leaky on Downstream" },
100 if (!queue_leaky_type) {
101 queue_leaky_type = g_enum_register_static("GstQueueLeaky", queue_leaky);
103 return queue_leaky_type;
106 static GstElementClass *parent_class = NULL;
107 //static guint gst_queue_signals[LAST_SIGNAL] = { 0 };
110 gst_queue_get_type(void)
112 static GType queue_type = 0;
115 static const GTypeInfo queue_info = {
116 sizeof(GstQueueClass),
119 (GClassInitFunc)gst_queue_class_init,
124 (GInstanceInitFunc)gst_queue_init,
127 queue_type = g_type_register_static (GST_TYPE_ELEMENT, "GstQueue", &queue_info, 0);
133 gst_queue_class_init (GstQueueClass *klass)
135 GObjectClass *gobject_class;
136 GstElementClass *gstelement_class;
138 gobject_class = (GObjectClass*)klass;
139 gstelement_class = (GstElementClass*)klass;
141 parent_class = g_type_class_ref (GST_TYPE_ELEMENT);
143 g_object_class_install_property(G_OBJECT_CLASS(klass), ARG_LEAKY,
144 g_param_spec_enum("leaky","Leaky","Where the queue leaks, if at all.",
145 GST_TYPE_QUEUE_LEAKY,GST_QUEUE_NO_LEAK,G_PARAM_READWRITE));
146 g_object_class_install_property(G_OBJECT_CLASS(klass), ARG_LEVEL,
147 g_param_spec_int("level","Level","How many buffers are in the queue.",
148 0,G_MAXINT,0,G_PARAM_READABLE));
149 g_object_class_install_property(G_OBJECT_CLASS(klass), ARG_MAX_LEVEL,
150 g_param_spec_int("max_level","Maximum Level","How many buffers the queue holds.",
151 0,G_MAXINT,100,G_PARAM_READWRITE));
153 gobject_class->set_property = GST_DEBUG_FUNCPTR(gst_queue_set_property);
154 gobject_class->get_property = GST_DEBUG_FUNCPTR(gst_queue_get_property);
156 gstelement_class->change_state = GST_DEBUG_FUNCPTR(gst_queue_change_state);
160 gst_queue_init (GstQueue *queue)
162 // scheduling on this kind of element is, well, interesting
163 GST_FLAG_SET (queue, GST_ELEMENT_DECOUPLED);
165 queue->sinkpad = gst_pad_new ("sink", GST_PAD_SINK);
166 gst_pad_set_chain_function (queue->sinkpad, GST_DEBUG_FUNCPTR(gst_queue_chain));
167 gst_element_add_pad (GST_ELEMENT (queue), queue->sinkpad);
168 gst_pad_set_negotiate_function (queue->sinkpad, GST_DEBUG_FUNCPTR(gst_queue_handle_negotiate_sink));
169 gst_pad_set_bufferpool_function (queue->sinkpad, GST_DEBUG_FUNCPTR(gst_queue_get_bufferpool));
171 queue->srcpad = gst_pad_new ("src", GST_PAD_SRC);
172 gst_pad_set_get_function (queue->srcpad, GST_DEBUG_FUNCPTR(gst_queue_get));
173 gst_element_add_pad (GST_ELEMENT (queue), queue->srcpad);
174 gst_pad_set_negotiate_function (queue->srcpad, GST_DEBUG_FUNCPTR(gst_queue_handle_negotiate_src));
177 queue->level_buffers = 0;
178 queue->level_bytes = 0;
179 queue->level_time = 0LL;
180 queue->size_buffers = 100; // 100 buffers
181 queue->size_bytes = 100 * 1024; // 100KB
182 queue->size_time = 1000000000LL; // 1sec
184 queue->qlock = g_mutex_new ();
185 queue->reader = FALSE;
186 queue->writer = FALSE;
187 queue->not_empty = g_cond_new ();
188 queue->not_full = g_cond_new ();
189 GST_DEBUG_ELEMENT (GST_CAT_THREAD, queue, "initialized queue's not_empty & not_full conditions\n");
192 static GstBufferPool*
193 gst_queue_get_bufferpool (GstPad *pad)
197 queue = GST_QUEUE (GST_OBJECT_PARENT (pad));
199 return gst_pad_get_bufferpool (queue->srcpad);
202 static GstPadNegotiateReturn
203 gst_queue_handle_negotiate_src (GstPad *pad, GstCaps **caps, gpointer *data)
207 queue = GST_QUEUE (GST_OBJECT_PARENT (pad));
209 return gst_pad_negotiate_proxy (pad, queue->sinkpad, caps);
212 static GstPadNegotiateReturn
213 gst_queue_handle_negotiate_sink (GstPad *pad, GstCaps **caps, gpointer *data)
217 queue = GST_QUEUE (GST_OBJECT_PARENT (pad));
219 return gst_pad_negotiate_proxy (pad, queue->srcpad, caps);
223 gst_queue_cleanup_buffers (gpointer data, const gpointer user_data)
225 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, user_data, "cleaning buffer %p\n", data);
226 gst_buffer_unref (GST_BUFFER (data));
230 gst_queue_locked_flush (GstQueue *queue)
232 g_slist_foreach (queue->queue, gst_queue_cleanup_buffers,
234 g_slist_free (queue->queue);
237 queue->level_buffers = 0;
238 queue->timeval = NULL;
242 gst_queue_flush (GstQueue *queue)
244 g_mutex_lock (queue->qlock);
245 gst_queue_locked_flush (queue);
246 g_mutex_unlock (queue->qlock);
250 gst_queue_chain (GstPad *pad, GstBuffer *buf)
255 g_return_if_fail (pad != NULL);
256 g_return_if_fail (GST_IS_PAD (pad));
257 g_return_if_fail (buf != NULL);
259 queue = GST_QUEUE (GST_OBJECT_PARENT (pad));
263 /* we have to lock the queue since we span threads */
265 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "locking t:%ld\n", pthread_self ());
266 g_mutex_lock (queue->qlock);
267 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "locked t:%ld\n", pthread_self ());
269 if (GST_IS_EVENT(buf)) {
270 GstEvent *event = GST_EVENT(buf);
271 switch (GST_EVENT_TYPE(event)) {
272 case GST_EVENT_FLUSH:
273 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "flushing queue\n");
274 gst_queue_locked_flush (queue);
281 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "adding buffer %p of size %d\n",buf,GST_BUFFER_SIZE(buf));
283 if (queue->level_buffers == queue->size_buffers) {
284 // if this is a leaky queue...
286 // FIXME don't want to leak events!
287 // if we leak on the upstream side, drop the current buffer
288 if (queue->leaky == GST_QUEUE_LEAK_UPSTREAM) {
289 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "queue is full, leaking buffer on upstream end\n");
290 if (GST_IS_EVENT (buf))
291 fprintf(stderr, "Error: queue [%s] leaked an event, type:%d\n",
292 GST_ELEMENT_NAME(GST_ELEMENT(queue)),
293 GST_EVENT_TYPE(GST_EVENT(buf)));
294 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "queue is full, leaking buffer on upstream end\n");
295 gst_buffer_unref(buf);
296 // now we have to clean up and exit right away
297 g_mutex_unlock (queue->qlock);
300 // otherwise we have to push a buffer off the other end
304 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "queue is full, leaking buffer on downstream end\n");
305 front = queue->queue;
306 leakbuf = (GstBuffer *)(front->data);
307 if (GST_IS_EVENT (leakbuf))
308 fprintf(stderr, "Error: queue [%s] leaked an event, type:%d\n",
309 GST_ELEMENT_NAME(GST_ELEMENT(queue)),
310 GST_EVENT_TYPE(GST_EVENT(leakbuf)));
311 queue->level_buffers--;
312 queue->level_bytes -= GST_BUFFER_SIZE(leakbuf);
313 gst_buffer_unref(leakbuf);
314 queue->queue = g_slist_remove_link (queue->queue, front);
315 g_slist_free (front);
319 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "pre full wait, level:%d/%d\n",
320 queue->level_buffers, queue->size_buffers);
321 while (queue->level_buffers == queue->size_buffers) {
322 // if there's a pending state change for this queue or its manager, switch
323 // back to iterator so bottom half of state change executes
324 if (GST_STATE_PENDING(queue) != GST_STATE_VOID_PENDING ||
325 // GST_STATE_PENDING(GST_SCHEDULE(GST_ELEMENT(queue)->sched)->parent) != GST_STATE_VOID_PENDING)
326 GST_STATE_PENDING(GST_SCHED_PARENT(GST_ELEMENT_SCHED(GST_PAD_PARENT(GST_PAD_PEER(queue->sinkpad))))) !=
327 GST_STATE_VOID_PENDING)
329 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "interrupted!!\n");
330 if (GST_STATE_PENDING(queue) != GST_STATE_VOID_PENDING)
331 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "GST_STATE_PENDING(queue) != GST_STATE_VOID_PENDING)\n");
332 if (GST_STATE_PENDING(GST_SCHEDULE(GST_ELEMENT(queue)->sched)->parent) != GST_STATE_VOID_PENDING)
333 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "GST_STATE_PENDING(GST_SCHEDULE(GST_ELEMENT(queue)->sched)->parent) != GST_STATE_VOID_PENDING\n");
334 g_mutex_unlock (queue->qlock);
335 cothread_switch(cothread_current_main());
338 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "waiting for not_full, level:%d/%d\n", queue->level_buffers, queue->size_buffers);
340 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "WARNING: multiple writers on queue!\n");
341 queue->writer = TRUE;
342 g_cond_wait (queue->not_full, queue->qlock);
343 queue->writer = FALSE;
344 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "got not_full signal\n");
346 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "post full wait, level:%d/%d\n",
347 queue->level_buffers, queue->size_buffers);
350 /* put the buffer on the tail of the list */
351 queue->queue = g_slist_append (queue->queue, buf);
352 queue->level_buffers++;
353 queue->level_bytes += GST_BUFFER_SIZE(buf);
354 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "(%s:%s)+ level:%d/%d\n",
355 GST_DEBUG_PAD_NAME(pad),
356 queue->level_buffers, queue->size_buffers);
358 /* reader waiting on an empty queue */
359 reader = queue->reader;
361 g_mutex_unlock (queue->qlock);
365 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "signalling not_empty\n");
366 g_cond_signal (queue->not_empty);
371 gst_queue_get (GstPad *pad)
374 GstBuffer *buf = NULL;
378 g_assert(pad != NULL);
379 g_assert(GST_IS_PAD(pad));
380 g_return_val_if_fail (pad != NULL, NULL);
381 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
383 queue = GST_QUEUE (GST_OBJECT_PARENT (pad));
387 /* have to lock for thread-safety */
388 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "locking t:%ld\n", pthread_self ());
389 g_mutex_lock (queue->qlock);
390 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "locked t:%ld %p\n", pthread_self (), queue->not_empty);
392 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "pre empty wait, level:%d/%d\n", queue->level_buffers, queue->size_buffers);
393 while (queue->level_buffers == 0) {
394 // if there's a pending state change for this queue or its manager, switch
395 // back to iterator so bottom half of state change executes
396 if (GST_STATE_PENDING(queue) != GST_STATE_VOID_PENDING ||
397 // GST_STATE_PENDING(GST_SCHEDULE(GST_ELEMENT(queue)->sched)->parent) != GST_STATE_VOID_PENDING)
398 GST_STATE_PENDING(GST_SCHED_PARENT(GST_ELEMENT_SCHED(GST_PAD_PARENT(GST_PAD_PEER(queue->srcpad))))) !=
399 GST_STATE_VOID_PENDING)
401 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "interrupted!!\n");
402 if (GST_STATE_PENDING(queue) != GST_STATE_VOID_PENDING)
403 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "GST_STATE_PENDING(queue) != GST_STATE_VOID_PENDING)\n");
404 if (GST_STATE_PENDING(GST_SCHEDULE(GST_ELEMENT(queue)->sched)->parent) != GST_STATE_VOID_PENDING)
405 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "GST_STATE_PENDING(GST_SCHEDULE(GST_ELEMENT(queue)->sched)->parent) != GST_STATE_VOID_PENDING\n");
406 g_mutex_unlock (queue->qlock);
407 cothread_switch(cothread_current_main());
410 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "waiting for not_empty, level:%d/%d\n", queue->level_buffers, queue->size_buffers);
412 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "WARNING: multiple readers on queue!\n");
413 queue->reader = TRUE;
414 g_cond_wait (queue->not_empty, queue->qlock);
415 queue->reader = FALSE;
416 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "got not_empty signal\n");
418 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "post empty wait, level:%d/%d\n", queue->level_buffers, queue->size_buffers);
420 front = queue->queue;
421 buf = (GstBuffer *)(front->data);
422 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "retrieved buffer %p from queue\n", buf);
423 queue->queue = g_slist_remove_link (queue->queue, front);
424 g_slist_free (front);
426 queue->level_buffers--;
427 queue->level_bytes -= GST_BUFFER_SIZE(buf);
428 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "(%s:%s)- level:%d/%d\n",
429 GST_DEBUG_PAD_NAME(pad),
430 queue->level_buffers, queue->size_buffers);
432 /* writer waiting on a full queue */
433 writer = queue->writer;
435 g_mutex_unlock (queue->qlock);
439 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "signalling not_full\n");
440 g_cond_signal (queue->not_full);
443 // FIXME where should this be? locked?
444 if (GST_IS_EVENT(buf)) {
445 GstEvent *event = GST_EVENT(buf);
446 switch (GST_EVENT_TYPE(event)) {
448 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "queue eos\n");
449 gst_element_set_state (GST_ELEMENT (queue), GST_STATE_PAUSED);
459 static GstElementStateReturn
460 gst_queue_change_state (GstElement *element)
463 GstElementStateReturn ret;
464 g_return_val_if_fail (GST_IS_QUEUE (element), GST_STATE_FAILURE);
466 queue = GST_QUEUE (element);
468 // lock the queue so another thread (not in sync with this thread's state)
469 // can't call this queue's _get (or whatever)
472 /* if going down into NULL state, clear out buffers*/
473 if (GST_STATE_PENDING (element) == GST_STATE_READY) {
474 /* otherwise (READY or higher) we need to open the file */
475 gst_queue_flush (queue);
478 // if we haven't failed already, give the parent class a chance to ;-)
479 if (GST_ELEMENT_CLASS (parent_class)->change_state)
481 gboolean valid_handler = FALSE;
482 guint state_change_id = g_signal_lookup("state_change", G_OBJECT_TYPE(element));
484 // determine whether we need to block the parent (element) class'
485 // STATE_CHANGE signal so we can UNLOCK before returning. we block
486 // it if we could find the state_change signal AND there's a signal
487 // handler attached to it.
489 // note: this assumes that change_state() *only* emits state_change signal.
490 // if element change_state() emits other signals, they need to be blocked
492 if (state_change_id &&
493 g_signal_has_handler_pending(G_OBJECT(element), state_change_id, 0, FALSE))
494 valid_handler = TRUE;
496 g_signal_handler_block(G_OBJECT(element), state_change_id);
498 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element);
501 g_signal_handler_unblock(G_OBJECT(element), state_change_id);
503 // UNLOCK, *then* emit signal (if there's one there)
506 g_signal_emit(G_OBJECT (element), state_change_id, 0, GST_STATE(element));
510 ret = GST_STATE_SUCCESS;
519 gst_queue_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
523 /* it's not null if we got it, but it might not be ours */
524 g_return_if_fail (GST_IS_QUEUE (object));
526 queue = GST_QUEUE (object);
530 queue->leaky = g_value_get_int(value);
533 queue->size_buffers = g_value_get_int(value);
536 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
542 gst_queue_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
546 /* it's not null if we got it, but it might not be ours */
547 g_return_if_fail (GST_IS_QUEUE (object));
549 queue = GST_QUEUE (object);
553 g_value_set_int(value, queue->leaky);
556 g_value_set_int(value, queue->level_buffers);
559 g_value_set_int(value, queue->size_buffers);
562 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);