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>
36 #include <gst/gsttoc.h>
40 typedef struct _GstQuery GstQuery;
44 * @GST_QUERY_TYPE_UPSTREAM: Set if the query can travel upstream.
45 * @GST_QUERY_TYPE_DOWNSTREAM: Set if the query can travel downstream.
46 * @GST_QUERY_TYPE_SERIALIZED: Set if the query should be serialized with data
49 * #GstQueryTypeFlags indicate the aspects of the different #GstQueryType
50 * values. You can get the type flags of a #GstQueryType with the
51 * gst_query_type_get_flags() function.
54 GST_QUERY_TYPE_UPSTREAM = 1 << 0,
55 GST_QUERY_TYPE_DOWNSTREAM = 1 << 1,
56 GST_QUERY_TYPE_SERIALIZED = 1 << 2
60 * GST_QUERY_TYPE_BOTH:
62 * The same thing as #GST_QUERY_TYPE_UPSTREAM | #GST_QUERY_TYPE_DOWNSTREAM.
64 #define GST_QUERY_TYPE_BOTH \
65 (GST_QUERY_TYPE_UPSTREAM | GST_QUERY_TYPE_DOWNSTREAM)
67 #define GST_QUERY_NUM_SHIFT (8)
70 * GST_QUERY_MAKE_TYPE:
71 * @num: the query number to create
72 * @flags: the query flags
74 * when making custom query types, use this macro with the num and
77 #define GST_QUERY_MAKE_TYPE(num,flags) \
78 (((num) << GST_QUERY_NUM_SHIFT) | (flags))
80 #define FLAG(name) GST_QUERY_TYPE_##name
85 * @GST_QUERY_UNKNOWN: unknown query type
86 * @GST_QUERY_POSITION: current position in stream
87 * @GST_QUERY_DURATION: total duration of the stream
88 * @GST_QUERY_LATENCY: latency of stream
89 * @GST_QUERY_JITTER: current jitter of stream
90 * @GST_QUERY_RATE: current rate of the stream
91 * @GST_QUERY_SEEKING: seeking capabilities
92 * @GST_QUERY_SEGMENT: segment start/stop positions
93 * @GST_QUERY_CONVERT: convert values between formats
94 * @GST_QUERY_FORMATS: query supported formats for convert
95 * @GST_QUERY_BUFFERING: query available media for efficient seeking. Since
97 * @GST_QUERY_CUSTOM: a custom application or element defined query. Since
99 * @GST_QUERY_URI: query the URI of the source or sink. Since 0.10.22.
100 * @GST_QUERY_ALLOCATION: the buffer allocation properties
101 * @GST_QUERY_SCHEDULING: the scheduling properties
102 * @GST_QUERY_ACCEPT_CAPS: the accept caps query
103 * @GST_QUERY_CAPS: the caps query
104 * @GST_QUERY_DRAIN: wait till all serialized data is consumed downstream
105 * @GST_QUERY_TOC: query the full table of contents (TOC) with the marker
106 * for an entry which can be used to extend received TOC. Since 0.10.37.
108 * Standard predefined Query types
110 /* NOTE: don't forget to update the table in gstquery.c when changing
113 GST_QUERY_UNKNOWN = GST_QUERY_MAKE_TYPE (0, 0),
114 GST_QUERY_POSITION = GST_QUERY_MAKE_TYPE (10, FLAG(BOTH)),
115 GST_QUERY_DURATION = GST_QUERY_MAKE_TYPE (20, FLAG(BOTH)),
116 GST_QUERY_LATENCY = GST_QUERY_MAKE_TYPE (30, FLAG(BOTH)),
117 GST_QUERY_JITTER = GST_QUERY_MAKE_TYPE (40, FLAG(BOTH)),
118 GST_QUERY_RATE = GST_QUERY_MAKE_TYPE (50, FLAG(BOTH)),
119 GST_QUERY_SEEKING = GST_QUERY_MAKE_TYPE (60, FLAG(BOTH)),
120 GST_QUERY_SEGMENT = GST_QUERY_MAKE_TYPE (70, FLAG(BOTH)),
121 GST_QUERY_CONVERT = GST_QUERY_MAKE_TYPE (80, FLAG(BOTH)),
122 GST_QUERY_FORMATS = GST_QUERY_MAKE_TYPE (90, FLAG(BOTH)),
123 GST_QUERY_BUFFERING = GST_QUERY_MAKE_TYPE (110, FLAG(BOTH)),
124 GST_QUERY_CUSTOM = GST_QUERY_MAKE_TYPE (120, FLAG(BOTH)),
125 GST_QUERY_URI = GST_QUERY_MAKE_TYPE (130, FLAG(BOTH)),
126 GST_QUERY_ALLOCATION = GST_QUERY_MAKE_TYPE (140, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),
127 GST_QUERY_SCHEDULING = GST_QUERY_MAKE_TYPE (150, FLAG(UPSTREAM)),
128 GST_QUERY_ACCEPT_CAPS = GST_QUERY_MAKE_TYPE (160, FLAG(BOTH)),
129 GST_QUERY_CAPS = GST_QUERY_MAKE_TYPE (170, FLAG(BOTH)),
130 GST_QUERY_DRAIN = GST_QUERY_MAKE_TYPE (180, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),
131 GST_QUERY_TOC = GST_QUERY_MAKE_TYPE (190, FLAG(BOTH))
135 #define GST_TYPE_QUERY (gst_query_get_type())
136 #define GST_IS_QUERY(obj) (GST_IS_MINI_OBJECT_TYPE (obj, GST_TYPE_QUERY))
137 #define GST_QUERY_CAST(obj) ((GstQuery*)(obj))
138 #define GST_QUERY(obj) (GST_QUERY_CAST(obj))
142 * @query: the query to query
144 * Get the #GstQueryType of the query.
146 #define GST_QUERY_TYPE(query) (((GstQuery*)(query))->type)
149 * GST_QUERY_TYPE_NAME:
150 * @query: the query to query
152 * Get a constant string representation of the #GstQueryType of the query.
156 #define GST_QUERY_TYPE_NAME(query) (gst_query_type_get_name(GST_QUERY_TYPE(query)))
159 * GST_QUERY_IS_UPSTREAM:
160 * @ev: the query to query
162 * Check if an query can travel upstream.
164 #define GST_QUERY_IS_UPSTREAM(ev) !!(GST_QUERY_TYPE (ev) & GST_QUERY_TYPE_UPSTREAM)
166 * GST_QUERY_IS_DOWNSTREAM:
167 * @ev: the query to query
169 * Check if an query can travel downstream.
171 #define GST_QUERY_IS_DOWNSTREAM(ev) !!(GST_QUERY_TYPE (ev) & GST_QUERY_TYPE_DOWNSTREAM)
173 * GST_QUERY_IS_SERIALIZED:
174 * @ev: the query to query
176 * Check if an query is serialized with the data stream.
178 #define GST_QUERY_IS_SERIALIZED(ev) !!(GST_QUERY_TYPE (ev) & GST_QUERY_TYPE_SERIALIZED)
183 * @mini_object: The parent #GstMiniObject type
184 * @type: the #GstQueryType
186 * The #GstQuery structure.
190 GstMiniObject mini_object;
192 /*< public > *//* with COW */
196 const gchar* gst_query_type_get_name (GstQueryType type);
197 GQuark gst_query_type_to_quark (GstQueryType type);
199 gst_query_type_get_flags (GstQueryType type);
202 GType gst_query_get_type (void);
207 * @q: a #GstQuery to increase the refcount of.
209 * Increases the refcount of the given query by one.
213 #ifdef _FOOL_GTK_DOC_
214 G_INLINE_FUNC GstQuery * gst_query_ref (GstQuery * q);
217 static inline GstQuery *
218 gst_query_ref (GstQuery * q)
220 return GST_QUERY_CAST (gst_mini_object_ref (GST_MINI_OBJECT_CAST (q)));
225 * @q: a #GstQuery to decrease the refcount of.
227 * Decreases the refcount of the query. If the refcount reaches 0, the query
230 #ifdef _FOOL_GTK_DOC_
231 G_INLINE_FUNC void gst_query_unref (GstQuery * q);
235 gst_query_unref (GstQuery * q)
237 gst_mini_object_unref (GST_MINI_OBJECT_CAST (q));
243 * @q: a #GstQuery to copy.
245 * Copies the given query using the copy function of the parent #GstStructure.
247 * Free-function: gst_query_unref
249 * Returns: (transfer full): a new copy of @q.
251 #ifdef _FOOL_GTK_DOC_
252 G_INLINE_FUNC GstQuery * gst_query_copy (const GstQuery * q);
255 static inline GstQuery *
256 gst_query_copy (const GstQuery * q)
258 return GST_QUERY_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (q)));
262 * gst_query_is_writable:
265 * Tests if you can safely write data into a query's structure.
267 #define gst_query_is_writable(q) gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (q))
269 * gst_query_make_writable:
270 * @q: (transfer full): a #GstQuery to make writable
272 * Makes a writable query from the given query.
274 * Returns: (transfer full): a new writable query (possibly same as @q)
276 #define gst_query_make_writable(q) GST_QUERY_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (q)))
279 * @old_query: (inout) (transfer full): pointer to a pointer to a #GstQuery
281 * @new_query: (allow-none) (transfer none): pointer to a #GstQuery that will
282 * replace the query pointed to by @old_query.
284 * Modifies a pointer to a #GstQuery to point to a different #GstQuery. The
285 * modification is done atomically (so this is useful for ensuring thread safety
286 * in some cases), and the reference counts are updated appropriately (the old
287 * query is unreffed, the new one is reffed).
289 * Either @new_query or the #GstQuery pointed to by @old_query may be NULL.
291 * Returns: TRUE if @new_query was different from @old_query
293 #ifdef _FOOL_GTK_DOC_
294 G_INLINE_FUNC gboolean gst_query_replace (GstQuery **old_query, GstQuery *new_query);
297 static inline gboolean
298 gst_query_replace (GstQuery **old_query, GstQuery *new_query)
300 return gst_mini_object_replace ((GstMiniObject **) old_query, (GstMiniObject *) new_query);
303 /* application specific query */
304 GstQuery * gst_query_new_custom (GstQueryType type, GstStructure *structure) G_GNUC_MALLOC;
306 gst_query_get_structure (GstQuery *query);
307 GstStructure * gst_query_writable_structure (GstQuery *query);
310 GstQuery* gst_query_new_position (GstFormat format) G_GNUC_MALLOC;
311 void gst_query_set_position (GstQuery *query, GstFormat format, gint64 cur);
312 void gst_query_parse_position (GstQuery *query, GstFormat *format, gint64 *cur);
315 GstQuery* gst_query_new_duration (GstFormat format) G_GNUC_MALLOC;
316 void gst_query_set_duration (GstQuery *query, GstFormat format, gint64 duration);
317 void gst_query_parse_duration (GstQuery *query, GstFormat *format, gint64 *duration);
320 GstQuery* gst_query_new_latency (void) G_GNUC_MALLOC;
321 void gst_query_set_latency (GstQuery *query, gboolean live, GstClockTime min_latency,
322 GstClockTime max_latency);
323 void gst_query_parse_latency (GstQuery *query, gboolean *live, GstClockTime *min_latency,
324 GstClockTime *max_latency);
327 GstQuery* gst_query_new_convert (GstFormat src_format, gint64 value, GstFormat dest_format) G_GNUC_MALLOC;
328 void gst_query_set_convert (GstQuery *query, GstFormat src_format, gint64 src_value,
329 GstFormat dest_format, gint64 dest_value);
330 void gst_query_parse_convert (GstQuery *query, GstFormat *src_format, gint64 *src_value,
331 GstFormat *dest_format, gint64 *dest_value);
333 GstQuery* gst_query_new_segment (GstFormat format) G_GNUC_MALLOC;
334 void gst_query_set_segment (GstQuery *query, gdouble rate, GstFormat format,
335 gint64 start_value, gint64 stop_value);
336 void gst_query_parse_segment (GstQuery *query, gdouble *rate, GstFormat *format,
337 gint64 *start_value, gint64 *stop_value);
340 GstQuery* gst_query_new_seeking (GstFormat format) G_GNUC_MALLOC;
341 void gst_query_set_seeking (GstQuery *query, GstFormat format,
343 gint64 segment_start,
345 void gst_query_parse_seeking (GstQuery *query, GstFormat *format,
347 gint64 *segment_start,
348 gint64 *segment_end);
350 GstQuery* gst_query_new_formats (void) G_GNUC_MALLOC;
351 void gst_query_set_formats (GstQuery *query, gint n_formats, ...);
352 void gst_query_set_formatsv (GstQuery *query, gint n_formats, const GstFormat *formats);
353 void gst_query_parse_n_formats (GstQuery *query, guint *n_formats);
354 void gst_query_parse_nth_format (GstQuery *query, guint nth, GstFormat *format);
356 /* buffering query */
359 * @GST_BUFFERING_STREAM: a small amount of data is buffered
360 * @GST_BUFFERING_DOWNLOAD: the stream is being downloaded
361 * @GST_BUFFERING_TIMESHIFT: the stream is being downloaded in a ringbuffer
362 * @GST_BUFFERING_LIVE: the stream is a live stream
364 * The different types of buffering methods.
367 GST_BUFFERING_STREAM,
368 GST_BUFFERING_DOWNLOAD,
369 GST_BUFFERING_TIMESHIFT,
373 GstQuery* gst_query_new_buffering (GstFormat format) G_GNUC_MALLOC;
374 void gst_query_set_buffering_percent (GstQuery *query, gboolean busy, gint percent);
375 void gst_query_parse_buffering_percent (GstQuery *query, gboolean *busy, gint *percent);
377 void gst_query_set_buffering_stats (GstQuery *query, GstBufferingMode mode,
378 gint avg_in, gint avg_out,
379 gint64 buffering_left);
380 void gst_query_parse_buffering_stats (GstQuery *query, GstBufferingMode *mode,
381 gint *avg_in, gint *avg_out,
382 gint64 *buffering_left);
384 void gst_query_set_buffering_range (GstQuery *query, GstFormat format,
385 gint64 start, gint64 stop,
386 gint64 estimated_total);
387 void gst_query_parse_buffering_range (GstQuery *query, GstFormat *format,
388 gint64 *start, gint64 *stop,
389 gint64 *estimated_total);
391 gboolean gst_query_add_buffering_range (GstQuery *query,
392 gint64 start, gint64 stop);
393 guint gst_query_get_n_buffering_ranges (GstQuery *query);
394 gboolean gst_query_parse_nth_buffering_range (GstQuery *query,
395 guint index, gint64 *start,
399 GstQuery * gst_query_new_uri (void) G_GNUC_MALLOC;
400 void gst_query_parse_uri (GstQuery *query, gchar **uri);
401 void gst_query_set_uri (GstQuery *query, const gchar *uri);
403 /* allocation query */
404 GstQuery * gst_query_new_allocation (GstCaps *caps, gboolean need_pool) G_GNUC_MALLOC;
405 void gst_query_parse_allocation (GstQuery *query, GstCaps **caps, gboolean *need_pool);
408 void gst_query_add_allocation_pool (GstQuery *query, GstBufferPool *pool,
409 guint size, guint min_buffers,
411 guint gst_query_get_n_allocation_pools (GstQuery *query);
412 void gst_query_parse_nth_allocation_pool (GstQuery *query, guint index,
413 GstBufferPool **pool,
414 guint *size, guint *min_buffers,
416 void gst_query_set_nth_allocation_pool (GstQuery *query, guint index,
418 guint size, guint min_buffers,
422 void gst_query_add_allocation_param (GstQuery *query, GstAllocator *allocator,
423 const GstAllocationParams *params);
424 guint gst_query_get_n_allocation_params (GstQuery *query);
425 void gst_query_parse_nth_allocation_param (GstQuery *query, guint index,
426 GstAllocator **allocator,
427 GstAllocationParams *params);
428 void gst_query_set_nth_allocation_param (GstQuery *query, guint index,
429 GstAllocator *allocator,
430 const GstAllocationParams *params);
433 void gst_query_add_allocation_meta (GstQuery *query, GType api);
434 guint gst_query_get_n_allocation_metas (GstQuery *query);
435 GType gst_query_parse_nth_allocation_meta (GstQuery *query, guint index);
436 void gst_query_remove_nth_allocation_meta (GstQuery *query, guint index);
437 gboolean gst_query_has_allocation_meta (GstQuery *query, GType api);
440 /* scheduling query */
442 * GstSchedulingFlags:
443 * @GST_SCHEDULING_FLAG_SEEKABLE: if seeking is possible
444 * @GST_SCHEDULING_FLAG_SEQUENTIAL: if sequential access is recommended
446 * The different scheduling flags.
449 GST_SCHEDULING_FLAG_SEEKABLE = (1 << 0),
450 GST_SCHEDULING_FLAG_SEQUENTIAL = (1 << 1)
451 } GstSchedulingFlags;
453 GstQuery * gst_query_new_scheduling (void) G_GNUC_MALLOC;
455 void gst_query_set_scheduling (GstQuery *query, GstSchedulingFlags flags,
456 gint minsize, gint maxsize, gint align);
457 void gst_query_parse_scheduling (GstQuery *query, GstSchedulingFlags *flags,
458 gint *minsize, gint *maxsize, gint *align);
460 void gst_query_add_scheduling_mode (GstQuery *query, GstPadMode mode);
461 guint gst_query_get_n_scheduling_modes (GstQuery *query);
462 GstPadMode gst_query_parse_nth_scheduling_mode (GstQuery *query, guint index);
463 gboolean gst_query_has_scheduling_mode (GstQuery *query, GstPadMode mode);
465 /* accept-caps query */
466 GstQuery * gst_query_new_accept_caps (GstCaps *caps) G_GNUC_MALLOC;
467 void gst_query_parse_accept_caps (GstQuery *query, GstCaps **caps);
468 void gst_query_set_accept_caps_result (GstQuery *query, gboolean result);
469 void gst_query_parse_accept_caps_result (GstQuery *query, gboolean *result);
472 GstQuery * gst_query_new_caps (GstCaps *filter) G_GNUC_MALLOC;
473 void gst_query_parse_caps (GstQuery *query, GstCaps **filter);
475 void gst_query_set_caps_result (GstQuery *query, GstCaps *caps);
476 void gst_query_parse_caps_result (GstQuery *query, GstCaps **caps);
479 GstQuery * gst_query_new_drain (void) G_GNUC_MALLOC;
482 GstQuery * gst_query_new_toc (void);
483 void gst_query_set_toc (GstQuery *query, GstToc *toc, const gchar *extend_uid);
484 void gst_query_parse_toc (GstQuery *query, GstToc **toc, gchar **extend_uid);
488 #endif /* __GST_QUERY_H__ */