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 G_BEGIN_DECLS
  31
  32 #define GST_TYPE_QUEUE \
  33   (gst_queue_get_type())
  34 #define GST_QUEUE(obj) \
  35   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_QUEUE,GstQueue))
  36 #define GST_QUEUE_CLASS(klass) \
  37   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_QUEUE,GstQueueClass))
  38 #define GST_IS_QUEUE(obj) \
  39   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_QUEUE))
  40 #define GST_IS_QUEUE_CLASS(obj) \
  41   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_QUEUE))
  42
  43 enum {
  44   GST_QUEUE_NO_LEAK             = 0,
  45   GST_QUEUE_LEAK_UPSTREAM       = 1,
  46   GST_QUEUE_LEAK_DOWNSTREAM     = 2
  47 };
  48
  49 typedef struct _GstQueue GstQueue;
  50 typedef struct _GstQueueSize GstQueueSize;
  51 typedef struct _GstQueueClass GstQueueClass;
  52
  53 /**
  54  * GstQueueSize:
  55  * @buffers: number of buffers
  56  * @bytes: number of bytes
  57  * @time: amount of time
  58  *
  59  * Structure describing the size of a queue.
  60  */
  61 struct _GstQueueSize {
  62     guint   buffers;
  63     guint   bytes;
  64     guint64 time;
  65 };
  66
  67 /**
  68  * GstQueue:
  69  *
  70  * Opaque #GstQueue structure.
  71  */
  72 struct _GstQueue {
  73   GstElement element;
  74
  75   /*< private >*/
  76   GstPad *sinkpad;
  77   GstPad *srcpad;
  78
  79   /* flowreturn when srcpad is paused */
  80   GstFlowReturn srcresult;
  81
  82   /* the queue of data we're keeping our grubby hands on */
  83   GQueue *queue;
  84
  85   GstQueueSize
  86     cur_level,          /* currently in the queue */
  87     max_size,           /* max. amount of data allowed in the queue */
  88     min_threshold;      /* min. amount of data required to wake reader */
  89
  90   /* whether we leak data, and at which end */
  91   gint leaky;
  92
  93   GMutex *qlock;        /* lock for queue (vs object lock) */
  94   GCond *item_add;      /* signals buffers now available for reading */
  95   GCond *item_del;      /* signals space now available for writing */
  96
  97   gpointer _gst_reserved[GST_PADDING];
  98 };
  99
 100 struct _GstQueueClass {
 101   GstElementClass parent_class;
 102
 103   /* signals - 'running' is called from both sides
 104    * which might make it sort of non-useful... */
 105   void (*underrun)      (GstQueue *queue);
 106   void (*running)       (GstQueue *queue);
 107   void (*overrun)       (GstQueue *queue);
 108
 109   gpointer _gst_reserved[GST_PADDING];
 110 };
 111
 112 GType gst_queue_get_type (void);
 113
 114 G_END_DECLS
 115
 116
 117 #endif /* __GST_QUEUE_H__ */