src/lib/openjp2/bio.c

   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 #include "opj_includes.h"
  39
  40 /** @defgroup BIO BIO - Individual bit input-output stream */
  41 /*@{*/
  42
  43 /** @name Local static functions */
  44 /*@{*/
  45
  46 /**
  47 Read a bit
  48 @param bio BIO handle
  49 @return Returns the read bit
  50 */
  51 static OPJ_UINT32 opj_bio_getbit(opj_bio_t *bio);
  52 /**
  53 Write a byte
  54 @param bio BIO handle
  55 @return Returns OPJ_TRUE if successful, returns OPJ_FALSE otherwise
  56 */
  57 static OPJ_BOOL opj_bio_byteout(opj_bio_t *bio);
  58 /**
  59 Read a byte
  60 @param bio BIO handle
  61 @return Returns OPJ_TRUE if successful, returns OPJ_FALSE otherwise
  62 */
  63 static OPJ_BOOL opj_bio_bytein(opj_bio_t *bio);
  64
  65 /*@}*/
  66
  67 /*@}*/
  68
  69 /*
  70 ==========================================================
  71    local functions
  72 ==========================================================
  73 */
  74
  75 static OPJ_BOOL opj_bio_byteout(opj_bio_t *bio)
  76 {
  77     bio->buf = (bio->buf << 8) & 0xffff;
  78     bio->ct = bio->buf == 0xff00 ? 7 : 8;
  79     if ((OPJ_SIZE_T)bio->bp >= (OPJ_SIZE_T)bio->end) {
  80         return OPJ_FALSE;
  81     }
  82     *bio->bp++ = (OPJ_BYTE)(bio->buf >> 8);
  83     return OPJ_TRUE;
  84 }
  85
  86 static OPJ_BOOL opj_bio_bytein(opj_bio_t *bio)
  87 {
  88     bio->buf = (bio->buf << 8) & 0xffff;
  89     bio->ct = bio->buf == 0xff00 ? 7 : 8;
  90     if ((OPJ_SIZE_T)bio->bp >= (OPJ_SIZE_T)bio->end) {
  91         return OPJ_FALSE;
  92     }
  93     bio->buf |= *bio->bp++;
  94     return OPJ_TRUE;
  95 }
  96
  97 static OPJ_UINT32 opj_bio_getbit(opj_bio_t *bio)
  98 {
  99     if (bio->ct == 0) {
 100         opj_bio_bytein(
 101             bio); /* MSD: why not check the return value of this function ? */
 102     }
 103     bio->ct--;
 104     return (bio->buf >> bio->ct) & 1;
 105 }
 106
 107 /*
 108 ==========================================================
 109    Bit Input/Output interface
 110 ==========================================================
 111 */
 112
 113 opj_bio_t* opj_bio_create(void)
 114 {
 115     opj_bio_t *bio = (opj_bio_t*)opj_malloc(sizeof(opj_bio_t));
 116     return bio;
 117 }
 118
 119 void opj_bio_destroy(opj_bio_t *bio)
 120 {
 121     if (bio) {
 122         opj_free(bio);
 123     }
 124 }
 125
 126 ptrdiff_t opj_bio_numbytes(opj_bio_t *bio)
 127 {
 128     return (bio->bp - bio->start);
 129 }
 130
 131 void opj_bio_init_enc(opj_bio_t *bio, OPJ_BYTE *bp, OPJ_UINT32 len)
 132 {
 133     bio->start = bp;
 134     bio->end = bp + len;
 135     bio->bp = bp;
 136     bio->buf = 0;
 137     bio->ct = 8;
 138 }
 139
 140 void opj_bio_init_dec(opj_bio_t *bio, OPJ_BYTE *bp, OPJ_UINT32 len)
 141 {
 142     bio->start = bp;
 143     bio->end = bp + len;
 144     bio->bp = bp;
 145     bio->buf = 0;
 146     bio->ct = 0;
 147 }
 148
 149 void opj_bio_putbit(opj_bio_t *bio, OPJ_UINT32 b)
 150 {
 151     if (bio->ct == 0) {
 152         opj_bio_byteout(
 153             bio); /* MSD: why not check the return value of this function ? */
 154     }
 155     bio->ct--;
 156     bio->buf |= b << bio->ct;
 157 }
 158
 159 void opj_bio_write(opj_bio_t *bio, OPJ_UINT32 v, OPJ_UINT32 n)
 160 {
 161     OPJ_INT32 i;
 162
 163     assert((n > 0U) && (n <= 32U));
 164     for (i = (OPJ_INT32)n - 1; i >= 0; i--) {
 165         opj_bio_putbit(bio, (v >> i) & 1);
 166     }
 167 }
 168
 169 OPJ_UINT32 opj_bio_read(opj_bio_t *bio, OPJ_UINT32 n)
 170 {
 171     OPJ_INT32 i;
 172     OPJ_UINT32 v;
 173
 174     assert((n > 0U) /* && (n <= 32U)*/);
 175 #ifdef OPJ_UBSAN_BUILD
 176     /* This assert fails for some corrupted images which are gracefully rejected */
 177     /* Add this assert only for ubsan build. */
 178     /* This is the condition for overflow not to occur below which is needed because of OPJ_NOSANITIZE */
 179     assert(n <= 32U);
 180 #endif
 181     v = 0U;
 182     for (i = (OPJ_INT32)n - 1; i >= 0; i--) {
 183         v |= opj_bio_getbit(bio) <<
 184              i; /* can't overflow, opj_bio_getbit returns 0 or 1 */
 185     }
 186     return v;
 187 }
 188
 189 OPJ_BOOL opj_bio_flush(opj_bio_t *bio)
 190 {
 191     if (! opj_bio_byteout(bio)) {
 192         return OPJ_FALSE;
 193     }
 194     if (bio->ct == 7) {
 195         if (! opj_bio_byteout(bio)) {
 196             return OPJ_FALSE;
 197         }
 198     }
 199     return OPJ_TRUE;
 200 }
 201
 202 OPJ_BOOL opj_bio_inalign(opj_bio_t *bio)
 203 {
 204     if ((bio->buf & 0xff) == 0xff) {
 205         if (! opj_bio_bytein(bio)) {
 206             return OPJ_FALSE;
 207         }
 208     }
 209     bio->ct = 0;
 210     return OPJ_TRUE;
 211 }