libopenjp3d/jp3d_lib.h

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