gst/gstquery.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wim.taymans@chello.be>
   4  *                    2005 Wim Taymans <wim@fluendo.com>
   5  *
   6  * gstquery.c: GstQueryType registration and Query parsing/creation
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  21  * Boston, MA 02110-1301, USA.
  22  */
  23
  24 /**
  25  * SECTION:gstquery
  26  * @short_description: Provide functions to create queries, and to set and parse
  27  *                     values in them.
  28  * @see_also: #GstPad, #GstElement
  29  *
  30  * Queries can be performed on pads (gst_pad_query()) and elements
  31  * (gst_element_query()). Please note that some queries might need a running
  32  * pipeline to work.
  33  *
  34  * Queries can be created using the gst_query_new_*() functions.
  35  * Query values can be set using gst_query_set_*(), and parsed using
  36  * gst_query_parse_*() helpers.
  37  *
  38  * The following example shows how to query the duration of a pipeline:
  39  *
  40  * <example>
  41  *  <title>Query duration on a pipeline</title>
  42  *  <programlisting>
  43  *  GstQuery *query;
  44  *  gboolean res;
  45  *  query = gst_query_new_duration (GST_FORMAT_TIME);
  46  *  res = gst_element_query (pipeline, query);
  47  *  if (res) {
  48  *    gint64 duration;
  49  *    gst_query_parse_duration (query, NULL, &amp;duration);
  50  *    g_print ("duration = %"GST_TIME_FORMAT, GST_TIME_ARGS (duration));
  51  *  }
  52  *  else {
  53  *    g_print ("duration query failed...");
  54  *  }
  55  *  gst_query_unref (query);
  56  *  </programlisting>
  57  * </example>
  58  *
  59  * Last reviewed on 2012-03-29 (0.11.3)
  60  */
  61
  62
  63 #include "gst_private.h"
  64 #include "gstinfo.h"
  65 #include "gstquery.h"
  66 #include "gstvalue.h"
  67 #include "gstenumtypes.h"
  68 #include "gstquark.h"
  69 #include "gsturi.h"
  70 #include "gstbufferpool.h"
  71
  72 GST_DEBUG_CATEGORY_STATIC (gst_query_debug);
  73 #define GST_CAT_DEFAULT gst_query_debug
  74
  75 static GType _gst_query_type = 0;
  76
  77 typedef struct
  78 {
  79   GstQuery query;
  80
  81   GstStructure *structure;
  82 } GstQueryImpl;
  83
  84 #define GST_QUERY_STRUCTURE(q)  (((GstQueryImpl *)(q))->structure)
  85
  86
  87 typedef struct
  88 {
  89   const gint type;
  90   const gchar *name;
  91   GQuark quark;
  92 } GstQueryQuarks;
  93
  94 static GstQueryQuarks query_quarks[] = {
  95   {GST_QUERY_UNKNOWN, "unknown", 0},
  96   {GST_QUERY_POSITION, "position", 0},
  97   {GST_QUERY_DURATION, "duration", 0},
  98   {GST_QUERY_LATENCY, "latency", 0},
  99   {GST_QUERY_JITTER, "jitter", 0},
 100   {GST_QUERY_RATE, "rate", 0},
 101   {GST_QUERY_SEEKING, "seeking", 0},
 102   {GST_QUERY_SEGMENT, "segment", 0},
 103   {GST_QUERY_CONVERT, "convert", 0},
 104   {GST_QUERY_FORMATS, "formats", 0},
 105   {GST_QUERY_BUFFERING, "buffering", 0},
 106   {GST_QUERY_CUSTOM, "custom", 0},
 107   {GST_QUERY_URI, "uri", 0},
 108   {GST_QUERY_ALLOCATION, "allocation", 0},
 109   {GST_QUERY_SCHEDULING, "scheduling", 0},
 110   {GST_QUERY_ACCEPT_CAPS, "accept-caps", 0},
 111   {GST_QUERY_CAPS, "caps", 0},
 112   {GST_QUERY_DRAIN, "drain", 0},
 113   {GST_QUERY_CONTEXT, "context", 0},
 114
 115   {0, NULL, 0}
 116 };
 117
 118 GST_DEFINE_MINI_OBJECT_TYPE (GstQuery, gst_query);
 119
 120 void
 121 _priv_gst_query_initialize (void)
 122 {
 123   gint i;
 124
 125   _gst_query_type = gst_query_get_type ();
 126
 127   GST_DEBUG_CATEGORY_INIT (gst_query_debug, "query", 0, "query system");
 128
 129   for (i = 0; query_quarks[i].name; i++) {
 130     query_quarks[i].quark = g_quark_from_static_string (query_quarks[i].name);
 131   }
 132 }
 133
 134 /**
 135  * gst_query_type_get_name:
 136  * @type: the query type
 137  *
 138  * Get a printable name for the given query type. Do not modify or free.
 139  *
 140  * Returns: a reference to the static name of the query.
 141  */
 142 const gchar *
 143 gst_query_type_get_name (GstQueryType type)
 144 {
 145   gint i;
 146
 147   for (i = 0; query_quarks[i].name; i++) {
 148     if (type == query_quarks[i].type)
 149       return query_quarks[i].name;
 150   }
 151   return "unknown";
 152 }
 153
 154 /**
 155  * gst_query_type_to_quark:
 156  * @type: the query type
 157  *
 158  * Get the unique quark for the given query type.
 159  *
 160  * Returns: the quark associated with the query type
 161  */
 162 GQuark
 163 gst_query_type_to_quark (GstQueryType type)
 164 {
 165   gint i;
 166
 167   for (i = 0; query_quarks[i].name; i++) {
 168     if (type == query_quarks[i].type)
 169       return query_quarks[i].quark;
 170   }
 171   return 0;
 172 }
 173
 174 /**
 175  * gst_query_type_get_flags:
 176  * @type: a #GstQueryType
 177  *
 178  * Gets the #GstQueryTypeFlags associated with @type.
 179  *
 180  * Returns: a #GstQueryTypeFlags.
 181  */
 182 GstQueryTypeFlags
 183 gst_query_type_get_flags (GstQueryType type)
 184 {
 185   GstQueryTypeFlags ret;
 186
 187   ret = type & ((1 << GST_QUERY_NUM_SHIFT) - 1);
 188
 189   return ret;
 190 }
 191
 192 static void
 193 _gst_query_free (GstQuery * query)
 194 {
 195   GstStructure *s;
 196
 197   g_return_if_fail (query != NULL);
 198
 199   s = GST_QUERY_STRUCTURE (query);
 200   if (s) {
 201     gst_structure_set_parent_refcount (s, NULL);
 202     gst_structure_free (s);
 203   }
 204
 205   g_slice_free1 (sizeof (GstQueryImpl), query);
 206 }
 207
 208 static GstQuery *
 209 _gst_query_copy (GstQuery * query)
 210 {
 211   GstQuery *copy;
 212   GstStructure *s;
 213
 214   s = GST_QUERY_STRUCTURE (query);
 215   if (s) {
 216     s = gst_structure_copy (s);
 217   }
 218   copy = gst_query_new_custom (query->type, s);
 219
 220   return copy;
 221 }
 222
 223 /**
 224  * gst_query_new_position:
 225  * @format: the default #GstFormat for the new query
 226  *
 227  * Constructs a new query stream position query object. Use gst_query_unref()
 228  * when done with it. A position query is used to query the current position
 229  * of playback in the streams, in some format.
 230  *
 231  * Free-function: gst_query_unref
 232  *
 233  * Returns: (transfer full): a new #GstQuery
 234  */
 235 GstQuery *
 236 gst_query_new_position (GstFormat format)
 237 {
 238   GstQuery *query;
 239   GstStructure *structure;
 240
 241   structure = gst_structure_new_id (GST_QUARK (QUERY_POSITION),
 242       GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
 243       GST_QUARK (CURRENT), G_TYPE_INT64, G_GINT64_CONSTANT (-1), NULL);
 244
 245   query = gst_query_new_custom (GST_QUERY_POSITION, structure);
 246
 247   return query;
 248 }
 249
 250 /**
 251  * gst_query_set_position:
 252  * @query: a #GstQuery with query type GST_QUERY_POSITION
 253  * @format: the requested #GstFormat
 254  * @cur: the position to set
 255  *
 256  * Answer a position query by setting the requested value in the given format.
 257  */
 258 void
 259 gst_query_set_position (GstQuery * query, GstFormat format, gint64 cur)
 260 {
 261   GstStructure *s;
 262
 263   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_POSITION);
 264
 265   s = GST_QUERY_STRUCTURE (query);
 266   g_return_if_fail (format == g_value_get_enum (gst_structure_id_get_value (s,
 267               GST_QUARK (FORMAT))));
 268
 269   gst_structure_id_set (s,
 270       GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
 271       GST_QUARK (CURRENT), G_TYPE_INT64, cur, NULL);
 272 }
 273
 274 /**
 275  * gst_query_parse_position:
 276  * @query: a #GstQuery
 277  * @format: (out) (allow-none): the storage for the #GstFormat of the
 278  *     position values (may be NULL)
 279  * @cur: (out) (allow-none): the storage for the current position (may be NULL)
 280  *
 281  * Parse a position query, writing the format into @format, and the position
 282  * into @cur, if the respective parameters are non-NULL.
 283  */
 284 void
 285 gst_query_parse_position (GstQuery * query, GstFormat * format, gint64 * cur)
 286 {
 287   GstStructure *structure;
 288
 289   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_POSITION);
 290
 291   structure = GST_QUERY_STRUCTURE (query);
 292   if (format)
 293     *format =
 294         (GstFormat) g_value_get_enum (gst_structure_id_get_value (structure,
 295             GST_QUARK (FORMAT)));
 296   if (cur)
 297     *cur = g_value_get_int64 (gst_structure_id_get_value (structure,
 298             GST_QUARK (CURRENT)));
 299 }
 300
 301
 302 /**
 303  * gst_query_new_duration:
 304  * @format: the #GstFormat for this duration query
 305  *
 306  * Constructs a new stream duration query object to query in the given format.
 307  * Use gst_query_unref() when done with it. A duration query will give the
 308  * total length of the stream.
 309  *
 310  * Free-function: gst_query_unref
 311  *
 312  * Returns: (transfer full): a new #GstQuery
 313  */
 314 GstQuery *
 315 gst_query_new_duration (GstFormat format)
 316 {
 317   GstQuery *query;
 318   GstStructure *structure;
 319
 320   structure = gst_structure_new_id (GST_QUARK (QUERY_DURATION),
 321       GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
 322       GST_QUARK (DURATION), G_TYPE_INT64, G_GINT64_CONSTANT (-1), NULL);
 323
 324   query = gst_query_new_custom (GST_QUERY_DURATION, structure);
 325
 326   return query;
 327 }
 328
 329 /**
 330  * gst_query_set_duration:
 331  * @query: a #GstQuery
 332  * @format: the #GstFormat for the duration
 333  * @duration: the duration of the stream
 334  *
 335  * Answer a duration query by setting the requested value in the given format.
 336  */
 337 void
 338 gst_query_set_duration (GstQuery * query, GstFormat format, gint64 duration)
 339 {
 340   GstStructure *s;
 341
 342   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_DURATION);
 343
 344   s = GST_QUERY_STRUCTURE (query);
 345   g_return_if_fail (format == g_value_get_enum (gst_structure_id_get_value (s,
 346               GST_QUARK (FORMAT))));
 347   gst_structure_id_set (s, GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
 348       GST_QUARK (DURATION), G_TYPE_INT64, duration, NULL);
 349 }
 350
 351 /**
 352  * gst_query_parse_duration:
 353  * @query: a #GstQuery
 354  * @format: (out) (allow-none): the storage for the #GstFormat of the duration
 355  *     value, or NULL.
 356  * @duration: (out) (allow-none): the storage for the total duration, or NULL.
 357  *
 358  * Parse a duration query answer. Write the format of the duration into @format,
 359  * and the value into @duration, if the respective variables are non-NULL.
 360  */
 361 void
 362 gst_query_parse_duration (GstQuery * query, GstFormat * format,
 363     gint64 * duration)
 364 {
 365   GstStructure *structure;
 366
 367   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_DURATION);
 368
 369   structure = GST_QUERY_STRUCTURE (query);
 370   if (format)
 371     *format =
 372         (GstFormat) g_value_get_enum (gst_structure_id_get_value (structure,
 373             GST_QUARK (FORMAT)));
 374   if (duration)
 375     *duration = g_value_get_int64 (gst_structure_id_get_value (structure,
 376             GST_QUARK (DURATION)));
 377 }
 378
 379 /**
 380  * gst_query_new_latency:
 381  *
 382  * Constructs a new latency query object.
 383  * Use gst_query_unref() when done with it. A latency query is usually performed
 384  * by sinks to compensate for additional latency introduced by elements in the
 385  * pipeline.
 386  *
 387  * Free-function: gst_query_unref
 388  *
 389  * Returns: (transfer full): a #GstQuery
 390  */
 391 GstQuery *
 392 gst_query_new_latency (void)
 393 {
 394   GstQuery *query;
 395   GstStructure *structure;
 396
 397   structure = gst_structure_new_id (GST_QUARK (QUERY_LATENCY),
 398       GST_QUARK (LIVE), G_TYPE_BOOLEAN, FALSE,
 399       GST_QUARK (MIN_LATENCY), G_TYPE_UINT64, G_GUINT64_CONSTANT (0),
 400       GST_QUARK (MAX_LATENCY), G_TYPE_UINT64, G_GUINT64_CONSTANT (-1), NULL);
 401
 402   query = gst_query_new_custom (GST_QUERY_LATENCY, structure);
 403
 404   return query;
 405 }
 406
 407 /**
 408  * gst_query_set_latency:
 409  * @query: a #GstQuery
 410  * @live: if there is a live element upstream
 411  * @min_latency: the minimal latency of the upstream elements
 412  * @max_latency: the maximal latency of the upstream elements
 413  *
 414  * Answer a latency query by setting the requested values in the given format.
 415  */
 416 void
 417 gst_query_set_latency (GstQuery * query, gboolean live,
 418     GstClockTime min_latency, GstClockTime max_latency)
 419 {
 420   GstStructure *structure;
 421
 422   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_LATENCY);
 423
 424   structure = GST_QUERY_STRUCTURE (query);
 425   gst_structure_id_set (structure,
 426       GST_QUARK (LIVE), G_TYPE_BOOLEAN, live,
 427       GST_QUARK (MIN_LATENCY), G_TYPE_UINT64, min_latency,
 428       GST_QUARK (MAX_LATENCY), G_TYPE_UINT64, max_latency, NULL);
 429 }
 430
 431 /**
 432  * gst_query_parse_latency:
 433  * @query: a #GstQuery
 434  * @live: (out) (allow-none): storage for live or NULL
 435  * @min_latency: (out) (allow-none): the storage for the min latency or NULL
 436  * @max_latency: (out) (allow-none): the storage for the max latency or NULL
 437  *
 438  * Parse a latency query answer.
 439  */
 440 void
 441 gst_query_parse_latency (GstQuery * query, gboolean * live,
 442     GstClockTime * min_latency, GstClockTime * max_latency)
 443 {
 444   GstStructure *structure;
 445
 446   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_LATENCY);
 447
 448   structure = GST_QUERY_STRUCTURE (query);
 449   if (live)
 450     *live =
 451         g_value_get_boolean (gst_structure_id_get_value (structure,
 452             GST_QUARK (LIVE)));
 453   if (min_latency)
 454     *min_latency = g_value_get_uint64 (gst_structure_id_get_value (structure,
 455             GST_QUARK (MIN_LATENCY)));
 456   if (max_latency)
 457     *max_latency = g_value_get_uint64 (gst_structure_id_get_value (structure,
 458             GST_QUARK (MAX_LATENCY)));
 459 }
 460
 461 /**
 462  * gst_query_new_convert:
 463  * @src_format: the source #GstFormat for the new query
 464  * @value: the value to convert
 465  * @dest_format: the target #GstFormat
 466  *
 467  * Constructs a new convert query object. Use gst_query_unref()
 468  * when done with it. A convert query is used to ask for a conversion between
 469  * one format and another.
 470  *
 471  * Free-function: gst_query_unref
 472  *
 473  * Returns: (transfer full): a #GstQuery
 474  */
 475 GstQuery *
 476 gst_query_new_convert (GstFormat src_format, gint64 value,
 477     GstFormat dest_format)
 478 {
 479   GstQuery *query;
 480   GstStructure *structure;
 481
 482   structure = gst_structure_new_id (GST_QUARK (QUERY_CONVERT),
 483       GST_QUARK (SRC_FORMAT), GST_TYPE_FORMAT, src_format,
 484       GST_QUARK (SRC_VALUE), G_TYPE_INT64, value,
 485       GST_QUARK (DEST_FORMAT), GST_TYPE_FORMAT, dest_format,
 486       GST_QUARK (DEST_VALUE), G_TYPE_INT64, G_GINT64_CONSTANT (-1), NULL);
 487
 488   query = gst_query_new_custom (GST_QUERY_CONVERT, structure);
 489
 490   return query;
 491 }
 492
 493 /**
 494  * gst_query_set_convert:
 495  * @query: a #GstQuery
 496  * @src_format: the source #GstFormat
 497  * @src_value: the source value
 498  * @dest_format: the destination #GstFormat
 499  * @dest_value: the destination value
 500  *
 501  * Answer a convert query by setting the requested values.
 502  */
 503 void
 504 gst_query_set_convert (GstQuery * query, GstFormat src_format, gint64 src_value,
 505     GstFormat dest_format, gint64 dest_value)
 506 {
 507   GstStructure *structure;
 508
 509   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CONVERT);
 510
 511   structure = GST_QUERY_STRUCTURE (query);
 512   gst_structure_id_set (structure,
 513       GST_QUARK (SRC_FORMAT), GST_TYPE_FORMAT, src_format,
 514       GST_QUARK (SRC_VALUE), G_TYPE_INT64, src_value,
 515       GST_QUARK (DEST_FORMAT), GST_TYPE_FORMAT, dest_format,
 516       GST_QUARK (DEST_VALUE), G_TYPE_INT64, dest_value, NULL);
 517 }
 518
 519 /**
 520  * gst_query_parse_convert:
 521  * @query: a #GstQuery
 522  * @src_format: (out) (allow-none): the storage for the #GstFormat of the
 523  *     source value, or NULL
 524  * @src_value: (out) (allow-none): the storage for the source value, or NULL
 525  * @dest_format: (out) (allow-none): the storage for the #GstFormat of the
 526  *     destination value, or NULL
 527  * @dest_value: (out) (allow-none): the storage for the destination value,
 528  *     or NULL
 529  *
 530  * Parse a convert query answer. Any of @src_format, @src_value, @dest_format,
 531  * and @dest_value may be NULL, in which case that value is omitted.
 532  */
 533 void
 534 gst_query_parse_convert (GstQuery * query, GstFormat * src_format,
 535     gint64 * src_value, GstFormat * dest_format, gint64 * dest_value)
 536 {
 537   GstStructure *structure;
 538
 539   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CONVERT);
 540
 541   structure = GST_QUERY_STRUCTURE (query);
 542   if (src_format)
 543     *src_format =
 544         (GstFormat) g_value_get_enum (gst_structure_id_get_value (structure,
 545             GST_QUARK (SRC_FORMAT)));
 546   if (src_value)
 547     *src_value = g_value_get_int64 (gst_structure_id_get_value (structure,
 548             GST_QUARK (SRC_VALUE)));
 549   if (dest_format)
 550     *dest_format =
 551         (GstFormat) g_value_get_enum (gst_structure_id_get_value (structure,
 552             GST_QUARK (DEST_FORMAT)));
 553   if (dest_value)
 554     *dest_value = g_value_get_int64 (gst_structure_id_get_value (structure,
 555             GST_QUARK (DEST_VALUE)));
 556 }
 557
 558 /**
 559  * gst_query_new_segment:
 560  * @format: the #GstFormat for the new query
 561  *
 562  * Constructs a new segment query object. Use gst_query_unref()
 563  * when done with it. A segment query is used to discover information about the
 564  * currently configured segment for playback.
 565  *
 566  * Free-function: gst_query_unref
 567  *
 568  * Returns: (transfer full): a new #GstQuery
 569  */
 570 GstQuery *
 571 gst_query_new_segment (GstFormat format)
 572 {
 573   GstQuery *query;
 574   GstStructure *structure;
 575
 576   structure = gst_structure_new_id (GST_QUARK (QUERY_SEGMENT),
 577       GST_QUARK (RATE), G_TYPE_DOUBLE, (gdouble) 0.0,
 578       GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
 579       GST_QUARK (START_VALUE), G_TYPE_INT64, G_GINT64_CONSTANT (-1),
 580       GST_QUARK (STOP_VALUE), G_TYPE_INT64, G_GINT64_CONSTANT (-1), NULL);
 581
 582   query = gst_query_new_custom (GST_QUERY_SEGMENT, structure);
 583
 584   return query;
 585 }
 586
 587 /**
 588  * gst_query_set_segment:
 589  * @query: a #GstQuery
 590  * @rate: the rate of the segment
 591  * @format: the #GstFormat of the segment values (@start_value and @stop_value)
 592  * @start_value: the start value
 593  * @stop_value: the stop value
 594  *
 595  * Answer a segment query by setting the requested values. The normal
 596  * playback segment of a pipeline is 0 to duration at the default rate of
 597  * 1.0. If a seek was performed on the pipeline to play a different
 598  * segment, this query will return the range specified in the last seek.
 599  *
 600  * @start_value and @stop_value will respectively contain the configured
 601  * playback range start and stop values expressed in @format.
 602  * The values are always between 0 and the duration of the media and
 603  * @start_value <= @stop_value. @rate will contain the playback rate. For
 604  * negative rates, playback will actually happen from @stop_value to
 605  * @start_value.
 606  */
 607 void
 608 gst_query_set_segment (GstQuery * query, gdouble rate, GstFormat format,
 609     gint64 start_value, gint64 stop_value)
 610 {
 611   GstStructure *structure;
 612
 613   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SEGMENT);
 614
 615   structure = GST_QUERY_STRUCTURE (query);
 616   gst_structure_id_set (structure,
 617       GST_QUARK (RATE), G_TYPE_DOUBLE, rate,
 618       GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
 619       GST_QUARK (START_VALUE), G_TYPE_INT64, start_value,
 620       GST_QUARK (STOP_VALUE), G_TYPE_INT64, stop_value, NULL);
 621 }
 622
 623 /**
 624  * gst_query_parse_segment:
 625  * @query: a #GstQuery
 626  * @rate: (out) (allow-none): the storage for the rate of the segment, or NULL
 627  * @format: (out) (allow-none): the storage for the #GstFormat of the values,
 628  *     or NULL
 629  * @start_value: (out) (allow-none): the storage for the start value, or NULL
 630  * @stop_value: (out) (allow-none): the storage for the stop value, or NULL
 631  *
 632  * Parse a segment query answer. Any of @rate, @format, @start_value, and
 633  * @stop_value may be NULL, which will cause this value to be omitted.
 634  *
 635  * See gst_query_set_segment() for an explanation of the function arguments.
 636  */
 637 void
 638 gst_query_parse_segment (GstQuery * query, gdouble * rate, GstFormat * format,
 639     gint64 * start_value, gint64 * stop_value)
 640 {
 641   GstStructure *structure;
 642
 643   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SEGMENT);
 644
 645   structure = GST_QUERY_STRUCTURE (query);
 646   if (rate)
 647     *rate = g_value_get_double (gst_structure_id_get_value (structure,
 648             GST_QUARK (RATE)));
 649   if (format)
 650     *format =
 651         (GstFormat) g_value_get_enum (gst_structure_id_get_value (structure,
 652             GST_QUARK (FORMAT)));
 653   if (start_value)
 654     *start_value = g_value_get_int64 (gst_structure_id_get_value (structure,
 655             GST_QUARK (START_VALUE)));
 656   if (stop_value)
 657     *stop_value = g_value_get_int64 (gst_structure_id_get_value (structure,
 658             GST_QUARK (STOP_VALUE)));
 659 }
 660
 661 /**
 662  * gst_query_new_custom:
 663  * @type: the query type
 664  * @structure: a structure for the query
 665  *
 666  * Constructs a new custom query object. Use gst_query_unref()
 667  * when done with it.
 668  *
 669  * Free-function: gst_query_unref
 670  *
 671  * Returns: (transfer full): a new #GstQuery
 672  */
 673 GstQuery *
 674 gst_query_new_custom (GstQueryType type, GstStructure * structure)
 675 {
 676   GstQueryImpl *query;
 677
 678   query = g_slice_new0 (GstQueryImpl);
 679
 680   GST_DEBUG ("creating new query %p %s", query, gst_query_type_get_name (type));
 681
 682   if (structure) {
 683     /* structure must not have a parent */
 684     if (!gst_structure_set_parent_refcount (structure,
 685             &query->query.mini_object.refcount))
 686       goto had_parent;
 687   }
 688
 689   gst_mini_object_init (GST_MINI_OBJECT_CAST (query), 0, _gst_query_type,
 690       (GstMiniObjectCopyFunction) _gst_query_copy, NULL,
 691       (GstMiniObjectFreeFunction) _gst_query_free);
 692
 693   GST_QUERY_TYPE (query) = type;
 694   GST_QUERY_STRUCTURE (query) = structure;
 695
 696   return GST_QUERY_CAST (query);
 697
 698   /* ERRORS */
 699 had_parent:
 700   {
 701     g_slice_free1 (sizeof (GstQueryImpl), query);
 702     g_warning ("structure is already owned by another object");
 703     return NULL;
 704   }
 705 }
 706
 707 /**
 708  * gst_query_get_structure:
 709  * @query: a #GstQuery
 710  *
 711  * Get the structure of a query.
 712  *
 713  * Returns: (transfer none): the #GstStructure of the query. The structure is
 714  *     still owned by the query and will therefore be freed when the query
 715  *     is unreffed.
 716  */
 717 const GstStructure *
 718 gst_query_get_structure (GstQuery * query)
 719 {
 720   g_return_val_if_fail (GST_IS_QUERY (query), NULL);
 721
 722   return GST_QUERY_STRUCTURE (query);
 723 }
 724
 725 /**
 726  * gst_query_writable_structure:
 727  * @query: a #GstQuery
 728  *
 729  * Get the structure of a query. This method should be called with a writable
 730  * @query so that the returned structure is guranteed to be writable.
 731  *
 732  * Returns: (transfer none): the #GstStructure of the query. The structure is
 733  *     still owned by the query and will therefore be freed when the query
 734  *     is unreffed.
 735  */
 736 GstStructure *
 737 gst_query_writable_structure (GstQuery * query)
 738 {
 739   g_return_val_if_fail (GST_IS_QUERY (query), NULL);
 740   g_return_val_if_fail (gst_query_is_writable (query), NULL);
 741
 742   return GST_QUERY_STRUCTURE (query);
 743 }
 744
 745 /**
 746  * gst_query_new_seeking:
 747  * @format: the default #GstFormat for the new query
 748  *
 749  * Constructs a new query object for querying seeking properties of
 750  * the stream.
 751  *
 752  * Free-function: gst_query_unref
 753  *
 754  * Returns: (transfer full): a new #GstQuery
 755  */
 756 GstQuery *
 757 gst_query_new_seeking (GstFormat format)
 758 {
 759   GstQuery *query;
 760   GstStructure *structure;
 761
 762   structure = gst_structure_new_id (GST_QUARK (QUERY_SEEKING),
 763       GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
 764       GST_QUARK (SEEKABLE), G_TYPE_BOOLEAN, FALSE,
 765       GST_QUARK (SEGMENT_START), G_TYPE_INT64, G_GINT64_CONSTANT (-1),
 766       GST_QUARK (SEGMENT_END), G_TYPE_INT64, G_GINT64_CONSTANT (-1), NULL);
 767
 768   query = gst_query_new_custom (GST_QUERY_SEEKING, structure);
 769
 770   return query;
 771 }
 772
 773 /**
 774  * gst_query_set_seeking:
 775  * @query: a #GstQuery
 776  * @format: the format to set for the @segment_start and @segment_end values
 777  * @seekable: the seekable flag to set
 778  * @segment_start: the segment_start to set
 779  * @segment_end: the segment_end to set
 780  *
 781  * Set the seeking query result fields in @query.
 782  */
 783 void
 784 gst_query_set_seeking (GstQuery * query, GstFormat format,
 785     gboolean seekable, gint64 segment_start, gint64 segment_end)
 786 {
 787   GstStructure *structure;
 788
 789   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SEEKING);
 790   g_return_if_fail (gst_query_is_writable (query));
 791
 792   structure = GST_QUERY_STRUCTURE (query);
 793   gst_structure_id_set (structure,
 794       GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
 795       GST_QUARK (SEEKABLE), G_TYPE_BOOLEAN, seekable,
 796       GST_QUARK (SEGMENT_START), G_TYPE_INT64, segment_start,
 797       GST_QUARK (SEGMENT_END), G_TYPE_INT64, segment_end, NULL);
 798 }
 799
 800 /**
 801  * gst_query_parse_seeking:
 802  * @query: a GST_QUERY_SEEKING type query #GstQuery
 803  * @format: (out) (allow-none): the format to set for the @segment_start
 804  *     and @segment_end values, or NULL
 805  * @seekable: (out) (allow-none): the seekable flag to set, or NULL
 806  * @segment_start: (out) (allow-none): the segment_start to set, or NULL
 807  * @segment_end: (out) (allow-none): the segment_end to set, or NULL
 808  *
 809  * Parse a seeking query, writing the format into @format, and
 810  * other results into the passed parameters, if the respective parameters
 811  * are non-NULL
 812  */
 813 void
 814 gst_query_parse_seeking (GstQuery * query, GstFormat * format,
 815     gboolean * seekable, gint64 * segment_start, gint64 * segment_end)
 816 {
 817   GstStructure *structure;
 818
 819   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SEEKING);
 820
 821   structure = GST_QUERY_STRUCTURE (query);
 822   if (format)
 823     *format =
 824         (GstFormat) g_value_get_enum (gst_structure_id_get_value (structure,
 825             GST_QUARK (FORMAT)));
 826   if (seekable)
 827     *seekable = g_value_get_boolean (gst_structure_id_get_value (structure,
 828             GST_QUARK (SEEKABLE)));
 829   if (segment_start)
 830     *segment_start = g_value_get_int64 (gst_structure_id_get_value (structure,
 831             GST_QUARK (SEGMENT_START)));
 832   if (segment_end)
 833     *segment_end = g_value_get_int64 (gst_structure_id_get_value (structure,
 834             GST_QUARK (SEGMENT_END)));
 835 }
 836
 837 static GArray *
 838 ensure_array (GstStructure * s, GQuark quark, gsize element_size,
 839     GDestroyNotify clear_func)
 840 {
 841   GArray *array;
 842   const GValue *value;
 843
 844   value = gst_structure_id_get_value (s, quark);
 845   if (value) {
 846     array = (GArray *) g_value_get_boxed (value);
 847   } else {
 848     GValue new_array_val = { 0, };
 849
 850     array = g_array_new (FALSE, TRUE, element_size);
 851     if (clear_func)
 852       g_array_set_clear_func (array, clear_func);
 853
 854     g_value_init (&new_array_val, G_TYPE_ARRAY);
 855     g_value_take_boxed (&new_array_val, array);
 856
 857     gst_structure_id_take_value (s, quark, &new_array_val);
 858   }
 859   return array;
 860 }
 861
 862 /**
 863  * gst_query_new_formats:
 864  *
 865  * Constructs a new query object for querying formats of
 866  * the stream.
 867  *
 868  * Free-function: gst_query_unref
 869  *
 870  * Returns: (transfer full): a new #GstQuery
 871  */
 872 GstQuery *
 873 gst_query_new_formats (void)
 874 {
 875   GstQuery *query;
 876   GstStructure *structure;
 877
 878   structure = gst_structure_new_id_empty (GST_QUARK (QUERY_FORMATS));
 879   query = gst_query_new_custom (GST_QUERY_FORMATS, structure);
 880
 881   return query;
 882 }
 883
 884 static void
 885 gst_query_list_add_format (GValue * list, GstFormat format)
 886 {
 887   GValue item = { 0, };
 888
 889   g_value_init (&item, GST_TYPE_FORMAT);
 890   g_value_set_enum (&item, format);
 891   gst_value_list_append_value (list, &item);
 892   g_value_unset (&item);
 893 }
 894
 895 /**
 896  * gst_query_set_formats:
 897  * @query: a #GstQuery
 898  * @n_formats: the number of formats to set.
 899  * @...: A number of @GstFormats equal to @n_formats.
 900  *
 901  * Set the formats query result fields in @query. The number of formats passed
 902  * must be equal to @n_formats.
 903  */
 904 void
 905 gst_query_set_formats (GstQuery * query, gint n_formats, ...)
 906 {
 907   va_list ap;
 908   GValue list = { 0, };
 909   gint i;
 910   GstStructure *structure;
 911
 912   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_FORMATS);
 913   g_return_if_fail (gst_query_is_writable (query));
 914
 915   g_value_init (&list, GST_TYPE_LIST);
 916
 917   va_start (ap, n_formats);
 918   for (i = 0; i < n_formats; i++) {
 919     gst_query_list_add_format (&list, va_arg (ap, GstFormat));
 920   }
 921   va_end (ap);
 922
 923   structure = GST_QUERY_STRUCTURE (query);
 924   gst_structure_set_value (structure, "formats", &list);
 925
 926   g_value_unset (&list);
 927
 928 }
 929
 930 /**
 931  * gst_query_set_formatsv:
 932  * @query: a #GstQuery
 933  * @n_formats: the number of formats to set.
 934  * @formats: (in) (array length=n_formats): an array containing @n_formats
 935  *     @GstFormat values.
 936  *
 937  * Set the formats query result fields in @query. The number of formats passed
 938  * in the @formats array must be equal to @n_formats.
 939  */
 940 void
 941 gst_query_set_formatsv (GstQuery * query, gint n_formats,
 942     const GstFormat * formats)
 943 {
 944   GValue list = { 0, };
 945   gint i;
 946   GstStructure *structure;
 947
 948   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_FORMATS);
 949   g_return_if_fail (gst_query_is_writable (query));
 950
 951   g_value_init (&list, GST_TYPE_LIST);
 952   for (i = 0; i < n_formats; i++) {
 953     gst_query_list_add_format (&list, formats[i]);
 954   }
 955   structure = GST_QUERY_STRUCTURE (query);
 956   gst_structure_set_value (structure, "formats", &list);
 957
 958   g_value_unset (&list);
 959 }
 960
 961 /**
 962  * gst_query_parse_n_formats:
 963  * @query: a #GstQuery
 964  * @n_formats: (out) (allow-none): the number of formats in this query.
 965  *
 966  * Parse the number of formats in the formats @query.
 967  */
 968 void
 969 gst_query_parse_n_formats (GstQuery * query, guint * n_formats)
 970 {
 971   GstStructure *structure;
 972
 973   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_FORMATS);
 974
 975   if (n_formats) {
 976     const GValue *list;
 977
 978     structure = GST_QUERY_STRUCTURE (query);
 979     list = gst_structure_get_value (structure, "formats");
 980     if (list == NULL)
 981       *n_formats = 0;
 982     else
 983       *n_formats = gst_value_list_get_size (list);
 984   }
 985 }
 986
 987 /**
 988  * gst_query_parse_nth_format:
 989  * @query: a #GstQuery
 990  * @nth: (out): the nth format to retrieve.
 991  * @format: (out) (allow-none): a pointer to store the nth format
 992  *
 993  * Parse the format query and retrieve the @nth format from it into
 994  * @format. If the list contains less elements than @nth, @format will be
 995  * set to GST_FORMAT_UNDEFINED.
 996  */
 997 void
 998 gst_query_parse_nth_format (GstQuery * query, guint nth, GstFormat * format)
 999 {
1000   GstStructure *structure;
1001
1002   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_FORMATS);
1003
1004   if (format) {
1005     const GValue *list;
1006
1007     structure = GST_QUERY_STRUCTURE (query);
1008     list = gst_structure_get_value (structure, "formats");
1009     if (list == NULL) {
1010       *format = GST_FORMAT_UNDEFINED;
1011     } else {
1012       if (nth < gst_value_list_get_size (list)) {
1013         *format =
1014             (GstFormat) g_value_get_enum (gst_value_list_get_value (list, nth));
1015       } else
1016         *format = GST_FORMAT_UNDEFINED;
1017     }
1018   }
1019 }
1020
1021 /**
1022  * gst_query_new_buffering:
1023  * @format: the default #GstFormat for the new query
1024  *
1025  * Constructs a new query object for querying the buffering status of
1026  * a stream.
1027  *
1028  * Free-function: gst_query_unref
1029  *
1030  * Returns: (transfer full): a new #GstQuery
1031  */
1032 GstQuery *
1033 gst_query_new_buffering (GstFormat format)
1034 {
1035   GstQuery *query;
1036   GstStructure *structure;
1037
1038   /* by default, we configure the answer as no buffering with a 100% buffering
1039    * progress */
1040   structure = gst_structure_new_id (GST_QUARK (QUERY_BUFFERING),
1041       GST_QUARK (BUSY), G_TYPE_BOOLEAN, FALSE,
1042       GST_QUARK (BUFFER_PERCENT), G_TYPE_INT, 100,
1043       GST_QUARK (BUFFERING_MODE), GST_TYPE_BUFFERING_MODE, GST_BUFFERING_STREAM,
1044       GST_QUARK (AVG_IN_RATE), G_TYPE_INT, -1,
1045       GST_QUARK (AVG_OUT_RATE), G_TYPE_INT, -1,
1046       GST_QUARK (BUFFERING_LEFT), G_TYPE_INT64, G_GINT64_CONSTANT (0),
1047       GST_QUARK (ESTIMATED_TOTAL), G_TYPE_INT64, G_GINT64_CONSTANT (-1),
1048       GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
1049       GST_QUARK (START_VALUE), G_TYPE_INT64, G_GINT64_CONSTANT (-1),
1050       GST_QUARK (STOP_VALUE), G_TYPE_INT64, G_GINT64_CONSTANT (-1), NULL);
1051
1052   query = gst_query_new_custom (GST_QUERY_BUFFERING, structure);
1053
1054   return query;
1055 }
1056
1057 /**
1058  * gst_query_set_buffering_percent:
1059  * @query: A valid #GstQuery of type GST_QUERY_BUFFERING.
1060  * @busy: if buffering is busy
1061  * @percent: a buffering percent
1062  *
1063  * Set the percentage of buffered data. This is a value between 0 and 100.
1064  * The @busy indicator is %TRUE when the buffering is in progress.
1065  */
1066 void
1067 gst_query_set_buffering_percent (GstQuery * query, gboolean busy, gint percent)
1068 {
1069   GstStructure *structure;
1070
1071   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING);
1072   g_return_if_fail (gst_query_is_writable (query));
1073   g_return_if_fail (percent >= 0 && percent <= 100);
1074
1075   structure = GST_QUERY_STRUCTURE (query);
1076   gst_structure_id_set (structure,
1077       GST_QUARK (BUSY), G_TYPE_BOOLEAN, busy,
1078       GST_QUARK (BUFFER_PERCENT), G_TYPE_INT, percent, NULL);
1079 }
1080
1081 /**
1082  * gst_query_parse_buffering_percent:
1083  * @query: A valid #GstQuery of type GST_QUERY_BUFFERING.
1084  * @busy: (out) (allow-none): if buffering is busy, or NULL
1085  * @percent: (out) (allow-none): a buffering percent, or NULL
1086  *
1087  * Get the percentage of buffered data. This is a value between 0 and 100.
1088  * The @busy indicator is %TRUE when the buffering is in progress.
1089  */
1090 void
1091 gst_query_parse_buffering_percent (GstQuery * query, gboolean * busy,
1092     gint * percent)
1093 {
1094   GstStructure *structure;
1095
1096   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING);
1097
1098   structure = GST_QUERY_STRUCTURE (query);
1099   if (busy)
1100     *busy = g_value_get_boolean (gst_structure_id_get_value (structure,
1101             GST_QUARK (BUSY)));
1102   if (percent)
1103     *percent = g_value_get_int (gst_structure_id_get_value (structure,
1104             GST_QUARK (BUFFER_PERCENT)));
1105 }
1106
1107 /**
1108  * gst_query_set_buffering_stats:
1109  * @query: A valid #GstQuery of type GST_QUERY_BUFFERING.
1110  * @mode: a buffering mode
1111  * @avg_in: the average input rate
1112  * @avg_out: the average output rate
1113  * @buffering_left: amount of buffering time left in milliseconds
1114  *
1115  * Configures the buffering stats values in @query.
1116  */
1117 void
1118 gst_query_set_buffering_stats (GstQuery * query, GstBufferingMode mode,
1119     gint avg_in, gint avg_out, gint64 buffering_left)
1120 {
1121   GstStructure *structure;
1122
1123   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING);
1124   g_return_if_fail (gst_query_is_writable (query));
1125
1126   structure = GST_QUERY_STRUCTURE (query);
1127   gst_structure_id_set (structure,
1128       GST_QUARK (BUFFERING_MODE), GST_TYPE_BUFFERING_MODE, mode,
1129       GST_QUARK (AVG_IN_RATE), G_TYPE_INT, avg_in,
1130       GST_QUARK (AVG_OUT_RATE), G_TYPE_INT, avg_out,
1131       GST_QUARK (BUFFERING_LEFT), G_TYPE_INT64, buffering_left, NULL);
1132 }
1133
1134 /**
1135  * gst_query_parse_buffering_stats:
1136  * @query: A valid #GstQuery of type GST_QUERY_BUFFERING.
1137  * @mode: (out) (allow-none): a buffering mode, or NULL
1138  * @avg_in: (out) (allow-none): the average input rate, or NULL
1139  * @avg_out: (out) (allow-none): the average output rat, or NULLe
1140  * @buffering_left: (out) (allow-none): amount of buffering time left in
1141  *     milliseconds, or NULL
1142  *
1143  * Extracts the buffering stats values from @query.
1144  */
1145 void
1146 gst_query_parse_buffering_stats (GstQuery * query,
1147     GstBufferingMode * mode, gint * avg_in, gint * avg_out,
1148     gint64 * buffering_left)
1149 {
1150   GstStructure *structure;
1151
1152   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING);
1153
1154   structure = GST_QUERY_STRUCTURE (query);
1155   if (mode)
1156     *mode = (GstBufferingMode)
1157         g_value_get_enum (gst_structure_id_get_value (structure,
1158             GST_QUARK (BUFFERING_MODE)));
1159   if (avg_in)
1160     *avg_in = g_value_get_int (gst_structure_id_get_value (structure,
1161             GST_QUARK (AVG_IN_RATE)));
1162   if (avg_out)
1163     *avg_out = g_value_get_int (gst_structure_id_get_value (structure,
1164             GST_QUARK (AVG_OUT_RATE)));
1165   if (buffering_left)
1166     *buffering_left =
1167         g_value_get_int64 (gst_structure_id_get_value (structure,
1168             GST_QUARK (BUFFERING_LEFT)));
1169 }
1170
1171 /**
1172  * gst_query_set_buffering_range:
1173  * @query: a #GstQuery
1174  * @format: the format to set for the @start and @stop values
1175  * @start: the start to set
1176  * @stop: the stop to set
1177  * @estimated_total: estimated total amount of download time remaining in
1178  *     miliseconds
1179  *
1180  * Set the available query result fields in @query.
1181  */
1182 void
1183 gst_query_set_buffering_range (GstQuery * query, GstFormat format,
1184     gint64 start, gint64 stop, gint64 estimated_total)
1185 {
1186   GstStructure *structure;
1187
1188   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING);
1189   g_return_if_fail (gst_query_is_writable (query));
1190
1191   structure = GST_QUERY_STRUCTURE (query);
1192   gst_structure_id_set (structure,
1193       GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
1194       GST_QUARK (START_VALUE), G_TYPE_INT64, start,
1195       GST_QUARK (STOP_VALUE), G_TYPE_INT64, stop,
1196       GST_QUARK (ESTIMATED_TOTAL), G_TYPE_INT64, estimated_total, NULL);
1197 }
1198
1199 /**
1200  * gst_query_parse_buffering_range:
1201  * @query: a GST_QUERY_BUFFERING type query #GstQuery
1202  * @format: (out) (allow-none): the format to set for the @segment_start
1203  *     and @segment_end values, or NULL
1204  * @start: (out) (allow-none): the start to set, or NULL
1205  * @stop: (out) (allow-none): the stop to set, or NULL
1206  * @estimated_total: (out) (allow-none): estimated total amount of download
1207  *     time remaining in miliseconds, or NULL
1208  *
1209  * Parse an available query, writing the format into @format, and
1210  * other results into the passed parameters, if the respective parameters
1211  * are non-NULL
1212  */
1213 void
1214 gst_query_parse_buffering_range (GstQuery * query, GstFormat * format,
1215     gint64 * start, gint64 * stop, gint64 * estimated_total)
1216 {
1217   GstStructure *structure;
1218
1219   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING);
1220
1221   structure = GST_QUERY_STRUCTURE (query);
1222   if (format)
1223     *format =
1224         (GstFormat) g_value_get_enum (gst_structure_id_get_value (structure,
1225             GST_QUARK (FORMAT)));
1226   if (start)
1227     *start = g_value_get_int64 (gst_structure_id_get_value (structure,
1228             GST_QUARK (START_VALUE)));
1229   if (stop)
1230     *stop = g_value_get_int64 (gst_structure_id_get_value (structure,
1231             GST_QUARK (STOP_VALUE)));
1232   if (estimated_total)
1233     *estimated_total =
1234         g_value_get_int64 (gst_structure_id_get_value (structure,
1235             GST_QUARK (ESTIMATED_TOTAL)));
1236 }
1237
1238 /* GstQueryBufferingRange: internal struct for GArray */
1239 typedef struct
1240 {
1241   gint64 start;
1242   gint64 stop;
1243 } GstQueryBufferingRange;
1244
1245 /**
1246  * gst_query_add_buffering_range:
1247  * @query: a GST_QUERY_BUFFERING type query #GstQuery
1248  * @start: start position of the range
1249  * @stop: stop position of the range
1250  *
1251  * Set the buffering-ranges array field in @query. The current last
1252  * start position of the array should be inferior to @start.
1253  *
1254  * Returns: a #gboolean indicating if the range was added or not.
1255  */
1256 gboolean
1257 gst_query_add_buffering_range (GstQuery * query, gint64 start, gint64 stop)
1258 {
1259   GstQueryBufferingRange range;
1260   GstStructure *structure;
1261   GArray *array;
1262
1263   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING, FALSE);
1264   g_return_val_if_fail (gst_query_is_writable (query), FALSE);
1265
1266   if (G_UNLIKELY (start >= stop))
1267     return FALSE;
1268
1269   structure = GST_QUERY_STRUCTURE (query);
1270   array = ensure_array (structure, GST_QUARK (BUFFERING_RANGES),
1271       sizeof (GstQueryBufferingRange), NULL);
1272
1273   if (array->len > 1) {
1274     GstQueryBufferingRange *last;
1275
1276     last = &g_array_index (array, GstQueryBufferingRange, array->len - 1);
1277
1278     if (G_UNLIKELY (start <= last->start))
1279       return FALSE;
1280   }
1281
1282   range.start = start;
1283   range.stop = stop;
1284   g_array_append_val (array, range);
1285
1286   return TRUE;
1287 }
1288
1289 /**
1290  * gst_query_get_n_buffering_ranges:
1291  * @query: a GST_QUERY_BUFFERING type query #GstQuery
1292  *
1293  * Retrieve the number of values currently stored in the
1294  * buffered-ranges array of the query's structure.
1295  *
1296  * Returns: the range array size as a #guint.
1297  */
1298 guint
1299 gst_query_get_n_buffering_ranges (GstQuery * query)
1300 {
1301   GstStructure *structure;
1302   GArray *array;
1303
1304   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING, 0);
1305
1306   structure = GST_QUERY_STRUCTURE (query);
1307   array = ensure_array (structure, GST_QUARK (BUFFERING_RANGES),
1308       sizeof (GstQueryBufferingRange), NULL);
1309
1310   return array->len;
1311 }
1312
1313
1314 /**
1315  * gst_query_parse_nth_buffering_range:
1316  * @query: a GST_QUERY_BUFFERING type query #GstQuery
1317  * @index: position in the buffered-ranges array to read
1318  * @start: (out) (allow-none): the start position to set, or NULL
1319  * @stop: (out) (allow-none): the stop position to set, or NULL
1320  *
1321  * Parse an available query and get the start and stop values stored
1322  * at the @index of the buffered ranges array.
1323  *
1324  * Returns: a #gboolean indicating if the parsing succeeded.
1325  */
1326 gboolean
1327 gst_query_parse_nth_buffering_range (GstQuery * query, guint index,
1328     gint64 * start, gint64 * stop)
1329 {
1330   GstQueryBufferingRange *range;
1331   GstStructure *structure;
1332   GArray *array;
1333
1334   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING, FALSE);
1335
1336   structure = GST_QUERY_STRUCTURE (query);
1337
1338   array = ensure_array (structure, GST_QUARK (BUFFERING_RANGES),
1339       sizeof (GstQueryBufferingRange), NULL);
1340   g_return_val_if_fail (index < array->len, FALSE);
1341
1342   range = &g_array_index (array, GstQueryBufferingRange, index);
1343
1344   if (start)
1345     *start = range->start;
1346   if (stop)
1347     *stop = range->stop;
1348
1349   return TRUE;
1350 }
1351
1352
1353 /**
1354  * gst_query_new_uri:
1355  *
1356  * Constructs a new query URI query object. Use gst_query_unref()
1357  * when done with it. An URI query is used to query the current URI
1358  * that is used by the source or sink.
1359  *
1360  * Free-function: gst_query_unref
1361  *
1362  * Returns: (transfer full): a new #GstQuery
1363  */
1364 GstQuery *
1365 gst_query_new_uri (void)
1366 {
1367   GstQuery *query;
1368   GstStructure *structure;
1369
1370   structure = gst_structure_new_id (GST_QUARK (QUERY_URI),
1371       GST_QUARK (URI), G_TYPE_STRING, NULL, NULL);
1372
1373   query = gst_query_new_custom (GST_QUERY_URI, structure);
1374
1375   return query;
1376 }
1377
1378 /**
1379  * gst_query_set_uri:
1380  * @query: a #GstQuery with query type GST_QUERY_URI
1381  * @uri: the URI to set
1382  *
1383  * Answer a URI query by setting the requested URI.
1384  */
1385 void
1386 gst_query_set_uri (GstQuery * query, const gchar * uri)
1387 {
1388   GstStructure *structure;
1389
1390   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_URI);
1391   g_return_if_fail (gst_query_is_writable (query));
1392   g_return_if_fail (gst_uri_is_valid (uri));
1393
1394   structure = GST_QUERY_STRUCTURE (query);
1395   gst_structure_id_set (structure, GST_QUARK (URI), G_TYPE_STRING, uri, NULL);
1396 }
1397
1398 /**
1399  * gst_query_parse_uri:
1400  * @query: a #GstQuery
1401  * @uri: (out callee-allocates) (allow-none): the storage for the current URI
1402  *     (may be NULL)
1403  *
1404  * Parse an URI query, writing the URI into @uri as a newly
1405  * allocated string, if the respective parameters are non-NULL.
1406  * Free the string with g_free() after usage.
1407  */
1408 void
1409 gst_query_parse_uri (GstQuery * query, gchar ** uri)
1410 {
1411   GstStructure *structure;
1412
1413   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_URI);
1414
1415   structure = GST_QUERY_STRUCTURE (query);
1416   if (uri)
1417     *uri = g_value_dup_string (gst_structure_id_get_value (structure,
1418             GST_QUARK (URI)));
1419 }
1420
1421 /**
1422  * gst_query_new_allocation:
1423  * @caps: the negotiated caps
1424  * @need_pool: return a pool
1425  *
1426  * Constructs a new query object for querying the allocation properties.
1427  *
1428  * Free-function: gst_query_unref
1429  *
1430  * Returns: (transfer full): a new #GstQuery
1431  */
1432 GstQuery *
1433 gst_query_new_allocation (GstCaps * caps, gboolean need_pool)
1434 {
1435   GstQuery *query;
1436   GstStructure *structure;
1437
1438   structure = gst_structure_new_id (GST_QUARK (QUERY_ALLOCATION),
1439       GST_QUARK (CAPS), GST_TYPE_CAPS, caps,
1440       GST_QUARK (NEED_POOL), G_TYPE_BOOLEAN, need_pool, NULL);
1441
1442   query = gst_query_new_custom (GST_QUERY_ALLOCATION, structure);
1443
1444   return query;
1445 }
1446
1447 /**
1448  * gst_query_parse_allocation:
1449  * @query: a #GstQuery
1450  * @caps: (out) (transfer none) (allow-none): The #GstCaps
1451  * @need_pool: (out) (allow-none): Whether a #GstBufferPool is needed
1452  *
1453  * Parse an allocation query, writing the requested caps in @caps and
1454  * whether a pool is needed in @need_pool, if the respective parameters
1455  * are non-NULL.
1456  */
1457 void
1458 gst_query_parse_allocation (GstQuery * query, GstCaps ** caps,
1459     gboolean * need_pool)
1460 {
1461   GstStructure *structure;
1462
1463   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1464
1465   structure = GST_QUERY_STRUCTURE (query);
1466   if (caps) {
1467     *caps = g_value_get_boxed (gst_structure_id_get_value (structure,
1468             GST_QUARK (CAPS)));
1469   }
1470   gst_structure_id_get (structure,
1471       GST_QUARK (NEED_POOL), G_TYPE_BOOLEAN, need_pool, NULL);
1472 }
1473
1474 typedef struct
1475 {
1476   GstBufferPool *pool;
1477   guint size;
1478   guint min_buffers;
1479   guint max_buffers;
1480 } AllocationPool;
1481
1482 static void
1483 allocation_pool_free (AllocationPool * ap)
1484 {
1485   if (ap->pool)
1486     gst_object_unref (ap->pool);
1487 }
1488
1489 /**
1490  * gst_query_add_allocation_pool:
1491  * @query: A valid #GstQuery of type GST_QUERY_ALLOCATION.
1492  * @pool: the #GstBufferPool
1493  * @size: the size
1494  * @min_buffers: the min buffers
1495  * @max_buffers: the max buffers
1496  *
1497  * Set the pool parameters in @query.
1498  */
1499 void
1500 gst_query_add_allocation_pool (GstQuery * query, GstBufferPool * pool,
1501     guint size, guint min_buffers, guint max_buffers)
1502 {
1503   GArray *array;
1504   GstStructure *structure;
1505   AllocationPool ap;
1506
1507   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1508   g_return_if_fail (gst_query_is_writable (query));
1509   g_return_if_fail (size != 0);
1510
1511   structure = GST_QUERY_STRUCTURE (query);
1512   array = ensure_array (structure, GST_QUARK (POOL),
1513       sizeof (AllocationPool), (GDestroyNotify) allocation_pool_free);
1514
1515   if ((ap.pool = pool))
1516     gst_object_ref (pool);
1517   ap.size = size;
1518   ap.min_buffers = min_buffers;
1519   ap.max_buffers = max_buffers;
1520
1521   g_array_append_val (array, ap);
1522 }
1523
1524
1525 /**
1526  * gst_query_get_n_allocation_pools:
1527  * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1528  *
1529  * Retrieve the number of values currently stored in the
1530  * pool array of the query's structure.
1531  *
1532  * Returns: the pool array size as a #guint.
1533  */
1534 guint
1535 gst_query_get_n_allocation_pools (GstQuery * query)
1536 {
1537   GArray *array;
1538   GstStructure *structure;
1539
1540   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION, 0);
1541
1542   structure = GST_QUERY_STRUCTURE (query);
1543   array = ensure_array (structure, GST_QUARK (POOL),
1544       sizeof (AllocationPool), (GDestroyNotify) allocation_pool_free);
1545
1546   return array->len;
1547 }
1548
1549 /**
1550  * gst_query_parse_nth_allocation_pool:
1551  * @query: A valid #GstQuery of type GST_QUERY_ALLOCATION.
1552  * @index: index to parse
1553  * @pool: (out) (allow-none) (transfer full): the #GstBufferPool
1554  * @size: (out) (allow-none): the size
1555  * @min_buffers: (out) (allow-none): the min buffers
1556  * @max_buffers: (out) (allow-none): the max buffers
1557  *
1558  * Get the pool parameters in @query.
1559  *
1560  * Unref @pool with gst_object_unref() when it's not needed any more.
1561  */
1562 void
1563 gst_query_parse_nth_allocation_pool (GstQuery * query, guint index,
1564     GstBufferPool ** pool, guint * size, guint * min_buffers,
1565     guint * max_buffers)
1566 {
1567   GArray *array;
1568   GstStructure *structure;
1569   AllocationPool *ap;
1570
1571   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1572
1573   structure = GST_QUERY_STRUCTURE (query);
1574   array = ensure_array (structure, GST_QUARK (POOL),
1575       sizeof (AllocationPool), (GDestroyNotify) allocation_pool_free);
1576   g_return_if_fail (index < array->len);
1577
1578   ap = &g_array_index (array, AllocationPool, index);
1579
1580   if (pool)
1581     if ((*pool = ap->pool))
1582       gst_object_ref (*pool);
1583   if (size)
1584     *size = ap->size;
1585   if (min_buffers)
1586     *min_buffers = ap->min_buffers;
1587   if (max_buffers)
1588     *max_buffers = ap->max_buffers;
1589 }
1590
1591 /**
1592  * gst_query_set_nth_allocation_pool:
1593  * @index: index to modify
1594  * @query: A valid #GstQuery of type GST_QUERY_ALLOCATION.
1595  * @pool: the #GstBufferPool
1596  * @size: the size
1597  * @min_buffers: the min buffers
1598  * @max_buffers: the max buffers
1599  *
1600  * Set the pool parameters in @query.
1601  */
1602 void
1603 gst_query_set_nth_allocation_pool (GstQuery * query, guint index,
1604     GstBufferPool * pool, guint size, guint min_buffers, guint max_buffers)
1605 {
1606   GArray *array;
1607   GstStructure *structure;
1608   AllocationPool *oldap, ap;
1609
1610   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1611
1612   structure = GST_QUERY_STRUCTURE (query);
1613   array = ensure_array (structure, GST_QUARK (POOL),
1614       sizeof (AllocationPool), (GDestroyNotify) allocation_pool_free);
1615   g_return_if_fail (index < array->len);
1616
1617   oldap = &g_array_index (array, AllocationPool, index);
1618   allocation_pool_free (oldap);
1619
1620   if ((ap.pool = pool))
1621     gst_object_ref (pool);
1622   ap.size = size;
1623   ap.min_buffers = min_buffers;
1624   ap.max_buffers = max_buffers;
1625   g_array_index (array, AllocationPool, index) = ap;
1626 }
1627
1628 /**
1629  * gst_query_remove_nth_allocation_pool:
1630  * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1631  * @index: position in the allocation pool array to remove
1632  *
1633  * Remove the allocation pool at @index of the allocation pool array.
1634  *
1635  * Since: 1.2
1636  */
1637 void
1638 gst_query_remove_nth_allocation_pool (GstQuery * query, guint index)
1639 {
1640   GArray *array;
1641   GstStructure *structure;
1642
1643   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1644   g_return_if_fail (gst_query_is_writable (query));
1645
1646   structure = GST_QUERY_STRUCTURE (query);
1647   array =
1648       ensure_array (structure, GST_QUARK (POOL), sizeof (AllocationPool),
1649       (GDestroyNotify) allocation_pool_free);
1650   g_return_if_fail (index < array->len);
1651
1652   g_array_remove_index (array, index);
1653 }
1654
1655 typedef struct
1656 {
1657   GType api;
1658   GstStructure *params;
1659 } AllocationMeta;
1660
1661 static void
1662 allocation_meta_free (AllocationMeta * am)
1663 {
1664   if (am->params)
1665     gst_structure_free (am->params);
1666 }
1667
1668 /**
1669  * gst_query_add_allocation_meta:
1670  * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1671  * @api: the metadata API
1672  * @params: (transfer none) (allow-none): API specific parameters
1673  *
1674  * Add @api with @params as one of the supported metadata API to @query.
1675  */
1676 void
1677 gst_query_add_allocation_meta (GstQuery * query, GType api,
1678     const GstStructure * params)
1679 {
1680   GArray *array;
1681   GstStructure *structure;
1682   AllocationMeta am;
1683
1684   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1685   g_return_if_fail (api != 0);
1686   g_return_if_fail (gst_query_is_writable (query));
1687
1688   structure = GST_QUERY_STRUCTURE (query);
1689   array =
1690       ensure_array (structure, GST_QUARK (META), sizeof (AllocationMeta),
1691       (GDestroyNotify) allocation_meta_free);
1692
1693   am.api = api;
1694   am.params = (params ? gst_structure_copy (params) : NULL);
1695
1696   g_array_append_val (array, am);
1697 }
1698
1699 /**
1700  * gst_query_get_n_allocation_metas:
1701  * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1702  *
1703  * Retrieve the number of values currently stored in the
1704  * meta API array of the query's structure.
1705  *
1706  * Returns: the metadata API array size as a #guint.
1707  */
1708 guint
1709 gst_query_get_n_allocation_metas (GstQuery * query)
1710 {
1711   GArray *array;
1712   GstStructure *structure;
1713
1714   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION, 0);
1715
1716   structure = GST_QUERY_STRUCTURE (query);
1717   array =
1718       ensure_array (structure, GST_QUARK (META), sizeof (AllocationMeta),
1719       (GDestroyNotify) allocation_meta_free);
1720
1721   return array->len;
1722 }
1723
1724 /**
1725  * gst_query_parse_nth_allocation_meta:
1726  * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1727  * @index: position in the metadata API array to read
1728  * @params: (out) (allow-none): API specific flags
1729  *
1730  * Parse an available query and get the metadata API
1731  * at @index of the metadata API array.
1732  *
1733  * Returns: a #GType of the metadata API at @index.
1734  */
1735 GType
1736 gst_query_parse_nth_allocation_meta (GstQuery * query, guint index,
1737     const GstStructure ** params)
1738 {
1739   GArray *array;
1740   GstStructure *structure;
1741   AllocationMeta *am;
1742
1743   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION, 0);
1744
1745   structure = GST_QUERY_STRUCTURE (query);
1746   array =
1747       ensure_array (structure, GST_QUARK (META), sizeof (AllocationMeta),
1748       (GDestroyNotify) allocation_meta_free);
1749
1750   g_return_val_if_fail (index < array->len, 0);
1751
1752   am = &g_array_index (array, AllocationMeta, index);
1753
1754   if (params)
1755     *params = am->params;
1756
1757   return am->api;
1758 }
1759
1760 /**
1761  * gst_query_remove_nth_allocation_meta:
1762  * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1763  * @index: position in the metadata API array to remove
1764  *
1765  * Remove the metadata API at @index of the metadata API array.
1766  */
1767 void
1768 gst_query_remove_nth_allocation_meta (GstQuery * query, guint index)
1769 {
1770   GArray *array;
1771   GstStructure *structure;
1772
1773   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1774   g_return_if_fail (gst_query_is_writable (query));
1775
1776   structure = GST_QUERY_STRUCTURE (query);
1777   array =
1778       ensure_array (structure, GST_QUARK (META), sizeof (AllocationMeta),
1779       (GDestroyNotify) allocation_meta_free);
1780   g_return_if_fail (index < array->len);
1781
1782   g_array_remove_index (array, index);
1783 }
1784
1785 /**
1786  * gst_query_find_allocation_meta:
1787  * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1788  * @api: the metadata API
1789  * @index: (out) (allow-none): the index
1790  *
1791  * Check if @query has metadata @api set. When this function returns TRUE,
1792  * @index will contain the index where the requested API and the flags can be
1793  * found.
1794  *
1795  * Returns: TRUE when @api is in the list of metadata.
1796  */
1797 gboolean
1798 gst_query_find_allocation_meta (GstQuery * query, GType api, guint * index)
1799 {
1800   GArray *array;
1801   GstStructure *structure;
1802   guint i, len;
1803
1804   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION, FALSE);
1805   g_return_val_if_fail (api != 0, FALSE);
1806
1807   structure = GST_QUERY_STRUCTURE (query);
1808   array =
1809       ensure_array (structure, GST_QUARK (META), sizeof (AllocationMeta),
1810       (GDestroyNotify) allocation_meta_free);
1811
1812   len = array->len;
1813   for (i = 0; i < len; i++) {
1814     AllocationMeta *am = &g_array_index (array, AllocationMeta, i);
1815     if (am->api == api) {
1816       if (index)
1817         *index = i;
1818       return TRUE;
1819     }
1820   }
1821   return FALSE;
1822 }
1823
1824 typedef struct
1825 {
1826   GstAllocator *allocator;
1827   GstAllocationParams params;
1828 } AllocationParam;
1829
1830 static void
1831 allocation_param_free (AllocationParam * ap)
1832 {
1833   if (ap->allocator)
1834     gst_object_unref (ap->allocator);
1835 }
1836
1837 /**
1838  * gst_query_add_allocation_param:
1839  * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1840  * @allocator: (transfer none) (allow-none): the memory allocator
1841  * @params: (transfer none) (allow-none): a #GstAllocationParams
1842  *
1843  * Add @allocator and its @params as a supported memory allocator.
1844  */
1845 void
1846 gst_query_add_allocation_param (GstQuery * query, GstAllocator * allocator,
1847     const GstAllocationParams * params)
1848 {
1849   GArray *array;
1850   GstStructure *structure;
1851   AllocationParam ap;
1852
1853   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1854   g_return_if_fail (gst_query_is_writable (query));
1855   g_return_if_fail (allocator != NULL || params != NULL);
1856
1857   structure = GST_QUERY_STRUCTURE (query);
1858   array = ensure_array (structure, GST_QUARK (ALLOCATOR),
1859       sizeof (AllocationParam), (GDestroyNotify) allocation_param_free);
1860
1861   if ((ap.allocator = allocator))
1862     gst_object_ref (allocator);
1863   if (params)
1864     ap.params = *params;
1865   else
1866     gst_allocation_params_init (&ap.params);
1867
1868   g_array_append_val (array, ap);
1869 }
1870
1871 /**
1872  * gst_query_get_n_allocation_params:
1873  * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1874  *
1875  * Retrieve the number of values currently stored in the
1876  * allocator params array of the query's structure.
1877  *
1878  * If no memory allocator is specified, the downstream element can handle
1879  * the default memory allocator. The first memory allocator in the query
1880  * should be generic and allow mapping to system memory, all following
1881  * allocators should be ordered by preference with the preferred one first.
1882  *
1883  * Returns: the allocator array size as a #guint.
1884  */
1885 guint
1886 gst_query_get_n_allocation_params (GstQuery * query)
1887 {
1888   GArray *array;
1889   GstStructure *structure;
1890
1891   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION, 0);
1892
1893   structure = GST_QUERY_STRUCTURE (query);
1894   array = ensure_array (structure, GST_QUARK (ALLOCATOR),
1895       sizeof (AllocationParam), (GDestroyNotify) allocation_param_free);
1896
1897   return array->len;
1898 }
1899
1900 /**
1901  * gst_query_parse_nth_allocation_param:
1902  * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1903  * @index: position in the allocator array to read
1904  * @allocator: (out) (transfer full) (allow-none): variable to hold the result
1905  * @params: (out) (allow-none): parameters for the allocator
1906  *
1907  * Parse an available query and get the alloctor and its params
1908  * at @index of the allocator array.
1909  */
1910 void
1911 gst_query_parse_nth_allocation_param (GstQuery * query, guint index,
1912     GstAllocator ** allocator, GstAllocationParams * params)
1913 {
1914   GArray *array;
1915   GstStructure *structure;
1916   AllocationParam *ap;
1917
1918   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1919
1920   structure = GST_QUERY_STRUCTURE (query);
1921   array = ensure_array (structure, GST_QUARK (ALLOCATOR),
1922       sizeof (AllocationParam), (GDestroyNotify) allocation_param_free);
1923   g_return_if_fail (index < array->len);
1924
1925   ap = &g_array_index (array, AllocationParam, index);
1926
1927   if (allocator)
1928     if ((*allocator = ap->allocator))
1929       gst_object_ref (*allocator);
1930   if (params)
1931     *params = ap->params;
1932 }
1933
1934 /**
1935  * gst_query_set_nth_allocation_param:
1936  * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1937  * @index: position in the allocator array to set
1938  * @allocator: (transfer none) (allow-none): new allocator to set
1939  * @params: (transfer none) (allow-none): parameters for the allocator
1940  *
1941  * Parse an available query and get the alloctor and its params
1942  * at @index of the allocator array.
1943  */
1944 void
1945 gst_query_set_nth_allocation_param (GstQuery * query, guint index,
1946     GstAllocator * allocator, const GstAllocationParams * params)
1947 {
1948   GArray *array;
1949   GstStructure *structure;
1950   AllocationParam *old, ap;
1951
1952   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1953
1954   structure = GST_QUERY_STRUCTURE (query);
1955   array = ensure_array (structure, GST_QUARK (ALLOCATOR),
1956       sizeof (AllocationParam), (GDestroyNotify) allocation_param_free);
1957   g_return_if_fail (index < array->len);
1958
1959   old = &g_array_index (array, AllocationParam, index);
1960   allocation_param_free (old);
1961
1962   if ((ap.allocator = allocator))
1963     gst_object_ref (allocator);
1964   if (params)
1965     ap.params = *params;
1966   else
1967     gst_allocation_params_init (&ap.params);
1968
1969   g_array_index (array, AllocationParam, index) = ap;
1970 }
1971
1972 /**
1973  * gst_query_remove_nth_allocation_param:
1974  * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1975  * @index: position in the allocation param array to remove
1976  *
1977  * Remove the allocation param at @index of the allocation param array.
1978  *
1979  * Since: 1.2
1980  */
1981 void
1982 gst_query_remove_nth_allocation_param (GstQuery * query, guint index)
1983 {
1984   GArray *array;
1985   GstStructure *structure;
1986
1987   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1988   g_return_if_fail (gst_query_is_writable (query));
1989
1990   structure = GST_QUERY_STRUCTURE (query);
1991   array =
1992       ensure_array (structure, GST_QUARK (ALLOCATOR), sizeof (AllocationParam),
1993       (GDestroyNotify) allocation_param_free);
1994   g_return_if_fail (index < array->len);
1995
1996   g_array_remove_index (array, index);
1997 }
1998
1999 /**
2000  * gst_query_new_scheduling:
2001  *
2002  * Constructs a new query object for querying the scheduling properties.
2003  *
2004  * Free-function: gst_query_unref
2005  *
2006  * Returns: (transfer full): a new #GstQuery
2007  */
2008 GstQuery *
2009 gst_query_new_scheduling (void)
2010 {
2011   GstQuery *query;
2012   GstStructure *structure;
2013
2014   structure = gst_structure_new_id (GST_QUARK (QUERY_SCHEDULING),
2015       GST_QUARK (FLAGS), GST_TYPE_SCHEDULING_FLAGS, 0,
2016       GST_QUARK (MINSIZE), G_TYPE_INT, 1,
2017       GST_QUARK (MAXSIZE), G_TYPE_INT, -1,
2018       GST_QUARK (ALIGN), G_TYPE_INT, 0, NULL);
2019   query = gst_query_new_custom (GST_QUERY_SCHEDULING, structure);
2020
2021   return query;
2022 }
2023
2024 /**
2025  * gst_query_set_scheduling:
2026  * @query: A valid #GstQuery of type GST_QUERY_SCHEDULING.
2027  * @flags: #GstSchedulingFlags
2028  * @minsize: the suggested minimum size of pull requests
2029  * @maxsize: the suggested maximum size of pull requests
2030  * @align: the suggested alignment of pull requests
2031  *
2032  * Set the scheduling properties.
2033  */
2034 void
2035 gst_query_set_scheduling (GstQuery * query, GstSchedulingFlags flags,
2036     gint minsize, gint maxsize, gint align)
2037 {
2038   GstStructure *structure;
2039
2040   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SCHEDULING);
2041   g_return_if_fail (gst_query_is_writable (query));
2042
2043   structure = GST_QUERY_STRUCTURE (query);
2044   gst_structure_id_set (structure,
2045       GST_QUARK (FLAGS), GST_TYPE_SCHEDULING_FLAGS, flags,
2046       GST_QUARK (MINSIZE), G_TYPE_INT, minsize,
2047       GST_QUARK (MAXSIZE), G_TYPE_INT, maxsize,
2048       GST_QUARK (ALIGN), G_TYPE_INT, align, NULL);
2049 }
2050
2051 /**
2052  * gst_query_parse_scheduling:
2053  * @query: A valid #GstQuery of type GST_QUERY_SCHEDULING.
2054  * @flags: (out) (allow-none): #GstSchedulingFlags
2055  * @minsize: (out) (allow-none): the suggested minimum size of pull requests
2056  * @maxsize: (out) (allow-none): the suggested maximum size of pull requests:
2057  * @align: (out) (allow-none): the suggested alignment of pull requests
2058  *
2059  * Set the scheduling properties.
2060  */
2061 void
2062 gst_query_parse_scheduling (GstQuery * query, GstSchedulingFlags * flags,
2063     gint * minsize, gint * maxsize, gint * align)
2064 {
2065   GstStructure *structure;
2066
2067   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SCHEDULING);
2068
2069   structure = GST_QUERY_STRUCTURE (query);
2070   gst_structure_id_get (structure,
2071       GST_QUARK (FLAGS), GST_TYPE_SCHEDULING_FLAGS, flags,
2072       GST_QUARK (MINSIZE), G_TYPE_INT, minsize,
2073       GST_QUARK (MAXSIZE), G_TYPE_INT, maxsize,
2074       GST_QUARK (ALIGN), G_TYPE_INT, align, NULL);
2075 }
2076
2077 /**
2078  * gst_query_add_scheduling_mode:
2079  * @query: a GST_QUERY_SCHEDULING type query #GstQuery
2080  * @mode: a #GstPadMode
2081  *
2082  * Add @mode as aone of the supported scheduling modes to @query.
2083  */
2084 void
2085 gst_query_add_scheduling_mode (GstQuery * query, GstPadMode mode)
2086 {
2087   GstStructure *structure;
2088   GArray *array;
2089
2090   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SCHEDULING);
2091   g_return_if_fail (gst_query_is_writable (query));
2092
2093   structure = GST_QUERY_STRUCTURE (query);
2094   array =
2095       ensure_array (structure, GST_QUARK (MODES), sizeof (GstPadMode), NULL);
2096
2097   g_array_append_val (array, mode);
2098 }
2099
2100 /**
2101  * gst_query_get_n_scheduling_modes:
2102  * @query: a GST_QUERY_SCHEDULING type query #GstQuery
2103  *
2104  * Retrieve the number of values currently stored in the
2105  * scheduling mode array of the query's structure.
2106  *
2107  * Returns: the scheduling mode array size as a #guint.
2108  */
2109 guint
2110 gst_query_get_n_scheduling_modes (GstQuery * query)
2111 {
2112   GArray *array;
2113   GstStructure *structure;
2114
2115   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SCHEDULING, 0);
2116
2117   structure = GST_QUERY_STRUCTURE (query);
2118   array =
2119       ensure_array (structure, GST_QUARK (MODES), sizeof (GstPadMode), NULL);
2120
2121   return array->len;
2122 }
2123
2124 /**
2125  * gst_query_parse_nth_scheduling_mode:
2126  * @query: a GST_QUERY_SCHEDULING type query #GstQuery
2127  * @index: position in the scheduling modes array to read
2128  *
2129  * Parse an available query and get the scheduling mode
2130  * at @index of the scheduling modes array.
2131  *
2132  * Returns: a #GstPadMode of the scheduling mode at @index.
2133  */
2134 GstPadMode
2135 gst_query_parse_nth_scheduling_mode (GstQuery * query, guint index)
2136 {
2137   GstStructure *structure;
2138   GArray *array;
2139
2140   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SCHEDULING,
2141       GST_PAD_MODE_NONE);
2142
2143   structure = GST_QUERY_STRUCTURE (query);
2144   array =
2145       ensure_array (structure, GST_QUARK (MODES), sizeof (GstPadMode), NULL);
2146   g_return_val_if_fail (index < array->len, GST_PAD_MODE_NONE);
2147
2148   return g_array_index (array, GstPadMode, index);
2149 }
2150
2151 /**
2152  * gst_query_has_scheduling_mode:
2153  * @query: a GST_QUERY_SCHEDULING type query #GstQuery
2154  * @mode: the scheduling mode
2155  *
2156  * Check if @query has scheduling mode set.
2157  *
2158  * <note>
2159  *   <para>
2160  *     When checking if upstream supports pull mode, it is usually not
2161  *     enough to just check for GST_PAD_MODE_PULL with this function, you
2162  *     also want to check whether the scheduling flags returned by
2163  *     gst_query_parse_scheduling() have the seeking flag set (meaning
2164  *     random access is supported, not only sequential pulls).
2165  *   </para>
2166  * </note>
2167  *
2168  * Returns: TRUE when @mode is in the list of scheduling modes.
2169  */
2170 gboolean
2171 gst_query_has_scheduling_mode (GstQuery * query, GstPadMode mode)
2172 {
2173   GstStructure *structure;
2174   GArray *array;
2175   guint i, len;
2176
2177   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SCHEDULING, FALSE);
2178
2179   structure = GST_QUERY_STRUCTURE (query);
2180   array =
2181       ensure_array (structure, GST_QUARK (MODES), sizeof (GstPadMode), NULL);
2182
2183   len = array->len;
2184   for (i = 0; i < len; i++) {
2185     if (mode == g_array_index (array, GstPadMode, i))
2186       return TRUE;
2187   }
2188   return FALSE;
2189 }
2190
2191 /**
2192  * gst_query_has_scheduling_mode_with_flags:
2193  * @query: a GST_QUERY_SCHEDULING type query #GstQuery
2194  * @mode: the scheduling mode
2195  * @flags: #GstSchedulingFlags
2196  *
2197  * Check if @query has scheduling mode set and @flags is set in
2198  * query scheduling flags.
2199  *
2200  * Returns: TRUE when @mode is in the list of scheduling modes
2201  *    and @flags are compatible with query flags.
2202  */
2203 gboolean
2204 gst_query_has_scheduling_mode_with_flags (GstQuery * query, GstPadMode mode,
2205     GstSchedulingFlags flags)
2206 {
2207   GstSchedulingFlags sched_flags;
2208
2209   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SCHEDULING, FALSE);
2210
2211   gst_query_parse_scheduling (query, &sched_flags, NULL, NULL, NULL);
2212
2213   return ((flags & sched_flags) == flags) &&
2214       gst_query_has_scheduling_mode (query, mode);
2215 }
2216
2217 /**
2218  * gst_query_new_accept_caps:
2219  * @caps: a fixed #GstCaps
2220  *
2221  * Constructs a new query object for querying if @caps are accepted.
2222  *
2223  * Free-function: gst_query_unref
2224  *
2225  * Returns: (transfer full): a new #GstQuery
2226  */
2227 GstQuery *
2228 gst_query_new_accept_caps (GstCaps * caps)
2229 {
2230   GstQuery *query;
2231   GstStructure *structure;
2232
2233   g_return_val_if_fail (gst_caps_is_fixed (caps), NULL);
2234
2235   structure = gst_structure_new_id (GST_QUARK (QUERY_ACCEPT_CAPS),
2236       GST_QUARK (CAPS), GST_TYPE_CAPS, caps,
2237       GST_QUARK (RESULT), G_TYPE_BOOLEAN, FALSE, NULL);
2238   query = gst_query_new_custom (GST_QUERY_ACCEPT_CAPS, structure);
2239
2240   return query;
2241 }
2242
2243 /**
2244  * gst_query_parse_accept_caps:
2245  * @query: The query to parse
2246  * @caps: (out): A pointer to the caps
2247  *
2248  * Get the caps from @query. The caps remains valid as long as @query remains
2249  * valid.
2250  */
2251 void
2252 gst_query_parse_accept_caps (GstQuery * query, GstCaps ** caps)
2253 {
2254   GstStructure *structure;
2255
2256   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ACCEPT_CAPS);
2257   g_return_if_fail (caps != NULL);
2258
2259   structure = GST_QUERY_STRUCTURE (query);
2260   *caps = g_value_get_boxed (gst_structure_id_get_value (structure,
2261           GST_QUARK (CAPS)));
2262 }
2263
2264 /**
2265  * gst_query_set_accept_caps_result:
2266  * @query: a GST_QUERY_ACCEPT_CAPS type query #GstQuery
2267  * @result: the result to set
2268  *
2269  * Set @result as the result for the @query.
2270  */
2271 void
2272 gst_query_set_accept_caps_result (GstQuery * query, gboolean result)
2273 {
2274   GstStructure *structure;
2275
2276   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ACCEPT_CAPS);
2277   g_return_if_fail (gst_query_is_writable (query));
2278
2279   structure = GST_QUERY_STRUCTURE (query);
2280   gst_structure_id_set (structure,
2281       GST_QUARK (RESULT), G_TYPE_BOOLEAN, result, NULL);
2282 }
2283
2284 /**
2285  * gst_query_parse_accept_caps_result:
2286  * @query: a GST_QUERY_ACCEPT_CAPS type query #GstQuery
2287  * @result: location for the result
2288  *
2289  * Parse the result from @query and store in @result.
2290  */
2291 void
2292 gst_query_parse_accept_caps_result (GstQuery * query, gboolean * result)
2293 {
2294   GstStructure *structure;
2295
2296   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ACCEPT_CAPS);
2297
2298   structure = GST_QUERY_STRUCTURE (query);
2299   gst_structure_id_get (structure,
2300       GST_QUARK (RESULT), G_TYPE_BOOLEAN, result, NULL);
2301 }
2302
2303 /**
2304  * gst_query_new_caps:
2305  * @filter: a filter
2306  *
2307  * Constructs a new query object for querying the caps.
2308  *
2309  * The CAPS query should return the allowable caps for a pad in the context
2310  * of the element's state, its link to other elements, and the devices or files
2311  * it has opened. These caps must be a subset of the pad template caps. In the
2312  * NULL state with no links, the CAPS query should ideally return the same caps
2313  * as the pad template. In rare circumstances, an object property can affect
2314  * the caps returned by the CAPS query, but this is discouraged.
2315  *
2316  * For most filters, the caps returned by CAPS query is directly affected by the
2317  * allowed caps on other pads. For demuxers and decoders, the caps returned by
2318  * the srcpad's getcaps function is directly related to the stream data. Again,
2319  * the CAPS query should return the most specific caps it reasonably can, since this
2320  * helps with autoplugging.
2321  *
2322  * The @filter is used to restrict the result caps, only the caps matching
2323  * @filter should be returned from the CAPS query. Specifying a filter might
2324  * greatly reduce the amount of processing an element needs to do.
2325  *
2326  * Free-function: gst_query_unref
2327  *
2328  * Returns: (transfer full): a new #GstQuery
2329  */
2330 GstQuery *
2331 gst_query_new_caps (GstCaps * filter)
2332 {
2333   GstQuery *query;
2334   GstStructure *structure;
2335
2336   structure = gst_structure_new_id (GST_QUARK (QUERY_CAPS),
2337       GST_QUARK (FILTER), GST_TYPE_CAPS, filter,
2338       GST_QUARK (CAPS), GST_TYPE_CAPS, NULL, NULL);
2339   query = gst_query_new_custom (GST_QUERY_CAPS, structure);
2340
2341   return query;
2342 }
2343
2344 /**
2345  * gst_query_parse_caps:
2346  * @query: The query to parse
2347  * @filter: (out): A pointer to the caps filter
2348  *
2349  * Get the filter from the caps @query. The caps remains valid as long as
2350  * @query remains valid.
2351  */
2352 void
2353 gst_query_parse_caps (GstQuery * query, GstCaps ** filter)
2354 {
2355   GstStructure *structure;
2356
2357   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CAPS);
2358   g_return_if_fail (filter != NULL);
2359
2360   structure = GST_QUERY_STRUCTURE (query);
2361   *filter = g_value_get_boxed (gst_structure_id_get_value (structure,
2362           GST_QUARK (FILTER)));
2363 }
2364
2365 /**
2366  * gst_query_set_caps_result:
2367  * @query: The query to use
2368  * @caps: (in): A pointer to the caps
2369  *
2370  * Set the @caps result in @query.
2371  */
2372 void
2373 gst_query_set_caps_result (GstQuery * query, GstCaps * caps)
2374 {
2375   GstStructure *structure;
2376
2377   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CAPS);
2378   g_return_if_fail (gst_query_is_writable (query));
2379
2380   structure = GST_QUERY_STRUCTURE (query);
2381   gst_structure_id_set (structure, GST_QUARK (CAPS), GST_TYPE_CAPS, caps, NULL);
2382 }
2383
2384 /**
2385  * gst_query_parse_caps_result:
2386  * @query: The query to parse
2387  * @caps: (out): A pointer to the caps
2388  *
2389  * Get the caps result from @query. The caps remains valid as long as
2390  * @query remains valid.
2391  */
2392 void
2393 gst_query_parse_caps_result (GstQuery * query, GstCaps ** caps)
2394 {
2395   GstStructure *structure;
2396
2397   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CAPS);
2398   g_return_if_fail (caps != NULL);
2399
2400   structure = GST_QUERY_STRUCTURE (query);
2401   *caps = g_value_get_boxed (gst_structure_id_get_value (structure,
2402           GST_QUARK (CAPS)));
2403 }
2404
2405 #if 0
2406 void
2407 gst_query_intersect_caps_result (GstQuery * query, GstCaps * filter,
2408     GstCapsIntersectMode mode)
2409 {
2410   GstCaps *res, *caps = NULL;
2411
2412   gst_query_parse_caps_result (query, &caps);
2413   res = gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
2414   gst_query_set_caps_result (query, res);
2415   gst_caps_unref (res);
2416 }
2417 #endif
2418
2419 /**
2420  * gst_query_new_drain:
2421  *
2422  * Constructs a new query object for querying the drain state.
2423  *
2424  * Free-function: gst_query_unref
2425  *
2426  * Returns: (transfer full): a new #GstQuery
2427  */
2428 GstQuery *
2429 gst_query_new_drain (void)
2430 {
2431   GstQuery *query;
2432   GstStructure *structure;
2433
2434   structure = gst_structure_new_id_empty (GST_QUARK (QUERY_DRAIN));
2435   query = gst_query_new_custom (GST_QUERY_DRAIN, structure);
2436
2437   return query;
2438 }
2439
2440 /**
2441  * gst_query_new_context:
2442  *
2443  * Constructs a new query object for querying the pipeline-local context.
2444  *
2445  * Free-function: gst_query_unref
2446  *
2447  * Returns: (transfer full): a new #GstQuery
2448  *
2449  * Since: 1.2
2450  */
2451 GstQuery *
2452 gst_query_new_context (void)
2453 {
2454   GstQuery *query;
2455   GstStructure *structure;
2456
2457   structure = gst_structure_new_id_empty (GST_QUARK (QUERY_CONTEXT));
2458   query = gst_query_new_custom (GST_QUERY_CONTEXT, structure);
2459
2460   return query;
2461 }
2462
2463 /**
2464  * gst_query_set_context:
2465  * @query: a #GstQuery with query type GST_QUERY_CONTEXT
2466  * @context: the requested #GstContext
2467  *
2468  * Answer a context query by setting the requested context.
2469  *
2470  * Since: 1.2
2471  */
2472 void
2473 gst_query_set_context (GstQuery * query, GstContext * context)
2474 {
2475   GstStructure *s;
2476
2477   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CONTEXT);
2478
2479   s = GST_QUERY_STRUCTURE (query);
2480
2481   gst_structure_id_set (s,
2482       GST_QUARK (CONTEXT), GST_TYPE_CONTEXT, context, NULL);
2483 }
2484
2485 /**
2486  * gst_query_parse_context:
2487  * @query: The query to parse
2488  * @context: (out): A pointer to store the #GstContext
2489  *
2490  * Get the context from the context @query. The context remains valid as long as
2491  * @query remains valid.
2492  *
2493  * Since: 1.2
2494  */
2495 void
2496 gst_query_parse_context (GstQuery * query, GstContext ** context)
2497 {
2498   GstStructure *structure;
2499   const GValue *v;
2500
2501   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CONTEXT);
2502   g_return_if_fail (context != NULL);
2503
2504   structure = GST_QUERY_STRUCTURE (query);
2505   v = gst_structure_id_get_value (structure, GST_QUARK (CONTEXT));
2506   if (v)
2507     *context = g_value_get_boxed (v);
2508   else
2509     *context = NULL;
2510 }
2511
2512 static void
2513 free_array_string (gpointer ptr)
2514 {
2515   gchar *str = *(gchar **) ptr;
2516   g_free (str);
2517 }
2518
2519 /**
2520  * gst_query_add_context_type:
2521  * @query: a GST_QUERY_CONTEXT type query
2522  * @context_type: a context type
2523  *
2524  * Add a new context type to @query.
2525  *
2526  * Since: 1.2
2527  */
2528 void
2529 gst_query_add_context_type (GstQuery * query, const gchar * context_type)
2530 {
2531   GstStructure *structure;
2532   GArray *array;
2533   gchar *copy;
2534
2535   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CONTEXT);
2536   g_return_if_fail (gst_query_is_writable (query));
2537
2538   structure = GST_QUERY_STRUCTURE (query);
2539   array = ensure_array (structure, GST_QUARK (CONTEXT_TYPES),
2540       sizeof (gchar *), free_array_string);
2541
2542   copy = g_strdup (context_type);
2543   g_array_append_val (array, copy);
2544 }
2545
2546 /**
2547  * gst_query_get_n_context_types:
2548  * @query: a GST_QUERY_CONTEXT type query
2549  *
2550  * Retrieve the number of values currently stored in the
2551  * context-types array of the query's structure.
2552  *
2553  * Returns: the context-types array size as a #guint.
2554  *
2555  * Since: 1.2
2556  */
2557 guint
2558 gst_query_get_n_context_types (GstQuery * query)
2559 {
2560   GstStructure *structure;
2561   GArray *array;
2562
2563   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CONTEXT, 0);
2564
2565   structure = GST_QUERY_STRUCTURE (query);
2566   array = ensure_array (structure, GST_QUARK (CONTEXT_TYPES),
2567       sizeof (gchar *), free_array_string);
2568
2569   return array->len;
2570 }
2571
2572 /**
2573  * gst_query_parse_nth_context_type:
2574  * @query: a GST_QUERY_CONTEXT type query
2575  * @context_type: (out) (allow-none): the context type, or NULL
2576  *
2577  * Parse a context type from an existing GST_QUERY_CONTEXT query
2578  * from @index.
2579  *
2580  * Returns: a #gboolean indicating if the parsing succeeded.
2581  *
2582  * Since: 1.2
2583  */
2584 gboolean
2585 gst_query_parse_nth_context_type (GstQuery * query, guint index,
2586     const gchar ** context_type)
2587 {
2588   GstStructure *structure;
2589   GArray *array;
2590
2591   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CONTEXT, FALSE);
2592
2593   structure = GST_QUERY_STRUCTURE (query);
2594
2595   array = ensure_array (structure, GST_QUARK (CONTEXT_TYPES),
2596       sizeof (gchar *), free_array_string);
2597   g_return_val_if_fail (index < array->len, FALSE);
2598
2599   if (context_type)
2600     *context_type = g_array_index (array, gchar *, index);
2601
2602   return TRUE;
2603 }
2604
2605 /**
2606  * gst_query_has_context_type:
2607  * @query: a GST_QUERY_CONTEXT type query
2608  * @context_type: the context type
2609  *
2610  * Check if @query is asking for @context_type.
2611  *
2612  * Returns: %TRUE if @context_type is requested.
2613  *
2614  * Since: 1.2
2615  */
2616 gboolean
2617 gst_query_has_context_type (GstQuery * query, const gchar * context_type)
2618 {
2619   guint i, n;
2620
2621   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CONTEXT, FALSE);
2622   g_return_val_if_fail (context_type != NULL, FALSE);
2623
2624   n = gst_query_get_n_context_types (query);
2625   for (i = 0; i < n; i++) {
2626     const gchar *tmp;
2627
2628     if (gst_query_parse_nth_context_type (query, i, &tmp) &&
2629         strcmp (tmp, context_type) == 0)
2630       return TRUE;
2631   }
2632
2633
2634   return FALSE;
2635 }