mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-02 22:46:35 +00:00
Code Issues 1 Projects Releases Wiki Activity

dmabuf: Improve documentation and annotations a bit

Browse source
This commit is contained in:
Sebastian Dröge 2013-02-19 09:35:51 +01:00
parent ceecdb8e1d
commit 76400ef226
1 changed files with 39 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
gst-libs/gst/allocators/gstdmabuf.c
View file

@ -26,7 +26,7 @@
#include <sys/mman.h> #include <sys/mman.h>
#include <unistd.h> #include <unistd.h>
/** /*
* GstDmaBufMemory * GstDmaBufMemory
* @fd: the file descriptor associated this memory * @fd: the file descriptor associated this memory
* @data: mmapped address * @data: mmapped address
@ -157,8 +157,8 @@ _dmabuf_mem_copy (GstDmaBufMemory * mem, gssize offset, gsize size)
gint newfd = dup (mem->fd); gint newfd = dup (mem->fd);
if (newfd == -1) { if (newfd == -1) {
GST_WARNING ("Can't duplicate dmabuf file descriptor"); GST_WARNING ("Can't duplicate dmabuf file descriptor");
return NULL; return NULL;
} }
GST_DEBUG ("%p: copy %" G_GSSIZE_FORMAT " %" G_GSIZE_FORMAT, mem, offset, GST_DEBUG ("%p: copy %" G_GSSIZE_FORMAT " %" G_GSIZE_FORMAT, mem, offset,
@ -217,8 +217,11 @@ _dmabuf_mem_init (void)
} }
/** /**
* gst_dmabuf_allocator_obtain * gst_dmabuf_allocator_obtain:
* return a dmabuf allocator or NULL if the allocator isn't found *
* Returns a dmabuf allocator.
*
* Returns: (transfer full): a dmabuf allocator or NULL if the allocator isn't found
* Use gst_object_unref() to release the allocator after usage. * Use gst_object_unref() to release the allocator after usage.
*/ */
GstAllocator * GstAllocator *
@ -226,6 +229,7 @@ gst_dmabuf_allocator_obtain (void)
{ {
static GOnce dmabuf_allocator_once = G_ONCE_INIT; static GOnce dmabuf_allocator_once = G_ONCE_INIT;
GstAllocator *allocator; GstAllocator *allocator;
g_once (&dmabuf_allocator_once, (GThreadFunc) _dmabuf_mem_init, NULL); g_once (&dmabuf_allocator_once, (GThreadFunc) _dmabuf_mem_init, NULL);
allocator = gst_allocator_find (ALLOCATOR_NAME); allocator = gst_allocator_find (ALLOCATOR_NAME);
@ -235,13 +239,16 @@ gst_dmabuf_allocator_obtain (void)
} }
/* /*
* gst_dmabuf_allocator_alloc * gst_dmabuf_allocator_alloc:
* @allocator: allocator to be used for this memory * @allocator: allocator to be used for this memory
* @fd: dmabuf file descriptor * @fd: dmabuf file descriptor
* @size: memory size * @size: memory size
* return a GstMemory based on @allocator. *
* Returns a %GstMemory that wraps a dmabuf file descriptor.
*
* Returns: (transfer full): a GstMemory based on @allocator.
* When the buffer will be released dmabuf allocator will close the @fd. * When the buffer will be released dmabuf allocator will close the @fd.
* The memory is only mmapped on gst_buffer_mmap request. * The memory is only mmapped on gst_buffer_mmap() request.
*/ */
GstMemory * GstMemory *
gst_dmabuf_allocator_alloc (GstAllocator * allocator, gint fd, gsize size) gst_dmabuf_allocator_alloc (GstAllocator * allocator, gint fd, gsize size)
@ -249,7 +256,7 @@ gst_dmabuf_allocator_alloc (GstAllocator * allocator, gint fd, gsize size)
GstDmaBufMemory *mem; GstDmaBufMemory *mem;
if (!allocator) { if (!allocator) {
allocator = gst_dmabuf_allocator_obtain(); allocator = gst_dmabuf_allocator_obtain ();
} }
if (!GST_IS_DMABUF_ALLOCATOR (allocator)) { if (!GST_IS_DMABUF_ALLOCATOR (allocator)) {
@ -270,13 +277,17 @@ gst_dmabuf_allocator_alloc (GstAllocator * allocator, gint fd, gsize size)
g_mutex_init (&mem->lock); g_mutex_init (&mem->lock);
GST_DEBUG ("%p: fd: %d size %d", mem, mem->fd, mem->mem.maxsize); GST_DEBUG ("%p: fd: %d size %d", mem, mem->fd, mem->mem.maxsize);
return (GstMemory *) mem; return (GstMemory *) mem;
} }
/** /**
* gst_dmabuf_memory_get_fd * gst_dmabuf_memory_get_fd:
* @mem: the memory to get the file descriptor * @mem: the memory to get the file descriptor
* return the file descriptor associated with the memory *
* Returns the file descriptor associated with @mem
*
* Returns: the file descriptor associated with the memory
* else return -1 * else return -1
*/ */
gint gint
@ -290,9 +301,12 @@ gst_dmabuf_memory_get_fd (GstMemory * mem)
} }
/** /**
* gst_is_dmabuf_memory * gst_is_dmabuf_memory:
* @mem: the memory to be check * @mem: the memory to be check
* return true is the memory allocator is the dmabuf one *
* Check if @mem is dmabuf memory.
*
* Returns: %TRUE if @mem is dmabuf memory
*/ */
gboolean gboolean
gst_is_dmabuf_memory (GstMemory * mem) gst_is_dmabuf_memory (GstMemory * mem)
@ -302,24 +316,28 @@ gst_is_dmabuf_memory (GstMemory * mem)
#else #else
GstAllocator * gst_dmabuf_allocator_obtain(void) GstAllocator *
gst_dmabuf_allocator_obtain (void)
{ {
return NULL; return NULL;
} }
GstMemory * gst_dmabuf_allocator_alloc(GstAllocator * allocator, gint fd, gsize size) GstMemory *
gst_dmabuf_allocator_alloc (GstAllocator * allocator, gint fd, gsize size)
{ {
return NULL; return NULL;
} }
gint gst_dmabuf_memory_get_fd(GstMemory * mem) gint
gst_dmabuf_memory_get_fd (GstMemory * mem)
{ {
return -1; return -1;
} }
gboolean gst_is_dmabuf_memory(GstMemory * mem) gboolean
gst_is_dmabuf_memory (GstMemory * mem)
{ {
return FALSE; return FALSE;
} }
#endif /* HAVE_MMAP */ #endif /* HAVE_MMAP */