OpenJPEG: mqc.h Source File

OpenJPEG 2.3.0

mqc.h
Go to the documentation of this file.
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 OPJ_MQC_H
40 #define OPJ_MQC_H
41
42 #include "opj_common.h"
43
54
58 typedef struct opj_mqc_state {
60 OPJ_UINT32 qeval;
62 OPJ_UINT32 mps;
64 const struct opj_mqc_state *nmps;
66 const struct opj_mqc_state *nlps;
67 } opj_mqc_state_t;
68
69 #define MQC_NUMCTXS 19
70
74 typedef struct opj_mqc {
76 OPJ_UINT32 c;
78 OPJ_UINT32 a;
80 OPJ_UINT32 ct;
81 /* only used by decoder, to count the number of times a terminating 0xFF >0x8F marker is read */
82 OPJ_UINT32 end_of_byte_stream_counter;
84 OPJ_BYTE *bp;
86 OPJ_BYTE *start;
88 OPJ_BYTE *end;
90 const opj_mqc_state_t *ctxs[MQC_NUMCTXS];
92 const opj_mqc_state_t **curctx;
93 /* lut_ctxno_zc shifted by (1 << 9) * bandno */
94 const OPJ_BYTE* lut_ctxno_zc_orient;
96 OPJ_BYTE backup[OPJ_COMMON_CBLK_DATA_EXTRA];
97 } opj_mqc_t;
98
99 #include "mqc_inl.h"
100
103 /* ----------------------------------------------------------------------- */
104
110 OPJ_UINT32 opj_mqc_numbytes(opj_mqc_t *mqc);
116 void opj_mqc_resetstates(opj_mqc_t *mqc);
124 void opj_mqc_setstate(opj_mqc_t *mqc, OPJ_UINT32 ctxno, OPJ_UINT32 msb,
125 OPJ_INT32 prob);
131 void opj_mqc_init_enc(opj_mqc_t *mqc, OPJ_BYTE *bp);
137 #define opj_mqc_setcurctx(mqc, ctxno) (mqc)->curctx = &(mqc)->ctxs[(OPJ_UINT32)(ctxno)]
138
143 void opj_mqc_encode(opj_mqc_t *mqc, OPJ_UINT32 d);
148 void opj_mqc_flush(opj_mqc_t *mqc);
154 void opj_mqc_bypass_init_enc(opj_mqc_t *mqc);
155
161 OPJ_UINT32 opj_mqc_bypass_get_extra_bytes(opj_mqc_t *mqc, OPJ_BOOL erterm);
162
169 void opj_mqc_bypass_enc(opj_mqc_t *mqc, OPJ_UINT32 d);
175 void opj_mqc_bypass_flush_enc(opj_mqc_t *mqc, OPJ_BOOL erterm);
180 void opj_mqc_reset_enc(opj_mqc_t *mqc);
181
182 #ifdef notdef
183
188 OPJ_UINT32 opj_mqc_restart_enc(opj_mqc_t *mqc);
189 #endif
190
195 void opj_mqc_restart_init_enc(opj_mqc_t *mqc);
200 void opj_mqc_erterm_enc(opj_mqc_t *mqc);
205 void opj_mqc_segmark_enc(opj_mqc_t *mqc);
206
225 void opj_mqc_init_dec(opj_mqc_t *mqc, OPJ_BYTE *bp, OPJ_UINT32 len,
226 OPJ_UINT32 extra_writable_bytes);
227
246 void opj_mqc_raw_init_dec(opj_mqc_t *mqc, OPJ_BYTE *bp, OPJ_UINT32 len,
247 OPJ_UINT32 extra_writable_bytes);
248
249
258 void opq_mqc_finish_dec(opj_mqc_t *mqc);
259
265 /*static INLINE OPJ_UINT32 opj_mqc_decode(opj_mqc_t * const mqc);*/
266 /* ----------------------------------------------------------------------- */
270
271 #endif /* OPJ_MQC_H */
opj_mqc_bypass_get_extra_bytes
OPJ_UINT32 opj_mqc_bypass_get_extra_bytes(opj_mqc_t *mqc, OPJ_BOOL erterm)
Return number of extra bytes to add to opj_mqc_numbytes() for the² size of a non-terminating BYPASS ...
Definition: mqc.c:371
opj_mqc_state::qeval
OPJ_UINT32 qeval
the probability of the Least Probable Symbol (0.75->0x8000, 1.5->0xffff)
Definition: mqc.h:60
opj_mqc::ctxs
const opj_mqc_state_t * ctxs[MQC_NUMCTXS]
Array of contexts.
Definition: mqc.h:90
opj_mqc::start
OPJ_BYTE * start
pointer to the start of the buffer
Definition: mqc.h:86
opj_mqc_restart_init_enc
void opj_mqc_restart_init_enc(opj_mqc_t *mqc)
RESTART mode switch (TERMALL) reinitialisation
Definition: mqc.c:442
opj_mqc_state::nlps
const struct opj_mqc_state * nlps
next state if the next encoded symbol is the LPS
Definition: mqc.h:66
OPJ_BOOL
int OPJ_BOOL
Definition: openjpeg.h:110
opj_mqc_resetstates
void opj_mqc_resetstates(opj_mqc_t *mqc)
Reset the states of all the context of the coder/decoder (each context is set to a state where 0 and...
Definition: mqc.c:546
MQC_NUMCTXS
#define MQC_NUMCTXS
Definition: mqc.h:69
opj_mqc::ct
OPJ_UINT32 ct
number of bits already read or free to write
Definition: mqc.h:80
opj_mqc_bypass_enc
void opj_mqc_bypass_enc(opj_mqc_t *mqc, OPJ_UINT32 d)
BYPASS mode switch, coding operation.
Definition: mqc.c:352
OPJ_BYTE
unsigned char OPJ_BYTE
Definition: openjpeg.h:117
opj_common.h
OPJ_INT32
int32_t OPJ_INT32
Definition: openjpeg.h:125
opj_mqc::c
OPJ_UINT32 c
temporary buffer where bits are coded or decoded
Definition: mqc.h:76
opj_mqc::curctx
const opj_mqc_state_t ** curctx
Active context.
Definition: mqc.h:92
opj_mqc_state
This struct defines the state of a context.
Definition: mqc.h:58
opj_mqc::bp
OPJ_BYTE * bp
pointer to the current position in the buffer
Definition: mqc.h:84
opj_mqc_init_dec
void opj_mqc_init_dec(opj_mqc_t *mqc, OPJ_BYTE *bp, OPJ_UINT32 len, OPJ_UINT32 extra_writable_bytes)
Initialize the decoder for MQ decoding.
Definition: mqc.c:507
opj_mqc_flush
void opj_mqc_flush(opj_mqc_t *mqc)
Flush the encoder, so that all remaining data is written
Definition: mqc.c:315
opj_mqc_t
struct opj_mqc opj_mqc_t
MQ coder
OPJ_COMMON_CBLK_DATA_EXTRA
#define OPJ_COMMON_CBLK_DATA_EXTRA
Margin for a fake FFFF marker.
Definition: opj_common.h:39
opq_mqc_finish_dec
void opq_mqc_finish_dec(opj_mqc_t *mqc)
Terminate RAW/MQC decoding
Definition: mqc.c:540
opj_mqc::end_of_byte_stream_counter
OPJ_UINT32 end_of_byte_stream_counter
Definition: mqc.h:82
opj_mqc::backup
OPJ_BYTE backup[OPJ_COMMON_CBLK_DATA_EXTRA]
Original value of the 2 bytes at end[0] and end[1].
Definition: mqc.h:96
opj_mqc_state::mps
OPJ_UINT32 mps
the Most Probable Symbol (0 or 1)
Definition: mqc.h:62
opj_mqc_bypass_init_enc
void opj_mqc_bypass_init_enc(opj_mqc_t *mqc)
BYPASS mode switch, initialization operation.
Definition: mqc.c:334
opj_mqc_state_t
struct opj_mqc_state opj_mqc_state_t
This struct defines the state of a context.
opj_mqc::a
OPJ_UINT32 a
only used by MQ decoder
Definition: mqc.h:78
opj_mqc_segmark_enc
void opj_mqc_segmark_enc(opj_mqc_t *mqc)
SEGMARK mode switch (SEGSYM)
Definition: mqc.c:478
opj_mqc_bypass_flush_enc
void opj_mqc_bypass_flush_enc(opj_mqc_t *mqc, OPJ_BOOL erterm)
BYPASS mode switch, flush operation
Definition: mqc.c:377
OPJ_UINT32
uint32_t OPJ_UINT32
Definition: openjpeg.h:126
mqc_inl.h
opj_mqc_encode
void opj_mqc_encode(opj_mqc_t *mqc, OPJ_UINT32 d)
Encode a symbol using the MQ-coder
Definition: mqc.c:306
opj_mqc_init_enc
void opj_mqc_init_enc(opj_mqc_t *mqc, OPJ_BYTE *bp)
Initialize the encoder
Definition: mqc.c:283
opj_mqc::end
OPJ_BYTE * end
pointer to the end of the buffer
Definition: mqc.h:88
opj_mqc_reset_enc
void opj_mqc_reset_enc(opj_mqc_t *mqc)
RESET mode switch
Definition: mqc.c:415
opj_mqc::lut_ctxno_zc_orient
const OPJ_BYTE * lut_ctxno_zc_orient
Definition: mqc.h:94
opj_mqc_erterm_enc
void opj_mqc_erterm_enc(opj_mqc_t *mqc)
ERTERM mode switch (PTERM)
Definition: mqc.c:462
opj_mqc_numbytes
OPJ_UINT32 opj_mqc_numbytes(opj_mqc_t *mqc)
Return the number of bytes written/read since initialisation
Definition: mqc.c:274
opj_mqc
MQ coder
Definition: mqc.h:74
opj_mqc_setstate
void opj_mqc_setstate(opj_mqc_t *mqc, OPJ_UINT32 ctxno, OPJ_UINT32 msb, OPJ_INT32 prob)
Set the state of a particular context
Definition: mqc.c:554
opj_mqc_state::nmps
const struct opj_mqc_state * nmps
next state if the next encoded symbol is the MPS
Definition: mqc.h:64
opj_mqc_raw_init_dec
void opj_mqc_raw_init_dec(opj_mqc_t *mqc, OPJ_BYTE *bp, OPJ_UINT32 len, OPJ_UINT32 extra_writable_bytes)
Initialize the decoder for RAW decoding.
Definition: mqc.c:531