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   GstBuffer *buffer = GST_BUFFER_CAST (item);
 624   gsize bsize = gst_buffer_get_size (buffer);
 625
 626   /* add buffer to the statistics */
 627   queue->cur_level.buffers++;
 628   queue->cur_level.bytes += bsize;
 629   apply_buffer (queue, buffer, &queue->sink_segment, TRUE, TRUE);
 630
 631   if (item) {
 632     GstQueueItem *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   }
 638   GST_QUEUE_SIGNAL_ADD (queue);
 639 }
 640
 641 static inline void
 642 gst_queue_locked_enqueue_event (GstQueue * queue, gpointer item)
 643 {
 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   if (item) {
 675     GstQueueItem *qitem = g_slice_new (GstQueueItem);
 676     qitem->item = item;
 677     qitem->is_query = FALSE;
 678     gst_queue_array_push_tail (queue->queue, qitem);
 679   }
 680   GST_QUEUE_SIGNAL_ADD (queue);
 681 }
 682
 683 /* dequeue an item from the queue and update level stats, with QUEUE_LOCK */
 684 static GstMiniObject *
 685 gst_queue_locked_dequeue (GstQueue * queue)
 686 {
 687   GstQueueItem *qitem;
 688   GstMiniObject *item;
 689   gsize bufsize;
 690
 691   qitem = gst_queue_array_pop_head (queue->queue);
 692   if (qitem == NULL)
 693     goto no_item;
 694
 695   item = qitem->item;
 696   bufsize = qitem->size;
 697   g_slice_free (GstQueueItem, qitem);
 698
 699   if (GST_IS_BUFFER (item)) {
 700     GstBuffer *buffer = GST_BUFFER_CAST (item);
 701
 702     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
 703         "retrieved buffer %p from queue", buffer);
 704
 705     queue->cur_level.buffers--;
 706     queue->cur_level.bytes -= bufsize;
 707     apply_buffer (queue, buffer, &queue->src_segment, TRUE, FALSE);
 708
 709     /* if the queue is empty now, update the other side */
 710     if (queue->cur_level.buffers == 0)
 711       queue->cur_level.time = 0;
 712
 713   } else if (GST_IS_EVENT (item)) {
 714     GstEvent *event = GST_EVENT_CAST (item);
 715
 716     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
 717         "retrieved event %p from queue", event);
 718
 719     switch (GST_EVENT_TYPE (event)) {
 720       case GST_EVENT_EOS:
 721         /* queue is empty now that we dequeued the EOS */
 722         GST_QUEUE_CLEAR_LEVEL (queue->cur_level);
 723         break;
 724       case GST_EVENT_SEGMENT:
 725         /* apply newsegment if it has not already been applied */
 726         if (G_LIKELY (!queue->newseg_applied_to_src)) {
 727           apply_segment (queue, event, &queue->src_segment, FALSE);
 728         } else {
 729           queue->newseg_applied_to_src = FALSE;
 730         }
 731         break;
 732       default:
 733         break;
 734     }
 735   } else if (GST_IS_QUERY (item)) {
 736     GstQuery *query = GST_QUERY_CAST (item);
 737
 738     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
 739         "retrieved query %p from queue", query);
 740   } else {
 741     g_warning
 742         ("Unexpected item %p dequeued from queue %s (refcounting problem?)",
 743         item, GST_OBJECT_NAME (queue));
 744     item = NULL;
 745   }
 746   GST_QUEUE_SIGNAL_DEL (queue);
 747
 748   return item;
 749
 750   /* ERRORS */
 751 no_item:
 752   {
 753     GST_CAT_DEBUG_OBJECT (queue_dataflow, queue, "the queue is empty");
 754     return NULL;
 755   }
 756 }
 757
 758 static gboolean
 759 gst_queue_handle_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
 760 {
 761   gboolean ret = TRUE;
 762   GstQueue *queue;
 763
 764   queue = GST_QUEUE (parent);
 765
 766   switch (GST_EVENT_TYPE (event)) {
 767     case GST_EVENT_FLUSH_START:
 768       STATUS (queue, pad, "received flush start event");
 769       /* forward event */
 770       ret = gst_pad_push_event (queue->srcpad, event);
 771
 772       /* now unblock the chain function */
 773       GST_QUEUE_MUTEX_LOCK (queue);
 774       queue->srcresult = GST_FLOW_FLUSHING;
 775       /* unblock the loop and chain functions */
 776       GST_QUEUE_SIGNAL_ADD (queue);
 777       GST_QUEUE_SIGNAL_DEL (queue);
 778       queue->last_query = FALSE;
 779       g_cond_signal (&queue->query_handled);
 780       GST_QUEUE_MUTEX_UNLOCK (queue);
 781
 782       /* make sure it pauses, this should happen since we sent
 783        * flush_start downstream. */
 784       gst_pad_pause_task (queue->srcpad);
 785       GST_CAT_LOG_OBJECT (queue_dataflow, queue, "loop stopped");
 786       break;
 787     case GST_EVENT_FLUSH_STOP:
 788       STATUS (queue, pad, "received flush stop event");
 789       /* forward event */
 790       ret = gst_pad_push_event (queue->srcpad, event);
 791
 792       GST_QUEUE_MUTEX_LOCK (queue);
 793       gst_queue_locked_flush (queue, FALSE);
 794       queue->srcresult = GST_FLOW_OK;
 795       queue->eos = FALSE;
 796       queue->unexpected = FALSE;
 797       gst_pad_start_task (queue->srcpad, (GstTaskFunction) gst_queue_loop,
 798           queue->srcpad, NULL);
 799       GST_QUEUE_MUTEX_UNLOCK (queue);
 800
 801       STATUS (queue, pad, "after flush");
 802       break;
 803     default:
 804       if (GST_EVENT_IS_SERIALIZED (event)) {
 805         /* serialized events go in the queue */
 806         GST_QUEUE_MUTEX_LOCK (queue);
 807         if (queue->srcresult != GST_FLOW_OK) {
 808           /* Errors in sticky event pushing are no problem and ignored here
 809            * as they will cause more meaningful errors during data flow.
 810            * For EOS events, that are not followed by data flow, we still
 811            * return FALSE here though.
 812            */
 813           if (!GST_EVENT_IS_STICKY (event) ||
 814               GST_EVENT_TYPE (event) == GST_EVENT_EOS)
 815             goto out_flow_error;
 816         }
 817         /* refuse more events on EOS */
 818         if (queue->eos)
 819           goto out_eos;
 820         gst_queue_locked_enqueue_event (queue, event);
 821         GST_QUEUE_MUTEX_UNLOCK (queue);
 822       } else {
 823         /* non-serialized events are forwarded downstream immediately */
 824         ret = gst_pad_push_event (queue->srcpad, event);
 825       }
 826       break;
 827   }
 828   return ret;
 829
 830   /* ERRORS */
 831 out_eos:
 832   {
 833     GST_CAT_LOG_OBJECT (queue_dataflow, queue, "refusing event, we are EOS");
 834     GST_QUEUE_MUTEX_UNLOCK (queue);
 835     gst_event_unref (event);
 836     return FALSE;
 837   }
 838 out_flow_error:
 839   {
 840     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
 841         "refusing event, we have a downstream flow error: %s",
 842         gst_flow_get_name (queue->srcresult));
 843     GST_QUEUE_MUTEX_UNLOCK (queue);
 844     gst_event_unref (event);
 845     return FALSE;
 846   }
 847 }
 848
 849 static gboolean
 850 gst_queue_handle_sink_query (GstPad * pad, GstObject * parent, GstQuery * query)
 851 {
 852   GstQueue *queue = GST_QUEUE_CAST (parent);
 853   gboolean res;
 854
 855   switch (GST_QUERY_TYPE (query)) {
 856     default:
 857       if (G_UNLIKELY (GST_QUERY_IS_SERIALIZED (query))) {
 858         GstQueueItem *qitem;
 859
 860         GST_QUEUE_MUTEX_LOCK_CHECK (queue, out_flushing);
 861         GST_LOG_OBJECT (queue, "queuing query %p (%s)", query,
 862             GST_QUERY_TYPE_NAME (query));
 863         qitem = g_slice_new (GstQueueItem);
 864         qitem->item = GST_MINI_OBJECT_CAST (query);
 865         qitem->is_query = TRUE;
 866         gst_queue_array_push_tail (queue->queue, qitem);
 867         GST_QUEUE_SIGNAL_ADD (queue);
 868         g_cond_wait (&queue->query_handled, &queue->qlock);
 869         if (queue->srcresult != GST_FLOW_OK)
 870           goto out_flushing;
 871         res = queue->last_query;
 872         GST_QUEUE_MUTEX_UNLOCK (queue);
 873       } else {
 874         res = gst_pad_query_default (pad, parent, query);
 875       }
 876       break;
 877   }
 878   return res;
 879
 880   /* ERRORS */
 881 out_flushing:
 882   {
 883     GST_DEBUG_OBJECT (queue, "we are flushing");
 884     GST_QUEUE_MUTEX_UNLOCK (queue);
 885     return FALSE;
 886   }
 887 }
 888
 889 static gboolean
 890 gst_queue_is_empty (GstQueue * queue)
 891 {
 892   GstQueueItem *head;
 893
 894   if (gst_queue_array_is_empty (queue->queue))
 895     return TRUE;
 896
 897   /* Only consider the queue empty if the minimum thresholds
 898    * are not reached and data is at the queue head. Otherwise
 899    * we would block forever on serialized queries.
 900    */
 901   head = gst_queue_array_peek_head (queue->queue);
 902   if (!GST_IS_BUFFER (head->item) && !GST_IS_BUFFER_LIST (head->item))
 903     return FALSE;
 904
 905   /* It is possible that a max size is reached before all min thresholds are.
 906    * Therefore, only consider it empty if it is not filled. */
 907   return ((queue->min_threshold.buffers > 0 &&
 908           queue->cur_level.buffers < queue->min_threshold.buffers) ||
 909       (queue->min_threshold.bytes > 0 &&
 910           queue->cur_level.bytes < queue->min_threshold.bytes) ||
 911       (queue->min_threshold.time > 0 &&
 912           queue->cur_level.time < queue->min_threshold.time)) &&
 913       !gst_queue_is_filled (queue);
 914 }
 915
 916 static gboolean
 917 gst_queue_is_filled (GstQueue * queue)
 918 {
 919   return (((queue->max_size.buffers > 0 &&
 920               queue->cur_level.buffers >= queue->max_size.buffers) ||
 921           (queue->max_size.bytes > 0 &&
 922               queue->cur_level.bytes >= queue->max_size.bytes) ||
 923           (queue->max_size.time > 0 &&
 924               queue->cur_level.time >= queue->max_size.time)));
 925 }
 926
 927 static void
 928 gst_queue_leak_downstream (GstQueue * queue)
 929 {
 930   /* for as long as the queue is filled, dequeue an item and discard it */
 931   while (gst_queue_is_filled (queue)) {
 932     GstMiniObject *leak;
 933
 934     leak = gst_queue_locked_dequeue (queue);
 935     /* there is nothing to dequeue and the queue is still filled.. This should
 936      * not happen */
 937     g_assert (leak != NULL);
 938
 939     GST_CAT_DEBUG_OBJECT (queue_dataflow, queue,
 940         "queue is full, leaking item %p on downstream end", leak);
 941     if (GST_IS_EVENT (leak) && GST_EVENT_IS_STICKY (leak)) {
 942       GST_CAT_DEBUG_OBJECT (queue_dataflow, queue,
 943           "Storing sticky event %s on srcpad", GST_EVENT_TYPE_NAME (leak));
 944       gst_pad_store_sticky_event (queue->srcpad, GST_EVENT_CAST (leak));
 945     }
 946
 947     if (!GST_IS_QUERY (leak))
 948       gst_mini_object_unref (leak);
 949
 950     /* last buffer needs to get a DISCONT flag */
 951     queue->head_needs_discont = TRUE;
 952   }
 953 }
 954
 955 static GstFlowReturn
 956 gst_queue_chain (GstPad * pad, GstObject * parent, GstBuffer * buffer)
 957 {
 958   GstQueue *queue;
 959   GstClockTime duration, timestamp;
 960
 961   queue = GST_QUEUE_CAST (parent);
 962
 963   /* we have to lock the queue since we span threads */
 964   GST_QUEUE_MUTEX_LOCK_CHECK (queue, out_flushing);
 965   /* when we received EOS, we refuse any more data */
 966   if (queue->eos)
 967     goto out_eos;
 968   if (queue->unexpected)
 969     goto out_unexpected;
 970
 971   timestamp = GST_BUFFER_TIMESTAMP (buffer);
 972   duration = GST_BUFFER_DURATION (buffer);
 973
 974   GST_CAT_LOG_OBJECT (queue_dataflow, queue, "received buffer %p of size %"
 975       G_GSIZE_FORMAT ", time %" GST_TIME_FORMAT ", duration %"
 976       GST_TIME_FORMAT, buffer, gst_buffer_get_size (buffer),
 977       GST_TIME_ARGS (timestamp), GST_TIME_ARGS (duration));
 978
 979   /* We make space available if we're "full" according to whatever
 980    * the user defined as "full". Note that this only applies to buffers.
 981    * We always handle events and they don't count in our statistics. */
 982   while (gst_queue_is_filled (queue)) {
 983     if (!queue->silent) {
 984       GST_QUEUE_MUTEX_UNLOCK (queue);
 985       g_signal_emit (queue, gst_queue_signals[SIGNAL_OVERRUN], 0);
 986       GST_QUEUE_MUTEX_LOCK_CHECK (queue, out_flushing);
 987       /* we recheck, the signal could have changed the thresholds */
 988       if (!gst_queue_is_filled (queue))
 989         break;
 990     }
 991
 992     /* how are we going to make space for this buffer? */
 993     switch (queue->leaky) {
 994       case GST_QUEUE_LEAK_UPSTREAM:
 995         /* next buffer needs to get a DISCONT flag */
 996         queue->tail_needs_discont = TRUE;
 997         /* leak current buffer */
 998         GST_CAT_DEBUG_OBJECT (queue_dataflow, queue,
 999             "queue is full, leaking buffer on upstream end");
1000         /* now we can clean up and exit right away */
1001         goto out_unref;
1002       case GST_QUEUE_LEAK_DOWNSTREAM:
1003         gst_queue_leak_downstream (queue);
1004         break;
1005       default:
1006         g_warning ("Unknown leaky type, using default");
1007         /* fall-through */
1008       case GST_QUEUE_NO_LEAK:
1009       {
1010         GST_CAT_DEBUG_OBJECT (queue_dataflow, queue,
1011             "queue is full, waiting for free space");
1012
1013         /* don't leak. Instead, wait for space to be available */
1014         do {
1015           /* for as long as the queue is filled, wait till an item was deleted. */
1016           GST_QUEUE_WAIT_DEL_CHECK (queue, out_flushing);
1017         } while (gst_queue_is_filled (queue));
1018
1019         GST_CAT_DEBUG_OBJECT (queue_dataflow, queue, "queue is not full");
1020
1021         if (!queue->silent) {
1022           GST_QUEUE_MUTEX_UNLOCK (queue);
1023           g_signal_emit (queue, gst_queue_signals[SIGNAL_RUNNING], 0);
1024           GST_QUEUE_MUTEX_LOCK_CHECK (queue, out_flushing);
1025         }
1026         break;
1027       }
1028     }
1029   }
1030
1031   if (queue->tail_needs_discont) {
1032     GstBuffer *subbuffer = gst_buffer_make_writable (buffer);
1033
1034     if (subbuffer) {
1035       buffer = subbuffer;
1036       GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_DISCONT);
1037     } else {
1038       GST_DEBUG_OBJECT (queue, "Could not mark buffer as DISCONT");
1039     }
1040     queue->tail_needs_discont = FALSE;
1041   }
1042
1043   /* put buffer in queue now */
1044   gst_queue_locked_enqueue_buffer (queue, buffer);
1045   GST_QUEUE_MUTEX_UNLOCK (queue);
1046
1047   return GST_FLOW_OK;
1048
1049   /* special conditions */
1050 out_unref:
1051   {
1052     GST_QUEUE_MUTEX_UNLOCK (queue);
1053
1054     gst_buffer_unref (buffer);
1055
1056     return GST_FLOW_OK;
1057   }
1058 out_flushing:
1059   {
1060     GstFlowReturn ret = queue->srcresult;
1061
1062     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
1063         "exit because task paused, reason: %s", gst_flow_get_name (ret));
1064     GST_QUEUE_MUTEX_UNLOCK (queue);
1065     gst_buffer_unref (buffer);
1066
1067     return ret;
1068   }
1069 out_eos:
1070   {
1071     GST_CAT_LOG_OBJECT (queue_dataflow, queue, "exit because we received EOS");
1072     GST_QUEUE_MUTEX_UNLOCK (queue);
1073
1074     gst_buffer_unref (buffer);
1075
1076     return GST_FLOW_EOS;
1077   }
1078 out_unexpected:
1079   {
1080     GST_CAT_LOG_OBJECT (queue_dataflow, queue, "exit because we received EOS");
1081     GST_QUEUE_MUTEX_UNLOCK (queue);
1082
1083     gst_buffer_unref (buffer);
1084
1085     return GST_FLOW_EOS;
1086   }
1087 }
1088
1089 /* dequeue an item from the queue an push it downstream. This functions returns
1090  * the result of the push. */
1091 static GstFlowReturn
1092 gst_queue_push_one (GstQueue * queue)
1093 {
1094   GstFlowReturn result = GST_FLOW_OK;
1095   GstMiniObject *data;
1096
1097   data = gst_queue_locked_dequeue (queue);
1098   if (data == NULL)
1099     goto no_item;
1100
1101 next:
1102   if (GST_IS_BUFFER (data)) {
1103     GstBuffer *buffer;
1104
1105     buffer = GST_BUFFER_CAST (data);
1106
1107     if (queue->head_needs_discont) {
1108       GstBuffer *subbuffer = gst_buffer_make_writable (buffer);
1109
1110       if (subbuffer) {
1111         buffer = subbuffer;
1112         GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_DISCONT);
1113       } else {
1114         GST_DEBUG_OBJECT (queue, "Could not mark buffer as DISCONT");
1115       }
1116       queue->head_needs_discont = FALSE;
1117     }
1118
1119     GST_QUEUE_MUTEX_UNLOCK (queue);
1120     result = gst_pad_push (queue->srcpad, buffer);
1121
1122     /* need to check for srcresult here as well */
1123     GST_QUEUE_MUTEX_LOCK_CHECK (queue, out_flushing);
1124
1125     if (result == GST_FLOW_EOS) {
1126       GST_CAT_LOG_OBJECT (queue_dataflow, queue, "got EOS from downstream");
1127       /* stop pushing buffers, we dequeue all items until we see an item that we
1128        * can push again, which is EOS or SEGMENT. If there is nothing in the
1129        * queue we can push, we set a flag to make the sinkpad refuse more
1130        * buffers with an EOS return value. */
1131       while ((data = gst_queue_locked_dequeue (queue))) {
1132         if (GST_IS_BUFFER (data)) {
1133           GST_CAT_LOG_OBJECT (queue_dataflow, queue,
1134               "dropping EOS buffer %p", data);
1135           gst_buffer_unref (GST_BUFFER_CAST (data));
1136         } else if (GST_IS_EVENT (data)) {
1137           GstEvent *event = GST_EVENT_CAST (data);
1138           GstEventType type = GST_EVENT_TYPE (event);
1139
1140           if (type == GST_EVENT_EOS || type == GST_EVENT_SEGMENT) {
1141             /* we found a pushable item in the queue, push it out */
1142             GST_CAT_LOG_OBJECT (queue_dataflow, queue,
1143                 "pushing pushable event %s after EOS",
1144                 GST_EVENT_TYPE_NAME (event));
1145             goto next;
1146           }
1147           GST_CAT_LOG_OBJECT (queue_dataflow, queue,
1148               "dropping EOS event %p", event);
1149           gst_event_unref (event);
1150         } else if (GST_IS_QUERY (data)) {
1151           GstQuery *query = GST_QUERY_CAST (data);
1152
1153           GST_CAT_LOG_OBJECT (queue_dataflow, queue,
1154               "dropping query %p because of EOS", query);
1155           queue->last_query = FALSE;
1156           g_cond_signal (&queue->query_handled);
1157         }
1158       }
1159       /* no more items in the queue. Set the unexpected flag so that upstream
1160        * make us refuse any more buffers on the sinkpad. Since we will still
1161        * accept EOS and SEGMENT we return _FLOW_OK to the caller so that the
1162        * task function does not shut down. */
1163       queue->unexpected = TRUE;
1164       result = GST_FLOW_OK;
1165     }
1166   } else if (GST_IS_EVENT (data)) {
1167     GstEvent *event = GST_EVENT_CAST (data);
1168     GstEventType type = GST_EVENT_TYPE (event);
1169
1170     GST_QUEUE_MUTEX_UNLOCK (queue);
1171
1172     gst_pad_push_event (queue->srcpad, event);
1173
1174     GST_QUEUE_MUTEX_LOCK_CHECK (queue, out_flushing);
1175     /* if we're EOS, return EOS so that the task pauses. */
1176     if (type == GST_EVENT_EOS) {
1177       GST_CAT_LOG_OBJECT (queue_dataflow, queue,
1178           "pushed EOS event %p, return EOS", event);
1179       result = GST_FLOW_EOS;
1180     }
1181   } else if (GST_IS_QUERY (data)) {
1182     GstQuery *query = GST_QUERY_CAST (data);
1183     gboolean ret;
1184
1185     GST_QUEUE_MUTEX_UNLOCK (queue);
1186     ret = gst_pad_peer_query (queue->srcpad, query);
1187     GST_QUEUE_MUTEX_LOCK_CHECK (queue, out_flushing_query);
1188     queue->last_query = ret;
1189     g_cond_signal (&queue->query_handled);
1190     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
1191         "did query %p, return %d", query, queue->last_query);
1192   }
1193   return result;
1194
1195   /* ERRORS */
1196 no_item:
1197   {
1198     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
1199         "exit because we have no item in the queue");
1200     return GST_FLOW_ERROR;
1201   }
1202 out_flushing:
1203   {
1204     GST_CAT_LOG_OBJECT (queue_dataflow, queue, "exit because we are flushing");
1205     return GST_FLOW_FLUSHING;
1206   }
1207 out_flushing_query:
1208   {
1209     queue->last_query = FALSE;
1210     g_cond_signal (&queue->query_handled);
1211     GST_CAT_LOG_OBJECT (queue_dataflow, queue, "exit because we are flushing");
1212     return GST_FLOW_FLUSHING;
1213   }
1214 }
1215
1216 static void
1217 gst_queue_loop (GstPad * pad)
1218 {
1219   GstQueue *queue;
1220   GstFlowReturn ret;
1221
1222   queue = (GstQueue *) GST_PAD_PARENT (pad);
1223
1224   /* have to lock for thread-safety */
1225   GST_QUEUE_MUTEX_LOCK_CHECK (queue, out_flushing);
1226
1227   while (gst_queue_is_empty (queue)) {
1228     GST_CAT_DEBUG_OBJECT (queue_dataflow, queue, "queue is empty");
1229     if (!queue->silent) {
1230       GST_QUEUE_MUTEX_UNLOCK (queue);
1231       g_signal_emit (queue, gst_queue_signals[SIGNAL_UNDERRUN], 0);
1232       GST_QUEUE_MUTEX_LOCK_CHECK (queue, out_flushing);
1233     }
1234
1235     /* we recheck, the signal could have changed the thresholds */
1236     while (gst_queue_is_empty (queue)) {
1237       GST_QUEUE_WAIT_ADD_CHECK (queue, out_flushing);
1238     }
1239
1240     GST_CAT_DEBUG_OBJECT (queue_dataflow, queue, "queue is not empty");
1241     if (!queue->silent) {
1242       GST_QUEUE_MUTEX_UNLOCK (queue);
1243       g_signal_emit (queue, gst_queue_signals[SIGNAL_RUNNING], 0);
1244       g_signal_emit (queue, gst_queue_signals[SIGNAL_PUSHING], 0);
1245       GST_QUEUE_MUTEX_LOCK_CHECK (queue, out_flushing);
1246     }
1247   }
1248
1249   ret = gst_queue_push_one (queue);
1250   queue->srcresult = ret;
1251   if (ret != GST_FLOW_OK)
1252     goto out_flushing;
1253
1254   GST_QUEUE_MUTEX_UNLOCK (queue);
1255
1256   return;
1257
1258   /* ERRORS */
1259 out_flushing:
1260   {
1261     gboolean eos = queue->eos;
1262     GstFlowReturn ret = queue->srcresult;
1263
1264     gst_pad_pause_task (queue->srcpad);
1265     GST_CAT_LOG_OBJECT (queue_dataflow, queue,
1266         "pause task, reason:  %s", gst_flow_get_name (ret));
1267     if (ret == GST_FLOW_FLUSHING)
1268       gst_queue_locked_flush (queue, FALSE);
1269     else
1270       GST_QUEUE_SIGNAL_DEL (queue);
1271     GST_QUEUE_MUTEX_UNLOCK (queue);
1272     /* let app know about us giving up if upstream is not expected to do so */
1273     /* EOS is already taken care of elsewhere */
1274     if (eos && (ret == GST_FLOW_NOT_LINKED || ret < GST_FLOW_EOS)) {
1275       GST_ELEMENT_ERROR (queue, STREAM, FAILED,
1276           (_("Internal data flow error.")),
1277           ("streaming task paused, reason %s (%d)",
1278               gst_flow_get_name (ret), ret));
1279       gst_pad_push_event (queue->srcpad, gst_event_new_eos ());
1280     }
1281     return;
1282   }
1283 }
1284
1285 static gboolean
1286 gst_queue_handle_src_event (GstPad * pad, GstObject * parent, GstEvent * event)
1287 {
1288   gboolean res = TRUE;
1289   GstQueue *queue = GST_QUEUE (parent);
1290
1291 #ifndef GST_DISABLE_GST_DEBUG
1292   GST_CAT_DEBUG_OBJECT (queue_dataflow, queue, "got event %p (%d)",
1293       event, GST_EVENT_TYPE (event));
1294 #endif
1295
1296   switch (GST_EVENT_TYPE (event)) {
1297     case GST_EVENT_RECONFIGURE:
1298       GST_QUEUE_MUTEX_LOCK (queue);
1299       if (queue->srcresult == GST_FLOW_NOT_LINKED) {
1300         /* when we got not linked, assume downstream is linked again now and we
1301          * can try to start pushing again */
1302         queue->srcresult = GST_FLOW_OK;
1303         gst_pad_start_task (pad, (GstTaskFunction) gst_queue_loop, pad, NULL);
1304       }
1305       GST_QUEUE_MUTEX_UNLOCK (queue);
1306
1307       res = gst_pad_push_event (queue->sinkpad, event);
1308       break;
1309     default:
1310       res = gst_pad_event_default (pad, parent, event);
1311       break;
1312   }
1313
1314
1315   return res;
1316 }
1317
1318 static gboolean
1319 gst_queue_handle_src_query (GstPad * pad, GstObject * parent, GstQuery * query)
1320 {
1321   GstQueue *queue = GST_QUEUE (parent);
1322   gboolean res;
1323
1324   switch (GST_QUERY_TYPE (query)) {
1325     case GST_QUERY_SCHEDULING:{
1326       gst_query_add_scheduling_mode (query, GST_PAD_MODE_PUSH);
1327       res = TRUE;
1328       break;
1329     }
1330     default:
1331       res = gst_pad_query_default (pad, parent, query);
1332       break;
1333   }
1334
1335   if (!res)
1336     return FALSE;
1337
1338   /* Adjust peer response for data contained in queue */
1339   switch (GST_QUERY_TYPE (query)) {
1340     case GST_QUERY_POSITION:
1341     {
1342       gint64 peer_pos;
1343       GstFormat format;
1344
1345       /* get peer position */
1346       gst_query_parse_position (query, &format, &peer_pos);
1347
1348       /* FIXME: this code assumes that there's no discont in the queue */
1349       switch (format) {
1350         case GST_FORMAT_BYTES:
1351           peer_pos -= queue->cur_level.bytes;
1352           break;
1353         case GST_FORMAT_TIME:
1354           peer_pos -= queue->cur_level.time;
1355           break;
1356         default:
1357           GST_DEBUG_OBJECT (queue, "Can't adjust query in %s format, don't "
1358               "know how to adjust value", gst_format_get_name (format));
1359           return TRUE;
1360       }
1361       /* set updated position */
1362       gst_query_set_position (query, format, peer_pos);
1363       break;
1364     }
1365     case GST_QUERY_LATENCY:
1366     {
1367       gboolean live;
1368       GstClockTime min, max;
1369
1370       gst_query_parse_latency (query, &live, &min, &max);
1371
1372       /* we can delay up to the limit of the queue in time. If we have no time
1373        * limit, the best thing we can do is to return an infinite delay. In
1374        * reality a better estimate would be the byte/buffer rate but that is not
1375        * possible right now. */
1376       if (queue->max_size.time > 0 && max != -1)
1377         max += queue->max_size.time;
1378       else
1379         max = -1;
1380
1381       /* adjust for min-threshold */
1382       if (queue->min_threshold.time > 0 && min != -1)
1383         min += queue->min_threshold.time;
1384
1385       gst_query_set_latency (query, live, min, max);
1386       break;
1387     }
1388     default:
1389       /* peer handled other queries */
1390       break;
1391   }
1392
1393   return TRUE;
1394 }
1395
1396 static gboolean
1397 gst_queue_sink_activate_mode (GstPad * pad, GstObject * parent, GstPadMode mode,
1398     gboolean active)
1399 {
1400   gboolean result;
1401   GstQueue *queue;
1402
1403   queue = GST_QUEUE (parent);
1404
1405   switch (mode) {
1406     case GST_PAD_MODE_PUSH:
1407       if (active) {
1408         GST_QUEUE_MUTEX_LOCK (queue);
1409         queue->srcresult = GST_FLOW_OK;
1410         queue->eos = FALSE;
1411         queue->unexpected = FALSE;
1412         GST_QUEUE_MUTEX_UNLOCK (queue);
1413       } else {
1414         /* step 1, unblock chain function */
1415         GST_QUEUE_MUTEX_LOCK (queue);
1416         queue->srcresult = GST_FLOW_FLUSHING;
1417         /* the item del signal will unblock */
1418         g_cond_signal (&queue->item_del);
1419         /* unblock query handler */
1420         queue->last_query = FALSE;
1421         g_cond_signal (&queue->query_handled);
1422         GST_QUEUE_MUTEX_UNLOCK (queue);
1423
1424         /* step 2, wait until streaming thread stopped and flush queue */
1425         GST_PAD_STREAM_LOCK (pad);
1426         GST_QUEUE_MUTEX_LOCK (queue);
1427         gst_queue_locked_flush (queue, TRUE);
1428         GST_QUEUE_MUTEX_UNLOCK (queue);
1429         GST_PAD_STREAM_UNLOCK (pad);
1430       }
1431       result = TRUE;
1432       break;
1433     default:
1434       result = FALSE;
1435       break;
1436   }
1437   return result;
1438 }
1439
1440 static gboolean
1441 gst_queue_src_activate_mode (GstPad * pad, GstObject * parent, GstPadMode mode,
1442     gboolean active)
1443 {
1444   gboolean result;
1445   GstQueue *queue;
1446
1447   queue = GST_QUEUE (parent);
1448
1449   switch (mode) {
1450     case GST_PAD_MODE_PUSH:
1451       if (active) {
1452         GST_QUEUE_MUTEX_LOCK (queue);
1453         queue->srcresult = GST_FLOW_OK;
1454         queue->eos = FALSE;
1455         queue->unexpected = FALSE;
1456         result =
1457             gst_pad_start_task (pad, (GstTaskFunction) gst_queue_loop, pad,
1458             NULL);
1459         GST_QUEUE_MUTEX_UNLOCK (queue);
1460       } else {
1461         /* step 1, unblock loop function */
1462         GST_QUEUE_MUTEX_LOCK (queue);
1463         queue->srcresult = GST_FLOW_FLUSHING;
1464         /* the item add signal will unblock */
1465         g_cond_signal (&queue->item_add);
1466         GST_QUEUE_MUTEX_UNLOCK (queue);
1467
1468         /* step 2, make sure streaming finishes */
1469         result = gst_pad_stop_task (pad);
1470       }
1471       break;
1472     default:
1473       result = FALSE;
1474       break;
1475   }
1476   return result;
1477 }
1478
1479 static void
1480 queue_capacity_change (GstQueue * queue)
1481 {
1482   if (queue->leaky == GST_QUEUE_LEAK_DOWNSTREAM) {
1483     gst_queue_leak_downstream (queue);
1484   }
1485
1486   /* changing the capacity of the queue must wake up
1487    * the _chain function, it might have more room now
1488    * to store the buffer/event in the queue */
1489   GST_QUEUE_SIGNAL_DEL (queue);
1490 }
1491
1492 /* Changing the minimum required fill level must
1493  * wake up the _loop function as it might now
1494  * be able to preceed.
1495  */
1496 #define QUEUE_THRESHOLD_CHANGE(q)\
1497   GST_QUEUE_SIGNAL_ADD (q);
1498
1499 static void
1500 gst_queue_set_property (GObject * object,
1501     guint prop_id, const GValue * value, GParamSpec * pspec)
1502 {
1503   GstQueue *queue = GST_QUEUE (object);
1504
1505   /* someone could change levels here, and since this
1506    * affects the get/put funcs, we need to lock for safety. */
1507   GST_QUEUE_MUTEX_LOCK (queue);
1508
1509   switch (prop_id) {
1510     case PROP_MAX_SIZE_BYTES:
1511       queue->max_size.bytes = g_value_get_uint (value);
1512       queue_capacity_change (queue);
1513       break;
1514     case PROP_MAX_SIZE_BUFFERS:
1515       queue->max_size.buffers = g_value_get_uint (value);
1516       queue_capacity_change (queue);
1517       break;
1518     case PROP_MAX_SIZE_TIME:
1519       queue->max_size.time = g_value_get_uint64 (value);
1520       queue_capacity_change (queue);
1521       break;
1522     case PROP_MIN_THRESHOLD_BYTES:
1523       queue->min_threshold.bytes = g_value_get_uint (value);
1524       queue->orig_min_threshold.bytes = queue->min_threshold.bytes;
1525       QUEUE_THRESHOLD_CHANGE (queue);
1526       break;
1527     case PROP_MIN_THRESHOLD_BUFFERS:
1528       queue->min_threshold.buffers = g_value_get_uint (value);
1529       queue->orig_min_threshold.buffers = queue->min_threshold.buffers;
1530       QUEUE_THRESHOLD_CHANGE (queue);
1531       break;
1532     case PROP_MIN_THRESHOLD_TIME:
1533       queue->min_threshold.time = g_value_get_uint64 (value);
1534       queue->orig_min_threshold.time = queue->min_threshold.time;
1535       QUEUE_THRESHOLD_CHANGE (queue);
1536       break;
1537     case PROP_LEAKY:
1538       queue->leaky = g_value_get_enum (value);
1539       break;
1540     case PROP_SILENT:
1541       queue->silent = g_value_get_boolean (value);
1542       break;
1543     case PROP_FLUSH_ON_EOS:
1544       queue->flush_on_eos = g_value_get_boolean (value);
1545       break;
1546     default:
1547       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1548       break;
1549   }
1550
1551   GST_QUEUE_MUTEX_UNLOCK (queue);
1552 }
1553
1554 static void
1555 gst_queue_get_property (GObject * object,
1556     guint prop_id, GValue * value, GParamSpec * pspec)
1557 {
1558   GstQueue *queue = GST_QUEUE (object);
1559
1560   GST_QUEUE_MUTEX_LOCK (queue);
1561
1562   switch (prop_id) {
1563     case PROP_CUR_LEVEL_BYTES:
1564       g_value_set_uint (value, queue->cur_level.bytes);
1565       break;
1566     case PROP_CUR_LEVEL_BUFFERS:
1567       g_value_set_uint (value, queue->cur_level.buffers);
1568       break;
1569     case PROP_CUR_LEVEL_TIME:
1570       g_value_set_uint64 (value, queue->cur_level.time);
1571       break;
1572     case PROP_MAX_SIZE_BYTES:
1573       g_value_set_uint (value, queue->max_size.bytes);
1574       break;
1575     case PROP_MAX_SIZE_BUFFERS:
1576       g_value_set_uint (value, queue->max_size.buffers);
1577       break;
1578     case PROP_MAX_SIZE_TIME:
1579       g_value_set_uint64 (value, queue->max_size.time);
1580       break;
1581     case PROP_MIN_THRESHOLD_BYTES:
1582       g_value_set_uint (value, queue->min_threshold.bytes);
1583       break;
1584     case PROP_MIN_THRESHOLD_BUFFERS:
1585       g_value_set_uint (value, queue->min_threshold.buffers);
1586       break;
1587     case PROP_MIN_THRESHOLD_TIME:
1588       g_value_set_uint64 (value, queue->min_threshold.time);
1589       break;
1590     case PROP_LEAKY:
1591       g_value_set_enum (value, queue->leaky);
1592       break;
1593     case PROP_SILENT:
1594       g_value_set_boolean (value, queue->silent);
1595       break;
1596     case PROP_FLUSH_ON_EOS:
1597       g_value_set_boolean (value, queue->flush_on_eos);
1598       break;
1599     default:
1600       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1601       break;
1602   }
1603
1604   GST_QUEUE_MUTEX_UNLOCK (queue);
1605 }