src/lib/openjp2/mqc.h

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