gst/gstcaps.h

   1 /* GStreamer
   2  * Copyright (C) 2003 David A. Schleef <ds@schleef.org>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  17  * Boston, MA 02110-1301, USA.
  18  */
  19
  20 #ifndef __GST_CAPS_H__
  21 #define __GST_CAPS_H__
  22
  23 #include <gst/gstconfig.h>
  24 #include <gst/gstminiobject.h>
  25 #include <gst/gststructure.h>
  26 #include <gst/gstcapsfeatures.h>
  27 #include <gst/glib-compat.h>
  28
  29 G_BEGIN_DECLS
  30
  31 GST_EXPORT GType _gst_caps_type;
  32
  33 #define GST_TYPE_CAPS             (_gst_caps_type)
  34 #define GST_IS_CAPS(obj)          (GST_IS_MINI_OBJECT_TYPE((obj), GST_TYPE_CAPS))
  35 #define GST_CAPS_CAST(obj)        ((GstCaps*)(obj))
  36 #define GST_CAPS(obj)             (GST_CAPS_CAST(obj))
  37
  38 #define GST_TYPE_STATIC_CAPS      (gst_static_caps_get_type())
  39
  40 /**
  41  * GstCapsFlags:
  42  * @GST_CAPS_FLAG_ANY: Caps has no specific content, but can contain
  43  *    anything.
  44  *
  45  * Extra flags for a caps.
  46  */
  47 typedef enum {
  48   GST_CAPS_FLAG_ANY     = (GST_MINI_OBJECT_FLAG_LAST << 0)
  49 } GstCapsFlags;
  50
  51 /**
  52  * GstCapsIntersectMode:
  53  * @GST_CAPS_INTERSECT_ZIG_ZAG  : Zig-zags over both caps.
  54  * @GST_CAPS_INTERSECT_FIRST    : Keeps the first caps order.
  55  *
  56  * Modes of caps intersection
  57  *
  58  * @GST_CAPS_INTERSECT_ZIG_ZAG tries to preserve overall order of both caps
  59  * by iterating on the caps' structures as the following matrix shows:
  60  * |[
  61  *          caps1
  62  *       +-------------
  63  *       | 1  2  4  7
  64  * caps2 | 3  5  8 10
  65  *       | 6  9 11 12
  66  * ]|
  67  * Used when there is no explicit precedence of one caps over the other. e.g.
  68  * tee's sink pad getcaps function, it will probe its src pad peers' for their
  69  * caps and intersect them with this mode.
  70  *
  71  * @GST_CAPS_INTERSECT_FIRST is useful when an element wants to preserve
  72  * another element's caps priority order when intersecting with its own caps.
  73  * Example: If caps1 is [A, B, C] and caps2 is [E, B, D, A], the result
  74  * would be [A, B], maintaining the first caps priority on the intersection.
  75  */
  76 typedef enum {
  77   GST_CAPS_INTERSECT_ZIG_ZAG            =  0,
  78   GST_CAPS_INTERSECT_FIRST              =  1
  79 } GstCapsIntersectMode;
  80
  81 /**
  82  * GST_CAPS_ANY:
  83  *
  84  * Means that the element/pad can output 'anything'. Useful for elements
  85  * that output unknown media, such as filesrc. This macro returns a singleton and
  86  * should not be unreffed.
  87  */
  88 #define GST_CAPS_ANY              _gst_caps_any
  89 /**
  90  * GST_CAPS_NONE:
  91  *
  92  * The opposite of %GST_CAPS_ANY: it means that the pad/element outputs an
  93  * undefined media type that can not be detected. This macro returns a singleton
  94  * and should not be unreffed.
  95  */
  96 #define GST_CAPS_NONE             _gst_caps_none
  97
  98 /**
  99  * GST_STATIC_CAPS_ANY:
 100  *
 101  * Creates a new #GstCaps static caps that matches anything.
 102  * This can be used in pad templates.
 103  */
 104 #define GST_STATIC_CAPS_ANY       GST_STATIC_CAPS("ANY")
 105 /**
 106  * GST_STATIC_CAPS_NONE:
 107  *
 108  * Creates a new #GstCaps static caps that matches nothing.
 109  * This can be used in pad templates.
 110  */
 111 #define GST_STATIC_CAPS_NONE      GST_STATIC_CAPS("NONE")
 112
 113 /**
 114  * GST_CAPS_IS_SIMPLE:
 115  * @caps: the #GstCaps instance to check
 116  *
 117  * Convenience macro that checks if the number of structures in the given caps
 118  * is exactly one.
 119  */
 120 #define GST_CAPS_IS_SIMPLE(caps) (gst_caps_get_size(caps) == 1)
 121
 122 /**
 123  * GST_STATIC_CAPS:
 124  * @string: the string describing the caps
 125  *
 126  * Creates a new #GstCaps static caps from an input string.
 127  * This can be used in pad templates.
 128  */
 129 #define GST_STATIC_CAPS(string) \
 130 { \
 131   /* caps */ NULL, \
 132   /* string */ string, \
 133   GST_PADDING_INIT \
 134 }
 135
 136 typedef struct _GstCaps GstCaps;
 137 typedef struct _GstStaticCaps GstStaticCaps;
 138
 139 GST_EXPORT GstCaps * _gst_caps_any;
 140 GST_EXPORT GstCaps * _gst_caps_none;
 141 /**
 142  * GST_CAPS_FLAGS:
 143  * @caps: a #GstCaps.
 144  *
 145  * A flags word containing #GstCapsFlags flags set on this caps.
 146  */
 147 #define GST_CAPS_FLAGS(caps)                    GST_MINI_OBJECT_FLAGS(caps)
 148
 149 /* refcount */
 150 /**
 151  * GST_CAPS_REFCOUNT:
 152  * @caps: a #GstCaps
 153  *
 154  * Get access to the reference count field of the caps
 155  */
 156 #define GST_CAPS_REFCOUNT(caps)                 GST_MINI_OBJECT_REFCOUNT(caps)
 157 /**
 158  * GST_CAPS_REFCOUNT_VALUE:
 159  * @caps: a #GstCaps
 160  *
 161  * Get the reference count value of the caps.
 162  */
 163 #define GST_CAPS_REFCOUNT_VALUE(caps)           GST_MINI_OBJECT_REFCOUNT_VALUE(caps)
 164
 165 /**
 166  * GST_CAPS_FLAG_IS_SET:
 167  * @caps: a #GstCaps.
 168  * @flag: the #GstCapsFlags to check.
 169  *
 170  * Gives the status of a specific flag on a caps.
 171  */
 172 #define GST_CAPS_FLAG_IS_SET(caps,flag)        GST_MINI_OBJECT_FLAG_IS_SET (caps, flag)
 173 /**
 174  * GST_CAPS_FLAG_SET:
 175  * @caps: a #GstCaps.
 176  * @flag: the #GstCapsFlags to set.
 177  *
 178  * Sets a caps flag on a caps.
 179  */
 180 #define GST_CAPS_FLAG_SET(caps,flag)           GST_MINI_OBJECT_FLAG_SET (caps, flag)
 181 /**
 182  * GST_CAPS_FLAG_UNSET:
 183  * @caps: a #GstCaps.
 184  * @flag: the #GstCapsFlags to clear.
 185  *
 186  * Clears a caps flag.
 187  */
 188 #define GST_CAPS_FLAG_UNSET(caps,flag)         GST_MINI_OBJECT_FLAG_UNSET (caps, flag)
 189
 190 /* refcounting */
 191 /**
 192  * gst_caps_ref:
 193  * @caps: the #GstCaps to reference
 194  *
 195  * Add a reference to a #GstCaps object.
 196  *
 197  * From this point on, until the caller calls gst_caps_unref() or
 198  * gst_caps_make_writable(), it is guaranteed that the caps object will not
 199  * change. This means its structures won't change, etc. To use a #GstCaps
 200  * object, you must always have a refcount on it -- either the one made
 201  * implicitly by e.g. gst_caps_new_simple(), or via taking one explicitly with
 202  * this function.
 203  *
 204  * Returns: the same #GstCaps object.
 205  */
 206 static inline GstCaps *
 207 gst_caps_ref (GstCaps * caps)
 208 {
 209   return (GstCaps *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (caps));
 210 }
 211
 212 /**
 213  * gst_caps_unref:
 214  * @caps: a #GstCaps.
 215  *
 216  * Unref a #GstCaps and and free all its structures and the
 217  * structures' values when the refcount reaches 0.
 218  */
 219 static inline void
 220 gst_caps_unref (GstCaps * caps)
 221 {
 222   gst_mini_object_unref (GST_MINI_OBJECT_CAST (caps));
 223 }
 224
 225 /* copy caps */
 226 /**
 227  * gst_caps_copy:
 228  * @caps: a #GstCaps.
 229  *
 230  * Creates a new #GstCaps as a copy of the old @caps. The new caps will have a
 231  * refcount of 1, owned by the caller. The structures are copied as well.
 232  *
 233  * Note that this function is the semantic equivalent of a gst_caps_ref()
 234  * followed by a gst_caps_make_writable(). If you only want to hold on to a
 235  * reference to the data, you should use gst_caps_ref().
 236  *
 237  * When you are finished with the caps, call gst_caps_unref() on it.
 238  *
 239  * Returns: the new #GstCaps
 240  */
 241 static inline GstCaps *
 242 gst_caps_copy (const GstCaps * caps)
 243 {
 244   return GST_CAPS (gst_mini_object_copy (GST_MINI_OBJECT_CAST (caps)));
 245 }
 246
 247 /**
 248  * gst_caps_is_writable:
 249  * @caps: a #GstCaps
 250  *
 251  * Tests if you can safely modify @caps. It is only safe to modify caps when
 252  * there is only one owner of the caps - ie, the object is writable.
 253  */
 254 #define         gst_caps_is_writable(caps)     gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (caps))
 255
 256 /**
 257  * gst_caps_make_writable:
 258  * @caps: (transfer full): a #GstCaps
 259  *
 260  * Returns a writable copy of @caps.
 261  *
 262  * If there is only one reference count on @caps, the caller must be the owner,
 263  * and so this function will return the caps object unchanged. If on the other
 264  * hand there is more than one reference on the object, a new caps object will
 265  * be returned. The caller's reference on @caps will be removed, and instead the
 266  * caller will own a reference to the returned object.
 267  *
 268  * In short, this function unrefs the caps in the argument and refs the caps
 269  * that it returns. Don't access the argument after calling this function. See
 270  * also: gst_caps_ref().
 271  *
 272  * Returns: (transfer full): a writable caps which may or may not be the
 273  *     same as @caps
 274  */
 275 #define         gst_caps_make_writable(caps)   GST_CAPS_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (caps)))
 276
 277 /**
 278  * gst_caps_replace:
 279  * @old_caps: (inout) (transfer full) (nullable): pointer to a pointer
 280  *     to a #GstCaps to be replaced.
 281  * @new_caps: (transfer none) (allow-none): pointer to a #GstCaps that will
 282  *     replace the caps pointed to by @old_caps.
 283  *
 284  * Modifies a pointer to a #GstCaps to point to a different #GstCaps. The
 285  * modification is done atomically (so this is useful for ensuring thread safety
 286  * in some cases), and the reference counts are updated appropriately (the old
 287  * caps is unreffed, the new is reffed).
 288  *
 289  * Either @new_caps or the #GstCaps pointed to by @old_caps may be %NULL.
 290  *
 291  * Returns: %TRUE if @new_caps was different from @old_caps
 292  */
 293 static inline gboolean
 294 gst_caps_replace (GstCaps **old_caps, GstCaps *new_caps)
 295 {
 296     return gst_mini_object_replace ((GstMiniObject **) old_caps, (GstMiniObject *) new_caps);
 297 }
 298
 299 /**
 300  * gst_caps_take:
 301  * @old_caps: (inout) (transfer full): pointer to a pointer to a #GstCaps to be
 302  *     replaced.
 303  * @new_caps: (transfer full) (allow-none): pointer to a #GstCaps that will
 304  *     replace the caps pointed to by @old_caps.
 305  *
 306  * Modifies a pointer to a #GstCaps to point to a different #GstCaps. This
 307  * function is similar to gst_caps_replace() except that it takes ownership
 308  * of @new_caps.
 309  *
 310  * Returns: %TRUE if @new_caps was different from @old_caps
 311  */
 312 static inline gboolean
 313 gst_caps_take (GstCaps **old_caps, GstCaps *new_caps)
 314 {
 315     return gst_mini_object_take ((GstMiniObject **) old_caps, (GstMiniObject *) new_caps);
 316 }
 317
 318 /**
 319  * GstCaps:
 320  * @mini_object: the parent type
 321  *
 322  * Object describing media types.
 323  */
 324 struct _GstCaps {
 325   GstMiniObject mini_object;
 326 };
 327
 328 /**
 329  * GstStaticCaps:
 330  * @caps: the cached #GstCaps
 331  * @string: a string describing a caps
 332  *
 333  * Datastructure to initialize #GstCaps from a string description usually
 334  * used in conjunction with GST_STATIC_CAPS() and gst_static_caps_get() to
 335  * instantiate a #GstCaps.
 336  */
 337 struct _GstStaticCaps {
 338   /*< public >*/
 339   GstCaps *caps;
 340   const char *string;
 341
 342   /*< private >*/
 343   gpointer _gst_reserved[GST_PADDING];
 344 };
 345
 346 /**
 347  * GstCapsForeachFunc:
 348  * @features: the #GstCapsFeatures
 349  * @structure: the #GstStructure
 350  * @user_data: user data
 351  *
 352  * A function that will be called in gst_caps_foreach(). The function may
 353  * not modify @features or @structure.
 354  *
 355  * Returns: %TRUE if the foreach operation should continue, %FALSE if
 356  * the foreach operation should stop with %FALSE.
 357  *
 358  * Since: 1.6
 359  */
 360 typedef gboolean (*GstCapsForeachFunc) (GstCapsFeatures *features,
 361                                         GstStructure    *structure,
 362                                         gpointer         user_data);
 363
 364 /**
 365  * GstCapsMapFunc:
 366  * @features: the #GstCapsFeatures
 367  * @structure: the #GstStructure
 368  * @user_data: user data
 369  *
 370  * A function that will be called in gst_caps_map_in_place(). The function
 371  * may modify @features and @structure.
 372  *
 373  * Returns: %TRUE if the map operation should continue, %FALSE if
 374  * the map operation should stop with %FALSE.
 375  */
 376 typedef gboolean (*GstCapsMapFunc)     (GstCapsFeatures *features,
 377                                         GstStructure    *structure,
 378                                         gpointer         user_data);
 379
 380 /**
 381  * GstCapsFilterMapFunc:
 382  * @features: the #GstCapsFeatures
 383  * @structure: the #GstStructure
 384  * @user_data: user data
 385  *
 386  * A function that will be called in gst_caps_filter_and_map_in_place().
 387  * The function may modify @features and @structure, and both will be
 388  * removed from the caps if %FALSE is returned.
 389  *
 390  * Returns: %TRUE if the features and structure should be preserved,
 391  * %FALSE if it should be removed.
 392  */
 393 typedef gboolean (*GstCapsFilterMapFunc) (GstCapsFeatures *features,
 394                                           GstStructure    *structure,
 395                                           gpointer user_data);
 396
 397
 398 GType             gst_caps_get_type                (void);
 399
 400 GstCaps *         gst_caps_new_empty               (void);
 401 GstCaps *         gst_caps_new_any                 (void);
 402 GstCaps *         gst_caps_new_empty_simple        (const char    *media_type) G_GNUC_WARN_UNUSED_RESULT;
 403 GstCaps *         gst_caps_new_simple              (const char    *media_type,
 404                                                     const char    *fieldname,
 405                                                     ...) G_GNUC_NULL_TERMINATED G_GNUC_WARN_UNUSED_RESULT;
 406 GstCaps *         gst_caps_new_full                (GstStructure  *struct1,
 407                                                     ...) G_GNUC_NULL_TERMINATED G_GNUC_WARN_UNUSED_RESULT;
 408 GstCaps *         gst_caps_new_full_valist         (GstStructure  *structure,
 409                                                     va_list        var_args) G_GNUC_WARN_UNUSED_RESULT;
 410
 411 GType             gst_static_caps_get_type         (void);
 412 GstCaps *         gst_static_caps_get              (GstStaticCaps *static_caps);
 413 void              gst_static_caps_cleanup          (GstStaticCaps *static_caps);
 414
 415 /* manipulation */
 416 void              gst_caps_append                  (GstCaps       *caps1,
 417                                                     GstCaps       *caps2);
 418 void              gst_caps_append_structure        (GstCaps       *caps,
 419                                                     GstStructure  *structure);
 420 void              gst_caps_append_structure_full   (GstCaps       *caps,
 421                                                     GstStructure  *structure,
 422                                                     GstCapsFeatures *features);
 423 void              gst_caps_remove_structure        (GstCaps       *caps, guint idx);
 424 GstCaps *         gst_caps_merge                   (GstCaps       *caps1,
 425                                                     GstCaps       *caps2) G_GNUC_WARN_UNUSED_RESULT;
 426 GstCaps *         gst_caps_merge_structure         (GstCaps       *caps,
 427                                                     GstStructure  *structure) G_GNUC_WARN_UNUSED_RESULT;
 428 GstCaps *         gst_caps_merge_structure_full    (GstCaps       *caps,
 429                                                     GstStructure  *structure,
 430                                                     GstCapsFeatures *features) G_GNUC_WARN_UNUSED_RESULT;
 431 guint             gst_caps_get_size                (const GstCaps *caps);
 432 GstStructure *    gst_caps_get_structure           (const GstCaps *caps,
 433                                                     guint          index);
 434 GstStructure *    gst_caps_steal_structure         (GstCaps       *caps,
 435                                                     guint          index) G_GNUC_WARN_UNUSED_RESULT;
 436 void              gst_caps_set_features            (GstCaps *caps,
 437                                                     guint          index,
 438                                                     GstCapsFeatures * features);
 439 GstCapsFeatures * gst_caps_get_features            (const GstCaps *caps,
 440                                                     guint          index);
 441 GstCaps *         gst_caps_copy_nth                (const GstCaps *caps, guint nth) G_GNUC_WARN_UNUSED_RESULT;
 442 GstCaps *         gst_caps_truncate                (GstCaps       *caps) G_GNUC_WARN_UNUSED_RESULT;
 443 void              gst_caps_set_value               (GstCaps       *caps,
 444                                                     const char    *field,
 445                                                     const GValue  *value);
 446 void              gst_caps_set_simple              (GstCaps       *caps,
 447                                                     const char    *field, ...) G_GNUC_NULL_TERMINATED;
 448 void              gst_caps_set_simple_valist       (GstCaps       *caps,
 449                                                     const char    *field,
 450                                                     va_list        varargs);
 451
 452 gboolean          gst_caps_foreach                 (const GstCaps       *caps,
 453                                                     GstCapsForeachFunc   func,
 454                                                     gpointer             user_data);
 455
 456 gboolean          gst_caps_map_in_place            (GstCaps        *caps,
 457                                                     GstCapsMapFunc  func,
 458                                                     gpointer        user_data);
 459
 460 void              gst_caps_filter_and_map_in_place (GstCaps              *caps,
 461                                                     GstCapsFilterMapFunc  func,
 462                                                     gpointer              user_data);
 463
 464 /* tests */
 465 gboolean          gst_caps_is_any                  (const GstCaps *caps);
 466 gboolean          gst_caps_is_empty                (const GstCaps *caps);
 467 gboolean          gst_caps_is_fixed                (const GstCaps *caps);
 468 gboolean          gst_caps_is_always_compatible    (const GstCaps *caps1,
 469                                                     const GstCaps *caps2);
 470 gboolean          gst_caps_is_subset               (const GstCaps *subset,
 471                                                     const GstCaps *superset);
 472 gboolean          gst_caps_is_subset_structure     (const GstCaps *caps,
 473                                                     const GstStructure *structure);
 474 gboolean          gst_caps_is_subset_structure_full (const GstCaps *caps,
 475                                                      const GstStructure *structure,
 476                                                      const GstCapsFeatures *features);
 477 gboolean          gst_caps_is_equal                (const GstCaps *caps1,
 478                                                     const GstCaps *caps2);
 479 gboolean          gst_caps_is_equal_fixed          (const GstCaps *caps1,
 480                                                     const GstCaps *caps2);
 481 gboolean          gst_caps_can_intersect           (const GstCaps * caps1,
 482                                                     const GstCaps * caps2);
 483 gboolean          gst_caps_is_strictly_equal       (const GstCaps *caps1,
 484                                                     const GstCaps *caps2);
 485
 486
 487 /* operations */
 488 GstCaps *         gst_caps_intersect               (GstCaps *caps1,
 489                                                     GstCaps *caps2) G_GNUC_WARN_UNUSED_RESULT;
 490 GstCaps *         gst_caps_intersect_full          (GstCaps *caps1,
 491                                                     GstCaps *caps2,
 492                                                     GstCapsIntersectMode mode) G_GNUC_WARN_UNUSED_RESULT;
 493 GstCaps *         gst_caps_subtract                (GstCaps *minuend,
 494                                                     GstCaps *subtrahend) G_GNUC_WARN_UNUSED_RESULT;
 495 GstCaps *         gst_caps_normalize               (GstCaps *caps) G_GNUC_WARN_UNUSED_RESULT;
 496 GstCaps *         gst_caps_simplify                (GstCaps *caps) G_GNUC_WARN_UNUSED_RESULT;
 497
 498 GstCaps *         gst_caps_fixate                  (GstCaps *caps) G_GNUC_WARN_UNUSED_RESULT;
 499
 500 /* utility */
 501 gchar *           gst_caps_to_string               (const GstCaps *caps) G_GNUC_MALLOC;
 502 GstCaps *         gst_caps_from_string             (const gchar   *string) G_GNUC_WARN_UNUSED_RESULT;
 503
 504 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
 505 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstCaps, gst_caps_unref)
 506 #endif
 507
 508 G_END_DECLS
 509
 510 #endif /* __GST_CAPS_H__ */