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  *
   6  * gstqueue.c:
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24
  25 #include "gst_private.h"
  26
  27 #include "gstqueue.h"
  28 #include "gstscheduler.h"
  29 #include "gstevent.h"
  30 #include "gstinfo.h"
  31
  32 static GstElementDetails gst_queue_details = GST_ELEMENT_DETAILS (
  33   "Queue",
  34   "Generic",
  35   "Simple data queue",
  36   "Erik Walthinsen <omega@cse.ogi.edu>"
  37 );
  38
  39
  40 /* Queue signals and args */
  41 enum {
  42   SIGNAL_UNDERRUN,
  43   SIGNAL_RUNNING,
  44   SIGNAL_OVERRUN,
  45   LAST_SIGNAL
  46 };
  47
  48 enum {
  49   ARG_0,
  50   /* FIXME: don't we have another way of doing this
  51    * "Gstreamer format" (frame/byte/time) queries? */
  52   ARG_CUR_LEVEL_BUFFERS,
  53   ARG_CUR_LEVEL_BYTES,
  54   ARG_CUR_LEVEL_TIME,
  55   ARG_MAX_SIZE_BUFFERS,
  56   ARG_MAX_SIZE_BYTES,
  57   ARG_MAX_SIZE_TIME,
  58   ARG_MIN_THRESHOLD_BUFFERS,
  59   ARG_MIN_THRESHOLD_BYTES,
  60   ARG_MIN_THRESHOLD_TIME,
  61   ARG_LEAKY,
  62   ARG_MAY_DEADLOCK,
  63   ARG_BLOCK_TIMEOUT
  64   /* FILL ME */
  65 };
  66
  67 typedef struct _GstQueueEventResponse {
  68   GstEvent *event;
  69   gboolean ret, handled;
  70 } GstQueueEventResponse;
  71
  72 static void     gst_queue_base_init             (GstQueueClass *klass);
  73 static void     gst_queue_class_init            (GstQueueClass *klass);
  74 static void     gst_queue_init                  (GstQueue      *queue);
  75 static void     gst_queue_dispose               (GObject       *object);
  76
  77 static void     gst_queue_set_property          (GObject       *object,
  78                                                  guint          prop_id,
  79                                                  const GValue  *value,
  80                                                  GParamSpec    *pspec);
  81 static void     gst_queue_get_property          (GObject       *object,
  82                                                  guint          prop_id,
  83                                                  GValue        *value,
  84                                                  GParamSpec    *pspec);
  85
  86 static void     gst_queue_chain                 (GstPad        *pad,
  87                                                  GstData       *data);
  88 static GstData *gst_queue_get                   (GstPad        *pad);
  89
  90 static gboolean gst_queue_handle_src_event      (GstPad        *pad,
  91                                                  GstEvent      *event);
  92
  93 static GstCaps *gst_queue_getcaps               (GstPad *pad);
  94 static GstPadLinkReturn
  95                 gst_queue_link                  (GstPad *pad,
  96                                                  const GstCaps *caps);
  97 static void     gst_queue_locked_flush          (GstQueue      *queue);
  98
  99 static GstElementStateReturn
 100                 gst_queue_change_state          (GstElement    *element);
 101 static gboolean gst_queue_release_locks         (GstElement    *element);
 102
 103
 104 #define GST_TYPE_QUEUE_LEAKY (queue_leaky_get_type ())
 105
 106 static GType
 107 queue_leaky_get_type (void)
 108 {
 109   static GType queue_leaky_type = 0;
 110   static GEnumValue queue_leaky[] = {
 111     { GST_QUEUE_NO_LEAK,                "0", "Not Leaky" },
 112     { GST_QUEUE_LEAK_UPSTREAM,          "1", "Leaky on Upstream" },
 113     { GST_QUEUE_LEAK_DOWNSTREAM,        "2", "Leaky on Downstream" },
 114     { 0, NULL, NULL },
 115   };
 116   if (!queue_leaky_type) {
 117     queue_leaky_type = g_enum_register_static("GstQueueLeaky", queue_leaky);
 118   }
 119   return queue_leaky_type;
 120 }
 121
 122 static GstElementClass *parent_class = NULL;
 123 static guint gst_queue_signals[LAST_SIGNAL] = { 0 };
 124
 125 GType
 126 gst_queue_get_type (void)
 127 {
 128   static GType queue_type = 0;
 129
 130   if (!queue_type) {
 131     static const GTypeInfo queue_info = {
 132       sizeof (GstQueueClass),
 133       (GBaseInitFunc) gst_queue_base_init,
 134       NULL,
 135       (GClassInitFunc) gst_queue_class_init,
 136       NULL,
 137       NULL,
 138       sizeof (GstQueue),
 139       4,
 140       (GInstanceInitFunc) gst_queue_init,
 141       NULL
 142     };
 143
 144     queue_type = g_type_register_static (GST_TYPE_ELEMENT,
 145                                          "GstQueue", &queue_info, 0);
 146   }
 147
 148   return queue_type;
 149 }
 150
 151 static void
 152 gst_queue_base_init (GstQueueClass *klass)
 153 {
 154   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
 155
 156   gst_element_class_set_details (gstelement_class, &gst_queue_details);
 157 }
 158
 159 static void
 160 gst_queue_class_init (GstQueueClass *klass)
 161 {
 162   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 163   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
 164
 165   parent_class = g_type_class_peek_parent (klass);
 166
 167   /* signals */
 168   gst_queue_signals[SIGNAL_UNDERRUN] =
 169     g_signal_new ("underrun", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_FIRST,
 170                   G_STRUCT_OFFSET (GstQueueClass, underrun), NULL, NULL,
 171                   g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
 172   gst_queue_signals[SIGNAL_RUNNING] =
 173     g_signal_new ("running", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_FIRST,
 174                   G_STRUCT_OFFSET (GstQueueClass, running), NULL, NULL,
 175                   g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
 176   gst_queue_signals[SIGNAL_OVERRUN] =
 177     g_signal_new ("overrun", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_FIRST,
 178                   G_STRUCT_OFFSET (GstQueueClass, overrun), NULL, NULL,
 179                   g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
 180
 181   /* properties */
 182   g_object_class_install_property (gobject_class, ARG_CUR_LEVEL_BYTES,
 183     g_param_spec_uint ("current-level-bytes", "Current level (kB)",
 184                        "Current amount of data in the queue (bytes)",
 185                        0, G_MAXUINT, 0, G_PARAM_READABLE));
 186   g_object_class_install_property (gobject_class, ARG_CUR_LEVEL_BUFFERS,
 187     g_param_spec_uint ("current-level-buffers", "Current level (buffers)",
 188                        "Current number of buffers in the queue",
 189                        0, G_MAXUINT, 0, G_PARAM_READABLE));
 190   g_object_class_install_property (gobject_class, ARG_CUR_LEVEL_TIME,
 191     g_param_spec_uint64 ("current-level-time", "Current level (ns)",
 192                          "Current amount of data in the queue (in ns)",
 193                          0, G_MAXUINT64, 0, G_PARAM_READABLE));
 194
 195   g_object_class_install_property (gobject_class, ARG_MAX_SIZE_BYTES,
 196     g_param_spec_uint ("max-size-bytes", "Max. size (kB)",
 197                        "Max. amount of data in the queue (bytes, 0=disable)",
 198                        0, G_MAXUINT, 0, G_PARAM_READWRITE));
 199   g_object_class_install_property (gobject_class, ARG_MAX_SIZE_BUFFERS,
 200     g_param_spec_uint ("max-size-buffers", "Max. size (buffers)",
 201                        "Max. number of buffers in the queue (0=disable)",
 202                        0, G_MAXUINT, 0, G_PARAM_READWRITE));
 203   g_object_class_install_property (gobject_class, ARG_MAX_SIZE_TIME,
 204     g_param_spec_uint64 ("max-size-time", "Max. size (ns)",
 205                          "Max. amount of data in the queue (in ns, 0=disable)",
 206                          0, G_MAXUINT64, 0, G_PARAM_READWRITE));
 207
 208   g_object_class_install_property (gobject_class, ARG_MIN_THRESHOLD_BYTES,
 209     g_param_spec_uint ("min-threshold-bytes", "Min. threshold (kB)",
 210                        "Min. amount of data in the queue to allow reading (bytes, 0=disable)",
 211                        0, G_MAXUINT, 0, G_PARAM_READWRITE));
 212   g_object_class_install_property (gobject_class, ARG_MIN_THRESHOLD_BUFFERS,
 213     g_param_spec_uint ("min-threshold-buffers", "Min. threshold (buffers)",
 214                        "Min. number of buffers in the queue to allow reading (0=disable)",
 215                        0, G_MAXUINT, 0, G_PARAM_READWRITE));
 216   g_object_class_install_property (gobject_class, ARG_MIN_THRESHOLD_TIME,
 217     g_param_spec_uint64 ("min-threshold-time", "Min. threshold (ns)",
 218                          "Min. amount of data in the queue to allow reading (in ns, 0=disable)",
 219                          0, G_MAXUINT64, 0, G_PARAM_READWRITE));
 220
 221   g_object_class_install_property (gobject_class, ARG_LEAKY,
 222     g_param_spec_enum ("leaky", "Leaky",
 223                        "Where the queue leaks, if at all",
 224                        GST_TYPE_QUEUE_LEAKY, GST_QUEUE_NO_LEAK, G_PARAM_READWRITE));
 225   g_object_class_install_property (gobject_class, ARG_MAY_DEADLOCK,
 226     g_param_spec_boolean ("may_deadlock", "May Deadlock",
 227                           "The queue may deadlock if it's full and not PLAYING",
 228                           TRUE, G_PARAM_READWRITE));
 229   g_object_class_install_property (gobject_class, ARG_BLOCK_TIMEOUT,
 230     g_param_spec_uint64 ("block_timeout", "Timeout for Block",
 231                          "Nanoseconds until blocked queue times out and returns filler event. "
 232                          "Value of -1 disables timeout",
 233                          0, G_MAXUINT64, -1, G_PARAM_READWRITE));
 234
 235   /* set several parent class virtual functions */
 236   gobject_class->dispose        = GST_DEBUG_FUNCPTR (gst_queue_dispose);
 237   gobject_class->set_property   = GST_DEBUG_FUNCPTR (gst_queue_set_property);
 238   gobject_class->get_property   = GST_DEBUG_FUNCPTR (gst_queue_get_property);
 239
 240   gstelement_class->change_state  = GST_DEBUG_FUNCPTR (gst_queue_change_state);
 241   gstelement_class->release_locks = GST_DEBUG_FUNCPTR (gst_queue_release_locks);
 242 }
 243
 244 static void
 245 gst_queue_init (GstQueue *queue)
 246 {
 247   /* scheduling on this kind of element is, well, interesting */
 248   GST_FLAG_SET (queue, GST_ELEMENT_DECOUPLED);
 249   GST_FLAG_SET (queue, GST_ELEMENT_EVENT_AWARE);
 250
 251   queue->sinkpad = gst_pad_new ("sink", GST_PAD_SINK);
 252   gst_pad_set_chain_function (queue->sinkpad, GST_DEBUG_FUNCPTR (gst_queue_chain));
 253   gst_element_add_pad (GST_ELEMENT (queue), queue->sinkpad);
 254   gst_pad_set_link_function (queue->sinkpad, GST_DEBUG_FUNCPTR (gst_queue_link));
 255   gst_pad_set_getcaps_function (queue->sinkpad, GST_DEBUG_FUNCPTR (gst_queue_getcaps));
 256   gst_pad_set_active (queue->sinkpad, TRUE);
 257
 258   queue->srcpad = gst_pad_new ("src", GST_PAD_SRC);
 259   gst_pad_set_get_function (queue->srcpad, GST_DEBUG_FUNCPTR (gst_queue_get));
 260   gst_element_add_pad (GST_ELEMENT (queue), queue->srcpad);
 261   gst_pad_set_link_function (queue->srcpad, GST_DEBUG_FUNCPTR (gst_queue_link));
 262   gst_pad_set_getcaps_function (queue->srcpad, GST_DEBUG_FUNCPTR (gst_queue_getcaps));
 263   gst_pad_set_event_function (queue->srcpad, GST_DEBUG_FUNCPTR (gst_queue_handle_src_event));
 264   gst_pad_set_active (queue->srcpad, TRUE);
 265
 266   queue->cur_level.buffers      = 0; /* no content */
 267   queue->cur_level.bytes        = 0; /* no content */
 268   queue->cur_level.time         = 0; /* no content */
 269   queue->max_size.buffers       = 250; /* high limit */
 270   queue->max_size.bytes         = 0; /* unlimited */
 271   queue->max_size.time          = 0; /* unlimited */
 272   queue->min_threshold.buffers  = 0; /* no threshold */
 273   queue->min_threshold.bytes    = 0; /* no threshold */
 274   queue->min_threshold.time     = 0; /* no threshold */
 275
 276   queue->leaky = GST_QUEUE_NO_LEAK;
 277   queue->may_deadlock = TRUE;
 278   queue->block_timeout = GST_CLOCK_TIME_NONE;
 279   queue->interrupt = FALSE;
 280   queue->flush = FALSE;
 281
 282   queue->qlock = g_mutex_new ();
 283   queue->item_add = g_cond_new ();
 284   queue->item_del = g_cond_new ();
 285   queue->event_done = g_cond_new ();
 286   queue->events = g_queue_new ();
 287   queue->queue = g_queue_new ();
 288
 289   GST_CAT_DEBUG_OBJECT (GST_CAT_THREAD, queue,
 290                         "initialized queue's not_empty & not_full conditions");
 291 }
 292
 293 static void
 294 gst_queue_dispose (GObject *object)
 295 {
 296   GstQueue *queue = GST_QUEUE (object);
 297
 298   gst_element_set_state (GST_ELEMENT (queue), GST_STATE_NULL);
 299
 300   while (!g_queue_is_empty (queue->queue)) {
 301     GstData *data = g_queue_pop_head (queue->queue);
 302     gst_data_unref (data);
 303   }
 304   g_queue_free (queue->queue);
 305   g_mutex_free (queue->qlock);
 306   g_cond_free (queue->item_add);
 307   g_cond_free (queue->item_del);
 308   g_cond_free (queue->event_done);
 309   while (!g_queue_is_empty (queue->events)) {
 310     GstEvent *event = g_queue_pop_head (queue->events);
 311     gst_event_unref (event);
 312   }
 313
 314   if (G_OBJECT_CLASS (parent_class)->dispose)
 315     G_OBJECT_CLASS (parent_class)->dispose (object);
 316 }
 317
 318 static GstCaps *
 319 gst_queue_getcaps (GstPad *pad)
 320 {
 321   GstQueue *queue;
 322
 323   queue = GST_QUEUE (gst_pad_get_parent (pad));
 324
 325   if (queue->cur_level.bytes > 0) {
 326     return gst_caps_copy (queue->negotiated_caps);
 327   }
 328
 329   return gst_pad_proxy_getcaps (pad);
 330 }
 331
 332 static GstPadLinkReturn
 333 gst_queue_link (GstPad *pad, const GstCaps *caps)
 334 {
 335   GstQueue *queue;
 336   GstPadLinkReturn link_ret;
 337
 338   queue = GST_QUEUE (gst_pad_get_parent (pad));
 339
 340   if (queue->cur_level.bytes > 0) {
 341     if (gst_caps_is_equal_fixed (caps, queue->negotiated_caps)) {
 342       return GST_PAD_LINK_OK;
 343     }
 344     return GST_PAD_LINK_REFUSED;
 345   }
 346
 347   link_ret = gst_pad_proxy_pad_link (pad, caps);
 348
 349   if (GST_PAD_LINK_SUCCESSFUL (link_ret)) {
 350     /* we store an extra copy of the negotiated caps, just in case
 351      * the pads become unnegotiated while we have buffers */
 352     gst_caps_replace (&queue->negotiated_caps, gst_caps_copy (caps));
 353   }
 354
 355   return link_ret;
 356 }
 357
 358 static void
 359 gst_queue_locked_flush (GstQueue *queue)
 360 {
 361   while (!g_queue_is_empty (queue->queue)) {
 362     GstData *data = g_queue_pop_head (queue->queue);
 363     gst_data_unref (data);
 364   }
 365   queue->timeval = NULL;
 366   queue->cur_level.buffers = 0;
 367   queue->cur_level.bytes = 0;
 368   queue->cur_level.time = 0;
 369
 370   /* make sure any pending buffers to be added are flushed too */
 371   queue->flush = TRUE;
 372
 373   /* we deleted something... */
 374   g_cond_signal (queue->item_del);
 375 }
 376
 377 static void
 378 gst_queue_handle_pending_events (GstQueue *queue)
 379 {
 380   /* check for events to send upstream */
 381   while (!g_queue_is_empty (queue->events)){
 382     GstQueueEventResponse *er = g_queue_pop_head (queue->events);
 383     GST_CAT_DEBUG_OBJECT (GST_CAT_DATAFLOW, queue, "sending event upstream");
 384     er->ret = gst_pad_event_default (queue->srcpad, er->event);
 385     er->handled = TRUE;
 386     g_cond_signal (queue->event_done);
 387     GST_CAT_DEBUG_OBJECT (GST_CAT_DATAFLOW, queue, "event sent");
 388   }
 389 }
 390
 391 #define STATUS(queue, msg) \
 392   GST_CAT_LOG_OBJECT (GST_CAT_DATAFLOW, queue, \
 393                       "(%s:%s) " msg ": %u of %u-%u buffers, %u of %u-%u " \
 394                       "bytes, %" G_GUINT64_FORMAT " of %" G_GUINT64_FORMAT \
 395                       "-%" G_GUINT64_FORMAT " ns, %u elements", \
 396                       GST_DEBUG_PAD_NAME (pad), \
 397                       queue->cur_level.buffers, \
 398                       queue->min_threshold.buffers, \
 399                       queue->max_size.buffers, \
 400                       queue->cur_level.bytes, \
 401                       queue->min_threshold.bytes, \
 402                       queue->max_size.bytes, \
 403                       queue->cur_level.time, \
 404                       queue->min_threshold.time, \
 405                       queue->max_size.time, \
 406                       queue->queue->length)
 407
 408 static void
 409 gst_queue_chain (GstPad  *pad,
 410                  GstData *data)
 411 {
 412   GstQueue *queue;
 413
 414   g_return_if_fail (pad != NULL);
 415   g_return_if_fail (GST_IS_PAD (pad));
 416   g_return_if_fail (data != NULL);
 417
 418   queue = GST_QUEUE (GST_OBJECT_PARENT (pad));
 419
 420 restart:
 421   /* we have to lock the queue since we span threads */
 422   GST_CAT_LOG_OBJECT (GST_CAT_DATAFLOW, queue, "locking t:%p", g_thread_self ());
 423   g_mutex_lock (queue->qlock);
 424   GST_CAT_LOG_OBJECT (GST_CAT_DATAFLOW, queue, "locked t:%p", g_thread_self ());
 425
 426   gst_queue_handle_pending_events (queue);
 427
 428   /* assume don't need to flush this buffer when the queue is filled */
 429   queue->flush = FALSE;
 430
 431   if (GST_IS_EVENT (data)) {
 432     switch (GST_EVENT_TYPE (data)) {
 433       case GST_EVENT_FLUSH:
 434         STATUS (queue, "received flush event");
 435         gst_queue_locked_flush (queue);
 436         STATUS (queue, "after flush");
 437         break;
 438       case GST_EVENT_EOS:
 439         STATUS (queue, "received EOS");
 440         break;
 441       default:
 442         /* we put the event in the queue, we don't have to act ourselves */
 443         GST_CAT_LOG_OBJECT (GST_CAT_DATAFLOW, queue,
 444                             "adding event %p of type %d",
 445                             data, GST_EVENT_TYPE (data));
 446         break;
 447     }
 448   }
 449
 450   if (GST_IS_BUFFER (data))
 451     GST_CAT_LOG_OBJECT (GST_CAT_DATAFLOW, queue,
 452                         "adding buffer %p of size %d",
 453                         data, GST_BUFFER_SIZE (data));
 454
 455   /* We make space available if we're "full" according to whatever
 456    * the user defined as "full". Note that this only applies to buffers.
 457    * We always handle events and they don't count in our statistics. */
 458   if (GST_IS_BUFFER (data) &&
 459       ((queue->max_size.buffers > 0 &&
 460         queue->cur_level.buffers >= queue->max_size.buffers) ||
 461        (queue->max_size.bytes > 0 &&
 462         queue->cur_level.bytes >= queue->max_size.bytes) ||
 463        (queue->max_size.time > 0 &&
 464         queue->cur_level.time >= queue->max_size.time))) {
 465     g_mutex_unlock (queue->qlock);
 466     g_signal_emit (G_OBJECT (queue), gst_queue_signals[SIGNAL_OVERRUN], 0);
 467     g_mutex_lock (queue->qlock);
 468
 469     /* how are we going to make space for this buffer? */
 470     switch (queue->leaky) {
 471       /* leak current buffer */
 472       case GST_QUEUE_LEAK_UPSTREAM:
 473         GST_CAT_DEBUG_OBJECT (GST_CAT_DATAFLOW, queue,
 474                               "queue is full, leaking buffer on upstream end");
 475         /* now we can clean up and exit right away */
 476         g_mutex_unlock (queue->qlock);
 477         goto out_unref;
 478
 479       /* leak first buffer in the queue */
 480       case GST_QUEUE_LEAK_DOWNSTREAM: {
 481         /* this is a bit hacky. We'll manually iterate the list
 482          * and find the first buffer from the head on. We'll
 483          * unref that and "fix up" the GQueue object... */
 484         GList *item;
 485         GstData *leak = NULL;
 486
 487         GST_CAT_DEBUG_OBJECT (GST_CAT_DATAFLOW, queue,
 488                               "queue is full, leaking buffer on downstream end");
 489
 490         for (item = queue->queue->head; item != NULL; item = item->next) {
 491           if (GST_IS_BUFFER (item->data)) {
 492             leak = item->data;
 493             break;
 494           }
 495         }
 496
 497         /* if we didn't find anything, it means we have no buffers
 498          * in here. That cannot happen, since we had >= 1 bufs */
 499         g_assert (leak);
 500
 501         /* Now remove it from the list, fixing up the GQueue
 502          * CHECKME: is a queue->head the first or the last item? */
 503         item = g_list_delete_link (queue->queue->head, item);
 504         queue->queue->head = g_list_first (item);
 505         queue->queue->tail = g_list_last (item);
 506         queue->queue->length--;
 507
 508         /* and unref the data at the end. Twice, because we keep a ref
 509          * to make things read-only. Also keep our list uptodate. */
 510         queue->cur_level.bytes -= GST_BUFFER_SIZE (data);
 511         queue->cur_level.buffers --;
 512         g_object_notify (G_OBJECT (queue), "current-level-buffers");
 513         if (GST_BUFFER_DURATION (data) != GST_CLOCK_TIME_NONE)
 514           queue->cur_level.time -= GST_BUFFER_DURATION (data);
 515
 516         gst_data_unref (data);
 517         gst_data_unref (data);
 518         break;
 519       }
 520
 521       default:
 522         g_warning ("Unknown leaky type, using default");
 523         /* fall-through */
 524
 525       /* don't leak. Instead, wait for space to be available */
 526       case GST_QUEUE_NO_LEAK:
 527         STATUS (queue, "pre-full wait");
 528
 529         while ((queue->max_size.buffers > 0 &&
 530                 queue->cur_level.buffers >= queue->max_size.buffers) ||
 531                (queue->max_size.bytes > 0 &&
 532                 queue->cur_level.bytes >= queue->max_size.bytes) ||
 533                (queue->max_size.time > 0 &&
 534                 queue->cur_level.time >= queue->max_size.time)) {
 535           /* if there's a pending state change for this queue
 536            * or its manager, switch back to iterator so bottom
 537            * half of state change executes */
 538           if (queue->interrupt) {
 539             GST_CAT_DEBUG_OBJECT (GST_CAT_DATAFLOW, queue, "interrupted");
 540             g_mutex_unlock (queue->qlock);
 541             if (gst_scheduler_interrupt (gst_pad_get_scheduler (queue->sinkpad),
 542                                          GST_ELEMENT (queue))) {
 543               goto out_unref;
 544             }
 545             /* if we got here because we were unlocked after a
 546              * flush, we don't need to add the buffer to the
 547              * queue again */
 548             if (queue->flush) {
 549               GST_CAT_DEBUG_OBJECT (GST_CAT_DATAFLOW, queue,
 550                                     "not adding pending buffer after flush");
 551               goto out_unref;
 552             }
 553             GST_CAT_DEBUG_OBJECT (GST_CAT_DATAFLOW, queue,
 554                                   "adding pending buffer after interrupt");
 555             goto restart;
 556           }
 557
 558           if (GST_STATE (queue) != GST_STATE_PLAYING) {
 559             /* this means the other end is shut down. Try to
 560              * signal to resolve the error */
 561             if (!queue->may_deadlock) {
 562               g_mutex_unlock (queue->qlock);
 563               gst_data_unref (data);
 564               gst_element_error (GST_ELEMENT (queue),
 565                                  "deadlock found, source pad elements are shut down");
 566               /* we don't go to out_unref here, since we want to
 567                * unref the buffer *before* calling gst_element_error */
 568               return;
 569             } else {
 570               GST_CAT_WARNING_OBJECT (GST_CAT_DATAFLOW, queue,
 571                                       "%s: waiting for the app to restart "
 572                                       "source pad elements",
 573                                       GST_ELEMENT_NAME (queue));
 574             }
 575           }
 576
 577           /* OK, we've got a serious issue here. Imagine the situation
 578            * where the puller (next element) is sending an event here,
 579            * so it cannot pull events from the queue, and we cannot
 580            * push data further because the queue is 'full' and therefore,
 581            * we wait here (and do not handle events): deadlock! to solve
 582            * that, we handle pending upstream events here, too. */
 583           gst_queue_handle_pending_events (queue);
 584
 585           STATUS (queue, "waiting for item_del signal");
 586           g_cond_wait (queue->item_del, queue->qlock);
 587           STATUS (queue, "received item_del signal");
 588         }
 589
 590         STATUS (queue, "post-full wait");
 591         g_mutex_unlock (queue->qlock);
 592         g_signal_emit (G_OBJECT (queue), gst_queue_signals[SIGNAL_RUNNING], 0);
 593         g_mutex_lock (queue->qlock);
 594         break;
 595     }
 596   }
 597
 598   /* put the buffer on the tail of the list. We keep a reference,
 599    * so that the data is read-only while in here. There's a good
 600    * reason to do so: we have a size and time counter, and any
 601    * modification to the content could change any of the two. */
 602   gst_data_ref (data);
 603   g_queue_push_tail (queue->queue, data);
 604
 605   /* Note that we only add buffers (not events) to the statistics */
 606   if (GST_IS_BUFFER (data)) {
 607     queue->cur_level.buffers++;
 608     g_object_notify (G_OBJECT (queue), "current-level-buffers");
 609     queue->cur_level.bytes += GST_BUFFER_SIZE (data);
 610     if (GST_BUFFER_DURATION (data) != GST_CLOCK_TIME_NONE)
 611       queue->cur_level.time += GST_BUFFER_DURATION (data);
 612   }
 613
 614   STATUS (queue, "+ level");
 615
 616   GST_CAT_LOG_OBJECT (GST_CAT_DATAFLOW, queue, "signalling item_add");
 617   g_cond_signal (queue->item_add);
 618   g_mutex_unlock (queue->qlock);
 619
 620   return;
 621
 622 out_unref:
 623   gst_data_unref (data);
 624   return;
 625 }
 626
 627 static GstData *
 628 gst_queue_get (GstPad *pad)
 629 {
 630   GstQueue *queue;
 631   GstData *data;
 632
 633   g_return_val_if_fail (pad != NULL, NULL);
 634   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
 635
 636   queue = GST_QUEUE (gst_pad_get_parent (pad));
 637
 638 restart:
 639   /* have to lock for thread-safety */
 640   GST_CAT_LOG_OBJECT (GST_CAT_DATAFLOW, queue,
 641                       "locking t:%p", g_thread_self ());
 642   g_mutex_lock (queue->qlock);
 643   GST_CAT_LOG_OBJECT (GST_CAT_DATAFLOW, queue,
 644                       "locked t:%p", g_thread_self ());
 645
 646   if (queue->queue->length == 0 ||
 647       (queue->min_threshold.buffers > 0 &&
 648        queue->cur_level.buffers < queue->min_threshold.buffers) ||
 649       (queue->min_threshold.bytes > 0 &&
 650        queue->cur_level.bytes < queue->min_threshold.bytes) ||
 651       (queue->min_threshold.time > 0 &&
 652        queue->cur_level.time < queue->min_threshold.time)) {
 653     g_mutex_unlock (queue->qlock);
 654     g_signal_emit (G_OBJECT (queue), gst_queue_signals[SIGNAL_UNDERRUN], 0);
 655     g_mutex_lock (queue->qlock);
 656
 657     STATUS (queue, "pre-empty wait");
 658     while (queue->queue->length == 0 ||
 659            (queue->min_threshold.buffers > 0 &&
 660             queue->cur_level.buffers < queue->min_threshold.buffers) ||
 661            (queue->min_threshold.bytes > 0 &&
 662             queue->cur_level.bytes < queue->min_threshold.bytes) ||
 663            (queue->min_threshold.time > 0 &&
 664             queue->cur_level.time < queue->min_threshold.time)) {
 665       /* if there's a pending state change for this queue or its
 666        * manager, switch back to iterator so bottom half of state
 667        * change executes. */
 668       if (queue->interrupt) {
 669         GST_CAT_DEBUG_OBJECT (GST_CAT_DATAFLOW, queue, "interrupted");
 670         g_mutex_unlock (queue->qlock);
 671         if (gst_scheduler_interrupt (gst_pad_get_scheduler (queue->srcpad),
 672                                      GST_ELEMENT (queue)))
 673           return GST_DATA (gst_event_new (GST_EVENT_INTERRUPT));
 674         goto restart;
 675       }
 676       if (GST_STATE (queue) != GST_STATE_PLAYING) {
 677         /* this means the other end is shut down */
 678         if (!queue->may_deadlock) {
 679           g_mutex_unlock (queue->qlock);
 680           gst_element_error (GST_ELEMENT (queue),
 681                              "deadlock found, sink pad elements are shut down");
 682           goto restart;
 683         } else {
 684           GST_CAT_WARNING_OBJECT (GST_CAT_DATAFLOW, queue,
 685                                   "%s: waiting for the app to restart "
 686                                   "source pad elements",
 687                                   GST_ELEMENT_NAME (queue));
 688         }
 689       }
 690
 691       STATUS (queue, "waiting for item_add");
 692
 693       if (queue->block_timeout != GST_CLOCK_TIME_NONE) {
 694         GTimeVal timeout;
 695         g_get_current_time (&timeout);
 696         g_time_val_add (&timeout, queue->block_timeout / 1000);
 697         if (!g_cond_timed_wait (queue->item_add, queue->qlock, &timeout)){
 698           g_mutex_unlock (queue->qlock);
 699           GST_CAT_WARNING_OBJECT (GST_CAT_DATAFLOW, queue,
 700                                   "Sending filler event");
 701           return GST_DATA (gst_event_new_filler ());
 702         }
 703       } else {
 704         g_cond_wait (queue->item_add, queue->qlock);
 705       }
 706       STATUS (queue, "got item_add signal");
 707     }
 708
 709     STATUS (queue, "post-empty wait");
 710     g_mutex_unlock (queue->qlock);
 711     g_signal_emit (G_OBJECT (queue), gst_queue_signals[SIGNAL_RUNNING], 0);
 712     g_mutex_lock (queue->qlock);
 713   }
 714
 715   /* There's something in the list now, whatever it is */
 716   data = g_queue_pop_head (queue->queue);
 717   GST_CAT_LOG_OBJECT (GST_CAT_DATAFLOW, queue,
 718                       "retrieved data %p from queue", data);
 719
 720   if (GST_IS_BUFFER (data)) {
 721     /* Update statistics */
 722     queue->cur_level.buffers--;
 723     queue->cur_level.bytes -= GST_BUFFER_SIZE (data);
 724     if (GST_BUFFER_DURATION (data) != GST_CLOCK_TIME_NONE)
 725       queue->cur_level.time -= GST_BUFFER_DURATION (data);
 726   }
 727
 728   /* Now that we're done, we can lose our own reference to
 729    * the item, since we're no longer in danger. */
 730   gst_data_unref (data);
 731
 732   STATUS (queue, "after _get()");
 733
 734   GST_CAT_LOG_OBJECT (GST_CAT_DATAFLOW, queue, "signalling item_del");
 735   g_cond_signal (queue->item_del);
 736   g_mutex_unlock (queue->qlock);
 737
 738   /* FIXME: I suppose this needs to be locked, since the EOS
 739    * bit affects the pipeline state. However, that bit is
 740    * locked too so it'd cause a deadlock. */
 741   if (GST_IS_EVENT (data)) {
 742     GstEvent *event = GST_EVENT (data);
 743     switch (GST_EVENT_TYPE (event)) {
 744       case GST_EVENT_EOS:
 745         GST_CAT_DEBUG_OBJECT (GST_CAT_DATAFLOW, queue,
 746                               "queue \"%s\" eos",
 747                               GST_ELEMENT_NAME (queue));
 748         gst_element_set_eos (GST_ELEMENT (queue));
 749         break;
 750       default:
 751         break;
 752     }
 753   }
 754
 755   return data;
 756 }
 757
 758
 759 static gboolean
 760 gst_queue_handle_src_event (GstPad   *pad,
 761                             GstEvent *event)
 762 {
 763   GstQueue *queue = GST_QUEUE (gst_pad_get_parent (pad));
 764   gboolean res;
 765
 766   g_mutex_lock (queue->qlock);
 767
 768   if (gst_element_get_state (GST_ELEMENT (queue)) == GST_STATE_PLAYING) {
 769     GstQueueEventResponse er;
 770
 771     /* push the event to the queue and wait for upstream consumption */
 772     er.event = event;
 773     er.handled = FALSE;
 774     g_queue_push_tail (queue->events, &er);
 775     GST_CAT_WARNING_OBJECT (GST_CAT_DATAFLOW, queue,
 776                             "Preparing for loop for event handler");
 777     /* see the chain function on why this is here - it prevents a deadlock */
 778     g_cond_signal (queue->item_del);
 779     while (!er.handled) {
 780       GTimeVal timeout;
 781       g_get_current_time (&timeout);
 782       g_time_val_add (&timeout, 500 * 1000); /* half a second */
 783       if (!g_cond_timed_wait (queue->event_done, queue->qlock, &timeout) &&
 784           !er.handled) {
 785         GST_CAT_WARNING_OBJECT (GST_CAT_DATAFLOW, queue,
 786                                 "timeout in upstream event handling");
 787         /* remove ourselves from the pending list. Since we're
 788          * locked, others cannot reference this anymore. */
 789         queue->queue->head = g_list_remove (queue->queue->head, &er);
 790         queue->queue->head = g_list_first (queue->queue->head);
 791         queue->queue->tail = g_list_last (queue->queue->head);
 792         queue->queue->length--;
 793         res = FALSE;
 794         goto handled;
 795       }
 796     }
 797     GST_CAT_WARNING_OBJECT (GST_CAT_DATAFLOW, queue,
 798                             "Event handled");
 799     res = er.ret;
 800   } else {
 801     res = gst_pad_event_default (pad, event);
 802
 803     switch (GST_EVENT_TYPE (event)) {
 804       case GST_EVENT_FLUSH:
 805         GST_CAT_DEBUG_OBJECT (GST_CAT_DATAFLOW, queue,
 806                               "FLUSH event, flushing queue\n");
 807         gst_queue_locked_flush (queue);
 808         break;
 809       case GST_EVENT_SEEK:
 810         if (GST_EVENT_SEEK_FLAGS (event) & GST_SEEK_FLAG_FLUSH) {
 811           gst_queue_locked_flush (queue);
 812         }
 813       default:
 814         break;
 815     }
 816   }
 817 handled:
 818   g_mutex_unlock (queue->qlock);
 819
 820   return res;
 821 }
 822
 823 static gboolean
 824 gst_queue_release_locks (GstElement *element)
 825 {
 826   GstQueue *queue;
 827
 828   queue = GST_QUEUE (element);
 829
 830   g_mutex_lock (queue->qlock);
 831   queue->interrupt = TRUE;
 832   g_cond_signal (queue->item_add);
 833   g_cond_signal (queue->item_del);
 834   g_mutex_unlock (queue->qlock);
 835
 836   return TRUE;
 837 }
 838
 839 static GstElementStateReturn
 840 gst_queue_change_state (GstElement *element)
 841 {
 842   GstQueue *queue;
 843   GstElementStateReturn ret = GST_STATE_SUCCESS;
 844
 845   queue = GST_QUEUE (element);
 846
 847   GST_CAT_LOG_OBJECT (GST_CAT_STATES, element, "starting state change");
 848
 849   /* lock the queue so another thread (not in sync with this thread's state)
 850    * can't call this queue's _get (or whatever)
 851    */
 852   g_mutex_lock (queue->qlock);
 853
 854   switch (GST_STATE_TRANSITION (element)) {
 855     case GST_STATE_NULL_TO_READY:
 856       gst_queue_locked_flush (queue);
 857       break;
 858     case GST_STATE_PAUSED_TO_PLAYING:
 859       if (!GST_PAD_IS_LINKED (queue->sinkpad)) {
 860         GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, queue,
 861                               "queue %s is not linked",
 862                               GST_ELEMENT_NAME (queue));
 863         /* FIXME can this be? */
 864         g_cond_signal (queue->item_add);
 865
 866         ret = GST_STATE_FAILURE;
 867         goto error;
 868       } else {
 869         GstScheduler *src_sched, *sink_sched;
 870
 871         src_sched = gst_pad_get_scheduler (GST_PAD (queue->srcpad));
 872         sink_sched = gst_pad_get_scheduler (GST_PAD (queue->sinkpad));
 873
 874         if (src_sched == sink_sched) {
 875           GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, queue,
 876                                 "queue %s does not connect different schedulers",
 877                                 GST_ELEMENT_NAME (queue));
 878
 879           g_warning ("queue %s does not connect different schedulers",
 880                      GST_ELEMENT_NAME (queue));
 881
 882           ret = GST_STATE_FAILURE;
 883           goto error;
 884         }
 885       }
 886       queue->interrupt = FALSE;
 887       break;
 888     case GST_STATE_PAUSED_TO_READY:
 889       gst_queue_locked_flush (queue);
 890       break;
 891     default:
 892       break;
 893   }
 894
 895   if (GST_ELEMENT_CLASS (parent_class)->change_state)
 896     ret = GST_ELEMENT_CLASS (parent_class)->change_state (element);
 897
 898   /* this is an ugly hack to make sure our pads are always active.
 899    * Reason for this is that pad activation for the queue element
 900    * depends on 2 schedulers (ugh) */
 901   gst_pad_set_active (queue->sinkpad, TRUE);
 902   gst_pad_set_active (queue->srcpad, TRUE);
 903
 904 error:
 905   g_mutex_unlock (queue->qlock);
 906
 907   GST_CAT_LOG_OBJECT (GST_CAT_STATES, element, "done with state change");
 908
 909   return ret;
 910 }
 911
 912
 913 static void
 914 gst_queue_set_property (GObject      *object,
 915                         guint         prop_id,
 916                         const GValue *value,
 917                         GParamSpec   *pspec)
 918 {
 919   GstQueue *queue = GST_QUEUE (object);
 920
 921   /* someone could change levels here, and since this
 922    * affects the get/put funcs, we need to lock for safety. */
 923   g_mutex_lock (queue->qlock);
 924
 925   switch (prop_id) {
 926     case ARG_MAX_SIZE_BYTES:
 927       queue->max_size.bytes = g_value_get_uint (value);
 928       break;
 929     case ARG_MAX_SIZE_BUFFERS:
 930       queue->max_size.buffers = g_value_get_uint (value);
 931       break;
 932     case ARG_MAX_SIZE_TIME:
 933       queue->max_size.time = g_value_get_uint64 (value);
 934       break;
 935     case ARG_MIN_THRESHOLD_BYTES:
 936       queue->min_threshold.bytes = g_value_get_uint (value);
 937       break;
 938     case ARG_MIN_THRESHOLD_BUFFERS:
 939       queue->min_threshold.buffers = g_value_get_uint (value);
 940       break;
 941     case ARG_MIN_THRESHOLD_TIME:
 942       queue->min_threshold.time = g_value_get_uint64 (value);
 943       break;
 944     case ARG_LEAKY:
 945       queue->leaky = g_value_get_enum (value);
 946       break;
 947     case ARG_MAY_DEADLOCK:
 948       queue->may_deadlock = g_value_get_boolean (value);
 949       break;
 950     case ARG_BLOCK_TIMEOUT:
 951       queue->block_timeout = g_value_get_uint64 (value);
 952       break;
 953     default:
 954       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 955       break;
 956   }
 957
 958   g_mutex_unlock (queue->qlock);
 959 }
 960
 961 static void
 962 gst_queue_get_property (GObject    *object,
 963                         guint       prop_id,
 964                         GValue     *value,
 965                         GParamSpec *pspec)
 966 {
 967   GstQueue *queue = GST_QUEUE (object);
 968
 969   switch (prop_id) {
 970     case ARG_CUR_LEVEL_BYTES:
 971       g_value_set_uint (value, queue->cur_level.bytes);
 972       break;
 973     case ARG_CUR_LEVEL_BUFFERS:
 974       g_value_set_uint (value, queue->cur_level.buffers);
 975       break;
 976     case ARG_CUR_LEVEL_TIME:
 977       g_value_set_uint64 (value, queue->cur_level.time);
 978       break;
 979     case ARG_MAX_SIZE_BYTES:
 980       g_value_set_uint (value, queue->max_size.bytes);
 981       break;
 982     case ARG_MAX_SIZE_BUFFERS:
 983       g_value_set_uint (value, queue->max_size.buffers);
 984       break;
 985     case ARG_MAX_SIZE_TIME:
 986       g_value_set_uint64 (value, queue->max_size.time);
 987       break;
 988     case ARG_MIN_THRESHOLD_BYTES:
 989       g_value_set_uint (value, queue->min_threshold.bytes);
 990       break;
 991     case ARG_MIN_THRESHOLD_BUFFERS:
 992       g_value_set_uint (value, queue->min_threshold.buffers);
 993       break;
 994     case ARG_MIN_THRESHOLD_TIME:
 995       g_value_set_uint64 (value, queue->min_threshold.time);
 996       break;
 997     case ARG_LEAKY:
 998       g_value_set_enum (value, queue->leaky);
 999       break;
1000     case ARG_MAY_DEADLOCK:
1001       g_value_set_boolean (value, queue->may_deadlock);
1002       break;
1003     case ARG_BLOCK_TIMEOUT:
1004       g_value_set_uint64 (value, queue->block_timeout);
1005       break;
1006     default:
1007       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1008       break;
1009   }
1010 }