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   ARG_TIMEOUT,
  60 };
  61
  62
  63 static void                     gst_queue_class_init    (GstQueueClass *klass);
  64 static void                     gst_queue_init          (GstQueue *queue);
  65
  66 static void                     gst_queue_set_arg       (GtkObject *object, GtkArg *arg, guint id);
  67 static void                     gst_queue_get_arg       (GtkObject *object, GtkArg *arg, guint id);
  68
  69 static gboolean                 gst_queue_handle_eos    (GstPad *pad);
  70 static void                     gst_queue_chain         (GstPad *pad, GstBuffer *buf);
  71 static GstBuffer *              gst_queue_get           (GstPad *pad);
  72
  73 static void                     gst_queue_flush         (GstQueue *queue);
  74
  75 static GstElementStateReturn    gst_queue_change_state  (GstElement *element);
  76
  77
  78 static GstElementClass *parent_class = NULL;
  79 //static guint gst_queue_signals[LAST_SIGNAL] = { 0 };
  80
  81 GtkType
  82 gst_queue_get_type(void) {
  83   static GtkType queue_type = 0;
  84
  85   if (!queue_type) {
  86     static const GtkTypeInfo queue_info = {
  87       "GstQueue",
  88       sizeof(GstQueue),
  89       sizeof(GstQueueClass),
  90       (GtkClassInitFunc)gst_queue_class_init,
  91       (GtkObjectInitFunc)gst_queue_init,
  92       (GtkArgSetFunc)gst_queue_set_arg,
  93       (GtkArgGetFunc)gst_queue_get_arg,
  94       (GtkClassInitFunc)NULL,
  95     };
  96     queue_type = gtk_type_unique (GST_TYPE_ELEMENT, &queue_info);
  97   }
  98   return queue_type;
  99 }
 100
 101 static void
 102 gst_queue_class_init (GstQueueClass *klass)
 103 {
 104   GtkObjectClass *gtkobject_class;
 105   GstElementClass *gstelement_class;
 106
 107   gtkobject_class = (GtkObjectClass*)klass;
 108   gstelement_class = (GstElementClass*)klass;
 109
 110   parent_class = gtk_type_class (GST_TYPE_ELEMENT);
 111
 112   gtk_object_add_arg_type ("GstQueue::level", GTK_TYPE_INT,
 113                            GTK_ARG_READABLE, ARG_LEVEL);
 114   gtk_object_add_arg_type ("GstQueue::max_level", GTK_TYPE_INT,
 115                            GTK_ARG_READWRITE, ARG_MAX_LEVEL);
 116   gtk_object_add_arg_type ("GstQueue::block", GTK_TYPE_BOOL,
 117                            GTK_ARG_READWRITE, ARG_BLOCK);
 118   gtk_object_add_arg_type ("GstQueue::timeout", GTK_TYPE_INT,
 119                            GTK_ARG_READWRITE, ARG_TIMEOUT);
 120
 121   gtkobject_class->set_arg = gst_queue_set_arg;
 122   gtkobject_class->get_arg = gst_queue_get_arg;
 123
 124   gstelement_class->change_state = gst_queue_change_state;
 125 }
 126
 127 static void
 128 gst_queue_init (GstQueue *queue)
 129 {
 130   // scheduling on this kind of element is, well, interesting
 131   GST_FLAG_SET (queue, GST_ELEMENT_DECOUPLED);
 132
 133   queue->sinkpad = gst_pad_new ("sink", GST_PAD_SINK);
 134   gst_pad_set_chain_function (queue->sinkpad, GST_DEBUG_FUNCPTR(gst_queue_chain));
 135   gst_element_add_pad (GST_ELEMENT (queue), queue->sinkpad);
 136   gst_pad_set_eos_function (queue->sinkpad, gst_queue_handle_eos);
 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
 142   queue->queue = NULL;
 143   queue->level_buffers = 0;
 144   queue->max_buffers = 100;
 145   queue->block = TRUE;
 146   queue->level_bytes = 0;
 147   queue->size_buffers = 0;
 148   queue->size_bytes = 0;
 149
 150   queue->emptycond = g_cond_new ();
 151   queue->fullcond = g_cond_new ();
 152 }
 153
 154 static gboolean
 155 gst_queue_handle_eos (GstPad *pad)
 156 {
 157   GstQueue *queue;
 158
 159   queue = GST_QUEUE(pad->parent);
 160
 161   GST_DEBUG (0,"queue: %s received eos\n", gst_element_get_name (GST_ELEMENT (queue)));
 162
 163   GST_LOCK (queue);
 164   GST_DEBUG (0,"queue: %s has %d buffers left\n", gst_element_get_name (GST_ELEMENT (queue)),
 165                   queue->level_buffers);
 166
 167   GST_FLAG_SET (pad, GST_PAD_EOS);
 168
 169   g_cond_signal (queue->emptycond);
 170
 171   GST_UNLOCK (queue);
 172
 173   return TRUE;
 174 }
 175
 176 static void
 177 gst_queue_cleanup_buffers (gpointer data, const gpointer user_data)
 178 {
 179   GST_DEBUG (0,"queue: %s cleaning buffer %p\n", (gchar *)user_data, data);
 180
 181   gst_buffer_unref (GST_BUFFER (data));
 182 }
 183
 184 static void
 185 gst_queue_flush (GstQueue *queue)
 186 {
 187   g_slist_foreach (queue->queue, gst_queue_cleanup_buffers,
 188                   (char *)gst_element_get_name (GST_ELEMENT (queue)));
 189   g_slist_free (queue->queue);
 190
 191   queue->queue = NULL;
 192   queue->level_buffers = 0;
 193   queue->timeval = NULL;
 194 }
 195
 196 static void
 197 gst_queue_chain (GstPad *pad, GstBuffer *buf)
 198 {
 199   GstQueue *queue;
 200   gboolean tosignal = FALSE;
 201   const guchar *name;
 202
 203   g_return_if_fail (pad != NULL);
 204   g_return_if_fail (GST_IS_PAD (pad));
 205   g_return_if_fail (buf != NULL);
 206
 207   queue = GST_QUEUE (pad->parent);
 208   name = gst_element_get_name (GST_ELEMENT (queue));
 209
 210   /* we have to lock the queue since we span threads */
 211
 212   GST_DEBUG (0,"queue: try have queue lock\n");
 213   GST_LOCK (queue);
 214   GST_DEBUG (0,"queue: %s adding buffer %p %ld\n", name, buf, pthread_self ());
 215   GST_DEBUG (0,"queue: have queue lock\n");
 216
 217   if (GST_BUFFER_FLAG_IS_SET (buf, GST_BUFFER_FLUSH)) {
 218     gst_queue_flush (queue);
 219   }
 220
 221   GST_DEBUG (0,"queue: %s: chain %d %p\n", name, queue->level_buffers, buf);
 222
 223   while (queue->level_buffers >= queue->max_buffers) {
 224     GST_DEBUG (0,"queue: %s waiting %d\n", name, queue->level_buffers);
 225     STATUS("%s: O\n");
 226     //g_cond_timed_wait (queue->fullcond, queue->fulllock, queue->timeval);
 227     //FIXME need to signal other thread in case signals got lost?
 228     g_cond_signal (queue->emptycond);
 229     g_cond_wait (queue->fullcond, GST_OBJECT(queue)->lock);
 230     STATUS("%s: O+\n");
 231     GST_DEBUG (0,"queue: %s waiting done %d\n", name, queue->level_buffers);
 232   }
 233
 234   /* put the buffer on the tail of the list */
 235   queue->queue = g_slist_append (queue->queue, buf);
 236 //  STATUS("%s: +\n");
 237   GST_DEBUG (0,"(%s:%s)+ ",GST_DEBUG_PAD_NAME(pad));
 238
 239   /* if we were empty, but aren't any more, signal a condition */
 240   tosignal = (queue->level_buffers >= 0);
 241   queue->level_buffers++;
 242
 243   /* we can unlock now */
 244   GST_DEBUG (0,"queue: %s chain %d end signal(%d,%p)\n", name, queue->level_buffers, tosignal, queue->emptycond);
 245
 246   if (tosignal) {
 247 //    STATUS("%s: >\n");
 248     g_cond_signal (queue->emptycond);
 249 //    STATUS("%s: >>\n");
 250   }
 251   GST_UNLOCK (queue);
 252 }
 253
 254 static GstBuffer *
 255 gst_queue_get (GstPad *pad)
 256 {
 257   GstQueue *queue = GST_QUEUE (gst_pad_get_parent(pad));
 258   GstBuffer *buf = NULL;
 259   GSList *front;
 260   const guchar *name;
 261
 262   name = gst_element_get_name (GST_ELEMENT (queue));
 263
 264   /* have to lock for thread-safety */
 265   GST_DEBUG (0,"queue: %s try have queue lock\n", name);
 266   GST_LOCK (queue);
 267   GST_DEBUG (0,"queue: %s push %d %ld %p\n", name, queue->level_buffers, pthread_self (), queue->emptycond);
 268   GST_DEBUG (0,"queue: %s have queue lock\n", name);
 269
 270   // we bail if there's nothing there
 271   if (!queue->level_buffers && !queue->block) {
 272     GST_UNLOCK(queue);
 273     return NULL;
 274   }
 275
 276   while (!queue->level_buffers) {
 277     STATUS("queue: %s U released lock\n");
 278     //g_cond_timed_wait (queue->emptycond, queue->emptylock, queue->timeval);
 279     if (GST_FLAG_IS_SET (queue->sinkpad, GST_PAD_EOS)) {
 280       gst_pad_set_eos (queue->srcpad);
 281       return NULL;
 282     }
 283     //FIXME need to signal other thread in case signals got lost?
 284     g_cond_signal (queue->fullcond);
 285     g_cond_wait (queue->emptycond, GST_OBJECT(queue)->lock);
 286 //    STATUS("queue: %s U- getting lock\n");
 287   }
 288
 289   front = queue->queue;
 290   buf = (GstBuffer *)(front->data);
 291   GST_DEBUG (0,"retrieved buffer %p from queue\n",buf);
 292   queue->queue = g_slist_remove_link (queue->queue, front);
 293   g_slist_free (front);
 294
 295   queue->level_buffers--;
 296 //  STATUS("%s: -\n");
 297   GST_DEBUG (0,"(%s:%s)- ",GST_DEBUG_PAD_NAME(pad));
 298
 299   if (queue->level_buffers < queue->max_buffers) {
 300 //    STATUS("%s: < \n");
 301     g_cond_signal (queue->fullcond);
 302 //    STATUS("%s: << \n");
 303   }
 304   GST_UNLOCK(queue);
 305
 306 //  GST_DEBUG (0,"queue: %s pushing %d %p \n", name, queue->level_buffers, buf);
 307 //  gst_pad_push (queue->srcpad, buf);
 308 //  GST_DEBUG (0,"queue: %s pushing %d done \n", name, queue->level_buffers);
 309
 310   return buf;
 311   /* unlock now */
 312 }
 313
 314 static GstElementStateReturn
 315 gst_queue_change_state (GstElement *element)
 316 {
 317   GstQueue *queue;
 318   g_return_val_if_fail (GST_IS_QUEUE (element), GST_STATE_FAILURE);
 319
 320   queue = GST_QUEUE (element);
 321   GST_DEBUG (0,"gstqueue: state pending %d\n", GST_STATE_PENDING (element));
 322
 323   /* if going down into NULL state, clear out buffers*/
 324   if (GST_STATE_PENDING (element) == GST_STATE_READY) {
 325     /* otherwise (READY or higher) we need to open the file */
 326     gst_queue_flush (queue);
 327   }
 328
 329   /* if we haven't failed already, give the parent class a chance to ;-) */
 330   if (GST_ELEMENT_CLASS (parent_class)->change_state)
 331     return GST_ELEMENT_CLASS (parent_class)->change_state (element);
 332
 333   return GST_STATE_SUCCESS;
 334 }
 335
 336
 337 static void
 338 gst_queue_set_arg (GtkObject *object, GtkArg *arg, guint id)
 339 {
 340   GstQueue *queue;
 341
 342   /* it's not null if we got it, but it might not be ours */
 343   g_return_if_fail (GST_IS_QUEUE (object));
 344
 345   queue = GST_QUEUE (object);
 346
 347   switch(id) {
 348     case ARG_MAX_LEVEL:
 349       queue->max_buffers = GTK_VALUE_INT (*arg);
 350       break;
 351     case ARG_BLOCK:
 352       queue->block = GTK_VALUE_BOOL (*arg);
 353       break;
 354     case ARG_TIMEOUT:
 355       break;
 356     default:
 357       break;
 358   }
 359 }
 360
 361 static void
 362 gst_queue_get_arg (GtkObject *object, GtkArg *arg, guint id)
 363 {
 364   GstQueue *queue;
 365
 366   /* it's not null if we got it, but it might not be ours */
 367   g_return_if_fail (GST_IS_QUEUE (object));
 368
 369   queue = GST_QUEUE (object);
 370
 371   switch (id) {
 372     case ARG_LEVEL:
 373       GTK_VALUE_INT (*arg) = queue->level_buffers;
 374       break;
 375     case ARG_MAX_LEVEL:
 376       GTK_VALUE_INT (*arg) = queue->max_buffers;
 377       break;
 378     case ARG_BLOCK:
 379       GTK_VALUE_BOOL (*arg) = queue->block;
 380       break;
 381     case ARG_TIMEOUT:
 382       break;
 383     default:
 384       arg->type = GTK_TYPE_INVALID;
 385       break;
 386   }
 387 }