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.
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.
16 * Redistribution and use in source and binary forms, with or without
17 * modification, are permitted provided that the following conditions
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.
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.
38 #include "opj_includes.h"
40 /** @defgroup BIO BIO - Individual bit input-output stream */
43 /** @name Local static functions */
49 @param b Bit to write (0 or 1)
51 static void opj_bio_putbit(opj_bio_t *bio, OPJ_UINT32 b);
55 @return Returns the read bit
57 static OPJ_UINT32 opj_bio_getbit(opj_bio_t *bio);
61 @return Returns OPJ_TRUE if successful, returns OPJ_FALSE otherwise
63 static OPJ_BOOL opj_bio_byteout(opj_bio_t *bio);
67 @return Returns OPJ_TRUE if successful, returns OPJ_FALSE otherwise
69 static OPJ_BOOL opj_bio_bytein(opj_bio_t *bio);
76 ==========================================================
78 ==========================================================
81 static OPJ_BOOL opj_bio_byteout(opj_bio_t *bio)
83 bio->buf = (bio->buf << 8) & 0xffff;
84 bio->ct = bio->buf == 0xff00 ? 7 : 8;
85 if ((OPJ_SIZE_T)bio->bp >= (OPJ_SIZE_T)bio->end) {
88 *bio->bp++ = (OPJ_BYTE)(bio->buf >> 8);
92 static OPJ_BOOL opj_bio_bytein(opj_bio_t *bio)
94 bio->buf = (bio->buf << 8) & 0xffff;
95 bio->ct = bio->buf == 0xff00 ? 7 : 8;
96 if ((OPJ_SIZE_T)bio->bp >= (OPJ_SIZE_T)bio->end) {
99 bio->buf |= *bio->bp++;
103 static void opj_bio_putbit(opj_bio_t *bio, OPJ_UINT32 b)
107 bio); /* MSD: why not check the return value of this function ? */
110 bio->buf |= b << bio->ct;
113 static OPJ_UINT32 opj_bio_getbit(opj_bio_t *bio)
117 bio); /* MSD: why not check the return value of this function ? */
120 return (bio->buf >> bio->ct) & 1;
124 ==========================================================
125 Bit Input/Output interface
126 ==========================================================
129 opj_bio_t* opj_bio_create(void)
131 opj_bio_t *bio = (opj_bio_t*)opj_malloc(sizeof(opj_bio_t));
135 void opj_bio_destroy(opj_bio_t *bio)
142 ptrdiff_t opj_bio_numbytes(opj_bio_t *bio)
144 return (bio->bp - bio->start);
147 void opj_bio_init_enc(opj_bio_t *bio, OPJ_BYTE *bp, OPJ_UINT32 len)
156 void opj_bio_init_dec(opj_bio_t *bio, OPJ_BYTE *bp, OPJ_UINT32 len)
165 void opj_bio_write(opj_bio_t *bio, OPJ_UINT32 v, OPJ_UINT32 n)
169 assert((n > 0U) && (n <= 32U));
170 for (i = (OPJ_INT32)n - 1; i >= 0; i--) {
171 opj_bio_putbit(bio, (v >> i) & 1);
175 OPJ_UINT32 opj_bio_read(opj_bio_t *bio, OPJ_UINT32 n)
180 assert((n > 0U) /* && (n <= 32U)*/);
181 #ifdef OPJ_UBSAN_BUILD
182 /* This assert fails for some corrupted images which are gracefully rejected */
183 /* Add this assert only for ubsan build. */
184 /* This is the condition for overflow not to occur below which is needed because of OPJ_NOSANITIZE */
188 for (i = (OPJ_INT32)n - 1; i >= 0; i--) {
189 v |= opj_bio_getbit(bio) <<
190 i; /* can't overflow, opj_bio_getbit returns 0 or 1 */
195 OPJ_BOOL opj_bio_flush(opj_bio_t *bio)
197 if (! opj_bio_byteout(bio)) {
201 if (! opj_bio_byteout(bio)) {
208 OPJ_BOOL opj_bio_inalign(opj_bio_t *bio)
210 if ((bio->buf & 0xff) == 0xff) {
211 if (! opj_bio_bytein(bio)) {