Logo Search packages:      
Sourcecode: gdcm version File versions

j2k.h

/*
 * Copyright (c) 2001-2003, David Janssens
 * Copyright (c) 2002-2003, Yannick Verschueren
 * Copyright (c) 2003-2005, Francois Devaux and Antonin Descampe
 * Copyright (c) 2005, Hervé Drolon, FreeImage Team
 * Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium
 * 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 __J2K_H
#define __J2K_H
/**
@file j2k.h
@brief The JPEG-2000 Codestream Reader/Writer (J2K)

The functions in J2K.C have for goal to read/write the several parts of the codestream: markers and data.
*/

/** @defgroup J2K J2K - JPEG-2000 codestream reader/writer */
/*@{*/

#define J2K_CP_CSTY_PRT 0x01
#define J2K_CP_CSTY_SOP 0x02
#define J2K_CP_CSTY_EPH 0x04
#define J2K_CCP_CSTY_PRT 0x01
#define J2K_CCP_CBLKSTY_LAZY 0x01
#define J2K_CCP_CBLKSTY_RESET 0x02
#define J2K_CCP_CBLKSTY_TERMALL 0x04
#define J2K_CCP_CBLKSTY_VSC 0x08
#define J2K_CCP_CBLKSTY_PTERM 0x10
#define J2K_CCP_CBLKSTY_SEGSYM 0x20
#define J2K_CCP_QNTSTY_NOQNT 0
#define J2K_CCP_QNTSTY_SIQNT 1
#define J2K_CCP_QNTSTY_SEQNT 2

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

00058 #define J2K_MS_SOC 0xff4f     /**< SOC marker value */
00059 #define J2K_MS_SOT 0xff90     /**< SOT marker value */
00060 #define J2K_MS_SOD 0xff93     /**< SOD marker value */
00061 #define J2K_MS_EOC 0xffd9     /**< EOC marker value */
00062 #define J2K_MS_SIZ 0xff51     /**< SIZ marker value */
00063 #define J2K_MS_COD 0xff52     /**< COD marker value */
00064 #define J2K_MS_COC 0xff53     /**< COC marker value */
00065 #define J2K_MS_RGN 0xff5e     /**< RGN marker value */
00066 #define J2K_MS_QCD 0xff5c     /**< QCD marker value */
00067 #define J2K_MS_QCC 0xff5d     /**< QCC marker value */
00068 #define J2K_MS_POC 0xff5f     /**< POC marker value */
00069 #define J2K_MS_TLM 0xff55     /**< TLM marker value */
00070 #define J2K_MS_PLM 0xff57     /**< PLM marker value */
00071 #define J2K_MS_PLT 0xff58     /**< PLT marker value */
00072 #define J2K_MS_PPM 0xff60     /**< PPM marker value */
00073 #define J2K_MS_PPT 0xff61     /**< PPT marker value */
00074 #define J2K_MS_SOP 0xff91     /**< SOP marker value */
00075 #define J2K_MS_EPH 0xff92     /**< EPH marker value */
00076 #define J2K_MS_CRG 0xff63     /**< CRG marker value */
00077 #define J2K_MS_COM 0xff64     /**< COM marker value */

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

/**
Values that specify the status of the decoding process when decoding the main header. 
These values may be combined with a | operator. 
*/
00085 typedef enum J2K_STATUS {
00086       J2K_STATE_MHSOC  = 0x0001, /**< a SOC marker is expected */
00087       J2K_STATE_MHSIZ  = 0x0002, /**< a SIZ marker is expected */
00088       J2K_STATE_MH     = 0x0004, /**< the decoding process is in the main header */
00089       J2K_STATE_TPHSOT = 0x0008, /**< the decoding process is in a tile part header and expects a SOT marker */
00090       J2K_STATE_TPH    = 0x0010, /**< the decoding process is in a tile part header */
00091       J2K_STATE_MT     = 0x0020, /**< the EOC marker has just been read */
00092       J2K_STATE_NEOC   = 0x0040  /**< the decoding process must not expect a EOC marker because the codestream is truncated */
} J2K_STATUS;

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

/**
Quantization stepsize
*/
00100 typedef struct opj_stepsize {
      /** exponent */
00102       int expn;
      /** mantissa */
00104       int mant;
} opj_stepsize_t;

/**
Tile-component coding parameters
*/
00110 typedef struct opj_tccp {
      /** coding style */
00112       int csty;
      /** number of resolutions */
00114       int numresolutions;
      /** code-blocks width */
00116       int cblkw;
      /** code-blocks height */
00118       int cblkh;
      /** code-block coding style */
00120       int cblksty;
      /** discrete wavelet transform identifier */
00122       int qmfbid;
      /** quantisation style */
00124       int qntsty;
      /** stepsizes used for quantization */
00126       opj_stepsize_t stepsizes[J2K_MAXBANDS];
      /** number of guard bits */
00128       int numgbits;
      /** Region Of Interest shift */
00130       int roishift;
      /** precinct width */
00132       int prcw[J2K_MAXRLVLS];
      /** precinct height */
00134       int prch[J2K_MAXRLVLS]; 
} opj_tccp_t;

