annotate mem.h @ 577:2fe796dc4c68 libavutil

Bump minor version after addition of FF_ARRAY_ELEMS macro.
author benoit
date Wed, 15 Oct 2008 08:06:12 +0000
parents 5e52a169969c
children e9d89a89561a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
108
11be8e0d1344 Add official LGPL license headers to the files that were missing them.
diego
parents: 104
diff changeset
1 /*
11be8e0d1344 Add official LGPL license headers to the files that were missing them.
diego
parents: 104
diff changeset
2 * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
11be8e0d1344 Add official LGPL license headers to the files that were missing them.
diego
parents: 104
diff changeset
3 *
116
d76a36742464 Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 113
diff changeset
4 * This file is part of FFmpeg.
d76a36742464 Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 113
diff changeset
5 *
d76a36742464 Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 113
diff changeset
6 * FFmpeg is free software; you can redistribute it and/or
108
11be8e0d1344 Add official LGPL license headers to the files that were missing them.
diego
parents: 104
diff changeset
7 * modify it under the terms of the GNU Lesser General Public
11be8e0d1344 Add official LGPL license headers to the files that were missing them.
diego
parents: 104
diff changeset
8 * License as published by the Free Software Foundation; either
116
d76a36742464 Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 113
diff changeset
9 * version 2.1 of the License, or (at your option) any later version.
108
11be8e0d1344 Add official LGPL license headers to the files that were missing them.
diego
parents: 104
diff changeset
10 *
116
d76a36742464 Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 113
diff changeset
11 * FFmpeg is distributed in the hope that it will be useful,
108
11be8e0d1344 Add official LGPL license headers to the files that were missing them.
diego
parents: 104
diff changeset
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11be8e0d1344 Add official LGPL license headers to the files that were missing them.
diego
parents: 104
diff changeset
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11be8e0d1344 Add official LGPL license headers to the files that were missing them.
diego
parents: 104
diff changeset
14 * Lesser General Public License for more details.
11be8e0d1344 Add official LGPL license headers to the files that were missing them.
diego
parents: 104
diff changeset
15 *
11be8e0d1344 Add official LGPL license headers to the files that were missing them.
diego
parents: 104
diff changeset
16 * You should have received a copy of the GNU Lesser General Public
116
d76a36742464 Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 113
diff changeset
17 * License along with FFmpeg; if not, write to the Free Software
108
11be8e0d1344 Add official LGPL license headers to the files that were missing them.
diego
parents: 104
diff changeset
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
11be8e0d1344 Add official LGPL license headers to the files that were missing them.
diego
parents: 104
diff changeset
19 */
11be8e0d1344 Add official LGPL license headers to the files that were missing them.
diego
parents: 104
diff changeset
20
0
ee8f44bb7c4d libavutil: Utility code from libavcodec moved to a separate library.
al
parents:
diff changeset
21 /**
286
c1d6b0378055 Move the memory related functions out of common.h into their own header file
takis
parents: 284
diff changeset
22 * @file mem.h
c1d6b0378055 Move the memory related functions out of common.h into their own header file
takis
parents: 284
diff changeset
23 * Memory handling functions.
0
ee8f44bb7c4d libavutil: Utility code from libavcodec moved to a separate library.
al
parents:
diff changeset
24 */
ee8f44bb7c4d libavutil: Utility code from libavcodec moved to a separate library.
al
parents:
diff changeset
25
567
bd4052d9050c Globally rename the header inclusion guard names.
stefano
parents: 515
diff changeset
26 #ifndef AVUTIL_MEM_H
bd4052d9050c Globally rename the header inclusion guard names.
stefano
parents: 515
diff changeset
27 #define AVUTIL_MEM_H
104
5111e87117b7 Align the input buffer in ffplay, introduce a public macro for aligned declarations
lu_zero
parents: 100
diff changeset
28
574
5e52a169969c Allow using DECLARE_ALIGNED with Sun cc.
cehoyos
parents: 567
diff changeset
29 #if defined(__ICC) || defined(__SUNPRO_C)
455
ed36fc829044 cosmetics: prettyprint
diego
parents: 454
diff changeset
30 #define DECLARE_ALIGNED(n,t,v) t v __attribute__ ((aligned (n)))
ed36fc829044 cosmetics: prettyprint
diego
parents: 454
diff changeset
31 #define DECLARE_ASM_CONST(n,t,v) const t __attribute__ ((aligned (n))) v
454
909853728b47 10l: Correctly use preprocessor conditionals.
diego
parents: 450
diff changeset
32 #elif defined(__GNUC__)
455
ed36fc829044 cosmetics: prettyprint
diego
parents: 454
diff changeset
33 #define DECLARE_ALIGNED(n,t,v) t v __attribute__ ((aligned (n)))
ed36fc829044 cosmetics: prettyprint
diego
parents: 454
diff changeset
34 #define DECLARE_ASM_CONST(n,t,v) static const t v attribute_used __attribute__ ((aligned (n)))
457
b612613c38ba Fix MSVC identification, patch by Eddie Pang.
michael
parents: 456
diff changeset
35 #elif defined(_MSC_VER)
455
ed36fc829044 cosmetics: prettyprint
diego
parents: 454
diff changeset
36 #define DECLARE_ALIGNED(n,t,v) __declspec(align(n)) t v
ed36fc829044 cosmetics: prettyprint
diego
parents: 454
diff changeset
37 #define DECLARE_ASM_CONST(n,t,v) __declspec(align(n)) static const t v
465
b0b971f533e4 #error in case we do not know how to provide alignment.
diego
parents: 457
diff changeset
38 #elif defined(HAVE_INLINE_ASM)
b0b971f533e4 #error in case we do not know how to provide alignment.
diego
parents: 457
diff changeset
39 #error The asm code needs alignment, but we do not know how to do it for this compiler.
450
dd654d025ed5 Add fallback for DECLARE_ALIGNED and DECLARE_ASM_CONST.
diego
parents: 449
diff changeset
40 #else
455
ed36fc829044 cosmetics: prettyprint
diego
parents: 454
diff changeset
41 #define DECLARE_ALIGNED(n,t,v) t v
ed36fc829044 cosmetics: prettyprint
diego
parents: 454
diff changeset
42 #define DECLARE_ASM_CONST(n,t,v) static const t v
104
5111e87117b7 Align the input buffer in ffplay, introduce a public macro for aligned declarations
lu_zero
parents: 100
diff changeset
43 #endif
5111e87117b7 Align the input buffer in ffplay, introduce a public macro for aligned declarations
lu_zero
parents: 100
diff changeset
44
514
913e95930efa Fix embarassing __GNU__ vs. __GNUC__ typo in preprocessor condition.
diego
parents: 484
diff changeset
45 #if defined(__GNUC__) && (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ > 0)
481
f4187c1c15a6 Reapply r12489: Add pure, const and malloc attributes to proper functions
zuxy
parents: 478
diff changeset
46 #define av_malloc_attrib __attribute__((__malloc__))
f4187c1c15a6 Reapply r12489: Add pure, const and malloc attributes to proper functions
zuxy
parents: 478
diff changeset
47 #else
f4187c1c15a6 Reapply r12489: Add pure, const and malloc attributes to proper functions
zuxy
parents: 478
diff changeset
48 #define av_malloc_attrib
f4187c1c15a6 Reapply r12489: Add pure, const and malloc attributes to proper functions
zuxy
parents: 478
diff changeset
49 #endif
f4187c1c15a6 Reapply r12489: Add pure, const and malloc attributes to proper functions
zuxy
parents: 478
diff changeset
50
515
e4454f7d9f4f alloc_size attribute is new to gcc 4.3; don't use it with lesser versions
mru
parents: 514
diff changeset
51 #if defined(__GNUC__) && (__GNUC__ > 4 || __GNUC__ == 4 && __GNUC_MINOR__ > 2)
482
0b8d0ec536a8 Apply "alloc_size" attribute to av_alloc, av_realloc and av_mallocz
zuxy
parents: 481
diff changeset
52 #define av_alloc_size(n) __attribute__((alloc_size(n)))
0b8d0ec536a8 Apply "alloc_size" attribute to av_alloc, av_realloc and av_mallocz
zuxy
parents: 481
diff changeset
53 #else
0b8d0ec536a8 Apply "alloc_size" attribute to av_alloc, av_realloc and av_mallocz
zuxy
parents: 481
diff changeset
54 #define av_alloc_size(n)
0b8d0ec536a8 Apply "alloc_size" attribute to av_alloc, av_realloc and av_mallocz
zuxy
parents: 481
diff changeset
55 #endif
0b8d0ec536a8 Apply "alloc_size" attribute to av_alloc, av_realloc and av_mallocz
zuxy
parents: 481
diff changeset
56
278
ca3eb39d3aa2 Move unaltered av_malloc() comments to the header file.
takis
parents: 252
diff changeset
57 /**
399
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
58 * Allocate a block of \p size bytes with alignment suitable for all
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
59 * memory accesses (including vectors if available on the CPU).
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
60 * @param size Size in bytes for the memory block to be allocated.
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
61 * @return Pointer to the allocated block, NULL if it cannot allocate
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
62 * it.
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
63 * @see av_mallocz()
278
ca3eb39d3aa2 Move unaltered av_malloc() comments to the header file.
takis
parents: 252
diff changeset
64 */
482
0b8d0ec536a8 Apply "alloc_size" attribute to av_alloc, av_realloc and av_mallocz
zuxy
parents: 481
diff changeset
65 void *av_malloc(unsigned int size) av_malloc_attrib av_alloc_size(1);
279
4964532166e6 Move unaltered av_realloc() comments to the header file.
takis
parents: 278
diff changeset
66
4964532166e6 Move unaltered av_realloc() comments to the header file.
takis
parents: 278
diff changeset
67 /**
399
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
68 * Allocate or reallocate a block of memory.
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
69 * If \p ptr is NULL and \p size > 0, allocate a new block. If \p
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
70 * size is zero, free the memory block pointed by \p ptr.
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
71 * @param size Size in bytes for the memory block to be allocated or
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
72 * reallocated.
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
73 * @param ptr Pointer to a memory block already allocated with
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
74 * av_malloc(z)() or av_realloc() or NULL.
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
75 * @return Pointer to a newly reallocated block or NULL if it cannot
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
76 * reallocate or the function is used to free the memory block.
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
77 * @see av_fast_realloc()
279
4964532166e6 Move unaltered av_realloc() comments to the header file.
takis
parents: 278
diff changeset
78 */
482
0b8d0ec536a8 Apply "alloc_size" attribute to av_alloc, av_realloc and av_mallocz
zuxy
parents: 481
diff changeset
79 void *av_realloc(void *ptr, unsigned int size) av_alloc_size(2);
280
8c22d0665daa Move unaltered av_free() comments to the header file.
takis
parents: 279
diff changeset
80
8c22d0665daa Move unaltered av_free() comments to the header file.
takis
parents: 279
diff changeset
81 /**
399
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
82 * Free a memory block which has been allocated with av_malloc(z)() or
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
83 * av_realloc().
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
84 * @param ptr Pointer to the memory block which should be freed.
398
d525bf15ea54 doxy/cosmetics fixes. Patch by Stefano Sabatini %stefano P sabatini-lala A posteP it %
gpoirier
parents: 392
diff changeset
85 * @note ptr = NULL is explicitly allowed.
d525bf15ea54 doxy/cosmetics fixes. Patch by Stefano Sabatini %stefano P sabatini-lala A posteP it %
gpoirier
parents: 392
diff changeset
86 * @note It is recommended that you use av_freep() instead.
399
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
87 * @see av_freep()
280
8c22d0665daa Move unaltered av_free() comments to the header file.
takis
parents: 279
diff changeset
88 */
82
8fb151c4d4c7 Move av_malloc(), av_realloc(), and av_free() from libavcodec to libavutil
lucabe
parents: 80
diff changeset
89 void av_free(void *ptr);
8fb151c4d4c7 Move av_malloc(), av_realloc(), and av_free() from libavcodec to libavutil
lucabe
parents: 80
diff changeset
90
399
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
91 /**
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
92 * Allocate a block of \p size bytes with alignment suitable for all
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
93 * memory accesses (including vectors if available on the CPU) and
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
94 * set to zeroes all the bytes of the block.
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
95 * @param size Size in bytes for the memory block to be allocated.
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
96 * @return Pointer to the allocated block, NULL if it cannot allocate
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
97 * it.
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
98 * @see av_malloc()
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
99 */
482
0b8d0ec536a8 Apply "alloc_size" attribute to av_alloc, av_realloc and av_mallocz
zuxy
parents: 481
diff changeset
100 void *av_mallocz(unsigned int size) av_malloc_attrib av_alloc_size(1);
382
6224c028828a Document libavutil/mem.h:av_strdup.
diego
parents: 286
diff changeset
101
6224c028828a Document libavutil/mem.h:av_strdup.
diego
parents: 286
diff changeset
102 /**
390
0fc1d6548be4 misc Doxygen spelling/grammar fixes
diego
parents: 382
diff changeset
103 * Duplicate the string \p s.
382
6224c028828a Document libavutil/mem.h:av_strdup.
diego
parents: 286
diff changeset
104 * @param s String to be duplicated.
6224c028828a Document libavutil/mem.h:av_strdup.
diego
parents: 286
diff changeset
105 * @return Pointer to a newly allocated string containing a
390
0fc1d6548be4 misc Doxygen spelling/grammar fixes
diego
parents: 382
diff changeset
106 * copy of \p s or NULL if it cannot be allocated.
382
6224c028828a Document libavutil/mem.h:av_strdup.
diego
parents: 286
diff changeset
107 */
481
f4187c1c15a6 Reapply r12489: Add pure, const and malloc attributes to proper functions
zuxy
parents: 478
diff changeset
108 char *av_strdup(const char *s) av_malloc_attrib;
281
411c8cbd578a Move unaltered av_freep() comments to the header file.
takis
parents: 280
diff changeset
109
411c8cbd578a Move unaltered av_freep() comments to the header file.
takis
parents: 280
diff changeset
110 /**
399
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
111 * Free a memory block which has been allocated with av_malloc(z)() or
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
112 * av_realloc() and set to NULL the pointer to it.
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
113 * @param ptr Pointer to the pointer to the memory block which should
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
114 * be freed.
ae3fbcfbad4c Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents: 398
diff changeset
115 * @see av_free()
281
411c8cbd578a Move unaltered av_freep() comments to the header file.
takis
parents: 280
diff changeset
116 */
113
8fc54918226e move memory functions from avcodec to avutil
lu_zero
parents: 112
diff changeset
117 void av_freep(void *ptr);
8fc54918226e move memory functions from avcodec to avutil
lu_zero
parents: 112
diff changeset
118
567
bd4052d9050c Globally rename the header inclusion guard names.
stefano
parents: 515
diff changeset
119 #endif /* AVUTIL_MEM_H */