Statistics
| Branch: | Revision:

ffmpeg / libavutil / mem.h @ 766324fc

History | View | Annotate | Download (3.31 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
  #define DECLARE_ASM_CONST(n,t,v)     static const t v attribute_used __attribute__ ((aligned (n)))
32
#else
33
  #define DECLARE_ALIGNED(n,t,v)      __declspec(align(n)) t v
34
  #define DECLARE_ASM_CONST(n,t,v)    __declspec(align(n)) static const t v
35
#endif
36

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

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

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

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

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

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

    
99
#endif /* FFMPEG_MEM_H */