gstbuffer.h 7.02 KB
Newer Older
1 2 3 4 5
/* GStreamer
 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
 *                    2000 Wim Taymans <wtay@chello.be>
 *
 * gstbuffer.h: Header for GstBuffer object
Erik Walthinsen's avatar
Erik Walthinsen committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */


#ifndef __GST_BUFFER_H__
#define __GST_BUFFER_H__

27
#include <gst/gstdata.h>
28
#include <gst/gstclock.h>
29
#include <gst/gstcaps.h>
30

31
G_BEGIN_DECLS
Erik Walthinsen's avatar
Erik Walthinsen committed
32

33 34 35
typedef struct _GstBuffer GstBuffer;

typedef void (*GstBufferFreeDataFunc) (GstBuffer *buffer);
36

37 38
#define GST_BUFFER_TRACE_NAME		"GstBuffer"

39
extern GType _gst_buffer_type;
40

41
#define GST_TYPE_BUFFER				(gst_buffer_get_type())
42

43 44
#define GST_BUFFER(buf)				((GstBuffer *)(buf))
#define GST_IS_BUFFER(buf)			(GST_DATA_TYPE(buf) == GST_TYPE_BUFFER)
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59

#define GST_BUFFER_REFCOUNT(buf)		GST_DATA_REFCOUNT(buf)
#define GST_BUFFER_REFCOUNT_VALUE(buf)		GST_DATA_REFCOUNT_VALUE(buf)
#define GST_BUFFER_COPY_FUNC(buf)		GST_DATA_COPY_FUNC(buf)
#define GST_BUFFER_FREE_FUNC(buf)		GST_DATA_FREE_FUNC(buf)

#define GST_BUFFER_FLAGS(buf)                   GST_DATA_FLAGS(buf)
#define GST_BUFFER_FLAG_IS_SET(buf,flag)        GST_DATA_FLAG_IS_SET (buf, flag)
#define GST_BUFFER_FLAG_SET(buf,flag)           GST_DATA_FLAG_SET (buf, flag)
#define GST_BUFFER_FLAG_UNSET(buf,flag)         GST_DATA_FLAG_UNSET (buf, flag)

#define GST_BUFFER_DATA(buf)			(GST_BUFFER(buf)->data)
#define GST_BUFFER_SIZE(buf)			(GST_BUFFER(buf)->size)
#define GST_BUFFER_MAXSIZE(buf)			(GST_BUFFER(buf)->maxsize)
#define GST_BUFFER_TIMESTAMP(buf)		(GST_BUFFER(buf)->timestamp)
60
#define GST_BUFFER_DURATION(buf)		(GST_BUFFER(buf)->duration)
61
#define GST_BUFFER_CAPS(buf)			(GST_BUFFER(buf)->caps)
62
#define GST_BUFFER_OFFSET(buf)			(GST_BUFFER(buf)->offset)
Benjamin Otte's avatar
Benjamin Otte committed
63
#define GST_BUFFER_OFFSET_END(buf)		(GST_BUFFER(buf)->offset_end)
64 65
#define GST_BUFFER_FREE_DATA_FUNC(buf)          (GST_BUFFER(buf)->free_data)
#define GST_BUFFER_PRIVATE(buf)                 (GST_BUFFER(buf)->buffer_private)
66

67 68 69
#define GST_BUFFER_OFFSET_NONE	((guint64)-1)
#define GST_BUFFER_MAXSIZE_NONE	((guint)0)

70
#define GST_BUFFER_DURATION_IS_VALID(buffer)	(GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DURATION (buffer)))
71
#define GST_BUFFER_TIMESTAMP_IS_VALID(buffer)	(GST_CLOCK_TIME_IS_VALID (GST_BUFFER_TIMESTAMP (buffer)))
72
#define GST_BUFFER_OFFSET_IS_VALID(buffer)	(GST_BUFFER_OFFSET (buffer) != GST_BUFFER_OFFSET_NONE)
Benjamin Otte's avatar
Benjamin Otte committed
73
#define GST_BUFFER_OFFSET_END_IS_VALID(buffer)	(GST_BUFFER_OFFSET_END (buffer) != GST_BUFFER_OFFSET_NONE)
74
#define GST_BUFFER_MAXSIZE_IS_VALID(buffer)	(GST_BUFFER_MAXSIZE (buffer) != GST_BUFFER_MAXSIZE_NONE)
75

76 77 78 79 80 81 82 83
/**
 * GstBufferFlag:
 * @GST_BUFFER_READONLY: the buffer is read-only.
 * @GST_BUFFER_SUBBUFFER: the buffer is a subbuffer, the parent buffer can be
 * found with the GST_BUFFER_POOL_PRIVATE() macro.
 * @GST_BUFFER_ORIGINAL: buffer is not a copy of another buffer.
 * @GST_BUFFER_DONTFREE: do not try to free the data when this buffer is
 * unreferenced.
84 85 86
 * @GST_BUFFER_PREROLL: the buffer is part of a preroll and should not be 
 * displayed.
 * @GST_BUFFER_DISCONT: the buffer marks a discontinuity in the stream.
87
 * @GST_BUFFER_IN_CAPS: the buffer has been added as a field in a #GstCaps.
88
 * @GST_BUFFER_GAP: the buffer has been created to fill a gap in the stream.
89 90 91 92 93 94
 * @GST_BUFFER_DELTA_UNIT: this unit cannot be decoded independently.
 * Since 0.8.5
 * @GST_BUFFER_FLAG_LAST: additional flags can be added starting from this flag.
 *
 * A set of buffer flags used to describe properties of a #GstBuffer.
 */
