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 extern GstElementDetails gst_queue_details;
36 #define GST_TYPE_QUEUE \
37 (gst_queue_get_type())
38 #define GST_QUEUE(obj) \
39 (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_QUEUE,GstQueue))
40 #define GST_QUEUE_CLASS(klass) \
41 (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_QUEUE,GstQueueClass))
42 #define GST_IS_QUEUE(obj) \
43 (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_QUEUE))
44 #define GST_IS_QUEUE_CLASS(obj) \
45 (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_QUEUE))
48 GST_QUEUE_NO_LEAK = 0,
49 GST_QUEUE_LEAK_UPSTREAM = 1,
50 GST_QUEUE_LEAK_DOWNSTREAM = 2
53 typedef struct _GstQueue GstQueue;
54 typedef struct _GstQueueClass GstQueueClass;
62 /* the queue of buffers we're keeping our grubby hands on */
65 guint level_buffers; /* number of buffers queued here */
66 guint level_bytes; /* number of bytes queued here */
67 guint64 level_time; /* amount of time queued here */
69 guint size_buffers; /* size of queue in buffers */
70 guint size_bytes; /* size of queue in bytes */
71 guint64 size_time; /* size of queue in time */
73 gint leaky; /* whether the queue is leaky, and if so at which end */
74 gint block_timeout; /* microseconds until a blocked queue times out and returns GST_EVENT_FILLER.
75 * A value of -1 will block forever. */
76 gboolean may_deadlock; /* it the queue should fail on possible deadlocks */
80 GMutex *qlock; /* lock for queue (vs object lock) */
81 /* we are single reader and single writer queue */
82 gboolean reader; /* reader waiting on empty queue */
83 gboolean writer; /* writer waiting on full queue */
84 GCond *not_empty; /* signals buffers now available for reading */
85 GCond *not_full; /* signals space now available for writing */
87 GTimeVal *timeval; /* the timeout for the queue locking */
88 GAsyncQueue *events; /* upstream events get decoupled here */
91 struct _GstQueueClass {
92 GstElementClass parent_class;
94 /* signal callbacks */
95 void (*low_watermark) (GstQueue *queue, gint level);
96 void (*high_watermark) (GstQueue *queue, gint level);
99 GType gst_queue_get_type (void);
104 #endif /* __GST_QUEUE_H__ */