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"
40 GstElementDetails gst_queue_details = {
45 "Erik Walthinsen <omega@cse.ogi.edu>",
50 /* Queue signals and args */
73 static void gst_queue_class_init (GstQueueClass *klass);
74 static void gst_queue_init (GstQueue *queue);
75 static void gst_queue_dispose (GObject *object);
77 static void gst_queue_set_property (GObject *object, guint prop_id,
78 const GValue *value, GParamSpec *pspec);
79 static void gst_queue_get_property (GObject *object, guint prop_id,
80 GValue *value, GParamSpec *pspec);
82 static void gst_queue_chain (GstPad *pad, GstBuffer *buf);
83 static GstBuffer * gst_queue_get (GstPad *pad);
84 static GstBufferPool* gst_queue_get_bufferpool (GstPad *pad);
86 static gboolean gst_queue_handle_src_event (GstPad *pad, GstEvent *event);
89 static void gst_queue_locked_flush (GstQueue *queue);
91 static GstElementStateReturn gst_queue_change_state (GstElement *element);
92 static gboolean gst_queue_release_locks (GstElement *element);
95 #define GST_TYPE_QUEUE_LEAKY (queue_leaky_get_type())
97 queue_leaky_get_type(void) {
98 static GType queue_leaky_type = 0;
99 static GEnumValue queue_leaky[] = {
100 { GST_QUEUE_NO_LEAK, "0", "Not Leaky" },
101 { GST_QUEUE_LEAK_UPSTREAM, "1", "Leaky on Upstream" },
102 { GST_QUEUE_LEAK_DOWNSTREAM, "2", "Leaky on Downstream" },
105 if (!queue_leaky_type) {
106 queue_leaky_type = g_enum_register_static("GstQueueLeaky", queue_leaky);
108 return queue_leaky_type;
111 static GstElementClass *parent_class = NULL;
112 /* static guint gst_queue_signals[LAST_SIGNAL] = { 0 }; */
115 gst_queue_get_type(void)
117 static GType queue_type = 0;
120 static const GTypeInfo queue_info = {
121 sizeof(GstQueueClass),
124 (GClassInitFunc)gst_queue_class_init,
129 (GInstanceInitFunc)gst_queue_init,
132 queue_type = g_type_register_static (GST_TYPE_ELEMENT, "GstQueue", &queue_info, 0);
138 gst_queue_class_init (GstQueueClass *klass)
140 GObjectClass *gobject_class;
141 GstElementClass *gstelement_class;
143 gobject_class = (GObjectClass*)klass;
144 gstelement_class = (GstElementClass*)klass;
146 parent_class = g_type_class_ref (GST_TYPE_ELEMENT);
148 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_LEAKY,
149 g_param_spec_enum ("leaky", "Leaky", "Where the queue leaks, if at all.",
150 GST_TYPE_QUEUE_LEAKY, GST_QUEUE_NO_LEAK, G_PARAM_READWRITE));
151 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_LEVEL,
152 g_param_spec_int ("level", "Level", "How many buffers are in the queue.",
153 0, G_MAXINT, 0, G_PARAM_READABLE));
154 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_MAX_LEVEL,
155 g_param_spec_int ("max_level", "Maximum Level", "How many buffers the queue holds.",
156 0, G_MAXINT, 100, G_PARAM_READWRITE));
157 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_MAY_DEADLOCK,
158 g_param_spec_boolean ("may_deadlock", "May Deadlock", "The queue may deadlock if it's full and not PLAYING",
159 TRUE, G_PARAM_READWRITE));
160 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_BLOCK_TIMEOUT,
161 g_param_spec_int ("block_timeout", "Timeout for Block",
162 "Microseconds until blocked queue times out and returns filler event. "
163 "Value of -1 disables timeout",
164 -1, G_MAXINT, -1, G_PARAM_READWRITE));
166 gobject_class->dispose = GST_DEBUG_FUNCPTR (gst_queue_dispose);
167 gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_queue_set_property);
168 gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_queue_get_property);
170 gstelement_class->change_state = GST_DEBUG_FUNCPTR(gst_queue_change_state);
171 gstelement_class->release_locks = GST_DEBUG_FUNCPTR(gst_queue_release_locks);
174 static GstPadConnectReturn
175 gst_queue_connect (GstPad *pad, GstCaps *caps)
177 GstQueue *queue = GST_QUEUE (gst_pad_get_parent (pad));
180 if (pad == queue->srcpad)
181 otherpad = queue->sinkpad;
183 otherpad = queue->srcpad;
185 return gst_pad_proxy_connect (otherpad, caps);
189 gst_queue_getcaps (GstPad *pad, GstCaps *caps)
191 GstQueue *queue = GST_QUEUE (gst_pad_get_parent (pad));
194 if (pad == queue->srcpad)
195 otherpad = queue->sinkpad;
197 otherpad = queue->srcpad;
199 return gst_pad_get_allowed_caps (otherpad);
203 gst_queue_init (GstQueue *queue)
205 /* scheduling on this kind of element is, well, interesting */
206 GST_FLAG_SET (queue, GST_ELEMENT_DECOUPLED);
207 GST_FLAG_SET (queue, GST_ELEMENT_EVENT_AWARE);
209 queue->sinkpad = gst_pad_new ("sink", GST_PAD_SINK);
210 gst_pad_set_chain_function (queue->sinkpad, GST_DEBUG_FUNCPTR (gst_queue_chain));
211 gst_element_add_pad (GST_ELEMENT (queue), queue->sinkpad);
212 gst_pad_set_bufferpool_function (queue->sinkpad, GST_DEBUG_FUNCPTR (gst_queue_get_bufferpool));
213 gst_pad_set_connect_function (queue->sinkpad, GST_DEBUG_FUNCPTR (gst_queue_connect));
214 gst_pad_set_getcaps_function (queue->sinkpad, GST_DEBUG_FUNCPTR (gst_queue_getcaps));
216 queue->srcpad = gst_pad_new ("src", GST_PAD_SRC);
217 gst_pad_set_get_function (queue->srcpad, GST_DEBUG_FUNCPTR (gst_queue_get));
218 gst_element_add_pad (GST_ELEMENT (queue), queue->srcpad);
219 gst_pad_set_connect_function (queue->srcpad, GST_DEBUG_FUNCPTR (gst_queue_connect));
220 gst_pad_set_getcaps_function (queue->srcpad, GST_DEBUG_FUNCPTR (gst_queue_getcaps));
221 gst_pad_set_event_function (queue->srcpad, GST_DEBUG_FUNCPTR (gst_queue_handle_src_event));
223 queue->leaky = GST_QUEUE_NO_LEAK;
225 queue->level_buffers = 0;
226 queue->level_bytes = 0;
227 queue->level_time = 0LL;
228 queue->size_buffers = 100; /* 100 buffers */
229 queue->size_bytes = 100 * 1024; /* 100KB */
230 queue->size_time = 1000000000LL; /* 1sec */
231 queue->may_deadlock = TRUE;
232 queue->block_timeout = -1;
234 queue->qlock = g_mutex_new ();
235 queue->reader = FALSE;
236 queue->writer = FALSE;
237 queue->not_empty = g_cond_new ();
238 queue->not_full = g_cond_new ();
239 GST_DEBUG_ELEMENT (GST_CAT_THREAD, queue, "initialized queue's not_empty & not_full conditions");
243 gst_queue_dispose (GObject *object)
245 GstQueue *queue = GST_QUEUE (object);
247 g_mutex_free (queue->qlock);
248 g_cond_free (queue->not_empty);
249 g_cond_free (queue->not_full);
251 G_OBJECT_CLASS (parent_class)->dispose (object);
254 static GstBufferPool*
255 gst_queue_get_bufferpool (GstPad *pad)
259 queue = GST_QUEUE (GST_OBJECT_PARENT (pad));
261 return gst_pad_get_bufferpool (queue->srcpad);
265 gst_queue_cleanup_buffers (gpointer data, const gpointer user_data)
267 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, user_data, "cleaning buffer %p", data);
269 if (GST_IS_BUFFER (data)) {
270 gst_buffer_unref (GST_BUFFER (data));
273 gst_event_free (GST_EVENT (data));
278 gst_queue_locked_flush (GstQueue *queue)
280 g_list_foreach (queue->queue, gst_queue_cleanup_buffers,
282 g_list_free (queue->queue);
285 queue->level_buffers = 0;
286 queue->timeval = NULL;
290 gst_queue_chain (GstPad *pad, GstBuffer *buf)
295 g_return_if_fail (pad != NULL);
296 g_return_if_fail (GST_IS_PAD (pad));
297 g_return_if_fail (buf != NULL);
299 queue = GST_QUEUE (GST_OBJECT_PARENT (pad));
302 /* we have to lock the queue since we span threads */
303 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "locking t:%ld", pthread_self ());
304 g_mutex_lock (queue->qlock);
305 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "locked t:%ld", pthread_self ());
307 if (GST_IS_EVENT (buf)) {
308 switch (GST_EVENT_TYPE (buf)) {
309 case GST_EVENT_FLUSH:
310 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "FLUSH event, flushing queue\n");
311 gst_queue_locked_flush (queue);
314 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "eos in on %s %d\n",
315 GST_ELEMENT_NAME (queue), queue->level_buffers);
317 case GST_EVENT_DISCONTINUOUS:
318 gst_queue_locked_flush (queue);
321 /*gst_pad_event_default (pad, GST_EVENT (buf)); */
326 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "adding buffer %p of size %d",buf,GST_BUFFER_SIZE(buf));
328 if (queue->level_buffers == queue->size_buffers) {
329 /* if this is a leaky queue... */
331 /* FIXME don't want to leak events! */
332 /* if we leak on the upstream side, drop the current buffer */
333 if (queue->leaky == GST_QUEUE_LEAK_UPSTREAM) {
334 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "queue is full, leaking buffer on upstream end");
335 if (GST_IS_EVENT (buf))
336 fprintf(stderr, "Error: queue [%s] leaked an event, type:%d\n",
337 GST_ELEMENT_NAME(GST_ELEMENT(queue)),
338 GST_EVENT_TYPE(GST_EVENT(buf)));
339 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "queue is full, leaking buffer on upstream end");
340 gst_buffer_unref(buf);
341 /* now we have to clean up and exit right away */
342 g_mutex_unlock (queue->qlock);
345 /* otherwise we have to push a buffer off the other end */
349 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "queue is full, leaking buffer on downstream end");
350 front = queue->queue;
351 leakbuf = (GstBuffer *)(front->data);
352 if (GST_IS_EVENT (leakbuf))
353 fprintf(stderr, "Error: queue [%s] leaked an event, type:%d\n",
354 GST_ELEMENT_NAME(GST_ELEMENT(queue)),
355 GST_EVENT_TYPE(GST_EVENT(leakbuf)));
356 queue->level_buffers--;
357 queue->level_bytes -= GST_BUFFER_SIZE(leakbuf);
358 gst_buffer_unref(leakbuf);
359 queue->queue = g_list_remove_link (queue->queue, front);
364 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "pre full wait, level:%d/%d",
365 queue->level_buffers, queue->size_buffers);
366 while (queue->level_buffers == queue->size_buffers) {
367 /* if there's a pending state change for this queue or its manager, switch */
368 /* back to iterator so bottom half of state change executes */
369 //while (GST_STATE_PENDING (queue) != GST_STATE_VOID_PENDING) {
370 if (queue->interrupt) {
371 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "interrupted!!");
372 g_mutex_unlock (queue->qlock);
373 if (gst_scheduler_interrupt (GST_RPAD_SCHED (queue->sinkpad), GST_ELEMENT (queue)))
377 if (GST_STATE (queue) != GST_STATE_PLAYING) {
378 /* this means the other end is shut down */
379 /* try to signal to resolve the error */
380 if (!queue->may_deadlock) {
381 if (GST_IS_BUFFER (buf)) gst_buffer_unref (buf);
382 else gst_event_free (GST_EVENT (buf));
383 g_mutex_unlock (queue->qlock);
384 gst_element_error (GST_ELEMENT (queue), "deadlock found, source pad elements are shut down");
388 g_print ("%s: waiting for the app to restart source pad elements\n", GST_ELEMENT_NAME (queue));
392 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "waiting for not_full, level:%d/%d",
393 queue->level_buffers, queue->size_buffers);
395 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "WARNING: multiple writers on queue!");
396 queue->writer = TRUE;
397 g_cond_wait (queue->not_full, queue->qlock);
398 queue->writer = FALSE;
399 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "got not_full signal");
401 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "post full wait, level:%d/%d",
402 queue->level_buffers, queue->size_buffers);
405 /* put the buffer on the tail of the list */
406 queue->queue = g_list_append (queue->queue, buf);
407 queue->level_buffers++;
408 queue->level_bytes += GST_BUFFER_SIZE(buf);
410 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "(%s:%s)+ level:%d/%d",
411 GST_DEBUG_PAD_NAME(pad),
412 queue->level_buffers, queue->size_buffers);
414 /* this assertion _has_ to hold */
415 /* g_assert (g_list_length (queue->queue) == queue->level_buffers); */
417 /* reader waiting on an empty queue */
418 reader = queue->reader;
420 g_mutex_unlock (queue->qlock);
424 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "signalling not_empty");
425 g_cond_signal (queue->not_empty);
430 gst_queue_get (GstPad *pad)
433 GstBuffer *buf = NULL;
437 g_assert(pad != NULL);
438 g_assert(GST_IS_PAD(pad));
439 g_return_val_if_fail (pad != NULL, NULL);
440 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
442 queue = GST_QUEUE (GST_OBJECT_PARENT (pad));
445 /* have to lock for thread-safety */
446 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "locking t:%ld", pthread_self ());
447 g_mutex_lock (queue->qlock);
448 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "locked t:%ld %p", pthread_self (), queue->not_empty);
450 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "pre empty wait, level:%d/%d", queue->level_buffers, queue->size_buffers);
451 while (queue->level_buffers == 0) {
452 /* if there's a pending state change for this queue or its manager, switch
453 * back to iterator so bottom half of state change executes
455 //while (GST_STATE_PENDING (queue) != GST_STATE_VOID_PENDING) {
456 if (queue->interrupt) {
457 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "interrupted!!");
458 g_mutex_unlock (queue->qlock);
459 if (gst_scheduler_interrupt (GST_RPAD_SCHED (queue->srcpad), GST_ELEMENT (queue)))
463 if (GST_STATE (queue) != GST_STATE_PLAYING) {
464 /* this means the other end is shut down */
465 if (!queue->may_deadlock) {
466 g_mutex_unlock (queue->qlock);
467 gst_element_error (GST_ELEMENT (queue), "deadlock found, sink pad elements are shut down");
471 g_print ("%s: waiting for the app to restart source pad elements\n", GST_ELEMENT_NAME (queue));
475 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "waiting for not_empty, level:%d/%d", queue->level_buffers, queue->size_buffers);
477 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "WARNING: multiple readers on queue!");
478 queue->reader = TRUE;
480 if (queue->block_timeout > -1){
482 g_get_current_time(&timeout);
483 g_time_val_add(&timeout, queue->block_timeout);
484 if (!g_cond_timed_wait (queue->not_empty, queue->qlock, &timeout)){
485 g_mutex_unlock (queue->qlock);
486 return GST_BUFFER(gst_event_new_filler());
490 g_cond_wait (queue->not_empty, queue->qlock);
492 queue->reader = FALSE;
493 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "got not_empty signal");
495 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "post empty wait, level:%d/%d", queue->level_buffers, queue->size_buffers);
497 front = queue->queue;
498 buf = (GstBuffer *)(front->data);
499 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "retrieved buffer %p from queue", buf);
500 queue->queue = g_list_remove_link (queue->queue, front);
503 queue->level_buffers--;
504 queue->level_bytes -= GST_BUFFER_SIZE(buf);
506 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "(%s:%s)- level:%d/%d",
507 GST_DEBUG_PAD_NAME(pad),
508 queue->level_buffers, queue->size_buffers);
510 /* this assertion _has_ to hold */
511 /* g_assert (g_list_length (queue->queue) == queue->level_buffers); */
513 /* writer waiting on a full queue */
514 writer = queue->writer;
516 g_mutex_unlock (queue->qlock);
520 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "signalling not_full");
521 g_cond_signal (queue->not_full);
524 /* FIXME where should this be? locked? */
525 if (GST_IS_EVENT(buf)) {
526 GstEvent *event = GST_EVENT(buf);
527 switch (GST_EVENT_TYPE(event)) {
529 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "queue \"%s\" eos", GST_ELEMENT_NAME (queue));
530 gst_element_set_eos (GST_ELEMENT (queue));
542 gst_queue_handle_src_event (GstPad *pad, GstEvent *event)
547 queue = GST_QUEUE (GST_OBJECT_PARENT (pad));
549 g_mutex_lock (queue->qlock);
551 if (gst_element_get_state (GST_ELEMENT (queue)) == GST_STATE_PLAYING) {
552 g_mutex_unlock (queue->qlock);
553 g_warning ("queue event in playing state");
557 res = gst_pad_event_default (pad, event);
559 switch (GST_EVENT_TYPE (event)) {
560 case GST_EVENT_FLUSH:
561 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "FLUSH event, flushing queue\n");
562 gst_queue_locked_flush (queue);
565 if (GST_EVENT_SEEK_FLAGS (event) & GST_SEEK_FLAG_FLUSH)
566 gst_queue_locked_flush (queue);
571 g_mutex_unlock (queue->qlock);
577 gst_queue_release_locks (GstElement *element)
581 queue = GST_QUEUE (element);
583 g_mutex_lock (queue->qlock);
584 queue->interrupt = TRUE;
585 g_cond_signal (queue->not_full);
586 g_cond_signal (queue->not_empty);
587 g_mutex_unlock (queue->qlock);
592 static GstElementStateReturn
593 gst_queue_change_state (GstElement *element)
596 GstElementStateReturn ret;
597 GstElementState new_state;
598 g_return_val_if_fail (GST_IS_QUEUE (element), GST_STATE_FAILURE);
600 queue = GST_QUEUE (element);
602 GST_DEBUG_ENTER("('%s')", GST_ELEMENT_NAME (element));
604 /* lock the queue so another thread (not in sync with this thread's state)
605 * can't call this queue's _get (or whatever)
607 g_mutex_lock (queue->qlock);
609 new_state = GST_STATE_PENDING (element);
611 if (new_state == GST_STATE_PAUSED) {
612 /*g_cond_signal (queue->not_full); */
613 /*g_cond_signal (queue->not_empty); */
615 else if (new_state == GST_STATE_READY) {
616 gst_queue_locked_flush (queue);
618 else if (new_state == GST_STATE_PLAYING) {
619 if (!GST_PAD_IS_CONNECTED (queue->sinkpad)) {
620 GST_DEBUG_ELEMENT (GST_CAT_STATES, queue, "queue %s is not connected", GST_ELEMENT_NAME (queue));
621 /* FIXME can this be? */
623 g_cond_signal (queue->not_empty);
624 g_mutex_unlock (queue->qlock);
626 return GST_STATE_FAILURE;
628 queue->interrupt = FALSE;
631 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element);
632 g_mutex_unlock (queue->qlock);
634 GST_DEBUG_LEAVE("('%s')", GST_ELEMENT_NAME (element));
640 gst_queue_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
644 /* it's not null if we got it, but it might not be ours */
645 g_return_if_fail (GST_IS_QUEUE (object));
647 queue = GST_QUEUE (object);
651 queue->leaky = g_value_get_enum (value);
654 queue->size_buffers = g_value_get_int (value);
656 case ARG_MAY_DEADLOCK:
657 queue->may_deadlock = g_value_get_boolean (value);
659 case ARG_BLOCK_TIMEOUT:
660 queue->block_timeout = g_value_get_int (value);
663 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
669 gst_queue_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
673 /* it's not null if we got it, but it might not be ours */
674 g_return_if_fail (GST_IS_QUEUE (object));
676 queue = GST_QUEUE (object);
680 g_value_set_enum (value, queue->leaky);
683 g_value_set_int (value, queue->level_buffers);
686 g_value_set_int (value, queue->size_buffers);
688 case ARG_MAY_DEADLOCK:
689 g_value_set_boolean (value, queue->may_deadlock);
691 case ARG_BLOCK_TIMEOUT:
692 g_value_set_int (value, queue->block_timeout);
695 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);