OpenJPEG  2.2.0
Data Structures | Macros | Typedefs
T1 - Implementation of the tier-1 coding

Data Structures

struct  opj_t1
 Tier-1 coding (coding of code-block coefficients) More...
 

Macros

#define T1_FLAGS(x, y)   (t1->flags[x + 1 + ((y / 4) + 1) * (t1->w+2)])
 
#define opj_t1_setcurctx(curctx, ctxno)   curctx = &(mqc)->ctxs[(OPJ_UINT32)(ctxno)]
 
#define T1_NMSEDEC_BITS   7
 
#define T1_NUMCTXS_ZC   9
 
#define T1_NUMCTXS_SC   5
 
#define T1_NUMCTXS_MAG   3
 
#define T1_NUMCTXS_AGG   1
 
#define T1_NUMCTXS_UNI   1
 
#define T1_CTXNO_ZC   0
 
#define T1_CTXNO_SC   (T1_CTXNO_ZC+T1_NUMCTXS_ZC)
 
#define T1_CTXNO_MAG   (T1_CTXNO_SC+T1_NUMCTXS_SC)
 
#define T1_CTXNO_AGG   (T1_CTXNO_MAG+T1_NUMCTXS_MAG)
 
#define T1_CTXNO_UNI   (T1_CTXNO_AGG+T1_NUMCTXS_AGG)
 
#define T1_NUMCTXS   (T1_CTXNO_UNI+T1_NUMCTXS_UNI)
 
#define T1_NMSEDEC_FRACBITS   (T1_NMSEDEC_BITS-1)
 
#define T1_TYPE_MQ   0
 Normal coding using entropy coder. More...
 
#define T1_TYPE_RAW   1
 No encoding the information is store under raw format in codestream (mode switch RAW) More...
 
#define T1_SIGMA_0   (1U << 0)
 We hold the state of individual data points for the T1 encoder using a single 32-bit flags word to hold the state of 4 data points. More...
 
#define T1_SIGMA_1   (1U << 1)
 
#define T1_SIGMA_2   (1U << 2)
 
#define T1_SIGMA_3   (1U << 3)
 
#define T1_SIGMA_4   (1U << 4)
 
#define T1_SIGMA_5   (1U << 5)
 
#define T1_SIGMA_6   (1U << 6)
 
#define T1_SIGMA_7   (1U << 7)
 
#define T1_SIGMA_8   (1U << 8)
 
#define T1_SIGMA_9   (1U << 9)
 
#define T1_SIGMA_10   (1U << 10)
 
#define T1_SIGMA_11   (1U << 11)
 
#define T1_SIGMA_12   (1U << 12)
 
#define T1_SIGMA_13   (1U << 13)
 
#define T1_SIGMA_14   (1U << 14)
 
#define T1_SIGMA_15   (1U << 15)
 
#define T1_SIGMA_16   (1U << 16)
 
#define T1_SIGMA_17   (1U << 17)
 
#define T1_CHI_0   (1U << 18)
 
#define T1_CHI_0_I   18
 
#define T1_CHI_1   (1U << 19)
 
#define T1_CHI_1_I   19
 
#define T1_MU_0   (1U << 20)
 
#define T1_PI_0   (1U << 21)
 
#define T1_CHI_2   (1U << 22)
 
#define T1_CHI_2_I   22
 
#define T1_MU_1   (1U << 23)
 
#define T1_PI_1   (1U << 24)
 
#define T1_CHI_3   (1U << 25)
 
#define T1_MU_2   (1U << 26)
 
#define T1_PI_2   (1U << 27)
 
#define T1_CHI_4   (1U << 28)
 
#define T1_MU_3   (1U << 29)
 
#define T1_PI_3   (1U << 30)
 
#define T1_CHI_5   (1U << 31)
 
#define T1_CHI_5_I   31
 
#define T1_SIGMA_NW   T1_SIGMA_0
 As an example, the bits T1_SIGMA_3, T1_SIGMA_4 and T1_SIGMA_5 indicate the significance state of the west neighbour of data point zero of our four, the point itself, and its east neighbour respectively. More...
 
#define T1_SIGMA_N   T1_SIGMA_1
 
#define T1_SIGMA_NE   T1_SIGMA_2
 
