gstreamer/gst/gstbuffer.h
Benjamin Otte df68257f94 EVENTS2 BRANCH: rewrote the buffer API
Original commit message from CVS:
EVENTS2 BRANCH:
rewrote the buffer API
2002-03-15 23:41:18 +00:00

142 lines
4.3 KiB
C

/* GStreamer
* Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
* 2000 Wim Taymans <wtay@chello.be>
*
* gstbuffer.h: Header for GstBuffer object
*
* 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__
/*
* Define this to add file:line info to each GstBuffer showing
* the location in the source code where the buffer was created.
*
* #define GST_BUFFER_WHERE
*
* Then in gdb, you can `call gst_buffer_print_live()' to get a list
* of allocated GstBuffers and also the file:line where they were
* allocated.
*/
#include <gst/gstdata.h>
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#ifdef HAVE_ATOMIC_H
#include <asm/atomic.h>
#endif
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/*
#define GST_BUFFER(buf) (((GstData*)(buf))->type == GST_BUFFER ? (GstBuffer *)(buf) : NULL)
*/
#define GST_BUFFER(buf) ((GstBuffer *)(buf))
#define GST_IS_BUFFER(buf) (((GstData*)(buf))->type == GST_DATA_BUFFER)
#ifdef HAVE_ATOMIC_H
# define GST_BUFFER_REFCOUNT(buf) (atomic_read(&(GST_DATA(buf)->refcount)))
#else
# define GST_BUFFER_REFCOUNT(buf) (GST_DATA(buf)->refcount)
#endif
#define GST_BUFFER_DATA(buf) (GST_BUFFER(buf)->data)
#define GST_BUFFER_SIZE(buf) (GST_BUFFER(buf)->size)
#define GST_BUFFER_OFFSET(buf) (GST_DATA(buf)->offset[GST_OFFSET_BYTES])
#define GST_BUFFER_MAXSIZE(buf) (GST_BUFFER(buf)->maxsize)
#define GST_BUFFER_TIMESTAMP(buf) (GST_DATA(buf)->offset[GST_OFFSET_TIME])
#define GST_BUFFER_MAXAGE(buf) (GST_BUFFER(buf)->maxage)
#define GST_BUFFER_BUFFERPOOL(buf) (GST_BUFFER(buf)->pool)
#define GST_BUFFER_PARENT(buf) (GST_BUFFER(buf)->parent)
#define GST_BUFFER_POOL_PRIVATE(buf) (GST_BUFFER(buf)->pool_private)
#define GST_BUFFER_COPY_FUNC(buf) (GST_BUFFER(buf)->copy)
#define GST_BUFFER_FREE_FUNC(buf) (GST_BUFFER(buf)->free)
#define GST_BUFFER_LOCK(buf) (g_mutex_lock(GST_BUFFER(buf)->lock))
#define GST_BUFFER_TRYLOCK(buf) (g_mutex_trylock(GST_BUFFER(buf)->lock))
#define GST_BUFFER_UNLOCK(buf) (g_mutex_unlock(GST_BUFFER(buf)->lock))
enum {
GST_BUFFER_ORIGINAL = GST_DATA_FLAG_LAST,
GST_BUFFER_FLAG_LAST,
};
typedef struct _GstBuffer GstBuffer;
#include <gst/gstbufferpool.h>
struct _GstBuffer {
GstData data_type;
/* pointer to data and its size */
gpointer data;
guint32 size;
/* subbuffer support, who's my parent? */
GstBuffer *parent;
/* this is a pointer to the buffer pool (if any) */
GstBufferPool * pool;
gpointer pool_private;
};
/* initialization */
void _gst_buffer_initialize (void);
/* allocation */
GstBuffer * gst_buffer_alloc (void);
void gst_buffer_free (GstBuffer *buffer);
/* inheritance */
void gst_buffer_init (GstBuffer *buffer, GstBufferPool *pool);
void gst_buffer_dispose (GstData *data);
/* creating a new buffer from scratch */
GstBuffer* gst_buffer_new (GstBufferPool *pool, guint size);
/* creating a subbuffer */
GstBuffer* gst_buffer_create_sub (GstBuffer *parent, guint32 offset, guint32 size);
/* copy buffer */
GstBuffer* gst_buffer_copy (const GstBuffer *buffer);
/* parentage */
void gst_buffer_set_parent (GstBuffer *buffer, GstBuffer *parent, guint offset, guint size);
void gst_buffer_unparent (GstBuffer *buffer);
/* merge, span, or append two buffers, intelligently */
GstBuffer* gst_buffer_merge (GstBuffer *buf1, GstBuffer *buf2);
GstBuffer* gst_buffer_span (GstBuffer *buf1, guint32 offset, GstBuffer *buf2, guint32 len);
GstBuffer* gst_buffer_append (GstBuffer *buffer, GstBuffer *append);
gboolean gst_buffer_is_span_fast (GstBuffer *buf1, GstBuffer *buf2);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* __GST_BUFFER_H__ */