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>
6 * gstquery.c: GstQueryType registration and Query parsing/creation
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.
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.
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., 51 Franklin St, Fifth Floor,
21 * Boston, MA 02110-1301, USA.
27 * @short_description: Provide functions to create queries, and to set and parse
29 * @see_also: #GstPad, #GstElement
31 * Queries can be performed on pads (gst_pad_query()) and elements
32 * (gst_element_query()). Please note that some queries might need a running
35 * Queries can be created using the gst_query_new_*() functions.
36 * Query values can be set using gst_query_set_*(), and parsed using
37 * gst_query_parse_*() helpers.
39 * The following example shows how to query the duration of a pipeline:
40 * |[<!-- language="C" -->
43 * query = gst_query_new_duration (GST_FORMAT_TIME);
44 * res = gst_element_query (pipeline, query);
47 * gst_query_parse_duration (query, NULL, &duration);
48 * g_print ("duration = %"GST_TIME_FORMAT, GST_TIME_ARGS (duration));
50 * g_print ("duration query failed...");
52 * gst_query_unref (query);
57 #include "gst_private.h"
61 #include "gstenumtypes.h"
64 #include "gstbufferpool.h"
66 GST_DEBUG_CATEGORY_STATIC (gst_query_debug);
67 #define GST_CAT_DEFAULT gst_query_debug
69 GType _gst_query_type = 0;
75 GstStructure *structure;
78 #define GST_QUERY_STRUCTURE(q) (((GstQueryImpl *)(q))->structure)
88 static GstQueryQuarks query_quarks[] = {
89 {GST_QUERY_UNKNOWN, "unknown", 0},
90 {GST_QUERY_POSITION, "position", 0},
91 {GST_QUERY_DURATION, "duration", 0},
92 {GST_QUERY_LATENCY, "latency", 0},
93 {GST_QUERY_JITTER, "jitter", 0},
94 {GST_QUERY_RATE, "rate", 0},
95 {GST_QUERY_SEEKING, "seeking", 0},
96 {GST_QUERY_SEGMENT, "segment", 0},
97 {GST_QUERY_CONVERT, "convert", 0},
98 {GST_QUERY_FORMATS, "formats", 0},
99 {GST_QUERY_BUFFERING, "buffering", 0},
100 {GST_QUERY_CUSTOM, "custom", 0},
101 {GST_QUERY_URI, "uri", 0},
102 {GST_QUERY_ALLOCATION, "allocation", 0},
103 {GST_QUERY_SCHEDULING, "scheduling", 0},
104 {GST_QUERY_ACCEPT_CAPS, "accept-caps", 0},
105 {GST_QUERY_CAPS, "caps", 0},
106 {GST_QUERY_DRAIN, "drain", 0},
107 {GST_QUERY_CONTEXT, "context", 0},
112 GST_DEFINE_MINI_OBJECT_TYPE (GstQuery, gst_query);
115 _priv_gst_query_initialize (void)
119 _gst_query_type = gst_query_get_type ();
121 GST_DEBUG_CATEGORY_INIT (gst_query_debug, "query", 0, "query system");
123 for (i = 0; query_quarks[i].name; i++) {
124 query_quarks[i].quark = g_quark_from_static_string (query_quarks[i].name);
129 * gst_query_type_get_name:
130 * @type: the query type
132 * Get a printable name for the given query type. Do not modify or free.
134 * Returns: a reference to the static name of the query.
137 gst_query_type_get_name (GstQueryType type)
141 for (i = 0; query_quarks[i].name; i++) {
142 if (type == query_quarks[i].type)
143 return query_quarks[i].name;
149 * gst_query_type_to_quark:
150 * @type: the query type
152 * Get the unique quark for the given query type.
154 * Returns: the quark associated with the query type
157 gst_query_type_to_quark (GstQueryType type)
161 for (i = 0; query_quarks[i].name; i++) {
162 if (type == query_quarks[i].type)
163 return query_quarks[i].quark;
169 * gst_query_type_get_flags:
170 * @type: a #GstQueryType
172 * Gets the #GstQueryTypeFlags associated with @type.
174 * Returns: a #GstQueryTypeFlags.
177 gst_query_type_get_flags (GstQueryType type)
179 GstQueryTypeFlags ret;
181 ret = type & ((1 << GST_QUERY_NUM_SHIFT) - 1);
187 _gst_query_free (GstQuery * query)
191 g_return_if_fail (query != NULL);
193 s = GST_QUERY_STRUCTURE (query);
195 gst_structure_set_parent_refcount (s, NULL);
196 gst_structure_free (s);
199 g_slice_free1 (sizeof (GstQueryImpl), query);
203 _gst_query_copy (GstQuery * query)
208 s = GST_QUERY_STRUCTURE (query);
210 s = gst_structure_copy (s);
212 copy = gst_query_new_custom (query->type, s);
218 * gst_query_new_position:
219 * @format: the default #GstFormat for the new query
221 * Constructs a new query stream position query object. Use gst_query_unref()
222 * when done with it. A position query is used to query the current position
223 * of playback in the streams, in some format.
225 * Free-function: gst_query_unref()
227 * Returns: (transfer full): a new #GstQuery
230 gst_query_new_position (GstFormat format)
233 GstStructure *structure;
235 structure = gst_structure_new_id (GST_QUARK (QUERY_POSITION),
236 GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
237 GST_QUARK (CURRENT), G_TYPE_INT64, G_GINT64_CONSTANT (-1), NULL);
239 query = gst_query_new_custom (GST_QUERY_POSITION, structure);
245 * gst_query_set_position:
246 * @query: a #GstQuery with query type GST_QUERY_POSITION
247 * @format: the requested #GstFormat
248 * @cur: the position to set
250 * Answer a position query by setting the requested value in the given format.
253 gst_query_set_position (GstQuery * query, GstFormat format, gint64 cur)
257 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_POSITION);
259 s = GST_QUERY_STRUCTURE (query);
260 g_return_if_fail (format == g_value_get_enum (gst_structure_id_get_value (s,
261 GST_QUARK (FORMAT))));
263 gst_structure_id_set (s,
264 GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
265 GST_QUARK (CURRENT), G_TYPE_INT64, cur, NULL);
269 * gst_query_parse_position:
270 * @query: a #GstQuery
271 * @format: (out) (allow-none): the storage for the #GstFormat of the
272 * position values (may be %NULL)
273 * @cur: (out) (allow-none): the storage for the current position (may be %NULL)
275 * Parse a position query, writing the format into @format, and the position
276 * into @cur, if the respective parameters are non-%NULL.
279 gst_query_parse_position (GstQuery * query, GstFormat * format, gint64 * cur)
281 GstStructure *structure;
283 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_POSITION);
285 structure = GST_QUERY_STRUCTURE (query);
288 (GstFormat) g_value_get_enum (gst_structure_id_get_value (structure,
289 GST_QUARK (FORMAT)));
291 *cur = g_value_get_int64 (gst_structure_id_get_value (structure,
292 GST_QUARK (CURRENT)));
297 * gst_query_new_duration:
298 * @format: the #GstFormat for this duration query
300 * Constructs a new stream duration query object to query in the given format.
301 * Use gst_query_unref() when done with it. A duration query will give the
302 * total length of the stream.
304 * Free-function: gst_query_unref()
306 * Returns: (transfer full): a new #GstQuery
309 gst_query_new_duration (GstFormat format)
312 GstStructure *structure;
314 structure = gst_structure_new_id (GST_QUARK (QUERY_DURATION),
315 GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
316 GST_QUARK (DURATION), G_TYPE_INT64, G_GINT64_CONSTANT (-1), NULL);
318 query = gst_query_new_custom (GST_QUERY_DURATION, structure);
324 * gst_query_set_duration:
325 * @query: a #GstQuery
326 * @format: the #GstFormat for the duration
327 * @duration: the duration of the stream
329 * Answer a duration query by setting the requested value in the given format.
332 gst_query_set_duration (GstQuery * query, GstFormat format, gint64 duration)
336 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_DURATION);
338 s = GST_QUERY_STRUCTURE (query);
339 g_return_if_fail (format == g_value_get_enum (gst_structure_id_get_value (s,
340 GST_QUARK (FORMAT))));
341 gst_structure_id_set (s, GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
342 GST_QUARK (DURATION), G_TYPE_INT64, duration, NULL);
346 * gst_query_parse_duration:
347 * @query: a #GstQuery
348 * @format: (out) (allow-none): the storage for the #GstFormat of the duration
350 * @duration: (out) (allow-none): the storage for the total duration, or %NULL.
352 * Parse a duration query answer. Write the format of the duration into @format,
353 * and the value into @duration, if the respective variables are non-%NULL.
356 gst_query_parse_duration (GstQuery * query, GstFormat * format,
359 GstStructure *structure;
361 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_DURATION);
363 structure = GST_QUERY_STRUCTURE (query);
366 (GstFormat) g_value_get_enum (gst_structure_id_get_value (structure,
367 GST_QUARK (FORMAT)));
369 *duration = g_value_get_int64 (gst_structure_id_get_value (structure,
370 GST_QUARK (DURATION)));
374 * gst_query_new_latency:
376 * Constructs a new latency query object.
377 * Use gst_query_unref() when done with it. A latency query is usually performed
378 * by sinks to compensate for additional latency introduced by elements in the
381 * Free-function: gst_query_unref()
383 * Returns: (transfer full): a #GstQuery
386 gst_query_new_latency (void)
389 GstStructure *structure;
391 structure = gst_structure_new_id (GST_QUARK (QUERY_LATENCY),
392 GST_QUARK (LIVE), G_TYPE_BOOLEAN, FALSE,
393 GST_QUARK (MIN_LATENCY), G_TYPE_UINT64, G_GUINT64_CONSTANT (0),
394 GST_QUARK (MAX_LATENCY), G_TYPE_UINT64, GST_CLOCK_TIME_NONE, NULL);
396 query = gst_query_new_custom (GST_QUERY_LATENCY, structure);
402 * gst_query_set_latency:
403 * @query: a #GstQuery
404 * @live: if there is a live element upstream
405 * @min_latency: the minimal latency of the upstream elements
406 * @max_latency: the maximal latency of the upstream elements
408 * Answer a latency query by setting the requested values in the given format.
411 gst_query_set_latency (GstQuery * query, gboolean live,
412 GstClockTime min_latency, GstClockTime max_latency)
414 GstStructure *structure;
416 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_LATENCY);
417 g_return_if_fail (GST_CLOCK_TIME_IS_VALID (min_latency));
419 structure = GST_QUERY_STRUCTURE (query);
420 gst_structure_id_set (structure,
421 GST_QUARK (LIVE), G_TYPE_BOOLEAN, live,
422 GST_QUARK (MIN_LATENCY), G_TYPE_UINT64, min_latency,
423 GST_QUARK (MAX_LATENCY), G_TYPE_UINT64, max_latency, NULL);
427 * gst_query_parse_latency:
428 * @query: a #GstQuery
429 * @live: (out) (allow-none): storage for live or %NULL
430 * @min_latency: (out) (allow-none): the storage for the min latency or %NULL
431 * @max_latency: (out) (allow-none): the storage for the max latency or %NULL
433 * Parse a latency query answer.
436 gst_query_parse_latency (GstQuery * query, gboolean * live,
437 GstClockTime * min_latency, GstClockTime * max_latency)
439 GstStructure *structure;
441 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_LATENCY);
443 structure = GST_QUERY_STRUCTURE (query);
446 g_value_get_boolean (gst_structure_id_get_value (structure,
449 *min_latency = g_value_get_uint64 (gst_structure_id_get_value (structure,
450 GST_QUARK (MIN_LATENCY)));
452 *max_latency = g_value_get_uint64 (gst_structure_id_get_value (structure,
453 GST_QUARK (MAX_LATENCY)));
457 * gst_query_new_convert:
458 * @src_format: the source #GstFormat for the new query
459 * @value: the value to convert
460 * @dest_format: the target #GstFormat
462 * Constructs a new convert query object. Use gst_query_unref()
463 * when done with it. A convert query is used to ask for a conversion between
464 * one format and another.
466 * Free-function: gst_query_unref()
468 * Returns: (transfer full): a #GstQuery
471 gst_query_new_convert (GstFormat src_format, gint64 value,
472 GstFormat dest_format)
475 GstStructure *structure;
477 structure = gst_structure_new_id (GST_QUARK (QUERY_CONVERT),
478 GST_QUARK (SRC_FORMAT), GST_TYPE_FORMAT, src_format,
479 GST_QUARK (SRC_VALUE), G_TYPE_INT64, value,
480 GST_QUARK (DEST_FORMAT), GST_TYPE_FORMAT, dest_format,
481 GST_QUARK (DEST_VALUE), G_TYPE_INT64, G_GINT64_CONSTANT (-1), NULL);
483 query = gst_query_new_custom (GST_QUERY_CONVERT, structure);
489 * gst_query_set_convert:
490 * @query: a #GstQuery
491 * @src_format: the source #GstFormat
492 * @src_value: the source value
493 * @dest_format: the destination #GstFormat
494 * @dest_value: the destination value
496 * Answer a convert query by setting the requested values.
499 gst_query_set_convert (GstQuery * query, GstFormat src_format, gint64 src_value,
500 GstFormat dest_format, gint64 dest_value)
502 GstStructure *structure;
504 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CONVERT);
506 structure = GST_QUERY_STRUCTURE (query);
507 gst_structure_id_set (structure,
508 GST_QUARK (SRC_FORMAT), GST_TYPE_FORMAT, src_format,
509 GST_QUARK (SRC_VALUE), G_TYPE_INT64, src_value,
510 GST_QUARK (DEST_FORMAT), GST_TYPE_FORMAT, dest_format,
511 GST_QUARK (DEST_VALUE), G_TYPE_INT64, dest_value, NULL);
515 * gst_query_parse_convert:
516 * @query: a #GstQuery
517 * @src_format: (out) (allow-none): the storage for the #GstFormat of the
518 * source value, or %NULL
519 * @src_value: (out) (allow-none): the storage for the source value, or %NULL
520 * @dest_format: (out) (allow-none): the storage for the #GstFormat of the
521 * destination value, or %NULL
522 * @dest_value: (out) (allow-none): the storage for the destination value,
525 * Parse a convert query answer. Any of @src_format, @src_value, @dest_format,
526 * and @dest_value may be %NULL, in which case that value is omitted.
529 gst_query_parse_convert (GstQuery * query, GstFormat * src_format,
530 gint64 * src_value, GstFormat * dest_format, gint64 * dest_value)
532 GstStructure *structure;
534 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CONVERT);
536 structure = GST_QUERY_STRUCTURE (query);
539 (GstFormat) g_value_get_enum (gst_structure_id_get_value (structure,
540 GST_QUARK (SRC_FORMAT)));
542 *src_value = g_value_get_int64 (gst_structure_id_get_value (structure,
543 GST_QUARK (SRC_VALUE)));
546 (GstFormat) g_value_get_enum (gst_structure_id_get_value (structure,
547 GST_QUARK (DEST_FORMAT)));
549 *dest_value = g_value_get_int64 (gst_structure_id_get_value (structure,
550 GST_QUARK (DEST_VALUE)));
554 * gst_query_new_segment:
555 * @format: the #GstFormat for the new query
557 * Constructs a new segment query object. Use gst_query_unref()
558 * when done with it. A segment query is used to discover information about the
559 * currently configured segment for playback.
561 * Free-function: gst_query_unref()
563 * Returns: (transfer full): a new #GstQuery
566 gst_query_new_segment (GstFormat format)
569 GstStructure *structure;
571 structure = gst_structure_new_id (GST_QUARK (QUERY_SEGMENT),
572 GST_QUARK (RATE), G_TYPE_DOUBLE, (gdouble) 0.0,
573 GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
574 GST_QUARK (START_VALUE), G_TYPE_INT64, G_GINT64_CONSTANT (-1),
575 GST_QUARK (STOP_VALUE), G_TYPE_INT64, G_GINT64_CONSTANT (-1), NULL);
577 query = gst_query_new_custom (GST_QUERY_SEGMENT, structure);
583 * gst_query_set_segment:
584 * @query: a #GstQuery
585 * @rate: the rate of the segment
586 * @format: the #GstFormat of the segment values (@start_value and @stop_value)
587 * @start_value: the start value
588 * @stop_value: the stop value
590 * Answer a segment query by setting the requested values. The normal
591 * playback segment of a pipeline is 0 to duration at the default rate of
592 * 1.0. If a seek was performed on the pipeline to play a different
593 * segment, this query will return the range specified in the last seek.
595 * @start_value and @stop_value will respectively contain the configured
596 * playback range start and stop values expressed in @format.
597 * The values are always between 0 and the duration of the media and
598 * @start_value <= @stop_value. @rate will contain the playback rate. For
599 * negative rates, playback will actually happen from @stop_value to
603 gst_query_set_segment (GstQuery * query, gdouble rate, GstFormat format,
604 gint64 start_value, gint64 stop_value)
606 GstStructure *structure;
608 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SEGMENT);
610 structure = GST_QUERY_STRUCTURE (query);
611 gst_structure_id_set (structure,
612 GST_QUARK (RATE), G_TYPE_DOUBLE, rate,
613 GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
614 GST_QUARK (START_VALUE), G_TYPE_INT64, start_value,
615 GST_QUARK (STOP_VALUE), G_TYPE_INT64, stop_value, NULL);
619 * gst_query_parse_segment:
620 * @query: a #GstQuery
621 * @rate: (out) (allow-none): the storage for the rate of the segment, or %NULL
622 * @format: (out) (allow-none): the storage for the #GstFormat of the values,
624 * @start_value: (out) (allow-none): the storage for the start value, or %NULL
625 * @stop_value: (out) (allow-none): the storage for the stop value, or %NULL
627 * Parse a segment query answer. Any of @rate, @format, @start_value, and
628 * @stop_value may be %NULL, which will cause this value to be omitted.
630 * See gst_query_set_segment() for an explanation of the function arguments.
633 gst_query_parse_segment (GstQuery * query, gdouble * rate, GstFormat * format,
634 gint64 * start_value, gint64 * stop_value)
636 GstStructure *structure;
638 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SEGMENT);
640 structure = GST_QUERY_STRUCTURE (query);
642 *rate = g_value_get_double (gst_structure_id_get_value (structure,
646 (GstFormat) g_value_get_enum (gst_structure_id_get_value (structure,
647 GST_QUARK (FORMAT)));
649 *start_value = g_value_get_int64 (gst_structure_id_get_value (structure,
650 GST_QUARK (START_VALUE)));
652 *stop_value = g_value_get_int64 (gst_structure_id_get_value (structure,
653 GST_QUARK (STOP_VALUE)));
657 * gst_query_new_custom:
658 * @type: the query type
659 * @structure: (allow-none) (transfer full): a structure for the query
661 * Constructs a new custom query object. Use gst_query_unref()
664 * Free-function: gst_query_unref()
666 * Returns: (transfer full): a new #GstQuery
669 gst_query_new_custom (GstQueryType type, GstStructure * structure)
673 query = g_slice_new0 (GstQueryImpl);
675 GST_DEBUG ("creating new query %p %s", query, gst_query_type_get_name (type));
678 /* structure must not have a parent */
679 if (!gst_structure_set_parent_refcount (structure,
680 &query->query.mini_object.refcount))
684 gst_mini_object_init (GST_MINI_OBJECT_CAST (query), 0, _gst_query_type,
685 (GstMiniObjectCopyFunction) _gst_query_copy, NULL,
686 (GstMiniObjectFreeFunction) _gst_query_free);
688 GST_QUERY_TYPE (query) = type;
689 GST_QUERY_STRUCTURE (query) = structure;
691 return GST_QUERY_CAST (query);
696 g_slice_free1 (sizeof (GstQueryImpl), query);
697 g_warning ("structure is already owned by another object");
703 * gst_query_get_structure:
704 * @query: a #GstQuery
706 * Get the structure of a query.
708 * Returns: (transfer none): the #GstStructure of the query. The structure is
709 * still owned by the query and will therefore be freed when the query
713 gst_query_get_structure (GstQuery * query)
715 g_return_val_if_fail (GST_IS_QUERY (query), NULL);
717 return GST_QUERY_STRUCTURE (query);
721 * gst_query_writable_structure:
722 * @query: a #GstQuery
724 * Get the structure of a query. This method should be called with a writable
725 * @query so that the returned structure is guaranteed to be writable.
727 * Returns: (transfer none): the #GstStructure of the query. The structure is
728 * still owned by the query and will therefore be freed when the query
732 gst_query_writable_structure (GstQuery * query)
734 GstStructure *structure;
736 g_return_val_if_fail (GST_IS_QUERY (query), NULL);
737 g_return_val_if_fail (gst_query_is_writable (query), NULL);
739 structure = GST_QUERY_STRUCTURE (query);
741 if (structure == NULL) {
743 gst_structure_new_id_empty (gst_query_type_to_quark (GST_QUERY_TYPE
745 gst_structure_set_parent_refcount (structure, &query->mini_object.refcount);
746 GST_QUERY_STRUCTURE (query) = structure;
752 * gst_query_new_seeking:
753 * @format: the default #GstFormat for the new query
755 * Constructs a new query object for querying seeking properties of
758 * Free-function: gst_query_unref()
760 * Returns: (transfer full): a new #GstQuery
763 gst_query_new_seeking (GstFormat format)
766 GstStructure *structure;
768 structure = gst_structure_new_id (GST_QUARK (QUERY_SEEKING),
769 GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
770 GST_QUARK (SEEKABLE), G_TYPE_BOOLEAN, FALSE,
771 GST_QUARK (SEGMENT_START), G_TYPE_INT64, G_GINT64_CONSTANT (-1),
772 GST_QUARK (SEGMENT_END), G_TYPE_INT64, G_GINT64_CONSTANT (-1), NULL);
774 query = gst_query_new_custom (GST_QUERY_SEEKING, structure);
780 * gst_query_set_seeking:
781 * @query: a #GstQuery
782 * @format: the format to set for the @segment_start and @segment_end values
783 * @seekable: the seekable flag to set
784 * @segment_start: the segment_start to set
785 * @segment_end: the segment_end to set
787 * Set the seeking query result fields in @query.
790 gst_query_set_seeking (GstQuery * query, GstFormat format,
791 gboolean seekable, gint64 segment_start, gint64 segment_end)
793 GstStructure *structure;
795 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SEEKING);
796 g_return_if_fail (gst_query_is_writable (query));
798 structure = GST_QUERY_STRUCTURE (query);
799 gst_structure_id_set (structure,
800 GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
801 GST_QUARK (SEEKABLE), G_TYPE_BOOLEAN, seekable,
802 GST_QUARK (SEGMENT_START), G_TYPE_INT64, segment_start,
803 GST_QUARK (SEGMENT_END), G_TYPE_INT64, segment_end, NULL);
807 * gst_query_parse_seeking:
808 * @query: a GST_QUERY_SEEKING type query #GstQuery
809 * @format: (out) (allow-none): the format to set for the @segment_start
810 * and @segment_end values, or %NULL
811 * @seekable: (out) (allow-none): the seekable flag to set, or %NULL
812 * @segment_start: (out) (allow-none): the segment_start to set, or %NULL
813 * @segment_end: (out) (allow-none): the segment_end to set, or %NULL
815 * Parse a seeking query, writing the format into @format, and
816 * other results into the passed parameters, if the respective parameters
820 gst_query_parse_seeking (GstQuery * query, GstFormat * format,
821 gboolean * seekable, gint64 * segment_start, gint64 * segment_end)
823 GstStructure *structure;
825 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SEEKING);
827 structure = GST_QUERY_STRUCTURE (query);
830 (GstFormat) g_value_get_enum (gst_structure_id_get_value (structure,
831 GST_QUARK (FORMAT)));
833 *seekable = g_value_get_boolean (gst_structure_id_get_value (structure,
834 GST_QUARK (SEEKABLE)));
836 *segment_start = g_value_get_int64 (gst_structure_id_get_value (structure,
837 GST_QUARK (SEGMENT_START)));
839 *segment_end = g_value_get_int64 (gst_structure_id_get_value (structure,
840 GST_QUARK (SEGMENT_END)));
844 ensure_array (GstStructure * s, GQuark quark, gsize element_size,
845 GDestroyNotify clear_func)
850 value = gst_structure_id_get_value (s, quark);
852 array = (GArray *) g_value_get_boxed (value);
854 GValue new_array_val = { 0, };
856 array = g_array_new (FALSE, TRUE, element_size);
858 g_array_set_clear_func (array, clear_func);
860 g_value_init (&new_array_val, G_TYPE_ARRAY);
861 g_value_take_boxed (&new_array_val, array);
863 gst_structure_id_take_value (s, quark, &new_array_val);
869 * gst_query_new_formats:
871 * Constructs a new query object for querying formats of
874 * Free-function: gst_query_unref()
876 * Returns: (transfer full): a new #GstQuery
879 gst_query_new_formats (void)
882 GstStructure *structure;
884 structure = gst_structure_new_id_empty (GST_QUARK (QUERY_FORMATS));
885 query = gst_query_new_custom (GST_QUERY_FORMATS, structure);
891 gst_query_list_add_format (GValue * list, GstFormat format)
893 GValue item = { 0, };
895 g_value_init (&item, GST_TYPE_FORMAT);
896 g_value_set_enum (&item, format);
897 gst_value_list_append_value (list, &item);
898 g_value_unset (&item);
902 * gst_query_set_formats:
903 * @query: a #GstQuery
904 * @n_formats: the number of formats to set.
905 * @...: A number of @GstFormats equal to @n_formats.
907 * Set the formats query result fields in @query. The number of formats passed
908 * must be equal to @n_formats.
911 gst_query_set_formats (GstQuery * query, gint n_formats, ...)
914 GValue list = { 0, };
916 GstStructure *structure;
918 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_FORMATS);
919 g_return_if_fail (gst_query_is_writable (query));
921 g_value_init (&list, GST_TYPE_LIST);
923 va_start (ap, n_formats);
924 for (i = 0; i < n_formats; i++) {
925 gst_query_list_add_format (&list, va_arg (ap, GstFormat));
929 structure = GST_QUERY_STRUCTURE (query);
930 gst_structure_set_value (structure, "formats", &list);
932 g_value_unset (&list);
937 * gst_query_set_formatsv:
938 * @query: a #GstQuery
939 * @n_formats: the number of formats to set.
940 * @formats: (in) (array length=n_formats): an array containing @n_formats
943 * Set the formats query result fields in @query. The number of formats passed
944 * in the @formats array must be equal to @n_formats.
947 gst_query_set_formatsv (GstQuery * query, gint n_formats,
948 const GstFormat * formats)
950 GValue list = { 0, };
952 GstStructure *structure;
954 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_FORMATS);
955 g_return_if_fail (gst_query_is_writable (query));
957 g_value_init (&list, GST_TYPE_LIST);
958 for (i = 0; i < n_formats; i++) {
959 gst_query_list_add_format (&list, formats[i]);
961 structure = GST_QUERY_STRUCTURE (query);
962 gst_structure_set_value (structure, "formats", &list);
964 g_value_unset (&list);
968 * gst_query_parse_n_formats:
969 * @query: a #GstQuery
970 * @n_formats: (out) (allow-none): the number of formats in this query.
972 * Parse the number of formats in the formats @query.
975 gst_query_parse_n_formats (GstQuery * query, guint * n_formats)
977 GstStructure *structure;
979 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_FORMATS);
984 structure = GST_QUERY_STRUCTURE (query);
985 list = gst_structure_get_value (structure, "formats");
989 *n_formats = gst_value_list_get_size (list);
994 * gst_query_parse_nth_format:
995 * @query: a #GstQuery
996 * @nth: (out): the nth format to retrieve.
997 * @format: (out) (allow-none): a pointer to store the nth format
999 * Parse the format query and retrieve the @nth format from it into
1000 * @format. If the list contains less elements than @nth, @format will be
1001 * set to GST_FORMAT_UNDEFINED.
1004 gst_query_parse_nth_format (GstQuery * query, guint nth, GstFormat * format)
1006 GstStructure *structure;
1008 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_FORMATS);
1013 structure = GST_QUERY_STRUCTURE (query);
1014 list = gst_structure_get_value (structure, "formats");
1016 *format = GST_FORMAT_UNDEFINED;
1018 if (nth < gst_value_list_get_size (list)) {
1020 (GstFormat) g_value_get_enum (gst_value_list_get_value (list, nth));
1022 *format = GST_FORMAT_UNDEFINED;
1028 * gst_query_new_buffering:
1029 * @format: the default #GstFormat for the new query
1031 * Constructs a new query object for querying the buffering status of
1034 * Free-function: gst_query_unref()
1036 * Returns: (transfer full): a new #GstQuery
1039 gst_query_new_buffering (GstFormat format)
1042 GstStructure *structure;
1044 /* by default, we configure the answer as no buffering with a 100% buffering
1046 structure = gst_structure_new_id (GST_QUARK (QUERY_BUFFERING),
1047 GST_QUARK (BUSY), G_TYPE_BOOLEAN, FALSE,
1048 GST_QUARK (BUFFER_PERCENT), G_TYPE_INT, 100,
1049 GST_QUARK (BUFFERING_MODE), GST_TYPE_BUFFERING_MODE, GST_BUFFERING_STREAM,
1050 GST_QUARK (AVG_IN_RATE), G_TYPE_INT, -1,
1051 GST_QUARK (AVG_OUT_RATE), G_TYPE_INT, -1,
1052 GST_QUARK (BUFFERING_LEFT), G_TYPE_INT64, G_GINT64_CONSTANT (0),
1053 GST_QUARK (ESTIMATED_TOTAL), G_TYPE_INT64, G_GINT64_CONSTANT (-1),
1054 GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
1055 GST_QUARK (START_VALUE), G_TYPE_INT64, G_GINT64_CONSTANT (-1),
1056 GST_QUARK (STOP_VALUE), G_TYPE_INT64, G_GINT64_CONSTANT (-1), NULL);
1058 query = gst_query_new_custom (GST_QUERY_BUFFERING, structure);
1064 * gst_query_set_buffering_percent:
1065 * @query: A valid #GstQuery of type GST_QUERY_BUFFERING.
1066 * @busy: if buffering is busy
1067 * @percent: a buffering percent
1069 * Set the percentage of buffered data. This is a value between 0 and 100.
1070 * The @busy indicator is %TRUE when the buffering is in progress.
1073 gst_query_set_buffering_percent (GstQuery * query, gboolean busy, gint percent)
1075 GstStructure *structure;
1077 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING);
1078 g_return_if_fail (gst_query_is_writable (query));
1079 g_return_if_fail (percent >= 0 && percent <= 100);
1081 structure = GST_QUERY_STRUCTURE (query);
1082 gst_structure_id_set (structure,
1083 GST_QUARK (BUSY), G_TYPE_BOOLEAN, busy,
1084 GST_QUARK (BUFFER_PERCENT), G_TYPE_INT, percent, NULL);
1088 * gst_query_parse_buffering_percent:
1089 * @query: A valid #GstQuery of type GST_QUERY_BUFFERING.
1090 * @busy: (out) (allow-none): if buffering is busy, or %NULL
1091 * @percent: (out) (allow-none): a buffering percent, or %NULL
1093 * Get the percentage of buffered data. This is a value between 0 and 100.
1094 * The @busy indicator is %TRUE when the buffering is in progress.
1097 gst_query_parse_buffering_percent (GstQuery * query, gboolean * busy,
1100 GstStructure *structure;
1102 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING);
1104 structure = GST_QUERY_STRUCTURE (query);
1106 *busy = g_value_get_boolean (gst_structure_id_get_value (structure,
1109 *percent = g_value_get_int (gst_structure_id_get_value (structure,
1110 GST_QUARK (BUFFER_PERCENT)));
1114 * gst_query_set_buffering_stats:
1115 * @query: A valid #GstQuery of type GST_QUERY_BUFFERING.
1116 * @mode: a buffering mode
1117 * @avg_in: the average input rate
1118 * @avg_out: the average output rate
1119 * @buffering_left: amount of buffering time left in milliseconds
1121 * Configures the buffering stats values in @query.
1124 gst_query_set_buffering_stats (GstQuery * query, GstBufferingMode mode,
1125 gint avg_in, gint avg_out, gint64 buffering_left)
1127 GstStructure *structure;
1129 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING);
1130 g_return_if_fail (gst_query_is_writable (query));
1132 structure = GST_QUERY_STRUCTURE (query);
1133 gst_structure_id_set (structure,
1134 GST_QUARK (BUFFERING_MODE), GST_TYPE_BUFFERING_MODE, mode,
1135 GST_QUARK (AVG_IN_RATE), G_TYPE_INT, avg_in,
1136 GST_QUARK (AVG_OUT_RATE), G_TYPE_INT, avg_out,
1137 GST_QUARK (BUFFERING_LEFT), G_TYPE_INT64, buffering_left, NULL);
1141 * gst_query_parse_buffering_stats:
1142 * @query: A valid #GstQuery of type GST_QUERY_BUFFERING.
1143 * @mode: (out) (allow-none): a buffering mode, or %NULL
1144 * @avg_in: (out) (allow-none): the average input rate, or %NULL
1145 * @avg_out: (out) (allow-none): the average output rat, or %NULL
1146 * @buffering_left: (out) (allow-none): amount of buffering time left in
1147 * milliseconds, or %NULL
1149 * Extracts the buffering stats values from @query.
1152 gst_query_parse_buffering_stats (GstQuery * query,
1153 GstBufferingMode * mode, gint * avg_in, gint * avg_out,
1154 gint64 * buffering_left)
1156 GstStructure *structure;
1158 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING);
1160 structure = GST_QUERY_STRUCTURE (query);
1162 *mode = (GstBufferingMode)
1163 g_value_get_enum (gst_structure_id_get_value (structure,
1164 GST_QUARK (BUFFERING_MODE)));
1166 *avg_in = g_value_get_int (gst_structure_id_get_value (structure,
1167 GST_QUARK (AVG_IN_RATE)));
1169 *avg_out = g_value_get_int (gst_structure_id_get_value (structure,
1170 GST_QUARK (AVG_OUT_RATE)));
1173 g_value_get_int64 (gst_structure_id_get_value (structure,
1174 GST_QUARK (BUFFERING_LEFT)));
1178 * gst_query_set_buffering_range:
1179 * @query: a #GstQuery
1180 * @format: the format to set for the @start and @stop values
1181 * @start: the start to set
1182 * @stop: the stop to set
1183 * @estimated_total: estimated total amount of download time remaining in
1186 * Set the available query result fields in @query.
1189 gst_query_set_buffering_range (GstQuery * query, GstFormat format,
1190 gint64 start, gint64 stop, gint64 estimated_total)
1192 GstStructure *structure;
1194 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING);
1195 g_return_if_fail (gst_query_is_writable (query));
1197 structure = GST_QUERY_STRUCTURE (query);
1198 gst_structure_id_set (structure,
1199 GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
1200 GST_QUARK (START_VALUE), G_TYPE_INT64, start,
1201 GST_QUARK (STOP_VALUE), G_TYPE_INT64, stop,
1202 GST_QUARK (ESTIMATED_TOTAL), G_TYPE_INT64, estimated_total, NULL);
1206 * gst_query_parse_buffering_range:
1207 * @query: a GST_QUERY_BUFFERING type query #GstQuery
1208 * @format: (out) (allow-none): the format to set for the @segment_start
1209 * and @segment_end values, or %NULL
1210 * @start: (out) (allow-none): the start to set, or %NULL
1211 * @stop: (out) (allow-none): the stop to set, or %NULL
1212 * @estimated_total: (out) (allow-none): estimated total amount of download
1213 * time remaining in milliseconds, or %NULL
1215 * Parse an available query, writing the format into @format, and
1216 * other results into the passed parameters, if the respective parameters
1220 gst_query_parse_buffering_range (GstQuery * query, GstFormat * format,
1221 gint64 * start, gint64 * stop, gint64 * estimated_total)
1223 GstStructure *structure;
1225 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING);
1227 structure = GST_QUERY_STRUCTURE (query);
1230 (GstFormat) g_value_get_enum (gst_structure_id_get_value (structure,
1231 GST_QUARK (FORMAT)));
1233 *start = g_value_get_int64 (gst_structure_id_get_value (structure,
1234 GST_QUARK (START_VALUE)));
1236 *stop = g_value_get_int64 (gst_structure_id_get_value (structure,
1237 GST_QUARK (STOP_VALUE)));
1238 if (estimated_total)
1240 g_value_get_int64 (gst_structure_id_get_value (structure,
1241 GST_QUARK (ESTIMATED_TOTAL)));
1244 /* GstQueryBufferingRange: internal struct for GArray */
1249 } GstQueryBufferingRange;
1252 * gst_query_add_buffering_range:
1253 * @query: a GST_QUERY_BUFFERING type query #GstQuery
1254 * @start: start position of the range
1255 * @stop: stop position of the range
1257 * Set the buffering-ranges array field in @query. The current last
1258 * start position of the array should be inferior to @start.
1260 * Returns: a #gboolean indicating if the range was added or not.
1263 gst_query_add_buffering_range (GstQuery * query, gint64 start, gint64 stop)
1265 GstQueryBufferingRange range;
1266 GstStructure *structure;
1269 g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING, FALSE);
1270 g_return_val_if_fail (gst_query_is_writable (query), FALSE);
1272 if (G_UNLIKELY (start >= stop))
1275 structure = GST_QUERY_STRUCTURE (query);
1276 array = ensure_array (structure, GST_QUARK (BUFFERING_RANGES),
1277 sizeof (GstQueryBufferingRange), NULL);
1279 if (array->len > 1) {
1280 GstQueryBufferingRange *last;
1282 last = &g_array_index (array, GstQueryBufferingRange, array->len - 1);
1284 if (G_UNLIKELY (start <= last->start))
1288 range.start = start;
1290 g_array_append_val (array, range);
1296 * gst_query_get_n_buffering_ranges:
1297 * @query: a GST_QUERY_BUFFERING type query #GstQuery
1299 * Retrieve the number of values currently stored in the
1300 * buffered-ranges array of the query's structure.
1302 * Returns: the range array size as a #guint.
1305 gst_query_get_n_buffering_ranges (GstQuery * query)
1307 GstStructure *structure;
1310 g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING, 0);
1312 structure = GST_QUERY_STRUCTURE (query);
1313 array = ensure_array (structure, GST_QUARK (BUFFERING_RANGES),
1314 sizeof (GstQueryBufferingRange), NULL);
1321 * gst_query_parse_nth_buffering_range:
1322 * @query: a GST_QUERY_BUFFERING type query #GstQuery
1323 * @index: position in the buffered-ranges array to read
1324 * @start: (out) (allow-none): the start position to set, or %NULL
1325 * @stop: (out) (allow-none): the stop position to set, or %NULL
1327 * Parse an available query and get the start and stop values stored
1328 * at the @index of the buffered ranges array.
1330 * Returns: a #gboolean indicating if the parsing succeeded.
1333 gst_query_parse_nth_buffering_range (GstQuery * query, guint index,
1334 gint64 * start, gint64 * stop)
1336 GstQueryBufferingRange *range;
1337 GstStructure *structure;
1340 g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING, FALSE);
1342 structure = GST_QUERY_STRUCTURE (query);
1344 array = ensure_array (structure, GST_QUARK (BUFFERING_RANGES),
1345 sizeof (GstQueryBufferingRange), NULL);
1346 g_return_val_if_fail (index < array->len, FALSE);
1348 range = &g_array_index (array, GstQueryBufferingRange, index);
1351 *start = range->start;
1353 *stop = range->stop;
1360 * gst_query_new_uri:
1362 * Constructs a new query URI query object. Use gst_query_unref()
1363 * when done with it. An URI query is used to query the current URI
1364 * that is used by the source or sink.
1366 * Free-function: gst_query_unref()
1368 * Returns: (transfer full): a new #GstQuery
1371 gst_query_new_uri (void)
1374 GstStructure *structure;
1376 structure = gst_structure_new_id (GST_QUARK (QUERY_URI),
1377 GST_QUARK (URI), G_TYPE_STRING, NULL, NULL);
1379 query = gst_query_new_custom (GST_QUERY_URI, structure);
1385 * gst_query_set_uri:
1386 * @query: a #GstQuery with query type GST_QUERY_URI
1387 * @uri: the URI to set
1389 * Answer a URI query by setting the requested URI.
1392 gst_query_set_uri (GstQuery * query, const gchar * uri)
1394 GstStructure *structure;
1396 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_URI);
1397 g_return_if_fail (gst_query_is_writable (query));
1398 g_return_if_fail (gst_uri_is_valid (uri));
1400 structure = GST_QUERY_STRUCTURE (query);
1401 gst_structure_id_set (structure, GST_QUARK (URI), G_TYPE_STRING, uri, NULL);
1405 * gst_query_parse_uri:
1406 * @query: a #GstQuery
1407 * @uri: (out) (transfer full) (allow-none): the storage for the current URI
1410 * Parse an URI query, writing the URI into @uri as a newly
1411 * allocated string, if the respective parameters are non-%NULL.
1412 * Free the string with g_free() after usage.
1415 gst_query_parse_uri (GstQuery * query, gchar ** uri)
1417 GstStructure *structure;
1419 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_URI);
1421 structure = GST_QUERY_STRUCTURE (query);
1423 *uri = g_value_dup_string (gst_structure_id_get_value (structure,
1428 * gst_query_set_uri_redirection:
1429 * @query: a #GstQuery with query type GST_QUERY_URI
1430 * @uri: the URI to set
1432 * Answer a URI query by setting the requested URI redirection.
1437 gst_query_set_uri_redirection (GstQuery * query, const gchar * uri)
1439 GstStructure *structure;
1441 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_URI);
1442 g_return_if_fail (gst_query_is_writable (query));
1443 g_return_if_fail (gst_uri_is_valid (uri));
1445 structure = GST_QUERY_STRUCTURE (query);
1446 gst_structure_id_set (structure, GST_QUARK (URI_REDIRECTION),
1447 G_TYPE_STRING, uri, NULL);
1451 * gst_query_parse_uri_redirection:
1452 * @query: a #GstQuery
1453 * @uri: (out) (transfer full) (allow-none): the storage for the redirect URI
1456 * Parse an URI query, writing the URI into @uri as a newly
1457 * allocated string, if the respective parameters are non-%NULL.
1458 * Free the string with g_free() after usage.
1463 gst_query_parse_uri_redirection (GstQuery * query, gchar ** uri)
1465 GstStructure *structure;
1467 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_URI);
1469 structure = GST_QUERY_STRUCTURE (query);
1471 if (!gst_structure_id_get (structure, GST_QUARK (URI_REDIRECTION),
1472 G_TYPE_STRING, uri, NULL))
1478 * gst_query_set_uri_redirection_permanent:
1479 * @query: a #GstQuery with query type %GST_QUERY_URI
1480 * @permanent: whether the redirect is permanent or not
1482 * Answer a URI query by setting the requested URI redirection
1483 * to permanent or not.
1488 gst_query_set_uri_redirection_permanent (GstQuery * query, gboolean permanent)
1490 GstStructure *structure;
1492 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_URI);
1493 g_return_if_fail (gst_query_is_writable (query));
1495 structure = GST_QUERY_STRUCTURE (query);
1496 gst_structure_id_set (structure, GST_QUARK (URI_REDIRECTION_PERMANENT),
1497 G_TYPE_BOOLEAN, permanent, NULL);
1501 * gst_query_parse_uri_redirection_permanent:
1502 * @query: a #GstQuery
1503 * @permanent: (out) (allow-none): if the URI redirection is permanent
1506 * Parse an URI query, and set @permanent to %TRUE if there is a redirection
1507 * and it should be considered permanent. If a redirection is permanent,
1508 * applications should update their internal storage of the URI, otherwise
1509 * they should make all future requests to the original URI.
1514 gst_query_parse_uri_redirection_permanent (GstQuery * query,
1515 gboolean * permanent)
1517 GstStructure *structure;
1519 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_URI);
1521 structure = GST_QUERY_STRUCTURE (query);
1523 if (!gst_structure_id_get (structure, GST_QUARK (URI_REDIRECTION_PERMANENT),
1524 G_TYPE_BOOLEAN, permanent, NULL))
1530 * gst_query_new_allocation:
1531 * @caps: the negotiated caps
1532 * @need_pool: return a pool
1534 * Constructs a new query object for querying the allocation properties.
1536 * Free-function: gst_query_unref()
1538 * Returns: (transfer full): a new #GstQuery
1541 gst_query_new_allocation (GstCaps * caps, gboolean need_pool)
1544 GstStructure *structure;
1546 structure = gst_structure_new_id (GST_QUARK (QUERY_ALLOCATION),
1547 GST_QUARK (CAPS), GST_TYPE_CAPS, caps,
1548 GST_QUARK (NEED_POOL), G_TYPE_BOOLEAN, need_pool, NULL);
1550 query = gst_query_new_custom (GST_QUERY_ALLOCATION, structure);
1556 * gst_query_parse_allocation:
1557 * @query: a #GstQuery
1558 * @caps: (out) (transfer none) (allow-none): The #GstCaps
1559 * @need_pool: (out) (allow-none): Whether a #GstBufferPool is needed
1561 * Parse an allocation query, writing the requested caps in @caps and
1562 * whether a pool is needed in @need_pool, if the respective parameters
1565 * Pool details can be retrieved using gst_query_get_n_allocation_pools() and
1566 * gst_query_parse_nth_allocation_pool().
1569 gst_query_parse_allocation (GstQuery * query, GstCaps ** caps,
1570 gboolean * need_pool)
1572 GstStructure *structure;
1574 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1576 structure = GST_QUERY_STRUCTURE (query);
1578 *caps = g_value_get_boxed (gst_structure_id_get_value (structure,
1581 gst_structure_id_get (structure,
1582 GST_QUARK (NEED_POOL), G_TYPE_BOOLEAN, need_pool, NULL);
1587 GstBufferPool *pool;
1594 allocation_pool_free (AllocationPool * ap)
1597 gst_object_unref (ap->pool);
1601 * gst_query_add_allocation_pool:
1602 * @query: A valid #GstQuery of type GST_QUERY_ALLOCATION.
1603 * @pool: (transfer none) (allow-none): the #GstBufferPool
1604 * @size: the buffer size
1605 * @min_buffers: the min buffers
1606 * @max_buffers: the max buffers
1608 * Set the pool parameters in @query.
1611 gst_query_add_allocation_pool (GstQuery * query, GstBufferPool * pool,
1612 guint size, guint min_buffers, guint max_buffers)
1615 GstStructure *structure;
1618 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1619 g_return_if_fail (gst_query_is_writable (query));
1621 structure = GST_QUERY_STRUCTURE (query);
1622 array = ensure_array (structure, GST_QUARK (POOL),
1623 sizeof (AllocationPool), (GDestroyNotify) allocation_pool_free);
1625 if ((ap.pool = pool))
1626 gst_object_ref (pool);
1628 ap.min_buffers = min_buffers;
1629 ap.max_buffers = max_buffers;
1631 g_array_append_val (array, ap);
1635 * gst_query_get_n_allocation_pools:
1636 * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1638 * Retrieve the number of values currently stored in the
1639 * pool array of the query's structure.
1641 * Returns: the pool array size as a #guint.
1644 gst_query_get_n_allocation_pools (GstQuery * query)
1647 GstStructure *structure;
1649 g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION, 0);
1651 structure = GST_QUERY_STRUCTURE (query);
1652 array = ensure_array (structure, GST_QUARK (POOL),
1653 sizeof (AllocationPool), (GDestroyNotify) allocation_pool_free);
1659 * gst_query_parse_nth_allocation_pool:
1660 * @query: A valid #GstQuery of type GST_QUERY_ALLOCATION.
1661 * @index: index to parse
1662 * @pool: (out) (allow-none) (transfer full): the #GstBufferPool
1663 * @size: (out) (allow-none): the buffer size
1664 * @min_buffers: (out) (allow-none): the min buffers
1665 * @max_buffers: (out) (allow-none): the max buffers
1667 * Get the pool parameters in @query.
1669 * Unref @pool with gst_object_unref() when it's not needed any more.
1672 gst_query_parse_nth_allocation_pool (GstQuery * query, guint index,
1673 GstBufferPool ** pool, guint * size, guint * min_buffers,
1674 guint * max_buffers)
1677 GstStructure *structure;
1680 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1682 structure = GST_QUERY_STRUCTURE (query);
1683 array = ensure_array (structure, GST_QUARK (POOL),
1684 sizeof (AllocationPool), (GDestroyNotify) allocation_pool_free);
1685 g_return_if_fail (index < array->len);
1687 ap = &g_array_index (array, AllocationPool, index);
1690 if ((*pool = ap->pool))
1691 gst_object_ref (*pool);
1695 *min_buffers = ap->min_buffers;
1697 *max_buffers = ap->max_buffers;
1701 * gst_query_set_nth_allocation_pool:
1702 * @index: index to modify
1703 * @query: A valid #GstQuery of type GST_QUERY_ALLOCATION.
1704 * @pool: (transfer none) (allow-none): the #GstBufferPool
1705 * @size: the buffer size
1706 * @min_buffers: the min buffers
1707 * @max_buffers: the max buffers
1709 * Set the pool parameters in @query.
1712 gst_query_set_nth_allocation_pool (GstQuery * query, guint index,
1713 GstBufferPool * pool, guint size, guint min_buffers, guint max_buffers)
1716 GstStructure *structure;
1717 AllocationPool *oldap, ap;
1719 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1721 structure = GST_QUERY_STRUCTURE (query);
1722 array = ensure_array (structure, GST_QUARK (POOL),
1723 sizeof (AllocationPool), (GDestroyNotify) allocation_pool_free);
1724 g_return_if_fail (index < array->len);
1726 oldap = &g_array_index (array, AllocationPool, index);
1727 allocation_pool_free (oldap);
1729 if ((ap.pool = pool))
1730 gst_object_ref (pool);
1732 ap.min_buffers = min_buffers;
1733 ap.max_buffers = max_buffers;
1734 g_array_index (array, AllocationPool, index) = ap;
1738 * gst_query_remove_nth_allocation_pool:
1739 * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1740 * @index: position in the allocation pool array to remove
1742 * Remove the allocation pool at @index of the allocation pool array.
1747 gst_query_remove_nth_allocation_pool (GstQuery * query, guint index)
1750 GstStructure *structure;
1752 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1753 g_return_if_fail (gst_query_is_writable (query));
1755 structure = GST_QUERY_STRUCTURE (query);
1757 ensure_array (structure, GST_QUARK (POOL), sizeof (AllocationPool),
1758 (GDestroyNotify) allocation_pool_free);
1759 g_return_if_fail (index < array->len);
1761 g_array_remove_index (array, index);
1767 GstStructure *params;
1771 allocation_meta_free (AllocationMeta * am)
1774 gst_structure_free (am->params);
1778 * gst_query_add_allocation_meta:
1779 * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1780 * @api: the metadata API
1781 * @params: (transfer none) (allow-none): API specific parameters
1783 * Add @api with @params as one of the supported metadata API to @query.
1786 gst_query_add_allocation_meta (GstQuery * query, GType api,
1787 const GstStructure * params)
1790 GstStructure *structure;
1793 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1794 g_return_if_fail (api != 0);
1795 g_return_if_fail (gst_query_is_writable (query));
1797 structure = GST_QUERY_STRUCTURE (query);
1799 ensure_array (structure, GST_QUARK (META), sizeof (AllocationMeta),
1800 (GDestroyNotify) allocation_meta_free);
1803 am.params = (params ? gst_structure_copy (params) : NULL);
1805 g_array_append_val (array, am);
1809 * gst_query_get_n_allocation_metas:
1810 * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1812 * Retrieve the number of values currently stored in the
1813 * meta API array of the query's structure.
1815 * Returns: the metadata API array size as a #guint.
1818 gst_query_get_n_allocation_metas (GstQuery * query)
1821 GstStructure *structure;
1823 g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION, 0);
1825 structure = GST_QUERY_STRUCTURE (query);
1827 ensure_array (structure, GST_QUARK (META), sizeof (AllocationMeta),
1828 (GDestroyNotify) allocation_meta_free);
1834 * gst_query_parse_nth_allocation_meta:
1835 * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1836 * @index: position in the metadata API array to read
1837 * @params: (out) (transfer none) (allow-none): API specific parameters
1839 * Parse an available query and get the metadata API
1840 * at @index of the metadata API array.
1842 * Returns: a #GType of the metadata API at @index.
1845 gst_query_parse_nth_allocation_meta (GstQuery * query, guint index,
1846 const GstStructure ** params)
1849 GstStructure *structure;
1852 g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION, 0);
1854 structure = GST_QUERY_STRUCTURE (query);
1856 ensure_array (structure, GST_QUARK (META), sizeof (AllocationMeta),
1857 (GDestroyNotify) allocation_meta_free);
1859 g_return_val_if_fail (index < array->len, 0);
1861 am = &g_array_index (array, AllocationMeta, index);
1864 *params = am->params;
1870 * gst_query_remove_nth_allocation_meta:
1871 * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1872 * @index: position in the metadata API array to remove
1874 * Remove the metadata API at @index of the metadata API array.
1877 gst_query_remove_nth_allocation_meta (GstQuery * query, guint index)
1880 GstStructure *structure;
1882 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1883 g_return_if_fail (gst_query_is_writable (query));
1885 structure = GST_QUERY_STRUCTURE (query);
1887 ensure_array (structure, GST_QUARK (META), sizeof (AllocationMeta),
1888 (GDestroyNotify) allocation_meta_free);
1889 g_return_if_fail (index < array->len);
1891 g_array_remove_index (array, index);
1895 * gst_query_find_allocation_meta:
1896 * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1897 * @api: the metadata API
1898 * @index: (out) (transfer none) (allow-none): the index
1900 * Check if @query has metadata @api set. When this function returns %TRUE,
1901 * @index will contain the index where the requested API and the parameters
1904 * Returns: %TRUE when @api is in the list of metadata.
1907 gst_query_find_allocation_meta (GstQuery * query, GType api, guint * index)
1910 GstStructure *structure;
1913 g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION, FALSE);
1914 g_return_val_if_fail (api != 0, FALSE);
1916 structure = GST_QUERY_STRUCTURE (query);
1918 ensure_array (structure, GST_QUARK (META), sizeof (AllocationMeta),
1919 (GDestroyNotify) allocation_meta_free);
1922 for (i = 0; i < len; i++) {
1923 AllocationMeta *am = &g_array_index (array, AllocationMeta, i);
1924 if (am->api == api) {
1935 GstAllocator *allocator;
1936 GstAllocationParams params;
1940 allocation_param_free (AllocationParam * ap)
1943 gst_object_unref (ap->allocator);
1947 * gst_query_add_allocation_param:
1948 * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1949 * @allocator: (transfer none) (allow-none): the memory allocator
1950 * @params: (transfer none) (allow-none): a #GstAllocationParams
1952 * Add @allocator and its @params as a supported memory allocator.
1955 gst_query_add_allocation_param (GstQuery * query, GstAllocator * allocator,
1956 const GstAllocationParams * params)
1959 GstStructure *structure;
1962 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1963 g_return_if_fail (gst_query_is_writable (query));
1964 g_return_if_fail (allocator != NULL || params != NULL);
1966 structure = GST_QUERY_STRUCTURE (query);
1967 array = ensure_array (structure, GST_QUARK (ALLOCATOR),
1968 sizeof (AllocationParam), (GDestroyNotify) allocation_param_free);
1970 if ((ap.allocator = allocator))
1971 gst_object_ref (allocator);
1973 ap.params = *params;
1975 gst_allocation_params_init (&ap.params);
1977 g_array_append_val (array, ap);
1981 * gst_query_get_n_allocation_params:
1982 * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1984 * Retrieve the number of values currently stored in the
1985 * allocator params array of the query's structure.
1987 * If no memory allocator is specified, the downstream element can handle
1988 * the default memory allocator. The first memory allocator in the query
1989 * should be generic and allow mapping to system memory, all following
1990 * allocators should be ordered by preference with the preferred one first.
1992 * Returns: the allocator array size as a #guint.
1995 gst_query_get_n_allocation_params (GstQuery * query)
1998 GstStructure *structure;
2000 g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION, 0);
2002 structure = GST_QUERY_STRUCTURE (query);
2003 array = ensure_array (structure, GST_QUARK (ALLOCATOR),
2004 sizeof (AllocationParam), (GDestroyNotify) allocation_param_free);
2010 * gst_query_parse_nth_allocation_param:
2011 * @query: a GST_QUERY_ALLOCATION type query #GstQuery
2012 * @index: position in the allocator array to read
2013 * @allocator: (out) (transfer full) (allow-none): variable to hold the result
2014 * @params: (out) (allow-none): parameters for the allocator
2016 * Parse an available query and get the allocator and its params
2017 * at @index of the allocator array.
2020 gst_query_parse_nth_allocation_param (GstQuery * query, guint index,
2021 GstAllocator ** allocator, GstAllocationParams * params)
2024 GstStructure *structure;
2025 AllocationParam *ap;
2027 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
2029 structure = GST_QUERY_STRUCTURE (query);
2030 array = ensure_array (structure, GST_QUARK (ALLOCATOR),
2031 sizeof (AllocationParam), (GDestroyNotify) allocation_param_free);
2032 g_return_if_fail (index < array->len);
2034 ap = &g_array_index (array, AllocationParam, index);
2037 if ((*allocator = ap->allocator))
2038 gst_object_ref (*allocator);
2040 *params = ap->params;
2044 * gst_query_set_nth_allocation_param:
2045 * @query: a GST_QUERY_ALLOCATION type query #GstQuery
2046 * @index: position in the allocator array to set
2047 * @allocator: (transfer none) (allow-none): new allocator to set
2048 * @params: (transfer none) (allow-none): parameters for the allocator
2050 * Parse an available query and get the allocator and its params
2051 * at @index of the allocator array.
2054 gst_query_set_nth_allocation_param (GstQuery * query, guint index,
2055 GstAllocator * allocator, const GstAllocationParams * params)
2058 GstStructure *structure;
2059 AllocationParam *old, ap;
2061 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
2063 structure = GST_QUERY_STRUCTURE (query);
2064 array = ensure_array (structure, GST_QUARK (ALLOCATOR),
2065 sizeof (AllocationParam), (GDestroyNotify) allocation_param_free);
2066 g_return_if_fail (index < array->len);
2068 old = &g_array_index (array, AllocationParam, index);
2069 allocation_param_free (old);
2071 if ((ap.allocator = allocator))
2072 gst_object_ref (allocator);
2074 ap.params = *params;
2076 gst_allocation_params_init (&ap.params);
2078 g_array_index (array, AllocationParam, index) = ap;
2082 * gst_query_remove_nth_allocation_param:
2083 * @query: a GST_QUERY_ALLOCATION type query #GstQuery
2084 * @index: position in the allocation param array to remove
2086 * Remove the allocation param at @index of the allocation param array.
2091 gst_query_remove_nth_allocation_param (GstQuery * query, guint index)
2094 GstStructure *structure;
2096 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
2097 g_return_if_fail (gst_query_is_writable (query));
2099 structure = GST_QUERY_STRUCTURE (query);
2101 ensure_array (structure, GST_QUARK (ALLOCATOR), sizeof (AllocationParam),
2102 (GDestroyNotify) allocation_param_free);
2103 g_return_if_fail (index < array->len);
2105 g_array_remove_index (array, index);
2109 * gst_query_new_scheduling:
2111 * Constructs a new query object for querying the scheduling properties.
2113 * Free-function: gst_query_unref()
2115 * Returns: (transfer full): a new #GstQuery
2118 gst_query_new_scheduling (void)
2121 GstStructure *structure;
2123 structure = gst_structure_new_id (GST_QUARK (QUERY_SCHEDULING),
2124 GST_QUARK (FLAGS), GST_TYPE_SCHEDULING_FLAGS, 0,
2125 GST_QUARK (MINSIZE), G_TYPE_INT, 1,
2126 GST_QUARK (MAXSIZE), G_TYPE_INT, -1,
2127 GST_QUARK (ALIGN), G_TYPE_INT, 0, NULL);
2128 query = gst_query_new_custom (GST_QUERY_SCHEDULING, structure);
2134 * gst_query_set_scheduling:
2135 * @query: A valid #GstQuery of type GST_QUERY_SCHEDULING.
2136 * @flags: #GstSchedulingFlags
2137 * @minsize: the suggested minimum size of pull requests
2138 * @maxsize: the suggested maximum size of pull requests
2139 * @align: the suggested alignment of pull requests
2141 * Set the scheduling properties.
2144 gst_query_set_scheduling (GstQuery * query, GstSchedulingFlags flags,
2145 gint minsize, gint maxsize, gint align)
2147 GstStructure *structure;
2149 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SCHEDULING);
2150 g_return_if_fail (gst_query_is_writable (query));
2152 structure = GST_QUERY_STRUCTURE (query);
2153 gst_structure_id_set (structure,
2154 GST_QUARK (FLAGS), GST_TYPE_SCHEDULING_FLAGS, flags,
2155 GST_QUARK (MINSIZE), G_TYPE_INT, minsize,
2156 GST_QUARK (MAXSIZE), G_TYPE_INT, maxsize,
2157 GST_QUARK (ALIGN), G_TYPE_INT, align, NULL);
2161 * gst_query_parse_scheduling:
2162 * @query: A valid #GstQuery of type GST_QUERY_SCHEDULING.
2163 * @flags: (out) (allow-none): #GstSchedulingFlags
2164 * @minsize: (out) (allow-none): the suggested minimum size of pull requests
2165 * @maxsize: (out) (allow-none): the suggested maximum size of pull requests:
2166 * @align: (out) (allow-none): the suggested alignment of pull requests
2168 * Set the scheduling properties.
2171 gst_query_parse_scheduling (GstQuery * query, GstSchedulingFlags * flags,
2172 gint * minsize, gint * maxsize, gint * align)
2174 GstStructure *structure;
2176 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SCHEDULING);
2178 structure = GST_QUERY_STRUCTURE (query);
2179 gst_structure_id_get (structure,
2180 GST_QUARK (FLAGS), GST_TYPE_SCHEDULING_FLAGS, flags,
2181 GST_QUARK (MINSIZE), G_TYPE_INT, minsize,
2182 GST_QUARK (MAXSIZE), G_TYPE_INT, maxsize,
2183 GST_QUARK (ALIGN), G_TYPE_INT, align, NULL);
2187 * gst_query_add_scheduling_mode:
2188 * @query: a GST_QUERY_SCHEDULING type query #GstQuery
2189 * @mode: a #GstPadMode
2191 * Add @mode as one of the supported scheduling modes to @query.
2194 gst_query_add_scheduling_mode (GstQuery * query, GstPadMode mode)
2196 GstStructure *structure;
2199 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SCHEDULING);
2200 g_return_if_fail (gst_query_is_writable (query));
2202 structure = GST_QUERY_STRUCTURE (query);
2204 ensure_array (structure, GST_QUARK (MODES), sizeof (GstPadMode), NULL);
2206 g_array_append_val (array, mode);
2210 * gst_query_get_n_scheduling_modes:
2211 * @query: a GST_QUERY_SCHEDULING type query #GstQuery
2213 * Retrieve the number of values currently stored in the
2214 * scheduling mode array of the query's structure.
2216 * Returns: the scheduling mode array size as a #guint.
2219 gst_query_get_n_scheduling_modes (GstQuery * query)
2222 GstStructure *structure;
2224 g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SCHEDULING, 0);
2226 structure = GST_QUERY_STRUCTURE (query);
2228 ensure_array (structure, GST_QUARK (MODES), sizeof (GstPadMode), NULL);
2234 * gst_query_parse_nth_scheduling_mode:
2235 * @query: a GST_QUERY_SCHEDULING type query #GstQuery
2236 * @index: position in the scheduling modes array to read
2238 * Parse an available query and get the scheduling mode
2239 * at @index of the scheduling modes array.
2241 * Returns: a #GstPadMode of the scheduling mode at @index.
2244 gst_query_parse_nth_scheduling_mode (GstQuery * query, guint index)
2246 GstStructure *structure;
2249 g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SCHEDULING,
2252 structure = GST_QUERY_STRUCTURE (query);
2254 ensure_array (structure, GST_QUARK (MODES), sizeof (GstPadMode), NULL);
2255 g_return_val_if_fail (index < array->len, GST_PAD_MODE_NONE);
2257 return g_array_index (array, GstPadMode, index);
2261 * gst_query_has_scheduling_mode:
2262 * @query: a GST_QUERY_SCHEDULING type query #GstQuery
2263 * @mode: the scheduling mode
2265 * Check if @query has scheduling mode set.
2267 * > When checking if upstream supports pull mode, it is usually not
2268 * > enough to just check for GST_PAD_MODE_PULL with this function, you
2269 * > also want to check whether the scheduling flags returned by
2270 * > gst_query_parse_scheduling() have the seeking flag set (meaning
2271 * > random access is supported, not only sequential pulls).
2273 * Returns: %TRUE when @mode is in the list of scheduling modes.
2276 gst_query_has_scheduling_mode (GstQuery * query, GstPadMode mode)
2278 GstStructure *structure;
2282 g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SCHEDULING, FALSE);
2284 structure = GST_QUERY_STRUCTURE (query);
2286 ensure_array (structure, GST_QUARK (MODES), sizeof (GstPadMode), NULL);
2289 for (i = 0; i < len; i++) {
2290 if (mode == g_array_index (array, GstPadMode, i))
2297 * gst_query_has_scheduling_mode_with_flags:
2298 * @query: a GST_QUERY_SCHEDULING type query #GstQuery
2299 * @mode: the scheduling mode
2300 * @flags: #GstSchedulingFlags
2302 * Check if @query has scheduling mode set and @flags is set in
2303 * query scheduling flags.
2305 * Returns: %TRUE when @mode is in the list of scheduling modes
2306 * and @flags are compatible with query flags.
2309 gst_query_has_scheduling_mode_with_flags (GstQuery * query, GstPadMode mode,
2310 GstSchedulingFlags flags)
2312 GstSchedulingFlags sched_flags;
2314 g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SCHEDULING, FALSE);
2316 gst_query_parse_scheduling (query, &sched_flags, NULL, NULL, NULL);
2318 return ((flags & sched_flags) == flags) &&
2319 gst_query_has_scheduling_mode (query, mode);
2323 * gst_query_new_accept_caps:
2324 * @caps: a fixed #GstCaps
2326 * Constructs a new query object for querying if @caps are accepted.
2328 * Free-function: gst_query_unref()
2330 * Returns: (transfer full): a new #GstQuery
2333 gst_query_new_accept_caps (GstCaps * caps)
2336 GstStructure *structure;
2338 g_return_val_if_fail (gst_caps_is_fixed (caps), NULL);
2340 structure = gst_structure_new_id (GST_QUARK (QUERY_ACCEPT_CAPS),
2341 GST_QUARK (CAPS), GST_TYPE_CAPS, caps,
2342 GST_QUARK (RESULT), G_TYPE_BOOLEAN, FALSE, NULL);
2343 query = gst_query_new_custom (GST_QUERY_ACCEPT_CAPS, structure);
2349 * gst_query_parse_accept_caps:
2350 * @query: The query to parse
2351 * @caps: (out) (transfer none): A pointer to the caps
2353 * Get the caps from @query. The caps remains valid as long as @query remains
2357 gst_query_parse_accept_caps (GstQuery * query, GstCaps ** caps)
2359 GstStructure *structure;
2361 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ACCEPT_CAPS);
2362 g_return_if_fail (caps != NULL);
2364 structure = GST_QUERY_STRUCTURE (query);
2365 *caps = g_value_get_boxed (gst_structure_id_get_value (structure,
2370 * gst_query_set_accept_caps_result:
2371 * @query: a GST_QUERY_ACCEPT_CAPS type query #GstQuery
2372 * @result: the result to set
2374 * Set @result as the result for the @query.
2377 gst_query_set_accept_caps_result (GstQuery * query, gboolean result)
2379 GstStructure *structure;
2381 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ACCEPT_CAPS);
2382 g_return_if_fail (gst_query_is_writable (query));
2384 structure = GST_QUERY_STRUCTURE (query);
2385 gst_structure_id_set (structure,
2386 GST_QUARK (RESULT), G_TYPE_BOOLEAN, result, NULL);
2390 * gst_query_parse_accept_caps_result:
2391 * @query: a GST_QUERY_ACCEPT_CAPS type query #GstQuery
2392 * @result: location for the result
2394 * Parse the result from @query and store in @result.
2397 gst_query_parse_accept_caps_result (GstQuery * query, gboolean * result)
2399 GstStructure *structure;
2401 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ACCEPT_CAPS);
2403 structure = GST_QUERY_STRUCTURE (query);
2404 gst_structure_id_get (structure,
2405 GST_QUARK (RESULT), G_TYPE_BOOLEAN, result, NULL);
2409 * gst_query_new_caps:
2412 * Constructs a new query object for querying the caps.
2414 * The CAPS query should return the allowable caps for a pad in the context
2415 * of the element's state, its link to other elements, and the devices or files
2416 * it has opened. These caps must be a subset of the pad template caps. In the
2417 * NULL state with no links, the CAPS query should ideally return the same caps
2418 * as the pad template. In rare circumstances, an object property can affect
2419 * the caps returned by the CAPS query, but this is discouraged.
2421 * For most filters, the caps returned by CAPS query is directly affected by the
2422 * allowed caps on other pads. For demuxers and decoders, the caps returned by
2423 * the srcpad's getcaps function is directly related to the stream data. Again,
2424 * the CAPS query should return the most specific caps it reasonably can, since this
2425 * helps with autoplugging.
2427 * The @filter is used to restrict the result caps, only the caps matching
2428 * @filter should be returned from the CAPS query. Specifying a filter might
2429 * greatly reduce the amount of processing an element needs to do.
2431 * Free-function: gst_query_unref()
2433 * Returns: (transfer full): a new #GstQuery
2436 gst_query_new_caps (GstCaps * filter)
2439 GstStructure *structure;
2441 structure = gst_structure_new_id (GST_QUARK (QUERY_CAPS),
2442 GST_QUARK (FILTER), GST_TYPE_CAPS, filter,
2443 GST_QUARK (CAPS), GST_TYPE_CAPS, NULL, NULL);
2444 query = gst_query_new_custom (GST_QUERY_CAPS, structure);
2450 * gst_query_parse_caps:
2451 * @query: The query to parse
2452 * @filter: (out) (transfer none): A pointer to the caps filter
2454 * Get the filter from the caps @query. The caps remains valid as long as
2455 * @query remains valid.
2458 gst_query_parse_caps (GstQuery * query, GstCaps ** filter)
2460 GstStructure *structure;
2462 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CAPS);
2463 g_return_if_fail (filter != NULL);
2465 structure = GST_QUERY_STRUCTURE (query);
2466 *filter = g_value_get_boxed (gst_structure_id_get_value (structure,
2467 GST_QUARK (FILTER)));
2471 * gst_query_set_caps_result:
2472 * @query: The query to use
2473 * @caps: (in): A pointer to the caps
2475 * Set the @caps result in @query.
2478 gst_query_set_caps_result (GstQuery * query, GstCaps * caps)
2480 GstStructure *structure;
2482 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CAPS);
2483 g_return_if_fail (gst_query_is_writable (query));
2485 structure = GST_QUERY_STRUCTURE (query);
2486 gst_structure_id_set (structure, GST_QUARK (CAPS), GST_TYPE_CAPS, caps, NULL);
2490 * gst_query_parse_caps_result:
2491 * @query: The query to parse
2492 * @caps: (out) (transfer none): A pointer to the caps
2494 * Get the caps result from @query. The caps remains valid as long as
2495 * @query remains valid.
2498 gst_query_parse_caps_result (GstQuery * query, GstCaps ** caps)
2500 GstStructure *structure;
2502 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CAPS);
2503 g_return_if_fail (caps != NULL);
2505 structure = GST_QUERY_STRUCTURE (query);
2506 *caps = g_value_get_boxed (gst_structure_id_get_value (structure,
2512 gst_query_intersect_caps_result (GstQuery * query, GstCaps * filter,
2513 GstCapsIntersectMode mode)
2515 GstCaps *res, *caps = NULL;
2517 gst_query_parse_caps_result (query, &caps);
2518 res = gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
2519 gst_query_set_caps_result (query, res);
2520 gst_caps_unref (res);
2525 * gst_query_new_drain:
2527 * Constructs a new query object for querying the drain state.
2529 * Free-function: gst_query_unref()
2531 * Returns: (transfer full): a new #GstQuery
2534 gst_query_new_drain (void)
2537 GstStructure *structure;
2539 structure = gst_structure_new_id_empty (GST_QUARK (QUERY_DRAIN));
2540 query = gst_query_new_custom (GST_QUERY_DRAIN, structure);
2546 * gst_query_new_context:
2547 * @context_type: Context type to query
2549 * Constructs a new query object for querying the pipeline-local context.
2551 * Free-function: gst_query_unref()
2553 * Returns: (transfer full): a new #GstQuery
2558 gst_query_new_context (const gchar * context_type)
2561 GstStructure *structure;
2563 g_return_val_if_fail (context_type != NULL, NULL);
2565 structure = gst_structure_new_id (GST_QUARK (QUERY_CONTEXT),
2566 GST_QUARK (CONTEXT_TYPE), G_TYPE_STRING, context_type, NULL);
2567 query = gst_query_new_custom (GST_QUERY_CONTEXT, structure);
2573 * gst_query_set_context:
2574 * @query: a #GstQuery with query type GST_QUERY_CONTEXT
2575 * @context: the requested #GstContext
2577 * Answer a context query by setting the requested context.
2582 gst_query_set_context (GstQuery * query, GstContext * context)
2585 const gchar *context_type;
2587 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CONTEXT);
2589 gst_query_parse_context_type (query, &context_type);
2590 g_return_if_fail (strcmp (gst_context_get_context_type (context),
2591 context_type) == 0);
2593 s = GST_QUERY_STRUCTURE (query);
2595 gst_structure_id_set (s,
2596 GST_QUARK (CONTEXT), GST_TYPE_CONTEXT, context, NULL);
2600 * gst_query_parse_context:
2601 * @query: The query to parse
2602 * @context: (out) (transfer none): A pointer to store the #GstContext
2604 * Get the context from the context @query. The context remains valid as long as
2605 * @query remains valid.
2610 gst_query_parse_context (GstQuery * query, GstContext ** context)
2612 GstStructure *structure;
2615 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CONTEXT);
2616 g_return_if_fail (context != NULL);
2618 structure = GST_QUERY_STRUCTURE (query);
2619 v = gst_structure_id_get_value (structure, GST_QUARK (CONTEXT));
2621 *context = g_value_get_boxed (v);
2627 * gst_query_parse_context_type:
2628 * @query: a GST_QUERY_CONTEXT type query
2629 * @context_type: (out) (transfer none) (allow-none): the context type, or %NULL
2631 * Parse a context type from an existing GST_QUERY_CONTEXT query.
2633 * Returns: a #gboolean indicating if the parsing succeeded.
2638 gst_query_parse_context_type (GstQuery * query, const gchar ** context_type)
2640 GstStructure *structure;
2641 const GValue *value;
2643 g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CONTEXT, FALSE);
2645 structure = GST_QUERY_STRUCTURE (query);
2648 value = gst_structure_id_get_value (structure, GST_QUARK (CONTEXT_TYPE));
2649 *context_type = g_value_get_string (value);