Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
[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 mem.h
23  * Memory handling functions.
24  */
25
26 #ifndef FFMPEG_MEM_H
27 #define FFMPEG_MEM_H
28
29 #ifdef __GNUC__
30   #define DECLARE_ALIGNED(n,t,v)       t v __attribute__ ((aligned (n)))
31 #else
32   #define DECLARE_ALIGNED(n,t,v)      __declspec(align(n)) t v
33 #endif
34
35 /**
36  * Allocate a block of \p size bytes with alignment suitable for all
37  * memory accesses (including vectors if available on the CPU).
38  * @param size Size in bytes for the memory block to be allocated.
39  * @return Pointer to the allocated block, NULL if it cannot allocate
40  * it.
41  * @see av_mallocz()
42  */
43 void *av_malloc(unsigned int size);
44
45 /**
46  * Allocate or reallocate a block of memory.
47  * If \p ptr is NULL and \p size > 0, allocate a new block. If \p
48  * size is zero, free the memory block pointed by \p ptr.
49  * @param size Size in bytes for the memory block to be allocated or
50  * reallocated.
51  * @param ptr Pointer to a memory block already allocated with
52  * av_malloc(z)() or av_realloc() or NULL.
53  * @return Pointer to a newly reallocated block or NULL if it cannot
54  * reallocate or the function is used to free the memory block.
55  * @see av_fast_realloc()
56  */
57 void *av_realloc(void *ptr, unsigned int size);
58
59 /**
60  * Free a memory block which has been allocated with av_malloc(z)() or
61  * av_realloc().
62  * @param ptr Pointer to the memory block which should be freed.
63  * @note ptr = NULL is explicitly allowed.
64  * @note It is recommended that you use av_freep() instead.
65  * @see av_freep()
66  */
67 void av_free(void *ptr);
68
69 /**
70  * Allocate a block of \p size bytes with alignment suitable for all
71  * memory accesses (including vectors if available on the CPU) and
72  * set to zeroes all the bytes of the block.
73  * @param size Size in bytes for the memory block to be allocated.
74  * @return Pointer to the allocated block, NULL if it cannot allocate
75  * it.
76  * @see av_malloc()
77  */
78 void *av_mallocz(unsigned int size);
79
80 /**
81  * Duplicate the string \p s.
82  * @param s String to be duplicated.
83  * @return Pointer to a newly allocated string containing a
84  * copy of \p s or NULL if it cannot be allocated.
85  */
86 char *av_strdup(const char *s);
87
88 /**
89  * Free a memory block which has been allocated with av_malloc(z)() or
90  * av_realloc() and set to NULL the pointer to it.
91  * @param ptr Pointer to the pointer to the memory block which should
92  * be freed.
93  * @see av_free()
94  */
95 void av_freep(void *ptr);
96
97 #endif /* FFMPEG_MEM_H */