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