#define T1_SIGMA_W   T1_SIGMA_3
 
#define T1_SIGMA_THIS   T1_SIGMA_4
 
#define T1_SIGMA_E   T1_SIGMA_5
 
#define T1_SIGMA_SW   T1_SIGMA_6
 
#define T1_SIGMA_S   T1_SIGMA_7
 
#define T1_SIGMA_SE   T1_SIGMA_8
 
#define T1_SIGMA_NEIGHBOURS   (T1_SIGMA_NW | T1_SIGMA_N | T1_SIGMA_NE | T1_SIGMA_W | T1_SIGMA_E | T1_SIGMA_SW | T1_SIGMA_S | T1_SIGMA_SE)
 
#define T1_CHI_THIS   T1_CHI_1
 
#define T1_CHI_THIS_I   T1_CHI_1_I
 
#define T1_MU_THIS   T1_MU_0
 
#define T1_PI_THIS   T1_PI_0
 
#define T1_CHI_S   T1_CHI_2
 
#define T1_LUT_SGN_W   (1U << 0)
 
#define T1_LUT_SIG_N   (1U << 1)
 
#define T1_LUT_SGN_E   (1U << 2)
 
#define T1_LUT_SIG_W   (1U << 3)
 
#define T1_LUT_SGN_N   (1U << 4)
 
#define T1_LUT_SIG_E   (1U << 5)
 
#define T1_LUT_SGN_S   (1U << 6)
 
#define T1_LUT_SIG_S   (1U << 7)
 

Typedefs

typedef OPJ_UINT32 opj_flag_t
 Flags for 4 consecutive rows of a column. More...
 
typedef struct opj_t1 opj_t1_t
 Tier-1 coding (coding of code-block coefficients) More...
 

Local static functions

static INLINE OPJ_BYTE opj_t1_getctxno_zc (opj_mqc_t *mqc, OPJ_UINT32 f)
 
static INLINE OPJ_UINT32 opj_t1_getctxno_mag (OPJ_UINT32 f)
 
static OPJ_INT16 opj_t1_getnmsedec_sig (OPJ_UINT32 x, OPJ_UINT32 bitpos)
 
static OPJ_INT16 opj_t1_getnmsedec_ref (OPJ_UINT32 x, OPJ_UINT32 bitpos)
 
static INLINE void opj_t1_update_flags (opj_flag_t *flagsp, OPJ_UINT32 ci, OPJ_UINT32 s, OPJ_UINT32 stride, OPJ_UINT32 vsc)
 
static INLINE void opj_t1_dec_sigpass_step_raw (opj_t1_t *t1, opj_flag_t *flagsp, OPJ_INT32 *datap, OPJ_INT32 oneplushalf, OPJ_UINT32 vsc, OPJ_UINT32 row)
 Decode significant pass. More...
 
static INLINE void opj_t1_dec_sigpass_step_mqc (opj_t1_t *t1, opj_flag_t *flagsp, OPJ_INT32 *datap, OPJ_INT32 oneplushalf, OPJ_UINT32 row, OPJ_UINT32 flags_stride, OPJ_UINT32 vsc)
 
static void opj_t1_enc_sigpass (opj_t1_t *t1, OPJ_INT32 bpno, OPJ_INT32 *nmsedec, OPJ_BYTE type, OPJ_UINT32 cblksty)
 Encode significant pass. More...
 
static void opj_t1_dec_sigpass_raw (opj_t1_t *t1, OPJ_INT32 bpno, OPJ_INT32 cblksty)
 Decode significant pass. More...
 
static void opj_t1_enc_refpass (opj_t1_t *t1, OPJ_INT32 bpno, OPJ_INT32 *nmsedec, OPJ_BYTE type)
 Encode refinement pass. More...
 
static void opj_t1_dec_refpass_raw (opj_t1_t *t1, OPJ_INT32 bpno)
 Decode refinement pass. More...
 
static INLINE void opj_t1_dec_refpass_step_raw (opj_t1_t *t1, opj_flag_t *flagsp, OPJ_INT32 *datap, OPJ_INT32 poshalf, OPJ_UINT32 row)
 Decode refinement pass. More...
 
