Mercurial > libavutil.hg
annotate mem.h @ 961:64a8e85b50be libavutil
Improve GET_UTF{8,16} documentation
author | mru |
---|---|
date | Wed, 30 Jun 2010 20:09:48 +0000 |
parents | e34e8d654ded |
children |
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 /** |
899
0795a743bda1
Remove explicit filename from Doxygen @file commands.
diego
parents:
873
diff
changeset
|
22 * @file |
633 | 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 | 26 #ifndef AVUTIL_MEM_H |
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 |
873
4d9ad0ed07d0
Replace many includes of libavutil/common.h with what is actually needed
mru
parents:
859
diff
changeset
|
29 #include "attributes.h" |
952 | 30 #include "avutil.h" |
590
e9d89a89561a
Use AV_GCC_VERSION_AT_LEAST() to simplify gcc version checks.
cehoyos
parents:
574
diff
changeset
|
31 |
944
90651a771549
icc 12 finally fixed attribute(used) so gcc's DECLARE_ASM_CONST can be used.
cehoyos
parents:
899
diff
changeset
|
32 #if defined(__ICC) && _ICC < 1200 || defined(__SUNPRO_C) |
819
1672d4566595
Make DECLARE_ALIGNED macros work with external array specifiers
mru
parents:
804
diff
changeset
|
33 #define DECLARE_ALIGNED(n,t,v) t __attribute__ ((aligned (n))) v |
746
3b90ae5577ad
Move DECLARE_ALIGNED and DECLARE_ASM_CONST back from lavu/internal.h to
ramiro
parents:
742
diff
changeset
|
34 #define DECLARE_ASM_CONST(n,t,v) const t __attribute__ ((aligned (n))) v |
822 | 35 #elif defined(__TI_COMPILER_VERSION__) |
36 #define DECLARE_ALIGNED(n,t,v) \ | |
37 AV_PRAGMA(DATA_ALIGN(v,n)) \ | |
38 t __attribute__((aligned(n))) v | |
39 #define DECLARE_ASM_CONST(n,t,v) \ | |
40 AV_PRAGMA(DATA_ALIGN(v,n)) \ | |
41 static const t __attribute__((aligned(n))) v | |
746
3b90ae5577ad
Move DECLARE_ALIGNED and DECLARE_ASM_CONST back from lavu/internal.h to
ramiro
parents:
742
diff
changeset
|
42 #elif defined(__GNUC__) |
819
1672d4566595
Make DECLARE_ALIGNED macros work with external array specifiers
mru
parents:
804
diff
changeset
|
43 #define DECLARE_ALIGNED(n,t,v) t __attribute__ ((aligned (n))) v |
1672d4566595
Make DECLARE_ALIGNED macros work with external array specifiers
mru
parents:
804
diff
changeset
|
44 #define DECLARE_ASM_CONST(n,t,v) static const t attribute_used __attribute__ ((aligned (n))) v |
746
3b90ae5577ad
Move DECLARE_ALIGNED and DECLARE_ASM_CONST back from lavu/internal.h to
ramiro
parents:
742
diff
changeset
|
45 #elif defined(_MSC_VER) |
3b90ae5577ad
Move DECLARE_ALIGNED and DECLARE_ASM_CONST back from lavu/internal.h to
ramiro
parents:
742
diff
changeset
|
46 #define DECLARE_ALIGNED(n,t,v) __declspec(align(n)) t v |
3b90ae5577ad
Move DECLARE_ALIGNED and DECLARE_ASM_CONST back from lavu/internal.h to
ramiro
parents:
742
diff
changeset
|
47 #define DECLARE_ASM_CONST(n,t,v) __declspec(align(n)) static const t v |
3b90ae5577ad
Move DECLARE_ALIGNED and DECLARE_ASM_CONST back from lavu/internal.h to
ramiro
parents:
742
diff
changeset
|
48 #else |
3b90ae5577ad
Move DECLARE_ALIGNED and DECLARE_ASM_CONST back from lavu/internal.h to
ramiro
parents:
742
diff
changeset
|
49 #define DECLARE_ALIGNED(n,t,v) t v |
3b90ae5577ad
Move DECLARE_ALIGNED and DECLARE_ASM_CONST back from lavu/internal.h to
ramiro
parents:
742
diff
changeset
|
50 #define DECLARE_ASM_CONST(n,t,v) static const t v |
3b90ae5577ad
Move DECLARE_ALIGNED and DECLARE_ASM_CONST back from lavu/internal.h to
ramiro
parents:
742
diff
changeset
|
51 #endif |
3b90ae5577ad
Move DECLARE_ALIGNED and DECLARE_ASM_CONST back from lavu/internal.h to
ramiro
parents:
742
diff
changeset
|
52 |
590
e9d89a89561a
Use AV_GCC_VERSION_AT_LEAST() to simplify gcc version checks.
cehoyos
parents:
574
diff
changeset
|
53 #if AV_GCC_VERSION_AT_LEAST(3,1) |
481
f4187c1c15a6
Reapply r12489: Add pure, const and malloc attributes to proper functions
zuxy
parents:
478
diff
changeset
|
54 #define av_malloc_attrib __attribute__((__malloc__)) |
f4187c1c15a6
Reapply r12489: Add pure, const and malloc attributes to proper functions
zuxy
parents:
478
diff
changeset
|
55 #else |
f4187c1c15a6
Reapply r12489: Add pure, const and malloc attributes to proper functions
zuxy
parents:
478
diff
changeset
|
56 #define av_malloc_attrib |
f4187c1c15a6
Reapply r12489: Add pure, const and malloc attributes to proper functions
zuxy
parents:
478
diff
changeset
|
57 #endif |
f4187c1c15a6
Reapply r12489: Add pure, const and malloc attributes to proper functions
zuxy
parents:
478
diff
changeset
|
58 |
742
1091b120412e
Icc 11.1 does not support attributes force_align_arg_pointer, alloc_size and cold.
cehoyos
parents:
738
diff
changeset
|
59 #if (!defined(__ICC) || __ICC > 1110) && AV_GCC_VERSION_AT_LEAST(4,3) |
482
0b8d0ec536a8
Apply "alloc_size" attribute to av_alloc, av_realloc and av_mallocz
zuxy
parents:
481
diff
changeset
|
60 #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
|
61 #else |
0b8d0ec536a8
Apply "alloc_size" attribute to av_alloc, av_realloc and av_mallocz
zuxy
parents:
481
diff
changeset
|
62 #define av_alloc_size(n) |
0b8d0ec536a8
Apply "alloc_size" attribute to av_alloc, av_realloc and av_mallocz
zuxy
parents:
481
diff
changeset
|
63 #endif |
0b8d0ec536a8
Apply "alloc_size" attribute to av_alloc, av_realloc and av_mallocz
zuxy
parents:
481
diff
changeset
|
64 |
278
ca3eb39d3aa2
Move unaltered av_malloc() comments to the header file.
takis
parents:
252
diff
changeset
|
65 /** |
957 | 66 * Allocate a block of size bytes with alignment suitable for all |
399
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
67 * 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
|
68 * @param size Size in bytes for the memory block to be allocated. |
633 | 69 * @return Pointer to the allocated block, NULL if the block cannot |
70 * be allocated. | |
399
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
71 * @see av_mallocz() |
278
ca3eb39d3aa2
Move unaltered av_malloc() comments to the header file.
takis
parents:
252
diff
changeset
|
72 */ |
482
0b8d0ec536a8
Apply "alloc_size" attribute to av_alloc, av_realloc and av_mallocz
zuxy
parents:
481
diff
changeset
|
73 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
|
74 |
4964532166e6
Move unaltered av_realloc() comments to the header file.
takis
parents:
278
diff
changeset
|
75 /** |
957 | 76 * Allocate or reallocate a block of memory. |
77 * If ptr is NULL and size > 0, allocate a new block. If | |
78 * size is zero, free the memory block pointed to by ptr. | |
399
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
79 * @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
|
80 * reallocated. |
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
81 * @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
|
82 * av_malloc(z)() or av_realloc() or NULL. |
633 | 83 * @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. | |
399
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
85 * @see av_fast_realloc() |
279
4964532166e6
Move unaltered av_realloc() comments to the header file.
takis
parents:
278
diff
changeset
|
86 */ |
482
0b8d0ec536a8
Apply "alloc_size" attribute to av_alloc, av_realloc and av_mallocz
zuxy
parents:
481
diff
changeset
|
87 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
|
88 |
8c22d0665daa
Move unaltered av_free() comments to the header file.
takis
parents:
279
diff
changeset
|
89 /** |
957 | 90 * Free a memory block which has been allocated with av_malloc(z)() or |
399
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
91 * av_realloc(). |
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
92 * @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
|
93 * @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
|
94 * @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
|
95 * @see av_freep() |
280
8c22d0665daa
Move unaltered av_free() comments to the header file.
takis
parents:
279
diff
changeset
|
96 */ |
82
8fb151c4d4c7
Move av_malloc(), av_realloc(), and av_free() from libavcodec to libavutil
lucabe
parents:
80
diff
changeset
|
97 void av_free(void *ptr); |
8fb151c4d4c7
Move av_malloc(), av_realloc(), and av_free() from libavcodec to libavutil
lucabe
parents:
80
diff
changeset
|
98 |
399
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
99 /** |
957 | 100 * Allocate a block of size bytes with alignment suitable for all |
399
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
101 * memory accesses (including vectors if available on the CPU) and |
957 | 102 * zero all the bytes of the block. |
399
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
103 * @param size Size in bytes for the memory block to be allocated. |
633 | 104 * @return Pointer to the allocated block, NULL if it cannot be allocated. |
399
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
105 * @see av_malloc() |
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
106 */ |
482
0b8d0ec536a8
Apply "alloc_size" attribute to av_alloc, av_realloc and av_mallocz
zuxy
parents:
481
diff
changeset
|
107 void *av_mallocz(unsigned int size) av_malloc_attrib av_alloc_size(1); |
382 | 108 |
109 /** | |
957 | 110 * Duplicate the string s. |
633 | 111 * @param s string to be duplicated |
382 | 112 * @return Pointer to a newly allocated string containing a |
738
4f98a323598c
Remove '\p', '\c' and '\e' doxygen markup from doxy, as it should
stefano
parents:
642
diff
changeset
|
113 * copy of s or NULL if the string cannot be allocated. |
382 | 114 */ |
481
f4187c1c15a6
Reapply r12489: Add pure, const and malloc attributes to proper functions
zuxy
parents:
478
diff
changeset
|
115 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
|
116 |
411c8cbd578a
Move unaltered av_freep() comments to the header file.
takis
parents:
280
diff
changeset
|
117 /** |
957 | 118 * Free a memory block which has been allocated with av_malloc(z)() or |
633 | 119 * av_realloc() and set the pointer pointing to it to NULL. |
399
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
120 * @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
|
121 * be freed. |
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
122 * @see av_free() |
281
411c8cbd578a
Move unaltered av_freep() comments to the header file.
takis
parents:
280
diff
changeset
|
123 */ |
113 | 124 void av_freep(void *ptr); |
125 | |
567 | 126 #endif /* AVUTIL_MEM_H */ |