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 #include <gst/gst.h>
  28
  29 G_BEGIN_DECLS
  30
  31 #define GST_TYPE_QUEUE \
  32   (gst_queue_get_type())
  33 #define GST_QUEUE(obj) \
  34   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_QUEUE,GstQueue))
  35 #define GST_QUEUE_CLASS(klass) \
  36   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_QUEUE,GstQueueClass))
  37 #define GST_IS_QUEUE(obj) \
  38   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_QUEUE))
  39 #define GST_IS_QUEUE_CLASS(klass) \
  40   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_QUEUE))
  41 #define GST_QUEUE_CAST(obj) \
  42   ((GstQueue *)(obj))
  43
  44 typedef struct _GstQueue GstQueue;
  45 typedef struct _GstQueueSize GstQueueSize;
  46 typedef enum _GstQueueLeaky GstQueueLeaky;
  47 typedef struct _GstQueueClass GstQueueClass;
  48
  49 /**
  50  * GstQueueLeaky:
  51  * @GST_QUEUE_NO_LEAK: Not Leaky
  52  * @GST_QUEUE_LEAK_UPSTREAM: Leaky on upstream (new buffers)
  53  * @GST_QUEUE_LEAK_DOWNSTREAM: Leaky on downstream (old buffers)
  54  *
  55  * Buffer dropping scheme to avoid the queue to block when full.
  56  */
  57 enum _GstQueueLeaky {
  58   GST_QUEUE_NO_LEAK             = 0,
  59   GST_QUEUE_LEAK_UPSTREAM       = 1,
  60   GST_QUEUE_LEAK_DOWNSTREAM     = 2
  61 };
  62
  63 /*
  64  * GstQueueSize:
  65  * @buffers: number of buffers
  66  * @bytes: number of bytes
  67  * @time: amount of time
  68  *
  69  * Structure describing the size of a queue.
  70  */
  71 struct _GstQueueSize {
  72     guint   buffers;
  73     guint   bytes;
  74     guint64 time;
  75 };
  76
  77 #define GST_QUEUE_CLEAR_LEVEL(l) G_STMT_START {         \
  78   l.buffers = 0;                                        \
  79   l.bytes = 0;                                          \
  80   l.time = 0;                                           \
  81 } G_STMT_END
  82
  83 /**
  84  * GstQueue:
  85  *
  86  * Opaque #GstQueue structure.
  87  */
  88 struct _GstQueue {
  89   GstElement element;
  90
  91   /*< private >*/
  92   GstPad *sinkpad;
  93   GstPad *srcpad;
  94
  95   /* segments to keep track of timestamps */
  96   GstSegment sink_segment;
  97   GstSegment src_segment;
  98
  99   /* position of src/sink */
 100   GstClockTime sinktime, srctime;
 101   /* TRUE if either position needs to be recalculated */
 102   gboolean sink_tainted, src_tainted;
 103
 104   /* flowreturn when srcpad is paused */
 105   GstFlowReturn srcresult;
 106   gboolean      unexpected;
 107   gboolean      eos;
 108
 109   /* the queue of data we're keeping our grubby hands on */
 110   GQueue queue;
 111
 112   GstQueueSize
 113     cur_level,          /* currently in the queue */
 114     max_size,           /* max. amount of data allowed in the queue */
 115     min_threshold,      /* min. amount of data required to wake reader */
 116     orig_min_threshold; /* Original min.threshold, for reset in EOS */
 117
 118   /* whether we leak data, and at which end */
 119   gint leaky;
 120
 121   GMutex qlock;        /* lock for queue (vs object lock) */
 122   gboolean waiting_add;
 123   GCond item_add;      /* signals buffers now available for reading */
 124   gboolean waiting_del;
 125   GCond item_del;      /* signals space now available for writing */
 126
 127   gboolean head_needs_discont, tail_needs_discont;
 128   gboolean push_newsegment;
 129
 130   gboolean silent;      /* don't emit signals */
 131
 132   /* whether the first new segment has been applied to src */
 133   gboolean newseg_applied_to_src;
 134 };
 135
 136 struct _GstQueueClass {
 137   GstElementClass parent_class;
 138
 139   /* signals - 'running' is called from both sides
 140    * which might make it sort of non-useful... */
 141   void (*underrun)      (GstQueue *queue);
 142   void (*running)       (GstQueue *queue);
 143   void (*overrun)       (GstQueue *queue);
 144
 145   void (*pushing)       (GstQueue *queue);
 146 };
 147
 148 GType gst_queue_get_type (void);
 149
 150 G_END_DECLS
 151
 152
 153 #endif /* __GST_QUEUE_H__ */