/**
* SECTION:gstcapsfeatures
- * @short_description: A set of features in caps
+ * @title: GstCapsFeatures
+ * @short_description: A set of features in caps
* @see_also: #GstCaps
*
* #GstCapsFeatures can optionally be set on a #GstCaps to add requirements
* structures with different feature sets to the caps.
*
* Empty #GstCapsFeatures are equivalent with the #GstCapsFeatures that only
- * contain #GST_CAPS_FEATURE_MEMORY_SYSTEM_MEMORY.
+ * contain #GST_CAPS_FEATURE_MEMORY_SYSTEM_MEMORY. ANY #GstCapsFeatures as
+ * created by gst_caps_features_new_any() are equal to any other #GstCapsFeatures
+ * and can be used to specify that any #GstCapsFeatures would be supported, e.g.
+ * for elements that don't touch buffer memory. #GstCaps with ANY #GstCapsFeatures
+ * are considered non-fixed and during negotiation some #GstCapsFeatures have
+ * to be selected.
*
* Examples for caps features would be the requirement of a specific #GstMemory
* types or the requirement of having a specific #GstMeta on the buffer. Features
* are given as a string of the format "memory:GstMemoryTypeName" or
* "meta:GstMetaAPIName".
+ *
+ * Since: 1.2
*/
#ifdef HAVE_CONFIG_H
};
GType _gst_caps_features_type = 0;
+static gint static_caps_features_parent_refcount = G_MAXINT;
GstCapsFeatures *_gst_caps_features_any = NULL;
GstCapsFeatures *_gst_caps_features_memory_system_memory = NULL;
static GQuark _gst_caps_feature_memory_system_memory = 0;
void
_priv_gst_caps_features_initialize (void)
{
+ GST_DEBUG_CATEGORY_INIT (gst_caps_features_debug, "caps-features", 0,
+ "GstCapsFeatures debug");
+
_gst_caps_features_type = gst_caps_features_get_type ();
_gst_caps_feature_memory_system_memory =
g_quark_from_static_string (GST_CAPS_FEATURE_MEMORY_SYSTEM_MEMORY);
gst_caps_features_transform_to_string);
_gst_caps_features_any = gst_caps_features_new_any ();
+ gst_caps_features_set_parent_refcount (_gst_caps_features_any,
+ &static_caps_features_parent_refcount);
_gst_caps_features_memory_system_memory =
gst_caps_features_new_id (_gst_caps_feature_memory_system_memory, 0);
+ gst_caps_features_set_parent_refcount
+ (_gst_caps_features_memory_system_memory,
+ &static_caps_features_parent_refcount);
+}
- GST_DEBUG_CATEGORY_INIT (gst_caps_features_debug, "caps-features", 0,
- "GstCapsFeatures debug");
+void
+_priv_gst_caps_features_cleanup (void)
+{
+ gst_caps_features_set_parent_refcount (_gst_caps_features_any, NULL);
+ gst_caps_features_free (_gst_caps_features_any);
+ _gst_caps_features_any = NULL;
+ gst_caps_features_set_parent_refcount
+ (_gst_caps_features_memory_system_memory, NULL);
+ gst_caps_features_free (_gst_caps_features_memory_system_memory);
+ _gst_caps_features_memory_system_memory = NULL;
}
gboolean
* Free-function: gst_caps_features_free
*
* Returns: (transfer full): a new, empty #GstCapsFeatures
+ *
+ * Since: 1.2
*/
GstCapsFeatures *
gst_caps_features_new_empty (void)
* Free-function: gst_caps_features_free
*
* Returns: (transfer full): a new, ANY #GstCapsFeatures
+ *
+ * Since: 1.2
*/
GstCapsFeatures *
gst_caps_features_new_any (void)
* @...: additional features
*
* Creates a new #GstCapsFeatures with the given features.
- * The last argument must be NULL.
+ * The last argument must be %NULL.
*
* Free-function: gst_caps_features_free
*
* Returns: (transfer full): a new, empty #GstCapsFeatures
+ *
+ * Since: 1.2
*/
GstCapsFeatures *
gst_caps_features_new (const gchar * feature1, ...)
* Free-function: gst_caps_features_free
*
* Returns: (transfer full): a new, empty #GstCapsFeatures
+ *
+ * Since: 1.2
*/
GstCapsFeatures *
gst_caps_features_new_valist (const gchar * feature1, va_list varargs)
* Free-function: gst_caps_features_free
*
* Returns: (transfer full): a new, empty #GstCapsFeatures
+ *
+ * Since: 1.2
*/
GstCapsFeatures *
gst_caps_features_new_id (GQuark feature1, ...)
* Free-function: gst_caps_features_free
*
* Returns: (transfer full): a new, empty #GstCapsFeatures
+ *
+ * Since: 1.2
*/
GstCapsFeatures *
gst_caps_features_new_id_valist (GQuark feature1, va_list varargs)
* the MT Refcounting section of the design documents.
*
* Returns: %TRUE if the parent refcount could be set.
+ *
+ * Since: 1.2
*/
gboolean
gst_caps_features_set_parent_refcount (GstCapsFeatures * features,
* Free-function: gst_caps_features_free
*
* Returns: (transfer full): a new #GstCapsFeatures.
+ *
+ * Since: 1.2
*/
GstCapsFeatures *
gst_caps_features_copy (const GstCapsFeatures * features)
n = gst_caps_features_get_size (features);
for (i = 0; i < n; i++)
gst_caps_features_add_id (copy, gst_caps_features_get_nth_id (features, i));
+ copy->is_any = features->is_any;
return copy;
}
*
* Frees a #GstCapsFeatures and all its values. The caps features must not
* have a parent when this function is called.
+ *
+ * Since: 1.2
*/
void
gst_caps_features_free (GstCapsFeatures * features)
* Converts @features to a human-readable string representation.
*
* For debugging purposes its easier to do something like this:
- * |[
+ * |[<!-- language="C" -->
* GST_LOG ("features is %" GST_PTR_FORMAT, features);
* ]|
- * This prints the features in human readble form.
+ * This prints the features in human readable form.
*
* Free-function: g_free
*
* Returns: (transfer full): a pointer to string allocated by g_malloc().
* g_free() after usage.
+ *
+ * Since: 1.2
*/
gchar *
gst_caps_features_to_string (const GstCapsFeatures * features)
*
* Free-function: gst_caps_features_free
*
- * Returns: (transfer full): a new #GstCapsFeatures or NULL when the string could
- * not be parsed. Free with gst_caps_features_free() after use.
+ * Returns: (transfer full) (nullable): a new #GstCapsFeatures or
+ * %NULL when the string could not be parsed. Free with
+ * gst_caps_features_free() after use.
+ *
+ * Since: 1.2
*/
GstCapsFeatures *
gst_caps_features_from_string (const gchar * features)
* Returns the number of features in @features.
*
* Returns: The number of features in @features.
+ *
+ * Since: 1.2
*/
guint
gst_caps_features_get_size (const GstCapsFeatures * features)
*
* Returns the @i-th feature of @features.
*
- * Returns: The @i-th feature of @features.
+ * Returns: (nullable): The @i-th feature of @features.
+ *
+ * Since: 1.2
*/
const gchar *
gst_caps_features_get_nth (const GstCapsFeatures * features, guint i)
* Returns the @i-th feature of @features.
*
* Returns: The @i-th feature of @features.
+ *
+ * Since: 1.2
*/
GQuark
gst_caps_features_get_nth_id (const GstCapsFeatures * features, guint i)
* @features: a #GstCapsFeatures.
* @feature: a feature
*
- * Returns %TRUE if @features contains @feature.
+ * Check if @features contains @feature.
*
* Returns: %TRUE if @features contains @feature.
+ *
+ * Since: 1.2
*/
gboolean
gst_caps_features_contains (const GstCapsFeatures * features,
* @features: a #GstCapsFeatures.
* @feature: a feature
*
- * Returns %TRUE if @features contains @feature.
+ * Check if @features contains @feature.
*
* Returns: %TRUE if @features contains @feature.
+ *
+ * Since: 1.2
*/
gboolean
gst_caps_features_contains_id (const GstCapsFeatures * features, GQuark feature)
* @features1: a #GstCapsFeatures.
* @features2: a #GstCapsFeatures.
*
- * Returns %TRUE if @features1 and @features2 are equal.
+ * Check if @features1 and @features2 are equal.
*
* Returns: %TRUE if @features1 and @features2 are equal.
+ *
+ * Since: 1.2
*/
gboolean
gst_caps_features_is_equal (const GstCapsFeatures * features1,
* gst_caps_features_is_any:
* @features: a #GstCapsFeatures.
*
- * Returns %TRUE if @features is %GST_CAPS_FEATURES_ANY.
+ * Check if @features is %GST_CAPS_FEATURES_ANY.
*
* Returns: %TRUE if @features is %GST_CAPS_FEATURES_ANY.
+ *
+ * Since: 1.2
*/
gboolean
gst_caps_features_is_any (const GstCapsFeatures * features)
* @feature: a feature.
*
* Adds @feature to @features.
+ *
+ * Since: 1.2
*/
void
gst_caps_features_add (GstCapsFeatures * features, const gchar * feature)
* @feature: a feature.
*
* Adds @feature to @features.
+ *
+ * Since: 1.2
*/
void
gst_caps_features_add_id (GstCapsFeatures * features, GQuark feature)
}
/* If features is empty it will contain sysmem, however
- * we want to add it explicitely if it is tried to be
+ * we want to add it explicitly if it is attempted to be
* added as first features
*/
if (features->array->len > 0
* @feature: a feature.
*
* Removes @feature from @features.
+ *
+ * Since: 1.2
*/
void
gst_caps_features_remove (GstCapsFeatures * features, const gchar * feature)
* @feature: a feature.
*
* Removes @feature from @features.
+ *
+ * Since: 1.2
*/
void
gst_caps_features_remove_id (GstCapsFeatures * features, GQuark feature)
projects / platform / upstream / gstreamer.git / blobdiff