Release 0.10.35
[glsdk/gstreamer0-10.git] / plugins / elements / gstmultiqueue.c
1 /* GStreamer
2  * Copyright (C) 2006 Edward Hervey <edward@fluendo.com>
3  * Copyright (C) 2007 Jan Schmidt <jan@fluendo.com>
4  * Copyright (C) 2007 Wim Taymans <wim@fluendo.com>
5  * Copyright (C) 2011 Sebastian Dröge <sebastian.droege@collabora.co.uk>
6  *
7  * gstmultiqueue.c:
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Library General Public
11  * License as published by the Free Software Foundation; either
12  * version 2 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Library General Public License for more details.
18  *
19  * You should have received a copy of the GNU Library General Public
20  * License along with this library; if not, write to the
21  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22  * Boston, MA 02111-1307, USA.
23  */
25 /**
26  * SECTION:element-multiqueue
27  * @see_also: #GstQueue
28  *
29  * <refsect2>
30  * <para>
31  * Multiqueue is similar to a normal #GstQueue with the following additional
32  * features:
33  * <orderedlist>
34  * <listitem>
35  *   <itemizedlist><title>Multiple streamhandling</title>
36  *   <listitem><para>
37  *     The element handles queueing data on more than one stream at once. To
38  *     achieve such a feature it has request sink pads (sink&percnt;d) and
39  *     'sometimes' src pads (src&percnt;d).
40  *   </para><para>
41  *     When requesting a given sinkpad with gst_element_get_request_pad(),
42  *     the associated srcpad for that stream will be created.
43  *     Example: requesting sink1 will generate src1.
44  *   </para></listitem>
45  *   </itemizedlist>
46  * </listitem>
47  * <listitem>
48  *   <itemizedlist><title>Non-starvation on multiple streams</title>
49  *   <listitem><para>
50  *     If more than one stream is used with the element, the streams' queues
51  *     will be dynamically grown (up to a limit), in order to ensure that no
52  *     stream is risking data starvation. This guarantees that at any given
53  *     time there are at least N bytes queued and available for each individual
54  *     stream.
55  *   </para><para>
56  *     If an EOS event comes through a srcpad, the associated queue will be
57  *     considered as 'not-empty' in the queue-size-growing algorithm.
58  *   </para></listitem>
59  *   </itemizedlist>
60  * </listitem>
61  * <listitem>
62  *   <itemizedlist><title>Non-linked srcpads graceful handling</title>
63  *   <listitem><para>
64  *     In order to better support dynamic switching between streams, the multiqueue
65  *     (unlike the current GStreamer queue) continues to push buffers on non-linked
66  *     pads rather than shutting down.
67  *   </para><para>
68  *     In addition, to prevent a non-linked stream from very quickly consuming all
69  *     available buffers and thus 'racing ahead' of the other streams, the element
70  *     must ensure that buffers and inlined events for a non-linked stream are pushed
71  *     in the same order as they were received, relative to the other streams
72  *     controlled by the element. This means that a buffer cannot be pushed to a
73  *     non-linked pad any sooner than buffers in any other stream which were received
74  *     before it.
75  *   </para></listitem>
76  *   </itemizedlist>
77  * </listitem>
78  * </orderedlist>
79  * </para>
80  * <para>
81  *   Data is queued until one of the limits specified by the
82  *   #GstMultiQueue:max-size-buffers, #GstMultiQueue:max-size-bytes and/or
83  *   #GstMultiQueue:max-size-time properties has been reached. Any attempt to push
84  *   more buffers into the queue will block the pushing thread until more space
85  *   becomes available. #GstMultiQueue:extra-size-buffers,
86  * </para>
87  * <para>
88  *   #GstMultiQueue:extra-size-bytes and #GstMultiQueue:extra-size-time are
89  *   currently unused.
90  * </para>
91  * <para>
92  *   The default queue size limits are 5 buffers, 10MB of data, or
93  *   two second worth of data, whichever is reached first. Note that the number
94  *   of buffers will dynamically grow depending on the fill level of 
95  *   other queues.
96  * </para>
97  * <para>
98  *   The #GstMultiQueue::underrun signal is emitted when all of the queues
99  *   are empty. The #GstMultiQueue::overrun signal is emitted when one of the
100  *   queues is filled.
101  *   Both signals are emitted from the context of the streaming thread.
102  * </para>
103  * </refsect2>
104  *
105  * Last reviewed on 2008-01-25 (0.10.17)
106  */
108 #ifdef HAVE_CONFIG_H
109 #  include "config.h"
110 #endif
112 #include <gst/gst.h>
113 #include <stdio.h>
114 #include "gstmultiqueue.h"
115 #include <gst/glib-compat-private.h>
117 /**
118  * GstSingleQueue:
119  * @sinkpad: associated sink #GstPad
120  * @srcpad: associated source #GstPad
121  *
122  * Structure containing all information and properties about
123  * a single queue.
124  */
125 typedef struct _GstSingleQueue GstSingleQueue;
127 struct _GstSingleQueue
129   /* unique identifier of the queue */
130   guint id;
132   GstMultiQueue *mqueue;
134   GstPad *sinkpad;
135   GstPad *srcpad;
137   /* flowreturn of previous srcpad push */
138   GstFlowReturn srcresult;
140   /* segments */
141   GstSegment sink_segment;
142   GstSegment src_segment;
144   /* position of src/sink */
145   GstClockTime sinktime, srctime;
146   /* TRUE if either position needs to be recalculated */
147   gboolean sink_tainted, src_tainted;
149   /* queue of data */
150   GstDataQueue *queue;
151   GstDataQueueSize max_size, extra_size;
152   GstClockTime cur_time;
153   gboolean is_eos;
154   gboolean flushing;
156   /* Protected by global lock */
157   guint32 nextid;               /* ID of the next object waiting to be pushed */
158   guint32 oldid;                /* ID of the last object pushed (last in a series) */
159   guint32 last_oldid;           /* Previously observed old_id, reset to MAXUINT32 on flush */
160   GCond *turn;                  /* SingleQueue turn waiting conditional */
161 };
164 /* Extension of GstDataQueueItem structure for our usage */
165 typedef struct _GstMultiQueueItem GstMultiQueueItem;
167 struct _GstMultiQueueItem
169   GstMiniObject *object;
170   guint size;
171   guint64 duration;
172   gboolean visible;
174   GDestroyNotify destroy;
175   guint32 posid;
176 };
178 static GstSingleQueue *gst_single_queue_new (GstMultiQueue * mqueue, gint id);
179 static void gst_single_queue_free (GstSingleQueue * squeue);
181 static void wake_up_next_non_linked (GstMultiQueue * mq);
182 static void compute_high_id (GstMultiQueue * mq);
183 static void single_queue_overrun_cb (GstDataQueue * dq, GstSingleQueue * sq);
184 static void single_queue_underrun_cb (GstDataQueue * dq, GstSingleQueue * sq);
186 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink%d",
187     GST_PAD_SINK,
188     GST_PAD_REQUEST,
189     GST_STATIC_CAPS_ANY);
191 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src%d",
192     GST_PAD_SRC,
193     GST_PAD_SOMETIMES,
194     GST_STATIC_CAPS_ANY);
196 GST_DEBUG_CATEGORY_STATIC (multi_queue_debug);
197 #define GST_CAT_DEFAULT (multi_queue_debug)
199 /* Signals and args */
200 enum
202   SIGNAL_UNDERRUN,
203   SIGNAL_OVERRUN,
204   LAST_SIGNAL
205 };
207 /* default limits, we try to keep up to 2 seconds of data and if there is not
208  * time, up to 10 MB. The number of buffers is dynamically scaled to make sure
209  * there is data in the queues. Normally, the byte and time limits are not hit
210  * in theses conditions. */
211 #define DEFAULT_MAX_SIZE_BYTES 10 * 1024 * 1024 /* 10 MB */
212 #define DEFAULT_MAX_SIZE_BUFFERS 5
213 #define DEFAULT_MAX_SIZE_TIME 2 * GST_SECOND
215 /* second limits. When we hit one of the above limits we are probably dealing
216  * with a badly muxed file and we scale the limits to these emergency values.
217  * This is currently not yet implemented.
218  * Since we dynamically scale the queue buffer size up to the limits but avoid
219  * going above the max-size-buffers when we can, we don't really need this
220  * aditional extra size. */
221 #define DEFAULT_EXTRA_SIZE_BYTES 10 * 1024 * 1024       /* 10 MB */
222 #define DEFAULT_EXTRA_SIZE_BUFFERS 5
223 #define DEFAULT_EXTRA_SIZE_TIME 3 * GST_SECOND
225 #define DEFAULT_USE_BUFFERING FALSE
226 #define DEFAULT_LOW_PERCENT   10
227 #define DEFAULT_HIGH_PERCENT  99
229 enum
231   PROP_0,
232   PROP_EXTRA_SIZE_BYTES,
233   PROP_EXTRA_SIZE_BUFFERS,
234   PROP_EXTRA_SIZE_TIME,
235   PROP_MAX_SIZE_BYTES,
236   PROP_MAX_SIZE_BUFFERS,
237   PROP_MAX_SIZE_TIME,
238   PROP_USE_BUFFERING,
239   PROP_LOW_PERCENT,
240   PROP_HIGH_PERCENT,
241   PROP_LAST
242 };
244 #define GST_MULTI_QUEUE_MUTEX_LOCK(q) G_STMT_START {                          \
245   g_mutex_lock (q->qlock);                                              \
246 } G_STMT_END
248 #define GST_MULTI_QUEUE_MUTEX_UNLOCK(q) G_STMT_START {                        \
249   g_mutex_unlock (q->qlock);                                            \
250 } G_STMT_END
252 static void gst_multi_queue_finalize (GObject * object);
253 static void gst_multi_queue_set_property (GObject * object,
254     guint prop_id, const GValue * value, GParamSpec * pspec);
255 static void gst_multi_queue_get_property (GObject * object,
256     guint prop_id, GValue * value, GParamSpec * pspec);
258 static GstPad *gst_multi_queue_request_new_pad (GstElement * element,
259     GstPadTemplate * temp, const gchar * name);
260 static void gst_multi_queue_release_pad (GstElement * element, GstPad * pad);
261 static GstStateChangeReturn gst_multi_queue_change_state (GstElement *
262     element, GstStateChange transition);
264 static void gst_multi_queue_loop (GstPad * pad);
266 #define _do_init(bla) \
267   GST_DEBUG_CATEGORY_INIT (multi_queue_debug, "multiqueue", 0, "multiqueue element");
269 GST_BOILERPLATE_FULL (GstMultiQueue, gst_multi_queue, GstElement,
270     GST_TYPE_ELEMENT, _do_init);
272 static guint gst_multi_queue_signals[LAST_SIGNAL] = { 0 };
274 static void
275 gst_multi_queue_base_init (gpointer g_class)
277   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
279   gst_element_class_set_details_simple (gstelement_class,
280       "MultiQueue",
281       "Generic", "Multiple data queue", "Edward Hervey <edward@fluendo.com>");
282   gst_element_class_add_pad_template (gstelement_class,
283       gst_static_pad_template_get (&sinktemplate));
284   gst_element_class_add_pad_template (gstelement_class,
285       gst_static_pad_template_get (&srctemplate));
288 static void
289 gst_multi_queue_class_init (GstMultiQueueClass * klass)
291   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
292   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
294   gobject_class->set_property = gst_multi_queue_set_property;
295   gobject_class->get_property = gst_multi_queue_get_property;
297   /* SIGNALS */
299   /**
300    * GstMultiQueue::underrun:
301    * @multiqueue: the multqueue instance
302    *
303    * This signal is emitted from the streaming thread when there is
304    * no data in any of the queues inside the multiqueue instance (underrun).
305    *
306    * This indicates either starvation or EOS from the upstream data sources.
307    */
308   gst_multi_queue_signals[SIGNAL_UNDERRUN] =
309       g_signal_new ("underrun", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_FIRST,
310       G_STRUCT_OFFSET (GstMultiQueueClass, underrun), NULL, NULL,
311       g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
313   /**
314    * GstMultiQueue::overrun:
315    * @multiqueue: the multiqueue instance
316    *
317    * Reports that one of the queues in the multiqueue is full (overrun).
318    * A queue is full if the total amount of data inside it (num-buffers, time,
319    * size) is higher than the boundary values which can be set through the
320    * GObject properties.
321    *
322    * This can be used as an indicator of pre-roll. 
323    */
324   gst_multi_queue_signals[SIGNAL_OVERRUN] =
325       g_signal_new ("overrun", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_FIRST,
326       G_STRUCT_OFFSET (GstMultiQueueClass, overrun), NULL, NULL,
327       g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
329   /* PROPERTIES */
331   g_object_class_install_property (gobject_class, PROP_MAX_SIZE_BYTES,
332       g_param_spec_uint ("max-size-bytes", "Max. size (kB)",
333           "Max. amount of data in the queue (bytes, 0=disable)",
334           0, G_MAXUINT, DEFAULT_MAX_SIZE_BYTES,
335           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
336   g_object_class_install_property (gobject_class, PROP_MAX_SIZE_BUFFERS,
337       g_param_spec_uint ("max-size-buffers", "Max. size (buffers)",
338           "Max. number of buffers in the queue (0=disable)", 0, G_MAXUINT,
339           DEFAULT_MAX_SIZE_BUFFERS,
340           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
341   g_object_class_install_property (gobject_class, PROP_MAX_SIZE_TIME,
342       g_param_spec_uint64 ("max-size-time", "Max. size (ns)",
343           "Max. amount of data in the queue (in ns, 0=disable)", 0, G_MAXUINT64,
344           DEFAULT_MAX_SIZE_TIME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
346   g_object_class_install_property (gobject_class, PROP_EXTRA_SIZE_BYTES,
347       g_param_spec_uint ("extra-size-bytes", "Extra Size (kB)",
348           "Amount of data the queues can grow if one of them is empty (bytes, 0=disable)"
349           " (NOT IMPLEMENTED)",
350           0, G_MAXUINT, DEFAULT_EXTRA_SIZE_BYTES,
351           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
352   g_object_class_install_property (gobject_class, PROP_EXTRA_SIZE_BUFFERS,
353       g_param_spec_uint ("extra-size-buffers", "Extra Size (buffers)",
354           "Amount of buffers the queues can grow if one of them is empty (0=disable)"
355           " (NOT IMPLEMENTED)",
356           0, G_MAXUINT, DEFAULT_EXTRA_SIZE_BUFFERS,
357           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
358   g_object_class_install_property (gobject_class, PROP_EXTRA_SIZE_TIME,
359       g_param_spec_uint64 ("extra-size-time", "Extra Size (ns)",
360           "Amount of time the queues can grow if one of them is empty (in ns, 0=disable)"
361           " (NOT IMPLEMENTED)",
362           0, G_MAXUINT64, DEFAULT_EXTRA_SIZE_TIME,
363           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
365   /**
366    * GstMultiQueue:use-buffering
367    * 
368    * Enable the buffering option in multiqueue so that BUFFERING messages are
369    * emited based on low-/high-percent thresholds.
370    *
371    * Since: 0.10.26
372    */
373   g_object_class_install_property (gobject_class, PROP_USE_BUFFERING,
374       g_param_spec_boolean ("use-buffering", "Use buffering",
375           "Emit GST_MESSAGE_BUFFERING based on low-/high-percent thresholds",
376           DEFAULT_USE_BUFFERING, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
377   /**
378    * GstMultiQueue:low-percent
379    * 
380    * Low threshold percent for buffering to start.
381    *
382    * Since: 0.10.26
383    */
384   g_object_class_install_property (gobject_class, PROP_LOW_PERCENT,
385       g_param_spec_int ("low-percent", "Low percent",
386           "Low threshold for buffering to start", 0, 100,
387           DEFAULT_LOW_PERCENT, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
388   /**
389    * GstMultiQueue:high-percent
390    * 
391    * High threshold percent for buffering to finish.
392    *
393    * Since: 0.10.26
394    */
395   g_object_class_install_property (gobject_class, PROP_HIGH_PERCENT,
396       g_param_spec_int ("high-percent", "High percent",
397           "High threshold for buffering to finish", 0, 100,
398           DEFAULT_HIGH_PERCENT, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
401   gobject_class->finalize = gst_multi_queue_finalize;
403   gstelement_class->request_new_pad =
404       GST_DEBUG_FUNCPTR (gst_multi_queue_request_new_pad);
405   gstelement_class->release_pad =
406       GST_DEBUG_FUNCPTR (gst_multi_queue_release_pad);
407   gstelement_class->change_state =
408       GST_DEBUG_FUNCPTR (gst_multi_queue_change_state);
411 static void
412 gst_multi_queue_init (GstMultiQueue * mqueue, GstMultiQueueClass * klass)
414   mqueue->nbqueues = 0;
415   mqueue->queues = NULL;
417   mqueue->max_size.bytes = DEFAULT_MAX_SIZE_BYTES;
418   mqueue->max_size.visible = DEFAULT_MAX_SIZE_BUFFERS;
419   mqueue->max_size.time = DEFAULT_MAX_SIZE_TIME;
421   mqueue->extra_size.bytes = DEFAULT_EXTRA_SIZE_BYTES;
422   mqueue->extra_size.visible = DEFAULT_EXTRA_SIZE_BUFFERS;
423   mqueue->extra_size.time = DEFAULT_EXTRA_SIZE_TIME;
425   mqueue->use_buffering = DEFAULT_USE_BUFFERING;
426   mqueue->low_percent = DEFAULT_LOW_PERCENT;
427   mqueue->high_percent = DEFAULT_HIGH_PERCENT;
429   mqueue->counter = 1;
430   mqueue->highid = -1;
432   mqueue->qlock = g_mutex_new ();
435 static void
436 gst_multi_queue_finalize (GObject * object)
438   GstMultiQueue *mqueue = GST_MULTI_QUEUE (object);
440   g_list_foreach (mqueue->queues, (GFunc) gst_single_queue_free, NULL);
441   g_list_free (mqueue->queues);
442   mqueue->queues = NULL;
443   mqueue->queues_cookie++;
445   /* free/unref instance data */
446   g_mutex_free (mqueue->qlock);
448   G_OBJECT_CLASS (parent_class)->finalize (object);
451 #define SET_CHILD_PROPERTY(mq,format) G_STMT_START {            \
452     GList * tmp = mq->queues;                                   \
453     while (tmp) {                                               \
454       GstSingleQueue *q = (GstSingleQueue*)tmp->data;           \
455       q->max_size.format = mq->max_size.format;                 \
456       tmp = g_list_next(tmp);                                   \
457     };                                                          \
458 } G_STMT_END
460 static void
461 gst_multi_queue_set_property (GObject * object, guint prop_id,
462     const GValue * value, GParamSpec * pspec)
464   GstMultiQueue *mq = GST_MULTI_QUEUE (object);
466   switch (prop_id) {
467     case PROP_MAX_SIZE_BYTES:
468       GST_MULTI_QUEUE_MUTEX_LOCK (mq);
469       mq->max_size.bytes = g_value_get_uint (value);
470       SET_CHILD_PROPERTY (mq, bytes);
471       GST_MULTI_QUEUE_MUTEX_UNLOCK (mq);
472       break;
473     case PROP_MAX_SIZE_BUFFERS:
474       GST_MULTI_QUEUE_MUTEX_LOCK (mq);
475       mq->max_size.visible = g_value_get_uint (value);
476       SET_CHILD_PROPERTY (mq, visible);
477       GST_MULTI_QUEUE_MUTEX_UNLOCK (mq);
478       break;
479     case PROP_MAX_SIZE_TIME:
480       GST_MULTI_QUEUE_MUTEX_LOCK (mq);
481       mq->max_size.time = g_value_get_uint64 (value);
482       SET_CHILD_PROPERTY (mq, time);
483       GST_MULTI_QUEUE_MUTEX_UNLOCK (mq);
484       break;
485     case PROP_EXTRA_SIZE_BYTES:
486       mq->extra_size.bytes = g_value_get_uint (value);
487       break;
488     case PROP_EXTRA_SIZE_BUFFERS:
489       mq->extra_size.visible = g_value_get_uint (value);
490       break;
491     case PROP_EXTRA_SIZE_TIME:
492       mq->extra_size.time = g_value_get_uint64 (value);
493       break;
494     case PROP_USE_BUFFERING:
495       mq->use_buffering = g_value_get_boolean (value);
496       break;
497     case PROP_LOW_PERCENT:
498       mq->low_percent = g_value_get_int (value);
499       break;
500     case PROP_HIGH_PERCENT:
501       mq->high_percent = g_value_get_int (value);
502       break;
503     default:
504       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
505       break;
506   }
509 static void
510 gst_multi_queue_get_property (GObject * object, guint prop_id,
511     GValue * value, GParamSpec * pspec)
513   GstMultiQueue *mq = GST_MULTI_QUEUE (object);
515   GST_MULTI_QUEUE_MUTEX_LOCK (mq);
517   switch (prop_id) {
518     case PROP_EXTRA_SIZE_BYTES:
519       g_value_set_uint (value, mq->extra_size.bytes);
520       break;
521     case PROP_EXTRA_SIZE_BUFFERS:
522       g_value_set_uint (value, mq->extra_size.visible);
523       break;
524     case PROP_EXTRA_SIZE_TIME:
525       g_value_set_uint64 (value, mq->extra_size.time);
526       break;
527     case PROP_MAX_SIZE_BYTES:
528       g_value_set_uint (value, mq->max_size.bytes);
529       break;
530     case PROP_MAX_SIZE_BUFFERS:
531       g_value_set_uint (value, mq->max_size.visible);
532       break;
533     case PROP_MAX_SIZE_TIME:
534       g_value_set_uint64 (value, mq->max_size.time);
535       break;
536     case PROP_USE_BUFFERING:
537       g_value_set_boolean (value, mq->use_buffering);
538       break;
539     case PROP_LOW_PERCENT:
540       g_value_set_int (value, mq->low_percent);
541       break;
542     case PROP_HIGH_PERCENT:
543       g_value_set_int (value, mq->high_percent);
544       break;
545     default:
546       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
547       break;
548   }
550   GST_MULTI_QUEUE_MUTEX_UNLOCK (mq);
553 static GstIterator *
554 gst_multi_queue_iterate_internal_links (GstPad * pad)
556   GstIterator *it = NULL;
557   GstPad *opad;
558   GstSingleQueue *squeue;
559   GstMultiQueue *mq = GST_MULTI_QUEUE (gst_pad_get_parent (pad));
561   GST_MULTI_QUEUE_MUTEX_LOCK (mq);
562   squeue = gst_pad_get_element_private (pad);
563   if (!squeue)
564     goto out;
566   if (squeue->sinkpad == pad)
567     opad = gst_object_ref (squeue->srcpad);
568   else if (squeue->srcpad == pad)
569     opad = gst_object_ref (squeue->sinkpad);
570   else
571     goto out;
573   it = gst_iterator_new_single (GST_TYPE_PAD, opad,
574       (GstCopyFunction) gst_object_ref, (GFreeFunc) gst_object_unref);
576   gst_object_unref (opad);
578 out:
579   GST_MULTI_QUEUE_MUTEX_UNLOCK (mq);
580   gst_object_unref (mq);
582   return it;
586 /*
587  * GstElement methods
588  */
590 static GstPad *
591 gst_multi_queue_request_new_pad (GstElement * element, GstPadTemplate * temp,
592     const gchar * name)
594   GstMultiQueue *mqueue = GST_MULTI_QUEUE (element);
595   GstSingleQueue *squeue;
596   gint temp_id = -1;
598   if (name) {
599     sscanf (name + 4, "%d", &temp_id);
600     GST_LOG_OBJECT (element, "name : %s (id %d)", GST_STR_NULL (name), temp_id);
601   }
603   /* Create a new single queue, add the sink and source pad and return the sink pad */
604   squeue = gst_single_queue_new (mqueue, temp_id);
606   GST_DEBUG_OBJECT (mqueue, "Returning pad %s:%s",
607       GST_DEBUG_PAD_NAME (squeue->sinkpad));
609   return squeue ? squeue->sinkpad : NULL;
612 static void
613 gst_multi_queue_release_pad (GstElement * element, GstPad * pad)
615   GstMultiQueue *mqueue = GST_MULTI_QUEUE (element);
616   GstSingleQueue *sq = NULL;
617   GList *tmp;
619   GST_LOG_OBJECT (element, "pad %s:%s", GST_DEBUG_PAD_NAME (pad));
621   GST_MULTI_QUEUE_MUTEX_LOCK (mqueue);
622   /* Find which single queue it belongs to, knowing that it should be a sinkpad */
623   for (tmp = mqueue->queues; tmp; tmp = g_list_next (tmp)) {
624     sq = (GstSingleQueue *) tmp->data;
626     if (sq->sinkpad == pad)
627       break;
628   }
630   if (!tmp) {
631     GST_WARNING_OBJECT (mqueue, "That pad doesn't belong to this element ???");
632     GST_MULTI_QUEUE_MUTEX_UNLOCK (mqueue);
633     return;
634   }
636   /* FIXME: The removal of the singlequeue should probably not happen until it
637    * finishes draining */
639   /* remove it from the list */
640   mqueue->queues = g_list_delete_link (mqueue->queues, tmp);
641   mqueue->queues_cookie++;
643   /* FIXME : recompute next-non-linked */
644   GST_MULTI_QUEUE_MUTEX_UNLOCK (mqueue);
646   /* delete SingleQueue */
647   gst_data_queue_set_flushing (sq->queue, TRUE);
649   gst_pad_set_active (sq->srcpad, FALSE);
650   gst_pad_set_active (sq->sinkpad, FALSE);
651   gst_pad_set_element_private (sq->srcpad, NULL);
652   gst_pad_set_element_private (sq->sinkpad, NULL);
653   gst_element_remove_pad (element, sq->srcpad);
654   gst_element_remove_pad (element, sq->sinkpad);
655   gst_single_queue_free (sq);
658 static GstStateChangeReturn
659 gst_multi_queue_change_state (GstElement * element, GstStateChange transition)
661   GstMultiQueue *mqueue = GST_MULTI_QUEUE (element);
662   GstSingleQueue *sq = NULL;
663   GstStateChangeReturn result;
665   switch (transition) {
666     case GST_STATE_CHANGE_READY_TO_PAUSED:{
667       GList *tmp;
669       /* Set all pads to non-flushing */
670       GST_MULTI_QUEUE_MUTEX_LOCK (mqueue);
671       for (tmp = mqueue->queues; tmp; tmp = g_list_next (tmp)) {
672         sq = (GstSingleQueue *) tmp->data;
673         sq->flushing = FALSE;
674       }
675       GST_MULTI_QUEUE_MUTEX_UNLOCK (mqueue);
676       break;
677     }
678     case GST_STATE_CHANGE_PAUSED_TO_READY:{
679       GList *tmp;
681       /* Un-wait all waiting pads */
682       GST_MULTI_QUEUE_MUTEX_LOCK (mqueue);
683       for (tmp = mqueue->queues; tmp; tmp = g_list_next (tmp)) {
684         sq = (GstSingleQueue *) tmp->data;
685         sq->flushing = TRUE;
686         g_cond_signal (sq->turn);
687       }
688       GST_MULTI_QUEUE_MUTEX_UNLOCK (mqueue);
689       break;
690     }
691     default:
692       break;
693   }
695   result = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
697   switch (transition) {
698     default:
699       break;
700   }
702   return result;
708 static gboolean
709 gst_single_queue_flush (GstMultiQueue * mq, GstSingleQueue * sq, gboolean flush)
711   gboolean result;
713   GST_DEBUG_OBJECT (mq, "flush %s queue %d", (flush ? "start" : "stop"),
714       sq->id);
716   if (flush) {
717     sq->srcresult = GST_FLOW_WRONG_STATE;
718     gst_data_queue_set_flushing (sq->queue, TRUE);
720     sq->flushing = TRUE;
722     /* wake up non-linked task */
723     GST_LOG_OBJECT (mq, "SingleQueue %d : waking up eventually waiting task",
724         sq->id);
725     GST_MULTI_QUEUE_MUTEX_LOCK (mq);
726     g_cond_signal (sq->turn);
727     GST_MULTI_QUEUE_MUTEX_UNLOCK (mq);
729     GST_LOG_OBJECT (mq, "SingleQueue %d : pausing task", sq->id);
730     result = gst_pad_pause_task (sq->srcpad);
731     sq->sink_tainted = sq->src_tainted = TRUE;
732   } else {
733     gst_data_queue_flush (sq->queue);
734     gst_segment_init (&sq->sink_segment, GST_FORMAT_TIME);
735     gst_segment_init (&sq->src_segment, GST_FORMAT_TIME);
736     /* All pads start off not-linked for a smooth kick-off */
737     sq->srcresult = GST_FLOW_OK;
738     sq->cur_time = 0;
739     sq->max_size.visible = mq->max_size.visible;
740     sq->is_eos = FALSE;
741     sq->nextid = 0;
742     sq->oldid = 0;
743     sq->last_oldid = G_MAXUINT32;
744     gst_data_queue_set_flushing (sq->queue, FALSE);
746     sq->flushing = FALSE;
748     GST_LOG_OBJECT (mq, "SingleQueue %d : starting task", sq->id);
749     result =
750         gst_pad_start_task (sq->srcpad, (GstTaskFunction) gst_multi_queue_loop,
751         sq->srcpad);
752   }
753   return result;
756 static void
757 update_buffering (GstMultiQueue * mq, GstSingleQueue * sq)
759   GstDataQueueSize size;
760   gint percent, tmp;
761   gboolean post = FALSE;
763   /* nothing to dowhen we are not in buffering mode */
764   if (!mq->use_buffering)
765     return;
767   gst_data_queue_get_level (sq->queue, &size);
769   GST_DEBUG_OBJECT (mq,
770       "queue %d: visible %u/%u, bytes %u/%u, time %" G_GUINT64_FORMAT "/%"
771       G_GUINT64_FORMAT, sq->id, size.visible, sq->max_size.visible,
772       size.bytes, sq->max_size.bytes, sq->cur_time, sq->max_size.time);
774   /* get bytes and time percentages and take the max */
775   if (sq->is_eos) {
776     percent = 100;
777   } else {
778     percent = 0;
779     if (sq->max_size.time > 0) {
780       tmp = (sq->cur_time * 100) / sq->max_size.time;
781       percent = MAX (percent, tmp);
782     }
783     if (sq->max_size.bytes > 0) {
784       tmp = (size.bytes * 100) / sq->max_size.bytes;
785       percent = MAX (percent, tmp);
786     }
787   }
789   if (mq->buffering) {
790     post = TRUE;
791     if (percent >= mq->high_percent) {
792       mq->buffering = FALSE;
793     }
794     /* make sure it increases */
795     percent = MAX (mq->percent, percent);
797     if (percent == mq->percent)
798       /* don't post if nothing changed */
799       post = FALSE;
800     else
801       /* else keep last value we posted */
802       mq->percent = percent;
803   } else {
804     if (percent < mq->low_percent) {
805       mq->buffering = TRUE;
806       mq->percent = percent;
807       post = TRUE;
808     }
809   }
810   if (post) {
811     GstMessage *message;
813     /* scale to high percent so that it becomes the 100% mark */
814     percent = percent * 100 / mq->high_percent;
815     /* clip */
816     if (percent > 100)
817       percent = 100;
819     GST_DEBUG_OBJECT (mq, "buffering %d percent", percent);
820     message = gst_message_new_buffering (GST_OBJECT_CAST (mq), percent);
822     gst_element_post_message (GST_ELEMENT_CAST (mq), message);
823   } else {
824     GST_DEBUG_OBJECT (mq, "filled %d percent", percent);
825   }
828 /* calculate the diff between running time on the sink and src of the queue.
829  * This is the total amount of time in the queue. 
830  * WITH LOCK TAKEN */
831 static void
832 update_time_level (GstMultiQueue * mq, GstSingleQueue * sq)
834   gint64 sink_time, src_time;
836   if (sq->sink_tainted) {
837     sink_time = sq->sinktime =
838         gst_segment_to_running_time (&sq->sink_segment, GST_FORMAT_TIME,
839         sq->sink_segment.last_stop);
841     if (G_UNLIKELY (sink_time != GST_CLOCK_TIME_NONE))
842       /* if we have a time, we become untainted and use the time */
843       sq->sink_tainted = FALSE;
844   } else
845     sink_time = sq->sinktime;
847   if (sq->src_tainted) {
848     src_time = sq->srctime =
849         gst_segment_to_running_time (&sq->src_segment, GST_FORMAT_TIME,
850         sq->src_segment.last_stop);
851     /* if we have a time, we become untainted and use the time */
852     if (G_UNLIKELY (src_time != GST_CLOCK_TIME_NONE))
853       sq->src_tainted = FALSE;
854   } else
855     src_time = sq->srctime;
857   GST_DEBUG_OBJECT (mq,
858       "queue %d, sink %" GST_TIME_FORMAT ", src %" GST_TIME_FORMAT, sq->id,
859       GST_TIME_ARGS (sink_time), GST_TIME_ARGS (src_time));
861   /* This allows for streams with out of order timestamping - sometimes the
862    * emerging timestamp is later than the arriving one(s) */
863   if (G_LIKELY (sink_time != -1 && src_time != -1 && sink_time > src_time))
864     sq->cur_time = sink_time - src_time;
865   else
866     sq->cur_time = 0;
868   /* updating the time level can change the buffering state */
869   update_buffering (mq, sq);
871   return;
874 /* take a NEWSEGMENT event and apply the values to segment, updating the time
875  * level of queue. */
876 static void
877 apply_segment (GstMultiQueue * mq, GstSingleQueue * sq, GstEvent * event,
878     GstSegment * segment)
880   gboolean update;
881   GstFormat format;
882   gdouble rate, arate;
883   gint64 start, stop, time;
885   gst_event_parse_new_segment_full (event, &update, &rate, &arate,
886       &format, &start, &stop, &time);
888   /* now configure the values, we use these to track timestamps on the
889    * sinkpad. */
890   if (format != GST_FORMAT_TIME) {
891     /* non-time format, pretent the current time segment is closed with a
892      * 0 start and unknown stop time. */
893     update = FALSE;
894     format = GST_FORMAT_TIME;
895     start = 0;
896     stop = -1;
897     time = 0;
898   }
900   GST_MULTI_QUEUE_MUTEX_LOCK (mq);
902   gst_segment_set_newsegment_full (segment, update,
903       rate, arate, format, start, stop, time);
905   if (segment == &sq->sink_segment)
906     sq->sink_tainted = TRUE;
907   else
908     sq->src_tainted = TRUE;
910   GST_DEBUG_OBJECT (mq,
911       "queue %d, configured NEWSEGMENT %" GST_SEGMENT_FORMAT, sq->id, segment);
913   /* segment can update the time level of the queue */
914   update_time_level (mq, sq);
916   GST_MULTI_QUEUE_MUTEX_UNLOCK (mq);
919 /* take a buffer and update segment, updating the time level of the queue. */
920 static void
921 apply_buffer (GstMultiQueue * mq, GstSingleQueue * sq, GstClockTime timestamp,
922     GstClockTime duration, GstSegment * segment)
924   GST_MULTI_QUEUE_MUTEX_LOCK (mq);
926   /* if no timestamp is set, assume it's continuous with the previous 
927    * time */
928   if (timestamp == GST_CLOCK_TIME_NONE)
929     timestamp = segment->last_stop;
931   /* add duration */
932   if (duration != GST_CLOCK_TIME_NONE)
933     timestamp += duration;
935   GST_DEBUG_OBJECT (mq, "queue %d, last_stop updated to %" GST_TIME_FORMAT,
936       sq->id, GST_TIME_ARGS (timestamp));
938   gst_segment_set_last_stop (segment, GST_FORMAT_TIME, timestamp);
940   if (segment == &sq->sink_segment)
941     sq->sink_tainted = TRUE;
942   else
943     sq->src_tainted = TRUE;
945   /* calc diff with other end */
946   update_time_level (mq, sq);
947   GST_MULTI_QUEUE_MUTEX_UNLOCK (mq);
950 static GstFlowReturn
951 gst_single_queue_push_one (GstMultiQueue * mq, GstSingleQueue * sq,
952     GstMiniObject * object)
954   GstFlowReturn result = GST_FLOW_OK;
956   if (GST_IS_BUFFER (object)) {
957     GstBuffer *buffer;
958     GstClockTime timestamp, duration;
959     GstCaps *caps;
961     buffer = GST_BUFFER_CAST (object);
962     timestamp = GST_BUFFER_TIMESTAMP (buffer);
963     duration = GST_BUFFER_DURATION (buffer);
964     caps = GST_BUFFER_CAPS (buffer);
966     apply_buffer (mq, sq, timestamp, duration, &sq->src_segment);
968     /* Applying the buffer may have made the queue non-full again, unblock it if needed */
969     gst_data_queue_limits_changed (sq->queue);
971     GST_DEBUG_OBJECT (mq,
972         "SingleQueue %d : Pushing buffer %p with ts %" GST_TIME_FORMAT,
973         sq->id, buffer, GST_TIME_ARGS (timestamp));
975     /* Set caps on pad before pushing, this avoids core calling the acceptcaps
976      * function on the srcpad, which will call acceptcaps upstream, which might
977      * not accept these caps (anymore). */
978     if (caps && caps != GST_PAD_CAPS (sq->srcpad))
979       gst_pad_set_caps (sq->srcpad, caps);
981     result = gst_pad_push (sq->srcpad, buffer);
982   } else if (GST_IS_EVENT (object)) {
983     GstEvent *event;
985     event = GST_EVENT_CAST (object);
987     switch (GST_EVENT_TYPE (event)) {
988       case GST_EVENT_EOS:
989         result = GST_FLOW_UNEXPECTED;
990         break;
991       case GST_EVENT_NEWSEGMENT:
992         apply_segment (mq, sq, event, &sq->src_segment);
993         /* Applying the segment may have made the queue non-full again, unblock it if needed */
994         gst_data_queue_limits_changed (sq->queue);
995         break;
996       default:
997         break;
998     }
1000     GST_DEBUG_OBJECT (mq,
1001         "SingleQueue %d : Pushing event %p of type %s",
1002         sq->id, event, GST_EVENT_TYPE_NAME (event));
1004     gst_pad_push_event (sq->srcpad, event);
1005   } else {
1006     g_warning ("Unexpected object in singlequeue %d (refcounting problem?)",
1007         sq->id);
1008   }
1009   return result;
1011   /* ERRORS */
1014 static GstMiniObject *
1015 gst_multi_queue_item_steal_object (GstMultiQueueItem * item)
1017   GstMiniObject *res;
1019   res = item->object;
1020   item->object = NULL;
1022   return res;
1025 static void
1026 gst_multi_queue_item_destroy (GstMultiQueueItem * item)
1028   if (item->object)
1029     gst_mini_object_unref (item->object);
1030   g_slice_free (GstMultiQueueItem, item);
1033 /* takes ownership of passed mini object! */
1034 static GstMultiQueueItem *
1035 gst_multi_queue_buffer_item_new (GstMiniObject * object, guint32 curid)
1037   GstMultiQueueItem *item;
1039   item = g_slice_new (GstMultiQueueItem);
1040   item->object = object;
1041   item->destroy = (GDestroyNotify) gst_multi_queue_item_destroy;
1042   item->posid = curid;
1044   item->size = GST_BUFFER_SIZE (object);
1045   item->duration = GST_BUFFER_DURATION (object);
1046   if (item->duration == GST_CLOCK_TIME_NONE)
1047     item->duration = 0;
1048   item->visible = TRUE;
1049   return item;
1052 static GstMultiQueueItem *
1053 gst_multi_queue_event_item_new (GstMiniObject * object, guint32 curid)
1055   GstMultiQueueItem *item;
1057   item = g_slice_new (GstMultiQueueItem);
1058   item->object = object;
1059   item->destroy = (GDestroyNotify) gst_multi_queue_item_destroy;
1060   item->posid = curid;
1062   item->size = 0;
1063   item->duration = 0;
1064   item->visible = FALSE;
1065   return item;
1068 /* Each main loop attempts to push buffers until the return value
1069  * is not-linked. not-linked pads are not allowed to push data beyond
1070  * any linked pads, so they don't 'rush ahead of the pack'.
1071  */
1072 static void
1073 gst_multi_queue_loop (GstPad * pad)
1075   GstSingleQueue *sq;
1076   GstMultiQueueItem *item;
1077   GstDataQueueItem *sitem;
1078   GstMultiQueue *mq;
1079   GstMiniObject *object = NULL;
1080   guint32 newid;
1081   GstFlowReturn result;
1083   sq = (GstSingleQueue *) gst_pad_get_element_private (pad);
1084   mq = sq->mqueue;
1086   GST_DEBUG_OBJECT (mq, "SingleQueue %d : trying to pop an object", sq->id);
1088   if (sq->flushing)
1089     goto out_flushing;
1091   /* Get something from the queue, blocking until that happens, or we get
1092    * flushed */
1093   if (!(gst_data_queue_pop (sq->queue, &sitem)))
1094     goto out_flushing;
1096   item = (GstMultiQueueItem *) sitem;
1097   newid = item->posid;
1099   /* steal the object and destroy the item */
1100   object = gst_multi_queue_item_steal_object (item);
1101   gst_multi_queue_item_destroy (item);
1103   GST_LOG_OBJECT (mq, "SingleQueue %d : newid:%d , oldid:%d",
1104       sq->id, newid, sq->last_oldid);
1106   /* If we're not-linked, we do some extra work because we might need to
1107    * wait before pushing. If we're linked but there's a gap in the IDs,
1108    * or it's the first loop, or we just passed the previous highid, 
1109    * we might need to wake some sleeping pad up, so there's extra work 
1110    * there too */
1111   if (sq->srcresult == GST_FLOW_NOT_LINKED ||
1112       (sq->last_oldid == G_MAXUINT32) || (newid != (sq->last_oldid + 1)) ||
1113       sq->last_oldid > mq->highid) {
1114     GST_LOG_OBJECT (mq, "CHECKING sq->srcresult: %s",
1115         gst_flow_get_name (sq->srcresult));
1117     GST_MULTI_QUEUE_MUTEX_LOCK (mq);
1119     /* Check again if we're flushing after the lock is taken,
1120      * the flush flag might have been changed in the meantime */
1121     if (sq->flushing) {
1122       GST_MULTI_QUEUE_MUTEX_UNLOCK (mq);
1123       goto out_flushing;
1124     }
1126     /* Update the nextid so other threads know when to wake us up */
1127     sq->nextid = newid;
1129     /* Update the oldid (the last ID we output) for highid tracking */
1130     if (sq->last_oldid != G_MAXUINT32)
1131       sq->oldid = sq->last_oldid;
1133     if (sq->srcresult == GST_FLOW_NOT_LINKED) {
1134       /* Go to sleep until it's time to push this buffer */
1136       /* Recompute the highid */
1137       compute_high_id (mq);
1138       while (newid > mq->highid && sq->srcresult == GST_FLOW_NOT_LINKED) {
1139         GST_DEBUG_OBJECT (mq, "queue %d sleeping for not-linked wakeup with "
1140             "newid %u and highid %u", sq->id, newid, mq->highid);
1143         /* Wake up all non-linked pads before we sleep */
1144         wake_up_next_non_linked (mq);
1146         mq->numwaiting++;
1147         g_cond_wait (sq->turn, mq->qlock);
1148         mq->numwaiting--;
1150         if (sq->flushing) {
1151           GST_MULTI_QUEUE_MUTEX_UNLOCK (mq);
1152           goto out_flushing;
1153         }
1155         GST_DEBUG_OBJECT (mq, "queue %d woken from sleeping for not-linked "
1156             "wakeup with newid %u and highid %u", sq->id, newid, mq->highid);
1157       }
1159       /* Re-compute the high_id in case someone else pushed */
1160       compute_high_id (mq);
1161     } else {
1162       compute_high_id (mq);
1163       /* Wake up all non-linked pads */
1164       wake_up_next_non_linked (mq);
1165     }
1166     /* We're done waiting, we can clear the nextid */
1167     sq->nextid = 0;
1169     GST_MULTI_QUEUE_MUTEX_UNLOCK (mq);
1170   }
1172   if (sq->flushing)
1173     goto out_flushing;
1175   GST_LOG_OBJECT (mq, "BEFORE PUSHING sq->srcresult: %s",
1176       gst_flow_get_name (sq->srcresult));
1178   /* Try to push out the new object */
1179   result = gst_single_queue_push_one (mq, sq, object);
1180   sq->srcresult = result;
1181   object = NULL;
1183   if (result != GST_FLOW_OK && result != GST_FLOW_NOT_LINKED
1184       && result != GST_FLOW_UNEXPECTED)
1185     goto out_flushing;
1187   GST_LOG_OBJECT (mq, "AFTER PUSHING sq->srcresult: %s",
1188       gst_flow_get_name (sq->srcresult));
1190   sq->last_oldid = newid;
1191   return;
1193 out_flushing:
1194   {
1195     if (object)
1196       gst_mini_object_unref (object);
1198     /* Need to make sure wake up any sleeping pads when we exit */
1199     GST_MULTI_QUEUE_MUTEX_LOCK (mq);
1200     compute_high_id (mq);
1201     wake_up_next_non_linked (mq);
1202     GST_MULTI_QUEUE_MUTEX_UNLOCK (mq);
1204     /* upstream needs to see fatal result ASAP to shut things down,
1205      * but might be stuck in one of our other full queues;
1206      * so empty this one and trigger dynamic queue growth. At
1207      * this point the srcresult is not OK, NOT_LINKED
1208      * or UNEXPECTED, i.e. a real failure */
1209     gst_data_queue_flush (sq->queue);
1210     single_queue_underrun_cb (sq->queue, sq);
1211     gst_data_queue_set_flushing (sq->queue, TRUE);
1212     gst_pad_pause_task (sq->srcpad);
1213     GST_CAT_LOG_OBJECT (multi_queue_debug, mq,
1214         "SingleQueue[%d] task paused, reason:%s",
1215         sq->id, gst_flow_get_name (sq->srcresult));
1216     return;
1217   }
1220 /**
1221  * gst_multi_queue_chain:
1222  *
1223  * This is similar to GstQueue's chain function, except:
1224  * _ we don't have leak behavioures,
1225  * _ we push with a unique id (curid)
1226  */
1227 static GstFlowReturn
1228 gst_multi_queue_chain (GstPad * pad, GstBuffer * buffer)
1230   GstSingleQueue *sq;
1231   GstMultiQueue *mq;
1232   GstMultiQueueItem *item;
1233   guint32 curid;
1234   GstClockTime timestamp, duration;
1236   sq = gst_pad_get_element_private (pad);
1237   mq = sq->mqueue;
1239   /* if eos, we are always full, so avoid hanging incoming indefinitely */
1240   if (sq->is_eos)
1241     goto was_eos;
1243   /* Get a unique incrementing id */
1244   curid = G_ATOMIC_INT_ADD ((gint *) & mq->counter, 1);
1246   GST_LOG_OBJECT (mq, "SingleQueue %d : about to enqueue buffer %p with id %d",
1247       sq->id, buffer, curid);
1249   item = gst_multi_queue_buffer_item_new (GST_MINI_OBJECT_CAST (buffer), curid);
1251   timestamp = GST_BUFFER_TIMESTAMP (buffer);
1252   duration = GST_BUFFER_DURATION (buffer);
1254   if (!(gst_data_queue_push (sq->queue, (GstDataQueueItem *) item)))
1255     goto flushing;
1257   /* update time level, we must do this after pushing the data in the queue so
1258    * that we never end up filling the queue first. */
1259   apply_buffer (mq, sq, timestamp, duration, &sq->sink_segment);
1261 done:
1262   return sq->srcresult;
1264   /* ERRORS */
1265 flushing:
1266   {
1267     GST_LOG_OBJECT (mq, "SingleQueue %d : exit because task paused, reason: %s",
1268         sq->id, gst_flow_get_name (sq->srcresult));
1269     gst_multi_queue_item_destroy (item);
1270     goto done;
1271   }
1272 was_eos:
1273   {
1274     GST_DEBUG_OBJECT (mq, "we are EOS, dropping buffer, return UNEXPECTED");
1275     gst_buffer_unref (buffer);
1276     return GST_FLOW_UNEXPECTED;
1277   }
1280 static gboolean
1281 gst_multi_queue_sink_activate_push (GstPad * pad, gboolean active)
1283   GstSingleQueue *sq;
1285   sq = (GstSingleQueue *) gst_pad_get_element_private (pad);
1287   if (active) {
1288     /* All pads start off linked until they push one buffer */
1289     sq->srcresult = GST_FLOW_OK;
1290   } else {
1291     sq->srcresult = GST_FLOW_WRONG_STATE;
1292     gst_data_queue_flush (sq->queue);
1293   }
1294   return TRUE;
1297 static gboolean
1298 gst_multi_queue_sink_event (GstPad * pad, GstEvent * event)
1300   GstSingleQueue *sq;
1301   GstMultiQueue *mq;
1302   guint32 curid;
1303   GstMultiQueueItem *item;
1304   gboolean res;
1305   GstEventType type;
1306   GstEvent *sref = NULL;
1308   sq = (GstSingleQueue *) gst_pad_get_element_private (pad);
1309   mq = (GstMultiQueue *) gst_pad_get_parent (pad);
1311   type = GST_EVENT_TYPE (event);
1313   switch (type) {
1314     case GST_EVENT_FLUSH_START:
1315       GST_DEBUG_OBJECT (mq, "SingleQueue %d : received flush start event",
1316           sq->id);
1318       res = gst_pad_push_event (sq->srcpad, event);
1320       gst_single_queue_flush (mq, sq, TRUE);
1321       goto done;
1323     case GST_EVENT_FLUSH_STOP:
1324       GST_DEBUG_OBJECT (mq, "SingleQueue %d : received flush stop event",
1325           sq->id);
1327       res = gst_pad_push_event (sq->srcpad, event);
1329       gst_single_queue_flush (mq, sq, FALSE);
1330       goto done;
1331     case GST_EVENT_NEWSEGMENT:
1332       /* take ref because the queue will take ownership and we need the event
1333        * afterwards to update the segment */
1334       sref = gst_event_ref (event);
1335       break;
1337     default:
1338       if (!(GST_EVENT_IS_SERIALIZED (event))) {
1339         res = gst_pad_push_event (sq->srcpad, event);
1340         goto done;
1341       }
1342       break;
1343   }
1345   /* if eos, we are always full, so avoid hanging incoming indefinitely */
1346   if (sq->is_eos)
1347     goto was_eos;
1349   /* Get an unique incrementing id. */
1350   curid = G_ATOMIC_INT_ADD ((gint *) & mq->counter, 1);
1352   item = gst_multi_queue_event_item_new ((GstMiniObject *) event, curid);
1354   GST_DEBUG_OBJECT (mq,
1355       "SingleQueue %d : Enqueuing event %p of type %s with id %d",
1356       sq->id, event, GST_EVENT_TYPE_NAME (event), curid);
1358   if (!(res = gst_data_queue_push (sq->queue, (GstDataQueueItem *) item)))
1359     goto flushing;
1361   /* mark EOS when we received one, we must do that after putting the
1362    * buffer in the queue because EOS marks the buffer as filled. No need to take
1363    * a lock, the _check_full happens from this thread only, right before pushing
1364    * into dataqueue. */
1365   switch (type) {
1366     case GST_EVENT_EOS:
1367       sq->is_eos = TRUE;
1368       /* EOS affects the buffering state */
1369       update_buffering (mq, sq);
1370       single_queue_overrun_cb (sq->queue, sq);
1371       break;
1372     case GST_EVENT_NEWSEGMENT:
1373       apply_segment (mq, sq, sref, &sq->sink_segment);
1374       gst_event_unref (sref);
1375       break;
1376     default:
1377       break;
1378   }
1379 done:
1380   gst_object_unref (mq);
1381   return res;
1383 flushing:
1384   {
1385     GST_LOG_OBJECT (mq, "SingleQueue %d : exit because task paused, reason: %s",
1386         sq->id, gst_flow_get_name (sq->srcresult));
1387     if (sref)
1388       gst_event_unref (sref);
1389     gst_multi_queue_item_destroy (item);
1390     goto done;
1391   }
1392 was_eos:
1393   {
1394     GST_DEBUG_OBJECT (mq, "we are EOS, dropping event, return FALSE");
1395     gst_event_unref (event);
1396     res = FALSE;
1397     goto done;
1398   }
1401 static GstCaps *
1402 gst_multi_queue_getcaps (GstPad * pad)
1404   GstSingleQueue *sq = gst_pad_get_element_private (pad);
1405   GstPad *otherpad;
1406   GstCaps *result;
1408   otherpad = (pad == sq->srcpad) ? sq->sinkpad : sq->srcpad;
1410   GST_LOG_OBJECT (otherpad, "Getting caps from the peer of this pad");
1412   result = gst_pad_peer_get_caps (otherpad);
1413   if (result == NULL)
1414     result = gst_caps_new_any ();
1416   return result;
1419 static gboolean
1420 gst_multi_queue_acceptcaps (GstPad * pad, GstCaps * caps)
1422   GstSingleQueue *sq = gst_pad_get_element_private (pad);
1423   GstPad *otherpad;
1424   gboolean result;
1426   otherpad = (pad == sq->srcpad) ? sq->sinkpad : sq->srcpad;
1428   GST_LOG_OBJECT (otherpad, "Accept caps from the peer of this pad");
1430   result = gst_pad_peer_accept_caps (otherpad, caps);
1432   return result;
1435 static GstFlowReturn
1436 gst_multi_queue_bufferalloc (GstPad * pad, guint64 offset, guint size,
1437     GstCaps * caps, GstBuffer ** buf)
1439   GstSingleQueue *sq = gst_pad_get_element_private (pad);
1441   return gst_pad_alloc_buffer (sq->srcpad, offset, size, caps, buf);
1444 static gboolean
1445 gst_multi_queue_src_activate_push (GstPad * pad, gboolean active)
1447   GstMultiQueue *mq;
1448   GstSingleQueue *sq;
1449   gboolean result = FALSE;
1451   sq = (GstSingleQueue *) gst_pad_get_element_private (pad);
1452   mq = sq->mqueue;
1454   GST_DEBUG_OBJECT (mq, "SingleQueue %d", sq->id);
1456   if (active) {
1457     result = gst_single_queue_flush (mq, sq, FALSE);
1458   } else {
1459     result = gst_single_queue_flush (mq, sq, TRUE);
1460     /* make sure streaming finishes */
1461     result |= gst_pad_stop_task (pad);
1462   }
1463   return result;
1466 static gboolean
1467 gst_multi_queue_src_event (GstPad * pad, GstEvent * event)
1469   GstSingleQueue *sq = gst_pad_get_element_private (pad);
1471   return gst_pad_push_event (sq->sinkpad, event);
1474 static gboolean
1475 gst_multi_queue_src_query (GstPad * pad, GstQuery * query)
1477   GstSingleQueue *sq = gst_pad_get_element_private (pad);
1478   GstPad *peerpad;
1479   gboolean res;
1481   /* FIXME, Handle position offset depending on queue size */
1483   /* default handling */
1484   if (!(peerpad = gst_pad_get_peer (sq->sinkpad)))
1485     goto no_peer;
1487   res = gst_pad_query (peerpad, query);
1489   gst_object_unref (peerpad);
1491   return res;
1493   /* ERRORS */
1494 no_peer:
1495   {
1496     GST_LOG_OBJECT (sq->sinkpad, "Couldn't send query because we have no peer");
1497     return FALSE;
1498   }
1501 /*
1502  * Next-non-linked functions
1503  */
1505 /* WITH LOCK TAKEN */
1506 static void
1507 wake_up_next_non_linked (GstMultiQueue * mq)
1509   GList *tmp;
1511   /* maybe no-one is waiting */
1512   if (mq->numwaiting < 1)
1513     return;
1515   /* Else figure out which singlequeue(s) need waking up */
1516   for (tmp = mq->queues; tmp; tmp = g_list_next (tmp)) {
1517     GstSingleQueue *sq = (GstSingleQueue *) tmp->data;
1519     if (sq->srcresult == GST_FLOW_NOT_LINKED) {
1520       if (sq->nextid != 0 && sq->nextid <= mq->highid) {
1521         GST_LOG_OBJECT (mq, "Waking up singlequeue %d", sq->id);
1522         g_cond_signal (sq->turn);
1523       }
1524     }
1525   }
1528 /* WITH LOCK TAKEN */
1529 static void
1530 compute_high_id (GstMultiQueue * mq)
1532   /* The high-id is either the highest id among the linked pads, or if all
1533    * pads are not-linked, it's the lowest not-linked pad */
1534   GList *tmp;
1535   guint32 lowest = G_MAXUINT32;
1536   guint32 highid = G_MAXUINT32;
1538   for (tmp = mq->queues; tmp; tmp = g_list_next (tmp)) {
1539     GstSingleQueue *sq = (GstSingleQueue *) tmp->data;
1541     GST_LOG_OBJECT (mq, "inspecting sq:%d , nextid:%d, oldid:%d, srcresult:%s",
1542         sq->id, sq->nextid, sq->oldid, gst_flow_get_name (sq->srcresult));
1544     if (sq->srcresult == GST_FLOW_NOT_LINKED) {
1545       /* No need to consider queues which are not waiting */
1546       if (sq->nextid == 0) {
1547         GST_LOG_OBJECT (mq, "sq:%d is not waiting - ignoring", sq->id);
1548         continue;
1549       }
1551       if (sq->nextid < lowest)
1552         lowest = sq->nextid;
1553     } else if (sq->srcresult != GST_FLOW_UNEXPECTED) {
1554       /* If we don't have a global highid, or the global highid is lower than
1555        * this single queue's last outputted id, store the queue's one, 
1556        * unless the singlequeue is at EOS (srcresult = UNEXPECTED) */
1557       if ((highid == G_MAXUINT32) || (sq->oldid > highid))
1558         highid = sq->oldid;
1559     }
1560   }
1562   if (highid == G_MAXUINT32 || lowest < highid)
1563     mq->highid = lowest;
1564   else
1565     mq->highid = highid;
1567   GST_LOG_OBJECT (mq, "Highid is now : %u, lowest non-linked %u", mq->highid,
1568       lowest);
1571 #define IS_FILLED(q, format, value) (((q)->max_size.format) != 0 && \
1572      ((q)->max_size.format) <= (value))
1574 /*
1575  * GstSingleQueue functions
1576  */
1577 static void
1578 single_queue_overrun_cb (GstDataQueue * dq, GstSingleQueue * sq)
1580   GstMultiQueue *mq = sq->mqueue;
1581   GList *tmp;
1582   GstDataQueueSize size;
1583   gboolean filled = FALSE;
1585   gst_data_queue_get_level (sq->queue, &size);
1587   GST_LOG_OBJECT (mq, "Single Queue %d is full", sq->id);
1589   GST_MULTI_QUEUE_MUTEX_LOCK (mq);
1590   for (tmp = mq->queues; tmp; tmp = g_list_next (tmp)) {
1591     GstSingleQueue *oq = (GstSingleQueue *) tmp->data;
1592     GstDataQueueSize ssize;
1594     GST_LOG_OBJECT (mq, "Checking Queue %d", oq->id);
1596     if (gst_data_queue_is_empty (oq->queue)) {
1597       GST_LOG_OBJECT (mq, "Queue %d is empty", oq->id);
1598       if (IS_FILLED (sq, visible, size.visible)) {
1599         sq->max_size.visible = size.visible + 1;
1600         GST_DEBUG_OBJECT (mq,
1601             "Another queue is empty, bumping single queue %d max visible to %d",
1602             sq->id, sq->max_size.visible);
1603       }
1604       GST_MULTI_QUEUE_MUTEX_UNLOCK (mq);
1605       goto beach;
1606     }
1607     /* check if we reached the hard time/bytes limits */
1608     gst_data_queue_get_level (oq->queue, &ssize);
1610     GST_DEBUG_OBJECT (mq,
1611         "queue %d: visible %u/%u, bytes %u/%u, time %" G_GUINT64_FORMAT "/%"
1612         G_GUINT64_FORMAT, oq->id, ssize.visible, oq->max_size.visible,
1613         ssize.bytes, oq->max_size.bytes, oq->cur_time, oq->max_size.time);
1615     /* if this queue is filled completely we must signal overrun.
1616      * FIXME, this seems wrong in many ways
1617      *  - we're comparing the filled level of this queue against the
1618      *    values of the other one
1619      *  - we should only do this after we found no empty queues, ie, move
1620      *    this check outside of the loop
1621      *  - the debug statement talks about a different queue than the one
1622      *    we are checking here.
1623      */
1624     if (sq->is_eos || IS_FILLED (sq, bytes, ssize.bytes) ||
1625         IS_FILLED (sq, time, sq->cur_time)) {
1626       GST_LOG_OBJECT (mq, "Queue %d is filled", oq->id);
1627       filled = TRUE;
1628     }
1629   }
1630   /* no queues were empty */
1631   GST_MULTI_QUEUE_MUTEX_UNLOCK (mq);
1633   /* Overrun is always forwarded, since this is blocking the upstream element */
1634   if (filled) {
1635     GST_DEBUG_OBJECT (mq, "A queue is filled, signalling overrun");
1636     g_signal_emit (mq, gst_multi_queue_signals[SIGNAL_OVERRUN], 0);
1637   }
1639 beach:
1640   return;
1643 static void
1644 single_queue_underrun_cb (GstDataQueue * dq, GstSingleQueue * sq)
1646   gboolean empty = TRUE;
1647   GstMultiQueue *mq = sq->mqueue;
1648   GList *tmp;
1650   GST_LOG_OBJECT (mq,
1651       "Single Queue %d is empty, Checking other single queues", sq->id);
1653   GST_MULTI_QUEUE_MUTEX_LOCK (mq);
1654   for (tmp = mq->queues; tmp; tmp = g_list_next (tmp)) {
1655     GstSingleQueue *oq = (GstSingleQueue *) tmp->data;
1657     if (gst_data_queue_is_full (oq->queue)) {
1658       GstDataQueueSize size;
1660       gst_data_queue_get_level (oq->queue, &size);
1661       if (IS_FILLED (oq, visible, size.visible)) {
1662         oq->max_size.visible = size.visible + 1;
1663         GST_DEBUG_OBJECT (mq,
1664             "queue %d is filled, bumping its max visible to %d", oq->id,
1665             oq->max_size.visible);
1666         gst_data_queue_limits_changed (oq->queue);
1667       }
1668     }
1669     if (!gst_data_queue_is_empty (oq->queue))
1670       empty = FALSE;
1671   }
1672   GST_MULTI_QUEUE_MUTEX_UNLOCK (mq);
1674   if (empty) {
1675     GST_DEBUG_OBJECT (mq, "All queues are empty, signalling it");
1676     g_signal_emit (mq, gst_multi_queue_signals[SIGNAL_UNDERRUN], 0);
1677   }
1680 static gboolean
1681 single_queue_check_full (GstDataQueue * dataq, guint visible, guint bytes,
1682     guint64 time, GstSingleQueue * sq)
1684   gboolean res;
1685   GstMultiQueue *mq = sq->mqueue;
1687   GST_DEBUG_OBJECT (mq,
1688       "queue %d: visible %u/%u, bytes %u/%u, time %" G_GUINT64_FORMAT "/%"
1689       G_GUINT64_FORMAT, sq->id, visible, sq->max_size.visible, bytes,
1690       sq->max_size.bytes, sq->cur_time, sq->max_size.time);
1692   /* we are always filled on EOS */
1693   if (sq->is_eos)
1694     return TRUE;
1696   /* we never go past the max visible items unless we are in buffering mode */
1697   if (!mq->use_buffering && IS_FILLED (sq, visible, visible))
1698     return TRUE;
1700   /* check time or bytes */
1701   res = IS_FILLED (sq, time, sq->cur_time) || IS_FILLED (sq, bytes, bytes);
1703   return res;
1706 static void
1707 gst_single_queue_free (GstSingleQueue * sq)
1709   /* DRAIN QUEUE */
1710   gst_data_queue_flush (sq->queue);
1711   g_object_unref (sq->queue);
1712   g_cond_free (sq->turn);
1713   g_free (sq);
1716 static GstSingleQueue *
1717 gst_single_queue_new (GstMultiQueue * mqueue, gint id)
1719   GstSingleQueue *sq;
1720   gchar *name;
1721   GList *tmp;
1722   gint temp_id = (id == -1) ? 0 : id;
1724   GST_MULTI_QUEUE_MUTEX_LOCK (mqueue);
1726   /* Find an unused queue ID, if possible the passed one */
1727   for (tmp = mqueue->queues; tmp; tmp = g_list_next (tmp)) {
1728     GstSingleQueue *sq2 = (GstSingleQueue *) tmp->data;
1729     /* This works because the IDs are sorted in ascending order */
1730     if (sq2->id == temp_id) {
1731       /* If this ID was requested by the caller return NULL,
1732        * otherwise just get us the next one */
1733       if (id == -1)
1734         temp_id = sq2->id + 1;
1735       else
1736         return NULL;
1737     } else if (sq2->id > temp_id) {
1738       break;
1739     }
1740   }
1742   sq = g_new0 (GstSingleQueue, 1);
1743   mqueue->nbqueues++;
1744   sq->id = temp_id;
1746   mqueue->queues = g_list_insert_before (mqueue->queues, tmp, sq);
1747   mqueue->queues_cookie++;
1749   /* copy over max_size and extra_size so we don't need to take the lock
1750    * any longer when checking if the queue is full. */
1751   sq->max_size.visible = mqueue->max_size.visible;
1752   sq->max_size.bytes = mqueue->max_size.bytes;
1753   sq->max_size.time = mqueue->max_size.time;
1755   sq->extra_size.visible = mqueue->extra_size.visible;
1756   sq->extra_size.bytes = mqueue->extra_size.bytes;
1757   sq->extra_size.time = mqueue->extra_size.time;
1759   GST_DEBUG_OBJECT (mqueue, "Creating GstSingleQueue id:%d", sq->id);
1761   sq->mqueue = mqueue;
1762   sq->srcresult = GST_FLOW_WRONG_STATE;
1763   sq->queue = gst_data_queue_new_full ((GstDataQueueCheckFullFunction)
1764       single_queue_check_full,
1765       (GstDataQueueFullCallback) single_queue_overrun_cb,
1766       (GstDataQueueEmptyCallback) single_queue_underrun_cb, sq);
1767   sq->is_eos = FALSE;
1768   sq->flushing = FALSE;
1769   gst_segment_init (&sq->sink_segment, GST_FORMAT_TIME);
1770   gst_segment_init (&sq->src_segment, GST_FORMAT_TIME);
1772   sq->nextid = 0;
1773   sq->oldid = 0;
1774   sq->turn = g_cond_new ();
1776   sq->sinktime = GST_CLOCK_TIME_NONE;
1777   sq->srctime = GST_CLOCK_TIME_NONE;
1778   sq->sink_tainted = TRUE;
1779   sq->src_tainted = TRUE;
1781   name = g_strdup_printf ("sink%d", sq->id);
1782   sq->sinkpad = gst_pad_new_from_static_template (&sinktemplate, name);
1783   g_free (name);
1785   gst_pad_set_chain_function (sq->sinkpad,
1786       GST_DEBUG_FUNCPTR (gst_multi_queue_chain));
1787   gst_pad_set_activatepush_function (sq->sinkpad,
1788       GST_DEBUG_FUNCPTR (gst_multi_queue_sink_activate_push));
1789   gst_pad_set_event_function (sq->sinkpad,
1790       GST_DEBUG_FUNCPTR (gst_multi_queue_sink_event));
1791   gst_pad_set_getcaps_function (sq->sinkpad,
1792       GST_DEBUG_FUNCPTR (gst_multi_queue_getcaps));
1793   gst_pad_set_acceptcaps_function (sq->sinkpad,
1794       GST_DEBUG_FUNCPTR (gst_multi_queue_acceptcaps));
1795   gst_pad_set_bufferalloc_function (sq->sinkpad,
1796       GST_DEBUG_FUNCPTR (gst_multi_queue_bufferalloc));
1797   gst_pad_set_iterate_internal_links_function (sq->sinkpad,
1798       GST_DEBUG_FUNCPTR (gst_multi_queue_iterate_internal_links));
1800   name = g_strdup_printf ("src%d", sq->id);
1801   sq->srcpad = gst_pad_new_from_static_template (&srctemplate, name);
1802   g_free (name);
1804   gst_pad_set_activatepush_function (sq->srcpad,
1805       GST_DEBUG_FUNCPTR (gst_multi_queue_src_activate_push));
1806   gst_pad_set_getcaps_function (sq->srcpad,
1807       GST_DEBUG_FUNCPTR (gst_multi_queue_getcaps));
1808   gst_pad_set_acceptcaps_function (sq->srcpad,
1809       GST_DEBUG_FUNCPTR (gst_multi_queue_acceptcaps));
1810   gst_pad_set_event_function (sq->srcpad,
1811       GST_DEBUG_FUNCPTR (gst_multi_queue_src_event));
1812   gst_pad_set_query_function (sq->srcpad,
1813       GST_DEBUG_FUNCPTR (gst_multi_queue_src_query));
1814   gst_pad_set_iterate_internal_links_function (sq->srcpad,
1815       GST_DEBUG_FUNCPTR (gst_multi_queue_iterate_internal_links));
1817   gst_pad_set_element_private (sq->sinkpad, (gpointer) sq);
1818   gst_pad_set_element_private (sq->srcpad, (gpointer) sq);
1820   GST_MULTI_QUEUE_MUTEX_UNLOCK (mqueue);
1822   /* only activate the pads when we are not in the NULL state
1823    * and add the pad under the state_lock to prevend state changes
1824    * between activating and adding */
1825   g_static_rec_mutex_lock (GST_STATE_GET_LOCK (mqueue));
1826   if (GST_STATE_TARGET (mqueue) != GST_STATE_NULL) {
1827     gst_pad_set_active (sq->srcpad, TRUE);
1828     gst_pad_set_active (sq->sinkpad, TRUE);
1829   }
1830   gst_element_add_pad (GST_ELEMENT (mqueue), sq->srcpad);
1831   gst_element_add_pad (GST_ELEMENT (mqueue), sq->sinkpad);
1832   g_static_rec_mutex_unlock (GST_STATE_GET_LOCK (mqueue));
1834   GST_DEBUG_OBJECT (mqueue, "GstSingleQueue [%d] created and pads added",
1835       sq->id);
1837   return sq;