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)
103 * @GST_QUERY_SELECTABLE: Query stream selection capability (Since: 1.22)
105 * Standard predefined Query types
107 /* NOTE: don't forget to update the table in gstquery.c when changing
110 GST_QUERY_UNKNOWN = GST_QUERY_MAKE_TYPE (0, 0),
111 GST_QUERY_POSITION = GST_QUERY_MAKE_TYPE (10, _FLAG(BOTH)),
112 GST_QUERY_DURATION = GST_QUERY_MAKE_TYPE (20, _FLAG(BOTH)),
113 GST_QUERY_LATENCY = GST_QUERY_MAKE_TYPE (30, _FLAG(BOTH)),
114 GST_QUERY_JITTER = GST_QUERY_MAKE_TYPE (40, _FLAG(BOTH)),
115 GST_QUERY_RATE = GST_QUERY_MAKE_TYPE (50, _FLAG(BOTH)),
116 GST_QUERY_SEEKING = GST_QUERY_MAKE_TYPE (60, _FLAG(BOTH)),
117 GST_QUERY_SEGMENT = GST_QUERY_MAKE_TYPE (70, _FLAG(BOTH)),
118 GST_QUERY_CONVERT = GST_QUERY_MAKE_TYPE (80, _FLAG(BOTH)),
119 GST_QUERY_FORMATS = GST_QUERY_MAKE_TYPE (90, _FLAG(BOTH)),
120 GST_QUERY_BUFFERING = GST_QUERY_MAKE_TYPE (110, _FLAG(BOTH)),
121 GST_QUERY_CUSTOM = GST_QUERY_MAKE_TYPE (120, _FLAG(BOTH)),
122 GST_QUERY_URI = GST_QUERY_MAKE_TYPE (130, _FLAG(BOTH)),
123 GST_QUERY_ALLOCATION = GST_QUERY_MAKE_TYPE (140, _FLAG(DOWNSTREAM) | _FLAG(SERIALIZED)),
124 GST_QUERY_SCHEDULING = GST_QUERY_MAKE_TYPE (150, _FLAG(UPSTREAM)),
125 GST_QUERY_ACCEPT_CAPS = GST_QUERY_MAKE_TYPE (160, _FLAG(BOTH)),
126 GST_QUERY_CAPS = GST_QUERY_MAKE_TYPE (170, _FLAG(BOTH)),
127 GST_QUERY_DRAIN = GST_QUERY_MAKE_TYPE (180, _FLAG(DOWNSTREAM) | _FLAG(SERIALIZED)),
128 GST_QUERY_CONTEXT = GST_QUERY_MAKE_TYPE (190, _FLAG(BOTH)),
129 GST_QUERY_BITRATE = GST_QUERY_MAKE_TYPE (200, _FLAG(DOWNSTREAM)),
132 * GST_QUERY_SELECTABLE:
134 * Query stream selection capability.
138 GST_QUERY_SELECTABLE = GST_QUERY_MAKE_TYPE (210, _FLAG(BOTH)),
142 GST_API GType _gst_query_type;
144 #define GST_TYPE_QUERY (_gst_query_type)
145 #define GST_IS_QUERY(obj) (GST_IS_MINI_OBJECT_TYPE (obj, GST_TYPE_QUERY))
146 #define GST_QUERY_CAST(obj) ((GstQuery*)(obj))
147 #define GST_QUERY(obj) (GST_QUERY_CAST(obj))
151 * @query: the query to query
153 * Get the #GstQueryType of the query.
155 #define GST_QUERY_TYPE(query) (((GstQuery*)(query))->type)
158 * GST_QUERY_TYPE_NAME:
159 * @query: the query to query
161 * Get a constant string representation of the #GstQueryType of the query.
163 #define GST_QUERY_TYPE_NAME(query) (gst_query_type_get_name(GST_QUERY_TYPE(query)))
166 * GST_QUERY_IS_UPSTREAM:
167 * @ev: the query to query
169 * Check if an query can travel upstream.
171 #define GST_QUERY_IS_UPSTREAM(ev) !!(GST_QUERY_TYPE (ev) & GST_QUERY_TYPE_UPSTREAM)
173 * GST_QUERY_IS_DOWNSTREAM:
174 * @ev: the query to query
176 * Check if an query can travel downstream.
178 #define GST_QUERY_IS_DOWNSTREAM(ev) !!(GST_QUERY_TYPE (ev) & GST_QUERY_TYPE_DOWNSTREAM)
180 * GST_QUERY_IS_SERIALIZED:
181 * @ev: the query to query
183 * Check if an query is serialized with the data stream.
185 #define GST_QUERY_IS_SERIALIZED(ev) !!(GST_QUERY_TYPE (ev) & GST_QUERY_TYPE_SERIALIZED)
190 * @mini_object: The parent #GstMiniObject type
191 * @type: the #GstQueryType
193 * The #GstQuery structure.
197 GstMiniObject mini_object;
199 /*< public > *//* with COW */
205 * @GST_BUFFERING_STREAM: a small amount of data is buffered
206 * @GST_BUFFERING_DOWNLOAD: the stream is being downloaded
207 * @GST_BUFFERING_TIMESHIFT: the stream is being downloaded in a ringbuffer
208 * @GST_BUFFERING_LIVE: the stream is a live stream
210 * The different types of buffering methods.
213 GST_BUFFERING_STREAM,
214 GST_BUFFERING_DOWNLOAD,
215 GST_BUFFERING_TIMESHIFT,
219 #include <gst/gstiterator.h>
220 #include <gst/gststructure.h>
221 #include <gst/gstformat.h>
222 #include <gst/gstpad.h>
223 #include <gst/gstallocator.h>
224 #include <gst/gsttoc.h>
225 #include <gst/gstcontext.h>
228 const gchar* gst_query_type_get_name (GstQueryType type);
231 GQuark gst_query_type_to_quark (GstQueryType type);
235 gst_query_type_get_flags (GstQueryType type);
239 GType gst_query_get_type (void);
241 #ifndef GST_DISABLE_MINIOBJECT_INLINE_FUNCTIONS
243 static inline GstQuery *
244 gst_query_ref (GstQuery * q)
246 return GST_QUERY_CAST (gst_mini_object_ref (GST_MINI_OBJECT_CAST (q)));
250 gst_query_unref (GstQuery * q)
252 gst_mini_object_unref (GST_MINI_OBJECT_CAST (q));
256 gst_clear_query (GstQuery ** query_ptr)
258 gst_clear_mini_object ((GstMiniObject **) query_ptr);
262 static inline GstQuery *
263 gst_query_copy (const GstQuery * q)
265 return GST_QUERY_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (q)));
267 #else /* GST_DISABLE_MINIOBJECT_INLINE_FUNCTIONS */
269 GstQuery * gst_query_ref (GstQuery * q);
272 void gst_query_unref (GstQuery * q);
275 void gst_clear_query (GstQuery ** query_ptr);
278 GstQuery * gst_query_copy (const GstQuery * q);
279 #endif /* GST_DISABLE_MINIOBJECT_INLINE_FUNCTIONS */
282 * gst_query_is_writable:
285 * Tests if you can safely write data into a query's structure.
287 #define gst_query_is_writable(q) gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (q))
289 * gst_query_make_writable:
290 * @q: (transfer full): a #GstQuery to make writable
292 * Makes a writable query from the given query.
294 * Returns: (transfer full): a new writable query (possibly same as @q)
296 #define gst_query_make_writable(q) GST_QUERY_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (q)))
298 #ifndef GST_DISABLE_MINIOBJECT_INLINE_FUNCTIONS
299 static inline gboolean
300 gst_query_replace (GstQuery **old_query, GstQuery *new_query)
302 return gst_mini_object_replace ((GstMiniObject **) old_query, (GstMiniObject *) new_query);
305 static inline gboolean
306 gst_query_take (GstQuery **old_query, GstQuery *new_query)
308 return gst_mini_object_take ((GstMiniObject **) old_query,
309 (GstMiniObject *) new_query);
311 #else /* GST_DISABLE_MINIOBJECT_INLINE_FUNCTIONS */
313 gboolean gst_query_replace (GstQuery ** old_query,
314 GstQuery * new_query);
317 gboolean gst_query_take (GstQuery ** old_query,
318 GstQuery * new_query);
319 #endif /* GST_DISABLE_MINIOBJECT_INLINE_FUNCTIONS */
321 /* application specific query */
324 GstQuery * gst_query_new_custom (GstQueryType type, GstStructure *structure) G_GNUC_MALLOC;
328 gst_query_get_structure (GstQuery *query);
331 GstStructure * gst_query_writable_structure (GstQuery *query);
336 GstQuery* gst_query_new_position (GstFormat format) G_GNUC_MALLOC;
339 void gst_query_set_position (GstQuery *query, GstFormat format, gint64 cur);
342 void gst_query_parse_position (GstQuery *query, GstFormat *format, gint64 *cur);
347 GstQuery* gst_query_new_duration (GstFormat format) G_GNUC_MALLOC;
350 void gst_query_set_duration (GstQuery *query, GstFormat format, gint64 duration);
353 void gst_query_parse_duration (GstQuery *query, GstFormat *format, gint64 *duration);
358 GstQuery* gst_query_new_latency (void) G_GNUC_MALLOC;
361 void gst_query_set_latency (GstQuery *query, gboolean live, GstClockTime min_latency,
362 GstClockTime max_latency);
365 void gst_query_parse_latency (GstQuery *query, gboolean *live, GstClockTime *min_latency,
366 GstClockTime *max_latency);
371 GstQuery* gst_query_new_convert (GstFormat src_format, gint64 value, GstFormat dest_format) G_GNUC_MALLOC;
374 void gst_query_set_convert (GstQuery *query, GstFormat src_format, gint64 src_value,
375 GstFormat dest_format, gint64 dest_value);
378 void gst_query_parse_convert (GstQuery *query, GstFormat *src_format, gint64 *src_value,
379 GstFormat *dest_format, gint64 *dest_value);
383 GstQuery* gst_query_new_segment (GstFormat format) G_GNUC_MALLOC;
386 void gst_query_set_segment (GstQuery *query, gdouble rate, GstFormat format,
387 gint64 start_value, gint64 stop_value);
390 void gst_query_parse_segment (GstQuery *query, gdouble *rate, GstFormat *format,
391 gint64 *start_value, gint64 *stop_value);
396 GstQuery* gst_query_new_seeking (GstFormat format) G_GNUC_MALLOC;
399 void gst_query_set_seeking (GstQuery *query, GstFormat format,
401 gint64 segment_start,
405 void gst_query_parse_seeking (GstQuery *query, GstFormat *format,
407 gint64 *segment_start,
408 gint64 *segment_end);
412 GstQuery* gst_query_new_formats (void) G_GNUC_MALLOC;
415 void gst_query_set_formats (GstQuery *query, gint n_formats, ...);
418 void gst_query_set_formatsv (GstQuery *query, gint n_formats, const GstFormat *formats);
421 void gst_query_parse_n_formats (GstQuery *query, guint *n_formats);
424 void gst_query_parse_nth_format (GstQuery *query, guint nth, GstFormat *format);
426 /* buffering query */
429 GstQuery* gst_query_new_buffering (GstFormat format) G_GNUC_MALLOC;
432 void gst_query_set_buffering_percent (GstQuery *query, gboolean busy, gint percent);
435 void gst_query_parse_buffering_percent (GstQuery *query, gboolean *busy, gint *percent);
438 void gst_query_set_buffering_stats (GstQuery *query, GstBufferingMode mode,
439 gint avg_in, gint avg_out,
440 gint64 buffering_left);
443 void gst_query_parse_buffering_stats (GstQuery *query, GstBufferingMode *mode,
444 gint *avg_in, gint *avg_out,
445 gint64 *buffering_left);
448 void gst_query_set_buffering_range (GstQuery *query, GstFormat format,
449 gint64 start, gint64 stop,
450 gint64 estimated_total);
453 void gst_query_parse_buffering_range (GstQuery *query, GstFormat *format,
454 gint64 *start, gint64 *stop,
455 gint64 *estimated_total);
458 gboolean gst_query_add_buffering_range (GstQuery *query,
459 gint64 start, gint64 stop);
462 guint gst_query_get_n_buffering_ranges (GstQuery *query);
465 gboolean gst_query_parse_nth_buffering_range (GstQuery *query,
466 guint index, gint64 *start,
472 GstQuery * gst_query_new_uri (void) G_GNUC_MALLOC;
475 void gst_query_parse_uri (GstQuery *query, gchar **uri);
478 void gst_query_set_uri (GstQuery *query, const gchar *uri);
481 void gst_query_parse_uri_redirection (GstQuery *query, gchar **uri);
484 void gst_query_set_uri_redirection (GstQuery *query, const gchar *uri);
487 void gst_query_parse_uri_redirection_permanent (GstQuery *query, gboolean * permanent);
490 void gst_query_set_uri_redirection_permanent (GstQuery *query, gboolean permanent);
492 /* allocation query */
495 GstQuery * gst_query_new_allocation (GstCaps *caps, gboolean need_pool) G_GNUC_MALLOC;
498 void gst_query_parse_allocation (GstQuery *query, GstCaps **caps, gboolean *need_pool);
503 void gst_query_add_allocation_pool (GstQuery *query, GstBufferPool *pool,
504 guint size, guint min_buffers,
508 guint gst_query_get_n_allocation_pools (GstQuery *query);
511 void gst_query_parse_nth_allocation_pool (GstQuery *query, guint index,
512 GstBufferPool **pool,
513 guint *size, guint *min_buffers,
517 void gst_query_set_nth_allocation_pool (GstQuery *query, guint index,
519 guint size, guint min_buffers,
523 void gst_query_remove_nth_allocation_pool (GstQuery *query, guint index);
528 void gst_query_add_allocation_param (GstQuery *query, GstAllocator *allocator,
529 const GstAllocationParams *params);
532 guint gst_query_get_n_allocation_params (GstQuery *query);
535 void gst_query_parse_nth_allocation_param (GstQuery *query, guint index,
536 GstAllocator **allocator,
537 GstAllocationParams *params);
540 void gst_query_set_nth_allocation_param (GstQuery *query, guint index,
541 GstAllocator *allocator,
542 const GstAllocationParams *params);
545 void gst_query_remove_nth_allocation_param (GstQuery *query, guint index);
550 void gst_query_add_allocation_meta (GstQuery *query, GType api, const GstStructure *params);
553 guint gst_query_get_n_allocation_metas (GstQuery *query);
556 GType gst_query_parse_nth_allocation_meta (GstQuery *query, guint index,
557 const GstStructure **params);
560 void gst_query_remove_nth_allocation_meta (GstQuery *query, guint index);
563 gboolean gst_query_find_allocation_meta (GstQuery *query, GType api, guint *index);
566 /* scheduling query */
568 * GstSchedulingFlags:
569 * @GST_SCHEDULING_FLAG_SEEKABLE: if seeking is possible
570 * @GST_SCHEDULING_FLAG_SEQUENTIAL: if sequential access is recommended
571 * @GST_SCHEDULING_FLAG_BANDWIDTH_LIMITED: if bandwidth is limited and buffering possible (since 1.2)
573 * The different scheduling flags.
576 GST_SCHEDULING_FLAG_SEEKABLE = (1 << 0),
577 GST_SCHEDULING_FLAG_SEQUENTIAL = (1 << 1),
578 GST_SCHEDULING_FLAG_BANDWIDTH_LIMITED = (1 << 2)
579 } GstSchedulingFlags;
582 GstQuery * gst_query_new_scheduling (void) G_GNUC_MALLOC;
585 void gst_query_set_scheduling (GstQuery *query, GstSchedulingFlags flags,
586 gint minsize, gint maxsize, gint align);
589 void gst_query_parse_scheduling (GstQuery *query, GstSchedulingFlags *flags,
590 gint *minsize, gint *maxsize, gint *align);
593 void gst_query_add_scheduling_mode (GstQuery *query, GstPadMode mode);
596 guint gst_query_get_n_scheduling_modes (GstQuery *query);
599 GstPadMode gst_query_parse_nth_scheduling_mode (GstQuery *query, guint index);
602 gboolean gst_query_has_scheduling_mode (GstQuery *query, GstPadMode mode);
605 gboolean gst_query_has_scheduling_mode_with_flags (GstQuery * query, GstPadMode mode,
606 GstSchedulingFlags flags);
608 /* accept-caps query */
611 GstQuery * gst_query_new_accept_caps (GstCaps *caps) G_GNUC_MALLOC;
614 void gst_query_parse_accept_caps (GstQuery *query, GstCaps **caps);
617 void gst_query_set_accept_caps_result (GstQuery *query, gboolean result);
620 void gst_query_parse_accept_caps_result (GstQuery *query, gboolean *result);
625 GstQuery * gst_query_new_caps (GstCaps *filter) G_GNUC_MALLOC;
628 void gst_query_parse_caps (GstQuery *query, GstCaps **filter);
631 void gst_query_set_caps_result (GstQuery *query, GstCaps *caps);
634 void gst_query_parse_caps_result (GstQuery *query, GstCaps **caps);
639 GstQuery * gst_query_new_drain (void) G_GNUC_MALLOC;
644 GstQuery * gst_query_new_context (const gchar * context_type) G_GNUC_MALLOC;
647 gboolean gst_query_parse_context_type (GstQuery * query, const gchar ** context_type);
650 void gst_query_set_context (GstQuery *query, GstContext *context);
653 void gst_query_parse_context (GstQuery *query, GstContext **context);
658 GstQuery * gst_query_new_bitrate (void) G_GNUC_MALLOC;
661 void gst_query_set_bitrate (GstQuery * query, guint nominal_bitrate);
664 void gst_query_parse_bitrate (GstQuery * query, guint * nominal_bitrate);
666 /* selectable query */
669 GstQuery * gst_query_new_selectable (void) G_GNUC_MALLOC;
672 void gst_query_set_selectable (GstQuery *query, gboolean selectable);
675 void gst_query_parse_selectable (GstQuery *query, gboolean * selectable);
677 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstQuery, gst_query_unref)
681 #endif /* __GST_QUERY_H__ */