/**
Tile coding parameters : 
this structure is used to store coding/decoding parameters common to all
tiles (information like COD, COC in main header)
*/
00142 typedef struct opj_tcp {
      /** 1 : first part-tile of a tile */
00144       int first;
      /** coding style */
00146       int csty;
      /** progression order */
00148       OPJ_PROG_ORDER prg;
      /** number of layers */
00150       int numlayers;
      /** multi-component transform identifier */
00152       int mct;
      /** rates of layers */
00154       int rates[100];
      /** number of progression order changes */
00156       int numpocs;
      /** indicates if a POC marker has been used O:NO, 1:YES */
00158       int POC;
      /** progression order changes */
00160       opj_poc_t pocs[32];
      /** packet header store there for futur use in t2_decode_packet */
00162       unsigned char *ppt_data;
      /** pointer remaining on the first byte of the first header if ppt is used */
00164       unsigned char *ppt_data_first;
      /** If ppt == 1 --> there was a PPT marker for the present tile */
00166       int ppt;
      /** used in case of multiple marker PPT (number of info already stored) */
00168       int ppt_store;
      /** ppmbug1 */
00170       int ppt_len;
      /** add fixed_quality */
00172       float distoratio[100];
      /** tile-component coding parameters */
00174       opj_tccp_t *tccps;
} opj_tcp_t;

/**
Coding parameters
*/
00180 typedef struct opj_cp {
      /** allocation by rate/distortion */
00182       int disto_alloc;
      /** allocation by fixed layer */
00184       int fixed_alloc;
      /** add fixed_quality */
00186       int fixed_quality;
      /** if != 0, then original dimension divided by 2^(reduce); if == 0 or not used, image is decoded to the full resolution */
00188       int reduce;
      /** if != 0, then only the first "layer" layers are decoded; if == 0 or not used, all the quality layers are decoded */
00190       int layer;
      /** 0 = no index || 1 = index */
00192       int index_on;
      /** XTOsiz */
00194       int tx0;
      /** YTOsiz */
00196       int ty0;
      /** XTsiz */
00198       int tdx;
      /** YTsiz */
00200       int tdy;
      /** comment for coding */
00202       char *comment;
      /** number of tiles in width */
00204       int tw;
      /** number of tiles in heigth */
00206       int th;
      /** ID number of the tiles present in the codestream */
00208       int *tileno;
      /** size of the vector tileno */
00210       int tileno_size;
      /** packet header store there for futur use in t2_decode_packet */
00212       unsigned char *ppm_data;
      /** pointer remaining on the first byte of the first header if ppm is used */
00214       unsigned char *ppm_data_first;
      /** if ppm == 1 --> there was a PPM marker for the present tile */
00216       int ppm;
      /** use in case of multiple marker PPM (number of info already store) */
00218       int ppm_store;
      /** use in case of multiple marker PPM (case on non-finished previous info) */
00220       int ppm_previous;
      /** ppmbug1 */
00222       int ppm_len;
      /** tile coding parameters */
00224       opj_tcp_t *tcps;
      /** fixed layer */
00226       int *matrice;
} opj_cp_t;

/**
Information concerning a packet inside tile
*/
00232 typedef struct opj_packet_info {
      /** start position */
00234       int start_pos;
      /** end position */
00236       int end_pos;
      /** ADD for Marcela */
00238       double disto;
} opj_packet_info_t;

/**
Index structure : information regarding tiles inside image
*/
00244 typedef struct opj_tile_info {
      /** value of thresh for each layer by tile cfr. Marcela   */
00246       double *thresh;
      /** number of tile */
00248       int num_tile;
      /** start position */
00250       int start_pos;
      /** end position of the header */
00252       int end_header;
      /** end position */
00254       int end_pos;
      /** precinct number for each resolution level (width) */
00256       int pw[33];
      /** precinct number for each resolution level (height) */
00258       int ph[33];
      /** precinct size (in power of 2), in X for each resolution level */
00260       int pdx[33];
      /** precinct size (in power of 2), in Y for each resolution level */
00262       int pdy[33];
      /** information concerning packets inside tile */
00264       opj_packet_info_t *packet;
      /** add fixed_quality */
00266       int nbpix;
      /** add fixed_quality */
00268       double distotile;
} opj_tile_info_t;

