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>
6 * gstquery.h: GstQuery API declaration
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.
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.
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.
25 #ifndef __GST_QUERY_H__
26 #define __GST_QUERY_H__
30 #include <gst/gstiterator.h>
31 #include <gst/gstminiobject.h>
32 #include <gst/gststructure.h>
33 #include <gst/gstformat.h>
39 * @GST_QUERY_NONE: invalid query type
40 * @GST_QUERY_POSITION: current position in stream
41 * @GST_QUERY_DURATION: total duration of the stream
42 * @GST_QUERY_LATENCY: latency of stream
43 * @GST_QUERY_JITTER: current jitter of stream
44 * @GST_QUERY_RATE: current rate of the stream
45 * @GST_QUERY_SEEKING: seeking capabilities
46 * @GST_QUERY_SEGMENT: segment start/stop positions
47 * @GST_QUERY_CONVERT: convert values between formats
48 * @GST_QUERY_FORMATS: query supported formats for convert
49 * @GST_QUERY_BUFFERING: query available media for efficient seeking. Since
51 * @GST_QUERY_CUSTOM: a custom application or element defined query. Since
53 * @GST_QUERY_URI: query the URI of the source or sink. Since 0.10.22.
55 * Standard predefined Query types
57 /* NOTE: don't forget to update the table in gstquery.c when changing
64 GST_QUERY_JITTER, /* not in draft-query, necessary? */
77 * @GST_BUFFERING_STREAM: a small amount of data is buffered
78 * @GST_BUFFERING_DOWNLOAD: the stream is being downloaded
79 * @GST_BUFFERING_TIMESHIFT: the stream is being downloaded in a ringbuffer
80 * @GST_BUFFERING_LIVE: the stream is a live stream
82 * The different types of buffering methods.
86 GST_BUFFERING_DOWNLOAD,
87 GST_BUFFERING_TIMESHIFT,
91 typedef struct _GstQueryTypeDefinition GstQueryTypeDefinition;
92 typedef struct _GstQuery GstQuery;
93 typedef struct _GstQueryClass GstQueryClass;
96 * GstQueryTypeDefinition:
97 * @value: the unique id of the Query type
99 * @description: a longer description of the query type
100 * @quark: the quark for the nick
102 * A Query Type definition
104 struct _GstQueryTypeDefinition
112 #define GST_TYPE_QUERY (gst_query_get_type())
113 #define GST_IS_QUERY(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_QUERY))
114 #define GST_IS_QUERY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_QUERY))
115 #define GST_QUERY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_QUERY, GstQueryClass))
116 #define GST_QUERY(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_QUERY, GstQuery))
117 #define GST_QUERY_CAST(obj) ((GstQuery*)(obj)) /* only since 0.10.23 */
118 #define GST_QUERY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_QUERY, GstQueryClass))
123 * @query: the query to query
125 * Get the #GstQueryType of the query.
127 #define GST_QUERY_TYPE(query) (((GstQuery*)(query))->type)
130 * GST_QUERY_TYPE_NAME:
131 * @query: the query to query
133 * Get a constant string representation of the #GstQueryType of the query.
137 #define GST_QUERY_TYPE_NAME(query) (gst_query_type_get_name(GST_QUERY_TYPE(query)))
142 * @mini_object: The parent #GstMiniObject type
143 * @type: the #GstQueryType
144 * @structure: the #GstStructure containing the query details.
146 * The #GstQuery structure.
150 GstMiniObject mini_object;
152 /*< public > *//* with COW */
155 GstStructure *structure;
158 gpointer _gst_reserved;
161 struct _GstQueryClass {
162 GstMiniObjectClass mini_object_class;
165 gpointer _gst_reserved[GST_PADDING];
168 const gchar* gst_query_type_get_name (GstQueryType query);
169 GQuark gst_query_type_to_quark (GstQueryType query);
171 GType gst_query_get_type (void);
173 /* register a new query */
174 GstQueryType gst_query_type_register (const gchar *nick,
175 const gchar *description);
176 GstQueryType gst_query_type_get_by_nick (const gchar *nick);
178 /* check if a query is in an array of querys */
179 gboolean gst_query_types_contains (const GstQueryType *types,
182 /* query for query details */
184 G_CONST_RETURN GstQueryTypeDefinition*
185 gst_query_type_get_details (GstQueryType type);
186 GstIterator* gst_query_type_iterate_definitions (void);
191 * @q: a #GstQuery to increase the refcount of.
193 * Increases the refcount of the given query by one.
197 #ifdef _FOOL_GTK_DOC_
198 G_INLINE_FUNC GstQuery * gst_query_ref (GstQuery * q);
201 static inline GstQuery *
202 gst_query_ref (GstQuery * q)
204 return GST_QUERY (gst_mini_object_ref (GST_MINI_OBJECT_CAST (q)));
209 * @q: a #GstQuery to decrease the refcount of.
211 * Decreases the refcount of the query. If the refcount reaches 0, the query
214 #ifdef _FOOL_GTK_DOC_
215 G_INLINE_FUNC void gst_query_unref (GstQuery * q);
219 gst_query_unref (GstQuery * q)
221 gst_mini_object_unref (GST_MINI_OBJECT_CAST (q));
227 * @q: a #GstQuery to copy.
229 * Copies the given query using the copy function of the parent #GstStructure.
231 * Returns: a new copy of @q.
233 #ifdef _FOOL_GTK_DOC_
234 G_INLINE_FUNC GstQuery * gst_query_copy (const GstQuery * q);
237 static inline GstQuery *
238 gst_query_copy (const GstQuery * q)
240 return GST_QUERY (gst_mini_object_copy (GST_MINI_OBJECT_CAST (q)));
244 * gst_query_make_writable:
245 * @q: a #GstQuery to make writable
247 * Makes a writable query from the given query.
249 #define gst_query_make_writable(q) GST_QUERY (gst_mini_object_make_writable (GST_MINI_OBJECT (q)))
252 GstQuery* gst_query_new_position (GstFormat format);
253 void gst_query_set_position (GstQuery *query, GstFormat format, gint64 cur);
254 void gst_query_parse_position (GstQuery *query, GstFormat *format, gint64 *cur);
257 GstQuery* gst_query_new_duration (GstFormat format);
258 void gst_query_set_duration (GstQuery *query, GstFormat format, gint64 duration);
259 void gst_query_parse_duration (GstQuery *query, GstFormat *format, gint64 *duration);
262 GstQuery* gst_query_new_latency (void);
263 void gst_query_set_latency (GstQuery *query, gboolean live, GstClockTime min_latency,
264 GstClockTime max_latency);
265 void gst_query_parse_latency (GstQuery *query, gboolean *live, GstClockTime *min_latency,
266 GstClockTime *max_latency);
269 GstQuery* gst_query_new_convert (GstFormat src_format, gint64 value, GstFormat dest_format);
270 void gst_query_set_convert (GstQuery *query, GstFormat src_format, gint64 src_value,
271 GstFormat dest_format, gint64 dest_value);
272 void gst_query_parse_convert (GstQuery *query, GstFormat *src_format, gint64 *src_value,
273 GstFormat *dest_format, gint64 *dest_value);
275 GstQuery* gst_query_new_segment (GstFormat format);
276 void gst_query_set_segment (GstQuery *query, gdouble rate, GstFormat format,
277 gint64 start_value, gint64 stop_value);
278 void gst_query_parse_segment (GstQuery *query, gdouble *rate, GstFormat *format,
279 gint64 *start_value, gint64 *stop_value);
281 /* application specific query */
282 GstQuery * gst_query_new_application (GstQueryType type,
283 GstStructure *structure);
284 GstStructure * gst_query_get_structure (GstQuery *query);
287 GstQuery* gst_query_new_seeking (GstFormat format);
288 void gst_query_set_seeking (GstQuery *query, GstFormat format,
290 gint64 segment_start,
292 void gst_query_parse_seeking (GstQuery *query, GstFormat *format,
294 gint64 *segment_start,
295 gint64 *segment_end);
297 GstQuery* gst_query_new_formats (void);
298 void gst_query_set_formats (GstQuery *query, gint n_formats, ...);
299 void gst_query_set_formatsv (GstQuery *query, gint n_formats, GstFormat *formats);
300 void gst_query_parse_formats_length (GstQuery *query, guint *n_formats);
301 void gst_query_parse_formats_nth (GstQuery *query, guint nth, GstFormat *format);
303 /* buffering query */
304 GstQuery* gst_query_new_buffering (GstFormat format);
305 void gst_query_set_buffering_percent (GstQuery *query, gboolean busy, gint percent);
306 void gst_query_parse_buffering_percent (GstQuery *query, gboolean *busy, gint *percent);
308 void gst_query_set_buffering_stats (GstQuery *query, GstBufferingMode mode,
309 gint avg_in, gint avg_out,
310 gint64 buffering_left);
311 void gst_query_parse_buffering_stats (GstQuery *query, GstBufferingMode *mode,
312 gint *avg_in, gint *avg_out,
313 gint64 *buffering_left);
315 void gst_query_set_buffering_range (GstQuery *query, GstFormat format,
316 gint64 start, gint64 stop,
317 gint64 estimated_total);
318 void gst_query_parse_buffering_range (GstQuery *query, GstFormat *format,
319 gint64 *start, gint64 *stop,
320 gint64 *estimated_total);
322 GstQuery * gst_query_new_uri (void);
323 void gst_query_parse_uri (GstQuery *query, gchar **uri);
324 void gst_query_set_uri (GstQuery *query, const gchar *uri);
328 #endif /* __GST_QUERY_H__ */