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