2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
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.
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.
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.
24 #ifndef __GST_QUEUE_H__
25 #define __GST_QUEUE_H__
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))
43 GST_QUEUE_NO_LEAK = 0,
44 GST_QUEUE_LEAK_UPSTREAM = 1,
45 GST_QUEUE_LEAK_DOWNSTREAM = 2
48 typedef struct _GstQueue GstQueue;
49 typedef struct _GstQueueSize GstQueueSize;
50 typedef struct _GstQueueClass GstQueueClass;
54 * @buffers: number of buffers
55 * @bytes: number of bytes
56 * @time: amount of time
58 * Structure describing the size of a queue.
60 struct _GstQueueSize {
66 #define GST_QUEUE_CLEAR_LEVEL(l) G_STMT_START { \
75 * Opaque #GstQueue structure.
84 /* segments to keep track of timestamps */
85 GstSegment sink_segment;
86 GstSegment src_segment;
88 /* position of src/sink */
89 GstClockTime sinktime, srctime;
90 /* TRUE if either position needs to be recalculated */
91 gboolean sink_tainted, src_tainted;
93 /* flowreturn when srcpad is paused */
94 GstFlowReturn srcresult;
98 /* the queue of data we're keeping our grubby hands on */
102 cur_level, /* currently in the queue */
103 max_size, /* max. amount of data allowed in the queue */
104 min_threshold, /* min. amount of data required to wake reader */
105 orig_min_threshold; /* Original min.threshold, for reset in EOS */
107 /* whether we leak data, and at which end */
110 GMutex *qlock; /* lock for queue (vs object lock) */
111 GCond *item_add; /* signals buffers now available for reading */
112 GCond *item_del; /* signals space now available for writing */
114 gboolean head_needs_discont, tail_needs_discont;
115 gboolean push_newsegment;
118 struct _GstQueueClass {
119 GstElementClass parent_class;
121 /* signals - 'running' is called from both sides
122 * which might make it sort of non-useful... */
123 void (*underrun) (GstQueue *queue);
124 void (*running) (GstQueue *queue);
125 void (*overrun) (GstQueue *queue);
127 void (*pushing) (GstQueue *queue);
130 GType gst_queue_get_type (void);
135 #endif /* __GST_QUEUE_H__ */