Statistics
| Branch: | Revision:

ffmpeg / libavutil / mem.h @ 7433ca29

History | View | Annotate | Download (3.47 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 __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
#else
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
#endif
39

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

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

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

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

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

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

    
102
#endif /* FFMPEG_MEM_H */