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
  27
  28 #ifndef __J2K_LIB_H
  29 #define __J2K_LIB_H
  30 /**
  31 @file j2k_lib.h
  32 @brief Internal functions
  33
  34 The functions in J2K_LIB.C are internal utilities mainly used for memory management.
  35 */
  36
  37 /** @defgroup MISC MISC - Miscellaneous internal functions */
  38 /*@{*/
  39
  40 /** @name Exported functions */
  41 /*@{*/
  42 /* ----------------------------------------------------------------------- */
  43
  44 /**
  45 Difference in successive opj_clock() calls tells you the elapsed time
  46 @return Returns time in seconds
  47 */
  48 double opj_clock();
  49
  50 /**
  51 Allocate a memory block with elements initialized to 0
  52 @param size Bytes to allocate
  53 @return Returns a void pointer to the allocated space, or NULL if there is insufficient memory available
  54 */
  55 void* opj_malloc( size_t size );
  56
  57 /**
  58 Reallocate memory blocks.
  59 @param memblock Pointer to previously allocated memory block
  60 @param size New size in bytes
  61 @return Returns a void pointer to the reallocated (and possibly moved) memory block
  62 */
  63 void* j2k_realloc( void *memblock, size_t size );
  64
  65 /**
  66 Deallocates or frees a memory block.
  67 @param memblock Previously allocated memory block to be freed
  68 */
  69 void opj_free( void *memblock );
  70
  71 /* ----------------------------------------------------------------------- */
  72 /*@}*/
  73
  74 /*@}*/
  75
  76 #endif /* __J2K_LIB_H */
  77