plugins/elements/gstqueue.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *
   5  * gstqueue.h:
   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
  24 #ifndef __GST_QUEUE_H__
  25 #define __GST_QUEUE_H__
  26
  27
  28 #include <gst/gstelement.h>
  29
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif /* __cplusplus */
  34
  35
  36 extern GstElementDetails gst_queue_details;
  37
  38
  39 #define GST_TYPE_QUEUE \
  40   (gst_queue_get_type())
  41 #define GST_QUEUE(obj) \
  42   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_QUEUE,GstQueue))
  43 #define GST_QUEUE_CLASS(klass) \
  44   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_QUEUE,GstQueueClass))
  45 #define GST_IS_QUEUE(obj) \
  46   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_QUEUE))
  47 #define GST_IS_QUEUE_CLASS(obj) \
  48   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_QUEUE))
  49
  50 enum {
  51   GST_QUEUE_NO_LEAK             = 0,
  52   GST_QUEUE_LEAK_UPSTREAM       = 1,
  53   GST_QUEUE_LEAK_DOWNSTREAM     = 2
  54 };
  55
  56 typedef struct _GstQueue GstQueue;
  57 typedef struct _GstQueueClass GstQueueClass;
  58
  59 struct _GstQueue {
  60   GstElement element;
  61
  62   GstPad *sinkpad;
  63   GstPad *srcpad;
  64
  65   /* the queue of buffers we're keeping our grubby hands on */
  66   GList *queue;
  67
  68   guint level_buffers;  /* number of buffers queued here */
  69   guint level_bytes;    /* number of bytes queued here */
  70   guint64 level_time;   /* amount of time queued here */
  71
  72   guint size_buffers;   /* size of queue in buffers */
  73   guint size_bytes;     /* size of queue in bytes */
  74   guint64 size_time;    /* size of queue in time */
  75
  76   gint leaky;           /* whether the queue is leaky, and if so at which end */
  77   gint block_timeout;   /* microseconds until a blocked queue times out and returns GST_EVENT_FILLER.
  78                          * A value of -1 will block forever. */
  79   gboolean may_deadlock; /* it the queue should fail on possible deadlocks */
  80   gboolean interrupt;
  81
  82   GMutex *qlock;        /* lock for queue (vs object lock) */
  83   /* we are single reader and single writer queue */
  84   gboolean reader;      /* reader waiting on empty queue */
  85   gboolean writer;      /* writer waiting on full queue */
  86   GCond *not_empty;     /* signals buffers now available for reading */
  87   GCond *not_full;      /* signals space now available for writing */
  88
  89   GTimeVal *timeval;    /* the timeout for the queue locking */
  90   GAsyncQueue *events;  /* upstream events get decoupled here */
  91 };
  92
  93 struct _GstQueueClass {
  94   GstElementClass parent_class;
  95
  96   /* signal callbacks */
  97   void (*low_watermark)         (GstQueue *queue, gint level);
  98   void (*high_watermark)        (GstQueue *queue, gint level);
  99 };
 100
 101 GType gst_queue_get_type (void);
 102
 103 #ifdef __cplusplus
 104 }
 105 #endif /* __cplusplus */
 106
 107
 108 #endif /* __GST_QUEUE_H__ */