Merge branch 'master' into 0.11
[platform/upstream/gstreamer.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  */
25
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  */
56
57 #ifdef HAVE_CONFIG_H
58 #include "config.h"
59 #endif
60
61 #include "gstqueue2.h"
62
63 #include <glib/gstdio.h>
64
65 #include "gst/gst-i18n-lib.h"
66
67 #include <string.h>
68
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
78
79 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
80     GST_PAD_SINK,
81     GST_PAD_ALWAYS,
82     GST_STATIC_CAPS_ANY);
83
84 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
85     GST_PAD_SRC,
86     GST_PAD_ALWAYS,
87     GST_STATIC_CAPS_ANY);
88
89 GST_DEBUG_CATEGORY_STATIC (queue_debug);
90 #define GST_CAT_DEFAULT (queue_debug)
91 GST_DEBUG_CATEGORY_STATIC (queue_dataflow);
92
93 enum
94 {
95   LAST_SIGNAL
96 };
97
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))
103
104 #define QUEUE_MAX_BYTES(queue) MIN((queue)->max_level.bytes, (queue)->ring_buffer_max_size)
105
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
116
117 enum
118 {
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 };
136
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
143
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))
159
160 #define GST_QUEUE2_MUTEX_LOCK(q) G_STMT_START {                          \
161   g_mutex_lock (q->qlock);                                              \
162 } G_STMT_END
163
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
169
170 #define GST_QUEUE2_MUTEX_UNLOCK(q) G_STMT_START {                        \
171   g_mutex_unlock (q->qlock);                                            \
172 } G_STMT_END
173
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
185
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
197
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
204
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
211
212 #define _do_init \
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");
216 #define gst_queue2_parent_class parent_class
217 G_DEFINE_TYPE_WITH_CODE (GstQueue2, gst_queue2, GST_TYPE_ELEMENT, _do_init);
218
219 static void gst_queue2_finalize (GObject * object);
220
221 static void gst_queue2_set_property (GObject * object,
222     guint prop_id, const GValue * value, GParamSpec * pspec);
223 static void gst_queue2_get_property (GObject * object,
224     guint prop_id, GValue * value, GParamSpec * pspec);
225
226 static GstFlowReturn gst_queue2_chain (GstPad * pad, GstBuffer * buffer);
227 static GstFlowReturn gst_queue2_push_one (GstQueue2 * queue);
228 static void gst_queue2_loop (GstPad * pad);
229
230 static gboolean gst_queue2_handle_sink_event (GstPad * pad, GstEvent * event);
231
232 static gboolean gst_queue2_handle_src_event (GstPad * pad, GstEvent * event);
233 static gboolean gst_queue2_handle_src_query (GstPad * pad, GstQuery * query);
234 static gboolean gst_queue2_handle_query (GstElement * element,
235     GstQuery * query);
236
237 static GstCaps *gst_queue2_getcaps (GstPad * pad);
238 static gboolean gst_queue2_acceptcaps (GstPad * pad, GstCaps * caps);
239
240 static GstFlowReturn gst_queue2_get_range (GstPad * pad, guint64 offset,
241     guint length, GstBuffer ** buffer);
242 static gboolean gst_queue2_src_checkgetrange_function (GstPad * pad);
243
244 static gboolean gst_queue2_src_activate_pull (GstPad * pad, gboolean active);
245 static gboolean gst_queue2_src_activate_push (GstPad * pad, gboolean active);
246 static gboolean gst_queue2_sink_activate_push (GstPad * pad, gboolean active);
247 static GstStateChangeReturn gst_queue2_change_state (GstElement * element,
248     GstStateChange transition);
249
250 static gboolean gst_queue2_is_empty (GstQueue2 * queue);
251 static gboolean gst_queue2_is_filled (GstQueue2 * queue);
252
253 static void update_cur_level (GstQueue2 * queue, GstQueue2Range * range);
254
255 /* static guint gst_queue2_signals[LAST_SIGNAL] = { 0 }; */
256
257 static void
258 gst_queue2_class_init (GstQueue2Class * klass)
259 {
260   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
261   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
262
263   gobject_class->set_property = gst_queue2_set_property;
264   gobject_class->get_property = gst_queue2_get_property;
265
266   /* properties */
267   g_object_class_install_property (gobject_class, PROP_CUR_LEVEL_BYTES,
268       g_param_spec_uint ("current-level-bytes", "Current level (kB)",
269           "Current amount of data in the queue (bytes)",
270           0, G_MAXUINT, 0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
271   g_object_class_install_property (gobject_class, PROP_CUR_LEVEL_BUFFERS,
272       g_param_spec_uint ("current-level-buffers", "Current level (buffers)",
273           "Current number of buffers in the queue",
274           0, G_MAXUINT, 0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
275   g_object_class_install_property (gobject_class, PROP_CUR_LEVEL_TIME,
276       g_param_spec_uint64 ("current-level-time", "Current level (ns)",
277           "Current amount of data in the queue (in ns)",
278           0, G_MAXUINT64, 0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
279
280   g_object_class_install_property (gobject_class, PROP_MAX_SIZE_BYTES,
281       g_param_spec_uint ("max-size-bytes", "Max. size (kB)",
282           "Max. amount of data in the queue (bytes, 0=disable)",
283           0, G_MAXUINT, DEFAULT_MAX_SIZE_BYTES,
284           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
285   g_object_class_install_property (gobject_class, PROP_MAX_SIZE_BUFFERS,
286       g_param_spec_uint ("max-size-buffers", "Max. size (buffers)",
287           "Max. number of buffers in the queue (0=disable)", 0, G_MAXUINT,
288           DEFAULT_MAX_SIZE_BUFFERS,
289           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
290   g_object_class_install_property (gobject_class, PROP_MAX_SIZE_TIME,
291       g_param_spec_uint64 ("max-size-time", "Max. size (ns)",
292           "Max. amount of data in the queue (in ns, 0=disable)", 0, G_MAXUINT64,
293           DEFAULT_MAX_SIZE_TIME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
294
295   g_object_class_install_property (gobject_class, PROP_USE_BUFFERING,
296       g_param_spec_boolean ("use-buffering", "Use buffering",
297           "Emit GST_MESSAGE_BUFFERING based on low-/high-percent thresholds",
298           DEFAULT_USE_BUFFERING, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
299   g_object_class_install_property (gobject_class, PROP_USE_RATE_ESTIMATE,
300       g_param_spec_boolean ("use-rate-estimate", "Use Rate Estimate",
301           "Estimate the bitrate of the stream to calculate time level",
302           DEFAULT_USE_RATE_ESTIMATE,
303           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
304   g_object_class_install_property (gobject_class, PROP_LOW_PERCENT,
305       g_param_spec_int ("low-percent", "Low percent",
306           "Low threshold for buffering to start. Only used if use-buffering is True",
307           0, 100, DEFAULT_LOW_PERCENT,
308           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
309   g_object_class_install_property (gobject_class, PROP_HIGH_PERCENT,
310       g_param_spec_int ("high-percent", "High percent",
311           "High threshold for buffering to finish. Only used if use-buffering is True",
312           0, 100, DEFAULT_HIGH_PERCENT,
313           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
314
315   g_object_class_install_property (gobject_class, PROP_TEMP_TEMPLATE,
316       g_param_spec_string ("temp-template", "Temporary File Template",
317           "File template to store temporary files in, should contain directory "
318           "and XXXXXX. (NULL == disabled)",
319           NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
320
321   g_object_class_install_property (gobject_class, PROP_TEMP_LOCATION,
322       g_param_spec_string ("temp-location", "Temporary File Location",
323           "Location to store temporary files in (Deprecated: Only read this "
324           "property, use temp-template to configure the name template)",
325           NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
326
327   /**
328    * GstQueue2:temp-remove
329    *
330    * When temp-template is set, remove the temporary file when going to READY.
331    *
332    * Since: 0.10.26
333    */
334   g_object_class_install_property (gobject_class, PROP_TEMP_REMOVE,
335       g_param_spec_boolean ("temp-remove", "Remove the Temporary File",
336           "Remove the temp-location after use",
337           DEFAULT_TEMP_REMOVE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
338
339   /**
340    * GstQueue2:ring-buffer-max-size
341    *
342    * The maximum size of the ring buffer in bytes. If set to 0, the ring
343    * buffer is disabled. Default 0.
344    *
345    * Since: 0.10.31
346    */
347   g_object_class_install_property (gobject_class, PROP_RING_BUFFER_MAX_SIZE,
348       g_param_spec_uint64 ("ring-buffer-max-size",
349           "Max. ring buffer size (bytes)",
350           "Max. amount of data in the ring buffer (bytes, 0 = disabled)",
351           0, G_MAXUINT64, DEFAULT_RING_BUFFER_MAX_SIZE,
352           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
353
354   /* set several parent class virtual functions */
355   gobject_class->finalize = gst_queue2_finalize;
356
357   gst_element_class_add_pad_template (gstelement_class,
358       gst_static_pad_template_get (&srctemplate));
359   gst_element_class_add_pad_template (gstelement_class,
360       gst_static_pad_template_get (&sinktemplate));
361
362   gst_element_class_set_details_simple (gstelement_class, "Queue 2",
363       "Generic",
364       "Simple data queue",
365       "Erik Walthinsen <omega@cse.ogi.edu>, "
366       "Wim Taymans <wim.taymans@gmail.com>");
367
368   gstelement_class->change_state = GST_DEBUG_FUNCPTR (gst_queue2_change_state);
369   gstelement_class->query = GST_DEBUG_FUNCPTR (gst_queue2_handle_query);
370 }
371
372 static void
373 gst_queue2_init (GstQueue2 * queue)
374 {
375   queue->sinkpad = gst_pad_new_from_static_template (&sinktemplate, "sink");
376
377   gst_pad_set_chain_function (queue->sinkpad,
378       GST_DEBUG_FUNCPTR (gst_queue2_chain));
379   gst_pad_set_activatepush_function (queue->sinkpad,
380       GST_DEBUG_FUNCPTR (gst_queue2_sink_activate_push));
381   gst_pad_set_event_function (queue->sinkpad,
382       GST_DEBUG_FUNCPTR (gst_queue2_handle_sink_event));
383   gst_pad_set_getcaps_function (queue->sinkpad,
384       GST_DEBUG_FUNCPTR (gst_queue2_getcaps));
385   gst_pad_set_acceptcaps_function (queue->sinkpad,
386       GST_DEBUG_FUNCPTR (gst_queue2_acceptcaps));
387   gst_element_add_pad (GST_ELEMENT (queue), queue->sinkpad);
388
389   queue->srcpad = gst_pad_new_from_static_template (&srctemplate, "src");
390
391   gst_pad_set_activatepull_function (queue->srcpad,
392       GST_DEBUG_FUNCPTR (gst_queue2_src_activate_pull));
393   gst_pad_set_activatepush_function (queue->srcpad,
394       GST_DEBUG_FUNCPTR (gst_queue2_src_activate_push));
395   gst_pad_set_getrange_function (queue->srcpad,
396       GST_DEBUG_FUNCPTR (gst_queue2_get_range));
397   gst_pad_set_checkgetrange_function (queue->srcpad,
398       GST_DEBUG_FUNCPTR (gst_queue2_src_checkgetrange_function));
399   gst_pad_set_getcaps_function (queue->srcpad,
400       GST_DEBUG_FUNCPTR (gst_queue2_getcaps));
401   gst_pad_set_acceptcaps_function (queue->srcpad,
402       GST_DEBUG_FUNCPTR (gst_queue2_acceptcaps));
403   gst_pad_set_event_function (queue->srcpad,
404       GST_DEBUG_FUNCPTR (gst_queue2_handle_src_event));
405   gst_pad_set_query_function (queue->srcpad,
406       GST_DEBUG_FUNCPTR (gst_queue2_handle_src_query));
407   gst_element_add_pad (GST_ELEMENT (queue), queue->srcpad);
408
409   /* levels */
410   GST_QUEUE2_CLEAR_LEVEL (queue->cur_level);
411   queue->max_level.buffers = DEFAULT_MAX_SIZE_BUFFERS;
412   queue->max_level.bytes = DEFAULT_MAX_SIZE_BYTES;
413   queue->max_level.time = DEFAULT_MAX_SIZE_TIME;
414   queue->max_level.rate_time = DEFAULT_MAX_SIZE_TIME;
415   queue->use_buffering = DEFAULT_USE_BUFFERING;
416   queue->use_rate_estimate = DEFAULT_USE_RATE_ESTIMATE;
417   queue->low_percent = DEFAULT_LOW_PERCENT;
418   queue->high_percent = DEFAULT_HIGH_PERCENT;
419
420   gst_segment_init (&queue->sink_segment, GST_FORMAT_TIME);
421   gst_segment_init (&queue->src_segment, GST_FORMAT_TIME);
422
423   queue->sinktime = GST_CLOCK_TIME_NONE;
424   queue->srctime = GST_CLOCK_TIME_NONE;
425   queue->sink_tainted = TRUE;
426   queue->src_tainted = TRUE;
427
428   queue->srcresult = GST_FLOW_WRONG_STATE;
429   queue->sinkresult = GST_FLOW_WRONG_STATE;
430   queue->is_eos = FALSE;
431   queue->in_timer = g_timer_new ();
432   queue->out_timer = g_timer_new ();
433
434   queue->qlock = g_mutex_new ();
435   queue->waiting_add = FALSE;
436   queue->item_add = g_cond_new ();
437   queue->waiting_del = FALSE;
438   queue->item_del = g_cond_new ();
439   queue->queue = g_queue_new ();
440
441   queue->buffering_percent = 100;
442
443   /* tempfile related */
444   queue->temp_template = NULL;
445   queue->temp_location = NULL;
446   queue->temp_location_set = FALSE;
447   queue->temp_remove = DEFAULT_TEMP_REMOVE;
448
449   queue->ring_buffer = NULL;
450   queue->ring_buffer_max_size = DEFAULT_RING_BUFFER_MAX_SIZE;
451
452   GST_DEBUG_OBJECT (queue,
453       "initialized queue's not_empty & not_full conditions");
454 }
455
456 /* called only once, as opposed to dispose */
457 static void
458 gst_queue2_finalize (GObject * object)
459 {
460   GstQueue2 *queue = GST_QUEUE2 (object);
461
462   GST_DEBUG_OBJECT (queue, "finalizing queue");
463
464   while (!g_queue_is_empty (queue->queue)) {
465     GstMiniObject *data = g_queue_pop_head (queue->queue);
466
467     gst_mini_object_unref (data);
468   }
469
470   g_queue_free (queue->queue);
471   g_mutex_free (queue->qlock);
472   g_cond_free (queue->item_add);
473   g_cond_free (queue->item_del);
474   g_timer_destroy (queue->in_timer);
475   g_timer_destroy (queue->out_timer);
476
477   /* temp_file path cleanup  */
478   g_free (queue->temp_template);
479   g_free (queue->temp_location);
480
481   G_OBJECT_CLASS (parent_class)->finalize (object);
482 }
483
484 static void
485 debug_ranges (GstQueue2 * queue)
486 {
487   GstQueue2Range *walk;
488
489   for (walk = queue->ranges; walk; walk = walk->next) {
490     GST_DEBUG_OBJECT (queue,
491         "range [%" G_GUINT64_FORMAT "-%" G_GUINT64_FORMAT "] (rb [%"
492         G_GUINT64_FORMAT "-%" G_GUINT64_FORMAT "]), reading %" G_GUINT64_FORMAT
493         " current range? %s", walk->offset, walk->writing_pos, walk->rb_offset,
494         walk->rb_writing_pos, walk->reading_pos,
495         walk == queue->current ? "**y**" : "  n  ");
496   }
497 }
498
499 /* clear all the downloaded ranges */
500 static void
501 clean_ranges (GstQueue2 * queue)
502 {
503   GST_DEBUG_OBJECT (queue, "clean queue ranges");
504
505   g_slice_free_chain (GstQueue2Range, queue->ranges, next);
506   queue->ranges = NULL;
507   queue->current = NULL;
508 }
509
510 /* find a range that contains @offset or NULL when nothing does */
511 static GstQueue2Range *
512 find_range (GstQueue2 * queue, guint64 offset)
513 {
514   GstQueue2Range *range = NULL;
515   GstQueue2Range *walk;
516
517   /* first do a quick check for the current range */
518   for (walk = queue->ranges; walk; walk = walk->next) {
519     if (offset >= walk->offset && offset <= walk->writing_pos) {
520       /* we can reuse an existing range */
521       range = walk;
522       break;
523     }
524   }
525   if (range) {
526     GST_DEBUG_OBJECT (queue,
527         "found range for %" G_GUINT64_FORMAT ": [%" G_GUINT64_FORMAT "-%"
528         G_GUINT64_FORMAT "]", offset, range->offset, range->writing_pos);
529   } else {
530     GST_DEBUG_OBJECT (queue, "no range for %" G_GUINT64_FORMAT, offset);
531   }
532   return range;
533 }
534
535 static void
536 update_cur_level (GstQueue2 * queue, GstQueue2Range * range)
537 {
538   guint64 max_reading_pos, writing_pos;
539
540   writing_pos = range->writing_pos;
541   max_reading_pos = range->max_reading_pos;
542
543   if (writing_pos > max_reading_pos)
544     queue->cur_level.bytes = writing_pos - max_reading_pos;
545   else
546     queue->cur_level.bytes = 0;
547 }
548
549 /* make a new range for @offset or reuse an existing range */
550 static GstQueue2Range *
551 add_range (GstQueue2 * queue, guint64 offset)
552 {
553   GstQueue2Range *range, *prev, *next;
554
555   GST_DEBUG_OBJECT (queue, "find range for %" G_GUINT64_FORMAT, offset);
556
557   if ((range = find_range (queue, offset))) {
558     GST_DEBUG_OBJECT (queue,
559         "reusing range %" G_GUINT64_FORMAT "-%" G_GUINT64_FORMAT, range->offset,
560         range->writing_pos);
561     range->writing_pos = offset;
562   } else {
563     GST_DEBUG_OBJECT (queue,
564         "new range %" G_GUINT64_FORMAT "-%" G_GUINT64_FORMAT, offset, offset);
565
566     range = g_slice_new0 (GstQueue2Range);
567     range->offset = offset;
568     /* we want to write to the next location in the ring buffer */
569     range->rb_offset = queue->current ? queue->current->rb_writing_pos : 0;
570     range->writing_pos = offset;
571     range->rb_writing_pos = range->rb_offset;
572     range->reading_pos = offset;
573     range->max_reading_pos = offset;
574
575     /* insert sorted */
576     prev = NULL;
577     next = queue->ranges;
578     while (next) {
579       if (next->offset > offset) {
580         /* insert before next */
581         GST_DEBUG_OBJECT (queue,
582             "insert before range %p, offset %" G_GUINT64_FORMAT, next,
583             next->offset);
584         break;
585       }
586       /* try next */
587       prev = next;
588       next = next->next;
589     }
590     range->next = next;
591     if (prev)
592       prev->next = range;
593     else
594       queue->ranges = range;
595   }
596   debug_ranges (queue);
597
598   /* update the stats for this range */
599   update_cur_level (queue, range);
600
601   return range;
602 }
603
604
605 /* clear and init the download ranges for offset 0 */
606 static void
607 init_ranges (GstQueue2 * queue)
608 {
609   GST_DEBUG_OBJECT (queue, "init queue ranges");
610
611   /* get rid of all the current ranges */
612   clean_ranges (queue);
613   /* make a range for offset 0 */
614   queue->current = add_range (queue, 0);
615 }
616
617 static gboolean
618 gst_queue2_acceptcaps (GstPad * pad, GstCaps * caps)
619 {
620   GstQueue2 *queue;
621   GstPad *otherpad;
622   gboolean result;
623
624   queue = GST_QUEUE2 (GST_PAD_PARENT (pad));
625
626   otherpad = (pad == queue->srcpad ? queue->sinkpad : queue->srcpad);
627   result = gst_pad_peer_accept_caps (otherpad, caps);
628
629   return result;
630 }
631
632 static GstCaps *
633 gst_queue2_getcaps (GstPad * pad)
634 {
635   GstQueue2 *queue;
636   GstPad *otherpad;
637   GstCaps *result;
638
639   queue = GST_QUEUE2 (gst_pad_get_parent (pad));
640   if (G_UNLIKELY (queue == NULL))
641     return gst_caps_new_any ();
642
643   otherpad = (pad == queue->srcpad ? queue->sinkpad : queue->srcpad);
644   result = gst_pad_peer_get_caps (otherpad);
645   if (result == NULL)
646     result = gst_caps_new_any ();
647
648   gst_object_unref (queue);
649
650   return result;
651 }
652
653 /* calculate the diff between running time on the sink and src of the queue.
654  * This is the total amount of time in the queue. */
655 static void
656 update_time_level (GstQueue2 * queue)
657 {
658   if (queue->sink_tainted) {
659     queue->sinktime =
660         gst_segment_to_running_time (&queue->sink_segment, GST_FORMAT_TIME,
661         queue->sink_segment.last_stop);
662     queue->sink_tainted = FALSE;
663   }
664
665   if (queue->src_tainted) {
666     queue->srctime =
667         gst_segment_to_running_time (&queue->src_segment, GST_FORMAT_TIME,
668         queue->src_segment.last_stop);
669     queue->src_tainted = FALSE;
670   }
671
672   GST_DEBUG_OBJECT (queue, "sink %" GST_TIME_FORMAT ", src %" GST_TIME_FORMAT,
673       GST_TIME_ARGS (queue->sinktime), GST_TIME_ARGS (queue->srctime));
674
675   if (queue->sinktime != GST_CLOCK_TIME_NONE
676       && queue->srctime != GST_CLOCK_TIME_NONE
677       && queue->sinktime >= queue->srctime)
678     queue->cur_level.time = queue->sinktime - queue->srctime;
679   else
680     queue->cur_level.time = 0;
681 }
682
683 /* take a NEWSEGMENT event and apply the values to segment, updating the time
684  * level of queue. */
685 static void
686 apply_segment (GstQueue2 * queue, GstEvent * event, GstSegment * segment,
687     gboolean is_sink)
688 {
689   gboolean update;
690   GstFormat format;
691   gdouble rate, arate;
692   gint64 start, stop, time;
693
694   gst_event_parse_new_segment_full (event, &update, &rate, &arate,
695       &format, &start, &stop, &time);
696
697   GST_DEBUG_OBJECT (queue,
698       "received NEWSEGMENT update %d, rate %lf, applied rate %lf, "
699       "format %d, "
700       "%" G_GINT64_FORMAT " -- %" G_GINT64_FORMAT ", time %"
701       G_GINT64_FORMAT, update, rate, arate, format, start, stop, time);
702
703   if (format == GST_FORMAT_BYTES) {
704     if (QUEUE_IS_USING_TEMP_FILE (queue)) {
705       /* start is where we'll be getting from and as such writing next */
706       queue->current = add_range (queue, start);
707       /* update the stats for this range */
708       update_cur_level (queue, queue->current);
709     }
710   }
711
712   /* now configure the values, we use these to track timestamps on the
713    * sinkpad. */
714   if (format != GST_FORMAT_TIME) {
715     /* non-time format, pretent the current time segment is closed with a
716      * 0 start and unknown stop time. */
717     update = FALSE;
718     format = GST_FORMAT_TIME;
719     start = 0;
720     stop = -1;
721     time = 0;
722   }
723   gst_segment_set_newsegment_full (segment, update,
724       rate, arate, format, start, stop, time);
725
726   GST_DEBUG_OBJECT (queue,
727       "configured NEWSEGMENT %" GST_SEGMENT_FORMAT, segment);
728
729   if (is_sink)
730     queue->sink_tainted = TRUE;
731   else
732     queue->src_tainted = TRUE;
733
734   /* segment can update the time level of the queue */
735   update_time_level (queue);
736 }
737
738 /* take a buffer and update segment, updating the time level of the queue. */
739 static void
740 apply_buffer (GstQueue2 * queue, GstBuffer * buffer, GstSegment * segment,
741     gboolean is_sink)
742 {
743   GstClockTime duration, timestamp;
744
745   timestamp = GST_BUFFER_TIMESTAMP (buffer);
746   duration = GST_BUFFER_DURATION (buffer);
747
748   /* if no timestamp is set, assume it's continuous with the previous
749    * time */
750   if (timestamp == GST_CLOCK_TIME_NONE)
751     timestamp = segment->last_stop;
752
753   /* add duration */
754   if (duration != GST_CLOCK_TIME_NONE)
755     timestamp += duration;
756
757   GST_DEBUG_OBJECT (queue, "last_stop updated to %" GST_TIME_FORMAT,
758       GST_TIME_ARGS (timestamp));
759
760   gst_segment_set_last_stop (segment, GST_FORMAT_TIME, timestamp);
761
762   if (is_sink)
763     queue->sink_tainted = TRUE;
764   else
765     queue->src_tainted = TRUE;
766
767   /* calc diff with other end */
768   update_time_level (queue);
769 }
770
771 static void
772 update_buffering (GstQueue2 * queue)
773 {
774   gint64 percent;
775   gboolean post = FALSE;
776
777   if (queue->high_percent <= 0)
778     return;
779
780 #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)
781
782   if (queue->is_eos) {
783     /* on EOS we are always 100% full, we set the var here so that it we can
784      * reuse the logic below to stop buffering */
785     percent = 100;
786     GST_LOG_OBJECT (queue, "we are EOS");
787   } else {
788     /* figure out the percent we are filled, we take the max of all formats. */
789
790     if (!QUEUE_IS_USING_RING_BUFFER (queue)) {
791       percent = GET_PERCENT (bytes, 0);
792     } else {
793       guint64 rb_size = queue->ring_buffer_max_size;
794       percent = GET_PERCENT (bytes, rb_size);
795     }
796     percent = MAX (percent, GET_PERCENT (time, 0));
797     percent = MAX (percent, GET_PERCENT (buffers, 0));
798
799     /* also apply the rate estimate when we need to */
800     if (queue->use_rate_estimate)
801       percent = MAX (percent, GET_PERCENT (rate_time, 0));
802   }
803
804   if (queue->is_buffering) {
805     post = TRUE;
806     /* if we were buffering see if we reached the high watermark */
807     if (percent >= queue->high_percent)
808       queue->is_buffering = FALSE;
809   } else {
810     /* we were not buffering, check if we need to start buffering if we drop
811      * below the low threshold */
812     if (percent < queue->low_percent) {
813       queue->is_buffering = TRUE;
814       queue->buffering_iteration++;
815       post = TRUE;
816     }
817   }
818   if (post) {
819     GstMessage *message;
820     GstBufferingMode mode;
821     gint64 buffering_left = -1;
822
823     /* scale to high percent so that it becomes the 100% mark */
824     percent = percent * 100 / queue->high_percent;
825     /* clip */
826     if (percent > 100)
827       percent = 100;
828
829     if (percent != queue->buffering_percent) {
830       queue->buffering_percent = percent;
831
832       if (!QUEUE_IS_USING_QUEUE (queue)) {
833         GstFormat fmt = GST_FORMAT_BYTES;
834         gint64 duration;
835
836         if (QUEUE_IS_USING_RING_BUFFER (queue))
837           mode = GST_BUFFERING_TIMESHIFT;
838         else
839           mode = GST_BUFFERING_DOWNLOAD;
840
841         if (queue->byte_in_rate > 0) {
842           if (gst_pad_query_peer_duration (queue->sinkpad, &fmt, &duration))
843             buffering_left =
844                 (gdouble) ((duration -
845                     queue->current->writing_pos) * 1000) / queue->byte_in_rate;
846         } else {
847           buffering_left = G_MAXINT64;
848         }
849       } else {
850         mode = GST_BUFFERING_STREAM;
851       }
852
853       GST_DEBUG_OBJECT (queue, "buffering %d percent", (gint) percent);
854       message = gst_message_new_buffering (GST_OBJECT_CAST (queue),
855           (gint) percent);
856       gst_message_set_buffering_stats (message, mode,
857           queue->byte_in_rate, queue->byte_out_rate, buffering_left);
858
859       gst_element_post_message (GST_ELEMENT_CAST (queue), message);
860     }
861   } else {
862     GST_DEBUG_OBJECT (queue, "filled %d percent", (gint) percent);
863   }
864
865 #undef GET_PERCENT
866 }
867
868 static void
869 reset_rate_timer (GstQueue2 * queue)
870 {
871   queue->bytes_in = 0;
872   queue->bytes_out = 0;
873   queue->byte_in_rate = 0.0;
874   queue->byte_out_rate = 0.0;
875   queue->last_in_elapsed = 0.0;
876   queue->last_out_elapsed = 0.0;
877   queue->in_timer_started = FALSE;
878   queue->out_timer_started = FALSE;
879 }
880
881 /* the interval in seconds to recalculate the rate */
882 #define RATE_INTERVAL    0.2
883 /* Tuning for rate estimation. We use a large window for the input rate because
884  * it should be stable when connected to a network. The output rate is less
885  * stable (the elements preroll, queues behind a demuxer fill, ...) and should
886  * therefore adapt more quickly. */
887 #define AVG_IN(avg,val)  ((avg) * 15.0 + (val)) / 16.0
888 #define AVG_OUT(avg,val) ((avg) * 3.0 + (val)) / 4.0
889
890 static void
891 update_in_rates (GstQueue2 * queue)
892 {
893   gdouble elapsed, period;
894   gdouble byte_in_rate;
895
896   if (!queue->in_timer_started) {
897     queue->in_timer_started = TRUE;
898     g_timer_start (queue->in_timer);
899     return;
900   }
901
902   elapsed = g_timer_elapsed (queue->in_timer, NULL);
903
904   /* recalc after each interval. */
905   if (queue->last_in_elapsed + RATE_INTERVAL < elapsed) {
906     period = elapsed - queue->last_in_elapsed;
907
908     GST_DEBUG_OBJECT (queue,
909         "rates: period %f, in %" G_GUINT64_FORMAT, period, queue->bytes_in);
910
911     byte_in_rate = queue->bytes_in / period;
912
913     if (queue->byte_in_rate == 0.0)
914       queue->byte_in_rate = byte_in_rate;
915     else
916       queue->byte_in_rate = AVG_IN (queue->byte_in_rate, byte_in_rate);
917
918     /* reset the values to calculate rate over the next interval */
919     queue->last_in_elapsed = elapsed;
920     queue->bytes_in = 0;
921   }
922
923   if (queue->byte_in_rate > 0.0) {
924     queue->cur_level.rate_time =
925         queue->cur_level.bytes / queue->byte_in_rate * GST_SECOND;
926   }
927   GST_DEBUG_OBJECT (queue, "rates: in %f, time %" GST_TIME_FORMAT,
928       queue->byte_in_rate, GST_TIME_ARGS (queue->cur_level.rate_time));
929 }
930
931 static void
932 update_out_rates (GstQueue2 * queue)
933 {
934   gdouble elapsed, period;
935   gdouble byte_out_rate;
936
937   if (!queue->out_timer_started) {
938     queue->out_timer_started = TRUE;
939     g_timer_start (queue->out_timer);
940     return;
941   }
942
943   elapsed = g_timer_elapsed (queue->out_timer, NULL);
944
945   /* recalc after each interval. */
946   if (queue->last_out_elapsed + RATE_INTERVAL < elapsed) {
947     period = elapsed - queue->last_out_elapsed;
948
949     GST_DEBUG_OBJECT (queue,
950         "rates: period %f, out %" G_GUINT64_FORMAT, period, queue->bytes_out);
951
952     byte_out_rate = queue->bytes_out / period;
953
954     if (queue->byte_out_rate == 0.0)
955       queue->byte_out_rate = byte_out_rate;
956     else
957       queue->byte_out_rate = AVG_OUT (queue->byte_out_rate, byte_out_rate);
958
959     /* reset the values to calculate rate over the next interval */
960     queue->last_out_elapsed = elapsed;
961     queue->bytes_out = 0;
962   }
963   if (queue->byte_in_rate > 0.0) {
964     queue->cur_level.rate_time =
965         queue->cur_level.bytes / queue->byte_in_rate * GST_SECOND;
966   }
967   GST_DEBUG_OBJECT (queue, "rates: out %f, time %" GST_TIME_FORMAT,
968       queue->byte_out_rate, GST_TIME_ARGS (queue->cur_level.rate_time));
969 }
970
971 static void
972 update_cur_pos (GstQueue2 * queue, GstQueue2Range * range, guint64 pos)
973 {
974   guint64 reading_pos, max_reading_pos;
975
976   reading_pos = pos;
977   max_reading_pos = range->max_reading_pos;
978
979   max_reading_pos = MAX (max_reading_pos, reading_pos);
980
981   GST_DEBUG_OBJECT (queue,
982       "updating max_reading_pos from %" G_GUINT64_FORMAT " to %"
983       G_GUINT64_FORMAT, range->max_reading_pos, max_reading_pos);
984   range->max_reading_pos = max_reading_pos;
985
986   update_cur_level (queue, range);
987 }
988
989 static gboolean
990 perform_seek_to_offset (GstQueue2 * queue, guint64 offset)
991 {
992   GstEvent *event;
993   gboolean res;
994
995   GST_QUEUE2_MUTEX_UNLOCK (queue);
996
997   GST_DEBUG_OBJECT (queue, "Seeking to %" G_GUINT64_FORMAT, offset);
998
999   event =
1000       gst_event_new_seek (1.0, GST_FORMAT_BYTES,
1001       GST_SEEK_FLAG_FLUSH | GST_SEEK_FLAG_ACCURATE, GST_SEEK_TYPE_SET, offset,
1002       GST_SEEK_TYPE_NONE, -1);
1003
1004   res = gst_pad_push_event (queue->sinkpad, event);
1005   GST_QUEUE2_MUTEX_LOCK (queue);
1006
1007   if (res)
1008     queue->current = add_range (queue, offset);
1009
1010   return res;
1011 }
1012
1013 /* see if there is enough data in the file to read a full buffer */
1014 static gboolean
1015 gst_queue2_have_data (GstQueue2 * queue, guint64 offset, guint length)
1016 {
1017   GstQueue2Range *range;
1018
1019   GST_DEBUG_OBJECT (queue, "looking for offset %" G_GUINT64_FORMAT ", len %u",
1020       offset, length);
1021
1022   if ((range = find_range (queue, offset))) {
1023     if (queue->current != range) {
1024       GST_DEBUG_OBJECT (queue, "switching ranges, do seek to range position");
1025       perform_seek_to_offset (queue, range->writing_pos);
1026     }
1027
1028     GST_INFO_OBJECT (queue, "cur_level.bytes %u (max %" G_GUINT64_FORMAT ")",
1029         queue->cur_level.bytes, QUEUE_MAX_BYTES (queue));
1030
1031     /* we have a range for offset */
1032     GST_DEBUG_OBJECT (queue,
1033         "we have a range %p, offset %" G_GUINT64_FORMAT ", writing_pos %"
1034         G_GUINT64_FORMAT, range, range->offset, range->writing_pos);
1035
1036     if (!QUEUE_IS_USING_RING_BUFFER (queue) && queue->is_eos)
1037       return TRUE;
1038
1039     if (offset + length <= range->writing_pos)
1040       return TRUE;
1041     else
1042       GST_DEBUG_OBJECT (queue,
1043           "Need more data (%" G_GUINT64_FORMAT " bytes more)",
1044           (offset + length) - range->writing_pos);
1045
1046   } else {
1047     GST_INFO_OBJECT (queue, "not found in any range");
1048     /* we don't have the range, see how far away we are, FIXME, find a good
1049      * threshold based on the incomming rate. */
1050     if (!queue->is_eos && queue->current) {
1051       if (QUEUE_IS_USING_RING_BUFFER (queue)) {
1052         if (offset < queue->current->offset || offset >
1053             queue->current->writing_pos + QUEUE_MAX_BYTES (queue) -
1054             queue->cur_level.bytes) {
1055           perform_seek_to_offset (queue, offset);
1056         } else {
1057           GST_INFO_OBJECT (queue,
1058               "requested data is within range, wait for data");
1059         }
1060       } else if (offset < queue->current->writing_pos + 200000) {
1061         update_cur_pos (queue, queue->current, offset + length);
1062         GST_INFO_OBJECT (queue, "wait for data");
1063         return FALSE;
1064       }
1065     }
1066
1067     /* too far away, do a seek */
1068     perform_seek_to_offset (queue, offset);
1069   }
1070
1071   return FALSE;
1072 }
1073
1074 #ifdef HAVE_FSEEKO
1075 #define FSEEK_FILE(file,offset)  (fseeko (file, (off_t) offset, SEEK_SET) != 0)
1076 #elif defined (G_OS_UNIX) || defined (G_OS_WIN32)
1077 #define FSEEK_FILE(file,offset)  (lseek (fileno (file), (off_t) offset, SEEK_SET) == (off_t) -1)
1078 #else
1079 #define FSEEK_FILE(file,offset)  (fseek (file, offset, SEEK_SET) != 0)
1080 #endif
1081
1082 static GstFlowReturn
1083 gst_queue2_read_data_at_offset (GstQueue2 * queue, guint64 offset, guint length,
1084     guint8 * dst, gint64 * read_return)
1085 {
1086   guint8 *ring_buffer;
1087   size_t res;
1088
1089   ring_buffer = queue->ring_buffer;
1090
1091   if (QUEUE_IS_USING_TEMP_FILE (queue) && FSEEK_FILE (queue->temp_file, offset))
1092     goto seek_failed;
1093
1094   /* this should not block */
1095   GST_LOG_OBJECT (queue, "Reading %d bytes from offset %" G_GUINT64_FORMAT,
1096       length, offset);
1097   if (QUEUE_IS_USING_TEMP_FILE (queue)) {
1098     res = fread (dst, 1, length, queue->temp_file);
1099   } else {
1100     memcpy (dst, ring_buffer + offset, length);
1101     res = length;
1102   }
1103
1104   GST_LOG_OBJECT (queue, "read %" G_GSIZE_FORMAT " bytes", res);
1105
1106   if (G_UNLIKELY (res < length)) {
1107     if (!QUEUE_IS_USING_TEMP_FILE (queue))
1108       goto could_not_read;
1109     /* check for errors or EOF */
1110     if (ferror (queue->temp_file))
1111       goto could_not_read;
1112     if (feof (queue->temp_file) && length > 0)
1113       goto eos;
1114   }
1115
1116   *read_return = res;
1117
1118   return GST_FLOW_OK;
1119
1120 seek_failed:
1121   {
1122     GST_ELEMENT_ERROR (queue, RESOURCE, SEEK, (NULL), GST_ERROR_SYSTEM);
1123     return GST_FLOW_ERROR;
1124   }
1125 could_not_read:
1126   {
1127     GST_ELEMENT_ERROR (queue, RESOURCE, READ, (NULL), GST_ERROR_SYSTEM);
1128     return GST_FLOW_ERROR;
1129   }
1130 eos:
1131   {
1132     GST_DEBUG ("non-regular file hits EOS");
1133     return GST_FLOW_UNEXPECTED;
1134   }
1135 }
1136
1137 static GstFlowReturn
1138 gst_queue2_create_read (GstQueue2 * queue, guint64 offset, guint length,
1139     GstBuffer ** buffer)
1140 {
1141   GstBuffer *buf;
1142   guint8 *data;
1143   guint64 file_offset;
1144   guint block_length, remaining, read_length;
1145   guint64 rb_size;
1146   guint64 rpos;
1147   GstFlowReturn ret = GST_FLOW_OK;
1148
1149   /* allocate the output buffer of the requested size */
1150   buf = gst_buffer_new_and_alloc (length);
1151   data = gst_buffer_map (buf, NULL, NULL, GST_MAP_WRITE);
1152
1153   GST_DEBUG_OBJECT (queue, "Reading %u bytes from %" G_GUINT64_FORMAT, length,
1154       offset);
1155
1156   rpos = offset;
1157   rb_size = queue->ring_buffer_max_size;
1158
1159   remaining = length;
1160   while (remaining > 0) {
1161     /* configure how much/whether to read */
1162     if (!gst_queue2_have_data (queue, rpos, remaining)) {
1163       read_length = 0;
1164
1165       if (QUEUE_IS_USING_RING_BUFFER (queue)) {
1166         guint64 level;
1167
1168         /* calculate how far away the offset is */
1169         if (queue->current->writing_pos > rpos)
1170           level = queue->current->writing_pos - rpos;
1171         else
1172           level = 0;
1173
1174         GST_DEBUG_OBJECT (queue,
1175             "reading %" G_GUINT64_FORMAT ", writing %" G_GUINT64_FORMAT
1176             ", level %" G_GUINT64_FORMAT,
1177             rpos, queue->current->writing_pos, level);
1178
1179         if (level >= rb_size) {
1180           /* we don't have the data but if we have a ring buffer that is full, we
1181            * need to read */
1182           GST_DEBUG_OBJECT (queue,
1183               "ring buffer full, reading ring-buffer-max-size %"
1184               G_GUINT64_FORMAT " bytes", rb_size);
1185           read_length = rb_size;
1186         } else if (queue->is_eos) {
1187           /* won't get any more data so read any data we have */
1188           if (level) {
1189             GST_DEBUG_OBJECT (queue,
1190                 "EOS hit but read %" G_GUINT64_FORMAT " bytes that we have",
1191                 level);
1192             read_length = level;
1193           } else
1194             goto hit_eos;
1195         }
1196       }
1197
1198       if (read_length == 0) {
1199         if (QUEUE_IS_USING_RING_BUFFER (queue)
1200             && queue->current->max_reading_pos > rpos) {
1201           /* protect cached data (data between offset and max_reading_pos)
1202            * and update current level */
1203           GST_DEBUG_OBJECT (queue,
1204               "protecting cached data [%" G_GUINT64_FORMAT "-%" G_GUINT64_FORMAT
1205               "]", rpos, queue->current->max_reading_pos);
1206           queue->current->max_reading_pos = rpos;
1207           update_cur_level (queue, queue->current);
1208         }
1209         GST_DEBUG_OBJECT (queue, "waiting for add");
1210         GST_QUEUE2_WAIT_ADD_CHECK (queue, queue->srcresult, out_flushing);
1211         continue;
1212       }
1213     } else {
1214       /* we have the requested data so read it */
1215       read_length = remaining;
1216     }
1217
1218     /* set range reading_pos to actual reading position for this read */
1219     queue->current->reading_pos = rpos;
1220
1221     /* congfigure how much and from where to read */
1222     if (QUEUE_IS_USING_RING_BUFFER (queue)) {
1223       file_offset =
1224           (queue->current->rb_offset + (rpos -
1225               queue->current->offset)) % rb_size;
1226       if (file_offset + read_length > rb_size) {
1227         block_length = rb_size - file_offset;
1228       } else {
1229         block_length = read_length;
1230       }
1231     } else {
1232       file_offset = rpos;
1233       block_length = read_length;
1234     }
1235
1236     /* while we still have data to read, we loop */
1237     while (read_length > 0) {
1238       gint64 read_return;
1239
1240       ret =
1241           gst_queue2_read_data_at_offset (queue, file_offset, block_length,
1242           data, &read_return);
1243       if (ret != GST_FLOW_OK)
1244         goto read_error;
1245
1246       file_offset += read_return;
1247       if (QUEUE_IS_USING_RING_BUFFER (queue))
1248         file_offset %= rb_size;
1249
1250       data += read_return;
1251       read_length -= read_return;
1252       block_length = read_length;
1253       remaining -= read_return;
1254
1255       rpos = (queue->current->reading_pos += read_return);
1256       update_cur_pos (queue, queue->current, queue->current->reading_pos);
1257     }
1258     GST_QUEUE2_SIGNAL_DEL (queue);
1259     GST_DEBUG_OBJECT (queue, "%u bytes left to read", remaining);
1260   }
1261
1262   gst_buffer_unmap (buf, data, length);
1263
1264   GST_BUFFER_OFFSET (buf) = offset;
1265   GST_BUFFER_OFFSET_END (buf) = offset + length;
1266
1267   *buffer = buf;
1268
1269   return ret;
1270
1271   /* ERRORS */
1272 hit_eos:
1273   {
1274     GST_DEBUG_OBJECT (queue, "EOS hit and we don't have any requested data");
1275     gst_buffer_unref (buf);
1276     return GST_FLOW_UNEXPECTED;
1277   }
1278 out_flushing:
1279   {
1280     GST_DEBUG_OBJECT (queue, "we are flushing");
1281     gst_buffer_unref (buf);
1282     return GST_FLOW_WRONG_STATE;
1283   }
1284 read_error:
1285   {
1286     GST_DEBUG_OBJECT (queue, "we have a read error");
1287     gst_buffer_unmap (buf, data, 0);
1288     gst_buffer_unref (buf);
1289     return ret;
1290   }
1291 }
1292
1293 /* should be called with QUEUE_LOCK */
1294 static GstMiniObject *
1295 gst_queue2_read_item_from_file (GstQueue2 * queue)
1296 {
1297   GstMiniObject *item;
1298
1299   if (queue->starting_segment != NULL) {
1300     item = GST_MINI_OBJECT_CAST (queue->starting_segment);
1301     queue->starting_segment = NULL;
1302   } else {
1303     GstFlowReturn ret;
1304     GstBuffer *buffer;
1305     guint64 reading_pos;
1306
1307     reading_pos = queue->current->reading_pos;
1308
1309     ret =
1310         gst_queue2_create_read (queue, reading_pos, DEFAULT_BUFFER_SIZE,
1311         &buffer);
1312
1313     switch (ret) {
1314       case GST_FLOW_OK:
1315         item = GST_MINI_OBJECT_CAST (buffer);
1316         break;
1317       case GST_FLOW_UNEXPECTED:
1318         item = GST_MINI_OBJECT_CAST (gst_event_new_eos ());
1319         break;
1320       default:
1321         item = NULL;
1322         break;
1323     }
1324   }
1325   return item;
1326 }
1327
1328 /* must be called with MUTEX_LOCK. Will briefly release the lock when notifying
1329  * the temp filename. */
1330 static gboolean
1331 gst_queue2_open_temp_location_file (GstQueue2 * queue)
1332 {
1333   gint fd = -1;
1334   gchar *name = NULL;
1335
1336   if (queue->temp_file)
1337     goto already_opened;
1338
1339   GST_DEBUG_OBJECT (queue, "opening temp file %s", queue->temp_template);
1340
1341   /* we have two cases:
1342    * - temp_location was set to something !NULL (Deprecated). in this case we
1343    *   open the specified filename.
1344    * - temp_template was set, allocate a filename and open that filename
1345    */
1346   if (!queue->temp_location_set) {
1347     /* nothing to do */
1348     if (queue->temp_template == NULL)
1349       goto no_directory;
1350
1351     /* make copy of the template, we don't want to change this */
1352     name = g_strdup (queue->temp_template);
1353     fd = g_mkstemp (name);
1354     if (fd == -1)
1355       goto mkstemp_failed;
1356
1357     /* open the file for update/writing */
1358     queue->temp_file = fdopen (fd, "wb+");
1359     /* error creating file */
1360     if (queue->temp_file == NULL)
1361       goto open_failed;
1362
1363     g_free (queue->temp_location);
1364     queue->temp_location = name;
1365
1366     GST_QUEUE2_MUTEX_UNLOCK (queue);
1367
1368     /* we can't emit the notify with the lock */
1369     g_object_notify (G_OBJECT (queue), "temp-location");
1370
1371     GST_QUEUE2_MUTEX_LOCK (queue);
1372   } else {
1373     /* open the file for update/writing, this is deprecated but we still need to
1374      * support it for API/ABI compatibility */
1375     queue->temp_file = g_fopen (queue->temp_location, "wb+");
1376     /* error creating file */
1377     if (queue->temp_file == NULL)
1378       goto open_failed;
1379   }
1380   GST_DEBUG_OBJECT (queue, "opened temp file %s", queue->temp_template);
1381
1382   return TRUE;
1383
1384   /* ERRORS */
1385 already_opened:
1386   {
1387     GST_DEBUG_OBJECT (queue, "temp file was already open");
1388     return TRUE;
1389   }
1390 no_directory:
1391   {
1392     GST_ELEMENT_ERROR (queue, RESOURCE, NOT_FOUND,
1393         (_("No Temp directory specified.")), (NULL));
1394     return FALSE;
1395   }
1396 mkstemp_failed:
1397   {
1398     GST_ELEMENT_ERROR (queue, RESOURCE, OPEN_READ,
1399         (_("Could not create temp file \"%s\"."), queue->temp_template),
1400         GST_ERROR_SYSTEM);
1401     g_free (name);
1402     return FALSE;
1403   }
1404 open_failed:
1405   {
1406     GST_ELEMENT_ERROR (queue, RESOURCE, OPEN_READ,
1407         (_("Could not open file \"%s\" for reading."), name), GST_ERROR_SYSTEM);
1408     g_free (name);
1409     if (fd != -1)
1410       close (fd);
1411     return FALSE;
1412   }
1413 }
1414
1415 static void
1416 gst_queue2_close_temp_location_file (GstQueue2 * queue)
1417 {
1418   /* nothing to do */
1419   if (queue->temp_file == NULL)
1420     return;
1421
1422   GST_DEBUG_OBJECT (queue, "closing temp file");
1423
1424   fflush (queue->temp_file);
1425   fclose (queue->temp_file);
1426
1427   if (queue->temp_remove)
1428     remove (queue->temp_location);
1429
1430   queue->temp_file = NULL;
1431   clean_ranges (queue);
1432 }
1433
1434 static void
1435 gst_queue2_flush_temp_file (GstQueue2 * queue)
1436 {
1437   if (queue->temp_file == NULL)
1438     return;
1439
1440   GST_DEBUG_OBJECT (queue, "flushing temp file");
1441
1442   queue->temp_file = g_freopen (queue->temp_location, "wb+", queue->temp_file);
1443 }
1444
1445 static void
1446 gst_queue2_locked_flush (GstQueue2 * queue)
1447 {
1448   if (!QUEUE_IS_USING_QUEUE (queue)) {
1449     if (QUEUE_IS_USING_TEMP_FILE (queue))
1450       gst_queue2_flush_temp_file (queue);
1451     init_ranges (queue);
1452   } else {
1453     while (!g_queue_is_empty (queue->queue)) {
1454       GstMiniObject *data = g_queue_pop_head (queue->queue);
1455
1456       /* Then lose another reference because we are supposed to destroy that
1457          data when flushing */
1458       gst_mini_object_unref (data);
1459     }
1460   }
1461   GST_QUEUE2_CLEAR_LEVEL (queue->cur_level);
1462   gst_segment_init (&queue->sink_segment, GST_FORMAT_TIME);
1463   gst_segment_init (&queue->src_segment, GST_FORMAT_TIME);
1464   queue->sinktime = queue->srctime = GST_CLOCK_TIME_NONE;
1465   queue->sink_tainted = queue->src_tainted = TRUE;
1466   if (queue->starting_segment != NULL)
1467     gst_event_unref (queue->starting_segment);
1468   queue->starting_segment = NULL;
1469   queue->segment_event_received = FALSE;
1470
1471   /* we deleted a lot of something */
1472   GST_QUEUE2_SIGNAL_DEL (queue);
1473 }
1474
1475 static gboolean
1476 gst_queue2_wait_free_space (GstQueue2 * queue)
1477 {
1478   /* We make space available if we're "full" according to whatever
1479    * the user defined as "full". */
1480   if (gst_queue2_is_filled (queue)) {
1481     gboolean started;
1482
1483     /* pause the timer while we wait. The fact that we are waiting does not mean
1484      * the byterate on the input pad is lower */
1485     if ((started = queue->in_timer_started))
1486       g_timer_stop (queue->in_timer);
1487
1488     GST_CAT_DEBUG_OBJECT (queue_dataflow, queue,
1489         "queue is full, waiting for free space");
1490     do {
1491       /* Wait for space to be available, we could be unlocked because of a flush. */
1492       GST_QUEUE2_WAIT_DEL_CHECK (queue, queue->sinkresult, out_flushing);
1493     }
1494     while (gst_queue2_is_filled (queue));
1495
1496     /* and continue if we were running before */
1497     if (started)
1498       g_timer_continue (queue->in_timer);
1499   }
1500   return TRUE;
1501
1502   /* ERRORS */
1503 out_flushing:
1504   {
1505     GST_CAT_DEBUG_OBJECT (queue_dataflow, queue, "queue is flushing");
1506     return FALSE;
1507   }
1508 }
1509
1510 static gboolean
1511 gst_queue2_create_write (GstQueue2 * queue, GstBuffer * buffer)
1512 {
1513   guint8 *odata, *data, *ring_buffer;
1514   guint size, rb_size;
1515   gsize osize;
1516   guint64 writing_pos, new_writing_pos;
1517   GstQueue2Range *range, *prev, *next;
1518
1519   if (QUEUE_IS_USING_RING_BUFFER (queue))
1520     writing_pos = queue->current->rb_writing_pos;
1521   else
1522     writing_pos = queue->current->writing_pos;
1523   ring_buffer = queue->ring_buffer;
1524   rb_size = queue->ring_buffer_max_size;
1525
1526   odata = gst_buffer_map (buffer, &osize, NULL, GST_MAP_READ);
1527
1528   size = osize;
1529   data = odata;
1530
1531   GST_DEBUG_OBJECT (queue, "Writing %u bytes to %" G_GUINT64_FORMAT, size,
1532       GST_BUFFER_OFFSET (buffer));
1533
1534   while (size > 0) {
1535     guint to_write;
1536
1537     if (QUEUE_IS_USING_RING_BUFFER (queue)) {
1538       gint64 space;
1539
1540       /* calculate the space in the ring buffer not used by data from
1541        * the current range */
1542       while (QUEUE_MAX_BYTES (queue) <= queue->cur_level.bytes) {
1543         /* wait until there is some free space */
1544         GST_QUEUE2_WAIT_DEL_CHECK (queue, queue->sinkresult, out_flushing);
1545       }
1546       /* get the amount of space we have */
1547       space = QUEUE_MAX_BYTES (queue) - queue->cur_level.bytes;
1548
1549       /* calculate if we need to split or if we can write the entire
1550        * buffer now */
1551       to_write = MIN (size, space);
1552
1553       /* the writing position in the ring buffer after writing (part
1554        * or all of) the buffer */
1555       new_writing_pos = (writing_pos + to_write) % rb_size;
1556
1557       prev = NULL;
1558       range = queue->ranges;
1559
1560       /* if we need to overwrite data in the ring buffer, we need to
1561        * update the ranges
1562        *
1563        * warning: this code is complicated and includes some
1564        * simplifications - pen, paper and diagrams for the cases
1565        * recommended! */
1566       while (range) {
1567         guint64 range_data_start, range_data_end;
1568         GstQueue2Range *range_to_destroy = NULL;
1569
1570         range_data_start = range->rb_offset;
1571         range_data_end = range->rb_writing_pos;
1572
1573         /* handle the special case where the range has no data in it */
1574         if (range->writing_pos == range->offset) {
1575           if (range != queue->current) {
1576             GST_DEBUG_OBJECT (queue,
1577                 "Removing range: offset %" G_GUINT64_FORMAT ", wpos %"
1578                 G_GUINT64_FORMAT, range->offset, range->writing_pos);
1579             /* remove range */
1580             range_to_destroy = range;
1581             if (prev)
1582               prev->next = range->next;
1583           }
1584           goto next_range;
1585         }
1586
1587         if (range_data_end > range_data_start) {
1588           if (writing_pos >= range_data_end && new_writing_pos >= writing_pos)
1589             goto next_range;
1590
1591           if (new_writing_pos > range_data_start) {
1592             if (new_writing_pos >= range_data_end) {
1593               GST_DEBUG_OBJECT (queue,
1594                   "Removing range: offset %" G_GUINT64_FORMAT ", wpos %"
1595                   G_GUINT64_FORMAT, range->offset, range->writing_pos);
1596               /* remove range */
1597               range_to_destroy = range;
1598               if (prev)
1599                 prev->next = range->next;
1600             } else {
1601               GST_DEBUG_OBJECT (queue,
1602                   "advancing offsets from %" G_GUINT64_FORMAT " (%"
1603                   G_GUINT64_FORMAT ") to %" G_GUINT64_FORMAT " (%"
1604                   G_GUINT64_FORMAT ")", range->offset, range->rb_offset,
1605                   range->offset + new_writing_pos - range_data_start,
1606                   new_writing_pos);
1607               range->offset += (new_writing_pos - range_data_start);
1608               range->rb_offset = new_writing_pos;
1609             }
1610           }
1611         } else {
1612           guint64 new_wpos_virt = writing_pos + to_write;
1613
1614           if (new_wpos_virt <= range_data_start)
1615             goto next_range;
1616
1617           if (new_wpos_virt > rb_size && new_writing_pos >= range_data_end) {
1618             GST_DEBUG_OBJECT (queue,
1619                 "Removing range: offset %" G_GUINT64_FORMAT ", wpos %"
1620                 G_GUINT64_FORMAT, range->offset, range->writing_pos);
1621             /* remove range */
1622             range_to_destroy = range;
1623             if (prev)
1624               prev->next = range->next;
1625           } else {
1626             GST_DEBUG_OBJECT (queue,
1627                 "advancing offsets from %" G_GUINT64_FORMAT " (%"
1628                 G_GUINT64_FORMAT ") to %" G_GUINT64_FORMAT " (%"
1629                 G_GUINT64_FORMAT ")", range->offset, range->rb_offset,
1630                 range->offset + new_writing_pos - range_data_start,
1631                 new_writing_pos);
1632             range->offset += (new_wpos_virt - range_data_start);
1633             range->rb_offset = new_writing_pos;
1634           }
1635         }
1636
1637       next_range:
1638         if (!range_to_destroy)
1639           prev = range;
1640
1641         range = range->next;
1642         if (range_to_destroy) {
1643           if (range_to_destroy == queue->ranges)
1644             queue->ranges = range;
1645           g_slice_free (GstQueue2Range, range_to_destroy);
1646           range_to_destroy = NULL;
1647         }
1648       }
1649     } else {
1650       to_write = size;
1651       new_writing_pos = writing_pos + to_write;
1652     }
1653
1654     if (QUEUE_IS_USING_TEMP_FILE (queue)
1655         && FSEEK_FILE (queue->temp_file, writing_pos))
1656       goto seek_failed;
1657
1658     if (new_writing_pos > writing_pos) {
1659       GST_INFO_OBJECT (queue,
1660           "writing %u bytes to range [%" G_GUINT64_FORMAT "-%" G_GUINT64_FORMAT
1661           "] (rb wpos %" G_GUINT64_FORMAT ")", to_write, queue->current->offset,
1662           queue->current->writing_pos, queue->current->rb_writing_pos);
1663       /* either not using ring buffer or no wrapping, just write */
1664       if (QUEUE_IS_USING_TEMP_FILE (queue)) {
1665         if (fwrite (data, to_write, 1, queue->temp_file) != 1)
1666           goto handle_error;
1667       } else {
1668         memcpy (ring_buffer + writing_pos, data, to_write);
1669       }
1670
1671       if (!QUEUE_IS_USING_RING_BUFFER (queue)) {
1672         /* try to merge with next range */
1673         while ((next = queue->current->next)) {
1674           GST_INFO_OBJECT (queue,
1675               "checking merge with next range %" G_GUINT64_FORMAT " < %"
1676               G_GUINT64_FORMAT, new_writing_pos, next->offset);
1677           if (new_writing_pos < next->offset)
1678             break;
1679
1680           GST_DEBUG_OBJECT (queue, "merging ranges %" G_GUINT64_FORMAT,
1681               next->writing_pos);
1682
1683           /* remove the group, we could choose to not read the data in this range
1684            * again. This would involve us doing a seek to the current writing position
1685            * in the range. FIXME, It would probably make sense to do a seek when there
1686            * is a lot of data in the range we merged with to avoid reading it all
1687            * again. */
1688           queue->current->next = next->next;
1689           g_slice_free (GstQueue2Range, next);
1690
1691           debug_ranges (queue);
1692         }
1693         goto update_and_signal;
1694       }
1695     } else {
1696       /* wrapping */
1697       guint block_one, block_two;
1698
1699       block_one = rb_size - writing_pos;
1700       block_two = to_write - block_one;
1701
1702       if (block_one > 0) {
1703         GST_INFO_OBJECT (queue, "writing %u bytes", block_one);
1704         /* write data to end of ring buffer */
1705         if (QUEUE_IS_USING_TEMP_FILE (queue)) {
1706           if (fwrite (data, block_one, 1, queue->temp_file) != 1)
1707             goto handle_error;
1708         } else {
1709           memcpy (ring_buffer + writing_pos, data, block_one);
1710         }
1711       }
1712
1713       if (QUEUE_IS_USING_TEMP_FILE (queue) && FSEEK_FILE (queue->temp_file, 0))
1714         goto seek_failed;
1715
1716       if (block_two > 0) {
1717         GST_INFO_OBJECT (queue, "writing %u bytes", block_two);
1718         if (QUEUE_IS_USING_TEMP_FILE (queue)) {
1719           if (fwrite (data + block_one, block_two, 1, queue->temp_file) != 1)
1720             goto handle_error;
1721         } else {
1722           memcpy (ring_buffer, data + block_one, block_two);
1723         }
1724       }
1725     }
1726
1727   update_and_signal:
1728     /* update the writing positions */
1729     size -= to_write;
1730     GST_INFO_OBJECT (queue,
1731         "wrote %u bytes to %" G_GUINT64_FORMAT " (%u bytes remaining to write)",
1732         to_write, writing_pos, size);
1733
1734     if (QUEUE_IS_USING_RING_BUFFER (queue)) {
1735       data += to_write;
1736       queue->current->writing_pos += to_write;
1737       queue->current->rb_writing_pos = writing_pos = new_writing_pos;
1738     } else {
1739       queue->current->writing_pos = writing_pos = new_writing_pos;
1740     }
1741     update_cur_level (queue, queue->current);
1742
1743     /* update the buffering status */
1744     if (queue->use_buffering)
1745       update_buffering (queue);
1746
1747     GST_INFO_OBJECT (queue, "cur_level.bytes %u (max %" G_GUINT64_FORMAT ")",
1748         queue->cur_level.bytes, QUEUE_MAX_BYTES (queue));
1749
1750     GST_QUEUE2_SIGNAL_ADD (queue);
1751   }
1752
1753   gst_buffer_unmap (buffer, odata, osize);
1754
1755   return TRUE;
1756
1757   /* ERRORS */
1758 out_flushing:
1759   {
1760     GST_DEBUG_OBJECT (queue, "we are flushing");
1761     gst_buffer_unmap (buffer, odata, osize);
1762     /* FIXME - GST_FLOW_UNEXPECTED ? */
1763     return FALSE;
1764   }
1765 seek_failed:
1766   {
1767     GST_ELEMENT_ERROR (queue, RESOURCE, SEEK, (NULL), GST_ERROR_SYSTEM);
1768     gst_buffer_unmap (buffer, odata, osize);
1769     return FALSE;
1770   }
1771 handle_error:
1772   {
1773     switch (errno) {
1774       case ENOSPC:{
1775         GST_ELEMENT_ERROR (queue, RESOURCE, NO_SPACE_LEFT, (NULL), (NULL));
1776         break;
1777       }
1778       default:{
1779         GST_ELEMENT_ERROR (queue, RESOURCE, WRITE,
1780             (_("Error while writing to download file.")),
1781             ("%s", g_strerror (errno)));
1782       }
1783     }
1784     gst_buffer_unmap (buffer, odata, osize);
1785     return FALSE;
1786   }
1787 }
1788
1789 /* enqueue an item an update the level stats */
1790 static void
1791 gst_queue2_locked_enqueue (GstQueue2 * queue, gpointer item, gboolean isbuffer)
1792 {
1793   if (isbuffer) {
1794     GstBuffer *buffer;
1795     guint size;
1796
1797     buffer = GST_BUFFER_CAST (item);
1798     size = gst_buffer_get_size (buffer);
1799
1800     /* add buffer to the statistics */
1801     if (QUEUE_IS_USING_QUEUE (queue)) {
1802       queue->cur_level.buffers++;
1803       queue->cur_level.bytes += size;
1804     }
1805     queue->bytes_in += size;
1806
1807     /* apply new buffer to segment stats */
1808     apply_buffer (queue, buffer, &queue->sink_segment, TRUE);
1809     /* update the byterate stats */
1810     update_in_rates (queue);
1811
1812     if (!QUEUE_IS_USING_QUEUE (queue)) {
1813       /* FIXME - check return value? */
1814       gst_queue2_create_write (queue, buffer);
1815     }
1816   } else if (GST_IS_EVENT (item)) {
1817     GstEvent *event;
1818
1819     event = GST_EVENT_CAST (item);
1820
1821     switch (GST_EVENT_TYPE (event)) {
1822       case GST_EVENT_EOS:
1823         /* Zero the thresholds, this makes sure the queue is completely
1824          * filled and we can read all data from the queue. */
1825         GST_DEBUG_OBJECT (queue, "we have EOS");
1826         queue->is_eos = TRUE;
1827         break;
1828       case GST_EVENT_NEWSEGMENT:
1829         apply_segment (queue, event, &queue->sink_segment, TRUE);
1830         /* This is our first new segment, we hold it
1831          * as we can't save it on the temp file */
1832         if (!QUEUE_IS_USING_QUEUE (queue)) {
1833           if (queue->segment_event_received)
1834             goto unexpected_event;
1835
1836           queue->segment_event_received = TRUE;
1837           if (queue->starting_segment != NULL)
1838             gst_event_unref (queue->starting_segment);
1839           queue->starting_segment = event;
1840           item = NULL;
1841         }
1842         /* a new segment allows us to accept more buffers if we got UNEXPECTED
1843          * from downstream */
1844         queue->unexpected = FALSE;
1845         break;
1846       default:
1847         if (!QUEUE_IS_USING_QUEUE (queue))
1848           goto unexpected_event;
1849         break;
1850     }
1851   } else {
1852     g_warning ("Unexpected item %p added in queue %s (refcounting problem?)",
1853         item, GST_OBJECT_NAME (queue));
1854     /* we can't really unref since we don't know what it is */
1855     item = NULL;
1856   }
1857
1858   if (item) {
1859     /* update the buffering status */
1860     if (queue->use_buffering)
1861       update_buffering (queue);
1862
1863     if (QUEUE_IS_USING_QUEUE (queue)) {
1864       g_queue_push_tail (queue->queue, item);
1865     } else {
1866       gst_mini_object_unref (GST_MINI_OBJECT_CAST (item));
1867     }
1868
1869     GST_QUEUE2_SIGNAL_ADD (queue);
1870   }
1871
1872   return;
1873
1874   /* ERRORS */
1875 unexpected_event:
1876   {
1877     g_warning
1878         ("Unexpected event of kind %s can't be added in temp file of queue %s ",
1879         gst_event_type_get_name (GST_EVENT_TYPE (item)),
1880         GST_OBJECT_NAME (queue));
1881     gst_event_unref (GST_EVENT_CAST (item));
1882     return;
1883   }
1884 }
1885
1886 /* dequeue an item from the queue and update level stats */
1887 static GstMiniObject *
1888 gst_queue2_locked_dequeue (GstQueue2 * queue, gboolean * is_buffer)
1889 {
1890   GstMiniObject *item;
1891
1892   if (!QUEUE_IS_USING_QUEUE (queue))
1893     item = gst_queue2_read_item_from_file (queue);
1894   else
1895     item = g_queue_pop_head (queue->queue);
1896
1897   if (item == NULL)
1898     goto no_item;
1899
1900   if (GST_IS_BUFFER (item)) {
1901     GstBuffer *buffer;
1902     guint size;
1903
1904     buffer = GST_BUFFER_CAST (item);
1905     size = gst_buffer_get_size (buffer);
1906     *is_buffer = TRUE;
1907
1908     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
1909         "retrieved buffer %p from queue", buffer);
1910
1911     if (QUEUE_IS_USING_QUEUE (queue)) {
1912       queue->cur_level.buffers--;
1913       queue->cur_level.bytes -= size;
1914     }
1915     queue->bytes_out += size;
1916
1917     apply_buffer (queue, buffer, &queue->src_segment, FALSE);
1918     /* update the byterate stats */
1919     update_out_rates (queue);
1920     /* update the buffering */
1921     if (queue->use_buffering)
1922       update_buffering (queue);
1923
1924   } else if (GST_IS_EVENT (item)) {
1925     GstEvent *event = GST_EVENT_CAST (item);
1926
1927     *is_buffer = FALSE;
1928
1929     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
1930         "retrieved event %p from queue", event);
1931
1932     switch (GST_EVENT_TYPE (event)) {
1933       case GST_EVENT_EOS:
1934         /* queue is empty now that we dequeued the EOS */
1935         GST_QUEUE2_CLEAR_LEVEL (queue->cur_level);
1936         break;
1937       case GST_EVENT_NEWSEGMENT:
1938         apply_segment (queue, event, &queue->src_segment, FALSE);
1939         break;
1940       default:
1941         break;
1942     }
1943   } else {
1944     g_warning
1945         ("Unexpected item %p dequeued from queue %s (refcounting problem?)",
1946         item, GST_OBJECT_NAME (queue));
1947     item = NULL;
1948   }
1949   GST_QUEUE2_SIGNAL_DEL (queue);
1950
1951   return item;
1952
1953   /* ERRORS */
1954 no_item:
1955   {
1956     GST_CAT_LOG_OBJECT (queue_dataflow, queue, "the queue is empty");
1957     return NULL;
1958   }
1959 }
1960
1961 static gboolean
1962 gst_queue2_handle_sink_event (GstPad * pad, GstEvent * event)
1963 {
1964   GstQueue2 *queue;
1965
1966   queue = GST_QUEUE2 (GST_OBJECT_PARENT (pad));
1967
1968   switch (GST_EVENT_TYPE (event)) {
1969     case GST_EVENT_FLUSH_START:
1970     {
1971       GST_CAT_LOG_OBJECT (queue_dataflow, queue, "received flush start event");
1972       if (QUEUE_IS_USING_QUEUE (queue)) {
1973         /* forward event */
1974         gst_pad_push_event (queue->srcpad, event);
1975
1976         /* now unblock the chain function */
1977         GST_QUEUE2_MUTEX_LOCK (queue);
1978         queue->srcresult = GST_FLOW_WRONG_STATE;
1979         queue->sinkresult = GST_FLOW_WRONG_STATE;
1980         /* unblock the loop and chain functions */
1981         GST_QUEUE2_SIGNAL_ADD (queue);
1982         GST_QUEUE2_SIGNAL_DEL (queue);
1983         GST_QUEUE2_MUTEX_UNLOCK (queue);
1984
1985         /* make sure it pauses, this should happen since we sent
1986          * flush_start downstream. */
1987         gst_pad_pause_task (queue->srcpad);
1988         GST_CAT_LOG_OBJECT (queue_dataflow, queue, "loop stopped");
1989       } else {
1990         GST_QUEUE2_MUTEX_LOCK (queue);
1991         /* flush the sink pad */
1992         queue->sinkresult = GST_FLOW_WRONG_STATE;
1993         GST_QUEUE2_SIGNAL_DEL (queue);
1994         GST_QUEUE2_MUTEX_UNLOCK (queue);
1995
1996         gst_event_unref (event);
1997       }
1998       goto done;
1999     }
2000     case GST_EVENT_FLUSH_STOP:
2001     {
2002       GST_CAT_LOG_OBJECT (queue_dataflow, queue, "received flush stop event");
2003
2004       if (QUEUE_IS_USING_QUEUE (queue)) {
2005         /* forward event */
2006         gst_pad_push_event (queue->srcpad, event);
2007
2008         GST_QUEUE2_MUTEX_LOCK (queue);
2009         gst_queue2_locked_flush (queue);
2010         queue->srcresult = GST_FLOW_OK;
2011         queue->sinkresult = GST_FLOW_OK;
2012         queue->is_eos = FALSE;
2013         queue->unexpected = FALSE;
2014         /* reset rate counters */
2015         reset_rate_timer (queue);
2016         gst_pad_start_task (queue->srcpad, (GstTaskFunction) gst_queue2_loop,
2017             queue->srcpad);
2018         GST_QUEUE2_MUTEX_UNLOCK (queue);
2019       } else {
2020         GST_QUEUE2_MUTEX_LOCK (queue);
2021         queue->segment_event_received = FALSE;
2022         queue->is_eos = FALSE;
2023         queue->unexpected = FALSE;
2024         queue->sinkresult = GST_FLOW_OK;
2025         GST_QUEUE2_MUTEX_UNLOCK (queue);
2026
2027         gst_event_unref (event);
2028       }
2029       goto done;
2030     }
2031     default:
2032       if (GST_EVENT_IS_SERIALIZED (event)) {
2033         /* serialized events go in the queue */
2034         GST_QUEUE2_MUTEX_LOCK_CHECK (queue, queue->sinkresult, out_flushing);
2035         /* refuse more events on EOS */
2036         if (queue->is_eos)
2037           goto out_eos;
2038         gst_queue2_locked_enqueue (queue, event, FALSE);
2039         GST_QUEUE2_MUTEX_UNLOCK (queue);
2040       } else {
2041         /* non-serialized events are passed upstream. */
2042         gst_pad_push_event (queue->srcpad, event);
2043       }
2044       break;
2045   }
2046 done:
2047   return TRUE;
2048
2049   /* ERRORS */
2050 out_flushing:
2051   {
2052     GST_DEBUG_OBJECT (queue, "refusing event, we are flushing");
2053     GST_QUEUE2_MUTEX_UNLOCK (queue);
2054     gst_event_unref (event);
2055     return FALSE;
2056   }
2057 out_eos:
2058   {
2059     GST_DEBUG_OBJECT (queue, "refusing event, we are EOS");
2060     GST_QUEUE2_MUTEX_UNLOCK (queue);
2061     gst_event_unref (event);
2062     return FALSE;
2063   }
2064 }
2065
2066 static gboolean
2067 gst_queue2_is_empty (GstQueue2 * queue)
2068 {
2069   /* never empty on EOS */
2070   if (queue->is_eos)
2071     return FALSE;
2072
2073   if (!QUEUE_IS_USING_QUEUE (queue) && queue->current) {
2074     return queue->current->writing_pos <= queue->current->max_reading_pos;
2075   } else {
2076     if (queue->queue->length == 0)
2077       return TRUE;
2078   }
2079
2080   return FALSE;
2081 }
2082
2083 static gboolean
2084 gst_queue2_is_filled (GstQueue2 * queue)
2085 {
2086   gboolean res;
2087
2088   /* always filled on EOS */
2089   if (queue->is_eos)
2090     return TRUE;
2091
2092 #define CHECK_FILLED(format,alt_max) ((queue->max_level.format) > 0 && \
2093     (queue->cur_level.format) >= ((alt_max) ? \
2094       MIN ((queue->max_level.format), (alt_max)) : (queue->max_level.format)))
2095
2096   /* if using a ring buffer we're filled if all ring buffer space is used
2097    * _by the current range_ */
2098   if (QUEUE_IS_USING_RING_BUFFER (queue)) {
2099     guint64 rb_size = queue->ring_buffer_max_size;
2100     GST_DEBUG_OBJECT (queue,
2101         "max bytes %u, rb size %" G_GUINT64_FORMAT ", cur bytes %u",
2102         queue->max_level.bytes, rb_size, queue->cur_level.bytes);
2103     return CHECK_FILLED (bytes, rb_size);
2104   }
2105
2106   /* if using file, we're never filled if we don't have EOS */
2107   if (QUEUE_IS_USING_TEMP_FILE (queue))
2108     return FALSE;
2109
2110   /* we are never filled when we have no buffers at all */
2111   if (queue->cur_level.buffers == 0)
2112     return FALSE;
2113
2114   /* we are filled if one of the current levels exceeds the max */
2115   res = CHECK_FILLED (buffers, 0) || CHECK_FILLED (bytes, 0)
2116       || CHECK_FILLED (time, 0);
2117
2118   /* if we need to, use the rate estimate to check against the max time we are
2119    * allowed to queue */
2120   if (queue->use_rate_estimate)
2121     res |= CHECK_FILLED (rate_time, 0);
2122
2123 #undef CHECK_FILLED
2124   return res;
2125 }
2126
2127 static GstFlowReturn
2128 gst_queue2_chain (GstPad * pad, GstBuffer * buffer)
2129 {
2130   GstQueue2 *queue;
2131
2132   queue = GST_QUEUE2 (GST_OBJECT_PARENT (pad));
2133
2134   GST_CAT_LOG_OBJECT (queue_dataflow, queue,
2135       "received buffer %p of size %d, time %" GST_TIME_FORMAT ", duration %"
2136       GST_TIME_FORMAT, buffer, gst_buffer_get_size (buffer),
2137       GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buffer)),
2138       GST_TIME_ARGS (GST_BUFFER_DURATION (buffer)));
2139
2140   /* we have to lock the queue since we span threads */
2141   GST_QUEUE2_MUTEX_LOCK_CHECK (queue, queue->sinkresult, out_flushing);
2142   /* when we received EOS, we refuse more data */
2143   if (queue->is_eos)
2144     goto out_eos;
2145   /* when we received unexpected from downstream, refuse more buffers */
2146   if (queue->unexpected)
2147     goto out_unexpected;
2148
2149   if (!gst_queue2_wait_free_space (queue))
2150     goto out_flushing;
2151
2152   /* put buffer in queue now */
2153   gst_queue2_locked_enqueue (queue, buffer, TRUE);
2154   GST_QUEUE2_MUTEX_UNLOCK (queue);
2155
2156   return GST_FLOW_OK;
2157
2158   /* special conditions */
2159 out_flushing:
2160   {
2161     GstFlowReturn ret = queue->sinkresult;
2162
2163     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
2164         "exit because task paused, reason: %s", gst_flow_get_name (ret));
2165     GST_QUEUE2_MUTEX_UNLOCK (queue);
2166     gst_buffer_unref (buffer);
2167
2168     return ret;
2169   }
2170 out_eos:
2171   {
2172     GST_CAT_LOG_OBJECT (queue_dataflow, queue, "exit because we received EOS");
2173     GST_QUEUE2_MUTEX_UNLOCK (queue);
2174     gst_buffer_unref (buffer);
2175
2176     return GST_FLOW_UNEXPECTED;
2177   }
2178 out_unexpected:
2179   {
2180     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
2181         "exit because we received UNEXPECTED");
2182     GST_QUEUE2_MUTEX_UNLOCK (queue);
2183     gst_buffer_unref (buffer);
2184
2185     return GST_FLOW_UNEXPECTED;
2186   }
2187 }
2188
2189 /* dequeue an item from the queue an push it downstream. This functions returns
2190  * the result of the push. */
2191 static GstFlowReturn
2192 gst_queue2_push_one (GstQueue2 * queue)
2193 {
2194   GstFlowReturn result = GST_FLOW_OK;
2195   GstMiniObject *data;
2196   gboolean is_buffer = FALSE;
2197
2198   data = gst_queue2_locked_dequeue (queue, &is_buffer);
2199   if (data == NULL)
2200     goto no_item;
2201
2202 next:
2203   GST_QUEUE2_MUTEX_UNLOCK (queue);
2204
2205   if (is_buffer) {
2206     GstBuffer *buffer;
2207
2208     buffer = GST_BUFFER_CAST (data);
2209
2210     result = gst_pad_push (queue->srcpad, buffer);
2211
2212     /* need to check for srcresult here as well */
2213     GST_QUEUE2_MUTEX_LOCK_CHECK (queue, queue->srcresult, out_flushing);
2214     if (result == GST_FLOW_UNEXPECTED) {
2215       GST_CAT_LOG_OBJECT (queue_dataflow, queue,
2216           "got UNEXPECTED from downstream");
2217       /* stop pushing buffers, we dequeue all items until we see an item that we
2218        * can push again, which is EOS or NEWSEGMENT. If there is nothing in the
2219        * queue we can push, we set a flag to make the sinkpad refuse more
2220        * buffers with an UNEXPECTED return value until we receive something
2221        * pushable again or we get flushed. */
2222       while ((data = gst_queue2_locked_dequeue (queue, &is_buffer))) {
2223         if (is_buffer) {
2224           GST_CAT_LOG_OBJECT (queue_dataflow, queue,
2225               "dropping UNEXPECTED buffer %p", data);
2226           gst_buffer_unref (GST_BUFFER_CAST (data));
2227         } else if (GST_IS_EVENT (data)) {
2228           GstEvent *event = GST_EVENT_CAST (data);
2229           GstEventType type = GST_EVENT_TYPE (event);
2230
2231           if (type == GST_EVENT_EOS || type == GST_EVENT_NEWSEGMENT) {
2232             /* we found a pushable item in the queue, push it out */
2233             GST_CAT_LOG_OBJECT (queue_dataflow, queue,
2234                 "pushing pushable event %s after UNEXPECTED",
2235                 GST_EVENT_TYPE_NAME (event));
2236             goto next;
2237           }
2238           GST_CAT_LOG_OBJECT (queue_dataflow, queue,
2239               "dropping UNEXPECTED event %p", event);
2240           gst_event_unref (event);
2241         }
2242       }
2243       /* no more items in the queue. Set the unexpected flag so that upstream
2244        * make us refuse any more buffers on the sinkpad. Since we will still
2245        * accept EOS and NEWSEGMENT we return _FLOW_OK to the caller so that the
2246        * task function does not shut down. */
2247       queue->unexpected = TRUE;
2248       result = GST_FLOW_OK;
2249     }
2250   } else if (GST_IS_EVENT (data)) {
2251     GstEvent *event = GST_EVENT_CAST (data);
2252     GstEventType type = GST_EVENT_TYPE (event);
2253
2254     gst_pad_push_event (queue->srcpad, event);
2255
2256     /* if we're EOS, return UNEXPECTED so that the task pauses. */
2257     if (type == GST_EVENT_EOS) {
2258       GST_CAT_LOG_OBJECT (queue_dataflow, queue,
2259           "pushed EOS event %p, return UNEXPECTED", event);
2260       result = GST_FLOW_UNEXPECTED;
2261     }
2262
2263     GST_QUEUE2_MUTEX_LOCK_CHECK (queue, queue->srcresult, out_flushing);
2264   }
2265   return result;
2266
2267   /* ERRORS */
2268 no_item:
2269   {
2270     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
2271         "exit because we have no item in the queue");
2272     return GST_FLOW_ERROR;
2273   }
2274 out_flushing:
2275   {
2276     GST_CAT_LOG_OBJECT (queue_dataflow, queue, "exit because we are flushing");
2277     return GST_FLOW_WRONG_STATE;
2278   }
2279 }
2280
2281 /* called repeadedly with @pad as the source pad. This function should push out
2282  * data to the peer element. */
2283 static void
2284 gst_queue2_loop (GstPad * pad)
2285 {
2286   GstQueue2 *queue;
2287   GstFlowReturn ret;
2288
2289   queue = GST_QUEUE2 (GST_PAD_PARENT (pad));
2290
2291   /* have to lock for thread-safety */
2292   GST_QUEUE2_MUTEX_LOCK_CHECK (queue, queue->srcresult, out_flushing);
2293
2294   if (gst_queue2_is_empty (queue)) {
2295     gboolean started;
2296
2297     /* pause the timer while we wait. The fact that we are waiting does not mean
2298      * the byterate on the output pad is lower */
2299     if ((started = queue->out_timer_started))
2300       g_timer_stop (queue->out_timer);
2301
2302     GST_CAT_DEBUG_OBJECT (queue_dataflow, queue,
2303         "queue is empty, waiting for new data");
2304     do {
2305       /* Wait for data to be available, we could be unlocked because of a flush. */
2306       GST_QUEUE2_WAIT_ADD_CHECK (queue, queue->srcresult, out_flushing);
2307     }
2308     while (gst_queue2_is_empty (queue));
2309
2310     /* and continue if we were running before */
2311     if (started)
2312       g_timer_continue (queue->out_timer);
2313   }
2314   ret = gst_queue2_push_one (queue);
2315   queue->srcresult = ret;
2316   queue->sinkresult = ret;
2317   if (ret != GST_FLOW_OK)
2318     goto out_flushing;
2319
2320   GST_QUEUE2_MUTEX_UNLOCK (queue);
2321
2322   return;
2323
2324   /* ERRORS */
2325 out_flushing:
2326   {
2327     gboolean eos = queue->is_eos;
2328     GstFlowReturn ret = queue->srcresult;
2329
2330     gst_pad_pause_task (queue->srcpad);
2331     GST_QUEUE2_MUTEX_UNLOCK (queue);
2332     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
2333         "pause task, reason:  %s", gst_flow_get_name (queue->srcresult));
2334     /* let app know about us giving up if upstream is not expected to do so */
2335     /* UNEXPECTED is already taken care of elsewhere */
2336     if (eos && (ret == GST_FLOW_NOT_LINKED || ret < GST_FLOW_UNEXPECTED)) {
2337       GST_ELEMENT_ERROR (queue, STREAM, FAILED,
2338           (_("Internal data flow error.")),
2339           ("streaming task paused, reason %s (%d)",
2340               gst_flow_get_name (ret), ret));
2341       gst_pad_push_event (queue->srcpad, gst_event_new_eos ());
2342     }
2343     return;
2344   }
2345 }
2346
2347 static gboolean
2348 gst_queue2_handle_src_event (GstPad * pad, GstEvent * event)
2349 {
2350   gboolean res = TRUE;
2351   GstQueue2 *queue = GST_QUEUE2 (gst_pad_get_parent (pad));
2352
2353   if (G_UNLIKELY (queue == NULL)) {
2354     gst_event_unref (event);
2355     return FALSE;
2356   }
2357 #ifndef GST_DISABLE_GST_DEBUG
2358   GST_CAT_DEBUG_OBJECT (queue_dataflow, queue, "got event %p (%s)",
2359       event, GST_EVENT_TYPE_NAME (event));
2360 #endif
2361
2362   switch (GST_EVENT_TYPE (event)) {
2363     case GST_EVENT_FLUSH_START:
2364       if (QUEUE_IS_USING_QUEUE (queue)) {
2365         /* just forward upstream */
2366         res = gst_pad_push_event (queue->sinkpad, event);
2367       } else {
2368         /* now unblock the getrange function */
2369         GST_QUEUE2_MUTEX_LOCK (queue);
2370         GST_DEBUG_OBJECT (queue, "flushing");
2371         queue->srcresult = GST_FLOW_WRONG_STATE;
2372         GST_QUEUE2_SIGNAL_ADD (queue);
2373         GST_QUEUE2_MUTEX_UNLOCK (queue);
2374
2375         /* when using a temp file, we eat the event */
2376         res = TRUE;
2377         gst_event_unref (event);
2378       }
2379       break;
2380     case GST_EVENT_FLUSH_STOP:
2381       if (QUEUE_IS_USING_QUEUE (queue)) {
2382         /* just forward upstream */
2383         res = gst_pad_push_event (queue->sinkpad, event);
2384       } else {
2385         /* now unblock the getrange function */
2386         GST_QUEUE2_MUTEX_LOCK (queue);
2387         queue->srcresult = GST_FLOW_OK;
2388         if (queue->current) {
2389           /* forget the highest read offset, we'll calculate a new one when we
2390            * get the next getrange request. We need to do this in order to reset
2391            * the buffering percentage */
2392           queue->current->max_reading_pos = 0;
2393         }
2394         GST_QUEUE2_MUTEX_UNLOCK (queue);
2395
2396         /* when using a temp file, we eat the event */
2397         res = TRUE;
2398         gst_event_unref (event);
2399       }
2400       break;
2401     default:
2402       res = gst_pad_push_event (queue->sinkpad, event);
2403       break;
2404   }
2405
2406   gst_object_unref (queue);
2407   return res;
2408 }
2409
2410 static gboolean
2411 gst_queue2_peer_query (GstQueue2 * queue, GstPad * pad, GstQuery * query)
2412 {
2413   gboolean ret = FALSE;
2414   GstPad *peer;
2415
2416   if ((peer = gst_pad_get_peer (pad))) {
2417     ret = gst_pad_query (peer, query);
2418     gst_object_unref (peer);
2419   }
2420   return ret;
2421 }
2422
2423 static gboolean
2424 gst_queue2_handle_src_query (GstPad * pad, GstQuery * query)
2425 {
2426   GstQueue2 *queue;
2427
2428   queue = GST_QUEUE2 (gst_pad_get_parent (pad));
2429   if (G_UNLIKELY (queue == NULL))
2430     return FALSE;
2431
2432   switch (GST_QUERY_TYPE (query)) {
2433     case GST_QUERY_POSITION:
2434     {
2435       gint64 peer_pos;
2436       GstFormat format;
2437
2438       if (!gst_queue2_peer_query (queue, queue->sinkpad, query))
2439         goto peer_failed;
2440
2441       /* get peer position */
2442       gst_query_parse_position (query, &format, &peer_pos);
2443
2444       /* FIXME: this code assumes that there's no discont in the queue */
2445       switch (format) {
2446         case GST_FORMAT_BYTES:
2447           peer_pos -= queue->cur_level.bytes;
2448           break;
2449         case GST_FORMAT_TIME:
2450           peer_pos -= queue->cur_level.time;
2451           break;
2452         default:
2453           GST_WARNING_OBJECT (queue, "dropping query in %s format, don't "
2454               "know how to adjust value", gst_format_get_name (format));
2455           return FALSE;
2456       }
2457       /* set updated position */
2458       gst_query_set_position (query, format, peer_pos);
2459       break;
2460     }
2461     case GST_QUERY_DURATION:
2462     {
2463       GST_DEBUG_OBJECT (queue, "doing peer query");
2464
2465       if (!gst_queue2_peer_query (queue, queue->sinkpad, query))
2466         goto peer_failed;
2467
2468       GST_DEBUG_OBJECT (queue, "peer query success");
2469       break;
2470     }
2471     case GST_QUERY_BUFFERING:
2472     {
2473       GstFormat format;
2474
2475       GST_DEBUG_OBJECT (queue, "query buffering");
2476
2477       /* FIXME - is this condition correct? what should ring buffer do? */
2478       if (QUEUE_IS_USING_QUEUE (queue)) {
2479         /* no temp file, just forward to the peer */
2480         if (!gst_queue2_peer_query (queue, queue->sinkpad, query))
2481           goto peer_failed;
2482         GST_DEBUG_OBJECT (queue, "buffering forwarded to peer");
2483       } else {
2484         gint64 start, stop, range_start, range_stop;
2485         guint64 writing_pos;
2486         gint percent;
2487         gint64 estimated_total, buffering_left;
2488         GstFormat peer_fmt;
2489         gint64 duration;
2490         gboolean peer_res, is_buffering, is_eos;
2491         gdouble byte_in_rate, byte_out_rate;
2492         GstQueue2Range *queued_ranges;
2493
2494         /* we need a current download region */
2495         if (queue->current == NULL)
2496           return FALSE;
2497
2498         writing_pos = queue->current->writing_pos;
2499         byte_in_rate = queue->byte_in_rate;
2500         byte_out_rate = queue->byte_out_rate;
2501         is_buffering = queue->is_buffering;
2502         is_eos = queue->is_eos;
2503         percent = queue->buffering_percent;
2504
2505         if (is_eos) {
2506           /* we're EOS, we know the duration in bytes now */
2507           peer_res = TRUE;
2508           duration = writing_pos;
2509         } else {
2510           /* get duration of upstream in bytes */
2511           peer_fmt = GST_FORMAT_BYTES;
2512           peer_res = gst_pad_query_peer_duration (queue->sinkpad, &peer_fmt,
2513               &duration);
2514         }
2515
2516         /* calculate remaining and total download time */
2517         if (peer_res && byte_in_rate > 0.0) {
2518           estimated_total = (duration * 1000) / byte_in_rate;
2519           buffering_left = ((duration - writing_pos) * 1000) / byte_in_rate;
2520         } else {
2521           estimated_total = -1;
2522           buffering_left = -1;
2523         }
2524         GST_DEBUG_OBJECT (queue, "estimated %" G_GINT64_FORMAT ", left %"
2525             G_GINT64_FORMAT, estimated_total, buffering_left);
2526
2527         gst_query_parse_buffering_range (query, &format, NULL, NULL, NULL);
2528
2529         switch (format) {
2530           case GST_FORMAT_PERCENT:
2531             /* we need duration */
2532             if (!peer_res)
2533               goto peer_failed;
2534
2535             GST_DEBUG_OBJECT (queue,
2536                 "duration %" G_GINT64_FORMAT ", writing %" G_GINT64_FORMAT,
2537                 duration, writing_pos);
2538
2539             start = 0;
2540             /* get our available data relative to the duration */
2541             if (duration != -1)
2542               stop = GST_FORMAT_PERCENT_MAX * writing_pos / duration;
2543             else
2544               stop = -1;
2545             break;
2546           case GST_FORMAT_BYTES:
2547             start = 0;
2548             stop = writing_pos;
2549             break;
2550           default:
2551             start = -1;
2552             stop = -1;
2553             break;
2554         }
2555
2556         /* fill out the buffered ranges */
2557         for (queued_ranges = queue->ranges; queued_ranges;
2558             queued_ranges = queued_ranges->next) {
2559           switch (format) {
2560             case GST_FORMAT_PERCENT:
2561               if (duration == -1) {
2562                 range_start = 0;
2563                 range_stop = 0;
2564                 break;
2565               }
2566               range_start = 100 * queued_ranges->offset / duration;
2567               range_stop = 100 * queued_ranges->writing_pos / duration;
2568               break;
2569             case GST_FORMAT_BYTES:
2570               range_start = queued_ranges->offset;
2571               range_stop = queued_ranges->writing_pos;
2572               break;
2573             default:
2574               range_start = -1;
2575               range_stop = -1;
2576               break;
2577           }
2578           if (range_start == range_stop)
2579             continue;
2580           GST_DEBUG_OBJECT (queue,
2581               "range starting at %" G_GINT64_FORMAT " and finishing at %"
2582               G_GINT64_FORMAT, range_start, range_stop);
2583           gst_query_add_buffering_range (query, range_start, range_stop);
2584         }
2585
2586         gst_query_set_buffering_percent (query, is_buffering, percent);
2587         gst_query_set_buffering_range (query, format, start, stop,
2588             estimated_total);
2589         gst_query_set_buffering_stats (query, GST_BUFFERING_DOWNLOAD,
2590             byte_in_rate, byte_out_rate, buffering_left);
2591       }
2592       break;
2593     }
2594     default:
2595       /* peer handled other queries */
2596       if (!gst_queue2_peer_query (queue, queue->sinkpad, query))
2597         goto peer_failed;
2598       break;
2599   }
2600
2601   gst_object_unref (queue);
2602   return TRUE;
2603
2604   /* ERRORS */
2605 peer_failed:
2606   {
2607     GST_DEBUG_OBJECT (queue, "failed peer query");
2608     gst_object_unref (queue);
2609     return FALSE;
2610   }
2611 }
2612
2613 static gboolean
2614 gst_queue2_handle_query (GstElement * element, GstQuery * query)
2615 {
2616   /* simply forward to the srcpad query function */
2617   return gst_queue2_handle_src_query (GST_QUEUE2_CAST (element)->srcpad, query);
2618 }
2619
2620 static void
2621 gst_queue2_update_upstream_size (GstQueue2 * queue)
2622 {
2623   GstFormat fmt = GST_FORMAT_BYTES;
2624   gint64 upstream_size = -1;
2625
2626   if (gst_pad_query_peer_duration (queue->sinkpad, &fmt, &upstream_size)) {
2627     GST_INFO_OBJECT (queue, "upstream size: %" G_GINT64_FORMAT, upstream_size);
2628     queue->upstream_size = upstream_size;
2629   }
2630 }
2631
2632 static GstFlowReturn
2633 gst_queue2_get_range (GstPad * pad, guint64 offset, guint length,
2634     GstBuffer ** buffer)
2635 {
2636   GstQueue2 *queue;
2637   GstFlowReturn ret;
2638
2639   queue = GST_QUEUE2_CAST (gst_pad_get_parent (pad));
2640
2641   length = (length == -1) ? DEFAULT_BUFFER_SIZE : length;
2642   GST_QUEUE2_MUTEX_LOCK_CHECK (queue, queue->srcresult, out_flushing);
2643   offset = (offset == -1) ? queue->current->reading_pos : offset;
2644
2645   GST_DEBUG_OBJECT (queue,
2646       "Getting range: offset %" G_GUINT64_FORMAT ", length %u", offset, length);
2647
2648   /* catch any reads beyond the size of the file here to make sure queue2
2649    * doesn't send seek events beyond the size of the file upstream, since
2650    * that would confuse elements such as souphttpsrc and/or http servers.
2651    * Demuxers often just loop until EOS at the end of the file to figure out
2652    * when they've read all the end-headers or index chunks. */
2653   if (G_UNLIKELY (offset >= queue->upstream_size)) {
2654     gst_queue2_update_upstream_size (queue);
2655     if (queue->upstream_size > 0 && offset >= queue->upstream_size)
2656       goto out_unexpected;
2657   }
2658
2659   if (G_UNLIKELY (offset + length > queue->upstream_size)) {
2660     gst_queue2_update_upstream_size (queue);
2661     if (queue->upstream_size > 0 && offset + length >= queue->upstream_size) {
2662       length = queue->upstream_size - offset;
2663       GST_DEBUG_OBJECT (queue, "adjusting length downto %d", length);
2664     }
2665   }
2666
2667   /* FIXME - function will block when the range is not yet available */
2668   ret = gst_queue2_create_read (queue, offset, length, buffer);
2669   GST_QUEUE2_MUTEX_UNLOCK (queue);
2670
2671   gst_object_unref (queue);
2672
2673   return ret;
2674
2675   /* ERRORS */
2676 out_flushing:
2677   {
2678     ret = queue->srcresult;
2679
2680     GST_DEBUG_OBJECT (queue, "we are flushing");
2681     GST_QUEUE2_MUTEX_UNLOCK (queue);
2682     gst_object_unref (queue);
2683     return ret;
2684   }
2685 out_unexpected:
2686   {
2687     GST_DEBUG_OBJECT (queue, "read beyond end of file");
2688     GST_QUEUE2_MUTEX_UNLOCK (queue);
2689     gst_object_unref (queue);
2690     return GST_FLOW_UNEXPECTED;
2691   }
2692 }
2693
2694 static gboolean
2695 gst_queue2_src_checkgetrange_function (GstPad * pad)
2696 {
2697   GstQueue2 *queue;
2698   gboolean ret;
2699
2700   queue = GST_QUEUE2 (gst_pad_get_parent (pad));
2701
2702   /* we can operate in pull mode when we are using a tempfile */
2703   ret = !QUEUE_IS_USING_QUEUE (queue);
2704
2705   gst_object_unref (GST_OBJECT (queue));
2706
2707   return ret;
2708 }
2709
2710 /* sink currently only operates in push mode */
2711 static gboolean
2712 gst_queue2_sink_activate_push (GstPad * pad, gboolean active)
2713 {
2714   gboolean result = TRUE;
2715   GstQueue2 *queue;
2716
2717   queue = GST_QUEUE2 (gst_pad_get_parent (pad));
2718
2719   if (active) {
2720     GST_QUEUE2_MUTEX_LOCK (queue);
2721     GST_DEBUG_OBJECT (queue, "activating push mode");
2722     queue->srcresult = GST_FLOW_OK;
2723     queue->sinkresult = GST_FLOW_OK;
2724     queue->is_eos = FALSE;
2725     queue->unexpected = FALSE;
2726     reset_rate_timer (queue);
2727     GST_QUEUE2_MUTEX_UNLOCK (queue);
2728   } else {
2729     /* unblock chain function */
2730     GST_QUEUE2_MUTEX_LOCK (queue);
2731     GST_DEBUG_OBJECT (queue, "deactivating push mode");
2732     queue->srcresult = GST_FLOW_WRONG_STATE;
2733     queue->sinkresult = GST_FLOW_WRONG_STATE;
2734     gst_queue2_locked_flush (queue);
2735     GST_QUEUE2_MUTEX_UNLOCK (queue);
2736   }
2737
2738   gst_object_unref (queue);
2739
2740   return result;
2741 }
2742
2743 /* src operating in push mode, we start a task on the source pad that pushes out
2744  * buffers from the queue */
2745 static gboolean
2746 gst_queue2_src_activate_push (GstPad * pad, gboolean active)
2747 {
2748   gboolean result = FALSE;
2749   GstQueue2 *queue;
2750
2751   queue = GST_QUEUE2 (gst_pad_get_parent (pad));
2752
2753   if (active) {
2754     GST_QUEUE2_MUTEX_LOCK (queue);
2755     GST_DEBUG_OBJECT (queue, "activating push mode");
2756     queue->srcresult = GST_FLOW_OK;
2757     queue->sinkresult = GST_FLOW_OK;
2758     queue->is_eos = FALSE;
2759     queue->unexpected = FALSE;
2760     result = gst_pad_start_task (pad, (GstTaskFunction) gst_queue2_loop, pad);
2761     GST_QUEUE2_MUTEX_UNLOCK (queue);
2762   } else {
2763     /* unblock loop function */
2764     GST_QUEUE2_MUTEX_LOCK (queue);
2765     GST_DEBUG_OBJECT (queue, "deactivating push mode");
2766     queue->srcresult = GST_FLOW_WRONG_STATE;
2767     queue->sinkresult = GST_FLOW_WRONG_STATE;
2768     /* the item add signal will unblock */
2769     GST_QUEUE2_SIGNAL_ADD (queue);
2770     GST_QUEUE2_MUTEX_UNLOCK (queue);
2771
2772     /* step 2, make sure streaming finishes */
2773     result = gst_pad_stop_task (pad);
2774   }
2775
2776   gst_object_unref (queue);
2777
2778   return result;
2779 }
2780
2781 /* pull mode, downstream will call our getrange function */
2782 static gboolean
2783 gst_queue2_src_activate_pull (GstPad * pad, gboolean active)
2784 {
2785   gboolean result;
2786   GstQueue2 *queue;
2787
2788   queue = GST_QUEUE2 (gst_pad_get_parent (pad));
2789
2790   if (active) {
2791     GST_QUEUE2_MUTEX_LOCK (queue);
2792     if (!QUEUE_IS_USING_QUEUE (queue)) {
2793       if (QUEUE_IS_USING_TEMP_FILE (queue)) {
2794         /* open the temp file now */
2795         result = gst_queue2_open_temp_location_file (queue);
2796       } else if (!queue->ring_buffer) {
2797         queue->ring_buffer = g_malloc (queue->ring_buffer_max_size);
2798         result = !!queue->ring_buffer;
2799       } else {
2800         result = TRUE;
2801       }
2802
2803       GST_DEBUG_OBJECT (queue, "activating pull mode");
2804       init_ranges (queue);
2805       queue->srcresult = GST_FLOW_OK;
2806       queue->sinkresult = GST_FLOW_OK;
2807       queue->is_eos = FALSE;
2808       queue->unexpected = FALSE;
2809       queue->upstream_size = 0;
2810       GST_QUEUE2_MUTEX_UNLOCK (queue);
2811     } else {
2812       GST_QUEUE2_MUTEX_LOCK (queue);
2813       GST_DEBUG_OBJECT (queue, "no temp file, cannot activate pull mode");
2814       /* this is not allowed, we cannot operate in pull mode without a temp
2815        * file. */
2816       queue->srcresult = GST_FLOW_WRONG_STATE;
2817       queue->sinkresult = GST_FLOW_WRONG_STATE;
2818       result = FALSE;
2819       GST_QUEUE2_MUTEX_UNLOCK (queue);
2820     }
2821   } else {
2822     GST_QUEUE2_MUTEX_LOCK (queue);
2823     GST_DEBUG_OBJECT (queue, "deactivating pull mode");
2824     queue->srcresult = GST_FLOW_WRONG_STATE;
2825     queue->sinkresult = GST_FLOW_WRONG_STATE;
2826     /* this will unlock getrange */
2827     GST_QUEUE2_SIGNAL_ADD (queue);
2828     result = TRUE;
2829     GST_QUEUE2_MUTEX_UNLOCK (queue);
2830   }
2831   gst_object_unref (queue);
2832
2833   return result;
2834 }
2835
2836 static GstStateChangeReturn
2837 gst_queue2_change_state (GstElement * element, GstStateChange transition)
2838 {
2839   GstQueue2 *queue;
2840   GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
2841
2842   queue = GST_QUEUE2 (element);
2843
2844   switch (transition) {
2845     case GST_STATE_CHANGE_NULL_TO_READY:
2846       break;
2847     case GST_STATE_CHANGE_READY_TO_PAUSED:
2848       GST_QUEUE2_MUTEX_LOCK (queue);
2849       if (!QUEUE_IS_USING_QUEUE (queue)) {
2850         if (QUEUE_IS_USING_TEMP_FILE (queue)) {
2851           if (!gst_queue2_open_temp_location_file (queue))
2852             ret = GST_STATE_CHANGE_FAILURE;
2853         } else {
2854           if (queue->ring_buffer) {
2855             g_free (queue->ring_buffer);
2856             queue->ring_buffer = NULL;
2857           }
2858           if (!(queue->ring_buffer = g_malloc (queue->ring_buffer_max_size)))
2859             ret = GST_STATE_CHANGE_FAILURE;
2860         }
2861         init_ranges (queue);
2862       }
2863       queue->segment_event_received = FALSE;
2864       queue->starting_segment = NULL;
2865       GST_QUEUE2_MUTEX_UNLOCK (queue);
2866       break;
2867     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
2868       break;
2869     default:
2870       break;
2871   }
2872
2873   if (ret == GST_STATE_CHANGE_FAILURE)
2874     return ret;
2875
2876   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
2877
2878   if (ret == GST_STATE_CHANGE_FAILURE)
2879     return ret;
2880
2881   switch (transition) {
2882     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
2883       break;
2884     case GST_STATE_CHANGE_PAUSED_TO_READY:
2885       GST_QUEUE2_MUTEX_LOCK (queue);
2886       if (!QUEUE_IS_USING_QUEUE (queue)) {
2887         if (QUEUE_IS_USING_TEMP_FILE (queue)) {
2888           gst_queue2_close_temp_location_file (queue);
2889         } else if (queue->ring_buffer) {
2890           g_free (queue->ring_buffer);
2891           queue->ring_buffer = NULL;
2892         }
2893         clean_ranges (queue);
2894       }
2895       if (queue->starting_segment != NULL) {
2896         gst_event_unref (queue->starting_segment);
2897         queue->starting_segment = NULL;
2898       }
2899       GST_QUEUE2_MUTEX_UNLOCK (queue);
2900       break;
2901     case GST_STATE_CHANGE_READY_TO_NULL:
2902       break;
2903     default:
2904       break;
2905   }
2906
2907   return ret;
2908 }
2909
2910 /* changing the capacity of the queue must wake up
2911  * the _chain function, it might have more room now
2912  * to store the buffer/event in the queue */
2913 #define QUEUE_CAPACITY_CHANGE(q)\
2914   GST_QUEUE2_SIGNAL_DEL (queue);
2915
2916 /* Changing the minimum required fill level must
2917  * wake up the _loop function as it might now
2918  * be able to preceed.
2919  */
2920 #define QUEUE_THRESHOLD_CHANGE(q)\
2921   GST_QUEUE2_SIGNAL_ADD (queue);
2922
2923 static void
2924 gst_queue2_set_temp_template (GstQueue2 * queue, const gchar * template)
2925 {
2926   GstState state;
2927
2928   /* the element must be stopped in order to do this */
2929   GST_OBJECT_LOCK (queue);
2930   state = GST_STATE (queue);
2931   if (state != GST_STATE_READY && state != GST_STATE_NULL)
2932     goto wrong_state;
2933   GST_OBJECT_UNLOCK (queue);
2934
2935   /* set new location */
2936   g_free (queue->temp_template);
2937   queue->temp_template = g_strdup (template);
2938
2939   return;
2940
2941 /* ERROR */
2942 wrong_state:
2943   {
2944     GST_WARNING_OBJECT (queue, "setting temp-template property in wrong state");
2945     GST_OBJECT_UNLOCK (queue);
2946   }
2947 }
2948
2949 static void
2950 gst_queue2_set_property (GObject * object,
2951     guint prop_id, const GValue * value, GParamSpec * pspec)
2952 {
2953   GstQueue2 *queue = GST_QUEUE2 (object);
2954
2955   /* someone could change levels here, and since this
2956    * affects the get/put funcs, we need to lock for safety. */
2957   GST_QUEUE2_MUTEX_LOCK (queue);
2958
2959   switch (prop_id) {
2960     case PROP_MAX_SIZE_BYTES:
2961       queue->max_level.bytes = g_value_get_uint (value);
2962       QUEUE_CAPACITY_CHANGE (queue);
2963       break;
2964     case PROP_MAX_SIZE_BUFFERS:
2965       queue->max_level.buffers = g_value_get_uint (value);
2966       QUEUE_CAPACITY_CHANGE (queue);
2967       break;
2968     case PROP_MAX_SIZE_TIME:
2969       queue->max_level.time = g_value_get_uint64 (value);
2970       /* set rate_time to the same value. We use an extra field in the level
2971        * structure so that we can easily access and compare it */
2972       queue->max_level.rate_time = queue->max_level.time;
2973       QUEUE_CAPACITY_CHANGE (queue);
2974       break;
2975     case PROP_USE_BUFFERING:
2976       queue->use_buffering = g_value_get_boolean (value);
2977       break;
2978     case PROP_USE_RATE_ESTIMATE:
2979       queue->use_rate_estimate = g_value_get_boolean (value);
2980       break;
2981     case PROP_LOW_PERCENT:
2982       queue->low_percent = g_value_get_int (value);
2983       break;
2984     case PROP_HIGH_PERCENT:
2985       queue->high_percent = g_value_get_int (value);
2986       break;
2987     case PROP_TEMP_TEMPLATE:
2988       gst_queue2_set_temp_template (queue, g_value_get_string (value));
2989       break;
2990     case PROP_TEMP_LOCATION:
2991       g_free (queue->temp_location);
2992       queue->temp_location = g_value_dup_string (value);
2993       /* you can set the property back to NULL to make it use the temp-tmpl
2994        * property. */
2995       queue->temp_location_set = queue->temp_location != NULL;
2996       break;
2997     case PROP_TEMP_REMOVE:
2998       queue->temp_remove = g_value_get_boolean (value);
2999       break;
3000     case PROP_RING_BUFFER_MAX_SIZE:
3001       queue->ring_buffer_max_size = g_value_get_uint64 (value);
3002       break;
3003     default:
3004       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
3005       break;
3006   }
3007
3008   GST_QUEUE2_MUTEX_UNLOCK (queue);
3009 }
3010
3011 static void
3012 gst_queue2_get_property (GObject * object,
3013     guint prop_id, GValue * value, GParamSpec * pspec)
3014 {
3015   GstQueue2 *queue = GST_QUEUE2 (object);
3016
3017   GST_QUEUE2_MUTEX_LOCK (queue);
3018
3019   switch (prop_id) {
3020     case PROP_CUR_LEVEL_BYTES:
3021       g_value_set_uint (value, queue->cur_level.bytes);
3022       break;
3023     case PROP_CUR_LEVEL_BUFFERS:
3024       g_value_set_uint (value, queue->cur_level.buffers);
3025       break;
3026     case PROP_CUR_LEVEL_TIME:
3027       g_value_set_uint64 (value, queue->cur_level.time);
3028       break;
3029     case PROP_MAX_SIZE_BYTES:
3030       g_value_set_uint (value, queue->max_level.bytes);
3031       break;
3032     case PROP_MAX_SIZE_BUFFERS:
3033       g_value_set_uint (value, queue->max_level.buffers);
3034       break;
3035     case PROP_MAX_SIZE_TIME:
3036       g_value_set_uint64 (value, queue->max_level.time);
3037       break;
3038     case PROP_USE_BUFFERING:
3039       g_value_set_boolean (value, queue->use_buffering);
3040       break;
3041     case PROP_USE_RATE_ESTIMATE:
3042       g_value_set_boolean (value, queue->use_rate_estimate);
3043       break;
3044     case PROP_LOW_PERCENT:
3045       g_value_set_int (value, queue->low_percent);
3046       break;
3047     case PROP_HIGH_PERCENT:
3048       g_value_set_int (value, queue->high_percent);
3049       break;
3050     case PROP_TEMP_TEMPLATE:
3051       g_value_set_string (value, queue->temp_template);
3052       break;
3053     case PROP_TEMP_LOCATION:
3054       g_value_set_string (value, queue->temp_location);
3055       break;
3056     case PROP_TEMP_REMOVE:
3057       g_value_set_boolean (value, queue->temp_remove);
3058       break;
3059     case PROP_RING_BUFFER_MAX_SIZE:
3060       g_value_set_uint64 (value, queue->ring_buffer_max_size);
3061       break;
3062     default:
3063       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
3064       break;
3065   }
3066
3067   GST_QUEUE2_MUTEX_UNLOCK (queue);
3068 }