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