add GstQueryBuffers query
[glsdk/gstreamer0-10.git] / gst / gstquery.c
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  *
6  * gstquery.c: GstQueryType registration and Query parsing/creation
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public
19  * License along with this library; if not, write to the
20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  */
24 /**
25  * SECTION:gstquery
26  * @short_description: Dynamically register new query types. Provide functions
27  *                     to create queries, and to set and parse values in them.
28  * @see_also: #GstPad, #GstElement
29  *
30  * GstQuery functions are used to register new query types to the gstreamer
31  * core and use them.
32  * Queries can be performed on pads (gst_pad_query()) and elements
33  * (gst_element_query()). Please note that some queries might need a running
34  * pipeline to work.
35  *
36  * Queries can be created using the gst_query_new_*() functions.
37  * Query values can be set using gst_query_set_*(), and parsed using
38  * gst_query_parse_*() helpers.
39  *
40  * The following example shows how to query the duration of a pipeline:
41  *
42  * <example>
43  *  <title>Query duration on a pipeline</title>
44  *  <programlisting>
45  *  GstQuery *query;
46  *  gboolean res;
47  *  query = gst_query_new_duration (GST_FORMAT_TIME);
48  *  res = gst_element_query (pipeline, query);
49  *  if (res) {
50  *    gint64 duration;
51  *    gst_query_parse_duration (query, NULL, &amp;duration);
52  *    g_print ("duration = %"GST_TIME_FORMAT, GST_TIME_ARGS (duration));
53  *  }
54  *  else {
55  *    g_print ("duration query failed...");
56  *  }
57  *  gst_query_unref (query);
58  *  </programlisting>
59  * </example>
60  *
61  * Last reviewed on 2006-02-14 (0.10.4)
62  */
64 #include "gst_private.h"
65 #include "gstinfo.h"
66 #include "gstquery.h"
67 #include "gstvalue.h"
68 #include "gstenumtypes.h"
69 #include "gstquark.h"
70 #include "gsturi.h"
72 GST_DEBUG_CATEGORY_STATIC (gst_query_debug);
73 #define GST_CAT_DEFAULT gst_query_debug
75 static void gst_query_finalize (GstQuery * query);
76 static GstQuery *_gst_query_copy (GstQuery * query);
78 static GStaticMutex mutex = G_STATIC_MUTEX_INIT;
79 static GList *_gst_queries = NULL;
80 static GHashTable *_nick_to_query = NULL;
81 static GHashTable *_query_type_to_nick = NULL;
82 static guint32 _n_values = 1;   /* we start from 1 because 0 reserved for NONE */
84 static GstMiniObjectClass *parent_class = NULL;
86 static GstQueryTypeDefinition standard_definitions[] = {
87   {GST_QUERY_POSITION, "position", "Current position", 0},
88   {GST_QUERY_DURATION, "duration", "Total duration", 0},
89   {GST_QUERY_LATENCY, "latency", "Latency", 0},
90   {GST_QUERY_JITTER, "jitter", "Jitter", 0},
91   {GST_QUERY_RATE, "rate", "Configured rate 1000000 = 1", 0},
92   {GST_QUERY_SEEKING, "seeking", "Seeking capabilities and parameters", 0},
93   {GST_QUERY_SEGMENT, "segment", "currently configured segment", 0},
94   {GST_QUERY_CONVERT, "convert", "Converting between formats", 0},
95   {GST_QUERY_FORMATS, "formats", "Supported formats for conversion", 0},
96   {GST_QUERY_BUFFERING, "buffering", "Buffering status", 0},
97   {GST_QUERY_CUSTOM, "custom", "Custom query", 0},
98   {GST_QUERY_URI, "uri", "URI of the source or sink", 0},
99   {GST_QUERY_BUFFERS, "buffers", "Minimum buffer requirements", 0},
100   {GST_QUERY_NONE, NULL, NULL, 0}
101 };
103 void
104 _gst_query_initialize (void)
106   GstQueryTypeDefinition *standards = standard_definitions;
108   GST_CAT_INFO (GST_CAT_GST_INIT, "init queries");
110   GST_DEBUG_CATEGORY_INIT (gst_query_debug, "query", 0, "query system");
112   g_static_mutex_lock (&mutex);
113   if (_nick_to_query == NULL) {
114     _nick_to_query = g_hash_table_new (g_str_hash, g_str_equal);
115     _query_type_to_nick = g_hash_table_new (NULL, NULL);
116   }
118   while (standards->nick) {
119     standards->quark = g_quark_from_static_string (standards->nick);
120     g_hash_table_insert (_nick_to_query, (gpointer) standards->nick, standards);
121     g_hash_table_insert (_query_type_to_nick,
122         GINT_TO_POINTER (standards->value), standards);
124     _gst_queries = g_list_append (_gst_queries, standards);
125     standards++;
126     _n_values++;
127   }
128   g_static_mutex_unlock (&mutex);
130   g_type_class_ref (gst_query_get_type ());
133 /**
134  * gst_query_type_get_name:
135  * @query: the query type
136  *
137  * Get a printable name for the given query type. Do not modify or free.
138  *
139  * Returns: a reference to the static name of the query.
140  */
141 const gchar *
142 gst_query_type_get_name (GstQueryType query)
144   const GstQueryTypeDefinition *def;
146   def = gst_query_type_get_details (query);
148   return def->nick;
151 /**
152  * gst_query_type_to_quark:
153  * @query: the query type
154  *
155  * Get the unique quark for the given query type.
156  *
157  * Returns: the quark associated with the query type
158  */
159 GQuark
160 gst_query_type_to_quark (GstQueryType query)
162   const GstQueryTypeDefinition *def;
164   def = gst_query_type_get_details (query);
166   return def->quark;
169 G_DEFINE_TYPE (GstQuery, gst_query, GST_TYPE_MINI_OBJECT);
171 static void
172 gst_query_class_init (GstQueryClass * klass)
174   parent_class = g_type_class_peek_parent (klass);
176   klass->mini_object_class.copy = (GstMiniObjectCopyFunction) _gst_query_copy;
177   klass->mini_object_class.finalize =
178       (GstMiniObjectFinalizeFunction) gst_query_finalize;
182 static void
183 gst_query_init (GstQuery * query)
187 static void
188 gst_query_finalize (GstQuery * query)
190   g_return_if_fail (query != NULL);
192   if (query->structure) {
193     gst_structure_set_parent_refcount (query->structure, NULL);
194     gst_structure_free (query->structure);
195   }
197 /*   GST_MINI_OBJECT_CLASS (parent_class)->finalize (GST_MINI_OBJECT (query)); */
200 static GstQuery *
201 _gst_query_copy (GstQuery * query)
203   GstQuery *copy;
205   copy = (GstQuery *) gst_mini_object_new (GST_TYPE_QUERY);
207   copy->type = query->type;
209   if (query->structure) {
210     copy->structure = gst_structure_copy (query->structure);
211     gst_structure_set_parent_refcount (copy->structure,
212         &query->mini_object.refcount);
213   }
215   return copy;
220 /**
221  * gst_query_type_register:
222  * @nick: The nick of the new query
223  * @description: The description of the new query
224  *
225  * Create a new GstQueryType based on the nick or return an
226  * already registered query with that nick
227  *
228  * Returns: A new GstQueryType or an already registered query
229  * with the same nick.
230  */
231 GstQueryType
232 gst_query_type_register (const gchar * nick, const gchar * description)
234   GstQueryTypeDefinition *query;
235   GstQueryType lookup;
237   g_return_val_if_fail (nick != NULL, GST_QUERY_NONE);
238   g_return_val_if_fail (description != NULL, GST_QUERY_NONE);
240   lookup = gst_query_type_get_by_nick (nick);
241   if (lookup != GST_QUERY_NONE)
242     return lookup;
244   query = g_slice_new (GstQueryTypeDefinition);
245   query->value = (GstQueryType) _n_values;
246   query->nick = g_strdup (nick);
247   query->description = g_strdup (description);
248   query->quark = g_quark_from_static_string (query->nick);
250   g_static_mutex_lock (&mutex);
251   g_hash_table_insert (_nick_to_query, (gpointer) query->nick, query);
252   g_hash_table_insert (_query_type_to_nick, GINT_TO_POINTER (query->value),
253       query);
254   _gst_queries = g_list_append (_gst_queries, query);
255   _n_values++;
256   g_static_mutex_unlock (&mutex);
258   return query->value;
261 /**
262  * gst_query_type_get_by_nick:
263  * @nick: The nick of the query
264  *
265  * Get the query type registered with @nick.
266  *
267  * Returns: The query registered with @nick or #GST_QUERY_NONE
268  * if the query was not registered.
269  */
270 GstQueryType
271 gst_query_type_get_by_nick (const gchar * nick)
273   GstQueryTypeDefinition *query;
275   g_return_val_if_fail (nick != NULL, GST_QUERY_NONE);
277   g_static_mutex_lock (&mutex);
278   query = g_hash_table_lookup (_nick_to_query, nick);
279   g_static_mutex_unlock (&mutex);
281   if (query != NULL)
282     return query->value;
283   else
284     return GST_QUERY_NONE;
287 /**
288  * gst_query_types_contains:
289  * @types: The query array to search
290  * @type: the #GstQueryType to find
291  *
292  * See if the given #GstQueryType is inside the @types query types array.
293  *
294  * Returns: TRUE if the type is found inside the array
295  */
296 gboolean
297 gst_query_types_contains (const GstQueryType * types, GstQueryType type)
299   if (!types)
300     return FALSE;
302   while (*types) {
303     if (*types == type)
304       return TRUE;
306     types++;
307   }
308   return FALSE;
312 /**
313  * gst_query_type_get_details:
314  * @type: a #GstQueryType
315  *
316  * Get details about the given #GstQueryType.
317  *
318  * Returns: The #GstQueryTypeDefinition for @type or NULL on failure.
319  */
320 const GstQueryTypeDefinition *
321 gst_query_type_get_details (GstQueryType type)
323   const GstQueryTypeDefinition *result;
325   g_static_mutex_lock (&mutex);
326   result = g_hash_table_lookup (_query_type_to_nick, GINT_TO_POINTER (type));
327   g_static_mutex_unlock (&mutex);
329   return result;
332 /**
333  * gst_query_type_iterate_definitions:
334  *
335  * Get a #GstIterator of all the registered query types. The definitions
336  * iterated over are read only.
337  *
338  * Free-function: gst_iterator_free
339  *
340  * Returns: (transfer full): a #GstIterator of #GstQueryTypeDefinition.
341  */
342 GstIterator *
343 gst_query_type_iterate_definitions (void)
345   GstIterator *result;
347   g_static_mutex_lock (&mutex);
348   /* FIXME: register a boxed type for GstQueryTypeDefinition */
349   result = gst_iterator_new_list (G_TYPE_POINTER,
350       g_static_mutex_get_mutex (&mutex), &_n_values, &_gst_queries,
351       NULL, NULL, NULL);
352   g_static_mutex_unlock (&mutex);
354   return result;
357 static GstQuery *
358 gst_query_new (GstQueryType type, GstStructure * structure)
360   GstQuery *query;
362   query = (GstQuery *) gst_mini_object_new (GST_TYPE_QUERY);
364   GST_DEBUG ("creating new query %p %s", query, gst_query_type_get_name (type));
366   query->type = type;
368   if (structure) {
369     query->structure = structure;
370     gst_structure_set_parent_refcount (query->structure,
371         &query->mini_object.refcount);
372   } else {
373     query->structure = NULL;
374   }
376   return query;
379 /**
380  * gst_query_new_position:
381  * @format: the default #GstFormat for the new query
382  *
383  * Constructs a new query stream position query object. Use gst_query_unref()
384  * when done with it. A position query is used to query the current position
385  * of playback in the streams, in some format.
386  *
387  * Free-function: gst_query_unref
388  *
389  * Returns: (transfer full): a new #GstQuery
390  */
391 GstQuery *
392 gst_query_new_position (GstFormat format)
394   GstQuery *query;
395   GstStructure *structure;
397   structure = gst_structure_id_new (GST_QUARK (QUERY_POSITION),
398       GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
399       GST_QUARK (CURRENT), G_TYPE_INT64, G_GINT64_CONSTANT (-1), NULL);
401   query = gst_query_new (GST_QUERY_POSITION, structure);
403   return query;
406 /**
407  * gst_query_set_position:
408  * @query: a #GstQuery with query type GST_QUERY_POSITION
409  * @format: the requested #GstFormat
410  * @cur: the position to set
411  *
412  * Answer a position query by setting the requested value in the given format.
413  */
414 void
415 gst_query_set_position (GstQuery * query, GstFormat format, gint64 cur)
417   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_POSITION);
419   gst_structure_id_set (query->structure,
420       GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
421       GST_QUARK (CURRENT), G_TYPE_INT64, cur, NULL);
424 /**
425  * gst_query_parse_position:
426  * @query: a #GstQuery
427  * @format: (out) (allow-none): the storage for the #GstFormat of the
428  *     position values (may be NULL)
429  * @cur: (out) (allow-none): the storage for the current position (may be NULL)
430  *
431  * Parse a position query, writing the format into @format, and the position
432  * into @cur, if the respective parameters are non-NULL.
433  */
434 void
435 gst_query_parse_position (GstQuery * query, GstFormat * format, gint64 * cur)
437   GstStructure *structure;
439   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_POSITION);
441   structure = query->structure;
442   if (format)
443     *format =
444         (GstFormat) g_value_get_enum (gst_structure_id_get_value (structure,
445             GST_QUARK (FORMAT)));
446   if (cur)
447     *cur = g_value_get_int64 (gst_structure_id_get_value (structure,
448             GST_QUARK (CURRENT)));
452 /**
453  * gst_query_new_duration:
454  * @format: the #GstFormat for this duration query
455  *
456  * Constructs a new stream duration query object to query in the given format.
457  * Use gst_query_unref() when done with it. A duration query will give the
458  * total length of the stream.
459  *
460  * Free-function: gst_query_unref
461  *
462  * Returns: (transfer full): a new #GstQuery
463  */
464 GstQuery *
465 gst_query_new_duration (GstFormat format)
467   GstQuery *query;
468   GstStructure *structure;
470   structure = gst_structure_id_new (GST_QUARK (QUERY_DURATION),
471       GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
472       GST_QUARK (DURATION), G_TYPE_INT64, G_GINT64_CONSTANT (-1), NULL);
474   query = gst_query_new (GST_QUERY_DURATION, structure);
476   return query;
479 /**
480  * gst_query_set_duration:
481  * @query: a #GstQuery
482  * @format: the #GstFormat for the duration
483  * @duration: the duration of the stream
484  *
485  * Answer a duration query by setting the requested value in the given format.
486  */
487 void
488 gst_query_set_duration (GstQuery * query, GstFormat format, gint64 duration)
490   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_DURATION);
492   gst_structure_id_set (query->structure,
493       GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
494       GST_QUARK (DURATION), G_TYPE_INT64, duration, NULL);
497 /**
498  * gst_query_parse_duration:
499  * @query: a #GstQuery
500  * @format: (out) (allow-none): the storage for the #GstFormat of the duration
501  *     value, or NULL.
502  * @duration: (out) (allow-none): the storage for the total duration, or NULL.
503  *
504  * Parse a duration query answer. Write the format of the duration into @format,
505  * and the value into @duration, if the respective variables are non-NULL.
506  */
507 void
508 gst_query_parse_duration (GstQuery * query, GstFormat * format,
509     gint64 * duration)
511   GstStructure *structure;
513   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_DURATION);
515   structure = query->structure;
516   if (format)
517     *format =
518         (GstFormat) g_value_get_enum (gst_structure_id_get_value (structure,
519             GST_QUARK (FORMAT)));
520   if (duration)
521     *duration = g_value_get_int64 (gst_structure_id_get_value (structure,
522             GST_QUARK (DURATION)));
525 /**
526  * gst_query_new_latency:
527  *
528  * Constructs a new latency query object.
529  * Use gst_query_unref() when done with it. A latency query is usually performed
530  * by sinks to compensate for additional latency introduced by elements in the
531  * pipeline.
532  *
533  * Free-function: gst_query_unref
534  *
535  * Returns: (transfer full): a #GstQuery
536  *
537  * Since: 0.10.12
538  */
539 GstQuery *
540 gst_query_new_latency (void)
542   GstQuery *query;
543   GstStructure *structure;
545   structure = gst_structure_id_new (GST_QUARK (QUERY_LATENCY),
546       GST_QUARK (LIVE), G_TYPE_BOOLEAN, FALSE,
547       GST_QUARK (MIN_LATENCY), G_TYPE_UINT64, G_GUINT64_CONSTANT (0),
548       GST_QUARK (MAX_LATENCY), G_TYPE_UINT64, G_GUINT64_CONSTANT (-1), NULL);
550   query = gst_query_new (GST_QUERY_LATENCY, structure);
552   return query;
555 /**
556  * gst_query_set_latency:
557  * @query: a #GstQuery
558  * @live: if there is a live element upstream
559  * @min_latency: the minimal latency of the live element
560  * @max_latency: the maximal latency of the live element
561  *
562  * Answer a latency query by setting the requested values in the given format.
563  *
564  * Since: 0.10.12
565  */
566 void
567 gst_query_set_latency (GstQuery * query, gboolean live,
568     GstClockTime min_latency, GstClockTime max_latency)
570   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_LATENCY);
572   gst_structure_id_set (query->structure,
573       GST_QUARK (LIVE), G_TYPE_BOOLEAN, live,
574       GST_QUARK (MIN_LATENCY), G_TYPE_UINT64, min_latency,
575       GST_QUARK (MAX_LATENCY), G_TYPE_UINT64, max_latency, NULL);
578 /**
579  * gst_query_parse_latency:
580  * @query: a #GstQuery
581  * @live: (out) (allow-none): storage for live or NULL
582  * @min_latency: (out) (allow-none): the storage for the min latency or NULL
583  * @max_latency: (out) (allow-none): the storage for the max latency or NULL
584  *
585  * Parse a latency query answer.
586  *
587  * Since: 0.10.12
588  */
589 void
590 gst_query_parse_latency (GstQuery * query, gboolean * live,
591     GstClockTime * min_latency, GstClockTime * max_latency)
593   GstStructure *structure;
595   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_LATENCY);
597   structure = query->structure;
598   if (live)
599     *live =
600         g_value_get_boolean (gst_structure_id_get_value (structure,
601             GST_QUARK (LIVE)));
602   if (min_latency)
603     *min_latency = g_value_get_uint64 (gst_structure_id_get_value (structure,
604             GST_QUARK (MIN_LATENCY)));
605   if (max_latency)
606     *max_latency = g_value_get_uint64 (gst_structure_id_get_value (structure,
607             GST_QUARK (MAX_LATENCY)));
610 /**
611  * gst_query_new_convert:
612  * @src_format: the source #GstFormat for the new query
613  * @value: the value to convert
614  * @dest_format: the target #GstFormat
615  *
616  * Constructs a new convert query object. Use gst_query_unref()
617  * when done with it. A convert query is used to ask for a conversion between
618  * one format and another.
619  *
620  * Free-function: gst_query_unref
621  *
622  * Returns: (transfer full): a #GstQuery
623  */
624 GstQuery *
625 gst_query_new_convert (GstFormat src_format, gint64 value,
626     GstFormat dest_format)
628   GstQuery *query;
629   GstStructure *structure;
631   structure = gst_structure_id_new (GST_QUARK (QUERY_CONVERT),
632       GST_QUARK (SRC_FORMAT), GST_TYPE_FORMAT, src_format,
633       GST_QUARK (SRC_VALUE), G_TYPE_INT64, value,
634       GST_QUARK (DEST_FORMAT), GST_TYPE_FORMAT, dest_format,
635       GST_QUARK (DEST_VALUE), G_TYPE_INT64, G_GINT64_CONSTANT (-1), NULL);
637   query = gst_query_new (GST_QUERY_CONVERT, structure);
639   return query;
642 /**
643  * gst_query_set_convert:
644  * @query: a #GstQuery
645  * @src_format: the source #GstFormat
646  * @src_value: the source value
647  * @dest_format: the destination #GstFormat
648  * @dest_value: the destination value
649  *
650  * Answer a convert query by setting the requested values.
651  */
652 void
653 gst_query_set_convert (GstQuery * query, GstFormat src_format, gint64 src_value,
654     GstFormat dest_format, gint64 dest_value)
656   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CONVERT);
658   gst_structure_id_set (query->structure,
659       GST_QUARK (SRC_FORMAT), GST_TYPE_FORMAT, src_format,
660       GST_QUARK (SRC_VALUE), G_TYPE_INT64, src_value,
661       GST_QUARK (DEST_FORMAT), GST_TYPE_FORMAT, dest_format,
662       GST_QUARK (DEST_VALUE), G_TYPE_INT64, dest_value, NULL);
665 /**
666  * gst_query_parse_convert:
667  * @query: a #GstQuery
668  * @src_format: (out) (allow-none): the storage for the #GstFormat of the
669  *     source value, or NULL
670  * @src_value: (out) (allow-none): the storage for the source value, or NULL
671  * @dest_format: (out) (allow-none): the storage for the #GstFormat of the
672  *     destination value, or NULL
673  * @dest_value: (out) (allow-none): the storage for the destination value,
674  *     or NULL
675  *
676  * Parse a convert query answer. Any of @src_format, @src_value, @dest_format,
677  * and @dest_value may be NULL, in which case that value is omitted.
678  */
679 void
680 gst_query_parse_convert (GstQuery * query, GstFormat * src_format,
681     gint64 * src_value, GstFormat * dest_format, gint64 * dest_value)
683   GstStructure *structure;
685   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CONVERT);
687   structure = query->structure;
688   if (src_format)
689     *src_format =
690         (GstFormat) g_value_get_enum (gst_structure_id_get_value (structure,
691             GST_QUARK (SRC_FORMAT)));
692   if (src_value)
693     *src_value = g_value_get_int64 (gst_structure_id_get_value (structure,
694             GST_QUARK (SRC_VALUE)));
695   if (dest_format)
696     *dest_format =
697         (GstFormat) g_value_get_enum (gst_structure_id_get_value (structure,
698             GST_QUARK (DEST_FORMAT)));
699   if (dest_value)
700     *dest_value = g_value_get_int64 (gst_structure_id_get_value (structure,
701             GST_QUARK (DEST_VALUE)));
704 /**
705  * gst_query_new_segment:
706  * @format: the #GstFormat for the new query
707  *
708  * Constructs a new segment query object. Use gst_query_unref()
709  * when done with it. A segment query is used to discover information about the
710  * currently configured segment for playback.
711  *
712  * Free-function: gst_query_unref
713  *
714  * Returns: (transfer full): a new #GstQuery
715  */
716 GstQuery *
717 gst_query_new_segment (GstFormat format)
719   GstQuery *query;
720   GstStructure *structure;
722   structure = gst_structure_id_new (GST_QUARK (QUERY_SEGMENT),
723       GST_QUARK (RATE), G_TYPE_DOUBLE, (gdouble) 0.0,
724       GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
725       GST_QUARK (START_VALUE), G_TYPE_INT64, G_GINT64_CONSTANT (-1),
726       GST_QUARK (STOP_VALUE), G_TYPE_INT64, G_GINT64_CONSTANT (-1), NULL);
728   query = gst_query_new (GST_QUERY_SEGMENT, structure);
730   return query;
733 /**
734  * gst_query_set_segment:
735  * @query: a #GstQuery
736  * @rate: the rate of the segment
737  * @format: the #GstFormat of the segment values (@start_value and @stop_value)
738  * @start_value: the start value
739  * @stop_value: the stop value
740  *
741  * Answer a segment query by setting the requested values. The normal
742  * playback segment of a pipeline is 0 to duration at the default rate of
743  * 1.0. If a seek was performed on the pipeline to play a different
744  * segment, this query will return the range specified in the last seek.
745  *
746  * @start_value and @stop_value will respectively contain the configured
747  * playback range start and stop values expressed in @format.
748  * The values are always between 0 and the duration of the media and
749  * @start_value <= @stop_value. @rate will contain the playback rate. For
750  * negative rates, playback will actually happen from @stop_value to
751  * @start_value.
752  */
753 void
754 gst_query_set_segment (GstQuery * query, gdouble rate, GstFormat format,
755     gint64 start_value, gint64 stop_value)
757   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SEGMENT);
759   gst_structure_id_set (query->structure,
760       GST_QUARK (RATE), G_TYPE_DOUBLE, rate,
761       GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
762       GST_QUARK (START_VALUE), G_TYPE_INT64, start_value,
763       GST_QUARK (STOP_VALUE), G_TYPE_INT64, stop_value, NULL);
766 /**
767  * gst_query_parse_segment:
768  * @query: a #GstQuery
769  * @rate: (out) (allow-none): the storage for the rate of the segment, or NULL
770  * @format: (out) (allow-none): the storage for the #GstFormat of the values,
771  *     or NULL
772  * @start_value: (out) (allow-none): the storage for the start value, or NULL
773  * @stop_value: (out) (allow-none): the storage for the stop value, or NULL
774  *
775  * Parse a segment query answer. Any of @rate, @format, @start_value, and
776  * @stop_value may be NULL, which will cause this value to be omitted.
777  *
778  * See gst_query_set_segment() for an explanation of the function arguments.
779  */
780 void
781 gst_query_parse_segment (GstQuery * query, gdouble * rate, GstFormat * format,
782     gint64 * start_value, gint64 * stop_value)
784   GstStructure *structure;
786   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SEGMENT);
788   structure = query->structure;
789   if (rate)
790     *rate = g_value_get_double (gst_structure_id_get_value (structure,
791             GST_QUARK (RATE)));
792   if (format)
793     *format =
794         (GstFormat) g_value_get_enum (gst_structure_id_get_value (structure,
795             GST_QUARK (FORMAT)));
796   if (start_value)
797     *start_value = g_value_get_int64 (gst_structure_id_get_value (structure,
798             GST_QUARK (START_VALUE)));
799   if (stop_value)
800     *stop_value = g_value_get_int64 (gst_structure_id_get_value (structure,
801             GST_QUARK (STOP_VALUE)));
804 /**
805  * gst_query_new_application:
806  * @type: the query type
807  * @structure: a structure for the query
808  *
809  * Constructs a new custom application query object. Use gst_query_unref()
810  * when done with it.
811  *
812  * Free-function: gst_query_unref
813  *
814  * Returns: (transfer full): a new #GstQuery
815  */
816 GstQuery *
817 gst_query_new_application (GstQueryType type, GstStructure * structure)
819   g_return_val_if_fail (gst_query_type_get_details (type) != NULL, NULL);
820   g_return_val_if_fail (structure != NULL, NULL);
822   return gst_query_new (type, structure);
825 /**
826  * gst_query_get_structure:
827  * @query: a #GstQuery
828  *
829  * Get the structure of a query.
830  *
831  * Returns: (transfer none): the #GstStructure of the query. The structure is
832  *     still owned by the query and will therefore be freed when the query
833  *     is unreffed.
834  */
835 GstStructure *
836 gst_query_get_structure (GstQuery * query)
838   g_return_val_if_fail (GST_IS_QUERY (query), NULL);
840   return query->structure;
843 /**
844  * gst_query_new_seeking:
845  * @format: the default #GstFormat for the new query
846  *
847  * Constructs a new query object for querying seeking properties of
848  * the stream.
849  *
850  * Free-function: gst_query_unref
851  *
852  * Returns: (transfer full): a new #GstQuery
853  */
854 GstQuery *
855 gst_query_new_seeking (GstFormat format)
857   GstQuery *query;
858   GstStructure *structure;
860   structure = gst_structure_id_new (GST_QUARK (QUERY_SEEKING),
861       GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
862       GST_QUARK (SEEKABLE), G_TYPE_BOOLEAN, FALSE,
863       GST_QUARK (SEGMENT_START), G_TYPE_INT64, G_GINT64_CONSTANT (-1),
864       GST_QUARK (SEGMENT_END), G_TYPE_INT64, G_GINT64_CONSTANT (-1), NULL);
866   query = gst_query_new (GST_QUERY_SEEKING, structure);
868   return query;
871 /**
872  * gst_query_set_seeking:
873  * @query: a #GstQuery
874  * @format: the format to set for the @segment_start and @segment_end values
875  * @seekable: the seekable flag to set
876  * @segment_start: the segment_start to set
877  * @segment_end: the segment_end to set
878  *
879  * Set the seeking query result fields in @query.
880  */
881 void
882 gst_query_set_seeking (GstQuery * query, GstFormat format,
883     gboolean seekable, gint64 segment_start, gint64 segment_end)
885   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SEEKING);
887   gst_structure_id_set (query->structure,
888       GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
889       GST_QUARK (SEEKABLE), G_TYPE_BOOLEAN, seekable,
890       GST_QUARK (SEGMENT_START), G_TYPE_INT64, segment_start,
891       GST_QUARK (SEGMENT_END), G_TYPE_INT64, segment_end, NULL);
894 /**
895  * gst_query_parse_seeking:
896  * @query: a GST_QUERY_SEEKING type query #GstQuery
897  * @format: (out) (allow-none): the format to set for the @segment_start
898  *     and @segment_end values, or NULL
899  * @seekable: (out) (allow-none): the seekable flag to set, or NULL
900  * @segment_start: (out) (allow-none): the segment_start to set, or NULL
901  * @segment_end: (out) (allow-none): the segment_end to set, or NULL
902  *
903  * Parse a seeking query, writing the format into @format, and
904  * other results into the passed parameters, if the respective parameters
905  * are non-NULL
906  */
907 void
908 gst_query_parse_seeking (GstQuery * query, GstFormat * format,
909     gboolean * seekable, gint64 * segment_start, gint64 * segment_end)
911   GstStructure *structure;
913   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SEEKING);
915   structure = query->structure;
916   if (format)
917     *format =
918         (GstFormat) g_value_get_enum (gst_structure_id_get_value (structure,
919             GST_QUARK (FORMAT)));
920   if (seekable)
921     *seekable = g_value_get_boolean (gst_structure_id_get_value (structure,
922             GST_QUARK (SEEKABLE)));
923   if (segment_start)
924     *segment_start = g_value_get_int64 (gst_structure_id_get_value (structure,
925             GST_QUARK (SEGMENT_START)));
926   if (segment_end)
927     *segment_end = g_value_get_int64 (gst_structure_id_get_value (structure,
928             GST_QUARK (SEGMENT_END)));
931 /**
932  * gst_query_new_formats:
933  *
934  * Constructs a new query object for querying formats of
935  * the stream.
936  *
937  * Free-function: gst_query_unref
938  *
939  * Returns: (transfer full): a new #GstQuery
940  *
941  * Since: 0.10.4
942  */
943 GstQuery *
944 gst_query_new_formats (void)
946   GstQuery *query;
947   GstStructure *structure;
949   structure = gst_structure_id_empty_new (GST_QUARK (QUERY_FORMATS));
950   query = gst_query_new (GST_QUERY_FORMATS, structure);
952   return query;
955 static void
956 gst_query_list_add_format (GValue * list, GstFormat format)
958   GValue item = { 0, };
960   g_value_init (&item, GST_TYPE_FORMAT);
961   g_value_set_enum (&item, format);
962   gst_value_list_append_value (list, &item);
963   g_value_unset (&item);
966 /**
967  * gst_query_set_formats:
968  * @query: a #GstQuery
969  * @n_formats: the number of formats to set.
970  * @...: A number of @GstFormats equal to @n_formats.
971  *
972  * Set the formats query result fields in @query. The number of formats passed
973  * must be equal to @n_formats.
974  */
975 void
976 gst_query_set_formats (GstQuery * query, gint n_formats, ...)
978   va_list ap;
979   GValue list = { 0, };
980   gint i;
982   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_FORMATS);
984   g_value_init (&list, GST_TYPE_LIST);
986   va_start (ap, n_formats);
987   for (i = 0; i < n_formats; i++) {
988     gst_query_list_add_format (&list, va_arg (ap, GstFormat));
989   }
990   va_end (ap);
992   gst_structure_set_value (query->structure, "formats", &list);
994   g_value_unset (&list);
998 /**
999  * gst_query_set_formatsv:
1000  * @query: a #GstQuery
1001  * @n_formats: the number of formats to set.
1002  * @formats: (in) (array length=n_formats): an array containing @n_formats
1003  *     @GstFormat values.
1004  *
1005  * Set the formats query result fields in @query. The number of formats passed
1006  * in the @formats array must be equal to @n_formats.
1007  *
1008  * Since: 0.10.4
1009  */
1010 void
1011 gst_query_set_formatsv (GstQuery * query, gint n_formats,
1012     const GstFormat * formats)
1014   GValue list = { 0, };
1015   gint i;
1017   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_FORMATS);
1019   g_value_init (&list, GST_TYPE_LIST);
1020   for (i = 0; i < n_formats; i++) {
1021     gst_query_list_add_format (&list, formats[i]);
1022   }
1023   gst_structure_set_value (query->structure, "formats", &list);
1025   g_value_unset (&list);
1028 /**
1029  * gst_query_parse_formats_length:
1030  * @query: a #GstQuery
1031  * @n_formats: (out): the number of formats in this query.
1032  *
1033  * Parse the number of formats in the formats @query.
1034  *
1035  * Since: 0.10.4
1036  */
1037 void
1038 gst_query_parse_formats_length (GstQuery * query, guint * n_formats)
1040   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_FORMATS);
1042   if (n_formats) {
1043     const GValue *list;
1045     list = gst_structure_get_value (query->structure, "formats");
1046     if (list == NULL)
1047       *n_formats = 0;
1048     else
1049       *n_formats = gst_value_list_get_size (list);
1050   }
1053 /**
1054  * gst_query_parse_formats_nth:
1055  * @query: a #GstQuery
1056  * @nth: (out): the nth format to retrieve.
1057  * @format: (out): a pointer to store the nth format
1058  *
1059  * Parse the format query and retrieve the @nth format from it into
1060  * @format. If the list contains less elements than @nth, @format will be
1061  * set to GST_FORMAT_UNDEFINED.
1062  *
1063  * Since: 0.10.4
1064  */
1065 void
1066 gst_query_parse_formats_nth (GstQuery * query, guint nth, GstFormat * format)
1068   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_FORMATS);
1070   if (format) {
1071     const GValue *list;
1073     list = gst_structure_get_value (query->structure, "formats");
1074     if (list == NULL) {
1075       *format = GST_FORMAT_UNDEFINED;
1076     } else {
1077       if (nth < gst_value_list_get_size (list)) {
1078         *format =
1079             (GstFormat) g_value_get_enum (gst_value_list_get_value (list, nth));
1080       } else
1081         *format = GST_FORMAT_UNDEFINED;
1082     }
1083   }
1086 /**
1087  * gst_query_new_buffering
1088  * @format: the default #GstFormat for the new query
1089  *
1090  * Constructs a new query object for querying the buffering status of
1091  * a stream.
1092  *
1093  * Free-function: gst_query_new
1094  *
1095  * Returns: (transfer full): a new #GstQuery
1096  *
1097  * Since: 0.10.20
1098  */
1099 GstQuery *
1100 gst_query_new_buffering (GstFormat format)
1102   GstQuery *query;
1103   GstStructure *structure;
1105   /* by default, we configure the answer as no buffering with a 100% buffering
1106    * progress */
1107   structure = gst_structure_id_new (GST_QUARK (QUERY_BUFFERING),
1108       GST_QUARK (BUSY), G_TYPE_BOOLEAN, FALSE,
1109       GST_QUARK (BUFFER_PERCENT), G_TYPE_INT, 100,
1110       GST_QUARK (BUFFERING_MODE), GST_TYPE_BUFFERING_MODE, GST_BUFFERING_STREAM,
1111       GST_QUARK (AVG_IN_RATE), G_TYPE_INT, -1,
1112       GST_QUARK (AVG_OUT_RATE), G_TYPE_INT, -1,
1113       GST_QUARK (BUFFERING_LEFT), G_TYPE_INT64, G_GINT64_CONSTANT (0),
1114       GST_QUARK (ESTIMATED_TOTAL), G_TYPE_INT64, G_GINT64_CONSTANT (-1),
1115       GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
1116       GST_QUARK (START_VALUE), G_TYPE_INT64, G_GINT64_CONSTANT (-1),
1117       GST_QUARK (STOP_VALUE), G_TYPE_INT64, G_GINT64_CONSTANT (-1), NULL);
1119   query = gst_query_new (GST_QUERY_BUFFERING, structure);
1121   return query;
1124 /**
1125  * gst_query_set_buffering_percent
1126  * @query: A valid #GstQuery of type GST_QUERY_BUFFERING.
1127  * @busy: if buffering is busy
1128  * @percent: a buffering percent
1129  *
1130  * Set the percentage of buffered data. This is a value between 0 and 100.
1131  * The @busy indicator is %TRUE when the buffering is in progress.
1132  *
1133  * Since: 0.10.20
1134  */
1135 void
1136 gst_query_set_buffering_percent (GstQuery * query, gboolean busy, gint percent)
1138   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING);
1139   g_return_if_fail (percent >= 0 && percent <= 100);
1141   gst_structure_id_set (query->structure,
1142       GST_QUARK (BUSY), G_TYPE_BOOLEAN, busy,
1143       GST_QUARK (BUFFER_PERCENT), G_TYPE_INT, percent, NULL);
1146 /**
1147  * gst_query_parse_buffering_percent
1148  * @query: A valid #GstQuery of type GST_QUERY_BUFFERING.
1149  * @busy: (out) (allow-none): if buffering is busy, or NULL
1150  * @percent: (out) (allow-none): a buffering percent, or NULL
1151  *
1152  * Get the percentage of buffered data. This is a value between 0 and 100.
1153  * The @busy indicator is %TRUE when the buffering is in progress.
1154  *
1155  * Since: 0.10.20
1156  */
1157 void
1158 gst_query_parse_buffering_percent (GstQuery * query, gboolean * busy,
1159     gint * percent)
1161   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING);
1163   if (busy)
1164     *busy = g_value_get_boolean (gst_structure_id_get_value (query->structure,
1165             GST_QUARK (BUSY)));
1166   if (percent)
1167     *percent = g_value_get_int (gst_structure_id_get_value (query->structure,
1168             GST_QUARK (BUFFER_PERCENT)));
1171 /**
1172  * gst_query_set_buffering_stats:
1173  * @query: A valid #GstQuery of type GST_QUERY_BUFFERING.
1174  * @mode: a buffering mode
1175  * @avg_in: the average input rate
1176  * @avg_out: the average output rate
1177  * @buffering_left: amount of buffering time left
1178  *
1179  * Configures the buffering stats values in @query.
1180  *
1181  * Since: 0.10.20
1182  */
1183 void
1184 gst_query_set_buffering_stats (GstQuery * query, GstBufferingMode mode,
1185     gint avg_in, gint avg_out, gint64 buffering_left)
1187   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING);
1189   gst_structure_id_set (query->structure,
1190       GST_QUARK (BUFFERING_MODE), GST_TYPE_BUFFERING_MODE, mode,
1191       GST_QUARK (AVG_IN_RATE), G_TYPE_INT, avg_in,
1192       GST_QUARK (AVG_OUT_RATE), G_TYPE_INT, avg_out,
1193       GST_QUARK (BUFFERING_LEFT), G_TYPE_INT64, buffering_left, NULL);
1196 /**
1197  * gst_query_parse_buffering_stats:
1198  * @query: A valid #GstQuery of type GST_QUERY_BUFFERING.
1199  * @mode: (out) (allow-none): a buffering mode, or NULL
1200  * @avg_in: (out) (allow-none): the average input rate, or NULL
1201  * @avg_out: (out) (allow-none): the average output rat, or NULLe
1202  * @buffering_left: (out) (allow-none): amount of buffering time left, or NULL
1203  *
1204  * Extracts the buffering stats values from @query.
1205  *
1206  * Since: 0.10.20
1207  */
1208 void
1209 gst_query_parse_buffering_stats (GstQuery * query,
1210     GstBufferingMode * mode, gint * avg_in, gint * avg_out,
1211     gint64 * buffering_left)
1213   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING);
1215   if (mode)
1216     *mode = (GstBufferingMode)
1217         g_value_get_enum (gst_structure_id_get_value (query->structure,
1218             GST_QUARK (BUFFERING_MODE)));
1219   if (avg_in)
1220     *avg_in = g_value_get_int (gst_structure_id_get_value (query->structure,
1221             GST_QUARK (AVG_IN_RATE)));
1222   if (avg_out)
1223     *avg_out = g_value_get_int (gst_structure_id_get_value (query->structure,
1224             GST_QUARK (AVG_OUT_RATE)));
1225   if (buffering_left)
1226     *buffering_left =
1227         g_value_get_int64 (gst_structure_id_get_value (query->structure,
1228             GST_QUARK (BUFFERING_LEFT)));
1232 /**
1233  * gst_query_set_buffering_range:
1234  * @query: a #GstQuery
1235  * @format: the format to set for the @start and @stop values
1236  * @start: the start to set
1237  * @stop: the stop to set
1238  * @estimated_total: estimated total amount of download time
1239  *
1240  * Set the available query result fields in @query.
1241  *
1242  * Since: 0.10.20
1243  */
1244 void
1245 gst_query_set_buffering_range (GstQuery * query, GstFormat format,
1246     gint64 start, gint64 stop, gint64 estimated_total)
1248   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING);
1250   gst_structure_id_set (query->structure,
1251       GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
1252       GST_QUARK (START_VALUE), G_TYPE_INT64, start,
1253       GST_QUARK (STOP_VALUE), G_TYPE_INT64, stop,
1254       GST_QUARK (ESTIMATED_TOTAL), G_TYPE_INT64, estimated_total, NULL);
1257 /**
1258  * gst_query_parse_buffering_range:
1259  * @query: a GST_QUERY_BUFFERING type query #GstQuery
1260  * @format: (out) (allow-none): the format to set for the @segment_start
1261  *     and @segment_end values, or NULL
1262  * @start: (out) (allow-none): the start to set, or NULL
1263  * @stop: (out) (allow-none): the stop to set, or NULL
1264  * @estimated_total: (out) (allow-none): estimated total amount of download
1265  *     time, or NULL
1266  *
1267  * Parse an available query, writing the format into @format, and
1268  * other results into the passed parameters, if the respective parameters
1269  * are non-NULL
1270  *
1271  * Since: 0.10.20
1272  */
1273 void
1274 gst_query_parse_buffering_range (GstQuery * query, GstFormat * format,
1275     gint64 * start, gint64 * stop, gint64 * estimated_total)
1277   GstStructure *structure;
1279   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING);
1281   structure = query->structure;
1282   if (format)
1283     *format =
1284         (GstFormat) g_value_get_enum (gst_structure_id_get_value (structure,
1285             GST_QUARK (FORMAT)));
1286   if (start)
1287     *start = g_value_get_int64 (gst_structure_id_get_value (structure,
1288             GST_QUARK (START_VALUE)));
1289   if (stop)
1290     *stop = g_value_get_int64 (gst_structure_id_get_value (structure,
1291             GST_QUARK (STOP_VALUE)));
1292   if (estimated_total)
1293     *estimated_total =
1294         g_value_get_int64 (gst_structure_id_get_value (structure,
1295             GST_QUARK (ESTIMATED_TOTAL)));
1298 /**
1299  * gst_query_add_buffering_range
1300  * @query: a GST_QUERY_BUFFERING type query #GstQuery
1301  * @start: start position of the range
1302  * @stop: stop position of the range
1303  *
1304  * Set the buffering-ranges array field in @query. The current last
1305  * start position of the array should be inferior to @start.
1306  *
1307  * Returns: a #gboolean indicating if the range was added or not.
1308  *
1309  * Since: 0.10.31
1310  */
1311 gboolean
1312 gst_query_add_buffering_range (GstQuery * query, gint64 start, gint64 stop)
1314   GValueArray *array;
1315   GValue *last_array_value;
1316   const GValue *value;
1317   GValue range_value = { 0 };
1319   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING, FALSE);
1321   if (G_UNLIKELY (start >= stop))
1322     return FALSE;
1324   value =
1325       gst_structure_id_get_value (query->structure,
1326       GST_QUARK (BUFFERING_RANGES));
1327   if (value) {
1328     array = (GValueArray *) g_value_get_boxed (value);
1329     last_array_value = g_value_array_get_nth (array, array->n_values - 1);
1330     if (G_UNLIKELY (start <= gst_value_get_int64_range_min (last_array_value)))
1331       return FALSE;
1332   } else {
1333     GValue new_array_val = { 0, };
1335     array = g_value_array_new (0);
1337     g_value_init (&new_array_val, G_TYPE_VALUE_ARRAY);
1338     g_value_take_boxed (&new_array_val, array);
1340     /* set the value array only once, so we then modify (append to) the
1341      * existing value array owned by the GstStructure / the field's GValue */
1342     gst_structure_id_take_value (query->structure, GST_QUARK (BUFFERING_RANGES),
1343         &new_array_val);
1344   }
1346   g_value_init (&range_value, GST_TYPE_INT64_RANGE);
1347   gst_value_set_int64_range (&range_value, start, stop);
1348   g_value_array_append (array, &range_value);
1349   /* skip the g_value_unset(&range_value) here, we know it's not needed */
1351   return TRUE;
1354 /**
1355  * gst_query_get_n_buffering_ranges
1356  * @query: a GST_QUERY_BUFFERING type query #GstQuery
1357  *
1358  * Retrieve the number of values currently stored in the
1359  * buffered-ranges array of the query's structure.
1360  *
1361  * Returns: the range array size as a #guint.
1362  *
1363  * Since: 0.10.31
1364  */
1365 guint
1366 gst_query_get_n_buffering_ranges (GstQuery * query)
1368   GValueArray *array;
1369   const GValue *value;
1370   guint size = 0;
1372   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING, 0);
1374   value =
1375       gst_structure_id_get_value (query->structure,
1376       GST_QUARK (BUFFERING_RANGES));
1377   if (value) {
1378     array = (GValueArray *) g_value_get_boxed (value);
1379     size = array->n_values;
1380   }
1381   return size;
1385 /**
1386  * gst_query_parse_nth_buffering_range
1387  * @query: a GST_QUERY_BUFFERING type query #GstQuery
1388  * @index: position in the buffered-ranges array to read
1389  * @start: (out) (allow-none): the start position to set, or NULL
1390  * @stop: (out) (allow-none): the stop position to set, or NULL
1391  *
1392  * Parse an available query and get the start and stop values stored
1393  * at the @index of the buffered ranges array.
1394  *
1395  * Returns: a #gboolean indicating if the parsing succeeded.
1396  *
1397  * Since: 0.10.31
1398  */
1399 gboolean
1400 gst_query_parse_nth_buffering_range (GstQuery * query, guint index,
1401     gint64 * start, gint64 * stop)
1403   const GValue *value;
1404   GValueArray *ranges;
1405   GValue *range_value;
1406   gboolean ret = FALSE;
1408   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING, ret);
1410   value =
1411       gst_structure_id_get_value (query->structure,
1412       GST_QUARK (BUFFERING_RANGES));
1413   ranges = (GValueArray *) g_value_get_boxed (value);
1414   range_value = g_value_array_get_nth (ranges, index);
1415   if (range_value) {
1416     if (start)
1417       *start = gst_value_get_int64_range_min (range_value);
1418     if (stop)
1419       *stop = gst_value_get_int64_range_max (range_value);
1420     ret = TRUE;
1421   }
1423   return ret;
1427 /**
1428  * gst_query_new_uri:
1429  *
1430  * Constructs a new query URI query object. Use gst_query_unref()
1431  * when done with it. An URI query is used to query the current URI
1432  * that is used by the source or sink.
1433  *
1434  * Free-function: gst_query_unref
1435  *
1436  * Returns: (transfer full): a new #GstQuery
1437  *
1438  * Since: 0.10.22
1439  */
1440 GstQuery *
1441 gst_query_new_uri (void)
1443   GstQuery *query;
1444   GstStructure *structure;
1446   structure = gst_structure_id_new (GST_QUARK (QUERY_URI),
1447       GST_QUARK (URI), G_TYPE_STRING, NULL, NULL);
1449   query = gst_query_new (GST_QUERY_URI, structure);
1451   return query;
1454 /**
1455  * gst_query_set_uri:
1456  * @query: a #GstQuery with query type GST_QUERY_URI
1457  * @uri: the URI to set
1458  *
1459  * Answer a URI query by setting the requested URI.
1460  *
1461  * Since: 0.10.22
1462  */
1463 void
1464 gst_query_set_uri (GstQuery * query, const gchar * uri)
1466   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_URI);
1467   g_return_if_fail (gst_uri_is_valid (uri));
1469   gst_structure_id_set (query->structure, GST_QUARK (URI), G_TYPE_STRING, uri,
1470       NULL);
1473 /**
1474  * gst_query_parse_uri:
1475  * @query: a #GstQuery
1476  * @uri: (out callee-allocates) (allow-none): the storage for the current URI
1477  *     (may be NULL)
1478  *
1479  * Parse an URI query, writing the URI into @uri as a newly
1480  * allocated string, if the respective parameters are non-NULL.
1481  * Free the string with g_free() after usage.
1482  *
1483  * Since: 0.10.22
1484  */
1485 void
1486 gst_query_parse_uri (GstQuery * query, gchar ** uri)
1488   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_URI);
1490   if (uri)
1491     *uri = g_value_dup_string (gst_structure_id_get_value (query->structure,
1492             GST_QUARK (URI)));
1495 /**
1496  * gst_query_new_buffers:
1497  * @caps: the #GstCaps for the buffers that are going to be allocated
1498  *
1499  * Constructs a new buffer requirements query object to query buffer
1500  * requirements for a particular caps.  Use gst_query_unref() when done
1501  * with it.
1502  *
1503  * Returns: A #GstQuery
1504  */
1505 GstQuery *
1506 gst_query_new_buffers (GstCaps * caps)
1508   GstQuery *query;
1509   GstStructure *structure;
1511   /* XXX could add size here, for linear (non YUV/RGB) buffers?  But I'm not
1512    * entirely sure what is the use-case for that.. it should be easy enough
1513    * to add more optional reply fields later
1514    */
1515   structure = gst_structure_id_new (GST_QUARK (QUERY_BUFFERS),
1516       GST_QUARK (CAPS), GST_TYPE_CAPS, caps,
1517       GST_QUARK (COUNT), G_TYPE_INT, -1,
1518       GST_QUARK (WIDTH), G_TYPE_INT, -1,
1519       GST_QUARK (HEIGHT), G_TYPE_INT, -1, NULL);
1521   query = gst_query_new (GST_QUERY_BUFFERS, structure);
1523   return query;
1526 /**
1527  * gst_query_set_buffers_count:
1528  * @count: minimum number of buffers required
1529  *
1530  * Answer a buffers query by setting the minimum number of buffers required.
1531  * If there is no minimum buffer count requirement, don't set this field in
1532  * the query.
1533  */
1534 void
1535 gst_query_set_buffers_count (GstQuery * query, gint count)
1537   GstStructure *structure;
1539   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERS);
1541   structure = gst_query_get_structure (query);
1542   gst_structure_id_set (structure, GST_QUARK (COUNT), G_TYPE_INT, count, NULL);
1545 /**
1546  * gst_query_set_buffers_dimensions:
1547  * @width: minimum buffer width
1548  * @height: minimum buffer height
1549  *
1550  * Answer a buffers query by setting the minimum buffer dimensions required.
1551  * If there is no minimum buffer dimensions (beyond the width/height specified
1552  * in the #GstCaps), don't set this field in the query.
1553  */
1554 void
1555 gst_query_set_buffers_dimensions (GstQuery * query, gint width, gint height)
1557   GstStructure *structure;
1559   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERS);
1561   structure = gst_query_get_structure (query);
1562   gst_structure_id_set (structure,
1563       GST_QUARK (WIDTH), G_TYPE_INT, width,
1564       GST_QUARK (HEIGHT), G_TYPE_INT, height, NULL);
1567 /**
1568  * gst_query_parse_buffers_caps:
1569  * @query: a #GstQuery
1570  * @caps: the storage for the #GstCaps pointer, or NULL
1571  *
1572  * Parse a buffers query.
1573  */
1574 void
1575 gst_query_parse_buffers_caps (GstQuery * query, const GstCaps ** caps)
1577   GstStructure *structure;
1579   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERS);
1581   structure = gst_query_get_structure (query);
1582   if (caps)
1583     *caps = gst_value_get_caps (gst_structure_id_get_value (structure,
1584             GST_QUARK (CAPS)));
1587 /**
1588  * gst_query_parse_buffers_count:
1589  * @query: a #GstQuery
1590  * @count: the storage for minimum number of buffers, or NULL
1591  *
1592  * Parse a buffers query answer to see the minimum number of buffers
1593  * required.  A returned value of -1 means there is no minimum requirement
1594  */
1595 void
1596 gst_query_parse_buffers_count (GstQuery * query, gint * count)
1598   GstStructure *structure;
1600   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERS);
1602   structure = gst_query_get_structure (query);
1603   if (count)
1604     *count = g_value_get_int (gst_structure_id_get_value (structure,
1605             GST_QUARK (COUNT)));
1608 /**
1609  * gst_query_parse_buffers_dimensions:
1610  * @query: a #GstQuery
1611  * @width: the storage for minimum width, or NULL
1612  * @height: the storage for minimum height, or NULL
1613  *
1614  * Parse a buffers query answer to see the minimum buffer dimensions required.
1615  * A returned value of -1 for either dimension means there is no minimum
1616  * requirement in that axis
1617  */
1618 void
1619 gst_query_parse_buffers_dimensions (GstQuery * query, gint * width,
1620     gint * height)
1622   GstStructure *structure;
1624   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERS);
1626   structure = gst_query_get_structure (query);
1627   if (width)
1628     *width = g_value_get_int (gst_structure_id_get_value (structure,
1629             GST_QUARK (WIDTH)));
1630   if (height)
1631     *height = g_value_get_int (gst_structure_id_get_value (structure,
1632             GST_QUARK (HEIGHT)));