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)
103 * Standard predefined Query types
105 /* NOTE: don't forget to update the table in gstquery.c when changing
108 GST_QUERY_UNKNOWN = GST_QUERY_MAKE_TYPE (0, 0),
109 GST_QUERY_POSITION = GST_QUERY_MAKE_TYPE (10, FLAG(BOTH)),
110 GST_QUERY_DURATION = GST_QUERY_MAKE_TYPE (20, FLAG(BOTH)),
111 GST_QUERY_LATENCY = GST_QUERY_MAKE_TYPE (30, FLAG(BOTH)),
112 GST_QUERY_JITTER = GST_QUERY_MAKE_TYPE (40, FLAG(BOTH)),
113 GST_QUERY_RATE = GST_QUERY_MAKE_TYPE (50, FLAG(BOTH)),
114 GST_QUERY_SEEKING = GST_QUERY_MAKE_TYPE (60, FLAG(BOTH)),
115 GST_QUERY_SEGMENT = GST_QUERY_MAKE_TYPE (70, FLAG(BOTH)),
116 GST_QUERY_CONVERT = GST_QUERY_MAKE_TYPE (80, FLAG(BOTH)),
117 GST_QUERY_FORMATS = GST_QUERY_MAKE_TYPE (90, FLAG(BOTH)),
118 GST_QUERY_BUFFERING = GST_QUERY_MAKE_TYPE (110, FLAG(BOTH)),
119 GST_QUERY_CUSTOM = GST_QUERY_MAKE_TYPE (120, FLAG(BOTH)),
120 GST_QUERY_URI = GST_QUERY_MAKE_TYPE (130, FLAG(BOTH)),
121 GST_QUERY_ALLOCATION = GST_QUERY_MAKE_TYPE (140, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),
122 GST_QUERY_SCHEDULING = GST_QUERY_MAKE_TYPE (150, FLAG(UPSTREAM)),
123 GST_QUERY_ACCEPT_CAPS = GST_QUERY_MAKE_TYPE (160, FLAG(BOTH)),
124 GST_QUERY_CAPS = GST_QUERY_MAKE_TYPE (170, FLAG(BOTH)),
125 GST_QUERY_DRAIN = GST_QUERY_MAKE_TYPE (180, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),
126 GST_QUERY_CONTEXT = GST_QUERY_MAKE_TYPE (190, FLAG(BOTH))
130 GST_API GType _gst_query_type;
132 #define GST_TYPE_QUERY (_gst_query_type)
133 #define GST_IS_QUERY(obj) (GST_IS_MINI_OBJECT_TYPE (obj, GST_TYPE_QUERY))
134 #define GST_QUERY_CAST(obj) ((GstQuery*)(obj))
135 #define GST_QUERY(obj) (GST_QUERY_CAST(obj))
139 * @query: the query to query
141 * Get the #GstQueryType of the query.
143 #define GST_QUERY_TYPE(query) (((GstQuery*)(query))->type)
146 * GST_QUERY_TYPE_NAME:
147 * @query: the query to query
149 * Get a constant string representation of the #GstQueryType of the query.
151 #define GST_QUERY_TYPE_NAME(query) (gst_query_type_get_name(GST_QUERY_TYPE(query)))
154 * GST_QUERY_IS_UPSTREAM:
155 * @ev: the query to query
157 * Check if an query can travel upstream.
159 #define GST_QUERY_IS_UPSTREAM(ev) !!(GST_QUERY_TYPE (ev) & GST_QUERY_TYPE_UPSTREAM)
161 * GST_QUERY_IS_DOWNSTREAM:
162 * @ev: the query to query
164 * Check if an query can travel downstream.
166 #define GST_QUERY_IS_DOWNSTREAM(ev) !!(GST_QUERY_TYPE (ev) & GST_QUERY_TYPE_DOWNSTREAM)
168 * GST_QUERY_IS_SERIALIZED:
169 * @ev: the query to query
171 * Check if an query is serialized with the data stream.
173 #define GST_QUERY_IS_SERIALIZED(ev) !!(GST_QUERY_TYPE (ev) & GST_QUERY_TYPE_SERIALIZED)
178 * @mini_object: The parent #GstMiniObject type
179 * @type: the #GstQueryType
181 * The #GstQuery structure.
185 GstMiniObject mini_object;
187 /*< public > *//* with COW */
193 * @GST_BUFFERING_STREAM: a small amount of data is buffered
194 * @GST_BUFFERING_DOWNLOAD: the stream is being downloaded
195 * @GST_BUFFERING_TIMESHIFT: the stream is being downloaded in a ringbuffer
196 * @GST_BUFFERING_LIVE: the stream is a live stream
198 * The different types of buffering methods.
201 GST_BUFFERING_STREAM,
202 GST_BUFFERING_DOWNLOAD,
203 GST_BUFFERING_TIMESHIFT,
207 #include <gst/gstiterator.h>
208 #include <gst/gststructure.h>
209 #include <gst/gstformat.h>
210 #include <gst/gstpad.h>
211 #include <gst/gstallocator.h>
212 #include <gst/gsttoc.h>
213 #include <gst/gstcontext.h>
216 const gchar* gst_query_type_get_name (GstQueryType type);
219 GQuark gst_query_type_to_quark (GstQueryType type);
223 gst_query_type_get_flags (GstQueryType type);
227 GType gst_query_get_type (void);
232 * @q: a #GstQuery to increase the refcount of.
234 * Increases the refcount of the given query by one.
238 static inline GstQuery *
239 gst_query_ref (GstQuery * q)
241 return GST_QUERY_CAST (gst_mini_object_ref (GST_MINI_OBJECT_CAST (q)));
246 * @q: a #GstQuery to decrease the refcount of.
248 * Decreases the refcount of the query. If the refcount reaches 0, the query
252 gst_query_unref (GstQuery * q)
254 gst_mini_object_unref (GST_MINI_OBJECT_CAST (q));
258 * gst_clear_query: (skip)
259 * @query_ptr: a pointer to a #GstQuery reference
261 * Clears a reference to a #GstQuery.
263 * @query_ptr must not be %NULL.
265 * If the reference is %NULL then this function does nothing. Otherwise, the
266 * reference count of the query is decreased and the pointer is set to %NULL.
271 gst_clear_query (GstQuery ** query_ptr)
273 gst_clear_mini_object (query_ptr);
279 * @q: a #GstQuery to copy.
281 * Copies the given query using the copy function of the parent #GstStructure.
283 * Free-function: gst_query_unref
285 * Returns: (transfer full): a new copy of @q.
287 static inline GstQuery *
288 gst_query_copy (const GstQuery * q)
290 return GST_QUERY_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (q)));
294 * gst_query_is_writable:
297 * Tests if you can safely write data into a query's structure.
299 #define gst_query_is_writable(q) gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (q))
301 * gst_query_make_writable:
302 * @q: (transfer full): a #GstQuery to make writable
304 * Makes a writable query from the given query.
306 * Returns: (transfer full): a new writable query (possibly same as @q)
308 #define gst_query_make_writable(q) GST_QUERY_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (q)))
311 * @old_query: (inout) (transfer full) (nullable): pointer to a pointer to a
312 * #GstQuery to be replaced.
313 * @new_query: (allow-none) (transfer none): pointer to a #GstQuery that will
314 * replace the query pointed to by @old_query.
316 * Modifies a pointer to a #GstQuery to point to a different #GstQuery. The
317 * modification is done atomically (so this is useful for ensuring thread safety
318 * in some cases), and the reference counts are updated appropriately (the old
319 * query is unreffed, the new one is reffed).
321 * Either @new_query or the #GstQuery pointed to by @old_query may be %NULL.
323 * Returns: %TRUE if @new_query was different from @old_query
325 static inline gboolean
326 gst_query_replace (GstQuery **old_query, GstQuery *new_query)
328 return gst_mini_object_replace ((GstMiniObject **) old_query, (GstMiniObject *) new_query);
331 /* application specific query */
334 GstQuery * gst_query_new_custom (GstQueryType type, GstStructure *structure) G_GNUC_MALLOC;
338 gst_query_get_structure (GstQuery *query);
341 GstStructure * gst_query_writable_structure (GstQuery *query);
346 GstQuery* gst_query_new_position (GstFormat format) G_GNUC_MALLOC;
349 void gst_query_set_position (GstQuery *query, GstFormat format, gint64 cur);
352 void gst_query_parse_position (GstQuery *query, GstFormat *format, gint64 *cur);
357 GstQuery* gst_query_new_duration (GstFormat format) G_GNUC_MALLOC;
360 void gst_query_set_duration (GstQuery *query, GstFormat format, gint64 duration);
363 void gst_query_parse_duration (GstQuery *query, GstFormat *format, gint64 *duration);
368 GstQuery* gst_query_new_latency (void) G_GNUC_MALLOC;
371 void gst_query_set_latency (GstQuery *query, gboolean live, GstClockTime min_latency,
372 GstClockTime max_latency);
375 void gst_query_parse_latency (GstQuery *query, gboolean *live, GstClockTime *min_latency,
376 GstClockTime *max_latency);
381 GstQuery* gst_query_new_convert (GstFormat src_format, gint64 value, GstFormat dest_format) G_GNUC_MALLOC;
384 void gst_query_set_convert (GstQuery *query, GstFormat src_format, gint64 src_value,
385 GstFormat dest_format, gint64 dest_value);
388 void gst_query_parse_convert (GstQuery *query, GstFormat *src_format, gint64 *src_value,
389 GstFormat *dest_format, gint64 *dest_value);
393 GstQuery* gst_query_new_segment (GstFormat format) G_GNUC_MALLOC;
396 void gst_query_set_segment (GstQuery *query, gdouble rate, GstFormat format,
397 gint64 start_value, gint64 stop_value);
400 void gst_query_parse_segment (GstQuery *query, gdouble *rate, GstFormat *format,
401 gint64 *start_value, gint64 *stop_value);
406 GstQuery* gst_query_new_seeking (GstFormat format) G_GNUC_MALLOC;
409 void gst_query_set_seeking (GstQuery *query, GstFormat format,
411 gint64 segment_start,
415 void gst_query_parse_seeking (GstQuery *query, GstFormat *format,
417 gint64 *segment_start,
418 gint64 *segment_end);
422 GstQuery* gst_query_new_formats (void) G_GNUC_MALLOC;
425 void gst_query_set_formats (GstQuery *query, gint n_formats, ...);
428 void gst_query_set_formatsv (GstQuery *query, gint n_formats, const GstFormat *formats);
431 void gst_query_parse_n_formats (GstQuery *query, guint *n_formats);
434 void gst_query_parse_nth_format (GstQuery *query, guint nth, GstFormat *format);
436 /* buffering query */
439 GstQuery* gst_query_new_buffering (GstFormat format) G_GNUC_MALLOC;
442 void gst_query_set_buffering_percent (GstQuery *query, gboolean busy, gint percent);
445 void gst_query_parse_buffering_percent (GstQuery *query, gboolean *busy, gint *percent);
448 void gst_query_set_buffering_stats (GstQuery *query, GstBufferingMode mode,
449 gint avg_in, gint avg_out,
450 gint64 buffering_left);
453 void gst_query_parse_buffering_stats (GstQuery *query, GstBufferingMode *mode,
454 gint *avg_in, gint *avg_out,
455 gint64 *buffering_left);
458 void gst_query_set_buffering_range (GstQuery *query, GstFormat format,
459 gint64 start, gint64 stop,
460 gint64 estimated_total);
463 void gst_query_parse_buffering_range (GstQuery *query, GstFormat *format,
464 gint64 *start, gint64 *stop,
465 gint64 *estimated_total);
468 gboolean gst_query_add_buffering_range (GstQuery *query,
469 gint64 start, gint64 stop);
472 guint gst_query_get_n_buffering_ranges (GstQuery *query);
475 gboolean gst_query_parse_nth_buffering_range (GstQuery *query,
476 guint index, gint64 *start,
482 GstQuery * gst_query_new_uri (void) G_GNUC_MALLOC;
485 void gst_query_parse_uri (GstQuery *query, gchar **uri);
488 void gst_query_set_uri (GstQuery *query, const gchar *uri);
491 void gst_query_parse_uri_redirection (GstQuery *query, gchar **uri);
494 void gst_query_set_uri_redirection (GstQuery *query, const gchar *uri);
497 void gst_query_parse_uri_redirection_permanent (GstQuery *query, gboolean * permanent);
500 void gst_query_set_uri_redirection_permanent (GstQuery *query, gboolean permanent);
502 /* allocation query */
505 GstQuery * gst_query_new_allocation (GstCaps *caps, gboolean need_pool) G_GNUC_MALLOC;
508 void gst_query_parse_allocation (GstQuery *query, GstCaps **caps, gboolean *need_pool);
513 void gst_query_add_allocation_pool (GstQuery *query, GstBufferPool *pool,
514 guint size, guint min_buffers,
518 guint gst_query_get_n_allocation_pools (GstQuery *query);
521 void gst_query_parse_nth_allocation_pool (GstQuery *query, guint index,
522 GstBufferPool **pool,
523 guint *size, guint *min_buffers,
527 void gst_query_set_nth_allocation_pool (GstQuery *query, guint index,
529 guint size, guint min_buffers,
533 void gst_query_remove_nth_allocation_pool (GstQuery *query, guint index);
538 void gst_query_add_allocation_param (GstQuery *query, GstAllocator *allocator,
539 const GstAllocationParams *params);
542 guint gst_query_get_n_allocation_params (GstQuery *query);
545 void gst_query_parse_nth_allocation_param (GstQuery *query, guint index,
546 GstAllocator **allocator,
547 GstAllocationParams *params);
550 void gst_query_set_nth_allocation_param (GstQuery *query, guint index,
551 GstAllocator *allocator,
552 const GstAllocationParams *params);
555 void gst_query_remove_nth_allocation_param (GstQuery *query, guint index);
560 void gst_query_add_allocation_meta (GstQuery *query, GType api, const GstStructure *params);
563 guint gst_query_get_n_allocation_metas (GstQuery *query);
566 GType gst_query_parse_nth_allocation_meta (GstQuery *query, guint index,
567 const GstStructure **params);
570 void gst_query_remove_nth_allocation_meta (GstQuery *query, guint index);
573 gboolean gst_query_find_allocation_meta (GstQuery *query, GType api, guint *index);
576 /* scheduling query */
578 * GstSchedulingFlags:
579 * @GST_SCHEDULING_FLAG_SEEKABLE: if seeking is possible
580 * @GST_SCHEDULING_FLAG_SEQUENTIAL: if sequential access is recommended
581 * @GST_SCHEDULING_FLAG_BANDWIDTH_LIMITED: if bandwidth is limited and buffering possible (since 1.2)
583 * The different scheduling flags.
586 GST_SCHEDULING_FLAG_SEEKABLE = (1 << 0),
587 GST_SCHEDULING_FLAG_SEQUENTIAL = (1 << 1),
588 GST_SCHEDULING_FLAG_BANDWIDTH_LIMITED = (1 << 2)
589 } GstSchedulingFlags;
592 GstQuery * gst_query_new_scheduling (void) G_GNUC_MALLOC;
595 void gst_query_set_scheduling (GstQuery *query, GstSchedulingFlags flags,
596 gint minsize, gint maxsize, gint align);
599 void gst_query_parse_scheduling (GstQuery *query, GstSchedulingFlags *flags,
600 gint *minsize, gint *maxsize, gint *align);
603 void gst_query_add_scheduling_mode (GstQuery *query, GstPadMode mode);
606 guint gst_query_get_n_scheduling_modes (GstQuery *query);
609 GstPadMode gst_query_parse_nth_scheduling_mode (GstQuery *query, guint index);
612 gboolean gst_query_has_scheduling_mode (GstQuery *query, GstPadMode mode);
615 gboolean gst_query_has_scheduling_mode_with_flags (GstQuery * query, GstPadMode mode,
616 GstSchedulingFlags flags);
618 /* accept-caps query */
621 GstQuery * gst_query_new_accept_caps (GstCaps *caps) G_GNUC_MALLOC;
624 void gst_query_parse_accept_caps (GstQuery *query, GstCaps **caps);
627 void gst_query_set_accept_caps_result (GstQuery *query, gboolean result);
630 void gst_query_parse_accept_caps_result (GstQuery *query, gboolean *result);
635 GstQuery * gst_query_new_caps (GstCaps *filter) G_GNUC_MALLOC;
638 void gst_query_parse_caps (GstQuery *query, GstCaps **filter);
641 void gst_query_set_caps_result (GstQuery *query, GstCaps *caps);
644 void gst_query_parse_caps_result (GstQuery *query, GstCaps **caps);
649 GstQuery * gst_query_new_drain (void) G_GNUC_MALLOC;
654 GstQuery * gst_query_new_context (const gchar * context_type) G_GNUC_MALLOC;
657 gboolean gst_query_parse_context_type (GstQuery * query, const gchar ** context_type);
660 void gst_query_set_context (GstQuery *query, GstContext *context);
663 void gst_query_parse_context (GstQuery *query, GstContext **context);
665 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
666 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstQuery, gst_query_unref)
671 #endif /* __GST_QUERY_H__ */