add GstQueryBuffers query
[glsdk/gstreamer0-10.git] / gst / gstquery.h
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wim.taymans@chello.be>
4  *                    2005 Wim Taymans <wim@fluendo.com>
5  *
6  * gstquery.h: GstQuery API declaration
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public
19  * License along with this library; if not, write to the
20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  */
25 #ifndef __GST_QUERY_H__
26 #define __GST_QUERY_H__
28 #include <glib.h>
30 #include <gst/gstiterator.h>
31 #include <gst/gstminiobject.h>
32 #include <gst/gststructure.h>
33 #include <gst/gstformat.h>
34 #include <gst/gstcaps.h>
36 G_BEGIN_DECLS
38 /**
39  * GstQueryType:
40  * @GST_QUERY_NONE: invalid query type
41  * @GST_QUERY_POSITION: current position in stream
42  * @GST_QUERY_DURATION: total duration of the stream
43  * @GST_QUERY_LATENCY: latency of stream
44  * @GST_QUERY_JITTER: current jitter of stream
45  * @GST_QUERY_RATE: current rate of the stream
46  * @GST_QUERY_SEEKING: seeking capabilities
47  * @GST_QUERY_SEGMENT: segment start/stop positions
48  * @GST_QUERY_CONVERT: convert values between formats
49  * @GST_QUERY_FORMATS: query supported formats for convert
50  * @GST_QUERY_BUFFERING: query available media for efficient seeking. Since
51  * 0.10.20.
52  * @GST_QUERY_CUSTOM: a custom application or element defined query. Since
53  * 0.10.22.
54  * @GST_QUERY_URI: query the URI of the source or sink. Since 0.10.22.
55  * @GST_QUERY_BUFFERS: query the upstream users of pad_alloc()'d buffers to
56  * find any particular requirements about buffer size (padding) or numbers of
57  * buffers. Since ?.?.?.
58  *
59  * Standard predefined Query types
60  */
61 /* NOTE: don't forget to update the table in gstquery.c when changing
62  * this enum */
63 typedef enum {
64   GST_QUERY_NONE = 0,
65   GST_QUERY_POSITION,
66   GST_QUERY_DURATION,
67   GST_QUERY_LATENCY,
68   GST_QUERY_JITTER,     /* not in draft-query, necessary? */
69   GST_QUERY_RATE,
70   GST_QUERY_SEEKING,
71   GST_QUERY_SEGMENT,
72   GST_QUERY_CONVERT,
73   GST_QUERY_FORMATS,
74   GST_QUERY_BUFFERING,
75   GST_QUERY_CUSTOM,
76   GST_QUERY_URI,
77   GST_QUERY_BUFFERS
78 } GstQueryType;
80 /**
81  * GstBufferingMode:
82  * @GST_BUFFERING_STREAM: a small amount of data is buffered
83  * @GST_BUFFERING_DOWNLOAD: the stream is being downloaded
84  * @GST_BUFFERING_TIMESHIFT: the stream is being downloaded in a ringbuffer
85  * @GST_BUFFERING_LIVE: the stream is a live stream
86  *
87  * The different types of buffering methods.
88  */
89 typedef enum {
90   GST_BUFFERING_STREAM,
91   GST_BUFFERING_DOWNLOAD,
92   GST_BUFFERING_TIMESHIFT,
93   GST_BUFFERING_LIVE
94 } GstBufferingMode;
96 typedef struct _GstQueryTypeDefinition GstQueryTypeDefinition;
97 typedef struct _GstQuery GstQuery;
98 typedef struct _GstQueryClass GstQueryClass;
100 /**
101  * GstQueryTypeDefinition:
102  * @value: the unique id of the Query type
103  * @nick: a short nick
104  * @description: a longer description of the query type
105  * @quark: the quark for the nick
106  *
107  * A Query Type definition
108  */
109 struct _GstQueryTypeDefinition
111   GstQueryType   value;
112   const gchar   *nick;
113   const gchar   *description;
114   GQuark         quark;
115 };
117 #define GST_TYPE_QUERY                          (gst_query_get_type())
118 #define GST_IS_QUERY(obj)                      (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_QUERY))
119 #define GST_IS_QUERY_CLASS(klass)              (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_QUERY))
120 #define GST_QUERY_GET_CLASS(obj)               (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_QUERY, GstQueryClass))
121 #define GST_QUERY(obj)                         (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_QUERY, GstQuery))
122 #define GST_QUERY_CAST(obj)                    ((GstQuery*)(obj)) /* only since 0.10.23 */
123 #define GST_QUERY_CLASS(klass)                 (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_QUERY, GstQueryClass))
126 /**
127  * GST_QUERY_TYPE:
128  * @query: the query to query
129  *
130  * Get the #GstQueryType of the query.
131  */
132 #define GST_QUERY_TYPE(query)  (((GstQuery*)(query))->type)
134 /**
135  * GST_QUERY_TYPE_NAME:
136  * @query: the query to query
137  *
138  * Get a constant string representation of the #GstQueryType of the query.
139  *
140  * Since: 0.10.4
141  */
142 #define GST_QUERY_TYPE_NAME(query) (gst_query_type_get_name(GST_QUERY_TYPE(query)))
145 /**
146  * GstQuery:
147  * @mini_object: The parent #GstMiniObject type
148  * @type: the #GstQueryType
149  * @structure: the #GstStructure containing the query details.
150  *
151  * The #GstQuery structure.
152  */
153 struct _GstQuery
155   GstMiniObject mini_object;
157   /*< public > *//* with COW */
158   GstQueryType type;
160   GstStructure *structure;
162   /*< private >*/
163   gpointer _gst_reserved;
164 };
166 struct _GstQueryClass {
167   GstMiniObjectClass mini_object_class;
169   /*< private >*/
170   gpointer _gst_reserved[GST_PADDING];
171 };
173 const gchar*    gst_query_type_get_name        (GstQueryType query);
174 GQuark          gst_query_type_to_quark        (GstQueryType query);
176 GType           gst_query_get_type             (void);
178 /* register a new query */
179 GstQueryType    gst_query_type_register        (const gchar *nick,
180                                                 const gchar *description);
181 GstQueryType    gst_query_type_get_by_nick     (const gchar *nick);
183 /* check if a query is in an array of querys */
184 gboolean        gst_query_types_contains       (const GstQueryType *types,
185                                                 GstQueryType type);
187 /* query for query details */
189 const GstQueryTypeDefinition*
190                 gst_query_type_get_details         (GstQueryType type);
191 GstIterator*    gst_query_type_iterate_definitions (void) G_GNUC_MALLOC;
193 /* refcounting */
194 /**
195  * gst_query_ref:
196  * @q: a #GstQuery to increase the refcount of.
197  *
198  * Increases the refcount of the given query by one.
199  *
200  * Returns: @q
201  */
202 #ifdef _FOOL_GTK_DOC_
203 G_INLINE_FUNC GstQuery * gst_query_ref (GstQuery * q);
204 #endif
206 static inline GstQuery *
207 gst_query_ref (GstQuery * q)
209   return GST_QUERY_CAST (gst_mini_object_ref (GST_MINI_OBJECT_CAST (q)));
212 /**
213  * gst_query_unref:
214  * @q: a #GstQuery to decrease the refcount of.
215  *
216  * Decreases the refcount of the query. If the refcount reaches 0, the query
217  * will be freed.
218  */
219 #ifdef _FOOL_GTK_DOC_
220 G_INLINE_FUNC void gst_query_unref (GstQuery * q);
221 #endif
223 static inline void
224 gst_query_unref (GstQuery * q)
226   gst_mini_object_unref (GST_MINI_OBJECT_CAST (q));
229 /* copy query */
230 /**
231  * gst_query_copy:
232  * @q: a #GstQuery to copy.
233  *
234  * Copies the given query using the copy function of the parent #GstStructure.
235  *
236  * Free-function: gst_query_unref
237  *
238  * Returns: (transfer full): a new copy of @q.
239  */
240 #ifdef _FOOL_GTK_DOC_
241 G_INLINE_FUNC GstQuery * gst_query_copy (const GstQuery * q);
242 #endif
244 static inline GstQuery *
245 gst_query_copy (const GstQuery * q)
247   return GST_QUERY_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (q)));
250 /**
251  * gst_query_make_writable:
252  * @q: (transfer full): a #GstQuery to make writable
253  *
254  * Makes a writable query from the given query.
255  *
256  * Returns: (transfer full): a new writable query (possibly same as @q)
257  */
258 #define         gst_query_make_writable(q)      GST_QUERY_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (q)))
260 /* position query */
261 GstQuery*       gst_query_new_position          (GstFormat format) G_GNUC_MALLOC;
262 void            gst_query_set_position          (GstQuery *query, GstFormat format, gint64 cur);
263 void            gst_query_parse_position        (GstQuery *query, GstFormat *format, gint64 *cur);
265 /* duration query */
266 GstQuery*       gst_query_new_duration          (GstFormat format) G_GNUC_MALLOC;
267 void            gst_query_set_duration          (GstQuery *query, GstFormat format, gint64 duration);
268 void            gst_query_parse_duration        (GstQuery *query, GstFormat *format, gint64 *duration);
270 /* latency query */
271 GstQuery*       gst_query_new_latency           (void) G_GNUC_MALLOC;
272 void            gst_query_set_latency           (GstQuery *query, gboolean live, GstClockTime min_latency,
273                                                  GstClockTime max_latency);
274 void            gst_query_parse_latency         (GstQuery *query, gboolean *live, GstClockTime *min_latency,
275                                                  GstClockTime *max_latency);
277 /* convert query */
278 GstQuery*       gst_query_new_convert           (GstFormat src_format, gint64 value, GstFormat dest_format) G_GNUC_MALLOC;
279 void            gst_query_set_convert           (GstQuery *query, GstFormat src_format, gint64 src_value,
280                                                  GstFormat dest_format, gint64 dest_value);
281 void            gst_query_parse_convert         (GstQuery *query, GstFormat *src_format, gint64 *src_value,
282                                                  GstFormat *dest_format, gint64 *dest_value);
283 /* segment query */
284 GstQuery*       gst_query_new_segment           (GstFormat format) G_GNUC_MALLOC;
285 void            gst_query_set_segment           (GstQuery *query, gdouble rate, GstFormat format,
286                                                  gint64 start_value, gint64 stop_value);
287 void            gst_query_parse_segment         (GstQuery *query, gdouble *rate, GstFormat *format,
288                                                  gint64 *start_value, gint64 *stop_value);
290 /* application specific query */
291 GstQuery *      gst_query_new_application       (GstQueryType type,
292                                                  GstStructure *structure) G_GNUC_MALLOC;
293 GstStructure *  gst_query_get_structure         (GstQuery *query);
295 /* seeking query */
296 GstQuery*       gst_query_new_seeking           (GstFormat format) G_GNUC_MALLOC;
297 void            gst_query_set_seeking           (GstQuery *query, GstFormat format,
298                                                  gboolean seekable,
299                                                  gint64 segment_start,
300                                                  gint64 segment_end);
301 void            gst_query_parse_seeking         (GstQuery *query, GstFormat *format,
302                                                  gboolean *seekable,
303                                                  gint64 *segment_start,
304                                                  gint64 *segment_end);
305 /* formats query */
306 GstQuery*       gst_query_new_formats           (void) G_GNUC_MALLOC;
307 void            gst_query_set_formats           (GstQuery *query, gint n_formats, ...);
308 void            gst_query_set_formatsv          (GstQuery *query, gint n_formats, const GstFormat *formats);
309 void            gst_query_parse_formats_length  (GstQuery *query, guint *n_formats);
310 void            gst_query_parse_formats_nth     (GstQuery *query, guint nth, GstFormat *format);
312 /* buffering query */
313 GstQuery*       gst_query_new_buffering           (GstFormat format) G_GNUC_MALLOC;
314 void            gst_query_set_buffering_percent   (GstQuery *query, gboolean busy, gint percent);
315 void            gst_query_parse_buffering_percent (GstQuery *query, gboolean *busy, gint *percent);
317 void            gst_query_set_buffering_stats     (GstQuery *query, GstBufferingMode mode,
318                                                    gint avg_in, gint avg_out,
319                                                    gint64 buffering_left);
320 void            gst_query_parse_buffering_stats    (GstQuery *query, GstBufferingMode *mode,
321                                                    gint *avg_in, gint *avg_out,
322                                                    gint64 *buffering_left);
324 void            gst_query_set_buffering_range     (GstQuery *query, GstFormat format,
325                                                    gint64 start, gint64 stop,
326                                                    gint64 estimated_total);
327 void            gst_query_parse_buffering_range   (GstQuery *query, GstFormat *format,
328                                                    gint64 *start, gint64 *stop,
329                                                    gint64 *estimated_total);
330 gboolean        gst_query_add_buffering_range     (GstQuery *query,
331                                                    gint64 start, gint64 stop);
333 guint           gst_query_get_n_buffering_ranges  (GstQuery *query);
335 gboolean        gst_query_parse_nth_buffering_range (GstQuery *query,
336                                                      guint index, gint64 *start,
337                                                      gint64 *stop);
339 /* URI query */
340 GstQuery *      gst_query_new_uri                 (void) G_GNUC_MALLOC;
341 void            gst_query_parse_uri               (GstQuery *query, gchar **uri);
342 void            gst_query_set_uri                 (GstQuery *query, const gchar *uri);
344 /* buffer requirements query */
345 GstQuery *      gst_query_new_buffers             (GstCaps * caps);
346 void            gst_query_set_buffers_count       (GstQuery * query, gint count);
347 void            gst_query_set_buffers_dimensions  (GstQuery * query, gint width, gint height);
348 void            gst_query_parse_buffers_caps      (GstQuery * query, const GstCaps ** caps);
349 void            gst_query_parse_buffers_count     (GstQuery * query, gint * count);
350 void            gst_query_parse_buffers_dimensions (GstQuery * query, gint * width, gint * height);
353 G_END_DECLS
355 #endif /* __GST_QUERY_H__ */