0d3e7f3ba0cba24a6405a023613702244c792fee
[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 mem.h
23 * Memory handling functions.
24 */
25
26 #ifndef AV_MEM_H
27 #define AV_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 * Memory allocation of size bytes with alignment suitable for all
37 * memory accesses (including vectors if available on the
38 * CPU). av_malloc(0) must return a non-NULL pointer.
39 */
40 void *av_malloc(unsigned int size);
41
42 /**
43 * av_realloc semantics (same as glibc): If ptr is NULL and size > 0,
44 * identical to malloc(size). If size is zero, it is identical to
45 * free(ptr) and NULL is returned.
46 */
47 void *av_realloc(void *ptr, unsigned int size);
48
49 /**
50 * Free memory which has been allocated with av_malloc(z)() or av_realloc().
51 * NOTE: ptr = NULL is explicitly allowed.
52 * Note2: It is recommended that you use av_freep() instead.
53 */
54 void av_free(void *ptr);
55
56 void *av_mallocz(unsigned int size);
57
58 /**
59 * Duplicate the string \p s.
60 * @param s String to be duplicated.
61 * @return Pointer to a newly allocated string containing a
62 * copy of \p s or NULL if it cannot be allocated.
63 */
64 char *av_strdup(const char *s);
65
66 /**
67 * Free memory and set the pointer to NULL.
68 * @param ptr pointer to the pointer which should be freed.
69 */
70 void av_freep(void *ptr);
71
72 #endif /* AV_MEM_H */