Remove explicit filename from Doxygen @file commands.
[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
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 #if AV_GCC_VERSION_AT_LEAST(3,1)
53     #define av_malloc_attrib __attribute__((__malloc__))
54 #else
55     #define av_malloc_attrib
56 #endif
57
58 #if (!defined(__ICC) || __ICC > 1110) && AV_GCC_VERSION_AT_LEAST(4,3)
59     #define av_alloc_size(n) __attribute__((alloc_size(n)))
60 #else
61     #define av_alloc_size(n)
62 #endif
63
64 /**
65  * Allocates a block of size bytes with alignment suitable for all
66  * memory accesses (including vectors if available on the CPU).
67  * @param size Size in bytes for the memory block to be allocated.
68  * @return Pointer to the allocated block, NULL if the block cannot
69  * be allocated.
70  * @see av_mallocz()
71  */
72 void *av_malloc(unsigned int size) av_malloc_attrib av_alloc_size(1);
73
74 /**
75  * Allocates or reallocates a block of memory.
76  * If ptr is NULL and size > 0, allocates a new block. If
77  * size is zero, frees the memory block pointed to by ptr.
78  * @param size Size in bytes for the memory block to be allocated or
79  * reallocated.
80  * @param ptr Pointer to a memory block already allocated with
81  * av_malloc(z)() or av_realloc() or NULL.
82  * @return Pointer to a newly reallocated block or NULL if the block
83  * cannot be reallocated or the function is used to free the memory block.
84  * @see av_fast_realloc()
85  */
86 void *av_realloc(void *ptr, unsigned int size) av_alloc_size(2);
87
88 /**
89  * Frees a memory block which has been allocated with av_malloc(z)() or
90  * av_realloc().
91  * @param ptr Pointer to the memory block which should be freed.
92  * @note ptr = NULL is explicitly allowed.
93  * @note It is recommended that you use av_freep() instead.
94  * @see av_freep()
95  */
96 void av_free(void *ptr);
97
98 /**
99  * Allocates a block of size bytes with alignment suitable for all
100  * memory accesses (including vectors if available on the CPU) and
101  * zeroes all the bytes of the block.
102  * @param size Size in bytes for the memory block to be allocated.
103  * @return Pointer to the allocated block, NULL if it cannot be allocated.
104  * @see av_malloc()
105  */
106 void *av_mallocz(unsigned int size) av_malloc_attrib av_alloc_size(1);
107
108 /**
109  * Duplicates the string s.
110  * @param s string to be duplicated
111  * @return Pointer to a newly allocated string containing a
112  * copy of s or NULL if the string cannot be allocated.
113  */
114 char *av_strdup(const char *s) av_malloc_attrib;
115
116 /**
117  * Frees a memory block which has been allocated with av_malloc(z)() or
118  * av_realloc() and set the pointer pointing to it to NULL.
119  * @param ptr Pointer to the pointer to the memory block which should
120  * be freed.
121  * @see av_free()
122  */
123 void av_freep(void *ptr);
124
125 #endif /* AVUTIL_MEM_H */