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 * 2011 Wim Taymans <wim.taymans@gmail.com>
7 * gstquery.h: GstQuery API declaration
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Library General Public
11 * License as published by the Free Software Foundation; either
12 * version 2 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Library General Public License for more details.
19 * You should have received a copy of the GNU Library General Public
20 * License along with this library; if not, write to the
21 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 * Boston, MA 02111-1307, USA.
26 #ifndef __GST_QUERY_H__
27 #define __GST_QUERY_H__
31 #include <gst/gstiterator.h>
32 #include <gst/gstminiobject.h>
33 #include <gst/gststructure.h>
34 #include <gst/gstformat.h>
35 #include <gst/gstpad.h>
41 * @GST_QUERY_NONE: invalid query type
42 * @GST_QUERY_POSITION: current position in stream
43 * @GST_QUERY_DURATION: total duration of the stream
44 * @GST_QUERY_LATENCY: latency of stream
45 * @GST_QUERY_JITTER: current jitter of stream
46 * @GST_QUERY_RATE: current rate of the stream
47 * @GST_QUERY_SEEKING: seeking capabilities
48 * @GST_QUERY_SEGMENT: segment start/stop positions
49 * @GST_QUERY_CONVERT: convert values between formats
50 * @GST_QUERY_FORMATS: query supported formats for convert
51 * @GST_QUERY_BUFFERING: query available media for efficient seeking. Since
53 * @GST_QUERY_CUSTOM: a custom application or element defined query. Since
55 * @GST_QUERY_URI: query the URI of the source or sink. Since 0.10.22.
56 * @GST_QUERY_ALLOCATION: the buffer allocation properties
57 * @GST_QUERY_SCHEDULING: the scheduling properties
58 * @GST_QUERY_ACCEPT_CAPS: the accept caps query
59 * @GST_QUERY_CAPS: the caps query
61 * Standard predefined Query types
63 /* NOTE: don't forget to update the table in gstquery.c when changing
70 GST_QUERY_JITTER, /* not in draft-query, necessary? */
81 GST_QUERY_ACCEPT_CAPS,
85 typedef struct _GstQueryTypeDefinition GstQueryTypeDefinition;
86 typedef struct _GstQuery GstQuery;
89 * GstQueryTypeDefinition:
90 * @value: the unique id of the Query type
92 * @description: a longer description of the query type
93 * @quark: the quark for the nick
95 * A Query Type definition
97 struct _GstQueryTypeDefinition
101 const gchar *description;
105 #define GST_TYPE_QUERY (gst_query_get_type())
106 #define GST_IS_QUERY(obj) (GST_IS_MINI_OBJECT_TYPE (obj, GST_TYPE_QUERY))
107 #define GST_QUERY_CAST(obj) ((GstQuery*)(obj))
108 #define GST_QUERY(obj) (GST_QUERY_CAST(obj))
113 * @query: the query to query
115 * Get the #GstQueryType of the query.
117 #define GST_QUERY_TYPE(query) (((GstQuery*)(query))->type)
120 * GST_QUERY_TYPE_NAME:
121 * @query: the query to query
123 * Get a constant string representation of the #GstQueryType of the query.
127 #define GST_QUERY_TYPE_NAME(query) (gst_query_type_get_name(GST_QUERY_TYPE(query)))
132 * @mini_object: The parent #GstMiniObject type
133 * @type: the #GstQueryType
135 * The #GstQuery structure.
139 GstMiniObject mini_object;
141 /*< public > *//* with COW */
145 const gchar* gst_query_type_get_name (GstQueryType query);
146 GQuark gst_query_type_to_quark (GstQueryType query);
148 GType gst_query_get_type (void);
150 /* register a new query */
151 GstQueryType gst_query_type_register (const gchar *nick,
152 const gchar *description);
153 GstQueryType gst_query_type_get_by_nick (const gchar *nick);
155 /* check if a query is in an array of querys */
156 gboolean gst_query_types_contains (const GstQueryType *types,
159 /* query for query details */
161 const GstQueryTypeDefinition*
162 gst_query_type_get_details (GstQueryType type);
163 GstIterator* gst_query_type_iterate_definitions (void);
168 * @q: a #GstQuery to increase the refcount of.
170 * Increases the refcount of the given query by one.
174 #ifdef _FOOL_GTK_DOC_
175 G_INLINE_FUNC GstQuery * gst_query_ref (GstQuery * q);
178 static inline GstQuery *
179 gst_query_ref (GstQuery * q)
181 return GST_QUERY_CAST (gst_mini_object_ref (GST_MINI_OBJECT_CAST (q)));
186 * @q: a #GstQuery to decrease the refcount of.
188 * Decreases the refcount of the query. If the refcount reaches 0, the query
191 #ifdef _FOOL_GTK_DOC_
192 G_INLINE_FUNC void gst_query_unref (GstQuery * q);
196 gst_query_unref (GstQuery * q)
198 gst_mini_object_unref (GST_MINI_OBJECT_CAST (q));
204 * @q: a #GstQuery to copy.
206 * Copies the given query using the copy function of the parent #GstStructure.
208 * Free-function: gst_query_unref
210 * Returns: (transfer full): a new copy of @q.
212 #ifdef _FOOL_GTK_DOC_
213 G_INLINE_FUNC GstQuery * gst_query_copy (const GstQuery * q);
216 static inline GstQuery *
217 gst_query_copy (const GstQuery * q)
219 return GST_QUERY_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (q)));
223 * gst_query_is_writable:
226 * Tests if you can safely write data into a query's structure.
228 #define gst_query_is_writable(q) gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (q))
230 * gst_query_make_writable:
231 * @q: (transfer full): a #GstQuery to make writable
233 * Makes a writable query from the given query.
235 * Returns: (transfer full): a new writable query (possibly same as @q)
237 #define gst_query_make_writable(q) GST_QUERY_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (q)))
240 * @old_query: (inout) (transfer full): pointer to a pointer to a #GstQuery
242 * @new_query: (allow-none) (transfer none): pointer to a #GstQuery that will
243 * replace the query pointed to by @old_query.
245 * Modifies a pointer to a #GstQuery to point to a different #GstQuery. The
246 * modification is done atomically (so this is useful for ensuring thread safety
247 * in some cases), and the reference counts are updated appropriately (the old
248 * query is unreffed, the new one is reffed).
250 * Either @new_query or the #GstQuery pointed to by @old_query may be NULL.
252 #define gst_query_replace(old_query,new_query) \
253 gst_mini_object_replace ((GstMiniObject **)(old_query), GST_MINI_OBJECT_CAST (new_query))
256 /* application specific query */
257 GstQuery * gst_query_new_custom (GstQueryType type, GstStructure *structure);
259 gst_query_get_structure (GstQuery *query);
260 GstStructure * gst_query_writable_structure (GstQuery *query);
263 GstQuery* gst_query_new_position (GstFormat format);
264 void gst_query_set_position (GstQuery *query, GstFormat format, gint64 cur);
265 void gst_query_parse_position (GstQuery *query, GstFormat *format, gint64 *cur);
268 GstQuery* gst_query_new_duration (GstFormat format);
269 void gst_query_set_duration (GstQuery *query, GstFormat format, gint64 duration);
270 void gst_query_parse_duration (GstQuery *query, GstFormat *format, gint64 *duration);
273 GstQuery* gst_query_new_latency (void);
274 void gst_query_set_latency (GstQuery *query, gboolean live, GstClockTime min_latency,
275 GstClockTime max_latency);
276 void gst_query_parse_latency (GstQuery *query, gboolean *live, GstClockTime *min_latency,
277 GstClockTime *max_latency);
280 GstQuery* gst_query_new_convert (GstFormat src_format, gint64 value, GstFormat dest_format);
281 void gst_query_set_convert (GstQuery *query, GstFormat src_format, gint64 src_value,
282 GstFormat dest_format, gint64 dest_value);
283 void gst_query_parse_convert (GstQuery *query, GstFormat *src_format, gint64 *src_value,
284 GstFormat *dest_format, gint64 *dest_value);
286 GstQuery* gst_query_new_segment (GstFormat format);
287 void gst_query_set_segment (GstQuery *query, gdouble rate, GstFormat format,
288 gint64 start_value, gint64 stop_value);
289 void gst_query_parse_segment (GstQuery *query, gdouble *rate, GstFormat *format,
290 gint64 *start_value, gint64 *stop_value);
293 GstQuery* gst_query_new_seeking (GstFormat format);
294 void gst_query_set_seeking (GstQuery *query, GstFormat format,
296 gint64 segment_start,
298 void gst_query_parse_seeking (GstQuery *query, GstFormat *format,
300 gint64 *segment_start,
301 gint64 *segment_end);
303 GstQuery* gst_query_new_formats (void);
304 void gst_query_set_formats (GstQuery *query, gint n_formats, ...);
305 void gst_query_set_formatsv (GstQuery *query, gint n_formats, const GstFormat *formats);
306 void gst_query_parse_n_formats (GstQuery *query, guint *n_formats);
307 void gst_query_parse_nth_format (GstQuery *query, guint nth, GstFormat *format);
309 /* buffering query */
312 * @GST_BUFFERING_STREAM: a small amount of data is buffered
313 * @GST_BUFFERING_DOWNLOAD: the stream is being downloaded
314 * @GST_BUFFERING_TIMESHIFT: the stream is being downloaded in a ringbuffer
315 * @GST_BUFFERING_LIVE: the stream is a live stream
317 * The different types of buffering methods.
320 GST_BUFFERING_STREAM,
321 GST_BUFFERING_DOWNLOAD,
322 GST_BUFFERING_TIMESHIFT,
326 GstQuery* gst_query_new_buffering (GstFormat format);
327 void gst_query_set_buffering_percent (GstQuery *query, gboolean busy, gint percent);
328 void gst_query_parse_buffering_percent (GstQuery *query, gboolean *busy, gint *percent);
330 void gst_query_set_buffering_stats (GstQuery *query, GstBufferingMode mode,
331 gint avg_in, gint avg_out,
332 gint64 buffering_left);
333 void gst_query_parse_buffering_stats (GstQuery *query, GstBufferingMode *mode,
334 gint *avg_in, gint *avg_out,
335 gint64 *buffering_left);
337 void gst_query_set_buffering_range (GstQuery *query, GstFormat format,
338 gint64 start, gint64 stop,
339 gint64 estimated_total);
340 void gst_query_parse_buffering_range (GstQuery *query, GstFormat *format,
341 gint64 *start, gint64 *stop,
342 gint64 *estimated_total);
344 gboolean gst_query_add_buffering_range (GstQuery *query,
345 gint64 start, gint64 stop);
346 guint gst_query_get_n_buffering_ranges (GstQuery *query);
347 gboolean gst_query_parse_nth_buffering_range (GstQuery *query,
348 guint index, gint64 *start,
352 GstQuery * gst_query_new_uri (void);
353 void gst_query_parse_uri (GstQuery *query, gchar **uri);
354 void gst_query_set_uri (GstQuery *query, const gchar *uri);
356 /* allocation query */
357 GstQuery * gst_query_new_allocation (GstCaps *caps, gboolean need_pool);
358 void gst_query_parse_allocation (GstQuery *query, GstCaps **caps, gboolean *need_pool);
360 void gst_query_set_allocation_params (GstQuery *query, guint size, guint min_buffers,
361 guint max_buffers, guint prefix, guint alignment,
362 GstBufferPool *pool);
363 void gst_query_parse_allocation_params (GstQuery *query, guint *size, guint *min_buffers,
364 guint *max_buffers, guint *prefix, guint *alignment,
365 GstBufferPool **pool);
367 void gst_query_add_allocation_meta (GstQuery *query, const gchar *api);
368 guint gst_query_get_n_allocation_metas (GstQuery *query);
369 const gchar * gst_query_parse_nth_allocation_meta (GstQuery *query, guint index);
370 gboolean gst_query_has_allocation_meta (GstQuery *query, const gchar *api);
372 void gst_query_add_allocation_memory (GstQuery *query, const gchar *alloc);
373 guint gst_query_get_n_allocation_memories (GstQuery *query);
374 const gchar * gst_query_parse_nth_allocation_memory (GstQuery *query, guint index);
376 /* scheduling query */
377 GstQuery * gst_query_new_scheduling (void);
379 void gst_query_set_scheduling (GstQuery *query, gboolean pull_mode,
380 gboolean random_access, gboolean sequential,
381 gint minsize, gint maxsize, gint align);
382 void gst_query_parse_scheduling (GstQuery *query, gboolean *pull_mode,
383 gboolean *random_access, gboolean *sequential,
384 gint *minsize, gint *maxsize, gint *align);
385 /* accept-caps query */
386 GstQuery * gst_query_new_accept_caps (GstCaps *caps);
387 void gst_query_parse_accept_caps (GstQuery *query, GstCaps **caps);
388 void gst_query_set_accept_caps_result (GstQuery *query, gboolean result);
389 void gst_query_parse_accept_caps_result (GstQuery *query, gboolean *result);
392 GstQuery * gst_query_new_caps (GstCaps *filter);
393 void gst_query_parse_caps (GstQuery *query, GstCaps **filter);
395 void gst_query_set_caps_result (GstQuery *query, GstCaps *caps);
396 void gst_query_parse_caps_result (GstQuery *query, GstCaps **caps);
398 void gst_query_intersect_caps_result (GstQuery *query, GstCaps *filter,
399 GstCapsIntersectMode mode);
403 #endif /* __GST_QUERY_H__ */