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 Create a new MQC handle
  91 @return Returns a new MQC handle if successful, returns NULL otherwise
  92 */
  93 opj_mqc_t* opj_mqc_create(void);
  94 /**
  95 Destroy a previously created MQC handle
  96 @param mqc MQC handle to destroy
  97 */
  98 void opj_mqc_destroy(opj_mqc_t *mqc);
  99 /**
 100 Return the number of bytes written/read since initialisation
 101 @param mqc MQC handle
 102 @return Returns the number of bytes already encoded
 103 */
 104 OPJ_UINT32 opj_mqc_numbytes(opj_mqc_t *mqc);
 105 /**
 106 Reset the states of all the context of the coder/decoder
 107 (each context is set to a state where 0 and 1 are more or less equiprobable)
 108 @param mqc MQC handle
 109 */
 110 void opj_mqc_resetstates(opj_mqc_t *mqc);
 111 /**
 112 Set the state of a particular context
 113 @param mqc MQC handle
 114 @param ctxno Number that identifies the context
 115 @param msb The MSB of the new state of the context
 116 @param prob Number that identifies the probability of the symbols for the new state of the context
 117 */
 118 void opj_mqc_setstate(opj_mqc_t *mqc, OPJ_UINT32 ctxno, OPJ_UINT32 msb,
 119                       OPJ_INT32 prob);
 120 /**
 121 Initialize the encoder
 122 @param mqc MQC handle
 123 @param bp Pointer to the start of the buffer where the bytes will be written
 124 */
 125 void opj_mqc_init_enc(opj_mqc_t *mqc, OPJ_BYTE *bp);
 126 /**
 127 Set the current context used for coding/decoding
 128 @param mqc MQC handle
 129 @param ctxno Number that identifies the context
 130 */
 131 #define opj_mqc_setcurctx(mqc, ctxno)   (mqc)->curctx = &(mqc)->ctxs[(OPJ_UINT32)(ctxno)]
 132 /**
 133 Encode a symbol using the MQ-coder
 134 @param mqc MQC handle
 135 @param d The symbol to be encoded (0 or 1)
 136 */
 137 void opj_mqc_encode(opj_mqc_t *mqc, OPJ_UINT32 d);
 138 /**
 139 Flush the encoder, so that all remaining data is written
 140 @param mqc MQC handle
 141 */
 142 void opj_mqc_flush(opj_mqc_t *mqc);
 143 /**
 144 BYPASS mode switch, initialization operation.
 145 JPEG 2000 p 505.
 146 <h2>Not fully implemented and tested !!</h2>
 147 @param mqc MQC handle
 148 */
 149 void opj_mqc_bypass_init_enc(opj_mqc_t *mqc);
 150 /**
 151 BYPASS mode switch, coding operation.
 152 JPEG 2000 p 505.
 153 <h2>Not fully implemented and tested !!</h2>
 154 @param mqc MQC handle
 155 @param d The symbol to be encoded (0 or 1)
 156 */
 157 void opj_mqc_bypass_enc(opj_mqc_t *mqc, OPJ_UINT32 d);
 158 /**
 159 BYPASS mode switch, flush operation
 160 <h2>Not fully implemented and tested !!</h2>
 161 @param mqc MQC handle
 162 @return Returns 1 (always)
 163 */
 164 OPJ_UINT32 opj_mqc_bypass_flush_enc(opj_mqc_t *mqc);
 165 /**
 166 RESET mode switch
 167 @param mqc MQC handle
 168 */
 169 void opj_mqc_reset_enc(opj_mqc_t *mqc);
 170 /**
 171 RESTART mode switch (TERMALL)
 172 @param mqc MQC handle
 173 @return Returns 1 (always)
 174 */
 175 OPJ_UINT32 opj_mqc_restart_enc(opj_mqc_t *mqc);
 176 /**
 177 RESTART mode switch (TERMALL) reinitialisation
 178 @param mqc MQC handle
 179 */
 180 void opj_mqc_restart_init_enc(opj_mqc_t *mqc);
 181 /**
 182 ERTERM mode switch (PTERM)
 183 @param mqc MQC handle
 184 */
 185 void opj_mqc_erterm_enc(opj_mqc_t *mqc);
 186 /**
 187 SEGMARK mode switch (SEGSYM)
 188 @param mqc MQC handle
 189 */
 190 void opj_mqc_segmark_enc(opj_mqc_t *mqc);
 191 /**
 192 Initialize the decoder
 193 @param mqc MQC handle
 194 @param bp Pointer to the start of the buffer from which the bytes will be read
 195 @param len Length of the input buffer
 196 */
 197 OPJ_BOOL opj_mqc_init_dec(opj_mqc_t *mqc, OPJ_BYTE *bp, OPJ_UINT32 len);
 198 /**
 199 Decode a symbol
 200 @param mqc MQC handle
 201 @return Returns the decoded symbol (0 or 1)
 202 */
 203 static INLINE OPJ_UINT32 opj_mqc_decode(opj_mqc_t * const mqc);
 204 /* ----------------------------------------------------------------------- */
 205 /*@}*/
 206
 207 /*@}*/
 208
 209 #endif /* __MQC_H */