mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-10-02 16:52:42 +00:00
187 lines
6.3 KiB
C
187 lines
6.3 KiB
C
|
/* GStreamer
|
||
|
* Copyright (C) 2009 Wim Taymans <wim.taymans@gmail.be>
|
||
|
*
|
||
|
* gstallocator.h: Header for memory allocation
|
||
|
*
|
||
|
* 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_ALLOCATOR_H__
|
||
|
#define __GST_ALLOCATOR_H__
|
||
|
|
||
|
#include <gst/gstmemory.h>
|
||
|
|
||
|
G_BEGIN_DECLS
|
||
|
|
||
|
typedef struct _GstAllocatorPrivate GstAllocatorPrivate;
|
||
|
typedef struct _GstAllocatorClass GstAllocatorClass;
|
||
|
|
||
|
#define GST_TYPE_ALLOCATOR (gst_allocator_get_type())
|
||
|
#define GST_IS_ALLOCATOR(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_ALLOCATOR))
|
||
|
#define GST_IS_ALLOCATOR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_ALLOCATOR))
|
||
|
#define GST_ALLOCATOR_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_ALLOCATOR, GstAllocatorClass))
|
||
|
#define GST_ALLOCATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_ALLOCATOR, GstAllocator))
|
||
|
#define GST_ALLOCATOR_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_ALLOCATOR, GstAllocatorClass))
|
||
|
#define GST_ALLOCATOR_CAST(obj) ((GstAllocator *)(obj))
|
||
|
|
||
|
#define GST_TYPE_ALLOCATION_PARAMS (gst_allocation_params_get_type())
|
||
|
GType gst_allocation_params_get_type(void);
|
||
|
|
||
|
typedef struct _GstAllocationParams GstAllocationParams;
|
||
|
|
||
|
/**
|
||
|
* gst_memory_alignment:
|
||
|
*
|
||
|
* The default memory alignment in bytes - 1
|
||
|
* an alignment of 7 would be the same as what malloc() guarantees.
|
||
|
*/
|
||
|
GST_EXPORT gsize gst_memory_alignment;
|
||
|
|
||
|
/**
|
||
|
* GST_ALLOCATOR_SYSMEM:
|
||
|
*
|
||
|
* The allocator name for the default system memory allocator
|
||
|
*/
|
||
|
#define GST_ALLOCATOR_SYSMEM "SystemMemory"
|
||
|
|
||
|
/**
|
||
|
* GstAllocationParams:
|
||
|
* @flags: flags to control allocation
|
||
|
* @align: the desired alignment of the memory
|
||
|
* @prefix: the desired prefix
|
||
|
* @padding: the desired padding
|
||
|
*
|
||
|
* Parameters to control the allocation of memory
|
||
|
*/
|
||
|
struct _GstAllocationParams {
|
||
|
GstMemoryFlags flags;
|
||
|
gsize align;
|
||
|
gsize prefix;
|
||
|
gsize padding;
|
||
|
|
||
|
/*< private >*/
|
||
|
gpointer _gst_reserved[GST_PADDING];
|
||
|
};
|
||
|
|
||
|
#if 0
|
||
|
/**
|
||
|
* GstAllocatorAllocFunction:
|
||
|
* @allocator: a #GstAllocator
|
||
|
* @size: the size
|
||
|
* @params: allocator params
|
||
|
* @user_data: user data
|
||
|
*
|
||
|
* Allocate a new #GstMemory from @allocator that can hold at least @size
|
||
|
* bytes (+ padding) and is aligned to (@align + 1) bytes.
|
||
|
*
|
||
|
* The offset and size of the memory should be set and the prefix/padding must
|
||
|
* be filled with 0 if @params flags contains #GST_MEMORY_FLAG_ZERO_PREFIXED and
|
||
|
* #GST_MEMORY_FLAG_ZERO_PADDED respectively.
|
||
|
*
|
||
|
* @user_data is extra data passed to this function. The default
|
||
|
* gst_allocator_alloc() passes the NULL but other implementations could pass
|
||
|
* custom data.
|
||
|
*
|
||
|
* Returns: a newly allocated #GstMemory. Free with gst_memory_unref()
|
||
|
*/
|
||
|
typedef GstMemory * (*GstAllocatorAllocFunction) (GstAllocator *allocator,
|
||
|
gsize size, GstAllocationParams *params,
|
||
|
gpointer user_data);
|
||
|
#endif
|
||
|
|
||
|
/**
|
||
|
* GstAllocatorFlags:
|
||
|
* @GST_ALLOCATOR_CUSTOM_ALLOC: The allocator has a custom alloc function.
|
||
|
* @GST_ALLOCATOR_FLAG_LAST: first flag that can be used for custom purposes
|
||
|
*
|
||
|
* Flags for allocators.
|
||
|
*/
|
||
|
typedef enum {
|
||
|
GST_ALLOCATOR_FLAG_CUSTOM_ALLOC = (GST_OBJECT_FLAG_LAST << 0),
|
||
|
|
||
|
GST_ALLOCATOR_FLAG_LAST = (GST_OBJECT_FLAG_LAST << 16)
|
||
|
} GstAllocatorFlags;
|
||
|
|
||
|
/**
|
||
|
* GstAllocator:
|
||
|
* @mini_object: parent structure
|
||
|
* @mem_type: the memory type this allocator provides
|
||
|
* @mem_map: the implementation of the GstMemoryMapFunction
|
||
|
* @mem_unmap: the implementation of the GstMemoryUnmapFunction
|
||
|
* @mem_free: the implementation of the GstMemoryFreeFunction
|
||
|
* @mem_copy: the implementation of the GstMemoryCopyFunction
|
||
|
* @mem_share: the implementation of the GstMemoryShareFunction
|
||
|
* @mem_is_span: the implementation of the GstMemoryIsSpanFunction
|
||
|
*
|
||
|
* The #GstAllocator is used to create new memory.
|
||
|
*/
|
||
|
struct _GstAllocator
|
||
|
{
|
||
|
GstObject object;
|
||
|
|
||
|
const gchar *mem_type;
|
||
|
|
||
|
GstMemoryMapFunction mem_map;
|
||
|
GstMemoryUnmapFunction mem_unmap;
|
||
|
|
||
|
GstMemoryCopyFunction mem_copy;
|
||
|
GstMemoryShareFunction mem_share;
|
||
|
GstMemoryIsSpanFunction mem_is_span;
|
||
|
|
||
|
gpointer _gst_reserved[GST_PADDING];
|
||
|
|
||
|
/*< private >*/
|
||
|
GstAllocatorPrivate *priv;
|
||
|
};
|
||
|
|
||
|
struct _GstAllocatorClass {
|
||
|
GstObjectClass object_class;
|
||
|
|
||
|
GstMemory * (*alloc) (GstAllocator *allocator, gsize size,
|
||
|
GstAllocationParams *params, gpointer user_data);
|
||
|
void (*free) (GstAllocator *allocator, GstMemory *memory);
|
||
|
|
||
|
/*< private >*/
|
||
|
gpointer _gst_reserved[GST_PADDING];
|
||
|
};
|
||
|
|
||
|
GType gst_allocator_get_type(void);
|
||
|
|
||
|
/* allocators */
|
||
|
void gst_allocator_register (const gchar *name, GstAllocator *allocator);
|
||
|
GstAllocator * gst_allocator_find (const gchar *name);
|
||
|
void gst_allocator_set_default (GstAllocator * allocator);
|
||
|
|
||
|
/* allocation parameters */
|
||
|
void gst_allocation_params_init (GstAllocationParams *params);
|
||
|
GstAllocationParams *
|
||
|
gst_allocation_params_copy (const GstAllocationParams *params) G_GNUC_MALLOC;
|
||
|
void gst_allocation_params_free (GstAllocationParams *params);
|
||
|
|
||
|
/* allocating memory blocks */
|
||
|
GstMemory * gst_allocator_alloc (GstAllocator * allocator, gsize size,
|
||
|
GstAllocationParams *params);
|
||
|
void gst_allocator_free (GstAllocator * allocator, GstMemory *mem);
|
||
|
|
||
|
GstMemory * gst_memory_new_wrapped (GstMemoryFlags flags, gpointer data, gsize maxsize,
|
||
|
gsize offset, gsize size, gpointer user_data,
|
||
|
GDestroyNotify notify);
|
||
|
|
||
|
G_END_DECLS
|
||
|
|
||
|
#endif /* __GST_ALLOCATOR_H__ */
|