gst/gstminiobject.h

   1 /* GStreamer
   2  * Copyright (C) 2005 David Schleef <ds@schleef.org>
   3  *
   4  * gstminiobject.h: Header for GstMiniObject
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  */
  21
  22
  23 #ifndef __GST_MINI_OBJECT_H__
  24 #define __GST_MINI_OBJECT_H__
  25
  26 #include <glib-object.h>
  27 #include "gst/gsttypes.h"
  28
  29 G_BEGIN_DECLS
  30
  31 #define GST_TYPE_MINI_OBJECT          (gst_mini_object_get_type())
  32 #define GST_IS_MINI_OBJECT(obj)       (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_MINI_OBJECT))
  33 #define GST_IS_MINI_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_MINI_OBJECT))
  34 #define GST_MINI_OBJECT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_MINI_OBJECT, GstMiniObjectClass))
  35 #define GST_MINI_OBJECT(obj)          (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_MINI_OBJECT, GstMiniObject))
  36 #define GST_MINI_OBJECT_CLASS(klass)  (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_MINI_OBJECT, GstMiniObjectClass))
  37
  38 typedef struct _GstMiniObject GstMiniObject;
  39 typedef struct _GstMiniObjectClass GstMiniObjectClass;
  40
  41 typedef GstMiniObject * (*GstMiniObjectCopyFunction) (const GstMiniObject *);
  42 typedef void (*GstMiniObjectFinalizeFunction) (GstMiniObject *);
  43
  44 #define GST_MINI_OBJECT_FLAGS(obj)  (GST_MINI_OBJECT(obj)->flags)
  45 #define GST_MINI_OBJECT_FLAG_IS_SET(obj,flag)        (GST_MINI_OBJECT_FLAGS(obj) & (flag))
  46 #define GST_MINI_OBJECT_FLAG_SET(obj,flag)           (GST_MINI_OBJECT_FLAGS (obj) |= (flag))
  47 #define GST_MINI_OBJECT_FLAG_UNSET(obj,flag)         (GST_MINI_OBJECT_FLAGS (obj) &= ~(flag))
  48
  49 #define GST_VALUE_HOLDS_MINI_OBJECT(value)  (G_VALUE_HOLDS(value, GST_TYPE_MINI_OBJECT))
  50
  51 typedef enum
  52 {
  53   GST_MINI_OBJECT_FLAG_READONLY = (1<<0),
  54   GST_MINI_OBJECT_FLAG_STATIC = (1<<1),
  55   GST_MINI_OBJECT_FLAG_LAST = (1<<4)
  56 } GstMiniObjectFlags;
  57
  58
  59 struct _GstMiniObject {
  60   GTypeInstance instance;
  61   gint refcount;
  62   guint flags;
  63
  64   gpointer _gst_reserved[GST_PADDING];
  65 };
  66
  67 struct _GstMiniObjectClass {
  68   GTypeClass type_class;
  69
  70   GstMiniObjectCopyFunction copy;
  71   GstMiniObjectFinalizeFunction finalize;
  72
  73   gpointer _gst_reserved[GST_PADDING];
  74 };
  75
  76 GType gst_mini_object_get_type (void);
  77
  78 GstMiniObject * gst_mini_object_new (GType type);
  79 GstMiniObject * gst_mini_object_copy (const GstMiniObject *mini_object);
  80 gboolean gst_mini_object_is_writable (const GstMiniObject *mini_object);
  81 GstMiniObject * gst_mini_object_make_writable (const GstMiniObject *mini_object);
  82
  83 GstMiniObject * gst_mini_object_ref (GstMiniObject *mini_object);
  84 void gst_mini_object_unref (GstMiniObject *mini_object);
  85
  86 void gst_mini_object_replace (GstMiniObject **olddata, GstMiniObject *newdata);
  87
  88 GParamSpec * gst_param_spec_mini_object (const char *name, const char *nick,
  89     const char *blurb, GType object_type, GParamFlags flags);
  90
  91 void gst_value_set_mini_object (GValue *value, GstMiniObject *mini_object);
  92 void gst_value_take_mini_object (GValue *value, GstMiniObject *mini_object);
  93 GstMiniObject * gst_value_get_mini_object (const GValue *value);
  94
  95
  96 G_END_DECLS
  97
  98 #endif
  99