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 g_return_val_if_fail (GST_IS_QUERY (query), NULL);
735 g_return_val_if_fail (gst_query_is_writable (query), NULL);
737 return GST_QUERY_STRUCTURE (query);
741 * gst_query_new_seeking:
742 * @format: the default #GstFormat for the new query
744 * Constructs a new query object for querying seeking properties of
747 * Free-function: gst_query_unref()
749 * Returns: (transfer full): a new #GstQuery
752 gst_query_new_seeking (GstFormat format)
755 GstStructure *structure;
757 structure = gst_structure_new_id (GST_QUARK (QUERY_SEEKING),
758 GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
759 GST_QUARK (SEEKABLE), G_TYPE_BOOLEAN, FALSE,
760 GST_QUARK (SEGMENT_START), G_TYPE_INT64, G_GINT64_CONSTANT (-1),
761 GST_QUARK (SEGMENT_END), G_TYPE_INT64, G_GINT64_CONSTANT (-1), NULL);
763 query = gst_query_new_custom (GST_QUERY_SEEKING, structure);
769 * gst_query_set_seeking:
770 * @query: a #GstQuery
771 * @format: the format to set for the @segment_start and @segment_end values
772 * @seekable: the seekable flag to set
773 * @segment_start: the segment_start to set
774 * @segment_end: the segment_end to set
776 * Set the seeking query result fields in @query.
779 gst_query_set_seeking (GstQuery * query, GstFormat format,
780 gboolean seekable, gint64 segment_start, gint64 segment_end)
782 GstStructure *structure;
784 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SEEKING);
785 g_return_if_fail (gst_query_is_writable (query));
787 structure = GST_QUERY_STRUCTURE (query);
788 gst_structure_id_set (structure,
789 GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
790 GST_QUARK (SEEKABLE), G_TYPE_BOOLEAN, seekable,
791 GST_QUARK (SEGMENT_START), G_TYPE_INT64, segment_start,
792 GST_QUARK (SEGMENT_END), G_TYPE_INT64, segment_end, NULL);
796 * gst_query_parse_seeking:
797 * @query: a GST_QUERY_SEEKING type query #GstQuery
798 * @format: (out) (allow-none): the format to set for the @segment_start
799 * and @segment_end values, or %NULL
800 * @seekable: (out) (allow-none): the seekable flag to set, or %NULL
801 * @segment_start: (out) (allow-none): the segment_start to set, or %NULL
802 * @segment_end: (out) (allow-none): the segment_end to set, or %NULL
804 * Parse a seeking query, writing the format into @format, and
805 * other results into the passed parameters, if the respective parameters
809 gst_query_parse_seeking (GstQuery * query, GstFormat * format,
810 gboolean * seekable, gint64 * segment_start, gint64 * segment_end)
812 GstStructure *structure;
814 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SEEKING);
816 structure = GST_QUERY_STRUCTURE (query);
819 (GstFormat) g_value_get_enum (gst_structure_id_get_value (structure,
820 GST_QUARK (FORMAT)));
822 *seekable = g_value_get_boolean (gst_structure_id_get_value (structure,
823 GST_QUARK (SEEKABLE)));
825 *segment_start = g_value_get_int64 (gst_structure_id_get_value (structure,
826 GST_QUARK (SEGMENT_START)));
828 *segment_end = g_value_get_int64 (gst_structure_id_get_value (structure,
829 GST_QUARK (SEGMENT_END)));
833 ensure_array (GstStructure * s, GQuark quark, gsize element_size,
834 GDestroyNotify clear_func)
839 value = gst_structure_id_get_value (s, quark);
841 array = (GArray *) g_value_get_boxed (value);
843 GValue new_array_val = { 0, };
845 array = g_array_new (FALSE, TRUE, element_size);
847 g_array_set_clear_func (array, clear_func);
849 g_value_init (&new_array_val, G_TYPE_ARRAY);
850 g_value_take_boxed (&new_array_val, array);
852 gst_structure_id_take_value (s, quark, &new_array_val);
858 * gst_query_new_formats:
860 * Constructs a new query object for querying formats of
863 * Free-function: gst_query_unref()
865 * Returns: (transfer full): a new #GstQuery
868 gst_query_new_formats (void)
871 GstStructure *structure;
873 structure = gst_structure_new_id_empty (GST_QUARK (QUERY_FORMATS));
874 query = gst_query_new_custom (GST_QUERY_FORMATS, structure);
880 gst_query_list_add_format (GValue * list, GstFormat format)
882 GValue item = { 0, };
884 g_value_init (&item, GST_TYPE_FORMAT);
885 g_value_set_enum (&item, format);
886 gst_value_list_append_value (list, &item);
887 g_value_unset (&item);
891 * gst_query_set_formats:
892 * @query: a #GstQuery
893 * @n_formats: the number of formats to set.
894 * @...: A number of @GstFormats equal to @n_formats.
896 * Set the formats query result fields in @query. The number of formats passed
897 * must be equal to @n_formats.
900 gst_query_set_formats (GstQuery * query, gint n_formats, ...)
903 GValue list = { 0, };
905 GstStructure *structure;
907 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_FORMATS);
908 g_return_if_fail (gst_query_is_writable (query));
910 g_value_init (&list, GST_TYPE_LIST);
912 va_start (ap, n_formats);
913 for (i = 0; i < n_formats; i++) {
914 gst_query_list_add_format (&list, va_arg (ap, GstFormat));
918 structure = GST_QUERY_STRUCTURE (query);
919 gst_structure_set_value (structure, "formats", &list);
921 g_value_unset (&list);
926 * gst_query_set_formatsv:
927 * @query: a #GstQuery
928 * @n_formats: the number of formats to set.
929 * @formats: (in) (array length=n_formats): an array containing @n_formats
932 * Set the formats query result fields in @query. The number of formats passed
933 * in the @formats array must be equal to @n_formats.
936 gst_query_set_formatsv (GstQuery * query, gint n_formats,
937 const GstFormat * formats)
939 GValue list = { 0, };
941 GstStructure *structure;
943 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_FORMATS);
944 g_return_if_fail (gst_query_is_writable (query));
946 g_value_init (&list, GST_TYPE_LIST);
947 for (i = 0; i < n_formats; i++) {
948 gst_query_list_add_format (&list, formats[i]);
950 structure = GST_QUERY_STRUCTURE (query);
951 gst_structure_set_value (structure, "formats", &list);
953 g_value_unset (&list);
957 * gst_query_parse_n_formats:
958 * @query: a #GstQuery
959 * @n_formats: (out) (allow-none): the number of formats in this query.
961 * Parse the number of formats in the formats @query.
964 gst_query_parse_n_formats (GstQuery * query, guint * n_formats)
966 GstStructure *structure;
968 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_FORMATS);
973 structure = GST_QUERY_STRUCTURE (query);
974 list = gst_structure_get_value (structure, "formats");
978 *n_formats = gst_value_list_get_size (list);
983 * gst_query_parse_nth_format:
984 * @query: a #GstQuery
985 * @nth: (out): the nth format to retrieve.
986 * @format: (out) (allow-none): a pointer to store the nth format
988 * Parse the format query and retrieve the @nth format from it into
989 * @format. If the list contains less elements than @nth, @format will be
990 * set to GST_FORMAT_UNDEFINED.
993 gst_query_parse_nth_format (GstQuery * query, guint nth, GstFormat * format)
995 GstStructure *structure;
997 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_FORMATS);
1002 structure = GST_QUERY_STRUCTURE (query);
1003 list = gst_structure_get_value (structure, "formats");
1005 *format = GST_FORMAT_UNDEFINED;
1007 if (nth < gst_value_list_get_size (list)) {
1009 (GstFormat) g_value_get_enum (gst_value_list_get_value (list, nth));
1011 *format = GST_FORMAT_UNDEFINED;
1017 * gst_query_new_buffering:
1018 * @format: the default #GstFormat for the new query
1020 * Constructs a new query object for querying the buffering status of
1023 * Free-function: gst_query_unref()
1025 * Returns: (transfer full): a new #GstQuery
1028 gst_query_new_buffering (GstFormat format)
1031 GstStructure *structure;
1033 /* by default, we configure the answer as no buffering with a 100% buffering
1035 structure = gst_structure_new_id (GST_QUARK (QUERY_BUFFERING),
1036 GST_QUARK (BUSY), G_TYPE_BOOLEAN, FALSE,
1037 GST_QUARK (BUFFER_PERCENT), G_TYPE_INT, 100,
1038 GST_QUARK (BUFFERING_MODE), GST_TYPE_BUFFERING_MODE, GST_BUFFERING_STREAM,
1039 GST_QUARK (AVG_IN_RATE), G_TYPE_INT, -1,
1040 GST_QUARK (AVG_OUT_RATE), G_TYPE_INT, -1,
1041 GST_QUARK (BUFFERING_LEFT), G_TYPE_INT64, G_GINT64_CONSTANT (0),
1042 GST_QUARK (ESTIMATED_TOTAL), G_TYPE_INT64, G_GINT64_CONSTANT (-1),
1043 GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
1044 GST_QUARK (START_VALUE), G_TYPE_INT64, G_GINT64_CONSTANT (-1),
1045 GST_QUARK (STOP_VALUE), G_TYPE_INT64, G_GINT64_CONSTANT (-1), NULL);
1047 query = gst_query_new_custom (GST_QUERY_BUFFERING, structure);
1053 * gst_query_set_buffering_percent:
1054 * @query: A valid #GstQuery of type GST_QUERY_BUFFERING.
1055 * @busy: if buffering is busy
1056 * @percent: a buffering percent
1058 * Set the percentage of buffered data. This is a value between 0 and 100.
1059 * The @busy indicator is %TRUE when the buffering is in progress.
1062 gst_query_set_buffering_percent (GstQuery * query, gboolean busy, gint percent)
1064 GstStructure *structure;
1066 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING);
1067 g_return_if_fail (gst_query_is_writable (query));
1068 g_return_if_fail (percent >= 0 && percent <= 100);
1070 structure = GST_QUERY_STRUCTURE (query);
1071 gst_structure_id_set (structure,
1072 GST_QUARK (BUSY), G_TYPE_BOOLEAN, busy,
1073 GST_QUARK (BUFFER_PERCENT), G_TYPE_INT, percent, NULL);
1077 * gst_query_parse_buffering_percent:
1078 * @query: A valid #GstQuery of type GST_QUERY_BUFFERING.
1079 * @busy: (out) (allow-none): if buffering is busy, or %NULL
1080 * @percent: (out) (allow-none): a buffering percent, or %NULL
1082 * Get the percentage of buffered data. This is a value between 0 and 100.
1083 * The @busy indicator is %TRUE when the buffering is in progress.
1086 gst_query_parse_buffering_percent (GstQuery * query, gboolean * busy,
1089 GstStructure *structure;
1091 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING);
1093 structure = GST_QUERY_STRUCTURE (query);
1095 *busy = g_value_get_boolean (gst_structure_id_get_value (structure,
1098 *percent = g_value_get_int (gst_structure_id_get_value (structure,
1099 GST_QUARK (BUFFER_PERCENT)));
1103 * gst_query_set_buffering_stats:
1104 * @query: A valid #GstQuery of type GST_QUERY_BUFFERING.
1105 * @mode: a buffering mode
1106 * @avg_in: the average input rate
1107 * @avg_out: the average output rate
1108 * @buffering_left: amount of buffering time left in milliseconds
1110 * Configures the buffering stats values in @query.
1113 gst_query_set_buffering_stats (GstQuery * query, GstBufferingMode mode,
1114 gint avg_in, gint avg_out, gint64 buffering_left)
1116 GstStructure *structure;
1118 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING);
1119 g_return_if_fail (gst_query_is_writable (query));
1121 structure = GST_QUERY_STRUCTURE (query);
1122 gst_structure_id_set (structure,
1123 GST_QUARK (BUFFERING_MODE), GST_TYPE_BUFFERING_MODE, mode,
1124 GST_QUARK (AVG_IN_RATE), G_TYPE_INT, avg_in,
1125 GST_QUARK (AVG_OUT_RATE), G_TYPE_INT, avg_out,
1126 GST_QUARK (BUFFERING_LEFT), G_TYPE_INT64, buffering_left, NULL);
1130 * gst_query_parse_buffering_stats:
1131 * @query: A valid #GstQuery of type GST_QUERY_BUFFERING.
1132 * @mode: (out) (allow-none): a buffering mode, or %NULL
1133 * @avg_in: (out) (allow-none): the average input rate, or %NULL
1134 * @avg_out: (out) (allow-none): the average output rat, or %NULL
1135 * @buffering_left: (out) (allow-none): amount of buffering time left in
1136 * milliseconds, or %NULL
1138 * Extracts the buffering stats values from @query.
1141 gst_query_parse_buffering_stats (GstQuery * query,
1142 GstBufferingMode * mode, gint * avg_in, gint * avg_out,
1143 gint64 * buffering_left)
1145 GstStructure *structure;
1147 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING);
1149 structure = GST_QUERY_STRUCTURE (query);
1151 *mode = (GstBufferingMode)
1152 g_value_get_enum (gst_structure_id_get_value (structure,
1153 GST_QUARK (BUFFERING_MODE)));
1155 *avg_in = g_value_get_int (gst_structure_id_get_value (structure,
1156 GST_QUARK (AVG_IN_RATE)));
1158 *avg_out = g_value_get_int (gst_structure_id_get_value (structure,
1159 GST_QUARK (AVG_OUT_RATE)));
1162 g_value_get_int64 (gst_structure_id_get_value (structure,
1163 GST_QUARK (BUFFERING_LEFT)));
1167 * gst_query_set_buffering_range:
1168 * @query: a #GstQuery
1169 * @format: the format to set for the @start and @stop values
1170 * @start: the start to set
1171 * @stop: the stop to set
1172 * @estimated_total: estimated total amount of download time remaining in
1175 * Set the available query result fields in @query.
1178 gst_query_set_buffering_range (GstQuery * query, GstFormat format,
1179 gint64 start, gint64 stop, gint64 estimated_total)
1181 GstStructure *structure;
1183 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING);
1184 g_return_if_fail (gst_query_is_writable (query));
1186 structure = GST_QUERY_STRUCTURE (query);
1187 gst_structure_id_set (structure,
1188 GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
1189 GST_QUARK (START_VALUE), G_TYPE_INT64, start,
1190 GST_QUARK (STOP_VALUE), G_TYPE_INT64, stop,
1191 GST_QUARK (ESTIMATED_TOTAL), G_TYPE_INT64, estimated_total, NULL);
1195 * gst_query_parse_buffering_range:
1196 * @query: a GST_QUERY_BUFFERING type query #GstQuery
1197 * @format: (out) (allow-none): the format to set for the @segment_start
1198 * and @segment_end values, or %NULL
1199 * @start: (out) (allow-none): the start to set, or %NULL
1200 * @stop: (out) (allow-none): the stop to set, or %NULL
1201 * @estimated_total: (out) (allow-none): estimated total amount of download
1202 * time remaining in milliseconds, or %NULL
1204 * Parse an available query, writing the format into @format, and
1205 * other results into the passed parameters, if the respective parameters
1209 gst_query_parse_buffering_range (GstQuery * query, GstFormat * format,
1210 gint64 * start, gint64 * stop, gint64 * estimated_total)
1212 GstStructure *structure;
1214 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING);
1216 structure = GST_QUERY_STRUCTURE (query);
1219 (GstFormat) g_value_get_enum (gst_structure_id_get_value (structure,
1220 GST_QUARK (FORMAT)));
1222 *start = g_value_get_int64 (gst_structure_id_get_value (structure,
1223 GST_QUARK (START_VALUE)));
1225 *stop = g_value_get_int64 (gst_structure_id_get_value (structure,
1226 GST_QUARK (STOP_VALUE)));
1227 if (estimated_total)
1229 g_value_get_int64 (gst_structure_id_get_value (structure,
1230 GST_QUARK (ESTIMATED_TOTAL)));
1233 /* GstQueryBufferingRange: internal struct for GArray */
1238 } GstQueryBufferingRange;
1241 * gst_query_add_buffering_range:
1242 * @query: a GST_QUERY_BUFFERING type query #GstQuery
1243 * @start: start position of the range
1244 * @stop: stop position of the range
1246 * Set the buffering-ranges array field in @query. The current last
1247 * start position of the array should be inferior to @start.
1249 * Returns: a #gboolean indicating if the range was added or not.
1252 gst_query_add_buffering_range (GstQuery * query, gint64 start, gint64 stop)
1254 GstQueryBufferingRange range;
1255 GstStructure *structure;
1258 g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING, FALSE);
1259 g_return_val_if_fail (gst_query_is_writable (query), FALSE);
1261 if (G_UNLIKELY (start >= stop))
1264 structure = GST_QUERY_STRUCTURE (query);
1265 array = ensure_array (structure, GST_QUARK (BUFFERING_RANGES),
1266 sizeof (GstQueryBufferingRange), NULL);
1268 if (array->len > 1) {
1269 GstQueryBufferingRange *last;
1271 last = &g_array_index (array, GstQueryBufferingRange, array->len - 1);
1273 if (G_UNLIKELY (start <= last->start))
1277 range.start = start;
1279 g_array_append_val (array, range);
1285 * gst_query_get_n_buffering_ranges:
1286 * @query: a GST_QUERY_BUFFERING type query #GstQuery
1288 * Retrieve the number of values currently stored in the
1289 * buffered-ranges array of the query's structure.
1291 * Returns: the range array size as a #guint.
1294 gst_query_get_n_buffering_ranges (GstQuery * query)
1296 GstStructure *structure;
1299 g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING, 0);
1301 structure = GST_QUERY_STRUCTURE (query);
1302 array = ensure_array (structure, GST_QUARK (BUFFERING_RANGES),
1303 sizeof (GstQueryBufferingRange), NULL);
1310 * gst_query_parse_nth_buffering_range:
1311 * @query: a GST_QUERY_BUFFERING type query #GstQuery
1312 * @index: position in the buffered-ranges array to read
1313 * @start: (out) (allow-none): the start position to set, or %NULL
1314 * @stop: (out) (allow-none): the stop position to set, or %NULL
1316 * Parse an available query and get the start and stop values stored
1317 * at the @index of the buffered ranges array.
1319 * Returns: a #gboolean indicating if the parsing succeeded.
1322 gst_query_parse_nth_buffering_range (GstQuery * query, guint index,
1323 gint64 * start, gint64 * stop)
1325 GstQueryBufferingRange *range;
1326 GstStructure *structure;
1329 g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING, FALSE);
1331 structure = GST_QUERY_STRUCTURE (query);
1333 array = ensure_array (structure, GST_QUARK (BUFFERING_RANGES),
1334 sizeof (GstQueryBufferingRange), NULL);
1335 g_return_val_if_fail (index < array->len, FALSE);
1337 range = &g_array_index (array, GstQueryBufferingRange, index);
1340 *start = range->start;
1342 *stop = range->stop;
1349 * gst_query_new_uri:
1351 * Constructs a new query URI query object. Use gst_query_unref()
1352 * when done with it. An URI query is used to query the current URI
1353 * that is used by the source or sink.
1355 * Free-function: gst_query_unref()
1357 * Returns: (transfer full): a new #GstQuery
1360 gst_query_new_uri (void)
1363 GstStructure *structure;
1365 structure = gst_structure_new_id (GST_QUARK (QUERY_URI),
1366 GST_QUARK (URI), G_TYPE_STRING, NULL, NULL);
1368 query = gst_query_new_custom (GST_QUERY_URI, structure);
1374 * gst_query_set_uri:
1375 * @query: a #GstQuery with query type GST_QUERY_URI
1376 * @uri: the URI to set
1378 * Answer a URI query by setting the requested URI.
1381 gst_query_set_uri (GstQuery * query, const gchar * uri)
1383 GstStructure *structure;
1385 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_URI);
1386 g_return_if_fail (gst_query_is_writable (query));
1387 g_return_if_fail (gst_uri_is_valid (uri));
1389 structure = GST_QUERY_STRUCTURE (query);
1390 gst_structure_id_set (structure, GST_QUARK (URI), G_TYPE_STRING, uri, NULL);
1394 * gst_query_parse_uri:
1395 * @query: a #GstQuery
1396 * @uri: (out) (transfer full) (allow-none): the storage for the current URI
1399 * Parse an URI query, writing the URI into @uri as a newly
1400 * allocated string, if the respective parameters are non-%NULL.
1401 * Free the string with g_free() after usage.
1404 gst_query_parse_uri (GstQuery * query, gchar ** uri)
1406 GstStructure *structure;
1408 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_URI);
1410 structure = GST_QUERY_STRUCTURE (query);
1412 *uri = g_value_dup_string (gst_structure_id_get_value (structure,
1417 * gst_query_set_uri_redirection:
1418 * @query: a #GstQuery with query type GST_QUERY_URI
1419 * @uri: the URI to set
1421 * Answer a URI query by setting the requested URI redirection.
1426 gst_query_set_uri_redirection (GstQuery * query, const gchar * uri)
1428 GstStructure *structure;
1430 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_URI);
1431 g_return_if_fail (gst_query_is_writable (query));
1432 g_return_if_fail (gst_uri_is_valid (uri));
1434 structure = GST_QUERY_STRUCTURE (query);
1435 gst_structure_id_set (structure, GST_QUARK (URI_REDIRECTION),
1436 G_TYPE_STRING, uri, NULL);
1440 * gst_query_parse_uri_redirection:
1441 * @query: a #GstQuery
1442 * @uri: (out) (transfer full) (allow-none): the storage for the redirect URI
1445 * Parse an URI query, writing the URI into @uri as a newly
1446 * allocated string, if the respective parameters are non-%NULL.
1447 * Free the string with g_free() after usage.
1452 gst_query_parse_uri_redirection (GstQuery * query, gchar ** uri)
1454 GstStructure *structure;
1456 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_URI);
1458 structure = GST_QUERY_STRUCTURE (query);
1460 if (!gst_structure_id_get (structure, GST_QUARK (URI_REDIRECTION),
1461 G_TYPE_STRING, uri, NULL))
1467 * gst_query_set_uri_redirection_permanent:
1468 * @query: a #GstQuery with query type %GST_QUERY_URI
1469 * @permanent: whether the redirect is permanent or not
1471 * Answer a URI query by setting the requested URI redirection
1472 * to permanent or not.
1477 gst_query_set_uri_redirection_permanent (GstQuery * query, gboolean permanent)
1479 GstStructure *structure;
1481 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_URI);
1482 g_return_if_fail (gst_query_is_writable (query));
1484 structure = GST_QUERY_STRUCTURE (query);
1485 gst_structure_id_set (structure, GST_QUARK (URI_REDIRECTION_PERMANENT),
1486 G_TYPE_BOOLEAN, permanent, NULL);
1490 * gst_query_parse_uri_redirection_permanent:
1491 * @query: a #GstQuery
1492 * @permanent: (out) (allow-none): if the URI redirection is permanent
1495 * Parse an URI query, and set @permanent to %TRUE if there is a redirection
1496 * and it should be considered permanent. If a redirection is permanent,
1497 * applications should update their internal storage of the URI, otherwise
1498 * they should make all future requests to the original URI.
1503 gst_query_parse_uri_redirection_permanent (GstQuery * query,
1504 gboolean * permanent)
1506 GstStructure *structure;
1508 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_URI);
1510 structure = GST_QUERY_STRUCTURE (query);
1512 if (!gst_structure_id_get (structure, GST_QUARK (URI_REDIRECTION_PERMANENT),
1513 G_TYPE_BOOLEAN, permanent, NULL))
1519 * gst_query_new_allocation:
1520 * @caps: the negotiated caps
1521 * @need_pool: return a pool
1523 * Constructs a new query object for querying the allocation properties.
1525 * Free-function: gst_query_unref()
1527 * Returns: (transfer full): a new #GstQuery
1530 gst_query_new_allocation (GstCaps * caps, gboolean need_pool)
1533 GstStructure *structure;
1535 structure = gst_structure_new_id (GST_QUARK (QUERY_ALLOCATION),
1536 GST_QUARK (CAPS), GST_TYPE_CAPS, caps,
1537 GST_QUARK (NEED_POOL), G_TYPE_BOOLEAN, need_pool, NULL);
1539 query = gst_query_new_custom (GST_QUERY_ALLOCATION, structure);
1545 * gst_query_parse_allocation:
1546 * @query: a #GstQuery
1547 * @caps: (out) (transfer none) (allow-none): The #GstCaps
1548 * @need_pool: (out) (allow-none): Whether a #GstBufferPool is needed
1550 * Parse an allocation query, writing the requested caps in @caps and
1551 * whether a pool is needed in @need_pool, if the respective parameters
1554 * Pool details can be retrieved using gst_query_get_n_allocation_pools() and
1555 * gst_query_parse_nth_allocation_pool().
1558 gst_query_parse_allocation (GstQuery * query, GstCaps ** caps,
1559 gboolean * need_pool)
1561 GstStructure *structure;
1563 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1565 structure = GST_QUERY_STRUCTURE (query);
1567 *caps = g_value_get_boxed (gst_structure_id_get_value (structure,
1570 gst_structure_id_get (structure,
1571 GST_QUARK (NEED_POOL), G_TYPE_BOOLEAN, need_pool, NULL);
1576 GstBufferPool *pool;
1583 allocation_pool_free (AllocationPool * ap)
1586 gst_object_unref (ap->pool);
1590 * gst_query_add_allocation_pool:
1591 * @query: A valid #GstQuery of type GST_QUERY_ALLOCATION.
1592 * @pool: (transfer none) (allow-none): the #GstBufferPool
1593 * @size: the buffer size
1594 * @min_buffers: the min buffers
1595 * @max_buffers: the max buffers
1597 * Set the pool parameters in @query.
1600 gst_query_add_allocation_pool (GstQuery * query, GstBufferPool * pool,
1601 guint size, guint min_buffers, guint max_buffers)
1604 GstStructure *structure;
1607 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1608 g_return_if_fail (gst_query_is_writable (query));
1610 structure = GST_QUERY_STRUCTURE (query);
1611 array = ensure_array (structure, GST_QUARK (POOL),
1612 sizeof (AllocationPool), (GDestroyNotify) allocation_pool_free);
1614 if ((ap.pool = pool))
1615 gst_object_ref (pool);
1617 ap.min_buffers = min_buffers;
1618 ap.max_buffers = max_buffers;
1620 g_array_append_val (array, ap);
1624 * gst_query_get_n_allocation_pools:
1625 * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1627 * Retrieve the number of values currently stored in the
1628 * pool array of the query's structure.
1630 * Returns: the pool array size as a #guint.
1633 gst_query_get_n_allocation_pools (GstQuery * query)
1636 GstStructure *structure;
1638 g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION, 0);
1640 structure = GST_QUERY_STRUCTURE (query);
1641 array = ensure_array (structure, GST_QUARK (POOL),
1642 sizeof (AllocationPool), (GDestroyNotify) allocation_pool_free);
1648 * gst_query_parse_nth_allocation_pool:
1649 * @query: A valid #GstQuery of type GST_QUERY_ALLOCATION.
1650 * @index: index to parse
1651 * @pool: (out) (allow-none) (transfer full): the #GstBufferPool
1652 * @size: (out) (allow-none): the buffer size
1653 * @min_buffers: (out) (allow-none): the min buffers
1654 * @max_buffers: (out) (allow-none): the max buffers
1656 * Get the pool parameters in @query.
1658 * Unref @pool with gst_object_unref() when it's not needed any more.
1661 gst_query_parse_nth_allocation_pool (GstQuery * query, guint index,
1662 GstBufferPool ** pool, guint * size, guint * min_buffers,
1663 guint * max_buffers)
1666 GstStructure *structure;
1669 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1671 structure = GST_QUERY_STRUCTURE (query);
1672 array = ensure_array (structure, GST_QUARK (POOL),
1673 sizeof (AllocationPool), (GDestroyNotify) allocation_pool_free);
1674 g_return_if_fail (index < array->len);
1676 ap = &g_array_index (array, AllocationPool, index);
1679 if ((*pool = ap->pool))
1680 gst_object_ref (*pool);
1684 *min_buffers = ap->min_buffers;
1686 *max_buffers = ap->max_buffers;
1690 * gst_query_set_nth_allocation_pool:
1691 * @index: index to modify
1692 * @query: A valid #GstQuery of type GST_QUERY_ALLOCATION.
1693 * @pool: (transfer none) (allow-none): the #GstBufferPool
1694 * @size: the buffer size
1695 * @min_buffers: the min buffers
1696 * @max_buffers: the max buffers
1698 * Set the pool parameters in @query.
1701 gst_query_set_nth_allocation_pool (GstQuery * query, guint index,
1702 GstBufferPool * pool, guint size, guint min_buffers, guint max_buffers)
1705 GstStructure *structure;
1706 AllocationPool *oldap, ap;
1708 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1710 structure = GST_QUERY_STRUCTURE (query);
1711 array = ensure_array (structure, GST_QUARK (POOL),
1712 sizeof (AllocationPool), (GDestroyNotify) allocation_pool_free);
1713 g_return_if_fail (index < array->len);
1715 oldap = &g_array_index (array, AllocationPool, index);
1716 allocation_pool_free (oldap);
1718 if ((ap.pool = pool))
1719 gst_object_ref (pool);
1721 ap.min_buffers = min_buffers;
1722 ap.max_buffers = max_buffers;
1723 g_array_index (array, AllocationPool, index) = ap;
1727 * gst_query_remove_nth_allocation_pool:
1728 * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1729 * @index: position in the allocation pool array to remove
1731 * Remove the allocation pool at @index of the allocation pool array.
1736 gst_query_remove_nth_allocation_pool (GstQuery * query, guint index)
1739 GstStructure *structure;
1741 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1742 g_return_if_fail (gst_query_is_writable (query));
1744 structure = GST_QUERY_STRUCTURE (query);
1746 ensure_array (structure, GST_QUARK (POOL), sizeof (AllocationPool),
1747 (GDestroyNotify) allocation_pool_free);
1748 g_return_if_fail (index < array->len);
1750 g_array_remove_index (array, index);
1756 GstStructure *params;
1760 allocation_meta_free (AllocationMeta * am)
1763 gst_structure_free (am->params);
1767 * gst_query_add_allocation_meta:
1768 * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1769 * @api: the metadata API
1770 * @params: (transfer none) (allow-none): API specific parameters
1772 * Add @api with @params as one of the supported metadata API to @query.
1775 gst_query_add_allocation_meta (GstQuery * query, GType api,
1776 const GstStructure * params)
1779 GstStructure *structure;
1782 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1783 g_return_if_fail (api != 0);
1784 g_return_if_fail (gst_query_is_writable (query));
1786 structure = GST_QUERY_STRUCTURE (query);
1788 ensure_array (structure, GST_QUARK (META), sizeof (AllocationMeta),
1789 (GDestroyNotify) allocation_meta_free);
1792 am.params = (params ? gst_structure_copy (params) : NULL);
1794 g_array_append_val (array, am);
1798 * gst_query_get_n_allocation_metas:
1799 * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1801 * Retrieve the number of values currently stored in the
1802 * meta API array of the query's structure.
1804 * Returns: the metadata API array size as a #guint.
1807 gst_query_get_n_allocation_metas (GstQuery * query)
1810 GstStructure *structure;
1812 g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION, 0);
1814 structure = GST_QUERY_STRUCTURE (query);
1816 ensure_array (structure, GST_QUARK (META), sizeof (AllocationMeta),
1817 (GDestroyNotify) allocation_meta_free);
1823 * gst_query_parse_nth_allocation_meta:
1824 * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1825 * @index: position in the metadata API array to read
1826 * @params: (out) (transfer none) (allow-none): API specific parameters
1828 * Parse an available query and get the metadata API
1829 * at @index of the metadata API array.
1831 * Returns: a #GType of the metadata API at @index.
1834 gst_query_parse_nth_allocation_meta (GstQuery * query, guint index,
1835 const GstStructure ** params)
1838 GstStructure *structure;
1841 g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION, 0);
1843 structure = GST_QUERY_STRUCTURE (query);
1845 ensure_array (structure, GST_QUARK (META), sizeof (AllocationMeta),
1846 (GDestroyNotify) allocation_meta_free);
1848 g_return_val_if_fail (index < array->len, 0);
1850 am = &g_array_index (array, AllocationMeta, index);
1853 *params = am->params;
1859 * gst_query_remove_nth_allocation_meta:
1860 * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1861 * @index: position in the metadata API array to remove
1863 * Remove the metadata API at @index of the metadata API array.
1866 gst_query_remove_nth_allocation_meta (GstQuery * query, guint index)
1869 GstStructure *structure;
1871 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1872 g_return_if_fail (gst_query_is_writable (query));
1874 structure = GST_QUERY_STRUCTURE (query);
1876 ensure_array (structure, GST_QUARK (META), sizeof (AllocationMeta),
1877 (GDestroyNotify) allocation_meta_free);
1878 g_return_if_fail (index < array->len);
1880 g_array_remove_index (array, index);
1884 * gst_query_find_allocation_meta:
1885 * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1886 * @api: the metadata API
1887 * @index: (out) (transfer none) (allow-none): the index
1889 * Check if @query has metadata @api set. When this function returns %TRUE,
1890 * @index will contain the index where the requested API and the parameters
1893 * Returns: %TRUE when @api is in the list of metadata.
1896 gst_query_find_allocation_meta (GstQuery * query, GType api, guint * index)
1899 GstStructure *structure;
1902 g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION, FALSE);
1903 g_return_val_if_fail (api != 0, FALSE);
1905 structure = GST_QUERY_STRUCTURE (query);
1907 ensure_array (structure, GST_QUARK (META), sizeof (AllocationMeta),
1908 (GDestroyNotify) allocation_meta_free);
1911 for (i = 0; i < len; i++) {
1912 AllocationMeta *am = &g_array_index (array, AllocationMeta, i);
1913 if (am->api == api) {
1924 GstAllocator *allocator;
1925 GstAllocationParams params;
1929 allocation_param_free (AllocationParam * ap)
1932 gst_object_unref (ap->allocator);
1936 * gst_query_add_allocation_param:
1937 * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1938 * @allocator: (transfer none) (allow-none): the memory allocator
1939 * @params: (transfer none) (allow-none): a #GstAllocationParams
1941 * Add @allocator and its @params as a supported memory allocator.
1944 gst_query_add_allocation_param (GstQuery * query, GstAllocator * allocator,
1945 const GstAllocationParams * params)
1948 GstStructure *structure;
1951 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1952 g_return_if_fail (gst_query_is_writable (query));
1953 g_return_if_fail (allocator != NULL || params != NULL);
1955 structure = GST_QUERY_STRUCTURE (query);
1956 array = ensure_array (structure, GST_QUARK (ALLOCATOR),
1957 sizeof (AllocationParam), (GDestroyNotify) allocation_param_free);
1959 if ((ap.allocator = allocator))
1960 gst_object_ref (allocator);
1962 ap.params = *params;
1964 gst_allocation_params_init (&ap.params);
1966 g_array_append_val (array, ap);
1970 * gst_query_get_n_allocation_params:
1971 * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1973 * Retrieve the number of values currently stored in the
1974 * allocator params array of the query's structure.
1976 * If no memory allocator is specified, the downstream element can handle
1977 * the default memory allocator. The first memory allocator in the query
1978 * should be generic and allow mapping to system memory, all following
1979 * allocators should be ordered by preference with the preferred one first.
1981 * Returns: the allocator array size as a #guint.
1984 gst_query_get_n_allocation_params (GstQuery * query)
1987 GstStructure *structure;
1989 g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION, 0);
1991 structure = GST_QUERY_STRUCTURE (query);
1992 array = ensure_array (structure, GST_QUARK (ALLOCATOR),
1993 sizeof (AllocationParam), (GDestroyNotify) allocation_param_free);
1999 * gst_query_parse_nth_allocation_param:
2000 * @query: a GST_QUERY_ALLOCATION type query #GstQuery
2001 * @index: position in the allocator array to read
2002 * @allocator: (out) (transfer full) (allow-none): variable to hold the result
2003 * @params: (out) (allow-none): parameters for the allocator
2005 * Parse an available query and get the allocator and its params
2006 * at @index of the allocator array.
2009 gst_query_parse_nth_allocation_param (GstQuery * query, guint index,
2010 GstAllocator ** allocator, GstAllocationParams * params)
2013 GstStructure *structure;
2014 AllocationParam *ap;
2016 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
2018 structure = GST_QUERY_STRUCTURE (query);
2019 array = ensure_array (structure, GST_QUARK (ALLOCATOR),
2020 sizeof (AllocationParam), (GDestroyNotify) allocation_param_free);
2021 g_return_if_fail (index < array->len);
2023 ap = &g_array_index (array, AllocationParam, index);
2026 if ((*allocator = ap->allocator))
2027 gst_object_ref (*allocator);
2029 *params = ap->params;
2033 * gst_query_set_nth_allocation_param:
2034 * @query: a GST_QUERY_ALLOCATION type query #GstQuery
2035 * @index: position in the allocator array to set
2036 * @allocator: (transfer none) (allow-none): new allocator to set
2037 * @params: (transfer none) (allow-none): parameters for the allocator
2039 * Parse an available query and get the allocator and its params
2040 * at @index of the allocator array.
2043 gst_query_set_nth_allocation_param (GstQuery * query, guint index,
2044 GstAllocator * allocator, const GstAllocationParams * params)
2047 GstStructure *structure;
2048 AllocationParam *old, ap;
2050 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
2052 structure = GST_QUERY_STRUCTURE (query);
2053 array = ensure_array (structure, GST_QUARK (ALLOCATOR),
2054 sizeof (AllocationParam), (GDestroyNotify) allocation_param_free);
2055 g_return_if_fail (index < array->len);
2057 old = &g_array_index (array, AllocationParam, index);
2058 allocation_param_free (old);
2060 if ((ap.allocator = allocator))
2061 gst_object_ref (allocator);
2063 ap.params = *params;
2065 gst_allocation_params_init (&ap.params);
2067 g_array_index (array, AllocationParam, index) = ap;
2071 * gst_query_remove_nth_allocation_param:
2072 * @query: a GST_QUERY_ALLOCATION type query #GstQuery
2073 * @index: position in the allocation param array to remove
2075 * Remove the allocation param at @index of the allocation param array.
2080 gst_query_remove_nth_allocation_param (GstQuery * query, guint index)
2083 GstStructure *structure;
2085 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
2086 g_return_if_fail (gst_query_is_writable (query));
2088 structure = GST_QUERY_STRUCTURE (query);
2090 ensure_array (structure, GST_QUARK (ALLOCATOR), sizeof (AllocationParam),
2091 (GDestroyNotify) allocation_param_free);
2092 g_return_if_fail (index < array->len);
2094 g_array_remove_index (array, index);
2098 * gst_query_new_scheduling:
2100 * Constructs a new query object for querying the scheduling properties.
2102 * Free-function: gst_query_unref()
2104 * Returns: (transfer full): a new #GstQuery
2107 gst_query_new_scheduling (void)
2110 GstStructure *structure;
2112 structure = gst_structure_new_id (GST_QUARK (QUERY_SCHEDULING),
2113 GST_QUARK (FLAGS), GST_TYPE_SCHEDULING_FLAGS, 0,
2114 GST_QUARK (MINSIZE), G_TYPE_INT, 1,
2115 GST_QUARK (MAXSIZE), G_TYPE_INT, -1,
2116 GST_QUARK (ALIGN), G_TYPE_INT, 0, NULL);
2117 query = gst_query_new_custom (GST_QUERY_SCHEDULING, structure);
2123 * gst_query_set_scheduling:
2124 * @query: A valid #GstQuery of type GST_QUERY_SCHEDULING.
2125 * @flags: #GstSchedulingFlags
2126 * @minsize: the suggested minimum size of pull requests
2127 * @maxsize: the suggested maximum size of pull requests
2128 * @align: the suggested alignment of pull requests
2130 * Set the scheduling properties.
2133 gst_query_set_scheduling (GstQuery * query, GstSchedulingFlags flags,
2134 gint minsize, gint maxsize, gint align)
2136 GstStructure *structure;
2138 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SCHEDULING);
2139 g_return_if_fail (gst_query_is_writable (query));
2141 structure = GST_QUERY_STRUCTURE (query);
2142 gst_structure_id_set (structure,
2143 GST_QUARK (FLAGS), GST_TYPE_SCHEDULING_FLAGS, flags,
2144 GST_QUARK (MINSIZE), G_TYPE_INT, minsize,
2145 GST_QUARK (MAXSIZE), G_TYPE_INT, maxsize,
2146 GST_QUARK (ALIGN), G_TYPE_INT, align, NULL);
2150 * gst_query_parse_scheduling:
2151 * @query: A valid #GstQuery of type GST_QUERY_SCHEDULING.
2152 * @flags: (out) (allow-none): #GstSchedulingFlags
2153 * @minsize: (out) (allow-none): the suggested minimum size of pull requests
2154 * @maxsize: (out) (allow-none): the suggested maximum size of pull requests:
2155 * @align: (out) (allow-none): the suggested alignment of pull requests
2157 * Set the scheduling properties.
2160 gst_query_parse_scheduling (GstQuery * query, GstSchedulingFlags * flags,
2161 gint * minsize, gint * maxsize, gint * align)
2163 GstStructure *structure;
2165 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SCHEDULING);
2167 structure = GST_QUERY_STRUCTURE (query);
2168 gst_structure_id_get (structure,
2169 GST_QUARK (FLAGS), GST_TYPE_SCHEDULING_FLAGS, flags,
2170 GST_QUARK (MINSIZE), G_TYPE_INT, minsize,
2171 GST_QUARK (MAXSIZE), G_TYPE_INT, maxsize,
2172 GST_QUARK (ALIGN), G_TYPE_INT, align, NULL);
2176 * gst_query_add_scheduling_mode:
2177 * @query: a GST_QUERY_SCHEDULING type query #GstQuery
2178 * @mode: a #GstPadMode
2180 * Add @mode as one of the supported scheduling modes to @query.
2183 gst_query_add_scheduling_mode (GstQuery * query, GstPadMode mode)
2185 GstStructure *structure;
2188 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SCHEDULING);
2189 g_return_if_fail (gst_query_is_writable (query));
2191 structure = GST_QUERY_STRUCTURE (query);
2193 ensure_array (structure, GST_QUARK (MODES), sizeof (GstPadMode), NULL);
2195 g_array_append_val (array, mode);
2199 * gst_query_get_n_scheduling_modes:
2200 * @query: a GST_QUERY_SCHEDULING type query #GstQuery
2202 * Retrieve the number of values currently stored in the
2203 * scheduling mode array of the query's structure.
2205 * Returns: the scheduling mode array size as a #guint.
2208 gst_query_get_n_scheduling_modes (GstQuery * query)
2211 GstStructure *structure;
2213 g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SCHEDULING, 0);
2215 structure = GST_QUERY_STRUCTURE (query);
2217 ensure_array (structure, GST_QUARK (MODES), sizeof (GstPadMode), NULL);
2223 * gst_query_parse_nth_scheduling_mode:
2224 * @query: a GST_QUERY_SCHEDULING type query #GstQuery
2225 * @index: position in the scheduling modes array to read
2227 * Parse an available query and get the scheduling mode
2228 * at @index of the scheduling modes array.
2230 * Returns: a #GstPadMode of the scheduling mode at @index.
2233 gst_query_parse_nth_scheduling_mode (GstQuery * query, guint index)
2235 GstStructure *structure;
2238 g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SCHEDULING,
2241 structure = GST_QUERY_STRUCTURE (query);
2243 ensure_array (structure, GST_QUARK (MODES), sizeof (GstPadMode), NULL);
2244 g_return_val_if_fail (index < array->len, GST_PAD_MODE_NONE);
2246 return g_array_index (array, GstPadMode, index);
2250 * gst_query_has_scheduling_mode:
2251 * @query: a GST_QUERY_SCHEDULING type query #GstQuery
2252 * @mode: the scheduling mode
2254 * Check if @query has scheduling mode set.
2256 * > When checking if upstream supports pull mode, it is usually not
2257 * > enough to just check for GST_PAD_MODE_PULL with this function, you
2258 * > also want to check whether the scheduling flags returned by
2259 * > gst_query_parse_scheduling() have the seeking flag set (meaning
2260 * > random access is supported, not only sequential pulls).
2262 * Returns: %TRUE when @mode is in the list of scheduling modes.
2265 gst_query_has_scheduling_mode (GstQuery * query, GstPadMode mode)
2267 GstStructure *structure;
2271 g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SCHEDULING, FALSE);
2273 structure = GST_QUERY_STRUCTURE (query);
2275 ensure_array (structure, GST_QUARK (MODES), sizeof (GstPadMode), NULL);
2278 for (i = 0; i < len; i++) {
2279 if (mode == g_array_index (array, GstPadMode, i))
2286 * gst_query_has_scheduling_mode_with_flags:
2287 * @query: a GST_QUERY_SCHEDULING type query #GstQuery
2288 * @mode: the scheduling mode
2289 * @flags: #GstSchedulingFlags
2291 * Check if @query has scheduling mode set and @flags is set in
2292 * query scheduling flags.
2294 * Returns: %TRUE when @mode is in the list of scheduling modes
2295 * and @flags are compatible with query flags.
2298 gst_query_has_scheduling_mode_with_flags (GstQuery * query, GstPadMode mode,
2299 GstSchedulingFlags flags)
2301 GstSchedulingFlags sched_flags;
2303 g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SCHEDULING, FALSE);
2305 gst_query_parse_scheduling (query, &sched_flags, NULL, NULL, NULL);
2307 return ((flags & sched_flags) == flags) &&
2308 gst_query_has_scheduling_mode (query, mode);
2312 * gst_query_new_accept_caps:
2313 * @caps: a fixed #GstCaps
2315 * Constructs a new query object for querying if @caps are accepted.
2317 * Free-function: gst_query_unref()
2319 * Returns: (transfer full): a new #GstQuery
2322 gst_query_new_accept_caps (GstCaps * caps)
2325 GstStructure *structure;
2327 g_return_val_if_fail (gst_caps_is_fixed (caps), NULL);
2329 structure = gst_structure_new_id (GST_QUARK (QUERY_ACCEPT_CAPS),
2330 GST_QUARK (CAPS), GST_TYPE_CAPS, caps,
2331 GST_QUARK (RESULT), G_TYPE_BOOLEAN, FALSE, NULL);
2332 query = gst_query_new_custom (GST_QUERY_ACCEPT_CAPS, structure);
2338 * gst_query_parse_accept_caps:
2339 * @query: The query to parse
2340 * @caps: (out) (transfer none): A pointer to the caps
2342 * Get the caps from @query. The caps remains valid as long as @query remains
2346 gst_query_parse_accept_caps (GstQuery * query, GstCaps ** caps)
2348 GstStructure *structure;
2350 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ACCEPT_CAPS);
2351 g_return_if_fail (caps != NULL);
2353 structure = GST_QUERY_STRUCTURE (query);
2354 *caps = g_value_get_boxed (gst_structure_id_get_value (structure,
2359 * gst_query_set_accept_caps_result:
2360 * @query: a GST_QUERY_ACCEPT_CAPS type query #GstQuery
2361 * @result: the result to set
2363 * Set @result as the result for the @query.
2366 gst_query_set_accept_caps_result (GstQuery * query, gboolean result)
2368 GstStructure *structure;
2370 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ACCEPT_CAPS);
2371 g_return_if_fail (gst_query_is_writable (query));
2373 structure = GST_QUERY_STRUCTURE (query);
2374 gst_structure_id_set (structure,
2375 GST_QUARK (RESULT), G_TYPE_BOOLEAN, result, NULL);
2379 * gst_query_parse_accept_caps_result:
2380 * @query: a GST_QUERY_ACCEPT_CAPS type query #GstQuery
2381 * @result: location for the result
2383 * Parse the result from @query and store in @result.
2386 gst_query_parse_accept_caps_result (GstQuery * query, gboolean * result)
2388 GstStructure *structure;
2390 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ACCEPT_CAPS);
2392 structure = GST_QUERY_STRUCTURE (query);
2393 gst_structure_id_get (structure,
2394 GST_QUARK (RESULT), G_TYPE_BOOLEAN, result, NULL);
2398 * gst_query_new_caps:
2401 * Constructs a new query object for querying the caps.
2403 * The CAPS query should return the allowable caps for a pad in the context
2404 * of the element's state, its link to other elements, and the devices or files
2405 * it has opened. These caps must be a subset of the pad template caps. In the
2406 * NULL state with no links, the CAPS query should ideally return the same caps
2407 * as the pad template. In rare circumstances, an object property can affect
2408 * the caps returned by the CAPS query, but this is discouraged.
2410 * For most filters, the caps returned by CAPS query is directly affected by the
2411 * allowed caps on other pads. For demuxers and decoders, the caps returned by
2412 * the srcpad's getcaps function is directly related to the stream data. Again,
2413 * the CAPS query should return the most specific caps it reasonably can, since this
2414 * helps with autoplugging.
2416 * The @filter is used to restrict the result caps, only the caps matching
2417 * @filter should be returned from the CAPS query. Specifying a filter might
2418 * greatly reduce the amount of processing an element needs to do.
2420 * Free-function: gst_query_unref()
2422 * Returns: (transfer full): a new #GstQuery
2425 gst_query_new_caps (GstCaps * filter)
2428 GstStructure *structure;
2430 structure = gst_structure_new_id (GST_QUARK (QUERY_CAPS),
2431 GST_QUARK (FILTER), GST_TYPE_CAPS, filter,
2432 GST_QUARK (CAPS), GST_TYPE_CAPS, NULL, NULL);
2433 query = gst_query_new_custom (GST_QUERY_CAPS, structure);
2439 * gst_query_parse_caps:
2440 * @query: The query to parse
2441 * @filter: (out) (transfer none): A pointer to the caps filter
2443 * Get the filter from the caps @query. The caps remains valid as long as
2444 * @query remains valid.
2447 gst_query_parse_caps (GstQuery * query, GstCaps ** filter)
2449 GstStructure *structure;
2451 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CAPS);
2452 g_return_if_fail (filter != NULL);
2454 structure = GST_QUERY_STRUCTURE (query);
2455 *filter = g_value_get_boxed (gst_structure_id_get_value (structure,
2456 GST_QUARK (FILTER)));
2460 * gst_query_set_caps_result:
2461 * @query: The query to use
2462 * @caps: (in): A pointer to the caps
2464 * Set the @caps result in @query.
2467 gst_query_set_caps_result (GstQuery * query, GstCaps * caps)
2469 GstStructure *structure;
2471 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CAPS);
2472 g_return_if_fail (gst_query_is_writable (query));
2474 structure = GST_QUERY_STRUCTURE (query);
2475 gst_structure_id_set (structure, GST_QUARK (CAPS), GST_TYPE_CAPS, caps, NULL);
2479 * gst_query_parse_caps_result:
2480 * @query: The query to parse
2481 * @caps: (out) (transfer none): A pointer to the caps
2483 * Get the caps result from @query. The caps remains valid as long as
2484 * @query remains valid.
2487 gst_query_parse_caps_result (GstQuery * query, GstCaps ** caps)
2489 GstStructure *structure;
2491 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CAPS);
2492 g_return_if_fail (caps != NULL);
2494 structure = GST_QUERY_STRUCTURE (query);
2495 *caps = g_value_get_boxed (gst_structure_id_get_value (structure,
2501 gst_query_intersect_caps_result (GstQuery * query, GstCaps * filter,
2502 GstCapsIntersectMode mode)
2504 GstCaps *res, *caps = NULL;
2506 gst_query_parse_caps_result (query, &caps);
2507 res = gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
2508 gst_query_set_caps_result (query, res);
2509 gst_caps_unref (res);
2514 * gst_query_new_drain:
2516 * Constructs a new query object for querying the drain state.
2518 * Free-function: gst_query_unref()
2520 * Returns: (transfer full): a new #GstQuery
2523 gst_query_new_drain (void)
2526 GstStructure *structure;
2528 structure = gst_structure_new_id_empty (GST_QUARK (QUERY_DRAIN));
2529 query = gst_query_new_custom (GST_QUERY_DRAIN, structure);
2535 * gst_query_new_context:
2536 * @context_type: Context type to query
2538 * Constructs a new query object for querying the pipeline-local context.
2540 * Free-function: gst_query_unref()
2542 * Returns: (transfer full): a new #GstQuery
2547 gst_query_new_context (const gchar * context_type)
2550 GstStructure *structure;
2552 g_return_val_if_fail (context_type != NULL, NULL);
2554 structure = gst_structure_new_id (GST_QUARK (QUERY_CONTEXT),
2555 GST_QUARK (CONTEXT_TYPE), G_TYPE_STRING, context_type, NULL);
2556 query = gst_query_new_custom (GST_QUERY_CONTEXT, structure);
2562 * gst_query_set_context:
2563 * @query: a #GstQuery with query type GST_QUERY_CONTEXT
2564 * @context: the requested #GstContext
2566 * Answer a context query by setting the requested context.
2571 gst_query_set_context (GstQuery * query, GstContext * context)
2574 const gchar *context_type;
2576 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CONTEXT);
2578 gst_query_parse_context_type (query, &context_type);
2579 g_return_if_fail (strcmp (gst_context_get_context_type (context),
2580 context_type) == 0);
2582 s = GST_QUERY_STRUCTURE (query);
2584 gst_structure_id_set (s,
2585 GST_QUARK (CONTEXT), GST_TYPE_CONTEXT, context, NULL);
2589 * gst_query_parse_context:
2590 * @query: The query to parse
2591 * @context: (out) (transfer none): A pointer to store the #GstContext
2593 * Get the context from the context @query. The context remains valid as long as
2594 * @query remains valid.
2599 gst_query_parse_context (GstQuery * query, GstContext ** context)
2601 GstStructure *structure;
2604 g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CONTEXT);
2605 g_return_if_fail (context != NULL);
2607 structure = GST_QUERY_STRUCTURE (query);
2608 v = gst_structure_id_get_value (structure, GST_QUARK (CONTEXT));
2610 *context = g_value_get_boxed (v);
2616 * gst_query_parse_context_type:
2617 * @query: a GST_QUERY_CONTEXT type query
2618 * @context_type: (out) (transfer none) (allow-none): the context type, or %NULL
2620 * Parse a context type from an existing GST_QUERY_CONTEXT query.
2622 * Returns: a #gboolean indicating if the parsing succeeded.
2627 gst_query_parse_context_type (GstQuery * query, const gchar ** context_type)
2629 GstStructure *structure;
2630 const GValue *value;
2632 g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CONTEXT, FALSE);
2634 structure = GST_QUERY_STRUCTURE (query);
2637 value = gst_structure_id_get_value (structure, GST_QUARK (CONTEXT_TYPE));
2638 *context_type = g_value_get_string (value);