static INLINE void opj_t1_dec_refpass_step_mqc (opj_t1_t *t1, opj_flag_t *flagsp, OPJ_INT32 *datap, OPJ_INT32 poshalf, OPJ_UINT32 row)
 
static void opj_t1_dec_clnpass_step (opj_t1_t *t1, opj_flag_t *flagsp, OPJ_INT32 *datap, OPJ_INT32 oneplushalf, OPJ_UINT32 row, OPJ_UINT32 vsc)
 Decode clean-up pass. More...
 
static void opj_t1_enc_clnpass (opj_t1_t *t1, OPJ_INT32 bpno, OPJ_INT32 *nmsedec, OPJ_UINT32 cblksty)
 Encode clean-up pass. More...
 
static OPJ_FLOAT64 opj_t1_getwmsedec (OPJ_INT32 nmsedec, OPJ_UINT32 compno, OPJ_UINT32 level, OPJ_UINT32 orient, OPJ_INT32 bpno, OPJ_UINT32 qmfbid, OPJ_FLOAT64 stepsize, OPJ_UINT32 numcomps, const OPJ_FLOAT64 *mct_norms, OPJ_UINT32 mct_numcomps)
 mod fixed_quality More...
 
static void opj_t1_encode_cblk (opj_t1_t *t1, opj_tcd_cblk_enc_t *cblk, OPJ_UINT32 orient, OPJ_UINT32 compno, OPJ_UINT32 level, OPJ_UINT32 qmfbid, OPJ_FLOAT64 stepsize, OPJ_UINT32 cblksty, OPJ_UINT32 numcomps, opj_tcd_tile_t *tile, const OPJ_FLOAT64 *mct_norms, OPJ_UINT32 mct_numcomps)
 mod fixed_quality More...
 
static OPJ_BOOL opj_t1_decode_cblk (opj_t1_t *t1, opj_tcd_cblk_dec_t *cblk, OPJ_UINT32 orient, OPJ_UINT32 roishift, OPJ_UINT32 cblksty, opj_event_mgr_t *p_manager, opj_mutex_t *p_manager_mutex, OPJ_BOOL check_pterm)
 Decode 1 code-block. More...
 
static OPJ_BOOL opj_t1_allocate_buffers (opj_t1_t *t1, OPJ_UINT32 w, OPJ_UINT32 h)
 

Exported functions

OPJ_BOOL opj_t1_encode_cblks (opj_t1_t *t1, opj_tcd_tile_t *tile, opj_tcp_t *tcp, const OPJ_FLOAT64 *mct_norms, OPJ_UINT32 mct_numcomps)
 Encode the code-blocks of a tile. More...
 
void opj_t1_decode_cblks (opj_thread_pool_t *tp, volatile OPJ_BOOL *pret, opj_tcd_tilecomp_t *tilec, opj_tccp_t *tccp, opj_event_mgr_t *p_manager, opj_mutex_t *p_manager_mutex, OPJ_BOOL check_pterm)
 Decode the code-blocks of a tile. More...
 
opj_t1_topj_t1_create (OPJ_BOOL isEncoder)
 Creates a new Tier 1 handle and initializes the look-up tables of the Tier-1 coder/decoder. More...
 
void opj_t1_destroy (opj_t1_t *p_t1)
 Destroys a previously created T1 handle. More...
 

Detailed Description

Macro Definition Documentation

#define opj_t1_setcurctx (   curctx,
  ctxno 
)    curctx = &(mqc)->ctxs[(OPJ_UINT32)(ctxno)]
#define T1_CHI_0   (1U << 18)
#define T1_CHI_0_I   18
#define T1_CHI_1   (1U << 19)
#define T1_CHI_1_I   19
#define T1_CHI_2   (1U << 22)
#define T1_CHI_2_I   22
#define T1_CHI_3   (1U << 25)
#define T1_CHI_4   (1U << 28)
#define T1_CHI_5   (1U << 31)
#define T1_CHI_5_I   31
#define T1_CHI_S   T1_CHI_2
#define T1_CHI_THIS   T1_CHI_1
#define T1_CHI_THIS_I   T1_CHI_1_I
#define T1_CTXNO_AGG   (T1_CTXNO_MAG+T1_NUMCTXS_MAG)
#define T1_CTXNO_MAG   (T1_CTXNO_SC+T1_NUMCTXS_SC)

