gstreamer/gst/gstbuffer.h

/* 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 */

extern GType _gst_buffer_type;

#define GST_TYPE_BUFFER		(_gst_buffer_type)
#define GST_BUFFER(buf) 	((GstBuffer *)(buf))
#define GST_IS_BUFFER(buf)	(GST_DATA_TYPE(buf) == GST_TYPE_BUFFER)

#define GST_BUFFER_FLAGS(buf)		 	(GST_BUFFER(buf)->flags)
#define GST_BUFFER_FLAG_IS_SET(buf,flag) 	(GST_BUFFER_FLAGS(buf) & (1<<(flag)))
#define GST_BUFFER_FLAG_SET(buf,flag) 		G_STMT_START{ (GST_BUFFER_FLAGS(buf) |= (1<<(flag))); }G_STMT_END
#define GST_BUFFER_FLAG_UNSET(buf,flag) 	G_STMT_START{ (GST_BUFFER_FLAGS(buf) &= ~(1<<(flag))); }G_STMT_END


#define GST_BUFFER_DATA(buf)		(GST_BUFFER(buf)->data)
#define GST_BUFFER_SIZE(buf)		(GST_BUFFER(buf)->size)
#define GST_BUFFER_OFFSET(buf)		(GST_BUFFER(buf)->offset)
#define GST_BUFFER_MAXSIZE(buf)		(GST_BUFFER(buf)->maxsize)
#define GST_BUFFER_TIMESTAMP(buf)	(GST_BUFFER(buf)->timestamp)
#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))


typedef enum {
  GST_BUFFER_READONLY,
  GST_BUFFER_ORIGINAL,
  GST_BUFFER_DONTFREE,

} GstBufferFlag;


typedef struct _GstBuffer GstBuffer;


typedef void       (*GstBufferFreeFunc)	(GstBuffer *buf);
typedef GstBuffer *(*GstBufferCopyFunc)	(GstBuffer *srcbuf);


#include <gst/gstbufferpool.h>

struct _GstBuffer {
  GstData 		data_type;

  /* locking */
  GMutex 		*lock;

  /* refcounting */
#ifdef HAVE_ATOMIC_H
  atomic_t 		refcount;
#define GST_BUFFER_REFCOUNT(buf)	(atomic_read(&(GST_BUFFER((buf))->refcount)))
#else
  int 			refcount;
#define GST_BUFFER_REFCOUNT(buf)	(GST_BUFFER(buf)->refcount)
#endif

  /* flags */
  guint16 		flags; /* boolean properties of buffer */

  /* pointer to data, its size, and offset in original source if known */
  guchar 		*data;
  guint32 		size;
  guint32 		maxsize;
  guint32 		offset;

  /* timestamp */
  gint64 		timestamp; /* nanoseconds since zero */
  gint64 		maxage;    /* FIXME: not used yet */

  /* subbuffer support, who's my parent? */
  GstBuffer 		*parent;

  /* this is a pointer to the buffer pool (if any) */
  GstBufferPool 	*pool;
  gpointer 		pool_private;

  /* utility function pointers, can override default */
  GstBufferFreeFunc 	free;		/* free the data associated with the buffer */
  GstBufferCopyFunc 	copy;		/* copy the data from one buffer to another */
};

/* initialisation */
void 		_gst_buffer_initialize		(void);
/* creating a new buffer from scratch */
GstBuffer*	gst_buffer_new			(void);
GstBuffer*	gst_buffer_new_from_pool 	(GstBufferPool *pool, guint32 offset, guint32 size);

/* creating a subbuffer */
GstBuffer*	gst_buffer_create_sub		(GstBuffer *parent, guint32 offset, guint32 size);

/* refcounting */
void 		gst_buffer_ref			(GstBuffer *buffer);
void 		gst_buffer_ref_by_count		(GstBuffer *buffer, gint count);
void 		gst_buffer_unref		(GstBuffer *buffer);

/* destroying the buffer */
void 		gst_buffer_destroy		(GstBuffer *buffer);

/* copy buffer */
GstBuffer*	gst_buffer_copy			(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);

void		gst_buffer_print_stats		(void);

#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __GST_BUFFER_H__ */