mem.h 4.65 KB
Newer Older
1 2 3
/*
 * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
 *
4
 * This file is part of Libav.
5
 *
6
 * Libav is free software; you can redistribute it and/or
7 8 9 10
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
11
 * Libav is distributed in the hope that it will be useful,
12 13 14 15 16
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
17
 * License along with Libav; if not, write to the Free Software
18 19 20 21
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

/**
22
 * @file
23
 * memory handling functions
24 25
 */

26 27
#ifndef AVUTIL_MEM_H
#define AVUTIL_MEM_H
28

29
#include "attributes.h"
30
#include "avutil.h"
31

32
#if defined(__ICC) && _ICC < 1200 || defined(__SUNPRO_C)
33
    #define DECLARE_ALIGNED(n,t,v)      t __attribute__ ((aligned (n))) v
34
    #define DECLARE_ASM_CONST(n,t,v)    const t __attribute__ ((aligned (n))) v
35 36 37 38 39 40 41
#elif defined(__TI_COMPILER_VERSION__)
    #define DECLARE_ALIGNED(n,t,v)                      \
        AV_PRAGMA(DATA_ALIGN(v,n))                      \
        t __attribute__((aligned(n))) v
    #define DECLARE_ASM_CONST(n,t,v)                    \
        AV_PRAGMA(DATA_ALIGN(v,n))                      \
        static const t __attribute__((aligned(n))) v
42
#elif defined(__GNUC__)
43
    #define DECLARE_ALIGNED(n,t,v)      t __attribute__ ((aligned (n))) v
44
    #define DECLARE_ASM_CONST(n,t,v)    static const t av_used __attribute__ ((aligned (n))) v
45 46 47 48 49 50 51 52
#elif defined(_MSC_VER)
    #define DECLARE_ALIGNED(n,t,v)      __declspec(align(n)) t v
    #define DECLARE_ASM_CONST(n,t,v)    __declspec(align(n)) static const t v
#else
    #define DECLARE_ALIGNED(n,t,v)      t v
    #define DECLARE_ASM_CONST(n,t,v)    static const t v
#endif

53
#if AV_GCC_VERSION_AT_LEAST(3,1)
54 55 56 57 58
    #define av_malloc_attrib __attribute__((__malloc__))
#else
    #define av_malloc_attrib
#endif

59
#if AV_GCC_VERSION_AT_LEAST(4,3)
60 61 62 63 64
    #define av_alloc_size(n) __attribute__((alloc_size(n)))
#else
    #define av_alloc_size(n)
#endif

65 66
#if LIBAVUTIL_VERSION_MAJOR < 51
#   define FF_INTERNAL_MEM_TYPE unsigned int
67
#   define FF_INTERNAL_MEM_TYPE_MAX_VALUE UINT_MAX
68 69
#else
#   define FF_INTERNAL_MEM_TYPE size_t
70
#   define FF_INTERNAL_MEM_TYPE_MAX_VALUE SIZE_MAX
71 72
#endif

73
/**
74
 * Allocate a block of size bytes with alignment suitable for all
75 76
 * memory accesses (including vectors if available on the CPU).
 * @param size Size in bytes for the memory block to be allocated.
77 78
 * @return Pointer to the allocated block, NULL if the block cannot
 * be allocated.
79
 * @see av_mallocz()
80
 */
81
void *av_malloc(FF_INTERNAL_MEM_TYPE size) av_malloc_attrib av_alloc_size(1);
82 83

/**
84 85 86
 * Allocate or reallocate a block of memory.
 * If ptr is NULL and size > 0, allocate a new block. If
 * size is zero, free the memory block pointed to by ptr.
87 88 89 90
 * @param size Size in bytes for the memory block to be allocated or
 * reallocated.
 * @param ptr Pointer to a memory block already allocated with
 * av_malloc(z)() or av_realloc() or NULL.
91 92
 * @return Pointer to a newly reallocated block or NULL if the block
 * cannot be reallocated or the function is used to free the memory block.
93
 * @see av_fast_realloc()
94
 */
95
void *av_realloc(void *ptr, FF_INTERNAL_MEM_TYPE size) av_alloc_size(2);
96 97

/**
98
 * Free a memory block which has been allocated with av_malloc(z)() or
99 100
 * av_realloc().
 * @param ptr Pointer to the memory block which should be freed.
101 102
 * @note ptr = NULL is explicitly allowed.
 * @note It is recommended that you use av_freep() instead.
103
 * @see av_freep()
104 105 106
 */
void av_free(void *ptr);

107
/**
108
 * Allocate a block of size bytes with alignment suitable for all
109
 * memory accesses (including vectors if available on the CPU) and
110
 * zero all the bytes of the block.
111
 * @param size Size in bytes for the memory block to be allocated.
112
 * @return Pointer to the allocated block, NULL if it cannot be allocated.
113 114
 * @see av_malloc()
 */
115
void *av_mallocz(FF_INTERNAL_MEM_TYPE size) av_malloc_attrib av_alloc_size(1);
116 117

/**
118
 * Duplicate the string s.
119
 * @param s string to be duplicated
120
 * @return Pointer to a newly allocated string containing a
121
 * copy of s or NULL if the string cannot be allocated.
122
 */
123
char *av_strdup(const char *s) av_malloc_attrib;
124 125

/**
126
 * Free a memory block which has been allocated with av_malloc(z)() or
127
 * av_realloc() and set the pointer pointing to it to NULL.
128 129 130
 * @param ptr Pointer to the pointer to the memory block which should
 * be freed.
 * @see av_free()
131 132 133
 */
void av_freep(void *ptr);

134
#endif /* AVUTIL_MEM_H */