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