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