mqc.h
Go to the documentation of this file.
/*
* The copyright in this software is being made available under the 2-clauses
* BSD License, included below. This software may be subject to other third
* party and contributor rights, including patent rights, and no such rights
* are granted under this license.
*
* Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
* Copyright (c) 2002-2014, Professor Benoit Macq
* Copyright (c) 2001-2003, David Janssens
* Copyright (c) 2002-2003, Yannick Verschueren
* Copyright (c) 2003-2007, Francois-Olivier Devaux
* Copyright (c) 2003-2014, Antonin Descampe
* Copyright (c) 2005, Herve Drolon, FreeImage Team
* Copyright (c) 2008, Jerome Fimes, Communications & Systemes <jerome.fimes@c-s.fr>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef OPJ_MQC_H
#define OPJ_MQC_H
#include "opj_common.h"
typedef struct opj_mqc_state {
OPJ_UINT32 qeval;
OPJ_UINT32 mps;
const struct opj_mqc_state *nmps;
const struct opj_mqc_state *nlps;
} opj_mqc_state_t;
#define MQC_NUMCTXS 19
typedef struct opj_mqc {
OPJ_UINT32 c;
OPJ_UINT32 a;
OPJ_UINT32 ct;
/* only used by decoder, to count the number of times a terminating 0xFF >0x8F marker is read */
OPJ_UINT32 end_of_byte_stream_counter;
OPJ_BYTE *bp;
OPJ_BYTE *start;
OPJ_BYTE *end;
const opj_mqc_state_t *ctxs[MQC_NUMCTXS];
const opj_mqc_state_t **curctx;
/* lut_ctxno_zc shifted by (1 << 9) * bandno */
const OPJ_BYTE* lut_ctxno_zc_orient;
OPJ_BYTE backup[OPJ_COMMON_CBLK_DATA_EXTRA];
} opj_mqc_t;
#define BYPASS_CT_INIT 0xDEADBEEF
#include "mqc_inl.h"
/* ----------------------------------------------------------------------- */
OPJ_UINT32 opj_mqc_numbytes(opj_mqc_t *mqc);
void opj_mqc_resetstates(opj_mqc_t *mqc);
void opj_mqc_setstate(opj_mqc_t *mqc, OPJ_UINT32 ctxno, OPJ_UINT32 msb,
OPJ_INT32 prob);
void opj_mqc_init_enc(opj_mqc_t *mqc, OPJ_BYTE *bp);
#define opj_mqc_setcurctx(mqc, ctxno) (mqc)->curctx = &(mqc)->ctxs[(OPJ_UINT32)(ctxno)]
void opj_mqc_flush(opj_mqc_t *mqc);
void opj_mqc_bypass_init_enc(opj_mqc_t *mqc);
OPJ_UINT32 opj_mqc_bypass_get_extra_bytes(opj_mqc_t *mqc, OPJ_BOOL erterm);
void opj_mqc_bypass_enc(opj_mqc_t *mqc, OPJ_UINT32 d);
void opj_mqc_bypass_flush_enc(opj_mqc_t *mqc, OPJ_BOOL erterm);
void opj_mqc_reset_enc(opj_mqc_t *mqc);
#ifdef notdef
OPJ_UINT32 opj_mqc_restart_enc(opj_mqc_t *mqc);
#endif
void opj_mqc_restart_init_enc(opj_mqc_t *mqc);
void opj_mqc_erterm_enc(opj_mqc_t *mqc);
void opj_mqc_segmark_enc(opj_mqc_t *mqc);
void opj_mqc_init_dec(opj_mqc_t *mqc, OPJ_BYTE *bp, OPJ_UINT32 len,
OPJ_UINT32 extra_writable_bytes);
void opj_mqc_raw_init_dec(opj_mqc_t *mqc, OPJ_BYTE *bp, OPJ_UINT32 len,
OPJ_UINT32 extra_writable_bytes);
void opq_mqc_finish_dec(opj_mqc_t *mqc);
/*static INLINE OPJ_UINT32 opj_mqc_decode(opj_mqc_t * const mqc);*/
/* ----------------------------------------------------------------------- */
#endif /* OPJ_MQC_H */
opj_mqc_restart_init_enc
void opj_mqc_restart_init_enc(opj_mqc_t *mqc)
RESTART mode switch (TERMALL) reinitialisation.
Definition mqc.c:337
MQC_NUMCTXS
#define MQC_NUMCTXS
Definition mqc.h:69
opj_mqc_flush
void opj_mqc_flush(opj_mqc_t *mqc)
Flush the encoder, so that all remaining data is written.
Definition mqc.c:212
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 p...
Definition mqc.c:266
opq_mqc_finish_dec
void opq_mqc_finish_dec(opj_mqc_t *mqc)
Terminate RAW/MQC decoding.
Definition mqc.c:472
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:463
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:486
opj_mqc_reset_enc
void opj_mqc_reset_enc(opj_mqc_t *mqc)
RESET mode switch.
Definition mqc.c:310
opj_mqc_t
struct opj_mqc opj_mqc_t
MQ coder.
opj_mqc_state_t
struct opj_mqc_state opj_mqc_state_t
This struct defines the state of a context.
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: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:272
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:439
opj_mqc_bypass_init_enc
void opj_mqc_bypass_init_enc(opj_mqc_t *mqc)
BYPASS mode switch, initialization operation.
Definition mqc.c:229
opj_mqc_init_enc
void opj_mqc_init_enc(opj_mqc_t *mqc, OPJ_BYTE *bp)
Initialize the encoder.
Definition mqc.c:188
opj_mqc_numbytes
OPJ_UINT32 opj_mqc_numbytes(opj_mqc_t *mqc)
Return the number of bytes written/read since initialisation.
Definition mqc.c:179
opj_mqc_bypass_enc
void opj_mqc_bypass_enc(opj_mqc_t *mqc, OPJ_UINT32 d)
BYPASS mode switch, coding operation.
Definition mqc.c:247
opj_mqc_erterm_enc
void opj_mqc_erterm_enc(opj_mqc_t *mqc)
ERTERM mode switch (PTERM)
Definition mqc.c:357
opj_mqc_segmark_enc
void opj_mqc_segmark_enc(opj_mqc_t *mqc)
SEGMARK mode switch (SEGSYM)
Definition mqc.c:410
mqc_inl.h
OPJ_BYTE
unsigned char OPJ_BYTE
Definition openjpeg.h:123
OPJ_INT32
int32_t OPJ_INT32
Definition openjpeg.h:131
OPJ_UINT32
uint32_t OPJ_UINT32
Definition openjpeg.h:132
OPJ_BOOL
int OPJ_BOOL
Definition openjpeg.h:116
opj_common.h
OPJ_COMMON_CBLK_DATA_EXTRA
#define OPJ_COMMON_CBLK_DATA_EXTRA
Margin for a fake FFFF marker.
Definition opj_common.h:39
opj_mqc_state
This struct defines the state of a context.
Definition mqc.h:58
opj_mqc_state::mps
OPJ_UINT32 mps
the Most Probable Symbol (0 or 1)
Definition mqc.h:62
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_state::nlps
const struct opj_mqc_state * nlps
next state if the next encoded symbol is the LPS
Definition mqc.h:66
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
MQ coder.
Definition mqc.h:74
opj_mqc::a
OPJ_UINT32 a
only used by MQ decoder
Definition mqc.h:78
opj_mqc::ctxs
const opj_mqc_state_t * ctxs[MQC_NUMCTXS]
Array of contexts.
Definition mqc.h:90
opj_mqc::bp
OPJ_BYTE * bp
pointer to the current position in the buffer
Definition mqc.h:84
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::end_of_byte_stream_counter
OPJ_UINT32 end_of_byte_stream_counter
Definition mqc.h:82
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::ct
OPJ_UINT32 ct
number of bits already read or free to write
Definition mqc.h:80
opj_mqc::end
OPJ_BYTE * end
pointer to the end of the buffer
Definition mqc.h:88
opj_mqc::lut_ctxno_zc_orient
const OPJ_BYTE * lut_ctxno_zc_orient
Definition mqc.h:94
opj_mqc::start
OPJ_BYTE * start
pointer to the start of the buffer
Definition mqc.h:86