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__
28 #include <gst/gstelement.h>
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))
44 GST_QUEUE_NO_LEAK = 0,
45 GST_QUEUE_LEAK_UPSTREAM = 1,
46 GST_QUEUE_LEAK_DOWNSTREAM = 2
49 typedef struct _GstQueue GstQueue;
50 typedef struct _GstQueueSize GstQueueSize;
51 typedef struct _GstQueueClass GstQueueClass;
53 struct _GstQueueSize {
54 guint buffers; /* no. of buffers */
55 guint bytes; /* no. of bytes */
56 guint64 time; /* amount of time */
65 /* the queue of data we're keeping our grubby hands on */
69 cur_level, /* currently in the queue */
70 max_size, /* max. amount of data allowed in the queue */
71 min_threshold; /* min. amount of data required to wake reader */
73 /* whether we leak data, and at which end */
76 /* number of nanoseconds until a blocked queue 'times out'
77 * to receive data and returns a filler event. -1 = disable */
78 guint64 block_timeout;
80 /* it the queue should fail on possible deadlocks */
81 gboolean may_deadlock;
85 GMutex *qlock; /* lock for queue (vs object lock) */
86 GCond *item_add; /* signals buffers now available for reading */
87 GCond *item_del; /* signals space now available for writing */
89 gpointer _gst_reserved[GST_PADDING];
92 struct _GstQueueClass {
93 GstElementClass parent_class;
95 /* signals - 'running' is called from both sides
96 * which might make it sort of non-useful... */
97 void (*underrun) (GstQueue *queue);
98 void (*running) (GstQueue *queue);
99 void (*overrun) (GstQueue *queue);
101 gpointer _gst_reserved[GST_PADDING];
104 GType gst_queue_get_type (void);
109 #endif /* __GST_QUEUE_H__ */