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 GstPadNegotiateReturn gst_queue_handle_negotiate_src (GstPad *pad, GstCaps **caps, gpointer *data);
82 static GstPadNegotiateReturn gst_queue_handle_negotiate_sink (GstPad *pad, GstCaps **caps, gpointer *data);
83 static void gst_queue_chain (GstPad *pad, GstBuffer *buf);
84 static GstBuffer * gst_queue_get (GstPad *pad);
85 static GstBufferPool* gst_queue_get_bufferpool (GstPad *pad);
87 static void gst_queue_locked_flush (GstQueue *queue);
88 static void gst_queue_flush (GstQueue *queue);
90 static GstElementStateReturn gst_queue_change_state (GstElement *element);
93 #define GST_TYPE_QUEUE_LEAKY (queue_leaky_get_type())
95 queue_leaky_get_type(void) {
96 static GType queue_leaky_type = 0;
97 static GEnumValue queue_leaky[] = {
98 { GST_QUEUE_NO_LEAK, "0", "Not Leaky" },
99 { GST_QUEUE_LEAK_UPSTREAM, "1", "Leaky on Upstream" },
100 { GST_QUEUE_LEAK_DOWNSTREAM, "2", "Leaky on Downstream" },
103 if (!queue_leaky_type) {
104 queue_leaky_type = g_enum_register_static("GstQueueLeaky", queue_leaky);
106 return queue_leaky_type;
109 static GstElementClass *parent_class = NULL;
110 /* static guint gst_queue_signals[LAST_SIGNAL] = { 0 }; */
113 gst_queue_get_type(void)
115 static GType queue_type = 0;
118 static const GTypeInfo queue_info = {
119 sizeof(GstQueueClass),
122 (GClassInitFunc)gst_queue_class_init,
127 (GInstanceInitFunc)gst_queue_init,
130 queue_type = g_type_register_static (GST_TYPE_ELEMENT, "GstQueue", &queue_info, 0);
136 gst_queue_class_init (GstQueueClass *klass)
138 GObjectClass *gobject_class;
139 GstElementClass *gstelement_class;
141 gobject_class = (GObjectClass*)klass;
142 gstelement_class = (GstElementClass*)klass;
144 parent_class = g_type_class_ref (GST_TYPE_ELEMENT);
146 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_LEAKY,
147 g_param_spec_enum ("leaky", "Leaky", "Where the queue leaks, if at all.",
148 GST_TYPE_QUEUE_LEAKY, GST_QUEUE_NO_LEAK, G_PARAM_READWRITE));
149 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_LEVEL,
150 g_param_spec_int ("level", "Level", "How many buffers are in the queue.",
151 0, G_MAXINT, 0, G_PARAM_READABLE));
152 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_MAX_LEVEL,
153 g_param_spec_int ("max_level", "Maximum Level", "How many buffers the queue holds.",
154 0, G_MAXINT, 100, G_PARAM_READWRITE));
155 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_MAY_DEADLOCK,
156 g_param_spec_boolean ("may_deadlock", "May Deadlock", "The queue may deadlock if it's full and not PLAYING",
157 TRUE, G_PARAM_READWRITE));
159 gobject_class->dispose = GST_DEBUG_FUNCPTR (gst_queue_dispose);
160 gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_queue_set_property);
161 gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_queue_get_property);
163 gstelement_class->change_state = GST_DEBUG_FUNCPTR(gst_queue_change_state);
167 gst_queue_init (GstQueue *queue)
169 /* scheduling on this kind of element is, well, interesting */
170 GST_FLAG_SET (queue, GST_ELEMENT_DECOUPLED);
171 GST_FLAG_SET (queue, GST_ELEMENT_EVENT_AWARE);
173 queue->sinkpad = gst_pad_new ("sink", GST_PAD_SINK);
174 gst_pad_set_chain_function (queue->sinkpad, GST_DEBUG_FUNCPTR(gst_queue_chain));
175 gst_element_add_pad (GST_ELEMENT (queue), queue->sinkpad);
176 gst_pad_set_negotiate_function (queue->sinkpad, GST_DEBUG_FUNCPTR(gst_queue_handle_negotiate_sink));
177 gst_pad_set_bufferpool_function (queue->sinkpad, GST_DEBUG_FUNCPTR(gst_queue_get_bufferpool));
179 queue->srcpad = gst_pad_new ("src", GST_PAD_SRC);
180 gst_pad_set_get_function (queue->srcpad, GST_DEBUG_FUNCPTR(gst_queue_get));
181 gst_element_add_pad (GST_ELEMENT (queue), queue->srcpad);
182 gst_pad_set_negotiate_function (queue->srcpad, GST_DEBUG_FUNCPTR(gst_queue_handle_negotiate_src));
184 queue->leaky = GST_QUEUE_NO_LEAK;
187 queue->level_buffers = 0;
188 queue->level_bytes = 0;
189 queue->level_time = 0LL;
190 queue->size_buffers = 100; /* 100 buffers */
191 queue->size_bytes = 100 * 1024; /* 100KB */
192 queue->size_time = 1000000000LL; /* 1sec */
193 queue->may_deadlock = TRUE;
195 queue->qlock = g_mutex_new ();
196 queue->reader = FALSE;
197 queue->writer = FALSE;
198 queue->not_empty = g_cond_new ();
199 queue->not_full = g_cond_new ();
200 GST_DEBUG_ELEMENT (GST_CAT_THREAD, queue, "initialized queue's not_empty & not_full conditions\n");
204 gst_queue_dispose (GObject *object)
206 GstQueue *queue = GST_QUEUE (object);
208 g_mutex_free (queue->qlock);
209 g_cond_free (queue->not_empty);
210 g_cond_free (queue->not_full);
212 G_OBJECT_CLASS (parent_class)->dispose (object);
215 static GstBufferPool*
216 gst_queue_get_bufferpool (GstPad *pad)
220 queue = GST_QUEUE (GST_OBJECT_PARENT (pad));
222 return gst_pad_get_bufferpool (queue->srcpad);
225 static GstPadNegotiateReturn
226 gst_queue_handle_negotiate_src (GstPad *pad, GstCaps **caps, gpointer *data)
230 queue = GST_QUEUE (GST_OBJECT_PARENT (pad));
232 return gst_pad_negotiate_proxy (pad, queue->sinkpad, caps);
235 static GstPadNegotiateReturn
236 gst_queue_handle_negotiate_sink (GstPad *pad, GstCaps **caps, gpointer *data)
240 queue = GST_QUEUE (GST_OBJECT_PARENT (pad));
242 return gst_pad_negotiate_proxy (pad, queue->srcpad, caps);
246 gst_queue_cleanup_buffers (gpointer data, const gpointer user_data)
248 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, user_data, "cleaning buffer %p\n", data);
250 if (GST_IS_BUFFER (data)) {
251 gst_buffer_unref (GST_BUFFER (data));
254 gst_event_free (GST_EVENT (data));
259 gst_queue_locked_flush (GstQueue *queue)
261 g_list_foreach (queue->queue, gst_queue_cleanup_buffers,
263 g_list_free (queue->queue);
266 queue->level_buffers = 0;
267 queue->timeval = NULL;
271 gst_queue_flush (GstQueue *queue)
273 g_mutex_lock (queue->qlock);
274 gst_queue_locked_flush (queue);
275 g_mutex_unlock (queue->qlock);
280 gst_queue_chain (GstPad *pad, GstBuffer *buf)
285 g_return_if_fail (pad != NULL);
286 g_return_if_fail (GST_IS_PAD (pad));
287 g_return_if_fail (buf != NULL);
289 queue = GST_QUEUE (GST_OBJECT_PARENT (pad));
292 /* we have to lock the queue since we span threads */
293 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "locking t:%ld\n", pthread_self ());
294 g_mutex_lock (queue->qlock);
295 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "locked t:%ld\n", pthread_self ());
297 if (GST_IS_EVENT (buf)) {
298 switch (GST_EVENT_TYPE (buf)) {
299 case GST_EVENT_FLUSH:
300 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "FLUSH event, flushing queue\n");
301 gst_queue_locked_flush (queue);
304 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "eos in on %s %d\n",
305 GST_ELEMENT_NAME (queue), queue->level_buffers);
308 //gst_pad_event_default (pad, GST_EVENT (buf));
313 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "adding buffer %p of size %d\n",buf,GST_BUFFER_SIZE(buf));
315 if (queue->level_buffers == queue->size_buffers) {
316 /* if this is a leaky queue... */
318 /* FIXME don't want to leak events! */
319 /* if we leak on the upstream side, drop the current buffer */
320 if (queue->leaky == GST_QUEUE_LEAK_UPSTREAM) {
321 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "queue is full, leaking buffer on upstream end\n");
322 if (GST_IS_EVENT (buf))
323 fprintf(stderr, "Error: queue [%s] leaked an event, type:%d\n",
324 GST_ELEMENT_NAME(GST_ELEMENT(queue)),
325 GST_EVENT_TYPE(GST_EVENT(buf)));
326 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "queue is full, leaking buffer on upstream end\n");
327 gst_buffer_unref(buf);
328 /* now we have to clean up and exit right away */
329 g_mutex_unlock (queue->qlock);
332 /* otherwise we have to push a buffer off the other end */
336 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "queue is full, leaking buffer on downstream end\n");
337 front = queue->queue;
338 leakbuf = (GstBuffer *)(front->data);
339 if (GST_IS_EVENT (leakbuf))
340 fprintf(stderr, "Error: queue [%s] leaked an event, type:%d\n",
341 GST_ELEMENT_NAME(GST_ELEMENT(queue)),
342 GST_EVENT_TYPE(GST_EVENT(leakbuf)));
343 queue->level_buffers--;
344 queue->level_bytes -= GST_BUFFER_SIZE(leakbuf);
345 gst_buffer_unref(leakbuf);
346 queue->queue = g_list_remove_link (queue->queue, front);
351 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "pre full wait, level:%d/%d\n",
352 queue->level_buffers, queue->size_buffers);
353 while (queue->level_buffers == queue->size_buffers) {
354 /* if there's a pending state change for this queue or its manager, switch */
355 /* back to iterator so bottom half of state change executes */
356 while (GST_STATE_PENDING (queue) != GST_STATE_VOID_PENDING) {
357 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "interrupted!!\n");
358 g_mutex_unlock (queue->qlock);
359 if (gst_element_interrupt (GST_ELEMENT (queue)))
363 if (GST_STATE (queue) != GST_STATE_PLAYING) {
364 /* this means the other end is shut down */
365 /* try to signal to resolve the error */
366 if (!queue->may_deadlock) {
367 if (GST_IS_BUFFER (buf)) gst_buffer_unref (buf);
368 else gst_event_free (GST_EVENT (buf));
369 g_mutex_unlock (queue->qlock);
370 gst_element_error (GST_ELEMENT (queue), "deadlock found, source pad elements are shut down");
374 gst_element_info (GST_ELEMENT (queue), "waiting for the app to restart source pad elements");
378 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "waiting for not_full, level:%d/%d\n", queue->level_buffers, queue->size_buffers);
380 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "WARNING: multiple writers on queue!\n");
381 queue->writer = TRUE;
382 g_cond_wait (queue->not_full, queue->qlock);
383 queue->writer = FALSE;
384 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "got not_full signal\n");
386 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "post full wait, level:%d/%d\n",
387 queue->level_buffers, queue->size_buffers);
390 GST_BUFFER_OFFSET (buf) = queue->count++;
391 /* put the buffer on the tail of the list */
392 queue->queue = g_list_append (queue->queue, buf);
393 queue->level_buffers++;
394 queue->level_bytes += GST_BUFFER_SIZE(buf);
396 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "(%s:%s)+ level:%d/%d\n",
397 GST_DEBUG_PAD_NAME(pad),
398 queue->level_buffers, queue->size_buffers);
400 /* this assertion _has_ to hold */
401 g_assert (g_list_length (queue->queue) == queue->level_buffers);
403 /* reader waiting on an empty queue */
404 reader = queue->reader;
406 g_mutex_unlock (queue->qlock);
410 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "signalling not_empty\n");
411 g_cond_signal (queue->not_empty);
416 gst_queue_get (GstPad *pad)
419 GstBuffer *buf = NULL;
423 g_assert(pad != NULL);
424 g_assert(GST_IS_PAD(pad));
425 g_return_val_if_fail (pad != NULL, NULL);
426 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
428 queue = GST_QUEUE (GST_OBJECT_PARENT (pad));
431 /* have to lock for thread-safety */
432 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "locking t:%ld\n", pthread_self ());
433 g_mutex_lock (queue->qlock);
434 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "locked t:%ld %p\n", pthread_self (), queue->not_empty);
436 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "pre empty wait, level:%d/%d\n", queue->level_buffers, queue->size_buffers);
437 while (queue->level_buffers == 0) {
438 /* if there's a pending state change for this queue or its manager, switch
439 * back to iterator so bottom half of state change executes
441 while (GST_STATE_PENDING (queue) != GST_STATE_VOID_PENDING) {
442 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "interrupted!!\n");
443 g_mutex_unlock (queue->qlock);
444 if (gst_element_interrupt (GST_ELEMENT (queue)))
448 if (GST_STATE (queue) != GST_STATE_PLAYING) {
449 /* this means the other end is shut down */
450 if (!queue->may_deadlock) {
451 g_mutex_unlock (queue->qlock);
452 gst_element_error (GST_ELEMENT (queue), "deadlock found, sink pad elements are shut down");
456 gst_element_info (GST_ELEMENT (queue), "waiting for the app to restart sink pad elements");
460 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "waiting for not_empty, level:%d/%d\n", queue->level_buffers, queue->size_buffers);
462 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "WARNING: multiple readers on queue!\n");
463 queue->reader = TRUE;
464 g_cond_wait (queue->not_empty, queue->qlock);
465 queue->reader = FALSE;
466 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "got not_empty signal\n");
468 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "post empty wait, level:%d/%d\n", queue->level_buffers, queue->size_buffers);
470 front = queue->queue;
471 buf = (GstBuffer *)(front->data);
472 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "retrieved buffer %p from queue\n", buf);
473 queue->queue = g_list_remove_link (queue->queue, front);
476 queue->level_buffers--;
477 queue->level_bytes -= GST_BUFFER_SIZE(buf);
479 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "(%s:%s)- level:%d/%d\n",
480 GST_DEBUG_PAD_NAME(pad),
481 queue->level_buffers, queue->size_buffers);
483 /* this assertion _has_ to hold */
484 g_assert (g_list_length (queue->queue) == queue->level_buffers);
486 /* writer waiting on a full queue */
487 writer = queue->writer;
489 g_mutex_unlock (queue->qlock);
493 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "signalling not_full\n");
494 g_cond_signal (queue->not_full);
497 /* FIXME where should this be? locked? */
498 if (GST_IS_EVENT(buf)) {
499 GstEvent *event = GST_EVENT(buf);
500 switch (GST_EVENT_TYPE(event)) {
502 GST_DEBUG_ELEMENT (GST_CAT_DATAFLOW, queue, "queue \"%s\" eos\n", GST_ELEMENT_NAME (queue));
503 gst_element_set_eos (GST_ELEMENT (queue));
513 static GstElementStateReturn
514 gst_queue_change_state (GstElement *element)
517 GstElementStateReturn ret;
518 GstElementState new_state;
519 g_return_val_if_fail (GST_IS_QUEUE (element), GST_STATE_FAILURE);
521 queue = GST_QUEUE (element);
523 GST_DEBUG_ENTER("('%s')", GST_ELEMENT_NAME (element));
525 /* lock the queue so another thread (not in sync with this thread's state)
526 * can't call this queue's _get (or whatever)
528 g_mutex_lock (queue->qlock);
530 new_state = GST_STATE_PENDING (element);
532 if (new_state == GST_STATE_PAUSED) {
533 //g_cond_signal (queue->not_full);
534 //g_cond_signal (queue->not_empty);
536 else if (new_state == GST_STATE_READY) {
537 gst_queue_locked_flush (queue);
539 else if (new_state == GST_STATE_PLAYING) {
540 if (!GST_PAD_CONNECTED (queue->sinkpad)) {
541 /* FIXME can this be? */
543 g_cond_signal (queue->not_empty);
544 g_mutex_unlock (queue->qlock);
546 return GST_STATE_FAILURE;
550 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element);
551 g_mutex_unlock (queue->qlock);
553 GST_DEBUG_LEAVE("('%s')", GST_ELEMENT_NAME (element));
559 gst_queue_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
563 /* it's not null if we got it, but it might not be ours */
564 g_return_if_fail (GST_IS_QUEUE (object));
566 queue = GST_QUEUE (object);
570 queue->leaky = g_value_get_int (value);
573 queue->size_buffers = g_value_get_int (value);
575 case ARG_MAY_DEADLOCK:
576 queue->may_deadlock = g_value_get_boolean (value);
579 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
585 gst_queue_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
589 /* it's not null if we got it, but it might not be ours */
590 g_return_if_fail (GST_IS_QUEUE (object));
592 queue = GST_QUEUE (object);
596 g_value_set_int (value, queue->leaky);
599 g_value_set_int (value, queue->level_buffers);
602 g_value_set_int (value, queue->size_buffers);
604 case ARG_MAY_DEADLOCK:
605 g_value_set_boolean (value, queue->may_deadlock);
608 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);