git.sesse.net Git - ffmpeg/blob - libavutil/mem.h

   1 /*
   2  * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
   3  *
   4  * This file is part of Libav.
   5  *
   6  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 /**
  22  * @file
  23  * memory handling functions
  24  */
  25
  26 #ifndef AVUTIL_MEM_H
  27 #define AVUTIL_MEM_H
  28
  29 #include <limits.h>
  30 #include <stdint.h>
  31
  32 #include "attributes.h"
  33 #include "avutil.h"
  34
  35 /**
  36  * @addtogroup lavu_mem
  37  * @{
  38  */
  39
  40
  41 #if defined(__ICC) && __ICC < 1200 || defined(__SUNPRO_C)
  42     #define DECLARE_ALIGNED(n,t,v)      t __attribute__ ((aligned (n))) v
  43     #define DECLARE_ASM_CONST(n,t,v)    const t __attribute__ ((aligned (n))) v
  44 #elif defined(__TI_COMPILER_VERSION__)
  45     #define DECLARE_ALIGNED(n,t,v)                      \
  46         AV_PRAGMA(DATA_ALIGN(v,n))                      \
  47         t __attribute__((aligned(n))) v
  48     #define DECLARE_ASM_CONST(n,t,v)                    \
  49         AV_PRAGMA(DATA_ALIGN(v,n))                      \
  50         static const t __attribute__((aligned(n))) v
  51 #elif defined(__GNUC__)
  52     #define DECLARE_ALIGNED(n,t,v)      t __attribute__ ((aligned (n))) v
  53     #define DECLARE_ASM_CONST(n,t,v)    static const t av_used __attribute__ ((aligned (n))) v
  54 #elif defined(_MSC_VER)
  55     #define DECLARE_ALIGNED(n,t,v)      __declspec(align(n)) t v
  56     #define DECLARE_ASM_CONST(n,t,v)    __declspec(align(n)) static const t v
  57 #else
  58     #define DECLARE_ALIGNED(n,t,v)      t v
  59     #define DECLARE_ASM_CONST(n,t,v)    static const t v
  60 #endif
  61
  62 #if AV_GCC_VERSION_AT_LEAST(3,1)
  63     #define av_malloc_attrib __attribute__((__malloc__))
  64 #else
  65     #define av_malloc_attrib
  66 #endif
  67
  68 #if AV_GCC_VERSION_AT_LEAST(4,3)
  69     #define av_alloc_size(...) __attribute__((alloc_size(__VA_ARGS__)))
  70 #else
  71     #define av_alloc_size(...)
  72 #endif
  73
  74 /**
  75  * Allocate a block of size bytes with alignment suitable for all
  76  * memory accesses (including vectors if available on the CPU).
  77  * @param size Size in bytes for the memory block to be allocated.
  78  * @return Pointer to the allocated block, NULL if the block cannot
  79  * be allocated.
  80  * @see av_mallocz()
  81  */
  82 void *av_malloc(size_t size) av_malloc_attrib av_alloc_size(1);
  83
  84 /**
  85  * Helper function to allocate a block of size * nmemb bytes with
  86  * using av_malloc()
  87  * @param nmemb Number of elements
  88  * @param size Size of the single element
  89  * @return Pointer to the allocated block, NULL if the block cannot
  90  * be allocated.
  91  * @see av_malloc()
  92  */
  93 av_alloc_size(1, 2) static inline void *av_malloc_array(size_t nmemb, size_t size)
  94 {
  95     if (size <= 0 || nmemb >= INT_MAX / size)
  96         return NULL;
  97     return av_malloc(nmemb * size);
  98 }
  99
 100 /**
 101  * Allocate or reallocate a block of memory.
 102  * If ptr is NULL and size > 0, allocate a new block. If
 103  * size is zero, free the memory block pointed to by ptr.
 104  * @param ptr Pointer to a memory block already allocated with
 105  * av_malloc(z)() or av_realloc() or NULL.
 106  * @param size Size in bytes for the memory block to be allocated or
 107  * reallocated.
 108  * @return Pointer to a newly reallocated block or NULL if the block
 109  * cannot be reallocated or the function is used to free the memory block.
 110  * @see av_fast_realloc()
 111  */
 112 void *av_realloc(void *ptr, size_t size) av_alloc_size(2);
 113
 114 /**
 115  * Allocate or reallocate an array.
 116  * If ptr is NULL and nmemb > 0, allocate a new block. If
 117  * nmemb is zero, free the memory block pointed to by ptr.
 118  * @param ptr Pointer to a memory block already allocated with
 119  * av_malloc(z)() or av_realloc() or NULL.
 120  * @param nmemb Number of elements
 121  * @param size Size of the single element
 122  * @return Pointer to a newly reallocated block or NULL if the block
 123  * cannot be reallocated or the function is used to free the memory block.
 124  */
 125 av_alloc_size(2, 3) void *av_realloc_array(void *ptr, size_t nmemb, size_t size);
 126
 127 /**
 128  * Allocate or reallocate an array.
 129  * If *ptr is NULL and nmemb > 0, allocate a new block. If
 130  * nmemb is zero, free the memory block pointed to by ptr.
 131  * @param ptr Pointer to a pointer to a memory block already allocated
 132  * with av_malloc(z)() or av_realloc(), or pointer to a pointer to NULL.
 133  * The pointer is updated on success, or freed on failure.
 134  * @param nmemb Number of elements
 135  * @param size Size of the single element
 136  * @return Zero on success, an AVERROR error code on failure.
 137  */
 138 av_alloc_size(2, 3) int av_reallocp_array(void *ptr, size_t nmemb, size_t size);
 139
 140 /**
 141  * Free a memory block which has been allocated with av_malloc(z)() or
 142  * av_realloc().
 143  * @param ptr Pointer to the memory block which should be freed.
 144  * @note ptr = NULL is explicitly allowed.
 145  * @note It is recommended that you use av_freep() instead.
 146  * @see av_freep()
 147  */
 148 void av_free(void *ptr);
 149
 150 /**
 151  * Allocate a block of size bytes with alignment suitable for all
 152  * memory accesses (including vectors if available on the CPU) and
 153  * zero all the bytes of the block.
 154  * @param size Size in bytes for the memory block to be allocated.
 155  * @return Pointer to the allocated block, NULL if it cannot be allocated.
 156  * @see av_malloc()
 157  */
 158 void *av_mallocz(size_t size) av_malloc_attrib av_alloc_size(1);
 159
 160 /**
 161  * Helper function to allocate a block of size * nmemb bytes with
 162  * using av_mallocz()
 163  * @param nmemb Number of elements
 164  * @param size Size of the single element
 165  * @return Pointer to the allocated block, NULL if the block cannot
 166  * be allocated.
 167  * @see av_mallocz()
 168  * @see av_malloc_array()
 169  */
 170 av_alloc_size(1, 2) static inline void *av_mallocz_array(size_t nmemb, size_t size)
 171 {
 172     if (size <= 0 || nmemb >= INT_MAX / size)
 173         return NULL;
 174     return av_mallocz(nmemb * size);
 175 }
 176
 177 /**
 178  * Duplicate the string s.
 179  * @param s string to be duplicated
 180  * @return Pointer to a newly allocated string containing a
 181  * copy of s or NULL if the string cannot be allocated.
 182  */
 183 char *av_strdup(const char *s) av_malloc_attrib;
 184
 185 /**
 186  * Free a memory block which has been allocated with av_malloc(z)() or
 187  * av_realloc() and set the pointer pointing to it to NULL.
 188  * @param ptr Pointer to the pointer to the memory block which should
 189  * be freed.
 190  * @see av_free()
 191  */
 192 void av_freep(void *ptr);
 193
 194 /**
 195  * @brief deliberately overlapping memcpy implementation
 196  * @param dst destination buffer
 197  * @param back how many bytes back we start (the initial size of the overlapping window)
 198  * @param cnt number of bytes to copy, must be >= 0
 199  *
 200  * cnt > back is valid, this will copy the bytes we just copied,
 201  * thus creating a repeating pattern with a period length of back.
 202  */
 203 void av_memcpy_backptr(uint8_t *dst, int back, int cnt);
 204
 205 /**
 206  * @}
 207  */
 208
 209 #endif /* AVUTIL_MEM_H */