* POSSIBILITY OF SUCH DAMAGE.
*/
-#ifndef __MQC_H
-#define __MQC_H
+#ifndef OPJ_MQC_H
+#define OPJ_MQC_H
+
+#include "opj_common.h"
+
/**
@file mqc.h
@brief Implementation of an MQ-Coder (MQC)
/** the Most Probable Symbol (0 or 1) */
OPJ_UINT32 mps;
/** next state if the next encoded symbol is the MPS */
- struct opj_mqc_state *nmps;
+ const struct opj_mqc_state *nmps;
/** next state if the next encoded symbol is the LPS */
- struct opj_mqc_state *nlps;
+ const struct opj_mqc_state *nlps;
} opj_mqc_state_t;
#define MQC_NUMCTXS 19
MQ coder
*/
typedef struct opj_mqc {
+ /** temporary buffer where bits are coded or decoded */
OPJ_UINT32 c;
+ /** only used by MQ decoder */
OPJ_UINT32 a;
+ /** number of bits already read or free to write */
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;
+ /** pointer to the current position in the buffer */
OPJ_BYTE *bp;
+ /** pointer to the start of the buffer */
OPJ_BYTE *start;
+ /** pointer to the end of the buffer */
OPJ_BYTE *end;
- opj_mqc_state_t *ctxs[MQC_NUMCTXS];
- opj_mqc_state_t **curctx;
+ /** Array of contexts */
+ const opj_mqc_state_t *ctxs[MQC_NUMCTXS];
+ /** Active context */
+ const opj_mqc_state_t **curctx;
/* lut_ctxno_zc shifted by (1 << 9) * bandno */
const OPJ_BYTE* lut_ctxno_zc_orient;
+ /** Original value of the 2 bytes at end[0] and end[1] */
+ OPJ_BYTE backup[OPJ_COMMON_CBLK_DATA_EXTRA];
} opj_mqc_t;
+#define BYPASS_CT_INIT 0xDEADBEEF
+
#include "mqc_inl.h"
/** @name Exported functions */
@param ctxno Number that identifies the context
*/
#define opj_mqc_setcurctx(mqc, ctxno) (mqc)->curctx = &(mqc)->ctxs[(OPJ_UINT32)(ctxno)]
-/**
-Encode a symbol using the MQ-coder
-@param mqc MQC handle
-@param d The symbol to be encoded (0 or 1)
-*/
-void opj_mqc_encode(opj_mqc_t *mqc, OPJ_UINT32 d);
+
/**
Flush the encoder, so that all remaining data is written
@param mqc MQC handle
/**
BYPASS mode switch, initialization operation.
JPEG 2000 p 505.
-<h2>Not fully implemented and tested !!</h2>
@param mqc MQC handle
*/
void opj_mqc_bypass_init_enc(opj_mqc_t *mqc);
+
+/** Return number of extra bytes to add to opj_mqc_numbytes() for theĀ²
+ size of a non-terminating BYPASS pass
+@param mqc MQC handle
+@param erterm 1 if ERTERM is enabled, 0 otherwise
+*/
+OPJ_UINT32 opj_mqc_bypass_get_extra_bytes(opj_mqc_t *mqc, OPJ_BOOL erterm);
+
/**
BYPASS mode switch, coding operation.
JPEG 2000 p 505.
-<h2>Not fully implemented and tested !!</h2>
@param mqc MQC handle
@param d The symbol to be encoded (0 or 1)
*/
void opj_mqc_bypass_enc(opj_mqc_t *mqc, OPJ_UINT32 d);
/**
BYPASS mode switch, flush operation
-<h2>Not fully implemented and tested !!</h2>
@param mqc MQC handle
-@return Returns 1 (always)
+@param erterm 1 if ERTERM is enabled, 0 otherwise
*/
-OPJ_UINT32 opj_mqc_bypass_flush_enc(opj_mqc_t *mqc);
+void opj_mqc_bypass_flush_enc(opj_mqc_t *mqc, OPJ_BOOL erterm);
/**
RESET mode switch
@param mqc MQC handle
*/
void opj_mqc_reset_enc(opj_mqc_t *mqc);
+
+#ifdef notdef
/**
RESTART mode switch (TERMALL)
@param mqc MQC handle
@return Returns 1 (always)
*/
OPJ_UINT32 opj_mqc_restart_enc(opj_mqc_t *mqc);
+#endif
+
/**
RESTART mode switch (TERMALL) reinitialisation
@param mqc MQC handle
@param mqc MQC handle
*/
void opj_mqc_segmark_enc(opj_mqc_t *mqc);
+
+/**
+Initialize the decoder for MQ decoding.
+
+opj_mqc_finish_dec() must be absolutely called after finishing the decoding
+passes, so as to restore the bytes temporarily overwritten.
+
+@param mqc MQC handle
+@param bp Pointer to the start of the buffer from which the bytes will be read
+ Note that OPJ_COMMON_CBLK_DATA_EXTRA bytes at the end of the buffer
+ will be temporarily overwritten with an artificial 0xFF 0xFF marker.
+ (they will be backuped in the mqc structure to be restored later)
+ So bp must be at least len + OPJ_COMMON_CBLK_DATA_EXTRA large, and
+ writable.
+@param len Length of the input buffer
+@param extra_writable_bytes Indicate how many bytes after len are writable.
+ This is to indicate your consent that bp must be
+ large enough.
+*/
+void opj_mqc_init_dec(opj_mqc_t *mqc, OPJ_BYTE *bp, OPJ_UINT32 len,
+ OPJ_UINT32 extra_writable_bytes);
+
/**
-Initialize the decoder
+Initialize the decoder for RAW decoding.
+
+opj_mqc_finish_dec() must be absolutely called after finishing the decoding
+passes, so as to restore the bytes temporarily overwritten.
+
@param mqc MQC handle
@param bp Pointer to the start of the buffer from which the bytes will be read
+ Note that OPJ_COMMON_CBLK_DATA_EXTRA bytes at the end of the buffer
+ will be temporarily overwritten with an artificial 0xFF 0xFF marker.
+ (they will be backuped in the mqc structure to be restored later)
+ So bp must be at least len + OPJ_COMMON_CBLK_DATA_EXTRA large, and
+ writable.
@param len Length of the input buffer
+@param extra_writable_bytes Indicate how many bytes after len are writable.
+ This is to indicate your consent that bp must be
+ large enough.
*/
-OPJ_BOOL opj_mqc_init_dec(opj_mqc_t *mqc, OPJ_BYTE *bp, OPJ_UINT32 len);
+void opj_mqc_raw_init_dec(opj_mqc_t *mqc, OPJ_BYTE *bp, OPJ_UINT32 len,
+ OPJ_UINT32 extra_writable_bytes);
+
+
+/**
+Terminate RAW/MQC decoding
+
+This restores the bytes temporarily overwritten by opj_mqc_init_dec()/
+opj_mqc_raw_init_dec()
+
+@param mqc MQC handle
+*/
+void opq_mqc_finish_dec(opj_mqc_t *mqc);
+
/**
Decode a symbol
@param mqc MQC handle
/*@}*/
-#endif /* __MQC_H */
+#endif /* OPJ_MQC_H */