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__
30 #include <glib-object.h>
31 #include <gst/gstconfig.h>
35 typedef struct _GstQuery GstQuery;
37 #include <gst/gstminiobject.h>
41 * @GST_QUERY_TYPE_UPSTREAM: Set if the query can travel upstream.
42 * @GST_QUERY_TYPE_DOWNSTREAM: Set if the query can travel downstream.
43 * @GST_QUERY_TYPE_SERIALIZED: Set if the query should be serialized with data
46 * #GstQueryTypeFlags indicate the aspects of the different #GstQueryType
47 * values. You can get the type flags of a #GstQueryType with the
48 * gst_query_type_get_flags() function.
51 GST_QUERY_TYPE_UPSTREAM = 1 << 0,
52 GST_QUERY_TYPE_DOWNSTREAM = 1 << 1,
53 GST_QUERY_TYPE_SERIALIZED = 1 << 2
57 * GST_QUERY_TYPE_BOTH: (value 3) (type GstQueryTypeFlags)
59 * The same thing as #GST_QUERY_TYPE_UPSTREAM | #GST_QUERY_TYPE_DOWNSTREAM.
61 #define GST_QUERY_TYPE_BOTH \
62 ((GstQueryTypeFlags)(GST_QUERY_TYPE_UPSTREAM | GST_QUERY_TYPE_DOWNSTREAM))
64 #define GST_QUERY_NUM_SHIFT (8)
67 * GST_QUERY_MAKE_TYPE:
68 * @num: the query number to create
69 * @flags: the query flags
71 * when making custom query types, use this macro with the num and
74 #define GST_QUERY_MAKE_TYPE(num,flags) \
75 (((num) << GST_QUERY_NUM_SHIFT) | (flags))
77 #define FLAG(name) GST_QUERY_TYPE_##name
82 * @GST_QUERY_UNKNOWN: unknown query type
83 * @GST_QUERY_POSITION: current position in stream
84 * @GST_QUERY_DURATION: total duration of the stream
85 * @GST_QUERY_LATENCY: latency of stream
86 * @GST_QUERY_JITTER: current jitter of stream
87 * @GST_QUERY_RATE: current rate of the stream
88 * @GST_QUERY_SEEKING: seeking capabilities
89 * @GST_QUERY_SEGMENT: segment start/stop positions
90 * @GST_QUERY_CONVERT: convert values between formats
91 * @GST_QUERY_FORMATS: query supported formats for convert
92 * @GST_QUERY_BUFFERING: query available media for efficient seeking.
93 * @GST_QUERY_CUSTOM: a custom application or element defined query.
94 * @GST_QUERY_URI: query the URI of the source or sink.
95 * @GST_QUERY_ALLOCATION: the buffer allocation properties
96 * @GST_QUERY_SCHEDULING: the scheduling properties
97 * @GST_QUERY_ACCEPT_CAPS: the accept caps query
98 * @GST_QUERY_CAPS: the caps query
99 * @GST_QUERY_DRAIN: wait till all serialized data is consumed downstream
100 * @GST_QUERY_CONTEXT: query the pipeline-local context from
101 * downstream or upstream (since 1.2)
102 * @GST_QUERY_BITRATE: the bitrate query (since 1.16)
104 * Standard predefined Query types
106 /* NOTE: don't forget to update the table in gstquery.c when changing
109 GST_QUERY_UNKNOWN = GST_QUERY_MAKE_TYPE (0, 0),
110 GST_QUERY_POSITION = GST_QUERY_MAKE_TYPE (10, FLAG(BOTH)),
111 GST_QUERY_DURATION = GST_QUERY_MAKE_TYPE (20, FLAG(BOTH)),
112 GST_QUERY_LATENCY = GST_QUERY_MAKE_TYPE (30, FLAG(BOTH)),
113 GST_QUERY_JITTER = GST_QUERY_MAKE_TYPE (40, FLAG(BOTH)),
114 GST_QUERY_RATE = GST_QUERY_MAKE_TYPE (50, FLAG(BOTH)),
115 GST_QUERY_SEEKING = GST_QUERY_MAKE_TYPE (60, FLAG(BOTH)),
116 GST_QUERY_SEGMENT = GST_QUERY_MAKE_TYPE (70, FLAG(BOTH)),
117 GST_QUERY_CONVERT = GST_QUERY_MAKE_TYPE (80, FLAG(BOTH)),
118 GST_QUERY_FORMATS = GST_QUERY_MAKE_TYPE (90, FLAG(BOTH)),
119 GST_QUERY_BUFFERING = GST_QUERY_MAKE_TYPE (110, FLAG(BOTH)),
120 GST_QUERY_CUSTOM = GST_QUERY_MAKE_TYPE (120, FLAG(BOTH)),
121 GST_QUERY_URI = GST_QUERY_MAKE_TYPE (130, FLAG(BOTH)),
122 GST_QUERY_ALLOCATION = GST_QUERY_MAKE_TYPE (140, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),
123 GST_QUERY_SCHEDULING = GST_QUERY_MAKE_TYPE (150, FLAG(UPSTREAM)),
124 GST_QUERY_ACCEPT_CAPS = GST_QUERY_MAKE_TYPE (160, FLAG(BOTH)),
125 GST_QUERY_CAPS = GST_QUERY_MAKE_TYPE (170, FLAG(BOTH)),
126 GST_QUERY_DRAIN = GST_QUERY_MAKE_TYPE (180, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),
127 GST_QUERY_CONTEXT = GST_QUERY_MAKE_TYPE (190, FLAG(BOTH)),
128 GST_QUERY_BITRATE = GST_QUERY_MAKE_TYPE (200, FLAG(DOWNSTREAM)),
132 GST_API GType _gst_query_type;
134 #define GST_TYPE_QUERY (_gst_query_type)
135 #define GST_IS_QUERY(obj) (GST_IS_MINI_OBJECT_TYPE (obj, GST_TYPE_QUERY))
136 #define GST_QUERY_CAST(obj) ((GstQuery*)(obj))
137 #define GST_QUERY(obj) (GST_QUERY_CAST(obj))
141 * @query: the query to query
143 * Get the #GstQueryType of the query.
145 #define GST_QUERY_TYPE(query) (((GstQuery*)(query))->type)
148 * GST_QUERY_TYPE_NAME:
149 * @query: the query to query
151 * Get a constant string representation of the #GstQueryType of the query.
153 #define GST_QUERY_TYPE_NAME(query) (gst_query_type_get_name(GST_QUERY_TYPE(query)))
156 * GST_QUERY_IS_UPSTREAM:
157 * @ev: the query to query
159 * Check if an query can travel upstream.
161 #define GST_QUERY_IS_UPSTREAM(ev) !!(GST_QUERY_TYPE (ev) & GST_QUERY_TYPE_UPSTREAM)
163 * GST_QUERY_IS_DOWNSTREAM:
164 * @ev: the query to query
166 * Check if an query can travel downstream.
168 #define GST_QUERY_IS_DOWNSTREAM(ev) !!(GST_QUERY_TYPE (ev) & GST_QUERY_TYPE_DOWNSTREAM)
170 * GST_QUERY_IS_SERIALIZED:
171 * @ev: the query to query
173 * Check if an query is serialized with the data stream.
175 #define GST_QUERY_IS_SERIALIZED(ev) !!(GST_QUERY_TYPE (ev) & GST_QUERY_TYPE_SERIALIZED)
180 * @mini_object: The parent #GstMiniObject type
181 * @type: the #GstQueryType
183 * The #GstQuery structure.
187 GstMiniObject mini_object;
189 /*< public > *//* with COW */
195 * @GST_BUFFERING_STREAM: a small amount of data is buffered
196 * @GST_BUFFERING_DOWNLOAD: the stream is being downloaded
197 * @GST_BUFFERING_TIMESHIFT: the stream is being downloaded in a ringbuffer
198 * @GST_BUFFERING_LIVE: the stream is a live stream
200 * The different types of buffering methods.
203 GST_BUFFERING_STREAM,
204 GST_BUFFERING_DOWNLOAD,
205 GST_BUFFERING_TIMESHIFT,
209 #include <gst/gstiterator.h>
210 #include <gst/gststructure.h>
211 #include <gst/gstformat.h>
212 #include <gst/gstpad.h>
213 #include <gst/gstallocator.h>
214 #include <gst/gsttoc.h>
215 #include <gst/gstcontext.h>
218 const gchar* gst_query_type_get_name (GstQueryType type);
221 GQuark gst_query_type_to_quark (GstQueryType type);
225 gst_query_type_get_flags (GstQueryType type);
229 GType gst_query_get_type (void);
234 * @q: a #GstQuery to increase the refcount of.
236 * Increases the refcount of the given query by one.
240 static inline GstQuery *
241 gst_query_ref (GstQuery * q)
243 return GST_QUERY_CAST (gst_mini_object_ref (GST_MINI_OBJECT_CAST (q)));
248 * @q: a #GstQuery to decrease the refcount of.
250 * Decreases the refcount of the query. If the refcount reaches 0, the query
254 gst_query_unref (GstQuery * q)
256 gst_mini_object_unref (GST_MINI_OBJECT_CAST (q));
260 * gst_clear_query: (skip)
261 * @query_ptr: a pointer to a #GstQuery reference
263 * Clears a reference to a #GstQuery.
265 * @query_ptr must not be %NULL.
267 * If the reference is %NULL then this function does nothing. Otherwise, the
268 * reference count of the query is decreased and the pointer is set to %NULL.
273 gst_clear_query (GstQuery ** query_ptr)
275 gst_clear_mini_object ((GstMiniObject **) query_ptr);
281 * @q: a #GstQuery to copy.
283 * Copies the given query using the copy function of the parent #GstStructure.
285 * Free-function: gst_query_unref
287 * Returns: (transfer full): a new copy of @q.
289 static inline GstQuery *
290 gst_query_copy (const GstQuery * q)
292 return GST_QUERY_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (q)));
296 * gst_query_is_writable:
299 * Tests if you can safely write data into a query's structure.
301 #define gst_query_is_writable(q) gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (q))
303 * gst_query_make_writable:
304 * @q: (transfer full): a #GstQuery to make writable
306 * Makes a writable query from the given query.
308 * Returns: (transfer full): a new writable query (possibly same as @q)
310 #define gst_query_make_writable(q) GST_QUERY_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (q)))
313 * @old_query: (inout) (transfer full) (nullable): pointer to a pointer to a
314 * #GstQuery to be replaced.
315 * @new_query: (allow-none) (transfer none): pointer to a #GstQuery that will
316 * replace the query pointed to by @old_query.
318 * Modifies a pointer to a #GstQuery to point to a different #GstQuery. The
319 * modification is done atomically (so this is useful for ensuring thread safety
320 * in some cases), and the reference counts are updated appropriately (the old
321 * query is unreffed, the new one is reffed).
323 * Either @new_query or the #GstQuery pointed to by @old_query may be %NULL.
325 * Returns: %TRUE if @new_query was different from @old_query
327 static inline gboolean
328 gst_query_replace (GstQuery **old_query, GstQuery *new_query)
330 return gst_mini_object_replace ((GstMiniObject **) old_query, (GstMiniObject *) new_query);
335 * @old_query: (inout) (transfer full) (nullable): pointer to a
336 * pointer to a #GstQuery to be stolen.
337 * @new_query: (allow-none) (transfer full): pointer to a #GstQuery that will
338 * replace the query pointed to by @old_query.
340 * Modifies a pointer to a #GstQuery to point to a different #GstQuery. This
341 * function is similar to gst_query_replace() except that it takes ownership of
344 * Either @new_query or the #GstQuery pointed to by @old_query may be %NULL.
346 * Returns: %TRUE if @new_query was different from @old_query
350 static inline gboolean
351 gst_query_take (GstQuery **old_query, GstQuery *new_query)
353 return gst_mini_object_take ((GstMiniObject **) old_query,
354 (GstMiniObject *) new_query);
357 /* application specific query */
360 GstQuery * gst_query_new_custom (GstQueryType type, GstStructure *structure) G_GNUC_MALLOC;
364 gst_query_get_structure (GstQuery *query);
367 GstStructure * gst_query_writable_structure (GstQuery *query);
372 GstQuery* gst_query_new_position (GstFormat format) G_GNUC_MALLOC;
375 void gst_query_set_position (GstQuery *query, GstFormat format, gint64 cur);
378 void gst_query_parse_position (GstQuery *query, GstFormat *format, gint64 *cur);
383 GstQuery* gst_query_new_duration (GstFormat format) G_GNUC_MALLOC;
386 void gst_query_set_duration (GstQuery *query, GstFormat format, gint64 duration);
389 void gst_query_parse_duration (GstQuery *query, GstFormat *format, gint64 *duration);
394 GstQuery* gst_query_new_latency (void) G_GNUC_MALLOC;
397 void gst_query_set_latency (GstQuery *query, gboolean live, GstClockTime min_latency,
398 GstClockTime max_latency);
401 void gst_query_parse_latency (GstQuery *query, gboolean *live, GstClockTime *min_latency,
402 GstClockTime *max_latency);
407 GstQuery* gst_query_new_convert (GstFormat src_format, gint64 value, GstFormat dest_format) G_GNUC_MALLOC;
410 void gst_query_set_convert (GstQuery *query, GstFormat src_format, gint64 src_value,
411 GstFormat dest_format, gint64 dest_value);
414 void gst_query_parse_convert (GstQuery *query, GstFormat *src_format, gint64 *src_value,
415 GstFormat *dest_format, gint64 *dest_value);
419 GstQuery* gst_query_new_segment (GstFormat format) G_GNUC_MALLOC;
422 void gst_query_set_segment (GstQuery *query, gdouble rate, GstFormat format,
423 gint64 start_value, gint64 stop_value);
426 void gst_query_parse_segment (GstQuery *query, gdouble *rate, GstFormat *format,
427 gint64 *start_value, gint64 *stop_value);
432 GstQuery* gst_query_new_seeking (GstFormat format) G_GNUC_MALLOC;
435 void gst_query_set_seeking (GstQuery *query, GstFormat format,
437 gint64 segment_start,
441 void gst_query_parse_seeking (GstQuery *query, GstFormat *format,
443 gint64 *segment_start,
444 gint64 *segment_end);
448 GstQuery* gst_query_new_formats (void) G_GNUC_MALLOC;
451 void gst_query_set_formats (GstQuery *query, gint n_formats, ...);
454 void gst_query_set_formatsv (GstQuery *query, gint n_formats, const GstFormat *formats);
457 void gst_query_parse_n_formats (GstQuery *query, guint *n_formats);
460 void gst_query_parse_nth_format (GstQuery *query, guint nth, GstFormat *format);
462 /* buffering query */
465 GstQuery* gst_query_new_buffering (GstFormat format) G_GNUC_MALLOC;
468 void gst_query_set_buffering_percent (GstQuery *query, gboolean busy, gint percent);
471 void gst_query_parse_buffering_percent (GstQuery *query, gboolean *busy, gint *percent);
474 void gst_query_set_buffering_stats (GstQuery *query, GstBufferingMode mode,
475 gint avg_in, gint avg_out,
476 gint64 buffering_left);
479 void gst_query_parse_buffering_stats (GstQuery *query, GstBufferingMode *mode,
480 gint *avg_in, gint *avg_out,
481 gint64 *buffering_left);
484 void gst_query_set_buffering_range (GstQuery *query, GstFormat format,
485 gint64 start, gint64 stop,
486 gint64 estimated_total);
489 void gst_query_parse_buffering_range (GstQuery *query, GstFormat *format,
490 gint64 *start, gint64 *stop,
491 gint64 *estimated_total);
494 gboolean gst_query_add_buffering_range (GstQuery *query,
495 gint64 start, gint64 stop);
498 guint gst_query_get_n_buffering_ranges (GstQuery *query);
501 gboolean gst_query_parse_nth_buffering_range (GstQuery *query,
502 guint index, gint64 *start,
508 GstQuery * gst_query_new_uri (void) G_GNUC_MALLOC;
511 void gst_query_parse_uri (GstQuery *query, gchar **uri);
514 void gst_query_set_uri (GstQuery *query, const gchar *uri);
517 void gst_query_parse_uri_redirection (GstQuery *query, gchar **uri);
520 void gst_query_set_uri_redirection (GstQuery *query, const gchar *uri);
523 void gst_query_parse_uri_redirection_permanent (GstQuery *query, gboolean * permanent);
526 void gst_query_set_uri_redirection_permanent (GstQuery *query, gboolean permanent);
528 /* allocation query */
531 GstQuery * gst_query_new_allocation (GstCaps *caps, gboolean need_pool) G_GNUC_MALLOC;
534 void gst_query_parse_allocation (GstQuery *query, GstCaps **caps, gboolean *need_pool);
539 void gst_query_add_allocation_pool (GstQuery *query, GstBufferPool *pool,
540 guint size, guint min_buffers,
544 guint gst_query_get_n_allocation_pools (GstQuery *query);
547 void gst_query_parse_nth_allocation_pool (GstQuery *query, guint index,
548 GstBufferPool **pool,
549 guint *size, guint *min_buffers,
553 void gst_query_set_nth_allocation_pool (GstQuery *query, guint index,
555 guint size, guint min_buffers,
559 void gst_query_remove_nth_allocation_pool (GstQuery *query, guint index);
564 void gst_query_add_allocation_param (GstQuery *query, GstAllocator *allocator,
565 const GstAllocationParams *params);
568 guint gst_query_get_n_allocation_params (GstQuery *query);
571 void gst_query_parse_nth_allocation_param (GstQuery *query, guint index,
572 GstAllocator **allocator,
573 GstAllocationParams *params);
576 void gst_query_set_nth_allocation_param (GstQuery *query, guint index,
577 GstAllocator *allocator,
578 const GstAllocationParams *params);
581 void gst_query_remove_nth_allocation_param (GstQuery *query, guint index);
586 void gst_query_add_allocation_meta (GstQuery *query, GType api, const GstStructure *params);
589 guint gst_query_get_n_allocation_metas (GstQuery *query);
592 GType gst_query_parse_nth_allocation_meta (GstQuery *query, guint index,
593 const GstStructure **params);
596 void gst_query_remove_nth_allocation_meta (GstQuery *query, guint index);
599 gboolean gst_query_find_allocation_meta (GstQuery *query, GType api, guint *index);
602 /* scheduling query */
604 * GstSchedulingFlags:
605 * @GST_SCHEDULING_FLAG_SEEKABLE: if seeking is possible
606 * @GST_SCHEDULING_FLAG_SEQUENTIAL: if sequential access is recommended
607 * @GST_SCHEDULING_FLAG_BANDWIDTH_LIMITED: if bandwidth is limited and buffering possible (since 1.2)
609 * The different scheduling flags.
612 GST_SCHEDULING_FLAG_SEEKABLE = (1 << 0),
613 GST_SCHEDULING_FLAG_SEQUENTIAL = (1 << 1),
614 GST_SCHEDULING_FLAG_BANDWIDTH_LIMITED = (1 << 2)
615 } GstSchedulingFlags;
618 GstQuery * gst_query_new_scheduling (void) G_GNUC_MALLOC;
621 void gst_query_set_scheduling (GstQuery *query, GstSchedulingFlags flags,
622 gint minsize, gint maxsize, gint align);
625 void gst_query_parse_scheduling (GstQuery *query, GstSchedulingFlags *flags,
626 gint *minsize, gint *maxsize, gint *align);
629 void gst_query_add_scheduling_mode (GstQuery *query, GstPadMode mode);
632 guint gst_query_get_n_scheduling_modes (GstQuery *query);
635 GstPadMode gst_query_parse_nth_scheduling_mode (GstQuery *query, guint index);
638 gboolean gst_query_has_scheduling_mode (GstQuery *query, GstPadMode mode);
641 gboolean gst_query_has_scheduling_mode_with_flags (GstQuery * query, GstPadMode mode,
642 GstSchedulingFlags flags);
644 /* accept-caps query */
647 GstQuery * gst_query_new_accept_caps (GstCaps *caps) G_GNUC_MALLOC;
650 void gst_query_parse_accept_caps (GstQuery *query, GstCaps **caps);
653 void gst_query_set_accept_caps_result (GstQuery *query, gboolean result);
656 void gst_query_parse_accept_caps_result (GstQuery *query, gboolean *result);
661 GstQuery * gst_query_new_caps (GstCaps *filter) G_GNUC_MALLOC;
664 void gst_query_parse_caps (GstQuery *query, GstCaps **filter);
667 void gst_query_set_caps_result (GstQuery *query, GstCaps *caps);
670 void gst_query_parse_caps_result (GstQuery *query, GstCaps **caps);
675 GstQuery * gst_query_new_drain (void) G_GNUC_MALLOC;
680 GstQuery * gst_query_new_context (const gchar * context_type) G_GNUC_MALLOC;
683 gboolean gst_query_parse_context_type (GstQuery * query, const gchar ** context_type);
686 void gst_query_set_context (GstQuery *query, GstContext *context);
689 void gst_query_parse_context (GstQuery *query, GstContext **context);
694 GstQuery * gst_query_new_bitrate (void) G_GNUC_MALLOC;
697 void gst_query_set_bitrate (GstQuery * query, guint nominal_bitrate);
700 void gst_query_parse_bitrate (GstQuery * query, guint * nominal_bitrate);
702 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
703 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstQuery, gst_query_unref)
708 #endif /* __GST_QUERY_H__ */