increment current, reset padding
[platform/upstream/gstreamer.git] / plugins / elements / gstqueue.h
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wtay@chello.be>
4  *
5  * gstqueue.h: 
6  *
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.
11  *
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.
16  *
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.
21  */
22
23
24 #ifndef __GST_QUEUE_H__
25 #define __GST_QUEUE_H__
26
27
28 #include <gst/gstelement.h>
29
30
31 G_BEGIN_DECLS
32
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))
43
44 enum {
45   GST_QUEUE_NO_LEAK             = 0,
46   GST_QUEUE_LEAK_UPSTREAM       = 1,
47   GST_QUEUE_LEAK_DOWNSTREAM     = 2
48 };
49
50 typedef struct _GstQueue GstQueue;
51 typedef struct _GstQueueClass GstQueueClass;
52
53 struct _GstQueue {
54   GstElement element;
55
56   GstPad *sinkpad;
57   GstPad *srcpad;
58
59   /* the queue of data we're keeping our grubby hands on */
60   GQueue *queue;
61
62   struct {
63     guint   buffers;    /* no. of buffers */
64     guint   bytes;      /* no. of bytes */
65     guint64 time;       /* amount of time */
66   } cur_level,          /* currently in the queue */
67     max_size,           /* max. amount of data allowed in the queue */
68     min_threshold;      /* min. amount of data required to wake reader */
69
70   /* whether we leak data, and at which end */
71   gint leaky;
72
73   /* number of nanoseconds until a blocked queue 'times out'
74    * to receive data and returns a filler event. -1 = disable */
75   guint64 block_timeout;
76
77   /* it the queue should fail on possible deadlocks */
78   gboolean may_deadlock;
79
80   gboolean interrupt;
81   gboolean flush;
82
83   GMutex *qlock;        /* lock for queue (vs object lock) */
84   GCond *item_add;      /* signals buffers now available for reading */
85   GCond *item_del;      /* signals space now available for writing */
86   GCond *event_done;    /* upstream event signaller */
87
88   GTimeVal *timeval;    /* the timeout for the queue locking */
89   GQueue *events;       /* upstream events get decoupled here */
90
91   GstCaps *negotiated_caps;
92
93   gpointer _gst_reserved[GST_PADDING];
94 };
95
96 struct _GstQueueClass {
97   GstElementClass parent_class;
98
99   /* signals - 'running' is called from both sides
100    * which might make it sort of non-useful... */
101   void (*underrun)      (GstQueue *queue);
102   void (*running)       (GstQueue *queue);
103   void (*overrun)       (GstQueue *queue);
104
105   gpointer _gst_reserved[GST_PADDING];
106 };
107
108 GType gst_queue_get_type (void);
109
110 G_END_DECLS
111
112
113 #endif /* __GST_QUEUE_H__ */