tcd.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, 2011-2012, Centre National d'Etudes Spatiales (CNES), FR 
 * Copyright (c) 2012, CS Systemes d'Information, France
 * 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 __TCD_H
#define __TCD_H


typedef struct opj_tcd_seg {
        OPJ_BYTE ** data;
        OPJ_UINT32 dataindex;
        OPJ_UINT32 numpasses;
        OPJ_UINT32 real_num_passes;
        OPJ_UINT32 len;
        OPJ_UINT32 maxpasses;
        OPJ_UINT32 numnewpasses;
        OPJ_UINT32 newlen;
} opj_tcd_seg_t;

typedef struct opj_tcd_pass {
        OPJ_UINT32 rate;
        OPJ_FLOAT64 distortiondec;
        OPJ_UINT32 len;
        OPJ_UINT32 term : 1;
} opj_tcd_pass_t;

typedef struct opj_tcd_layer {
        OPJ_UINT32 numpasses;           /* Number of passes in the layer */
        OPJ_UINT32 len;                         /* len of information */
        OPJ_FLOAT64 disto;                      /* add for index (Cfr. Marcela) */
        OPJ_BYTE *data;                         /* data */
} opj_tcd_layer_t;

typedef struct opj_tcd_cblk_enc {
        OPJ_BYTE* data;               /* Data */
        opj_tcd_layer_t* layers;      /* layer information */
        opj_tcd_pass_t* passes;       /* information about the passes */
        OPJ_INT32 x0, y0, x1, y1;     /* dimension of the code-blocks : left upper corner (x0, y0) right low corner (x1,y1) */
        OPJ_UINT32 numbps;
        OPJ_UINT32 numlenbits;
        OPJ_UINT32 data_size;         /* Size of allocated data buffer */
        OPJ_UINT32 numpasses;         /* number of pass already done for the code-blocks */
        OPJ_UINT32 numpassesinlayers; /* number of passes in the layer */
        OPJ_UINT32 totalpasses;       /* total number of passes */
} opj_tcd_cblk_enc_t;


typedef struct opj_tcd_cblk_dec {
        OPJ_BYTE * data;                                /* Data */
        opj_tcd_seg_t* segs;                    /* segments information */
        OPJ_INT32 x0, y0, x1, y1;               /* position of the code-blocks : left upper corner (x0, y0) right low corner (x1,y1) */
        OPJ_UINT32 numbps;
        OPJ_UINT32 numlenbits;
        OPJ_UINT32 data_max_size;               /* Size of allocated data buffer */
        OPJ_UINT32 data_current_size;   /* Size of used data buffer */
        OPJ_UINT32 numnewpasses;                /* number of pass added to the code-blocks */
        OPJ_UINT32 numsegs;                             /* number of segments */
        OPJ_UINT32 real_num_segs;
        OPJ_UINT32 m_current_max_segs;
} opj_tcd_cblk_dec_t;

typedef struct opj_tcd_precinct {
        OPJ_INT32 x0, y0, x1, y1;               /* dimension of the precinct : left upper corner (x0, y0) right low corner (x1,y1) */
        OPJ_UINT32 cw, ch;                              /* number of precinct in width and height */
        union{                                                  /* code-blocks information */
                opj_tcd_cblk_enc_t* enc;
                opj_tcd_cblk_dec_t* dec;
                void*               blocks;
        } cblks;
        OPJ_UINT32 block_size;                  /* size taken by cblks (in bytes) */
        opj_tgt_tree_t *incltree;           /* inclusion tree */
        opj_tgt_tree_t *imsbtree;           /* IMSB tree */
} opj_tcd_precinct_t;

typedef struct opj_tcd_band {
        OPJ_INT32 x0, y0, x1, y1;               /* dimension of the subband : left upper corner (x0, y0) right low corner (x1,y1) */
        OPJ_UINT32 bandno;
        opj_tcd_precinct_t *precincts;  /* precinct information */
        OPJ_UINT32 precincts_data_size; /* size of data taken by precincts */
        OPJ_INT32 numbps;
        OPJ_FLOAT32 stepsize;
} opj_tcd_band_t;

typedef struct opj_tcd_resolution {
        OPJ_INT32 x0, y0, x1, y1;               /* dimension of the resolution level : left upper corner (x0, y0) right low corner (x1,y1) */
        OPJ_UINT32 pw, ph;
        OPJ_UINT32 numbands;                    /* number sub-band for the resolution level */
        opj_tcd_band_t bands[3];                /* subband information */
} opj_tcd_resolution_t;

