Statistics
| Branch: | Revision:

ffmpeg / libavutil / mem.h @ 6544f48f

History | View | Annotate | Download (3.89 KB)

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 __ICC
30
    #define DECLARE_ALIGNED(n,t,v)      t v __attribute__ ((aligned (n)))
31
    #define DECLARE_ASM_CONST(n,t,v)    const t __attribute__ ((aligned (n))) v
32
#elif defined(__GNUC__)
33
    #define DECLARE_ALIGNED(n,t,v)      t v __attribute__ ((aligned (n)))
34
    #define DECLARE_ASM_CONST(n,t,v)    static const t v attribute_used __attribute__ ((aligned (n)))
35
#elif defined(_MSC_VER)
36
    #define DECLARE_ALIGNED(n,t,v)      __declspec(align(n)) t v
37
    #define DECLARE_ASM_CONST(n,t,v)    __declspec(align(n)) static const t v
38
#elif defined(HAVE_INLINE_ASM)
39
    #error The asm code needs alignment, but we do not know how to do it for this compiler.
40
#else
41
    #define DECLARE_ALIGNED(n,t,v)      t v
42
    #define DECLARE_ASM_CONST(n,t,v)    static const t v
43
#endif
44

    
45
#ifdef __GNUC__
46
    #define av_malloc_attrib __attribute__((__malloc__))
47
#else
48
    #define av_malloc_attrib
49
#endif
50

    
51
/**
52
 * Allocate a block of \p size bytes with alignment suitable for all
53
 * memory accesses (including vectors if available on the CPU).
54
 * @param size Size in bytes for the memory block to be allocated.
55
 * @return Pointer to the allocated block, NULL if it cannot allocate
56
 * it.
57
 * @see av_mallocz()
58
 */
59
void *av_malloc(unsigned int size) av_malloc_attrib;
60

    
61
/**
62
 * Allocate or reallocate a block of memory.
63
 * If \p ptr is NULL and \p size > 0, allocate a new block. If \p
64
 * size is zero, free the memory block pointed by \p ptr.
65
 * @param size Size in bytes for the memory block to be allocated or
66
 * reallocated.
67
 * @param ptr Pointer to a memory block already allocated with
68
 * av_malloc(z)() or av_realloc() or NULL.
69
 * @return Pointer to a newly reallocated block or NULL if it cannot
70
 * reallocate or the function is used to free the memory block.
71
 * @see av_fast_realloc()
72
 */
73
void *av_realloc(void *ptr, unsigned int size);
74

    
75
/**
76
 * Free a memory block which has been allocated with av_malloc(z)() or
77
 * av_realloc().
78
 * @param ptr Pointer to the memory block which should be freed.
79
 * @note ptr = NULL is explicitly allowed.
80
 * @note It is recommended that you use av_freep() instead.
81
 * @see av_freep()
82
 */
83
void av_free(void *ptr);
84

    
85
/**
86
 * Allocate a block of \p size bytes with alignment suitable for all
87
 * memory accesses (including vectors if available on the CPU) and
88
 * set to zeroes all the bytes of the block.
89
 * @param size Size in bytes for the memory block to be allocated.
90
 * @return Pointer to the allocated block, NULL if it cannot allocate
91
 * it.
92
 * @see av_malloc()
93
 */
94
void *av_mallocz(unsigned int size) av_malloc_attrib;
95

    
96
/**
97
 * Duplicate the string \p s.
98
 * @param s String to be duplicated.
99
 * @return Pointer to a newly allocated string containing a
100
 * copy of \p s or NULL if it cannot be allocated.
101
 */
102
char *av_strdup(const char *s) av_malloc_attrib;
103

    
104
/**
105
 * Free a memory block which has been allocated with av_malloc(z)() or
106
 * av_realloc() and set to NULL the pointer to it.
107
 * @param ptr Pointer to the pointer to the memory block which should
108
 * be freed.
109
 * @see av_free()
110
 */
111
void av_freep(void *ptr);
112

    
113
#endif /* FFMPEG_MEM_H */