Referenced by opj_t1_getctxno_mag().

#define T1_CTXNO_SC   (T1_CTXNO_ZC+T1_NUMCTXS_ZC)

Referenced by t1_init_ctxno_sc().

#define T1_CTXNO_UNI   (T1_CTXNO_AGG+T1_NUMCTXS_AGG)
#define T1_CTXNO_ZC   0
#define T1_FLAGS (   x,
 
)    (t1->flags[x + 1 + ((y / 4) + 1) * (t1->w+2)])
#define T1_LUT_SGN_E   (1U << 2)

Referenced by t1_init_ctxno_sc(), and t1_init_spb().

#define T1_LUT_SGN_N   (1U << 4)

Referenced by t1_init_ctxno_sc(), and t1_init_spb().

#define T1_LUT_SGN_S   (1U << 6)

Referenced by t1_init_ctxno_sc(), and t1_init_spb().

#define T1_LUT_SGN_W   (1U << 0)

Referenced by t1_init_ctxno_sc(), and t1_init_spb().

#define T1_LUT_SIG_E   (1U << 5)

Referenced by t1_init_ctxno_sc(), and t1_init_spb().

#define T1_LUT_SIG_N   (1U << 1)

Referenced by t1_init_ctxno_sc(), and t1_init_spb().

#define T1_LUT_SIG_S   (1U << 7)

Referenced by t1_init_ctxno_sc(), and t1_init_spb().

#define T1_LUT_SIG_W   (1U << 3)

Referenced by t1_init_ctxno_sc(), and t1_init_spb().

#define T1_MU_0   (1U << 20)

Referenced by opj_t1_getctxno_mag().

#define T1_MU_1   (1U << 23)
#define T1_MU_2   (1U << 26)
#define T1_MU_3   (1U << 29)
#define T1_MU_THIS   T1_MU_0
#define T1_NMSEDEC_BITS   7
#define T1_NMSEDEC_FRACBITS   (T1_NMSEDEC_BITS-1)
#define T1_NUMCTXS   (T1_CTXNO_UNI+T1_NUMCTXS_UNI)
#define T1_NUMCTXS_AGG   1
#define T1_NUMCTXS_MAG   3
#define T1_NUMCTXS_SC   5
#define T1_NUMCTXS_UNI   1
#define T1_NUMCTXS_ZC   9
#define T1_PI_0   (1U << 21)
#define T1_PI_1   (1U << 24)
#define T1_PI_2   (1U << 27)
#define T1_PI_3   (1U << 30)
#define T1_PI_THIS   T1_PI_0
#define T1_SIGMA_0   (1U << 0)

We hold the state of individual data points for the T1 encoder using a single 32-bit flags word to hold the state of 4 data points.

This corresponds to the 4-point-high columns that the data is processed in.

These #defines declare the layout of a 32-bit flags word.

This is currently done for encoding only. The values must NOT be changed, otherwise this is going to break a lot of assumptions.

Referenced by t1_init_ctxno_zc().

#define T1_SIGMA_1   (1U << 1)
#define T1_SIGMA_10   (1U << 10)
#define T1_SIGMA_11   (1U << 11)
#define T1_SIGMA_12   (1U << 12)
#define T1_SIGMA_13   (1U << 13)
#define T1_SIGMA_14   (1U << 14)
#define T1_SIGMA_15   (1U << 15)
#define T1_SIGMA_16   (1U << 16)
#define T1_SIGMA_17   (1U << 17)
#define T1_SIGMA_2   (1U << 2)

Referenced by t1_init_ctxno_zc().

#define T1_SIGMA_3   (1U << 3)
#define T1_SIGMA_4   (1U << 4)
#define T1_SIGMA_5   (1U << 5)
#define T1_SIGMA_6   (1U << 6)

Referenced by t1_init_ctxno_zc().

#define T1_SIGMA_7   (1U << 7)
#define T1_SIGMA_8   (1U << 8)

Referenced by t1_init_ctxno_zc().

