libopenjpeg/cio.h

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