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>
33 #define GST_TYPE_QUEUE \
34 (gst_queue_get_type())
35 #define GST_QUEUE(obj) \
36 (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_QUEUE,GstQueue))
37 #define GST_QUEUE_CLASS(klass) \
38 (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_QUEUE,GstQueueClass))
39 #define GST_IS_QUEUE(obj) \
40 (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_QUEUE))
41 #define GST_IS_QUEUE_CLASS(obj) \
42 (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_QUEUE))
45 GST_QUEUE_NO_LEAK = 0,
46 GST_QUEUE_LEAK_UPSTREAM = 1,
47 GST_QUEUE_LEAK_DOWNSTREAM = 2
50 typedef struct _GstQueue GstQueue;
51 typedef struct _GstQueueSize GstQueueSize;
52 typedef struct _GstQueueClass GstQueueClass;
54 struct _GstQueueSize {
55 guint buffers; /* no. of buffers */
56 guint bytes; /* no. of bytes */
57 guint64 time; /* amount of time */
66 /* the queue of data we're keeping our grubby hands on */
70 cur_level, /* currently in the queue */
71 max_size, /* max. amount of data allowed in the queue */
72 min_threshold; /* min. amount of data required to wake reader */
74 /* whether we leak data, and at which end */
77 /* number of nanoseconds until a blocked queue 'times out'
78 * to receive data and returns a filler event. -1 = disable */
79 guint64 block_timeout;
81 /* it the queue should fail on possible deadlocks */
82 gboolean may_deadlock;
87 GMutex *qlock; /* lock for queue (vs object lock) */
88 GCond *item_add; /* signals buffers now available for reading */
89 GCond *item_del; /* signals space now available for writing */
90 GCond *event_done; /* upstream event signaller */
92 GTimeVal *timeval; /* the timeout for the queue locking */
93 GQueue *events; /* upstream events get decoupled here */
95 GstCaps *negotiated_caps;
97 gpointer _gst_reserved[GST_PADDING];
100 struct _GstQueueClass {
101 GstElementClass parent_class;
103 /* signals - 'running' is called from both sides
104 * which might make it sort of non-useful... */
105 void (*underrun) (GstQueue *queue);
106 void (*running) (GstQueue *queue);
107 void (*overrun) (GstQueue *queue);
109 gpointer _gst_reserved[GST_PADDING];
112 GType gst_queue_get_type (void);
117 #endif /* __GST_QUEUE_H__ */