gst/gstcaps.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *
   5  * gstcaps.h: Header for caps subsystem
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23
  24 #ifndef __GST_CAPS_H__
  25 #define __GST_CAPS_H__
  26
  27 #include <gst/gstconfig.h>
  28
  29 #include <gst/gstprops.h>
  30
  31 typedef struct _GstCaps GstCaps;
  32
  33 #define GST_CAPS(caps) \
  34   ((GstCaps *)(caps))
  35
  36 #define GST_CAPS_LOCK(caps)    (g_mutex_lock(GST_CAPS(caps)->lock))
  37 #define GST_CAPS_TRYLOCK(caps) (g_mutex_trylock(GST_CAPS(caps)->lock))
  38 #define GST_CAPS_UNLOCK(caps)  (g_mutex_unlock(GST_CAPS(caps)->lock))
  39
  40 struct _GstCaps {
  41   gchar *name;                  /* the name of this caps */
  42   guint16 id;                   /* type id (major type) */
  43
  44   guint refcount;
  45   GMutex *lock;                 /* global lock for this capability */
  46
  47   GstProps *properties;         /* properties for this capability */
  48
  49   GstCaps *next;
  50 };
  51
  52 #define GST_CAPS_NEW(name, type, a...)          \
  53 gst_caps_new (                                  \
  54   name,                                         \
  55   type,                                         \
  56   gst_props_new (                               \
  57     a,                                          \
  58     NULL))
  59
  60 #define GST_CAPS_FACTORY(factoryname, a...)     \
  61 static GstCaps*                                 \
  62 factoryname (void)                              \
  63 {                                               \
  64   static GstCaps *caps = NULL;                  \
  65   if (!caps) {                                  \
  66     caps = gst_caps_chain (a, NULL);            \
  67   }                                             \
  68   return caps;                                  \
  69 }
  70
  71 #define GST_CAPS_GET(fact) (fact)()
  72
  73
  74 /* initialize the subsystem */
  75 void            _gst_caps_initialize                    (void);
  76
  77 GstCaps*        gst_caps_new                            (const gchar *name, const gchar *mime, GstProps *props);
  78
  79 GstCaps*        gst_caps_unref                          (GstCaps *caps);
  80 GstCaps*        gst_caps_ref                            (GstCaps *caps);
  81 void            gst_caps_destroy                        (GstCaps *caps);
  82
  83 GstCaps*        gst_caps_copy                           (GstCaps *caps);
  84 GstCaps*        gst_caps_copy_on_write                  (GstCaps *caps);
  85
  86 const gchar*    gst_caps_get_name                       (GstCaps *caps);
  87 void            gst_caps_set_name                       (GstCaps *caps, const gchar *name);
  88
  89 const gchar*    gst_caps_get_mime                       (GstCaps *caps);
  90 void            gst_caps_set_mime                       (GstCaps *caps, const gchar *mime);
  91
  92 guint16         gst_caps_get_type_id                    (GstCaps *caps);
  93 void            gst_caps_set_type_id                    (GstCaps *caps, guint16 type_id);
  94
  95 GstCaps*        gst_caps_set_props                      (GstCaps *caps, GstProps *props);
  96 GstProps*       gst_caps_get_props                      (GstCaps *caps);
  97
  98 #define         gst_caps_set(caps, name, args...)       gst_props_set ((caps)->properties, name, args)
  99
 100 #define         gst_caps_get_int(caps, name)            gst_props_get_int ((caps)->properties, name)
 101 #define         gst_caps_get_float(caps, name)          gst_props_get_float ((caps)->properties, name)
 102 #define         gst_caps_get_fourcc_int(caps, name)     gst_props_get_fourcc_int ((caps)->properties, name)
 103 #define         gst_caps_get_boolean(caps, name)        gst_props_get_boolean ((caps)->properties, name)
 104 #define         gst_caps_get_string(caps, name)         gst_props_get_string ((caps)->properties, name)
 105
 106 GstCaps*        gst_caps_get_by_name                    (GstCaps *caps, const gchar *name);
 107
 108 GstCaps*        gst_caps_chain                          (GstCaps *caps, ...);
 109 GstCaps*        gst_caps_append                         (GstCaps *caps, GstCaps *capstoadd);
 110 GstCaps*        gst_caps_prepend                        (GstCaps *caps, GstCaps *capstoadd);
 111
 112 gboolean        gst_caps_check_compatibility            (GstCaps *fromcaps, GstCaps *tocaps);
 113
 114 #ifndef GST_DISABLE_LOADSAVE
 115 xmlNodePtr      gst_caps_save_thyself                   (GstCaps *caps, xmlNodePtr parent);
 116 GstCaps*        gst_caps_load_thyself                   (xmlNodePtr parent);
 117 #endif
 118
 119 #endif /* __GST_CAPS_H__ */