gst/gststructure.c

   1 /* GStreamer
   2  * Copyright (C) 2003 David A. Schleef <ds@schleef.org>
   3  *
   4  * gststructure.c: lists of { GQuark, GValue } tuples
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  19  * Boston, MA 02110-1301, USA.
  20  */
  21
  22 /**
  23  * SECTION:gststructure
  24  * @short_description: Generic structure containing fields of names and values
  25  * @see_also: #GstCaps, #GstMessage, #GstEvent, #GstQuery
  26  *
  27  * A #GstStructure is a collection of key/value pairs. The keys are expressed
  28  * as GQuarks and the values can be of any GType.
  29  *
  30  * In addition to the key/value pairs, a #GstStructure also has a name. The name
  31  * starts with a letter and can be filled by letters, numbers and any of "/-_.:".
  32  *
  33  * #GstStructure is used by various GStreamer subsystems to store information
  34  * in a flexible and extensible way. A #GstStructure does not have a refcount
  35  * because it usually is part of a higher level object such as #GstCaps,
  36  * #GstMessage, #GstEvent, #GstQuery. It provides a means to enforce mutability
  37  * using the refcount of the parent with the gst_structure_set_parent_refcount()
  38  * method.
  39  *
  40  * A #GstStructure can be created with gst_structure_new_empty() or
  41  * gst_structure_new(), which both take a name and an optional set of
  42  * key/value pairs along with the types of the values.
  43  *
  44  * Field values can be changed with gst_structure_set_value() or
  45  * gst_structure_set().
  46  *
  47  * Field values can be retrieved with gst_structure_get_value() or the more
  48  * convenient gst_structure_get_*() functions.
  49  *
  50  * Fields can be removed with gst_structure_remove_field() or
  51  * gst_structure_remove_fields().
  52  *
  53  * Strings in structures must be ASCII or UTF-8 encoded. Other encodings are
  54  * not allowed. Strings may be NULL however.
  55  *
  56  * Be aware that the current #GstCaps / #GstStructure serialization into string
  57  * has limited support for nested #GstCaps / #GstStructure fields. It can only
  58  * support one level of nesting. Using more levels will lead to unexpected
  59  * behavior when using serialization features, such as gst_caps_to_string() or
  60  * gst_value_serialize() and their counterparts.
  61  *
  62  * Last reviewed on 2012-03-29 (0.11.3)
  63  */
  64
  65 #ifdef HAVE_CONFIG_H
  66 #include "config.h"
  67 #endif
  68
  69 #include <string.h>
  70
  71 #include "gst_private.h"
  72 #include "gstquark.h"
  73 #include <gst/gst.h>
  74 #include <gobject/gvaluecollector.h>
  75
  76 GST_DEBUG_CATEGORY_STATIC (gst_structure_debug);
  77 #define GST_CAT_DEFAULT gst_structure_debug
  78
  79 typedef struct _GstStructureField GstStructureField;
  80
  81 struct _GstStructureField
  82 {
  83   GQuark name;
  84   GValue value;
  85 };
  86
  87 typedef struct
  88 {
  89   GstStructure s;
  90
  91   /* owned by parent structure, NULL if no parent */
  92   gint *parent_refcount;
  93
  94   GArray *fields;
  95 } GstStructureImpl;
  96
  97 #define GST_STRUCTURE_REFCOUNT(s) (((GstStructureImpl*)(s))->parent_refcount)
  98 #define GST_STRUCTURE_FIELDS(s) (((GstStructureImpl*)(s))->fields)
  99
 100 #define GST_STRUCTURE_FIELD(structure, index) \
 101     &g_array_index(GST_STRUCTURE_FIELDS(structure), GstStructureField, (index))
 102
 103 #define IS_MUTABLE(structure) \
 104     (!GST_STRUCTURE_REFCOUNT(structure) || \
 105      g_atomic_int_get (GST_STRUCTURE_REFCOUNT(structure)) == 1)
 106
 107 #define IS_TAGLIST(structure) \
 108     (structure->name == GST_QUARK (TAGLIST))
 109
 110 static void gst_structure_set_field (GstStructure * structure,
 111     GstStructureField * field);
 112 static GstStructureField *gst_structure_get_field (const GstStructure *
 113     structure, const gchar * fieldname);
 114 static GstStructureField *gst_structure_id_get_field (const GstStructure *
 115     structure, GQuark field);
 116 static void gst_structure_transform_to_string (const GValue * src_value,
 117     GValue * dest_value);
 118 static GstStructure *gst_structure_copy_conditional (const GstStructure *
 119     structure);
 120 static gboolean gst_structure_parse_value (gchar * str, gchar ** after,
 121     GValue * value, GType default_type);
 122 static gboolean gst_structure_parse_simple_string (gchar * s, gchar ** end);
 123
 124 GType _gst_structure_type = 0;
 125
 126
 127 G_DEFINE_BOXED_TYPE (GstStructure, gst_structure,
 128     gst_structure_copy_conditional, gst_structure_free);
 129
 130 void
 131 _priv_gst_structure_initialize (void)
 132 {
 133   _gst_structure_type = gst_structure_get_type ();
 134
 135   g_value_register_transform_func (_gst_structure_type, G_TYPE_STRING,
 136       gst_structure_transform_to_string);
 137
 138   GST_DEBUG_CATEGORY_INIT (gst_structure_debug, "structure", 0,
 139       "GstStructure debug");
 140 }
 141
 142 static GstStructure *
 143 gst_structure_new_id_empty_with_size (GQuark quark, guint prealloc)
 144 {
 145   GstStructureImpl *structure;
 146
 147   structure = g_slice_new (GstStructureImpl);
 148   ((GstStructure *) structure)->type = _gst_structure_type;
 149   ((GstStructure *) structure)->name = quark;
 150   GST_STRUCTURE_REFCOUNT (structure) = NULL;
 151   GST_STRUCTURE_FIELDS (structure) =
 152       g_array_sized_new (FALSE, FALSE, sizeof (GstStructureField), prealloc);
 153
 154   GST_TRACE ("created structure %p", structure);
 155
 156   return GST_STRUCTURE_CAST (structure);
 157 }
 158
 159 /**
 160  * gst_structure_new_id_empty:
 161  * @quark: name of new structure
 162  *
 163  * Creates a new, empty #GstStructure with the given name as a GQuark.
 164  *
 165  * Free-function: gst_structure_free
 166  *
 167  * Returns: (transfer full): a new, empty #GstStructure
 168  */
 169 GstStructure *
 170 gst_structure_new_id_empty (GQuark quark)
 171 {
 172   g_return_val_if_fail (quark != 0, NULL);
 173
 174   return gst_structure_new_id_empty_with_size (quark, 0);
 175 }
 176
 177 #ifndef G_DISABLE_CHECKS
 178 static gboolean
 179 gst_structure_validate_name (const gchar * name)
 180 {
 181   const gchar *s;
 182
 183   g_return_val_if_fail (name != NULL, FALSE);
 184
 185   if (G_UNLIKELY (!g_ascii_isalpha (*name))) {
 186     GST_WARNING ("Invalid character '%c' at offset 0 in structure name: %s",
 187         *name, name);
 188     return FALSE;
 189   }
 190
 191   /* FIXME: test name string more */
 192   s = &name[1];
 193   while (*s && (g_ascii_isalnum (*s) || strchr ("/-_.:+", *s) != NULL))
 194     s++;
 195   if (G_UNLIKELY (*s != '\0')) {
 196     GST_WARNING ("Invalid character '%c' at offset %" G_GUINTPTR_FORMAT " in"
 197         " structure name: %s", *s, ((guintptr) s - (guintptr) name), name);
 198     return FALSE;
 199   }
 200
 201   if (strncmp (name, "video/x-raw-", 12) == 0) {
 202     g_warning ("0.10-style raw video caps are being created. Should be "
 203         "video/x-raw,format=(string).. now.");
 204   } else if (strncmp (name, "audio/x-raw-", 12) == 0) {
 205     g_warning ("0.10-style raw audio caps are being created. Should be "
 206         "audio/x-raw,format=(string).. now.");
 207   }
 208
 209   return TRUE;
 210 }
 211 #endif
 212
 213 /**
 214  * gst_structure_new_empty:
 215  * @name: name of new structure
 216  *
 217  * Creates a new, empty #GstStructure with the given @name.
 218  *
 219  * See gst_structure_set_name() for constraints on the @name parameter.
 220  *
 221  * Free-function: gst_structure_free
 222  *
 223  * Returns: (transfer full): a new, empty #GstStructure
 224  */
 225 GstStructure *
 226 gst_structure_new_empty (const gchar * name)
 227 {
 228   g_return_val_if_fail (gst_structure_validate_name (name), NULL);
 229
 230   return gst_structure_new_id_empty_with_size (g_quark_from_string (name), 0);
 231 }
 232
 233 /**
 234  * gst_structure_new:
 235  * @name: name of new structure
 236  * @firstfield: name of first field to set
 237  * @...: additional arguments
 238  *
 239  * Creates a new #GstStructure with the given name.  Parses the
 240  * list of variable arguments and sets fields to the values listed.
 241  * Variable arguments should be passed as field name, field type,
 242  * and value.  Last variable argument should be NULL.
 243  *
 244  * Free-function: gst_structure_free
 245  *
 246  * Returns: (transfer full): a new #GstStructure
 247  */
 248 GstStructure *
 249 gst_structure_new (const gchar * name, const gchar * firstfield, ...)
 250 {
 251   GstStructure *structure;
 252   va_list varargs;
 253
 254   va_start (varargs, firstfield);
 255   structure = gst_structure_new_valist (name, firstfield, varargs);
 256   va_end (varargs);
 257
 258   return structure;
 259 }
 260
 261 /**
 262  * gst_structure_new_valist:
 263  * @name: name of new structure
 264  * @firstfield: name of first field to set
 265  * @varargs: variable argument list
 266  *
 267  * Creates a new #GstStructure with the given @name.  Structure fields
 268  * are set according to the varargs in a manner similar to
 269  * gst_structure_new().
 270  *
 271  * See gst_structure_set_name() for constraints on the @name parameter.
 272  *
 273  * Free-function: gst_structure_free
 274  *
 275  * Returns: (transfer full): a new #GstStructure
 276  */
 277 GstStructure *
 278 gst_structure_new_valist (const gchar * name,
 279     const gchar * firstfield, va_list varargs)
 280 {
 281   GstStructure *structure;
 282
 283   structure = gst_structure_new_empty (name);
 284
 285   if (structure)
 286     gst_structure_set_valist (structure, firstfield, varargs);
 287
 288   return structure;
 289 }
 290
 291 /**
 292  * gst_structure_set_parent_refcount:
 293  * @structure: a #GstStructure
 294  * @refcount: (in): a pointer to the parent's refcount
 295  *
 296  * Sets the parent_refcount field of #GstStructure. This field is used to
 297  * determine whether a structure is mutable or not. This function should only be
 298  * called by code implementing parent objects of #GstStructure, as described in
 299  * the MT Refcounting section of the design documents.
 300  *
 301  * Returns: %TRUE if the parent refcount could be set.
 302  */
 303 gboolean
 304 gst_structure_set_parent_refcount (GstStructure * structure, gint * refcount)
 305 {
 306   g_return_val_if_fail (structure != NULL, FALSE);
 307
 308   /* if we have a parent_refcount already, we can only clear
 309    * if with a NULL refcount */
 310   if (GST_STRUCTURE_REFCOUNT (structure)) {
 311     if (refcount != NULL) {
 312       g_return_val_if_fail (refcount == NULL, FALSE);
 313       return FALSE;
 314     }
 315   } else {
 316     if (refcount == NULL) {
 317       g_return_val_if_fail (refcount != NULL, FALSE);
 318       return FALSE;
 319     }
 320   }
 321
 322   GST_STRUCTURE_REFCOUNT (structure) = refcount;
 323
 324   return TRUE;
 325 }
 326
 327 /**
 328  * gst_structure_copy:
 329  * @structure: a #GstStructure to duplicate
 330  *
 331  * Duplicates a #GstStructure and all its fields and values.
 332  *
 333  * Free-function: gst_structure_free
 334  *
 335  * Returns: (transfer full): a new #GstStructure.
 336  */
 337 GstStructure *
 338 gst_structure_copy (const GstStructure * structure)
 339 {
 340   GstStructure *new_structure;
 341   GstStructureField *field;
 342   guint i, len;
 343
 344   g_return_val_if_fail (structure != NULL, NULL);
 345
 346   len = GST_STRUCTURE_FIELDS (structure)->len;
 347   new_structure = gst_structure_new_id_empty_with_size (structure->name, len);
 348
 349   for (i = 0; i < len; i++) {
 350     GstStructureField new_field = { 0 };
 351
 352     field = GST_STRUCTURE_FIELD (structure, i);
 353
 354     new_field.name = field->name;
 355     gst_value_init_and_copy (&new_field.value, &field->value);
 356     g_array_append_val (GST_STRUCTURE_FIELDS (new_structure), new_field);
 357   }
 358   GST_CAT_TRACE (GST_CAT_PERFORMANCE, "doing copy %p -> %p",
 359       structure, new_structure);
 360
 361   return new_structure;
 362 }
 363
 364 /**
 365  * gst_structure_free:
 366  * @structure: (in) (transfer full): the #GstStructure to free
 367  *
 368  * Frees a #GstStructure and all its fields and values. The structure must not
 369  * have a parent when this function is called.
 370  */
 371 void
 372 gst_structure_free (GstStructure * structure)
 373 {
 374   GstStructureField *field;
 375   guint i, len;
 376
 377   g_return_if_fail (structure != NULL);
 378   g_return_if_fail (GST_STRUCTURE_REFCOUNT (structure) == NULL);
 379
 380   len = GST_STRUCTURE_FIELDS (structure)->len;
 381   for (i = 0; i < len; i++) {
 382     field = GST_STRUCTURE_FIELD (structure, i);
 383
 384     if (G_IS_VALUE (&field->value)) {
 385       g_value_unset (&field->value);
 386     }
 387   }
 388   g_array_free (GST_STRUCTURE_FIELDS (structure), TRUE);
 389 #ifdef USE_POISONING
 390   memset (structure, 0xff, sizeof (GstStructure));
 391 #endif
 392   GST_TRACE ("free structure %p", structure);
 393
 394   g_slice_free1 (sizeof (GstStructureImpl), structure);
 395 }
 396
 397 /**
 398  * gst_structure_get_name:
 399  * @structure: a #GstStructure
 400  *
 401  * Get the name of @structure as a string.
 402  *
 403  * Returns: the name of the structure.
 404  */
 405 const gchar *
 406 gst_structure_get_name (const GstStructure * structure)
 407 {
 408   g_return_val_if_fail (structure != NULL, NULL);
 409
 410   return g_quark_to_string (structure->name);
 411 }
 412
 413 /**
 414  * gst_structure_has_name:
 415  * @structure: a #GstStructure
 416  * @name: structure name to check for
 417  *
 418  * Checks if the structure has the given name
 419  *
 420  * Returns: TRUE if @name matches the name of the structure.
 421  */
 422 gboolean
 423 gst_structure_has_name (const GstStructure * structure, const gchar * name)
 424 {
 425   const gchar *structure_name;
 426
 427   g_return_val_if_fail (structure != NULL, FALSE);
 428   g_return_val_if_fail (name != NULL, FALSE);
 429
 430   /* getting the string is cheap and comparing short strings is too
 431    * should be faster than getting the quark for name and comparing the quarks
 432    */
 433   structure_name = g_quark_to_string (structure->name);
 434
 435   return (structure_name && strcmp (structure_name, name) == 0);
 436 }
 437
 438 /**
 439  * gst_structure_get_name_id:
 440  * @structure: a #GstStructure
 441  *
 442  * Get the name of @structure as a GQuark.
 443  *
 444  * Returns: the quark representing the name of the structure.
 445  */
 446 GQuark
 447 gst_structure_get_name_id (const GstStructure * structure)
 448 {
 449   g_return_val_if_fail (structure != NULL, 0);
 450
 451   return structure->name;
 452 }
 453
 454 /**
 455  * gst_structure_set_name:
 456  * @structure: a #GstStructure
 457  * @name: the new name of the structure
 458  *
 459  * Sets the name of the structure to the given @name.  The string
 460  * provided is copied before being used. It must not be empty, start with a
 461  * letter and can be followed by letters, numbers and any of "/-_.:".
 462  */
 463 void
 464 gst_structure_set_name (GstStructure * structure, const gchar * name)
 465 {
 466   g_return_if_fail (structure != NULL);
 467   g_return_if_fail (IS_MUTABLE (structure));
 468   g_return_if_fail (gst_structure_validate_name (name));
 469
 470   structure->name = g_quark_from_string (name);
 471 }
 472
 473 static inline void
 474 gst_structure_id_set_value_internal (GstStructure * structure, GQuark field,
 475     const GValue * value)
 476 {
 477   GstStructureField gsfield = { 0, {0,} };
 478
 479   gsfield.name = field;
 480   gst_value_init_and_copy (&gsfield.value, value);
 481
 482   gst_structure_set_field (structure, &gsfield);
 483 }
 484
 485 /**
 486  * gst_structure_id_set_value:
 487  * @structure: a #GstStructure
 488  * @field: a #GQuark representing a field
 489  * @value: the new value of the field
 490  *
 491  * Sets the field with the given GQuark @field to @value.  If the field
 492  * does not exist, it is created.  If the field exists, the previous
 493  * value is replaced and freed.
 494  */
 495 void
 496 gst_structure_id_set_value (GstStructure * structure,
 497     GQuark field, const GValue * value)
 498 {
 499
 500   g_return_if_fail (structure != NULL);
 501   g_return_if_fail (G_IS_VALUE (value));
 502   g_return_if_fail (IS_MUTABLE (structure));
 503
 504   gst_structure_id_set_value_internal (structure, field, value);
 505 }
 506
 507 /**
 508  * gst_structure_set_value:
 509  * @structure: a #GstStructure
 510  * @fieldname: the name of the field to set
 511  * @value: the new value of the field
 512  *
 513  * Sets the field with the given name @field to @value.  If the field
 514  * does not exist, it is created.  If the field exists, the previous
 515  * value is replaced and freed.
 516  */
 517 void
 518 gst_structure_set_value (GstStructure * structure,
 519     const gchar * fieldname, const GValue * value)
 520 {
 521   g_return_if_fail (structure != NULL);
 522   g_return_if_fail (fieldname != NULL);
 523   g_return_if_fail (G_IS_VALUE (value));
 524   g_return_if_fail (IS_MUTABLE (structure));
 525
 526   gst_structure_id_set_value_internal (structure,
 527       g_quark_from_string (fieldname), value);
 528 }
 529
 530 static inline void
 531 gst_structure_id_take_value_internal (GstStructure * structure, GQuark field,
 532     GValue * value)
 533 {
 534   GstStructureField gsfield = { 0, {0,} };
 535
 536   gsfield.name = field;
 537   gsfield.value = *value;
 538
 539   gst_structure_set_field (structure, &gsfield);
 540
 541   /* we took ownership */
 542 #ifdef USE_POISONING
 543   memset (value, 0, sizeof (GValue));
 544 #else
 545   value->g_type = G_TYPE_INVALID;
 546 #endif
 547 }
 548
 549 /**
 550  * gst_structure_id_take_value:
 551  * @structure: a #GstStructure
 552  * @field: a #GQuark representing a field
 553  * @value: (transfer full): the new value of the field
 554  *
 555  * Sets the field with the given GQuark @field to @value.  If the field
 556  * does not exist, it is created.  If the field exists, the previous
 557  * value is replaced and freed.
 558  */
 559 void
 560 gst_structure_id_take_value (GstStructure * structure, GQuark field,
 561     GValue * value)
 562 {
 563   g_return_if_fail (structure != NULL);
 564   g_return_if_fail (G_IS_VALUE (value));
 565   g_return_if_fail (IS_MUTABLE (structure));
 566
 567   gst_structure_id_take_value_internal (structure, field, value);
 568 }
 569
 570 /**
 571  * gst_structure_take_value:
 572  * @structure: a #GstStructure
 573  * @fieldname: the name of the field to set
 574  * @value: (transfer full): the new value of the field
 575  *
 576  * Sets the field with the given name @field to @value.  If the field
 577  * does not exist, it is created.  If the field exists, the previous
 578  * value is replaced and freed. The function will take ownership of @value.
 579  */
 580 void
 581 gst_structure_take_value (GstStructure * structure, const gchar * fieldname,
 582     GValue * value)
 583 {
 584   g_return_if_fail (structure != NULL);
 585   g_return_if_fail (fieldname != NULL);
 586   g_return_if_fail (G_IS_VALUE (value));
 587   g_return_if_fail (IS_MUTABLE (structure));
 588
 589   gst_structure_id_take_value_internal (structure,
 590       g_quark_from_string (fieldname), value);
 591 }
 592
 593 static void
 594 gst_structure_set_valist_internal (GstStructure * structure,
 595     const gchar * fieldname, va_list varargs)
 596 {
 597   gchar *err = NULL;
 598   GType type;
 599
 600   while (fieldname) {
 601     GstStructureField field = { 0 };
 602
 603     field.name = g_quark_from_string (fieldname);
 604
 605     type = va_arg (varargs, GType);
 606
 607     G_VALUE_COLLECT_INIT (&field.value, type, varargs, 0, &err);
 608     if (G_UNLIKELY (err)) {
 609       g_critical ("%s", err);
 610       return;
 611     }
 612     gst_structure_set_field (structure, &field);
 613
 614     fieldname = va_arg (varargs, gchar *);
 615   }
 616 }
 617
 618 /**
 619  * gst_structure_set:
 620  * @structure: a #GstStructure
 621  * @fieldname: the name of the field to set
 622  * @...: variable arguments
 623  *
 624  * Parses the variable arguments and sets fields accordingly.
 625  * Variable arguments should be in the form field name, field type
 626  * (as a GType), value(s).  The last variable argument should be NULL.
 627  */
 628 void
 629 gst_structure_set (GstStructure * structure, const gchar * field, ...)
 630 {
 631   va_list varargs;
 632
 633   g_return_if_fail (structure != NULL);
 634   g_return_if_fail (IS_MUTABLE (structure) || field == NULL);
 635
 636   va_start (varargs, field);
 637   gst_structure_set_valist_internal (structure, field, varargs);
 638   va_end (varargs);
 639 }
 640
 641 /**
 642  * gst_structure_set_valist:
 643  * @structure: a #GstStructure
 644  * @fieldname: the name of the field to set
 645  * @varargs: variable arguments
 646  *
 647  * va_list form of gst_structure_set().
 648  */
 649 void
 650 gst_structure_set_valist (GstStructure * structure,
 651     const gchar * fieldname, va_list varargs)
 652 {
 653   g_return_if_fail (structure != NULL);
 654   g_return_if_fail (IS_MUTABLE (structure));
 655
 656   gst_structure_set_valist_internal (structure, fieldname, varargs);
 657 }
 658
 659 static void
 660 gst_structure_id_set_valist_internal (GstStructure * structure,
 661     GQuark fieldname, va_list varargs)
 662 {
 663   gchar *err = NULL;
 664   GType type;
 665
 666   while (fieldname) {
 667     GstStructureField field = { 0 };
 668
 669     field.name = fieldname;
 670
 671     type = va_arg (varargs, GType);
 672
 673 #ifndef G_VALUE_COLLECT_INIT
 674     g_value_init (&field.value, type);
 675     G_VALUE_COLLECT (&field.value, varargs, 0, &err);
 676 #else
 677     G_VALUE_COLLECT_INIT (&field.value, type, varargs, 0, &err);
 678 #endif
 679     if (G_UNLIKELY (err)) {
 680       g_critical ("%s", err);
 681       return;
 682     }
 683     gst_structure_set_field (structure, &field);
 684
 685     fieldname = va_arg (varargs, GQuark);
 686   }
 687 }
 688
 689 /**
 690  * gst_structure_id_set:
 691  * @structure: a #GstStructure
 692  * @fieldname: the GQuark for the name of the field to set
 693  * @...: variable arguments
 694  *
 695  * Identical to gst_structure_set, except that field names are
 696  * passed using the GQuark for the field name. This allows more efficient
 697  * setting of the structure if the caller already knows the associated
 698  * quark values.
 699  * The last variable argument must be NULL.
 700  */
 701 void
 702 gst_structure_id_set (GstStructure * structure, GQuark field, ...)
 703 {
 704   va_list varargs;
 705
 706   g_return_if_fail (structure != NULL);
 707
 708   va_start (varargs, field);
 709   gst_structure_id_set_valist_internal (structure, field, varargs);
 710   va_end (varargs);
 711 }
 712
 713 /**
 714  * gst_structure_id_set_valist:
 715  * @structure: a #GstStructure
 716  * @fieldname: the name of the field to set
 717  * @varargs: variable arguments
 718  *
 719  * va_list form of gst_structure_id_set().
 720  */
 721 void
 722 gst_structure_id_set_valist (GstStructure * structure,
 723     GQuark fieldname, va_list varargs)
 724 {
 725   g_return_if_fail (structure != NULL);
 726   g_return_if_fail (IS_MUTABLE (structure));
 727
 728   gst_structure_id_set_valist_internal (structure, fieldname, varargs);
 729 }
 730
 731 /**
 732  * gst_structure_new_id:
 733  * @name_quark: name of new structure
 734  * @field_quark: the GQuark for the name of the field to set
 735  * @...: variable arguments
 736  *
 737  * Creates a new #GstStructure with the given name as a GQuark, followed by
 738  * fieldname quark, GType, argument(s) "triplets" in the same format as
 739  * gst_structure_id_set(). Basically a convenience wrapper around
 740  * gst_structure_new_id_empty() and gst_structure_id_set().
 741  *
 742  * The last variable argument must be NULL (or 0).
 743  *
 744  * Free-function: gst_structure_free
 745  *
 746  * Returns: (transfer full): a new #GstStructure
 747  */
 748 GstStructure *
 749 gst_structure_new_id (GQuark name_quark, GQuark field_quark, ...)
 750 {
 751   GstStructure *s;
 752   va_list varargs;
 753
 754   g_return_val_if_fail (name_quark != 0, NULL);
 755   g_return_val_if_fail (field_quark != 0, NULL);
 756
 757   s = gst_structure_new_id_empty (name_quark);
 758
 759   va_start (varargs, field_quark);
 760   gst_structure_id_set_valist_internal (s, field_quark, varargs);
 761   va_end (varargs);
 762
 763   return s;
 764 }
 765
 766 #if GST_VERSION_NANO == 1
 767 #define GIT_G_WARNING g_warning
 768 #else
 769 #define GIT_G_WARNING GST_WARNING
 770 #endif
 771
 772 /* If the structure currently contains a field with the same name, it is
 773  * replaced with the provided field. Otherwise, the field is added to the
 774  * structure. The field's value is not deeply copied.
 775  */
 776 static void
 777 gst_structure_set_field (GstStructure * structure, GstStructureField * field)
 778 {
 779   GstStructureField *f;
 780   guint i, len = GST_STRUCTURE_FIELDS (structure)->len;
 781
 782   if (G_UNLIKELY (G_VALUE_HOLDS_STRING (&field->value))) {
 783     const gchar *s;
 784
 785     s = g_value_get_string (&field->value);
 786     /* only check for NULL strings in taglists, as they are allowed in message
 787      * structs, e.g. error message debug strings */
 788     if (G_UNLIKELY (IS_TAGLIST (structure) && (s == NULL || *s == '\0'))) {
 789       if (s == NULL) {
 790         GIT_G_WARNING ("Trying to set NULL string on field '%s' on taglist. "
 791             "Please file a bug.", g_quark_to_string (field->name));
 792         g_value_unset (&field->value);
 793         return;
 794       } else {
 795         /* empty strings never make sense */
 796         GIT_G_WARNING ("Trying to set empty string on taglist field '%s'. "
 797             "Please file a bug.", g_quark_to_string (field->name));
 798         g_value_unset (&field->value);
 799         return;
 800       }
 801     } else if (G_UNLIKELY (s != NULL && !g_utf8_validate (s, -1, NULL))) {
 802       g_warning ("Trying to set string on %s field '%s', but string is not "
 803           "valid UTF-8. Please file a bug.",
 804           IS_TAGLIST (structure) ? "taglist" : "structure",
 805           g_quark_to_string (field->name));
 806       g_value_unset (&field->value);
 807       return;
 808     }
 809   } else if (G_UNLIKELY (G_VALUE_HOLDS (&field->value, G_TYPE_DATE))) {
 810     const GDate *d;
 811
 812     d = g_value_get_boxed (&field->value);
 813     /* only check for NULL GDates in taglists, as they might make sense
 814      * in other, generic structs */
 815     if (G_UNLIKELY ((IS_TAGLIST (structure) && d == NULL))) {
 816       GIT_G_WARNING ("Trying to set NULL GDate on field '%s' on taglist. "
 817           "Please file a bug.", g_quark_to_string (field->name));
 818       g_value_unset (&field->value);
 819       return;
 820     } else if (G_UNLIKELY (d != NULL && !g_date_valid (d))) {
 821       g_warning
 822           ("Trying to set invalid GDate on %s field '%s'. Please file a bug.",
 823           IS_TAGLIST (structure) ? "taglist" : "structure",
 824           g_quark_to_string (field->name));
 825       g_value_unset (&field->value);
 826       return;
 827     }
 828   }
 829
 830   for (i = 0; i < len; i++) {
 831     f = GST_STRUCTURE_FIELD (structure, i);
 832
 833     if (G_UNLIKELY (f->name == field->name)) {
 834       g_value_unset (&f->value);
 835       memcpy (f, field, sizeof (GstStructureField));
 836       return;
 837     }
 838   }
 839
 840   g_array_append_val (GST_STRUCTURE_FIELDS (structure), *field);
 841 }
 842
 843 /* If there is no field with the given ID, NULL is returned.
 844  */
 845 static GstStructureField *
 846 gst_structure_id_get_field (const GstStructure * structure, GQuark field_id)
 847 {
 848   GstStructureField *field;
 849   guint i, len;
 850
 851   len = GST_STRUCTURE_FIELDS (structure)->len;
 852
 853   for (i = 0; i < len; i++) {
 854     field = GST_STRUCTURE_FIELD (structure, i);
 855
 856     if (G_UNLIKELY (field->name == field_id))
 857       return field;
 858   }
 859
 860   return NULL;
 861 }
 862
 863 /* If there is no field with the given ID, NULL is returned.
 864  */
 865 static GstStructureField *
 866 gst_structure_get_field (const GstStructure * structure,
 867     const gchar * fieldname)
 868 {
 869   g_return_val_if_fail (structure != NULL, NULL);
 870   g_return_val_if_fail (fieldname != NULL, NULL);
 871
 872   return gst_structure_id_get_field (structure,
 873       g_quark_from_string (fieldname));
 874 }
 875
 876 /**
 877  * gst_structure_get_value:
 878  * @structure: a #GstStructure
 879  * @fieldname: the name of the field to get
 880  *
 881  * Get the value of the field with name @fieldname.
 882  *
 883  * Returns: the #GValue corresponding to the field with the given name.
 884  */
 885 const GValue *
 886 gst_structure_get_value (const GstStructure * structure,
 887     const gchar * fieldname)
 888 {
 889   GstStructureField *field;
 890
 891   g_return_val_if_fail (structure != NULL, NULL);
 892   g_return_val_if_fail (fieldname != NULL, NULL);
 893
 894   field = gst_structure_get_field (structure, fieldname);
 895   if (field == NULL)
 896     return NULL;
 897
 898   return &field->value;
 899 }
 900
 901 /**
 902  * gst_structure_id_get_value:
 903  * @structure: a #GstStructure
 904  * @field: the #GQuark of the field to get
 905  *
 906  * Get the value of the field with GQuark @field.
 907  *
 908  * Returns: the #GValue corresponding to the field with the given name
 909  *          identifier.
 910  */
 911 const GValue *
 912 gst_structure_id_get_value (const GstStructure * structure, GQuark field)
 913 {
 914   GstStructureField *gsfield;
 915
 916   g_return_val_if_fail (structure != NULL, NULL);
 917
 918   gsfield = gst_structure_id_get_field (structure, field);
 919   if (gsfield == NULL)
 920     return NULL;
 921
 922   return &gsfield->value;
 923 }
 924
 925 /**
 926  * gst_structure_remove_field:
 927  * @structure: a #GstStructure
 928  * @fieldname: the name of the field to remove
 929  *
 930  * Removes the field with the given name.  If the field with the given
 931  * name does not exist, the structure is unchanged.
 932  */
 933 void
 934 gst_structure_remove_field (GstStructure * structure, const gchar * fieldname)
 935 {
 936   GstStructureField *field;
 937   GQuark id;
 938   guint i, len;
 939
 940   g_return_if_fail (structure != NULL);
 941   g_return_if_fail (fieldname != NULL);
 942   g_return_if_fail (IS_MUTABLE (structure));
 943
 944   id = g_quark_from_string (fieldname);
 945   len = GST_STRUCTURE_FIELDS (structure)->len;
 946
 947   for (i = 0; i < len; i++) {
 948     field = GST_STRUCTURE_FIELD (structure, i);
 949
 950     if (field->name == id) {
 951       if (G_IS_VALUE (&field->value)) {
 952         g_value_unset (&field->value);
 953       }
 954       GST_STRUCTURE_FIELDS (structure) =
 955           g_array_remove_index (GST_STRUCTURE_FIELDS (structure), i);
 956       return;
 957     }
 958   }
 959 }
 960
 961 /**
 962  * gst_structure_remove_fields:
 963  * @structure: a #GstStructure
 964  * @fieldname: the name of the field to remove
 965  * @...: NULL-terminated list of more fieldnames to remove
 966  *
 967  * Removes the fields with the given names. If a field does not exist, the
 968  * argument is ignored.
 969  */
 970 void
 971 gst_structure_remove_fields (GstStructure * structure,
 972     const gchar * fieldname, ...)
 973 {
 974   va_list varargs;
 975
 976   g_return_if_fail (structure != NULL);
 977   g_return_if_fail (fieldname != NULL);
 978   /* mutability checked in remove_field */
 979
 980   va_start (varargs, fieldname);
 981   gst_structure_remove_fields_valist (structure, fieldname, varargs);
 982   va_end (varargs);
 983 }
 984
 985 /**
 986  * gst_structure_remove_fields_valist:
 987  * @structure: a #GstStructure
 988  * @fieldname: the name of the field to remove
 989  * @varargs: NULL-terminated list of more fieldnames to remove
 990  *
 991  * va_list form of gst_structure_remove_fields().
 992  */
 993 void
 994 gst_structure_remove_fields_valist (GstStructure * structure,
 995     const gchar * fieldname, va_list varargs)
 996 {
 997   gchar *field = (gchar *) fieldname;
 998
 999   g_return_if_fail (structure != NULL);
1000   g_return_if_fail (fieldname != NULL);
1001   /* mutability checked in remove_field */
1002
1003   while (field) {
1004     gst_structure_remove_field (structure, field);
1005     field = va_arg (varargs, char *);
1006   }
1007 }
1008
1009 /**
1010  * gst_structure_remove_all_fields:
1011  * @structure: a #GstStructure
1012  *
1013  * Removes all fields in a GstStructure.
1014  */
1015 void
1016 gst_structure_remove_all_fields (GstStructure * structure)
1017 {
1018   GstStructureField *field;
1019   int i;
1020
1021   g_return_if_fail (structure != NULL);
1022   g_return_if_fail (IS_MUTABLE (structure));
1023
1024   for (i = GST_STRUCTURE_FIELDS (structure)->len - 1; i >= 0; i--) {
1025     field = GST_STRUCTURE_FIELD (structure, i);
1026
1027     if (G_IS_VALUE (&field->value)) {
1028       g_value_unset (&field->value);
1029     }
1030     GST_STRUCTURE_FIELDS (structure) =
1031         g_array_remove_index (GST_STRUCTURE_FIELDS (structure), i);
1032   }
1033 }
1034
1035 /**
1036  * gst_structure_get_field_type:
1037  * @structure: a #GstStructure
1038  * @fieldname: the name of the field
1039  *
1040  * Finds the field with the given name, and returns the type of the
1041  * value it contains.  If the field is not found, G_TYPE_INVALID is
1042  * returned.
1043  *
1044  * Returns: the #GValue of the field
1045  */
1046 GType
1047 gst_structure_get_field_type (const GstStructure * structure,
1048     const gchar * fieldname)
1049 {
1050   GstStructureField *field;
1051
1052   g_return_val_if_fail (structure != NULL, G_TYPE_INVALID);
1053   g_return_val_if_fail (fieldname != NULL, G_TYPE_INVALID);
1054
1055   field = gst_structure_get_field (structure, fieldname);
1056   if (field == NULL)
1057     return G_TYPE_INVALID;
1058
1059   return G_VALUE_TYPE (&field->value);
1060 }
1061
1062 /**
1063  * gst_structure_n_fields:
1064  * @structure: a #GstStructure
1065  *
1066  * Get the number of fields in the structure.
1067  *
1068  * Returns: the number of fields in the structure
1069  */
1070 gint
1071 gst_structure_n_fields (const GstStructure * structure)
1072 {
1073   g_return_val_if_fail (structure != NULL, 0);
1074
1075   return GST_STRUCTURE_FIELDS (structure)->len;
1076 }
1077
1078 /**
1079  * gst_structure_nth_field_name:
1080  * @structure: a #GstStructure
1081  * @index: the index to get the name of
1082  *
1083  * Get the name of the given field number, counting from 0 onwards.
1084  *
1085  * Returns: the name of the given field number
1086  */
1087 const gchar *
1088 gst_structure_nth_field_name (const GstStructure * structure, guint index)
1089 {
1090   GstStructureField *field;
1091
1092   g_return_val_if_fail (structure != NULL, NULL);
1093   g_return_val_if_fail (index < GST_STRUCTURE_FIELDS (structure)->len, NULL);
1094
1095   field = GST_STRUCTURE_FIELD (structure, index);
1096
1097   return g_quark_to_string (field->name);
1098 }
1099
1100 /**
1101  * gst_structure_foreach:
1102  * @structure: a #GstStructure
1103  * @func: (scope call): a function to call for each field
1104  * @user_data: (closure): private data
1105  *
1106  * Calls the provided function once for each field in the #GstStructure. The
1107  * function must not modify the fields. Also see gst_structure_map_in_place().
1108  *
1109  * Returns: TRUE if the supplied function returns TRUE For each of the fields,
1110  * FALSE otherwise.
1111  */
1112 gboolean
1113 gst_structure_foreach (const GstStructure * structure,
1114     GstStructureForeachFunc func, gpointer user_data)
1115 {
1116   guint i, len;
1117   GstStructureField *field;
1118   gboolean ret;
1119
1120   g_return_val_if_fail (structure != NULL, FALSE);
1121   g_return_val_if_fail (func != NULL, FALSE);
1122
1123   len = GST_STRUCTURE_FIELDS (structure)->len;
1124
1125   for (i = 0; i < len; i++) {
1126     field = GST_STRUCTURE_FIELD (structure, i);
1127
1128     ret = func (field->name, &field->value, user_data);
1129     if (G_UNLIKELY (!ret))
1130       return FALSE;
1131   }
1132
1133   return TRUE;
1134 }
1135
1136 /**
1137  * gst_structure_map_in_place:
1138  * @structure: a #GstStructure
1139  * @func: (scope call): a function to call for each field
1140  * @user_data: (closure): private data
1141  *
1142  * Calls the provided function once for each field in the #GstStructure. In
1143  * contrast to gst_structure_foreach(), the function may modify but not delete the
1144  * fields. The structure must be mutable.
1145  *
1146  * Returns: TRUE if the supplied function returns TRUE For each of the fields,
1147  * FALSE otherwise.
1148  */
1149 gboolean
1150 gst_structure_map_in_place (GstStructure * structure,
1151     GstStructureMapFunc func, gpointer user_data)
1152 {
1153   guint i, len;
1154   GstStructureField *field;
1155   gboolean ret;
1156
1157   g_return_val_if_fail (structure != NULL, FALSE);
1158   g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
1159   g_return_val_if_fail (func != NULL, FALSE);
1160   len = GST_STRUCTURE_FIELDS (structure)->len;
1161
1162   for (i = 0; i < len; i++) {
1163     field = GST_STRUCTURE_FIELD (structure, i);
1164
1165     ret = func (field->name, &field->value, user_data);
1166     if (!ret)
1167       return FALSE;
1168   }
1169
1170   return TRUE;
1171 }
1172
1173 /**
1174  * gst_structure_id_has_field:
1175  * @structure: a #GstStructure
1176  * @field: #GQuark of the field name
1177  *
1178  * Check if @structure contains a field named @field.
1179  *
1180  * Returns: TRUE if the structure contains a field with the given name
1181  */
1182 gboolean
1183 gst_structure_id_has_field (const GstStructure * structure, GQuark field)
1184 {
1185   GstStructureField *f;
1186
1187   g_return_val_if_fail (structure != NULL, FALSE);
1188   g_return_val_if_fail (field != 0, FALSE);
1189
1190   f = gst_structure_id_get_field (structure, field);
1191
1192   return (f != NULL);
1193 }
1194
1195 /**
1196  * gst_structure_has_field:
1197  * @structure: a #GstStructure
1198  * @fieldname: the name of a field
1199  *
1200  * Check if @structure contains a field named @fieldname.
1201  *
1202  * Returns: TRUE if the structure contains a field with the given name
1203  */
1204 gboolean
1205 gst_structure_has_field (const GstStructure * structure,
1206     const gchar * fieldname)
1207 {
1208   g_return_val_if_fail (structure != NULL, FALSE);
1209   g_return_val_if_fail (fieldname != NULL, FALSE);
1210
1211   return gst_structure_id_has_field (structure,
1212       g_quark_from_string (fieldname));
1213 }
1214
1215 /**
1216  * gst_structure_id_has_field_typed:
1217  * @structure: a #GstStructure
1218  * @field: #GQuark of the field name
1219  * @type: the type of a value
1220  *
1221  * Check if @structure contains a field named @field and with GType @type.
1222  *
1223  * Returns: TRUE if the structure contains a field with the given name and type
1224  */
1225 gboolean
1226 gst_structure_id_has_field_typed (const GstStructure * structure,
1227     GQuark field, GType type)
1228 {
1229   GstStructureField *f;
1230
1231   g_return_val_if_fail (structure != NULL, FALSE);
1232   g_return_val_if_fail (field != 0, FALSE);
1233
1234   f = gst_structure_id_get_field (structure, field);
1235   if (f == NULL)
1236     return FALSE;
1237
1238   return (G_VALUE_TYPE (&f->value) == type);
1239 }
1240
1241 /**
1242  * gst_structure_has_field_typed:
1243  * @structure: a #GstStructure
1244  * @fieldname: the name of a field
1245  * @type: the type of a value
1246  *
1247  * Check if @structure contains a field named @fieldname and with GType @type.
1248  *
1249  * Returns: TRUE if the structure contains a field with the given name and type
1250  */
1251 gboolean
1252 gst_structure_has_field_typed (const GstStructure * structure,
1253     const gchar * fieldname, GType type)
1254 {
1255   g_return_val_if_fail (structure != NULL, FALSE);
1256   g_return_val_if_fail (fieldname != NULL, FALSE);
1257
1258   return gst_structure_id_has_field_typed (structure,
1259       g_quark_from_string (fieldname), type);
1260 }
1261
1262 /* utility functions */
1263
1264 /**
1265  * gst_structure_get_boolean:
1266  * @structure: a #GstStructure
1267  * @fieldname: the name of a field
1268  * @value: (out): a pointer to a #gboolean to set
1269  *
1270  * Sets the boolean pointed to by @value corresponding to the value of the
1271  * given field.  Caller is responsible for making sure the field exists
1272  * and has the correct type.
1273  *
1274  * Returns: TRUE if the value could be set correctly. If there was no field
1275  * with @fieldname or the existing field did not contain a boolean, this
1276  * function returns FALSE.
1277  */
1278 gboolean
1279 gst_structure_get_boolean (const GstStructure * structure,
1280     const gchar * fieldname, gboolean * value)
1281 {
1282   GstStructureField *field;
1283
1284   g_return_val_if_fail (structure != NULL, FALSE);
1285   g_return_val_if_fail (fieldname != NULL, FALSE);
1286
1287   field = gst_structure_get_field (structure, fieldname);
1288
1289   if (field == NULL)
1290     return FALSE;
1291   if (!G_VALUE_HOLDS_BOOLEAN (&field->value))
1292     return FALSE;
1293
1294   *value = gst_g_value_get_boolean_unchecked (&field->value);
1295
1296   return TRUE;
1297 }
1298
1299 /**
1300  * gst_structure_get_int:
1301  * @structure: a #GstStructure
1302  * @fieldname: the name of a field
1303  * @value: (out): a pointer to an int to set
1304  *
1305  * Sets the int pointed to by @value corresponding to the value of the
1306  * given field.  Caller is responsible for making sure the field exists
1307  * and has the correct type.
1308  *
1309  * Returns: %TRUE if the value could be set correctly. If there was no field
1310  * with @fieldname or the existing field did not contain an int, this function
1311  * returns %FALSE.
1312  */
1313 gboolean
1314 gst_structure_get_int (const GstStructure * structure,
1315     const gchar * fieldname, gint * value)
1316 {
1317   GstStructureField *field;
1318
1319   g_return_val_if_fail (structure != NULL, FALSE);
1320   g_return_val_if_fail (fieldname != NULL, FALSE);
1321   g_return_val_if_fail (value != NULL, FALSE);
1322
1323   field = gst_structure_get_field (structure, fieldname);
1324
1325   if (field == NULL)
1326     return FALSE;
1327   if (!G_VALUE_HOLDS_INT (&field->value))
1328     return FALSE;
1329
1330   *value = gst_g_value_get_int_unchecked (&field->value);
1331
1332   return TRUE;
1333 }
1334
1335 /**
1336  * gst_structure_get_uint:
1337  * @structure: a #GstStructure
1338  * @fieldname: the name of a field
1339  * @value: (out): a pointer to a uint to set
1340  *
1341  * Sets the uint pointed to by @value corresponding to the value of the
1342  * given field.  Caller is responsible for making sure the field exists
1343  * and has the correct type.
1344  *
1345  * Returns: %TRUE if the value could be set correctly. If there was no field
1346  * with @fieldname or the existing field did not contain a uint, this function
1347  * returns %FALSE.
1348  */
1349 gboolean
1350 gst_structure_get_uint (const GstStructure * structure,
1351     const gchar * fieldname, guint * value)
1352 {
1353   GstStructureField *field;
1354
1355   g_return_val_if_fail (structure != NULL, FALSE);
1356   g_return_val_if_fail (fieldname != NULL, FALSE);
1357   g_return_val_if_fail (value != NULL, FALSE);
1358
1359   field = gst_structure_get_field (structure, fieldname);
1360
1361   if (field == NULL)
1362     return FALSE;
1363   if (!G_VALUE_HOLDS_UINT (&field->value))
1364     return FALSE;
1365
1366   *value = gst_g_value_get_uint_unchecked (&field->value);
1367
1368   return TRUE;
1369 }
1370
1371 /**
1372  * gst_structure_get_int64:
1373  * @structure: a #GstStructure
1374  * @fieldname: the name of a field
1375  * @value: (out): a pointer to an int64 to set
1376  *
1377  * Sets the int64 pointed to by @value corresponding to the value of the
1378  * given field. Caller is responsible for making sure the field exists
1379  * and has the correct type.
1380  *
1381  * Returns: %TRUE if the value could be set correctly. If there was no field
1382  * with @fieldname or the existing field did not contain an int64, this function
1383  * returns %FALSE.
1384  *
1385  * Since: 1.4
1386  */
1387 gboolean
1388 gst_structure_get_int64 (const GstStructure * structure,
1389     const gchar * fieldname, gint64 * value)
1390 {
1391   GstStructureField *field;
1392
1393   g_return_val_if_fail (structure != NULL, FALSE);
1394   g_return_val_if_fail (fieldname != NULL, FALSE);
1395   g_return_val_if_fail (value != NULL, FALSE);
1396
1397   field = gst_structure_get_field (structure, fieldname);
1398
1399   if (field == NULL)
1400     return FALSE;
1401   if (!G_VALUE_HOLDS_INT64 (&field->value))
1402     return FALSE;
1403
1404   *value = gst_g_value_get_int64_unchecked (&field->value);
1405
1406   return TRUE;
1407 }
1408
1409 /**
1410  * gst_structure_get_uint64:
1411  * @structure: a #GstStructure
1412  * @fieldname: the name of a field
1413  * @value: (out): a pointer to a uint64 to set
1414  *
1415  * Sets the uint64 pointed to by @value corresponding to the value of the
1416  * given field. Caller is responsible for making sure the field exists
1417  * and has the correct type.
1418  *
1419  * Returns: %TRUE if the value could be set correctly. If there was no field
1420  * with @fieldname or the existing field did not contain a uint64, this function
1421  * returns %FALSE.
1422  *
1423  * Since: 1.4
1424  */
1425 gboolean
1426 gst_structure_get_uint64 (const GstStructure * structure,
1427     const gchar * fieldname, guint64 * value)
1428 {
1429   GstStructureField *field;
1430
1431   g_return_val_if_fail (structure != NULL, FALSE);
1432   g_return_val_if_fail (fieldname != NULL, FALSE);
1433   g_return_val_if_fail (value != NULL, FALSE);
1434
1435   field = gst_structure_get_field (structure, fieldname);
1436
1437   if (field == NULL)
1438     return FALSE;
1439   if (!G_VALUE_HOLDS_UINT64 (&field->value))
1440     return FALSE;
1441
1442   *value = gst_g_value_get_uint64_unchecked (&field->value);
1443
1444   return TRUE;
1445 }
1446
1447 /**
1448  * gst_structure_get_date:
1449  * @structure: a #GstStructure
1450  * @fieldname: the name of a field
1451  * @value: (out callee-allocates): a pointer to a #GDate to set
1452  *
1453  * Sets the date pointed to by @value corresponding to the date of the
1454  * given field.  Caller is responsible for making sure the field exists
1455  * and has the correct type.
1456  *
1457  * On success @value will point to a newly-allocated copy of the date which
1458  * should be freed with g_date_free() when no longer needed (note: this is
1459  * inconsistent with e.g. gst_structure_get_string() which doesn't return a
1460  * copy of the string).
1461  *
1462  * Returns: TRUE if the value could be set correctly. If there was no field
1463  * with @fieldname or the existing field did not contain a data, this function
1464  * returns FALSE.
1465  */
1466 gboolean
1467 gst_structure_get_date (const GstStructure * structure, const gchar * fieldname,
1468     GDate ** value)
1469 {
1470   GstStructureField *field;
1471
1472   g_return_val_if_fail (structure != NULL, FALSE);
1473   g_return_val_if_fail (fieldname != NULL, FALSE);
1474   g_return_val_if_fail (value != NULL, FALSE);
1475
1476   field = gst_structure_get_field (structure, fieldname);
1477
1478   if (field == NULL)
1479     return FALSE;
1480   if (!G_VALUE_HOLDS (&field->value, G_TYPE_DATE))
1481     return FALSE;
1482
1483   /* FIXME: 0.11 g_value_dup_boxed() -> g_value_get_boxed() */
1484   *value = g_value_dup_boxed (&field->value);
1485
1486   return TRUE;
1487 }
1488
1489 /**
1490  * gst_structure_get_date_time:
1491  * @structure: a #GstStructure
1492  * @fieldname: the name of a field
1493  * @value: (out callee-allocates): a pointer to a #GstDateTime to set
1494  *
1495  * Sets the datetime pointed to by @value corresponding to the datetime of the
1496  * given field. Caller is responsible for making sure the field exists
1497  * and has the correct type.
1498  *
1499  * On success @value will point to a reference of the datetime which
1500  * should be unreffed with gst_date_time_unref() when no longer needed
1501  * (note: this is inconsistent with e.g. gst_structure_get_string()
1502  * which doesn't return a copy of the string).
1503  *
1504  * Returns: TRUE if the value could be set correctly. If there was no field
1505  * with @fieldname or the existing field did not contain a data, this function
1506  * returns FALSE.
1507  */
1508 gboolean
1509 gst_structure_get_date_time (const GstStructure * structure,
1510     const gchar * fieldname, GstDateTime ** value)
1511 {
1512   GstStructureField *field;
1513
1514   g_return_val_if_fail (structure != NULL, FALSE);
1515   g_return_val_if_fail (fieldname != NULL, FALSE);
1516   g_return_val_if_fail (value != NULL, FALSE);
1517
1518   field = gst_structure_get_field (structure, fieldname);
1519
1520   if (field == NULL)
1521     return FALSE;
1522   if (!GST_VALUE_HOLDS_DATE_TIME (&field->value))
1523     return FALSE;
1524
1525   /* FIXME: 0.11 g_value_dup_boxed() -> g_value_get_boxed() */
1526   *value = g_value_dup_boxed (&field->value);
1527
1528   return TRUE;
1529 }
1530
1531 /**
1532  * gst_structure_get_clock_time:
1533  * @structure: a #GstStructure
1534  * @fieldname: the name of a field
1535  * @value: (out): a pointer to a #GstClockTime to set
1536  *
1537  * Sets the clock time pointed to by @value corresponding to the clock time
1538  * of the given field.  Caller is responsible for making sure the field exists
1539  * and has the correct type.
1540  *
1541  * Returns: TRUE if the value could be set correctly. If there was no field
1542  * with @fieldname or the existing field did not contain a #GstClockTime, this
1543  * function returns FALSE.
1544  */
1545 gboolean
1546 gst_structure_get_clock_time (const GstStructure * structure,
1547     const gchar * fieldname, GstClockTime * value)
1548 {
1549   return gst_structure_get_uint64 (structure, fieldname, value);
1550 }
1551
1552 /**
1553  * gst_structure_get_double:
1554  * @structure: a #GstStructure
1555  * @fieldname: the name of a field
1556  * @value: (out): a pointer to a gdouble to set
1557  *
1558  * Sets the double pointed to by @value corresponding to the value of the
1559  * given field.  Caller is responsible for making sure the field exists
1560  * and has the correct type.
1561  *
1562  * Returns: TRUE if the value could be set correctly. If there was no field
1563  * with @fieldname or the existing field did not contain a double, this
1564  * function returns FALSE.
1565  */
1566 gboolean
1567 gst_structure_get_double (const GstStructure * structure,
1568     const gchar * fieldname, gdouble * value)
1569 {
1570   GstStructureField *field;
1571
1572   g_return_val_if_fail (structure != NULL, FALSE);
1573   g_return_val_if_fail (fieldname != NULL, FALSE);
1574   g_return_val_if_fail (value != NULL, FALSE);
1575
1576   field = gst_structure_get_field (structure, fieldname);
1577
1578   if (field == NULL)
1579     return FALSE;
1580   if (!G_VALUE_HOLDS_DOUBLE (&field->value))
1581     return FALSE;
1582
1583   *value = gst_g_value_get_double_unchecked (&field->value);
1584
1585   return TRUE;
1586 }
1587
1588 /**
1589  * gst_structure_get_string:
1590  * @structure: a #GstStructure
1591  * @fieldname: the name of a field
1592  *
1593  * Finds the field corresponding to @fieldname, and returns the string
1594  * contained in the field's value.  Caller is responsible for making
1595  * sure the field exists and has the correct type.
1596  *
1597  * The string should not be modified, and remains valid until the next
1598  * call to a gst_structure_*() function with the given structure.
1599  *
1600  * Returns: a pointer to the string or NULL when the field did not exist
1601  * or did not contain a string.
1602  */
1603 const gchar *
1604 gst_structure_get_string (const GstStructure * structure,
1605     const gchar * fieldname)
1606 {
1607   GstStructureField *field;
1608
1609   g_return_val_if_fail (structure != NULL, NULL);
1610   g_return_val_if_fail (fieldname != NULL, NULL);
1611
1612   field = gst_structure_get_field (structure, fieldname);
1613
1614   if (field == NULL)
1615     return NULL;
1616   if (!G_VALUE_HOLDS_STRING (&field->value))
1617     return NULL;
1618
1619   return gst_g_value_get_string_unchecked (&field->value);
1620 }
1621
1622 /**
1623  * gst_structure_get_enum:
1624  * @structure: a #GstStructure
1625  * @fieldname: the name of a field
1626  * @enumtype: the enum type of a field
1627  * @value: (out): a pointer to an int to set
1628  *
1629  * Sets the int pointed to by @value corresponding to the value of the
1630  * given field.  Caller is responsible for making sure the field exists,
1631  * has the correct type and that the enumtype is correct.
1632  *
1633  * Returns: TRUE if the value could be set correctly. If there was no field
1634  * with @fieldname or the existing field did not contain an enum of the given
1635  * type, this function returns FALSE.
1636  */
1637 gboolean
1638 gst_structure_get_enum (const GstStructure * structure,
1639     const gchar * fieldname, GType enumtype, gint * value)
1640 {
1641   GstStructureField *field;
1642
1643   g_return_val_if_fail (structure != NULL, FALSE);
1644   g_return_val_if_fail (fieldname != NULL, FALSE);
1645   g_return_val_if_fail (enumtype != G_TYPE_INVALID, FALSE);
1646   g_return_val_if_fail (value != NULL, FALSE);
1647
1648   field = gst_structure_get_field (structure, fieldname);
1649
1650   if (field == NULL)
1651     return FALSE;
1652   if (!G_TYPE_CHECK_VALUE_TYPE (&field->value, enumtype))
1653     return FALSE;
1654
1655   *value = g_value_get_enum (&field->value);
1656
1657   return TRUE;
1658 }
1659
1660 /**
1661  * gst_structure_get_fraction:
1662  * @structure: a #GstStructure
1663  * @fieldname: the name of a field
1664  * @value_numerator: (out): a pointer to an int to set
1665  * @value_denominator: (out): a pointer to an int to set
1666  *
1667  * Sets the integers pointed to by @value_numerator and @value_denominator
1668  * corresponding to the value of the given field.  Caller is responsible
1669  * for making sure the field exists and has the correct type.
1670  *
1671  * Returns: TRUE if the values could be set correctly. If there was no field
1672  * with @fieldname or the existing field did not contain a GstFraction, this
1673  * function returns FALSE.
1674  */
1675 gboolean
1676 gst_structure_get_fraction (const GstStructure * structure,
1677     const gchar * fieldname, gint * value_numerator, gint * value_denominator)
1678 {
1679   GstStructureField *field;
1680
1681   g_return_val_if_fail (structure != NULL, FALSE);
1682   g_return_val_if_fail (fieldname != NULL, FALSE);
1683   g_return_val_if_fail (value_numerator != NULL, FALSE);
1684   g_return_val_if_fail (value_denominator != NULL, FALSE);
1685
1686   field = gst_structure_get_field (structure, fieldname);
1687
1688   if (field == NULL)
1689     return FALSE;
1690   if (!GST_VALUE_HOLDS_FRACTION (&field->value))
1691     return FALSE;
1692
1693   *value_numerator = gst_value_get_fraction_numerator (&field->value);
1694   *value_denominator = gst_value_get_fraction_denominator (&field->value);
1695
1696   return TRUE;
1697 }
1698
1699 typedef struct _GstStructureAbbreviation
1700 {
1701   const gchar *type_name;
1702   GType type;
1703 }
1704 GstStructureAbbreviation;
1705
1706 /* return a copy of an array of GstStructureAbbreviation containing all the
1707  * known type_string, GType maps, including abbreviations for common types */
1708 static GstStructureAbbreviation *
1709 gst_structure_get_abbrs (gint * n_abbrs)
1710 {
1711   static GstStructureAbbreviation *abbrs = NULL;
1712   static volatile gsize num = 0;
1713
1714   if (g_once_init_enter (&num)) {
1715     /* dynamically generate the array */
1716     gsize _num;
1717     GstStructureAbbreviation dyn_abbrs[] = {
1718       {"int", G_TYPE_INT}
1719       ,
1720       {"i", G_TYPE_INT}
1721       ,
1722       {"uint", G_TYPE_UINT}
1723       ,
1724       {"u", G_TYPE_UINT}
1725       ,
1726       {"float", G_TYPE_FLOAT}
1727       ,
1728       {"f", G_TYPE_FLOAT}
1729       ,
1730       {"double", G_TYPE_DOUBLE}
1731       ,
1732       {"d", G_TYPE_DOUBLE}
1733       ,
1734       {"buffer", GST_TYPE_BUFFER}
1735       ,
1736       {"fraction", GST_TYPE_FRACTION}
1737       ,
1738       {"boolean", G_TYPE_BOOLEAN}
1739       ,
1740       {"bool", G_TYPE_BOOLEAN}
1741       ,
1742       {"b", G_TYPE_BOOLEAN}
1743       ,
1744       {"string", G_TYPE_STRING}
1745       ,
1746       {"str", G_TYPE_STRING}
1747       ,
1748       {"s", G_TYPE_STRING}
1749       ,
1750       {"structure", GST_TYPE_STRUCTURE}
1751       ,
1752       {"date", G_TYPE_DATE}
1753       ,
1754       {"datetime", GST_TYPE_DATE_TIME}
1755       ,
1756       {"bitmask", GST_TYPE_BITMASK}
1757       ,
1758       {"sample", GST_TYPE_SAMPLE}
1759       ,
1760       {"taglist", GST_TYPE_TAG_LIST}
1761     };
1762     _num = G_N_ELEMENTS (dyn_abbrs);
1763     /* permanently allocate and copy the array now */
1764     abbrs = g_new0 (GstStructureAbbreviation, _num);
1765     memcpy (abbrs, dyn_abbrs, sizeof (GstStructureAbbreviation) * _num);
1766     g_once_init_leave (&num, _num);
1767   }
1768   *n_abbrs = num;
1769
1770   return abbrs;
1771 }
1772
1773 /* given a type_name that could be a type abbreviation or a registered GType,
1774  * return a matching GType */
1775 static GType
1776 gst_structure_gtype_from_abbr (const char *type_name)
1777 {
1778   int i;
1779   GstStructureAbbreviation *abbrs;
1780   gint n_abbrs;
1781
1782   g_return_val_if_fail (type_name != NULL, G_TYPE_INVALID);
1783
1784   abbrs = gst_structure_get_abbrs (&n_abbrs);
1785
1786   for (i = 0; i < n_abbrs; i++) {
1787     if (strcmp (type_name, abbrs[i].type_name) == 0) {
1788       return abbrs[i].type;
1789     }
1790   }
1791
1792   /* this is the fallback */
1793   return g_type_from_name (type_name);
1794 }
1795
1796 static const char *
1797 gst_structure_to_abbr (GType type)
1798 {
1799   int i;
1800   GstStructureAbbreviation *abbrs;
1801   gint n_abbrs;
1802
1803   g_return_val_if_fail (type != G_TYPE_INVALID, NULL);
1804
1805   abbrs = gst_structure_get_abbrs (&n_abbrs);
1806
1807   for (i = 0; i < n_abbrs; i++) {
1808     if (type == abbrs[i].type) {
1809       return abbrs[i].type_name;
1810     }
1811   }
1812
1813   return g_type_name (type);
1814 }
1815
1816 static GType
1817 gst_structure_value_get_generic_type (GValue * val)
1818 {
1819   if (G_VALUE_TYPE (val) == GST_TYPE_LIST
1820       || G_VALUE_TYPE (val) == GST_TYPE_ARRAY) {
1821     GArray *array = g_value_peek_pointer (val);
1822
1823     if (array->len > 0) {
1824       GValue *value = &g_array_index (array, GValue, 0);
1825
1826       return gst_structure_value_get_generic_type (value);
1827     } else {
1828       return G_TYPE_INT;
1829     }
1830   } else if (G_VALUE_TYPE (val) == GST_TYPE_INT_RANGE) {
1831     return G_TYPE_INT;
1832   } else if (G_VALUE_TYPE (val) == GST_TYPE_INT64_RANGE) {
1833     return G_TYPE_INT64;
1834   } else if (G_VALUE_TYPE (val) == GST_TYPE_DOUBLE_RANGE) {
1835     return G_TYPE_DOUBLE;
1836   } else if (G_VALUE_TYPE (val) == GST_TYPE_FRACTION_RANGE) {
1837     return GST_TYPE_FRACTION;
1838   }
1839   return G_VALUE_TYPE (val);
1840 }
1841
1842 gboolean
1843 priv_gst_structure_append_to_gstring (const GstStructure * structure,
1844     GString * s)
1845 {
1846   GstStructureField *field;
1847   guint i, len;
1848
1849   g_return_val_if_fail (s != NULL, FALSE);
1850
1851   len = GST_STRUCTURE_FIELDS (structure)->len;
1852   for (i = 0; i < len; i++) {
1853     char *t;
1854     GType type;
1855
1856     field = GST_STRUCTURE_FIELD (structure, i);
1857
1858     t = gst_value_serialize (&field->value);
1859     type = gst_structure_value_get_generic_type (&field->value);
1860
1861     g_string_append_len (s, ", ", 2);
1862     /* FIXME: do we need to escape fieldnames? */
1863     g_string_append (s, g_quark_to_string (field->name));
1864     g_string_append_len (s, "=(", 2);
1865     g_string_append (s, gst_structure_to_abbr (type));
1866     g_string_append_c (s, ')');
1867     g_string_append (s, t == NULL ? "NULL" : t);
1868     g_free (t);
1869   }
1870
1871   g_string_append_c (s, ';');
1872   return TRUE;
1873 }
1874
1875 /**
1876  * gst_structure_to_string:
1877  * @structure: a #GstStructure
1878  *
1879  * Converts @structure to a human-readable string representation.
1880  *
1881  * For debugging purposes its easier to do something like this:
1882  * |[
1883  * GST_LOG ("structure is %" GST_PTR_FORMAT, structure);
1884  * ]|
1885  * This prints the structure in human readable form.
1886  *
1887  * The current implementation of serialization will lead to unexpected results
1888  * when there are nested #GstCaps / #GstStructure deeper than one level.
1889  *
1890  * Free-function: g_free
1891  *
1892  * Returns: (transfer full): a pointer to string allocated by g_malloc().
1893  *     g_free() after usage.
1894  */
1895 gchar *
1896 gst_structure_to_string (const GstStructure * structure)
1897 {
1898   GString *s;
1899
1900   /* NOTE:  This function is potentially called by the debug system,
1901    * so any calls to gst_log() (and GST_DEBUG(), GST_LOG(), etc.)
1902    * should be careful to avoid recursion.  This includes any functions
1903    * called by gst_structure_to_string.  In particular, calls should
1904    * not use the GST_PTR_FORMAT extension.  */
1905
1906   g_return_val_if_fail (structure != NULL, NULL);
1907
1908   /* we estimate a minimum size based on the number of fields in order to
1909    * avoid unnecessary reallocs within GString */
1910   s = g_string_sized_new (STRUCTURE_ESTIMATED_STRING_LEN (structure));
1911   g_string_append (s, g_quark_to_string (structure->name));
1912   priv_gst_structure_append_to_gstring (structure, s);
1913   return g_string_free (s, FALSE);
1914 }
1915
1916 /*
1917  * r will still point to the string. if end == next, the string will not be
1918  * null-terminated. In all other cases it will be.
1919  * end = pointer to char behind end of string, next = pointer to start of
1920  * unread data.
1921  * THIS FUNCTION MODIFIES THE STRING AND DETECTS INSIDE A NONTERMINATED STRING
1922  */
1923 static gboolean
1924 gst_structure_parse_string (gchar * s, gchar ** end, gchar ** next,
1925     gboolean unescape)
1926 {
1927   gchar *w;
1928
1929   if (*s == 0)
1930     return FALSE;
1931
1932   if (*s != '"') {
1933     int ret;
1934
1935     ret = gst_structure_parse_simple_string (s, end);
1936     *next = *end;
1937
1938     return ret;
1939   }
1940
1941   if (unescape) {
1942     w = s;
1943     s++;
1944     while (*s != '"') {
1945       if (G_UNLIKELY (*s == 0))
1946         return FALSE;
1947       if (G_UNLIKELY (*s == '\\'))
1948         s++;
1949       *w = *s;
1950       w++;
1951       s++;
1952     }
1953     s++;
1954   } else {
1955     /* Find the closing quotes */
1956     s++;
1957     while (*s != '"') {
1958       if (G_UNLIKELY (*s == 0))
1959         return FALSE;
1960       if (G_UNLIKELY (*s == '\\'))
1961         s++;
1962       s++;
1963     }
1964     s++;
1965     w = s;
1966   }
1967
1968   *end = w;
1969   *next = s;
1970
1971   return TRUE;
1972 }
1973
1974 static gboolean
1975 gst_structure_parse_range (gchar * s, gchar ** after, GValue * value,
1976     GType type)
1977 {
1978   GValue value1 = { 0 };
1979   GValue value2 = { 0 };
1980   GValue value3 = { 0 };
1981   GType range_type;
1982   gboolean ret, have_step = FALSE;
1983
1984   if (*s != '[')
1985     return FALSE;
1986   s++;
1987
1988   ret = gst_structure_parse_value (s, &s, &value1, type);
1989   if (ret == FALSE)
1990     return FALSE;
1991
1992   while (g_ascii_isspace (*s))
1993     s++;
1994
1995   if (*s != ',')
1996     return FALSE;
1997   s++;
1998
1999   while (g_ascii_isspace (*s))
2000     s++;
2001
2002   ret = gst_structure_parse_value (s, &s, &value2, type);
2003   if (ret == FALSE)
2004     return FALSE;
2005
2006   while (g_ascii_isspace (*s))
2007     s++;
2008
2009   /* optional step for int and int64 */
2010   if (G_VALUE_TYPE (&value1) == G_TYPE_INT
2011       || G_VALUE_TYPE (&value1) == G_TYPE_INT64) {
2012     if (*s == ',') {
2013       s++;
2014
2015       while (g_ascii_isspace (*s))
2016         s++;
2017
2018       ret = gst_structure_parse_value (s, &s, &value3, type);
2019       if (ret == FALSE)
2020         return FALSE;
2021
2022       while (g_ascii_isspace (*s))
2023         s++;
2024
2025       have_step = TRUE;
2026     }
2027   }
2028
2029   if (*s != ']')
2030     return FALSE;
2031   s++;
2032
2033   if (G_VALUE_TYPE (&value1) != G_VALUE_TYPE (&value2))
2034     return FALSE;
2035   if (have_step && G_VALUE_TYPE (&value1) != G_VALUE_TYPE (&value3))
2036     return FALSE;
2037
2038   if (G_VALUE_TYPE (&value1) == G_TYPE_DOUBLE) {
2039     range_type = GST_TYPE_DOUBLE_RANGE;
2040     g_value_init (value, range_type);
2041     gst_value_set_double_range (value,
2042         gst_g_value_get_double_unchecked (&value1),
2043         gst_g_value_get_double_unchecked (&value2));
2044   } else if (G_VALUE_TYPE (&value1) == G_TYPE_INT) {
2045     range_type = GST_TYPE_INT_RANGE;
2046     g_value_init (value, range_type);
2047     if (have_step)
2048       gst_value_set_int_range_step (value,
2049           gst_g_value_get_int_unchecked (&value1),
2050           gst_g_value_get_int_unchecked (&value2),
2051           gst_g_value_get_int_unchecked (&value3));
2052     else
2053       gst_value_set_int_range (value, gst_g_value_get_int_unchecked (&value1),
2054           gst_g_value_get_int_unchecked (&value2));
2055   } else if (G_VALUE_TYPE (&value1) == G_TYPE_INT64) {
2056     range_type = GST_TYPE_INT64_RANGE;
2057     g_value_init (value, range_type);
2058     if (have_step)
2059       gst_value_set_int64_range_step (value,
2060           gst_g_value_get_int64_unchecked (&value1),
2061           gst_g_value_get_int64_unchecked (&value2),
2062           gst_g_value_get_int64_unchecked (&value3));
2063     else
2064       gst_value_set_int64_range (value,
2065           gst_g_value_get_int64_unchecked (&value1),
2066           gst_g_value_get_int64_unchecked (&value2));
2067   } else if (G_VALUE_TYPE (&value1) == GST_TYPE_FRACTION) {
2068     range_type = GST_TYPE_FRACTION_RANGE;
2069     g_value_init (value, range_type);
2070     gst_value_set_fraction_range (value, &value1, &value2);
2071   } else {
2072     return FALSE;
2073   }
2074
2075   *after = s;
2076   return TRUE;
2077 }
2078
2079 static gboolean
2080 gst_structure_parse_any_list (gchar * s, gchar ** after, GValue * value,
2081     GType type, GType list_type, char begin, char end)
2082 {
2083   GValue list_value = { 0 };
2084   gboolean ret;
2085   GArray *array;
2086
2087   g_value_init (value, list_type);
2088   array = g_value_peek_pointer (value);
2089
2090   if (*s != begin)
2091     return FALSE;
2092   s++;
2093
2094   while (g_ascii_isspace (*s))
2095     s++;
2096   if (*s == end) {
2097     s++;
2098     *after = s;
2099     return TRUE;
2100   }
2101
2102   ret = gst_structure_parse_value (s, &s, &list_value, type);
2103   if (ret == FALSE)
2104     return FALSE;
2105
2106   g_array_append_val (array, list_value);
2107
2108   while (g_ascii_isspace (*s))
2109     s++;
2110
2111   while (*s != end) {
2112     if (*s != ',')
2113       return FALSE;
2114     s++;
2115
2116     while (g_ascii_isspace (*s))
2117       s++;
2118
2119     memset (&list_value, 0, sizeof (list_value));
2120     ret = gst_structure_parse_value (s, &s, &list_value, type);
2121     if (ret == FALSE)
2122       return FALSE;
2123
2124     g_array_append_val (array, list_value);
2125     while (g_ascii_isspace (*s))
2126       s++;
2127   }
2128
2129   s++;
2130
2131   *after = s;
2132   return TRUE;
2133 }
2134
2135 static gboolean
2136 gst_structure_parse_list (gchar * s, gchar ** after, GValue * value, GType type)
2137 {
2138   return gst_structure_parse_any_list (s, after, value, type, GST_TYPE_LIST,
2139       '{', '}');
2140 }
2141
2142 static gboolean
2143 gst_structure_parse_array (gchar * s, gchar ** after, GValue * value,
2144     GType type)
2145 {
2146   return gst_structure_parse_any_list (s, after, value, type,
2147       GST_TYPE_ARRAY, '<', '>');
2148 }
2149
2150 static gboolean
2151 gst_structure_parse_simple_string (gchar * str, gchar ** end)
2152 {
2153   char *s = str;
2154
2155   while (G_LIKELY (GST_ASCII_IS_STRING (*s))) {
2156     s++;
2157   }
2158
2159   *end = s;
2160
2161   return (s != str);
2162 }
2163
2164 static gboolean
2165 gst_structure_parse_field (gchar * str,
2166     gchar ** after, GstStructureField * field)
2167 {
2168   gchar *name;
2169   gchar *name_end;
2170   gchar *s;
2171   gchar c;
2172
2173   s = str;
2174
2175   while (g_ascii_isspace (*s) || (s[0] == '\\' && g_ascii_isspace (s[1])))
2176     s++;
2177   name = s;
2178   if (G_UNLIKELY (!gst_structure_parse_simple_string (s, &name_end))) {
2179     GST_WARNING ("failed to parse simple string, str=%s", str);
2180     return FALSE;
2181   }
2182
2183   s = name_end;
2184   while (g_ascii_isspace (*s) || (s[0] == '\\' && g_ascii_isspace (s[1])))
2185     s++;
2186
2187   if (G_UNLIKELY (*s != '=')) {
2188     GST_WARNING ("missing assignment operator in the field, str=%s", str);
2189     return FALSE;
2190   }
2191   s++;
2192
2193   c = *name_end;
2194   *name_end = '\0';
2195   field->name = g_quark_from_string (name);
2196   GST_DEBUG ("trying field name '%s'", name);
2197   *name_end = c;
2198
2199   if (G_UNLIKELY (!gst_structure_parse_value (s, &s, &field->value,
2200               G_TYPE_INVALID))) {
2201     GST_WARNING ("failed to parse value %s", str);
2202     return FALSE;
2203   }
2204
2205   *after = s;
2206   return TRUE;
2207 }
2208
2209 static gboolean
2210 gst_structure_parse_value (gchar * str,
2211     gchar ** after, GValue * value, GType default_type)
2212 {
2213   gchar *type_name;
2214   gchar *type_end;
2215   gchar *value_s;
2216   gchar *value_end;
2217   gchar *s;
2218   gchar c;
2219   int ret = 0;
2220   GType type = default_type;
2221
2222   s = str;
2223   while (g_ascii_isspace (*s))
2224     s++;
2225
2226   /* check if there's a (type_name) 'cast' */
2227   type_name = NULL;
2228   if (*s == '(') {
2229     s++;
2230     while (g_ascii_isspace (*s))
2231       s++;
2232     type_name = s;
2233     if (G_UNLIKELY (!gst_structure_parse_simple_string (s, &type_end)))
2234       return FALSE;
2235     s = type_end;
2236     while (g_ascii_isspace (*s))
2237       s++;
2238     if (G_UNLIKELY (*s != ')'))
2239       return FALSE;
2240     s++;
2241     while (g_ascii_isspace (*s))
2242       s++;
2243
2244     c = *type_end;
2245     *type_end = 0;
2246     type = gst_structure_gtype_from_abbr (type_name);
2247     GST_DEBUG ("trying type name '%s'", type_name);
2248     *type_end = c;
2249
2250     if (G_UNLIKELY (type == G_TYPE_INVALID)) {
2251       GST_WARNING ("invalid type");
2252       return FALSE;
2253     }
2254   }
2255
2256   while (g_ascii_isspace (*s))
2257     s++;
2258   if (*s == '[') {
2259     ret = gst_structure_parse_range (s, &s, value, type);
2260   } else if (*s == '{') {
2261     ret = gst_structure_parse_list (s, &s, value, type);
2262   } else if (*s == '<') {
2263     ret = gst_structure_parse_array (s, &s, value, type);
2264   } else {
2265     value_s = s;
2266
2267     if (G_UNLIKELY (type == G_TYPE_INVALID)) {
2268       GType try_types[] =
2269           { G_TYPE_INT, G_TYPE_DOUBLE, GST_TYPE_FRACTION, G_TYPE_BOOLEAN,
2270         G_TYPE_STRING
2271       };
2272       int i;
2273
2274       if (G_UNLIKELY (!gst_structure_parse_string (s, &value_end, &s, TRUE)))
2275         return FALSE;
2276       /* Set NULL terminator for deserialization */
2277       c = *value_end;
2278       *value_end = '\0';
2279
2280       for (i = 0; i < G_N_ELEMENTS (try_types); i++) {
2281         g_value_init (value, try_types[i]);
2282         ret = gst_value_deserialize (value, value_s);
2283         if (ret)
2284           break;
2285         g_value_unset (value);
2286       }
2287     } else {
2288       g_value_init (value, type);
2289
2290       if (G_UNLIKELY (!gst_structure_parse_string (s, &value_end, &s,
2291                   (type != G_TYPE_STRING))))
2292         return FALSE;
2293       /* Set NULL terminator for deserialization */
2294       c = *value_end;
2295       *value_end = '\0';
2296
2297       ret = gst_value_deserialize (value, value_s);
2298       if (G_UNLIKELY (!ret))
2299         g_value_unset (value);
2300     }
2301     *value_end = c;
2302   }
2303
2304   *after = s;
2305
2306   return ret;
2307 }
2308
2309 gboolean
2310 priv_gst_structure_parse_name (gchar * str, gchar ** start, gchar ** end,
2311     gchar ** next)
2312 {
2313   char *w;
2314   char *r;
2315
2316   r = str;
2317
2318   /* skip spaces (FIXME: _isspace treats tabs and newlines as space!) */
2319   while (*r && (g_ascii_isspace (*r) || (r[0] == '\\'
2320               && g_ascii_isspace (r[1]))))
2321     r++;
2322
2323   *start = r;
2324
2325   if (G_UNLIKELY (!gst_structure_parse_string (r, &w, &r, TRUE))) {
2326     GST_WARNING ("Failed to parse structure string '%s'", str);
2327     return FALSE;
2328   }
2329
2330   *end = w;
2331   *next = r;
2332
2333   return TRUE;
2334 }
2335
2336 gboolean
2337 priv_gst_structure_parse_fields (gchar * str, gchar ** end,
2338     GstStructure * structure)
2339 {
2340   gchar *r;
2341   GstStructureField field;
2342
2343   r = str;
2344
2345   do {
2346     while (*r && (g_ascii_isspace (*r) || (r[0] == '\\'
2347                 && g_ascii_isspace (r[1]))))
2348       r++;
2349     if (*r == ';') {
2350       /* end of structure, get the next char and finish */
2351       r++;
2352       break;
2353     }
2354     if (*r == '\0') {
2355       /* accept \0 as end delimiter */
2356       break;
2357     }
2358     if (G_UNLIKELY (*r != ',')) {
2359       GST_WARNING ("Failed to find delimiter, r=%s", r);
2360       return FALSE;
2361     }
2362     r++;
2363     while (*r && (g_ascii_isspace (*r) || (r[0] == '\\'
2364                 && g_ascii_isspace (r[1]))))
2365       r++;
2366
2367     memset (&field, 0, sizeof (field));
2368     if (G_UNLIKELY (!gst_structure_parse_field (r, &r, &field))) {
2369       GST_WARNING ("Failed to parse field, r=%s", r);
2370       return FALSE;
2371     }
2372     gst_structure_set_field (structure, &field);
2373   } while (TRUE);
2374
2375   *end = r;
2376
2377   return TRUE;
2378 }
2379
2380 /**
2381  * gst_structure_new_from_string:
2382  * @string: a string representation of a #GstStructure
2383  *
2384  * Creates a #GstStructure from a string representation.
2385  * If end is not NULL, a pointer to the place inside the given string
2386  * where parsing ended will be returned.
2387  *
2388  * The current implementation of serialization will lead to unexpected results
2389  * when there are nested #GstCaps / #GstStructure deeper than one level.
2390  *
2391  * Free-function: gst_structure_free
2392  *
2393  * Returns: (transfer full): a new #GstStructure or NULL when the string could
2394  *     not be parsed. Free with gst_structure_free() after use.
2395  *
2396  * Since: 1.2
2397  */
2398 GstStructure *
2399 gst_structure_new_from_string (const gchar * string)
2400 {
2401   return gst_structure_from_string (string, NULL);
2402 }
2403
2404 /**
2405  * gst_structure_from_string:
2406  * @string: a string representation of a #GstStructure.
2407  * @end: (out) (allow-none) (transfer none) (skip): pointer to store the end of the string in.
2408  *
2409  * Creates a #GstStructure from a string representation.
2410  * If end is not NULL, a pointer to the place inside the given string
2411  * where parsing ended will be returned.
2412  *
2413  * Free-function: gst_structure_free
2414  *
2415  * Returns: (transfer full): a new #GstStructure or NULL when the string could
2416  *     not be parsed. Free with gst_structure_free() after use.
2417  */
2418 GstStructure *
2419 gst_structure_from_string (const gchar * string, gchar ** end)
2420 {
2421   char *name;
2422   char *copy;
2423   char *w;
2424   char *r;
2425   char save;
2426   GstStructure *structure = NULL;
2427
2428   g_return_val_if_fail (string != NULL, NULL);
2429
2430   copy = g_strdup (string);
2431   r = copy;
2432
2433   if (!priv_gst_structure_parse_name (r, &name, &w, &r))
2434     goto error;
2435
2436   save = *w;
2437   *w = '\0';
2438   structure = gst_structure_new_empty (name);
2439   *w = save;
2440
2441   if (G_UNLIKELY (structure == NULL))
2442     goto error;
2443
2444   if (!priv_gst_structure_parse_fields (r, &r, structure))
2445     goto error;
2446
2447   if (end)
2448     *end = (char *) string + (r - copy);
2449   else if (*r)
2450     g_warning ("gst_structure_from_string did not consume whole string,"
2451         " but caller did not provide end pointer (\"%s\")", string);
2452
2453   g_free (copy);
2454   return structure;
2455
2456 error:
2457   if (structure)
2458     gst_structure_free (structure);
2459   g_free (copy);
2460   return NULL;
2461 }
2462
2463 static void
2464 gst_structure_transform_to_string (const GValue * src_value,
2465     GValue * dest_value)
2466 {
2467   g_return_if_fail (src_value != NULL);
2468   g_return_if_fail (dest_value != NULL);
2469
2470   dest_value->data[0].v_pointer =
2471       gst_structure_to_string (src_value->data[0].v_pointer);
2472 }
2473
2474 static GstStructure *
2475 gst_structure_copy_conditional (const GstStructure * structure)
2476 {
2477   if (structure)
2478     return gst_structure_copy (structure);
2479   return NULL;
2480 }
2481
2482 /* fixate utility functions */
2483
2484 /**
2485  * gst_structure_fixate_field_nearest_int:
2486  * @structure: a #GstStructure
2487  * @field_name: a field in @structure
2488  * @target: the target value of the fixation
2489  *
2490  * Fixates a #GstStructure by changing the given field to the nearest
2491  * integer to @target that is a subset of the existing field.
2492  *
2493  * Returns: TRUE if the structure could be fixated
2494  */
2495 gboolean
2496 gst_structure_fixate_field_nearest_int (GstStructure * structure,
2497     const char *field_name, int target)
2498 {
2499   const GValue *value;
2500
2501   g_return_val_if_fail (gst_structure_has_field (structure, field_name), FALSE);
2502   g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2503
2504   value = gst_structure_get_value (structure, field_name);
2505
2506   if (G_VALUE_TYPE (value) == G_TYPE_INT) {
2507     /* already fixed */
2508     return FALSE;
2509   } else if (G_VALUE_TYPE (value) == GST_TYPE_INT_RANGE) {
2510     int x;
2511
2512     x = gst_value_get_int_range_min (value);
2513     if (target < x)
2514       target = x;
2515     x = gst_value_get_int_range_max (value);
2516     if (target > x)
2517       target = x;
2518     gst_structure_set (structure, field_name, G_TYPE_INT, target, NULL);
2519     return TRUE;
2520   } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
2521     const GValue *list_value;
2522     int i, n;
2523     int best = 0;
2524     int best_index = -1;
2525
2526     n = gst_value_list_get_size (value);
2527     for (i = 0; i < n; i++) {
2528       list_value = gst_value_list_get_value (value, i);
2529       if (G_VALUE_TYPE (list_value) == G_TYPE_INT) {
2530         int x = gst_g_value_get_int_unchecked (list_value);
2531
2532         if (best_index == -1 || (ABS (target - x) < ABS (target - best))) {
2533           best_index = i;
2534           best = x;
2535         }
2536       }
2537     }
2538     if (best_index != -1) {
2539       gst_structure_set (structure, field_name, G_TYPE_INT, best, NULL);
2540       return TRUE;
2541     }
2542     return FALSE;
2543   }
2544
2545   return FALSE;
2546 }
2547
2548 /**
2549  * gst_structure_fixate_field_nearest_double:
2550  * @structure: a #GstStructure
2551  * @field_name: a field in @structure
2552  * @target: the target value of the fixation
2553  *
2554  * Fixates a #GstStructure by changing the given field to the nearest
2555  * double to @target that is a subset of the existing field.
2556  *
2557  * Returns: TRUE if the structure could be fixated
2558  */
2559 gboolean
2560 gst_structure_fixate_field_nearest_double (GstStructure * structure,
2561     const char *field_name, double target)
2562 {
2563   const GValue *value;
2564
2565   g_return_val_if_fail (gst_structure_has_field (structure, field_name), FALSE);
2566   g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2567
2568   value = gst_structure_get_value (structure, field_name);
2569
2570   if (G_VALUE_TYPE (value) == G_TYPE_DOUBLE) {
2571     /* already fixed */
2572     return FALSE;
2573   } else if (G_VALUE_TYPE (value) == GST_TYPE_DOUBLE_RANGE) {
2574     double x;
2575
2576     x = gst_value_get_double_range_min (value);
2577     if (target < x)
2578       target = x;
2579     x = gst_value_get_double_range_max (value);
2580     if (target > x)
2581       target = x;
2582     gst_structure_set (structure, field_name, G_TYPE_DOUBLE, target, NULL);
2583     return TRUE;
2584   } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
2585     const GValue *list_value;
2586     int i, n;
2587     double best = 0;
2588     int best_index = -1;
2589
2590     n = gst_value_list_get_size (value);
2591     for (i = 0; i < n; i++) {
2592       list_value = gst_value_list_get_value (value, i);
2593       if (G_VALUE_TYPE (list_value) == G_TYPE_DOUBLE) {
2594         double x = gst_g_value_get_double_unchecked (list_value);
2595
2596         if (best_index == -1 || (ABS (target - x) < ABS (target - best))) {
2597           best_index = i;
2598           best = x;
2599         }
2600       }
2601     }
2602     if (best_index != -1) {
2603       gst_structure_set (structure, field_name, G_TYPE_DOUBLE, best, NULL);
2604       return TRUE;
2605     }
2606     return FALSE;
2607   }
2608
2609   return FALSE;
2610
2611 }
2612
2613 /**
2614  * gst_structure_fixate_field_boolean:
2615  * @structure: a #GstStructure
2616  * @field_name: a field in @structure
2617  * @target: the target value of the fixation
2618  *
2619  * Fixates a #GstStructure by changing the given @field_name field to the given
2620  * @target boolean if that field is not fixed yet.
2621  *
2622  * Returns: TRUE if the structure could be fixated
2623  */
2624 gboolean
2625 gst_structure_fixate_field_boolean (GstStructure * structure,
2626     const char *field_name, gboolean target)
2627 {
2628   const GValue *value;
2629
2630   g_return_val_if_fail (gst_structure_has_field (structure, field_name), FALSE);
2631   g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2632
2633   value = gst_structure_get_value (structure, field_name);
2634
2635   if (G_VALUE_TYPE (value) == G_TYPE_BOOLEAN) {
2636     /* already fixed */
2637     return FALSE;
2638   } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
2639     const GValue *list_value;
2640     int i, n;
2641     int best = 0;
2642     int best_index = -1;
2643
2644     n = gst_value_list_get_size (value);
2645     for (i = 0; i < n; i++) {
2646       list_value = gst_value_list_get_value (value, i);
2647       if (G_VALUE_TYPE (list_value) == G_TYPE_BOOLEAN) {
2648         gboolean x = gst_g_value_get_boolean_unchecked (list_value);
2649
2650         if (best_index == -1 || x == target) {
2651           best_index = i;
2652           best = x;
2653         }
2654       }
2655     }
2656     if (best_index != -1) {
2657       gst_structure_set (structure, field_name, G_TYPE_BOOLEAN, best, NULL);
2658       return TRUE;
2659     }
2660     return FALSE;
2661   }
2662
2663   return FALSE;
2664 }
2665
2666 /**
2667  * gst_structure_fixate_field_string:
2668  * @structure: a #GstStructure
2669  * @field_name: a field in @structure
2670  * @target: the target value of the fixation
2671  *
2672  * Fixates a #GstStructure by changing the given @field_name field to the given
2673  * @target string if that field is not fixed yet.
2674  *
2675  * Returns: TRUE if the structure could be fixated
2676  */
2677 gboolean
2678 gst_structure_fixate_field_string (GstStructure * structure,
2679     const gchar * field_name, const gchar * target)
2680 {
2681   const GValue *value;
2682
2683   g_return_val_if_fail (gst_structure_has_field (structure, field_name), FALSE);
2684   g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2685
2686   value = gst_structure_get_value (structure, field_name);
2687
2688   if (G_VALUE_TYPE (value) == G_TYPE_STRING) {
2689     /* already fixed */
2690     return FALSE;
2691   } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
2692     const GValue *list_value;
2693     int i, n;
2694     const gchar *best = NULL;
2695     int best_index = -1;
2696
2697     n = gst_value_list_get_size (value);
2698     for (i = 0; i < n; i++) {
2699       list_value = gst_value_list_get_value (value, i);
2700       if (G_VALUE_TYPE (list_value) == G_TYPE_STRING) {
2701         const gchar *x = g_value_get_string (list_value);
2702
2703         if (best_index == -1 || g_str_equal (x, target)) {
2704           best_index = i;
2705           best = x;
2706         }
2707       }
2708     }
2709     if (best_index != -1) {
2710       gst_structure_set (structure, field_name, G_TYPE_STRING, best, NULL);
2711       return TRUE;
2712     }
2713     return FALSE;
2714   }
2715
2716   return FALSE;
2717 }
2718
2719 /**
2720  * gst_structure_fixate_field_nearest_fraction:
2721  * @structure: a #GstStructure
2722  * @field_name: a field in @structure
2723  * @target_numerator: The numerator of the target value of the fixation
2724  * @target_denominator: The denominator of the target value of the fixation
2725  *
2726  * Fixates a #GstStructure by changing the given field to the nearest
2727  * fraction to @target_numerator/@target_denominator that is a subset
2728  * of the existing field.
2729  *
2730  * Returns: TRUE if the structure could be fixated
2731  */
2732 gboolean
2733 gst_structure_fixate_field_nearest_fraction (GstStructure * structure,
2734     const char *field_name, const gint target_numerator,
2735     const gint target_denominator)
2736 {
2737   const GValue *value;
2738
2739   g_return_val_if_fail (gst_structure_has_field (structure, field_name), FALSE);
2740   g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2741
2742   value = gst_structure_get_value (structure, field_name);
2743
2744   if (G_VALUE_TYPE (value) == GST_TYPE_FRACTION) {
2745     /* already fixed */
2746     return FALSE;
2747   } else if (G_VALUE_TYPE (value) == GST_TYPE_FRACTION_RANGE) {
2748     const GValue *x, *new_value;
2749     GValue target = { 0 };
2750     g_value_init (&target, GST_TYPE_FRACTION);
2751     gst_value_set_fraction (&target, target_numerator, target_denominator);
2752
2753     new_value = &target;
2754     x = gst_value_get_fraction_range_min (value);
2755     if (gst_value_compare (&target, x) == GST_VALUE_LESS_THAN)
2756       new_value = x;
2757     x = gst_value_get_fraction_range_max (value);
2758     if (gst_value_compare (&target, x) == GST_VALUE_GREATER_THAN)
2759       new_value = x;
2760
2761     gst_structure_set_value (structure, field_name, new_value);
2762     g_value_unset (&target);
2763     return TRUE;
2764   } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
2765     const GValue *list_value;
2766     int i, n;
2767     const GValue *best = NULL;
2768     gdouble target;
2769     gdouble cur_diff;
2770     gdouble best_diff = G_MAXDOUBLE;
2771
2772     target = (gdouble) target_numerator / (gdouble) target_denominator;
2773
2774     GST_DEBUG ("target %g, best %g", target, best_diff);
2775
2776     best = NULL;
2777
2778     n = gst_value_list_get_size (value);
2779     for (i = 0; i < n; i++) {
2780       list_value = gst_value_list_get_value (value, i);
2781       if (G_VALUE_TYPE (list_value) == GST_TYPE_FRACTION) {
2782         gint num, denom;
2783         gdouble list_double;
2784
2785         num = gst_value_get_fraction_numerator (list_value);
2786         denom = gst_value_get_fraction_denominator (list_value);
2787
2788         list_double = ((gdouble) num / (gdouble) denom);
2789         cur_diff = target - list_double;
2790
2791         GST_DEBUG ("curr diff %g, list %g", cur_diff, list_double);
2792
2793         if (cur_diff < 0)
2794           cur_diff = -cur_diff;
2795
2796         if (!best || cur_diff < best_diff) {
2797           GST_DEBUG ("new best %g", list_double);
2798           best = list_value;
2799           best_diff = cur_diff;
2800         }
2801       }
2802     }
2803     if (best != NULL) {
2804       gst_structure_set_value (structure, field_name, best);
2805       return TRUE;
2806     }
2807   }
2808
2809   return FALSE;
2810 }
2811
2812 static gboolean
2813 default_fixate (GQuark field_id, const GValue * value, gpointer data)
2814 {
2815   GstStructure *s = data;
2816   GValue v = { 0 };
2817
2818   if (gst_value_fixate (&v, value)) {
2819     gst_structure_id_take_value (s, field_id, &v);
2820   }
2821   return TRUE;
2822 }
2823
2824 /**
2825  * gst_structure_fixate_field:
2826  * @structure: a #GstStructure
2827  * @field_name: a field in @structure
2828  *
2829  * Fixates a #GstStructure by changing the given field with its fixated value.
2830  *
2831  * Returns: TRUE if the structure field could be fixated
2832  */
2833 gboolean
2834 gst_structure_fixate_field (GstStructure * structure, const char *field_name)
2835 {
2836   GstStructureField *field;
2837
2838   g_return_val_if_fail (structure != NULL, FALSE);
2839   g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2840
2841   if (!(field = gst_structure_get_field (structure, field_name)))
2842     return FALSE;
2843
2844   return default_fixate (field->name, &field->value, structure);
2845 }
2846
2847 /* our very own version of G_VALUE_LCOPY that allows NULL return locations
2848  * (useful for message parsing functions where the return location is user
2849  * supplied and the user may pass NULL if the value isn't of interest) */
2850 #define GST_VALUE_LCOPY(value, var_args, flags, __error, fieldname)           \
2851 G_STMT_START {                                                                \
2852   const GValue *_value = (value);                                             \
2853   guint _flags = (flags);                                                     \
2854   GType _value_type = G_VALUE_TYPE (_value);                                  \
2855   GTypeValueTable *_vtable = g_type_value_table_peek (_value_type);           \
2856   const gchar *_lcopy_format = _vtable->lcopy_format;                         \
2857   GTypeCValue _cvalues[G_VALUE_COLLECT_FORMAT_MAX_LENGTH] = { { 0, }, };      \
2858   guint _n_values = 0;                                                        \
2859                                                                               \
2860   while (*_lcopy_format != '\0') {                                            \
2861     g_assert (*_lcopy_format == G_VALUE_COLLECT_POINTER);                     \
2862     _cvalues[_n_values++].v_pointer = va_arg ((var_args), gpointer);          \
2863     _lcopy_format++;                                                          \
2864   }                                                                           \
2865   if (_n_values == 2 && !!_cvalues[0].v_pointer != !!_cvalues[1].v_pointer) { \
2866     *(__error) = g_strdup_printf ("either all or none of the return "         \
2867         "locations for field '%s' need to be NULL", fieldname);               \
2868   } else if (_cvalues[0].v_pointer != NULL) {                                 \
2869     *(__error) = _vtable->lcopy_value (_value, _n_values, _cvalues, _flags);  \
2870   }                                                                           \
2871 } G_STMT_END
2872
2873 /**
2874  * gst_structure_get_valist:
2875  * @structure: a #GstStructure
2876  * @first_fieldname: the name of the first field to read
2877  * @args: variable arguments
2878  *
2879  * Parses the variable arguments and reads fields from @structure accordingly.
2880  * valist-variant of gst_structure_get(). Look at the documentation of
2881  * gst_structure_get() for more details.
2882  *
2883  * Returns: TRUE, or FALSE if there was a problem reading any of the fields
2884  */
2885 gboolean
2886 gst_structure_get_valist (const GstStructure * structure,
2887     const char *first_fieldname, va_list args)
2888 {
2889   const char *field_name;
2890   GType expected_type = G_TYPE_INVALID;
2891
2892   g_return_val_if_fail (GST_IS_STRUCTURE (structure), FALSE);
2893   g_return_val_if_fail (first_fieldname != NULL, FALSE);
2894
2895   field_name = first_fieldname;
2896   while (field_name) {
2897     const GValue *val = NULL;
2898     gchar *err = NULL;
2899
2900     expected_type = va_arg (args, GType);
2901
2902     val = gst_structure_get_value (structure, field_name);
2903
2904     if (val == NULL)
2905       goto no_such_field;
2906
2907     if (G_VALUE_TYPE (val) != expected_type)
2908       goto wrong_type;
2909
2910     GST_VALUE_LCOPY (val, args, 0, &err, field_name);
2911     if (err) {
2912       g_warning ("%s: %s", G_STRFUNC, err);
2913       g_free (err);
2914       return FALSE;
2915     }
2916
2917     field_name = va_arg (args, const gchar *);
2918   }
2919
2920   return TRUE;
2921
2922 /* ERRORS */
2923 no_such_field:
2924   {
2925     GST_INFO ("Expected field '%s' in structure: %" GST_PTR_FORMAT,
2926         field_name, structure);
2927     return FALSE;
2928   }
2929 wrong_type:
2930   {
2931     GST_INFO ("Expected field '%s' in structure to be of type '%s', but "
2932         "field was of type '%s': %" GST_PTR_FORMAT, field_name,
2933         GST_STR_NULL (g_type_name (expected_type)),
2934         G_VALUE_TYPE_NAME (gst_structure_get_value (structure, field_name)),
2935         structure);
2936     return FALSE;
2937   }
2938 }
2939
2940 /**
2941  * gst_structure_id_get_valist:
2942  * @structure: a #GstStructure
2943  * @first_field_id: the quark of the first field to read
2944  * @args: variable arguments
2945  *
2946  * Parses the variable arguments and reads fields from @structure accordingly.
2947  * valist-variant of gst_structure_id_get(). Look at the documentation of
2948  * gst_structure_id_get() for more details.
2949  *
2950  * Returns: TRUE, or FALSE if there was a problem reading any of the fields
2951  */
2952 gboolean
2953 gst_structure_id_get_valist (const GstStructure * structure,
2954     GQuark first_field_id, va_list args)
2955 {
2956   GQuark field_id;
2957   GType expected_type = G_TYPE_INVALID;
2958
2959   g_return_val_if_fail (GST_IS_STRUCTURE (structure), FALSE);
2960   g_return_val_if_fail (first_field_id != 0, FALSE);
2961
2962   field_id = first_field_id;
2963   while (field_id) {
2964     const GValue *val = NULL;
2965     gchar *err = NULL;
2966
2967     expected_type = va_arg (args, GType);
2968
2969     val = gst_structure_id_get_value (structure, field_id);
2970
2971     if (val == NULL)
2972       goto no_such_field;
2973
2974     if (G_VALUE_TYPE (val) != expected_type)
2975       goto wrong_type;
2976
2977     GST_VALUE_LCOPY (val, args, 0, &err, g_quark_to_string (field_id));
2978     if (err) {
2979       g_warning ("%s: %s", G_STRFUNC, err);
2980       g_free (err);
2981       return FALSE;
2982     }
2983
2984     field_id = va_arg (args, GQuark);
2985   }
2986
2987   return TRUE;
2988
2989 /* ERRORS */
2990 no_such_field:
2991   {
2992     GST_DEBUG ("Expected field '%s' in structure: %" GST_PTR_FORMAT,
2993         GST_STR_NULL (g_quark_to_string (field_id)), structure);
2994     return FALSE;
2995   }
2996 wrong_type:
2997   {
2998     GST_DEBUG ("Expected field '%s' in structure to be of type '%s', but "
2999         "field was of type '%s': %" GST_PTR_FORMAT,
3000         g_quark_to_string (field_id),
3001         GST_STR_NULL (g_type_name (expected_type)),
3002         G_VALUE_TYPE_NAME (gst_structure_id_get_value (structure, field_id)),
3003         structure);
3004     return FALSE;
3005   }
3006 }
3007
3008 /**
3009  * gst_structure_get:
3010  * @structure: a #GstStructure
3011  * @first_fieldname: the name of the first field to read
3012  * @...: variable arguments
3013  *
3014  * Parses the variable arguments and reads fields from @structure accordingly.
3015  * Variable arguments should be in the form field name, field type
3016  * (as a GType), pointer(s) to a variable(s) to hold the return value(s).
3017  * The last variable argument should be NULL.
3018  *
3019  * For refcounted (mini)objects you will receive a new reference which
3020  * you must release with a suitable _unref() when no longer needed. For
3021  * strings and boxed types you will receive a copy which you will need to
3022  * release with either g_free() or the suitable function for the boxed type.
3023  *
3024  * Returns: FALSE if there was a problem reading any of the fields (e.g.
3025  *     because the field requested did not exist, or was of a type other
3026  *     than the type specified), otherwise TRUE.
3027  */
3028 gboolean
3029 gst_structure_get (const GstStructure * structure, const char *first_fieldname,
3030     ...)
3031 {
3032   gboolean ret;
3033   va_list args;
3034
3035   g_return_val_if_fail (GST_IS_STRUCTURE (structure), FALSE);
3036   g_return_val_if_fail (first_fieldname != NULL, FALSE);
3037
3038   va_start (args, first_fieldname);
3039   ret = gst_structure_get_valist (structure, first_fieldname, args);
3040   va_end (args);
3041
3042   return ret;
3043 }
3044
3045 /**
3046  * gst_structure_id_get:
3047  * @structure: a #GstStructure
3048  * @first_field_id: the quark of the first field to read
3049  * @...: variable arguments
3050  *
3051  * Parses the variable arguments and reads fields from @structure accordingly.
3052  * Variable arguments should be in the form field id quark, field type
3053  * (as a GType), pointer(s) to a variable(s) to hold the return value(s).
3054  * The last variable argument should be NULL (technically it should be a
3055  * 0 quark, but we require NULL so compilers that support it can check for
3056  * the NULL terminator and warn if it's not there).
3057  *
3058  * This function is just like gst_structure_get() only that it is slightly
3059  * more efficient since it saves the string-to-quark lookup in the global
3060  * quark hashtable.
3061  *
3062  * For refcounted (mini)objects you will receive a new reference which
3063  * you must release with a suitable _unref() when no longer needed. For
3064  * strings and boxed types you will receive a copy which you will need to
3065  * release with either g_free() or the suitable function for the boxed type.
3066  *
3067  * Returns: FALSE if there was a problem reading any of the fields (e.g.
3068  *     because the field requested did not exist, or was of a type other
3069  *     than the type specified), otherwise TRUE.
3070  */
3071 gboolean
3072 gst_structure_id_get (const GstStructure * structure, GQuark first_field_id,
3073     ...)
3074 {
3075   gboolean ret;
3076   va_list args;
3077
3078   g_return_val_if_fail (GST_IS_STRUCTURE (structure), FALSE);
3079   g_return_val_if_fail (first_field_id != 0, FALSE);
3080
3081   va_start (args, first_field_id);
3082   ret = gst_structure_id_get_valist (structure, first_field_id, args);
3083   va_end (args);
3084
3085   return ret;
3086 }
3087
3088 static gboolean
3089 gst_structure_is_equal_foreach (GQuark field_id, const GValue * val2,
3090     gpointer data)
3091 {
3092   const GstStructure *struct1 = (const GstStructure *) data;
3093   const GValue *val1 = gst_structure_id_get_value (struct1, field_id);
3094
3095   if (G_UNLIKELY (val1 == NULL))
3096     return FALSE;
3097   if (gst_value_compare (val1, val2) == GST_VALUE_EQUAL) {
3098     return TRUE;
3099   }
3100
3101   return FALSE;
3102 }
3103
3104 /**
3105  * gst_structure_is_equal:
3106  * @structure1: a #GstStructure.
3107  * @structure2: a #GstStructure.
3108  *
3109  * Tests if the two #GstStructure are equal.
3110  *
3111  * Returns: TRUE if the two structures have the same name and field.
3112  **/
3113 gboolean
3114 gst_structure_is_equal (const GstStructure * structure1,
3115     const GstStructure * structure2)
3116 {
3117   g_return_val_if_fail (GST_IS_STRUCTURE (structure1), FALSE);
3118   g_return_val_if_fail (GST_IS_STRUCTURE (structure2), FALSE);
3119
3120   if (G_UNLIKELY (structure1 == structure2))
3121     return TRUE;
3122
3123   if (structure1->name != structure2->name) {
3124     return FALSE;
3125   }
3126   if (GST_STRUCTURE_FIELDS (structure1)->len !=
3127       GST_STRUCTURE_FIELDS (structure2)->len) {
3128     return FALSE;
3129   }
3130
3131   return gst_structure_foreach (structure1, gst_structure_is_equal_foreach,
3132       (gpointer) structure2);
3133 }
3134
3135
3136 typedef struct
3137 {
3138   GstStructure *dest;
3139   const GstStructure *intersect;
3140 }
3141 IntersectData;
3142
3143 static gboolean
3144 gst_structure_intersect_field1 (GQuark id, const GValue * val1, gpointer data)
3145 {
3146   IntersectData *idata = (IntersectData *) data;
3147   const GValue *val2 = gst_structure_id_get_value (idata->intersect, id);
3148
3149   if (G_UNLIKELY (val2 == NULL)) {
3150     gst_structure_id_set_value (idata->dest, id, val1);
3151   } else {
3152     GValue dest_value = { 0 };
3153     if (gst_value_intersect (&dest_value, val1, val2)) {
3154       gst_structure_id_take_value (idata->dest, id, &dest_value);
3155     } else {
3156       return FALSE;
3157     }
3158   }
3159   return TRUE;
3160 }
3161
3162 static gboolean
3163 gst_structure_intersect_field2 (GQuark id, const GValue * val1, gpointer data)
3164 {
3165   IntersectData *idata = (IntersectData *) data;
3166   const GValue *val2 = gst_structure_id_get_value (idata->intersect, id);
3167
3168   if (G_UNLIKELY (val2 == NULL)) {
3169     gst_structure_id_set_value (idata->dest, id, val1);
3170   }
3171   return TRUE;
3172 }
3173
3174 /**
3175  * gst_structure_intersect:
3176  * @struct1: a #GstStructure
3177  * @struct2: a #GstStructure
3178  *
3179  * Intersects @struct1 and @struct2 and returns the intersection.
3180  *
3181  * Returns: Intersection of @struct1 and @struct2
3182  */
3183 GstStructure *
3184 gst_structure_intersect (const GstStructure * struct1,
3185     const GstStructure * struct2)
3186 {
3187   IntersectData data;
3188
3189   g_assert (struct1 != NULL);
3190   g_assert (struct2 != NULL);
3191
3192   if (G_UNLIKELY (struct1->name != struct2->name))
3193     return NULL;
3194
3195   /* copy fields from struct1 which we have not in struct2 to target
3196    * intersect if we have the field in both */
3197   data.dest = gst_structure_new_id_empty (struct1->name);
3198   data.intersect = struct2;
3199   if (G_UNLIKELY (!gst_structure_foreach ((GstStructure *) struct1,
3200               gst_structure_intersect_field1, &data)))
3201     goto error;
3202
3203   /* copy fields from struct2 which we have not in struct1 to target */
3204   data.intersect = struct1;
3205   if (G_UNLIKELY (!gst_structure_foreach ((GstStructure *) struct2,
3206               gst_structure_intersect_field2, &data)))
3207     goto error;
3208
3209   return data.dest;
3210
3211 error:
3212   gst_structure_free (data.dest);
3213   return NULL;
3214 }
3215
3216 static gboolean
3217 gst_caps_structure_can_intersect_field (GQuark id, const GValue * val1,
3218     gpointer data)
3219 {
3220   GstStructure *other = (GstStructure *) data;
3221   const GValue *val2 = gst_structure_id_get_value (other, id);
3222
3223   if (G_LIKELY (val2)) {
3224     if (!gst_value_can_intersect (val1, val2)) {
3225       return FALSE;
3226     } else {
3227       gint eq = gst_value_compare (val1, val2);
3228
3229       if (eq == GST_VALUE_UNORDERED) {
3230         /* we need to try interseting */
3231         if (!gst_value_intersect (NULL, val1, val2)) {
3232           return FALSE;
3233         }
3234       } else if (eq != GST_VALUE_EQUAL) {
3235         return FALSE;
3236       }
3237     }
3238   }
3239   return TRUE;
3240 }
3241
3242 /**
3243  * gst_structure_can_intersect:
3244  * @struct1: a #GstStructure
3245  * @struct2: a #GstStructure
3246  *
3247  * Tries intersecting @struct1 and @struct2 and reports whether the result
3248  * would not be empty.
3249  *
3250  * Returns: %TRUE if intersection would not be empty
3251  */
3252 gboolean
3253 gst_structure_can_intersect (const GstStructure * struct1,
3254     const GstStructure * struct2)
3255 {
3256   g_return_val_if_fail (GST_IS_STRUCTURE (struct1), FALSE);
3257   g_return_val_if_fail (GST_IS_STRUCTURE (struct2), FALSE);
3258
3259   if (G_UNLIKELY (struct1->name != struct2->name))
3260     return FALSE;
3261
3262   /* tries to intersect if we have the field in both */
3263   return gst_structure_foreach ((GstStructure *) struct1,
3264       gst_caps_structure_can_intersect_field, (gpointer) struct2);
3265 }
3266
3267 static gboolean
3268 gst_caps_structure_is_superset_field (GQuark field_id, const GValue * value,
3269     gpointer user_data)
3270 {
3271   GstStructure *subset = user_data;
3272   const GValue *other;
3273   int comparison;
3274
3275   if (!(other = gst_structure_id_get_value (subset, field_id)))
3276     /* field is missing in the subset => no subset */
3277     return FALSE;
3278
3279   comparison = gst_value_compare (value, other);
3280
3281   /* equal values are subset */
3282   if (comparison == GST_VALUE_EQUAL)
3283     return TRUE;
3284
3285   /* ordered, but unequal, values are not */
3286   if (comparison != GST_VALUE_UNORDERED)
3287     return FALSE;
3288
3289   return gst_value_is_subset (other, value);
3290 }
3291
3292 /**
3293  * gst_structure_is_subset:
3294  * @subset: a #GstStructure
3295  * @superset: a potentially greater #GstStructure
3296  *
3297  * Checks if @subset is a subset of @superset, i.e. has the same
3298  * structure name and for all fields that are existing in @superset,
3299  * @subset has a value that is a subset of the value in @superset.
3300  *
3301  * Returns: %TRUE if @subset is a subset of @superset
3302  */
3303 gboolean
3304 gst_structure_is_subset (const GstStructure * subset,
3305     const GstStructure * superset)
3306 {
3307   if ((superset->name != subset->name) ||
3308       (gst_structure_n_fields (superset) > gst_structure_n_fields (subset)))
3309     return FALSE;
3310
3311   return gst_structure_foreach ((GstStructure *) superset,
3312       gst_caps_structure_is_superset_field, (gpointer) subset);
3313 }
3314
3315
3316 /**
3317  * gst_structure_fixate:
3318  * @structure: a #GstStructure
3319  *
3320  * Fixate all values in @structure using gst_value_fixate().
3321  * @structure will be modified in-place and should be writable.
3322  */
3323 void
3324 gst_structure_fixate (GstStructure * structure)
3325 {
3326   g_return_if_fail (GST_IS_STRUCTURE (structure));
3327
3328   gst_structure_foreach (structure, default_fixate, structure);
3329 }