libjp3dvm/cio.h

   1 /*\r
   2  * Copyright (c) 2001-2003, David Janssens\r
   3  * Copyright (c) 2002-2003, Yannick Verschueren\r
   4  * Copyright (c) 2003-2005, Francois Devaux and Antonin Descampe\r
   5  * Copyright (c) 2005, Herve Drolon, FreeImage Team\r
   6  * Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium\r
   7  * All rights reserved.\r
   8  *\r
   9  * Redistribution and use in source and binary forms, with or without\r
  10  * modification, are permitted provided that the following conditions\r
  11  * are met:\r
  12  * 1. Redistributions of source code must retain the above copyright\r
  13  *    notice, this list of conditions and the following disclaimer.\r
  14  * 2. Redistributions in binary form must reproduce the above copyright\r
  15  *    notice, this list of conditions and the following disclaimer in the\r
  16  *    documentation and/or other materials provided with the distribution.\r
  17  *\r
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'\r
  19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\r
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE\r
  22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR\r
  23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF\r
  24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS\r
  25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN\r
  26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)\r
  27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE\r
  28  * POSSIBILITY OF SUCH DAMAGE.\r
  29  */\r
  30 \r
  31 #ifndef __CIO_H\r
  32 #define __CIO_H\r
  33 /**\r
  34 @file cio.h\r
  35 @brief Implementation of a byte input-output process (CIO)\r
  36 \r
  37 The functions in CIO.C have for goal to realize a byte input / output process.\r
  38 */\r
  39 \r
  40 /** @defgroup CIO CIO - byte input-output stream */\r
  41 /*@{*/\r
  42 \r
  43 /** @name Funciones generales (see also openjpeg3d.h) */\r
  44 /*@{*/\r
  45 /* ----------------------------------------------------------------------- */\r
  46 /**\r
  47 Number of bytes left before the end of the stream\r
  48 @param cio CIO handle\r
  49 @return Returns the number of bytes before the end of the stream\r
  50 */\r
  51 int cio_numbytesleft(opj_cio_t *cio);\r
  52 /**\r
  53 Get pointer to the current position in the stream\r
  54 @param cio CIO handle\r
  55 @return Returns a pointer to the current position\r
  56 */\r
  57 unsigned char *cio_getbp(opj_cio_t *cio);\r
  58 /**\r
  59 Write some bytes\r
  60 @param cio CIO handle\r
  61 @param v Value to write\r
  62 @param n Number of bytes to write\r
  63 @return Returns the number of bytes written or 0 if an error occured\r
  64 */\r
  65 unsigned int cio_write(opj_cio_t *cio, unsigned int v, int n);\r
  66 /**\r
  67 Read some bytes\r
  68 @param cio CIO handle\r
  69 @param n Number of bytes to read\r
  70 @return Returns the value of the n bytes read\r
  71 */\r
  72 unsigned int cio_read(opj_cio_t *cio, int n);\r
  73 /**\r
  74 Skip some bytes\r
  75 @param cio CIO handle\r
  76 @param n Number of bytes to skip\r
  77 */\r
  78 void cio_skip(opj_cio_t *cio, int n);\r
  79 /**\r
  80 Write some bytes\r
  81 @param cio CIO handle\r
  82 @param v Signed integer value to write\r
  83 @param n Number of bytes to write\r
  84 @return Returns the number of bytes written or 0 if an error occured\r
  85 */\r
  86 int cio_write_int(opj_cio_t *cio, int v, int n);\r
  87 /**\r
  88 Read some bytes\r
  89 @param cio CIO handle\r
  90 @param n Number of bytes to read\r
  91 @return Returns the value of the n bytes read\r
  92 */\r
  93 int cio_read_int(opj_cio_t *cio, int n);\r
  94 /* ----------------------------------------------------------------------- */\r
  95 /*@}*/\r
  96 \r
  97 /*@}*/\r
  98 \r
  99 #endif /* __CIO_H */\r
 100 \r