src/lib/openjp2/mqc.h

   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  * Copyright (c) 2008, Jerome Fimes, Communications & Systemes <jerome.fimes@c-s.fr>
  15  * All rights reserved.
  16  *
  17  * Redistribution and use in source and binary forms, with or without
  18  * modification, are permitted provided that the following conditions
  19  * are met:
  20  * 1. Redistributions of source code must retain the above copyright
  21  *    notice, this list of conditions and the following disclaimer.
  22  * 2. Redistributions in binary form must reproduce the above copyright
  23  *    notice, this list of conditions and the following disclaimer in the
  24  *    documentation and/or other materials provided with the distribution.
  25  *
  26  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  27  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  30  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  36  * POSSIBILITY OF SUCH DAMAGE.
  37  */
  38
  39 #ifndef __MQC_H
  40 #define __MQC_H
  41 /**
  42 @file mqc.h
  43 @brief Implementation of an MQ-Coder (MQC)
  44
  45 The functions in MQC.C have for goal to realize the MQ-coder operations. The functions
  46 in MQC.C are used by some function in T1.C.
  47 */
  48
  49 /** @defgroup MQC MQC - Implementation of an MQ-Coder */
  50 /*@{*/
  51
  52 /**
  53 This struct defines the state of a context.
  54 */
  55 typedef struct opj_mqc_state {
  56     /** the probability of the Least Probable Symbol (0.75->0x8000, 1.5->0xffff) */
  57     OPJ_UINT32 qeval;
  58     /** the Most Probable Symbol (0 or 1) */
  59     OPJ_UINT32 mps;
  60     /** next state if the next encoded symbol is the MPS */
  61     struct opj_mqc_state *nmps;
  62     /** next state if the next encoded symbol is the LPS */
  63     struct opj_mqc_state *nlps;
  64 } opj_mqc_state_t;
  65
  66 #define MQC_NUMCTXS 19
  67
  68 /**
  69 MQ coder
  70 */
  71 typedef struct opj_mqc {
  72     OPJ_UINT32 c;
  73     OPJ_UINT32 a;
  74     OPJ_UINT32 ct;
  75     OPJ_BYTE *bp;
  76     OPJ_BYTE *start;
  77     OPJ_BYTE *end;
  78     opj_mqc_state_t *ctxs[MQC_NUMCTXS];
  79     opj_mqc_state_t **curctx;
  80     /* lut_ctxno_zc shifted by (1 << 9) * bandno */
  81     const OPJ_BYTE* lut_ctxno_zc_orient;
  82 } opj_mqc_t;
  83
  84 #include "mqc_inl.h"
  85
  86 /** @name Exported functions */
  87 /*@{*/
  88 /* ----------------------------------------------------------------------- */
  89
  90 /**
  91 Return the number of bytes written/read since initialisation
  92 @param mqc MQC handle
  93 @return Returns the number of bytes already encoded
  94 */
  95 OPJ_UINT32 opj_mqc_numbytes(opj_mqc_t *mqc);
  96 /**
  97 Reset the states of all the context of the coder/decoder
  98 (each context is set to a state where 0 and 1 are more or less equiprobable)
  99 @param mqc MQC handle
 100 */
 101 void opj_mqc_resetstates(opj_mqc_t *mqc);
 102 /**
 103 Set the state of a particular context
 104 @param mqc MQC handle
 105 @param ctxno Number that identifies the context
 106 @param msb The MSB of the new state of the context
 107 @param prob Number that identifies the probability of the symbols for the new state of the context
 108 */
 109 void opj_mqc_setstate(opj_mqc_t *mqc, OPJ_UINT32 ctxno, OPJ_UINT32 msb,
 110                       OPJ_INT32 prob);
 111 /**
 112 Initialize the encoder
 113 @param mqc MQC handle
 114 @param bp Pointer to the start of the buffer where the bytes will be written
 115 */
 116 void opj_mqc_init_enc(opj_mqc_t *mqc, OPJ_BYTE *bp);
 117 /**
 118 Set the current context used for coding/decoding
 119 @param mqc MQC handle
 120 @param ctxno Number that identifies the context
 121 */
 122 #define opj_mqc_setcurctx(mqc, ctxno)   (mqc)->curctx = &(mqc)->ctxs[(OPJ_UINT32)(ctxno)]
 123 /**
 124 Encode a symbol using the MQ-coder
 125 @param mqc MQC handle
 126 @param d The symbol to be encoded (0 or 1)
 127 */
 128 void opj_mqc_encode(opj_mqc_t *mqc, OPJ_UINT32 d);
 129 /**
 130 Flush the encoder, so that all remaining data is written
 131 @param mqc MQC handle
 132 */
 133 void opj_mqc_flush(opj_mqc_t *mqc);
 134 /**
 135 BYPASS mode switch, initialization operation.
 136 JPEG 2000 p 505.
 137 <h2>Not fully implemented and tested !!</h2>
 138 @param mqc MQC handle
 139 */
 140 void opj_mqc_bypass_init_enc(opj_mqc_t *mqc);
 141 /**
 142 BYPASS mode switch, coding operation.
 143 JPEG 2000 p 505.
 144 <h2>Not fully implemented and tested !!</h2>
 145 @param mqc MQC handle
 146 @param d The symbol to be encoded (0 or 1)
 147 */
 148 void opj_mqc_bypass_enc(opj_mqc_t *mqc, OPJ_UINT32 d);
 149 /**
 150 BYPASS mode switch, flush operation
 151 <h2>Not fully implemented and tested !!</h2>
 152 @param mqc MQC handle
 153 @return Returns 1 (always)
 154 */
 155 OPJ_UINT32 opj_mqc_bypass_flush_enc(opj_mqc_t *mqc);
 156 /**
 157 RESET mode switch
 158 @param mqc MQC handle
 159 */
 160 void opj_mqc_reset_enc(opj_mqc_t *mqc);
 161 /**
 162 RESTART mode switch (TERMALL)
 163 @param mqc MQC handle
 164 @return Returns 1 (always)
 165 */
 166 OPJ_UINT32 opj_mqc_restart_enc(opj_mqc_t *mqc);
 167 /**
 168 RESTART mode switch (TERMALL) reinitialisation
 169 @param mqc MQC handle
 170 */
 171 void opj_mqc_restart_init_enc(opj_mqc_t *mqc);
 172 /**
 173 ERTERM mode switch (PTERM)
 174 @param mqc MQC handle
 175 */
 176 void opj_mqc_erterm_enc(opj_mqc_t *mqc);
 177 /**
 178 SEGMARK mode switch (SEGSYM)
 179 @param mqc MQC handle
 180 */
 181 void opj_mqc_segmark_enc(opj_mqc_t *mqc);
 182 /**
 183 Initialize the decoder
 184 @param mqc MQC handle
 185 @param bp Pointer to the start of the buffer from which the bytes will be read
 186 @param len Length of the input buffer
 187 */
 188 OPJ_BOOL opj_mqc_init_dec(opj_mqc_t *mqc, OPJ_BYTE *bp, OPJ_UINT32 len);
 189 /**
 190 Decode a symbol
 191 @param mqc MQC handle
 192 @return Returns the decoded symbol (0 or 1)
 193 */
 194 /*static INLINE OPJ_UINT32 opj_mqc_decode(opj_mqc_t * const mqc);*/
 195 /* ----------------------------------------------------------------------- */
 196 /*@}*/
 197
 198 /*@}*/
 199
 200 #endif /* __MQC_H */