#define T1_SIGMA_9   (1U << 9)
#define T1_SIGMA_E   T1_SIGMA_5
#define T1_SIGMA_N   T1_SIGMA_1
#define T1_SIGMA_NE   T1_SIGMA_2
#define T1_SIGMA_NEIGHBOURS   (T1_SIGMA_NW | T1_SIGMA_N | T1_SIGMA_NE | T1_SIGMA_W | T1_SIGMA_E | T1_SIGMA_SW | T1_SIGMA_S | T1_SIGMA_SE)
#define T1_SIGMA_NW   T1_SIGMA_0

As an example, the bits T1_SIGMA_3, T1_SIGMA_4 and T1_SIGMA_5 indicate the significance state of the west neighbour of data point zero of our four, the point itself, and its east neighbour respectively.

Many of the bits are arranged so that given a flags word, you can look at the values for the data point 0, then shift the flags word right by 3 bits and look at the same bit positions to see the values for data point 1.

The #defines below help a bit with this; say you have a flags word f, you can do things like

(f & T1_SIGMA_THIS)

to see the significance bit of data point 0, then do

((f >> 3) & T1_SIGMA_THIS)

to see the significance bit of data point 1.

#define T1_SIGMA_S   T1_SIGMA_7
#define T1_SIGMA_SE   T1_SIGMA_8
#define T1_SIGMA_SW   T1_SIGMA_6
#define T1_SIGMA_THIS   T1_SIGMA_4
#define T1_SIGMA_W   T1_SIGMA_3
#define T1_TYPE_MQ   0

Normal coding using entropy coder.

Referenced by opj_t1_decode_cblk(), and opj_t1_encode_cblk().

#define T1_TYPE_RAW   1

No encoding the information is store under raw format in codestream (mode switch RAW)

Referenced by opj_t1_decode_cblk(), opj_t1_enc_refpass_step(), opj_t1_enc_sigpass_step(), and opj_t1_encode_cblk().

Typedef Documentation

Flags for 4 consecutive rows of a column.

typedef struct opj_t1 opj_t1_t

Tier-1 coding (coding of code-block coefficients)

Function Documentation

static OPJ_BOOL opj_t1_allocate_buffers ( opj_t1_t t1,
OPJ_UINT32  w,
OPJ_UINT32  h 
)
static
opj_t1_t* opj_t1_create ( OPJ_BOOL  isEncoder)

Creates a new Tier 1 handle and initializes the look-up tables of the Tier-1 coder/decoder.

Returns
a new T1 handle if successful, returns NULL otherwise

References opj_t1::encoder, and opj_calloc().

Referenced by opj_t1_clbl_decode_processor(), and opj_tcd_t1_encode().

static void opj_t1_dec_clnpass_step ( opj_t1_t t1,
opj_flag_t flagsp,
OPJ_INT32 datap,
OPJ_INT32  oneplushalf,
OPJ_UINT32  row,
OPJ_UINT32  vsc 
)
static
static void opj_t1_dec_refpass_raw ( opj_t1_t t1,
OPJ_INT32  bpno 
)
static

Decode refinement pass.

References opj_t1::data, opj_t1::h, opj_t1_dec_refpass_step_raw(), T1_FLAGS, and opj_t1::w.

Referenced by opj_t1_decode_cblk().

static INLINE void opj_t1_dec_refpass_step_mqc ( opj_t1_t t1,
opj_flag_t flagsp,
OPJ_INT32 datap,
OPJ_INT32  poshalf,
OPJ_UINT32  row 
)
static
static INLINE void opj_t1_dec_refpass_step_raw ( opj_t1_t t1,
opj_flag_t flagsp,
OPJ_INT32 datap,
OPJ_INT32  poshalf,
OPJ_UINT32  row 
)
static

Decode refinement pass.

References opj_t1::mqc, opj_mqc_raw_decode(), T1_MU_THIS, T1_PI_THIS, and T1_SIGMA_THIS.

Referenced by opj_t1_dec_refpass_raw().

