mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-05 17:09:48 +00:00
Code Issues 1 Projects Releases Wiki Activity
gstreamer/gst/gstallocator.h

201 lines
6.1 KiB
C
Raw Normal View History

memory: Make GstAllocator a GstObject Make GstAllocator a GstObject instead of a GstMiniObject, like bufferpool. Make a new gstallocator.c file. Make a GstAllocator subclass for the default allocator.
2012-07-09 14:02:50 +00:00
/* 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
Fix FSF address https://bugzilla.gnome.org/show_bug.cgi?id=687520
2012-11-03 20:44:48 +00:00
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
memory: Make GstAllocator a GstObject Make GstAllocator a GstObject instead of a GstMiniObject, like bufferpool. Make a new gstallocator.c file. Make a GstAllocator subclass for the default allocator.
2012-07-09 14:02:50 +00:00
*/
#ifndef __GST_ALLOCATOR_H__
#define __GST_ALLOCATOR_H__
#include <gst/gstmemory.h>
Headers: add missing includes.
2015-08-10 22:35:21 +00:00
#include <gst/gstobject.h>
memory: Make GstAllocator a GstObject Make GstAllocator a GstObject instead of a GstMiniObject, like bufferpool. Make a new gstallocator.c file. Make a GstAllocator subclass for the default allocator.
2012-07-09 14:02:50 +00:00
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())
gst: mark symbols explicitly for export with GST_EXPORT One omission: gst_allocator_sysmem_get_type() was exported but never in any public header file.
2017-05-10 09:56:16 +00:00
gst: GST_EXPORT -> GST_API We need different export decorators for the different libs. For now no actual change though, just rename before the release, and add prelude headers to define the new decorator to GST_EXPORT.
2018-03-12 23:03:26 +00:00
GST_API
memory: Make GstAllocator a GstObject Make GstAllocator a GstObject instead of a GstMiniObject, like bufferpool. Make a new gstallocator.c file. Make a GstAllocator subclass for the default allocator.
2012-07-09 14:02:50 +00:00
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: mark symbols explicitly for export with GST_EXPORT One omission: gst_allocator_sysmem_get_type() was exported but never in any public header file.
2017-05-10 09:56:16 +00:00
gst: GST_EXPORT -> GST_API We need different export decorators for the different libs. For now no actual change though, just rename before the release, and add prelude headers to define the new decorator to GST_EXPORT.
2018-03-12 23:03:26 +00:00
GST_API gsize gst_memory_alignment;
memory: Make GstAllocator a GstObject Make GstAllocator a GstObject instead of a GstMiniObject, like bufferpool. Make a new gstallocator.c file. Make a GstAllocator subclass for the default allocator.
2012-07-09 14:02:50 +00:00
/**
* 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];
};
/**
* GstAllocatorFlags:
docs: fix docs a little more
2012-07-09 14:22:04 +00:00
* @GST_ALLOCATOR_FLAG_CUSTOM_ALLOC: The allocator has a custom alloc function.
memory: Make GstAllocator a GstObject Make GstAllocator a GstObject instead of a GstMiniObject, like bufferpool. Make a new gstallocator.c file. Make a GstAllocator subclass for the default allocator.
2012-07-09 14:02:50 +00:00
* @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:
* @mem_map: the implementation of the GstMemoryMapFunction
* @mem_unmap: the implementation of the GstMemoryUnmapFunction
* @mem_copy: the implementation of the GstMemoryCopyFunction
* @mem_share: the implementation of the GstMemoryShareFunction
* @mem_is_span: the implementation of the GstMemoryIsSpanFunction
memory: provide a mem_map_full that takes the GstMapInfo Follow up of 7130230ddb349d0ca7942abdba26b7558df055d1 Provide the memory implementation the GstMapInfo that will be used to map/unmap the memory. This allows the memory implementation to use some scratch space in GstMapInfo to e.g. track different map/unmap behaviour or store extra implementation defined data about the map in use. https://bugzilla.gnome.org/show_bug.cgi?id=750319
2015-06-03 14:03:16 +00:00
* @mem_map_full: the implementation of the GstMemoryMapFullFunction.
doc: Fix Since: marks There was few Since: mark missing their column. Also unify the way we set the Since mark on enum value and structure members. These sadly don't show up in the index.
2015-06-14 00:19:59 +00:00
* Will be used instead of @mem_map if present. (Since 1.6)
memory: provide a mem_unmap function that takes the flags to unmap There are gstmemory's available that operate in two memory domains and need to ensure consistent access between these domains. Imagine a scenario where e.g. the GLMemory is mapped twice in both the GPU and the CPU domain. On unmap or a subsequent map, it would like to ensure that the most recent data is available in the memory domain requested. Either by flushing the writes and/or initiating a DMA transfer. Without knowing which domain is being unmapped, the memory does not know where the most recent data is to transfer to the other memory domain. Note: this still does not allow downgrading a memory map. https://bugzilla.gnome.org/show_bug.cgi?id=750319
2015-06-03 08:03:36 +00:00
* @mem_unmap_full: the implementation of the GstMemoryUnmapFullFunction.
doc: Fix Since: marks There was few Since: mark missing their column. Also unify the way we set the Since mark on enum value and structure members. These sadly don't show up in the index.
2015-06-14 00:19:59 +00:00
* Will be used instead of @mem_unmap if present. (Since 1.6)
memory: Make GstAllocator a GstObject Make GstAllocator a GstObject instead of a GstMiniObject, like bufferpool. Make a new gstallocator.c file. Make a GstAllocator subclass for the default allocator.
2012-07-09 14:02:50 +00:00
*
* The #GstAllocator is used to create new memory.
*/
struct _GstAllocator
{
GstObject object;
memory: provide a mem_unmap function that takes the flags to unmap There are gstmemory's available that operate in two memory domains and need to ensure consistent access between these domains. Imagine a scenario where e.g. the GLMemory is mapped twice in both the GPU and the CPU domain. On unmap or a subsequent map, it would like to ensure that the most recent data is available in the memory domain requested. Either by flushing the writes and/or initiating a DMA transfer. Without knowing which domain is being unmapped, the memory does not know where the most recent data is to transfer to the other memory domain. Note: this still does not allow downgrading a memory map. https://bugzilla.gnome.org/show_bug.cgi?id=750319
2015-06-03 08:03:36 +00:00
const gchar *mem_type;
memory: Make GstAllocator a GstObject Make GstAllocator a GstObject instead of a GstMiniObject, like bufferpool. Make a new gstallocator.c file. Make a GstAllocator subclass for the default allocator.
2012-07-09 14:02:50 +00:00
docs: unhide docs for allocator Unhinde the class docs. Tech gtk-doc about GST_EXPORTS.
2014-01-31 07:35:41 +00:00
/*< public >*/
memory: provide a mem_unmap function that takes the flags to unmap There are gstmemory's available that operate in two memory domains and need to ensure consistent access between these domains. Imagine a scenario where e.g. the GLMemory is mapped twice in both the GPU and the CPU domain. On unmap or a subsequent map, it would like to ensure that the most recent data is available in the memory domain requested. Either by flushing the writes and/or initiating a DMA transfer. Without knowing which domain is being unmapped, the memory does not know where the most recent data is to transfer to the other memory domain. Note: this still does not allow downgrading a memory map. https://bugzilla.gnome.org/show_bug.cgi?id=750319
2015-06-03 08:03:36 +00:00
GstMemoryMapFunction mem_map;
GstMemoryUnmapFunction mem_unmap;
memory: Make GstAllocator a GstObject Make GstAllocator a GstObject instead of a GstMiniObject, like bufferpool. Make a new gstallocator.c file. Make a GstAllocator subclass for the default allocator.
2012-07-09 14:02:50 +00:00
memory: provide a mem_unmap function that takes the flags to unmap There are gstmemory's available that operate in two memory domains and need to ensure consistent access between these domains. Imagine a scenario where e.g. the GLMemory is mapped twice in both the GPU and the CPU domain. On unmap or a subsequent map, it would like to ensure that the most recent data is available in the memory domain requested. Either by flushing the writes and/or initiating a DMA transfer. Without knowing which domain is being unmapped, the memory does not know where the most recent data is to transfer to the other memory domain. Note: this still does not allow downgrading a memory map. https://bugzilla.gnome.org/show_bug.cgi?id=750319
2015-06-03 08:03:36 +00:00
GstMemoryCopyFunction mem_copy;
GstMemoryShareFunction mem_share;
GstMemoryIsSpanFunction mem_is_span;
memory: provide a mem_map_full that takes the GstMapInfo Follow up of 7130230ddb349d0ca7942abdba26b7558df055d1 Provide the memory implementation the GstMapInfo that will be used to map/unmap the memory. This allows the memory implementation to use some scratch space in GstMapInfo to e.g. track different map/unmap behaviour or store extra implementation defined data about the map in use. https://bugzilla.gnome.org/show_bug.cgi?id=750319
2015-06-03 14:03:16 +00:00
GstMemoryMapFullFunction mem_map_full;
memory: provide a mem_unmap function that takes the flags to unmap There are gstmemory's available that operate in two memory domains and need to ensure consistent access between these domains. Imagine a scenario where e.g. the GLMemory is mapped twice in both the GPU and the CPU domain. On unmap or a subsequent map, it would like to ensure that the most recent data is available in the memory domain requested. Either by flushing the writes and/or initiating a DMA transfer. Without knowing which domain is being unmapped, the memory does not know where the most recent data is to transfer to the other memory domain. Note: this still does not allow downgrading a memory map. https://bugzilla.gnome.org/show_bug.cgi?id=750319
2015-06-03 08:03:36 +00:00
GstMemoryUnmapFullFunction mem_unmap_full;
memory: Make GstAllocator a GstObject Make GstAllocator a GstObject instead of a GstMiniObject, like bufferpool. Make a new gstallocator.c file. Make a GstAllocator subclass for the default allocator.
2012-07-09 14:02:50 +00:00
docs: fix docs a little more
2012-07-09 14:22:04 +00:00
/*< private >*/
memory: provide a mem_map_full that takes the GstMapInfo Follow up of 7130230ddb349d0ca7942abdba26b7558df055d1 Provide the memory implementation the GstMapInfo that will be used to map/unmap the memory. This allows the memory implementation to use some scratch space in GstMapInfo to e.g. track different map/unmap behaviour or store extra implementation defined data about the map in use. https://bugzilla.gnome.org/show_bug.cgi?id=750319
2015-06-03 14:03:16 +00:00
gpointer _gst_reserved[GST_PADDING - 2];
memory: Make GstAllocator a GstObject Make GstAllocator a GstObject instead of a GstMiniObject, like bufferpool. Make a new gstallocator.c file. Make a GstAllocator subclass for the default allocator.
2012-07-09 14:02:50 +00:00
GstAllocatorPrivate *priv;
};
docs: unhide docs for allocator Unhinde the class docs. Tech gtk-doc about GST_EXPORTS.
2014-01-31 07:35:41 +00:00
/**
* GstAllocatorClass:
* @object_class: Object parent class
* @alloc: implementation that acquires memory
* @free: implementation that releases memory
*
* The #GstAllocator is used to create new memory.
*/
memory: Make GstAllocator a GstObject Make GstAllocator a GstObject instead of a GstMiniObject, like bufferpool. Make a new gstallocator.c file. Make a GstAllocator subclass for the default allocator.
2012-07-09 14:02:50 +00:00
struct _GstAllocatorClass {
GstObjectClass object_class;
docs: unhide docs for allocator Unhinde the class docs. Tech gtk-doc about GST_EXPORTS.
2014-01-31 07:35:41 +00:00
/*< public >*/
memory: Make GstAllocator a GstObject Make GstAllocator a GstObject instead of a GstMiniObject, like bufferpool. Make a new gstallocator.c file. Make a GstAllocator subclass for the default allocator.
2012-07-09 14:02:50 +00:00
GstMemory * (*alloc) (GstAllocator *allocator, gsize size,
allocator: remove user_data from alloc vmethod Remove the user_data from the alloc vmethod. Subclasses that implement a new alloc function can also implement their own vmethod to pass extra arguments. We can then also require that custom allocators implement an alloc function so that gst_allocator_alloc() always works.
2012-07-27 10:12:37 +00:00
GstAllocationParams *params);
memory: Make GstAllocator a GstObject Make GstAllocator a GstObject instead of a GstMiniObject, like bufferpool. Make a new gstallocator.c file. Make a GstAllocator subclass for the default allocator.
2012-07-09 14:02:50 +00:00
void (*free) (GstAllocator *allocator, GstMemory *memory);
/*< private >*/
gpointer _gst_reserved[GST_PADDING];
};
gst: GST_EXPORT -> GST_API We need different export decorators for the different libs. For now no actual change though, just rename before the release, and add prelude headers to define the new decorator to GST_EXPORT.
2018-03-12 23:03:26 +00:00
GST_API
gst: mark symbols explicitly for export with GST_EXPORT One omission: gst_allocator_sysmem_get_type() was exported but never in any public header file.
2017-05-10 09:56:16 +00:00
GType gst_allocator_get_type (void);
memory: Make GstAllocator a GstObject Make GstAllocator a GstObject instead of a GstMiniObject, like bufferpool. Make a new gstallocator.c file. Make a GstAllocator subclass for the default allocator.
2012-07-09 14:02:50 +00:00
/* allocators */
gst: mark symbols explicitly for export with GST_EXPORT One omission: gst_allocator_sysmem_get_type() was exported but never in any public header file.
2017-05-10 09:56:16 +00:00
gst: GST_EXPORT -> GST_API We need different export decorators for the different libs. For now no actual change though, just rename before the release, and add prelude headers to define the new decorator to GST_EXPORT.
2018-03-12 23:03:26 +00:00
GST_API
memory: Make GstAllocator a GstObject Make GstAllocator a GstObject instead of a GstMiniObject, like bufferpool. Make a new gstallocator.c file. Make a GstAllocator subclass for the default allocator.
2012-07-09 14:02:50 +00:00
void gst_allocator_register (const gchar *name, GstAllocator *allocator);
gst: mark symbols explicitly for export with GST_EXPORT One omission: gst_allocator_sysmem_get_type() was exported but never in any public header file.
2017-05-10 09:56:16 +00:00
gst: GST_EXPORT -> GST_API We need different export decorators for the different libs. For now no actual change though, just rename before the release, and add prelude headers to define the new decorator to GST_EXPORT.
2018-03-12 23:03:26 +00:00
GST_API
memory: Make GstAllocator a GstObject Make GstAllocator a GstObject instead of a GstMiniObject, like bufferpool. Make a new gstallocator.c file. Make a GstAllocator subclass for the default allocator.
2012-07-09 14:02:50 +00:00
GstAllocator * gst_allocator_find (const gchar *name);
gst: mark symbols explicitly for export with GST_EXPORT One omission: gst_allocator_sysmem_get_type() was exported but never in any public header file.
2017-05-10 09:56:16 +00:00
gst: GST_EXPORT -> GST_API We need different export decorators for the different libs. For now no actual change though, just rename before the release, and add prelude headers to define the new decorator to GST_EXPORT.
2018-03-12 23:03:26 +00:00
GST_API
memory: Make GstAllocator a GstObject Make GstAllocator a GstObject instead of a GstMiniObject, like bufferpool. Make a new gstallocator.c file. Make a GstAllocator subclass for the default allocator.
2012-07-09 14:02:50 +00:00
void gst_allocator_set_default (GstAllocator * allocator);
/* allocation parameters */
gst: mark symbols explicitly for export with GST_EXPORT One omission: gst_allocator_sysmem_get_type() was exported but never in any public header file.
2017-05-10 09:56:16 +00:00
gst: GST_EXPORT -> GST_API We need different export decorators for the different libs. For now no actual change though, just rename before the release, and add prelude headers to define the new decorator to GST_EXPORT.
2018-03-12 23:03:26 +00:00
GST_API
memory: Make GstAllocator a GstObject Make GstAllocator a GstObject instead of a GstMiniObject, like bufferpool. Make a new gstallocator.c file. Make a GstAllocator subclass for the default allocator.
2012-07-09 14:02:50 +00:00
void gst_allocation_params_init (GstAllocationParams *params);
gst: mark symbols explicitly for export with GST_EXPORT One omission: gst_allocator_sysmem_get_type() was exported but never in any public header file.
2017-05-10 09:56:16 +00:00
gst: GST_EXPORT -> GST_API We need different export decorators for the different libs. For now no actual change though, just rename before the release, and add prelude headers to define the new decorator to GST_EXPORT.
2018-03-12 23:03:26 +00:00
GST_API
memory: Make GstAllocator a GstObject Make GstAllocator a GstObject instead of a GstMiniObject, like bufferpool. Make a new gstallocator.c file. Make a GstAllocator subclass for the default allocator.
2012-07-09 14:02:50 +00:00
GstAllocationParams *
gst_allocation_params_copy (const GstAllocationParams *params) G_GNUC_MALLOC;
gst: mark symbols explicitly for export with GST_EXPORT One omission: gst_allocator_sysmem_get_type() was exported but never in any public header file.
2017-05-10 09:56:16 +00:00
gst: GST_EXPORT -> GST_API We need different export decorators for the different libs. For now no actual change though, just rename before the release, and add prelude headers to define the new decorator to GST_EXPORT.
2018-03-12 23:03:26 +00:00
GST_API
memory: Make GstAllocator a GstObject Make GstAllocator a GstObject instead of a GstMiniObject, like bufferpool. Make a new gstallocator.c file. Make a GstAllocator subclass for the default allocator.
2012-07-09 14:02:50 +00:00
void gst_allocation_params_free (GstAllocationParams *params);
/* allocating memory blocks */
gst: mark symbols explicitly for export with GST_EXPORT One omission: gst_allocator_sysmem_get_type() was exported but never in any public header file.
2017-05-10 09:56:16 +00:00
gst: GST_EXPORT -> GST_API We need different export decorators for the different libs. For now no actual change though, just rename before the release, and add prelude headers to define the new decorator to GST_EXPORT.
2018-03-12 23:03:26 +00:00
GST_API
memory: Make GstAllocator a GstObject Make GstAllocator a GstObject instead of a GstMiniObject, like bufferpool. Make a new gstallocator.c file. Make a GstAllocator subclass for the default allocator.
2012-07-09 14:02:50 +00:00
GstMemory * gst_allocator_alloc (GstAllocator * allocator, gsize size,
GstAllocationParams *params);
gst: mark symbols explicitly for export with GST_EXPORT One omission: gst_allocator_sysmem_get_type() was exported but never in any public header file.
2017-05-10 09:56:16 +00:00
gst: GST_EXPORT -> GST_API We need different export decorators for the different libs. For now no actual change though, just rename before the release, and add prelude headers to define the new decorator to GST_EXPORT.
2018-03-12 23:03:26 +00:00
GST_API
docs: fix docs a little more
2012-07-09 14:22:04 +00:00
void gst_allocator_free (GstAllocator * allocator, GstMemory *memory);
memory: Make GstAllocator a GstObject Make GstAllocator a GstObject instead of a GstMiniObject, like bufferpool. Make a new gstallocator.c file. Make a GstAllocator subclass for the default allocator.
2012-07-09 14:02:50 +00:00
gst: GST_EXPORT -> GST_API We need different export decorators for the different libs. For now no actual change though, just rename before the release, and add prelude headers to define the new decorator to GST_EXPORT.
2018-03-12 23:03:26 +00:00
GST_API
memory: Make GstAllocator a GstObject Make GstAllocator a GstObject instead of a GstMiniObject, like bufferpool. Make a new gstallocator.c file. Make a GstAllocator subclass for the default allocator.
2012-07-09 14:02:50 +00:00
GstMemory * gst_memory_new_wrapped (GstMemoryFlags flags, gpointer data, gsize maxsize,
gsize offset, gsize size, gpointer user_data,
GDestroyNotify notify);
core: Add g_autoptr() support to all types https://bugzilla.gnome.org/show_bug.cgi?id=754464
2015-11-10 17:38:59 +00:00
#ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstAllocationParams, gst_allocation_params_free)
#endif
memory: Make GstAllocator a GstObject Make GstAllocator a GstObject instead of a GstMiniObject, like bufferpool. Make a new gstallocator.c file. Make a GstAllocator subclass for the default allocator.
2012-07-09 14:02:50 +00:00
G_END_DECLS
#endif /* __GST_ALLOCATOR_H__ */
Reference in a new issue Copy permalink