mem.h 4.44 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/*
 * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
 *
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
 * 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.
 *
 * FFmpeg is distributed in the hope that it will be useful,
 * 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
 * License along with FFmpeg; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

/**
22
 * @file libavutil/mem.h
23
 * memory handling functions
24 25
 */

26 27
#ifndef AVUTIL_MEM_H
#define AVUTIL_MEM_H
28

29
#include "attributes.h"
30

31
#if defined(__ICC) || defined(__SUNPRO_C)
32
    #define DECLARE_ALIGNED(n,t,v)      t __attribute__ ((aligned (n))) v
33
    #define DECLARE_ASM_CONST(n,t,v)    const t __attribute__ ((aligned (n))) v
34 35 36 37 38 39 40
#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
41
#elif defined(__GNUC__)
42 43
    #define DECLARE_ALIGNED(n,t,v)      t __attribute__ ((aligned (n))) v
    #define DECLARE_ASM_CONST(n,t,v)    static const t attribute_used __attribute__ ((aligned (n))) v
44 45 46 47 48 49 50 51
#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

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

58
#if (!defined(__ICC) || __ICC > 1110) && AV_GCC_VERSION_AT_LEAST(4,3)
59 60 61 62 63
    #define av_alloc_size(n) __attribute__((alloc_size(n)))
#else
    #define av_alloc_size(n)
#endif

64
/**
65
 * Allocates a block of size bytes with alignment suitable for all
66 67
 * memory accesses (including vectors if available on the CPU).
 * @param size Size in bytes for the memory block to be allocated.
68 69
 * @return Pointer to the allocated block, NULL if the block cannot
 * be allocated.
70
 * @see av_mallocz()
71
 */
72
void *av_malloc(unsigned int size) av_malloc_attrib av_alloc_size(1);
73 74

/**
75
 * Allocates or reallocates a block of memory.
76
 * If ptr is NULL and size > 0, allocates a new block. If
77
 * size is zero, frees the memory block pointed to by ptr.
78 79 80 81
 * @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.
82 83
 * @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.
84
 * @see av_fast_realloc()
85
 */
86
void *av_realloc(void *ptr, unsigned int size) av_alloc_size(2);
87 88

/**
89
 * Frees a memory block which has been allocated with av_malloc(z)() or
90 91
 * av_realloc().
 * @param ptr Pointer to the memory block which should be freed.
92 93
 * @note ptr = NULL is explicitly allowed.
 * @note It is recommended that you use av_freep() instead.
94
 * @see av_freep()
95 96 97
 */
void av_free(void *ptr);

98
/**
99
 * Allocates a block of size bytes with alignment suitable for all
100
 * memory accesses (including vectors if available on the CPU) and
101
 * zeroes all the bytes of the block.
102
 * @param size Size in bytes for the memory block to be allocated.
103
 * @return Pointer to the allocated block, NULL if it cannot be allocated.
104 105
 * @see av_malloc()
 */
106
void *av_mallocz(unsigned int size) av_malloc_attrib av_alloc_size(1);
107 108

/**
109
 * Duplicates the string s.
110
 * @param s string to be duplicated
111
 * @return Pointer to a newly allocated string containing a
112
 * copy of s or NULL if the string cannot be allocated.
113
 */
114
char *av_strdup(const char *s) av_malloc_attrib;
115 116

/**
117 118
 * Frees a memory block which has been allocated with av_malloc(z)() or
 * av_realloc() and set the pointer pointing to it to NULL.
119 120 121
 * @param ptr Pointer to the pointer to the memory block which should
 * be freed.
 * @see av_free()
122 123 124
 */
void av_freep(void *ptr);

125
#endif /* AVUTIL_MEM_H */