2 * Copyright (C) 2009 Wim Taymans <wim.taymans@gmail.be>
4 * gstmemory.h: Header for memory blocks
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
23 #ifndef __GST_MEMORY_H__
24 #define __GST_MEMORY_H__
26 #include <gst/gstconfig.h>
28 #include <glib-object.h>
32 #define GST_TYPE_MEMORY (gst_memory_get_type())
33 GType gst_memory_get_type(void);
35 #define GST_TYPE_ALLOCATOR (gst_allocator_get_type())
36 GType gst_allocator_get_type(void);
38 #define GST_TYPE_ALLOCATION_PARAMS (gst_allocation_params_get_type())
39 GType gst_allocation_params_get_type(void);
41 typedef struct _GstMemory GstMemory;
42 typedef struct _GstMemoryInfo GstMemoryInfo;
43 typedef struct _GstAllocator GstAllocator;
44 typedef struct _GstAllocationParams GstAllocationParams;
47 * gst_memory_alignment:
49 * The default memory alignment in bytes - 1
50 * an alignment of 7 would be the same as what malloc() guarantees.
52 GST_EXPORT gsize gst_memory_alignment;
54 #define GST_MEMORY_CAST(mem) ((GstMemory *)(mem))
58 * @GST_MEMORY_FLAG_READONLY: memory is readonly. It is not allowed to map the
59 * memory with #GST_MAP_WRITE.
60 * @GST_MEMORY_FLAG_NO_SHARE: memory must not be shared. Copies will have to be
61 * made when this memory needs to be shared between buffers.
62 * @GST_MEMORY_FLAG_ZERO_PREFIXED: the memory prefix is filled with 0 bytes
63 * @GST_MEMORY_FLAG_ZERO_PADDED: the memory padding is filled with 0 bytes
64 * @GST_MEMORY_FLAG_LAST: first flag that can be used for custom purposes
66 * Flags for wrapped memory.
69 GST_MEMORY_FLAG_READONLY = (GST_MINI_OBJECT_FLAG_LAST << 0),
70 GST_MEMORY_FLAG_NO_SHARE = (GST_MINI_OBJECT_FLAG_LAST << 1),
71 GST_MEMORY_FLAG_ZERO_PREFIXED = (GST_MINI_OBJECT_FLAG_LAST << 2),
72 GST_MEMORY_FLAG_ZERO_PADDED = (GST_MINI_OBJECT_FLAG_LAST << 3),
74 GST_MEMORY_FLAG_LAST = (GST_MINI_OBJECT_FLAG_LAST << 16)
81 * A flags word containing #GstMemoryFlags flags set on @mem
83 #define GST_MEMORY_FLAGS(mem) GST_MINI_OBJECT_FLAGS (mem)
85 * GST_MEMORY_FLAG_IS_SET:
87 * @flag: the #GstMemoryFlags to check.
89 * Gives the status of a specific flag on a @mem.
91 #define GST_MEMORY_FLAG_IS_SET(mem,flag) GST_MINI_OBJECT_FLAG_IS_SET (mem,flag)
93 * GST_MEMORY_FLAG_UNSET:
95 * @flag: the #GstMemoryFlags to clear.
97 * Clear a specific flag on a @mem.
99 #define GST_MEMORY_FLAG_UNSET(mem,flag) GST_MINI_OBJECT_FLAG_UNSET (mem, flag)
102 * GST_MEMORY_IS_READONLY:
103 * @mem: a #GstMemory.
105 * Check if @mem is readonly.
107 #define GST_MEMORY_IS_READONLY(mem) GST_MEMORY_FLAG_IS_SET(mem,GST_MEMORY_FLAG_READONLY)
109 * GST_MEMORY_IS_NO_SHARE:
110 * @mem: a #GstMemory.
112 * Check if @mem cannot be shared between buffers
114 #define GST_MEMORY_IS_NO_SHARE(mem) GST_MEMORY_FLAG_IS_SET(mem,GST_MEMORY_FLAG_NO_SHARE)
116 * GST_MEMORY_IS_ZERO_PREFIXED:
117 * @mem: a #GstMemory.
119 * Check if the prefix in @mem is 0 filled.
121 #define GST_MEMORY_IS_ZERO_PREFIXED(mem) GST_MEMORY_FLAG_IS_SET(mem,GST_MEMORY_FLAG_ZERO_PREFIXED)
123 * GST_MEMORY_IS_ZERO_PADDED:
124 * @mem: a #GstMemory.
126 * Check if the padding in @mem is 0 filled.
128 #define GST_MEMORY_IS_ZERO_PADDED(mem) GST_MEMORY_FLAG_IS_SET(mem,GST_MEMORY_FLAG_ZERO_PADDED)
133 * @mini_object: parent structure
134 * @allocator: pointer to the #GstAllocator
135 * @parent: parent memory block
136 * @state: private state
137 * @maxsize: the maximum size allocated
138 * @align: the alignment of the memory
139 * @offset: the offset where valid data starts
140 * @size: the size of valid data
142 * Base structure for memory implementations. Custom memory will put this structure
143 * as the first member of their structure.
146 GstMiniObject mini_object;
148 GstAllocator *allocator;
160 * @GST_MAP_READ: map for read access
161 * @GST_MAP_WRITE: map for write access
162 * @GST_MAP_FLAG_LAST: first flag that can be used for custom purposes
164 * Flags used when mapping memory
167 GST_MAP_READ = (1 << 0),
168 GST_MAP_WRITE = (1 << 1),
170 GST_MAP_FLAG_LAST = (1 << 16)
175 * @memory: a pointer to the mapped memory
176 * @flags: flags used when mapping the memory
177 * @data: a pointer to the mapped data
178 * @size: the valid size in @data
179 * @maxsize: the maximum bytes in @data
180 * @user_data: extra private user_data that the implementation of the memory
181 * can use to store extra info.
183 * A structure containing the result of a map operation such as
184 * gst_memory_map(). It contains the data and size.
193 gpointer user_data[4];
199 * Initializer for #GstMapInfo
201 #define GST_MAP_INFO_INIT { NULL, 0, NULL, 0, 0, }
206 * Map for readwrite access
208 #define GST_MAP_READWRITE (GST_MAP_READ | GST_MAP_WRITE)
211 * GST_ALLOCATOR_SYSMEM:
213 * The allocator name for the default system memory allocator
215 #define GST_ALLOCATOR_SYSMEM "SystemMemory"
218 * GstAllocationParams:
219 * @flags: flags to control allocation
220 * @align: the desired alignment of the memory
221 * @prefix: the disired prefix
222 * @padding: the desired padding
224 * Parameters to control the allocation of memory
226 struct _GstAllocationParams {
227 GstMemoryFlags flags;
233 gpointer _gst_reserved[GST_PADDING];
237 * GstAllocatorAllocFunction:
238 * @allocator: a #GstAllocator
240 * @params: allocator params
241 * @user_data: user data
243 * Allocate a new #GstMemory from @allocator that can hold at least @size
244 * bytes (+ padding) and is aligned to (@align + 1) bytes.
246 * The offset and size of the memory should be set and the prefix/padding must
247 * be filled with 0 if @params flags contains #GST_MEMORY_FLAG_ZERO_PREFIXED and
248 * #GST_MEMORY_FLAG_ZERO_PADDED respectively.
250 * @user_data is the data that was used when creating @allocator.
252 * Returns: a newly allocated #GstMemory. Free with gst_memory_unref()
254 typedef GstMemory * (*GstAllocatorAllocFunction) (GstAllocator *allocator,
255 gsize size, GstAllocationParams *params,
259 * GstMemoryMapFunction:
261 * @maxsize: size to map
262 * @flags: access mode for the memory
264 * Get the memory of @mem that can be accessed according to the mode specified
265 * in @flags. The function should return a pointer that contains at least
268 * Returns: a pointer to memory of which at least @maxsize bytes can be
269 * accessed according to the access pattern in @flags.
271 typedef gpointer (*GstMemoryMapFunction) (GstMemory *mem, gsize maxsize, GstMapFlags flags);
274 * GstMemoryUnmapFunction:
277 * Return the pointer previously retrieved with gst_memory_map().
279 * Returns: %TRUE on success.
281 typedef void (*GstMemoryUnmapFunction) (GstMemory *mem);
284 * GstMemoryFreeFunction:
287 * Free the memory used by @mem. This function is usually called when the
288 * refcount of the @mem has reached 0.
290 typedef void (*GstMemoryFreeFunction) (GstMemory *mem);
293 * GstMemoryCopyFunction:
296 * @size: a size or -1
298 * Copy @size bytes from @mem starting at @offset and return them wrapped in a
299 * new GstMemory object.
300 * If @size is set to -1, all bytes starting at @offset are copied.
302 * Returns: a new #GstMemory object wrapping a copy of the requested region in
305 typedef GstMemory * (*GstMemoryCopyFunction) (GstMemory *mem, gssize offset, gssize size);
308 * GstMemoryShareFunction:
311 * @size: a size or -1
313 * Share @size bytes from @mem starting at @offset and return them wrapped in a
314 * new GstMemory object. If @size is set to -1, all bytes starting at @offset are
315 * shared. This function does not make a copy of the bytes in @mem.
317 * Returns: a new #GstMemory object sharing the requested region in @mem.
319 typedef GstMemory * (*GstMemoryShareFunction) (GstMemory *mem, gssize offset, gssize size);
322 * GstMemoryIsSpanFunction:
323 * @mem1: a #GstMemory
324 * @mem2: a #GstMemory
325 * @offset: a result offset
327 * Check if @mem1 and @mem2 occupy contiguous memory and return the offset of
328 * @mem1 in the parent buffer in @offset.
330 * Returns: %TRUE if @mem1 and @mem2 are in contiguous memory.
332 typedef gboolean (*GstMemoryIsSpanFunction) (GstMemory *mem1, GstMemory *mem2, gsize *offset);
336 * @mem_type: the memory type this allocator provides
337 * @alloc: the implementation of the GstAllocatorAllocFunction
338 * @mem_map: the implementation of the GstMemoryMapFunction
339 * @mem_unmap: the implementation of the GstMemoryUnmapFunction
340 * @mem_free: the implementation of the GstMemoryFreeFunction
341 * @mem_copy: the implementation of the GstMemoryCopyFunction
342 * @mem_share: the implementation of the GstMemoryShareFunction
343 * @mem_is_span: the implementation of the GstMemoryIsSpanFunction
345 * The #GstMemoryInfo is used to register new memory allocators and contain
346 * the implementations for various memory operations.
348 struct _GstMemoryInfo {
349 const gchar *mem_type;
351 GstAllocatorAllocFunction alloc;
353 GstMemoryMapFunction mem_map;
354 GstMemoryUnmapFunction mem_unmap;
355 GstMemoryFreeFunction mem_free;
357 GstMemoryCopyFunction mem_copy;
358 GstMemoryShareFunction mem_share;
359 GstMemoryIsSpanFunction mem_is_span;
362 gpointer _gst_reserved[GST_PADDING];
368 * An opaque type returned from gst_allocator_new() or gst_allocator_find()
369 * that can be used to allocator memory.
373 GstAllocator * gst_allocator_new (const GstMemoryInfo * info,
374 gpointer user_data, GDestroyNotify notify);
375 const gchar * gst_allocator_get_memory_type (GstAllocator * allocator);
379 * @allocator: The allocator to refcount
381 * Increase the refcount of this allocator.
383 * Returns: (transfer full): @allocator (for convenience when doing assignments)
385 #ifdef _FOOL_GTK_DOC_
386 G_INLINE_FUNC GstAllocator * gst_allocator_ref (GstAllocator * allocator);
389 static inline GstAllocator *
390 gst_allocator_ref (GstAllocator * allocator)
392 return (GstAllocator *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (allocator));
396 * gst_allocator_unref:
397 * @allocator: (transfer full): the allocator to refcount
399 * Decrease the refcount of an allocator, freeing it if the refcount reaches 0.
401 #ifdef _FOOL_GTK_DOC_
402 G_INLINE_FUNC void gst_allocator_unref (GstAllocator * allocator);
406 gst_allocator_unref (GstAllocator * allocator)
408 gst_mini_object_unref (GST_MINI_OBJECT_CAST (allocator));
411 void gst_allocator_register (const gchar *name, GstAllocator *allocator);
412 GstAllocator * gst_allocator_find (const gchar *name);
414 void gst_allocator_set_default (GstAllocator * allocator);
416 /* allocating memory blocks */
417 void gst_allocation_params_init (GstAllocationParams *params);
418 GstAllocationParams *
419 gst_allocation_params_copy (const GstAllocationParams *params) G_GNUC_MALLOC;
420 void gst_allocation_params_free (GstAllocationParams *params);
422 GstMemory * gst_allocator_alloc (GstAllocator * allocator, gsize size,
423 GstAllocationParams *params);
425 GstMemory * gst_memory_new_wrapped (GstMemoryFlags flags, gpointer data, gsize maxsize,
426 gsize offset, gsize size, gpointer user_data,
427 GDestroyNotify notify);
432 * @memory: The memory to refcount
434 * Increase the refcount of this memory.
436 * Returns: (transfer full): @memory (for convenience when doing assignments)
438 #ifdef _FOOL_GTK_DOC_
439 G_INLINE_FUNC GstMemory * gst_memory_ref (GstMemory * memory);
442 static inline GstMemory *
443 gst_memory_ref (GstMemory * memory)
445 return (GstMemory *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (memory));
450 * @memory: (transfer full): the memory to refcount
452 * Decrease the refcount of an memory, freeing it if the refcount reaches 0.
454 #ifdef _FOOL_GTK_DOC_
455 G_INLINE_FUNC void gst_memory_unref (GstMemory * memory);
459 gst_memory_unref (GstMemory * memory)
461 gst_mini_object_unref (GST_MINI_OBJECT_CAST (memory));
464 gboolean gst_memory_is_exclusive (GstMemory *mem);
466 /* getting/setting memory properties */
467 gsize gst_memory_get_sizes (GstMemory *mem, gsize *offset, gsize *maxsize);
468 void gst_memory_resize (GstMemory *mem, gssize offset, gsize size);
470 /* retrieving data */
471 GstMemory * gst_memory_make_mapped (GstMemory *mem, GstMapInfo *info, GstMapFlags flags);
472 gboolean gst_memory_map (GstMemory *mem, GstMapInfo *info, GstMapFlags flags);
473 void gst_memory_unmap (GstMemory *mem, GstMapInfo *info);
475 /* copy and subregions */
476 GstMemory * gst_memory_copy (GstMemory *mem, gssize offset, gssize size);
477 GstMemory * gst_memory_share (GstMemory *mem, gssize offset, gssize size);
480 gboolean gst_memory_is_span (GstMemory *mem1, GstMemory *mem2, gsize *offset);
484 #endif /* __GST_MEMORY_H__ */