diff mbox series

[FFmpeg-devel,1/2] avutil/buffer: add a mention that some arguments from av_buffer_pool_init2() may be NULL

Message ID 20200530233204.683-1-jamrial@gmail.com
State New
Headers show
Series [FFmpeg-devel,1/2] avutil/buffer: add a mention that some arguments from av_buffer_pool_init2() may be NULL
Related show

Checks

Context Check Description
andriy/default pending
andriy/make success Make finished
andriy/make_fate success Make fate finished

Commit Message

James Almer May 30, 2020, 11:32 p.m. UTC
Signed-off-by: James Almer <jamrial@gmail.com>
---
 libavutil/buffer.h | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git a/libavutil/buffer.h b/libavutil/buffer.h
index e0f94314f4..aa611fee8a 100644
--- a/libavutil/buffer.h
+++ b/libavutil/buffer.h
@@ -252,14 +252,15 @@  AVBufferPool *av_buffer_pool_init(int size, AVBufferRef* (*alloc)(int size));
  * Allocate and initialize a buffer pool with a more complex allocator.
  *
  * @param size size of each buffer in this pool
- * @param opaque arbitrary user data used by the allocator
+ * @param opaque arbitrary user data used by the allocator. May be NULL.
  * @param alloc a function that will be used to allocate new buffers when the
  *              pool is empty.
  * @param pool_free a function that will be called immediately before the pool
  *                  is freed. I.e. after av_buffer_pool_uninit() is called
  *                  by the caller and all the frames are returned to the pool
  *                  and freed. It is intended to uninitialize the user opaque
- *                  data.
+ *                  data. May be NULL if the opaque data doesn't need to be
+ *                  uninitialized.
  * @return newly created buffer pool on success, NULL on error.
  */
 AVBufferPool *av_buffer_pool_init2(int size, void *opaque,