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