doxygen/t1_8h_source.html

/*

 * 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) 2012, Carl Hetherington

 * Copyright (c) 2017, IntoPIX SA <support@intopix.com>

 * 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_T1_H

#define OPJ_T1_H


/* ----------------------------------------------------------------------- */

#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

#define T1_TYPE_RAW 1

/* BEGINNING of flags that apply to opj_flag_t */


/* SIGMA: significance state (3 cols x 6 rows)

 * CHI:   state for negative sample value (1 col x 6 rows)

 * MU:    state for visited in refinement pass (1 col x 4 rows)

 * PI:    state for visited in significance pass (1 col * 4 rows)

 */


#define T1_SIGMA_0  (1U << 0)

#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

#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)

/* END of flags that apply to opj_flag_t */


/* ----------------------------------------------------------------------- */


typedef OPJ_UINT32 opj_flag_t;


typedef struct opj_t1 {


    opj_mqc_t mqc;


    OPJ_INT32  *data;

    opj_flag_t *flags;


    OPJ_UINT32 w;

    OPJ_UINT32 h;

    OPJ_UINT32 datasize;

    OPJ_UINT32 flagssize;

    OPJ_BOOL   encoder;


    /* The 3 variables below are only used by the decoder */

    /* set to TRUE in multithreaded context */

    OPJ_BOOL     mustuse_cblkdatabuffer;

    /* Temporary buffer to concatenate all chunks of a codebock */

    OPJ_BYTE    *cblkdatabuffer;

    /* Maximum size available in cblkdatabuffer */

    OPJ_UINT32   cblkdatabuffersize;

} opj_t1_t;


/* ----------------------------------------------------------------------- */


OPJ_BOOL opj_t1_encode_cblks(opj_tcd_t* tcd,

                             opj_tcd_tile_t *tile,

                             opj_tcp_t *tcp,

                             const OPJ_FLOAT64 * mct_norms,

                             OPJ_UINT32 mct_numcomps);


void opj_t1_decode_cblks(opj_tcd_t* tcd,

                         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);


opj_t1_t* opj_t1_create(OPJ_BOOL isEncoder);


void opj_t1_destroy(opj_t1_t *p_t1);

/* ----------------------------------------------------------------------- */


#endif /* OPJ_T1_H */