libavutil/mem.h

   1 /*
   2  * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
   3  *
   4  * This file is part of FFmpeg.
   5  *
   6  * FFmpeg 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  * FFmpeg 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 FFmpeg; 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 mem.h
  23  * Memory handling functions.
  24  */
  25
  26 #ifndef FFMPEG_MEM_H
  27 #define FFMPEG_MEM_H
  28
  29 #ifdef __ICC
  30   #define DECLARE_ALIGNED(n,t,v)       t v __attribute__ ((aligned (n)))
  31   #define DECLARE_ASM_CONST(n,t,v)     const t __attribute__ ((aligned (n))) v
  32 #elif defined(__GNUC__)
  33   #define DECLARE_ALIGNED(n,t,v)       t v __attribute__ ((aligned (n)))
  34   #define DECLARE_ASM_CONST(n,t,v)     static const t v attribute_used __attribute__ ((aligned (n)))
  35 #elif defined(_MSVC)
  36   #define DECLARE_ALIGNED(n,t,v)      __declspec(align(n)) t v
  37   #define DECLARE_ASM_CONST(n,t,v)    __declspec(align(n)) static const t v
  38 #else
  39   #warning No align and asm directives, this might fail.
  40   #define DECLARE_ALIGNED(n,t,v)      t v
  41   #define DECLARE_ASM_CONST(n,t,v)    static const t v
  42 #endif
  43
  44 /**
  45  * Allocate a block of \p size bytes with alignment suitable for all
  46  * memory accesses (including vectors if available on the CPU).
  47  * @param size Size in bytes for the memory block to be allocated.
  48  * @return Pointer to the allocated block, NULL if it cannot allocate
  49  * it.
  50  * @see av_mallocz()
  51  */
  52 void *av_malloc(unsigned int size);
  53
  54 /**
  55  * Allocate or reallocate a block of memory.
  56  * If \p ptr is NULL and \p size > 0, allocate a new block. If \p
  57  * size is zero, free the memory block pointed by \p ptr.
  58  * @param size Size in bytes for the memory block to be allocated or
  59  * reallocated.
  60  * @param ptr Pointer to a memory block already allocated with
  61  * av_malloc(z)() or av_realloc() or NULL.
  62  * @return Pointer to a newly reallocated block or NULL if it cannot
  63  * reallocate or the function is used to free the memory block.
  64  * @see av_fast_realloc()
  65  */
  66 void *av_realloc(void *ptr, unsigned int size);
  67
  68 /**
  69  * Free a memory block which has been allocated with av_malloc(z)() or
  70  * av_realloc().
  71  * @param ptr Pointer to the memory block which should be freed.
  72  * @note ptr = NULL is explicitly allowed.
  73  * @note It is recommended that you use av_freep() instead.
  74  * @see av_freep()
  75  */
  76 void av_free(void *ptr);
  77
  78 /**
  79  * Allocate a block of \p size bytes with alignment suitable for all
  80  * memory accesses (including vectors if available on the CPU) and
  81  * set to zeroes all the bytes of the block.
  82  * @param size Size in bytes for the memory block to be allocated.
  83  * @return Pointer to the allocated block, NULL if it cannot allocate
  84  * it.
  85  * @see av_malloc()
  86  */
  87 void *av_mallocz(unsigned int size);
  88
  89 /**
  90  * Duplicate the string \p s.
  91  * @param s String to be duplicated.
  92  * @return Pointer to a newly allocated string containing a
  93  * copy of \p s or NULL if it cannot be allocated.
  94  */
  95 char *av_strdup(const char *s);
  96
  97 /**
  98  * Free a memory block which has been allocated with av_malloc(z)() or
  99  * av_realloc() and set to NULL the pointer to it.
 100  * @param ptr Pointer to the pointer to the memory block which should
 101  * be freed.
 102  * @see av_free()
 103  */
 104 void av_freep(void *ptr);
 105
 106 #endif /* FFMPEG_MEM_H */