95 96 97
typedef enum {
  GST_BUFFER_READONLY   = GST_DATA_READONLY,
  GST_BUFFER_SUBBUFFER  = GST_DATA_FLAG_LAST,
98 99 100 101 102 103 104 105
  GST_BUFFER_ORIGINAL,		/* original data, not copied, not currently used  */
  GST_BUFFER_DONTFREE,		/* buffer data is managed by somebody else and cannot be freeed */
  GST_BUFFER_PREROLL,		/* sample should not be displayed */
  GST_BUFFER_DISCONT,		/* buffer is first after discontinuity in the stream */
  GST_BUFFER_IN_CAPS,		/* buffer is also part of caps */
  GST_BUFFER_GAP,		/* buffer has been created to fill a gap in the stream */
  GST_BUFFER_DELTA_UNIT,	/* can't be used as sync point in stream */
  GST_BUFFER_FLAG_LAST 	= GST_DATA_FLAG_LAST + 8
106
} GstBufferFlag;
Erik Walthinsen's avatar
Erik Walthinsen committed
107

108
struct _GstBuffer {
109
  GstData		 data_type;
110

111
  /*< public >*/ /* with COW */
112
  /* pointer to data and its size */
113 114
  guint8		*data;			/* pointer to buffer data */
  guint			 size;			/* size of buffer data */
115
  guint			 maxsize;		/* max size of this buffer */
116

Wim Taymans's avatar
Wim Taymans committed
117
  /* timestamp */
118 119
  GstClockTime		 timestamp;
  GstClockTime		 duration;
120

121 122 123
  /* the media type of this buffer */
  GstCaps		*caps;

124 125 126 127
  /* media specific offset
   * for video frames, this could be the number of frames,
   * for audio data, this could be the number of audio samples,
   * for file data or compressed data, this could be the number of bytes
Benjamin Otte's avatar
Benjamin Otte committed
128 129
   * offset_end is the last offset contained in the buffer. The format specifies
   * the meaning of both of them exactly.
130
   */
131 132
  guint64		 offset;
  guint64		 offset_end;
133

134
  /*< protected >*/
135
  GstBufferFreeDataFunc  free_data;
136
  gpointer		 buffer_private;
137

138
  /*< private >*/
139
  gpointer _gst_reserved[GST_PADDING];
140
};
141

142
/* allocation */
143
GType		gst_buffer_get_type		(void);
144
GstBuffer*	gst_buffer_new			(void);
145
GstBuffer*	gst_buffer_new_and_alloc	(guint size);
146

147 148
#define		gst_buffer_set_data(buf, data, size)	\
G_STMT_START {						\
149 150 151 152
  GST_BUFFER_DATA (buf) = data;				\
  GST_BUFFER_SIZE (buf) = size;				\
} G_STMT_END

Erik Walthinsen's avatar
Erik Walthinsen committed
153
/* refcounting */
154 155 156 157
#define		gst_buffer_ref(buf)		GST_BUFFER (gst_data_ref (GST_DATA (buf)))
#define		gst_buffer_ref_by_count(buf,c)	GST_BUFFER (gst_data_ref_by_count (GST_DATA (buf), c))
#define		gst_buffer_unref(buf)		gst_data_unref (GST_DATA (buf))
/* copy buffer */
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
158
#define		gst_buffer_copy(buf)		GST_BUFFER (gst_data_copy (GST_DATA (buf)))
159
#define		gst_buffer_is_writable(buf)	gst_data_is_writable (GST_DATA (buf))
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
160
#define		gst_buffer_copy_on_write(buf)   GST_BUFFER (gst_data_copy_on_write (GST_DATA (buf)))
Erik Walthinsen's avatar
Erik Walthinsen committed
161

162 163 164
GstCaps*	gst_buffer_get_caps		(GstBuffer *buffer);
void		gst_buffer_set_caps		(GstBuffer *buffer, GstCaps *caps);

165
/* creating a subbuffer */
166
GstBuffer*	gst_buffer_create_sub		(GstBuffer *parent, guint offset, guint size);
167

168
/* span, two buffers, intelligently */
169 170
gboolean	gst_buffer_is_span_fast		(GstBuffer *buf1, GstBuffer *buf2);
GstBuffer*	gst_buffer_span			(GstBuffer *buf1, guint32 offset, GstBuffer *buf2, guint32 len);
171

172
/* --- protected --- */
173
void		_gst_buffer_initialize		(void);
Wim Taymans's avatar
Wim Taymans committed
174

175 176
void		gst_buffer_default_free		(GstBuffer *buffer);
GstBuffer*	gst_buffer_default_copy		(GstBuffer *buffer);
Wim Taymans's avatar
Wim Taymans committed
177

178
G_END_DECLS
179

Erik Walthinsen's avatar
Erik Walthinsen committed
180
#endif /* __GST_BUFFER_H__ */