2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
4 * 2003 Colin Walters <cwalters@gnome.org>
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
25 #include "gst_private.h"
28 #include "gstscheduler.h"
33 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
38 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
43 GST_DEBUG_CATEGORY_STATIC (queue_dataflow);
44 #define GST_CAT_DEFAULT (queue_dataflow)
46 #define STATUS(queue, msg) \
47 GST_CAT_LOG_OBJECT (queue_dataflow, queue, \
48 "(%s:%s) " msg ": %u of %u-%u buffers, %u of %u-%u " \
49 "bytes, %" G_GUINT64_FORMAT " of %" G_GUINT64_FORMAT \
50 "-%" G_GUINT64_FORMAT " ns, %u elements", \
51 GST_DEBUG_PAD_NAME (pad), \
52 queue->cur_level.buffers, \
53 queue->min_threshold.buffers, \
54 queue->max_size.buffers, \
55 queue->cur_level.bytes, \
56 queue->min_threshold.bytes, \
57 queue->max_size.bytes, \
58 queue->cur_level.time, \
59 queue->min_threshold.time, \
60 queue->max_size.time, \
63 static GstElementDetails gst_queue_details = GST_ELEMENT_DETAILS ("Queue",
66 "Erik Walthinsen <omega@cse.ogi.edu>");
69 /* Queue signals and args */
81 /* FIXME: don't we have another way of doing this
82 * "Gstreamer format" (frame/byte/time) queries? */
83 ARG_CUR_LEVEL_BUFFERS,
89 ARG_MIN_THRESHOLD_BUFFERS,
90 ARG_MIN_THRESHOLD_BYTES,
91 ARG_MIN_THRESHOLD_TIME,
98 #define GST_QUEUE_MUTEX_LOCK G_STMT_START { \
99 GST_CAT_LOG_OBJECT (queue_dataflow, queue, \
100 "locking qlock from thread %p", \
102 g_mutex_lock (queue->qlock); \
103 GST_CAT_LOG_OBJECT (queue_dataflow, queue, \
104 "locked qlock from thread %p", \
108 #define GST_QUEUE_MUTEX_UNLOCK G_STMT_START { \
109 GST_CAT_LOG_OBJECT (queue_dataflow, queue, \
110 "unlocking qlock from thread %p", \
112 g_mutex_unlock (queue->qlock); \
116 typedef struct _GstQueueEventResponse
119 gboolean ret, handled;
121 GstQueueEventResponse;
123 static void gst_queue_base_init (GstQueueClass * klass);
124 static void gst_queue_class_init (GstQueueClass * klass);
125 static void gst_queue_init (GstQueue * queue);
126 static void gst_queue_finalize (GObject * object);
128 static void gst_queue_set_property (GObject * object,
129 guint prop_id, const GValue * value, GParamSpec * pspec);
130 static void gst_queue_get_property (GObject * object,
131 guint prop_id, GValue * value, GParamSpec * pspec);
133 static void gst_queue_chain (GstPad * pad, GstData * data);
134 static GstData *gst_queue_get (GstPad * pad);
136 static gboolean gst_queue_handle_src_event (GstPad * pad, GstEvent * event);
137 static gboolean gst_queue_handle_src_query (GstPad * pad,
138 GstQueryType type, GstFormat * fmt, gint64 * value);
140 static GstCaps *gst_queue_getcaps (GstPad * pad);
141 static GstPadLinkReturn
142 gst_queue_link_sink (GstPad * pad, const GstCaps * caps);
143 static GstPadLinkReturn gst_queue_link_src (GstPad * pad, const GstCaps * caps);
144 static void gst_queue_locked_flush (GstQueue * queue);
146 static GstElementStateReturn gst_queue_change_state (GstElement * element);
147 static gboolean gst_queue_release_locks (GstElement * element);
150 #define GST_TYPE_QUEUE_LEAKY (queue_leaky_get_type ())
153 queue_leaky_get_type (void)
155 static GType queue_leaky_type = 0;
156 static GEnumValue queue_leaky[] = {
157 {GST_QUEUE_NO_LEAK, "0", "Not Leaky"},
158 {GST_QUEUE_LEAK_UPSTREAM, "1", "Leaky on Upstream"},
159 {GST_QUEUE_LEAK_DOWNSTREAM, "2", "Leaky on Downstream"},
163 if (!queue_leaky_type) {
164 queue_leaky_type = g_enum_register_static ("GstQueueLeaky", queue_leaky);
166 return queue_leaky_type;
169 static GstElementClass *parent_class = NULL;
170 static guint gst_queue_signals[LAST_SIGNAL] = { 0 };
173 gst_queue_get_type (void)
175 static GType queue_type = 0;
178 static const GTypeInfo queue_info = {
179 sizeof (GstQueueClass),
180 (GBaseInitFunc) gst_queue_base_init,
182 (GClassInitFunc) gst_queue_class_init,
187 (GInstanceInitFunc) gst_queue_init,
191 queue_type = g_type_register_static (GST_TYPE_ELEMENT,
192 "GstQueue", &queue_info, 0);
193 GST_DEBUG_CATEGORY_INIT (queue_dataflow, "queue_dataflow", 0,
194 "dataflow inside the queue element");
201 gst_queue_base_init (GstQueueClass * klass)
203 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
205 gst_element_class_add_pad_template (gstelement_class,
206 gst_static_pad_template_get (&srctemplate));
207 gst_element_class_add_pad_template (gstelement_class,
208 gst_static_pad_template_get (&sinktemplate));
209 gst_element_class_set_details (gstelement_class, &gst_queue_details);
213 gst_queue_class_init (GstQueueClass * klass)
215 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
216 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
218 parent_class = g_type_class_peek_parent (klass);
221 gst_queue_signals[SIGNAL_UNDERRUN] =
222 g_signal_new ("underrun", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_FIRST,
223 G_STRUCT_OFFSET (GstQueueClass, underrun), NULL, NULL,
224 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
225 gst_queue_signals[SIGNAL_RUNNING] =
226 g_signal_new ("running", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_FIRST,
227 G_STRUCT_OFFSET (GstQueueClass, running), NULL, NULL,
228 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
229 gst_queue_signals[SIGNAL_OVERRUN] =
230 g_signal_new ("overrun", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_FIRST,
231 G_STRUCT_OFFSET (GstQueueClass, overrun), NULL, NULL,
232 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
235 g_object_class_install_property (gobject_class, ARG_CUR_LEVEL_BYTES,
236 g_param_spec_uint ("current-level-bytes", "Current level (kB)",
237 "Current amount of data in the queue (bytes)",
238 0, G_MAXUINT, 0, G_PARAM_READABLE));
239 g_object_class_install_property (gobject_class, ARG_CUR_LEVEL_BUFFERS,
240 g_param_spec_uint ("current-level-buffers", "Current level (buffers)",
241 "Current number of buffers in the queue",
242 0, G_MAXUINT, 0, G_PARAM_READABLE));
243 g_object_class_install_property (gobject_class, ARG_CUR_LEVEL_TIME,
244 g_param_spec_uint64 ("current-level-time", "Current level (ns)",
245 "Current amount of data in the queue (in ns)",
246 0, G_MAXUINT64, 0, G_PARAM_READABLE));
248 g_object_class_install_property (gobject_class, ARG_MAX_SIZE_BYTES,
249 g_param_spec_uint ("max-size-bytes", "Max. size (kB)",
250 "Max. amount of data in the queue (bytes, 0=disable)",
251 0, G_MAXUINT, 0, G_PARAM_READWRITE));
252 g_object_class_install_property (gobject_class, ARG_MAX_SIZE_BUFFERS,
253 g_param_spec_uint ("max-size-buffers", "Max. size (buffers)",
254 "Max. number of buffers in the queue (0=disable)",
255 0, G_MAXUINT, 0, G_PARAM_READWRITE));
256 g_object_class_install_property (gobject_class, ARG_MAX_SIZE_TIME,
257 g_param_spec_uint64 ("max-size-time", "Max. size (ns)",
258 "Max. amount of data in the queue (in ns, 0=disable)",
259 0, G_MAXUINT64, 0, G_PARAM_READWRITE));
261 g_object_class_install_property (gobject_class, ARG_MIN_THRESHOLD_BYTES,
262 g_param_spec_uint ("min-threshold-bytes", "Min. threshold (kB)",
263 "Min. amount of data in the queue to allow reading (bytes, 0=disable)",
264 0, G_MAXUINT, 0, G_PARAM_READWRITE));
265 g_object_class_install_property (gobject_class, ARG_MIN_THRESHOLD_BUFFERS,
266 g_param_spec_uint ("min-threshold-buffers", "Min. threshold (buffers)",
267 "Min. number of buffers in the queue to allow reading (0=disable)",
268 0, G_MAXUINT, 0, G_PARAM_READWRITE));
269 g_object_class_install_property (gobject_class, ARG_MIN_THRESHOLD_TIME,
270 g_param_spec_uint64 ("min-threshold-time", "Min. threshold (ns)",
271 "Min. amount of data in the queue to allow reading (in ns, 0=disable)",
272 0, G_MAXUINT64, 0, G_PARAM_READWRITE));
274 g_object_class_install_property (gobject_class, ARG_LEAKY,
275 g_param_spec_enum ("leaky", "Leaky",
276 "Where the queue leaks, if at all",
277 GST_TYPE_QUEUE_LEAKY, GST_QUEUE_NO_LEAK, G_PARAM_READWRITE));
278 g_object_class_install_property (gobject_class, ARG_MAY_DEADLOCK,
279 g_param_spec_boolean ("may_deadlock", "May Deadlock",
280 "The queue may deadlock if it's full and not PLAYING",
281 TRUE, G_PARAM_READWRITE));
282 g_object_class_install_property (gobject_class, ARG_BLOCK_TIMEOUT,
283 g_param_spec_uint64 ("block_timeout", "Timeout for Block",
284 "Nanoseconds until blocked queue times out and returns filler event. "
285 "Value of -1 disables timeout",
286 0, G_MAXUINT64, -1, G_PARAM_READWRITE));
288 /* set several parent class virtual functions */
289 gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_queue_finalize);
290 gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_queue_set_property);
291 gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_queue_get_property);
293 gstelement_class->change_state = GST_DEBUG_FUNCPTR (gst_queue_change_state);
294 gstelement_class->release_locks = GST_DEBUG_FUNCPTR (gst_queue_release_locks);
298 gst_queue_init (GstQueue * queue)
300 /* scheduling on this kind of element is, well, interesting */
301 GST_FLAG_SET (queue, GST_ELEMENT_DECOUPLED);
302 GST_FLAG_SET (queue, GST_ELEMENT_EVENT_AWARE);
305 gst_pad_new_from_template (gst_static_pad_template_get (&sinktemplate),
307 gst_pad_set_chain_function (queue->sinkpad,
308 GST_DEBUG_FUNCPTR (gst_queue_chain));
309 gst_element_add_pad (GST_ELEMENT (queue), queue->sinkpad);
310 gst_pad_set_link_function (queue->sinkpad,
311 GST_DEBUG_FUNCPTR (gst_queue_link_sink));
312 gst_pad_set_getcaps_function (queue->sinkpad,
313 GST_DEBUG_FUNCPTR (gst_queue_getcaps));
314 gst_pad_set_active (queue->sinkpad, TRUE);
317 gst_pad_new_from_template (gst_static_pad_template_get (&srctemplate),
319 gst_pad_set_get_function (queue->srcpad, GST_DEBUG_FUNCPTR (gst_queue_get));
320 gst_element_add_pad (GST_ELEMENT (queue), queue->srcpad);
321 gst_pad_set_link_function (queue->srcpad,
322 GST_DEBUG_FUNCPTR (gst_queue_link_src));
323 gst_pad_set_getcaps_function (queue->srcpad,
324 GST_DEBUG_FUNCPTR (gst_queue_getcaps));
325 gst_pad_set_event_function (queue->srcpad,
326 GST_DEBUG_FUNCPTR (gst_queue_handle_src_event));
327 gst_pad_set_query_function (queue->srcpad,
328 GST_DEBUG_FUNCPTR (gst_queue_handle_src_query));
329 gst_pad_set_active (queue->srcpad, TRUE);
331 queue->cur_level.buffers = 0; /* no content */
332 queue->cur_level.bytes = 0; /* no content */
333 queue->cur_level.time = 0; /* no content */
334 queue->max_size.buffers = 100; /* 100 buffers */
335 queue->max_size.bytes = 10 * 1024 * 1024; /* 10 MB */
336 queue->max_size.time = GST_SECOND; /* 1 s. */
337 queue->min_threshold.buffers = 0; /* no threshold */
338 queue->min_threshold.bytes = 0; /* no threshold */
339 queue->min_threshold.time = 0; /* no threshold */
341 queue->leaky = GST_QUEUE_NO_LEAK;
342 queue->may_deadlock = TRUE;
343 queue->block_timeout = GST_CLOCK_TIME_NONE;
344 queue->interrupt = FALSE;
345 queue->flush = FALSE;
347 queue->qlock = g_mutex_new ();
348 queue->item_add = g_cond_new ();
349 queue->item_del = g_cond_new ();
350 queue->event_done = g_cond_new ();
351 queue->events = g_queue_new ();
352 queue->event_lock = g_mutex_new ();
353 queue->queue = g_queue_new ();
355 GST_CAT_DEBUG_OBJECT (GST_CAT_THREAD, queue,
356 "initialized queue's not_empty & not_full conditions");
359 /* called only once, as opposed to dispose */
361 gst_queue_finalize (GObject * object)
363 GstQueue *queue = GST_QUEUE (object);
365 GST_DEBUG_OBJECT (queue, "finalizing queue");
367 while (!g_queue_is_empty (queue->queue)) {
368 GstData *data = g_queue_pop_head (queue->queue);
370 gst_data_unref (data);
372 g_queue_free (queue->queue);
373 g_mutex_free (queue->qlock);
374 g_cond_free (queue->item_add);
375 g_cond_free (queue->item_del);
376 g_cond_free (queue->event_done);
377 g_mutex_lock (queue->event_lock);
378 while (!g_queue_is_empty (queue->events)) {
379 GstQueueEventResponse *er = g_queue_pop_head (queue->events);
381 gst_event_unref (er->event);
383 g_mutex_unlock (queue->event_lock);
384 g_mutex_free (queue->event_lock);
385 g_queue_free (queue->events);
387 if (G_OBJECT_CLASS (parent_class)->finalize)
388 G_OBJECT_CLASS (parent_class)->finalize (object);
392 gst_queue_getcaps (GstPad * pad)
396 queue = GST_QUEUE (gst_pad_get_parent (pad));
398 if (pad == queue->srcpad && queue->cur_level.bytes > 0) {
399 return gst_caps_copy (queue->negotiated_caps);
402 return gst_pad_proxy_getcaps (pad);
405 static GstPadLinkReturn
406 gst_queue_link_sink (GstPad * pad, const GstCaps * caps)
409 GstPadLinkReturn link_ret;
411 queue = GST_QUEUE (gst_pad_get_parent (pad));
413 if (queue->cur_level.bytes > 0) {
414 if (gst_caps_is_equal (caps, queue->negotiated_caps)) {
415 return GST_PAD_LINK_OK;
416 } else if (GST_STATE (queue) != GST_STATE_PLAYING) {
417 return GST_PAD_LINK_DELAYED;
420 /* Wait until the queue is empty before attempting the pad
422 GST_QUEUE_MUTEX_LOCK;
424 STATUS (queue, "waiting for queue to get empty");
425 while (queue->cur_level.bytes > 0) {
426 g_cond_wait (queue->item_del, queue->qlock);
427 if (queue->interrupt) {
428 GST_QUEUE_MUTEX_UNLOCK;
429 return GST_PAD_LINK_DELAYED;
432 STATUS (queue, "queue is now empty");
434 GST_QUEUE_MUTEX_UNLOCK;
437 link_ret = gst_pad_proxy_pad_link (pad, caps);
439 if (GST_PAD_LINK_SUCCESSFUL (link_ret)) {
440 /* we store an extra copy of the negotiated caps, just in case
441 * the pads become unnegotiated while we have buffers */
442 gst_caps_replace (&queue->negotiated_caps, gst_caps_copy (caps));
448 static GstPadLinkReturn
449 gst_queue_link_src (GstPad * pad, const GstCaps * caps)
452 GstPadLinkReturn link_ret;
454 queue = GST_QUEUE (gst_pad_get_parent (pad));
456 if (queue->cur_level.bytes > 0) {
457 if (gst_caps_is_equal (caps, queue->negotiated_caps)) {
458 return GST_PAD_LINK_OK;
460 return GST_PAD_LINK_REFUSED;
463 link_ret = gst_pad_proxy_pad_link (pad, caps);
465 if (GST_PAD_LINK_SUCCESSFUL (link_ret)) {
466 /* we store an extra copy of the negotiated caps, just in case
467 * the pads become unnegotiated while we have buffers */
468 gst_caps_replace (&queue->negotiated_caps, gst_caps_copy (caps));
475 gst_queue_locked_flush (GstQueue * queue)
477 while (!g_queue_is_empty (queue->queue)) {
478 GstData *data = g_queue_pop_head (queue->queue);
480 /* First loose the reference we added when putting that data in the queue */
481 gst_data_unref (data);
482 /* Then loose another reference because we are supposed to destroy that
483 data when flushing */
484 gst_data_unref (data);
486 queue->timeval = NULL;
487 queue->cur_level.buffers = 0;
488 queue->cur_level.bytes = 0;
489 queue->cur_level.time = 0;
491 /* make sure any pending buffers to be added are flushed too */
494 /* we deleted something... */
495 g_cond_signal (queue->item_del);
499 gst_queue_handle_pending_events (GstQueue * queue)
501 /* check for events to send upstream */
502 /* g_queue_get_length is glib 2.4, so don't depend on it yet, use ->length */
503 GST_CAT_DEBUG_OBJECT (queue_dataflow, queue,
504 "handling pending events, events queue of size %d",
505 queue->events->length);
506 g_mutex_lock (queue->event_lock);
507 while (!g_queue_is_empty (queue->events)) {
508 GstQueueEventResponse *er;
510 er = g_queue_pop_head (queue->events);
512 GST_CAT_DEBUG_OBJECT (queue_dataflow, queue,
513 "sending event %p (%d) from event response %p upstream",
514 er->event, GST_EVENT_TYPE (er->event), er);
516 /* change this to an assert when this file gets reviewed properly. */
517 GST_ELEMENT_ERROR (queue, CORE, EVENT, (NULL),
518 ("already handled event %p (%d) from event response %p upstream",
519 er->event, GST_EVENT_TYPE (er->event), er));
522 g_mutex_unlock (queue->event_lock);
523 er->ret = gst_pad_event_default (queue->srcpad, er->event);
525 g_cond_signal (queue->event_done);
526 g_mutex_lock (queue->event_lock);
527 GST_CAT_DEBUG_OBJECT (queue_dataflow, queue, "event sent");
529 g_mutex_unlock (queue->event_lock);
533 gst_queue_chain (GstPad * pad, GstData * data)
537 g_return_if_fail (pad != NULL);
538 g_return_if_fail (GST_IS_PAD (pad));
539 g_return_if_fail (data != NULL);
541 queue = GST_QUEUE (GST_OBJECT_PARENT (pad));
544 /* we have to lock the queue since we span threads */
545 GST_QUEUE_MUTEX_LOCK;
547 gst_queue_handle_pending_events (queue);
549 /* assume don't need to flush this buffer when the queue is filled */
550 queue->flush = FALSE;
552 if (GST_IS_EVENT (data)) {
553 switch (GST_EVENT_TYPE (data)) {
554 case GST_EVENT_FLUSH:
555 STATUS (queue, "received flush event");
556 gst_queue_locked_flush (queue);
557 STATUS (queue, "after flush");
560 STATUS (queue, "received EOS");
563 /* we put the event in the queue, we don't have to act ourselves */
564 GST_CAT_LOG_OBJECT (queue_dataflow, queue,
565 "adding event %p of type %d", data, GST_EVENT_TYPE (data));
570 if (GST_IS_BUFFER (data))
571 GST_CAT_LOG_OBJECT (queue_dataflow, queue,
572 "adding buffer %p of size %d", data, GST_BUFFER_SIZE (data));
574 /* We make space available if we're "full" according to whatever
575 * the user defined as "full". Note that this only applies to buffers.
576 * We always handle events and they don't count in our statistics. */
577 if (GST_IS_BUFFER (data) &&
578 ((queue->max_size.buffers > 0 &&
579 queue->cur_level.buffers >= queue->max_size.buffers) ||
580 (queue->max_size.bytes > 0 &&
581 queue->cur_level.bytes >= queue->max_size.bytes) ||
582 (queue->max_size.time > 0 &&
583 queue->cur_level.time >= queue->max_size.time))) {
584 GST_QUEUE_MUTEX_UNLOCK;
585 g_signal_emit (G_OBJECT (queue), gst_queue_signals[SIGNAL_OVERRUN], 0);
586 GST_QUEUE_MUTEX_LOCK;
588 /* how are we going to make space for this buffer? */
589 switch (queue->leaky) {
590 /* leak current buffer */
591 case GST_QUEUE_LEAK_UPSTREAM:
592 GST_CAT_DEBUG_OBJECT (queue_dataflow, queue,
593 "queue is full, leaking buffer on upstream end");
594 /* now we can clean up and exit right away */
595 GST_QUEUE_MUTEX_UNLOCK;
598 /* leak first buffer in the queue */
599 case GST_QUEUE_LEAK_DOWNSTREAM:{
600 /* this is a bit hacky. We'll manually iterate the list
601 * and find the first buffer from the head on. We'll
602 * unref that and "fix up" the GQueue object... */
604 GstData *leak = NULL;
606 GST_CAT_DEBUG_OBJECT (queue_dataflow, queue,
607 "queue is full, leaking buffer on downstream end");
609 for (item = queue->queue->head; item != NULL; item = item->next) {
610 if (GST_IS_BUFFER (item->data)) {
616 /* if we didn't find anything, it means we have no buffers
617 * in here. That cannot happen, since we had >= 1 bufs */
620 /* Now remove it from the list, fixing up the GQueue
621 * CHECKME: is a queue->head the first or the last item? */
622 item = g_list_delete_link (queue->queue->head, item);
623 queue->queue->head = g_list_first (item);
624 queue->queue->tail = g_list_last (item);
625 queue->queue->length--;
627 /* and unref the data at the end. Twice, because we keep a ref
628 * to make things read-only. Also keep our list uptodate. */
629 queue->cur_level.bytes -= GST_BUFFER_SIZE (data);
630 queue->cur_level.buffers--;
631 if (GST_BUFFER_DURATION (data) != GST_CLOCK_TIME_NONE)
632 queue->cur_level.time -= GST_BUFFER_DURATION (data);
634 gst_data_unref (data);
635 gst_data_unref (data);
640 g_warning ("Unknown leaky type, using default");
643 /* don't leak. Instead, wait for space to be available */
644 case GST_QUEUE_NO_LEAK:
645 STATUS (queue, "pre-full wait");
647 while ((queue->max_size.buffers > 0 &&
648 queue->cur_level.buffers >= queue->max_size.buffers) ||
649 (queue->max_size.bytes > 0 &&
650 queue->cur_level.bytes >= queue->max_size.bytes) ||
651 (queue->max_size.time > 0 &&
652 queue->cur_level.time >= queue->max_size.time)) {
653 /* if there's a pending state change for this queue
654 * or its manager, switch back to iterator so bottom
655 * half of state change executes */
656 if (queue->interrupt) {
659 GST_CAT_DEBUG_OBJECT (queue_dataflow, queue, "interrupted");
660 queue->interrupt = FALSE;
661 GST_QUEUE_MUTEX_UNLOCK;
662 sched = gst_pad_get_scheduler (queue->sinkpad);
663 if (!sched || gst_scheduler_interrupt (sched, GST_ELEMENT (queue))) {
666 /* if we got here because we were unlocked after a
667 * flush, we don't need to add the buffer to the
670 GST_CAT_DEBUG_OBJECT (queue_dataflow, queue,
671 "not adding pending buffer after flush");
674 GST_CAT_DEBUG_OBJECT (queue_dataflow, queue,
675 "adding pending buffer after interrupt");
679 if (GST_STATE (queue) != GST_STATE_PLAYING) {
680 /* this means the other end is shut down. Try to
681 * signal to resolve the error */
682 if (!queue->may_deadlock) {
683 GST_QUEUE_MUTEX_UNLOCK;
684 gst_data_unref (data);
685 GST_ELEMENT_ERROR (queue, CORE, THREAD, (NULL),
686 ("deadlock found, shutting down source pad elements"));
687 /* we don't go to out_unref here, since we want to
688 * unref the buffer *before* calling GST_ELEMENT_ERROR */
691 GST_CAT_WARNING_OBJECT (queue_dataflow, queue,
692 "%s: waiting for the app to restart "
693 "source pad elements", GST_ELEMENT_NAME (queue));
697 /* OK, we've got a serious issue here. Imagine the situation
698 * where the puller (next element) is sending an event here,
699 * so it cannot pull events from the queue, and we cannot
700 * push data further because the queue is 'full' and therefore,
701 * we wait here (and do not handle events): deadlock! to solve
702 * that, we handle pending upstream events here, too. */
703 gst_queue_handle_pending_events (queue);
705 STATUS (queue, "waiting for item_del signal from thread using qlock");
706 g_cond_wait (queue->item_del, queue->qlock);
707 STATUS (queue, "received item_del signal from thread using qlock");
710 STATUS (queue, "post-full wait");
711 GST_QUEUE_MUTEX_UNLOCK;
712 g_signal_emit (G_OBJECT (queue), gst_queue_signals[SIGNAL_RUNNING], 0);
713 GST_QUEUE_MUTEX_LOCK;
718 /* put the buffer on the tail of the list. We keep a reference,
719 * so that the data is read-only while in here. There's a good
720 * reason to do so: we have a size and time counter, and any
721 * modification to the content could change any of the two. */
723 g_queue_push_tail (queue->queue, data);
725 /* Note that we only add buffers (not events) to the statistics */
726 if (GST_IS_BUFFER (data)) {
727 queue->cur_level.buffers++;
728 queue->cur_level.bytes += GST_BUFFER_SIZE (data);
729 if (GST_BUFFER_DURATION (data) != GST_CLOCK_TIME_NONE)
730 queue->cur_level.time += GST_BUFFER_DURATION (data);
733 STATUS (queue, "+ level");
735 GST_CAT_LOG_OBJECT (queue_dataflow, queue, "signalling item_add");
736 g_cond_signal (queue->item_add);
737 GST_QUEUE_MUTEX_UNLOCK;
742 gst_data_unref (data);
747 gst_queue_get (GstPad * pad)
752 g_return_val_if_fail (pad != NULL, NULL);
753 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
755 queue = GST_QUEUE (gst_pad_get_parent (pad));
758 /* have to lock for thread-safety */
759 GST_QUEUE_MUTEX_LOCK;
761 if (queue->queue->length == 0 ||
762 (queue->min_threshold.buffers > 0 &&
763 queue->cur_level.buffers < queue->min_threshold.buffers) ||
764 (queue->min_threshold.bytes > 0 &&
765 queue->cur_level.bytes < queue->min_threshold.bytes) ||
766 (queue->min_threshold.time > 0 &&
767 queue->cur_level.time < queue->min_threshold.time)) {
768 GST_QUEUE_MUTEX_UNLOCK;
769 g_signal_emit (G_OBJECT (queue), gst_queue_signals[SIGNAL_UNDERRUN], 0);
770 GST_QUEUE_MUTEX_LOCK;
772 STATUS (queue, "pre-empty wait");
773 while (queue->queue->length == 0 ||
774 (queue->min_threshold.buffers > 0 &&
775 queue->cur_level.buffers < queue->min_threshold.buffers) ||
776 (queue->min_threshold.bytes > 0 &&
777 queue->cur_level.bytes < queue->min_threshold.bytes) ||
778 (queue->min_threshold.time > 0 &&
779 queue->cur_level.time < queue->min_threshold.time)) {
780 /* if there's a pending state change for this queue or its
781 * manager, switch back to iterator so bottom half of state
782 * change executes. */
783 if (queue->interrupt) {
786 GST_CAT_DEBUG_OBJECT (queue_dataflow, queue, "interrupted");
787 queue->interrupt = FALSE;
788 GST_QUEUE_MUTEX_UNLOCK;
789 sched = gst_pad_get_scheduler (queue->srcpad);
790 if (!sched || gst_scheduler_interrupt (sched, GST_ELEMENT (queue)))
791 return GST_DATA (gst_event_new (GST_EVENT_INTERRUPT));
794 if (GST_STATE (queue) != GST_STATE_PLAYING) {
795 /* this means the other end is shut down */
796 if (!queue->may_deadlock) {
797 GST_QUEUE_MUTEX_UNLOCK;
798 GST_ELEMENT_ERROR (queue, CORE, THREAD, (NULL),
799 ("deadlock found, shutting down sink pad elements"));
802 GST_CAT_WARNING_OBJECT (queue_dataflow, queue,
803 "%s: waiting for the app to restart "
804 "source pad elements", GST_ELEMENT_NAME (queue));
808 STATUS (queue, "waiting for item_add");
810 if (queue->block_timeout != GST_CLOCK_TIME_NONE) {
813 g_get_current_time (&timeout);
814 g_time_val_add (&timeout, queue->block_timeout / 1000);
815 GST_LOG_OBJECT (queue, "g_cond_time_wait using qlock from thread %p",
817 if (!g_cond_timed_wait (queue->item_add, queue->qlock, &timeout)) {
818 GST_QUEUE_MUTEX_UNLOCK;
819 GST_CAT_WARNING_OBJECT (queue_dataflow, queue,
820 "Sending filler event");
821 return GST_DATA (gst_event_new_filler ());
824 GST_LOG_OBJECT (queue, "doing g_cond_wait using qlock from thread %p",
826 g_cond_wait (queue->item_add, queue->qlock);
827 GST_LOG_OBJECT (queue, "done g_cond_wait using qlock from thread %p",
830 STATUS (queue, "got item_add signal");
833 STATUS (queue, "post-empty wait");
834 GST_QUEUE_MUTEX_UNLOCK;
835 g_signal_emit (G_OBJECT (queue), gst_queue_signals[SIGNAL_RUNNING], 0);
836 GST_QUEUE_MUTEX_LOCK;
839 /* There's something in the list now, whatever it is */
840 data = g_queue_pop_head (queue->queue);
841 GST_CAT_LOG_OBJECT (queue_dataflow, queue,
842 "retrieved data %p from queue", data);
847 if (GST_IS_BUFFER (data)) {
848 /* Update statistics */
849 queue->cur_level.buffers--;
850 queue->cur_level.bytes -= GST_BUFFER_SIZE (data);
851 if (GST_BUFFER_DURATION (data) != GST_CLOCK_TIME_NONE)
852 queue->cur_level.time -= GST_BUFFER_DURATION (data);
855 /* Now that we're done, we can lose our own reference to
856 * the item, since we're no longer in danger. */
857 gst_data_unref (data);
859 STATUS (queue, "after _get()");
861 GST_CAT_LOG_OBJECT (queue_dataflow, queue, "signalling item_del");
862 g_cond_signal (queue->item_del);
863 GST_QUEUE_MUTEX_UNLOCK;
865 /* FIXME: I suppose this needs to be locked, since the EOS
866 * bit affects the pipeline state. However, that bit is
867 * locked too so it'd cause a deadlock. */
868 if (GST_IS_EVENT (data)) {
869 GstEvent *event = GST_EVENT (data);
871 switch (GST_EVENT_TYPE (event)) {
873 GST_CAT_DEBUG_OBJECT (queue_dataflow, queue,
874 "queue \"%s\" eos", GST_ELEMENT_NAME (queue));
875 gst_element_set_eos (GST_ELEMENT (queue));
887 gst_queue_handle_src_event (GstPad * pad, GstEvent * event)
889 GstQueue *queue = GST_QUEUE (gst_pad_get_parent (pad));
892 GST_CAT_DEBUG_OBJECT (queue_dataflow, queue, "got event %p (%d)",
893 event, GST_EVENT_TYPE (event));
894 GST_QUEUE_MUTEX_LOCK;
896 if (gst_element_get_state (GST_ELEMENT (queue)) == GST_STATE_PLAYING) {
897 GstQueueEventResponse er;
899 /* push the event to the queue and wait for upstream consumption */
902 g_mutex_lock (queue->event_lock);
903 GST_CAT_DEBUG_OBJECT (queue_dataflow, queue,
904 "putting event %p (%d) on internal queue", event,
905 GST_EVENT_TYPE (event));
906 g_queue_push_tail (queue->events, &er);
907 g_mutex_unlock (queue->event_lock);
908 GST_CAT_WARNING_OBJECT (queue_dataflow, queue,
909 "Preparing for loop for event handler");
910 /* see the chain function on why this is here - it prevents a deadlock */
911 g_cond_signal (queue->item_del);
912 while (!er.handled) {
915 g_get_current_time (&timeout);
916 g_time_val_add (&timeout, 500 * 1000); /* half a second */
917 GST_LOG_OBJECT (queue, "doing g_cond_wait using qlock from thread %p",
919 if (!g_cond_timed_wait (queue->event_done, queue->qlock, &timeout) &&
921 GST_CAT_WARNING_OBJECT (queue_dataflow, queue,
922 "timeout in upstream event handling, dropping event %p (%d)",
923 er.event, GST_EVENT_TYPE (er.event));
924 g_mutex_lock (queue->event_lock);
925 /* since this queue is for src events (ie upstream), this thread is
926 * the only one that is pushing stuff on it, so we're sure that
927 * it's still the tail element. FIXME: But in practice, we should use
928 * GList instead of GQueue for this so we can remove any element in
930 g_queue_pop_tail (queue->events);
931 g_mutex_unlock (queue->event_lock);
932 gst_event_unref (er.event);
937 GST_CAT_WARNING_OBJECT (queue_dataflow, queue, "Event handled");
940 res = gst_pad_event_default (pad, event);
942 switch (GST_EVENT_TYPE (event)) {
943 case GST_EVENT_FLUSH:
944 GST_CAT_DEBUG_OBJECT (queue_dataflow, queue,
945 "FLUSH event, flushing queue\n");
946 gst_queue_locked_flush (queue);
949 if (GST_EVENT_SEEK_FLAGS (event) & GST_SEEK_FLAG_FLUSH) {
950 gst_queue_locked_flush (queue);
957 GST_QUEUE_MUTEX_UNLOCK;
963 gst_queue_handle_src_query (GstPad * pad,
964 GstQueryType type, GstFormat * fmt, gint64 * value)
966 GstQueue *queue = GST_QUEUE (gst_pad_get_parent (pad));
969 if (!GST_PAD_PEER (queue->sinkpad))
971 res = gst_pad_query (GST_PAD_PEER (queue->sinkpad), type, fmt, value);
975 if (type == GST_QUERY_POSITION) {
976 /* FIXME: this code assumes that there's no discont in the queue */
978 case GST_FORMAT_BYTES:
979 *value -= queue->cur_level.bytes;
981 case GST_FORMAT_TIME:
982 *value -= queue->cur_level.time;
994 gst_queue_release_locks (GstElement * element)
998 queue = GST_QUEUE (element);
1000 GST_QUEUE_MUTEX_LOCK;
1001 queue->interrupt = TRUE;
1002 g_cond_signal (queue->item_add);
1003 g_cond_signal (queue->item_del);
1004 GST_QUEUE_MUTEX_UNLOCK;
1009 static GstElementStateReturn
1010 gst_queue_change_state (GstElement * element)
1013 GstElementStateReturn ret = GST_STATE_SUCCESS;
1015 queue = GST_QUEUE (element);
1017 GST_CAT_LOG_OBJECT (GST_CAT_STATES, element,
1018 "starting state change 0x%x", GST_STATE_TRANSITION (element));
1020 /* lock the queue so another thread (not in sync with this thread's state)
1021 * can't call this queue's _get (or whatever)
1023 GST_QUEUE_MUTEX_LOCK;
1025 switch (GST_STATE_TRANSITION (element)) {
1026 case GST_STATE_NULL_TO_READY:
1027 gst_queue_locked_flush (queue);
1029 case GST_STATE_PAUSED_TO_PLAYING:
1030 if (!GST_PAD_IS_LINKED (queue->sinkpad)) {
1031 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, queue,
1032 "queue %s is not linked", GST_ELEMENT_NAME (queue));
1033 /* FIXME can this be? */
1034 g_cond_signal (queue->item_add);
1036 ret = GST_STATE_FAILURE;
1039 GstScheduler *src_sched, *sink_sched;
1041 src_sched = gst_pad_get_scheduler (GST_PAD (queue->srcpad));
1042 sink_sched = gst_pad_get_scheduler (GST_PAD (queue->sinkpad));
1044 if (src_sched == sink_sched) {
1045 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, queue,
1046 "queue %s does not connect different schedulers",
1047 GST_ELEMENT_NAME (queue));
1049 g_warning ("queue %s does not connect different schedulers",
1050 GST_ELEMENT_NAME (queue));
1052 ret = GST_STATE_FAILURE;
1056 queue->interrupt = FALSE;
1058 case GST_STATE_PAUSED_TO_READY:
1059 gst_queue_locked_flush (queue);
1060 gst_caps_replace (&queue->negotiated_caps, NULL);
1066 GST_QUEUE_MUTEX_UNLOCK;
1068 if (GST_ELEMENT_CLASS (parent_class)->change_state)
1069 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element);
1071 /* this is an ugly hack to make sure our pads are always active.
1072 * Reason for this is that pad activation for the queue element
1073 * depends on 2 schedulers (ugh) */
1074 gst_pad_set_active (queue->sinkpad, TRUE);
1075 gst_pad_set_active (queue->srcpad, TRUE);
1077 GST_CAT_LOG_OBJECT (GST_CAT_STATES, element, "done with state change");
1082 GST_QUEUE_MUTEX_UNLOCK;
1084 GST_CAT_LOG_OBJECT (GST_CAT_STATES, element, "done with state change");
1091 gst_queue_set_property (GObject * object,
1092 guint prop_id, const GValue * value, GParamSpec * pspec)
1094 GstQueue *queue = GST_QUEUE (object);
1096 /* someone could change levels here, and since this
1097 * affects the get/put funcs, we need to lock for safety. */
1098 GST_QUEUE_MUTEX_LOCK;
1101 case ARG_MAX_SIZE_BYTES:
1102 queue->max_size.bytes = g_value_get_uint (value);
1104 case ARG_MAX_SIZE_BUFFERS:
1105 queue->max_size.buffers = g_value_get_uint (value);
1107 case ARG_MAX_SIZE_TIME:
1108 queue->max_size.time = g_value_get_uint64 (value);
1110 case ARG_MIN_THRESHOLD_BYTES:
1111 queue->min_threshold.bytes = g_value_get_uint (value);
1113 case ARG_MIN_THRESHOLD_BUFFERS:
1114 queue->min_threshold.buffers = g_value_get_uint (value);
1116 case ARG_MIN_THRESHOLD_TIME:
1117 queue->min_threshold.time = g_value_get_uint64 (value);
1120 queue->leaky = g_value_get_enum (value);
1122 case ARG_MAY_DEADLOCK:
1123 queue->may_deadlock = g_value_get_boolean (value);
1125 case ARG_BLOCK_TIMEOUT:
1126 queue->block_timeout = g_value_get_uint64 (value);
1129 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1133 GST_QUEUE_MUTEX_UNLOCK;
1137 gst_queue_get_property (GObject * object,
1138 guint prop_id, GValue * value, GParamSpec * pspec)
1140 GstQueue *queue = GST_QUEUE (object);
1143 case ARG_CUR_LEVEL_BYTES:
1144 g_value_set_uint (value, queue->cur_level.bytes);
1146 case ARG_CUR_LEVEL_BUFFERS:
1147 g_value_set_uint (value, queue->cur_level.buffers);
1149 case ARG_CUR_LEVEL_TIME:
1150 g_value_set_uint64 (value, queue->cur_level.time);
1152 case ARG_MAX_SIZE_BYTES:
1153 g_value_set_uint (value, queue->max_size.bytes);
1155 case ARG_MAX_SIZE_BUFFERS:
1156 g_value_set_uint (value, queue->max_size.buffers);
1158 case ARG_MAX_SIZE_TIME:
1159 g_value_set_uint64 (value, queue->max_size.time);
1161 case ARG_MIN_THRESHOLD_BYTES:
1162 g_value_set_uint (value, queue->min_threshold.bytes);
1164 case ARG_MIN_THRESHOLD_BUFFERS:
1165 g_value_set_uint (value, queue->min_threshold.buffers);
1167 case ARG_MIN_THRESHOLD_TIME:
1168 g_value_set_uint64 (value, queue->min_threshold.time);
1171 g_value_set_enum (value, queue->leaky);
1173 case ARG_MAY_DEADLOCK:
1174 g_value_set_boolean (value, queue->may_deadlock);
1176 case ARG_BLOCK_TIMEOUT:
1177 g_value_set_uint64 (value, queue->block_timeout);
1180 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);