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