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 GST_EXPORT GType _gst_memory_type;
33 #define GST_TYPE_MEMORY (_gst_memory_type)
34 GType gst_memory_get_type(void);
36 typedef struct _GstMemory GstMemory;
37 typedef struct _GstAllocator GstAllocator;
39 #define GST_MEMORY_CAST(mem) ((GstMemory *)(mem))
43 * @GST_MEMORY_FLAG_READONLY: memory is readonly. It is not allowed to map the
44 * memory with #GST_MAP_WRITE.
45 * @GST_MEMORY_FLAG_NO_SHARE: memory must not be shared. Copies will have to be
46 * made when this memory needs to be shared between buffers.
47 * @GST_MEMORY_FLAG_ZERO_PREFIXED: the memory prefix is filled with 0 bytes
48 * @GST_MEMORY_FLAG_ZERO_PADDED: the memory padding is filled with 0 bytes
49 * @GST_MEMORY_FLAG_PHYSICALLY_CONTIGUOUS: the memory is physically contiguous. (Since 2.2)
50 * @GST_MEMORY_FLAG_NOT_MAPPABLE: the memory can't be mapped via gst_memory_map() without any preconditions. (Since 1.2)
51 * @GST_MEMORY_FLAG_LAST: first flag that can be used for custom purposes
53 * Flags for wrapped memory.
56 GST_MEMORY_FLAG_READONLY = GST_MINI_OBJECT_FLAG_LOCK_READONLY,
57 GST_MEMORY_FLAG_NO_SHARE = (GST_MINI_OBJECT_FLAG_LAST << 0),
58 GST_MEMORY_FLAG_ZERO_PREFIXED = (GST_MINI_OBJECT_FLAG_LAST << 1),
59 GST_MEMORY_FLAG_ZERO_PADDED = (GST_MINI_OBJECT_FLAG_LAST << 2),
60 GST_MEMORY_FLAG_PHYSICALLY_CONTIGUOUS = (GST_MINI_OBJECT_FLAG_LAST << 3),
61 GST_MEMORY_FLAG_NOT_MAPPABLE = (GST_MINI_OBJECT_FLAG_LAST << 4),
63 GST_MEMORY_FLAG_LAST = (GST_MINI_OBJECT_FLAG_LAST << 16)
70 * A flags word containing #GstMemoryFlags flags set on @mem
72 #define GST_MEMORY_FLAGS(mem) GST_MINI_OBJECT_FLAGS (mem)
74 * GST_MEMORY_FLAG_IS_SET:
76 * @flag: the #GstMemoryFlags to check.
78 * Gives the status of a specific flag on a @mem.
80 #define GST_MEMORY_FLAG_IS_SET(mem,flag) GST_MINI_OBJECT_FLAG_IS_SET (mem,flag)
82 * GST_MEMORY_FLAG_UNSET:
84 * @flag: the #GstMemoryFlags to clear.
86 * Clear a specific flag on a @mem.
88 #define GST_MEMORY_FLAG_UNSET(mem,flag) GST_MINI_OBJECT_FLAG_UNSET (mem, flag)
91 * GST_MEMORY_IS_READONLY:
94 * Check if @mem is readonly.
96 #define GST_MEMORY_IS_READONLY(mem) GST_MEMORY_FLAG_IS_SET(mem,GST_MEMORY_FLAG_READONLY)
98 * GST_MEMORY_IS_NO_SHARE:
101 * Check if @mem cannot be shared between buffers
103 #define GST_MEMORY_IS_NO_SHARE(mem) GST_MEMORY_FLAG_IS_SET(mem,GST_MEMORY_FLAG_NO_SHARE)
105 * GST_MEMORY_IS_ZERO_PREFIXED:
106 * @mem: a #GstMemory.
108 * Check if the prefix in @mem is 0 filled.
110 #define GST_MEMORY_IS_ZERO_PREFIXED(mem) GST_MEMORY_FLAG_IS_SET(mem,GST_MEMORY_FLAG_ZERO_PREFIXED)
112 * GST_MEMORY_IS_ZERO_PADDED:
113 * @mem: a #GstMemory.
115 * Check if the padding in @mem is 0 filled.
117 #define GST_MEMORY_IS_ZERO_PADDED(mem) GST_MEMORY_FLAG_IS_SET(mem,GST_MEMORY_FLAG_ZERO_PADDED)
120 * GST_MEMORY_IS_PHYSICALLY_CONTIGUOUS:
121 * @mem: a #GstMemory.
123 * Check if @mem is physically contiguous.
127 #define GST_MEMORY_IS_PHYSICALLY_CONTIGUOUS(mem) GST_MEMORY_FLAG_IS_SET(mem,GST_MEMORY_FLAG_PHYSICALLY_CONTIGUOUS)
130 * GST_MEMORY_IS_NOT_MAPPABLE:
131 * @mem: a #GstMemory.
133 * Check if @mem can't be mapped via gst_memory_map() without any preconditions
137 #define GST_MEMORY_IS_NOT_MAPPABLE(mem) GST_MEMORY_FLAG_IS_SET(mem,GST_MEMORY_FLAG_NOT_MAPPABLE)
141 * @mini_object: parent structure
142 * @allocator: pointer to the #GstAllocator
143 * @parent: parent memory block
144 * @maxsize: the maximum size allocated
145 * @align: the alignment of the memory
146 * @offset: the offset where valid data starts
147 * @size: the size of valid data
149 * Base structure for memory implementations. Custom memory will put this structure
150 * as the first member of their structure.
153 GstMiniObject mini_object;
155 GstAllocator *allocator;
166 * @GST_MAP_READ: map for read access
167 * @GST_MAP_WRITE: map for write access
168 * @GST_MAP_FLAG_LAST: first flag that can be used for custom purposes
170 * Flags used when mapping memory
173 GST_MAP_READ = GST_LOCK_FLAG_READ,
174 GST_MAP_WRITE = GST_LOCK_FLAG_WRITE,
176 GST_MAP_FLAG_LAST = (1 << 16)
182 * GstMapFlags value alias for GST_MAP_READ | GST_MAP_WRITE
184 #define GST_MAP_READWRITE (GST_MAP_READ | GST_MAP_WRITE)
189 * @memory: a pointer to the mapped memory
190 * @flags: flags used when mapping the memory
191 * @data: (array length=size): a pointer to the mapped data
192 * @size: the valid size in @data
193 * @maxsize: the maximum bytes in @data
194 * @user_data: extra private user_data that the implementation of the memory
195 * can use to store extra info.
197 * A structure containing the result of a map operation such as
198 * gst_memory_map(). It contains the data and size.
207 gpointer user_data[4];
210 gpointer _gst_reserved[GST_PADDING];
216 * Initializer for #GstMapInfo
218 #define GST_MAP_INFO_INIT { NULL, 0, NULL, 0, 0, {0, }, {0, }}
221 * GstMemoryMapFunction:
223 * @maxsize: size to map
224 * @flags: access mode for the memory
226 * Get the memory of @mem that can be accessed according to the mode specified
227 * in @flags. The function should return a pointer that contains at least
230 * Returns: a pointer to memory of which at least @maxsize bytes can be
231 * accessed according to the access pattern in @flags.
233 typedef gpointer (*GstMemoryMapFunction) (GstMemory *mem, gsize maxsize, GstMapFlags flags);
236 * GstMemoryMapFullFunction:
238 * @info: the #GstMapInfo to map with
239 * @maxsize: size to map
241 * Get the memory of @mem that can be accessed according to the mode specified
242 * in @info's flags. The function should return a pointer that contains at least
245 * Returns: a pointer to memory of which at least @maxsize bytes can be
246 * accessed according to the access pattern in @info's flags.
248 typedef gpointer (*GstMemoryMapFullFunction) (GstMemory *mem, GstMapInfo * info, gsize maxsize);
251 * GstMemoryUnmapFunction:
254 * Return the pointer previously retrieved with gst_memory_map().
256 typedef void (*GstMemoryUnmapFunction) (GstMemory *mem);
259 * GstMemoryUnmapFullFunction:
261 * @info: a #GstMapInfo
263 * Return the pointer previously retrieved with gst_memory_map() with @info.
265 typedef void (*GstMemoryUnmapFullFunction) (GstMemory *mem, GstMapInfo * info);
268 * GstMemoryCopyFunction:
271 * @size: a size or -1
273 * Copy @size bytes from @mem starting at @offset and return them wrapped in a
274 * new GstMemory object.
275 * If @size is set to -1, all bytes starting at @offset are copied.
277 * Returns: a new #GstMemory object wrapping a copy of the requested region in
280 typedef GstMemory * (*GstMemoryCopyFunction) (GstMemory *mem, gssize offset, gssize size);
283 * GstMemoryShareFunction:
286 * @size: a size or -1
288 * Share @size bytes from @mem starting at @offset and return them wrapped in a
289 * new GstMemory object. If @size is set to -1, all bytes starting at @offset are
290 * shared. This function does not make a copy of the bytes in @mem.
292 * Returns: a new #GstMemory object sharing the requested region in @mem.
294 typedef GstMemory * (*GstMemoryShareFunction) (GstMemory *mem, gssize offset, gssize size);
297 * GstMemoryIsSpanFunction:
298 * @mem1: a #GstMemory
299 * @mem2: a #GstMemory
300 * @offset: a result offset
302 * Check if @mem1 and @mem2 occupy contiguous memory and return the offset of
303 * @mem1 in the parent buffer in @offset.
305 * Returns: %TRUE if @mem1 and @mem2 are in contiguous memory.
307 typedef gboolean (*GstMemoryIsSpanFunction) (GstMemory *mem1, GstMemory *mem2, gsize *offset);
309 void gst_memory_init (GstMemory *mem, GstMemoryFlags flags,
310 GstAllocator *allocator, GstMemory *parent,
311 gsize maxsize, gsize align,
312 gsize offset, gsize size);
314 gboolean gst_memory_is_type (GstMemory *mem, const gchar *mem_type);
319 * @memory: The memory to refcount
321 * Increase the refcount of this memory.
323 * Returns: (transfer full): @memory (for convenience when doing assignments)
325 #ifdef _FOOL_GTK_DOC_
326 G_INLINE_FUNC GstMemory * gst_memory_ref (GstMemory * memory);
329 static inline GstMemory *
330 gst_memory_ref (GstMemory * memory)
332 return (GstMemory *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (memory));
337 * @memory: (transfer full): the memory to refcount
339 * Decrease the refcount of an memory, freeing it if the refcount reaches 0.
341 #ifdef _FOOL_GTK_DOC_
342 G_INLINE_FUNC void gst_memory_unref (GstMemory * memory);
346 gst_memory_unref (GstMemory * memory)
348 gst_mini_object_unref (GST_MINI_OBJECT_CAST (memory));
351 /* getting/setting memory properties */
352 gsize gst_memory_get_sizes (GstMemory *mem, gsize *offset, gsize *maxsize);
353 void gst_memory_resize (GstMemory *mem, gssize offset, gsize size);
355 #define gst_memory_lock(m,f) gst_mini_object_lock (GST_MINI_OBJECT_CAST (m), (f))
356 #define gst_memory_unlock(m,f) gst_mini_object_unlock (GST_MINI_OBJECT_CAST (m), (f))
357 #define gst_memory_is_writable(m) gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (m))
358 #define gst_memory_make_writable(m) GST_MEMORY_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (m)))
360 /* retrieving data */
361 GstMemory * gst_memory_make_mapped (GstMemory *mem, GstMapInfo *info, GstMapFlags flags);
362 gboolean gst_memory_map (GstMemory *mem, GstMapInfo *info, GstMapFlags flags);
363 void gst_memory_unmap (GstMemory *mem, GstMapInfo *info);
365 /* copy and subregions */
366 GstMemory * gst_memory_copy (GstMemory *mem, gssize offset, gssize size);
367 GstMemory * gst_memory_share (GstMemory *mem, gssize offset, gssize size);
370 gboolean gst_memory_is_span (GstMemory *mem1, GstMemory *mem2, gsize *offset);
374 #endif /* __GST_MEMORY_H__ */