gstreamer/gst/gstbufferpool.h

/* GStreamer
 * Copyright (C) 2010 Wim Taymans <wim.taymans@gmail.com>
 *
 * gstbufferpool.h: Header for GstBufferPool 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_POOL_H__
#define __GST_BUFFER_POOL_H__

#include <gst/gstminiobject.h>
#include <gst/gstatomicqueue.h>
#include <gst/gstpoll.h>
#include <gst/gstclock.h>
#include <gst/gstpad.h>
#include <gst/gstbuffer.h>

G_BEGIN_DECLS

typedef struct _GstBufferPool GstBufferPool;
typedef struct _GstBufferPoolClass GstBufferPoolClass;

/**
 * GST_BUFFER_POOL_TRACE_NAME:
 *
 * The name used for tracing memory allocations.
 */
#define GST_BUFFER_POOL_TRACE_NAME           "GstBufferPool"

#define GST_TYPE_BUFFER_POOL                 (gst_buffer_pool_get_type())
#define GST_IS_BUFFER_POOL(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_BUFFER_POOL))
#define GST_IS_BUFFER_POOL_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_BUFFER_POOL))
#define GST_BUFFER_POOL_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_BUFFER_POOL, GstBufferPoolClass))
#define GST_BUFFER_POOL(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_BUFFER_POOL, GstBufferPool))
#define GST_BUFFER_POOL_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_BUFFER_POOL, GstBufferPoolClass))
#define GST_BUFFER_POOL_CAST(obj)            ((GstBufferPool *)(obj))

/**
 * GstBufferPoolFlags:
 * @GST_BUFFER_POOL_FLAG_NONE: no flags
 * @GST_BUFFER_POOL_FLAG_KEY_UNIT: buffer is keyframe
 * @GST_BUFFER_POOL_FLAG_WAIT: wait for buffer
 * @GST_BUFFER_POOL_FLAG_DISCONT: buffer is discont
 *
 * Additional flags to control the allocation of a buffer
 */
typedef enum {
  GST_BUFFER_POOL_FLAG_NONE     = 0,
  GST_BUFFER_POOL_FLAG_KEY_UNIT = (1 << 0),
  GST_BUFFER_POOL_FLAG_WAIT     = (1 << 1),
  GST_BUFFER_POOL_FLAG_DISCONT  = (1 << 2),
  GST_BUFFER_POOL_FLAG_LAST     = (1 << 16),
} GstBufferPoolFlags;

/**
 * GstBufferPoolParams:
 * @format: the format of @start and @stop
 * @start: the start position
 * @stop: the stop position
 * @flags: additional flags
 *
 * Parameters passed to the gst_buffer_pool_acquire_buffer() function to control the
 * allocation of the buffer.
 */
typedef struct _GstBufferPoolParams {
  GstFormat          format;
  gint64             start;
  gint64             stop;
  GstBufferPoolFlags flags;
} GstBufferPoolParams;

/**
 * GstBufferPoolAlloc:
 * @min_buffers: the minimum amount of buffers to allocate.
 * @max_buffers: the maximum amount of buffers to allocate or 0 for unlimited.
 * @size: the size of each buffer, not including pre and post fix
 * @prefix: prefix each buffer with this many bytes
 * @postfix: postfix each buffer with this many bytes
 * @align: alignment of the buffer data.
 *
 * Properties for controlling the allocation of buffers. Buffer memory will be
 * allocated with the given alignment and the returned buffers will have their
 * data pointer set to this memory + prefix.
 */
typedef struct _GstBufferPoolConfig {
  guint              min_buffers;
  guint              max_buffers;
  guint              size;
  guint              prefix;
  guint              postfix;
  guint              align;
} GstBufferPoolConfig;

/**
 * GstBufferPool:
 * @mini_object: the parent structure
 *
 * The structure of a #GstBufferPool. Use the associated macros to access the public
 * variables.
 */
struct _GstBufferPool {
  GstObject            object;

  /*< private >*/
  gboolean             flushing;
  GstAtomicQueue      *queue;
  GstPoll             *poll;

  GstBufferPoolConfig  config;

  gpointer _gst_reserved[GST_PADDING];
};

struct _GstBufferPoolClass {
  GstObjectClass    object_class;

  /* vmethods */
  void           (*set_flushing)   (GstBufferPool *pool, gboolean flushing);
  gboolean       (*set_config)     (GstBufferPool *pool, GstBufferPoolConfig *config);

  GstFlowReturn  (*acquire_buffer) (GstBufferPool *pool, GstBuffer **buffer,
                                    GstBufferPoolParams *params);
  GstFlowReturn  (*alloc_buffer)   (GstBufferPool *pool, GstBuffer **buffer,
                                    GstBufferPoolConfig *config,
                                    GstBufferPoolParams *params);
  void           (*release_buffer) (GstBufferPool *pool, GstBuffer *buffer);
  void           (*free_buffer)    (GstBufferPool *pool, GstBuffer *buffer);

  gpointer _gst_reserved[GST_PADDING];
};

GType       gst_buffer_pool_get_type (void);

/* allocation */
GstBufferPool * gst_buffer_pool_new  (void);


/* state management */
void            gst_buffer_pool_set_flushing    (GstBufferPool *pool, gboolean flushing);

gboolean        gst_buffer_pool_set_config      (GstBufferPool *pool, GstBufferPoolConfig *config);
void            gst_buffer_pool_get_config      (GstBufferPool *pool, GstBufferPoolConfig *config);

/* buffer management */
GstFlowReturn   gst_buffer_pool_acquire_buffer  (GstBufferPool *pool, GstBuffer **buffer, GstBufferPoolParams *params);
void            gst_buffer_pool_release_buffer  (GstBufferPool *pool, GstBuffer *buffer);

G_END_DECLS

#endif /* __GST_BUFFER_POOL_H__ */