buffer: Add annotations and pygi friendly extraction function

API: gst_buffer_extract_dup
This commit is contained in:
Olivier Crête 2013-03-26 19:22:18 -04:00
parent 21851c0e04
commit ec16d6b0a4
5 changed files with 44 additions and 11 deletions

View file

@ -223,6 +223,7 @@ gst_buffer_unmap
gst_buffer_memcmp gst_buffer_memcmp
gst_buffer_extract gst_buffer_extract
gst_buffer_extract_dup
gst_buffer_fill gst_buffer_fill
gst_buffer_memset gst_buffer_memset

View file

@ -599,19 +599,20 @@ _priv_gst_memory_initialize (void)
/** /**
* gst_memory_new_wrapped: * gst_memory_new_wrapped:
* @flags: #GstMemoryFlags * @flags: #GstMemoryFlags
* @data: data to wrap * @data: (array length=size) (element-type guint8) (transfer none): data to
* wrap
* @maxsize: allocated size of @data * @maxsize: allocated size of @data
* @offset: offset in @data * @offset: offset in @data
* @size: size of valid data * @size: size of valid data
* @user_data: user_data * @user_data: (allow-none): user_data
* @notify: called with @user_data when the memory is freed * @notify: (allow-none) (scope async) (closure user_data): called with @user_data when the memory is freed
* *
* Allocate a new memory block that wraps the given @data. * Allocate a new memory block that wraps the given @data.
* *
* The prefix/padding must be filled with 0 if @flags contains * The prefix/padding must be filled with 0 if @flags contains
* #GST_MEMORY_FLAG_ZERO_PREFIXED and #GST_MEMORY_FLAG_ZERO_PADDED respectively. * #GST_MEMORY_FLAG_ZERO_PREFIXED and #GST_MEMORY_FLAG_ZERO_PADDED respectively.
* *
* Returns: a new #GstMemory. * Returns: (transfer full): a new #GstMemory.
*/ */
GstMemory * GstMemory *
gst_memory_new_wrapped (GstMemoryFlags flags, gpointer data, gst_memory_new_wrapped (GstMemoryFlags flags, gpointer data,

View file

@ -719,12 +719,12 @@ no_memory:
/** /**
* gst_buffer_new_wrapped_full: * gst_buffer_new_wrapped_full:
* @flags: #GstMemoryFlags * @flags: #GstMemoryFlags
* @data: (array length=size) (element-type guint8): data to wrap * @data: (array length=size) (element-type guint8) (transfer none): data to wrap
* @maxsize: allocated size of @data * @maxsize: allocated size of @data
* @offset: offset in @data * @offset: offset in @data
* @size: size of valid data * @size: size of valid data
* @user_data: user_data * @user_data: (allow-none): user_data
* @notify: called with @user_data when the memory is freed * @notify: (allow-none) (scope async) (closure user_data): called with @user_data when the memory is freed
* *
* Allocate a new buffer that wraps the given memory. @data must point to * Allocate a new buffer that wraps the given memory. @data must point to
* @maxsize of memory, the wrapped buffer will have the region from @offset and * @maxsize of memory, the wrapped buffer will have the region from @offset and
@ -754,7 +754,7 @@ gst_buffer_new_wrapped_full (GstMemoryFlags flags, gpointer data,
/** /**
* gst_buffer_new_wrapped: * gst_buffer_new_wrapped:
* @data: (array length=size) (element-type guint8): data to wrap * @data: (array length=size) (element-type guint8) (transfer full): data to wrap
* @size: allocated size of @data * @size: allocated size of @data
* *
* Creates a new buffer that wraps the given @data. The memory will be freed * Creates a new buffer that wraps the given @data. The memory will be freed
@ -1529,7 +1529,7 @@ gst_buffer_unmap (GstBuffer * buffer, GstMapInfo * info)
* gst_buffer_fill: * gst_buffer_fill:
* @buffer: a #GstBuffer. * @buffer: a #GstBuffer.
* @offset: the offset to fill * @offset: the offset to fill
* @src: the source address * @src: (array length=size) (element-type guint8): the source address
* @size: the size to fill * @size: the size to fill
* *
* Copy @size bytes from @src to @buffer at @offset. * Copy @size bytes from @src to @buffer at @offset.
@ -1631,7 +1631,7 @@ gst_buffer_extract (GstBuffer * buffer, gsize offset, gpointer dest, gsize size)
* gst_buffer_memcmp: * gst_buffer_memcmp:
* @buffer: a #GstBuffer. * @buffer: a #GstBuffer.
* @offset: the offset in @buffer * @offset: the offset in @buffer
* @mem: the memory to compare * @mem: (array length=size) (element-type guint8): the memory to compare
* @size: the size to compare * @size: the size to compare
* *
* Compare @size bytes starting from @offset in @buffer with the memory in @mem. * Compare @size bytes starting from @offset in @buffer with the memory in @mem.
@ -2051,3 +2051,31 @@ gst_buffer_foreach_meta (GstBuffer * buffer, GstBufferForeachMetaFunc func,
} }
return res; return res;
} }
/**
* gst_buffer_extract_dup:
* @buffer: a #GstBuffer
* @offset: the offset to extract
* @size: the size to extract
* @dest: (array length=dest_size) (element-type guint8) (out): A pointer where
* the destination array will be written.
* @dest_size: (out): A location where the size of @dest can be written
*
* Extracts a copy of at most @size bytes the data at @offset into a #GBytes.
* @dest must be freed using g_free() when done.
*
* Since: 3.2
*/
void
gst_buffer_extract_dup (GstBuffer * buffer, gsize offset, gsize size,
gpointer * dest, gsize * dest_size)
{
gsize real_size;
real_size = gst_buffer_get_size (buffer);
*dest = g_malloc (MIN (real_size - offset, size));
*dest_size = gst_buffer_extract (buffer, offset, *dest, size);
}

View file

@ -306,7 +306,9 @@ gboolean gst_buffer_map_range (GstBuffer *buffer, guint idx, gint l
gboolean gst_buffer_map (GstBuffer *buffer, GstMapInfo *info, GstMapFlags flags); gboolean gst_buffer_map (GstBuffer *buffer, GstMapInfo *info, GstMapFlags flags);
void gst_buffer_unmap (GstBuffer *buffer, GstMapInfo *info); void gst_buffer_unmap (GstBuffer *buffer, GstMapInfo *info);
void gst_buffer_extract_dup (GstBuffer *buffer, gsize offset,
gsize size, gpointer *dest,
gsize *dest_size);
/* refcounting */ /* refcounting */
/** /**

View file

@ -98,6 +98,7 @@ EXPORTS
gst_buffer_copy_into gst_buffer_copy_into
gst_buffer_copy_region gst_buffer_copy_region
gst_buffer_extract gst_buffer_extract
gst_buffer_extract_dup
gst_buffer_fill gst_buffer_fill
gst_buffer_find_memory gst_buffer_find_memory
gst_buffer_flags_get_type gst_buffer_flags_get_type