From b4ec7a5fee644ad9882e10c097817b65447b8e55 Mon Sep 17 00:00:00 2001 From: Luca Barbato Date: Sun, 1 Sep 2013 19:46:59 +0200 Subject: mem: Document the av_realloc family of functions properly realloc() does not accept pointers from memalign(). --- libavutil/mem.h | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) (limited to 'libavutil/mem.h') diff --git a/libavutil/mem.h b/libavutil/mem.h index 8a4fcd90ae..e472a3f81c 100644 --- a/libavutil/mem.h +++ b/libavutil/mem.h @@ -101,8 +101,10 @@ av_alloc_size(1, 2) static inline void *av_malloc_array(size_t nmemb, size_t siz * Allocate or reallocate a block of memory. * If ptr is NULL and size > 0, allocate a new block. If * size is zero, free the memory block pointed to by ptr. + * @note Pointers provided by av_malloc family of functions cannot be + * passed to av_realloc(). * @param ptr Pointer to a memory block already allocated with - * av_malloc(z)() or av_realloc() or NULL. + * av_realloc() or NULL. * @param size Size in bytes for the memory block to be allocated or * reallocated. * @return Pointer to a newly reallocated block or NULL if the block @@ -115,8 +117,10 @@ void *av_realloc(void *ptr, size_t size) av_alloc_size(2); * Allocate or reallocate an array. * If ptr is NULL and nmemb > 0, allocate a new block. If * nmemb is zero, free the memory block pointed to by ptr. + * @note Pointers provided by av_malloc family of functions cannot be + * passed to av_realloc_array(). * @param ptr Pointer to a memory block already allocated with - * av_malloc(z)() or av_realloc() or NULL. + * av_realloc() or NULL. * @param nmemb Number of elements * @param size Size of the single element * @return Pointer to a newly reallocated block or NULL if the block @@ -128,8 +132,10 @@ av_alloc_size(2, 3) void *av_realloc_array(void *ptr, size_t nmemb, size_t size) * Allocate or reallocate an array. * If *ptr is NULL and nmemb > 0, allocate a new block. If * nmemb is zero, free the memory block pointed to by ptr. + * @note Pointers provided by av_malloc family of functions cannot be + * passed to av_reallocp_array(). * @param ptr Pointer to a pointer to a memory block already allocated - * with av_malloc(z)() or av_realloc(), or pointer to a pointer to NULL. + * with av_realloc(), or pointer to a pointer to NULL. * The pointer is updated on success, or freed on failure. * @param nmemb Number of elements * @param size Size of the single element -- cgit v1.2.3