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 */
72 static void gst_queue_class_init (GstQueueClass *klass);
73 static void gst_queue_init (GstQueue *queue);
74 static void gst_queue_dispose (GObject *object);
76 static void gst_queue_set_property (GObject *object, guint prop_id,
77 const GValue *value, GParamSpec *pspec);
78 static void gst_queue_get_property (GObject *object, guint prop_id,
79 GValue *value, GParamSpec *pspec);
81 static void gst_queue_chain (GstPad *pad, GstBuffer *buf);
82 static GstBuffer * gst_queue_get (GstPad *pad);
83 static GstBufferPool* gst_queue_get_bufferpool (GstPad *pad);
85 static void gst_queue_locked_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));
152 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_MAY_DEADLOCK,
153 g_param_spec_boolean ("may_deadlock", "May Deadlock", "The queue may deadlock if it's full and not PLAYING",
154 TRUE, G_PARAM_READWRITE));
156 gobject_class->dispose = GST_DEBUG_FUNCPTR (gst_queue_dispose);
157 gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_queue_set_property);
158 gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_queue_get_property);
160 gstelement_class->change_state = GST_DEBUG_FUNCPTR(gst_queue_change_state);
163 static GstPadConnectReturn
164 gst_queue_connect (GstPad *pad, GstCaps *caps)
166 GstQueue *queue = GST_QUEUE (gst_pad_get_parent (pad));
169 if (pad == queue->srcpad)
170 otherpad = queue->sinkpad;
172 otherpad = queue->srcpad;
174 return gst_pad_proxy_connect (otherpad, caps);
178 gst_queue_getcaps (GstPad *pad, GstCaps *caps)
180 GstQueue *queue = GST_QUEUE (gst_pad_get_parent (pad));
183 if (pad == queue->srcpad)
184 otherpad = queue->sinkpad;
186 otherpad = queue->srcpad;
188 return gst_pad_get_allowed_caps (otherpad);
192 gst_queue_init (GstQueue *queue)
194 /* scheduling on this kind of element is, well, interesting */
195 GST_FLAG_SET (queue, GST_ELEMENT_DECOUPLED);
196 GST_FLAG_SET (queue, GST_ELEMENT_EVENT_AWARE);
198 queue->sinkpad = gst_pad_new ("sink", GST_PAD_SINK);
199 gst_pad_set_chain_function (queue->sinkpad, GST_DEBUG_FUNCPTR (gst_queue_chain));
200 gst_element_add_pad (GST_ELEMENT (queue), queue->sinkpad);
201 gst_pad_set_bufferpool_function (queue->sinkpad, GST_DEBUG_FUNCPTR (gst_queue_get_bufferpool));
202 gst_pad_set_connect_function (queue->sinkpad, GST_DEBUG_FUNCPTR (gst_queue_connect));
203 gst_pad_set_getcaps_function (queue->sinkpad, GST_DEBUG_FUNCPTR (gst_queue_getcaps));
205 queue->srcpad = gst_pad_new ("src", GST_PAD_SRC);
206 gst_pad_set_get_function (queue->srcpad, GST_DEBUG_FUNCPTR (gst_queue_get));
207 gst_element_add_pad (GST_ELEMENT (queue), queue->srcpad);
208 gst_pad_set_connect_function (queue->srcpad, GST_DEBUG_FUNCPTR (gst_queue_connect));
209 gst_pad_set_getcaps_function (queue->srcpad, GST_DEBUG_FUNCPTR (gst_queue_getcaps));
211 queue->leaky = GST_QUEUE_NO_LEAK;
213 queue->level_buffers = 0;
214 queue->level_bytes = 0;
215 queue->level_time = 0LL;
216 queue->size_buffers = 100; /* 100 buffers */
217 queue->size_bytes = 100 * 1024; /* 100KB */
218 queue->size_time = 1000000000LL; /* 1sec */
219 queue->may_deadlock = TRUE;
221 queue->qlock = g_mutex_new ();
222 queue->reader = FALSE;
223 queue->writer = FALSE;
224 queue->not_empty = g_cond_new ();
225 queue->not_full = g_cond_new ();
226 GST_DEBUG_ELEMENT (GST_CAT_THREAD, queue, "initialized queue's not_empty & not_full conditions");
230 gst_queue_dispose (GObject *object)
232 GstQueue *queue = GST_QUEUE (object);
234 g_mutex_free (queue->qlock);
235 g_cond_free (queue->not_empty);
236 g_cond_free (queue->not_full);
238 G_OBJECT_CLASS (parent_class)->dispose (object);
241 static GstBufferPool*
242 gst_queue_get_bufferpool (GstPad *pad)
246 queue = GST_QUEUE (GST_OBJECT_PARENT (pad));
248 return gst_pad_get_bufferpool (queue->srcpad);
252 gst_queue_cleanup_buffers (gpointer data, const gpointer user_data)
254 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, user_data, "cleaning buffer %p", data);
256 if (GST_IS_BUFFER (data)) {
257 gst_buffer_unref (GST_BUFFER (data));
260 gst_event_free (GST_EVENT (data));
265 gst_queue_locked_flush (GstQueue *queue)
267 g_list_foreach (queue->queue, gst_queue_cleanup_buffers,
269 g_list_free (queue->queue);
272 queue->level_buffers = 0;
273 queue->timeval = NULL;
277 gst_queue_chain (GstPad *pad, GstBuffer *buf)
282 g_return_if_fail (pad != NULL);
283 g_return_if_fail (GST_IS_PAD (pad));
284 g_return_if_fail (buf != NULL);
286 queue = GST_QUEUE (GST_OBJECT_PARENT (pad));
289 /* we have to lock the queue since we span threads */
290 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "locking t:%ld", pthread_self ());
291 g_mutex_lock (queue->qlock);
292 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "locked t:%ld", pthread_self ());
294 if (GST_IS_EVENT (buf)) {
295 switch (GST_EVENT_TYPE (buf)) {
296 case GST_EVENT_FLUSH:
297 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "FLUSH event, flushing queue\n");
298 gst_queue_locked_flush (queue);
301 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "eos in on %s %d\n",
302 GST_ELEMENT_NAME (queue), queue->level_buffers);
305 /*gst_pad_event_default (pad, GST_EVENT (buf)); */
310 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "adding buffer %p of size %d",buf,GST_BUFFER_SIZE(buf));
312 if (queue->level_buffers == queue->size_buffers) {
313 /* if this is a leaky queue... */
315 /* FIXME don't want to leak events! */
316 /* if we leak on the upstream side, drop the current buffer */
317 if (queue->leaky == GST_QUEUE_LEAK_UPSTREAM) {
318 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "queue is full, leaking buffer on upstream end");
319 if (GST_IS_EVENT (buf))
320 fprintf(stderr, "Error: queue [%s] leaked an event, type:%d\n",
321 GST_ELEMENT_NAME(GST_ELEMENT(queue)),
322 GST_EVENT_TYPE(GST_EVENT(buf)));
323 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "queue is full, leaking buffer on upstream end");
324 gst_buffer_unref(buf);
325 /* now we have to clean up and exit right away */
326 g_mutex_unlock (queue->qlock);
329 /* otherwise we have to push a buffer off the other end */
333 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "queue is full, leaking buffer on downstream end");
334 front = queue->queue;
335 leakbuf = (GstBuffer *)(front->data);
336 if (GST_IS_EVENT (leakbuf))
337 fprintf(stderr, "Error: queue [%s] leaked an event, type:%d\n",
338 GST_ELEMENT_NAME(GST_ELEMENT(queue)),
339 GST_EVENT_TYPE(GST_EVENT(leakbuf)));
340 queue->level_buffers--;
341 queue->level_bytes -= GST_BUFFER_SIZE(leakbuf);
342 gst_buffer_unref(leakbuf);
343 queue->queue = g_list_remove_link (queue->queue, front);
348 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "pre full wait, level:%d/%d",
349 queue->level_buffers, queue->size_buffers);
350 while (queue->level_buffers == queue->size_buffers) {
351 /* if there's a pending state change for this queue or its manager, switch */
352 /* back to iterator so bottom half of state change executes */
353 while (GST_STATE_PENDING (queue) != GST_STATE_VOID_PENDING) {
354 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "interrupted!!");
355 g_mutex_unlock (queue->qlock);
356 if (gst_element_interrupt (GST_ELEMENT (queue)))
360 if (GST_STATE (queue) != GST_STATE_PLAYING) {
361 /* this means the other end is shut down */
362 /* try to signal to resolve the error */
363 if (!queue->may_deadlock) {
364 if (GST_IS_BUFFER (buf)) gst_buffer_unref (buf);
365 else gst_event_free (GST_EVENT (buf));
366 g_mutex_unlock (queue->qlock);
367 gst_element_error (GST_ELEMENT (queue), "deadlock found, source pad elements are shut down");
371 g_print ("%s: waiting for the app to restart source pad elements\n", GST_ELEMENT_NAME (queue));
375 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "waiting for not_full, level:%d/%d",
376 queue->level_buffers, queue->size_buffers);
378 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "WARNING: multiple writers on queue!");
379 queue->writer = TRUE;
380 g_cond_wait (queue->not_full, queue->qlock);
381 queue->writer = FALSE;
382 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "got not_full signal");
384 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "post full wait, level:%d/%d",
385 queue->level_buffers, queue->size_buffers);
388 /* put the buffer on the tail of the list */
389 queue->queue = g_list_append (queue->queue, buf);
390 queue->level_buffers++;
391 queue->level_bytes += GST_BUFFER_SIZE(buf);
393 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "(%s:%s)+ level:%d/%d",
394 GST_DEBUG_PAD_NAME(pad),
395 queue->level_buffers, queue->size_buffers);
397 /* this assertion _has_ to hold */
398 /* g_assert (g_list_length (queue->queue) == queue->level_buffers); */
400 /* reader waiting on an empty queue */
401 reader = queue->reader;
403 g_mutex_unlock (queue->qlock);
407 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "signalling not_empty");
408 g_cond_signal (queue->not_empty);
413 gst_queue_get (GstPad *pad)
416 GstBuffer *buf = NULL;
420 g_assert(pad != NULL);
421 g_assert(GST_IS_PAD(pad));
422 g_return_val_if_fail (pad != NULL, NULL);
423 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
425 queue = GST_QUEUE (GST_OBJECT_PARENT (pad));
428 /* have to lock for thread-safety */
429 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "locking t:%ld", pthread_self ());
430 g_mutex_lock (queue->qlock);
431 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "locked t:%ld %p", pthread_self (), queue->not_empty);
433 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "pre empty wait, level:%d/%d", queue->level_buffers, queue->size_buffers);
434 while (queue->level_buffers == 0) {
435 /* if there's a pending state change for this queue or its manager, switch
436 * back to iterator so bottom half of state change executes
438 while (GST_STATE_PENDING (queue) != GST_STATE_VOID_PENDING) {
439 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "interrupted!!");
440 g_mutex_unlock (queue->qlock);
441 if (gst_element_interrupt (GST_ELEMENT (queue)))
445 if (GST_STATE (queue) != GST_STATE_PLAYING) {
446 /* this means the other end is shut down */
447 if (!queue->may_deadlock) {
448 g_mutex_unlock (queue->qlock);
449 gst_element_error (GST_ELEMENT (queue), "deadlock found, sink pad elements are shut down");
453 g_print ("%s: waiting for the app to restart source pad elements\n", GST_ELEMENT_NAME (queue));
457 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "waiting for not_empty, level:%d/%d", queue->level_buffers, queue->size_buffers);
459 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "WARNING: multiple readers on queue!");
460 queue->reader = TRUE;
461 g_cond_wait (queue->not_empty, queue->qlock);
462 queue->reader = FALSE;
463 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "got not_empty signal");
465 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "post empty wait, level:%d/%d", queue->level_buffers, queue->size_buffers);
467 front = queue->queue;
468 buf = (GstBuffer *)(front->data);
469 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "retrieved buffer %p from queue", buf);
470 queue->queue = g_list_remove_link (queue->queue, front);
473 queue->level_buffers--;
474 queue->level_bytes -= GST_BUFFER_SIZE(buf);
476 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "(%s:%s)- level:%d/%d",
477 GST_DEBUG_PAD_NAME(pad),
478 queue->level_buffers, queue->size_buffers);
480 /* this assertion _has_ to hold */
481 /* g_assert (g_list_length (queue->queue) == queue->level_buffers); */
483 /* writer waiting on a full queue */
484 writer = queue->writer;
486 g_mutex_unlock (queue->qlock);
490 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "signalling not_full");
491 g_cond_signal (queue->not_full);
494 /* FIXME where should this be? locked? */
495 if (GST_IS_EVENT(buf)) {
496 GstEvent *event = GST_EVENT(buf);
497 switch (GST_EVENT_TYPE(event)) {
499 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "queue \"%s\" eos", GST_ELEMENT_NAME (queue));
500 gst_element_set_eos (GST_ELEMENT (queue));
510 static GstElementStateReturn
511 gst_queue_change_state (GstElement *element)
514 GstElementStateReturn ret;
515 GstElementState new_state;
516 g_return_val_if_fail (GST_IS_QUEUE (element), GST_STATE_FAILURE);
518 queue = GST_QUEUE (element);
520 GST_DEBUG_ENTER("('%s')", GST_ELEMENT_NAME (element));
522 /* lock the queue so another thread (not in sync with this thread's state)
523 * can't call this queue's _get (or whatever)
525 g_mutex_lock (queue->qlock);
527 new_state = GST_STATE_PENDING (element);
529 if (new_state == GST_STATE_PAUSED) {
530 /*g_cond_signal (queue->not_full); */
531 /*g_cond_signal (queue->not_empty); */
533 else if (new_state == GST_STATE_READY) {
534 gst_queue_locked_flush (queue);
536 else if (new_state == GST_STATE_PLAYING) {
537 if (!GST_PAD_IS_CONNECTED (queue->sinkpad)) {
538 /* FIXME can this be? */
540 g_cond_signal (queue->not_empty);
541 g_mutex_unlock (queue->qlock);
543 return GST_STATE_FAILURE;
547 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element);
548 g_mutex_unlock (queue->qlock);
550 GST_DEBUG_LEAVE("('%s')", GST_ELEMENT_NAME (element));
556 gst_queue_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
560 /* it's not null if we got it, but it might not be ours */
561 g_return_if_fail (GST_IS_QUEUE (object));
563 queue = GST_QUEUE (object);
567 queue->leaky = g_value_get_enum (value);
570 queue->size_buffers = g_value_get_int (value);
572 case ARG_MAY_DEADLOCK:
573 queue->may_deadlock = g_value_get_boolean (value);
576 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
582 gst_queue_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
586 /* it's not null if we got it, but it might not be ours */
587 g_return_if_fail (GST_IS_QUEUE (object));
589 queue = GST_QUEUE (object);
593 g_value_set_enum (value, queue->leaky);
596 g_value_set_int (value, queue->level_buffers);
599 g_value_set_int (value, queue->size_buffers);
601 case ARG_MAY_DEADLOCK:
602 g_value_set_boolean (value, queue->may_deadlock);
605 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);