Statistics
| Branch: | Revision:

ffmpeg / libavutil / mem.h @ 7ce3e4a8

History | View | Annotate | Download (3.41 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 __GNUC__
30
  #define DECLARE_ALIGNED(n,t,v)       t v __attribute__ ((aligned (n)))
31
#ifdef __ICC
32
  #define DECLARE_ASM_CONST(n,t,v)     const t __attribute__ ((aligned (n))) v
33
#else
34
  #define DECLARE_ASM_CONST(n,t,v)     static const t v attribute_used __attribute__ ((aligned (n)))
35
#endif
36
#else
37
  #define DECLARE_ALIGNED(n,t,v)      __declspec(align(n)) t v
38
  #define DECLARE_ASM_CONST(n,t,v)    __declspec(align(n)) static const t v
39
#endif
40

    
41
/**
42
 * Allocate a block of \p size bytes with alignment suitable for all
43
 * memory accesses (including vectors if available on the CPU).
44
 * @param size Size in bytes for the memory block to be allocated.
45
 * @return Pointer to the allocated block, NULL if it cannot allocate
46
 * it.
47
 * @see av_mallocz()
48
 */
49
void *av_malloc(unsigned int size);
50

    
51
/**
52
 * Allocate or reallocate a block of memory.
53
 * If \p ptr is NULL and \p size > 0, allocate a new block. If \p
54
 * size is zero, free the memory block pointed by \p ptr.
55
 * @param size Size in bytes for the memory block to be allocated or
56
 * reallocated.
57
 * @param ptr Pointer to a memory block already allocated with
58
 * av_malloc(z)() or av_realloc() or NULL.
59
 * @return Pointer to a newly reallocated block or NULL if it cannot
60
 * reallocate or the function is used to free the memory block.
61
 * @see av_fast_realloc()
62
 */
63
void *av_realloc(void *ptr, unsigned int size);
64

    
65
/**
66
 * Free a memory block which has been allocated with av_malloc(z)() or
67
 * av_realloc().
68
 * @param ptr Pointer to the memory block which should be freed.
69
 * @note ptr = NULL is explicitly allowed.
70
 * @note It is recommended that you use av_freep() instead.
71
 * @see av_freep()
72
 */
73
void av_free(void *ptr);
74

    
75
/**
76
 * Allocate a block of \p size bytes with alignment suitable for all
77
 * memory accesses (including vectors if available on the CPU) and
78
 * set to zeroes all the bytes of the block.
79
 * @param size Size in bytes for the memory block to be allocated.
80
 * @return Pointer to the allocated block, NULL if it cannot allocate
81
 * it.
82
 * @see av_malloc()
83
 */
84
void *av_mallocz(unsigned int size);
85

    
86
/**
87
 * Duplicate the string \p s.
88
 * @param s String to be duplicated.
89
 * @return Pointer to a newly allocated string containing a
90
 * copy of \p s or NULL if it cannot be allocated.
91
 */
92
char *av_strdup(const char *s);
93

    
94
/**
95
 * Free a memory block which has been allocated with av_malloc(z)() or
96
 * av_realloc() and set to NULL the pointer to it.
97
 * @param ptr Pointer to the pointer to the memory block which should
98
 * be freed.
99
 * @see av_free()
100
 */
101
void av_freep(void *ptr);
102

    
103
#endif /* FFMPEG_MEM_H */