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., 51 Franklin St, Fifth Floor,
22 * Boston, MA 02110-1301, 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/gstallocator.h>
37 #include <gst/gsttoc.h>
38 #include <gst/gstcontext.h>
42 typedef struct _GstQuery GstQuery;
46 * @GST_QUERY_TYPE_UPSTREAM: Set if the query can travel upstream.
47 * @GST_QUERY_TYPE_DOWNSTREAM: Set if the query can travel downstream.
48 * @GST_QUERY_TYPE_SERIALIZED: Set if the query should be serialized with data
51 * #GstQueryTypeFlags indicate the aspects of the different #GstQueryType
52 * values. You can get the type flags of a #GstQueryType with the
53 * gst_query_type_get_flags() function.
56 GST_QUERY_TYPE_UPSTREAM = 1 << 0,
57 GST_QUERY_TYPE_DOWNSTREAM = 1 << 1,
58 GST_QUERY_TYPE_SERIALIZED = 1 << 2
62 * GST_QUERY_TYPE_BOTH:
64 * The same thing as #GST_QUERY_TYPE_UPSTREAM | #GST_QUERY_TYPE_DOWNSTREAM.
66 #define GST_QUERY_TYPE_BOTH \
67 (GST_QUERY_TYPE_UPSTREAM | GST_QUERY_TYPE_DOWNSTREAM)
69 #define GST_QUERY_NUM_SHIFT (8)
72 * GST_QUERY_MAKE_TYPE:
73 * @num: the query number to create
74 * @flags: the query flags
76 * when making custom query types, use this macro with the num and
79 #define GST_QUERY_MAKE_TYPE(num,flags) \
80 (((num) << GST_QUERY_NUM_SHIFT) | (flags))
82 #define FLAG(name) GST_QUERY_TYPE_##name
87 * @GST_QUERY_UNKNOWN: unknown query type
88 * @GST_QUERY_POSITION: current position in stream
89 * @GST_QUERY_DURATION: total duration of the stream
90 * @GST_QUERY_LATENCY: latency of stream
91 * @GST_QUERY_JITTER: current jitter of stream
92 * @GST_QUERY_RATE: current rate of the stream
93 * @GST_QUERY_SEEKING: seeking capabilities
94 * @GST_QUERY_SEGMENT: segment start/stop positions
95 * @GST_QUERY_CONVERT: convert values between formats
96 * @GST_QUERY_FORMATS: query supported formats for convert
97 * @GST_QUERY_BUFFERING: query available media for efficient seeking.
98 * @GST_QUERY_CUSTOM: a custom application or element defined query.
99 * @GST_QUERY_URI: query the URI of the source or sink.
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_CONTEXT: query the pipeline-local context from
106 * downstream or upstream (since 1.2)
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_CONTEXT = 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.
154 #define GST_QUERY_TYPE_NAME(query) (gst_query_type_get_name(GST_QUERY_TYPE(query)))
157 * GST_QUERY_IS_UPSTREAM:
158 * @ev: the query to query
160 * Check if an query can travel upstream.
162 #define GST_QUERY_IS_UPSTREAM(ev) !!(GST_QUERY_TYPE (ev) & GST_QUERY_TYPE_UPSTREAM)
164 * GST_QUERY_IS_DOWNSTREAM:
165 * @ev: the query to query
167 * Check if an query can travel downstream.
169 #define GST_QUERY_IS_DOWNSTREAM(ev) !!(GST_QUERY_TYPE (ev) & GST_QUERY_TYPE_DOWNSTREAM)
171 * GST_QUERY_IS_SERIALIZED:
172 * @ev: the query to query
174 * Check if an query is serialized with the data stream.
176 #define GST_QUERY_IS_SERIALIZED(ev) !!(GST_QUERY_TYPE (ev) & GST_QUERY_TYPE_SERIALIZED)
181 * @mini_object: The parent #GstMiniObject type
182 * @type: the #GstQueryType
184 * The #GstQuery structure.
188 GstMiniObject mini_object;
190 /*< public > *//* with COW */
194 const gchar* gst_query_type_get_name (GstQueryType type);
195 GQuark gst_query_type_to_quark (GstQueryType type);
197 gst_query_type_get_flags (GstQueryType type);
200 GType gst_query_get_type (void);
205 * @q: a #GstQuery to increase the refcount of.
207 * Increases the refcount of the given query by one.
211 #ifdef _FOOL_GTK_DOC_
212 G_INLINE_FUNC GstQuery * gst_query_ref (GstQuery * q);
215 static inline GstQuery *
216 gst_query_ref (GstQuery * q)
218 return GST_QUERY_CAST (gst_mini_object_ref (GST_MINI_OBJECT_CAST (q)));
223 * @q: a #GstQuery to decrease the refcount of.
225 * Decreases the refcount of the query. If the refcount reaches 0, the query
228 #ifdef _FOOL_GTK_DOC_
229 G_INLINE_FUNC void gst_query_unref (GstQuery * q);
233 gst_query_unref (GstQuery * q)
235 gst_mini_object_unref (GST_MINI_OBJECT_CAST (q));
241 * @q: a #GstQuery to copy.
243 * Copies the given query using the copy function of the parent #GstStructure.
245 * Free-function: gst_query_unref
247 * Returns: (transfer full): a new copy of @q.
249 #ifdef _FOOL_GTK_DOC_
250 G_INLINE_FUNC GstQuery * gst_query_copy (const GstQuery * q);
253 static inline GstQuery *
254 gst_query_copy (const GstQuery * q)
256 return GST_QUERY_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (q)));
260 * gst_query_is_writable:
263 * Tests if you can safely write data into a query's structure.
265 #define gst_query_is_writable(q) gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (q))
267 * gst_query_make_writable:
268 * @q: (transfer full): a #GstQuery to make writable
270 * Makes a writable query from the given query.
272 * Returns: (transfer full): a new writable query (possibly same as @q)
274 #define gst_query_make_writable(q) GST_QUERY_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (q)))
277 * @old_query: (inout) (transfer full): pointer to a pointer to a #GstQuery
279 * @new_query: (allow-none) (transfer none): pointer to a #GstQuery that will
280 * replace the query pointed to by @old_query.
282 * Modifies a pointer to a #GstQuery to point to a different #GstQuery. The
283 * modification is done atomically (so this is useful for ensuring thread safety
284 * in some cases), and the reference counts are updated appropriately (the old
285 * query is unreffed, the new one is reffed).
287 * Either @new_query or the #GstQuery pointed to by @old_query may be NULL.
289 * Returns: TRUE if @new_query was different from @old_query
291 #ifdef _FOOL_GTK_DOC_
292 G_INLINE_FUNC gboolean gst_query_replace (GstQuery **old_query, GstQuery *new_query);
295 static inline gboolean
296 gst_query_replace (GstQuery **old_query, GstQuery *new_query)
298 return gst_mini_object_replace ((GstMiniObject **) old_query, (GstMiniObject *) new_query);
301 /* application specific query */
302 GstQuery * gst_query_new_custom (GstQueryType type, GstStructure *structure) G_GNUC_MALLOC;
304 gst_query_get_structure (GstQuery *query);
305 GstStructure * gst_query_writable_structure (GstQuery *query);
308 GstQuery* gst_query_new_position (GstFormat format) G_GNUC_MALLOC;
309 void gst_query_set_position (GstQuery *query, GstFormat format, gint64 cur);
310 void gst_query_parse_position (GstQuery *query, GstFormat *format, gint64 *cur);
313 GstQuery* gst_query_new_duration (GstFormat format) G_GNUC_MALLOC;
314 void gst_query_set_duration (GstQuery *query, GstFormat format, gint64 duration);
315 void gst_query_parse_duration (GstQuery *query, GstFormat *format, gint64 *duration);
318 GstQuery* gst_query_new_latency (void) G_GNUC_MALLOC;
319 void gst_query_set_latency (GstQuery *query, gboolean live, GstClockTime min_latency,
320 GstClockTime max_latency);
321 void gst_query_parse_latency (GstQuery *query, gboolean *live, GstClockTime *min_latency,
322 GstClockTime *max_latency);
325 GstQuery* gst_query_new_convert (GstFormat src_format, gint64 value, GstFormat dest_format) G_GNUC_MALLOC;
326 void gst_query_set_convert (GstQuery *query, GstFormat src_format, gint64 src_value,
327 GstFormat dest_format, gint64 dest_value);
328 void gst_query_parse_convert (GstQuery *query, GstFormat *src_format, gint64 *src_value,
329 GstFormat *dest_format, gint64 *dest_value);
331 GstQuery* gst_query_new_segment (GstFormat format) G_GNUC_MALLOC;
332 void gst_query_set_segment (GstQuery *query, gdouble rate, GstFormat format,
333 gint64 start_value, gint64 stop_value);
334 void gst_query_parse_segment (GstQuery *query, gdouble *rate, GstFormat *format,
335 gint64 *start_value, gint64 *stop_value);
338 GstQuery* gst_query_new_seeking (GstFormat format) G_GNUC_MALLOC;
339 void gst_query_set_seeking (GstQuery *query, GstFormat format,
341 gint64 segment_start,
343 void gst_query_parse_seeking (GstQuery *query, GstFormat *format,
345 gint64 *segment_start,
346 gint64 *segment_end);
348 GstQuery* gst_query_new_formats (void) G_GNUC_MALLOC;
349 void gst_query_set_formats (GstQuery *query, gint n_formats, ...);
350 void gst_query_set_formatsv (GstQuery *query, gint n_formats, const GstFormat *formats);
351 void gst_query_parse_n_formats (GstQuery *query, guint *n_formats);
352 void gst_query_parse_nth_format (GstQuery *query, guint nth, GstFormat *format);
354 /* buffering query */
357 * @GST_BUFFERING_STREAM: a small amount of data is buffered
358 * @GST_BUFFERING_DOWNLOAD: the stream is being downloaded
359 * @GST_BUFFERING_TIMESHIFT: the stream is being downloaded in a ringbuffer
360 * @GST_BUFFERING_LIVE: the stream is a live stream
362 * The different types of buffering methods.
365 GST_BUFFERING_STREAM,
366 GST_BUFFERING_DOWNLOAD,
367 GST_BUFFERING_TIMESHIFT,
371 GstQuery* gst_query_new_buffering (GstFormat format) G_GNUC_MALLOC;
372 void gst_query_set_buffering_percent (GstQuery *query, gboolean busy, gint percent);
373 void gst_query_parse_buffering_percent (GstQuery *query, gboolean *busy, gint *percent);
375 void gst_query_set_buffering_stats (GstQuery *query, GstBufferingMode mode,
376 gint avg_in, gint avg_out,
377 gint64 buffering_left);
378 void gst_query_parse_buffering_stats (GstQuery *query, GstBufferingMode *mode,
379 gint *avg_in, gint *avg_out,
380 gint64 *buffering_left);
382 void gst_query_set_buffering_range (GstQuery *query, GstFormat format,
383 gint64 start, gint64 stop,
384 gint64 estimated_total);
385 void gst_query_parse_buffering_range (GstQuery *query, GstFormat *format,
386 gint64 *start, gint64 *stop,
387 gint64 *estimated_total);
389 gboolean gst_query_add_buffering_range (GstQuery *query,
390 gint64 start, gint64 stop);
391 guint gst_query_get_n_buffering_ranges (GstQuery *query);
392 gboolean gst_query_parse_nth_buffering_range (GstQuery *query,
393 guint index, gint64 *start,
397 GstQuery * gst_query_new_uri (void) G_GNUC_MALLOC;
398 void gst_query_parse_uri (GstQuery *query, gchar **uri);
399 void gst_query_set_uri (GstQuery *query, const gchar *uri);
400 void gst_query_parse_uri_redirection (GstQuery *query, gchar **uri);
401 void gst_query_set_uri_redirection (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,
420 void gst_query_remove_nth_allocation_pool (GstQuery *query, guint index);
423 void gst_query_add_allocation_param (GstQuery *query, GstAllocator *allocator,
424 const GstAllocationParams *params);
425 guint gst_query_get_n_allocation_params (GstQuery *query);
426 void gst_query_parse_nth_allocation_param (GstQuery *query, guint index,
427 GstAllocator **allocator,
428 GstAllocationParams *params);
429 void gst_query_set_nth_allocation_param (GstQuery *query, guint index,
430 GstAllocator *allocator,
431 const GstAllocationParams *params);
432 void gst_query_remove_nth_allocation_param (GstQuery *query, guint index);
435 void gst_query_add_allocation_meta (GstQuery *query, GType api, const GstStructure *params);
436 guint gst_query_get_n_allocation_metas (GstQuery *query);
437 GType gst_query_parse_nth_allocation_meta (GstQuery *query, guint index,
438 const GstStructure **params);
439 void gst_query_remove_nth_allocation_meta (GstQuery *query, guint index);
440 gboolean gst_query_find_allocation_meta (GstQuery *query, GType api, guint *index);
443 /* scheduling query */
445 * GstSchedulingFlags:
446 * @GST_SCHEDULING_FLAG_SEEKABLE: if seeking is possible
447 * @GST_SCHEDULING_FLAG_SEQUENTIAL: if sequential access is recommended
448 * @GST_SCHEDULING_FLAG_BANDWIDTH_LIMITED: if bandwidth is limited and buffering possible (since 1.2)
450 * The different scheduling flags.
453 GST_SCHEDULING_FLAG_SEEKABLE = (1 << 0),
454 GST_SCHEDULING_FLAG_SEQUENTIAL = (1 << 1),
455 GST_SCHEDULING_FLAG_BANDWIDTH_LIMITED = (1 << 2)
456 } GstSchedulingFlags;
458 GstQuery * gst_query_new_scheduling (void) G_GNUC_MALLOC;
460 void gst_query_set_scheduling (GstQuery *query, GstSchedulingFlags flags,
461 gint minsize, gint maxsize, gint align);
462 void gst_query_parse_scheduling (GstQuery *query, GstSchedulingFlags *flags,
463 gint *minsize, gint *maxsize, gint *align);
465 void gst_query_add_scheduling_mode (GstQuery *query, GstPadMode mode);
466 guint gst_query_get_n_scheduling_modes (GstQuery *query);
467 GstPadMode gst_query_parse_nth_scheduling_mode (GstQuery *query, guint index);
468 gboolean gst_query_has_scheduling_mode (GstQuery *query, GstPadMode mode);
469 gboolean gst_query_has_scheduling_mode_with_flags (GstQuery * query, GstPadMode mode,
470 GstSchedulingFlags flags);
472 /* accept-caps query */
473 GstQuery * gst_query_new_accept_caps (GstCaps *caps) G_GNUC_MALLOC;
474 void gst_query_parse_accept_caps (GstQuery *query, GstCaps **caps);
475 void gst_query_set_accept_caps_result (GstQuery *query, gboolean result);
476 void gst_query_parse_accept_caps_result (GstQuery *query, gboolean *result);
479 GstQuery * gst_query_new_caps (GstCaps *filter) G_GNUC_MALLOC;
480 void gst_query_parse_caps (GstQuery *query, GstCaps **filter);
482 void gst_query_set_caps_result (GstQuery *query, GstCaps *caps);
483 void gst_query_parse_caps_result (GstQuery *query, GstCaps **caps);
486 GstQuery * gst_query_new_drain (void) G_GNUC_MALLOC;
489 GstQuery * gst_query_new_context (const gchar * context_type) G_GNUC_MALLOC;
490 gboolean gst_query_parse_context_type (GstQuery * query, const gchar ** context_type);
491 void gst_query_set_context (GstQuery *query, GstContext *context);
492 void gst_query_parse_context (GstQuery *query, GstContext **context);
496 #endif /* __GST_QUERY_H__ */