libopenjpeg/bio.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  * Copyright (c) 2008, Jerome Fimes, Communications & Systemes <jerome.fimes@c-s.fr>
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  24  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30  * POSSIBILITY OF SUCH DAMAGE.
  31  */
  32
  33 #ifndef __BIO_H
  34 #define __BIO_H
  35 /**
  36 @file bio.h
  37 @brief Implementation of an individual bit input-output (BIO)
  38
  39 The functions in BIO.C have for goal to realize an individual bit input - output.
  40 */
  41 #include "openjpeg.h"
  42 /** @defgroup BIO BIO - Individual bit input-output stream */
  43 /*@{*/
  44
  45 /**
  46 Individual bit input-output stream (BIO)
  47 */
  48 typedef struct opj_bio {
  49         /** pointer to the start of the buffer */
  50         OPJ_BYTE *start;
  51         /** pointer to the end of the buffer */
  52         OPJ_BYTE *end;
  53         /** pointer to the present position in the buffer */
  54         OPJ_BYTE *bp;
  55         /** temporary place where each byte is read or written */
  56         OPJ_UINT32 buf;
  57         /** coder : number of bits free to write. decoder : number of bits read */
  58         OPJ_UINT32 ct;
  59 } opj_bio_t;
  60
  61 /** @name Exported functions */
  62 /*@{*/
  63 /* ----------------------------------------------------------------------- */
  64 /**
  65 Create a new BIO handle
  66 @return Returns a new BIO handle if successful, returns NULL otherwise
  67 */
  68 opj_bio_t* bio_create(void);
  69 /**
  70 Destroy a previously created BIO handle
  71 @param bio BIO handle to destroy
  72 */
  73 void bio_destroy(opj_bio_t *bio);
  74 /**
  75 Number of bytes written.
  76 @param bio BIO handle
  77 @return Returns the number of bytes written
  78 */
  79 OPJ_UINT32 bio_numbytes(opj_bio_t *bio);
  80 /**
  81 Init encoder
  82 @param bio BIO handle
  83 @param bp Output buffer
  84 @param len Output buffer length
  85 */
  86 void bio_init_enc(opj_bio_t *bio, OPJ_BYTE *bp, OPJ_UINT32 len);
  87 /**
  88 Init decoder
  89 @param bio BIO handle
  90 @param bp Input buffer
  91 @param len Input buffer length
  92 */
  93 void bio_init_dec(opj_bio_t *bio, OPJ_BYTE *bp, OPJ_UINT32 len);
  94 /**
  95 Write bits
  96 @param bio BIO handle
  97 @param v Value of bits
  98 @param n Number of bits to write
  99 */
 100 void bio_write(opj_bio_t *bio, OPJ_UINT32 v, OPJ_UINT32 n);
 101 /**
 102 Read bits
 103 @param bio BIO handle
 104 @param n Number of bits to read
 105 @return Returns the corresponding read number
 106 */
 107 OPJ_UINT32 bio_read(opj_bio_t *bio, OPJ_UINT32 n);
 108 /**
 109 Flush bits
 110 @param bio BIO handle
 111 @return Returns 1 if successful, returns 0 otherwise
 112 */
 113 bool bio_flush(opj_bio_t *bio);
 114 /**
 115 Passes the ending bits (coming from flushing)
 116 @param bio BIO handle
 117 @return Returns 1 if successful, returns 0 otherwise
 118 */
 119 bool bio_inalign(opj_bio_t *bio);
 120 /* ----------------------------------------------------------------------- */
 121 /*@}*/
 122
 123 /*@}*/
 124
 125 #endif /* __BIO_H */
 126