Do not throw compiler error if asm code needs alignment, but we do not know
[libav.git] / libavutil / mem.h
CommitLineData
792098c2
PI
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/**
bad5537e 22 * @file libavutil/mem.h
89c9ff50 23 * memory handling functions
792098c2
PI
24 */
25
98790382
SS
26#ifndef AVUTIL_MEM_H
27#define AVUTIL_MEM_H
792098c2 28
52476c1b
CEH
29#include "common.h"
30
52476c1b 31#if AV_GCC_VERSION_AT_LEAST(3,1)
85074d3c
ZM
32 #define av_malloc_attrib __attribute__((__malloc__))
33#else
34 #define av_malloc_attrib
35#endif
36
06be9d9d 37#if (!defined(__ICC) || __ICC > 1110) && AV_GCC_VERSION_AT_LEAST(4,3)
cca6d953
ZM
38 #define av_alloc_size(n) __attribute__((alloc_size(n)))
39#else
40 #define av_alloc_size(n)
41#endif
42
792098c2 43/**
bf7e799c 44 * Allocates a block of size bytes with alignment suitable for all
0ee97f0d
SS
45 * memory accesses (including vectors if available on the CPU).
46 * @param size Size in bytes for the memory block to be allocated.
89c9ff50
DB
47 * @return Pointer to the allocated block, NULL if the block cannot
48 * be allocated.
0ee97f0d 49 * @see av_mallocz()
792098c2 50 */
cca6d953 51void *av_malloc(unsigned int size) av_malloc_attrib av_alloc_size(1);
792098c2
PI
52
53/**
89c9ff50 54 * Allocates or reallocates a block of memory.
bf7e799c
SS
55 * If ptr is NULL and size > 0, allocates a new block. If \p
56 * size is zero, frees the memory block pointed to by ptr.
0ee97f0d
SS
57 * @param size Size in bytes for the memory block to be allocated or
58 * reallocated.
59 * @param ptr Pointer to a memory block already allocated with
60 * av_malloc(z)() or av_realloc() or NULL.
89c9ff50
DB
61 * @return Pointer to a newly reallocated block or NULL if the block
62 * cannot be reallocated or the function is used to free the memory block.
0ee97f0d 63 * @see av_fast_realloc()
792098c2 64 */
cca6d953 65void *av_realloc(void *ptr, unsigned int size) av_alloc_size(2);
792098c2
PI
66
67/**
89c9ff50 68 * Frees a memory block which has been allocated with av_malloc(z)() or
0ee97f0d
SS
69 * av_realloc().
70 * @param ptr Pointer to the memory block which should be freed.
22baf42c
SS
71 * @note ptr = NULL is explicitly allowed.
72 * @note It is recommended that you use av_freep() instead.
0ee97f0d 73 * @see av_freep()
792098c2
PI
74 */
75void av_free(void *ptr);
76
0ee97f0d 77/**
bf7e799c 78 * Allocates a block of size bytes with alignment suitable for all
0ee97f0d 79 * memory accesses (including vectors if available on the CPU) and
89c9ff50 80 * zeroes all the bytes of the block.
0ee97f0d 81 * @param size Size in bytes for the memory block to be allocated.
89c9ff50 82 * @return Pointer to the allocated block, NULL if it cannot be allocated.
0ee97f0d
SS
83 * @see av_malloc()
84 */
cca6d953 85void *av_mallocz(unsigned int size) av_malloc_attrib av_alloc_size(1);
d3de3ee2
SS
86
87/**
bf7e799c 88 * Duplicates the string s.
89c9ff50 89 * @param s string to be duplicated
d3de3ee2 90 * @return Pointer to a newly allocated string containing a
bf7e799c 91 * copy of s or NULL if the string cannot be allocated.
d3de3ee2 92 */
85074d3c 93char *av_strdup(const char *s) av_malloc_attrib;
792098c2
PI
94
95/**
89c9ff50
DB
96 * Frees a memory block which has been allocated with av_malloc(z)() or
97 * av_realloc() and set the pointer pointing to it to NULL.
0ee97f0d
SS
98 * @param ptr Pointer to the pointer to the memory block which should
99 * be freed.
100 * @see av_free()
792098c2
PI
101 */
102void av_freep(void *ptr);
103
98790382 104#endif /* AVUTIL_MEM_H */