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 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_LAST: first flag that can be used for custom purposes
50 * Flags for wrapped memory.
53 GST_MEMORY_FLAG_READONLY = GST_MINI_OBJECT_FLAG_LOCK_READONLY,
54 GST_MEMORY_FLAG_NO_SHARE = (GST_MINI_OBJECT_FLAG_LAST << 0),
55 GST_MEMORY_FLAG_ZERO_PREFIXED = (GST_MINI_OBJECT_FLAG_LAST << 1),
56 GST_MEMORY_FLAG_ZERO_PADDED = (GST_MINI_OBJECT_FLAG_LAST << 2),
58 GST_MEMORY_FLAG_LAST = (GST_MINI_OBJECT_FLAG_LAST << 16)
65 * A flags word containing #GstMemoryFlags flags set on @mem
67 #define GST_MEMORY_FLAGS(mem) GST_MINI_OBJECT_FLAGS (mem)
69 * GST_MEMORY_FLAG_IS_SET:
71 * @flag: the #GstMemoryFlags to check.
73 * Gives the status of a specific flag on a @mem.
75 #define GST_MEMORY_FLAG_IS_SET(mem,flag) GST_MINI_OBJECT_FLAG_IS_SET (mem,flag)
77 * GST_MEMORY_FLAG_UNSET:
79 * @flag: the #GstMemoryFlags to clear.
81 * Clear a specific flag on a @mem.
83 #define GST_MEMORY_FLAG_UNSET(mem,flag) GST_MINI_OBJECT_FLAG_UNSET (mem, flag)
86 * GST_MEMORY_IS_READONLY:
89 * Check if @mem is readonly.
91 #define GST_MEMORY_IS_READONLY(mem) GST_MEMORY_FLAG_IS_SET(mem,GST_MEMORY_FLAG_READONLY)
93 * GST_MEMORY_IS_NO_SHARE:
96 * Check if @mem cannot be shared between buffers
98 #define GST_MEMORY_IS_NO_SHARE(mem) GST_MEMORY_FLAG_IS_SET(mem,GST_MEMORY_FLAG_NO_SHARE)
100 * GST_MEMORY_IS_ZERO_PREFIXED:
101 * @mem: a #GstMemory.
103 * Check if the prefix in @mem is 0 filled.
105 #define GST_MEMORY_IS_ZERO_PREFIXED(mem) GST_MEMORY_FLAG_IS_SET(mem,GST_MEMORY_FLAG_ZERO_PREFIXED)
107 * GST_MEMORY_IS_ZERO_PADDED:
108 * @mem: a #GstMemory.
110 * Check if the padding in @mem is 0 filled.
112 #define GST_MEMORY_IS_ZERO_PADDED(mem) GST_MEMORY_FLAG_IS_SET(mem,GST_MEMORY_FLAG_ZERO_PADDED)
117 * @mini_object: parent structure
118 * @allocator: pointer to the #GstAllocator
119 * @parent: parent memory block
120 * @maxsize: the maximum size allocated
121 * @align: the alignment of the memory
122 * @offset: the offset where valid data starts
123 * @size: the size of valid data
125 * Base structure for memory implementations. Custom memory will put this structure
126 * as the first member of their structure.
129 GstMiniObject mini_object;
131 GstAllocator *allocator;
142 * @GST_MAP_READ: map for read access
143 * @GST_MAP_WRITE: map for write access
144 * @GST_MAP_FLAG_LAST: first flag that can be used for custom purposes
146 * Flags used when mapping memory
149 GST_MAP_READ = GST_LOCK_FLAG_READ,
150 GST_MAP_WRITE = GST_LOCK_FLAG_WRITE,
152 GST_MAP_FLAG_LAST = (1 << 16)
158 * GstMapFlags value alias for GST_MAP_READ | GST_MAP_WRITE
160 #define GST_MAP_READWRITE (GST_MAP_READ | GST_MAP_WRITE)
165 * @memory: a pointer to the mapped memory
166 * @flags: flags used when mapping the memory
167 * @data: (array length=size): a pointer to the mapped data
168 * @size: the valid size in @data
169 * @maxsize: the maximum bytes in @data
170 * @user_data: extra private user_data that the implementation of the memory
171 * can use to store extra info.
173 * A structure containing the result of a map operation such as
174 * gst_memory_map(). It contains the data and size.
183 gpointer user_data[4];
189 * Initializer for #GstMapInfo
191 #define GST_MAP_INFO_INIT { NULL, 0, NULL, 0, 0, }
194 * GstMemoryMapFunction:
196 * @maxsize: size to map
197 * @flags: access mode for the memory
199 * Get the memory of @mem that can be accessed according to the mode specified
200 * in @flags. The function should return a pointer that contains at least
203 * Returns: a pointer to memory of which at least @maxsize bytes can be
204 * accessed according to the access pattern in @flags.
206 typedef gpointer (*GstMemoryMapFunction) (GstMemory *mem, gsize maxsize, GstMapFlags flags);
209 * GstMemoryUnmapFunction:
212 * Return the pointer previously retrieved with gst_memory_map().
214 * Returns: %TRUE on success.
216 typedef void (*GstMemoryUnmapFunction) (GstMemory *mem);
219 * GstMemoryCopyFunction:
222 * @size: a size or -1
224 * Copy @size bytes from @mem starting at @offset and return them wrapped in a
225 * new GstMemory object.
226 * If @size is set to -1, all bytes starting at @offset are copied.
228 * Returns: a new #GstMemory object wrapping a copy of the requested region in
231 typedef GstMemory * (*GstMemoryCopyFunction) (GstMemory *mem, gssize offset, gssize size);
234 * GstMemoryShareFunction:
237 * @size: a size or -1
239 * Share @size bytes from @mem starting at @offset and return them wrapped in a
240 * new GstMemory object. If @size is set to -1, all bytes starting at @offset are
241 * shared. This function does not make a copy of the bytes in @mem.
243 * Returns: a new #GstMemory object sharing the requested region in @mem.
245 typedef GstMemory * (*GstMemoryShareFunction) (GstMemory *mem, gssize offset, gssize size);
248 * GstMemoryIsSpanFunction:
249 * @mem1: a #GstMemory
250 * @mem2: a #GstMemory
251 * @offset: a result offset
253 * Check if @mem1 and @mem2 occupy contiguous memory and return the offset of
254 * @mem1 in the parent buffer in @offset.
256 * Returns: %TRUE if @mem1 and @mem2 are in contiguous memory.
258 typedef gboolean (*GstMemoryIsSpanFunction) (GstMemory *mem1, GstMemory *mem2, gsize *offset);
260 void gst_memory_init (GstMemory *mem, GstMemoryFlags flags,
261 GstAllocator *allocator, GstMemory *parent,
262 gsize maxsize, gsize align,
263 gsize offset, gsize size);
267 * @memory: The memory to refcount
269 * Increase the refcount of this memory.
271 * Returns: (transfer full): @memory (for convenience when doing assignments)
273 #ifdef _FOOL_GTK_DOC_
274 G_INLINE_FUNC GstMemory * gst_memory_ref (GstMemory * memory);
277 static inline GstMemory *
278 gst_memory_ref (GstMemory * memory)
280 return (GstMemory *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (memory));
285 * @memory: (transfer full): the memory to refcount
287 * Decrease the refcount of an memory, freeing it if the refcount reaches 0.
289 #ifdef _FOOL_GTK_DOC_
290 G_INLINE_FUNC void gst_memory_unref (GstMemory * memory);
294 gst_memory_unref (GstMemory * memory)
296 gst_mini_object_unref (GST_MINI_OBJECT_CAST (memory));
299 /* getting/setting memory properties */
300 gsize gst_memory_get_sizes (GstMemory *mem, gsize *offset, gsize *maxsize);
301 void gst_memory_resize (GstMemory *mem, gssize offset, gsize size);
303 #define gst_memory_lock(m,f) gst_mini_object_lock (GST_MINI_OBJECT_CAST (m), (f))
304 #define gst_memory_unlock(m,f) gst_mini_object_unlock (GST_MINI_OBJECT_CAST (m), (f))
305 #define gst_memory_is_writable(m) gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (m))
307 /* retrieving data */
308 GstMemory * gst_memory_make_mapped (GstMemory *mem, GstMapInfo *info, GstMapFlags flags);
309 gboolean gst_memory_map (GstMemory *mem, GstMapInfo *info, GstMapFlags flags);
310 void gst_memory_unmap (GstMemory *mem, GstMapInfo *info);
312 /* copy and subregions */
313 GstMemory * gst_memory_copy (GstMemory *mem, gssize offset, gssize size);
314 GstMemory * gst_memory_share (GstMemory *mem, gssize offset, gssize size);
317 gboolean gst_memory_is_span (GstMemory *mem1, GstMemory *mem2, gsize *offset);
321 #endif /* __GST_MEMORY_H__ */