gstvalue: Do more checks when guessing at flagset strings
[platform/upstream/gstreamer.git] / gst / gstquery.h
1 /* GStreamer
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>
6  *
7  * gstquery.h: GstQuery API declaration
8  *
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.
13  *
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.
18  *
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.
23  */
24
25
26 #ifndef __GST_QUERY_H__
27 #define __GST_QUERY_H__
28
29 #include <glib.h>
30 #include <glib-object.h>
31 #include <gst/gstconfig.h>
32
33 G_BEGIN_DECLS
34
35 typedef struct _GstQuery GstQuery;
36
37 #include <gst/gstminiobject.h>
38
39 /**
40  * GstQueryTypeFlags:
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
44  *                               flow.
45  *
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.
49  */
50 typedef enum {
51   GST_QUERY_TYPE_UPSTREAM       = 1 << 0,
52   GST_QUERY_TYPE_DOWNSTREAM     = 1 << 1,
53   GST_QUERY_TYPE_SERIALIZED     = 1 << 2
54 } GstQueryTypeFlags;
55
56 /**
57  * GST_QUERY_TYPE_BOTH:
58  *
59  * The same thing as #GST_QUERY_TYPE_UPSTREAM | #GST_QUERY_TYPE_DOWNSTREAM.
60  */
61 #define GST_QUERY_TYPE_BOTH \
62     (GST_QUERY_TYPE_UPSTREAM | GST_QUERY_TYPE_DOWNSTREAM)
63
64 #define GST_QUERY_NUM_SHIFT     (8)
65
66 /**
67  * GST_QUERY_MAKE_TYPE:
68  * @num: the query number to create
69  * @flags: the query flags
70  *
71  * when making custom query types, use this macro with the num and
72  * the given flags
73  */
74 #define GST_QUERY_MAKE_TYPE(num,flags) \
75     (((num) << GST_QUERY_NUM_SHIFT) | (flags))
76
77 #define FLAG(name) GST_QUERY_TYPE_##name
78
79
80 /**
81  * GstQueryType:
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  *
103  * Standard predefined Query types
104  */
105 /* NOTE: don't forget to update the table in gstquery.c when changing
106  * this enum */
107 typedef enum {
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))
127 } GstQueryType;
128 #undef FLAG
129
130 GST_EXPORT GType _gst_query_type;
131
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))
136
137 /**
138  * GST_QUERY_TYPE:
139  * @query: the query to query
140  *
141  * Get the #GstQueryType of the query.
142  */
143 #define GST_QUERY_TYPE(query)  (((GstQuery*)(query))->type)
144
145 /**
146  * GST_QUERY_TYPE_NAME:
147  * @query: the query to query
148  *
149  * Get a constant string representation of the #GstQueryType of the query.
150  */
151 #define GST_QUERY_TYPE_NAME(query) (gst_query_type_get_name(GST_QUERY_TYPE(query)))
152
153 /**
154  * GST_QUERY_IS_UPSTREAM:
155  * @ev: the query to query
156  *
157  * Check if an query can travel upstream.
158  */
159 #define GST_QUERY_IS_UPSTREAM(ev)       !!(GST_QUERY_TYPE (ev) & GST_QUERY_TYPE_UPSTREAM)
160 /**
161  * GST_QUERY_IS_DOWNSTREAM:
162  * @ev: the query to query
163  *
164  * Check if an query can travel downstream.
165  */
166 #define GST_QUERY_IS_DOWNSTREAM(ev)     !!(GST_QUERY_TYPE (ev) & GST_QUERY_TYPE_DOWNSTREAM)
167 /**
168  * GST_QUERY_IS_SERIALIZED:
169  * @ev: the query to query
170  *
171  * Check if an query is serialized with the data stream.
172  */
173 #define GST_QUERY_IS_SERIALIZED(ev)     !!(GST_QUERY_TYPE (ev) & GST_QUERY_TYPE_SERIALIZED)
174
175
176 /**
177  * GstQuery:
178  * @mini_object: The parent #GstMiniObject type
179  * @type: the #GstQueryType
180  *
181  * The #GstQuery structure.
182  */
183 struct _GstQuery
184 {
185   GstMiniObject mini_object;
186
187   /*< public > *//* with COW */
188   GstQueryType type;
189 };
190
191 /**
192  * GstBufferingMode:
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
197  *
198  * The different types of buffering methods.
199  */
200 typedef enum {
201   GST_BUFFERING_STREAM,
202   GST_BUFFERING_DOWNLOAD,
203   GST_BUFFERING_TIMESHIFT,
204   GST_BUFFERING_LIVE
205 } GstBufferingMode;
206
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>
214
215 const gchar*    gst_query_type_get_name        (GstQueryType type);
216 GQuark          gst_query_type_to_quark        (GstQueryType type);
217 GstQueryTypeFlags
218                 gst_query_type_get_flags       (GstQueryType type);
219
220
221 GType           gst_query_get_type             (void);
222
223 /* refcounting */
224 /**
225  * gst_query_ref:
226  * @q: a #GstQuery to increase the refcount of.
227  *
228  * Increases the refcount of the given query by one.
229  *
230  * Returns: @q
231  */
232 static inline GstQuery *
233 gst_query_ref (GstQuery * q)
234 {
235   return GST_QUERY_CAST (gst_mini_object_ref (GST_MINI_OBJECT_CAST (q)));
236 }
237
238 /**
239  * gst_query_unref:
240  * @q: a #GstQuery to decrease the refcount of.
241  *
242  * Decreases the refcount of the query. If the refcount reaches 0, the query
243  * will be freed.
244  */
245 static inline void
246 gst_query_unref (GstQuery * q)
247 {
248   gst_mini_object_unref (GST_MINI_OBJECT_CAST (q));
249 }
250
251 /* copy query */
252 /**
253  * gst_query_copy:
254  * @q: a #GstQuery to copy.
255  *
256  * Copies the given query using the copy function of the parent #GstStructure.
257  *
258  * Free-function: gst_query_unref
259  *
260  * Returns: (transfer full): a new copy of @q.
261  */
262 static inline GstQuery *
263 gst_query_copy (const GstQuery * q)
264 {
265   return GST_QUERY_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (q)));
266 }
267
268 /**
269  * gst_query_is_writable:
270  * @q: a #GstQuery
271  *
272  * Tests if you can safely write data into a query's structure.
273  */
274 #define         gst_query_is_writable(q)     gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (q))
275 /**
276  * gst_query_make_writable:
277  * @q: (transfer full): a #GstQuery to make writable
278  *
279  * Makes a writable query from the given query.
280  *
281  * Returns: (transfer full): a new writable query (possibly same as @q)
282  */
283 #define         gst_query_make_writable(q)      GST_QUERY_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (q)))
284 /**
285  * gst_query_replace:
286  * @old_query: (inout) (transfer full) (nullable): pointer to a pointer to a
287  *     #GstQuery to be replaced.
288  * @new_query: (allow-none) (transfer none): pointer to a #GstQuery that will
289  *     replace the query pointed to by @old_query.
290  *
291  * Modifies a pointer to a #GstQuery to point to a different #GstQuery. The
292  * modification is done atomically (so this is useful for ensuring thread safety
293  * in some cases), and the reference counts are updated appropriately (the old
294  * query is unreffed, the new one is reffed).
295  *
296  * Either @new_query or the #GstQuery pointed to by @old_query may be %NULL.
297  *
298  * Returns: %TRUE if @new_query was different from @old_query
299  */
300 static inline gboolean
301 gst_query_replace (GstQuery **old_query, GstQuery *new_query)
302 {
303   return gst_mini_object_replace ((GstMiniObject **) old_query, (GstMiniObject *) new_query);
304 }
305
306 /* application specific query */
307 GstQuery *      gst_query_new_custom            (GstQueryType type, GstStructure *structure) G_GNUC_MALLOC;
308 const GstStructure *
309                 gst_query_get_structure         (GstQuery *query);
310 GstStructure *  gst_query_writable_structure    (GstQuery *query);
311
312 /* position query */
313 GstQuery*       gst_query_new_position          (GstFormat format) G_GNUC_MALLOC;
314 void            gst_query_set_position          (GstQuery *query, GstFormat format, gint64 cur);
315 void            gst_query_parse_position        (GstQuery *query, GstFormat *format, gint64 *cur);
316
317 /* duration query */
318 GstQuery*       gst_query_new_duration          (GstFormat format) G_GNUC_MALLOC;
319 void            gst_query_set_duration          (GstQuery *query, GstFormat format, gint64 duration);
320 void            gst_query_parse_duration        (GstQuery *query, GstFormat *format, gint64 *duration);
321
322 /* latency query */
323 GstQuery*       gst_query_new_latency           (void) G_GNUC_MALLOC;
324 void            gst_query_set_latency           (GstQuery *query, gboolean live, GstClockTime min_latency,
325                                                  GstClockTime max_latency);
326 void            gst_query_parse_latency         (GstQuery *query, gboolean *live, GstClockTime *min_latency,
327                                                  GstClockTime *max_latency);
328
329 /* convert query */
330 GstQuery*       gst_query_new_convert           (GstFormat src_format, gint64 value, GstFormat dest_format) G_GNUC_MALLOC;
331 void            gst_query_set_convert           (GstQuery *query, GstFormat src_format, gint64 src_value,
332                                                  GstFormat dest_format, gint64 dest_value);
333 void            gst_query_parse_convert         (GstQuery *query, GstFormat *src_format, gint64 *src_value,
334                                                  GstFormat *dest_format, gint64 *dest_value);
335 /* segment query */
336 GstQuery*       gst_query_new_segment           (GstFormat format) G_GNUC_MALLOC;
337 void            gst_query_set_segment           (GstQuery *query, gdouble rate, GstFormat format,
338                                                  gint64 start_value, gint64 stop_value);
339 void            gst_query_parse_segment         (GstQuery *query, gdouble *rate, GstFormat *format,
340                                                  gint64 *start_value, gint64 *stop_value);
341
342 /* seeking query */
343 GstQuery*       gst_query_new_seeking           (GstFormat format) G_GNUC_MALLOC;
344 void            gst_query_set_seeking           (GstQuery *query, GstFormat format,
345                                                  gboolean seekable,
346                                                  gint64 segment_start,
347                                                  gint64 segment_end);
348 void            gst_query_parse_seeking         (GstQuery *query, GstFormat *format,
349                                                  gboolean *seekable,
350                                                  gint64 *segment_start,
351                                                  gint64 *segment_end);
352 /* formats query */
353 GstQuery*       gst_query_new_formats           (void) G_GNUC_MALLOC;
354 void            gst_query_set_formats           (GstQuery *query, gint n_formats, ...);
355 void            gst_query_set_formatsv          (GstQuery *query, gint n_formats, const GstFormat *formats);
356 void            gst_query_parse_n_formats       (GstQuery *query, guint *n_formats);
357 void            gst_query_parse_nth_format      (GstQuery *query, guint nth, GstFormat *format);
358
359 /* buffering query */
360 GstQuery*       gst_query_new_buffering           (GstFormat format) G_GNUC_MALLOC;
361 void            gst_query_set_buffering_percent   (GstQuery *query, gboolean busy, gint percent);
362 void            gst_query_parse_buffering_percent (GstQuery *query, gboolean *busy, gint *percent);
363
364 void            gst_query_set_buffering_stats     (GstQuery *query, GstBufferingMode mode,
365                                                    gint avg_in, gint avg_out,
366                                                    gint64 buffering_left);
367 void            gst_query_parse_buffering_stats    (GstQuery *query, GstBufferingMode *mode,
368                                                    gint *avg_in, gint *avg_out,
369                                                    gint64 *buffering_left);
370
371 void            gst_query_set_buffering_range     (GstQuery *query, GstFormat format,
372                                                    gint64 start, gint64 stop,
373                                                    gint64 estimated_total);
374 void            gst_query_parse_buffering_range   (GstQuery *query, GstFormat *format,
375                                                    gint64 *start, gint64 *stop,
376                                                    gint64 *estimated_total);
377
378 gboolean        gst_query_add_buffering_range       (GstQuery *query,
379                                                      gint64 start, gint64 stop);
380 guint           gst_query_get_n_buffering_ranges    (GstQuery *query);
381 gboolean        gst_query_parse_nth_buffering_range (GstQuery *query,
382                                                      guint index, gint64 *start,
383                                                      gint64 *stop);
384
385 /* URI query */
386 GstQuery *      gst_query_new_uri                    (void) G_GNUC_MALLOC;
387 void            gst_query_parse_uri                  (GstQuery *query, gchar **uri);
388 void            gst_query_set_uri                    (GstQuery *query, const gchar *uri);
389 void            gst_query_parse_uri_redirection      (GstQuery *query, gchar **uri);
390 void            gst_query_set_uri_redirection        (GstQuery *query, const gchar *uri);
391 void            gst_query_parse_uri_redirection_permanent (GstQuery *query, gboolean * permanent);
392 void            gst_query_set_uri_redirection_permanent (GstQuery *query, gboolean permanent);
393
394 /* allocation query */
395 GstQuery *      gst_query_new_allocation             (GstCaps *caps, gboolean need_pool) G_GNUC_MALLOC;
396 void            gst_query_parse_allocation           (GstQuery *query, GstCaps **caps, gboolean *need_pool);
397
398 /* pools */
399 void            gst_query_add_allocation_pool        (GstQuery *query, GstBufferPool *pool,
400                                                       guint size, guint min_buffers,
401                                                       guint max_buffers);
402 guint           gst_query_get_n_allocation_pools     (GstQuery *query);
403 void            gst_query_parse_nth_allocation_pool  (GstQuery *query, guint index,
404                                                       GstBufferPool **pool,
405                                                       guint *size, guint *min_buffers,
406                                                       guint *max_buffers);
407 void            gst_query_set_nth_allocation_pool    (GstQuery *query, guint index,
408                                                       GstBufferPool *pool,
409                                                       guint size, guint min_buffers,
410                                                       guint max_buffers);
411 void            gst_query_remove_nth_allocation_pool (GstQuery *query, guint index);
412
413 /* allocators */
414 void            gst_query_add_allocation_param       (GstQuery *query, GstAllocator *allocator,
415                                                       const GstAllocationParams *params);
416 guint           gst_query_get_n_allocation_params    (GstQuery *query);
417 void            gst_query_parse_nth_allocation_param (GstQuery *query, guint index,
418                                                       GstAllocator **allocator,
419                                                       GstAllocationParams *params);
420 void            gst_query_set_nth_allocation_param   (GstQuery *query, guint index,
421                                                       GstAllocator *allocator,
422                                                       const GstAllocationParams *params);
423 void            gst_query_remove_nth_allocation_param (GstQuery *query, guint index);
424
425 /* metadata */
426 void            gst_query_add_allocation_meta        (GstQuery *query, GType api, const GstStructure *params);
427 guint           gst_query_get_n_allocation_metas     (GstQuery *query);
428 GType           gst_query_parse_nth_allocation_meta  (GstQuery *query, guint index,
429                                                       const GstStructure **params);
430 void            gst_query_remove_nth_allocation_meta (GstQuery *query, guint index);
431 gboolean        gst_query_find_allocation_meta       (GstQuery *query, GType api, guint *index);
432
433
434 /* scheduling query */
435 /**
436  * GstSchedulingFlags:
437  * @GST_SCHEDULING_FLAG_SEEKABLE: if seeking is possible
438  * @GST_SCHEDULING_FLAG_SEQUENTIAL: if sequential access is recommended
439  * @GST_SCHEDULING_FLAG_BANDWIDTH_LIMITED: if bandwidth is limited and buffering possible (since 1.2)
440  *
441  * The different scheduling flags.
442  */
443 typedef enum {
444   GST_SCHEDULING_FLAG_SEEKABLE          = (1 << 0),
445   GST_SCHEDULING_FLAG_SEQUENTIAL        = (1 << 1),
446   GST_SCHEDULING_FLAG_BANDWIDTH_LIMITED = (1 << 2)
447 } GstSchedulingFlags;
448
449 GstQuery *      gst_query_new_scheduling          (void) G_GNUC_MALLOC;
450
451 void            gst_query_set_scheduling          (GstQuery *query, GstSchedulingFlags flags,
452                                                    gint minsize, gint maxsize, gint align);
453 void            gst_query_parse_scheduling        (GstQuery *query, GstSchedulingFlags *flags,
454                                                    gint *minsize, gint *maxsize, gint *align);
455
456 void            gst_query_add_scheduling_mode       (GstQuery *query, GstPadMode mode);
457 guint           gst_query_get_n_scheduling_modes    (GstQuery *query);
458 GstPadMode      gst_query_parse_nth_scheduling_mode (GstQuery *query, guint index);
459 gboolean        gst_query_has_scheduling_mode       (GstQuery *query, GstPadMode mode);
460 gboolean        gst_query_has_scheduling_mode_with_flags (GstQuery * query, GstPadMode mode,
461                                                     GstSchedulingFlags flags);
462
463 /* accept-caps query */
464 GstQuery *      gst_query_new_accept_caps          (GstCaps *caps) G_GNUC_MALLOC;
465 void            gst_query_parse_accept_caps        (GstQuery *query, GstCaps **caps);
466 void            gst_query_set_accept_caps_result   (GstQuery *query, gboolean result);
467 void            gst_query_parse_accept_caps_result (GstQuery *query, gboolean *result);
468
469 /* caps query */
470 GstQuery *      gst_query_new_caps                 (GstCaps *filter) G_GNUC_MALLOC;
471 void            gst_query_parse_caps               (GstQuery *query, GstCaps **filter);
472
473 void            gst_query_set_caps_result          (GstQuery *query, GstCaps *caps);
474 void            gst_query_parse_caps_result        (GstQuery *query, GstCaps **caps);
475
476 /* drain query */
477 GstQuery *      gst_query_new_drain                (void) G_GNUC_MALLOC;
478
479 /* context query */
480 GstQuery *      gst_query_new_context              (const gchar * context_type) G_GNUC_MALLOC;
481 gboolean        gst_query_parse_context_type       (GstQuery * query, const gchar ** context_type);
482 void            gst_query_set_context              (GstQuery *query, GstContext *context);
483 void            gst_query_parse_context            (GstQuery *query, GstContext **context);
484
485 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
486 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstQuery, gst_query_unref)
487 #endif
488
489 G_END_DECLS
490
491 #endif /* __GST_QUERY_H__ */
492