libavutil: drop fallback definitions of INTxx_MIN/MAX
[ffmpeg.git] / libavutil / mem.h
1 /*
2  * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
3  *
4  * This file is part of Libav.
5  *
6  * Libav 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  * Libav 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 Libav; 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
23  * memory handling functions
24  */
25
26 #ifndef AVUTIL_MEM_H
27 #define AVUTIL_MEM_H
28
29 #include "attributes.h"
30 #include "avutil.h"
31
32 /**
33  * @addtogroup lavu_mem
34  * @{
35  */
36
37
38 #if defined(__ICC) && _ICC < 1200 || defined(__SUNPRO_C)
39     #define DECLARE_ALIGNED(n,t,v)      t __attribute__ ((aligned (n))) v
40     #define DECLARE_ASM_CONST(n,t,v)    const t __attribute__ ((aligned (n))) v
41 #elif defined(__TI_COMPILER_VERSION__)
42     #define DECLARE_ALIGNED(n,t,v)                      \
43         AV_PRAGMA(DATA_ALIGN(v,n))                      \
44         t __attribute__((aligned(n))) v
45     #define DECLARE_ASM_CONST(n,t,v)                    \
46         AV_PRAGMA(DATA_ALIGN(v,n))                      \
47         static const t __attribute__((aligned(n))) v
48 #elif defined(__GNUC__)
49     #define DECLARE_ALIGNED(n,t,v)      t __attribute__ ((aligned (n))) v
50     #define DECLARE_ASM_CONST(n,t,v)    static const t av_used __attribute__ ((aligned (n))) v
51 #elif defined(_MSC_VER)
52     #define DECLARE_ALIGNED(n,t,v)      __declspec(align(n)) t v
53     #define DECLARE_ASM_CONST(n,t,v)    __declspec(align(n)) static const t v
54 #else
55     #define DECLARE_ALIGNED(n,t,v)      t v
56     #define DECLARE_ASM_CONST(n,t,v)    static const t v
57 #endif
58
59 #if AV_GCC_VERSION_AT_LEAST(3,1)
60     #define av_malloc_attrib __attribute__((__malloc__))
61 #else
62     #define av_malloc_attrib
63 #endif
64
65 #if AV_GCC_VERSION_AT_LEAST(4,3)
66     #define av_alloc_size(...) __attribute__((alloc_size(__VA_ARGS__)))
67 #else
68     #define av_alloc_size(...)
69 #endif
70
71 /**
72  * Allocate a block of size bytes with alignment suitable for all
73  * memory accesses (including vectors if available on the CPU).
74  * @param size Size in bytes for the memory block to be allocated.
75  * @return Pointer to the allocated block, NULL if the block cannot
76  * be allocated.
77  * @see av_mallocz()
78  */
79 void *av_malloc(size_t size) av_malloc_attrib av_alloc_size(1);
80
81 /**
82  * Helper function to allocate a block of size * nmemb bytes with
83  * using av_malloc()
84  * @param nmemb Number of elements
85  * @param size Size of the single element
86  * @return Pointer to the allocated block, NULL if the block cannot
87  * be allocated.
88  * @see av_malloc()
89  */
90 av_alloc_size(1,2) static inline void *av_malloc_array(size_t nmemb, size_t size)
91 {
92     if (size <= 0 || nmemb >= INT_MAX / size)
93         return NULL;
94     return av_malloc(nmemb * size);
95 }
96
97 /**
98  * Allocate or reallocate a block of memory.
99  * If ptr is NULL and size > 0, allocate a new block. If
100  * size is zero, free the memory block pointed to by ptr.
101  * @param ptr Pointer to a memory block already allocated with
102  * av_malloc(z)() or av_realloc() or NULL.
103  * @param size Size in bytes for the memory block to be allocated or
104  * reallocated.
105  * @return Pointer to a newly reallocated block or NULL if the block
106  * cannot be reallocated or the function is used to free the memory block.
107  * @see av_fast_realloc()
108  */
109 void *av_realloc(void *ptr, size_t size) av_alloc_size(2);
110
111 /**
112  * Free a memory block which has been allocated with av_malloc(z)() or
113  * av_realloc().
114  * @param ptr Pointer to the memory block which should be freed.
115  * @note ptr = NULL is explicitly allowed.
116  * @note It is recommended that you use av_freep() instead.
117  * @see av_freep()
118  */
119 void av_free(void *ptr);
120
121 /**
122  * Allocate a block of size bytes with alignment suitable for all
123  * memory accesses (including vectors if available on the CPU) and
124  * zero all the bytes of the block.
125  * @param size Size in bytes for the memory block to be allocated.
126  * @return Pointer to the allocated block, NULL if it cannot be allocated.
127  * @see av_malloc()
128  */
129 void *av_mallocz(size_t size) av_malloc_attrib av_alloc_size(1);
130
131 /**
132  * Helper function to allocate a block of size * nmemb bytes with
133  * using av_mallocz()
134  * @param nmemb Number of elements
135  * @param size Size of the single element
136  * @return Pointer to the allocated block, NULL if the block cannot
137  * be allocated.
138  * @see av_mallocz()
139  * @see av_malloc_array()
140  */
141 av_alloc_size(1,2) static inline void *av_mallocz_array(size_t nmemb, size_t size)
142 {
143     if (size <= 0 || nmemb >= INT_MAX / size)
144         return NULL;
145     return av_mallocz(nmemb * size);
146 }
147
148 /**
149  * Duplicate the string s.
150  * @param s string to be duplicated
151  * @return Pointer to a newly allocated string containing a
152  * copy of s or NULL if the string cannot be allocated.
153  */
154 char *av_strdup(const char *s) av_malloc_attrib;
155
156 /**
157  * Free a memory block which has been allocated with av_malloc(z)() or
158  * av_realloc() and set the pointer pointing to it to NULL.
159  * @param ptr Pointer to the pointer to the memory block which should
160  * be freed.
161  * @see av_free()
162  */
163 void av_freep(void *ptr);
164
165 /**
166  * @}
167  */
168
169 #endif /* AVUTIL_MEM_H */