Statistics
| Branch: | Revision:

ffmpeg / libavutil / mem.h @ 16c2e214

History | View | Annotate | Download (4.08 KB)

1 792098c2 Panagiotis Issaris
/*
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 bad5537e Diego Biurrun
 * @file libavutil/mem.h
23 89c9ff50 Diego Biurrun
 * memory handling functions
24 792098c2 Panagiotis Issaris
 */
25
26 98790382 Stefano Sabatini
#ifndef AVUTIL_MEM_H
27
#define AVUTIL_MEM_H
28 792098c2 Panagiotis Issaris
29 52476c1b Carl Eugen Hoyos
#include "common.h"
30
31 16c2e214 Ramiro Polla
#if defined(__ICC) || defined(__SUNPRO_C)
32
    #define DECLARE_ALIGNED(n,t,v)      t v __attribute__ ((aligned (n)))
33
    #define DECLARE_ASM_CONST(n,t,v)    const t __attribute__ ((aligned (n))) v
34
#elif defined(__GNUC__)
35
    #define DECLARE_ALIGNED(n,t,v)      t v __attribute__ ((aligned (n)))
36
    #define DECLARE_ASM_CONST(n,t,v)    static const t v attribute_used __attribute__ ((aligned (n)))
37
#elif defined(_MSC_VER)
38
    #define DECLARE_ALIGNED(n,t,v)      __declspec(align(n)) t v
39
    #define DECLARE_ASM_CONST(n,t,v)    __declspec(align(n)) static const t v
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
46 52476c1b Carl Eugen Hoyos
#if AV_GCC_VERSION_AT_LEAST(3,1)
47 85074d3c Zuxy Meng
    #define av_malloc_attrib __attribute__((__malloc__))
48
#else
49
    #define av_malloc_attrib
50
#endif
51
52 06be9d9d Carl Eugen Hoyos
#if (!defined(__ICC) || __ICC > 1110) && AV_GCC_VERSION_AT_LEAST(4,3)
53 cca6d953 Zuxy Meng
    #define av_alloc_size(n) __attribute__((alloc_size(n)))
54
#else
55
    #define av_alloc_size(n)
56
#endif
57
58 792098c2 Panagiotis Issaris
/**
59 bf7e799c Stefano Sabatini
 * Allocates a block of size bytes with alignment suitable for all
60 0ee97f0d Stefano Sabatini
 * memory accesses (including vectors if available on the CPU).
61
 * @param size Size in bytes for the memory block to be allocated.
62 89c9ff50 Diego Biurrun
 * @return Pointer to the allocated block, NULL if the block cannot
63
 * be allocated.
64 0ee97f0d Stefano Sabatini
 * @see av_mallocz()
65 792098c2 Panagiotis Issaris
 */
66 cca6d953 Zuxy Meng
void *av_malloc(unsigned int size) av_malloc_attrib av_alloc_size(1);
67 792098c2 Panagiotis Issaris
68
/**
69 89c9ff50 Diego Biurrun
 * Allocates or reallocates a block of memory.
70 bf7e799c Stefano Sabatini
 * If ptr is NULL and size > 0, allocates a new block. If \p
71
 * size is zero, frees the memory block pointed to by ptr.
72 0ee97f0d Stefano Sabatini
 * @param size Size in bytes for the memory block to be allocated or
73
 * reallocated.
74
 * @param ptr Pointer to a memory block already allocated with
75
 * av_malloc(z)() or av_realloc() or NULL.
76 89c9ff50 Diego Biurrun
 * @return Pointer to a newly reallocated block or NULL if the block
77
 * cannot be reallocated or the function is used to free the memory block.
78 0ee97f0d Stefano Sabatini
 * @see av_fast_realloc()
79 792098c2 Panagiotis Issaris
 */
80 cca6d953 Zuxy Meng
void *av_realloc(void *ptr, unsigned int size) av_alloc_size(2);
81 792098c2 Panagiotis Issaris
82
/**
83 89c9ff50 Diego Biurrun
 * Frees a memory block which has been allocated with av_malloc(z)() or
84 0ee97f0d Stefano Sabatini
 * av_realloc().
85
 * @param ptr Pointer to the memory block which should be freed.
86 22baf42c Stefano Sabatini
 * @note ptr = NULL is explicitly allowed.
87
 * @note It is recommended that you use av_freep() instead.
88 0ee97f0d Stefano Sabatini
 * @see av_freep()
89 792098c2 Panagiotis Issaris
 */
90
void av_free(void *ptr);
91
92 0ee97f0d Stefano Sabatini
/**
93 bf7e799c Stefano Sabatini
 * Allocates a block of size bytes with alignment suitable for all
94 0ee97f0d Stefano Sabatini
 * memory accesses (including vectors if available on the CPU) and
95 89c9ff50 Diego Biurrun
 * zeroes all the bytes of the block.
96 0ee97f0d Stefano Sabatini
 * @param size Size in bytes for the memory block to be allocated.
97 89c9ff50 Diego Biurrun
 * @return Pointer to the allocated block, NULL if it cannot be allocated.
98 0ee97f0d Stefano Sabatini
 * @see av_malloc()
99
 */
100 cca6d953 Zuxy Meng
void *av_mallocz(unsigned int size) av_malloc_attrib av_alloc_size(1);
101 d3de3ee2 Stefano Sabatini
102
/**
103 bf7e799c Stefano Sabatini
 * Duplicates the string s.
104 89c9ff50 Diego Biurrun
 * @param s string to be duplicated
105 d3de3ee2 Stefano Sabatini
 * @return Pointer to a newly allocated string containing a
106 bf7e799c Stefano Sabatini
 * copy of s or NULL if the string cannot be allocated.
107 d3de3ee2 Stefano Sabatini
 */
108 85074d3c Zuxy Meng
char *av_strdup(const char *s) av_malloc_attrib;
109 792098c2 Panagiotis Issaris
110
/**
111 89c9ff50 Diego Biurrun
 * Frees a memory block which has been allocated with av_malloc(z)() or
112
 * av_realloc() and set the pointer pointing to it to NULL.
113 0ee97f0d Stefano Sabatini
 * @param ptr Pointer to the pointer to the memory block which should
114
 * be freed.
115
 * @see av_free()
116 792098c2 Panagiotis Issaris
 */
117
void av_freep(void *ptr);
118
119 98790382 Stefano Sabatini
#endif /* AVUTIL_MEM_H */