gst/gstqueue.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *
   5  * gstqueue.c:
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 //#define DEBUG_ENABLED
  24 //#define STATUS_ENABLED
  25 #ifdef STATUS_ENABLED
  26 #define STATUS(A) GST_DEBUG(0,A, gst_element_get_name(GST_ELEMENT(queue)))
  27 #else
  28 #define STATUS(A)
  29 #endif
  30
  31 #include <pthread.h>
  32
  33 #include "config.h"
  34 #include "gst_private.h"
  35
  36 #include "gstqueue.h"
  37
  38 GstElementDetails gst_queue_details = {
  39   "Queue",
  40   "Connection",
  41   "Simple data queue",
  42   VERSION,
  43   "Erik Walthinsen <omega@cse.ogi.edu>",
  44   "(C) 1999",
  45 };
  46
  47
  48 /* Queue signals and args */
  49 enum {
  50   /* FILL ME */
  51   LAST_SIGNAL
  52 };
  53
  54 enum {
  55   ARG_0,
  56   ARG_LEVEL,
  57   ARG_MAX_LEVEL,
  58   ARG_BLOCK,
  59 };
  60
  61
  62 static void                     gst_queue_class_init    (GstQueueClass *klass);
  63 static void                     gst_queue_init          (GstQueue *queue);
  64
  65 static void                     gst_queue_set_arg       (GtkObject *object, GtkArg *arg, guint id);
  66 static void                     gst_queue_get_arg       (GtkObject *object, GtkArg *arg, guint id);
  67
  68 static gboolean                 gst_queue_handle_eos    (GstPad *pad);
  69 static GstCaps*                 gst_queue_handle_negotiate_src (GstPad *pad, GstCaps *caps, gint count);
  70 static GstCaps*                 gst_queue_handle_negotiate_sink (GstPad *pad, GstCaps *caps, gint count);
  71 static void                     gst_queue_chain         (GstPad *pad, GstBuffer *buf);
  72 static GstBuffer *              gst_queue_get           (GstPad *pad);
  73
  74 static void                     gst_queue_flush         (GstQueue *queue);
  75
  76 static GstElementStateReturn    gst_queue_change_state  (GstElement *element);
  77
  78
  79 static GstElementClass *parent_class = NULL;
  80 //static guint gst_queue_signals[LAST_SIGNAL] = { 0 };
  81
  82 GtkType
  83 gst_queue_get_type(void) {
  84   static GtkType queue_type = 0;
  85
  86   if (!queue_type) {
  87     static const GtkTypeInfo queue_info = {
  88       "GstQueue",
  89       sizeof(GstQueue),
  90       sizeof(GstQueueClass),
  91       (GtkClassInitFunc)gst_queue_class_init,
  92       (GtkObjectInitFunc)gst_queue_init,
  93       (GtkArgSetFunc)gst_queue_set_arg,
  94       (GtkArgGetFunc)gst_queue_get_arg,
  95       (GtkClassInitFunc)NULL,
  96     };
  97     queue_type = gtk_type_unique (GST_TYPE_ELEMENT, &queue_info);
  98   }
  99   return queue_type;
 100 }
 101
 102 static void
 103 gst_queue_class_init (GstQueueClass *klass)
 104 {
 105   GtkObjectClass *gtkobject_class;
 106   GstElementClass *gstelement_class;
 107
 108   gtkobject_class = (GtkObjectClass*)klass;
 109   gstelement_class = (GstElementClass*)klass;
 110
 111   parent_class = gtk_type_class (GST_TYPE_ELEMENT);
 112
 113   gtk_object_add_arg_type ("GstQueue::level", GTK_TYPE_INT,
 114                            GTK_ARG_READABLE, ARG_LEVEL);
 115   gtk_object_add_arg_type ("GstQueue::max_level", GTK_TYPE_INT,
 116                            GTK_ARG_READWRITE, ARG_MAX_LEVEL);
 117   gtk_object_add_arg_type ("GstQueue::block", GTK_TYPE_BOOL,
 118                            GTK_ARG_READWRITE, ARG_BLOCK);
 119
 120   gtkobject_class->set_arg = gst_queue_set_arg;
 121   gtkobject_class->get_arg = gst_queue_get_arg;
 122
 123   gstelement_class->change_state = gst_queue_change_state;
 124 }
 125
 126 static void
 127 gst_queue_init (GstQueue *queue)
 128 {
 129   // scheduling on this kind of element is, well, interesting
 130   GST_FLAG_SET (queue, GST_ELEMENT_DECOUPLED);
 131
 132   queue->sinkpad = gst_pad_new ("sink", GST_PAD_SINK);
 133   gst_pad_set_chain_function (queue->sinkpad, GST_DEBUG_FUNCPTR(gst_queue_chain));
 134   gst_element_add_pad (GST_ELEMENT (queue), queue->sinkpad);
 135   gst_pad_set_eos_function (queue->sinkpad, gst_queue_handle_eos);
 136   gst_pad_set_negotiate_function (queue->sinkpad, gst_queue_handle_negotiate_sink);
 137
 138   queue->srcpad = gst_pad_new ("src", GST_PAD_SRC);
 139   gst_pad_set_get_function (queue->srcpad, GST_DEBUG_FUNCPTR(gst_queue_get));
 140   gst_element_add_pad (GST_ELEMENT (queue), queue->srcpad);
 141   gst_pad_set_negotiate_function (queue->srcpad, gst_queue_handle_negotiate_src);
 142
 143   queue->queue = NULL;
 144   queue->level_buffers = 0;
 145   queue->max_buffers = 100;
 146   queue->block = TRUE;
 147   queue->level_bytes = 0;
 148   queue->size_buffers = 0;
 149   queue->size_bytes = 0;
 150
 151   queue->emptycond = g_cond_new ();
 152   queue->fullcond = g_cond_new ();
 153 }
 154
 155 static GstCaps*
 156 gst_queue_handle_negotiate_src (GstPad *pad, GstCaps *caps, gint count)
 157 {
 158   GstQueue *queue;
 159
 160   queue = GST_QUEUE (GST_OBJECT_PARENT (pad));
 161
 162   return gst_pad_negotiate_proxy (queue->sinkpad, caps, count);
 163 }
 164
 165 static GstCaps*
 166 gst_queue_handle_negotiate_sink (GstPad *pad, GstCaps *caps, gint count)
 167 {
 168   GstQueue *queue;
 169
 170   queue = GST_QUEUE (GST_OBJECT_PARENT (pad));
 171
 172   return gst_pad_negotiate_proxy (queue->srcpad, caps, count);
 173 }
 174
 175 static gboolean
 176 gst_queue_handle_eos (GstPad *pad)
 177 {
 178   GstQueue *queue;
 179
 180   queue = GST_QUEUE (GST_OBJECT_PARENT (pad));
 181
 182   GST_DEBUG (0,"queue: %s received eos\n", GST_ELEMENT_NAME (queue));
 183
 184   GST_LOCK (queue);
 185   GST_DEBUG (0,"queue: %s has %d buffers left\n", GST_ELEMENT_NAME (queue),
 186                   queue->level_buffers);
 187
 188   GST_FLAG_SET (pad, GST_PAD_EOS);
 189
 190   g_cond_signal (queue->emptycond);
 191
 192   GST_UNLOCK (queue);
 193
 194   return TRUE;
 195 }
 196
 197 static void
 198 gst_queue_cleanup_buffers (gpointer data, const gpointer user_data)
 199 {
 200   GST_DEBUG (0,"queue: %s cleaning buffer %p\n", (gchar *)user_data, data);
 201
 202   gst_buffer_unref (GST_BUFFER (data));
 203 }
 204
 205 static void
 206 gst_queue_flush (GstQueue *queue)
 207 {
 208   g_slist_foreach (queue->queue, gst_queue_cleanup_buffers,
 209                   (char *) GST_ELEMENT_NAME (queue));
 210   g_slist_free (queue->queue);
 211
 212   queue->queue = NULL;
 213   queue->level_buffers = 0;
 214   queue->timeval = NULL;
 215 }
 216
 217 static void
 218 gst_queue_chain (GstPad *pad, GstBuffer *buf)
 219 {
 220   GstQueue *queue;
 221   gboolean tosignal = FALSE;
 222   const guchar *name;
 223
 224   g_return_if_fail (pad != NULL);
 225   g_return_if_fail (GST_IS_PAD (pad));
 226   g_return_if_fail (buf != NULL);
 227
 228   queue = GST_QUEUE (GST_OBJECT_PARENT (pad));
 229   name = GST_ELEMENT_NAME (queue);
 230
 231   /* we have to lock the queue since we span threads */
 232
 233   GST_DEBUG (0,"queue: try have queue lock\n");
 234   GST_LOCK (queue);
 235   GST_DEBUG (0,"queue: %s adding buffer %p %ld\n", name, buf, pthread_self ());
 236   GST_DEBUG (0,"queue: have queue lock\n");
 237
 238   if (GST_BUFFER_FLAG_IS_SET (buf, GST_BUFFER_FLUSH)) {
 239     gst_queue_flush (queue);
 240   }
 241
 242   GST_DEBUG (0,"queue: %s: chain %d %p\n", name, queue->level_buffers, buf);
 243
 244   while (queue->level_buffers >= queue->max_buffers) {
 245     GST_DEBUG (0,"queue: %s waiting %d\n", name, queue->level_buffers);
 246     STATUS("%s: O\n");
 247     //g_cond_timed_wait (queue->fullcond, queue->fulllock, queue->timeval);
 248     //FIXME need to signal other thread in case signals got lost?
 249     g_cond_signal (queue->emptycond);
 250     g_cond_wait (queue->fullcond, GST_OBJECT(queue)->lock);
 251     STATUS("%s: O+\n");
 252     GST_DEBUG (0,"queue: %s waiting done %d\n", name, queue->level_buffers);
 253   }
 254
 255   /* put the buffer on the tail of the list */
 256   queue->queue = g_slist_append (queue->queue, buf);
 257 //  STATUS("%s: +\n");
 258   GST_DEBUG (0,"(%s:%s)+ ",GST_DEBUG_PAD_NAME(pad));
 259
 260   /* if we were empty, but aren't any more, signal a condition */
 261   tosignal = (queue->level_buffers >= 0);
 262   queue->level_buffers++;
 263
 264   /* we can unlock now */
 265   GST_DEBUG (0,"queue: %s chain %d end signal(%d,%p)\n", name, queue->level_buffers, tosignal, queue->emptycond);
 266
 267   if (tosignal) {
 268 //    STATUS("%s: >\n");
 269     g_cond_signal (queue->emptycond);
 270 //    STATUS("%s: >>\n");
 271   }
 272   GST_UNLOCK (queue);
 273 }
 274
 275 static GstBuffer *
 276 gst_queue_get (GstPad *pad)
 277 {
 278   GstQueue *queue;
 279   GstBuffer *buf = NULL;
 280   GSList *front;
 281   const guchar *name;
 282
 283   g_return_val_if_fail (pad != NULL, NULL);
 284   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
 285
 286   queue = GST_QUEUE (GST_OBJECT_PARENT (pad));
 287   name = GST_ELEMENT_NAME (queue);
 288
 289   /* have to lock for thread-safety */
 290   GST_DEBUG (0,"queue: %s try have queue lock\n", name);
 291   GST_LOCK (queue);
 292   GST_DEBUG (0,"queue: %s push %d %ld %p\n", name, queue->level_buffers, pthread_self (), queue->emptycond);
 293   GST_DEBUG (0,"queue: %s have queue lock\n", name);
 294
 295   // we bail if there's nothing there
 296   if (!queue->level_buffers && !queue->block) {
 297     GST_UNLOCK(queue);
 298     return NULL;
 299   }
 300
 301   while (!queue->level_buffers) {
 302     STATUS("queue: %s U released lock\n");
 303     //g_cond_timed_wait (queue->emptycond, queue->emptylock, queue->timeval);
 304     if (GST_FLAG_IS_SET (queue->sinkpad, GST_PAD_EOS)) {
 305       gst_pad_set_eos (queue->srcpad);
 306       return NULL;
 307     }
 308     //FIXME need to signal other thread in case signals got lost?
 309     g_cond_signal (queue->fullcond);
 310     g_cond_wait (queue->emptycond, GST_OBJECT(queue)->lock);
 311 //    STATUS("queue: %s U- getting lock\n");
 312   }
 313
 314   front = queue->queue;
 315   buf = (GstBuffer *)(front->data);
 316   GST_DEBUG (0,"retrieved buffer %p from queue\n",buf);
 317   queue->queue = g_slist_remove_link (queue->queue, front);
 318   g_slist_free (front);
 319
 320   queue->level_buffers--;
 321 //  STATUS("%s: -\n");
 322   GST_DEBUG (0,"(%s:%s)- ",GST_DEBUG_PAD_NAME(pad));
 323
 324   if (queue->level_buffers < queue->max_buffers) {
 325 //    STATUS("%s: < \n");
 326     g_cond_signal (queue->fullcond);
 327 //    STATUS("%s: << \n");
 328   }
 329   GST_UNLOCK(queue);
 330
 331 //  GST_DEBUG (0,"queue: %s pushing %d %p \n", name, queue->level_buffers, buf);
 332 //  gst_pad_push (queue->srcpad, buf);
 333 //  GST_DEBUG (0,"queue: %s pushing %d done \n", name, queue->level_buffers);
 334
 335   return buf;
 336   /* unlock now */
 337 }
 338
 339 static GstElementStateReturn
 340 gst_queue_change_state (GstElement *element)
 341 {
 342   GstQueue *queue;
 343   g_return_val_if_fail (GST_IS_QUEUE (element), GST_STATE_FAILURE);
 344
 345   queue = GST_QUEUE (element);
 346   GST_DEBUG (0,"gstqueue: state pending %d\n", GST_STATE_PENDING (element));
 347
 348   /* if going down into NULL state, clear out buffers*/
 349   if (GST_STATE_PENDING (element) == GST_STATE_READY) {
 350     /* otherwise (READY or higher) we need to open the file */
 351     gst_queue_flush (queue);
 352   }
 353
 354   /* if we haven't failed already, give the parent class a chance to ;-) */
 355   if (GST_ELEMENT_CLASS (parent_class)->change_state)
 356     return GST_ELEMENT_CLASS (parent_class)->change_state (element);
 357
 358   return GST_STATE_SUCCESS;
 359 }
 360
 361
 362 static void
 363 gst_queue_set_arg (GtkObject *object, GtkArg *arg, guint id)
 364 {
 365   GstQueue *queue;
 366
 367   /* it's not null if we got it, but it might not be ours */
 368   g_return_if_fail (GST_IS_QUEUE (object));
 369
 370   queue = GST_QUEUE (object);
 371
 372   switch(id) {
 373     case ARG_MAX_LEVEL:
 374       queue->max_buffers = GTK_VALUE_INT (*arg);
 375       break;
 376     case ARG_BLOCK:
 377       queue->block = GTK_VALUE_BOOL (*arg);
 378       break;
 379     default:
 380       break;
 381   }
 382 }
 383
 384 static void
 385 gst_queue_get_arg (GtkObject *object, GtkArg *arg, guint id)
 386 {
 387   GstQueue *queue;
 388
 389   /* it's not null if we got it, but it might not be ours */
 390   g_return_if_fail (GST_IS_QUEUE (object));
 391
 392   queue = GST_QUEUE (object);
 393
 394   switch (id) {
 395     case ARG_LEVEL:
 396       GTK_VALUE_INT (*arg) = queue->level_buffers;
 397       break;
 398     case ARG_MAX_LEVEL:
 399       GTK_VALUE_INT (*arg) = queue->max_buffers;
 400       break;
 401     case ARG_BLOCK:
 402       GTK_VALUE_BOOL (*arg) = queue->block;
 403       break;
 404     default:
 405       arg->type = GTK_TYPE_INVALID;
 406       break;
 407   }
 408 }