OpenJPEG: mqc.h Source File

OpenJPEG 2.1.2

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 __MQC_H
40 #define __MQC_H
41
51
55 typedef struct opj_mqc_state {
57 OPJ_UINT32 qeval;
59 OPJ_UINT32 mps;
61 struct opj_mqc_state *nmps;
63 struct opj_mqc_state *nlps;
64 } opj_mqc_state_t;
65
66 #define MQC_NUMCTXS 19
67
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 #ifdef MQC_PERF_OPT
81 unsigned char *buffer;
82 #endif
83 } opj_mqc_t;
84
87 /* ----------------------------------------------------------------------- */
92 opj_mqc_t* opj_mqc_create(void);
97 void opj_mqc_destroy(opj_mqc_t *mqc);
103 OPJ_UINT32 opj_mqc_numbytes(opj_mqc_t *mqc);
109 void opj_mqc_resetstates(opj_mqc_t *mqc);
117 void opj_mqc_setstate(opj_mqc_t *mqc, OPJ_UINT32 ctxno, OPJ_UINT32 msb, OPJ_INT32 prob);
123 void opj_mqc_init_enc(opj_mqc_t *mqc, OPJ_BYTE *bp);
129 #define opj_mqc_setcurctx(mqc, ctxno) (mqc)->curctx = &(mqc)->ctxs[(OPJ_UINT32)(ctxno)]
130
135 void opj_mqc_encode(opj_mqc_t *mqc, OPJ_UINT32 d);
140 void opj_mqc_flush(opj_mqc_t *mqc);
147 void opj_mqc_bypass_init_enc(opj_mqc_t *mqc);
155 void opj_mqc_bypass_enc(opj_mqc_t *mqc, OPJ_UINT32 d);
162 OPJ_UINT32 opj_mqc_bypass_flush_enc(opj_mqc_t *mqc);
167 void opj_mqc_reset_enc(opj_mqc_t *mqc);
173 OPJ_UINT32 opj_mqc_restart_enc(opj_mqc_t *mqc);
178 void opj_mqc_restart_init_enc(opj_mqc_t *mqc);
183 void opj_mqc_erterm_enc(opj_mqc_t *mqc);
188 void opj_mqc_segmark_enc(opj_mqc_t *mqc);
195 OPJ_BOOL opj_mqc_init_dec(opj_mqc_t *mqc, OPJ_BYTE *bp, OPJ_UINT32 len);
201 OPJ_INT32 opj_mqc_decode(opj_mqc_t * const mqc);
202 /* ----------------------------------------------------------------------- */
206
207 #endif /* __MQC_H */
opj_mqc_state::qeval
OPJ_UINT32 qeval
the probability of the Least Probable Symbol (0.75->0x8000, 1.5->0xffff)
Definition: mqc.h:57
opj_mqc::start
OPJ_BYTE * start
Definition: mqc.h:76
opj_mqc::curctx
opj_mqc_state_t ** curctx
Definition: mqc.h:79
opj_mqc_create
opj_mqc_t * opj_mqc_create(void)
Create a new MQC handle.
Definition: mqc.c:369
opj_mqc_restart_init_enc
void opj_mqc_restart_init_enc(opj_mqc_t *mqc)
RESTART mode switch (TERMALL) reinitialisation.
Definition: mqc.c:493
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:607
MQC_NUMCTXS
#define MQC_NUMCTXS
Definition: mqc.h:66
opj_mqc::ct
OPJ_UINT32 ct
Definition: mqc.h:74
opj_mqc_decode
OPJ_INT32 opj_mqc_decode(opj_mqc_t *const mqc)
Decode a symbol.
Definition: mqc.c:588
opj_mqc_bypass_enc
void opj_mqc_bypass_enc(opj_mqc_t *mqc, OPJ_UINT32 d)
BYPASS mode switch, coding operation.
Definition: mqc.c:436
OPJ_BYTE
unsigned char OPJ_BYTE
Definition: openjpeg.h:117
opj_mqc_init_dec
OPJ_BOOL opj_mqc_init_dec(opj_mqc_t *mqc, OPJ_BYTE *bp, OPJ_UINT32 len)
Initialize the decoder.
Definition: mqc.c:529
OPJ_INT32
int32_t OPJ_INT32
Definition: openjpeg.h:125
opj_mqc::c
OPJ_UINT32 c
Definition: mqc.h:72
opj_mqc_state
This struct defines the state of a context.
Definition: mqc.h:55
opj_mqc_destroy
void opj_mqc_destroy(opj_mqc_t *mqc)
Destroy a previously created MQC handle.
Definition: mqc.c:379
opj_mqc::bp
OPJ_BYTE * bp
Definition: mqc.h:75
opj_mqc_flush
void opj_mqc_flush(opj_mqc_t *mqc)
Flush the encoder, so that all remaining data is written.
Definition: mqc.c:416
opj_mqc_state::nmps
struct opj_mqc_state * nmps
next state if the next encoded symbol is the MPS
Definition: mqc.h:61
opj_mqc_t
struct opj_mqc opj_mqc_t
MQ coder.
opj_mqc_bypass_flush_enc
OPJ_UINT32 opj_mqc_bypass_flush_enc(opj_mqc_t *mqc)
BYPASS mode switch, flush operation.
Definition: mqc.c:450
opj_mqc_state::mps
OPJ_UINT32 mps
the Most Probable Symbol (0 or 1)
Definition: mqc.h:59
opj_mqc_bypass_init_enc
void opj_mqc_bypass_init_enc(opj_mqc_t *mqc)
BYPASS mode switch, initialization operation.
Definition: mqc.c:428
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
Definition: mqc.h:73
opj_mqc_segmark_enc
void opj_mqc_segmark_enc(opj_mqc_t *mqc)
SEGMARK mode switch (SEGSYM)
Definition: mqc.c:520
opj_mqc_state::nlps
struct opj_mqc_state * nlps
next state if the next encoded symbol is the LPS
Definition: mqc.h:63
OPJ_UINT32
uint32_t OPJ_UINT32
Definition: openjpeg.h:126
opj_mqc_encode
void opj_mqc_encode(opj_mqc_t *mqc, OPJ_UINT32 d)
Encode a symbol using the MQ-coder.
Definition: mqc.c:408
opj_mqc_init_enc
void opj_mqc_init_enc(opj_mqc_t *mqc, OPJ_BYTE *bp)
Initialize the encoder.
Definition: mqc.c:398
opj_mqc::end
OPJ_BYTE * end
Definition: mqc.h:77
opj_mqc_reset_enc
void opj_mqc_reset_enc(opj_mqc_t *mqc)
RESET mode switch.
Definition: mqc.c:470
opj_mqc_erterm_enc
void opj_mqc_erterm_enc(opj_mqc_t *mqc)
ERTERM mode switch (PTERM)
Definition: mqc.c:505
opj_mqc_numbytes
OPJ_UINT32 opj_mqc_numbytes(opj_mqc_t *mqc)
Return the number of bytes written/read since initialisation.
Definition: mqc.c:390
opj_mqc
MQ coder.
Definition: mqc.h:71
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:614
opj_mqc_restart_enc
OPJ_UINT32 opj_mqc_restart_enc(opj_mqc_t *mqc)
RESTART mode switch (TERMALL)
Definition: mqc.c:477