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