src/lib/openjp3d/bio.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 __BIO_H
  37 #define __BIO_H
  38 /**
  39 @file bio.h
  40 @brief Implementation of an individual bit input-output (BIO)
  41
  42 The functions in BIO.C have for goal to realize an individual bit input - output.
  43 */
  44
  45 /** @defgroup BIO BIO - Individual bit input-output stream */
  46 /*@{*/
  47
  48 /**
  49 Individual bit input-output stream (BIO)
  50 */
  51 typedef struct opj_bio {
  52     /** pointer to the start of the buffer */
  53     unsigned char *start;
  54     /** pointer to the end of the buffer */
  55     unsigned char *end;
  56     /** pointer to the present position in the buffer */
  57     unsigned char *bp;
  58     /** temporary place where each byte is read or written */
  59     unsigned int buf;
  60     /** coder : number of bits free to write. decoder : number of bits read */
  61     int ct;
  62 } opj_bio_t;
  63
  64 /** @name Funciones generales */
  65 /*@{*/
  66 /* ----------------------------------------------------------------------- */
  67 /**
  68 Create a new BIO handle
  69 @return Returns a new BIO handle if successful, returns NULL otherwise
  70 */
  71 opj_bio_t* bio_create(void);
  72 /**
  73 Destroy a previously created BIO handle
  74 @param bio BIO handle to destroy
  75 */
  76 void bio_destroy(opj_bio_t *bio);
  77 /**
  78 Number of bytes written.
  79 @param bio BIO handle
  80 @return Returns the number of bytes written
  81 */
  82 int bio_numbytes(opj_bio_t *bio);
  83 /**
  84 Init encoder
  85 @param bio BIO handle
  86 @param bp Output buffer
  87 @param len Output buffer length
  88 */
  89 void bio_init_enc(opj_bio_t *bio, unsigned char *bp, int len);
  90 /**
  91 Init decoder
  92 @param bio BIO handle
  93 @param bp Input buffer
  94 @param len Input buffer length
  95 */
  96 void bio_init_dec(opj_bio_t *bio, unsigned char *bp, int len);
  97 /**
  98 Write bits
  99 @param bio BIO handle
 100 @param v Value of bits
 101 @param n Number of bits to write
 102 */
 103 void bio_write(opj_bio_t *bio, int v, int n);
 104 /**
 105 Read bits
 106 @param bio BIO handle
 107 @param n Number of bits to read
 108 @return Returns the corresponding read number
 109 */
 110 int bio_read(opj_bio_t *bio, int n);
 111 /**
 112 Flush bits
 113 @param bio BIO handle
 114 @return Returns 1 if successful, returns 0 otherwise
 115 */
 116 int bio_flush(opj_bio_t *bio);
 117 /**
 118 Passes the ending bits (coming from flushing)
 119 @param bio BIO handle
 120 @return Returns 1 if successful, returns 0 otherwise
 121 */
 122 int bio_inalign(opj_bio_t *bio);
 123 /**
 124 Read a bit
 125 @param bio BIO handle
 126 @return Returns the read bit
 127 */
 128 /* MOD antonin */
 129 /*int bio_getbit(opj_bio_t *bio);*/
 130 /* DOM */
 131 /* ----------------------------------------------------------------------- */
 132 /*@}*/
 133
 134 /*@}*/
 135
 136 #endif /* __BIO_H */
 137