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
1178  *
1179  * Set the available query result fields in @query.
1180  */
1181 void
1182 gst_query_set_buffering_range (GstQuery * query, GstFormat format,
1183     gint64 start, gint64 stop, gint64 estimated_total)
1184 {
1185   GstStructure *structure;
1186
1187   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING);
1188   g_return_if_fail (gst_query_is_writable (query));
1189
1190   structure = GST_QUERY_STRUCTURE (query);
1191   gst_structure_id_set (structure,
1192       GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
1193       GST_QUARK (START_VALUE), G_TYPE_INT64, start,
1194       GST_QUARK (STOP_VALUE), G_TYPE_INT64, stop,
1195       GST_QUARK (ESTIMATED_TOTAL), G_TYPE_INT64, estimated_total, NULL);
1196 }
1197
1198 /**
1199  * gst_query_parse_buffering_range:
1200  * @query: a GST_QUERY_BUFFERING type query #GstQuery
1201  * @format: (out) (allow-none): the format to set for the @segment_start
1202  *     and @segment_end values, or NULL
1203  * @start: (out) (allow-none): the start to set, or NULL
1204  * @stop: (out) (allow-none): the stop to set, or NULL
1205  * @estimated_total: (out) (allow-none): estimated total amount of download
1206  *     time, or NULL
1207  *
1208  * Parse an available query, writing the format into @format, and
1209  * other results into the passed parameters, if the respective parameters
1210  * are non-NULL
1211  */
1212 void
1213 gst_query_parse_buffering_range (GstQuery * query, GstFormat * format,
1214     gint64 * start, gint64 * stop, gint64 * estimated_total)
1215 {
1216   GstStructure *structure;
1217
1218   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING);
1219
1220   structure = GST_QUERY_STRUCTURE (query);
1221   if (format)
1222     *format =
1223         (GstFormat) g_value_get_enum (gst_structure_id_get_value (structure,
1224             GST_QUARK (FORMAT)));
1225   if (start)
1226     *start = g_value_get_int64 (gst_structure_id_get_value (structure,
1227             GST_QUARK (START_VALUE)));
1228   if (stop)
1229     *stop = g_value_get_int64 (gst_structure_id_get_value (structure,
1230             GST_QUARK (STOP_VALUE)));
1231   if (estimated_total)
1232     *estimated_total =
1233         g_value_get_int64 (gst_structure_id_get_value (structure,
1234             GST_QUARK (ESTIMATED_TOTAL)));
1235 }
1236
1237 /* GstQueryBufferingRange: internal struct for GArray */
1238 typedef struct
1239 {
1240   gint64 start;
1241   gint64 stop;
1242 } GstQueryBufferingRange;
1243
1244 /**
1245  * gst_query_add_buffering_range:
1246  * @query: a GST_QUERY_BUFFERING type query #GstQuery
1247  * @start: start position of the range
1248  * @stop: stop position of the range
1249  *
1250  * Set the buffering-ranges array field in @query. The current last
1251  * start position of the array should be inferior to @start.
1252  *
1253  * Returns: a #gboolean indicating if the range was added or not.
1254  */
1255 gboolean
1256 gst_query_add_buffering_range (GstQuery * query, gint64 start, gint64 stop)
1257 {
1258   GstQueryBufferingRange range;
1259   GstStructure *structure;
1260   GArray *array;
1261
1262   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING, FALSE);
1263   g_return_val_if_fail (gst_query_is_writable (query), FALSE);
1264
1265   if (G_UNLIKELY (start >= stop))
1266     return FALSE;
1267
1268   structure = GST_QUERY_STRUCTURE (query);
1269   array = ensure_array (structure, GST_QUARK (BUFFERING_RANGES),
1270       sizeof (GstQueryBufferingRange), NULL);
1271
1272   if (array->len > 1) {
1273     GstQueryBufferingRange *last;
1274
1275     last = &g_array_index (array, GstQueryBufferingRange, array->len - 1);
1276
1277     if (G_UNLIKELY (start <= last->start))
1278       return FALSE;
1279   }
1280
1281   range.start = start;
1282   range.stop = stop;
1283   g_array_append_val (array, range);
1284
1285   return TRUE;
1286 }
1287
1288 /**
1289  * gst_query_get_n_buffering_ranges:
1290  * @query: a GST_QUERY_BUFFERING type query #GstQuery
1291  *
1292  * Retrieve the number of values currently stored in the
1293  * buffered-ranges array of the query's structure.
1294  *
1295  * Returns: the range array size as a #guint.
1296  */
1297 guint
1298 gst_query_get_n_buffering_ranges (GstQuery * query)
1299 {
1300   GstStructure *structure;
1301   GArray *array;
1302
1303   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING, 0);
1304
1305   structure = GST_QUERY_STRUCTURE (query);
1306   array = ensure_array (structure, GST_QUARK (BUFFERING_RANGES),
1307       sizeof (GstQueryBufferingRange), NULL);
1308
1309   return array->len;
1310 }
1311
1312
1313 /**
1314  * gst_query_parse_nth_buffering_range:
1315  * @query: a GST_QUERY_BUFFERING type query #GstQuery
1316  * @index: position in the buffered-ranges array to read
1317  * @start: (out) (allow-none): the start position to set, or NULL
1318  * @stop: (out) (allow-none): the stop position to set, or NULL
1319  *
1320  * Parse an available query and get the start and stop values stored
1321  * at the @index of the buffered ranges array.
1322  *
1323  * Returns: a #gboolean indicating if the parsing succeeded.
1324  */
1325 gboolean
1326 gst_query_parse_nth_buffering_range (GstQuery * query, guint index,
1327     gint64 * start, gint64 * stop)
1328 {
1329   GstQueryBufferingRange *range;
1330   GstStructure *structure;
1331   GArray *array;
1332
1333   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_BUFFERING, FALSE);
1334
1335   structure = GST_QUERY_STRUCTURE (query);
1336
1337   array = ensure_array (structure, GST_QUARK (BUFFERING_RANGES),
1338       sizeof (GstQueryBufferingRange), NULL);
1339   g_return_val_if_fail (index < array->len, FALSE);
1340
1341   range = &g_array_index (array, GstQueryBufferingRange, index);
1342
1343   if (start)
1344     *start = range->start;
1345   if (stop)
1346     *stop = range->stop;
1347
1348   return TRUE;
1349 }
1350
1351
1352 /**
1353  * gst_query_new_uri:
1354  *
1355  * Constructs a new query URI query object. Use gst_query_unref()
1356  * when done with it. An URI query is used to query the current URI
1357  * that is used by the source or sink.
1358  *
1359  * Free-function: gst_query_unref
1360  *
1361  * Returns: (transfer full): a new #GstQuery
1362  */
1363 GstQuery *
1364 gst_query_new_uri (void)
1365 {
1366   GstQuery *query;
1367   GstStructure *structure;
1368
1369   structure = gst_structure_new_id (GST_QUARK (QUERY_URI),
1370       GST_QUARK (URI), G_TYPE_STRING, NULL, NULL);
1371
1372   query = gst_query_new_custom (GST_QUERY_URI, structure);
1373
1374   return query;
1375 }
1376
1377 /**
1378  * gst_query_set_uri:
1379  * @query: a #GstQuery with query type GST_QUERY_URI
1380  * @uri: the URI to set
1381  *
1382  * Answer a URI query by setting the requested URI.
1383  */
1384 void
1385 gst_query_set_uri (GstQuery * query, const gchar * uri)
1386 {
1387   GstStructure *structure;
1388
1389   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_URI);
1390   g_return_if_fail (gst_query_is_writable (query));
1391   g_return_if_fail (gst_uri_is_valid (uri));
1392
1393   structure = GST_QUERY_STRUCTURE (query);
1394   gst_structure_id_set (structure, GST_QUARK (URI), G_TYPE_STRING, uri, NULL);
1395 }
1396
1397 /**
1398  * gst_query_parse_uri:
1399  * @query: a #GstQuery
1400  * @uri: (out callee-allocates) (allow-none): the storage for the current URI
1401  *     (may be NULL)
1402  *
1403  * Parse an URI query, writing the URI into @uri as a newly
1404  * allocated string, if the respective parameters are non-NULL.
1405  * Free the string with g_free() after usage.
1406  */
1407 void
1408 gst_query_parse_uri (GstQuery * query, gchar ** uri)
1409 {
1410   GstStructure *structure;
1411
1412   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_URI);
1413
1414   structure = GST_QUERY_STRUCTURE (query);
1415   if (uri)
1416     *uri = g_value_dup_string (gst_structure_id_get_value (structure,
1417             GST_QUARK (URI)));
1418 }
1419
1420 /**
1421  * gst_query_new_allocation:
1422  * @caps: the negotiated caps
1423  * @need_pool: return a pool
1424  *
1425  * Constructs a new query object for querying the allocation properties.
1426  *
1427  * Free-function: gst_query_unref
1428  *
1429  * Returns: (transfer full): a new #GstQuery
1430  */
1431 GstQuery *
1432 gst_query_new_allocation (GstCaps * caps, gboolean need_pool)
1433 {
1434   GstQuery *query;
1435   GstStructure *structure;
1436
1437   structure = gst_structure_new_id (GST_QUARK (QUERY_ALLOCATION),
1438       GST_QUARK (CAPS), GST_TYPE_CAPS, caps,
1439       GST_QUARK (NEED_POOL), G_TYPE_BOOLEAN, need_pool, NULL);
1440
1441   query = gst_query_new_custom (GST_QUERY_ALLOCATION, structure);
1442
1443   return query;
1444 }
1445
1446 /**
1447  * gst_query_parse_allocation:
1448  * @query: a #GstQuery
1449  * @caps: (out) (transfer none) (allow-none): The #GstCaps
1450  * @need_pool: (out) (allow-none): Whether a #GstBufferPool is needed
1451  *
1452  * Parse an allocation query, writing the requested caps in @caps and
1453  * whether a pool is needed in @need_pool, if the respective parameters
1454  * are non-NULL.
1455  */
1456 void
1457 gst_query_parse_allocation (GstQuery * query, GstCaps ** caps,
1458     gboolean * need_pool)
1459 {
1460   GstStructure *structure;
1461
1462   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1463
1464   structure = GST_QUERY_STRUCTURE (query);
1465   if (caps) {
1466     *caps = g_value_get_boxed (gst_structure_id_get_value (structure,
1467             GST_QUARK (CAPS)));
1468   }
1469   gst_structure_id_get (structure,
1470       GST_QUARK (NEED_POOL), G_TYPE_BOOLEAN, need_pool, NULL);
1471 }
1472
1473 typedef struct
1474 {
1475   GstBufferPool *pool;
1476   guint size;
1477   guint min_buffers;
1478   guint max_buffers;
1479 } AllocationPool;
1480
1481 static void
1482 allocation_pool_free (AllocationPool * ap)
1483 {
1484   if (ap->pool)
1485     gst_object_unref (ap->pool);
1486 }
1487
1488 /**
1489  * gst_query_add_allocation_pool:
1490  * @query: A valid #GstQuery of type GST_QUERY_ALLOCATION.
1491  * @pool: the #GstBufferPool
1492  * @size: the size
1493  * @min_buffers: the min buffers
1494  * @max_buffers: the max buffers
1495  *
1496  * Set the pool parameters in @query.
1497  */
1498 void
1499 gst_query_add_allocation_pool (GstQuery * query, GstBufferPool * pool,
1500     guint size, guint min_buffers, guint max_buffers)
1501 {
1502   GArray *array;
1503   GstStructure *structure;
1504   AllocationPool ap;
1505
1506   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1507   g_return_if_fail (gst_query_is_writable (query));
1508   g_return_if_fail (size != 0);
1509
1510   structure = GST_QUERY_STRUCTURE (query);
1511   array = ensure_array (structure, GST_QUARK (POOL),
1512       sizeof (AllocationPool), (GDestroyNotify) allocation_pool_free);
1513
1514   if ((ap.pool = pool))
1515     gst_object_ref (pool);
1516   ap.size = size;
1517   ap.min_buffers = min_buffers;
1518   ap.max_buffers = max_buffers;
1519
1520   g_array_append_val (array, ap);
1521 }
1522
1523
1524 /**
1525  * gst_query_get_n_allocation_pools:
1526  * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1527  *
1528  * Retrieve the number of values currently stored in the
1529  * pool array of the query's structure.
1530  *
1531  * Returns: the pool array size as a #guint.
1532  */
1533 guint
1534 gst_query_get_n_allocation_pools (GstQuery * query)
1535 {
1536   GArray *array;
1537   GstStructure *structure;
1538
1539   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION, 0);
1540
1541   structure = GST_QUERY_STRUCTURE (query);
1542   array = ensure_array (structure, GST_QUARK (POOL),
1543       sizeof (AllocationPool), (GDestroyNotify) allocation_pool_free);
1544
1545   return array->len;
1546 }
1547
1548 /**
1549  * gst_query_parse_nth_allocation_pool:
1550  * @query: A valid #GstQuery of type GST_QUERY_ALLOCATION.
1551  * @index: index to parse
1552  * @pool: (out) (allow-none) (transfer full): the #GstBufferPool
1553  * @size: (out) (allow-none): the size
1554  * @min_buffers: (out) (allow-none): the min buffers
1555  * @max_buffers: (out) (allow-none): the max buffers
1556  *
1557  * Get the pool parameters in @query.
1558  *
1559  * Unref @pool with gst_object_unref() when it's not needed any more.
1560  */
1561 void
1562 gst_query_parse_nth_allocation_pool (GstQuery * query, guint index,
1563     GstBufferPool ** pool, guint * size, guint * min_buffers,
1564     guint * max_buffers)
1565 {
1566   GArray *array;
1567   GstStructure *structure;
1568   AllocationPool *ap;
1569
1570   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1571
1572   structure = GST_QUERY_STRUCTURE (query);
1573   array = ensure_array (structure, GST_QUARK (POOL),
1574       sizeof (AllocationPool), (GDestroyNotify) allocation_pool_free);
1575   g_return_if_fail (index < array->len);
1576
1577   ap = &g_array_index (array, AllocationPool, index);
1578
1579   if (pool)
1580     if ((*pool = ap->pool))
1581       gst_object_ref (*pool);
1582   if (size)
1583     *size = ap->size;
1584   if (min_buffers)
1585     *min_buffers = ap->min_buffers;
1586   if (max_buffers)
1587     *max_buffers = ap->max_buffers;
1588 }
1589
1590 /**
1591  * gst_query_set_nth_allocation_pool:
1592  * @index: index to modify
1593  * @query: A valid #GstQuery of type GST_QUERY_ALLOCATION.
1594  * @pool: the #GstBufferPool
1595  * @size: the size
1596  * @min_buffers: the min buffers
1597  * @max_buffers: the max buffers
1598  *
1599  * Set the pool parameters in @query.
1600  */
1601 void
1602 gst_query_set_nth_allocation_pool (GstQuery * query, guint index,
1603     GstBufferPool * pool, guint size, guint min_buffers, guint max_buffers)
1604 {
1605   GArray *array;
1606   GstStructure *structure;
1607   AllocationPool *oldap, ap;
1608
1609   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1610
1611   structure = GST_QUERY_STRUCTURE (query);
1612   array = ensure_array (structure, GST_QUARK (POOL),
1613       sizeof (AllocationPool), (GDestroyNotify) allocation_pool_free);
1614   g_return_if_fail (index < array->len);
1615
1616   oldap = &g_array_index (array, AllocationPool, index);
1617   allocation_pool_free (oldap);
1618
1619   if ((ap.pool = pool))
1620     gst_object_ref (pool);
1621   ap.size = size;
1622   ap.min_buffers = min_buffers;
1623   ap.max_buffers = max_buffers;
1624   g_array_index (array, AllocationPool, index) = ap;
1625 }
1626
1627 /**
1628  * gst_query_remove_nth_allocation_pool:
1629  * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1630  * @index: position in the allocation pool array to remove
1631  *
1632  * Remove the allocation pool at @index of the allocation pool array.
1633  */
1634 void
1635 gst_query_remove_nth_allocation_pool (GstQuery * query, guint index)
1636 {
1637   GArray *array;
1638   GstStructure *structure;
1639
1640   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1641   g_return_if_fail (gst_query_is_writable (query));
1642
1643   structure = GST_QUERY_STRUCTURE (query);
1644   array =
1645       ensure_array (structure, GST_QUARK (POOL), sizeof (AllocationPool),
1646       (GDestroyNotify) allocation_pool_free);
1647   g_return_if_fail (index < array->len);
1648
1649   g_array_remove_index (array, index);
1650 }
1651
1652 typedef struct
1653 {
1654   GType api;
1655   GstStructure *params;
1656 } AllocationMeta;
1657
1658 static void
1659 allocation_meta_free (AllocationMeta * am)
1660 {
1661   if (am->params)
1662     gst_structure_free (am->params);
1663 }
1664
1665 /**
1666  * gst_query_add_allocation_meta:
1667  * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1668  * @api: the metadata API
1669  * @params: (transfer none) (allow-none): API specific parameters
1670  *
1671  * Add @api with @params as one of the supported metadata API to @query.
1672  */
1673 void
1674 gst_query_add_allocation_meta (GstQuery * query, GType api,
1675     const GstStructure * params)
1676 {
1677   GArray *array;
1678   GstStructure *structure;
1679   AllocationMeta am;
1680
1681   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1682   g_return_if_fail (api != 0);
1683   g_return_if_fail (gst_query_is_writable (query));
1684
1685   structure = GST_QUERY_STRUCTURE (query);
1686   array =
1687       ensure_array (structure, GST_QUARK (META), sizeof (AllocationMeta),
1688       (GDestroyNotify) allocation_meta_free);
1689
1690   am.api = api;
1691   am.params = (params ? gst_structure_copy (params) : NULL);
1692
1693   g_array_append_val (array, am);
1694 }
1695
1696 /**
1697  * gst_query_get_n_allocation_metas:
1698  * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1699  *
1700  * Retrieve the number of values currently stored in the
1701  * meta API array of the query's structure.
1702  *
1703  * Returns: the metadata API array size as a #guint.
1704  */
1705 guint
1706 gst_query_get_n_allocation_metas (GstQuery * query)
1707 {
1708   GArray *array;
1709   GstStructure *structure;
1710
1711   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION, 0);
1712
1713   structure = GST_QUERY_STRUCTURE (query);
1714   array =
1715       ensure_array (structure, GST_QUARK (META), sizeof (AllocationMeta),
1716       (GDestroyNotify) allocation_meta_free);
1717
1718   return array->len;
1719 }
1720
1721 /**
1722  * gst_query_parse_nth_allocation_meta:
1723  * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1724  * @index: position in the metadata API array to read
1725  * @params: (out) (allow-none): API specific flags
1726  *
1727  * Parse an available query and get the metadata API
1728  * at @index of the metadata API array.
1729  *
1730  * Returns: a #GType of the metadata API at @index.
1731  */
1732 GType
1733 gst_query_parse_nth_allocation_meta (GstQuery * query, guint index,
1734     const GstStructure ** params)
1735 {
1736   GArray *array;
1737   GstStructure *structure;
1738   AllocationMeta *am;
1739
1740   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION, 0);
1741
1742   structure = GST_QUERY_STRUCTURE (query);
1743   array =
1744       ensure_array (structure, GST_QUARK (META), sizeof (AllocationMeta),
1745       (GDestroyNotify) allocation_meta_free);
1746
1747   g_return_val_if_fail (index < array->len, 0);
1748
1749   am = &g_array_index (array, AllocationMeta, index);
1750
1751   if (params)
1752     *params = am->params;
1753
1754   return am->api;
1755 }
1756
1757 /**
1758  * gst_query_remove_nth_allocation_meta:
1759  * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1760  * @index: position in the metadata API array to remove
1761  *
1762  * Remove the metadata API at @index of the metadata API array.
1763  */
1764 void
1765 gst_query_remove_nth_allocation_meta (GstQuery * query, guint index)
1766 {
1767   GArray *array;
1768   GstStructure *structure;
1769
1770   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1771   g_return_if_fail (gst_query_is_writable (query));
1772
1773   structure = GST_QUERY_STRUCTURE (query);
1774   array =
1775       ensure_array (structure, GST_QUARK (META), sizeof (AllocationMeta),
1776       (GDestroyNotify) allocation_meta_free);
1777   g_return_if_fail (index < array->len);
1778
1779   g_array_remove_index (array, index);
1780 }
1781
1782 /**
1783  * gst_query_find_allocation_meta:
1784  * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1785  * @api: the metadata API
1786  * @index: (out) (allow-none): the index
1787  *
1788  * Check if @query has metadata @api set. When this function returns TRUE,
1789  * @index will contain the index where the requested API and the flags can be
1790  * found.
1791  *
1792  * Returns: TRUE when @api is in the list of metadata.
1793  */
1794 gboolean
1795 gst_query_find_allocation_meta (GstQuery * query, GType api, guint * index)
1796 {
1797   GArray *array;
1798   GstStructure *structure;
1799   guint i, len;
1800
1801   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION, FALSE);
1802   g_return_val_if_fail (api != 0, FALSE);
1803
1804   structure = GST_QUERY_STRUCTURE (query);
1805   array =
1806       ensure_array (structure, GST_QUARK (META), sizeof (AllocationMeta),
1807       (GDestroyNotify) allocation_meta_free);
1808
1809   len = array->len;
1810   for (i = 0; i < len; i++) {
1811     AllocationMeta *am = &g_array_index (array, AllocationMeta, i);
1812     if (am->api == api) {
1813       if (index)
1814         *index = i;
1815       return TRUE;
1816     }
1817   }
1818   return FALSE;
1819 }
1820
1821 typedef struct
1822 {
1823   GstAllocator *allocator;
1824   GstAllocationParams params;
1825 } AllocationParam;
1826
1827 static void
1828 allocation_param_free (AllocationParam * ap)
1829 {
1830   if (ap->allocator)
1831     gst_object_unref (ap->allocator);
1832 }
1833
1834 /**
1835  * gst_query_add_allocation_param:
1836  * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1837  * @allocator: (transfer none) (allow-none): the memory allocator
1838  * @params: (transfer none) (allow-none): a #GstAllocationParams
1839  *
1840  * Add @allocator and its @params as a supported memory allocator.
1841  */
1842 void
1843 gst_query_add_allocation_param (GstQuery * query, GstAllocator * allocator,
1844     const GstAllocationParams * params)
1845 {
1846   GArray *array;
1847   GstStructure *structure;
1848   AllocationParam ap;
1849
1850   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1851   g_return_if_fail (gst_query_is_writable (query));
1852   g_return_if_fail (allocator != NULL || params != NULL);
1853
1854   structure = GST_QUERY_STRUCTURE (query);
1855   array = ensure_array (structure, GST_QUARK (ALLOCATOR),
1856       sizeof (AllocationParam), (GDestroyNotify) allocation_param_free);
1857
1858   if ((ap.allocator = allocator))
1859     gst_object_ref (allocator);
1860   if (params)
1861     ap.params = *params;
1862   else
1863     gst_allocation_params_init (&ap.params);
1864
1865   g_array_append_val (array, ap);
1866 }
1867
1868 /**
1869  * gst_query_get_n_allocation_params:
1870  * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1871  *
1872  * Retrieve the number of values currently stored in the
1873  * allocator params array of the query's structure.
1874  *
1875  * If no memory allocator is specified, the downstream element can handle
1876  * the default memory allocator. The first memory allocator in the query
1877  * should be generic and allow mapping to system memory, all following
1878  * allocators should be ordered by preference with the preferred one first.
1879  *
1880  * Returns: the allocator array size as a #guint.
1881  */
1882 guint
1883 gst_query_get_n_allocation_params (GstQuery * query)
1884 {
1885   GArray *array;
1886   GstStructure *structure;
1887
1888   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION, 0);
1889
1890   structure = GST_QUERY_STRUCTURE (query);
1891   array = ensure_array (structure, GST_QUARK (ALLOCATOR),
1892       sizeof (AllocationParam), (GDestroyNotify) allocation_param_free);
1893
1894   return array->len;
1895 }
1896
1897 /**
1898  * gst_query_parse_nth_allocation_param:
1899  * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1900  * @index: position in the allocator array to read
1901  * @allocator: (out) (transfer full) (allow-none): variable to hold the result
1902  * @params: (out) (allow-none): parameters for the allocator
1903  *
1904  * Parse an available query and get the alloctor and its params
1905  * at @index of the allocator array.
1906  */
1907 void
1908 gst_query_parse_nth_allocation_param (GstQuery * query, guint index,
1909     GstAllocator ** allocator, GstAllocationParams * params)
1910 {
1911   GArray *array;
1912   GstStructure *structure;
1913   AllocationParam *ap;
1914
1915   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1916
1917   structure = GST_QUERY_STRUCTURE (query);
1918   array = ensure_array (structure, GST_QUARK (ALLOCATOR),
1919       sizeof (AllocationParam), (GDestroyNotify) allocation_param_free);
1920   g_return_if_fail (index < array->len);
1921
1922   ap = &g_array_index (array, AllocationParam, index);
1923
1924   if (allocator)
1925     if ((*allocator = ap->allocator))
1926       gst_object_ref (*allocator);
1927   if (params)
1928     *params = ap->params;
1929 }
1930
1931 /**
1932  * gst_query_set_nth_allocation_param:
1933  * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1934  * @index: position in the allocator array to set
1935  * @allocator: (transfer none) (allow-none): new allocator to set
1936  * @params: (transfer none) (allow-none): parameters for the allocator
1937  *
1938  * Parse an available query and get the alloctor and its params
1939  * at @index of the allocator array.
1940  */
1941 void
1942 gst_query_set_nth_allocation_param (GstQuery * query, guint index,
1943     GstAllocator * allocator, const GstAllocationParams * params)
1944 {
1945   GArray *array;
1946   GstStructure *structure;
1947   AllocationParam *old, ap;
1948
1949   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1950
1951   structure = GST_QUERY_STRUCTURE (query);
1952   array = ensure_array (structure, GST_QUARK (ALLOCATOR),
1953       sizeof (AllocationParam), (GDestroyNotify) allocation_param_free);
1954   g_return_if_fail (index < array->len);
1955
1956   old = &g_array_index (array, AllocationParam, index);
1957   allocation_param_free (old);
1958
1959   if ((ap.allocator = allocator))
1960     gst_object_ref (allocator);
1961   if (params)
1962     ap.params = *params;
1963   else
1964     gst_allocation_params_init (&ap.params);
1965
1966   g_array_index (array, AllocationParam, index) = ap;
1967 }
1968
1969 /**
1970  * gst_query_remove_nth_allocation_param:
1971  * @query: a GST_QUERY_ALLOCATION type query #GstQuery
1972  * @index: position in the allocation param array to remove
1973  *
1974  * Remove the allocation param at @index of the allocation param array.
1975  */
1976 void
1977 gst_query_remove_nth_allocation_param (GstQuery * query, guint index)
1978 {
1979   GArray *array;
1980   GstStructure *structure;
1981
1982   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION);
1983   g_return_if_fail (gst_query_is_writable (query));
1984
1985   structure = GST_QUERY_STRUCTURE (query);
1986   array =
1987       ensure_array (structure, GST_QUARK (ALLOCATOR), sizeof (AllocationParam),
1988       (GDestroyNotify) allocation_param_free);
1989   g_return_if_fail (index < array->len);
1990
1991   g_array_remove_index (array, index);
1992 }
1993
1994 /**
1995  * gst_query_new_scheduling:
1996  *
1997  * Constructs a new query object for querying the scheduling properties.
1998  *
1999  * Free-function: gst_query_unref
2000  *
2001  * Returns: (transfer full): a new #GstQuery
2002  */
2003 GstQuery *
2004 gst_query_new_scheduling (void)
2005 {
2006   GstQuery *query;
2007   GstStructure *structure;
2008
2009   structure = gst_structure_new_id (GST_QUARK (QUERY_SCHEDULING),
2010       GST_QUARK (FLAGS), GST_TYPE_SCHEDULING_FLAGS, 0,
2011       GST_QUARK (MINSIZE), G_TYPE_INT, 1,
2012       GST_QUARK (MAXSIZE), G_TYPE_INT, -1,
2013       GST_QUARK (ALIGN), G_TYPE_INT, 0, NULL);
2014   query = gst_query_new_custom (GST_QUERY_SCHEDULING, structure);
2015
2016   return query;
2017 }
2018
2019 /**
2020  * gst_query_set_scheduling:
2021  * @query: A valid #GstQuery of type GST_QUERY_SCHEDULING.
2022  * @flags: #GstSchedulingFlags
2023  * @minsize: the suggested minimum size of pull requests
2024  * @maxsize: the suggested maximum size of pull requests
2025  * @align: the suggested alignment of pull requests
2026  *
2027  * Set the scheduling properties.
2028  */
2029 void
2030 gst_query_set_scheduling (GstQuery * query, GstSchedulingFlags flags,
2031     gint minsize, gint maxsize, gint align)
2032 {
2033   GstStructure *structure;
2034
2035   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SCHEDULING);
2036   g_return_if_fail (gst_query_is_writable (query));
2037
2038   structure = GST_QUERY_STRUCTURE (query);
2039   gst_structure_id_set (structure,
2040       GST_QUARK (FLAGS), GST_TYPE_SCHEDULING_FLAGS, flags,
2041       GST_QUARK (MINSIZE), G_TYPE_INT, minsize,
2042       GST_QUARK (MAXSIZE), G_TYPE_INT, maxsize,
2043       GST_QUARK (ALIGN), G_TYPE_INT, align, NULL);
2044 }
2045
2046 /**
2047  * gst_query_parse_scheduling:
2048  * @query: A valid #GstQuery of type GST_QUERY_SCHEDULING.
2049  * @flags: (out) (allow-none): #GstSchedulingFlags
2050  * @minsize: (out) (allow-none): the suggested minimum size of pull requests
2051  * @maxsize: (out) (allow-none): the suggested maximum size of pull requests:
2052  * @align: (out) (allow-none): the suggested alignment of pull requests
2053  *
2054  * Set the scheduling properties.
2055  */
2056 void
2057 gst_query_parse_scheduling (GstQuery * query, GstSchedulingFlags * flags,
2058     gint * minsize, gint * maxsize, gint * align)
2059 {
2060   GstStructure *structure;
2061
2062   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SCHEDULING);
2063
2064   structure = GST_QUERY_STRUCTURE (query);
2065   gst_structure_id_get (structure,
2066       GST_QUARK (FLAGS), GST_TYPE_SCHEDULING_FLAGS, flags,
2067       GST_QUARK (MINSIZE), G_TYPE_INT, minsize,
2068       GST_QUARK (MAXSIZE), G_TYPE_INT, maxsize,
2069       GST_QUARK (ALIGN), G_TYPE_INT, align, NULL);
2070 }
2071
2072 /**
2073  * gst_query_add_scheduling_mode:
2074  * @query: a GST_QUERY_SCHEDULING type query #GstQuery
2075  * @mode: a #GstPadMode
2076  *
2077  * Add @mode as aone of the supported scheduling modes to @query.
2078  */
2079 void
2080 gst_query_add_scheduling_mode (GstQuery * query, GstPadMode mode)
2081 {
2082   GstStructure *structure;
2083   GArray *array;
2084
2085   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SCHEDULING);
2086   g_return_if_fail (gst_query_is_writable (query));
2087
2088   structure = GST_QUERY_STRUCTURE (query);
2089   array =
2090       ensure_array (structure, GST_QUARK (MODES), sizeof (GstPadMode), NULL);
2091
2092   g_array_append_val (array, mode);
2093 }
2094
2095 /**
2096  * gst_query_get_n_scheduling_modes:
2097  * @query: a GST_QUERY_SCHEDULING type query #GstQuery
2098  *
2099  * Retrieve the number of values currently stored in the
2100  * scheduling mode array of the query's structure.
2101  *
2102  * Returns: the scheduling mode array size as a #guint.
2103  */
2104 guint
2105 gst_query_get_n_scheduling_modes (GstQuery * query)
2106 {
2107   GArray *array;
2108   GstStructure *structure;
2109
2110   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SCHEDULING, 0);
2111
2112   structure = GST_QUERY_STRUCTURE (query);
2113   array =
2114       ensure_array (structure, GST_QUARK (MODES), sizeof (GstPadMode), NULL);
2115
2116   return array->len;
2117 }
2118
2119 /**
2120  * gst_query_parse_nth_scheduling_mode:
2121  * @query: a GST_QUERY_SCHEDULING type query #GstQuery
2122  * @index: position in the scheduling modes array to read
2123  *
2124  * Parse an available query and get the scheduling mode
2125  * at @index of the scheduling modes array.
2126  *
2127  * Returns: a #GstPadMode of the scheduling mode at @index.
2128  */
2129 GstPadMode
2130 gst_query_parse_nth_scheduling_mode (GstQuery * query, guint index)
2131 {
2132   GstStructure *structure;
2133   GArray *array;
2134
2135   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SCHEDULING,
2136       GST_PAD_MODE_NONE);
2137
2138   structure = GST_QUERY_STRUCTURE (query);
2139   array =
2140       ensure_array (structure, GST_QUARK (MODES), sizeof (GstPadMode), NULL);
2141   g_return_val_if_fail (index < array->len, GST_PAD_MODE_NONE);
2142
2143   return g_array_index (array, GstPadMode, index);
2144 }
2145
2146 /**
2147  * gst_query_has_scheduling_mode:
2148  * @query: a GST_QUERY_SCHEDULING type query #GstQuery
2149  * @mode: the scheduling mode
2150  *
2151  * Check if @query has scheduling mode set.
2152  *
2153  * <note>
2154  *   <para>
2155  *     When checking if upstream supports pull mode, it is usually not
2156  *     enough to just check for GST_PAD_MODE_PULL with this function, you
2157  *     also want to check whether the scheduling flags returned by
2158  *     gst_query_parse_scheduling() have the seeking flag set (meaning
2159  *     random access is supported, not only sequential pulls).
2160  *   </para>
2161  * </note>
2162  *
2163  * Returns: TRUE when @mode is in the list of scheduling modes.
2164  */
2165 gboolean
2166 gst_query_has_scheduling_mode (GstQuery * query, GstPadMode mode)
2167 {
2168   GstStructure *structure;
2169   GArray *array;
2170   guint i, len;
2171
2172   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SCHEDULING, FALSE);
2173
2174   structure = GST_QUERY_STRUCTURE (query);
2175   array =
2176       ensure_array (structure, GST_QUARK (MODES), sizeof (GstPadMode), NULL);
2177
2178   len = array->len;
2179   for (i = 0; i < len; i++) {
2180     if (mode == g_array_index (array, GstPadMode, i))
2181       return TRUE;
2182   }
2183   return FALSE;
2184 }
2185
2186 /**
2187  * gst_query_has_scheduling_mode_with_flags:
2188  * @query: a GST_QUERY_SCHEDULING type query #GstQuery
2189  * @mode: the scheduling mode
2190  * @flags: #GstSchedulingFlags
2191  *
2192  * Check if @query has scheduling mode set and @flags is set in
2193  * query scheduling flags.
2194  *
2195  * Returns: TRUE when @mode is in the list of scheduling modes
2196  *    and @flags are compatible with query flags.
2197  */
2198 gboolean
2199 gst_query_has_scheduling_mode_with_flags (GstQuery * query, GstPadMode mode,
2200     GstSchedulingFlags flags)
2201 {
2202   GstSchedulingFlags sched_flags;
2203
2204   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_SCHEDULING, FALSE);
2205
2206   gst_query_parse_scheduling (query, &sched_flags, NULL, NULL, NULL);
2207
2208   return ((flags & sched_flags) == flags) &&
2209       gst_query_has_scheduling_mode (query, mode);
2210 }
2211
2212 /**
2213  * gst_query_new_accept_caps:
2214  * @caps: a fixed #GstCaps
2215  *
2216  * Constructs a new query object for querying if @caps are accepted.
2217  *
2218  * Free-function: gst_query_unref
2219  *
2220  * Returns: (transfer full): a new #GstQuery
2221  */
2222 GstQuery *
2223 gst_query_new_accept_caps (GstCaps * caps)
2224 {
2225   GstQuery *query;
2226   GstStructure *structure;
2227
2228   g_return_val_if_fail (gst_caps_is_fixed (caps), NULL);
2229
2230   structure = gst_structure_new_id (GST_QUARK (QUERY_ACCEPT_CAPS),
2231       GST_QUARK (CAPS), GST_TYPE_CAPS, caps,
2232       GST_QUARK (RESULT), G_TYPE_BOOLEAN, FALSE, NULL);
2233   query = gst_query_new_custom (GST_QUERY_ACCEPT_CAPS, structure);
2234
2235   return query;
2236 }
2237
2238 /**
2239  * gst_query_parse_accept_caps:
2240  * @query: The query to parse
2241  * @caps: (out): A pointer to the caps
2242  *
2243  * Get the caps from @query. The caps remains valid as long as @query remains
2244  * valid.
2245  */
2246 void
2247 gst_query_parse_accept_caps (GstQuery * query, GstCaps ** caps)
2248 {
2249   GstStructure *structure;
2250
2251   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ACCEPT_CAPS);
2252   g_return_if_fail (caps != NULL);
2253
2254   structure = GST_QUERY_STRUCTURE (query);
2255   *caps = g_value_get_boxed (gst_structure_id_get_value (structure,
2256           GST_QUARK (CAPS)));
2257 }
2258
2259 /**
2260  * gst_query_set_accept_caps_result:
2261  * @query: a GST_QUERY_ACCEPT_CAPS type query #GstQuery
2262  * @result: the result to set
2263  *
2264  * Set @result as the result for the @query.
2265  */
2266 void
2267 gst_query_set_accept_caps_result (GstQuery * query, gboolean result)
2268 {
2269   GstStructure *structure;
2270
2271   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ACCEPT_CAPS);
2272   g_return_if_fail (gst_query_is_writable (query));
2273
2274   structure = GST_QUERY_STRUCTURE (query);
2275   gst_structure_id_set (structure,
2276       GST_QUARK (RESULT), G_TYPE_BOOLEAN, result, NULL);
2277 }
2278
2279 /**
2280  * gst_query_parse_accept_caps_result:
2281  * @query: a GST_QUERY_ACCEPT_CAPS type query #GstQuery
2282  * @result: location for the result
2283  *
2284  * Parse the result from @query and store in @result.
2285  */
2286 void
2287 gst_query_parse_accept_caps_result (GstQuery * query, gboolean * result)
2288 {
2289   GstStructure *structure;
2290
2291   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ACCEPT_CAPS);
2292
2293   structure = GST_QUERY_STRUCTURE (query);
2294   gst_structure_id_get (structure,
2295       GST_QUARK (RESULT), G_TYPE_BOOLEAN, result, NULL);
2296 }
2297
2298 /**
2299  * gst_query_new_caps:
2300  * @filter: a filter
2301  *
2302  * Constructs a new query object for querying the caps.
2303  *
2304  * The CAPS query should return the allowable caps for a pad in the context
2305  * of the element's state, its link to other elements, and the devices or files
2306  * it has opened. These caps must be a subset of the pad template caps. In the
2307  * NULL state with no links, the CAPS query should ideally return the same caps
2308  * as the pad template. In rare circumstances, an object property can affect
2309  * the caps returned by the CAPS query, but this is discouraged.
2310  *
2311  * For most filters, the caps returned by CAPS query is directly affected by the
2312  * allowed caps on other pads. For demuxers and decoders, the caps returned by
2313  * the srcpad's getcaps function is directly related to the stream data. Again,
2314  * the CAPS query should return the most specific caps it reasonably can, since this
2315  * helps with autoplugging.
2316  *
2317  * The @filter is used to restrict the result caps, only the caps matching
2318  * @filter should be returned from the CAPS query. Specifying a filter might
2319  * greatly reduce the amount of processing an element needs to do.
2320  *
2321  * Free-function: gst_query_unref
2322  *
2323  * Returns: (transfer full): a new #GstQuery
2324  */
2325 GstQuery *
2326 gst_query_new_caps (GstCaps * filter)
2327 {
2328   GstQuery *query;
2329   GstStructure *structure;
2330
2331   structure = gst_structure_new_id (GST_QUARK (QUERY_CAPS),
2332       GST_QUARK (FILTER), GST_TYPE_CAPS, filter,
2333       GST_QUARK (CAPS), GST_TYPE_CAPS, NULL, NULL);
2334   query = gst_query_new_custom (GST_QUERY_CAPS, structure);
2335
2336   return query;
2337 }
2338
2339 /**
2340  * gst_query_parse_caps:
2341  * @query: The query to parse
2342  * @filter: (out): A pointer to the caps filter
2343  *
2344  * Get the filter from the caps @query. The caps remains valid as long as
2345  * @query remains valid.
2346  */
2347 void
2348 gst_query_parse_caps (GstQuery * query, GstCaps ** filter)
2349 {
2350   GstStructure *structure;
2351
2352   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CAPS);
2353   g_return_if_fail (filter != NULL);
2354
2355   structure = GST_QUERY_STRUCTURE (query);
2356   *filter = g_value_get_boxed (gst_structure_id_get_value (structure,
2357           GST_QUARK (FILTER)));
2358 }
2359
2360 /**
2361  * gst_query_set_caps_result:
2362  * @query: The query to use
2363  * @caps: (in): A pointer to the caps
2364  *
2365  * Set the @caps result in @query.
2366  */
2367 void
2368 gst_query_set_caps_result (GstQuery * query, GstCaps * caps)
2369 {
2370   GstStructure *structure;
2371
2372   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CAPS);
2373   g_return_if_fail (gst_query_is_writable (query));
2374
2375   structure = GST_QUERY_STRUCTURE (query);
2376   gst_structure_id_set (structure, GST_QUARK (CAPS), GST_TYPE_CAPS, caps, NULL);
2377 }
2378
2379 /**
2380  * gst_query_parse_caps_result:
2381  * @query: The query to parse
2382  * @caps: (out): A pointer to the caps
2383  *
2384  * Get the caps result from @query. The caps remains valid as long as
2385  * @query remains valid.
2386  */
2387 void
2388 gst_query_parse_caps_result (GstQuery * query, GstCaps ** caps)
2389 {
2390   GstStructure *structure;
2391
2392   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CAPS);
2393   g_return_if_fail (caps != NULL);
2394
2395   structure = GST_QUERY_STRUCTURE (query);
2396   *caps = g_value_get_boxed (gst_structure_id_get_value (structure,
2397           GST_QUARK (CAPS)));
2398 }
2399
2400 #if 0
2401 void
2402 gst_query_intersect_caps_result (GstQuery * query, GstCaps * filter,
2403     GstCapsIntersectMode mode)
2404 {
2405   GstCaps *res, *caps = NULL;
2406
2407   gst_query_parse_caps_result (query, &caps);
2408   res = gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
2409   gst_query_set_caps_result (query, res);
2410   gst_caps_unref (res);
2411 }
2412 #endif
2413
2414 /**
2415  * gst_query_new_drain:
2416  *
2417  * Constructs a new query object for querying the drain state.
2418  *
2419  * Free-function: gst_query_unref
2420  *
2421  * Returns: (transfer full): a new #GstQuery
2422  */
2423 GstQuery *
2424 gst_query_new_drain (void)
2425 {
2426   GstQuery *query;
2427   GstStructure *structure;
2428
2429   structure = gst_structure_new_id_empty (GST_QUARK (QUERY_DRAIN));
2430   query = gst_query_new_custom (GST_QUERY_DRAIN, structure);
2431
2432   return query;
2433 }
2434
2435 /**
2436  * gst_query_new_context:
2437  *
2438  * Constructs a new query object for querying the pipeline-local context.
2439  *
2440  * Free-function: gst_query_unref
2441  *
2442  * Returns: (transfer full): a new #GstQuery
2443  */
2444 GstQuery *
2445 gst_query_new_context (void)
2446 {
2447   GstQuery *query;
2448   GstStructure *structure;
2449
2450   structure = gst_structure_new_id_empty (GST_QUARK (QUERY_CONTEXT));
2451   query = gst_query_new_custom (GST_QUERY_CONTEXT, structure);
2452
2453   return query;
2454 }
2455
2456 /**
2457  * gst_query_set_context:
2458  * @query: a #GstQuery with query type GST_QUERY_CONTEXT
2459  * @context: the requested #GstContext
2460  *
2461  * Answer a context query by setting the requested context.
2462  */
2463 void
2464 gst_query_set_context (GstQuery * query, GstContext * context)
2465 {
2466   GstStructure *s;
2467
2468   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CONTEXT);
2469
2470   s = GST_QUERY_STRUCTURE (query);
2471
2472   gst_structure_id_set (s,
2473       GST_QUARK (CONTEXT), GST_TYPE_CONTEXT, context, NULL);
2474 }
2475
2476 /**
2477  * gst_query_parse_context:
2478  * @query: The query to parse
2479  * @context: (out): A pointer to store the #GstContext
2480  *
2481  * Get the context from the context @query. The context remains valid as long as
2482  * @query remains valid.
2483  */
2484 void
2485 gst_query_parse_context (GstQuery * query, GstContext ** context)
2486 {
2487   GstStructure *structure;
2488
2489   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CONTEXT);
2490   g_return_if_fail (context != NULL);
2491
2492   structure = GST_QUERY_STRUCTURE (query);
2493   *context = g_value_get_boxed (gst_structure_id_get_value (structure,
2494           GST_QUARK (CONTEXT)));
2495 }
2496
2497 static void
2498 free_array_string (gpointer ptr)
2499 {
2500   gchar *str = *(gchar **) ptr;
2501   g_free (str);
2502 }
2503
2504 /**
2505  * gst_query_add_context_type:
2506  * @query: a GST_QUERY_NEED_CONTEXT type query
2507  * @context_type: a context type
2508  *
2509  * Add a new context type to @query.
2510  */
2511 void
2512 gst_query_add_context_type (GstQuery * query, const gchar * context_type)
2513 {
2514   GstStructure *structure;
2515   GArray *array;
2516   gchar *copy;
2517
2518   g_return_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CONTEXT);
2519   g_return_if_fail (gst_query_is_writable (query));
2520
2521   structure = GST_QUERY_STRUCTURE (query);
2522   array = ensure_array (structure, GST_QUARK (CONTEXT_TYPES),
2523       sizeof (gchar *), free_array_string);
2524
2525   copy = g_strdup (context_type);
2526   g_array_append_val (array, copy);
2527 }
2528
2529 /**
2530  * gst_query_get_n_context_types:
2531  * @query: a GST_QUERY_NEED_CONTEXT type query
2532  *
2533  * Retrieve the number of values currently stored in the
2534  * context-types array of the query's structure.
2535  *
2536  * Returns: the context-types array size as a #guint.
2537  */
2538 guint
2539 gst_query_get_n_context_types (GstQuery * query)
2540 {
2541   GstStructure *structure;
2542   GArray *array;
2543
2544   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CONTEXT, 0);
2545
2546   structure = GST_QUERY_STRUCTURE (query);
2547   array = ensure_array (structure, GST_QUARK (CONTEXT_TYPES),
2548       sizeof (gchar *), free_array_string);
2549
2550   return array->len;
2551 }
2552
2553 /**
2554  * gst_query_parse_nth_context_type:
2555  * @query: a GST_QUERY_NEED_CONTEXT type query
2556  * @context_type: (out) (allow-none): the context type, or NULL
2557  *
2558  * Parse a context type from an existing GST_QUERY_NEED_CONTEXT query
2559  * from @index.
2560  *
2561  * Returns: a #gboolean indicating if the parsing succeeded.
2562  */
2563 gboolean
2564 gst_query_parse_nth_context_type (GstQuery * query, guint index,
2565     const gchar ** context_type)
2566 {
2567   GstStructure *structure;
2568   GArray *array;
2569
2570   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CONTEXT, FALSE);
2571
2572   structure = GST_QUERY_STRUCTURE (query);
2573
2574   array = ensure_array (structure, GST_QUARK (CONTEXT_TYPES),
2575       sizeof (gchar *), free_array_string);
2576   g_return_val_if_fail (index < array->len, FALSE);
2577
2578   if (context_type)
2579     *context_type = g_array_index (array, gchar *, index);
2580
2581   return TRUE;
2582 }