*
* 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.
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
*/
#include <gst/gstconfig.h>
#include <glib-object.h>
+#include <gst/gstminiobject.h>
+#include <gst/gstobject.h>
G_BEGIN_DECLS
-#define GST_TYPE_MEMORY (gst_memory_get_type())
-GType gst_memory_get_type(void);
-
-#define GST_TYPE_ALLOCATOR (gst_allocator_get_type())
-GType gst_allocator_get_type(void);
+GST_API GType _gst_memory_type;
+#define GST_TYPE_MEMORY (_gst_memory_type)
-#define GST_TYPE_ALLOCATION_PARAMS (gst_allocation_params_get_type())
-GType gst_allocation_params_get_type(void);
+GST_API
+GType gst_memory_get_type(void);
typedef struct _GstMemory GstMemory;
-typedef struct _GstMemoryInfo GstMemoryInfo;
typedef struct _GstAllocator GstAllocator;
-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;
#define GST_MEMORY_CAST(mem) ((GstMemory *)(mem))
* made when this memory needs to be shared between buffers.
* @GST_MEMORY_FLAG_ZERO_PREFIXED: the memory prefix is filled with 0 bytes
* @GST_MEMORY_FLAG_ZERO_PADDED: the memory padding is filled with 0 bytes
+ * @GST_MEMORY_FLAG_PHYSICALLY_CONTIGUOUS: the memory is physically contiguous. (Since: 1.2)
+ * @GST_MEMORY_FLAG_NOT_MAPPABLE: the memory can't be mapped via gst_memory_map() without any preconditions. (Since: 1.2)
* @GST_MEMORY_FLAG_LAST: first flag that can be used for custom purposes
*
* Flags for wrapped memory.
*/
typedef enum {
- GST_MEMORY_FLAG_READONLY = (GST_MINI_OBJECT_FLAG_LAST << 0),
- GST_MEMORY_FLAG_NO_SHARE = (GST_MINI_OBJECT_FLAG_LAST << 1),
- GST_MEMORY_FLAG_ZERO_PREFIXED = (GST_MINI_OBJECT_FLAG_LAST << 2),
- GST_MEMORY_FLAG_ZERO_PADDED = (GST_MINI_OBJECT_FLAG_LAST << 3),
+ GST_MEMORY_FLAG_READONLY = GST_MINI_OBJECT_FLAG_LOCK_READONLY,
+ GST_MEMORY_FLAG_NO_SHARE = (GST_MINI_OBJECT_FLAG_LAST << 0),
+ GST_MEMORY_FLAG_ZERO_PREFIXED = (GST_MINI_OBJECT_FLAG_LAST << 1),
+ GST_MEMORY_FLAG_ZERO_PADDED = (GST_MINI_OBJECT_FLAG_LAST << 2),
+ GST_MEMORY_FLAG_PHYSICALLY_CONTIGUOUS = (GST_MINI_OBJECT_FLAG_LAST << 3),
+ GST_MEMORY_FLAG_NOT_MAPPABLE = (GST_MINI_OBJECT_FLAG_LAST << 4),
GST_MEMORY_FLAG_LAST = (GST_MINI_OBJECT_FLAG_LAST << 16)
} GstMemoryFlags;
*/
#define GST_MEMORY_IS_ZERO_PADDED(mem) GST_MEMORY_FLAG_IS_SET(mem,GST_MEMORY_FLAG_ZERO_PADDED)
+/**
+ * GST_MEMORY_IS_PHYSICALLY_CONTIGUOUS:
+ * @mem: a #GstMemory.
+ *
+ * Check if @mem is physically contiguous.
+ *
+ * Since: 1.2
+ */
+#define GST_MEMORY_IS_PHYSICALLY_CONTIGUOUS(mem) GST_MEMORY_FLAG_IS_SET(mem,GST_MEMORY_FLAG_PHYSICALLY_CONTIGUOUS)
+
+/**
+ * GST_MEMORY_IS_NOT_MAPPABLE:
+ * @mem: a #GstMemory.
+ *
+ * Check if @mem can't be mapped via gst_memory_map() without any preconditions
+ *
+ * Since: 1.2
+ */
+#define GST_MEMORY_IS_NOT_MAPPABLE(mem) GST_MEMORY_FLAG_IS_SET(mem,GST_MEMORY_FLAG_NOT_MAPPABLE)
/**
* GstMemory:
* @mini_object: parent structure
* @allocator: pointer to the #GstAllocator
* @parent: parent memory block
- * @state: private state
* @maxsize: the maximum size allocated
* @align: the alignment of the memory
* @offset: the offset where valid data starts
GstAllocator *allocator;
GstMemory *parent;
- volatile gint state;
gsize maxsize;
gsize align;
gsize offset;
* Flags used when mapping memory
*/
typedef enum {
- GST_MAP_READ = (1 << 0),
- GST_MAP_WRITE = (1 << 1),
+ GST_MAP_READ = GST_LOCK_FLAG_READ,
+ GST_MAP_WRITE = GST_LOCK_FLAG_WRITE,
GST_MAP_FLAG_LAST = (1 << 16)
} GstMapFlags;
/**
+ * GST_MAP_READWRITE: (value 3) (type GstMapFlags)
+ *
+ * GstMapFlags value alias for GST_MAP_READ | GST_MAP_WRITE
+ */
+#define GST_MAP_READWRITE ((GstMapFlags) (GST_MAP_READ | GST_MAP_WRITE))
+
+
+/**
* GstMapInfo:
* @memory: a pointer to the mapped memory
* @flags: flags used when mapping the memory
- * @data: a pointer to the mapped data
+ * @data: (array length=size): a pointer to the mapped data
* @size: the valid size in @data
* @maxsize: the maximum bytes in @data
* @user_data: extra private user_data that the implementation of the memory
guint8 *data;
gsize size;
gsize maxsize;
- /*< private >*/
+ /*< protected >*/
gpointer user_data[4];
-} GstMapInfo;
-
-/**
- * GST_MAP_INFO_INIT:
- *
- * Initializer for #GstMapInfo
- */
-#define GST_MAP_INFO_INIT { NULL, 0, NULL, 0, 0, }
-
-/**
- * GST_MAP_READWRITE:
- *
- * Map for readwrite access
- */
-#define GST_MAP_READWRITE (GST_MAP_READ | GST_MAP_WRITE)
-
-/**
- * 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];
-};
+} GstMapInfo;
/**
- * 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 the data that was used when creating @allocator.
+ * GST_MAP_INFO_INIT:
*
- * Returns: a newly allocated #GstMemory. Free with gst_memory_unref()
+ * Initializer for #GstMapInfo
*/
-typedef GstMemory * (*GstAllocatorAllocFunction) (GstAllocator *allocator,
- gsize size, GstAllocationParams *params,
- gpointer user_data);
+#define GST_MAP_INFO_INIT { NULL, (GstMapFlags) 0, NULL, 0, 0, { NULL, NULL, NULL, NULL}, {NULL, NULL, NULL, NULL}}
/**
* GstMemoryMapFunction:
typedef gpointer (*GstMemoryMapFunction) (GstMemory *mem, gsize maxsize, GstMapFlags flags);
/**
+ * GstMemoryMapFullFunction:
+ * @mem: a #GstMemory
+ * @info: the #GstMapInfo to map with
+ * @maxsize: size to map
+ *
+ * Get the memory of @mem that can be accessed according to the mode specified
+ * in @info's flags. The function should return a pointer that contains at least
+ * @maxsize bytes.
+ *
+ * Returns: a pointer to memory of which at least @maxsize bytes can be
+ * accessed according to the access pattern in @info's flags.
+ */
+typedef gpointer (*GstMemoryMapFullFunction) (GstMemory *mem, GstMapInfo * info, gsize maxsize);
+
+/**
* GstMemoryUnmapFunction:
* @mem: a #GstMemory
*
* Return the pointer previously retrieved with gst_memory_map().
- *
- * Returns: %TRUE on success.
*/
typedef void (*GstMemoryUnmapFunction) (GstMemory *mem);
/**
- * GstMemoryFreeFunction:
+ * GstMemoryUnmapFullFunction:
* @mem: a #GstMemory
+ * @info: a #GstMapInfo
*
- * Free the memory used by @mem. This function is usually called when the
- * refcount of the @mem has reached 0.
+ * Return the pointer previously retrieved with gst_memory_map() with @info.
*/
-typedef void (*GstMemoryFreeFunction) (GstMemory *mem);
+typedef void (*GstMemoryUnmapFullFunction) (GstMemory *mem, GstMapInfo * info);
/**
* GstMemoryCopyFunction:
*/
typedef gboolean (*GstMemoryIsSpanFunction) (GstMemory *mem1, GstMemory *mem2, gsize *offset);
-/**
- * GstMemoryInfo:
- * @mem_type: the memory type this allocator provides
- * @alloc: the implementation of the GstAllocatorAllocFunction
- * @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 #GstMemoryInfo is used to register new memory allocators and contain
- * the implementations for various memory operations.
- */
-struct _GstMemoryInfo {
- const gchar *mem_type;
-
- GstAllocatorAllocFunction alloc;
-
- GstMemoryMapFunction mem_map;
- GstMemoryUnmapFunction mem_unmap;
- GstMemoryFreeFunction mem_free;
-
- GstMemoryCopyFunction mem_copy;
- GstMemoryShareFunction mem_share;
- GstMemoryIsSpanFunction mem_is_span;
-
- /*< private >*/
- gpointer _gst_reserved[GST_PADDING];
-};
-
-/**
- * GstAllocator:
- *
- * An opaque type returned from gst_allocator_new() or gst_allocator_find()
- * that can be used to allocator memory.
- */
-
-/* allocators */
-GstAllocator * gst_allocator_new (const GstMemoryInfo * info,
- gpointer user_data, GDestroyNotify notify);
-const gchar * gst_allocator_get_memory_type (GstAllocator * allocator);
-
-/**
- * gst_allocator_ref:
- * @allocator: The allocator to refcount
- *
- * Increase the refcount of this allocator.
- *
- * Returns: (transfer full): @allocator (for convenience when doing assignments)
- */
-#ifdef _FOOL_GTK_DOC_
-G_INLINE_FUNC GstAllocator * gst_allocator_ref (GstAllocator * allocator);
-#endif
-
-static inline GstAllocator *
-gst_allocator_ref (GstAllocator * allocator)
-{
- return (GstAllocator *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (allocator));
-}
-
-/**
- * gst_allocator_unref:
- * @allocator: (transfer full): the allocator to refcount
- *
- * Decrease the refcount of an allocator, freeing it if the refcount reaches 0.
- */
-#ifdef _FOOL_GTK_DOC_
-G_INLINE_FUNC void gst_allocator_unref (GstAllocator * allocator);
-#endif
-
-static inline void
-gst_allocator_unref (GstAllocator * allocator)
-{
- gst_mini_object_unref (GST_MINI_OBJECT_CAST (allocator));
-}
-
-void gst_allocator_register (const gchar *name, GstAllocator *allocator);
-GstAllocator * gst_allocator_find (const gchar *name);
-
-void gst_allocator_set_default (GstAllocator * allocator);
-
-/* allocating memory blocks */
-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);
-
-GstMemory * gst_allocator_alloc (GstAllocator * allocator, gsize size,
- GstAllocationParams *params);
-
-GstMemory * gst_memory_new_wrapped (GstMemoryFlags flags, gpointer data, gsize maxsize,
- gsize offset, gsize size, gpointer user_data,
- GDestroyNotify notify);
+GST_API
+void gst_memory_init (GstMemory *mem, GstMemoryFlags flags,
+ GstAllocator *allocator, GstMemory *parent,
+ gsize maxsize, gsize align,
+ gsize offset, gsize size);
+GST_API
+gboolean gst_memory_is_type (GstMemory *mem, const gchar *mem_type);
/* refcounting */
/**
*
* Returns: (transfer full): @memory (for convenience when doing assignments)
*/
-#ifdef _FOOL_GTK_DOC_
-G_INLINE_FUNC GstMemory * gst_memory_ref (GstMemory * memory);
-#endif
-
static inline GstMemory *
gst_memory_ref (GstMemory * memory)
{
*
* Decrease the refcount of an memory, freeing it if the refcount reaches 0.
*/
-#ifdef _FOOL_GTK_DOC_
-G_INLINE_FUNC void gst_memory_unref (GstMemory * memory);
-#endif
-
static inline void
gst_memory_unref (GstMemory * memory)
{
gst_mini_object_unref (GST_MINI_OBJECT_CAST (memory));
}
-gboolean gst_memory_is_exclusive (GstMemory *mem);
-
/* getting/setting memory properties */
+
+GST_API
gsize gst_memory_get_sizes (GstMemory *mem, gsize *offset, gsize *maxsize);
+
+GST_API
void gst_memory_resize (GstMemory *mem, gssize offset, gsize size);
+#define gst_memory_lock(m,f) gst_mini_object_lock (GST_MINI_OBJECT_CAST (m), (f))
+#define gst_memory_unlock(m,f) gst_mini_object_unlock (GST_MINI_OBJECT_CAST (m), (f))
+#define gst_memory_is_writable(m) gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (m))
+#define gst_memory_make_writable(m) GST_MEMORY_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (m)))
+
/* retrieving data */
-GstMemory * gst_memory_make_mapped (GstMemory *mem, GstMapInfo *info, GstMapFlags flags);
+
+GST_API
+GstMemory * gst_memory_make_mapped (GstMemory *mem, GstMapInfo *info, GstMapFlags flags) G_GNUC_WARN_UNUSED_RESULT;
+
+GST_API
gboolean gst_memory_map (GstMemory *mem, GstMapInfo *info, GstMapFlags flags);
+
+GST_API
void gst_memory_unmap (GstMemory *mem, GstMapInfo *info);
/* copy and subregions */
-GstMemory * gst_memory_copy (GstMemory *mem, gssize offset, gssize size);
-GstMemory * gst_memory_share (GstMemory *mem, gssize offset, gssize size);
+
+GST_API
+GstMemory * gst_memory_copy (GstMemory *mem, gssize offset, gssize size) G_GNUC_WARN_UNUSED_RESULT;
+
+GST_API
+GstMemory * gst_memory_share (GstMemory *mem, gssize offset, gssize size) G_GNUC_WARN_UNUSED_RESULT;
/* span memory */
+
+GST_API
gboolean gst_memory_is_span (GstMemory *mem1, GstMemory *mem2, gsize *offset);
+#ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
+G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstMemory, gst_memory_unref)
+#endif
+
+#ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
+G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstAllocator, gst_object_unref)
+#endif
+
G_END_DECLS
#endif /* __GST_MEMORY_H__ */
projects / platform / upstream / gstreamer.git / blobdiff