libopenjpeg/j2k_lib.h

   1 /*
   2  * Copyright (c) 2005, Herv� Drolon, FreeImage Team
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  18  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  19  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  20  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  21  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  22  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  23  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  24  * POSSIBILITY OF SUCH DAMAGE.
  25  */
  26 #ifndef __J2K_LIB_H
  27 #define __J2K_LIB_H
  28 /**
  29 @file j2k_lib.h
  30 @brief Internal functions
  31
  32 The functions in J2K_LIB.C are internal utilities mainly used for memory management.
  33 */
  34
  35 #ifndef __GCC__
  36 #define __attribute__(x) /* */
  37 #endif
  38
  39 /** @defgroup MISC MISC - Miscellaneous internal functions */
  40 /*@{*/
  41
  42 /** @name Exported functions */
  43 /*@{*/
  44 /* ----------------------------------------------------------------------- */
  45
  46 /**
  47 Difference in successive opj_clock() calls tells you the elapsed time
  48 @return Returns time in seconds
  49 */
  50 double opj_clock(void);
  51
  52 /**
  53 Allocate a memory block with elements initialized to 0
  54 @param size Bytes to allocate
  55 @return Returns a void pointer to the allocated space, or NULL if there is insufficient memory available
  56 */
  57 void* __attribute__ ((malloc)) opj_malloc( size_t size );
  58
  59 /**
  60 Allocate memory aligned to a 16 byte boundry
  61 @param size Bytes to allocate
  62 @return Returns a void pointer to the allocated space, or NULL if there is insufficient memory available
  63 */
  64 #include <xmmintrin.h>
  65 #define opj_aligned_malloc(size)        _mm_malloc(size, 16)
  66 #define opj_aligned_free(m) _mm_free(m)
  67
  68 /**
  69 Reallocate memory blocks.
  70 @param memblock Pointer to previously allocated memory block
  71 @param size New size in bytes
  72 @return Returns a void pointer to the reallocated (and possibly moved) memory block
  73 */
  74 void* __attribute__ ((malloc)) opj_realloc( void *memblock, size_t size );
  75
  76 /**
  77 Deallocates or frees a memory block.
  78 @param memblock Previously allocated memory block to be freed
  79 */
  80 void opj_free( void *memblock );
  81
  82 /* ----------------------------------------------------------------------- */
  83 /*@}*/
  84
  85 /*@}*/
  86
  87 #endif /* __J2K_LIB_H */
  88