2 * Copyright (C) 2013 Collabora Ltd.
3 * Author: Sebastian Dröge <sebastian.droege@collabora.co.uk>
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
15 * You should have received a copy of the GNU Library General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
18 * Boston, MA 02110-1301, USA.
22 * SECTION:gstcapsfeatures
23 * @short_description: A set of features in caps
26 * #GstCapsFeatures can optionally be set on a #GstCaps to add requirements
27 * for additional features for a specific #GstStructure. Caps structures with
28 * the same name but with a non-equal set of caps features are not compatible.
29 * If a pad supports multiple sets of features it has to add multiple equal
30 * structures with different feature sets to the caps.
32 * Empty #GstCapsFeatures are equivalent with the #GstCapsFeatures that only
33 * contain #GST_CAPS_FEATURE_MEMORY_SYSTEM_MEMORY.
35 * Examples for caps features would be the requirement of a specific #GstMemory
36 * types or the requirement of having a specific #GstMeta on the buffer. Features
37 * are given as a string of the format "memory:GstMemoryTypeName" or
38 * "meta:GstMetaAPIName".
48 #include "gst_private.h"
49 #include "gstcapsfeatures.h"
52 GST_DEBUG_CATEGORY_STATIC (gst_caps_features_debug);
53 #define GST_CAT_DEFAULT gst_caps_features_debug
55 struct _GstCapsFeatures
58 gint *parent_refcount;
63 GType _gst_caps_features_type = 0;
64 GstCapsFeatures *_gst_caps_features_any = NULL;
65 GstCapsFeatures *_gst_caps_features_memory_system_memory = NULL;
66 static GQuark _gst_caps_feature_memory_system_memory = 0;
68 G_DEFINE_BOXED_TYPE (GstCapsFeatures, gst_caps_features,
69 gst_caps_features_copy, gst_caps_features_free);
71 #define IS_MUTABLE(features) \
72 (!features->parent_refcount || \
73 g_atomic_int_get (features->parent_refcount) == 1)
76 gst_caps_features_transform_to_string (const GValue * src_value,
80 _priv_gst_caps_features_initialize (void)
82 _gst_caps_features_type = gst_caps_features_get_type ();
83 _gst_caps_feature_memory_system_memory =
84 g_quark_from_static_string (GST_CAPS_FEATURE_MEMORY_SYSTEM_MEMORY);
86 g_value_register_transform_func (_gst_caps_features_type, G_TYPE_STRING,
87 gst_caps_features_transform_to_string);
89 _gst_caps_features_any = gst_caps_features_new_any ();
90 _gst_caps_features_memory_system_memory =
91 gst_caps_features_new_id (_gst_caps_feature_memory_system_memory, 0);
93 GST_DEBUG_CATEGORY_INIT (gst_caps_features_debug, "caps-features", 0,
94 "GstCapsFeatures debug");
98 gst_is_caps_features (gconstpointer obj)
100 const GstCapsFeatures *features = obj;
102 return (obj != NULL && features->type == _gst_caps_features_type);
106 gst_caps_feature_name_is_valid (const gchar * feature)
108 #ifndef G_DISABLE_CHECKS
110 if (g_ascii_isalpha (*feature))
112 else if (*feature == ':')
122 if (*feature == '\0' || !g_ascii_isalpha (*feature))
126 if (g_ascii_isalnum (*feature))
128 else if (*feature == '\0')
139 * gst_caps_features_new_empty:
141 * Creates a new, empty #GstCapsFeatures.
143 * Free-function: gst_caps_features_free
145 * Returns: (transfer full): a new, empty #GstCapsFeatures
150 gst_caps_features_new_empty (void)
152 GstCapsFeatures *features;
154 features = g_slice_new (GstCapsFeatures);
155 features->type = _gst_caps_features_type;
156 features->parent_refcount = NULL;
157 features->array = g_array_new (FALSE, FALSE, sizeof (GQuark));
158 features->is_any = FALSE;
160 GST_TRACE ("created caps features %p", features);
166 * gst_caps_features_new_any:
168 * Creates a new, ANY #GstCapsFeatures. This will be equal
169 * to any other #GstCapsFeatures but caps with these are
172 * Free-function: gst_caps_features_free
174 * Returns: (transfer full): a new, ANY #GstCapsFeatures
179 gst_caps_features_new_any (void)
181 GstCapsFeatures *features;
183 features = gst_caps_features_new_empty ();
184 features->is_any = TRUE;
190 * gst_caps_features_new:
191 * @feature1: name of first feature to set
192 * @...: additional features
194 * Creates a new #GstCapsFeatures with the given features.
195 * The last argument must be NULL.
197 * Free-function: gst_caps_features_free
199 * Returns: (transfer full): a new, empty #GstCapsFeatures
204 gst_caps_features_new (const gchar * feature1, ...)
206 GstCapsFeatures *features;
209 g_return_val_if_fail (feature1 != NULL, NULL);
211 va_start (varargs, feature1);
212 features = gst_caps_features_new_valist (feature1, varargs);
219 * gst_caps_features_new_valist:
220 * @feature1: name of first feature to set
221 * @varargs: variable argument list
223 * Creates a new #GstCapsFeatures with the given features.
225 * Free-function: gst_caps_features_free
227 * Returns: (transfer full): a new, empty #GstCapsFeatures
232 gst_caps_features_new_valist (const gchar * feature1, va_list varargs)
234 GstCapsFeatures *features;
236 g_return_val_if_fail (feature1 != NULL, NULL);
238 features = gst_caps_features_new_empty ();
241 gst_caps_features_add (features, feature1);
242 feature1 = va_arg (varargs, const gchar *);
249 * gst_caps_features_new_id:
250 * @feature1: name of first feature to set
251 * @...: additional features
253 * Creates a new #GstCapsFeatures with the given features.
254 * The last argument must be 0.
256 * Free-function: gst_caps_features_free
258 * Returns: (transfer full): a new, empty #GstCapsFeatures
263 gst_caps_features_new_id (GQuark feature1, ...)
265 GstCapsFeatures *features;
268 g_return_val_if_fail (feature1 != 0, NULL);
270 va_start (varargs, feature1);
271 features = gst_caps_features_new_id_valist (feature1, varargs);
278 * gst_caps_features_new_id_valist:
279 * @feature1: name of first feature to set
280 * @varargs: variable argument list
282 * Creates a new #GstCapsFeatures with the given features.
284 * Free-function: gst_caps_features_free
286 * Returns: (transfer full): a new, empty #GstCapsFeatures
291 gst_caps_features_new_id_valist (GQuark feature1, va_list varargs)
293 GstCapsFeatures *features;
295 g_return_val_if_fail (feature1 != 0, NULL);
297 features = gst_caps_features_new_empty ();
300 gst_caps_features_add_id (features, feature1);
301 feature1 = va_arg (varargs, GQuark);
308 * gst_caps_features_set_parent_refcount:
309 * @features: a #GstCapsFeatures
310 * @refcount: (in): a pointer to the parent's refcount
312 * Sets the parent_refcount field of #GstCapsFeatures. This field is used to
313 * determine whether a caps features is mutable or not. This function should only be
314 * called by code implementing parent objects of #GstCapsFeatures, as described in
315 * the MT Refcounting section of the design documents.
317 * Returns: %TRUE if the parent refcount could be set.
322 gst_caps_features_set_parent_refcount (GstCapsFeatures * features,
325 g_return_val_if_fail (features != NULL, FALSE);
327 /* if we have a parent_refcount already, we can only clear
328 * if with a NULL refcount */
329 if (features->parent_refcount) {
330 if (refcount != NULL) {
331 g_return_val_if_fail (refcount == NULL, FALSE);
335 if (refcount == NULL) {
336 g_return_val_if_fail (refcount != NULL, FALSE);
341 features->parent_refcount = refcount;
347 * gst_caps_features_copy:
348 * @features: a #GstCapsFeatures to duplicate
350 * Duplicates a #GstCapsFeatures and all its values.
352 * Free-function: gst_caps_features_free
354 * Returns: (transfer full): a new #GstCapsFeatures.
359 gst_caps_features_copy (const GstCapsFeatures * features)
361 GstCapsFeatures *copy;
364 g_return_val_if_fail (features != NULL, NULL);
366 copy = gst_caps_features_new_empty ();
367 n = gst_caps_features_get_size (features);
368 for (i = 0; i < n; i++)
369 gst_caps_features_add_id (copy, gst_caps_features_get_nth_id (features, i));
375 * gst_caps_features_free:
376 * @features: (in) (transfer full): the #GstCapsFeatures to free
378 * Frees a #GstCapsFeatures and all its values. The caps features must not
379 * have a parent when this function is called.
384 gst_caps_features_free (GstCapsFeatures * features)
386 g_return_if_fail (features != NULL);
387 g_return_if_fail (features->parent_refcount == NULL);
389 g_array_free (features->array, TRUE);
391 memset (features, 0xff, sizeof (GstCapsFeatures));
393 GST_TRACE ("free caps features %p", features);
395 g_slice_free (GstCapsFeatures, features);
399 * gst_caps_features_to_string:
400 * @features: a #GstCapsFeatures
402 * Converts @features to a human-readable string representation.
404 * For debugging purposes its easier to do something like this:
406 * GST_LOG ("features is %" GST_PTR_FORMAT, features);
408 * This prints the features in human readble form.
410 * Free-function: g_free
412 * Returns: (transfer full): a pointer to string allocated by g_malloc().
413 * g_free() after usage.
418 gst_caps_features_to_string (const GstCapsFeatures * features)
422 g_return_val_if_fail (features != NULL, NULL);
424 s = g_string_sized_new (FEATURES_ESTIMATED_STRING_LEN (features));
426 priv_gst_caps_features_append_to_gstring (features, s);
428 return g_string_free (s, FALSE);
432 priv_gst_caps_features_append_to_gstring (const GstCapsFeatures * features,
437 g_return_if_fail (features != NULL);
439 if (features->array->len == 0 && features->is_any) {
440 g_string_append (s, "ANY");
444 n = features->array->len;
445 for (i = 0; i < n; i++) {
446 GQuark *quark = &g_array_index (features->array, GQuark, i);
448 g_string_append (s, g_quark_to_string (*quark));
450 g_string_append (s, ", ");
455 * gst_caps_features_from_string:
456 * @features: a string representation of a #GstCapsFeatures.
458 * Creates a #GstCapsFeatures from a string representation.
460 * Free-function: gst_caps_features_free
462 * Returns: (transfer full): a new #GstCapsFeatures or NULL when the string could
463 * not be parsed. Free with gst_caps_features_free() after use.
468 gst_caps_features_from_string (const gchar * features)
470 GstCapsFeatures *ret;
471 gboolean escape = FALSE;
472 const gchar *features_orig = features;
473 const gchar *feature;
475 ret = gst_caps_features_new_empty ();
477 if (!features || *features == '\0')
480 if (strcmp (features, "ANY") == 0) {
485 /* Skip trailing spaces */
486 while (*features == ' ')
497 } else if ((!escape && c == ',') || c == '\0') {
498 guint len = features - feature + 1;
503 g_warning ("Failed deserialize caps features '%s'", features_orig);
504 gst_caps_features_free (ret);
508 tmp = g_malloc (len);
509 memcpy (tmp, feature, len - 1);
518 if (strstr (tmp, " ") != NULL || *tmp == '\0') {
520 g_warning ("Failed deserialize caps features '%s'", features_orig);
521 gst_caps_features_free (ret);
525 gst_caps_features_add (ret, tmp);
531 /* Skip to the next value */
533 while (*features == ' ')
546 * gst_caps_features_get_size:
547 * @features: a #GstCapsFeatures.
549 * Returns the number of features in @features.
551 * Returns: The number of features in @features.
556 gst_caps_features_get_size (const GstCapsFeatures * features)
558 g_return_val_if_fail (features != NULL, 0);
560 return features->array->len;
564 * gst_caps_features_get_nth:
565 * @features: a #GstCapsFeatures.
566 * @i: index of the feature
568 * Returns the @i-th feature of @features.
570 * Returns: The @i-th feature of @features.
575 gst_caps_features_get_nth (const GstCapsFeatures * features, guint i)
577 const gchar *feature;
580 g_return_val_if_fail (features != NULL, NULL);
582 quark = gst_caps_features_get_nth_id (features, i);
586 feature = g_quark_to_string (quark);
591 * gst_caps_features_get_nth_id:
592 * @features: a #GstCapsFeatures.
593 * @i: index of the feature
595 * Returns the @i-th feature of @features.
597 * Returns: The @i-th feature of @features.
602 gst_caps_features_get_nth_id (const GstCapsFeatures * features, guint i)
606 g_return_val_if_fail (features != NULL, 0);
607 g_return_val_if_fail (i < features->array->len, 0);
609 quark = &g_array_index (features->array, GQuark, i);
615 * gst_caps_features_contains:
616 * @features: a #GstCapsFeatures.
617 * @feature: a feature
619 * Check if @features contains @feature.
621 * Returns: %TRUE if @features contains @feature.
626 gst_caps_features_contains (const GstCapsFeatures * features,
627 const gchar * feature)
629 g_return_val_if_fail (features != NULL, FALSE);
630 g_return_val_if_fail (feature != NULL, FALSE);
632 return gst_caps_features_contains_id (features,
633 g_quark_from_string (feature));
637 * gst_caps_features_contains_id:
638 * @features: a #GstCapsFeatures.
639 * @feature: a feature
641 * Check if @features contains @feature.
643 * Returns: %TRUE if @features contains @feature.
648 gst_caps_features_contains_id (const GstCapsFeatures * features, GQuark feature)
652 g_return_val_if_fail (features != NULL, FALSE);
653 g_return_val_if_fail (feature != 0, FALSE);
655 if (features->is_any)
658 n = features->array->len;
660 return feature == _gst_caps_feature_memory_system_memory;
662 for (i = 0; i < n; i++) {
663 if (gst_caps_features_get_nth_id (features, i) == feature)
671 * gst_caps_features_is_equal:
672 * @features1: a #GstCapsFeatures.
673 * @features2: a #GstCapsFeatures.
675 * Check if @features1 and @features2 are equal.
677 * Returns: %TRUE if @features1 and @features2 are equal.
682 gst_caps_features_is_equal (const GstCapsFeatures * features1,
683 const GstCapsFeatures * features2)
687 g_return_val_if_fail (features1 != NULL, FALSE);
688 g_return_val_if_fail (features2 != NULL, FALSE);
690 if (features1->is_any || features2->is_any)
693 /* Check for the sysmem==empty case */
694 if (features1->array->len == 0 && features2->array->len == 0)
696 if (features1->array->len == 0 && features2->array->len == 1
697 && gst_caps_features_contains_id (features2,
698 _gst_caps_feature_memory_system_memory))
700 if (features2->array->len == 0 && features1->array->len == 1
701 && gst_caps_features_contains_id (features1,
702 _gst_caps_feature_memory_system_memory))
705 if (features1->array->len != features2->array->len)
708 n = features1->array->len;
709 for (i = 0; i < n; i++)
710 if (!gst_caps_features_contains_id (features2,
711 gst_caps_features_get_nth_id (features1, i)))
718 * gst_caps_features_is_any:
719 * @features: a #GstCapsFeatures.
721 * Check if @features is %GST_CAPS_FEATURES_ANY.
723 * Returns: %TRUE if @features is %GST_CAPS_FEATURES_ANY.
728 gst_caps_features_is_any (const GstCapsFeatures * features)
730 g_return_val_if_fail (features != NULL, FALSE);
732 return features->is_any;
736 * gst_caps_features_add:
737 * @features: a #GstCapsFeatures.
738 * @feature: a feature.
740 * Adds @feature to @features.
745 gst_caps_features_add (GstCapsFeatures * features, const gchar * feature)
747 g_return_if_fail (features != NULL);
748 g_return_if_fail (IS_MUTABLE (features));
749 g_return_if_fail (feature != NULL);
750 g_return_if_fail (!features->is_any);
752 gst_caps_features_add_id (features, g_quark_from_string (feature));
756 * gst_caps_features_add_id:
757 * @features: a #GstCapsFeatures.
758 * @feature: a feature.
760 * Adds @feature to @features.
765 gst_caps_features_add_id (GstCapsFeatures * features, GQuark feature)
767 g_return_if_fail (features != NULL);
768 g_return_if_fail (IS_MUTABLE (features));
769 g_return_if_fail (feature != 0);
770 g_return_if_fail (!features->is_any);
772 if (!gst_caps_feature_name_is_valid (g_quark_to_string (feature))) {
773 g_warning ("Invalid caps feature name: %s", g_quark_to_string (feature));
777 /* If features is empty it will contain sysmem, however
778 * we want to add it explicitely if it is tried to be
779 * added as first features
781 if (features->array->len > 0
782 && gst_caps_features_contains_id (features, feature))
785 g_array_append_val (features->array, feature);
789 * gst_caps_features_remove:
790 * @features: a #GstCapsFeatures.
791 * @feature: a feature.
793 * Removes @feature from @features.
798 gst_caps_features_remove (GstCapsFeatures * features, const gchar * feature)
800 g_return_if_fail (features != NULL);
801 g_return_if_fail (IS_MUTABLE (features));
802 g_return_if_fail (feature != NULL);
804 gst_caps_features_remove_id (features, g_quark_from_string (feature));
808 * gst_caps_features_remove_id:
809 * @features: a #GstCapsFeatures.
810 * @feature: a feature.
812 * Removes @feature from @features.
817 gst_caps_features_remove_id (GstCapsFeatures * features, GQuark feature)
821 g_return_if_fail (features != NULL);
822 g_return_if_fail (IS_MUTABLE (features));
823 g_return_if_fail (feature != 0);
825 n = features->array->len;
826 for (i = 0; i < n; i++) {
827 GQuark quark = gst_caps_features_get_nth_id (features, i);
829 if (quark == feature) {
830 g_array_remove_index_fast (features->array, i);
837 gst_caps_features_transform_to_string (const GValue * src_value,
840 g_return_if_fail (src_value != NULL);
841 g_return_if_fail (dest_value != NULL);
843 dest_value->data[0].v_pointer =
844 gst_caps_features_to_string (src_value->data[0].v_pointer);