gst/gstquery.c

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