/**
Index structure
*/
00274 typedef struct opj_image_info {
      /** 0 = no index || 1 = index */
00276       int index_on;
      /** maximum distortion reduction on the whole image (add for Marcela) */
00278       double D_max;
      /** packet number */
00280       int num;
      /** writing the packet in the index with t2_encode_packets */
00282       int index_write;
      /** image width */
00284       int image_w;
      /** image height */
00286       int image_h;
      /** progression order */
00288       OPJ_PROG_ORDER prog;
      /** tile size in x */
00290       int tile_x;
      /** tile size in y */
00292       int tile_y;
      /** */
00294       int tile_Ox;
      /** */
00296       int tile_Oy;
      /** number of tiles in X */
00298       int tw;
      /** number of tiles in Y */
00300       int th;
      /** component numbers */
00302       int comp;
      /** number of layer */
00304       int layer;
      /** number of decomposition */
00306       int decomposition;
      /** main header position */
00308       int main_head_end;
      /** codestream's size */
00310       int codestream_size;
      /** information regarding tiles inside image */
00312       opj_tile_info_t *tile;
} opj_image_info_t;

/**
JPEG-2000 codestream reader/writer
*/
00318 typedef struct opj_j2k {
      /** codec context */
00320       opj_common_ptr cinfo;

      /** locate in which part of the codestream the decoder is (main header, tile header, end) */
00323       int state;
      /** number of the tile curently concern by coding/decoding */
00325       int curtileno;
      /** 
      locate the position of the end of the tile in the codestream, 
      used to detect a truncated codestream (in j2k_read_sod)
      */
00330       unsigned char *eot;
      /**
      locate the start position of the SOT marker of the current coded tile:  
      after encoding the tile, a jump (in j2k_write_sod) is done to the SOT marker to store the value of its length. 
      */
00335       int sot_start;
      int sod_start;
      /**
      as the J2K-file is written in several parts during encoding, 
      it enables to make the right correction in position return by cio_tell
      */
00341       int pos_correction;
      /** array used to store the data of each tile */
00343       unsigned char **tile_data;
      /** array used to store the length of each tile */
00345       int *tile_len;
      /** 
      decompression only : 
      store decoding parameters common to all tiles (information like COD, COC in main header)
      */
00350       opj_tcp_t *default_tcp;
      /** pointer to the encoded / decoded image */
00352       opj_image_t *image;
      /** pointer to the coding parameters */
00354       opj_cp_t *cp;
      /** helper used to write the index file */
00356       opj_image_info_t *image_info;
      /** pointer to the byte i/o stream */
00358       opj_cio_t *cio;
} opj_j2k_t;

/** @name Exported functions */
/*@{*/
/* ----------------------------------------------------------------------- */
/**
Creates a J2K decompression structure
@param cinfo Codec context info
@return Returns a handle to a J2K decompressor if successful, returns NULL otherwise
*/
opj_j2k_t* j2k_create_decompress(opj_common_ptr cinfo);
/**
Destroy a J2K decompressor handle
@param j2k J2K decompressor handle to destroy
*/
void j2k_destroy_decompress(opj_j2k_t *j2k);
/**
Setup the decoder decoding parameters using user parameters.
Decoding parameters are returned in j2k->cp. 
@param j2k J2K decompressor handle
@param parameters decompression parameters
*/
void j2k_setup_decoder(opj_j2k_t *j2k, opj_dparameters_t *parameters);
/**
Decode an image from a JPEG-2000 codestream
@param j2k J2K decompressor handle
@param cio Input buffer stream
@return Returns a decoded image if successful, returns NULL otherwise
*/
opj_image_t* j2k_decode(opj_j2k_t *j2k, opj_cio_t *cio);
/**
Decode an image form a JPT-stream (JPEG 2000, JPIP)
@param j2k J2K decompressor handle
@param cio Input buffer stream
@return Returns a decoded image if successful, returns NULL otherwise
*/
opj_image_t* j2k_decode_jpt_stream(opj_j2k_t *j2k, opj_cio_t *cio);
/**
Creates a J2K compression structure
@param cinfo Codec context info
@return Returns a handle to a J2K compressor if successful, returns NULL otherwise
*/
opj_j2k_t* j2k_create_compress(opj_common_ptr cinfo);
/**
Destroy a J2K compressor handle
@param j2k J2K compressor handle to destroy
*/
void j2k_destroy_compress(opj_j2k_t *j2k);
/**
Setup the encoder parameters using the current image and using user parameters. 
Coding parameters are returned in j2k->cp. 
@param j2k J2K compressor handle
@param parameters compression parameters
@param image input filled image
*/
void j2k_setup_encoder(opj_j2k_t *j2k, opj_cparameters_t *parameters, opj_image_t *image);
/**
Encode an image into a JPEG-2000 codestream
@param j2k J2K compressor handle
@param cio Output buffer stream
@param image Image to encode
@param index Name of the index file if required, NULL otherwise
@return Returns true if successful, returns false otherwise
*/
bool j2k_encode(opj_j2k_t *j2k, opj_cio_t *cio, opj_image_t *image, char *index);
/* ----------------------------------------------------------------------- */
/*@}*/

/*@}*/

#endif /* __J2K_H */

Generated by  Doxygen 1.6.0   Back to index