Directly #include a bunch of indirectly #included headers.
[libav.git] / libavutil / mem.h
CommitLineData
792098c2
PI
1/*
2 * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
3 *
4 * This file is part of FFmpeg.
5 *
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.
10 *
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.
15 *
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
19 */
20
21/**
22 * @file mem.h
23 * Memory handling functions.
24 */
25
98790382
SS
26#ifndef AVUTIL_MEM_H
27#define AVUTIL_MEM_H
792098c2 28
dfcb6b56 29#include "config.h"
52476c1b
CEH
30#include "common.h"
31
aaa0df02 32#if defined(__ICC) || defined(__SUNPRO_C)
4bfc91a0
DB
33 #define DECLARE_ALIGNED(n,t,v) t v __attribute__ ((aligned (n)))
34 #define DECLARE_ASM_CONST(n,t,v) const t __attribute__ ((aligned (n))) v
5cbd67ea 35#elif defined(__GNUC__)
4bfc91a0
DB
36 #define DECLARE_ALIGNED(n,t,v) t v __attribute__ ((aligned (n)))
37 #define DECLARE_ASM_CONST(n,t,v) static const t v attribute_used __attribute__ ((aligned (n)))
a02dd7eb 38#elif defined(_MSC_VER)
4bfc91a0
DB
39 #define DECLARE_ALIGNED(n,t,v) __declspec(align(n)) t v
40 #define DECLARE_ASM_CONST(n,t,v) __declspec(align(n)) static const t v
b250f9c6 41#elif HAVE_INLINE_ASM
c123486e 42 #error The asm code needs alignment, but we do not know how to do it for this compiler.
7cb1fc76 43#else
4bfc91a0
DB
44 #define DECLARE_ALIGNED(n,t,v) t v
45 #define DECLARE_ASM_CONST(n,t,v) static const t v
792098c2
PI
46#endif
47
52476c1b 48#if AV_GCC_VERSION_AT_LEAST(3,1)
85074d3c
ZM
49 #define av_malloc_attrib __attribute__((__malloc__))
50#else
51 #define av_malloc_attrib
52#endif
53
af4c0bcb 54#if (!defined(__ICC) || __ICC > 1100) && AV_GCC_VERSION_AT_LEAST(4,3)
cca6d953
ZM
55 #define av_alloc_size(n) __attribute__((alloc_size(n)))
56#else
57 #define av_alloc_size(n)
58#endif
59
792098c2 60/**
0ee97f0d
SS
61 * Allocate a block of \p size bytes with alignment suitable for all
62 * memory accesses (including vectors if available on the CPU).
63 * @param size Size in bytes for the memory block to be allocated.
64 * @return Pointer to the allocated block, NULL if it cannot allocate
65 * it.
66 * @see av_mallocz()
792098c2 67 */
cca6d953 68void *av_malloc(unsigned int size) av_malloc_attrib av_alloc_size(1);
792098c2
PI
69
70/**
0ee97f0d
SS
71 * Allocate or reallocate a block of memory.
72 * If \p ptr is NULL and \p size > 0, allocate a new block. If \p
73 * size is zero, free the memory block pointed by \p ptr.
74 * @param size Size in bytes for the memory block to be allocated or
75 * reallocated.
76 * @param ptr Pointer to a memory block already allocated with
77 * av_malloc(z)() or av_realloc() or NULL.
78 * @return Pointer to a newly reallocated block or NULL if it cannot
79 * reallocate or the function is used to free the memory block.
80 * @see av_fast_realloc()
792098c2 81 */
cca6d953 82void *av_realloc(void *ptr, unsigned int size) av_alloc_size(2);
792098c2
PI
83
84/**
0ee97f0d
SS
85 * Free a memory block which has been allocated with av_malloc(z)() or
86 * av_realloc().
87 * @param ptr Pointer to the memory block which should be freed.
22baf42c
SS
88 * @note ptr = NULL is explicitly allowed.
89 * @note It is recommended that you use av_freep() instead.
0ee97f0d 90 * @see av_freep()
792098c2
PI
91 */
92void av_free(void *ptr);
93
0ee97f0d
SS
94/**
95 * Allocate a block of \p size bytes with alignment suitable for all
96 * memory accesses (including vectors if available on the CPU) and
97 * set to zeroes all the bytes of the block.
98 * @param size Size in bytes for the memory block to be allocated.
99 * @return Pointer to the allocated block, NULL if it cannot allocate
100 * it.
101 * @see av_malloc()
102 */
cca6d953 103void *av_mallocz(unsigned int size) av_malloc_attrib av_alloc_size(1);
d3de3ee2
SS
104
105/**
8a2d973d 106 * Duplicate the string \p s.
d3de3ee2
SS
107 * @param s String to be duplicated.
108 * @return Pointer to a newly allocated string containing a
8a2d973d 109 * copy of \p s or NULL if it cannot be allocated.
d3de3ee2 110 */
85074d3c 111char *av_strdup(const char *s) av_malloc_attrib;
792098c2
PI
112
113/**
0ee97f0d
SS
114 * Free a memory block which has been allocated with av_malloc(z)() or
115 * av_realloc() and set to NULL the pointer to it.
116 * @param ptr Pointer to the pointer to the memory block which should
117 * be freed.
118 * @see av_free()
792098c2
PI
119 */
120void av_freep(void *ptr);
121
98790382 122#endif /* AVUTIL_MEM_H */