queue2: fix refactoring of draining-on-eos, munge flow return to FLOW_OK
[glsdk/gstreamer0-10.git] / plugins / elements / gstqueue2.c
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2003 Colin Walters <cwalters@gnome.org>
4  *                    2000,2005,2007 Wim Taymans <wim.taymans@gmail.com>
5  *                    2007 Thiago Sousa Santos <thiagoss@lcc.ufcg.edu.br>
6  *                 SA 2010 ST-Ericsson <benjamin.gaignard@stericsson.com>
7  *
8  * gstqueue2.c:
9  *
10  * This library is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Library General Public
12  * License as published by the Free Software Foundation; either
13  * version 2 of the License, or (at your option) any later version.
14  *
15  * This library is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * Library General Public License for more details.
19  *
20  * You should have received a copy of the GNU Library General Public
21  * License along with this library; if not, write to the
22  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23  * Boston, MA 02111-1307, USA.
24  */
26 /**
27  * SECTION:element-queue2
28  *
29  * Data is queued until one of the limits specified by the
30  * #GstQueue2:max-size-buffers, #GstQueue2:max-size-bytes and/or
31  * #GstQueue2:max-size-time properties has been reached. Any attempt to push
32  * more buffers into the queue will block the pushing thread until more space
33  * becomes available.
34  *
35  * The queue will create a new thread on the source pad to decouple the
36  * processing on sink and source pad.
37  *
38  * You can query how many buffers are queued by reading the
39  * #GstQueue2:current-level-buffers property.
40  *
41  * The default queue size limits are 100 buffers, 2MB of data, or
42  * two seconds worth of data, whichever is reached first.
43  *
44  * If you set temp-tmpl to a value such as /tmp/gstreamer-XXXXXX, the element
45  * will allocate a random free filename and buffer data in the file.
46  * By using this, it will buffer the entire stream data on the file independently
47  * of the queue size limits, they will only be used for buffering statistics.
48  *
49  * Since 0.10.24, setting the temp-location property with a filename is deprecated
50  * because it's impossible to securely open a temporary file in this way. The
51  * property will still be used to notify the application of the allocated
52  * filename, though.
53  *
54  * Last reviewed on 2009-07-10 (0.10.24)
55  */
57 #ifdef HAVE_CONFIG_H
58 #include "config.h"
59 #endif
61 #include "gstqueue2.h"
63 #include <glib/gstdio.h>
65 #include "gst/gst-i18n-lib.h"
67 #include <string.h>
69 #ifdef G_OS_WIN32
70 #include <io.h>                 /* lseek, open, close, read */
71 #undef lseek
72 #define lseek _lseeki64
73 #undef off_t
74 #define off_t guint64
75 #else
76 #include <unistd.h>
77 #endif
79 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
80     GST_PAD_SINK,
81     GST_PAD_ALWAYS,
82     GST_STATIC_CAPS_ANY);
84 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
85     GST_PAD_SRC,
86     GST_PAD_ALWAYS,
87     GST_STATIC_CAPS_ANY);
89 GST_DEBUG_CATEGORY_STATIC (queue_debug);
90 #define GST_CAT_DEFAULT (queue_debug)
91 GST_DEBUG_CATEGORY_STATIC (queue_dataflow);
93 enum
94 {
95   LAST_SIGNAL
96 };
98 /* other defines */
99 #define DEFAULT_BUFFER_SIZE 4096
100 #define QUEUE_IS_USING_TEMP_FILE(queue) ((queue)->temp_location_set || (queue)->temp_template != NULL)
101 #define QUEUE_IS_USING_RING_BUFFER(queue) ((queue)->ring_buffer_max_size != 0)  /* for consistency with the above macro */
102 #define QUEUE_IS_USING_QUEUE(queue) (!QUEUE_IS_USING_TEMP_FILE(queue) && !QUEUE_IS_USING_RING_BUFFER (queue))
104 #define QUEUE_MAX_BYTES(queue) MIN((queue)->max_level.bytes, (queue)->ring_buffer_max_size)
106 /* default property values */
107 #define DEFAULT_MAX_SIZE_BUFFERS   100  /* 100 buffers */
108 #define DEFAULT_MAX_SIZE_BYTES     (2 * 1024 * 1024)    /* 2 MB */
109 #define DEFAULT_MAX_SIZE_TIME      2 * GST_SECOND       /* 2 seconds */
110 #define DEFAULT_USE_BUFFERING      FALSE
111 #define DEFAULT_USE_RATE_ESTIMATE  TRUE
112 #define DEFAULT_LOW_PERCENT        10
113 #define DEFAULT_HIGH_PERCENT       99
114 #define DEFAULT_TEMP_REMOVE        TRUE
115 #define DEFAULT_RING_BUFFER_MAX_SIZE 0
117 enum
119   PROP_0,
120   PROP_CUR_LEVEL_BUFFERS,
121   PROP_CUR_LEVEL_BYTES,
122   PROP_CUR_LEVEL_TIME,
123   PROP_MAX_SIZE_BUFFERS,
124   PROP_MAX_SIZE_BYTES,
125   PROP_MAX_SIZE_TIME,
126   PROP_USE_BUFFERING,
127   PROP_USE_RATE_ESTIMATE,
128   PROP_LOW_PERCENT,
129   PROP_HIGH_PERCENT,
130   PROP_TEMP_TEMPLATE,
131   PROP_TEMP_LOCATION,
132   PROP_TEMP_REMOVE,
133   PROP_RING_BUFFER_MAX_SIZE,
134   PROP_LAST
135 };
137 #define GST_QUEUE2_CLEAR_LEVEL(l) G_STMT_START {         \
138   l.buffers = 0;                                        \
139   l.bytes = 0;                                          \
140   l.time = 0;                                           \
141   l.rate_time = 0;                                      \
142 } G_STMT_END
144 #define STATUS(queue, pad, msg) \
145   GST_CAT_LOG_OBJECT (queue_dataflow, queue, \
146                       "(%s:%s) " msg ": %u of %u buffers, %u of %u " \
147                       "bytes, %" G_GUINT64_FORMAT " of %" G_GUINT64_FORMAT \
148                       " ns, %"G_GUINT64_FORMAT" items", \
149                       GST_DEBUG_PAD_NAME (pad), \
150                       queue->cur_level.buffers, \
151                       queue->max_level.buffers, \
152                       queue->cur_level.bytes, \
153                       queue->max_level.bytes, \
154                       queue->cur_level.time, \
155                       queue->max_level.time, \
156                       (guint64) (!QUEUE_IS_USING_QUEUE(queue) ? \
157                         queue->current->writing_pos - queue->current->max_reading_pos : \
158                         queue->queue.length))
160 #define GST_QUEUE2_MUTEX_LOCK(q) G_STMT_START {                          \
161   g_mutex_lock (q->qlock);                                              \
162 } G_STMT_END
164 #define GST_QUEUE2_MUTEX_LOCK_CHECK(q,res,label) G_STMT_START {         \
165   GST_QUEUE2_MUTEX_LOCK (q);                                            \
166   if (res != GST_FLOW_OK)                                               \
167     goto label;                                                         \
168 } G_STMT_END
170 #define GST_QUEUE2_MUTEX_UNLOCK(q) G_STMT_START {                        \
171   g_mutex_unlock (q->qlock);                                            \
172 } G_STMT_END
174 #define GST_QUEUE2_WAIT_DEL_CHECK(q, res, label) G_STMT_START {         \
175   STATUS (queue, q->sinkpad, "wait for DEL");                           \
176   q->waiting_del = TRUE;                                                \
177   g_cond_wait (q->item_del, queue->qlock);                              \
178   q->waiting_del = FALSE;                                               \
179   if (res != GST_FLOW_OK) {                                             \
180     STATUS (queue, q->srcpad, "received DEL wakeup");                   \
181     goto label;                                                         \
182   }                                                                     \
183   STATUS (queue, q->sinkpad, "received DEL");                           \
184 } G_STMT_END
186 #define GST_QUEUE2_WAIT_ADD_CHECK(q, res, label) G_STMT_START {         \
187   STATUS (queue, q->srcpad, "wait for ADD");                            \
188   q->waiting_add = TRUE;                                                \
189   g_cond_wait (q->item_add, q->qlock);                                  \
190   q->waiting_add = FALSE;                                               \
191   if (res != GST_FLOW_OK) {                                             \
192     STATUS (queue, q->srcpad, "received ADD wakeup");                   \
193     goto label;                                                         \
194   }                                                                     \
195   STATUS (queue, q->srcpad, "received ADD");                            \
196 } G_STMT_END
198 #define GST_QUEUE2_SIGNAL_DEL(q) G_STMT_START {                          \
199   if (q->waiting_del) {                                                 \
200     STATUS (q, q->srcpad, "signal DEL");                                \
201     g_cond_signal (q->item_del);                                        \
202   }                                                                     \
203 } G_STMT_END
205 #define GST_QUEUE2_SIGNAL_ADD(q) G_STMT_START {                          \
206   if (q->waiting_add) {                                                 \
207     STATUS (q, q->sinkpad, "signal ADD");                               \
208     g_cond_signal (q->item_add);                                        \
209   }                                                                     \
210 } G_STMT_END
212 #define _do_init(bla) \
213     GST_DEBUG_CATEGORY_INIT (queue_debug, "queue2", 0, "queue element"); \
214     GST_DEBUG_CATEGORY_INIT (queue_dataflow, "queue2_dataflow", 0, \
215         "dataflow inside the queue element");
217 GST_BOILERPLATE_FULL (GstQueue2, gst_queue2, GstElement, GST_TYPE_ELEMENT,
218     _do_init);
220 static void gst_queue2_finalize (GObject * object);
222 static void gst_queue2_set_property (GObject * object,
223     guint prop_id, const GValue * value, GParamSpec * pspec);
224 static void gst_queue2_get_property (GObject * object,
225     guint prop_id, GValue * value, GParamSpec * pspec);
227 static GstFlowReturn gst_queue2_chain (GstPad * pad, GstBuffer * buffer);
228 static GstFlowReturn gst_queue2_chain_list (GstPad * pad,
229     GstBufferList * buffer_list);
230 static GstFlowReturn gst_queue2_bufferalloc (GstPad * pad, guint64 offset,
231     guint size, GstCaps * caps, GstBuffer ** buf);
232 static GstFlowReturn gst_queue2_push_one (GstQueue2 * queue);
233 static void gst_queue2_loop (GstPad * pad);
235 static gboolean gst_queue2_handle_sink_event (GstPad * pad, GstEvent * event);
237 static gboolean gst_queue2_handle_src_event (GstPad * pad, GstEvent * event);
238 static gboolean gst_queue2_handle_src_query (GstPad * pad, GstQuery * query);
239 static gboolean gst_queue2_handle_query (GstElement * element,
240     GstQuery * query);
242 static GstCaps *gst_queue2_getcaps (GstPad * pad);
243 static gboolean gst_queue2_acceptcaps (GstPad * pad, GstCaps * caps);
245 static GstFlowReturn gst_queue2_get_range (GstPad * pad, guint64 offset,
246     guint length, GstBuffer ** buffer);
247 static gboolean gst_queue2_src_checkgetrange_function (GstPad * pad);
249 static gboolean gst_queue2_src_activate_pull (GstPad * pad, gboolean active);
250 static gboolean gst_queue2_src_activate_push (GstPad * pad, gboolean active);
251 static gboolean gst_queue2_sink_activate_push (GstPad * pad, gboolean active);
252 static GstStateChangeReturn gst_queue2_change_state (GstElement * element,
253     GstStateChange transition);
255 static gboolean gst_queue2_is_empty (GstQueue2 * queue);
256 static gboolean gst_queue2_is_filled (GstQueue2 * queue);
258 static void update_cur_level (GstQueue2 * queue, GstQueue2Range * range);
260 typedef enum
262   GST_QUEUE2_ITEM_TYPE_UNKNOWN = 0,
263   GST_QUEUE2_ITEM_TYPE_BUFFER,
264   GST_QUEUE2_ITEM_TYPE_BUFFER_LIST,
265   GST_QUEUE2_ITEM_TYPE_EVENT
266 } GstQueue2ItemType;
268 /* static guint gst_queue2_signals[LAST_SIGNAL] = { 0 }; */
270 static void
271 gst_queue2_base_init (gpointer g_class)
273   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
275   gst_element_class_add_pad_template (gstelement_class,
276       gst_static_pad_template_get (&srctemplate));
277   gst_element_class_add_pad_template (gstelement_class,
278       gst_static_pad_template_get (&sinktemplate));
280   gst_element_class_set_details_simple (gstelement_class, "Queue 2",
281       "Generic",
282       "Simple data queue",
283       "Erik Walthinsen <omega@cse.ogi.edu>, "
284       "Wim Taymans <wim.taymans@gmail.com>");
287 static void
288 gst_queue2_class_init (GstQueue2Class * klass)
290   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
291   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
293   gobject_class->set_property = gst_queue2_set_property;
294   gobject_class->get_property = gst_queue2_get_property;
296   /* properties */
297   g_object_class_install_property (gobject_class, PROP_CUR_LEVEL_BYTES,
298       g_param_spec_uint ("current-level-bytes", "Current level (kB)",
299           "Current amount of data in the queue (bytes)",
300           0, G_MAXUINT, 0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
301   g_object_class_install_property (gobject_class, PROP_CUR_LEVEL_BUFFERS,
302       g_param_spec_uint ("current-level-buffers", "Current level (buffers)",
303           "Current number of buffers in the queue",
304           0, G_MAXUINT, 0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
305   g_object_class_install_property (gobject_class, PROP_CUR_LEVEL_TIME,
306       g_param_spec_uint64 ("current-level-time", "Current level (ns)",
307           "Current amount of data in the queue (in ns)",
308           0, G_MAXUINT64, 0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
310   g_object_class_install_property (gobject_class, PROP_MAX_SIZE_BYTES,
311       g_param_spec_uint ("max-size-bytes", "Max. size (kB)",
312           "Max. amount of data in the queue (bytes, 0=disable)",
313           0, G_MAXUINT, DEFAULT_MAX_SIZE_BYTES,
314           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
315   g_object_class_install_property (gobject_class, PROP_MAX_SIZE_BUFFERS,
316       g_param_spec_uint ("max-size-buffers", "Max. size (buffers)",
317           "Max. number of buffers in the queue (0=disable)", 0, G_MAXUINT,
318           DEFAULT_MAX_SIZE_BUFFERS,
319           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
320   g_object_class_install_property (gobject_class, PROP_MAX_SIZE_TIME,
321       g_param_spec_uint64 ("max-size-time", "Max. size (ns)",
322           "Max. amount of data in the queue (in ns, 0=disable)", 0, G_MAXUINT64,
323           DEFAULT_MAX_SIZE_TIME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
325   g_object_class_install_property (gobject_class, PROP_USE_BUFFERING,
326       g_param_spec_boolean ("use-buffering", "Use buffering",
327           "Emit GST_MESSAGE_BUFFERING based on low-/high-percent thresholds",
328           DEFAULT_USE_BUFFERING, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
329   g_object_class_install_property (gobject_class, PROP_USE_RATE_ESTIMATE,
330       g_param_spec_boolean ("use-rate-estimate", "Use Rate Estimate",
331           "Estimate the bitrate of the stream to calculate time level",
332           DEFAULT_USE_RATE_ESTIMATE,
333           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
334   g_object_class_install_property (gobject_class, PROP_LOW_PERCENT,
335       g_param_spec_int ("low-percent", "Low percent",
336           "Low threshold for buffering to start. Only used if use-buffering is True",
337           0, 100, DEFAULT_LOW_PERCENT,
338           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
339   g_object_class_install_property (gobject_class, PROP_HIGH_PERCENT,
340       g_param_spec_int ("high-percent", "High percent",
341           "High threshold for buffering to finish. Only used if use-buffering is True",
342           0, 100, DEFAULT_HIGH_PERCENT,
343           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
345   g_object_class_install_property (gobject_class, PROP_TEMP_TEMPLATE,
346       g_param_spec_string ("temp-template", "Temporary File Template",
347           "File template to store temporary files in, should contain directory "
348           "and XXXXXX. (NULL == disabled)",
349           NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
351   g_object_class_install_property (gobject_class, PROP_TEMP_LOCATION,
352       g_param_spec_string ("temp-location", "Temporary File Location",
353           "Location to store temporary files in (Deprecated: Only read this "
354           "property, use temp-template to configure the name template)",
355           NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
357   /**
358    * GstQueue2:temp-remove
359    *
360    * When temp-template is set, remove the temporary file when going to READY.
361    *
362    * Since: 0.10.26
363    */
364   g_object_class_install_property (gobject_class, PROP_TEMP_REMOVE,
365       g_param_spec_boolean ("temp-remove", "Remove the Temporary File",
366           "Remove the temp-location after use",
367           DEFAULT_TEMP_REMOVE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
369   /**
370    * GstQueue2:ring-buffer-max-size
371    *
372    * The maximum size of the ring buffer in bytes. If set to 0, the ring
373    * buffer is disabled. Default 0.
374    *
375    * Since: 0.10.31
376    */
377   g_object_class_install_property (gobject_class, PROP_RING_BUFFER_MAX_SIZE,
378       g_param_spec_uint64 ("ring-buffer-max-size",
379           "Max. ring buffer size (bytes)",
380           "Max. amount of data in the ring buffer (bytes, 0 = disabled)",
381           0, G_MAXUINT64, DEFAULT_RING_BUFFER_MAX_SIZE,
382           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
384   /* set several parent class virtual functions */
385   gobject_class->finalize = gst_queue2_finalize;
387   gstelement_class->change_state = GST_DEBUG_FUNCPTR (gst_queue2_change_state);
388   gstelement_class->query = GST_DEBUG_FUNCPTR (gst_queue2_handle_query);
391 static void
392 gst_queue2_init (GstQueue2 * queue, GstQueue2Class * g_class)
394   queue->sinkpad = gst_pad_new_from_static_template (&sinktemplate, "sink");
396   gst_pad_set_chain_function (queue->sinkpad,
397       GST_DEBUG_FUNCPTR (gst_queue2_chain));
398   gst_pad_set_chain_list_function (queue->sinkpad,
399       GST_DEBUG_FUNCPTR (gst_queue2_chain_list));
400   gst_pad_set_activatepush_function (queue->sinkpad,
401       GST_DEBUG_FUNCPTR (gst_queue2_sink_activate_push));
402   gst_pad_set_event_function (queue->sinkpad,
403       GST_DEBUG_FUNCPTR (gst_queue2_handle_sink_event));
404   gst_pad_set_getcaps_function (queue->sinkpad,
405       GST_DEBUG_FUNCPTR (gst_queue2_getcaps));
406   gst_pad_set_acceptcaps_function (queue->sinkpad,
407       GST_DEBUG_FUNCPTR (gst_queue2_acceptcaps));
408   gst_pad_set_bufferalloc_function (queue->sinkpad,
409       GST_DEBUG_FUNCPTR (gst_queue2_bufferalloc));
410   gst_element_add_pad (GST_ELEMENT (queue), queue->sinkpad);
412   queue->srcpad = gst_pad_new_from_static_template (&srctemplate, "src");
414   gst_pad_set_activatepull_function (queue->srcpad,
415       GST_DEBUG_FUNCPTR (gst_queue2_src_activate_pull));
416   gst_pad_set_activatepush_function (queue->srcpad,
417       GST_DEBUG_FUNCPTR (gst_queue2_src_activate_push));
418   gst_pad_set_getrange_function (queue->srcpad,
419       GST_DEBUG_FUNCPTR (gst_queue2_get_range));
420   gst_pad_set_checkgetrange_function (queue->srcpad,
421       GST_DEBUG_FUNCPTR (gst_queue2_src_checkgetrange_function));
422   gst_pad_set_getcaps_function (queue->srcpad,
423       GST_DEBUG_FUNCPTR (gst_queue2_getcaps));
424   gst_pad_set_acceptcaps_function (queue->srcpad,
425       GST_DEBUG_FUNCPTR (gst_queue2_acceptcaps));
426   gst_pad_set_event_function (queue->srcpad,
427       GST_DEBUG_FUNCPTR (gst_queue2_handle_src_event));
428   gst_pad_set_query_function (queue->srcpad,
429       GST_DEBUG_FUNCPTR (gst_queue2_handle_src_query));
430   gst_element_add_pad (GST_ELEMENT (queue), queue->srcpad);
432   /* levels */
433   GST_QUEUE2_CLEAR_LEVEL (queue->cur_level);
434   queue->max_level.buffers = DEFAULT_MAX_SIZE_BUFFERS;
435   queue->max_level.bytes = DEFAULT_MAX_SIZE_BYTES;
436   queue->max_level.time = DEFAULT_MAX_SIZE_TIME;
437   queue->max_level.rate_time = DEFAULT_MAX_SIZE_TIME;
438   queue->use_buffering = DEFAULT_USE_BUFFERING;
439   queue->use_rate_estimate = DEFAULT_USE_RATE_ESTIMATE;
440   queue->low_percent = DEFAULT_LOW_PERCENT;
441   queue->high_percent = DEFAULT_HIGH_PERCENT;
443   gst_segment_init (&queue->sink_segment, GST_FORMAT_TIME);
444   gst_segment_init (&queue->src_segment, GST_FORMAT_TIME);
446   queue->sinktime = GST_CLOCK_TIME_NONE;
447   queue->srctime = GST_CLOCK_TIME_NONE;
448   queue->sink_tainted = TRUE;
449   queue->src_tainted = TRUE;
451   queue->srcresult = GST_FLOW_WRONG_STATE;
452   queue->sinkresult = GST_FLOW_WRONG_STATE;
453   queue->is_eos = FALSE;
454   queue->in_timer = g_timer_new ();
455   queue->out_timer = g_timer_new ();
457   queue->qlock = g_mutex_new ();
458   queue->waiting_add = FALSE;
459   queue->item_add = g_cond_new ();
460   queue->waiting_del = FALSE;
461   queue->item_del = g_cond_new ();
462   g_queue_init (&queue->queue);
464   queue->buffering_percent = 100;
466   /* tempfile related */
467   queue->temp_template = NULL;
468   queue->temp_location = NULL;
469   queue->temp_location_set = FALSE;
470   queue->temp_remove = DEFAULT_TEMP_REMOVE;
472   queue->ring_buffer = NULL;
473   queue->ring_buffer_max_size = DEFAULT_RING_BUFFER_MAX_SIZE;
475   GST_DEBUG_OBJECT (queue,
476       "initialized queue's not_empty & not_full conditions");
479 /* called only once, as opposed to dispose */
480 static void
481 gst_queue2_finalize (GObject * object)
483   GstQueue2 *queue = GST_QUEUE2 (object);
485   GST_DEBUG_OBJECT (queue, "finalizing queue");
487   while (!g_queue_is_empty (&queue->queue)) {
488     GstMiniObject *data = g_queue_pop_head (&queue->queue);
490     gst_mini_object_unref (data);
491   }
493   g_queue_clear (&queue->queue);
494   g_mutex_free (queue->qlock);
495   g_cond_free (queue->item_add);
496   g_cond_free (queue->item_del);
497   g_timer_destroy (queue->in_timer);
498   g_timer_destroy (queue->out_timer);
500   /* temp_file path cleanup  */
501   g_free (queue->temp_template);
502   g_free (queue->temp_location);
504   G_OBJECT_CLASS (parent_class)->finalize (object);
507 static void
508 debug_ranges (GstQueue2 * queue)
510   GstQueue2Range *walk;
512   for (walk = queue->ranges; walk; walk = walk->next) {
513     GST_DEBUG_OBJECT (queue,
514         "range [%" G_GUINT64_FORMAT "-%" G_GUINT64_FORMAT "] (rb [%"
515         G_GUINT64_FORMAT "-%" G_GUINT64_FORMAT "]), reading %" G_GUINT64_FORMAT
516         " current range? %s", walk->offset, walk->writing_pos, walk->rb_offset,
517         walk->rb_writing_pos, walk->reading_pos,
518         walk == queue->current ? "**y**" : "  n  ");
519   }
522 /* clear all the downloaded ranges */
523 static void
524 clean_ranges (GstQueue2 * queue)
526   GST_DEBUG_OBJECT (queue, "clean queue ranges");
528   g_slice_free_chain (GstQueue2Range, queue->ranges, next);
529   queue->ranges = NULL;
530   queue->current = NULL;
533 /* find a range that contains @offset or NULL when nothing does */
534 static GstQueue2Range *
535 find_range (GstQueue2 * queue, guint64 offset)
537   GstQueue2Range *range = NULL;
538   GstQueue2Range *walk;
540   /* first do a quick check for the current range */
541   for (walk = queue->ranges; walk; walk = walk->next) {
542     if (offset >= walk->offset && offset <= walk->writing_pos) {
543       /* we can reuse an existing range */
544       range = walk;
545       break;
546     }
547   }
548   if (range) {
549     GST_DEBUG_OBJECT (queue,
550         "found range for %" G_GUINT64_FORMAT ": [%" G_GUINT64_FORMAT "-%"
551         G_GUINT64_FORMAT "]", offset, range->offset, range->writing_pos);
552   } else {
553     GST_DEBUG_OBJECT (queue, "no range for %" G_GUINT64_FORMAT, offset);
554   }
555   return range;
558 static void
559 update_cur_level (GstQueue2 * queue, GstQueue2Range * range)
561   guint64 max_reading_pos, writing_pos;
563   writing_pos = range->writing_pos;
564   max_reading_pos = range->max_reading_pos;
566   if (writing_pos > max_reading_pos)
567     queue->cur_level.bytes = writing_pos - max_reading_pos;
568   else
569     queue->cur_level.bytes = 0;
572 /* make a new range for @offset or reuse an existing range */
573 static GstQueue2Range *
574 add_range (GstQueue2 * queue, guint64 offset)
576   GstQueue2Range *range, *prev, *next;
578   GST_DEBUG_OBJECT (queue, "find range for %" G_GUINT64_FORMAT, offset);
580   if ((range = find_range (queue, offset))) {
581     GST_DEBUG_OBJECT (queue,
582         "reusing range %" G_GUINT64_FORMAT "-%" G_GUINT64_FORMAT, range->offset,
583         range->writing_pos);
584     range->writing_pos = offset;
585   } else {
586     GST_DEBUG_OBJECT (queue,
587         "new range %" G_GUINT64_FORMAT "-%" G_GUINT64_FORMAT, offset, offset);
589     range = g_slice_new0 (GstQueue2Range);
590     range->offset = offset;
591     /* we want to write to the next location in the ring buffer */
592     range->rb_offset = queue->current ? queue->current->rb_writing_pos : 0;
593     range->writing_pos = offset;
594     range->rb_writing_pos = range->rb_offset;
595     range->reading_pos = offset;
596     range->max_reading_pos = offset;
598     /* insert sorted */
599     prev = NULL;
600     next = queue->ranges;
601     while (next) {
602       if (next->offset > offset) {
603         /* insert before next */
604         GST_DEBUG_OBJECT (queue,
605             "insert before range %p, offset %" G_GUINT64_FORMAT, next,
606             next->offset);
607         break;
608       }
609       /* try next */
610       prev = next;
611       next = next->next;
612     }
613     range->next = next;
614     if (prev)
615       prev->next = range;
616     else
617       queue->ranges = range;
618   }
619   debug_ranges (queue);
621   /* update the stats for this range */
622   update_cur_level (queue, range);
624   return range;
628 /* clear and init the download ranges for offset 0 */
629 static void
630 init_ranges (GstQueue2 * queue)
632   GST_DEBUG_OBJECT (queue, "init queue ranges");
634   /* get rid of all the current ranges */
635   clean_ranges (queue);
636   /* make a range for offset 0 */
637   queue->current = add_range (queue, 0);
640 static gboolean
641 gst_queue2_acceptcaps (GstPad * pad, GstCaps * caps)
643   GstQueue2 *queue;
644   GstPad *otherpad;
645   gboolean result;
647   queue = GST_QUEUE2 (GST_PAD_PARENT (pad));
649   otherpad = (pad == queue->srcpad ? queue->sinkpad : queue->srcpad);
650   result = gst_pad_peer_accept_caps (otherpad, caps);
652   return result;
655 static GstCaps *
656 gst_queue2_getcaps (GstPad * pad)
658   GstQueue2 *queue;
659   GstPad *otherpad;
660   GstCaps *result;
662   queue = GST_QUEUE2 (gst_pad_get_parent (pad));
663   if (G_UNLIKELY (queue == NULL))
664     return gst_caps_new_any ();
666   otherpad = (pad == queue->srcpad ? queue->sinkpad : queue->srcpad);
667   result = gst_pad_peer_get_caps (otherpad);
668   if (result == NULL)
669     result = gst_caps_new_any ();
671   gst_object_unref (queue);
673   return result;
676 static GstFlowReturn
677 gst_queue2_bufferalloc (GstPad * pad, guint64 offset, guint size,
678     GstCaps * caps, GstBuffer ** buf)
680   GstQueue2 *queue;
681   GstFlowReturn result;
683   queue = GST_QUEUE2 (GST_PAD_PARENT (pad));
685   /* Forward to src pad, without setting caps on the src pad */
686   result = gst_pad_alloc_buffer (queue->srcpad, offset, size, caps, buf);
688   return result;
691 /* calculate the diff between running time on the sink and src of the queue.
692  * This is the total amount of time in the queue. */
693 static void
694 update_time_level (GstQueue2 * queue)
696   if (queue->sink_tainted) {
697     queue->sinktime =
698         gst_segment_to_running_time (&queue->sink_segment, GST_FORMAT_TIME,
699         queue->sink_segment.last_stop);
700     queue->sink_tainted = FALSE;
701   }
703   if (queue->src_tainted) {
704     queue->srctime =
705         gst_segment_to_running_time (&queue->src_segment, GST_FORMAT_TIME,
706         queue->src_segment.last_stop);
707     queue->src_tainted = FALSE;
708   }
710   GST_DEBUG_OBJECT (queue, "sink %" GST_TIME_FORMAT ", src %" GST_TIME_FORMAT,
711       GST_TIME_ARGS (queue->sinktime), GST_TIME_ARGS (queue->srctime));
713   if (queue->sinktime != GST_CLOCK_TIME_NONE
714       && queue->srctime != GST_CLOCK_TIME_NONE
715       && queue->sinktime >= queue->srctime)
716     queue->cur_level.time = queue->sinktime - queue->srctime;
717   else
718     queue->cur_level.time = 0;
721 /* take a NEWSEGMENT event and apply the values to segment, updating the time
722  * level of queue. */
723 static void
724 apply_segment (GstQueue2 * queue, GstEvent * event, GstSegment * segment,
725     gboolean is_sink)
727   gboolean update;
728   GstFormat format;
729   gdouble rate, arate;
730   gint64 start, stop, time;
732   gst_event_parse_new_segment_full (event, &update, &rate, &arate,
733       &format, &start, &stop, &time);
735   GST_DEBUG_OBJECT (queue,
736       "received NEWSEGMENT update %d, rate %lf, applied rate %lf, "
737       "format %d, "
738       "%" G_GINT64_FORMAT " -- %" G_GINT64_FORMAT ", time %"
739       G_GINT64_FORMAT, update, rate, arate, format, start, stop, time);
741   if (format == GST_FORMAT_BYTES) {
742     if (QUEUE_IS_USING_TEMP_FILE (queue)) {
743       /* start is where we'll be getting from and as such writing next */
744       queue->current = add_range (queue, start);
745       /* update the stats for this range */
746       update_cur_level (queue, queue->current);
747     }
748   }
750   /* now configure the values, we use these to track timestamps on the
751    * sinkpad. */
752   if (format != GST_FORMAT_TIME) {
753     /* non-time format, pretent the current time segment is closed with a
754      * 0 start and unknown stop time. */
755     update = FALSE;
756     format = GST_FORMAT_TIME;
757     start = 0;
758     stop = -1;
759     time = 0;
760   }
761   gst_segment_set_newsegment_full (segment, update,
762       rate, arate, format, start, stop, time);
764   GST_DEBUG_OBJECT (queue,
765       "configured NEWSEGMENT %" GST_SEGMENT_FORMAT, segment);
767   if (is_sink)
768     queue->sink_tainted = TRUE;
769   else
770     queue->src_tainted = TRUE;
772   /* segment can update the time level of the queue */
773   update_time_level (queue);
776 /* take a buffer and update segment, updating the time level of the queue. */
777 static void
778 apply_buffer (GstQueue2 * queue, GstBuffer * buffer, GstSegment * segment,
779     gboolean is_sink)
781   GstClockTime duration, timestamp;
783   timestamp = GST_BUFFER_TIMESTAMP (buffer);
784   duration = GST_BUFFER_DURATION (buffer);
786   /* if no timestamp is set, assume it's continuous with the previous
787    * time */
788   if (timestamp == GST_CLOCK_TIME_NONE)
789     timestamp = segment->last_stop;
791   /* add duration */
792   if (duration != GST_CLOCK_TIME_NONE)
793     timestamp += duration;
795   GST_DEBUG_OBJECT (queue, "last_stop updated to %" GST_TIME_FORMAT,
796       GST_TIME_ARGS (timestamp));
798   gst_segment_set_last_stop (segment, GST_FORMAT_TIME, timestamp);
800   if (is_sink)
801     queue->sink_tainted = TRUE;
802   else
803     queue->src_tainted = TRUE;
805   /* calc diff with other end */
806   update_time_level (queue);
809 static GstBufferListItem
810 buffer_list_apply_time (GstBuffer ** buf, guint group, guint idx, gpointer data)
812   GstClockTime *timestamp = data;
814   GST_TRACE ("buffer %u in group %u has ts %" GST_TIME_FORMAT
815       " duration %" GST_TIME_FORMAT, idx, group,
816       GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (*buf)),
817       GST_TIME_ARGS (GST_BUFFER_DURATION (*buf)));
819   if (GST_BUFFER_TIMESTAMP_IS_VALID (*buf))
820     *timestamp = GST_BUFFER_TIMESTAMP (*buf);
822   if (GST_BUFFER_DURATION_IS_VALID (*buf))
823     *timestamp += GST_BUFFER_DURATION (*buf);
825   GST_TRACE ("ts now %" GST_TIME_FORMAT, GST_TIME_ARGS (*timestamp));
826   return GST_BUFFER_LIST_CONTINUE;
829 /* take a buffer list and update segment, updating the time level of the queue */
830 static void
831 apply_buffer_list (GstQueue2 * queue, GstBufferList * buffer_list,
832     GstSegment * segment, gboolean is_sink)
834   GstClockTime timestamp;
836   /* if no timestamp is set, assume it's continuous with the previous time */
837   timestamp = segment->last_stop;
839   gst_buffer_list_foreach (buffer_list, buffer_list_apply_time, &timestamp);
841   GST_DEBUG_OBJECT (queue, "last_stop updated to %" GST_TIME_FORMAT,
842       GST_TIME_ARGS (timestamp));
844   gst_segment_set_last_stop (segment, GST_FORMAT_TIME, timestamp);
846   if (is_sink)
847     queue->sink_tainted = TRUE;
848   else
849     queue->src_tainted = TRUE;
851   /* calc diff with other end */
852   update_time_level (queue);
855 static void
856 update_buffering (GstQueue2 * queue)
858   gint64 percent;
859   gboolean post = FALSE;
861   if (queue->high_percent <= 0)
862     return;
864 #define GET_PERCENT(format,alt_max) ((queue->max_level.format) > 0 ? (queue->cur_level.format) * 100 / ((alt_max) > 0 ? MIN ((alt_max), (queue->max_level.format)) : (queue->max_level.format)) : 0)
866   if (queue->is_eos) {
867     /* on EOS we are always 100% full, we set the var here so that it we can
868      * reuse the logic below to stop buffering */
869     percent = 100;
870     GST_LOG_OBJECT (queue, "we are EOS");
871   } else {
872     /* figure out the percent we are filled, we take the max of all formats. */
874     if (!QUEUE_IS_USING_RING_BUFFER (queue)) {
875       percent = GET_PERCENT (bytes, 0);
876     } else {
877       guint64 rb_size = queue->ring_buffer_max_size;
878       percent = GET_PERCENT (bytes, rb_size);
879     }
880     percent = MAX (percent, GET_PERCENT (time, 0));
881     percent = MAX (percent, GET_PERCENT (buffers, 0));
883     /* also apply the rate estimate when we need to */
884     if (queue->use_rate_estimate)
885       percent = MAX (percent, GET_PERCENT (rate_time, 0));
886   }
888   if (queue->is_buffering) {
889     post = TRUE;
890     /* if we were buffering see if we reached the high watermark */
891     if (percent >= queue->high_percent)
892       queue->is_buffering = FALSE;
893   } else {
894     /* we were not buffering, check if we need to start buffering if we drop
895      * below the low threshold */
896     if (percent < queue->low_percent) {
897       queue->is_buffering = TRUE;
898       queue->buffering_iteration++;
899       post = TRUE;
900     }
901   }
902   if (post) {
903     GstMessage *message;
904     GstBufferingMode mode;
905     gint64 buffering_left = -1;
907     /* scale to high percent so that it becomes the 100% mark */
908     percent = percent * 100 / queue->high_percent;
909     /* clip */
910     if (percent > 100)
911       percent = 100;
913     if (percent != queue->buffering_percent) {
914       queue->buffering_percent = percent;
916       if (!QUEUE_IS_USING_QUEUE (queue)) {
917         GstFormat fmt = GST_FORMAT_BYTES;
918         gint64 duration;
920         if (QUEUE_IS_USING_RING_BUFFER (queue))
921           mode = GST_BUFFERING_TIMESHIFT;
922         else
923           mode = GST_BUFFERING_DOWNLOAD;
925         if (queue->byte_in_rate > 0) {
926           if (gst_pad_query_peer_duration (queue->sinkpad, &fmt, &duration))
927             buffering_left =
928                 (gdouble) ((duration -
929                     queue->current->writing_pos) * 1000) / queue->byte_in_rate;
930         } else {
931           buffering_left = G_MAXINT64;
932         }
933       } else {
934         mode = GST_BUFFERING_STREAM;
935       }
937       GST_DEBUG_OBJECT (queue, "buffering %d percent", (gint) percent);
938       message = gst_message_new_buffering (GST_OBJECT_CAST (queue),
939           (gint) percent);
940       gst_message_set_buffering_stats (message, mode,
941           queue->byte_in_rate, queue->byte_out_rate, buffering_left);
943       gst_element_post_message (GST_ELEMENT_CAST (queue), message);
944     }
945   } else {
946     GST_DEBUG_OBJECT (queue, "filled %d percent", (gint) percent);
947   }
949 #undef GET_PERCENT
952 static void
953 reset_rate_timer (GstQueue2 * queue)
955   queue->bytes_in = 0;
956   queue->bytes_out = 0;
957   queue->byte_in_rate = 0.0;
958   queue->byte_in_period = 0;
959   queue->byte_out_rate = 0.0;
960   queue->last_in_elapsed = 0.0;
961   queue->last_out_elapsed = 0.0;
962   queue->in_timer_started = FALSE;
963   queue->out_timer_started = FALSE;
966 /* the interval in seconds to recalculate the rate */
967 #define RATE_INTERVAL    0.2
968 /* Tuning for rate estimation. We use a large window for the input rate because
969  * it should be stable when connected to a network. The output rate is less
970  * stable (the elements preroll, queues behind a demuxer fill, ...) and should
971  * therefore adapt more quickly.
972  * However, initial input rate may be subject to a burst, and should therefore
973  * initially also adapt more quickly to changes, and only later on give higher
974  * weight to previous values. */
975 #define AVG_IN(avg,val,w1,w2)  ((avg) * (w1) + (val) * (w2)) / ((w1) + (w2))
976 #define AVG_OUT(avg,val) ((avg) * 3.0 + (val)) / 4.0
978 static void
979 update_in_rates (GstQueue2 * queue)
981   gdouble elapsed, period;
982   gdouble byte_in_rate;
984   if (!queue->in_timer_started) {
985     queue->in_timer_started = TRUE;
986     g_timer_start (queue->in_timer);
987     return;
988   }
990   elapsed = g_timer_elapsed (queue->in_timer, NULL);
992   /* recalc after each interval. */
993   if (queue->last_in_elapsed + RATE_INTERVAL < elapsed) {
994     period = elapsed - queue->last_in_elapsed;
996     GST_DEBUG_OBJECT (queue,
997         "rates: period %f, in %" G_GUINT64_FORMAT ", global period %f",
998         period, queue->bytes_in, queue->byte_in_period);
1000     byte_in_rate = queue->bytes_in / period;
1002     if (queue->byte_in_rate == 0.0)
1003       queue->byte_in_rate = byte_in_rate;
1004     else
1005       queue->byte_in_rate = AVG_IN (queue->byte_in_rate, byte_in_rate,
1006           (double) queue->byte_in_period, period);
1008     /* another data point, cap at 16 for long time running average */
1009     if (queue->byte_in_period < 16 * RATE_INTERVAL)
1010       queue->byte_in_period += period;
1012     /* reset the values to calculate rate over the next interval */
1013     queue->last_in_elapsed = elapsed;
1014     queue->bytes_in = 0;
1015   }
1017   if (queue->byte_in_rate > 0.0) {
1018     queue->cur_level.rate_time =
1019         queue->cur_level.bytes / queue->byte_in_rate * GST_SECOND;
1020   }
1021   GST_DEBUG_OBJECT (queue, "rates: in %f, time %" GST_TIME_FORMAT,
1022       queue->byte_in_rate, GST_TIME_ARGS (queue->cur_level.rate_time));
1025 static void
1026 update_out_rates (GstQueue2 * queue)
1028   gdouble elapsed, period;
1029   gdouble byte_out_rate;
1031   if (!queue->out_timer_started) {
1032     queue->out_timer_started = TRUE;
1033     g_timer_start (queue->out_timer);
1034     return;
1035   }
1037   elapsed = g_timer_elapsed (queue->out_timer, NULL);
1039   /* recalc after each interval. */
1040   if (queue->last_out_elapsed + RATE_INTERVAL < elapsed) {
1041     period = elapsed - queue->last_out_elapsed;
1043     GST_DEBUG_OBJECT (queue,
1044         "rates: period %f, out %" G_GUINT64_FORMAT, period, queue->bytes_out);
1046     byte_out_rate = queue->bytes_out / period;
1048     if (queue->byte_out_rate == 0.0)
1049       queue->byte_out_rate = byte_out_rate;
1050     else
1051       queue->byte_out_rate = AVG_OUT (queue->byte_out_rate, byte_out_rate);
1053     /* reset the values to calculate rate over the next interval */
1054     queue->last_out_elapsed = elapsed;
1055     queue->bytes_out = 0;
1056   }
1057   if (queue->byte_in_rate > 0.0) {
1058     queue->cur_level.rate_time =
1059         queue->cur_level.bytes / queue->byte_in_rate * GST_SECOND;
1060   }
1061   GST_DEBUG_OBJECT (queue, "rates: out %f, time %" GST_TIME_FORMAT,
1062       queue->byte_out_rate, GST_TIME_ARGS (queue->cur_level.rate_time));
1065 static void
1066 update_cur_pos (GstQueue2 * queue, GstQueue2Range * range, guint64 pos)
1068   guint64 reading_pos, max_reading_pos;
1070   reading_pos = pos;
1071   max_reading_pos = range->max_reading_pos;
1073   max_reading_pos = MAX (max_reading_pos, reading_pos);
1075   GST_DEBUG_OBJECT (queue,
1076       "updating max_reading_pos from %" G_GUINT64_FORMAT " to %"
1077       G_GUINT64_FORMAT, range->max_reading_pos, max_reading_pos);
1078   range->max_reading_pos = max_reading_pos;
1080   update_cur_level (queue, range);
1083 static gboolean
1084 perform_seek_to_offset (GstQueue2 * queue, guint64 offset)
1086   GstEvent *event;
1087   gboolean res;
1089   GST_QUEUE2_MUTEX_UNLOCK (queue);
1091   GST_DEBUG_OBJECT (queue, "Seeking to %" G_GUINT64_FORMAT, offset);
1093   event =
1094       gst_event_new_seek (1.0, GST_FORMAT_BYTES,
1095       GST_SEEK_FLAG_FLUSH | GST_SEEK_FLAG_ACCURATE, GST_SEEK_TYPE_SET, offset,
1096       GST_SEEK_TYPE_NONE, -1);
1098   res = gst_pad_push_event (queue->sinkpad, event);
1099   GST_QUEUE2_MUTEX_LOCK (queue);
1101   if (res)
1102     queue->current = add_range (queue, offset);
1104   return res;
1107 /* see if there is enough data in the file to read a full buffer */
1108 static gboolean
1109 gst_queue2_have_data (GstQueue2 * queue, guint64 offset, guint length)
1111   GstQueue2Range *range;
1113   GST_DEBUG_OBJECT (queue, "looking for offset %" G_GUINT64_FORMAT ", len %u",
1114       offset, length);
1116   if ((range = find_range (queue, offset))) {
1117     if (queue->current != range) {
1118       GST_DEBUG_OBJECT (queue, "switching ranges, do seek to range position");
1119       perform_seek_to_offset (queue, range->writing_pos);
1120     }
1122     GST_INFO_OBJECT (queue, "cur_level.bytes %u (max %" G_GUINT64_FORMAT ")",
1123         queue->cur_level.bytes, QUEUE_MAX_BYTES (queue));
1125     /* we have a range for offset */
1126     GST_DEBUG_OBJECT (queue,
1127         "we have a range %p, offset %" G_GUINT64_FORMAT ", writing_pos %"
1128         G_GUINT64_FORMAT, range, range->offset, range->writing_pos);
1130     if (!QUEUE_IS_USING_RING_BUFFER (queue) && queue->is_eos)
1131       return TRUE;
1133     if (offset + length <= range->writing_pos)
1134       return TRUE;
1135     else
1136       GST_DEBUG_OBJECT (queue,
1137           "Need more data (%" G_GUINT64_FORMAT " bytes more)",
1138           (offset + length) - range->writing_pos);
1140   } else {
1141     GST_INFO_OBJECT (queue, "not found in any range");
1142     /* we don't have the range, see how far away we are, FIXME, find a good
1143      * threshold based on the incoming rate. */
1144     if (!queue->is_eos && queue->current) {
1145       if (QUEUE_IS_USING_RING_BUFFER (queue)) {
1146         if (offset < queue->current->offset || offset >
1147             queue->current->writing_pos + QUEUE_MAX_BYTES (queue) -
1148             queue->cur_level.bytes) {
1149           perform_seek_to_offset (queue, offset);
1150         } else {
1151           GST_INFO_OBJECT (queue,
1152               "requested data is within range, wait for data");
1153         }
1154       } else if (offset < queue->current->writing_pos + 200000) {
1155         update_cur_pos (queue, queue->current, offset + length);
1156         GST_INFO_OBJECT (queue, "wait for data");
1157         return FALSE;
1158       }
1159     }
1161     /* too far away, do a seek */
1162     perform_seek_to_offset (queue, offset);
1163   }
1165   return FALSE;
1168 #ifdef HAVE_FSEEKO
1169 #define FSEEK_FILE(file,offset)  (fseeko (file, (off_t) offset, SEEK_SET) != 0)
1170 #elif defined (G_OS_UNIX) || defined (G_OS_WIN32)
1171 #define FSEEK_FILE(file,offset)  (lseek (fileno (file), (off_t) offset, SEEK_SET) == (off_t) -1)
1172 #else
1173 #define FSEEK_FILE(file,offset)  (fseek (file, offset, SEEK_SET) != 0)
1174 #endif
1176 static gint64
1177 gst_queue2_read_data_at_offset (GstQueue2 * queue, guint64 offset, guint length,
1178     guint8 * dst)
1180   guint8 *ring_buffer;
1181   size_t res;
1183   ring_buffer = queue->ring_buffer;
1185   if (QUEUE_IS_USING_TEMP_FILE (queue) && FSEEK_FILE (queue->temp_file, offset))
1186     goto seek_failed;
1188   /* this should not block */
1189   GST_LOG_OBJECT (queue, "Reading %d bytes from offset %" G_GUINT64_FORMAT,
1190       length, offset);
1191   if (QUEUE_IS_USING_TEMP_FILE (queue)) {
1192     res = fread (dst, 1, length, queue->temp_file);
1193   } else {
1194     memcpy (dst, ring_buffer + offset, length);
1195     res = length;
1196   }
1198   GST_LOG_OBJECT (queue, "read %" G_GSIZE_FORMAT " bytes", res);
1200   if (G_UNLIKELY (res < length)) {
1201     if (!QUEUE_IS_USING_TEMP_FILE (queue))
1202       goto could_not_read;
1203     /* check for errors or EOF */
1204     if (ferror (queue->temp_file))
1205       goto could_not_read;
1206     if (feof (queue->temp_file) && length > 0)
1207       goto eos;
1208   }
1210   return res;
1212 seek_failed:
1213   {
1214     GST_ELEMENT_ERROR (queue, RESOURCE, SEEK, (NULL), GST_ERROR_SYSTEM);
1215     return GST_FLOW_ERROR;
1216   }
1217 could_not_read:
1218   {
1219     GST_ELEMENT_ERROR (queue, RESOURCE, READ, (NULL), GST_ERROR_SYSTEM);
1220     return GST_FLOW_ERROR;
1221   }
1222 eos:
1223   {
1224     GST_DEBUG ("non-regular file hits EOS");
1225     return GST_FLOW_UNEXPECTED;
1226   }
1229 static GstFlowReturn
1230 gst_queue2_create_read (GstQueue2 * queue, guint64 offset, guint length,
1231     GstBuffer ** buffer)
1233   GstBuffer *buf;
1234   guint8 *data;
1235   guint64 file_offset;
1236   guint block_length, remaining, read_length;
1237   gint64 read_return;
1238   guint64 rb_size;
1239   guint64 rpos;
1241   /* allocate the output buffer of the requested size */
1242   buf = gst_buffer_new_and_alloc (length);
1243   data = GST_BUFFER_DATA (buf);
1245   GST_DEBUG_OBJECT (queue, "Reading %u bytes from %" G_GUINT64_FORMAT, length,
1246       offset);
1248   rpos = offset;
1249   rb_size = queue->ring_buffer_max_size;
1251   remaining = length;
1252   while (remaining > 0) {
1253     /* configure how much/whether to read */
1254     if (!gst_queue2_have_data (queue, rpos, remaining)) {
1255       read_length = 0;
1257       if (QUEUE_IS_USING_RING_BUFFER (queue)) {
1258         guint64 level;
1260         /* calculate how far away the offset is */
1261         if (queue->current->writing_pos > rpos)
1262           level = queue->current->writing_pos - rpos;
1263         else
1264           level = 0;
1266         GST_DEBUG_OBJECT (queue,
1267             "reading %" G_GUINT64_FORMAT ", writing %" G_GUINT64_FORMAT
1268             ", level %" G_GUINT64_FORMAT,
1269             rpos, queue->current->writing_pos, level);
1271         if (level >= rb_size) {
1272           /* we don't have the data but if we have a ring buffer that is full, we
1273            * need to read */
1274           GST_DEBUG_OBJECT (queue,
1275               "ring buffer full, reading ring-buffer-max-size %"
1276               G_GUINT64_FORMAT " bytes", rb_size);
1277           read_length = rb_size;
1278         } else if (queue->is_eos) {
1279           /* won't get any more data so read any data we have */
1280           if (level) {
1281             GST_DEBUG_OBJECT (queue,
1282                 "EOS hit but read %" G_GUINT64_FORMAT " bytes that we have",
1283                 level);
1284             read_length = level;
1285           } else {
1286             GST_DEBUG_OBJECT (queue,
1287                 "EOS hit and we don't have any requested data");
1288             gst_buffer_unref (buf);
1289             return GST_FLOW_UNEXPECTED;
1290           }
1291         }
1292       }
1294       if (read_length == 0) {
1295         if (QUEUE_IS_USING_RING_BUFFER (queue)
1296             && queue->current->max_reading_pos > rpos) {
1297           /* protect cached data (data between offset and max_reading_pos)
1298            * and update current level */
1299           GST_DEBUG_OBJECT (queue,
1300               "protecting cached data [%" G_GUINT64_FORMAT "-%" G_GUINT64_FORMAT
1301               "]", rpos, queue->current->max_reading_pos);
1302           queue->current->max_reading_pos = rpos;
1303           update_cur_level (queue, queue->current);
1304         }
1305         GST_DEBUG_OBJECT (queue, "waiting for add");
1306         GST_QUEUE2_WAIT_ADD_CHECK (queue, queue->srcresult, out_flushing);
1307         continue;
1308       }
1309     } else {
1310       /* we have the requested data so read it */
1311       read_length = remaining;
1312     }
1314     /* set range reading_pos to actual reading position for this read */
1315     queue->current->reading_pos = rpos;
1317     /* configure how much and from where to read */
1318     if (QUEUE_IS_USING_RING_BUFFER (queue)) {
1319       file_offset =
1320           (queue->current->rb_offset + (rpos -
1321               queue->current->offset)) % rb_size;
1322       if (file_offset + read_length > rb_size) {
1323         block_length = rb_size - file_offset;
1324       } else {
1325         block_length = read_length;
1326       }
1327     } else {
1328       file_offset = rpos;
1329       block_length = read_length;
1330     }
1332     /* while we still have data to read, we loop */
1333     while (read_length > 0) {
1334       read_return =
1335           gst_queue2_read_data_at_offset (queue, file_offset, block_length,
1336           data);
1337       if (read_return < 0)
1338         goto read_error;
1340       file_offset += read_return;
1341       if (QUEUE_IS_USING_RING_BUFFER (queue))
1342         file_offset %= rb_size;
1344       data += read_return;
1345       read_length -= read_return;
1346       block_length = read_length;
1347       remaining -= read_return;
1349       rpos = (queue->current->reading_pos += read_return);
1350       update_cur_pos (queue, queue->current, queue->current->reading_pos);
1351     }
1352     GST_QUEUE2_SIGNAL_DEL (queue);
1353     GST_DEBUG_OBJECT (queue, "%u bytes left to read", remaining);
1354   }
1356   GST_BUFFER_SIZE (buf) = length;
1357   GST_BUFFER_OFFSET (buf) = offset;
1358   GST_BUFFER_OFFSET_END (buf) = offset + length;
1360   *buffer = buf;
1362   return GST_FLOW_OK;
1364   /* ERRORS */
1365 out_flushing:
1366   {
1367     GST_DEBUG_OBJECT (queue, "we are flushing");
1368     gst_buffer_unref (buf);
1369     return GST_FLOW_WRONG_STATE;
1370   }
1371 read_error:
1372   {
1373     GST_DEBUG_OBJECT (queue, "we have a read error");
1374     gst_buffer_unref (buf);
1375     return read_return;
1376   }
1379 /* should be called with QUEUE_LOCK */
1380 static GstMiniObject *
1381 gst_queue2_read_item_from_file (GstQueue2 * queue)
1383   GstMiniObject *item;
1385   if (queue->starting_segment != NULL) {
1386     item = GST_MINI_OBJECT_CAST (queue->starting_segment);
1387     queue->starting_segment = NULL;
1388   } else {
1389     GstFlowReturn ret;
1390     GstBuffer *buffer;
1391     guint64 reading_pos;
1393     reading_pos = queue->current->reading_pos;
1395     ret =
1396         gst_queue2_create_read (queue, reading_pos, DEFAULT_BUFFER_SIZE,
1397         &buffer);
1399     switch (ret) {
1400       case GST_FLOW_OK:
1401         item = GST_MINI_OBJECT_CAST (buffer);
1402         break;
1403       case GST_FLOW_UNEXPECTED:
1404         item = GST_MINI_OBJECT_CAST (gst_event_new_eos ());
1405         break;
1406       default:
1407         item = NULL;
1408         break;
1409     }
1410   }
1411   return item;
1414 /* must be called with MUTEX_LOCK. Will briefly release the lock when notifying
1415  * the temp filename. */
1416 static gboolean
1417 gst_queue2_open_temp_location_file (GstQueue2 * queue)
1419   gint fd = -1;
1420   gchar *name = NULL;
1422   if (queue->temp_file)
1423     goto already_opened;
1425   GST_DEBUG_OBJECT (queue, "opening temp file %s", queue->temp_template);
1427   /* we have two cases:
1428    * - temp_location was set to something !NULL (Deprecated). in this case we
1429    *   open the specified filename.
1430    * - temp_template was set, allocate a filename and open that filename
1431    */
1432   if (!queue->temp_location_set) {
1433     /* nothing to do */
1434     if (queue->temp_template == NULL)
1435       goto no_directory;
1437     /* make copy of the template, we don't want to change this */
1438     name = g_strdup (queue->temp_template);
1439     fd = g_mkstemp (name);
1440     if (fd == -1)
1441       goto mkstemp_failed;
1443     /* open the file for update/writing */
1444     queue->temp_file = fdopen (fd, "wb+");
1445     /* error creating file */
1446     if (queue->temp_file == NULL)
1447       goto open_failed;
1449     g_free (queue->temp_location);
1450     queue->temp_location = name;
1452     GST_QUEUE2_MUTEX_UNLOCK (queue);
1454     /* we can't emit the notify with the lock */
1455     g_object_notify (G_OBJECT (queue), "temp-location");
1457     GST_QUEUE2_MUTEX_LOCK (queue);
1458   } else {
1459     /* open the file for update/writing, this is deprecated but we still need to
1460      * support it for API/ABI compatibility */
1461     queue->temp_file = g_fopen (queue->temp_location, "wb+");
1462     /* error creating file */
1463     if (queue->temp_file == NULL)
1464       goto open_failed;
1465   }
1466   GST_DEBUG_OBJECT (queue, "opened temp file %s", queue->temp_template);
1468   return TRUE;
1470   /* ERRORS */
1471 already_opened:
1472   {
1473     GST_DEBUG_OBJECT (queue, "temp file was already open");
1474     return TRUE;
1475   }
1476 no_directory:
1477   {
1478     GST_ELEMENT_ERROR (queue, RESOURCE, NOT_FOUND,
1479         (_("No Temp directory specified.")), (NULL));
1480     return FALSE;
1481   }
1482 mkstemp_failed:
1483   {
1484     GST_ELEMENT_ERROR (queue, RESOURCE, OPEN_READ,
1485         (_("Could not create temp file \"%s\"."), queue->temp_template),
1486         GST_ERROR_SYSTEM);
1487     g_free (name);
1488     return FALSE;
1489   }
1490 open_failed:
1491   {
1492     GST_ELEMENT_ERROR (queue, RESOURCE, OPEN_READ,
1493         (_("Could not open file \"%s\" for reading."), name), GST_ERROR_SYSTEM);
1494     g_free (name);
1495     if (fd != -1)
1496       close (fd);
1497     return FALSE;
1498   }
1501 static void
1502 gst_queue2_close_temp_location_file (GstQueue2 * queue)
1504   /* nothing to do */
1505   if (queue->temp_file == NULL)
1506     return;
1508   GST_DEBUG_OBJECT (queue, "closing temp file");
1510   fflush (queue->temp_file);
1511   fclose (queue->temp_file);
1513   if (queue->temp_remove)
1514     remove (queue->temp_location);
1516   queue->temp_file = NULL;
1517   clean_ranges (queue);
1520 static void
1521 gst_queue2_flush_temp_file (GstQueue2 * queue)
1523   if (queue->temp_file == NULL)
1524     return;
1526   GST_DEBUG_OBJECT (queue, "flushing temp file");
1528   queue->temp_file = g_freopen (queue->temp_location, "wb+", queue->temp_file);
1531 static void
1532 gst_queue2_locked_flush (GstQueue2 * queue)
1534   if (!QUEUE_IS_USING_QUEUE (queue)) {
1535     if (QUEUE_IS_USING_TEMP_FILE (queue))
1536       gst_queue2_flush_temp_file (queue);
1537     init_ranges (queue);
1538   } else {
1539     while (!g_queue_is_empty (&queue->queue)) {
1540       GstMiniObject *data = g_queue_pop_head (&queue->queue);
1542       /* Then lose another reference because we are supposed to destroy that
1543          data when flushing */
1544       gst_mini_object_unref (data);
1545     }
1546   }
1547   GST_QUEUE2_CLEAR_LEVEL (queue->cur_level);
1548   gst_segment_init (&queue->sink_segment, GST_FORMAT_TIME);
1549   gst_segment_init (&queue->src_segment, GST_FORMAT_TIME);
1550   queue->sinktime = queue->srctime = GST_CLOCK_TIME_NONE;
1551   queue->sink_tainted = queue->src_tainted = TRUE;
1552   if (queue->starting_segment != NULL)
1553     gst_event_unref (queue->starting_segment);
1554   queue->starting_segment = NULL;
1555   queue->segment_event_received = FALSE;
1557   /* we deleted a lot of something */
1558   GST_QUEUE2_SIGNAL_DEL (queue);
1561 static gboolean
1562 gst_queue2_wait_free_space (GstQueue2 * queue)
1564   /* We make space available if we're "full" according to whatever
1565    * the user defined as "full". */
1566   if (gst_queue2_is_filled (queue)) {
1567     gboolean started;
1569     /* pause the timer while we wait. The fact that we are waiting does not mean
1570      * the byterate on the input pad is lower */
1571     if ((started = queue->in_timer_started))
1572       g_timer_stop (queue->in_timer);
1574     GST_CAT_DEBUG_OBJECT (queue_dataflow, queue,
1575         "queue is full, waiting for free space");
1576     do {
1577       /* Wait for space to be available, we could be unlocked because of a flush. */
1578       GST_QUEUE2_WAIT_DEL_CHECK (queue, queue->sinkresult, out_flushing);
1579     }
1580     while (gst_queue2_is_filled (queue));
1582     /* and continue if we were running before */
1583     if (started)
1584       g_timer_continue (queue->in_timer);
1585   }
1586   return TRUE;
1588   /* ERRORS */
1589 out_flushing:
1590   {
1591     GST_CAT_DEBUG_OBJECT (queue_dataflow, queue, "queue is flushing");
1592     return FALSE;
1593   }
1596 static gboolean
1597 gst_queue2_create_write (GstQueue2 * queue, GstBuffer * buffer)
1599   guint8 *data, *ring_buffer;
1600   guint size, rb_size;
1601   guint64 writing_pos, new_writing_pos;
1602   GstQueue2Range *range, *prev, *next;
1604   if (QUEUE_IS_USING_RING_BUFFER (queue))
1605     writing_pos = queue->current->rb_writing_pos;
1606   else
1607     writing_pos = queue->current->writing_pos;
1608   ring_buffer = queue->ring_buffer;
1609   rb_size = queue->ring_buffer_max_size;
1611   size = GST_BUFFER_SIZE (buffer);
1612   data = GST_BUFFER_DATA (buffer);
1614   GST_DEBUG_OBJECT (queue, "Writing %u bytes to %" G_GUINT64_FORMAT, size,
1615       GST_BUFFER_OFFSET (buffer));
1617   while (size > 0) {
1618     guint to_write;
1620     if (QUEUE_IS_USING_RING_BUFFER (queue)) {
1621       gint64 space;
1623       /* calculate the space in the ring buffer not used by data from
1624        * the current range */
1625       while (QUEUE_MAX_BYTES (queue) <= queue->cur_level.bytes) {
1626         /* wait until there is some free space */
1627         GST_QUEUE2_WAIT_DEL_CHECK (queue, queue->sinkresult, out_flushing);
1628       }
1629       /* get the amount of space we have */
1630       space = QUEUE_MAX_BYTES (queue) - queue->cur_level.bytes;
1632       /* calculate if we need to split or if we can write the entire
1633        * buffer now */
1634       to_write = MIN (size, space);
1636       /* the writing position in the ring buffer after writing (part
1637        * or all of) the buffer */
1638       new_writing_pos = (writing_pos + to_write) % rb_size;
1640       prev = NULL;
1641       range = queue->ranges;
1643       /* if we need to overwrite data in the ring buffer, we need to
1644        * update the ranges
1645        *
1646        * warning: this code is complicated and includes some
1647        * simplifications - pen, paper and diagrams for the cases
1648        * recommended! */
1649       while (range) {
1650         guint64 range_data_start, range_data_end;
1651         GstQueue2Range *range_to_destroy = NULL;
1653         range_data_start = range->rb_offset;
1654         range_data_end = range->rb_writing_pos;
1656         /* handle the special case where the range has no data in it */
1657         if (range->writing_pos == range->offset) {
1658           if (range != queue->current) {
1659             GST_DEBUG_OBJECT (queue,
1660                 "Removing range: offset %" G_GUINT64_FORMAT ", wpos %"
1661                 G_GUINT64_FORMAT, range->offset, range->writing_pos);
1662             /* remove range */
1663             range_to_destroy = range;
1664             if (prev)
1665               prev->next = range->next;
1666           }
1667           goto next_range;
1668         }
1670         if (range_data_end > range_data_start) {
1671           if (writing_pos >= range_data_end && new_writing_pos >= writing_pos)
1672             goto next_range;
1674           if (new_writing_pos > range_data_start) {
1675             if (new_writing_pos >= range_data_end) {
1676               GST_DEBUG_OBJECT (queue,
1677                   "Removing range: offset %" G_GUINT64_FORMAT ", wpos %"
1678                   G_GUINT64_FORMAT, range->offset, range->writing_pos);
1679               /* remove range */
1680               range_to_destroy = range;
1681               if (prev)
1682                 prev->next = range->next;
1683             } else {
1684               GST_DEBUG_OBJECT (queue,
1685                   "advancing offsets from %" G_GUINT64_FORMAT " (%"
1686                   G_GUINT64_FORMAT ") to %" G_GUINT64_FORMAT " (%"
1687                   G_GUINT64_FORMAT ")", range->offset, range->rb_offset,
1688                   range->offset + new_writing_pos - range_data_start,
1689                   new_writing_pos);
1690               range->offset += (new_writing_pos - range_data_start);
1691               range->rb_offset = new_writing_pos;
1692             }
1693           }
1694         } else {
1695           guint64 new_wpos_virt = writing_pos + to_write;
1697           if (new_wpos_virt <= range_data_start)
1698             goto next_range;
1700           if (new_wpos_virt > rb_size && new_writing_pos >= range_data_end) {
1701             GST_DEBUG_OBJECT (queue,
1702                 "Removing range: offset %" G_GUINT64_FORMAT ", wpos %"
1703                 G_GUINT64_FORMAT, range->offset, range->writing_pos);
1704             /* remove range */
1705             range_to_destroy = range;
1706             if (prev)
1707               prev->next = range->next;
1708           } else {
1709             GST_DEBUG_OBJECT (queue,
1710                 "advancing offsets from %" G_GUINT64_FORMAT " (%"
1711                 G_GUINT64_FORMAT ") to %" G_GUINT64_FORMAT " (%"
1712                 G_GUINT64_FORMAT ")", range->offset, range->rb_offset,
1713                 range->offset + new_writing_pos - range_data_start,
1714                 new_writing_pos);
1715             range->offset += (new_wpos_virt - range_data_start);
1716             range->rb_offset = new_writing_pos;
1717           }
1718         }
1720       next_range:
1721         if (!range_to_destroy)
1722           prev = range;
1724         range = range->next;
1725         if (range_to_destroy) {
1726           if (range_to_destroy == queue->ranges)
1727             queue->ranges = range;
1728           g_slice_free (GstQueue2Range, range_to_destroy);
1729           range_to_destroy = NULL;
1730         }
1731       }
1732     } else {
1733       to_write = size;
1734       new_writing_pos = writing_pos + to_write;
1735     }
1737     if (QUEUE_IS_USING_TEMP_FILE (queue)
1738         && FSEEK_FILE (queue->temp_file, writing_pos))
1739       goto seek_failed;
1741     if (new_writing_pos > writing_pos) {
1742       GST_INFO_OBJECT (queue,
1743           "writing %u bytes to range [%" G_GUINT64_FORMAT "-%" G_GUINT64_FORMAT
1744           "] (rb wpos %" G_GUINT64_FORMAT ")", to_write, queue->current->offset,
1745           queue->current->writing_pos, queue->current->rb_writing_pos);
1746       /* either not using ring buffer or no wrapping, just write */
1747       if (QUEUE_IS_USING_TEMP_FILE (queue)) {
1748         if (fwrite (data, to_write, 1, queue->temp_file) != 1)
1749           goto handle_error;
1750       } else {
1751         memcpy (ring_buffer + writing_pos, data, to_write);
1752       }
1754       if (!QUEUE_IS_USING_RING_BUFFER (queue)) {
1755         /* try to merge with next range */
1756         while ((next = queue->current->next)) {
1757           GST_INFO_OBJECT (queue,
1758               "checking merge with next range %" G_GUINT64_FORMAT " < %"
1759               G_GUINT64_FORMAT, new_writing_pos, next->offset);
1760           if (new_writing_pos < next->offset)
1761             break;
1763           GST_DEBUG_OBJECT (queue, "merging ranges %" G_GUINT64_FORMAT,
1764               next->writing_pos);
1766           /* remove the group, we could choose to not read the data in this range
1767            * again. This would involve us doing a seek to the current writing position
1768            * in the range. FIXME, It would probably make sense to do a seek when there
1769            * is a lot of data in the range we merged with to avoid reading it all
1770            * again. */
1771           queue->current->next = next->next;
1772           g_slice_free (GstQueue2Range, next);
1774           debug_ranges (queue);
1775         }
1776         goto update_and_signal;
1777       }
1778     } else {
1779       /* wrapping */
1780       guint block_one, block_two;
1782       block_one = rb_size - writing_pos;
1783       block_two = to_write - block_one;
1785       if (block_one > 0) {
1786         GST_INFO_OBJECT (queue, "writing %u bytes", block_one);
1787         /* write data to end of ring buffer */
1788         if (QUEUE_IS_USING_TEMP_FILE (queue)) {
1789           if (fwrite (data, block_one, 1, queue->temp_file) != 1)
1790             goto handle_error;
1791         } else {
1792           memcpy (ring_buffer + writing_pos, data, block_one);
1793         }
1794       }
1796       if (QUEUE_IS_USING_TEMP_FILE (queue) && FSEEK_FILE (queue->temp_file, 0))
1797         goto seek_failed;
1799       if (block_two > 0) {
1800         GST_INFO_OBJECT (queue, "writing %u bytes", block_two);
1801         if (QUEUE_IS_USING_TEMP_FILE (queue)) {
1802           if (fwrite (data + block_one, block_two, 1, queue->temp_file) != 1)
1803             goto handle_error;
1804         } else {
1805           memcpy (ring_buffer, data + block_one, block_two);
1806         }
1807       }
1808     }
1810   update_and_signal:
1811     /* update the writing positions */
1812     size -= to_write;
1813     GST_INFO_OBJECT (queue,
1814         "wrote %u bytes to %" G_GUINT64_FORMAT " (%u bytes remaining to write)",
1815         to_write, writing_pos, size);
1817     if (QUEUE_IS_USING_RING_BUFFER (queue)) {
1818       data += to_write;
1819       queue->current->writing_pos += to_write;
1820       queue->current->rb_writing_pos = writing_pos = new_writing_pos;
1821     } else {
1822       queue->current->writing_pos = writing_pos = new_writing_pos;
1823     }
1824     update_cur_level (queue, queue->current);
1826     /* update the buffering status */
1827     if (queue->use_buffering)
1828       update_buffering (queue);
1830     GST_INFO_OBJECT (queue, "cur_level.bytes %u (max %" G_GUINT64_FORMAT ")",
1831         queue->cur_level.bytes, QUEUE_MAX_BYTES (queue));
1833     GST_QUEUE2_SIGNAL_ADD (queue);
1834   };
1836   return TRUE;
1838   /* ERRORS */
1839 out_flushing:
1840   {
1841     GST_DEBUG_OBJECT (queue, "we are flushing");
1842     /* FIXME - GST_FLOW_UNEXPECTED ? */
1843     return FALSE;
1844   }
1845 seek_failed:
1846   {
1847     GST_ELEMENT_ERROR (queue, RESOURCE, SEEK, (NULL), GST_ERROR_SYSTEM);
1848     return FALSE;
1849   }
1850 handle_error:
1851   {
1852     switch (errno) {
1853       case ENOSPC:{
1854         GST_ELEMENT_ERROR (queue, RESOURCE, NO_SPACE_LEFT, (NULL), (NULL));
1855         break;
1856       }
1857       default:{
1858         GST_ELEMENT_ERROR (queue, RESOURCE, WRITE,
1859             (_("Error while writing to download file.")),
1860             ("%s", g_strerror (errno)));
1861       }
1862     }
1863     return FALSE;
1864   }
1867 static GstBufferListItem
1868 buffer_list_create_write (GstBuffer ** buf, guint group, guint idx, gpointer q)
1870   GstQueue2 *queue = q;
1872   GST_TRACE_OBJECT (queue, "writing buffer %u in group %u of size %u bytes",
1873       idx, group, GST_BUFFER_SIZE (*buf));
1875   if (!gst_queue2_create_write (queue, *buf)) {
1876     GST_INFO_OBJECT (queue, "create_write() returned FALSE, bailing out");
1877     return GST_BUFFER_LIST_END;
1878   }
1880   return GST_BUFFER_LIST_CONTINUE;
1883 static GstBufferListItem
1884 buffer_list_calc_size (GstBuffer ** buf, guint group, guint idx, gpointer data)
1886   guint *p_size = data;
1887   guint buf_size;
1889   buf_size = GST_BUFFER_SIZE (*buf);
1890   GST_TRACE ("buffer %u in group %u has size %u", idx, group, buf_size);
1891   *p_size += buf_size;
1893   return GST_BUFFER_LIST_CONTINUE;
1896 /* enqueue an item an update the level stats */
1897 static void
1898 gst_queue2_locked_enqueue (GstQueue2 * queue, gpointer item,
1899     GstQueue2ItemType item_type)
1901   if (item_type == GST_QUEUE2_ITEM_TYPE_BUFFER) {
1902     GstBuffer *buffer;
1903     guint size;
1905     buffer = GST_BUFFER_CAST (item);
1906     size = GST_BUFFER_SIZE (buffer);
1908     /* add buffer to the statistics */
1909     if (QUEUE_IS_USING_QUEUE (queue)) {
1910       queue->cur_level.buffers++;
1911       queue->cur_level.bytes += size;
1912     }
1913     queue->bytes_in += size;
1915     /* apply new buffer to segment stats */
1916     apply_buffer (queue, buffer, &queue->sink_segment, TRUE);
1917     /* update the byterate stats */
1918     update_in_rates (queue);
1920     if (!QUEUE_IS_USING_QUEUE (queue)) {
1921       /* FIXME - check return value? */
1922       gst_queue2_create_write (queue, buffer);
1923     }
1924   } else if (item_type == GST_QUEUE2_ITEM_TYPE_BUFFER_LIST) {
1925     GstBufferList *buffer_list;
1926     guint size = 0;
1928     buffer_list = GST_BUFFER_LIST_CAST (item);
1930     gst_buffer_list_foreach (buffer_list, buffer_list_calc_size, &size);
1931     GST_LOG_OBJECT (queue, "total size of buffer list: %u bytes", size);
1933     /* add buffer to the statistics */
1934     if (QUEUE_IS_USING_QUEUE (queue)) {
1935       queue->cur_level.buffers++;
1936       queue->cur_level.bytes += size;
1937     }
1938     queue->bytes_in += size;
1940     /* apply new buffer to segment stats */
1941     apply_buffer_list (queue, buffer_list, &queue->sink_segment, TRUE);
1943     /* update the byterate stats */
1944     update_in_rates (queue);
1946     if (!QUEUE_IS_USING_QUEUE (queue)) {
1947       gst_buffer_list_foreach (buffer_list, buffer_list_create_write, queue);
1948     }
1949   } else if (item_type == GST_QUEUE2_ITEM_TYPE_EVENT) {
1950     GstEvent *event;
1952     event = GST_EVENT_CAST (item);
1954     switch (GST_EVENT_TYPE (event)) {
1955       case GST_EVENT_EOS:
1956         /* Zero the thresholds, this makes sure the queue is completely
1957          * filled and we can read all data from the queue. */
1958         GST_DEBUG_OBJECT (queue, "we have EOS");
1959         queue->is_eos = TRUE;
1960         break;
1961       case GST_EVENT_NEWSEGMENT:
1962         apply_segment (queue, event, &queue->sink_segment, TRUE);
1963         /* This is our first new segment, we hold it
1964          * as we can't save it on the temp file */
1965         if (!QUEUE_IS_USING_QUEUE (queue)) {
1966           if (queue->segment_event_received)
1967             goto unexpected_event;
1969           queue->segment_event_received = TRUE;
1970           if (queue->starting_segment != NULL)
1971             gst_event_unref (queue->starting_segment);
1972           queue->starting_segment = event;
1973           item = NULL;
1974         }
1975         /* a new segment allows us to accept more buffers if we got UNEXPECTED
1976          * from downstream */
1977         queue->unexpected = FALSE;
1978         break;
1979       default:
1980         if (!QUEUE_IS_USING_QUEUE (queue))
1981           goto unexpected_event;
1982         break;
1983     }
1984   } else {
1985     g_warning ("Unexpected item %p added in queue %s (refcounting problem?)",
1986         item, GST_OBJECT_NAME (queue));
1987     /* we can't really unref since we don't know what it is */
1988     item = NULL;
1989   }
1991   if (item) {
1992     /* update the buffering status */
1993     if (queue->use_buffering)
1994       update_buffering (queue);
1996     if (QUEUE_IS_USING_QUEUE (queue)) {
1997       g_queue_push_tail (&queue->queue, item);
1998     } else {
1999       gst_mini_object_unref (GST_MINI_OBJECT_CAST (item));
2000     }
2002     GST_QUEUE2_SIGNAL_ADD (queue);
2003   }
2005   return;
2007   /* ERRORS */
2008 unexpected_event:
2009   {
2010     g_warning
2011         ("Unexpected event of kind %s can't be added in temp file of queue %s ",
2012         gst_event_type_get_name (GST_EVENT_TYPE (item)),
2013         GST_OBJECT_NAME (queue));
2014     gst_event_unref (GST_EVENT_CAST (item));
2015     return;
2016   }
2019 /* dequeue an item from the queue and update level stats */
2020 static GstMiniObject *
2021 gst_queue2_locked_dequeue (GstQueue2 * queue, GstQueue2ItemType * item_type)
2023   GstMiniObject *item;
2025   if (!QUEUE_IS_USING_QUEUE (queue))
2026     item = gst_queue2_read_item_from_file (queue);
2027   else
2028     item = g_queue_pop_head (&queue->queue);
2030   if (item == NULL)
2031     goto no_item;
2033   if (GST_IS_BUFFER (item)) {
2034     GstBuffer *buffer;
2035     guint size;
2037     buffer = GST_BUFFER_CAST (item);
2038     size = GST_BUFFER_SIZE (buffer);
2039     *item_type = GST_QUEUE2_ITEM_TYPE_BUFFER;
2041     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
2042         "retrieved buffer %p from queue", buffer);
2044     if (QUEUE_IS_USING_QUEUE (queue)) {
2045       queue->cur_level.buffers--;
2046       queue->cur_level.bytes -= size;
2047     }
2048     queue->bytes_out += size;
2050     apply_buffer (queue, buffer, &queue->src_segment, FALSE);
2051     /* update the byterate stats */
2052     update_out_rates (queue);
2053     /* update the buffering */
2054     if (queue->use_buffering)
2055       update_buffering (queue);
2057   } else if (GST_IS_EVENT (item)) {
2058     GstEvent *event = GST_EVENT_CAST (item);
2060     *item_type = GST_QUEUE2_ITEM_TYPE_EVENT;
2062     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
2063         "retrieved event %p from queue", event);
2065     switch (GST_EVENT_TYPE (event)) {
2066       case GST_EVENT_EOS:
2067         /* queue is empty now that we dequeued the EOS */
2068         GST_QUEUE2_CLEAR_LEVEL (queue->cur_level);
2069         break;
2070       case GST_EVENT_NEWSEGMENT:
2071         apply_segment (queue, event, &queue->src_segment, FALSE);
2072         break;
2073       default:
2074         break;
2075     }
2076   } else if (GST_IS_BUFFER_LIST (item)) {
2077     GstBufferList *buffer_list;
2078     guint size = 0;
2080     buffer_list = GST_BUFFER_LIST_CAST (item);
2081     gst_buffer_list_foreach (buffer_list, buffer_list_calc_size, &size);
2082     *item_type = GST_QUEUE2_ITEM_TYPE_BUFFER_LIST;
2084     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
2085         "retrieved buffer list %p from queue", buffer_list);
2087     if (QUEUE_IS_USING_QUEUE (queue)) {
2088       queue->cur_level.buffers--;
2089       queue->cur_level.bytes -= size;
2090     }
2091     queue->bytes_out += size;
2093     apply_buffer_list (queue, buffer_list, &queue->src_segment, FALSE);
2094     /* update the byterate stats */
2095     update_out_rates (queue);
2096     /* update the buffering */
2097     if (queue->use_buffering)
2098       update_buffering (queue);
2100   } else {
2101     g_warning
2102         ("Unexpected item %p dequeued from queue %s (refcounting problem?)",
2103         item, GST_OBJECT_NAME (queue));
2104     item = NULL;
2105     *item_type = GST_QUEUE2_ITEM_TYPE_UNKNOWN;
2106   }
2107   GST_QUEUE2_SIGNAL_DEL (queue);
2109   return item;
2111   /* ERRORS */
2112 no_item:
2113   {
2114     GST_CAT_LOG_OBJECT (queue_dataflow, queue, "the queue is empty");
2115     return NULL;
2116   }
2119 static gboolean
2120 gst_queue2_handle_sink_event (GstPad * pad, GstEvent * event)
2122   GstQueue2 *queue;
2124   queue = GST_QUEUE2 (GST_OBJECT_PARENT (pad));
2126   switch (GST_EVENT_TYPE (event)) {
2127     case GST_EVENT_FLUSH_START:
2128     {
2129       GST_CAT_LOG_OBJECT (queue_dataflow, queue, "received flush start event");
2130       if (QUEUE_IS_USING_QUEUE (queue)) {
2131         /* forward event */
2132         gst_pad_push_event (queue->srcpad, event);
2134         /* now unblock the chain function */
2135         GST_QUEUE2_MUTEX_LOCK (queue);
2136         queue->srcresult = GST_FLOW_WRONG_STATE;
2137         queue->sinkresult = GST_FLOW_WRONG_STATE;
2138         /* unblock the loop and chain functions */
2139         GST_QUEUE2_SIGNAL_ADD (queue);
2140         GST_QUEUE2_SIGNAL_DEL (queue);
2141         GST_QUEUE2_MUTEX_UNLOCK (queue);
2143         /* make sure it pauses, this should happen since we sent
2144          * flush_start downstream. */
2145         gst_pad_pause_task (queue->srcpad);
2146         GST_CAT_LOG_OBJECT (queue_dataflow, queue, "loop stopped");
2147       } else {
2148         GST_QUEUE2_MUTEX_LOCK (queue);
2149         /* flush the sink pad */
2150         queue->sinkresult = GST_FLOW_WRONG_STATE;
2151         GST_QUEUE2_SIGNAL_DEL (queue);
2152         GST_QUEUE2_MUTEX_UNLOCK (queue);
2154         gst_event_unref (event);
2155       }
2156       goto done;
2157     }
2158     case GST_EVENT_FLUSH_STOP:
2159     {
2160       GST_CAT_LOG_OBJECT (queue_dataflow, queue, "received flush stop event");
2162       if (QUEUE_IS_USING_QUEUE (queue)) {
2163         /* forward event */
2164         gst_pad_push_event (queue->srcpad, event);
2166         GST_QUEUE2_MUTEX_LOCK (queue);
2167         gst_queue2_locked_flush (queue);
2168         queue->srcresult = GST_FLOW_OK;
2169         queue->sinkresult = GST_FLOW_OK;
2170         queue->is_eos = FALSE;
2171         queue->unexpected = FALSE;
2172         /* reset rate counters */
2173         reset_rate_timer (queue);
2174         gst_pad_start_task (queue->srcpad, (GstTaskFunction) gst_queue2_loop,
2175             queue->srcpad);
2176         GST_QUEUE2_MUTEX_UNLOCK (queue);
2177       } else {
2178         GST_QUEUE2_MUTEX_LOCK (queue);
2179         queue->segment_event_received = FALSE;
2180         queue->is_eos = FALSE;
2181         queue->unexpected = FALSE;
2182         queue->sinkresult = GST_FLOW_OK;
2183         GST_QUEUE2_MUTEX_UNLOCK (queue);
2185         gst_event_unref (event);
2186       }
2187       goto done;
2188     }
2189     default:
2190       if (GST_EVENT_IS_SERIALIZED (event)) {
2191         /* serialized events go in the queue */
2192         GST_QUEUE2_MUTEX_LOCK_CHECK (queue, queue->sinkresult, out_flushing);
2193         /* refuse more events on EOS */
2194         if (queue->is_eos)
2195           goto out_eos;
2196         gst_queue2_locked_enqueue (queue, event, GST_QUEUE2_ITEM_TYPE_EVENT);
2197         GST_QUEUE2_MUTEX_UNLOCK (queue);
2198       } else {
2199         /* non-serialized events are passed upstream. */
2200         gst_pad_push_event (queue->srcpad, event);
2201       }
2202       break;
2203   }
2204 done:
2205   return TRUE;
2207   /* ERRORS */
2208 out_flushing:
2209   {
2210     GST_DEBUG_OBJECT (queue, "refusing event, we are flushing");
2211     GST_QUEUE2_MUTEX_UNLOCK (queue);
2212     gst_event_unref (event);
2213     return FALSE;
2214   }
2215 out_eos:
2216   {
2217     GST_DEBUG_OBJECT (queue, "refusing event, we are EOS");
2218     GST_QUEUE2_MUTEX_UNLOCK (queue);
2219     gst_event_unref (event);
2220     return FALSE;
2221   }
2224 static gboolean
2225 gst_queue2_is_empty (GstQueue2 * queue)
2227   /* never empty on EOS */
2228   if (queue->is_eos)
2229     return FALSE;
2231   if (!QUEUE_IS_USING_QUEUE (queue) && queue->current) {
2232     return queue->current->writing_pos <= queue->current->max_reading_pos;
2233   } else {
2234     if (queue->queue.length == 0)
2235       return TRUE;
2236   }
2238   return FALSE;
2241 static gboolean
2242 gst_queue2_is_filled (GstQueue2 * queue)
2244   gboolean res;
2246   /* always filled on EOS */
2247   if (queue->is_eos)
2248     return TRUE;
2250 #define CHECK_FILLED(format,alt_max) ((queue->max_level.format) > 0 && \
2251     (queue->cur_level.format) >= ((alt_max) ? \
2252       MIN ((queue->max_level.format), (alt_max)) : (queue->max_level.format)))
2254   /* if using a ring buffer we're filled if all ring buffer space is used
2255    * _by the current range_ */
2256   if (QUEUE_IS_USING_RING_BUFFER (queue)) {
2257     guint64 rb_size = queue->ring_buffer_max_size;
2258     GST_DEBUG_OBJECT (queue,
2259         "max bytes %u, rb size %" G_GUINT64_FORMAT ", cur bytes %u",
2260         queue->max_level.bytes, rb_size, queue->cur_level.bytes);
2261     return CHECK_FILLED (bytes, rb_size);
2262   }
2264   /* if using file, we're never filled if we don't have EOS */
2265   if (QUEUE_IS_USING_TEMP_FILE (queue))
2266     return FALSE;
2268   /* we are never filled when we have no buffers at all */
2269   if (queue->cur_level.buffers == 0)
2270     return FALSE;
2272   /* we are filled if one of the current levels exceeds the max */
2273   res = CHECK_FILLED (buffers, 0) || CHECK_FILLED (bytes, 0)
2274       || CHECK_FILLED (time, 0);
2276   /* if we need to, use the rate estimate to check against the max time we are
2277    * allowed to queue */
2278   if (queue->use_rate_estimate)
2279     res |= CHECK_FILLED (rate_time, 0);
2281 #undef CHECK_FILLED
2282   return res;
2285 static GstFlowReturn
2286 gst_queue2_chain_buffer_or_buffer_list (GstQueue2 * queue,
2287     GstMiniObject * item, GstQueue2ItemType item_type)
2289   /* we have to lock the queue since we span threads */
2290   GST_QUEUE2_MUTEX_LOCK_CHECK (queue, queue->sinkresult, out_flushing);
2291   /* when we received EOS, we refuse more data */
2292   if (queue->is_eos)
2293     goto out_eos;
2294   /* when we received unexpected from downstream, refuse more buffers */
2295   if (queue->unexpected)
2296     goto out_unexpected;
2298   if (!gst_queue2_wait_free_space (queue))
2299     goto out_flushing;
2301   /* put buffer in queue now */
2302   gst_queue2_locked_enqueue (queue, item, item_type);
2303   GST_QUEUE2_MUTEX_UNLOCK (queue);
2305   return GST_FLOW_OK;
2307   /* special conditions */
2308 out_flushing:
2309   {
2310     GstFlowReturn ret = queue->sinkresult;
2312     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
2313         "exit because task paused, reason: %s", gst_flow_get_name (ret));
2314     GST_QUEUE2_MUTEX_UNLOCK (queue);
2315     gst_mini_object_unref (item);
2317     return ret;
2318   }
2319 out_eos:
2320   {
2321     GST_CAT_LOG_OBJECT (queue_dataflow, queue, "exit because we received EOS");
2322     GST_QUEUE2_MUTEX_UNLOCK (queue);
2323     gst_mini_object_unref (item);
2325     return GST_FLOW_UNEXPECTED;
2326   }
2327 out_unexpected:
2328   {
2329     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
2330         "exit because we received UNEXPECTED");
2331     GST_QUEUE2_MUTEX_UNLOCK (queue);
2332     gst_mini_object_unref (item);
2334     return GST_FLOW_UNEXPECTED;
2335   }
2338 static GstFlowReturn
2339 gst_queue2_chain (GstPad * pad, GstBuffer * buffer)
2341   GstQueue2 *queue;
2343   queue = GST_QUEUE2 (GST_OBJECT_PARENT (pad));
2345   GST_CAT_LOG_OBJECT (queue_dataflow, queue,
2346       "received buffer %p of size %d, time %" GST_TIME_FORMAT ", duration %"
2347       GST_TIME_FORMAT, buffer, GST_BUFFER_SIZE (buffer),
2348       GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buffer)),
2349       GST_TIME_ARGS (GST_BUFFER_DURATION (buffer)));
2351   return gst_queue2_chain_buffer_or_buffer_list (queue,
2352       GST_MINI_OBJECT_CAST (buffer), GST_QUEUE2_ITEM_TYPE_BUFFER);
2355 static GstFlowReturn
2356 gst_queue2_chain_list (GstPad * pad, GstBufferList * buffer_list)
2358   GstQueue2 *queue;
2360   queue = GST_QUEUE2 (GST_OBJECT_PARENT (pad));
2362   GST_CAT_LOG_OBJECT (queue_dataflow, queue,
2363       "received buffer list %p", buffer_list);
2365   return gst_queue2_chain_buffer_or_buffer_list (queue,
2366       GST_MINI_OBJECT_CAST (buffer_list), GST_QUEUE2_ITEM_TYPE_BUFFER_LIST);
2369 static GstMiniObject *
2370 gst_queue2_dequeue_on_unexpected (GstQueue2 * queue,
2371     GstQueue2ItemType * item_type)
2373   GstMiniObject *data;
2375   GST_CAT_LOG_OBJECT (queue_dataflow, queue, "got UNEXPECTED from downstream");
2377   /* stop pushing buffers, we dequeue all items until we see an item that we
2378    * can push again, which is EOS or NEWSEGMENT. If there is nothing in the
2379    * queue we can push, we set a flag to make the sinkpad refuse more
2380    * buffers with an UNEXPECTED return value until we receive something
2381    * pushable again or we get flushed. */
2382   while ((data = gst_queue2_locked_dequeue (queue, item_type))) {
2383     if (*item_type == GST_QUEUE2_ITEM_TYPE_BUFFER) {
2384       GST_CAT_LOG_OBJECT (queue_dataflow, queue,
2385           "dropping UNEXPECTED buffer %p", data);
2386       gst_buffer_unref (GST_BUFFER_CAST (data));
2387     } else if (*item_type == GST_QUEUE2_ITEM_TYPE_EVENT) {
2388       GstEvent *event = GST_EVENT_CAST (data);
2389       GstEventType type = GST_EVENT_TYPE (event);
2391       if (type == GST_EVENT_EOS || type == GST_EVENT_NEWSEGMENT) {
2392         /* we found a pushable item in the queue, push it out */
2393         GST_CAT_LOG_OBJECT (queue_dataflow, queue,
2394             "pushing pushable event %s after UNEXPECTED",
2395             GST_EVENT_TYPE_NAME (event));
2396         return data;
2397       }
2398       GST_CAT_LOG_OBJECT (queue_dataflow, queue,
2399           "dropping UNEXPECTED event %p", event);
2400       gst_event_unref (event);
2401     } else if (*item_type == GST_QUEUE2_ITEM_TYPE_BUFFER_LIST) {
2402       GST_CAT_LOG_OBJECT (queue_dataflow, queue,
2403           "dropping UNEXPECTED buffer list %p", data);
2404       gst_buffer_list_unref (GST_BUFFER_LIST_CAST (data));
2405     }
2406   }
2407   /* no more items in the queue. Set the unexpected flag so that upstream
2408    * make us refuse any more buffers on the sinkpad. Since we will still
2409    * accept EOS and NEWSEGMENT we return _FLOW_OK to the caller so that the
2410    * task function does not shut down. */
2411   queue->unexpected = TRUE;
2412   return NULL;
2415 /* dequeue an item from the queue an push it downstream. This functions returns
2416  * the result of the push. */
2417 static GstFlowReturn
2418 gst_queue2_push_one (GstQueue2 * queue)
2420   GstFlowReturn result = GST_FLOW_OK;
2421   GstMiniObject *data;
2422   GstQueue2ItemType item_type;
2424   data = gst_queue2_locked_dequeue (queue, &item_type);
2425   if (data == NULL)
2426     goto no_item;
2428 next:
2429   GST_QUEUE2_MUTEX_UNLOCK (queue);
2431   if (item_type == GST_QUEUE2_ITEM_TYPE_BUFFER) {
2432     GstBuffer *buffer;
2433     GstCaps *caps;
2435     buffer = GST_BUFFER_CAST (data);
2436     caps = GST_BUFFER_CAPS (buffer);
2438     /* set caps before pushing the buffer so that core does not try to do
2439      * something fancy to check if this is possible. */
2440     if (caps && caps != GST_PAD_CAPS (queue->srcpad))
2441       gst_pad_set_caps (queue->srcpad, caps);
2443     result = gst_pad_push (queue->srcpad, buffer);
2445     /* need to check for srcresult here as well */
2446     GST_QUEUE2_MUTEX_LOCK_CHECK (queue, queue->srcresult, out_flushing);
2447     if (result == GST_FLOW_UNEXPECTED) {
2448       data = gst_queue2_dequeue_on_unexpected (queue, &item_type);
2449       if (data != NULL)
2450         goto next;
2451       /* Since we will still accept EOS and NEWSEGMENT we return _FLOW_OK
2452        * to the caller so that the task function does not shut down */
2453       result = GST_FLOW_OK;
2454     }
2455   } else if (item_type == GST_QUEUE2_ITEM_TYPE_EVENT) {
2456     GstEvent *event = GST_EVENT_CAST (data);
2457     GstEventType type = GST_EVENT_TYPE (event);
2459     gst_pad_push_event (queue->srcpad, event);
2461     /* if we're EOS, return UNEXPECTED so that the task pauses. */
2462     if (type == GST_EVENT_EOS) {
2463       GST_CAT_LOG_OBJECT (queue_dataflow, queue,
2464           "pushed EOS event %p, return UNEXPECTED", event);
2465       result = GST_FLOW_UNEXPECTED;
2466     }
2468     GST_QUEUE2_MUTEX_LOCK_CHECK (queue, queue->srcresult, out_flushing);
2469   } else if (item_type == GST_QUEUE2_ITEM_TYPE_BUFFER_LIST) {
2470     GstBufferList *buffer_list;
2471     GstBuffer *first_buf;
2472     GstCaps *caps;
2474     buffer_list = GST_BUFFER_LIST_CAST (data);
2476     first_buf = gst_buffer_list_get (buffer_list, 0, 0);
2477     caps = (first_buf != NULL) ? GST_BUFFER_CAPS (first_buf) : NULL;
2479     /* set caps before pushing the buffer so that core does not try to do
2480      * something fancy to check if this is possible. */
2481     if (caps && caps != GST_PAD_CAPS (queue->srcpad))
2482       gst_pad_set_caps (queue->srcpad, caps);
2484     result = gst_pad_push_list (queue->srcpad, buffer_list);
2486     /* need to check for srcresult here as well */
2487     GST_QUEUE2_MUTEX_LOCK_CHECK (queue, queue->srcresult, out_flushing);
2488     if (result == GST_FLOW_UNEXPECTED) {
2489       data = gst_queue2_dequeue_on_unexpected (queue, &item_type);
2490       if (data != NULL)
2491         goto next;
2492       /* Since we will still accept EOS and NEWSEGMENT we return _FLOW_OK
2493        * to the caller so that the task function does not shut down */
2494       result = GST_FLOW_OK;
2495     }
2496   }
2497   return result;
2499   /* ERRORS */
2500 no_item:
2501   {
2502     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
2503         "exit because we have no item in the queue");
2504     return GST_FLOW_ERROR;
2505   }
2506 out_flushing:
2507   {
2508     GST_CAT_LOG_OBJECT (queue_dataflow, queue, "exit because we are flushing");
2509     return GST_FLOW_WRONG_STATE;
2510   }
2513 /* called repeatedly with @pad as the source pad. This function should push out
2514  * data to the peer element. */
2515 static void
2516 gst_queue2_loop (GstPad * pad)
2518   GstQueue2 *queue;
2519   GstFlowReturn ret;
2521   queue = GST_QUEUE2 (GST_PAD_PARENT (pad));
2523   /* have to lock for thread-safety */
2524   GST_QUEUE2_MUTEX_LOCK_CHECK (queue, queue->srcresult, out_flushing);
2526   if (gst_queue2_is_empty (queue)) {
2527     gboolean started;
2529     /* pause the timer while we wait. The fact that we are waiting does not mean
2530      * the byterate on the output pad is lower */
2531     if ((started = queue->out_timer_started))
2532       g_timer_stop (queue->out_timer);
2534     GST_CAT_DEBUG_OBJECT (queue_dataflow, queue,
2535         "queue is empty, waiting for new data");
2536     do {
2537       /* Wait for data to be available, we could be unlocked because of a flush. */
2538       GST_QUEUE2_WAIT_ADD_CHECK (queue, queue->srcresult, out_flushing);
2539     }
2540     while (gst_queue2_is_empty (queue));
2542     /* and continue if we were running before */
2543     if (started)
2544       g_timer_continue (queue->out_timer);
2545   }
2546   ret = gst_queue2_push_one (queue);
2547   queue->srcresult = ret;
2548   queue->sinkresult = ret;
2549   if (ret != GST_FLOW_OK)
2550     goto out_flushing;
2552   GST_QUEUE2_MUTEX_UNLOCK (queue);
2554   return;
2556   /* ERRORS */
2557 out_flushing:
2558   {
2559     gboolean eos = queue->is_eos;
2560     GstFlowReturn ret = queue->srcresult;
2562     gst_pad_pause_task (queue->srcpad);
2563     GST_QUEUE2_MUTEX_UNLOCK (queue);
2564     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
2565         "pause task, reason:  %s", gst_flow_get_name (queue->srcresult));
2566     /* let app know about us giving up if upstream is not expected to do so */
2567     /* UNEXPECTED is already taken care of elsewhere */
2568     if (eos && (ret == GST_FLOW_NOT_LINKED || ret < GST_FLOW_UNEXPECTED)) {
2569       GST_ELEMENT_ERROR (queue, STREAM, FAILED,
2570           (_("Internal data flow error.")),
2571           ("streaming task paused, reason %s (%d)",
2572               gst_flow_get_name (ret), ret));
2573       gst_pad_push_event (queue->srcpad, gst_event_new_eos ());
2574     }
2575     return;
2576   }
2579 static gboolean
2580 gst_queue2_handle_src_event (GstPad * pad, GstEvent * event)
2582   gboolean res = TRUE;
2583   GstQueue2 *queue = GST_QUEUE2 (gst_pad_get_parent (pad));
2585   if (G_UNLIKELY (queue == NULL)) {
2586     gst_event_unref (event);
2587     return FALSE;
2588   }
2589 #ifndef GST_DISABLE_GST_DEBUG
2590   GST_CAT_DEBUG_OBJECT (queue_dataflow, queue, "got event %p (%s)",
2591       event, GST_EVENT_TYPE_NAME (event));
2592 #endif
2594   switch (GST_EVENT_TYPE (event)) {
2595     case GST_EVENT_FLUSH_START:
2596       if (QUEUE_IS_USING_QUEUE (queue)) {
2597         /* just forward upstream */
2598         res = gst_pad_push_event (queue->sinkpad, event);
2599       } else {
2600         /* now unblock the getrange function */
2601         GST_QUEUE2_MUTEX_LOCK (queue);
2602         GST_DEBUG_OBJECT (queue, "flushing");
2603         queue->srcresult = GST_FLOW_WRONG_STATE;
2604         GST_QUEUE2_SIGNAL_ADD (queue);
2605         GST_QUEUE2_MUTEX_UNLOCK (queue);
2607         /* when using a temp file, we eat the event */
2608         res = TRUE;
2609         gst_event_unref (event);
2610       }
2611       break;
2612     case GST_EVENT_FLUSH_STOP:
2613       if (QUEUE_IS_USING_QUEUE (queue)) {
2614         /* just forward upstream */
2615         res = gst_pad_push_event (queue->sinkpad, event);
2616       } else {
2617         /* now unblock the getrange function */
2618         GST_QUEUE2_MUTEX_LOCK (queue);
2619         queue->srcresult = GST_FLOW_OK;
2620         if (queue->current) {
2621           /* forget the highest read offset, we'll calculate a new one when we
2622            * get the next getrange request. We need to do this in order to reset
2623            * the buffering percentage */
2624           queue->current->max_reading_pos = 0;
2625         }
2626         GST_QUEUE2_MUTEX_UNLOCK (queue);
2628         /* when using a temp file, we eat the event */
2629         res = TRUE;
2630         gst_event_unref (event);
2631       }
2632       break;
2633     default:
2634       res = gst_pad_push_event (queue->sinkpad, event);
2635       break;
2636   }
2638   gst_object_unref (queue);
2639   return res;
2642 static gboolean
2643 gst_queue2_peer_query (GstQueue2 * queue, GstPad * pad, GstQuery * query)
2645   gboolean ret = FALSE;
2646   GstPad *peer;
2648   if ((peer = gst_pad_get_peer (pad))) {
2649     ret = gst_pad_query (peer, query);
2650     gst_object_unref (peer);
2651   }
2652   return ret;
2655 static gboolean
2656 gst_queue2_handle_src_query (GstPad * pad, GstQuery * query)
2658   GstQueue2 *queue;
2660   queue = GST_QUEUE2 (gst_pad_get_parent (pad));
2661   if (G_UNLIKELY (queue == NULL))
2662     return FALSE;
2664   switch (GST_QUERY_TYPE (query)) {
2665     case GST_QUERY_POSITION:
2666     {
2667       gint64 peer_pos;
2668       GstFormat format;
2670       if (!gst_queue2_peer_query (queue, queue->sinkpad, query))
2671         goto peer_failed;
2673       /* get peer position */
2674       gst_query_parse_position (query, &format, &peer_pos);
2676       /* FIXME: this code assumes that there's no discont in the queue */
2677       switch (format) {
2678         case GST_FORMAT_BYTES:
2679           peer_pos -= queue->cur_level.bytes;
2680           break;
2681         case GST_FORMAT_TIME:
2682           peer_pos -= queue->cur_level.time;
2683           break;
2684         default:
2685           GST_WARNING_OBJECT (queue, "dropping query in %s format, don't "
2686               "know how to adjust value", gst_format_get_name (format));
2687           return FALSE;
2688       }
2689       /* set updated position */
2690       gst_query_set_position (query, format, peer_pos);
2691       break;
2692     }
2693     case GST_QUERY_DURATION:
2694     {
2695       GST_DEBUG_OBJECT (queue, "doing peer query");
2697       if (!gst_queue2_peer_query (queue, queue->sinkpad, query))
2698         goto peer_failed;
2700       GST_DEBUG_OBJECT (queue, "peer query success");
2701       break;
2702     }
2703     case GST_QUERY_BUFFERING:
2704     {
2705       GstFormat format;
2707       GST_DEBUG_OBJECT (queue, "query buffering");
2709       /* FIXME - is this condition correct? what should ring buffer do? */
2710       if (QUEUE_IS_USING_QUEUE (queue)) {
2711         /* no temp file, just forward to the peer */
2712         if (!gst_queue2_peer_query (queue, queue->sinkpad, query))
2713           goto peer_failed;
2714         GST_DEBUG_OBJECT (queue, "buffering forwarded to peer");
2715       } else {
2716         gint64 start, stop, range_start, range_stop;
2717         guint64 writing_pos;
2718         gint percent;
2719         gint64 estimated_total, buffering_left;
2720         GstFormat peer_fmt;
2721         gint64 duration;
2722         gboolean peer_res, is_buffering, is_eos;
2723         gdouble byte_in_rate, byte_out_rate;
2724         GstQueue2Range *queued_ranges;
2726         /* we need a current download region */
2727         if (queue->current == NULL)
2728           return FALSE;
2730         writing_pos = queue->current->writing_pos;
2731         byte_in_rate = queue->byte_in_rate;
2732         byte_out_rate = queue->byte_out_rate;
2733         is_buffering = queue->is_buffering;
2734         is_eos = queue->is_eos;
2735         percent = queue->buffering_percent;
2737         if (is_eos) {
2738           /* we're EOS, we know the duration in bytes now */
2739           peer_res = TRUE;
2740           duration = writing_pos;
2741         } else {
2742           /* get duration of upstream in bytes */
2743           peer_fmt = GST_FORMAT_BYTES;
2744           peer_res = gst_pad_query_peer_duration (queue->sinkpad, &peer_fmt,
2745               &duration);
2746         }
2748         /* calculate remaining and total download time */
2749         if (peer_res && byte_in_rate > 0.0) {
2750           estimated_total = (duration * 1000) / byte_in_rate;
2751           buffering_left = ((duration - writing_pos) * 1000) / byte_in_rate;
2752         } else {
2753           estimated_total = -1;
2754           buffering_left = -1;
2755         }
2756         GST_DEBUG_OBJECT (queue, "estimated %" G_GINT64_FORMAT ", left %"
2757             G_GINT64_FORMAT, estimated_total, buffering_left);
2759         gst_query_parse_buffering_range (query, &format, NULL, NULL, NULL);
2761         switch (format) {
2762           case GST_FORMAT_PERCENT:
2763             /* we need duration */
2764             if (!peer_res)
2765               goto peer_failed;
2767             GST_DEBUG_OBJECT (queue,
2768                 "duration %" G_GINT64_FORMAT ", writing %" G_GINT64_FORMAT,
2769                 duration, writing_pos);
2771             start = 0;
2772             /* get our available data relative to the duration */
2773             if (duration != -1)
2774               stop = GST_FORMAT_PERCENT_MAX * writing_pos / duration;
2775             else
2776               stop = -1;
2777             break;
2778           case GST_FORMAT_BYTES:
2779             start = 0;
2780             stop = writing_pos;
2781             break;
2782           default:
2783             start = -1;
2784             stop = -1;
2785             break;
2786         }
2788         /* fill out the buffered ranges */
2789         for (queued_ranges = queue->ranges; queued_ranges;
2790             queued_ranges = queued_ranges->next) {
2791           switch (format) {
2792             case GST_FORMAT_PERCENT:
2793               if (duration == -1) {
2794                 range_start = 0;
2795                 range_stop = 0;
2796                 break;
2797               }
2798               range_start = 100 * queued_ranges->offset / duration;
2799               range_stop = 100 * queued_ranges->writing_pos / duration;
2800               break;
2801             case GST_FORMAT_BYTES:
2802               range_start = queued_ranges->offset;
2803               range_stop = queued_ranges->writing_pos;
2804               break;
2805             default:
2806               range_start = -1;
2807               range_stop = -1;
2808               break;
2809           }
2810           if (range_start == range_stop)
2811             continue;
2812           GST_DEBUG_OBJECT (queue,
2813               "range starting at %" G_GINT64_FORMAT " and finishing at %"
2814               G_GINT64_FORMAT, range_start, range_stop);
2815           gst_query_add_buffering_range (query, range_start, range_stop);
2816         }
2818         gst_query_set_buffering_percent (query, is_buffering, percent);
2819         gst_query_set_buffering_range (query, format, start, stop,
2820             estimated_total);
2821         gst_query_set_buffering_stats (query, GST_BUFFERING_DOWNLOAD,
2822             byte_in_rate, byte_out_rate, buffering_left);
2823       }
2824       break;
2825     }
2826     default:
2827       /* peer handled other queries */
2828       if (!gst_queue2_peer_query (queue, queue->sinkpad, query))
2829         goto peer_failed;
2830       break;
2831   }
2833   gst_object_unref (queue);
2834   return TRUE;
2836   /* ERRORS */
2837 peer_failed:
2838   {
2839     GST_DEBUG_OBJECT (queue, "failed peer query");
2840     gst_object_unref (queue);
2841     return FALSE;
2842   }
2845 static gboolean
2846 gst_queue2_handle_query (GstElement * element, GstQuery * query)
2848   /* simply forward to the srcpad query function */
2849   return gst_queue2_handle_src_query (GST_QUEUE2_CAST (element)->srcpad, query);
2852 static void
2853 gst_queue2_update_upstream_size (GstQueue2 * queue)
2855   GstFormat fmt = GST_FORMAT_BYTES;
2856   gint64 upstream_size = -1;
2858   if (gst_pad_query_peer_duration (queue->sinkpad, &fmt, &upstream_size)) {
2859     GST_INFO_OBJECT (queue, "upstream size: %" G_GINT64_FORMAT, upstream_size);
2860     queue->upstream_size = upstream_size;
2861   }
2864 static GstFlowReturn
2865 gst_queue2_get_range (GstPad * pad, guint64 offset, guint length,
2866     GstBuffer ** buffer)
2868   GstQueue2 *queue;
2869   GstFlowReturn ret;
2871   queue = GST_QUEUE2_CAST (gst_pad_get_parent (pad));
2873   length = (length == -1) ? DEFAULT_BUFFER_SIZE : length;
2874   GST_QUEUE2_MUTEX_LOCK_CHECK (queue, queue->srcresult, out_flushing);
2875   offset = (offset == -1) ? queue->current->reading_pos : offset;
2877   GST_DEBUG_OBJECT (queue,
2878       "Getting range: offset %" G_GUINT64_FORMAT ", length %u", offset, length);
2880   /* catch any reads beyond the size of the file here to make sure queue2
2881    * doesn't send seek events beyond the size of the file upstream, since
2882    * that would confuse elements such as souphttpsrc and/or http servers.
2883    * Demuxers often just loop until EOS at the end of the file to figure out
2884    * when they've read all the end-headers or index chunks. */
2885   if (G_UNLIKELY (offset >= queue->upstream_size)) {
2886     gst_queue2_update_upstream_size (queue);
2887     if (queue->upstream_size > 0 && offset >= queue->upstream_size)
2888       goto out_unexpected;
2889   }
2891   if (G_UNLIKELY (offset + length > queue->upstream_size)) {
2892     gst_queue2_update_upstream_size (queue);
2893     if (queue->upstream_size > 0 && offset + length >= queue->upstream_size) {
2894       length = queue->upstream_size - offset;
2895       GST_DEBUG_OBJECT (queue, "adjusting length downto %d", length);
2896     }
2897   }
2899   /* FIXME - function will block when the range is not yet available */
2900   ret = gst_queue2_create_read (queue, offset, length, buffer);
2901   GST_QUEUE2_MUTEX_UNLOCK (queue);
2903   gst_object_unref (queue);
2905   return ret;
2907   /* ERRORS */
2908 out_flushing:
2909   {
2910     ret = queue->srcresult;
2912     GST_DEBUG_OBJECT (queue, "we are flushing");
2913     GST_QUEUE2_MUTEX_UNLOCK (queue);
2914     gst_object_unref (queue);
2915     return ret;
2916   }
2917 out_unexpected:
2918   {
2919     GST_DEBUG_OBJECT (queue, "read beyond end of file");
2920     GST_QUEUE2_MUTEX_UNLOCK (queue);
2921     gst_object_unref (queue);
2922     return GST_FLOW_UNEXPECTED;
2923   }
2926 static gboolean
2927 gst_queue2_src_checkgetrange_function (GstPad * pad)
2929   GstQueue2 *queue;
2930   gboolean ret;
2932   queue = GST_QUEUE2 (gst_pad_get_parent (pad));
2934   /* we can operate in pull mode when we are using a tempfile */
2935   ret = !QUEUE_IS_USING_QUEUE (queue);
2937   gst_object_unref (GST_OBJECT (queue));
2939   return ret;
2942 /* sink currently only operates in push mode */
2943 static gboolean
2944 gst_queue2_sink_activate_push (GstPad * pad, gboolean active)
2946   gboolean result = TRUE;
2947   GstQueue2 *queue;
2949   queue = GST_QUEUE2 (gst_pad_get_parent (pad));
2951   if (active) {
2952     GST_QUEUE2_MUTEX_LOCK (queue);
2953     GST_DEBUG_OBJECT (queue, "activating push mode");
2954     queue->srcresult = GST_FLOW_OK;
2955     queue->sinkresult = GST_FLOW_OK;
2956     queue->is_eos = FALSE;
2957     queue->unexpected = FALSE;
2958     reset_rate_timer (queue);
2959     GST_QUEUE2_MUTEX_UNLOCK (queue);
2960   } else {
2961     /* unblock chain function */
2962     GST_QUEUE2_MUTEX_LOCK (queue);
2963     GST_DEBUG_OBJECT (queue, "deactivating push mode");
2964     queue->srcresult = GST_FLOW_WRONG_STATE;
2965     queue->sinkresult = GST_FLOW_WRONG_STATE;
2966     gst_queue2_locked_flush (queue);
2967     GST_QUEUE2_MUTEX_UNLOCK (queue);
2968   }
2970   gst_object_unref (queue);
2972   return result;
2975 /* src operating in push mode, we start a task on the source pad that pushes out
2976  * buffers from the queue */
2977 static gboolean
2978 gst_queue2_src_activate_push (GstPad * pad, gboolean active)
2980   gboolean result = FALSE;
2981   GstQueue2 *queue;
2983   queue = GST_QUEUE2 (gst_pad_get_parent (pad));
2985   if (active) {
2986     GST_QUEUE2_MUTEX_LOCK (queue);
2987     GST_DEBUG_OBJECT (queue, "activating push mode");
2988     queue->srcresult = GST_FLOW_OK;
2989     queue->sinkresult = GST_FLOW_OK;
2990     queue->is_eos = FALSE;
2991     queue->unexpected = FALSE;
2992     result = gst_pad_start_task (pad, (GstTaskFunction) gst_queue2_loop, pad);
2993     GST_QUEUE2_MUTEX_UNLOCK (queue);
2994   } else {
2995     /* unblock loop function */
2996     GST_QUEUE2_MUTEX_LOCK (queue);
2997     GST_DEBUG_OBJECT (queue, "deactivating push mode");
2998     queue->srcresult = GST_FLOW_WRONG_STATE;
2999     queue->sinkresult = GST_FLOW_WRONG_STATE;
3000     /* the item add signal will unblock */
3001     GST_QUEUE2_SIGNAL_ADD (queue);
3002     GST_QUEUE2_MUTEX_UNLOCK (queue);
3004     /* step 2, make sure streaming finishes */
3005     result = gst_pad_stop_task (pad);
3006   }
3008   gst_object_unref (queue);
3010   return result;
3013 /* pull mode, downstream will call our getrange function */
3014 static gboolean
3015 gst_queue2_src_activate_pull (GstPad * pad, gboolean active)
3017   gboolean result;
3018   GstQueue2 *queue;
3020   queue = GST_QUEUE2 (gst_pad_get_parent (pad));
3022   if (active) {
3023     GST_QUEUE2_MUTEX_LOCK (queue);
3024     if (!QUEUE_IS_USING_QUEUE (queue)) {
3025       if (QUEUE_IS_USING_TEMP_FILE (queue)) {
3026         /* open the temp file now */
3027         result = gst_queue2_open_temp_location_file (queue);
3028       } else if (!queue->ring_buffer) {
3029         queue->ring_buffer = g_malloc (queue->ring_buffer_max_size);
3030         result = ! !queue->ring_buffer;
3031       } else {
3032         result = TRUE;
3033       }
3035       GST_DEBUG_OBJECT (queue, "activating pull mode");
3036       init_ranges (queue);
3037       queue->srcresult = GST_FLOW_OK;
3038       queue->sinkresult = GST_FLOW_OK;
3039       queue->is_eos = FALSE;
3040       queue->unexpected = FALSE;
3041       queue->upstream_size = 0;
3042     } else {
3043       GST_DEBUG_OBJECT (queue, "no temp file, cannot activate pull mode");
3044       /* this is not allowed, we cannot operate in pull mode without a temp
3045        * file. */
3046       queue->srcresult = GST_FLOW_WRONG_STATE;
3047       queue->sinkresult = GST_FLOW_WRONG_STATE;
3048       result = FALSE;
3049     }
3050     GST_QUEUE2_MUTEX_UNLOCK (queue);
3051   } else {
3052     GST_QUEUE2_MUTEX_LOCK (queue);
3053     GST_DEBUG_OBJECT (queue, "deactivating pull mode");
3054     queue->srcresult = GST_FLOW_WRONG_STATE;
3055     queue->sinkresult = GST_FLOW_WRONG_STATE;
3056     /* this will unlock getrange */
3057     GST_QUEUE2_SIGNAL_ADD (queue);
3058     result = TRUE;
3059     GST_QUEUE2_MUTEX_UNLOCK (queue);
3060   }
3061   gst_object_unref (queue);
3063   return result;
3066 static GstStateChangeReturn
3067 gst_queue2_change_state (GstElement * element, GstStateChange transition)
3069   GstQueue2 *queue;
3070   GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
3072   queue = GST_QUEUE2 (element);
3074   switch (transition) {
3075     case GST_STATE_CHANGE_NULL_TO_READY:
3076       break;
3077     case GST_STATE_CHANGE_READY_TO_PAUSED:
3078       GST_QUEUE2_MUTEX_LOCK (queue);
3079       if (!QUEUE_IS_USING_QUEUE (queue)) {
3080         if (QUEUE_IS_USING_TEMP_FILE (queue)) {
3081           if (!gst_queue2_open_temp_location_file (queue))
3082             ret = GST_STATE_CHANGE_FAILURE;
3083         } else {
3084           if (queue->ring_buffer) {
3085             g_free (queue->ring_buffer);
3086             queue->ring_buffer = NULL;
3087           }
3088           if (!(queue->ring_buffer = g_malloc (queue->ring_buffer_max_size)))
3089             ret = GST_STATE_CHANGE_FAILURE;
3090         }
3091         init_ranges (queue);
3092       }
3093       queue->segment_event_received = FALSE;
3094       queue->starting_segment = NULL;
3095       GST_QUEUE2_MUTEX_UNLOCK (queue);
3096       break;
3097     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
3098       break;
3099     default:
3100       break;
3101   }
3103   if (ret == GST_STATE_CHANGE_FAILURE)
3104     return ret;
3106   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
3108   if (ret == GST_STATE_CHANGE_FAILURE)
3109     return ret;
3111   switch (transition) {
3112     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
3113       break;
3114     case GST_STATE_CHANGE_PAUSED_TO_READY:
3115       GST_QUEUE2_MUTEX_LOCK (queue);
3116       if (!QUEUE_IS_USING_QUEUE (queue)) {
3117         if (QUEUE_IS_USING_TEMP_FILE (queue)) {
3118           gst_queue2_close_temp_location_file (queue);
3119         } else if (queue->ring_buffer) {
3120           g_free (queue->ring_buffer);
3121           queue->ring_buffer = NULL;
3122         }
3123         clean_ranges (queue);
3124       }
3125       if (queue->starting_segment != NULL) {
3126         gst_event_unref (queue->starting_segment);
3127         queue->starting_segment = NULL;
3128       }
3129       GST_QUEUE2_MUTEX_UNLOCK (queue);
3130       break;
3131     case GST_STATE_CHANGE_READY_TO_NULL:
3132       break;
3133     default:
3134       break;
3135   }
3137   return ret;
3140 /* changing the capacity of the queue must wake up
3141  * the _chain function, it might have more room now
3142  * to store the buffer/event in the queue */
3143 #define QUEUE_CAPACITY_CHANGE(q)\
3144   GST_QUEUE2_SIGNAL_DEL (queue);
3146 /* Changing the minimum required fill level must
3147  * wake up the _loop function as it might now
3148  * be able to preceed.
3149  */
3150 #define QUEUE_THRESHOLD_CHANGE(q)\
3151   GST_QUEUE2_SIGNAL_ADD (queue);
3153 static void
3154 gst_queue2_set_temp_template (GstQueue2 * queue, const gchar * template)
3156   GstState state;
3158   /* the element must be stopped in order to do this */
3159   GST_OBJECT_LOCK (queue);
3160   state = GST_STATE (queue);
3161   if (state != GST_STATE_READY && state != GST_STATE_NULL)
3162     goto wrong_state;
3163   GST_OBJECT_UNLOCK (queue);
3165   /* set new location */
3166   g_free (queue->temp_template);
3167   queue->temp_template = g_strdup (template);
3169   return;
3171 /* ERROR */
3172 wrong_state:
3173   {
3174     GST_WARNING_OBJECT (queue, "setting temp-template property in wrong state");
3175     GST_OBJECT_UNLOCK (queue);
3176   }
3179 static void
3180 gst_queue2_set_property (GObject * object,
3181     guint prop_id, const GValue * value, GParamSpec * pspec)
3183   GstQueue2 *queue = GST_QUEUE2 (object);
3185   /* someone could change levels here, and since this
3186    * affects the get/put funcs, we need to lock for safety. */
3187   GST_QUEUE2_MUTEX_LOCK (queue);
3189   switch (prop_id) {
3190     case PROP_MAX_SIZE_BYTES:
3191       queue->max_level.bytes = g_value_get_uint (value);
3192       QUEUE_CAPACITY_CHANGE (queue);
3193       break;
3194     case PROP_MAX_SIZE_BUFFERS:
3195       queue->max_level.buffers = g_value_get_uint (value);
3196       QUEUE_CAPACITY_CHANGE (queue);
3197       break;
3198     case PROP_MAX_SIZE_TIME:
3199       queue->max_level.time = g_value_get_uint64 (value);
3200       /* set rate_time to the same value. We use an extra field in the level
3201        * structure so that we can easily access and compare it */
3202       queue->max_level.rate_time = queue->max_level.time;
3203       QUEUE_CAPACITY_CHANGE (queue);
3204       break;
3205     case PROP_USE_BUFFERING:
3206       queue->use_buffering = g_value_get_boolean (value);
3207       break;
3208     case PROP_USE_RATE_ESTIMATE:
3209       queue->use_rate_estimate = g_value_get_boolean (value);
3210       break;
3211     case PROP_LOW_PERCENT:
3212       queue->low_percent = g_value_get_int (value);
3213       break;
3214     case PROP_HIGH_PERCENT:
3215       queue->high_percent = g_value_get_int (value);
3216       break;
3217     case PROP_TEMP_TEMPLATE:
3218       gst_queue2_set_temp_template (queue, g_value_get_string (value));
3219       break;
3220     case PROP_TEMP_LOCATION:
3221       g_free (queue->temp_location);
3222       queue->temp_location = g_value_dup_string (value);
3223       /* you can set the property back to NULL to make it use the temp-tmpl
3224        * property. */
3225       queue->temp_location_set = queue->temp_location != NULL;
3226       break;
3227     case PROP_TEMP_REMOVE:
3228       queue->temp_remove = g_value_get_boolean (value);
3229       break;
3230     case PROP_RING_BUFFER_MAX_SIZE:
3231       queue->ring_buffer_max_size = g_value_get_uint64 (value);
3232       break;
3233     default:
3234       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
3235       break;
3236   }
3238   GST_QUEUE2_MUTEX_UNLOCK (queue);
3241 static void
3242 gst_queue2_get_property (GObject * object,
3243     guint prop_id, GValue * value, GParamSpec * pspec)
3245   GstQueue2 *queue = GST_QUEUE2 (object);
3247   GST_QUEUE2_MUTEX_LOCK (queue);
3249   switch (prop_id) {
3250     case PROP_CUR_LEVEL_BYTES:
3251       g_value_set_uint (value, queue->cur_level.bytes);
3252       break;
3253     case PROP_CUR_LEVEL_BUFFERS:
3254       g_value_set_uint (value, queue->cur_level.buffers);
3255       break;
3256     case PROP_CUR_LEVEL_TIME:
3257       g_value_set_uint64 (value, queue->cur_level.time);
3258       break;
3259     case PROP_MAX_SIZE_BYTES:
3260       g_value_set_uint (value, queue->max_level.bytes);
3261       break;
3262     case PROP_MAX_SIZE_BUFFERS:
3263       g_value_set_uint (value, queue->max_level.buffers);
3264       break;
3265     case PROP_MAX_SIZE_TIME:
3266       g_value_set_uint64 (value, queue->max_level.time);
3267       break;
3268     case PROP_USE_BUFFERING:
3269       g_value_set_boolean (value, queue->use_buffering);
3270       break;
3271     case PROP_USE_RATE_ESTIMATE:
3272       g_value_set_boolean (value, queue->use_rate_estimate);
3273       break;
3274     case PROP_LOW_PERCENT:
3275       g_value_set_int (value, queue->low_percent);
3276       break;
3277     case PROP_HIGH_PERCENT:
3278       g_value_set_int (value, queue->high_percent);
3279       break;
3280     case PROP_TEMP_TEMPLATE:
3281       g_value_set_string (value, queue->temp_template);
3282       break;
3283     case PROP_TEMP_LOCATION:
3284       g_value_set_string (value, queue->temp_location);
3285       break;
3286     case PROP_TEMP_REMOVE:
3287       g_value_set_boolean (value, queue->temp_remove);
3288       break;
3289     case PROP_RING_BUFFER_MAX_SIZE:
3290       g_value_set_uint64 (value, queue->ring_buffer_max_size);
3291       break;
3292     default:
3293       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
3294       break;
3295   }
3297   GST_QUEUE2_MUTEX_UNLOCK (queue);