static void opj_t1_dec_sigpass_raw ( opj_t1_t t1,
OPJ_INT32  bpno,
OPJ_INT32  cblksty 
)
static
static INLINE void opj_t1_dec_sigpass_step_mqc ( opj_t1_t t1,
opj_flag_t flagsp,
OPJ_INT32 datap,
OPJ_INT32  oneplushalf,
OPJ_UINT32  row,
OPJ_UINT32  flags_stride,
OPJ_UINT32  vsc 
)
static
static INLINE void opj_t1_dec_sigpass_step_raw ( opj_t1_t t1,
opj_flag_t flagsp,
OPJ_INT32 datap,
OPJ_INT32  oneplushalf,
OPJ_UINT32  vsc,
OPJ_UINT32  row 
)
static
static OPJ_BOOL opj_t1_decode_cblk ( opj_t1_t t1,
opj_tcd_cblk_dec_t cblk,
OPJ_UINT32  orient,
OPJ_UINT32  roishift,
OPJ_UINT32  cblksty,
opj_event_mgr_t p_manager,
opj_mutex_t p_manager_mutex,
OPJ_BOOL  check_pterm 
)
static
void opj_t1_decode_cblks ( opj_thread_pool_t tp,
volatile OPJ_BOOL pret,
opj_tcd_tilecomp_t tilec,
opj_tccp_t tccp,
opj_event_mgr_t p_manager,
opj_mutex_t p_manager_mutex,
OPJ_BOOL  check_pterm 
)
void opj_t1_destroy ( opj_t1_t p_t1)

Destroys a previously created T1 handle.

Parameters
p_t1Tier 1 handle to destroy

References opj_t1::cblkdatabuffer, opj_t1::data, opj_t1::encoder, opj_t1::flags, opj_aligned_free(), and opj_free().

Referenced by opj_t1_destroy_wrapper(), and opj_tcd_t1_encode().

static void opj_t1_enc_clnpass ( opj_t1_t t1,
OPJ_INT32  bpno,
OPJ_INT32 nmsedec,
OPJ_UINT32  cblksty 
)
static
static void opj_t1_enc_refpass ( opj_t1_t t1,
OPJ_INT32  bpno,
OPJ_INT32 nmsedec,
OPJ_BYTE  type 
)
static
static void opj_t1_enc_sigpass ( opj_t1_t t1,
OPJ_INT32  bpno,
OPJ_INT32 nmsedec,
OPJ_BYTE  type,
OPJ_UINT32  cblksty 
)
static
static void opj_t1_encode_cblk ( opj_t1_t t1,
opj_tcd_cblk_enc_t cblk,
OPJ_UINT32  orient,
OPJ_UINT32  compno,
OPJ_UINT32  level,
OPJ_UINT32  qmfbid,
OPJ_FLOAT64  stepsize,
OPJ_UINT32  cblksty,
OPJ_UINT32  numcomps,
opj_tcd_tile_t tile,
const OPJ_FLOAT64 mct_norms,
OPJ_UINT32  mct_numcomps 
)
static
OPJ_BOOL opj_t1_encode_cblks ( opj_t1_t t1,
opj_tcd_tile_t tile,
opj_tcp_t tcp,
const OPJ_FLOAT64 mct_norms,
OPJ_UINT32  mct_numcomps 
)
static INLINE OPJ_UINT32 opj_t1_getctxno_mag ( OPJ_UINT32  f)
static
static INLINE OPJ_BYTE opj_t1_getctxno_zc ( opj_mqc_t mqc,
OPJ_UINT32  f 
)
static
static OPJ_INT16 opj_t1_getnmsedec_ref ( OPJ_UINT32  x,
OPJ_UINT32  bitpos 
)
static
static OPJ_INT16 opj_t1_getnmsedec_sig ( OPJ_UINT32  x,
OPJ_UINT32  bitpos 
)
static
static OPJ_FLOAT64 opj_t1_getwmsedec ( OPJ_INT32  nmsedec,
OPJ_UINT32  compno,
OPJ_UINT32  level,
OPJ_UINT32  orient,
OPJ_INT32  bpno,
OPJ_UINT32  qmfbid,
OPJ_FLOAT64  stepsize,
OPJ_UINT32  numcomps,
const OPJ_FLOAT64 mct_norms,
OPJ_UINT32  mct_numcomps 
)
static

mod fixed_quality

References OPJ_ARG_NOT_USED, opj_dwt_getnorm(), and opj_dwt_getnorm_real().

Referenced by opj_t1_encode_cblk().

static INLINE void opj_t1_update_flags ( opj_flag_t flagsp,
OPJ_UINT32  ci,
OPJ_UINT32  s,
OPJ_UINT32  stride,
OPJ_UINT32  vsc 
)
static