src/lib/openmj2/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  * 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 __MQC_H
  39 #define __MQC_H
  40 /**
  41 @file mqc.h
  42 @brief Implementation of an MQ-Coder (MQC)
  43
  44 The functions in MQC.C have for goal to realize the MQ-coder operations. The functions
  45 in MQC.C are used by some function in T1.C.
  46 */
  47
  48 /** @defgroup MQC MQC - Implementation of an MQ-Coder */
  49 /*@{*/
  50
  51 /**
  52 This struct defines the state of a context.
  53 */
  54 typedef struct opj_mqc_state {
  55     /** the probability of the Least Probable Symbol (0.75->0x8000, 1.5->0xffff) */
  56     unsigned int qeval;
  57     /** the Most Probable Symbol (0 or 1) */
  58     int mps;
  59     /** next state if the next encoded symbol is the MPS */
  60     struct opj_mqc_state *nmps;
  61     /** next state if the next encoded symbol is the LPS */
  62     struct opj_mqc_state *nlps;
  63 } opj_mqc_state_t;
  64
  65 #define MQC_NUMCTXS 19
  66
  67 /**
  68 MQ coder
  69 */
  70 typedef struct opj_mqc {
  71     unsigned int c;
  72     unsigned int a;
  73     unsigned int ct;
  74     unsigned char *bp;
  75     unsigned char *start;
  76     unsigned char *end;
  77     opj_mqc_state_t *ctxs[MQC_NUMCTXS];
  78     opj_mqc_state_t **curctx;
  79 #ifdef MQC_PERF_OPT
  80     unsigned char *buffer;
  81 #endif
  82 } opj_mqc_t;
  83
  84 /** @name Exported functions */
  85 /*@{*/
  86 /* ----------------------------------------------------------------------- */
  87 /**
  88 Create a new MQC handle
  89 @return Returns a new MQC handle if successful, returns NULL otherwise
  90 */
  91 opj_mqc_t* mqc_create(void);
  92 /**
  93 Destroy a previously created MQC handle
  94 @param mqc MQC handle to destroy
  95 */
  96 void mqc_destroy(opj_mqc_t *mqc);
  97 /**
  98 Return the number of bytes written/read since initialisation
  99 @param mqc MQC handle
 100 @return Returns the number of bytes already encoded
 101 */
 102 int mqc_numbytes(opj_mqc_t *mqc);
 103 /**
 104 Reset the states of all the context of the coder/decoder
 105 (each context is set to a state where 0 and 1 are more or less equiprobable)
 106 @param mqc MQC handle
 107 */
 108 void mqc_resetstates(opj_mqc_t *mqc);
 109 /**
 110 Set the state of a particular context
 111 @param mqc MQC handle
 112 @param ctxno Number that identifies the context
 113 @param msb The MSB of the new state of the context
 114 @param prob Number that identifies the probability of the symbols for the new state of the context
 115 */
 116 void mqc_setstate(opj_mqc_t *mqc, int ctxno, int msb, int prob);
 117 /**
 118 Initialize the encoder
 119 @param mqc MQC handle
 120 @param bp Pointer to the start of the buffer where the bytes will be written
 121 */
 122 void mqc_init_enc(opj_mqc_t *mqc, unsigned char *bp);
 123 /**
 124 Set the current context used for coding/decoding
 125 @param mqc MQC handle
 126 @param ctxno Number that identifies the context
 127 */
 128 #define mqc_setcurctx(mqc, ctxno)   (mqc)->curctx = &(mqc)->ctxs[(int)(ctxno)]
 129 /**
 130 Encode a symbol using the MQ-coder
 131 @param mqc MQC handle
 132 @param d The symbol to be encoded (0 or 1)
 133 */
 134 void mqc_encode(opj_mqc_t *mqc, int d);
 135 /**
 136 Flush the encoder, so that all remaining data is written
 137 @param mqc MQC handle
 138 */
 139 void mqc_flush(opj_mqc_t *mqc);
 140 /**
 141 BYPASS mode switch, initialization operation.
 142 JPEG 2000 p 505.
 143 <h2>Not fully implemented and tested !!</h2>
 144 @param mqc MQC handle
 145 */
 146 void mqc_bypass_init_enc(opj_mqc_t *mqc);
 147 /**
 148 BYPASS mode switch, coding operation.
 149 JPEG 2000 p 505.
 150 <h2>Not fully implemented and tested !!</h2>
 151 @param mqc MQC handle
 152 @param d The symbol to be encoded (0 or 1)
 153 */
 154 void mqc_bypass_enc(opj_mqc_t *mqc, int d);
 155 /**
 156 BYPASS mode switch, flush operation
 157 <h2>Not fully implemented and tested !!</h2>
 158 @param mqc MQC handle
 159 @return Returns 1 (always)
 160 */
 161 int mqc_bypass_flush_enc(opj_mqc_t *mqc);
 162 /**
 163 RESET mode switch
 164 @param mqc MQC handle
 165 */
 166 void mqc_reset_enc(opj_mqc_t *mqc);
 167 /**
 168 RESTART mode switch (TERMALL)
 169 @param mqc MQC handle
 170 @return Returns 1 (always)
 171 */
 172 int mqc_restart_enc(opj_mqc_t *mqc);
 173 /**
 174 RESTART mode switch (TERMALL) reinitialisation
 175 @param mqc MQC handle
 176 */
 177 void mqc_restart_init_enc(opj_mqc_t *mqc);
 178 /**
 179 ERTERM mode switch (PTERM)
 180 @param mqc MQC handle
 181 */
 182 void mqc_erterm_enc(opj_mqc_t *mqc);
 183 /**
 184 SEGMARK mode switch (SEGSYM)
 185 @param mqc MQC handle
 186 */
 187 void mqc_segmark_enc(opj_mqc_t *mqc);
 188 /**
 189 Initialize the decoder
 190 @param mqc MQC handle
 191 @param bp Pointer to the start of the buffer from which the bytes will be read
 192 @param len Length of the input buffer
 193 */
 194 void mqc_init_dec(opj_mqc_t *mqc, unsigned char *bp, int len);
 195 /**
 196 Decode a symbol
 197 @param mqc MQC handle
 198 @return Returns the decoded symbol (0 or 1)
 199 */
 200 int mqc_decode(opj_mqc_t *const mqc);
 201 /* ----------------------------------------------------------------------- */
 202 /*@}*/
 203
 204 /*@}*/
 205
 206 #endif /* __MQC_H */