Mercurial > libavutil.hg
annotate mem.h @ 639:19d5f5c17725 libavutil
cosmetics: Move all #includes together at the beginning of the file.
author | diego |
---|---|
date | Fri, 30 Jan 2009 18:46:39 +0000 |
parents | 8c48a1b999a3 |
children | 70bdd5501662 |
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 |
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 |
590
e9d89a89561a
Use AV_GCC_VERSION_AT_LEAST() to simplify gcc version checks.
cehoyos
parents:
574
diff
changeset
|
29 #include "common.h" |
e9d89a89561a
Use AV_GCC_VERSION_AT_LEAST() to simplify gcc version checks.
cehoyos
parents:
574
diff
changeset
|
30 |
e9d89a89561a
Use AV_GCC_VERSION_AT_LEAST() to simplify gcc version checks.
cehoyos
parents:
574
diff
changeset
|
31 #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
|
32 #define av_malloc_attrib __attribute__((__malloc__)) |
f4187c1c15a6
Reapply r12489: Add pure, const and malloc attributes to proper functions
zuxy
parents:
478
diff
changeset
|
33 #else |
f4187c1c15a6
Reapply r12489: Add pure, const and malloc attributes to proper functions
zuxy
parents:
478
diff
changeset
|
34 #define av_malloc_attrib |
f4187c1c15a6
Reapply r12489: Add pure, const and malloc attributes to proper functions
zuxy
parents:
478
diff
changeset
|
35 #endif |
f4187c1c15a6
Reapply r12489: Add pure, const and malloc attributes to proper functions
zuxy
parents:
478
diff
changeset
|
36 |
591 | 37 #if (!defined(__ICC) || __ICC > 1100) && 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
|
38 #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
|
39 #else |
0b8d0ec536a8
Apply "alloc_size" attribute to av_alloc, av_realloc and av_mallocz
zuxy
parents:
481
diff
changeset
|
40 #define av_alloc_size(n) |
0b8d0ec536a8
Apply "alloc_size" attribute to av_alloc, av_realloc and av_mallocz
zuxy
parents:
481
diff
changeset
|
41 #endif |
0b8d0ec536a8
Apply "alloc_size" attribute to av_alloc, av_realloc and av_mallocz
zuxy
parents:
481
diff
changeset
|
42 |
278
ca3eb39d3aa2
Move unaltered av_malloc() comments to the header file.
takis
parents:
252
diff
changeset
|
43 /** |
633 | 44 * Allocates a block of \p 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
|
45 * 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
|
46 * @param size Size in bytes for the memory block to be allocated. |
633 | 47 * @return Pointer to the allocated block, NULL if the block cannot |
48 * be allocated. | |
399
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
49 * @see av_mallocz() |
278
ca3eb39d3aa2
Move unaltered av_malloc() comments to the header file.
takis
parents:
252
diff
changeset
|
50 */ |
482
0b8d0ec536a8
Apply "alloc_size" attribute to av_alloc, av_realloc and av_mallocz
zuxy
parents:
481
diff
changeset
|
51 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
|
52 |
4964532166e6
Move unaltered av_realloc() comments to the header file.
takis
parents:
278
diff
changeset
|
53 /** |
633 | 54 * Allocates or reallocates a block of memory. |
55 * If \p ptr is NULL and \p size > 0, allocates a new block. If \p | |
56 * size is zero, frees the memory block pointed to by \p ptr. | |
399
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
57 * @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
|
58 * reallocated. |
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
59 * @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
|
60 * av_malloc(z)() or av_realloc() or NULL. |
633 | 61 * @return Pointer to a newly reallocated block or NULL if the block |
62 * 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
|
63 * @see av_fast_realloc() |
279
4964532166e6
Move unaltered av_realloc() comments to the header file.
takis
parents:
278
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_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
|
66 |
8c22d0665daa
Move unaltered av_free() comments to the header file.
takis
parents:
279
diff
changeset
|
67 /** |
633 | 68 * Frees 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
|
69 * av_realloc(). |
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
70 * @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
|
71 * @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
|
72 * @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
|
73 * @see av_freep() |
280
8c22d0665daa
Move unaltered av_free() comments to the header file.
takis
parents:
279
diff
changeset
|
74 */ |
82
8fb151c4d4c7
Move av_malloc(), av_realloc(), and av_free() from libavcodec to libavutil
lucabe
parents:
80
diff
changeset
|
75 void av_free(void *ptr); |
8fb151c4d4c7
Move av_malloc(), av_realloc(), and av_free() from libavcodec to libavutil
lucabe
parents:
80
diff
changeset
|
76 |
399
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
77 /** |
633 | 78 * Allocates a block of \p 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
|
79 * memory accesses (including vectors if available on the CPU) and |
633 | 80 * zeroes 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
|
81 * @param size Size in bytes for the memory block to be allocated. |
633 | 82 * @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
|
83 * @see av_malloc() |
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
84 */ |
482
0b8d0ec536a8
Apply "alloc_size" attribute to av_alloc, av_realloc and av_mallocz
zuxy
parents:
481
diff
changeset
|
85 void *av_mallocz(unsigned int size) av_malloc_attrib av_alloc_size(1); |
382 | 86 |
87 /** | |
633 | 88 * Duplicates the string \p s. |
89 * @param s string to be duplicated | |
382 | 90 * @return Pointer to a newly allocated string containing a |
633 | 91 * copy of \p s or NULL if the string cannot be allocated. |
382 | 92 */ |
481
f4187c1c15a6
Reapply r12489: Add pure, const and malloc attributes to proper functions
zuxy
parents:
478
diff
changeset
|
93 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
|
94 |
411c8cbd578a
Move unaltered av_freep() comments to the header file.
takis
parents:
280
diff
changeset
|
95 /** |
633 | 96 * Frees a memory block which has been allocated with av_malloc(z)() or |
97 * 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
|
98 * @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
|
99 * be freed. |
ae3fbcfbad4c
Doxyfication, patch by Stefano Sabatini %stefano P sabatini-lala A poste P it%
gpoirier
parents:
398
diff
changeset
|
100 * @see av_free() |
281
411c8cbd578a
Move unaltered av_freep() comments to the header file.
takis
parents:
280
diff
changeset
|
101 */ |
113 | 102 void av_freep(void *ptr); |
103 | |
567 | 104 #endif /* AVUTIL_MEM_H */ |