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_date:
1373  * @structure: a #GstStructure
1374  * @fieldname: the name of a field
1375  * @value: (out callee-allocates): a pointer to a #GDate to set
1376  *
1377  * Sets the date pointed to by @value corresponding to the date of the
1378  * given field.  Caller is responsible for making sure the field exists
1379  * and has the correct type.
1380  *
1381  * On success @value will point to a newly-allocated copy of the date which
1382  * should be freed with g_date_free() when no longer needed (note: this is
1383  * inconsistent with e.g. gst_structure_get_string() which doesn't return a
1384  * copy of the string).
1385  *
1386  * Returns: TRUE if the value could be set correctly. If there was no field
1387  * with @fieldname or the existing field did not contain a data, this function
1388  * returns FALSE.
1389  */
1390 gboolean
1391 gst_structure_get_date (const GstStructure * structure, const gchar * fieldname,
1392     GDate ** value)
1393 {
1394   GstStructureField *field;
1395
1396   g_return_val_if_fail (structure != NULL, FALSE);
1397   g_return_val_if_fail (fieldname != NULL, FALSE);
1398   g_return_val_if_fail (value != NULL, FALSE);
1399
1400   field = gst_structure_get_field (structure, fieldname);
1401
1402   if (field == NULL)
1403     return FALSE;
1404   if (!G_VALUE_HOLDS (&field->value, G_TYPE_DATE))
1405     return FALSE;
1406
1407   /* FIXME: 0.11 g_value_dup_boxed() -> g_value_get_boxed() */
1408   *value = g_value_dup_boxed (&field->value);
1409
1410   return TRUE;
1411 }
1412
1413 /**
1414  * gst_structure_get_date_time:
1415  * @structure: a #GstStructure
1416  * @fieldname: the name of a field
1417  * @value: (out callee-allocates): a pointer to a #GstDateTime to set
1418  *
1419  * Sets the datetime pointed to by @value corresponding to the datetime of the
1420  * given field. Caller is responsible for making sure the field exists
1421  * and has the correct type.
1422  *
1423  * On success @value will point to a reference of the datetime which
1424  * should be unreffed with gst_date_time_unref() when no longer needed
1425  * (note: this is inconsistent with e.g. gst_structure_get_string()
1426  * which doesn't return a copy of the string).
1427  *
1428  * Returns: TRUE if the value could be set correctly. If there was no field
1429  * with @fieldname or the existing field did not contain a data, this function
1430  * returns FALSE.
1431  */
1432 gboolean
1433 gst_structure_get_date_time (const GstStructure * structure,
1434     const gchar * fieldname, GstDateTime ** value)
1435 {
1436   GstStructureField *field;
1437
1438   g_return_val_if_fail (structure != NULL, FALSE);
1439   g_return_val_if_fail (fieldname != NULL, FALSE);
1440   g_return_val_if_fail (value != NULL, FALSE);
1441
1442   field = gst_structure_get_field (structure, fieldname);
1443
1444   if (field == NULL)
1445     return FALSE;
1446   if (!GST_VALUE_HOLDS_DATE_TIME (&field->value))
1447     return FALSE;
1448
1449   /* FIXME: 0.11 g_value_dup_boxed() -> g_value_get_boxed() */
1450   *value = g_value_dup_boxed (&field->value);
1451
1452   return TRUE;
1453 }
1454
1455 /**
1456  * gst_structure_get_clock_time:
1457  * @structure: a #GstStructure
1458  * @fieldname: the name of a field
1459  * @value: (out): a pointer to a #GstClockTime to set
1460  *
1461  * Sets the clock time pointed to by @value corresponding to the clock time
1462  * of the given field.  Caller is responsible for making sure the field exists
1463  * and has the correct type.
1464  *
1465  * Returns: TRUE if the value could be set correctly. If there was no field
1466  * with @fieldname or the existing field did not contain a #GstClockTime, this
1467  * function returns FALSE.
1468  */
1469 gboolean
1470 gst_structure_get_clock_time (const GstStructure * structure,
1471     const gchar * fieldname, GstClockTime * value)
1472 {
1473   GstStructureField *field;
1474
1475   g_return_val_if_fail (structure != NULL, FALSE);
1476   g_return_val_if_fail (fieldname != NULL, FALSE);
1477   g_return_val_if_fail (value != NULL, FALSE);
1478
1479   field = gst_structure_get_field (structure, fieldname);
1480
1481   if (field == NULL)
1482     return FALSE;
1483   if (!G_VALUE_HOLDS_UINT64 (&field->value))
1484     return FALSE;
1485
1486   *value = gst_g_value_get_uint64_unchecked (&field->value);
1487
1488   return TRUE;
1489 }
1490
1491 /**
1492  * gst_structure_get_double:
1493  * @structure: a #GstStructure
1494  * @fieldname: the name of a field
1495  * @value: (out): a pointer to a gdouble to set
1496  *
1497  * Sets the double pointed to by @value corresponding to the value of the
1498  * given field.  Caller is responsible for making sure the field exists
1499  * and has the correct type.
1500  *
1501  * Returns: TRUE if the value could be set correctly. If there was no field
1502  * with @fieldname or the existing field did not contain a double, this
1503  * function returns FALSE.
1504  */
1505 gboolean
1506 gst_structure_get_double (const GstStructure * structure,
1507     const gchar * fieldname, gdouble * value)
1508 {
1509   GstStructureField *field;
1510
1511   g_return_val_if_fail (structure != NULL, FALSE);
1512   g_return_val_if_fail (fieldname != NULL, FALSE);
1513   g_return_val_if_fail (value != NULL, FALSE);
1514
1515   field = gst_structure_get_field (structure, fieldname);
1516
1517   if (field == NULL)
1518     return FALSE;
1519   if (!G_VALUE_HOLDS_DOUBLE (&field->value))
1520     return FALSE;
1521
1522   *value = gst_g_value_get_double_unchecked (&field->value);
1523
1524   return TRUE;
1525 }
1526
1527 /**
1528  * gst_structure_get_string:
1529  * @structure: a #GstStructure
1530  * @fieldname: the name of a field
1531  *
1532  * Finds the field corresponding to @fieldname, and returns the string
1533  * contained in the field's value.  Caller is responsible for making
1534  * sure the field exists and has the correct type.
1535  *
1536  * The string should not be modified, and remains valid until the next
1537  * call to a gst_structure_*() function with the given structure.
1538  *
1539  * Returns: a pointer to the string or NULL when the field did not exist
1540  * or did not contain a string.
1541  */
1542 const gchar *
1543 gst_structure_get_string (const GstStructure * structure,
1544     const gchar * fieldname)
1545 {
1546   GstStructureField *field;
1547
1548   g_return_val_if_fail (structure != NULL, NULL);
1549   g_return_val_if_fail (fieldname != NULL, NULL);
1550
1551   field = gst_structure_get_field (structure, fieldname);
1552
1553   if (field == NULL)
1554     return NULL;
1555   if (!G_VALUE_HOLDS_STRING (&field->value))
1556     return NULL;
1557
1558   return gst_g_value_get_string_unchecked (&field->value);
1559 }
1560
1561 /**
1562  * gst_structure_get_enum:
1563  * @structure: a #GstStructure
1564  * @fieldname: the name of a field
1565  * @enumtype: the enum type of a field
1566  * @value: (out): a pointer to an int to set
1567  *
1568  * Sets the int pointed to by @value corresponding to the value of the
1569  * given field.  Caller is responsible for making sure the field exists,
1570  * has the correct type and that the enumtype is correct.
1571  *
1572  * Returns: TRUE if the value could be set correctly. If there was no field
1573  * with @fieldname or the existing field did not contain an enum of the given
1574  * type, this function returns FALSE.
1575  */
1576 gboolean
1577 gst_structure_get_enum (const GstStructure * structure,
1578     const gchar * fieldname, GType enumtype, gint * value)
1579 {
1580   GstStructureField *field;
1581
1582   g_return_val_if_fail (structure != NULL, FALSE);
1583   g_return_val_if_fail (fieldname != NULL, FALSE);
1584   g_return_val_if_fail (enumtype != G_TYPE_INVALID, FALSE);
1585   g_return_val_if_fail (value != NULL, FALSE);
1586
1587   field = gst_structure_get_field (structure, fieldname);
1588
1589   if (field == NULL)
1590     return FALSE;
1591   if (!G_TYPE_CHECK_VALUE_TYPE (&field->value, enumtype))
1592     return FALSE;
1593
1594   *value = g_value_get_enum (&field->value);
1595
1596   return TRUE;
1597 }
1598
1599 /**
1600  * gst_structure_get_fraction:
1601  * @structure: a #GstStructure
1602  * @fieldname: the name of a field
1603  * @value_numerator: (out): a pointer to an int to set
1604  * @value_denominator: (out): a pointer to an int to set
1605  *
1606  * Sets the integers pointed to by @value_numerator and @value_denominator
1607  * corresponding to the value of the given field.  Caller is responsible
1608  * for making sure the field exists and has the correct type.
1609  *
1610  * Returns: TRUE if the values could be set correctly. If there was no field
1611  * with @fieldname or the existing field did not contain a GstFraction, this
1612  * function returns FALSE.
1613  */
1614 gboolean
1615 gst_structure_get_fraction (const GstStructure * structure,
1616     const gchar * fieldname, gint * value_numerator, gint * value_denominator)
1617 {
1618   GstStructureField *field;
1619
1620   g_return_val_if_fail (structure != NULL, FALSE);
1621   g_return_val_if_fail (fieldname != NULL, FALSE);
1622   g_return_val_if_fail (value_numerator != NULL, FALSE);
1623   g_return_val_if_fail (value_denominator != NULL, FALSE);
1624
1625   field = gst_structure_get_field (structure, fieldname);
1626
1627   if (field == NULL)
1628     return FALSE;
1629   if (!GST_VALUE_HOLDS_FRACTION (&field->value))
1630     return FALSE;
1631
1632   *value_numerator = gst_value_get_fraction_numerator (&field->value);
1633   *value_denominator = gst_value_get_fraction_denominator (&field->value);
1634
1635   return TRUE;
1636 }
1637
1638 typedef struct _GstStructureAbbreviation
1639 {
1640   const gchar *type_name;
1641   GType type;
1642 }
1643 GstStructureAbbreviation;
1644
1645 /* return a copy of an array of GstStructureAbbreviation containing all the
1646  * known type_string, GType maps, including abbreviations for common types */
1647 static GstStructureAbbreviation *
1648 gst_structure_get_abbrs (gint * n_abbrs)
1649 {
1650   static GstStructureAbbreviation *abbrs = NULL;
1651   static volatile gsize num = 0;
1652
1653   if (g_once_init_enter (&num)) {
1654     /* dynamically generate the array */
1655     gsize _num;
1656     GstStructureAbbreviation dyn_abbrs[] = {
1657       {"int", G_TYPE_INT}
1658       ,
1659       {"i", G_TYPE_INT}
1660       ,
1661       {"uint", G_TYPE_UINT}
1662       ,
1663       {"u", G_TYPE_UINT}
1664       ,
1665       {"float", G_TYPE_FLOAT}
1666       ,
1667       {"f", G_TYPE_FLOAT}
1668       ,
1669       {"double", G_TYPE_DOUBLE}
1670       ,
1671       {"d", G_TYPE_DOUBLE}
1672       ,
1673       {"buffer", GST_TYPE_BUFFER}
1674       ,
1675       {"fraction", GST_TYPE_FRACTION}
1676       ,
1677       {"boolean", G_TYPE_BOOLEAN}
1678       ,
1679       {"bool", G_TYPE_BOOLEAN}
1680       ,
1681       {"b", G_TYPE_BOOLEAN}
1682       ,
1683       {"string", G_TYPE_STRING}
1684       ,
1685       {"str", G_TYPE_STRING}
1686       ,
1687       {"s", G_TYPE_STRING}
1688       ,
1689       {"structure", GST_TYPE_STRUCTURE}
1690       ,
1691       {"date", G_TYPE_DATE}
1692       ,
1693       {"datetime", GST_TYPE_DATE_TIME}
1694       ,
1695       {"bitmask", GST_TYPE_BITMASK}
1696       ,
1697       {"sample", GST_TYPE_SAMPLE}
1698       ,
1699       {"taglist", GST_TYPE_TAG_LIST}
1700     };
1701     _num = G_N_ELEMENTS (dyn_abbrs);
1702     /* permanently allocate and copy the array now */
1703     abbrs = g_new0 (GstStructureAbbreviation, _num);
1704     memcpy (abbrs, dyn_abbrs, sizeof (GstStructureAbbreviation) * _num);
1705     g_once_init_leave (&num, _num);
1706   }
1707   *n_abbrs = num;
1708
1709   return abbrs;
1710 }
1711
1712 /* given a type_name that could be a type abbreviation or a registered GType,
1713  * return a matching GType */
1714 static GType
1715 gst_structure_gtype_from_abbr (const char *type_name)
1716 {
1717   int i;
1718   GstStructureAbbreviation *abbrs;
1719   gint n_abbrs;
1720
1721   g_return_val_if_fail (type_name != NULL, G_TYPE_INVALID);
1722
1723   abbrs = gst_structure_get_abbrs (&n_abbrs);
1724
1725   for (i = 0; i < n_abbrs; i++) {
1726     if (strcmp (type_name, abbrs[i].type_name) == 0) {
1727       return abbrs[i].type;
1728     }
1729   }
1730
1731   /* this is the fallback */
1732   return g_type_from_name (type_name);
1733 }
1734
1735 static const char *
1736 gst_structure_to_abbr (GType type)
1737 {
1738   int i;
1739   GstStructureAbbreviation *abbrs;
1740   gint n_abbrs;
1741
1742   g_return_val_if_fail (type != G_TYPE_INVALID, NULL);
1743
1744   abbrs = gst_structure_get_abbrs (&n_abbrs);
1745
1746   for (i = 0; i < n_abbrs; i++) {
1747     if (type == abbrs[i].type) {
1748       return abbrs[i].type_name;
1749     }
1750   }
1751
1752   return g_type_name (type);
1753 }
1754
1755 static GType
1756 gst_structure_value_get_generic_type (GValue * val)
1757 {
1758   if (G_VALUE_TYPE (val) == GST_TYPE_LIST
1759       || G_VALUE_TYPE (val) == GST_TYPE_ARRAY) {
1760     GArray *array = g_value_peek_pointer (val);
1761
1762     if (array->len > 0) {
1763       GValue *value = &g_array_index (array, GValue, 0);
1764
1765       return gst_structure_value_get_generic_type (value);
1766     } else {
1767       return G_TYPE_INT;
1768     }
1769   } else if (G_VALUE_TYPE (val) == GST_TYPE_INT_RANGE) {
1770     return G_TYPE_INT;
1771   } else if (G_VALUE_TYPE (val) == GST_TYPE_INT64_RANGE) {
1772     return G_TYPE_INT64;
1773   } else if (G_VALUE_TYPE (val) == GST_TYPE_DOUBLE_RANGE) {
1774     return G_TYPE_DOUBLE;
1775   } else if (G_VALUE_TYPE (val) == GST_TYPE_FRACTION_RANGE) {
1776     return GST_TYPE_FRACTION;
1777   }
1778   return G_VALUE_TYPE (val);
1779 }
1780
1781 gboolean
1782 priv_gst_structure_append_to_gstring (const GstStructure * structure,
1783     GString * s)
1784 {
1785   GstStructureField *field;
1786   guint i, len;
1787
1788   g_return_val_if_fail (s != NULL, FALSE);
1789
1790   len = GST_STRUCTURE_FIELDS (structure)->len;
1791   for (i = 0; i < len; i++) {
1792     char *t;
1793     GType type;
1794
1795     field = GST_STRUCTURE_FIELD (structure, i);
1796
1797     t = gst_value_serialize (&field->value);
1798     type = gst_structure_value_get_generic_type (&field->value);
1799
1800     g_string_append_len (s, ", ", 2);
1801     /* FIXME: do we need to escape fieldnames? */
1802     g_string_append (s, g_quark_to_string (field->name));
1803     g_string_append_len (s, "=(", 2);
1804     g_string_append (s, gst_structure_to_abbr (type));
1805     g_string_append_c (s, ')');
1806     g_string_append (s, t == NULL ? "NULL" : t);
1807     g_free (t);
1808   }
1809
1810   g_string_append_c (s, ';');
1811   return TRUE;
1812 }
1813
1814 /**
1815  * gst_structure_to_string:
1816  * @structure: a #GstStructure
1817  *
1818  * Converts @structure to a human-readable string representation.
1819  *
1820  * For debugging purposes its easier to do something like this:
1821  * |[
1822  * GST_LOG ("structure is %" GST_PTR_FORMAT, structure);
1823  * ]|
1824  * This prints the structure in human readable form.
1825  *
1826  * The current implementation of serialization will lead to unexpected results
1827  * when there are nested #GstCaps / #GstStructure deeper than one level.
1828  *
1829  * Free-function: g_free
1830  *
1831  * Returns: (transfer full): a pointer to string allocated by g_malloc().
1832  *     g_free() after usage.
1833  */
1834 gchar *
1835 gst_structure_to_string (const GstStructure * structure)
1836 {
1837   GString *s;
1838
1839   /* NOTE:  This function is potentially called by the debug system,
1840    * so any calls to gst_log() (and GST_DEBUG(), GST_LOG(), etc.)
1841    * should be careful to avoid recursion.  This includes any functions
1842    * called by gst_structure_to_string.  In particular, calls should
1843    * not use the GST_PTR_FORMAT extension.  */
1844
1845   g_return_val_if_fail (structure != NULL, NULL);
1846
1847   /* we estimate a minimum size based on the number of fields in order to
1848    * avoid unnecessary reallocs within GString */
1849   s = g_string_sized_new (STRUCTURE_ESTIMATED_STRING_LEN (structure));
1850   g_string_append (s, g_quark_to_string (structure->name));
1851   priv_gst_structure_append_to_gstring (structure, s);
1852   return g_string_free (s, FALSE);
1853 }
1854
1855 /*
1856  * r will still point to the string. if end == next, the string will not be
1857  * null-terminated. In all other cases it will be.
1858  * end = pointer to char behind end of string, next = pointer to start of
1859  * unread data.
1860  * THIS FUNCTION MODIFIES THE STRING AND DETECTS INSIDE A NONTERMINATED STRING
1861  */
1862 static gboolean
1863 gst_structure_parse_string (gchar * s, gchar ** end, gchar ** next,
1864     gboolean unescape)
1865 {
1866   gchar *w;
1867
1868   if (*s == 0)
1869     return FALSE;
1870
1871   if (*s != '"') {
1872     int ret;
1873
1874     ret = gst_structure_parse_simple_string (s, end);
1875     *next = *end;
1876
1877     return ret;
1878   }
1879
1880   if (unescape) {
1881     w = s;
1882     s++;
1883     while (*s != '"') {
1884       if (G_UNLIKELY (*s == 0))
1885         return FALSE;
1886       if (G_UNLIKELY (*s == '\\'))
1887         s++;
1888       *w = *s;
1889       w++;
1890       s++;
1891     }
1892     s++;
1893   } else {
1894     /* Find the closing quotes */
1895     s++;
1896     while (*s != '"') {
1897       if (G_UNLIKELY (*s == 0))
1898         return FALSE;
1899       if (G_UNLIKELY (*s == '\\'))
1900         s++;
1901       s++;
1902     }
1903     s++;
1904     w = s;
1905   }
1906
1907   *end = w;
1908   *next = s;
1909
1910   return TRUE;
1911 }
1912
1913 static gboolean
1914 gst_structure_parse_range (gchar * s, gchar ** after, GValue * value,
1915     GType type)
1916 {
1917   GValue value1 = { 0 };
1918   GValue value2 = { 0 };
1919   GValue value3 = { 0 };
1920   GType range_type;
1921   gboolean ret, have_step = FALSE;
1922
1923   if (*s != '[')
1924     return FALSE;
1925   s++;
1926
1927   ret = gst_structure_parse_value (s, &s, &value1, type);
1928   if (ret == FALSE)
1929     return FALSE;
1930
1931   while (g_ascii_isspace (*s))
1932     s++;
1933
1934   if (*s != ',')
1935     return FALSE;
1936   s++;
1937
1938   while (g_ascii_isspace (*s))
1939     s++;
1940
1941   ret = gst_structure_parse_value (s, &s, &value2, type);
1942   if (ret == FALSE)
1943     return FALSE;
1944
1945   while (g_ascii_isspace (*s))
1946     s++;
1947
1948   /* optional step for int and int64 */
1949   if (G_VALUE_TYPE (&value1) == G_TYPE_INT
1950       || G_VALUE_TYPE (&value1) == G_TYPE_INT64) {
1951     if (*s == ',') {
1952       s++;
1953
1954       while (g_ascii_isspace (*s))
1955         s++;
1956
1957       ret = gst_structure_parse_value (s, &s, &value3, type);
1958       if (ret == FALSE)
1959         return FALSE;
1960
1961       while (g_ascii_isspace (*s))
1962         s++;
1963
1964       have_step = TRUE;
1965     }
1966   }
1967
1968   if (*s != ']')
1969     return FALSE;
1970   s++;
1971
1972   if (G_VALUE_TYPE (&value1) != G_VALUE_TYPE (&value2))
1973     return FALSE;
1974   if (have_step && G_VALUE_TYPE (&value1) != G_VALUE_TYPE (&value3))
1975     return FALSE;
1976
1977   if (G_VALUE_TYPE (&value1) == G_TYPE_DOUBLE) {
1978     range_type = GST_TYPE_DOUBLE_RANGE;
1979     g_value_init (value, range_type);
1980     gst_value_set_double_range (value,
1981         gst_g_value_get_double_unchecked (&value1),
1982         gst_g_value_get_double_unchecked (&value2));
1983   } else if (G_VALUE_TYPE (&value1) == G_TYPE_INT) {
1984     range_type = GST_TYPE_INT_RANGE;
1985     g_value_init (value, range_type);
1986     if (have_step)
1987       gst_value_set_int_range_step (value,
1988           gst_g_value_get_int_unchecked (&value1),
1989           gst_g_value_get_int_unchecked (&value2),
1990           gst_g_value_get_int_unchecked (&value3));
1991     else
1992       gst_value_set_int_range (value, gst_g_value_get_int_unchecked (&value1),
1993           gst_g_value_get_int_unchecked (&value2));
1994   } else if (G_VALUE_TYPE (&value1) == G_TYPE_INT64) {
1995     range_type = GST_TYPE_INT64_RANGE;
1996     g_value_init (value, range_type);
1997     if (have_step)
1998       gst_value_set_int64_range_step (value,
1999           gst_g_value_get_int64_unchecked (&value1),
2000           gst_g_value_get_int64_unchecked (&value2),
2001           gst_g_value_get_int64_unchecked (&value3));
2002     else
2003       gst_value_set_int64_range (value,
2004           gst_g_value_get_int64_unchecked (&value1),
2005           gst_g_value_get_int64_unchecked (&value2));
2006   } else if (G_VALUE_TYPE (&value1) == GST_TYPE_FRACTION) {
2007     range_type = GST_TYPE_FRACTION_RANGE;
2008     g_value_init (value, range_type);
2009     gst_value_set_fraction_range (value, &value1, &value2);
2010   } else {
2011     return FALSE;
2012   }
2013
2014   *after = s;
2015   return TRUE;
2016 }
2017
2018 static gboolean
2019 gst_structure_parse_any_list (gchar * s, gchar ** after, GValue * value,
2020     GType type, GType list_type, char begin, char end)
2021 {
2022   GValue list_value = { 0 };
2023   gboolean ret;
2024   GArray *array;
2025
2026   g_value_init (value, list_type);
2027   array = g_value_peek_pointer (value);
2028
2029   if (*s != begin)
2030     return FALSE;
2031   s++;
2032
2033   while (g_ascii_isspace (*s))
2034     s++;
2035   if (*s == end) {
2036     s++;
2037     *after = s;
2038     return TRUE;
2039   }
2040
2041   ret = gst_structure_parse_value (s, &s, &list_value, type);
2042   if (ret == FALSE)
2043     return FALSE;
2044
2045   g_array_append_val (array, list_value);
2046
2047   while (g_ascii_isspace (*s))
2048     s++;
2049
2050   while (*s != end) {
2051     if (*s != ',')
2052       return FALSE;
2053     s++;
2054
2055     while (g_ascii_isspace (*s))
2056       s++;
2057
2058     memset (&list_value, 0, sizeof (list_value));
2059     ret = gst_structure_parse_value (s, &s, &list_value, type);
2060     if (ret == FALSE)
2061       return FALSE;
2062
2063     g_array_append_val (array, list_value);
2064     while (g_ascii_isspace (*s))
2065       s++;
2066   }
2067
2068   s++;
2069
2070   *after = s;
2071   return TRUE;
2072 }
2073
2074 static gboolean
2075 gst_structure_parse_list (gchar * s, gchar ** after, GValue * value, GType type)
2076 {
2077   return gst_structure_parse_any_list (s, after, value, type, GST_TYPE_LIST,
2078       '{', '}');
2079 }
2080
2081 static gboolean
2082 gst_structure_parse_array (gchar * s, gchar ** after, GValue * value,
2083     GType type)
2084 {
2085   return gst_structure_parse_any_list (s, after, value, type,
2086       GST_TYPE_ARRAY, '<', '>');
2087 }
2088
2089 static gboolean
2090 gst_structure_parse_simple_string (gchar * str, gchar ** end)
2091 {
2092   char *s = str;
2093
2094   while (G_LIKELY (GST_ASCII_IS_STRING (*s))) {
2095     s++;
2096   }
2097
2098   *end = s;
2099
2100   return (s != str);
2101 }
2102
2103 static gboolean
2104 gst_structure_parse_field (gchar * str,
2105     gchar ** after, GstStructureField * field)
2106 {
2107   gchar *name;
2108   gchar *name_end;
2109   gchar *s;
2110   gchar c;
2111
2112   s = str;
2113
2114   while (g_ascii_isspace (*s) || (s[0] == '\\' && g_ascii_isspace (s[1])))
2115     s++;
2116   name = s;
2117   if (G_UNLIKELY (!gst_structure_parse_simple_string (s, &name_end))) {
2118     GST_WARNING ("failed to parse simple string, str=%s", str);
2119     return FALSE;
2120   }
2121
2122   s = name_end;
2123   while (g_ascii_isspace (*s) || (s[0] == '\\' && g_ascii_isspace (s[1])))
2124     s++;
2125
2126   if (G_UNLIKELY (*s != '=')) {
2127     GST_WARNING ("missing assignment operator in the field, str=%s", str);
2128     return FALSE;
2129   }
2130   s++;
2131
2132   c = *name_end;
2133   *name_end = '\0';
2134   field->name = g_quark_from_string (name);
2135   GST_DEBUG ("trying field name '%s'", name);
2136   *name_end = c;
2137
2138   if (G_UNLIKELY (!gst_structure_parse_value (s, &s, &field->value,
2139               G_TYPE_INVALID))) {
2140     GST_WARNING ("failed to parse value %s", str);
2141     return FALSE;
2142   }
2143
2144   *after = s;
2145   return TRUE;
2146 }
2147
2148 static gboolean
2149 gst_structure_parse_value (gchar * str,
2150     gchar ** after, GValue * value, GType default_type)
2151 {
2152   gchar *type_name;
2153   gchar *type_end;
2154   gchar *value_s;
2155   gchar *value_end;
2156   gchar *s;
2157   gchar c;
2158   int ret = 0;
2159   GType type = default_type;
2160
2161   s = str;
2162   while (g_ascii_isspace (*s))
2163     s++;
2164
2165   /* check if there's a (type_name) 'cast' */
2166   type_name = NULL;
2167   if (*s == '(') {
2168     s++;
2169     while (g_ascii_isspace (*s))
2170       s++;
2171     type_name = s;
2172     if (G_UNLIKELY (!gst_structure_parse_simple_string (s, &type_end)))
2173       return FALSE;
2174     s = type_end;
2175     while (g_ascii_isspace (*s))
2176       s++;
2177     if (G_UNLIKELY (*s != ')'))
2178       return FALSE;
2179     s++;
2180     while (g_ascii_isspace (*s))
2181       s++;
2182
2183     c = *type_end;
2184     *type_end = 0;
2185     type = gst_structure_gtype_from_abbr (type_name);
2186     GST_DEBUG ("trying type name '%s'", type_name);
2187     *type_end = c;
2188
2189     if (G_UNLIKELY (type == G_TYPE_INVALID)) {
2190       GST_WARNING ("invalid type");
2191       return FALSE;
2192     }
2193   }
2194
2195   while (g_ascii_isspace (*s))
2196     s++;
2197   if (*s == '[') {
2198     ret = gst_structure_parse_range (s, &s, value, type);
2199   } else if (*s == '{') {
2200     ret = gst_structure_parse_list (s, &s, value, type);
2201   } else if (*s == '<') {
2202     ret = gst_structure_parse_array (s, &s, value, type);
2203   } else {
2204     value_s = s;
2205
2206     if (G_UNLIKELY (type == G_TYPE_INVALID)) {
2207       GType try_types[] =
2208           { G_TYPE_INT, G_TYPE_DOUBLE, GST_TYPE_FRACTION, G_TYPE_BOOLEAN,
2209         G_TYPE_STRING
2210       };
2211       int i;
2212
2213       if (G_UNLIKELY (!gst_structure_parse_string (s, &value_end, &s, TRUE)))
2214         return FALSE;
2215       /* Set NULL terminator for deserialization */
2216       c = *value_end;
2217       *value_end = '\0';
2218
2219       for (i = 0; i < G_N_ELEMENTS (try_types); i++) {
2220         g_value_init (value, try_types[i]);
2221         ret = gst_value_deserialize (value, value_s);
2222         if (ret)
2223           break;
2224         g_value_unset (value);
2225       }
2226     } else {
2227       g_value_init (value, type);
2228
2229       if (G_UNLIKELY (!gst_structure_parse_string (s, &value_end, &s,
2230                   (type != G_TYPE_STRING))))
2231         return FALSE;
2232       /* Set NULL terminator for deserialization */
2233       c = *value_end;
2234       *value_end = '\0';
2235
2236       ret = gst_value_deserialize (value, value_s);
2237       if (G_UNLIKELY (!ret))
2238         g_value_unset (value);
2239     }
2240     *value_end = c;
2241   }
2242
2243   *after = s;
2244
2245   return ret;
2246 }
2247
2248 gboolean
2249 priv_gst_structure_parse_name (gchar * str, gchar ** start, gchar ** end,
2250     gchar ** next)
2251 {
2252   char *w;
2253   char *r;
2254
2255   r = str;
2256
2257   /* skip spaces (FIXME: _isspace treats tabs and newlines as space!) */
2258   while (*r && (g_ascii_isspace (*r) || (r[0] == '\\'
2259               && g_ascii_isspace (r[1]))))
2260     r++;
2261
2262   *start = r;
2263
2264   if (G_UNLIKELY (!gst_structure_parse_string (r, &w, &r, TRUE))) {
2265     GST_WARNING ("Failed to parse structure string '%s'", str);
2266     return FALSE;
2267   }
2268
2269   *end = w;
2270   *next = r;
2271
2272   return TRUE;
2273 }
2274
2275 gboolean
2276 priv_gst_structure_parse_fields (gchar * str, gchar ** end,
2277     GstStructure * structure)
2278 {
2279   gchar *r;
2280   GstStructureField field;
2281
2282   r = str;
2283
2284   do {
2285     while (*r && (g_ascii_isspace (*r) || (r[0] == '\\'
2286                 && g_ascii_isspace (r[1]))))
2287       r++;
2288     if (*r == ';') {
2289       /* end of structure, get the next char and finish */
2290       r++;
2291       break;
2292     }
2293     if (*r == '\0') {
2294       /* accept \0 as end delimiter */
2295       break;
2296     }
2297     if (G_UNLIKELY (*r != ',')) {
2298       GST_WARNING ("Failed to find delimiter, r=%s", r);
2299       return FALSE;
2300     }
2301     r++;
2302     while (*r && (g_ascii_isspace (*r) || (r[0] == '\\'
2303                 && g_ascii_isspace (r[1]))))
2304       r++;
2305
2306     memset (&field, 0, sizeof (field));
2307     if (G_UNLIKELY (!gst_structure_parse_field (r, &r, &field))) {
2308       GST_WARNING ("Failed to parse field, r=%s", r);
2309       return FALSE;
2310     }
2311     gst_structure_set_field (structure, &field);
2312   } while (TRUE);
2313
2314   *end = r;
2315
2316   return TRUE;
2317 }
2318
2319 /**
2320  * gst_structure_new_from_string:
2321  * @string: a string representation of a #GstStructure
2322  *
2323  * Creates a #GstStructure from a string representation.
2324  * If end is not NULL, a pointer to the place inside the given string
2325  * where parsing ended will be returned.
2326  *
2327  * The current implementation of serialization will lead to unexpected results
2328  * when there are nested #GstCaps / #GstStructure deeper than one level.
2329  *
2330  * Free-function: gst_structure_free
2331  *
2332  * Returns: (transfer full): a new #GstStructure or NULL when the string could
2333  *     not be parsed. Free with gst_structure_free() after use.
2334  *
2335  * Since: 1.2
2336  */
2337 GstStructure *
2338 gst_structure_new_from_string (const gchar * string)
2339 {
2340   return gst_structure_from_string (string, NULL);
2341 }
2342
2343 /**
2344  * gst_structure_from_string:
2345  * @string: a string representation of a #GstStructure.
2346  * @end: (out) (allow-none) (transfer none) (skip): pointer to store the end of the string in.
2347  *
2348  * Creates a #GstStructure from a string representation.
2349  * If end is not NULL, a pointer to the place inside the given string
2350  * where parsing ended will be returned.
2351  *
2352  * Free-function: gst_structure_free
2353  *
2354  * Returns: (transfer full): a new #GstStructure or NULL when the string could
2355  *     not be parsed. Free with gst_structure_free() after use.
2356  */
2357 GstStructure *
2358 gst_structure_from_string (const gchar * string, gchar ** end)
2359 {
2360   char *name;
2361   char *copy;
2362   char *w;
2363   char *r;
2364   char save;
2365   GstStructure *structure = NULL;
2366
2367   g_return_val_if_fail (string != NULL, NULL);
2368
2369   copy = g_strdup (string);
2370   r = copy;
2371
2372   if (!priv_gst_structure_parse_name (r, &name, &w, &r))
2373     goto error;
2374
2375   save = *w;
2376   *w = '\0';
2377   structure = gst_structure_new_empty (name);
2378   *w = save;
2379
2380   if (G_UNLIKELY (structure == NULL))
2381     goto error;
2382
2383   if (!priv_gst_structure_parse_fields (r, &r, structure))
2384     goto error;
2385
2386   if (end)
2387     *end = (char *) string + (r - copy);
2388   else if (*r)
2389     g_warning ("gst_structure_from_string did not consume whole string,"
2390         " but caller did not provide end pointer (\"%s\")", string);
2391
2392   g_free (copy);
2393   return structure;
2394
2395 error:
2396   if (structure)
2397     gst_structure_free (structure);
2398   g_free (copy);
2399   return NULL;
2400 }
2401
2402 static void
2403 gst_structure_transform_to_string (const GValue * src_value,
2404     GValue * dest_value)
2405 {
2406   g_return_if_fail (src_value != NULL);
2407   g_return_if_fail (dest_value != NULL);
2408
2409   dest_value->data[0].v_pointer =
2410       gst_structure_to_string (src_value->data[0].v_pointer);
2411 }
2412
2413 static GstStructure *
2414 gst_structure_copy_conditional (const GstStructure * structure)
2415 {
2416   if (structure)
2417     return gst_structure_copy (structure);
2418   return NULL;
2419 }
2420
2421 /* fixate utility functions */
2422
2423 /**
2424  * gst_structure_fixate_field_nearest_int:
2425  * @structure: a #GstStructure
2426  * @field_name: a field in @structure
2427  * @target: the target value of the fixation
2428  *
2429  * Fixates a #GstStructure by changing the given field to the nearest
2430  * integer to @target that is a subset of the existing field.
2431  *
2432  * Returns: TRUE if the structure could be fixated
2433  */
2434 gboolean
2435 gst_structure_fixate_field_nearest_int (GstStructure * structure,
2436     const char *field_name, int target)
2437 {
2438   const GValue *value;
2439
2440   g_return_val_if_fail (gst_structure_has_field (structure, field_name), FALSE);
2441   g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2442
2443   value = gst_structure_get_value (structure, field_name);
2444
2445   if (G_VALUE_TYPE (value) == G_TYPE_INT) {
2446     /* already fixed */
2447     return FALSE;
2448   } else if (G_VALUE_TYPE (value) == GST_TYPE_INT_RANGE) {
2449     int x;
2450
2451     x = gst_value_get_int_range_min (value);
2452     if (target < x)
2453       target = x;
2454     x = gst_value_get_int_range_max (value);
2455     if (target > x)
2456       target = x;
2457     gst_structure_set (structure, field_name, G_TYPE_INT, target, NULL);
2458     return TRUE;
2459   } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
2460     const GValue *list_value;
2461     int i, n;
2462     int best = 0;
2463     int best_index = -1;
2464
2465     n = gst_value_list_get_size (value);
2466     for (i = 0; i < n; i++) {
2467       list_value = gst_value_list_get_value (value, i);
2468       if (G_VALUE_TYPE (list_value) == G_TYPE_INT) {
2469         int x = gst_g_value_get_int_unchecked (list_value);
2470
2471         if (best_index == -1 || (ABS (target - x) < ABS (target - best))) {
2472           best_index = i;
2473           best = x;
2474         }
2475       }
2476     }
2477     if (best_index != -1) {
2478       gst_structure_set (structure, field_name, G_TYPE_INT, best, NULL);
2479       return TRUE;
2480     }
2481     return FALSE;
2482   }
2483
2484   return FALSE;
2485 }
2486
2487 /**
2488  * gst_structure_fixate_field_nearest_double:
2489  * @structure: a #GstStructure
2490  * @field_name: a field in @structure
2491  * @target: the target value of the fixation
2492  *
2493  * Fixates a #GstStructure by changing the given field to the nearest
2494  * double to @target that is a subset of the existing field.
2495  *
2496  * Returns: TRUE if the structure could be fixated
2497  */
2498 gboolean
2499 gst_structure_fixate_field_nearest_double (GstStructure * structure,
2500     const char *field_name, double target)
2501 {
2502   const GValue *value;
2503
2504   g_return_val_if_fail (gst_structure_has_field (structure, field_name), FALSE);
2505   g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2506
2507   value = gst_structure_get_value (structure, field_name);
2508
2509   if (G_VALUE_TYPE (value) == G_TYPE_DOUBLE) {
2510     /* already fixed */
2511     return FALSE;
2512   } else if (G_VALUE_TYPE (value) == GST_TYPE_DOUBLE_RANGE) {
2513     double x;
2514
2515     x = gst_value_get_double_range_min (value);
2516     if (target < x)
2517       target = x;
2518     x = gst_value_get_double_range_max (value);
2519     if (target > x)
2520       target = x;
2521     gst_structure_set (structure, field_name, G_TYPE_DOUBLE, target, NULL);
2522     return TRUE;
2523   } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
2524     const GValue *list_value;
2525     int i, n;
2526     double best = 0;
2527     int best_index = -1;
2528
2529     n = gst_value_list_get_size (value);
2530     for (i = 0; i < n; i++) {
2531       list_value = gst_value_list_get_value (value, i);
2532       if (G_VALUE_TYPE (list_value) == G_TYPE_DOUBLE) {
2533         double x = gst_g_value_get_double_unchecked (list_value);
2534
2535         if (best_index == -1 || (ABS (target - x) < ABS (target - best))) {
2536           best_index = i;
2537           best = x;
2538         }
2539       }
2540     }
2541     if (best_index != -1) {
2542       gst_structure_set (structure, field_name, G_TYPE_DOUBLE, best, NULL);
2543       return TRUE;
2544     }
2545     return FALSE;
2546   }
2547
2548   return FALSE;
2549
2550 }
2551
2552 /**
2553  * gst_structure_fixate_field_boolean:
2554  * @structure: a #GstStructure
2555  * @field_name: a field in @structure
2556  * @target: the target value of the fixation
2557  *
2558  * Fixates a #GstStructure by changing the given @field_name field to the given
2559  * @target boolean if that field is not fixed yet.
2560  *
2561  * Returns: TRUE if the structure could be fixated
2562  */
2563 gboolean
2564 gst_structure_fixate_field_boolean (GstStructure * structure,
2565     const char *field_name, gboolean target)
2566 {
2567   const GValue *value;
2568
2569   g_return_val_if_fail (gst_structure_has_field (structure, field_name), FALSE);
2570   g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2571
2572   value = gst_structure_get_value (structure, field_name);
2573
2574   if (G_VALUE_TYPE (value) == G_TYPE_BOOLEAN) {
2575     /* already fixed */
2576     return FALSE;
2577   } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
2578     const GValue *list_value;
2579     int i, n;
2580     int best = 0;
2581     int best_index = -1;
2582
2583     n = gst_value_list_get_size (value);
2584     for (i = 0; i < n; i++) {
2585       list_value = gst_value_list_get_value (value, i);
2586       if (G_VALUE_TYPE (list_value) == G_TYPE_BOOLEAN) {
2587         gboolean x = gst_g_value_get_boolean_unchecked (list_value);
2588
2589         if (best_index == -1 || x == target) {
2590           best_index = i;
2591           best = x;
2592         }
2593       }
2594     }
2595     if (best_index != -1) {
2596       gst_structure_set (structure, field_name, G_TYPE_BOOLEAN, best, NULL);
2597       return TRUE;
2598     }
2599     return FALSE;
2600   }
2601
2602   return FALSE;
2603 }
2604
2605 /**
2606  * gst_structure_fixate_field_string:
2607  * @structure: a #GstStructure
2608  * @field_name: a field in @structure
2609  * @target: the target value of the fixation
2610  *
2611  * Fixates a #GstStructure by changing the given @field_name field to the given
2612  * @target string if that field is not fixed yet.
2613  *
2614  * Returns: TRUE if the structure could be fixated
2615  */
2616 gboolean
2617 gst_structure_fixate_field_string (GstStructure * structure,
2618     const gchar * field_name, const gchar * target)
2619 {
2620   const GValue *value;
2621
2622   g_return_val_if_fail (gst_structure_has_field (structure, field_name), FALSE);
2623   g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2624
2625   value = gst_structure_get_value (structure, field_name);
2626
2627   if (G_VALUE_TYPE (value) == G_TYPE_STRING) {
2628     /* already fixed */
2629     return FALSE;
2630   } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
2631     const GValue *list_value;
2632     int i, n;
2633     const gchar *best = NULL;
2634     int best_index = -1;
2635
2636     n = gst_value_list_get_size (value);
2637     for (i = 0; i < n; i++) {
2638       list_value = gst_value_list_get_value (value, i);
2639       if (G_VALUE_TYPE (list_value) == G_TYPE_STRING) {
2640         const gchar *x = g_value_get_string (list_value);
2641
2642         if (best_index == -1 || g_str_equal (x, target)) {
2643           best_index = i;
2644           best = x;
2645         }
2646       }
2647     }
2648     if (best_index != -1) {
2649       gst_structure_set (structure, field_name, G_TYPE_STRING, best, NULL);
2650       return TRUE;
2651     }
2652     return FALSE;
2653   }
2654
2655   return FALSE;
2656 }
2657
2658 /**
2659  * gst_structure_fixate_field_nearest_fraction:
2660  * @structure: a #GstStructure
2661  * @field_name: a field in @structure
2662  * @target_numerator: The numerator of the target value of the fixation
2663  * @target_denominator: The denominator of the target value of the fixation
2664  *
2665  * Fixates a #GstStructure by changing the given field to the nearest
2666  * fraction to @target_numerator/@target_denominator that is a subset
2667  * of the existing field.
2668  *
2669  * Returns: TRUE if the structure could be fixated
2670  */
2671 gboolean
2672 gst_structure_fixate_field_nearest_fraction (GstStructure * structure,
2673     const char *field_name, const gint target_numerator,
2674     const gint target_denominator)
2675 {
2676   const GValue *value;
2677
2678   g_return_val_if_fail (gst_structure_has_field (structure, field_name), FALSE);
2679   g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2680
2681   value = gst_structure_get_value (structure, field_name);
2682
2683   if (G_VALUE_TYPE (value) == GST_TYPE_FRACTION) {
2684     /* already fixed */
2685     return FALSE;
2686   } else if (G_VALUE_TYPE (value) == GST_TYPE_FRACTION_RANGE) {
2687     const GValue *x, *new_value;
2688     GValue target = { 0 };
2689     g_value_init (&target, GST_TYPE_FRACTION);
2690     gst_value_set_fraction (&target, target_numerator, target_denominator);
2691
2692     new_value = &target;
2693     x = gst_value_get_fraction_range_min (value);
2694     if (gst_value_compare (&target, x) == GST_VALUE_LESS_THAN)
2695       new_value = x;
2696     x = gst_value_get_fraction_range_max (value);
2697     if (gst_value_compare (&target, x) == GST_VALUE_GREATER_THAN)
2698       new_value = x;
2699
2700     gst_structure_set_value (structure, field_name, new_value);
2701     g_value_unset (&target);
2702     return TRUE;
2703   } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
2704     const GValue *list_value;
2705     int i, n;
2706     const GValue *best = NULL;
2707     gdouble target;
2708     gdouble cur_diff;
2709     gdouble best_diff = G_MAXDOUBLE;
2710
2711     target = (gdouble) target_numerator / (gdouble) target_denominator;
2712
2713     GST_DEBUG ("target %g, best %g", target, best_diff);
2714
2715     best = NULL;
2716
2717     n = gst_value_list_get_size (value);
2718     for (i = 0; i < n; i++) {
2719       list_value = gst_value_list_get_value (value, i);
2720       if (G_VALUE_TYPE (list_value) == GST_TYPE_FRACTION) {
2721         gint num, denom;
2722         gdouble list_double;
2723
2724         num = gst_value_get_fraction_numerator (list_value);
2725         denom = gst_value_get_fraction_denominator (list_value);
2726
2727         list_double = ((gdouble) num / (gdouble) denom);
2728         cur_diff = target - list_double;
2729
2730         GST_DEBUG ("curr diff %g, list %g", cur_diff, list_double);
2731
2732         if (cur_diff < 0)
2733           cur_diff = -cur_diff;
2734
2735         if (!best || cur_diff < best_diff) {
2736           GST_DEBUG ("new best %g", list_double);
2737           best = list_value;
2738           best_diff = cur_diff;
2739         }
2740       }
2741     }
2742     if (best != NULL) {
2743       gst_structure_set_value (structure, field_name, best);
2744       return TRUE;
2745     }
2746   }
2747
2748   return FALSE;
2749 }
2750
2751 static gboolean
2752 default_fixate (GQuark field_id, const GValue * value, gpointer data)
2753 {
2754   GstStructure *s = data;
2755   GValue v = { 0 };
2756
2757   if (gst_value_fixate (&v, value)) {
2758     gst_structure_id_take_value (s, field_id, &v);
2759   }
2760   return TRUE;
2761 }
2762
2763 /**
2764  * gst_structure_fixate_field:
2765  * @structure: a #GstStructure
2766  * @field_name: a field in @structure
2767  *
2768  * Fixates a #GstStructure by changing the given field with its fixated value.
2769  *
2770  * Returns: TRUE if the structure field could be fixated
2771  */
2772 gboolean
2773 gst_structure_fixate_field (GstStructure * structure, const char *field_name)
2774 {
2775   GstStructureField *field;
2776
2777   g_return_val_if_fail (structure != NULL, FALSE);
2778   g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2779
2780   if (!(field = gst_structure_get_field (structure, field_name)))
2781     return FALSE;
2782
2783   return default_fixate (field->name, &field->value, structure);
2784 }
2785
2786 /* our very own version of G_VALUE_LCOPY that allows NULL return locations
2787  * (useful for message parsing functions where the return location is user
2788  * supplied and the user may pass NULL if the value isn't of interest) */
2789 #define GST_VALUE_LCOPY(value, var_args, flags, __error, fieldname)           \
2790 G_STMT_START {                                                                \
2791   const GValue *_value = (value);                                             \
2792   guint _flags = (flags);                                                     \
2793   GType _value_type = G_VALUE_TYPE (_value);                                  \
2794   GTypeValueTable *_vtable = g_type_value_table_peek (_value_type);           \
2795   const gchar *_lcopy_format = _vtable->lcopy_format;                         \
2796   GTypeCValue _cvalues[G_VALUE_COLLECT_FORMAT_MAX_LENGTH] = { { 0, }, };      \
2797   guint _n_values = 0;                                                        \
2798                                                                               \
2799   while (*_lcopy_format != '\0') {                                            \
2800     g_assert (*_lcopy_format == G_VALUE_COLLECT_POINTER);                     \
2801     _cvalues[_n_values++].v_pointer = va_arg ((var_args), gpointer);          \
2802     _lcopy_format++;                                                          \
2803   }                                                                           \
2804   if (_n_values == 2 && !!_cvalues[0].v_pointer != !!_cvalues[1].v_pointer) { \
2805     *(__error) = g_strdup_printf ("either all or none of the return "         \
2806         "locations for field '%s' need to be NULL", fieldname);               \
2807   } else if (_cvalues[0].v_pointer != NULL) {                                 \
2808     *(__error) = _vtable->lcopy_value (_value, _n_values, _cvalues, _flags);  \
2809   }                                                                           \
2810 } G_STMT_END
2811
2812 /**
2813  * gst_structure_get_valist:
2814  * @structure: a #GstStructure
2815  * @first_fieldname: the name of the first field to read
2816  * @args: variable arguments
2817  *
2818  * Parses the variable arguments and reads fields from @structure accordingly.
2819  * valist-variant of gst_structure_get(). Look at the documentation of
2820  * gst_structure_get() for more details.
2821  *
2822  * Returns: TRUE, or FALSE if there was a problem reading any of the fields
2823  */
2824 gboolean
2825 gst_structure_get_valist (const GstStructure * structure,
2826     const char *first_fieldname, va_list args)
2827 {
2828   const char *field_name;
2829   GType expected_type = G_TYPE_INVALID;
2830
2831   g_return_val_if_fail (GST_IS_STRUCTURE (structure), FALSE);
2832   g_return_val_if_fail (first_fieldname != NULL, FALSE);
2833
2834   field_name = first_fieldname;
2835   while (field_name) {
2836     const GValue *val = NULL;
2837     gchar *err = NULL;
2838
2839     expected_type = va_arg (args, GType);
2840
2841     val = gst_structure_get_value (structure, field_name);
2842
2843     if (val == NULL)
2844       goto no_such_field;
2845
2846     if (G_VALUE_TYPE (val) != expected_type)
2847       goto wrong_type;
2848
2849     GST_VALUE_LCOPY (val, args, 0, &err, field_name);
2850     if (err) {
2851       g_warning ("%s: %s", G_STRFUNC, err);
2852       g_free (err);
2853       return FALSE;
2854     }
2855
2856     field_name = va_arg (args, const gchar *);
2857   }
2858
2859   return TRUE;
2860
2861 /* ERRORS */
2862 no_such_field:
2863   {
2864     GST_INFO ("Expected field '%s' in structure: %" GST_PTR_FORMAT,
2865         field_name, structure);
2866     return FALSE;
2867   }
2868 wrong_type:
2869   {
2870     GST_INFO ("Expected field '%s' in structure to be of type '%s', but "
2871         "field was of type '%s': %" GST_PTR_FORMAT, field_name,
2872         GST_STR_NULL (g_type_name (expected_type)),
2873         G_VALUE_TYPE_NAME (gst_structure_get_value (structure, field_name)),
2874         structure);
2875     return FALSE;
2876   }
2877 }
2878
2879 /**
2880  * gst_structure_id_get_valist:
2881  * @structure: a #GstStructure
2882  * @first_field_id: the quark of the first field to read
2883  * @args: variable arguments
2884  *
2885  * Parses the variable arguments and reads fields from @structure accordingly.
2886  * valist-variant of gst_structure_id_get(). Look at the documentation of
2887  * gst_structure_id_get() for more details.
2888  *
2889  * Returns: TRUE, or FALSE if there was a problem reading any of the fields
2890  */
2891 gboolean
2892 gst_structure_id_get_valist (const GstStructure * structure,
2893     GQuark first_field_id, va_list args)
2894 {
2895   GQuark field_id;
2896   GType expected_type = G_TYPE_INVALID;
2897
2898   g_return_val_if_fail (GST_IS_STRUCTURE (structure), FALSE);
2899   g_return_val_if_fail (first_field_id != 0, FALSE);
2900
2901   field_id = first_field_id;
2902   while (field_id) {
2903     const GValue *val = NULL;
2904     gchar *err = NULL;
2905
2906     expected_type = va_arg (args, GType);
2907
2908     val = gst_structure_id_get_value (structure, field_id);
2909
2910     if (val == NULL)
2911       goto no_such_field;
2912
2913     if (G_VALUE_TYPE (val) != expected_type)
2914       goto wrong_type;
2915
2916     GST_VALUE_LCOPY (val, args, 0, &err, g_quark_to_string (field_id));
2917     if (err) {
2918       g_warning ("%s: %s", G_STRFUNC, err);
2919       g_free (err);
2920       return FALSE;
2921     }
2922
2923     field_id = va_arg (args, GQuark);
2924   }
2925
2926   return TRUE;
2927
2928 /* ERRORS */
2929 no_such_field:
2930   {
2931     GST_DEBUG ("Expected field '%s' in structure: %" GST_PTR_FORMAT,
2932         GST_STR_NULL (g_quark_to_string (field_id)), structure);
2933     return FALSE;
2934   }
2935 wrong_type:
2936   {
2937     GST_DEBUG ("Expected field '%s' in structure to be of type '%s', but "
2938         "field was of type '%s': %" GST_PTR_FORMAT,
2939         g_quark_to_string (field_id),
2940         GST_STR_NULL (g_type_name (expected_type)),
2941         G_VALUE_TYPE_NAME (gst_structure_id_get_value (structure, field_id)),
2942         structure);
2943     return FALSE;
2944   }
2945 }
2946
2947 /**
2948  * gst_structure_get:
2949  * @structure: a #GstStructure
2950  * @first_fieldname: the name of the first field to read
2951  * @...: variable arguments
2952  *
2953  * Parses the variable arguments and reads fields from @structure accordingly.
2954  * Variable arguments should be in the form field name, field type
2955  * (as a GType), pointer(s) to a variable(s) to hold the return value(s).
2956  * The last variable argument should be NULL.
2957  *
2958  * For refcounted (mini)objects you will receive a new reference which
2959  * you must release with a suitable _unref() when no longer needed. For
2960  * strings and boxed types you will receive a copy which you will need to
2961  * release with either g_free() or the suitable function for the boxed type.
2962  *
2963  * Returns: FALSE if there was a problem reading any of the fields (e.g.
2964  *     because the field requested did not exist, or was of a type other
2965  *     than the type specified), otherwise TRUE.
2966  */
2967 gboolean
2968 gst_structure_get (const GstStructure * structure, const char *first_fieldname,
2969     ...)
2970 {
2971   gboolean ret;
2972   va_list args;
2973
2974   g_return_val_if_fail (GST_IS_STRUCTURE (structure), FALSE);
2975   g_return_val_if_fail (first_fieldname != NULL, FALSE);
2976
2977   va_start (args, first_fieldname);
2978   ret = gst_structure_get_valist (structure, first_fieldname, args);
2979   va_end (args);
2980
2981   return ret;
2982 }
2983
2984 /**
2985  * gst_structure_id_get:
2986  * @structure: a #GstStructure
2987  * @first_field_id: the quark of the first field to read
2988  * @...: variable arguments
2989  *
2990  * Parses the variable arguments and reads fields from @structure accordingly.
2991  * Variable arguments should be in the form field id quark, field type
2992  * (as a GType), pointer(s) to a variable(s) to hold the return value(s).
2993  * The last variable argument should be NULL (technically it should be a
2994  * 0 quark, but we require NULL so compilers that support it can check for
2995  * the NULL terminator and warn if it's not there).
2996  *
2997  * This function is just like gst_structure_get() only that it is slightly
2998  * more efficient since it saves the string-to-quark lookup in the global
2999  * quark hashtable.
3000  *
3001  * For refcounted (mini)objects you will receive a new reference which
3002  * you must release with a suitable _unref() when no longer needed. For
3003  * strings and boxed types you will receive a copy which you will need to
3004  * release with either g_free() or the suitable function for the boxed type.
3005  *
3006  * Returns: FALSE if there was a problem reading any of the fields (e.g.
3007  *     because the field requested did not exist, or was of a type other
3008  *     than the type specified), otherwise TRUE.
3009  */
3010 gboolean
3011 gst_structure_id_get (const GstStructure * structure, GQuark first_field_id,
3012     ...)
3013 {
3014   gboolean ret;
3015   va_list args;
3016
3017   g_return_val_if_fail (GST_IS_STRUCTURE (structure), FALSE);
3018   g_return_val_if_fail (first_field_id != 0, FALSE);
3019
3020   va_start (args, first_field_id);
3021   ret = gst_structure_id_get_valist (structure, first_field_id, args);
3022   va_end (args);
3023
3024   return ret;
3025 }
3026
3027 static gboolean
3028 gst_structure_is_equal_foreach (GQuark field_id, const GValue * val2,
3029     gpointer data)
3030 {
3031   const GstStructure *struct1 = (const GstStructure *) data;
3032   const GValue *val1 = gst_structure_id_get_value (struct1, field_id);
3033
3034   if (G_UNLIKELY (val1 == NULL))
3035     return FALSE;
3036   if (gst_value_compare (val1, val2) == GST_VALUE_EQUAL) {
3037     return TRUE;
3038   }
3039
3040   return FALSE;
3041 }
3042
3043 /**
3044  * gst_structure_is_equal:
3045  * @structure1: a #GstStructure.
3046  * @structure2: a #GstStructure.
3047  *
3048  * Tests if the two #GstStructure are equal.
3049  *
3050  * Returns: TRUE if the two structures have the same name and field.
3051  **/
3052 gboolean
3053 gst_structure_is_equal (const GstStructure * structure1,
3054     const GstStructure * structure2)
3055 {
3056   g_return_val_if_fail (GST_IS_STRUCTURE (structure1), FALSE);
3057   g_return_val_if_fail (GST_IS_STRUCTURE (structure2), FALSE);
3058
3059   if (G_UNLIKELY (structure1 == structure2))
3060     return TRUE;
3061
3062   if (structure1->name != structure2->name) {
3063     return FALSE;
3064   }
3065   if (GST_STRUCTURE_FIELDS (structure1)->len !=
3066       GST_STRUCTURE_FIELDS (structure2)->len) {
3067     return FALSE;
3068   }
3069
3070   return gst_structure_foreach (structure1, gst_structure_is_equal_foreach,
3071       (gpointer) structure2);
3072 }
3073
3074
3075 typedef struct
3076 {
3077   GstStructure *dest;
3078   const GstStructure *intersect;
3079 }
3080 IntersectData;
3081
3082 static gboolean
3083 gst_structure_intersect_field1 (GQuark id, const GValue * val1, gpointer data)
3084 {
3085   IntersectData *idata = (IntersectData *) data;
3086   const GValue *val2 = gst_structure_id_get_value (idata->intersect, id);
3087
3088   if (G_UNLIKELY (val2 == NULL)) {
3089     gst_structure_id_set_value (idata->dest, id, val1);
3090   } else {
3091     GValue dest_value = { 0 };
3092     if (gst_value_intersect (&dest_value, val1, val2)) {
3093       gst_structure_id_take_value (idata->dest, id, &dest_value);
3094     } else {
3095       return FALSE;
3096     }
3097   }
3098   return TRUE;
3099 }
3100
3101 static gboolean
3102 gst_structure_intersect_field2 (GQuark id, const GValue * val1, gpointer data)
3103 {
3104   IntersectData *idata = (IntersectData *) data;
3105   const GValue *val2 = gst_structure_id_get_value (idata->intersect, id);
3106
3107   if (G_UNLIKELY (val2 == NULL)) {
3108     gst_structure_id_set_value (idata->dest, id, val1);
3109   }
3110   return TRUE;
3111 }
3112
3113 /**
3114  * gst_structure_intersect:
3115  * @struct1: a #GstStructure
3116  * @struct2: a #GstStructure
3117  *
3118  * Intersects @struct1 and @struct2 and returns the intersection.
3119  *
3120  * Returns: Intersection of @struct1 and @struct2
3121  */
3122 GstStructure *
3123 gst_structure_intersect (const GstStructure * struct1,
3124     const GstStructure * struct2)
3125 {
3126   IntersectData data;
3127
3128   g_assert (struct1 != NULL);
3129   g_assert (struct2 != NULL);
3130
3131   if (G_UNLIKELY (struct1->name != struct2->name))
3132     return NULL;
3133
3134   /* copy fields from struct1 which we have not in struct2 to target
3135    * intersect if we have the field in both */
3136   data.dest = gst_structure_new_id_empty (struct1->name);
3137   data.intersect = struct2;
3138   if (G_UNLIKELY (!gst_structure_foreach ((GstStructure *) struct1,
3139               gst_structure_intersect_field1, &data)))
3140     goto error;
3141
3142   /* copy fields from struct2 which we have not in struct1 to target */
3143   data.intersect = struct1;
3144   if (G_UNLIKELY (!gst_structure_foreach ((GstStructure *) struct2,
3145               gst_structure_intersect_field2, &data)))
3146     goto error;
3147
3148   return data.dest;
3149
3150 error:
3151   gst_structure_free (data.dest);
3152   return NULL;
3153 }
3154
3155 static gboolean
3156 gst_caps_structure_can_intersect_field (GQuark id, const GValue * val1,
3157     gpointer data)
3158 {
3159   GstStructure *other = (GstStructure *) data;
3160   const GValue *val2 = gst_structure_id_get_value (other, id);
3161
3162   if (G_LIKELY (val2)) {
3163     if (!gst_value_can_intersect (val1, val2)) {
3164       return FALSE;
3165     } else {
3166       gint eq = gst_value_compare (val1, val2);
3167
3168       if (eq == GST_VALUE_UNORDERED) {
3169         /* we need to try interseting */
3170         if (!gst_value_intersect (NULL, val1, val2)) {
3171           return FALSE;
3172         }
3173       } else if (eq != GST_VALUE_EQUAL) {
3174         return FALSE;
3175       }
3176     }
3177   }
3178   return TRUE;
3179 }
3180
3181 /**
3182  * gst_structure_can_intersect:
3183  * @struct1: a #GstStructure
3184  * @struct2: a #GstStructure
3185  *
3186  * Tries intersecting @struct1 and @struct2 and reports whether the result
3187  * would not be empty.
3188  *
3189  * Returns: %TRUE if intersection would not be empty
3190  */
3191 gboolean
3192 gst_structure_can_intersect (const GstStructure * struct1,
3193     const GstStructure * struct2)
3194 {
3195   g_return_val_if_fail (GST_IS_STRUCTURE (struct1), FALSE);
3196   g_return_val_if_fail (GST_IS_STRUCTURE (struct2), FALSE);
3197
3198   if (G_UNLIKELY (struct1->name != struct2->name))
3199     return FALSE;
3200
3201   /* tries to intersect if we have the field in both */
3202   return gst_structure_foreach ((GstStructure *) struct1,
3203       gst_caps_structure_can_intersect_field, (gpointer) struct2);
3204 }
3205
3206 static gboolean
3207 gst_caps_structure_is_superset_field (GQuark field_id, const GValue * value,
3208     gpointer user_data)
3209 {
3210   GstStructure *subset = user_data;
3211   const GValue *other;
3212   int comparison;
3213
3214   if (!(other = gst_structure_id_get_value (subset, field_id)))
3215     /* field is missing in the subset => no subset */
3216     return FALSE;
3217
3218   comparison = gst_value_compare (value, other);
3219
3220   /* equal values are subset */
3221   if (comparison == GST_VALUE_EQUAL)
3222     return TRUE;
3223
3224   /* ordered, but unequal, values are not */
3225   if (comparison != GST_VALUE_UNORDERED)
3226     return FALSE;
3227
3228   return gst_value_is_subset (other, value);
3229 }
3230
3231 /**
3232  * gst_structure_is_subset:
3233  * @subset: a #GstStructure
3234  * @superset: a potentially greater #GstStructure
3235  *
3236  * Checks if @subset is a subset of @superset, i.e. has the same
3237  * structure name and for all fields that are existing in @superset,
3238  * @subset has a value that is a subset of the value in @superset.
3239  *
3240  * Returns: %TRUE if @subset is a subset of @superset
3241  */
3242 gboolean
3243 gst_structure_is_subset (const GstStructure * subset,
3244     const GstStructure * superset)
3245 {
3246   if ((superset->name != subset->name) ||
3247       (gst_structure_n_fields (superset) > gst_structure_n_fields (subset)))
3248     return FALSE;
3249
3250   return gst_structure_foreach ((GstStructure *) superset,
3251       gst_caps_structure_is_superset_field, (gpointer) subset);
3252 }
3253
3254
3255 /**
3256  * gst_structure_fixate:
3257  * @structure: a #GstStructure
3258  *
3259  * Fixate all values in @structure using gst_value_fixate().
3260  * @structure will be modified in-place and should be writable.
3261  */
3262 void
3263 gst_structure_fixate (GstStructure * structure)
3264 {
3265   g_return_if_fail (GST_IS_STRUCTURE (structure));
3266
3267   gst_structure_foreach (structure, default_fixate, structure);
3268 }