Statistics
| Branch: | Revision:

ffmpeg / libavutil / mem.h @ 80a07f6e

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