src/lib/openjp3d/cio.h

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