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 {
69 * Opaque #GstQueue structure.
78 /* segments to keep track of timestamps */
79 GstSegment sink_segment;
80 GstSegment src_segment;
82 /* flowreturn when srcpad is paused */
83 GstFlowReturn srcresult;
85 /* the queue of data we're keeping our grubby hands on */
89 cur_level, /* currently in the queue */
90 max_size, /* max. amount of data allowed in the queue */
91 min_threshold, /* min. amount of data required to wake reader */
92 orig_min_threshold; /* Original min.threshold, for reset in EOS */
94 /* whether we leak data, and at which end */
97 GMutex *qlock; /* lock for queue (vs object lock) */
98 GCond *item_add; /* signals buffers now available for reading */
99 GCond *item_del; /* signals space now available for writing */
101 gpointer _gst_reserved[GST_PADDING];
104 struct _GstQueueClass {
105 GstElementClass parent_class;
107 /* signals - 'running' is called from both sides
108 * which might make it sort of non-useful... */
109 void (*underrun) (GstQueue *queue);
110 void (*running) (GstQueue *queue);
111 void (*overrun) (GstQueue *queue);
113 void (*pushing) (GstQueue *queue);
115 gpointer _gst_reserved[GST_PADDING];
118 GType gst_queue_get_type (void);
123 #endif /* __GST_QUEUE_H__ */