Merge remote-tracking branch 'newdev/master'
[ffmpeg.git] / libavutil / mem.h
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
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 #if defined(__INTEL_COMPILER) && __INTEL_COMPILER < 1110 || defined(__SUNPRO_C)
33     #define DECLARE_ALIGNED(n,t,v)      t __attribute__ ((aligned (n))) v
34     #define DECLARE_ASM_CONST(n,t,v)    const t __attribute__ ((aligned (n))) v
35 #elif defined(__TI_COMPILER_VERSION__)
36     #define DECLARE_ALIGNED(n,t,v)                      \
37         AV_PRAGMA(DATA_ALIGN(v,n))                      \
38         t __attribute__((aligned(n))) v
39     #define DECLARE_ASM_CONST(n,t,v)                    \
40         AV_PRAGMA(DATA_ALIGN(v,n))                      \
41         static const t __attribute__((aligned(n))) v
42 #elif defined(__GNUC__)
43     #define DECLARE_ALIGNED(n,t,v)      t __attribute__ ((aligned (n))) v
44     #define DECLARE_ASM_CONST(n,t,v)    static const t av_used __attribute__ ((aligned (n))) v
45 #elif defined(_MSC_VER)
46     #define DECLARE_ALIGNED(n,t,v)      __declspec(align(n)) t v
47     #define DECLARE_ASM_CONST(n,t,v)    __declspec(align(n)) static const t v
48 #else
49     #define DECLARE_ALIGNED(n,t,v)      t v
50     #define DECLARE_ASM_CONST(n,t,v)    static const t v
51 #endif
52
53 #if AV_GCC_VERSION_AT_LEAST(3,1)
54     #define av_malloc_attrib __attribute__((__malloc__))
55 #else
56     #define av_malloc_attrib
57 #endif
58
59 #if AV_GCC_VERSION_AT_LEAST(4,3)
60     #define av_alloc_size(n) __attribute__((alloc_size(n)))
61 #else
62     #define av_alloc_size(n)
63 #endif
64
65 #if LIBAVUTIL_VERSION_MAJOR < 51
66 #   define FF_INTERNAL_MEM_TYPE unsigned int
67 #   define FF_INTERNAL_MEM_TYPE_MAX_VALUE UINT_MAX
68 #else
69 #   define FF_INTERNAL_MEM_TYPE size_t
70 #   define FF_INTERNAL_MEM_TYPE_MAX_VALUE SIZE_MAX
71 #endif
72
73 /**
74  * Allocate a block of size bytes with alignment suitable for all
75  * memory accesses (including vectors if available on the CPU).
76  * @param size Size in bytes for the memory block to be allocated.
77  * @return Pointer to the allocated block, NULL if the block cannot
78  * be allocated.
79  * @see av_mallocz()
80  */
81 void *av_malloc(FF_INTERNAL_MEM_TYPE size) av_malloc_attrib av_alloc_size(1);
82
83 /**
84  * Allocate or reallocate a block of memory.
85  * If ptr is NULL and size > 0, allocate a new block. If
86  * size is zero, free the memory block pointed to by ptr.
87  * @param size Size in bytes for the memory block to be allocated or
88  * reallocated.
89  * @param ptr Pointer to a memory block already allocated with
90  * av_malloc(z)() or av_realloc() or NULL.
91  * @return Pointer to a newly reallocated block or NULL if the block
92  * cannot be reallocated or the function is used to free the memory block.
93  * @see av_fast_realloc()
94  */
95 void *av_realloc(void *ptr, FF_INTERNAL_MEM_TYPE size) av_alloc_size(2);
96
97 /**
98  * Free a memory block which has been allocated with av_malloc(z)() or
99  * av_realloc().
100  * @param ptr Pointer to the memory block which should be freed.
101  * @note ptr = NULL is explicitly allowed.
102  * @note It is recommended that you use av_freep() instead.
103  * @see av_freep()
104  */
105 void av_free(void *ptr);
106
107 /**
108  * Allocate a block of size bytes with alignment suitable for all
109  * memory accesses (including vectors if available on the CPU) and
110  * zero all the bytes of the block.
111  * @param size Size in bytes for the memory block to be allocated.
112  * @return Pointer to the allocated block, NULL if it cannot be allocated.
113  * @see av_malloc()
114  */
115 void *av_mallocz(FF_INTERNAL_MEM_TYPE size) av_malloc_attrib av_alloc_size(1);
116
117 /**
118  * Duplicate the string s.
119  * @param s string to be duplicated
120  * @return Pointer to a newly allocated string containing a
121  * copy of s or NULL if the string cannot be allocated.
122  */
123 char *av_strdup(const char *s) av_malloc_attrib;
124
125 /**
126  * Free a memory block which has been allocated with av_malloc(z)() or
127  * av_realloc() and set the pointer pointing to it to NULL.
128  * @param ptr Pointer to the pointer to the memory block which should
129  * be freed.
130  * @see av_free()
131  */
132 void av_freep(void *ptr);
133
134 #endif /* AVUTIL_MEM_H */