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