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)          (G_TYPE_CHECK_INSTANCE_CAST ((object), GST_TYPE_CAPS, GstCaps))
  30 #define GST_IS_CAPS(object)       (G_TYPE_CHECK_INSTANCE_TYPE ((object), 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 struct _GstCaps {
  58   GType type;
  59
  60   guint16 flags;
  61   GPtrArray *structs;
  62 };
  63
  64 struct _GstStaticCaps {
  65   GstCaps caps;
  66   const char *string;
  67 };
  68
  69 GType                    gst_caps_get_type                              (void) G_GNUC_CONST;
  70 GstCaps *                gst_caps_new_empty                             (void);
  71 GstCaps *                gst_caps_new_any                               (void);
  72 GstCaps *                gst_caps_new_simple                            (const char    *media_type,
  73                                                                          const char    *fieldname,
  74                                                                          ...);
  75 GstCaps *                gst_caps_new_full                              (GstStructure  *struct1,
  76                                                                                          ...);
  77 GstCaps *                gst_caps_new_full_valist                       (GstStructure  *structure,
  78                                                                          va_list        var_args);
  79 GstCaps *                gst_caps_copy                                  (const GstCaps *caps);
  80 void                     gst_caps_free                                  (GstCaps       *caps);
  81 G_CONST_RETURN GstCaps * gst_static_caps_get                            (GstStaticCaps *caps);
  82
  83 /* manipulation */
  84 void                     gst_caps_append                                (GstCaps       *caps1,
  85                                                                          GstCaps       *caps2);
  86 void                     gst_caps_append_structure                      (GstCaps       *caps1,
  87                                                                          GstStructure  *structure);
  88 GstCaps *                gst_caps_split_one                             (GstCaps       *caps);
  89 int                      gst_caps_get_size                              (const GstCaps *caps);
  90 GstStructure *           gst_caps_get_structure                         (const GstCaps *caps,
  91                                                                          int            index);
  92 #ifndef GST_DISABLE_DEPRECATED
  93 GstCaps *                gst_caps_copy_1                                (const GstCaps *caps);
  94 #endif
  95 void                     gst_caps_set_simple                            (GstCaps       *caps,
  96                                                                          char          *field, ...);
  97 void                     gst_caps_set_simple_valist                     (GstCaps       *caps,
  98                                                                          char          *field,
  99                                                                          va_list        varargs);
 100
 101 /* tests */
 102 gboolean                 gst_caps_is_any                                (const GstCaps *caps);
 103 gboolean                 gst_caps_is_empty                              (const GstCaps *caps);
 104 #ifndef GST_DISABLE_DEPRECATED
 105 gboolean                 gst_caps_is_chained                            (const GstCaps *caps);
 106 #endif
 107 gboolean                 gst_caps_is_fixed                              (const GstCaps *caps);
 108 gboolean                 gst_caps_is_equal_fixed                        (const GstCaps *caps1,
 109                                                                          const GstCaps *caps2);
 110 gboolean                 gst_caps_is_always_compatible                  (const GstCaps *caps1,
 111                                                                          const GstCaps *caps2);
 112
 113 /* operations */
 114 GstCaps *                gst_caps_intersect                             (const GstCaps *caps1,
 115                                                                          const GstCaps *caps2);
 116 GstCaps *                gst_caps_union                                 (const GstCaps *caps1,
 117                                                                          const GstCaps *caps2);
 118 GstCaps *                gst_caps_normalize                             (const GstCaps *caps);
 119 GstCaps *                gst_caps_simplify                              (const GstCaps *caps);
 120
 121 #ifndef GST_DISABLE_LOADSAVE
 122 xmlNodePtr               gst_caps_save_thyself                          (const GstCaps *caps,
 123                                                                          xmlNodePtr     parent);
 124 GstCaps *                gst_caps_load_thyself                          (xmlNodePtr     parent);
 125 #endif
 126
 127 /* utility */
 128 void                     gst_caps_replace                               (GstCaps      **caps,
 129                                                                          GstCaps       *newcaps);
 130 gchar *                  gst_caps_to_string                             (const GstCaps *caps);
 131 GstCaps *                gst_caps_from_string                           (const gchar   *string);
 132
 133 gboolean                 gst_caps_structure_fixate_field_nearest_int    (GstStructure *structure,
 134                                                                          const char   *field_name,
 135                                                                          int           target);
 136 gboolean                 gst_caps_structure_fixate_field_nearest_double (GstStructure *structure,
 137                                                                          const char   *field_name,
 138                                                                          double        target);
 139
 140 G_END_DECLS
 141
 142 #endif /* __GST_CAPS_H__ */