Mercurial > libavutil.hg
annotate mem.h @ 449:f150c3ca02d5 libavutil
Mark MSVC compiler macros as such.
author | diego |
---|---|
date | Wed, 13 Feb 2008 08:33:05 +0000 |
parents | 41603959875e |
children | dd654d025ed5 |
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 |
392 | 26 #ifndef FFMPEG_MEM_H |
27 #define FFMPEG_MEM_H | |
104
5111e87117b7
Align the input buffer in ffplay, introduce a public macro for aligned declarations
lu_zero
parents:
100
diff
changeset
|
28 |
448 | 29 #ifdef __ICC |
104
5111e87117b7
Align the input buffer in ffplay, introduce a public macro for aligned declarations
lu_zero
parents:
100
diff
changeset
|
30 #define DECLARE_ALIGNED(n,t,v) t v __attribute__ ((aligned (n))) |
447 | 31 #define DECLARE_ASM_CONST(n,t,v) const t __attribute__ ((aligned (n))) v |
448 | 32 #elif __GNUC__ |
33 #define DECLARE_ALIGNED(n,t,v) t v __attribute__ ((aligned (n))) | |
434
61beff437735
Add and use DECLARE_ASM_CONST for constants used in assembler code.
reimar
parents:
399
diff
changeset
|
34 #define DECLARE_ASM_CONST(n,t,v) static const t v attribute_used __attribute__ ((aligned (n))) |
449 | 35 #elif _MSVC |
104
5111e87117b7
Align the input buffer in ffplay, introduce a public macro for aligned declarations
lu_zero
parents:
100
diff
changeset
|
36 #define DECLARE_ALIGNED(n,t,v) __declspec(align(n)) t v |
434
61beff437735
Add and use DECLARE_ASM_CONST for constants used in assembler code.
reimar
parents:
399
diff
changeset
|
37 #define DECLARE_ASM_CONST(n,t,v) __declspec(align(n)) 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
|
38 #endif |
5111e87117b7
Align the input buffer in ffplay, introduce a public macro for aligned declarations
lu_zero
parents:
100
diff
changeset
|
39 |
278
ca3eb39d3aa2
Move unaltered av_malloc() comments to the header file.
takis
parents:
252
diff
changeset
|
40 /** |
399
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
41 * 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
|
42 * 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
|
43 * @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
|
44 * @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
|
45 * it. |
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
46 * @see av_mallocz() |
278
ca3eb39d3aa2
Move unaltered av_malloc() comments to the header file.
takis
parents:
252
diff
changeset
|
47 */ |
82
8fb151c4d4c7
Move av_malloc(), av_realloc(), and av_free() from libavcodec to libavutil
lucabe
parents:
80
diff
changeset
|
48 void *av_malloc(unsigned int size); |
279
4964532166e6
Move unaltered av_realloc() comments to the header file.
takis
parents:
278
diff
changeset
|
49 |
4964532166e6
Move unaltered av_realloc() comments to the header file.
takis
parents:
278
diff
changeset
|
50 /** |
399
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
51 * 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
|
52 * 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
|
53 * 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
|
54 * @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
|
55 * reallocated. |
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
56 * @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
|
57 * 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
|
58 * @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
|
59 * 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
|
60 * @see av_fast_realloc() |
279
4964532166e6
Move unaltered av_realloc() comments to the header file.
takis
parents:
278
diff
changeset
|
61 */ |
82
8fb151c4d4c7
Move av_malloc(), av_realloc(), and av_free() from libavcodec to libavutil
lucabe
parents:
80
diff
changeset
|
62 void *av_realloc(void *ptr, unsigned int size); |
280
8c22d0665daa
Move unaltered av_free() comments to the header file.
takis
parents:
279
diff
changeset
|
63 |
8c22d0665daa
Move unaltered av_free() comments to the header file.
takis
parents:
279
diff
changeset
|
64 /** |
399
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
65 * 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
|
66 * av_realloc(). |
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
67 * @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
|
68 * @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
|
69 * @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
|
70 * @see av_freep() |
280
8c22d0665daa
Move unaltered av_free() comments to the header file.
takis
parents:
279
diff
changeset
|
71 */ |
82
8fb151c4d4c7
Move av_malloc(), av_realloc(), and av_free() from libavcodec to libavutil
lucabe
parents:
80
diff
changeset
|
72 void av_free(void *ptr); |
8fb151c4d4c7
Move av_malloc(), av_realloc(), and av_free() from libavcodec to libavutil
lucabe
parents:
80
diff
changeset
|
73 |
399
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
74 /** |
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
75 * 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
|
76 * 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
|
77 * 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
|
78 * @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
|
79 * @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
|
80 * it. |
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
81 * @see av_malloc() |
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
82 */ |
113 | 83 void *av_mallocz(unsigned int size); |
382 | 84 |
85 /** | |
390 | 86 * Duplicate the string \p s. |
382 | 87 * @param s String to be duplicated. |
88 * @return Pointer to a newly allocated string containing a | |
390 | 89 * copy of \p s or NULL if it cannot be allocated. |
382 | 90 */ |
113 | 91 char *av_strdup(const char *s); |
281
411c8cbd578a
Move unaltered av_freep() comments to the header file.
takis
parents:
280
diff
changeset
|
92 |
411c8cbd578a
Move unaltered av_freep() comments to the header file.
takis
parents:
280
diff
changeset
|
93 /** |
399
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
94 * 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
|
95 * 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
|
96 * @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
|
97 * be freed. |
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
98 * @see av_free() |
281
411c8cbd578a
Move unaltered av_freep() comments to the header file.
takis
parents:
280
diff
changeset
|
99 */ |
113 | 100 void av_freep(void *ptr); |
101 | |
392 | 102 #endif /* FFMPEG_MEM_H */ |