plugins/elements/gstqueue.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *                    2003 Colin Walters <cwalters@gnome.org>
   5  *                    2005 Wim Taymans <wim@fluendo.com>
   6  *
   7  * gstqueue.c:
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Library General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2 of the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Library General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Library General Public
  20  * License along with this library; if not, write to the
  21  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  22  * Boston, MA 02110-1301, USA.
  23  */
  24
  25 /**
  26  * SECTION:element-queue
  27  *
  28  * Data is queued until one of the limits specified by the
  29  * #GstQueue:max-size-buffers, #GstQueue:max-size-bytes and/or
  30  * #GstQueue:max-size-time properties has been reached. Any attempt to push
  31  * more buffers into the queue will block the pushing thread until more space
  32  * becomes available.
  33  *
  34  * The queue will create a new thread on the source pad to decouple the
  35  * processing on sink and source pad.
  36  *
  37  * You can query how many buffers are queued by reading the
  38  * #GstQueue:current-level-buffers property. You can track changes
  39  * by connecting to the notify::current-level-buffers signal (which
  40  * like all signals will be emitted from the streaming thread). The same
  41  * applies to the #GstQueue:current-level-time and
  42  * #GstQueue:current-level-bytes properties.
  43  *
  44  * The default queue size limits are 200 buffers, 10MB of data, or
  45  * one second worth of data, whichever is reached first.
  46  *
  47  * As said earlier, the queue blocks by default when one of the specified
  48  * maximums (bytes, time, buffers) has been reached. You can set the
  49  * #GstQueue:leaky property to specify that instead of blocking it should
  50  * leak (drop) new or old buffers.
  51  *
  52  * The #GstQueue::underrun signal is emitted when the queue has less data than
  53  * the specified minimum thresholds require (by default: when the queue is
  54  * empty). The #GstQueue::overrun signal is emitted when the queue is filled
  55  * up. Both signals are emitted from the context of the streaming thread.
  56  */
  57
  58 #include "gst/gst_private.h"
  59
  60 #include <gst/gst.h>
  61 #include "gstqueue.h"
  62
  63 #include "../../gst/gst-i18n-lib.h"
  64 #include "../../gst/glib-compat-private.h"
  65
  66 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
  67     GST_PAD_SINK,
  68     GST_PAD_ALWAYS,
  69     GST_STATIC_CAPS_ANY);
  70
  71 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
  72     GST_PAD_SRC,
  73     GST_PAD_ALWAYS,
  74     GST_STATIC_CAPS_ANY);
  75
  76 GST_DEBUG_CATEGORY_STATIC (queue_debug);
  77 #define GST_CAT_DEFAULT (queue_debug)
  78 GST_DEBUG_CATEGORY_STATIC (queue_dataflow);
  79
  80 #define STATUS(queue, pad, msg) \
  81   GST_CAT_LOG_OBJECT (queue_dataflow, queue, \
  82                       "(%s:%s) " msg ": %u of %u-%u buffers, %u of %u-%u " \
  83                       "bytes, %" G_GUINT64_FORMAT " of %" G_GUINT64_FORMAT \
  84                       "-%" G_GUINT64_FORMAT " ns, %u items", \
  85                       GST_DEBUG_PAD_NAME (pad), \
  86                       queue->cur_level.buffers, \
  87                       queue->min_threshold.buffers, \
  88                       queue->max_size.buffers, \
  89                       queue->cur_level.bytes, \
  90                       queue->min_threshold.bytes, \
  91                       queue->max_size.bytes, \
  92                       queue->cur_level.time, \
  93                       queue->min_threshold.time, \
  94                       queue->max_size.time, \
  95                       gst_queue_array_get_length (queue->queue))
  96
  97 /* Queue signals and args */
  98 enum
  99 {
 100   SIGNAL_UNDERRUN,
 101   SIGNAL_RUNNING,
 102   SIGNAL_OVERRUN,
 103   SIGNAL_PUSHING,
 104   LAST_SIGNAL
 105 };
 106
 107 enum
 108 {
 109   PROP_0,
 110   /* FIXME: don't we have another way of doing this
 111    * "Gstreamer format" (frame/byte/time) queries? */
 112   PROP_CUR_LEVEL_BUFFERS,
 113   PROP_CUR_LEVEL_BYTES,
 114   PROP_CUR_LEVEL_TIME,
 115   PROP_MAX_SIZE_BUFFERS,
 116   PROP_MAX_SIZE_BYTES,
 117   PROP_MAX_SIZE_TIME,
 118   PROP_MIN_THRESHOLD_BUFFERS,
 119   PROP_MIN_THRESHOLD_BYTES,
 120   PROP_MIN_THRESHOLD_TIME,
 121   PROP_LEAKY,
 122   PROP_SILENT,
 123   PROP_FLUSH_ON_EOS
 124 };
 125
 126 /* default property values */
 127 #define DEFAULT_MAX_SIZE_BUFFERS  200   /* 200 buffers */
 128 #define DEFAULT_MAX_SIZE_BYTES    (10 * 1024 * 1024)    /* 10 MB       */
 129 #define DEFAULT_MAX_SIZE_TIME     GST_SECOND    /* 1 second    */
 130
 131 #define GST_QUEUE_MUTEX_LOCK(q) G_STMT_START {                          \
 132   g_mutex_lock (&q->qlock);                                              \
 133 } G_STMT_END
 134
 135 #define GST_QUEUE_MUTEX_LOCK_CHECK(q,label) G_STMT_START {              \
 136   GST_QUEUE_MUTEX_LOCK (q);                                             \
 137   if (q->srcresult != GST_FLOW_OK)                                      \
 138     goto label;                                                         \
 139 } G_STMT_END
 140
 141 #define GST_QUEUE_MUTEX_UNLOCK(q) G_STMT_START {                        \
 142   g_mutex_unlock (&q->qlock);                                            \
 143 } G_STMT_END
 144
 145 #define GST_QUEUE_WAIT_DEL_CHECK(q, label) G_STMT_START {               \
 146   STATUS (q, q->sinkpad, "wait for DEL");                               \
 147   q->waiting_del = TRUE;                                                \
 148   g_cond_wait (&q->item_del, &q->qlock);                                  \
 149   q->waiting_del = FALSE;                                               \
 150   if (q->srcresult != GST_FLOW_OK) {                                    \
 151     STATUS (q, q->srcpad, "received DEL wakeup");                       \
 152     goto label;                                                         \
 153   }                                                                     \
 154   STATUS (q, q->sinkpad, "received DEL");                               \
 155 } G_STMT_END
 156
 157 #define GST_QUEUE_WAIT_ADD_CHECK(q, label) G_STMT_START {               \
 158   STATUS (q, q->srcpad, "wait for ADD");                                \
 159   q->waiting_add = TRUE;                                                \
 160   g_cond_wait (&q->item_add, &q->qlock);                                  \
 161   q->waiting_add = FALSE;                                               \
 162   if (q->srcresult != GST_FLOW_OK) {                                    \
 163     STATUS (q, q->srcpad, "received ADD wakeup");                       \
 164     goto label;                                                         \
 165   }                                                                     \
 166   STATUS (q, q->srcpad, "received ADD");                                \
 167 } G_STMT_END
 168
 169 #define GST_QUEUE_SIGNAL_DEL(q) G_STMT_START {                          \
 170   if (q->waiting_del) {                                                 \
 171     STATUS (q, q->srcpad, "signal DEL");                                \
 172     g_cond_signal (&q->item_del);                                        \
 173   }                                                                     \
 174 } G_STMT_END
 175
 176 #define GST_QUEUE_SIGNAL_ADD(q) G_STMT_START {                          \
 177   if (q->waiting_add) {                                                 \
 178     STATUS (q, q->sinkpad, "signal ADD");                               \
 179     g_cond_signal (&q->item_add);                                        \
 180   }                                                                     \
 181 } G_STMT_END
 182
 183 #define _do_init \
 184     GST_DEBUG_CATEGORY_INIT (queue_debug, "queue", 0, "queue element"); \
 185     GST_DEBUG_CATEGORY_INIT (queue_dataflow, "queue_dataflow", 0, \
 186         "dataflow inside the queue element");
 187 #define gst_queue_parent_class parent_class
 188 G_DEFINE_TYPE_WITH_CODE (GstQueue, gst_queue, GST_TYPE_ELEMENT, _do_init);
 189
 190 static void gst_queue_finalize (GObject * object);
 191 static void gst_queue_set_property (GObject * object,
 192     guint prop_id, const GValue * value, GParamSpec * pspec);
 193 static void gst_queue_get_property (GObject * object,
 194     guint prop_id, GValue * value, GParamSpec * pspec);
 195
 196 static GstFlowReturn gst_queue_chain (GstPad * pad, GstObject * parent,
 197     GstBuffer * buffer);
 198 static GstFlowReturn gst_queue_push_one (GstQueue * queue);
 199 static void gst_queue_loop (GstPad * pad);
 200
 201 static gboolean gst_queue_handle_sink_event (GstPad * pad, GstObject * parent,
 202     GstEvent * event);
 203 static gboolean gst_queue_handle_sink_query (GstPad * pad, GstObject * parent,
 204     GstQuery * query);
 205
 206 static gboolean gst_queue_handle_src_event (GstPad * pad, GstObject * parent,
 207     GstEvent * event);
 208 static gboolean gst_queue_handle_src_query (GstPad * pad, GstObject * parent,
 209     GstQuery * query);
 210
 211 static void gst_queue_locked_flush (GstQueue * queue, gboolean full);
 212
 213 static gboolean gst_queue_src_activate_mode (GstPad * pad, GstObject * parent,
 214     GstPadMode mode, gboolean active);
 215 static gboolean gst_queue_sink_activate_mode (GstPad * pad, GstObject * parent,
 216     GstPadMode mode, gboolean active);
 217
 218 static gboolean gst_queue_is_empty (GstQueue * queue);
 219 static gboolean gst_queue_is_filled (GstQueue * queue);
 220
 221
 222 typedef struct
 223 {
 224   gboolean is_query;
 225   GstMiniObject *item;
 226   gsize size;
 227 } GstQueueItem;
 228
 229 #define GST_TYPE_QUEUE_LEAKY (queue_leaky_get_type ())
 230
 231 static GType
 232 queue_leaky_get_type (void)
 233 {
 234   static GType queue_leaky_type = 0;
 235   static const GEnumValue queue_leaky[] = {
 236     {GST_QUEUE_NO_LEAK, "Not Leaky", "no"},
 237     {GST_QUEUE_LEAK_UPSTREAM, "Leaky on upstream (new buffers)", "upstream"},
 238     {GST_QUEUE_LEAK_DOWNSTREAM, "Leaky on downstream (old buffers)",
 239         "downstream"},
 240     {0, NULL, NULL},
 241   };
 242
 243   if (!queue_leaky_type) {
 244     queue_leaky_type = g_enum_register_static ("GstQueueLeaky", queue_leaky);
 245   }
 246   return queue_leaky_type;
 247 }
 248
 249 static guint gst_queue_signals[LAST_SIGNAL] = { 0 };
 250
 251 static void
 252 gst_queue_class_init (GstQueueClass * klass)
 253 {
 254   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 255   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
 256
 257   gobject_class->set_property = gst_queue_set_property;
 258   gobject_class->get_property = gst_queue_get_property;
 259
 260   /* signals */
 261   /**
 262    * GstQueue::underrun:
 263    * @queue: the queue instance
 264    *
 265    * Reports that the buffer became empty (underrun).
 266    * A buffer is empty if the total amount of data inside it (num-buffers, time,
 267    * size) is lower than the boundary values which can be set through the
 268    * GObject properties.
 269    */
 270   gst_queue_signals[SIGNAL_UNDERRUN] =
 271       g_signal_new ("underrun", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_FIRST,
 272       G_STRUCT_OFFSET (GstQueueClass, underrun), NULL, NULL,
 273       g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
 274   /**
 275    * GstQueue::running:
 276    * @queue: the queue instance
 277    *
 278    * Reports that enough (min-threshold) data is in the queue. Use this signal
 279    * together with the underrun signal to pause the pipeline on underrun and
 280    * wait for the queue to fill-up before resume playback.
 281    */
 282   gst_queue_signals[SIGNAL_RUNNING] =
 283       g_signal_new ("running", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_FIRST,
 284       G_STRUCT_OFFSET (GstQueueClass, running), NULL, NULL,
 285       g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
 286   /**
 287    * GstQueue::overrun:
 288    * @queue: the queue instance
 289    *
 290    * Reports that the buffer became full (overrun).
 291    * A buffer is full if the total amount of data inside it (num-buffers, time,
 292    * size) is higher than the boundary values which can be set through the
 293    * GObject properties.
 294    */
 295   gst_queue_signals[SIGNAL_OVERRUN] =
 296       g_signal_new ("overrun", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_FIRST,
 297       G_STRUCT_OFFSET (GstQueueClass, overrun), NULL, NULL,
 298       g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
 299   /**
 300    * GstQueue::pushing:
 301    * @queue: the queue instance
 302    *
 303    * Reports when the queue has enough data to start pushing data again on the
 304    * source pad.
 305    */
 306   gst_queue_signals[SIGNAL_PUSHING] =
 307       g_signal_new ("pushing", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_FIRST,
 308       G_STRUCT_OFFSET (GstQueueClass, pushing), NULL, NULL,
 309       g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
 310
 311   /* properties */
 312   g_object_class_install_property (gobject_class, PROP_CUR_LEVEL_BYTES,
 313       g_param_spec_uint ("current-level-bytes", "Current level (kB)",
 314           "Current amount of data in the queue (bytes)",
 315           0, G_MAXUINT, 0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 316   g_object_class_install_property (gobject_class, PROP_CUR_LEVEL_BUFFERS,
 317       g_param_spec_uint ("current-level-buffers", "Current level (buffers)",
 318           "Current number of buffers in the queue",
 319           0, G_MAXUINT, 0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 320   g_object_class_install_property (gobject_class, PROP_CUR_LEVEL_TIME,
 321       g_param_spec_uint64 ("current-level-time", "Current level (ns)",
 322           "Current amount of data in the queue (in ns)",
 323           0, G_MAXUINT64, 0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 324
 325   g_object_class_install_property (gobject_class, PROP_MAX_SIZE_BYTES,
 326       g_param_spec_uint ("max-size-bytes", "Max. size (kB)",
 327           "Max. amount of data in the queue (bytes, 0=disable)",
 328           0, G_MAXUINT, DEFAULT_MAX_SIZE_BYTES,
 329           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 330   g_object_class_install_property (gobject_class, PROP_MAX_SIZE_BUFFERS,
 331       g_param_spec_uint ("max-size-buffers", "Max. size (buffers)",
 332           "Max. number of buffers in the queue (0=disable)", 0, G_MAXUINT,
 333           DEFAULT_MAX_SIZE_BUFFERS,
 334           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 335   g_object_class_install_property (gobject_class, PROP_MAX_SIZE_TIME,
 336       g_param_spec_uint64 ("max-size-time", "Max. size (ns)",
 337           "Max. amount of data in the queue (in ns, 0=disable)", 0, G_MAXUINT64,
 338           DEFAULT_MAX_SIZE_TIME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 339
 340   g_object_class_install_property (gobject_class, PROP_MIN_THRESHOLD_BYTES,
 341       g_param_spec_uint ("min-threshold-bytes", "Min. threshold (kB)",
 342           "Min. amount of data in the queue to allow reading (bytes, 0=disable)",
 343           0, G_MAXUINT, 0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 344   g_object_class_install_property (gobject_class, PROP_MIN_THRESHOLD_BUFFERS,
 345       g_param_spec_uint ("min-threshold-buffers", "Min. threshold (buffers)",
 346           "Min. number of buffers in the queue to allow reading (0=disable)",
 347           0, G_MAXUINT, 0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 348   g_object_class_install_property (gobject_class, PROP_MIN_THRESHOLD_TIME,
 349       g_param_spec_uint64 ("min-threshold-time", "Min. threshold (ns)",
 350           "Min. amount of data in the queue to allow reading (in ns, 0=disable)",
 351           0, G_MAXUINT64, 0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 352
 353   g_object_class_install_property (gobject_class, PROP_LEAKY,
 354       g_param_spec_enum ("leaky", "Leaky",
 355           "Where the queue leaks, if at all",
 356           GST_TYPE_QUEUE_LEAKY, GST_QUEUE_NO_LEAK,
 357           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 358
 359   /**
 360    * GstQueue:silent
 361    *
 362    * Don't emit queue signals. Makes queues more lightweight if no signals are
 363    * needed.
 364    */
 365   g_object_class_install_property (gobject_class, PROP_SILENT,
 366       g_param_spec_boolean ("silent", "Silent",
 367           "Don't emit queue signals", FALSE,
 368           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 369
 370   /**
 371    * GstQueue:flush-on-eos
 372    *
 373    * Discard all data in the queue when an EOS event is received, and pass
 374    * on the EOS event as soon as possible (instead of waiting until all
 375    * buffers in the queue have been processed, which is the default behaviour).
 376    *
 377    * Flushing the queue on EOS might be useful when capturing and encoding
 378    * from a live source, to finish up the recording quickly in cases when
 379    * the encoder is slow. Note that this might mean some data from the end of
 380    * the recording data might be lost though (never more than the configured
 381    * max. sizes though).
 382    *
 383    * Since: 1.2
 384    */
 385   g_object_class_install_property (gobject_class, PROP_FLUSH_ON_EOS,
 386       g_param_spec_boolean ("flush-on-eos", "Flush on EOS",
 387           "Discard all data in the queue when an EOS event is received", FALSE,
 388           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 389
 390   gobject_class->finalize = gst_queue_finalize;
 391
 392   gst_element_class_set_static_metadata (gstelement_class,
 393       "Queue",
 394       "Generic", "Simple data queue", "Erik Walthinsen <omega@cse.ogi.edu>");
 395   gst_element_class_add_pad_template (gstelement_class,
 396       gst_static_pad_template_get (&srctemplate));
 397   gst_element_class_add_pad_template (gstelement_class,
 398       gst_static_pad_template_get (&sinktemplate));
 399
 400   /* Registering debug symbols for function pointers */
 401   GST_DEBUG_REGISTER_FUNCPTR (gst_queue_src_activate_mode);
 402   GST_DEBUG_REGISTER_FUNCPTR (gst_queue_handle_sink_event);
 403   GST_DEBUG_REGISTER_FUNCPTR (gst_queue_handle_sink_query);
 404   GST_DEBUG_REGISTER_FUNCPTR (gst_queue_handle_src_event);
 405   GST_DEBUG_REGISTER_FUNCPTR (gst_queue_handle_src_query);
 406   GST_DEBUG_REGISTER_FUNCPTR (gst_queue_chain);
 407 }
 408
 409 static void
 410 gst_queue_init (GstQueue * queue)
 411 {
 412   queue->sinkpad = gst_pad_new_from_static_template (&sinktemplate, "sink");
 413
 414   gst_pad_set_chain_function (queue->sinkpad, gst_queue_chain);
 415   gst_pad_set_activatemode_function (queue->sinkpad,
 416       gst_queue_sink_activate_mode);
 417   gst_pad_set_event_function (queue->sinkpad, gst_queue_handle_sink_event);
 418   gst_pad_set_query_function (queue->sinkpad, gst_queue_handle_sink_query);
 419   GST_PAD_SET_PROXY_CAPS (queue->sinkpad);
 420   gst_element_add_pad (GST_ELEMENT (queue), queue->sinkpad);
 421
 422   queue->srcpad = gst_pad_new_from_static_template (&srctemplate, "src");
 423
 424   gst_pad_set_activatemode_function (queue->srcpad,
 425       gst_queue_src_activate_mode);
 426   gst_pad_set_event_function (queue->srcpad, gst_queue_handle_src_event);
 427   gst_pad_set_query_function (queue->srcpad, gst_queue_handle_src_query);
 428   GST_PAD_SET_PROXY_CAPS (queue->srcpad);
 429   gst_element_add_pad (GST_ELEMENT (queue), queue->srcpad);
 430
 431   GST_QUEUE_CLEAR_LEVEL (queue->cur_level);
 432   queue->max_size.buffers = DEFAULT_MAX_SIZE_BUFFERS;
 433   queue->max_size.bytes = DEFAULT_MAX_SIZE_BYTES;
 434   queue->max_size.time = DEFAULT_MAX_SIZE_TIME;
 435   GST_QUEUE_CLEAR_LEVEL (queue->min_threshold);
 436   GST_QUEUE_CLEAR_LEVEL (queue->orig_min_threshold);
 437   gst_segment_init (&queue->sink_segment, GST_FORMAT_TIME);
 438   gst_segment_init (&queue->src_segment, GST_FORMAT_TIME);
 439   queue->head_needs_discont = queue->tail_needs_discont = FALSE;
 440
 441   queue->leaky = GST_QUEUE_NO_LEAK;
 442   queue->srcresult = GST_FLOW_FLUSHING;
 443
 444   g_mutex_init (&queue->qlock);
 445   g_cond_init (&queue->item_add);
 446   g_cond_init (&queue->item_del);
 447   g_cond_init (&queue->query_handled);
 448
 449   queue->queue = gst_queue_array_new (DEFAULT_MAX_SIZE_BUFFERS * 3 / 2);
 450
 451   queue->sinktime = GST_CLOCK_TIME_NONE;
 452   queue->srctime = GST_CLOCK_TIME_NONE;
 453
 454   queue->sink_tainted = TRUE;
 455   queue->src_tainted = TRUE;
 456
 457   queue->newseg_applied_to_src = FALSE;
 458
 459   GST_DEBUG_OBJECT (queue,
 460       "initialized queue's not_empty & not_full conditions");
 461 }
 462
 463 /* called only once, as opposed to dispose */
 464 static void
 465 gst_queue_finalize (GObject * object)
 466 {
 467   GstQueue *queue = GST_QUEUE (object);
 468
 469   GST_DEBUG_OBJECT (queue, "finalizing queue");
 470
 471   while (!gst_queue_array_is_empty (queue->queue)) {
 472     GstQueueItem *qitem = gst_queue_array_pop_head (queue->queue);
 473     /* FIXME: if it's a query, shouldn't we unref that too? */
 474     if (!qitem->is_query)
 475       gst_mini_object_unref (qitem->item);
 476     g_slice_free (GstQueueItem, qitem);
 477   }
 478   gst_queue_array_free (queue->queue);
 479
 480   g_mutex_clear (&queue->qlock);
 481   g_cond_clear (&queue->item_add);
 482   g_cond_clear (&queue->item_del);
 483   g_cond_clear (&queue->query_handled);
 484
 485   G_OBJECT_CLASS (parent_class)->finalize (object);
 486 }
 487
 488 /* calculate the diff between running time on the sink and src of the queue.
 489  * This is the total amount of time in the queue. */
 490 static void
 491 update_time_level (GstQueue * queue)
 492 {
 493   gint64 sink_time, src_time;
 494
 495   if (queue->sink_tainted) {
 496     GST_LOG_OBJECT (queue, "update sink time");
 497     queue->sinktime =
 498         gst_segment_to_running_time (&queue->sink_segment, GST_FORMAT_TIME,
 499         queue->sink_segment.position);
 500     queue->sink_tainted = FALSE;
 501   }
 502   sink_time = queue->sinktime;
 503
 504   if (queue->src_tainted) {
 505     GST_LOG_OBJECT (queue, "update src time");
 506     queue->srctime =
 507         gst_segment_to_running_time (&queue->src_segment, GST_FORMAT_TIME,
 508         queue->src_segment.position);
 509     queue->src_tainted = FALSE;
 510   }
 511   src_time = queue->srctime;
 512
 513   GST_LOG_OBJECT (queue, "sink %" GST_TIME_FORMAT ", src %" GST_TIME_FORMAT,
 514       GST_TIME_ARGS (sink_time), GST_TIME_ARGS (src_time));
 515
 516   if (sink_time >= src_time)
 517     queue->cur_level.time = sink_time - src_time;
 518   else
 519     queue->cur_level.time = 0;
 520 }
 521
 522 /* take a SEGMENT event and apply the values to segment, updating the time
 523  * level of queue. */
 524 static void
 525 apply_segment (GstQueue * queue, GstEvent * event, GstSegment * segment,
 526     gboolean sink)
 527 {
 528   gst_event_copy_segment (event, segment);
 529
 530   /* now configure the values, we use these to track timestamps on the
 531    * sinkpad. */
 532   if (segment->format != GST_FORMAT_TIME) {
 533     /* non-time format, pretent the current time segment is closed with a
 534      * 0 start and unknown stop time. */
 535     segment->format = GST_FORMAT_TIME;
 536     segment->start = 0;
 537     segment->stop = -1;
 538     segment->time = 0;
 539   }
 540   if (sink)
 541     queue->sink_tainted = TRUE;
 542   else
 543     queue->src_tainted = TRUE;
 544
 545   GST_DEBUG_OBJECT (queue, "configured SEGMENT %" GST_SEGMENT_FORMAT, segment);
 546
 547   /* segment can update the time level of the queue */
 548   update_time_level (queue);
 549 }
 550
 551 /* take a buffer and update segment, updating the time level of the queue. */
 552 static void
 553 apply_buffer (GstQueue * queue, GstBuffer * buffer, GstSegment * segment,
 554     gboolean with_duration, gboolean sink)
 555 {
 556   GstClockTime duration, timestamp;
 557
 558   timestamp = GST_BUFFER_TIMESTAMP (buffer);
 559   duration = GST_BUFFER_DURATION (buffer);
 560
 561   /* if no timestamp is set, assume it's continuous with the previous
 562    * time */
 563   if (timestamp == GST_CLOCK_TIME_NONE)
 564     timestamp = segment->position;
 565
 566   /* add duration */
 567   if (with_duration && duration != GST_CLOCK_TIME_NONE)
 568     timestamp += duration;
 569
 570   GST_LOG_OBJECT (queue, "position updated to %" GST_TIME_FORMAT,
 571       GST_TIME_ARGS (timestamp));
 572
 573   segment->position = timestamp;
 574   if (sink)
 575     queue->sink_tainted = TRUE;
 576   else
 577     queue->src_tainted = TRUE;
 578
 579
 580   /* calc diff with other end */
 581   update_time_level (queue);
 582 }
 583
 584 static void
 585 gst_queue_locked_flush (GstQueue * queue, gboolean full)
 586 {
 587   while (!gst_queue_array_is_empty (queue->queue)) {
 588     GstQueueItem *qitem = gst_queue_array_pop_head (queue->queue);
 589
 590     /* Then lose another reference because we are supposed to destroy that
 591        data when flushing */
 592     if (!full && !qitem->is_query && GST_IS_EVENT (qitem->item)
 593         && GST_EVENT_IS_STICKY (qitem->item)
 594         && GST_EVENT_TYPE (qitem->item) != GST_EVENT_SEGMENT
 595         && GST_EVENT_TYPE (qitem->item) != GST_EVENT_EOS) {
 596       gst_pad_store_sticky_event (queue->srcpad, GST_EVENT_CAST (qitem->item));
 597     }
 598     if (!qitem->is_query)
 599       gst_mini_object_unref (qitem->item);
 600     g_slice_free (GstQueueItem, qitem);
 601   }
 602   queue->last_query = FALSE;
 603   g_cond_signal (&queue->query_handled);
 604   GST_QUEUE_CLEAR_LEVEL (queue->cur_level);
 605   queue->min_threshold.buffers = queue->orig_min_threshold.buffers;
 606   queue->min_threshold.bytes = queue->orig_min_threshold.bytes;
 607   queue->min_threshold.time = queue->orig_min_threshold.time;
 608   gst_segment_init (&queue->sink_segment, GST_FORMAT_TIME);
 609   gst_segment_init (&queue->src_segment, GST_FORMAT_TIME);
 610   queue->head_needs_discont = queue->tail_needs_discont = FALSE;
 611
 612   queue->sinktime = queue->srctime = GST_CLOCK_TIME_NONE;
 613   queue->sink_tainted = queue->src_tainted = TRUE;
 614
 615   /* we deleted a lot of something */
 616   GST_QUEUE_SIGNAL_DEL (queue);
 617 }
 618
 619 /* enqueue an item an update the level stats, with QUEUE_LOCK */
 620 static inline void
 621 gst_queue_locked_enqueue_buffer (GstQueue * queue, gpointer item)
 622 {
 623   GstQueueItem *qitem;
 624   GstBuffer *buffer = GST_BUFFER_CAST (item);
 625   gsize bsize = gst_buffer_get_size (buffer);
 626
 627   /* add buffer to the statistics */
 628   queue->cur_level.buffers++;
 629   queue->cur_level.bytes += bsize;
 630   apply_buffer (queue, buffer, &queue->sink_segment, TRUE, TRUE);
 631
 632   qitem = g_slice_new (GstQueueItem);
 633   qitem->item = item;
 634   qitem->is_query = FALSE;
 635   qitem->size = bsize;
 636   gst_queue_array_push_tail (queue->queue, qitem);
 637   GST_QUEUE_SIGNAL_ADD (queue);
 638 }
 639
 640 static inline void
 641 gst_queue_locked_enqueue_event (GstQueue * queue, gpointer item)
 642 {
 643   GstQueueItem *qitem;
 644   GstEvent *event = GST_EVENT_CAST (item);
 645
 646   switch (GST_EVENT_TYPE (event)) {
 647     case GST_EVENT_EOS:
 648       GST_CAT_LOG_OBJECT (queue_dataflow, queue, "got EOS from upstream");
 649       /* Zero the thresholds, this makes sure the queue is completely
 650        * filled and we can read all data from the queue. */
 651       if (queue->flush_on_eos)
 652         gst_queue_locked_flush (queue, FALSE);
 653       else
 654         GST_QUEUE_CLEAR_LEVEL (queue->min_threshold);
 655       /* mark the queue as EOS. This prevents us from accepting more data. */
 656       queue->eos = TRUE;
 657       break;
 658     case GST_EVENT_SEGMENT:
 659       apply_segment (queue, event, &queue->sink_segment, TRUE);
 660       /* if the queue is empty, apply sink segment on the source */
 661       if (gst_queue_array_is_empty (queue->queue)) {
 662         GST_CAT_LOG_OBJECT (queue_dataflow, queue, "Apply segment on srcpad");
 663         apply_segment (queue, event, &queue->src_segment, FALSE);
 664         queue->newseg_applied_to_src = TRUE;
 665       }
 666       /* a new segment allows us to accept more buffers if we got EOS
 667        * from downstream */
 668       queue->unexpected = FALSE;
 669       break;
 670     default:
 671       break;
 672   }
 673
 674   qitem = g_slice_new (GstQueueItem);
 675   qitem->item = item;
 676   qitem->is_query = FALSE;
 677   gst_queue_array_push_tail (queue->queue, qitem);
 678   GST_QUEUE_SIGNAL_ADD (queue);
 679 }
 680
 681 /* dequeue an item from the queue and update level stats, with QUEUE_LOCK */
 682 static GstMiniObject *
 683 gst_queue_locked_dequeue (GstQueue * queue)
 684 {
 685   GstQueueItem *qitem;
 686   GstMiniObject *item;
 687   gsize bufsize;
 688
 689   qitem = gst_queue_array_pop_head (queue->queue);
 690   if (qitem == NULL)
 691     goto no_item;
 692
 693   item = qitem->item;
 694   bufsize = qitem->size;
 695   g_slice_free (GstQueueItem, qitem);
 696
 697   if (GST_IS_BUFFER (item)) {
 698     GstBuffer *buffer = GST_BUFFER_CAST (item);
 699
 700     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
 701         "retrieved buffer %p from queue", buffer);
 702
 703     queue->cur_level.buffers--;
 704     queue->cur_level.bytes -= bufsize;
 705     apply_buffer (queue, buffer, &queue->src_segment, TRUE, FALSE);
 706
 707     /* if the queue is empty now, update the other side */
 708     if (queue->cur_level.buffers == 0)
 709       queue->cur_level.time = 0;
 710
 711   } else if (GST_IS_EVENT (item)) {
 712     GstEvent *event = GST_EVENT_CAST (item);
 713
 714     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
 715         "retrieved event %p from queue", event);
 716
 717     switch (GST_EVENT_TYPE (event)) {
 718       case GST_EVENT_EOS:
 719         /* queue is empty now that we dequeued the EOS */
 720         GST_QUEUE_CLEAR_LEVEL (queue->cur_level);
 721         break;
 722       case GST_EVENT_SEGMENT:
 723         /* apply newsegment if it has not already been applied */
 724         if (G_LIKELY (!queue->newseg_applied_to_src)) {
 725           apply_segment (queue, event, &queue->src_segment, FALSE);
 726         } else {
 727           queue->newseg_applied_to_src = FALSE;
 728         }
 729         break;
 730       default:
 731         break;
 732     }
 733   } else if (GST_IS_QUERY (item)) {
 734     GstQuery *query = GST_QUERY_CAST (item);
 735
 736     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
 737         "retrieved query %p from queue", query);
 738   } else {
 739     g_warning
 740         ("Unexpected item %p dequeued from queue %s (refcounting problem?)",
 741         item, GST_OBJECT_NAME (queue));
 742     item = NULL;
 743   }
 744   GST_QUEUE_SIGNAL_DEL (queue);
 745
 746   return item;
 747
 748   /* ERRORS */
 749 no_item:
 750   {
 751     GST_CAT_DEBUG_OBJECT (queue_dataflow, queue, "the queue is empty");
 752     return NULL;
 753   }
 754 }
 755
 756 static gboolean
 757 gst_queue_handle_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
 758 {
 759   gboolean ret = TRUE;
 760   GstQueue *queue;
 761
 762   queue = GST_QUEUE (parent);
 763
 764   switch (GST_EVENT_TYPE (event)) {
 765     case GST_EVENT_FLUSH_START:
 766       STATUS (queue, pad, "received flush start event");
 767       /* forward event */
 768       ret = gst_pad_push_event (queue->srcpad, event);
 769
 770       /* now unblock the chain function */
 771       GST_QUEUE_MUTEX_LOCK (queue);
 772       queue->srcresult = GST_FLOW_FLUSHING;
 773       /* unblock the loop and chain functions */
 774       GST_QUEUE_SIGNAL_ADD (queue);
 775       GST_QUEUE_SIGNAL_DEL (queue);
 776       queue->last_query = FALSE;
 777       g_cond_signal (&queue->query_handled);
 778       GST_QUEUE_MUTEX_UNLOCK (queue);
 779
 780       /* make sure it pauses, this should happen since we sent
 781        * flush_start downstream. */
 782       gst_pad_pause_task (queue->srcpad);
 783       GST_CAT_LOG_OBJECT (queue_dataflow, queue, "loop stopped");
 784       break;
 785     case GST_EVENT_FLUSH_STOP:
 786       STATUS (queue, pad, "received flush stop event");
 787       /* forward event */
 788       ret = gst_pad_push_event (queue->srcpad, event);
 789
 790       GST_QUEUE_MUTEX_LOCK (queue);
 791       gst_queue_locked_flush (queue, FALSE);
 792       queue->srcresult = GST_FLOW_OK;
 793       queue->eos = FALSE;
 794       queue->unexpected = FALSE;
 795       if (gst_pad_is_active (queue->srcpad)) {
 796         gst_pad_start_task (queue->srcpad, (GstTaskFunction) gst_queue_loop,
 797             queue->srcpad, NULL);
 798       } else {
 799         GST_INFO_OBJECT (queue->srcpad, "not re-starting task on srcpad, "
 800             "pad not active any longer");
 801       }
 802       GST_QUEUE_MUTEX_UNLOCK (queue);
 803
 804       STATUS (queue, pad, "after flush");
 805       break;
 806     default:
 807       if (GST_EVENT_IS_SERIALIZED (event)) {
 808         /* serialized events go in the queue */
 809         GST_QUEUE_MUTEX_LOCK (queue);
 810         if (queue->srcresult != GST_FLOW_OK) {
 811           /* Errors in sticky event pushing are no problem and ignored here
 812            * as they will cause more meaningful errors during data flow.
 813            * For EOS events, that are not followed by data flow, we still
 814            * return FALSE here though and report an error.
 815            */
 816           if (!GST_EVENT_IS_STICKY (event)) {
 817             goto out_flow_error;
 818           } else if (GST_EVENT_TYPE (event) == GST_EVENT_EOS) {
 819             if (queue->srcresult == GST_FLOW_NOT_LINKED
 820                 || queue->srcresult < GST_FLOW_EOS) {
 821               GST_ELEMENT_ERROR (queue, STREAM, FAILED,
 822                   (_("Internal data flow error.")),
 823                   ("streaming task paused, reason %s (%d)",
 824                       gst_flow_get_name (queue->srcresult), queue->srcresult));
 825             }
 826             goto out_flow_error;
 827           }
 828         }
 829         /* refuse more events on EOS */
 830         if (queue->eos)
 831           goto out_eos;
 832         gst_queue_locked_enqueue_event (queue, event);
 833         GST_QUEUE_MUTEX_UNLOCK (queue);
 834       } else {
 835         /* non-serialized events are forwarded downstream immediately */
 836         ret = gst_pad_push_event (queue->srcpad, event);
 837       }
 838       break;
 839   }
 840   return ret;
 841
 842   /* ERRORS */
 843 out_eos:
 844   {
 845     GST_CAT_LOG_OBJECT (queue_dataflow, queue, "refusing event, we are EOS");
 846     GST_QUEUE_MUTEX_UNLOCK (queue);
 847     gst_event_unref (event);
 848     return FALSE;
 849   }
 850 out_flow_error:
 851   {
 852     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
 853         "refusing event, we have a downstream flow error: %s",
 854         gst_flow_get_name (queue->srcresult));
 855     GST_QUEUE_MUTEX_UNLOCK (queue);
 856     gst_event_unref (event);
 857     return FALSE;
 858   }
 859 }
 860
 861 static gboolean
 862 gst_queue_handle_sink_query (GstPad * pad, GstObject * parent, GstQuery * query)
 863 {
 864   GstQueue *queue = GST_QUEUE_CAST (parent);
 865   gboolean res;
 866
 867   switch (GST_QUERY_TYPE (query)) {
 868     default:
 869       if (G_UNLIKELY (GST_QUERY_IS_SERIALIZED (query))) {
 870         GstQueueItem *qitem;
 871
 872         GST_QUEUE_MUTEX_LOCK_CHECK (queue, out_flushing);
 873         GST_LOG_OBJECT (queue, "queuing query %p (%s)", query,
 874             GST_QUERY_TYPE_NAME (query));
 875         qitem = g_slice_new (GstQueueItem);
 876         qitem->item = GST_MINI_OBJECT_CAST (query);
 877         qitem->is_query = TRUE;
 878         gst_queue_array_push_tail (queue->queue, qitem);
 879         GST_QUEUE_SIGNAL_ADD (queue);
 880         g_cond_wait (&queue->query_handled, &queue->qlock);
 881         if (queue->srcresult != GST_FLOW_OK)
 882           goto out_flushing;
 883         res = queue->last_query;
 884         GST_QUEUE_MUTEX_UNLOCK (queue);
 885       } else {
 886         res = gst_pad_query_default (pad, parent, query);
 887       }
 888       break;
 889   }
 890   return res;
 891
 892   /* ERRORS */
 893 out_flushing:
 894   {
 895     GST_DEBUG_OBJECT (queue, "we are flushing");
 896     GST_QUEUE_MUTEX_UNLOCK (queue);
 897     return FALSE;
 898   }
 899 }
 900
 901 static gboolean
 902 gst_queue_is_empty (GstQueue * queue)
 903 {
 904   GstQueueItem *head;
 905
 906   if (gst_queue_array_is_empty (queue->queue))
 907     return TRUE;
 908
 909   /* Only consider the queue empty if the minimum thresholds
 910    * are not reached and data is at the queue head. Otherwise
 911    * we would block forever on serialized queries.
 912    */
 913   head = gst_queue_array_peek_head (queue->queue);
 914   if (!GST_IS_BUFFER (head->item) && !GST_IS_BUFFER_LIST (head->item))
 915     return FALSE;
 916
 917   /* It is possible that a max size is reached before all min thresholds are.
 918    * Therefore, only consider it empty if it is not filled. */
 919   return ((queue->min_threshold.buffers > 0 &&
 920           queue->cur_level.buffers < queue->min_threshold.buffers) ||
 921       (queue->min_threshold.bytes > 0 &&
 922           queue->cur_level.bytes < queue->min_threshold.bytes) ||
 923       (queue->min_threshold.time > 0 &&
 924           queue->cur_level.time < queue->min_threshold.time)) &&
 925       !gst_queue_is_filled (queue);
 926 }
 927
 928 static gboolean
 929 gst_queue_is_filled (GstQueue * queue)
 930 {
 931   return (((queue->max_size.buffers > 0 &&
 932               queue->cur_level.buffers >= queue->max_size.buffers) ||
 933           (queue->max_size.bytes > 0 &&
 934               queue->cur_level.bytes >= queue->max_size.bytes) ||
 935           (queue->max_size.time > 0 &&
 936               queue->cur_level.time >= queue->max_size.time)));
 937 }
 938
 939 static void
 940 gst_queue_leak_downstream (GstQueue * queue)
 941 {
 942   /* for as long as the queue is filled, dequeue an item and discard it */
 943   while (gst_queue_is_filled (queue)) {
 944     GstMiniObject *leak;
 945
 946     leak = gst_queue_locked_dequeue (queue);
 947     /* there is nothing to dequeue and the queue is still filled.. This should
 948      * not happen */
 949     g_assert (leak != NULL);
 950
 951     GST_CAT_DEBUG_OBJECT (queue_dataflow, queue,
 952         "queue is full, leaking item %p on downstream end", leak);
 953     if (GST_IS_EVENT (leak) && GST_EVENT_IS_STICKY (leak)) {
 954       GST_CAT_DEBUG_OBJECT (queue_dataflow, queue,
 955           "Storing sticky event %s on srcpad", GST_EVENT_TYPE_NAME (leak));
 956       gst_pad_store_sticky_event (queue->srcpad, GST_EVENT_CAST (leak));
 957     }
 958
 959     if (!GST_IS_QUERY (leak))
 960       gst_mini_object_unref (leak);
 961
 962     /* last buffer needs to get a DISCONT flag */
 963     queue->head_needs_discont = TRUE;
 964   }
 965 }
 966
 967 static GstFlowReturn
 968 gst_queue_chain (GstPad * pad, GstObject * parent, GstBuffer * buffer)
 969 {
 970   GstQueue *queue;
 971   GstClockTime duration, timestamp;
 972
 973   queue = GST_QUEUE_CAST (parent);
 974
 975   /* we have to lock the queue since we span threads */
 976   GST_QUEUE_MUTEX_LOCK_CHECK (queue, out_flushing);
 977   /* when we received EOS, we refuse any more data */
 978   if (queue->eos)
 979     goto out_eos;
 980   if (queue->unexpected)
 981     goto out_unexpected;
 982
 983   timestamp = GST_BUFFER_TIMESTAMP (buffer);
 984   duration = GST_BUFFER_DURATION (buffer);
 985
 986   GST_CAT_LOG_OBJECT (queue_dataflow, queue, "received buffer %p of size %"
 987       G_GSIZE_FORMAT ", time %" GST_TIME_FORMAT ", duration %"
 988       GST_TIME_FORMAT, buffer, gst_buffer_get_size (buffer),
 989       GST_TIME_ARGS (timestamp), GST_TIME_ARGS (duration));
 990
 991   /* We make space available if we're "full" according to whatever
 992    * the user defined as "full". Note that this only applies to buffers.
 993    * We always handle events and they don't count in our statistics. */
 994   while (gst_queue_is_filled (queue)) {
 995     if (!queue->silent) {
 996       GST_QUEUE_MUTEX_UNLOCK (queue);
 997       g_signal_emit (queue, gst_queue_signals[SIGNAL_OVERRUN], 0);
 998       GST_QUEUE_MUTEX_LOCK_CHECK (queue, out_flushing);
 999       /* we recheck, the signal could have changed the thresholds */
1000       if (!gst_queue_is_filled (queue))
1001         break;
1002     }
1003
1004     /* how are we going to make space for this buffer? */
1005     switch (queue->leaky) {
1006       case GST_QUEUE_LEAK_UPSTREAM:
1007         /* next buffer needs to get a DISCONT flag */
1008         queue->tail_needs_discont = TRUE;
1009         /* leak current buffer */
1010         GST_CAT_DEBUG_OBJECT (queue_dataflow, queue,
1011             "queue is full, leaking buffer on upstream end");
1012         /* now we can clean up and exit right away */
1013         goto out_unref;
1014       case GST_QUEUE_LEAK_DOWNSTREAM:
1015         gst_queue_leak_downstream (queue);
1016         break;
1017       default:
1018         g_warning ("Unknown leaky type, using default");
1019         /* fall-through */
1020       case GST_QUEUE_NO_LEAK:
1021       {
1022         GST_CAT_DEBUG_OBJECT (queue_dataflow, queue,
1023             "queue is full, waiting for free space");
1024
1025         /* don't leak. Instead, wait for space to be available */
1026         do {
1027           /* for as long as the queue is filled, wait till an item was deleted. */
1028           GST_QUEUE_WAIT_DEL_CHECK (queue, out_flushing);
1029         } while (gst_queue_is_filled (queue));
1030
1031         GST_CAT_DEBUG_OBJECT (queue_dataflow, queue, "queue is not full");
1032
1033         if (!queue->silent) {
1034           GST_QUEUE_MUTEX_UNLOCK (queue);
1035           g_signal_emit (queue, gst_queue_signals[SIGNAL_RUNNING], 0);
1036           GST_QUEUE_MUTEX_LOCK_CHECK (queue, out_flushing);
1037         }
1038         break;
1039       }
1040     }
1041   }
1042
1043   if (queue->tail_needs_discont) {
1044     GstBuffer *subbuffer = gst_buffer_make_writable (buffer);
1045
1046     if (subbuffer) {
1047       buffer = subbuffer;
1048       GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_DISCONT);
1049     } else {
1050       GST_DEBUG_OBJECT (queue, "Could not mark buffer as DISCONT");
1051     }
1052     queue->tail_needs_discont = FALSE;
1053   }
1054
1055   /* put buffer in queue now */
1056   gst_queue_locked_enqueue_buffer (queue, buffer);
1057   GST_QUEUE_MUTEX_UNLOCK (queue);
1058
1059   return GST_FLOW_OK;
1060
1061   /* special conditions */
1062 out_unref:
1063   {
1064     GST_QUEUE_MUTEX_UNLOCK (queue);
1065
1066     gst_buffer_unref (buffer);
1067
1068     return GST_FLOW_OK;
1069   }
1070 out_flushing:
1071   {
1072     GstFlowReturn ret = queue->srcresult;
1073
1074     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
1075         "exit because task paused, reason: %s", gst_flow_get_name (ret));
1076     GST_QUEUE_MUTEX_UNLOCK (queue);
1077     gst_buffer_unref (buffer);
1078
1079     return ret;
1080   }
1081 out_eos:
1082   {
1083     GST_CAT_LOG_OBJECT (queue_dataflow, queue, "exit because we received EOS");
1084     GST_QUEUE_MUTEX_UNLOCK (queue);
1085
1086     gst_buffer_unref (buffer);
1087
1088     return GST_FLOW_EOS;
1089   }
1090 out_unexpected:
1091   {
1092     GST_CAT_LOG_OBJECT (queue_dataflow, queue, "exit because we received EOS");
1093     GST_QUEUE_MUTEX_UNLOCK (queue);
1094
1095     gst_buffer_unref (buffer);
1096
1097     return GST_FLOW_EOS;
1098   }
1099 }
1100
1101 /* dequeue an item from the queue an push it downstream. This functions returns
1102  * the result of the push. */
1103 static GstFlowReturn
1104 gst_queue_push_one (GstQueue * queue)
1105 {
1106   GstFlowReturn result = queue->srcresult;
1107   GstMiniObject *data;
1108
1109   data = gst_queue_locked_dequeue (queue);
1110   if (data == NULL)
1111     goto no_item;
1112
1113 next:
1114   if (GST_IS_BUFFER (data)) {
1115     GstBuffer *buffer;
1116
1117     buffer = GST_BUFFER_CAST (data);
1118
1119     if (queue->head_needs_discont) {
1120       GstBuffer *subbuffer = gst_buffer_make_writable (buffer);
1121
1122       if (subbuffer) {
1123         buffer = subbuffer;
1124         GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_DISCONT);
1125       } else {
1126         GST_DEBUG_OBJECT (queue, "Could not mark buffer as DISCONT");
1127       }
1128       queue->head_needs_discont = FALSE;
1129     }
1130
1131     GST_QUEUE_MUTEX_UNLOCK (queue);
1132     result = gst_pad_push (queue->srcpad, buffer);
1133
1134     /* need to check for srcresult here as well */
1135     GST_QUEUE_MUTEX_LOCK_CHECK (queue, out_flushing);
1136
1137     if (result == GST_FLOW_EOS) {
1138       GST_CAT_LOG_OBJECT (queue_dataflow, queue, "got EOS from downstream");
1139       /* stop pushing buffers, we dequeue all items until we see an item that we
1140        * can push again, which is EOS or SEGMENT. If there is nothing in the
1141        * queue we can push, we set a flag to make the sinkpad refuse more
1142        * buffers with an EOS return value. */
1143       while ((data = gst_queue_locked_dequeue (queue))) {
1144         if (GST_IS_BUFFER (data)) {
1145           GST_CAT_LOG_OBJECT (queue_dataflow, queue,
1146               "dropping EOS buffer %p", data);
1147           gst_buffer_unref (GST_BUFFER_CAST (data));
1148         } else if (GST_IS_EVENT (data)) {
1149           GstEvent *event = GST_EVENT_CAST (data);
1150           GstEventType type = GST_EVENT_TYPE (event);
1151
1152           if (type == GST_EVENT_EOS || type == GST_EVENT_SEGMENT) {
1153             /* we found a pushable item in the queue, push it out */
1154             GST_CAT_LOG_OBJECT (queue_dataflow, queue,
1155                 "pushing pushable event %s after EOS",
1156                 GST_EVENT_TYPE_NAME (event));
1157             goto next;
1158           }
1159           GST_CAT_LOG_OBJECT (queue_dataflow, queue,
1160               "dropping EOS event %p", event);
1161           gst_event_unref (event);
1162         } else if (GST_IS_QUERY (data)) {
1163           GstQuery *query = GST_QUERY_CAST (data);
1164
1165           GST_CAT_LOG_OBJECT (queue_dataflow, queue,
1166               "dropping query %p because of EOS", query);
1167           queue->last_query = FALSE;
1168           g_cond_signal (&queue->query_handled);
1169         }
1170       }
1171       /* no more items in the queue. Set the unexpected flag so that upstream
1172        * make us refuse any more buffers on the sinkpad. Since we will still
1173        * accept EOS and SEGMENT we return _FLOW_OK to the caller so that the
1174        * task function does not shut down. */
1175       queue->unexpected = TRUE;
1176       result = GST_FLOW_OK;
1177     }
1178   } else if (GST_IS_EVENT (data)) {
1179     GstEvent *event = GST_EVENT_CAST (data);
1180     GstEventType type = GST_EVENT_TYPE (event);
1181
1182     GST_QUEUE_MUTEX_UNLOCK (queue);
1183
1184     gst_pad_push_event (queue->srcpad, event);
1185
1186     GST_QUEUE_MUTEX_LOCK_CHECK (queue, out_flushing);
1187     /* if we're EOS, return EOS so that the task pauses. */
1188     if (type == GST_EVENT_EOS) {
1189       GST_CAT_LOG_OBJECT (queue_dataflow, queue,
1190           "pushed EOS event %p, return EOS", event);
1191       result = GST_FLOW_EOS;
1192     }
1193   } else if (GST_IS_QUERY (data)) {
1194     GstQuery *query = GST_QUERY_CAST (data);
1195     gboolean ret;
1196
1197     GST_QUEUE_MUTEX_UNLOCK (queue);
1198     ret = gst_pad_peer_query (queue->srcpad, query);
1199     GST_QUEUE_MUTEX_LOCK_CHECK (queue, out_flushing_query);
1200     queue->last_query = ret;
1201     g_cond_signal (&queue->query_handled);
1202     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
1203         "did query %p, return %d", query, queue->last_query);
1204   }
1205   return result;
1206
1207   /* ERRORS */
1208 no_item:
1209   {
1210     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
1211         "exit because we have no item in the queue");
1212     return GST_FLOW_ERROR;
1213   }
1214 out_flushing:
1215   {
1216     GST_CAT_LOG_OBJECT (queue_dataflow, queue, "exit because we are flushing");
1217     return GST_FLOW_FLUSHING;
1218   }
1219 out_flushing_query:
1220   {
1221     queue->last_query = FALSE;
1222     g_cond_signal (&queue->query_handled);
1223     GST_CAT_LOG_OBJECT (queue_dataflow, queue, "exit because we are flushing");
1224     return GST_FLOW_FLUSHING;
1225   }
1226 }
1227
1228 static void
1229 gst_queue_loop (GstPad * pad)
1230 {
1231   GstQueue *queue;
1232   GstFlowReturn ret;
1233
1234   queue = (GstQueue *) GST_PAD_PARENT (pad);
1235
1236   /* have to lock for thread-safety */
1237   GST_QUEUE_MUTEX_LOCK_CHECK (queue, out_flushing);
1238
1239   while (gst_queue_is_empty (queue)) {
1240     GST_CAT_DEBUG_OBJECT (queue_dataflow, queue, "queue is empty");
1241     if (!queue->silent) {
1242       GST_QUEUE_MUTEX_UNLOCK (queue);
1243       g_signal_emit (queue, gst_queue_signals[SIGNAL_UNDERRUN], 0);
1244       GST_QUEUE_MUTEX_LOCK_CHECK (queue, out_flushing);
1245     }
1246
1247     /* we recheck, the signal could have changed the thresholds */
1248     while (gst_queue_is_empty (queue)) {
1249       GST_QUEUE_WAIT_ADD_CHECK (queue, out_flushing);
1250     }
1251
1252     GST_CAT_DEBUG_OBJECT (queue_dataflow, queue, "queue is not empty");
1253     if (!queue->silent) {
1254       GST_QUEUE_MUTEX_UNLOCK (queue);
1255       g_signal_emit (queue, gst_queue_signals[SIGNAL_RUNNING], 0);
1256       g_signal_emit (queue, gst_queue_signals[SIGNAL_PUSHING], 0);
1257       GST_QUEUE_MUTEX_LOCK_CHECK (queue, out_flushing);
1258     }
1259   }
1260
1261   ret = gst_queue_push_one (queue);
1262   queue->srcresult = ret;
1263   if (ret != GST_FLOW_OK)
1264     goto out_flushing;
1265
1266   GST_QUEUE_MUTEX_UNLOCK (queue);
1267
1268   return;
1269
1270   /* ERRORS */
1271 out_flushing:
1272   {
1273     gboolean eos = queue->eos;
1274     GstFlowReturn ret = queue->srcresult;
1275
1276     gst_pad_pause_task (queue->srcpad);
1277     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
1278         "pause task, reason:  %s", gst_flow_get_name (ret));
1279     if (ret == GST_FLOW_FLUSHING)
1280       gst_queue_locked_flush (queue, FALSE);
1281     else
1282       GST_QUEUE_SIGNAL_DEL (queue);
1283     GST_QUEUE_MUTEX_UNLOCK (queue);
1284     /* let app know about us giving up if upstream is not expected to do so */
1285     /* EOS is already taken care of elsewhere */
1286     if (eos && (ret == GST_FLOW_NOT_LINKED || ret < GST_FLOW_EOS)) {
1287       GST_ELEMENT_ERROR (queue, STREAM, FAILED,
1288           (_("Internal data flow error.")),
1289           ("streaming task paused, reason %s (%d)",
1290               gst_flow_get_name (ret), ret));
1291       gst_pad_push_event (queue->srcpad, gst_event_new_eos ());
1292     }
1293     return;
1294   }
1295 }
1296
1297 static gboolean
1298 gst_queue_handle_src_event (GstPad * pad, GstObject * parent, GstEvent * event)
1299 {
1300   gboolean res = TRUE;
1301   GstQueue *queue = GST_QUEUE (parent);
1302
1303 #ifndef GST_DISABLE_GST_DEBUG
1304   GST_CAT_DEBUG_OBJECT (queue_dataflow, queue, "got event %p (%d)",
1305       event, GST_EVENT_TYPE (event));
1306 #endif
1307
1308   switch (GST_EVENT_TYPE (event)) {
1309     case GST_EVENT_RECONFIGURE:
1310       GST_QUEUE_MUTEX_LOCK (queue);
1311       if (queue->srcresult == GST_FLOW_NOT_LINKED) {
1312         /* when we got not linked, assume downstream is linked again now and we
1313          * can try to start pushing again */
1314         queue->srcresult = GST_FLOW_OK;
1315         gst_pad_start_task (pad, (GstTaskFunction) gst_queue_loop, pad, NULL);
1316       }
1317       GST_QUEUE_MUTEX_UNLOCK (queue);
1318
1319       res = gst_pad_push_event (queue->sinkpad, event);
1320       break;
1321     default:
1322       res = gst_pad_event_default (pad, parent, event);
1323       break;
1324   }
1325
1326
1327   return res;
1328 }
1329
1330 static gboolean
1331 gst_queue_handle_src_query (GstPad * pad, GstObject * parent, GstQuery * query)
1332 {
1333   GstQueue *queue = GST_QUEUE (parent);
1334   gboolean res;
1335
1336   switch (GST_QUERY_TYPE (query)) {
1337     case GST_QUERY_SCHEDULING:{
1338       gst_query_add_scheduling_mode (query, GST_PAD_MODE_PUSH);
1339       res = TRUE;
1340       break;
1341     }
1342     default:
1343       res = gst_pad_query_default (pad, parent, query);
1344       break;
1345   }
1346
1347   if (!res)
1348     return FALSE;
1349
1350   /* Adjust peer response for data contained in queue */
1351   switch (GST_QUERY_TYPE (query)) {
1352     case GST_QUERY_POSITION:
1353     {
1354       gint64 peer_pos;
1355       GstFormat format;
1356
1357       /* get peer position */
1358       gst_query_parse_position (query, &format, &peer_pos);
1359
1360       /* FIXME: this code assumes that there's no discont in the queue */
1361       switch (format) {
1362         case GST_FORMAT_BYTES:
1363           peer_pos -= queue->cur_level.bytes;
1364           break;
1365         case GST_FORMAT_TIME:
1366           peer_pos -= queue->cur_level.time;
1367           break;
1368         default:
1369           GST_DEBUG_OBJECT (queue, "Can't adjust query in %s format, don't "
1370               "know how to adjust value", gst_format_get_name (format));
1371           return TRUE;
1372       }
1373       /* set updated position */
1374       gst_query_set_position (query, format, peer_pos);
1375       break;
1376     }
1377     case GST_QUERY_LATENCY:
1378     {
1379       gboolean live;
1380       GstClockTime min, max;
1381
1382       gst_query_parse_latency (query, &live, &min, &max);
1383
1384       /* we can delay up to the limit of the queue in time. If we have no time
1385        * limit, the best thing we can do is to return an infinite delay. In
1386        * reality a better estimate would be the byte/buffer rate but that is not
1387        * possible right now. */
1388       if (queue->max_size.time > 0 && max != -1)
1389         max += queue->max_size.time;
1390       else
1391         max = -1;
1392
1393       /* adjust for min-threshold */
1394       if (queue->min_threshold.time > 0 && min != -1)
1395         min += queue->min_threshold.time;
1396
1397       gst_query_set_latency (query, live, min, max);
1398       break;
1399     }
1400     default:
1401       /* peer handled other queries */
1402       break;
1403   }
1404
1405   return TRUE;
1406 }
1407
1408 static gboolean
1409 gst_queue_sink_activate_mode (GstPad * pad, GstObject * parent, GstPadMode mode,
1410     gboolean active)
1411 {
1412   gboolean result;
1413   GstQueue *queue;
1414
1415   queue = GST_QUEUE (parent);
1416
1417   switch (mode) {
1418     case GST_PAD_MODE_PUSH:
1419       if (active) {
1420         GST_QUEUE_MUTEX_LOCK (queue);
1421         queue->srcresult = GST_FLOW_OK;
1422         queue->eos = FALSE;
1423         queue->unexpected = FALSE;
1424         GST_QUEUE_MUTEX_UNLOCK (queue);
1425       } else {
1426         /* step 1, unblock chain function */
1427         GST_QUEUE_MUTEX_LOCK (queue);
1428         queue->srcresult = GST_FLOW_FLUSHING;
1429         /* the item del signal will unblock */
1430         g_cond_signal (&queue->item_del);
1431         /* unblock query handler */
1432         queue->last_query = FALSE;
1433         g_cond_signal (&queue->query_handled);
1434         GST_QUEUE_MUTEX_UNLOCK (queue);
1435
1436         /* step 2, wait until streaming thread stopped and flush queue */
1437         GST_PAD_STREAM_LOCK (pad);
1438         GST_QUEUE_MUTEX_LOCK (queue);
1439         gst_queue_locked_flush (queue, TRUE);
1440         GST_QUEUE_MUTEX_UNLOCK (queue);
1441         GST_PAD_STREAM_UNLOCK (pad);
1442       }
1443       result = TRUE;
1444       break;
1445     default:
1446       result = FALSE;
1447       break;
1448   }
1449   return result;
1450 }
1451
1452 static gboolean
1453 gst_queue_src_activate_mode (GstPad * pad, GstObject * parent, GstPadMode mode,
1454     gboolean active)
1455 {
1456   gboolean result;
1457   GstQueue *queue;
1458
1459   queue = GST_QUEUE (parent);
1460
1461   switch (mode) {
1462     case GST_PAD_MODE_PUSH:
1463       if (active) {
1464         GST_QUEUE_MUTEX_LOCK (queue);
1465         queue->srcresult = GST_FLOW_OK;
1466         queue->eos = FALSE;
1467         queue->unexpected = FALSE;
1468         result =
1469             gst_pad_start_task (pad, (GstTaskFunction) gst_queue_loop, pad,
1470             NULL);
1471         GST_QUEUE_MUTEX_UNLOCK (queue);
1472       } else {
1473         /* step 1, unblock loop function */
1474         GST_QUEUE_MUTEX_LOCK (queue);
1475         queue->srcresult = GST_FLOW_FLUSHING;
1476         /* the item add signal will unblock */
1477         g_cond_signal (&queue->item_add);
1478         GST_QUEUE_MUTEX_UNLOCK (queue);
1479
1480         /* step 2, make sure streaming finishes */
1481         result = gst_pad_stop_task (pad);
1482       }
1483       break;
1484     default:
1485       result = FALSE;
1486       break;
1487   }
1488   return result;
1489 }
1490
1491 static void
1492 queue_capacity_change (GstQueue * queue)
1493 {
1494   if (queue->leaky == GST_QUEUE_LEAK_DOWNSTREAM) {
1495     gst_queue_leak_downstream (queue);
1496   }
1497
1498   /* changing the capacity of the queue must wake up
1499    * the _chain function, it might have more room now
1500    * to store the buffer/event in the queue */
1501   GST_QUEUE_SIGNAL_DEL (queue);
1502 }
1503
1504 /* Changing the minimum required fill level must
1505  * wake up the _loop function as it might now
1506  * be able to preceed.
1507  */
1508 #define QUEUE_THRESHOLD_CHANGE(q)\
1509   GST_QUEUE_SIGNAL_ADD (q);
1510
1511 static void
1512 gst_queue_set_property (GObject * object,
1513     guint prop_id, const GValue * value, GParamSpec * pspec)
1514 {
1515   GstQueue *queue = GST_QUEUE (object);
1516
1517   /* someone could change levels here, and since this
1518    * affects the get/put funcs, we need to lock for safety. */
1519   GST_QUEUE_MUTEX_LOCK (queue);
1520
1521   switch (prop_id) {
1522     case PROP_MAX_SIZE_BYTES:
1523       queue->max_size.bytes = g_value_get_uint (value);
1524       queue_capacity_change (queue);
1525       break;
1526     case PROP_MAX_SIZE_BUFFERS:
1527       queue->max_size.buffers = g_value_get_uint (value);
1528       queue_capacity_change (queue);
1529       break;
1530     case PROP_MAX_SIZE_TIME:
1531       queue->max_size.time = g_value_get_uint64 (value);
1532       queue_capacity_change (queue);
1533       break;
1534     case PROP_MIN_THRESHOLD_BYTES:
1535       queue->min_threshold.bytes = g_value_get_uint (value);
1536       queue->orig_min_threshold.bytes = queue->min_threshold.bytes;
1537       QUEUE_THRESHOLD_CHANGE (queue);
1538       break;
1539     case PROP_MIN_THRESHOLD_BUFFERS:
1540       queue->min_threshold.buffers = g_value_get_uint (value);
1541       queue->orig_min_threshold.buffers = queue->min_threshold.buffers;
1542       QUEUE_THRESHOLD_CHANGE (queue);
1543       break;
1544     case PROP_MIN_THRESHOLD_TIME:
1545       queue->min_threshold.time = g_value_get_uint64 (value);
1546       queue->orig_min_threshold.time = queue->min_threshold.time;
1547       QUEUE_THRESHOLD_CHANGE (queue);
1548       break;
1549     case PROP_LEAKY:
1550       queue->leaky = g_value_get_enum (value);
1551       break;
1552     case PROP_SILENT:
1553       queue->silent = g_value_get_boolean (value);
1554       break;
1555     case PROP_FLUSH_ON_EOS:
1556       queue->flush_on_eos = g_value_get_boolean (value);
1557       break;
1558     default:
1559       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1560       break;
1561   }
1562
1563   GST_QUEUE_MUTEX_UNLOCK (queue);
1564 }
1565
1566 static void
1567 gst_queue_get_property (GObject * object,
1568     guint prop_id, GValue * value, GParamSpec * pspec)
1569 {
1570   GstQueue *queue = GST_QUEUE (object);
1571
1572   GST_QUEUE_MUTEX_LOCK (queue);
1573
1574   switch (prop_id) {
1575     case PROP_CUR_LEVEL_BYTES:
1576       g_value_set_uint (value, queue->cur_level.bytes);
1577       break;
1578     case PROP_CUR_LEVEL_BUFFERS:
1579       g_value_set_uint (value, queue->cur_level.buffers);
1580       break;
1581     case PROP_CUR_LEVEL_TIME:
1582       g_value_set_uint64 (value, queue->cur_level.time);
1583       break;
1584     case PROP_MAX_SIZE_BYTES:
1585       g_value_set_uint (value, queue->max_size.bytes);
1586       break;
1587     case PROP_MAX_SIZE_BUFFERS:
1588       g_value_set_uint (value, queue->max_size.buffers);
1589       break;
1590     case PROP_MAX_SIZE_TIME:
1591       g_value_set_uint64 (value, queue->max_size.time);
1592       break;
1593     case PROP_MIN_THRESHOLD_BYTES:
1594       g_value_set_uint (value, queue->min_threshold.bytes);
1595       break;
1596     case PROP_MIN_THRESHOLD_BUFFERS:
1597       g_value_set_uint (value, queue->min_threshold.buffers);
1598       break;
1599     case PROP_MIN_THRESHOLD_TIME:
1600       g_value_set_uint64 (value, queue->min_threshold.time);
1601       break;
1602     case PROP_LEAKY:
1603       g_value_set_enum (value, queue->leaky);
1604       break;
1605     case PROP_SILENT:
1606       g_value_set_boolean (value, queue->silent);
1607       break;
1608     case PROP_FLUSH_ON_EOS:
1609       g_value_set_boolean (value, queue->flush_on_eos);
1610       break;
1611     default:
1612       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1613       break;
1614   }
1615
1616   GST_QUEUE_MUTEX_UNLOCK (queue);
1617 }