2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wim.taymans@chello.be>
5 * gstdata.h: Header for GstData objects (used for data passing)
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.
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.
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.
24 #ifndef __GST_DATA_H__
25 #define __GST_DATA_H__
27 #include <glib-object.h>
28 #include <gst/gstatomic.h>
33 #define GST_DATA(data) ((GstData*)(data))
34 #define GST_DATA_TYPE(data) (GST_DATA(data)->type)
37 #define GST_DATA_FLAGS(data) (GST_DATA(data)->flags)
38 #define GST_DATA_FLAG_SHIFT(flag) (1<<(flag))
39 #define GST_DATA_FLAG_IS_SET(data,flag) (GST_DATA_FLAGS(data) & (1<<(flag)))
40 #define GST_DATA_FLAG_SET(data,flag) G_STMT_START{ (GST_DATA_FLAGS(data) |= (1<<(flag))); }G_STMT_END
41 #define GST_DATA_FLAG_UNSET(data,flag) G_STMT_START{ (GST_DATA_FLAGS(data) &= ~(1<<(flag))); }G_STMT_END
43 typedef struct _GstData GstData;
45 typedef void (*GstDataFreeFunction) (GstData *data);
46 typedef GstData* (*GstDataCopyFunction) (const GstData *data);
50 GST_DATA_READONLY = 1,
53 GST_DATA_FLAG_LAST = 8
57 #define GST_DATA_REFCOUNT(data) ((GST_DATA(data))->refcount)
58 #define GST_DATA_REFCOUNT_VALUE(data) (gst_atomic_int_read (&(GST_DATA(data))->refcount))
60 /* copy/free functions */
61 #define GST_DATA_COPY_FUNC(data) (GST_DATA(data)->copy)
62 #define GST_DATA_FREE_FUNC(data) (GST_DATA(data)->free)
69 GstAtomicInt refcount;
73 /* utility function pointers, can override default */
74 GstDataFreeFunction free; /* free the data */
75 GstDataCopyFunction copy; /* copy the data */
78 /* function used by subclasses only */
79 void gst_data_init (GstData *data, GType type, guint16 flags,
80 GstDataFreeFunction free,
81 GstDataCopyFunction copy);
82 void gst_data_dispose (GstData *data);
83 void gst_data_copy_into (const GstData *data, GstData *target);
85 /* basic operations on data */
86 GstData* gst_data_copy (const GstData *data);
87 gboolean gst_data_is_writable (GstData *data);
88 GstData* gst_data_copy_on_write (GstData *data);
89 void gst_data_free (GstData *data);
91 /* reference counting */
92 GstData* gst_data_ref (GstData* data);
93 GstData* gst_data_ref_by_count (GstData* data, gint count);
94 void gst_data_unref (GstData* data);
98 #endif /* __GST_DATA_H__ */