2 * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg 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 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 * Memory handling functions.
30 #define DECLARE_ALIGNED(n,t,v) t v __attribute__ ((aligned (n)))
31 #define DECLARE_ASM_CONST(n,t,v) const t __attribute__ ((aligned (n))) v
32 #elif defined(__GNUC__)
33 #define DECLARE_ALIGNED(n,t,v) t v __attribute__ ((aligned (n)))
34 #define DECLARE_ASM_CONST(n,t,v) static const t v attribute_used __attribute__ ((aligned (n)))
35 #elif defined(_MSC_VER)
36 #define DECLARE_ALIGNED(n,t,v) __declspec(align(n)) t v
37 #define DECLARE_ASM_CONST(n,t,v) __declspec(align(n)) static const t v
38 #elif defined(HAVE_INLINE_ASM)
39 #error The asm code needs alignment, but we do not know how to do it for this compiler.
41 #define DECLARE_ALIGNED(n,t,v) t v
42 #define DECLARE_ASM_CONST(n,t,v) static const t v
45 #if defined(__GNUC__) && (__GNU__ > 3 || __GNU__ == 3 && __GNU_MINOR__ > 0)
46 #define av_malloc_attrib __attribute__((__malloc__))
48 #define av_malloc_attrib
51 #if defined(__GNUC__) && (__GNU__ > 4 || __GNU__ == 4 && __GNU_MINOR__ > 1)
52 #define av_alloc_size(n) __attribute__((alloc_size(n)))
54 #define av_alloc_size(n)
58 * Allocate a block of \p size bytes with alignment suitable for all
59 * memory accesses (including vectors if available on the CPU).
60 * @param size Size in bytes for the memory block to be allocated.
61 * @return Pointer to the allocated block, NULL if it cannot allocate
65 void *av_malloc(unsigned int size) av_malloc_attrib av_alloc_size(1);
68 * Allocate or reallocate a block of memory.
69 * If \p ptr is NULL and \p size > 0, allocate a new block. If \p
70 * size is zero, free the memory block pointed by \p ptr.
71 * @param size Size in bytes for the memory block to be allocated or
73 * @param ptr Pointer to a memory block already allocated with
74 * av_malloc(z)() or av_realloc() or NULL.
75 * @return Pointer to a newly reallocated block or NULL if it cannot
76 * reallocate or the function is used to free the memory block.
77 * @see av_fast_realloc()
79 void *av_realloc(void *ptr, unsigned int size) av_alloc_size(2);
82 * Free a memory block which has been allocated with av_malloc(z)() or
84 * @param ptr Pointer to the memory block which should be freed.
85 * @note ptr = NULL is explicitly allowed.
86 * @note It is recommended that you use av_freep() instead.
89 void av_free(void *ptr);
92 * Allocate a block of \p size bytes with alignment suitable for all
93 * memory accesses (including vectors if available on the CPU) and
94 * set to zeroes all the bytes of the block.
95 * @param size Size in bytes for the memory block to be allocated.
96 * @return Pointer to the allocated block, NULL if it cannot allocate
100 void *av_mallocz(unsigned int size) av_malloc_attrib av_alloc_size(1);
103 * Duplicate the string \p s.
104 * @param s String to be duplicated.
105 * @return Pointer to a newly allocated string containing a
106 * copy of \p s or NULL if it cannot be allocated.
108 char *av_strdup(const char *s) av_malloc_attrib;
111 * Free a memory block which has been allocated with av_malloc(z)() or
112 * av_realloc() and set to NULL the pointer to it.
113 * @param ptr Pointer to the pointer to the memory block which should
117 void av_freep(void *ptr);
119 #endif /* FFMPEG_MEM_H */