2 * Copyright (c) 2001-2003, David Janssens
3 * Copyright (c) 2002-2003, Yannick Verschueren
4 * Copyright (c) 2003-2005, Francois Devaux and Antonin Descampe
5 * Copyright (c) 2005, Hervé Drolon, FreeImage Team
6 * Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
35 @brief Implementation of an individual bit input-output (BIO)
37 The functions in BIO.C have for goal to realize an individual bit input - output.
40 /** @defgroup BIO BIO - Individual bit input-output stream */
44 Individual bit input-output stream (BIO)
46 typedef struct opj_bio {
47 /** pointer to the start of the buffer */
49 /** pointer to the end of the buffer */
51 /** pointer to the present position in the buffer */
53 /** temporary place where each byte is read or written */
55 /** coder : number of bits free to write. decoder : number of bits read */
59 /** @name Exported functions */
61 /* ----------------------------------------------------------------------- */
63 Create a new BIO handle
64 @return Returns a new BIO handle if successful, returns NULL otherwise
66 opj_bio_t* bio_create();
68 Destroy a previously created BIO handle
69 @param bio BIO handle to destroy
71 void bio_destroy(opj_bio_t *bio);
73 Number of bytes written.
75 @return Returns the number of bytes written
77 int bio_numbytes(opj_bio_t *bio);
81 @param bp Output buffer
82 @param len Output buffer length
84 void bio_init_enc(opj_bio_t *bio, unsigned char *bp, int len);
88 @param bp Input buffer
89 @param len Input buffer length
91 void bio_init_dec(opj_bio_t *bio, unsigned char *bp, int len);
95 @param v Value of bits
96 @param n Number of bits to write
98 void bio_write(opj_bio_t *bio, int v, int n);
101 @param bio BIO handle
102 @param n Number of bits to read
103 @return Returns the corresponding read number
105 int bio_read(opj_bio_t *bio, int n);
108 @param bio BIO handle
109 @return Returns 1 if successful, returns 0 otherwise
111 int bio_flush(opj_bio_t *bio);
113 Passes the ending bits (coming from flushing)
114 @param bio BIO handle
115 @return Returns 1 if successful, returns 0 otherwise
117 int bio_inalign(opj_bio_t *bio);
118 /* ----------------------------------------------------------------------- */