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