typedef struct opj_tcd_tilecomp
{
        OPJ_INT32 x0, y0, x1, y1;           /* dimension of component : left upper corner (x0, y0) right low corner (x1,y1) */
        OPJ_UINT32 numresolutions;          /* number of resolutions level */
        OPJ_UINT32 minimum_num_resolutions; /* number of resolutions level to decode (at max)*/
        opj_tcd_resolution_t *resolutions;  /* resolutions information */
        OPJ_UINT32 resolutions_size;        /* size of data for resolutions (in bytes) */
        OPJ_INT32 *data;                    /* data of the component */
        OPJ_BOOL  ownsData;                 /* if true, then need to free after usage, otherwise do not free */
        OPJ_UINT32 data_size_needed;        /* we may either need to allocate this amount of data, or re-use image data and ignore this value */
        OPJ_UINT32 data_size;               /* size of the data of the component */
        OPJ_INT32 numpix;                   /* add fixed_quality */
} opj_tcd_tilecomp_t;


typedef struct opj_tcd_tile {
        OPJ_INT32 x0, y0, x1, y1;               /* dimension of the tile : left upper corner (x0, y0) right low corner (x1,y1) */
        OPJ_UINT32 numcomps;                    /* number of components in tile */
        opj_tcd_tilecomp_t *comps;      /* Components information */
        OPJ_INT32 numpix;                               /* add fixed_quality */
        OPJ_FLOAT64 distotile;                  /* add fixed_quality */
        OPJ_FLOAT64 distolayer[100];    /* add fixed_quality */
        OPJ_UINT32 packno;              /* packet number */
} opj_tcd_tile_t;

typedef struct opj_tcd_image
{
        opj_tcd_tile_t *tiles;          /* Tiles information */
}
opj_tcd_image_t;


typedef struct opj_tcd
{
        OPJ_INT32 tp_pos;
        OPJ_UINT32 tp_num;
        OPJ_UINT32 cur_tp_num;
        OPJ_UINT32 cur_totnum_tp;
        OPJ_UINT32 cur_pino;
        opj_tcd_image_t *tcd_image;
        opj_image_t *image;
        opj_cp_t *cp;
        opj_tcp_t *tcp;
        OPJ_UINT32 tcd_tileno;
        OPJ_UINT32 m_is_decoder : 1;
} opj_tcd_t;

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

/*void tcd_dump(FILE *fd, opj_tcd_t *tcd, opj_tcd_image_t *img);*/ /* TODO MSD shoul use the new v2 structures */ 

opj_tcd_t* opj_tcd_create(OPJ_BOOL p_is_decoder);

void opj_tcd_destroy(opj_tcd_t *tcd);

OPJ_BOOL opj_tcd_init(  opj_tcd_t *p_tcd,
                                                opj_image_t * p_image,
                                                opj_cp_t * p_cp );

OPJ_BOOL opj_tcd_init_decode_tile(opj_tcd_t *p_tcd, OPJ_UINT32 p_tile_no);

void opj_tcd_makelayer_fixed(opj_tcd_t *tcd, OPJ_UINT32 layno, OPJ_UINT32 final);

void opj_tcd_rateallocate_fixed(opj_tcd_t *tcd);

void opj_tcd_makelayer( opj_tcd_t *tcd,
                                                OPJ_UINT32 layno,
                                                OPJ_FLOAT64 thresh,
                                                OPJ_UINT32 final);

OPJ_BOOL opj_tcd_rateallocate(  opj_tcd_t *tcd,
                                                                OPJ_BYTE *dest,
                                                                OPJ_UINT32 * p_data_written,
                                                                OPJ_UINT32 len,
                                                                opj_codestream_info_t *cstr_info);

OPJ_UINT32 opj_tcd_get_decoded_tile_size (opj_tcd_t *p_tcd );

OPJ_BOOL opj_tcd_encode_tile(   opj_tcd_t *p_tcd,
                                                            OPJ_UINT32 p_tile_no,
                                                            OPJ_BYTE *p_dest,
                                                            OPJ_UINT32 * p_data_written,
                                                            OPJ_UINT32 p_len,
                                                            struct opj_codestream_info *p_cstr_info);


OPJ_BOOL opj_tcd_decode_tile(   opj_tcd_t *tcd,
                                                            OPJ_BYTE *src,
                                                            OPJ_UINT32 len,
                                                            OPJ_UINT32 tileno,
                                                            opj_codestream_index_t *cstr_info);


OPJ_BOOL opj_tcd_update_tile_data (     opj_tcd_t *p_tcd,
                                                                    OPJ_BYTE * p_dest,
                                                                    OPJ_UINT32 p_dest_length );

OPJ_UINT32 opj_tcd_get_encoded_tile_size ( opj_tcd_t *p_tcd );

OPJ_BOOL opj_tcd_init_encode_tile (     opj_tcd_t *p_tcd,
                                                                    OPJ_UINT32 p_tile_no );

OPJ_BOOL opj_tcd_copy_tile_data (opj_tcd_t *p_tcd,
                                 OPJ_BYTE * p_src,
                                 OPJ_UINT32 p_src_length );

OPJ_BOOL opj_alloc_tile_component_data(opj_tcd_tilecomp_t *l_tilec);

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

#endif /* __TCD_H */