gst/gstdata.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wim.taymans@chello.be>
   4  *
   5  * gstdata.h: Header for GstData objects (used for data passing)
   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_DATA_H__
  25 #define __GST_DATA_H__
  26
  27 #include <glib-object.h>
  28 #include <gst/gstatomic.h>
  29 #include <gst/gsttypes.h>
  30
  31 G_BEGIN_DECLS
  32
  33 /* type */
  34 #define GST_DATA(data)          ((GstData*)(data))
  35 #define GST_DATA_TYPE(data)     (GST_DATA(data)->type)
  36
  37 /* flags */
  38 #define GST_DATA_FLAGS(data)            (GST_DATA(data)->flags)
  39 #define GST_DATA_FLAG_SHIFT(flag)       (1<<(flag))
  40 #define GST_DATA_FLAG_IS_SET(data,flag) (GST_DATA_FLAGS(data) & (1<<(flag)))
  41 #define GST_DATA_FLAG_SET(data,flag)    G_STMT_START{ (GST_DATA_FLAGS(data) |= (1<<(flag))); }G_STMT_END
  42 #define GST_DATA_FLAG_UNSET(data,flag)  G_STMT_START{ (GST_DATA_FLAGS(data) &= ~(1<<(flag))); }G_STMT_END
  43
  44 typedef struct _GstData GstData;
  45
  46 typedef void            (*GstDataFreeFunction)          (GstData *data);
  47 typedef GstData*        (*GstDataCopyFunction)          (const GstData *data);
  48
  49 typedef enum
  50 {
  51   GST_DATA_READONLY     = 1,
  52
  53   /* insert more */
  54   GST_DATA_FLAG_LAST    = 8
  55 } GstDataFlags;
  56
  57 /* refcount */
  58 #define GST_DATA_REFCOUNT(data)                 ((GST_DATA(data))->refcount)
  59 #define GST_DATA_REFCOUNT_VALUE(data)           (gst_atomic_int_read (&(GST_DATA(data))->refcount))
  60
  61 /* copy/free functions */
  62 #define GST_DATA_COPY_FUNC(data)                (GST_DATA(data)->copy)
  63 #define GST_DATA_FREE_FUNC(data)                (GST_DATA(data)->free)
  64
  65
  66 struct _GstData {
  67   GType                  type;
  68
  69   /* refcounting */
  70   GstAtomicInt           refcount;
  71
  72   guint16                flags;
  73
  74   /* utility function pointers, can override default */
  75   GstDataFreeFunction    free;          /* free the data */
  76   GstDataCopyFunction    copy;          /* copy the data */
  77
  78   gpointer _gst_reserved[GST_PADDING];
  79 };
  80
  81 /* function used by subclasses only */
  82 void                    gst_data_init                   (GstData *data, GType type, guint16 flags,
  83                                                          GstDataFreeFunction free,
  84                                                          GstDataCopyFunction copy);
  85 void                    gst_data_dispose                (GstData *data);
  86 void                    gst_data_copy_into              (const GstData *data, GstData *target);
  87
  88 /* basic operations on data */
  89 GstData*                gst_data_copy                   (const GstData *data);
  90 gboolean                gst_data_is_writable            (GstData *data);
  91 GstData*                gst_data_copy_on_write          (GstData *data);
  92 void                    gst_data_free                   (GstData *data);
  93
  94 /* reference counting */
  95 GstData*                gst_data_ref                    (GstData* data);
  96 GstData*                gst_data_ref_by_count           (GstData* data, gint count);
  97 void                    gst_data_unref                  (GstData* data);
  98
  99 G_END_DECLS
 100
 101 #endif /* __GST_DATA_H__ */