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., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #ifndef __GST_CAPS_H__
  21 #define __GST_CAPS_H__
  22
  23 #include <gst/gstconfig.h>
  24 #include <gst/gststructure.h>
  25
  26 G_BEGIN_DECLS
  27
  28 #define GST_TYPE_CAPS             (gst_caps_get_type())
  29 #define GST_CAPS(object)          ((GstCaps*)object)
  30 #define GST_IS_CAPS(object)       ((object) && (GST_CAPS(object)->type == GST_TYPE_CAPS))
  31
  32 #define GST_CAPS_FLAGS_ANY        (1 << 0)
  33
  34 #define GST_CAPS_ANY              gst_caps_new_any()
  35 #define GST_CAPS_NONE             gst_caps_new_empty()
  36
  37 #define GST_STATIC_CAPS_ANY       GST_STATIC_CAPS("ANY")
  38 #define GST_STATIC_CAPS_NONE      GST_STATIC_CAPS("NONE")
  39
  40 #define GST_CAPS_IS_SIMPLE(caps) (gst_caps_get_size(caps) == 1)
  41 #define gst_caps_is_simple(caps) GST_CAPS_IS_SIMPLE(caps)
  42
  43 #ifndef GST_DISABLE_DEPRECATED
  44 #define GST_DEBUG_CAPS(string, caps) \
  45   GST_DEBUG ( string "%s: " GST_PTR_FORMAT, caps)
  46 #endif
  47
  48 #define GST_STATIC_CAPS(string) \
  49 { \
  50   /* caps */ { 0 }, \
  51   /* string */ string, \
  52 }
  53
  54 typedef struct _GstCaps GstCaps;
  55 typedef struct _GstStaticCaps GstStaticCaps;
  56
  57 /* refcount */
  58 #define GST_CAPS_REFCOUNT(caps)                 ((GST_CAPS(caps))->refcount)
  59 #define GST_CAPS_REFCOUNT_VALUE(caps)           (gst_atomic_int_read (&(GST_CAPS(caps))->refcount))
  60
  61 struct _GstCaps {
  62   GType type;
  63
  64   /*< public >*/ /* with COW */
  65   /* refcounting */
  66   GstAtomicInt           refcount;
  67
  68   guint16 flags;
  69   GPtrArray *structs;
  70
  71   /*< private >*/
  72   gpointer _gst_reserved[GST_PADDING];
  73 };
  74
  75 struct _GstStaticCaps {
  76   /*< public >*/
  77   GstCaps caps;
  78   const char *string;
  79
  80   /*< private >*/
  81   gpointer _gst_reserved[GST_PADDING];
  82 };
  83
  84 GType                    gst_caps_get_type                              (void);
  85 GstCaps *                gst_caps_new_empty                             (void);
  86 GstCaps *                gst_caps_new_any                               (void);
  87 GstCaps *                gst_caps_new_simple                            (const char    *media_type,
  88                                                                          const char    *fieldname,
  89                                                                          ...);
  90 GstCaps *                gst_caps_new_full                              (GstStructure  *struct1,
  91                                                                                          ...);
  92 GstCaps *                gst_caps_new_full_valist                       (GstStructure  *structure,
  93                                                                          va_list        var_args);
  94
  95 /* reference counting */
  96 GstCaps *                gst_caps_ref                                   (GstCaps* caps);
  97 GstCaps *                gst_caps_copy                                  (const GstCaps * caps);
  98 GstCaps *                gst_caps_make_writable                         (GstCaps *caps);
  99 void                     gst_caps_unref                                 (GstCaps* caps);
 100
 101 G_CONST_RETURN GstCaps * gst_static_caps_get                            (GstStaticCaps *static_caps);
 102
 103 /* manipulation */
 104 void                     gst_caps_append                                (GstCaps       *caps1,
 105                                                                          GstCaps       *caps2);
 106 void                     gst_caps_append_structure                      (GstCaps       *caps,
 107                                                                          GstStructure  *structure);
 108 int                      gst_caps_get_size                              (const GstCaps *caps);
 109 GstStructure *           gst_caps_get_structure                         (const GstCaps *caps,
 110                                                                          int            index);
 111 GstCaps *                gst_caps_copy_nth                              (const GstCaps * caps, gint nth);
 112 void                     gst_caps_set_simple                            (GstCaps       *caps,
 113                                                                          char          *field, ...);
 114 void                     gst_caps_set_simple_valist                     (GstCaps       *caps,
 115                                                                          char          *field,
 116                                                                          va_list        varargs);
 117
 118 /* tests */
 119 gboolean                 gst_caps_is_any                                (const GstCaps *caps);
 120 gboolean                 gst_caps_is_empty                              (const GstCaps *caps);
 121 gboolean                 gst_caps_is_fixed                              (const GstCaps *caps);
 122 gboolean                 gst_caps_is_always_compatible                  (const GstCaps *caps1,
 123                                                                          const GstCaps *caps2);
 124 gboolean                 gst_caps_is_subset                             (const GstCaps *subset,
 125                                                                          const GstCaps *superset);
 126 gboolean                 gst_caps_is_equal                              (const GstCaps *caps1,
 127                                                                          const GstCaps *caps2);
 128
 129 /* operations */
 130 GstCaps *                gst_caps_intersect                             (const GstCaps *caps1,
 131                                                                          const GstCaps *caps2);
 132 GstCaps *                gst_caps_subtract                              (const GstCaps *minuend,
 133                                                                          const GstCaps *subtrahend);
 134 GstCaps *                gst_caps_union                                 (const GstCaps *caps1,
 135                                                                          const GstCaps *caps2);
 136 GstCaps *                gst_caps_normalize                             (const GstCaps *caps);
 137 gboolean                 gst_caps_do_simplify                           (GstCaps *caps);
 138
 139 #ifndef GST_DISABLE_LOADSAVE
 140 xmlNodePtr               gst_caps_save_thyself                          (const GstCaps *caps,
 141                                                                          xmlNodePtr     parent);
 142 GstCaps *                gst_caps_load_thyself                          (xmlNodePtr     parent);
 143 #endif
 144
 145 /* utility */
 146 void                     gst_caps_replace                               (GstCaps      **caps,
 147                                                                          GstCaps       *newcaps);
 148 gchar *                  gst_caps_to_string                             (const GstCaps *caps);
 149 GstCaps *                gst_caps_from_string                           (const gchar   *string);
 150
 151 G_END_DECLS
 152
 153 #endif /* __GST_CAPS_H__ */