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(0,A, gst_element_get_name(GST_ELEMENT(queue)))
34 #include "gst_private.h"
38 GstElementDetails gst_queue_details = {
43 "Erik Walthinsen <omega@cse.ogi.edu>",
48 /* Queue signals and args */
63 static void gst_queue_class_init (GstQueueClass *klass);
64 static void gst_queue_init (GstQueue *queue);
66 static void gst_queue_set_arg (GtkObject *object, GtkArg *arg, guint id);
67 static void gst_queue_get_arg (GtkObject *object, GtkArg *arg, guint id);
69 static void gst_queue_chain (GstPad *pad, GstBuffer *buf);
70 static GstBuffer * gst_queue_get (GstPad *pad);
72 static void gst_queue_flush (GstQueue *queue);
74 static GstElementStateReturn gst_queue_change_state (GstElement *element);
77 static GstElementClass *parent_class = NULL;
78 //static guint gst_queue_signals[LAST_SIGNAL] = { 0 };
81 gst_queue_get_type(void) {
82 static GtkType queue_type = 0;
85 static const GtkTypeInfo queue_info = {
88 sizeof(GstQueueClass),
89 (GtkClassInitFunc)gst_queue_class_init,
90 (GtkObjectInitFunc)gst_queue_init,
91 (GtkArgSetFunc)gst_queue_set_arg,
92 (GtkArgGetFunc)gst_queue_get_arg,
93 (GtkClassInitFunc)NULL,
95 queue_type = gtk_type_unique (GST_TYPE_ELEMENT, &queue_info);
101 gst_queue_class_init (GstQueueClass *klass)
103 GtkObjectClass *gtkobject_class;
104 GstElementClass *gstelement_class;
106 gtkobject_class = (GtkObjectClass*)klass;
107 gstelement_class = (GstElementClass*)klass;
109 parent_class = gtk_type_class (GST_TYPE_ELEMENT);
111 gtk_object_add_arg_type ("GstQueue::level", GTK_TYPE_INT,
112 GTK_ARG_READABLE, ARG_LEVEL);
113 gtk_object_add_arg_type ("GstQueue::max_level", GTK_TYPE_INT,
114 GTK_ARG_READWRITE, ARG_MAX_LEVEL);
115 gtk_object_add_arg_type ("GstQueue::block", GTK_TYPE_BOOL,
116 GTK_ARG_READWRITE, ARG_BLOCK);
117 gtk_object_add_arg_type ("GstQueue::timeout", GTK_TYPE_INT,
118 GTK_ARG_READWRITE, ARG_TIMEOUT);
120 gtkobject_class->set_arg = gst_queue_set_arg;
121 gtkobject_class->get_arg = gst_queue_get_arg;
123 gstelement_class->change_state = gst_queue_change_state;
127 gst_queue_init (GstQueue *queue)
129 // scheduling on this kind of element is, well, interesting
130 GST_FLAG_SET (queue, GST_ELEMENT_DECOUPLED);
132 queue->sinkpad = gst_pad_new ("sink", GST_PAD_SINK);
133 gst_pad_set_chain_function (queue->sinkpad, GST_DEBUG_FUNCPTR(gst_queue_chain));
134 gst_element_add_pad (GST_ELEMENT (queue), queue->sinkpad);
136 queue->srcpad = gst_pad_new ("src", GST_PAD_SRC);
137 gst_pad_set_get_function (queue->srcpad, GST_DEBUG_FUNCPTR(gst_queue_get));
138 gst_element_add_pad (GST_ELEMENT (queue), queue->srcpad);
141 queue->level_buffers = 0;
142 queue->max_buffers = 100;
144 queue->level_bytes = 0;
145 queue->size_buffers = 0;
146 queue->size_bytes = 0;
148 queue->emptycond = g_cond_new ();
149 queue->fullcond = g_cond_new ();
153 gst_queue_cleanup_buffers (gpointer data, const gpointer user_data)
155 GST_DEBUG (0,"queue: %s cleaning buffer %p\n", (gchar *)user_data, data);
157 gst_buffer_unref (GST_BUFFER (data));
161 gst_queue_flush (GstQueue *queue)
163 g_slist_foreach (queue->queue, gst_queue_cleanup_buffers,
164 (char *)gst_element_get_name (GST_ELEMENT (queue)));
165 g_slist_free (queue->queue);
168 queue->level_buffers = 0;
169 queue->timeval = NULL;
173 gst_queue_chain (GstPad *pad, GstBuffer *buf)
176 gboolean tosignal = FALSE;
179 g_return_if_fail (pad != NULL);
180 g_return_if_fail (GST_IS_PAD (pad));
181 g_return_if_fail (buf != NULL);
183 queue = GST_QUEUE (pad->parent);
184 name = gst_element_get_name (GST_ELEMENT (queue));
186 /* we have to lock the queue since we span threads */
188 GST_DEBUG (0,"queue: try have queue lock\n");
190 GST_DEBUG (0,"queue: %s adding buffer %p %ld\n", name, buf, pthread_self ());
191 GST_DEBUG (0,"queue: have queue lock\n");
193 if (GST_BUFFER_FLAG_IS_SET (buf, GST_BUFFER_FLUSH)) {
194 gst_queue_flush (queue);
197 GST_DEBUG (0,"queue: %s: chain %d %p\n", name, queue->level_buffers, buf);
199 while (queue->level_buffers >= queue->max_buffers) {
200 GST_DEBUG (0,"queue: %s waiting %d\n", name, queue->level_buffers);
202 //g_cond_timed_wait (queue->fullcond, queue->fulllock, queue->timeval);
203 //FIXME need to signal other thread in case signals got lost?
204 g_cond_signal (queue->emptycond);
205 g_cond_wait (queue->fullcond, GST_OBJECT(queue)->lock);
207 GST_DEBUG (0,"queue: %s waiting done %d\n", name, queue->level_buffers);
210 /* put the buffer on the tail of the list */
211 queue->queue = g_slist_append (queue->queue, buf);
212 // STATUS("%s: +\n");
213 GST_DEBUG (0,"(%s:%s)+ ",GST_DEBUG_PAD_NAME(pad));
215 /* if we were empty, but aren't any more, signal a condition */
216 tosignal = (queue->level_buffers >= 0);
217 queue->level_buffers++;
219 /* we can unlock now */
220 GST_DEBUG (0,"queue: %s chain %d end signal(%d,%p)\n", name, queue->level_buffers, tosignal, queue->emptycond);
223 // STATUS("%s: >\n");
224 g_cond_signal (queue->emptycond);
225 // STATUS("%s: >>\n");
231 gst_queue_get (GstPad *pad)
233 GstQueue *queue = GST_QUEUE (gst_pad_get_parent(pad));
234 GstBuffer *buf = NULL;
238 name = gst_element_get_name (GST_ELEMENT (queue));
240 /* have to lock for thread-safety */
241 GST_DEBUG (0,"queue: %s try have queue lock\n", name);
243 GST_DEBUG (0,"queue: %s push %d %ld %p\n", name, queue->level_buffers, pthread_self (), queue->emptycond);
244 GST_DEBUG (0,"queue: %s have queue lock\n", name);
246 // we bail if there's nothing there
247 if (!queue->level_buffers && !queue->block) {
252 while (!queue->level_buffers) {
253 STATUS("queue: %s U released lock\n");
254 //g_cond_timed_wait (queue->emptycond, queue->emptylock, queue->timeval);
255 //FIXME need to signal other thread in case signals got lost?
256 g_cond_signal (queue->fullcond);
257 g_cond_wait (queue->emptycond, GST_OBJECT(queue)->lock);
258 // STATUS("queue: %s U- getting lock\n");
261 front = queue->queue;
262 buf = (GstBuffer *)(front->data);
263 GST_DEBUG (0,"retrieved buffer %p from queue\n",buf);
264 queue->queue = g_slist_remove_link (queue->queue, front);
265 g_slist_free (front);
267 queue->level_buffers--;
268 // STATUS("%s: -\n");
269 GST_DEBUG (0,"(%s:%s)- ",GST_DEBUG_PAD_NAME(pad));
271 if (queue->level_buffers < queue->max_buffers) {
272 // STATUS("%s: < \n");
273 g_cond_signal (queue->fullcond);
274 // STATUS("%s: << \n");
278 // GST_DEBUG (0,"queue: %s pushing %d %p \n", name, queue->level_buffers, buf);
279 // gst_pad_push (queue->srcpad, buf);
280 // GST_DEBUG (0,"queue: %s pushing %d done \n", name, queue->level_buffers);
286 static GstElementStateReturn
287 gst_queue_change_state (GstElement *element)
290 g_return_val_if_fail (GST_IS_QUEUE (element), GST_STATE_FAILURE);
292 queue = GST_QUEUE (element);
293 GST_DEBUG (0,"gstqueue: state pending %d\n", GST_STATE_PENDING (element));
295 /* if going down into NULL state, clear out buffers*/
296 if (GST_STATE_PENDING (element) == GST_STATE_READY) {
297 /* otherwise (READY or higher) we need to open the file */
298 gst_queue_flush (queue);
301 /* if we haven't failed already, give the parent class a chance to ;-) */
302 if (GST_ELEMENT_CLASS (parent_class)->change_state)
303 return GST_ELEMENT_CLASS (parent_class)->change_state (element);
305 return GST_STATE_SUCCESS;
310 gst_queue_set_arg (GtkObject *object, GtkArg *arg, guint id)
314 /* it's not null if we got it, but it might not be ours */
315 g_return_if_fail (GST_IS_QUEUE (object));
317 queue = GST_QUEUE (object);
321 queue->max_buffers = GTK_VALUE_INT (*arg);
324 queue->block = GTK_VALUE_BOOL (*arg);
334 gst_queue_get_arg (GtkObject *object, GtkArg *arg, guint id)
338 /* it's not null if we got it, but it might not be ours */
339 g_return_if_fail (GST_IS_QUEUE (object));
341 queue = GST_QUEUE (object);
345 GTK_VALUE_INT (*arg) = queue->level_buffers;
348 GTK_VALUE_INT (*arg) = queue->max_buffers;
351 GTK_VALUE_BOOL (*arg) = queue->block;
356 arg->type = GTK_TYPE_INVALID;