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., 51 Franklin St, Fifth Floor,
19 * Boston, MA 02110-1301, 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 typedef struct _GstMemory GstMemory;
36 typedef struct _GstAllocator GstAllocator;
38 #define GST_MEMORY_CAST(mem) ((GstMemory *)(mem))
42 * @GST_MEMORY_FLAG_READONLY: memory is readonly. It is not allowed to map the
43 * memory with #GST_MAP_WRITE.
44 * @GST_MEMORY_FLAG_NO_SHARE: memory must not be shared. Copies will have to be
45 * made when this memory needs to be shared between buffers.
46 * @GST_MEMORY_FLAG_ZERO_PREFIXED: the memory prefix is filled with 0 bytes
47 * @GST_MEMORY_FLAG_ZERO_PADDED: the memory padding is filled with 0 bytes
48 * @GST_MEMORY_FLAG_PHYSICALLY_CONTIGUOUS: the memory is physically contiguous. Since 1.2
49 * @GST_MEMORY_FLAG_NOT_MAPPABLE: the memory can't be mapped via gst_memory_map() without any preconditions. Since 1.2
50 * @GST_MEMORY_FLAG_LAST: first flag that can be used for custom purposes
52 * Flags for wrapped memory.
55 GST_MEMORY_FLAG_READONLY = GST_MINI_OBJECT_FLAG_LOCK_READONLY,
56 GST_MEMORY_FLAG_NO_SHARE = (GST_MINI_OBJECT_FLAG_LAST << 0),
57 GST_MEMORY_FLAG_ZERO_PREFIXED = (GST_MINI_OBJECT_FLAG_LAST << 1),
58 GST_MEMORY_FLAG_ZERO_PADDED = (GST_MINI_OBJECT_FLAG_LAST << 2),
59 GST_MEMORY_FLAG_PHYSICALLY_CONTIGUOUS = (GST_MINI_OBJECT_FLAG_LAST << 3),
60 GST_MEMORY_FLAG_NOT_MAPPABLE = (GST_MINI_OBJECT_FLAG_LAST << 4),
62 GST_MEMORY_FLAG_LAST = (GST_MINI_OBJECT_FLAG_LAST << 16)
69 * A flags word containing #GstMemoryFlags flags set on @mem
71 #define GST_MEMORY_FLAGS(mem) GST_MINI_OBJECT_FLAGS (mem)
73 * GST_MEMORY_FLAG_IS_SET:
75 * @flag: the #GstMemoryFlags to check.
77 * Gives the status of a specific flag on a @mem.
79 #define GST_MEMORY_FLAG_IS_SET(mem,flag) GST_MINI_OBJECT_FLAG_IS_SET (mem,flag)
81 * GST_MEMORY_FLAG_UNSET:
83 * @flag: the #GstMemoryFlags to clear.
85 * Clear a specific flag on a @mem.
87 #define GST_MEMORY_FLAG_UNSET(mem,flag) GST_MINI_OBJECT_FLAG_UNSET (mem, flag)
90 * GST_MEMORY_IS_READONLY:
93 * Check if @mem is readonly.
95 #define GST_MEMORY_IS_READONLY(mem) GST_MEMORY_FLAG_IS_SET(mem,GST_MEMORY_FLAG_READONLY)
97 * GST_MEMORY_IS_NO_SHARE:
100 * Check if @mem cannot be shared between buffers
102 #define GST_MEMORY_IS_NO_SHARE(mem) GST_MEMORY_FLAG_IS_SET(mem,GST_MEMORY_FLAG_NO_SHARE)
104 * GST_MEMORY_IS_ZERO_PREFIXED:
105 * @mem: a #GstMemory.
107 * Check if the prefix in @mem is 0 filled.
109 #define GST_MEMORY_IS_ZERO_PREFIXED(mem) GST_MEMORY_FLAG_IS_SET(mem,GST_MEMORY_FLAG_ZERO_PREFIXED)
111 * GST_MEMORY_IS_ZERO_PADDED:
112 * @mem: a #GstMemory.
114 * Check if the padding in @mem is 0 filled.
116 #define GST_MEMORY_IS_ZERO_PADDED(mem) GST_MEMORY_FLAG_IS_SET(mem,GST_MEMORY_FLAG_ZERO_PADDED)
119 * GST_MEMORY_IS_PHYSICALLY_CONTIGUOUS:
120 * @mem: a #GstMemory.
122 * Check if @mem is physically contiguous.
126 #define GST_MEMORY_IS_PHYSICALLY_CONTIGUOUS(mem) GST_MEMORY_FLAG_IS_SET(mem,GST_MEMORY_FLAG_PHYSICALLY_CONTIGUOUS)
129 * GST_MEMORY_IS_NOT_MAPPABLE:
130 * @mem: a #GstMemory.
132 * Check if @mem can't be mapped via gst_memory_map() without any preconditions
136 #define GST_MEMORY_IS_NOT_MAPPABLE(mem) GST_MEMORY_FLAG_IS_SET(mem,GST_MEMORY_FLAG_NOT_MAPPABLE)
140 * @mini_object: parent structure
141 * @allocator: pointer to the #GstAllocator
142 * @parent: parent memory block
143 * @maxsize: the maximum size allocated
144 * @align: the alignment of the memory
145 * @offset: the offset where valid data starts
146 * @size: the size of valid data
148 * Base structure for memory implementations. Custom memory will put this structure
149 * as the first member of their structure.
152 GstMiniObject mini_object;
154 GstAllocator *allocator;
165 * @GST_MAP_READ: map for read access
166 * @GST_MAP_WRITE: map for write access
167 * @GST_MAP_FLAG_LAST: first flag that can be used for custom purposes
169 * Flags used when mapping memory
172 GST_MAP_READ = GST_LOCK_FLAG_READ,
173 GST_MAP_WRITE = GST_LOCK_FLAG_WRITE,
175 GST_MAP_FLAG_LAST = (1 << 16)
181 * GstMapFlags value alias for GST_MAP_READ | GST_MAP_WRITE
183 #define GST_MAP_READWRITE (GST_MAP_READ | GST_MAP_WRITE)
188 * @memory: a pointer to the mapped memory
189 * @flags: flags used when mapping the memory
190 * @data: (array length=size): a pointer to the mapped data
191 * @size: the valid size in @data
192 * @maxsize: the maximum bytes in @data
193 * @user_data: extra private user_data that the implementation of the memory
194 * can use to store extra info.
196 * A structure containing the result of a map operation such as
197 * gst_memory_map(). It contains the data and size.
206 gpointer user_data[4];
209 gpointer _gst_reserved[GST_PADDING];
215 * Initializer for #GstMapInfo
217 #define GST_MAP_INFO_INIT { NULL, 0, NULL, 0, 0, }
220 * GstMemoryMapFunction:
222 * @maxsize: size to map
223 * @flags: access mode for the memory
225 * Get the memory of @mem that can be accessed according to the mode specified
226 * in @flags. The function should return a pointer that contains at least
229 * Returns: a pointer to memory of which at least @maxsize bytes can be
230 * accessed according to the access pattern in @flags.
232 typedef gpointer (*GstMemoryMapFunction) (GstMemory *mem, gsize maxsize, GstMapFlags flags);
235 * GstMemoryUnmapFunction:
238 * Return the pointer previously retrieved with gst_memory_map().
240 * Returns: %TRUE on success.
242 typedef void (*GstMemoryUnmapFunction) (GstMemory *mem);
245 * GstMemoryCopyFunction:
248 * @size: a size or -1
250 * Copy @size bytes from @mem starting at @offset and return them wrapped in a
251 * new GstMemory object.
252 * If @size is set to -1, all bytes starting at @offset are copied.
254 * Returns: a new #GstMemory object wrapping a copy of the requested region in
257 typedef GstMemory * (*GstMemoryCopyFunction) (GstMemory *mem, gssize offset, gssize size);
260 * GstMemoryShareFunction:
263 * @size: a size or -1
265 * Share @size bytes from @mem starting at @offset and return them wrapped in a
266 * new GstMemory object. If @size is set to -1, all bytes starting at @offset are
267 * shared. This function does not make a copy of the bytes in @mem.
269 * Returns: a new #GstMemory object sharing the requested region in @mem.
271 typedef GstMemory * (*GstMemoryShareFunction) (GstMemory *mem, gssize offset, gssize size);
274 * GstMemoryIsSpanFunction:
275 * @mem1: a #GstMemory
276 * @mem2: a #GstMemory
277 * @offset: a result offset
279 * Check if @mem1 and @mem2 occupy contiguous memory and return the offset of
280 * @mem1 in the parent buffer in @offset.
282 * Returns: %TRUE if @mem1 and @mem2 are in contiguous memory.
284 typedef gboolean (*GstMemoryIsSpanFunction) (GstMemory *mem1, GstMemory *mem2, gsize *offset);
286 void gst_memory_init (GstMemory *mem, GstMemoryFlags flags,
287 GstAllocator *allocator, GstMemory *parent,
288 gsize maxsize, gsize align,
289 gsize offset, gsize size);
293 * @memory: The memory to refcount
295 * Increase the refcount of this memory.
297 * Returns: (transfer full): @memory (for convenience when doing assignments)
299 #ifdef _FOOL_GTK_DOC_
300 G_INLINE_FUNC GstMemory * gst_memory_ref (GstMemory * memory);
303 static inline GstMemory *
304 gst_memory_ref (GstMemory * memory)
306 return (GstMemory *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (memory));
311 * @memory: (transfer full): the memory to refcount
313 * Decrease the refcount of an memory, freeing it if the refcount reaches 0.
315 #ifdef _FOOL_GTK_DOC_
316 G_INLINE_FUNC void gst_memory_unref (GstMemory * memory);
320 gst_memory_unref (GstMemory * memory)
322 gst_mini_object_unref (GST_MINI_OBJECT_CAST (memory));
325 /* getting/setting memory properties */
326 gsize gst_memory_get_sizes (GstMemory *mem, gsize *offset, gsize *maxsize);
327 void gst_memory_resize (GstMemory *mem, gssize offset, gsize size);
329 #define gst_memory_lock(m,f) gst_mini_object_lock (GST_MINI_OBJECT_CAST (m), (f))
330 #define gst_memory_unlock(m,f) gst_mini_object_unlock (GST_MINI_OBJECT_CAST (m), (f))
331 #define gst_memory_is_writable(m) gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (m))
332 #define gst_memory_make_writable(m) GST_MEMORY_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (m)))
334 /* retrieving data */
335 GstMemory * gst_memory_make_mapped (GstMemory *mem, GstMapInfo *info, GstMapFlags flags);
336 gboolean gst_memory_map (GstMemory *mem, GstMapInfo *info, GstMapFlags flags);
337 void gst_memory_unmap (GstMemory *mem, GstMapInfo *info);
339 /* copy and subregions */
340 GstMemory * gst_memory_copy (GstMemory *mem, gssize offset, gssize size);
341 GstMemory * gst_memory_share (GstMemory *mem, gssize offset, gssize size);
344 gboolean gst_memory_is_span (GstMemory *mem1, GstMemory *mem2, gsize *offset);
348 #endif /* __GST_MEMORY_H__ */