Bug fixed for scalar_derived quantization type
[openjpeg.git] / libopenjpeg / j2k.h
1 /*
2  * Copyright (c) 2001-2002, David Janssens
3  * Copyright (c) 2002-2003, Yannick Verschueren
4  * Copyright (c) 2002-2003,  Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium
5  * All rights reserved. 
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  * POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #define VERSION "0.0.8"
30
31 #ifdef DAVID_WIN32
32 #ifdef LIBJ2K_EXPORTS
33 #define LIBJ2K_API __declspec(dllexport)
34 #else
35 #define LIBJ2K_API __declspec(dllimport)
36 #endif
37 #else
38 #define LIBJ2K_API
39 #endif
40
41 #ifndef __J2K_H
42 #define __J2K_H
43
44 #define J2K_MAXRLVLS 33         /* Number of maximum resolution level authorized                   */
45 #define J2K_MAXBANDS (3*J2K_MAXRLVLS-2) /* Number of maximum sub-band linked to number of resolution level */
46
47 #define J2K_CP_CSTY_PRT 0x01
48 #define J2K_CP_CSTY_SOP 0x02
49 #define J2K_CP_CSTY_EPH 0x04
50 #define J2K_CCP_CSTY_PRT 0x01
51 #define J2K_CCP_CBLKSTY_LAZY 0x01
52 #define J2K_CCP_CBLKSTY_RESET 0x02
53 #define J2K_CCP_CBLKSTY_TERMALL 0x04
54 #define J2K_CCP_CBLKSTY_VSC 0x08
55 #define J2K_CCP_CBLKSTY_PTERM 0x10
56 #define J2K_CCP_CBLKSTY_SEGSYM 0x20
57 #define J2K_CCP_QNTSTY_NOQNT 0
58 #define J2K_CCP_QNTSTY_SIQNT 1
59 #define J2K_CCP_QNTSTY_SEQNT 2
60
61 typedef struct {
62   int reduce_on;                /* option reduce is used if reduce = 1 */
63   int reduce_value;             /* if option reduce is used -> original dimension divided by 2^value */
64 } j2k_option_t;
65
66 typedef struct {
67   int dx, dy;                   /* XRsiz, YRsiz              */
68   int w, h;                     /* width and height of data  */
69   int x0, y0;                   /* offset of the component compare to the whole image  */
70   int prec;                     /* precision                 */
71   int bpp;                      /* deapth of image in bits   */
72   int sgnd;                     /* signed                    */
73   int resno_decoded;            /* number of decoded resolution */
74   int factor;                   /* number of division by 2 of the out image  compare to the original size of image */
75   int *data;                    /* image-component data      */
76 } j2k_comp_t;
77
78 typedef struct {
79   int x0, y0;                   /* XOsiz, YOsiz              */
80   int x1, y1;                   /* Xsiz, Ysiz                */
81   int numcomps;                 /* number of components      */
82   int index_on;                 /* 0 = no index || 1 = index */
83   int color_space;              /* sRGB, Greyscale or YUV */
84   j2k_comp_t *comps;            /* image-components          */
85 } j2k_image_t;
86
87 typedef struct {
88   int expn;                     /* exponent                  */
89   int mant;                     /* mantissa                  */
90 } j2k_stepsize_t;
91
92 typedef struct {
93   int csty;                     /* coding style                          */
94   int numresolutions;           /* number of resolutions                 */
95   int cblkw;                    /* width of code-blocks                  */
96   int cblkh;                    /* height of code-blocks                 */
97   int cblksty;                  /* code-block coding style               */
98   int qmfbid;                   /* discrete wavelet transform identifier */
99   int qntsty;                   /* quantisation style                    */
100   j2k_stepsize_t stepsizes[J2K_MAXBANDS];       /* stepsizes used for quantization       */
101   int numgbits;                 /* number of guard bits                  */
102   int roishift;                 /* Region Of Interest shift              */
103   int prcw[J2K_MAXRLVLS];       /* Precinct width                        */
104   int prch[J2K_MAXRLVLS];       /* Precinct height                       */
105 } j2k_tccp_t;
106
107 typedef struct {
108   int resno0, compno0;
109   int layno1, resno1, compno1;
110   int prg;
111   int tile;
112   char progorder[4];
113 } j2k_poc_t;
114
115 typedef struct {
116   int first;                    /* 1 : first part-tile of a tile                                     */
117   int csty;                     /* coding style                                                      */
118   int prg;                      /* progression order                                                 */
119   int numlayers;                /* number of layers                                                  */
120   int mct;                      /* multi-component transform identifier                              */
121   int rates[100];               /* rates of layers                                                   */
122   int numpocs;                  /* number of progression order changes                               */
123   int POC;                      /* Precise if a POC marker has been used O:NO, 1:YES                 */
124   j2k_poc_t pocs[32];           /* progression order changes                                         */
125   unsigned char *ppt_data;      /* packet header store there for futur use in t2_decode_packet       */
126   int ppt;                      /* If ppt == 1 --> there was a PPT marker for the present tile       */
127   int ppt_store;                /* Use in case of multiple marker PPT (number of info already store) */
128   float distoratio[100];        /* add fixed_quality */
129   j2k_tccp_t *tccps;            /* tile-component coding parameters                                  */
130 } j2k_tcp_t;
131
132 typedef struct {
133   int JPEG2000_format;          /* 0: J2K   1:JP2 */
134   int intermed_file;            /* 1: Store each encoded tile one by one in the output file (for mega-Images)*/
135   int image_type;               /* 0: PNM, PGM, PPM 1: PGX           */
136   int disto_alloc;              /* Allocation by rate/distortion     */
137   int fixed_alloc;              /* Allocation by fixed layer         */
138   int fixed_quality;            /* add fixed_quality */
139   int reduce_on;                /* option reduce is used if reduce = 1 */
140   int reduce_value;             /* if option reduce is used -> original dimension divided by 2^value */
141   int tx0, ty0;                 /* XTOsiz, YTOsiz                    */
142   int tdx, tdy;                 /* XTsiz, YTsiz                      */
143   char *comment;                /* comment for coding                */
144   int tw, th;                   /* number of tiles in width and heigth */
145   int *tileno;                  /* ID number of the tiles present in the codestream */
146   int tileno_size;              /* size of the vector tileno */
147   unsigned char *ppm_data;      /* packet header store there for futur use in t2_decode_packet             */
148   int ppm;                      /* If ppm == 1 --> there was a PPM marker for the present tile             */
149   int ppm_store;                /* Use in case of multiple marker PPM (number of info already store)       */
150   int ppm_previous;             /* Use in case of multiple marker PPM (case on non-finished previous info) */
151   j2k_tcp_t *tcps;              /* tile coding parameters                                                  */
152   int *matrice;                 /* Fixed layer                                                             */
153 } j2k_cp_t;
154
155 typedef struct {
156   int start_pos, end_pos;       /* start and end position            */
157   double disto;                 /* ADD for Marcela                   */
158 } info_packet;                  /* Index struct                      */
159
160 typedef struct {
161   double *thresh;               /* value of thresh for each layer by tile cfr. Marcela   */
162   int num_tile;                 /* Number of Tile                                        */
163   int start_pos;                /* Start position                                        */
164   int end_header;               /* End position of the header                            */
165   int end_pos;                  /* End position                                          */
166   int pw[33], ph[33];           /* precinct number for each resolution level             */
167
168   int pdx[33], pdy[33];         /* precinct size (in power of 2), in X and Y for each resolution level */
169   info_packet *packet;          /* information concerning packets inside tile            */
170   int nbpix;                    /* add fixed_quality                                     */
171   double distotile;             /* add fixed_quality                                     */
172 } info_tile;                    /* index struct                                          */
173
174 typedef struct {
175   int index_on;
176   double D_max;                 /* ADD for Marcela                                       */
177   int num;                      /* numero of packet                                      */
178   int index_write;              /* writing the packet inthe index with t2_encode_packets */
179   int Im_w, Im_h;               /* Image width and Height                                */
180   int Prog;                     /* progression order                                     */
181   int Tile_x, Tile_y;           /* Tile size in x and y                                  */
182   int tw, th;                   /* Number of Tile in X and Y                             */
183   int Comp;                     /* Component numbers                                     */
184   int Layer;                    /* number of layer                                       */
185   int Decomposition;            /* number of decomposition                               */
186   int Main_head_end;            /* Main header position                                  */
187   int codestream_size;          /* codestream's size                                     */
188   info_tile *tile;              /* information concerning tiles inside image             */
189 } info_image;                   /* index struct                                          */
190
191 /* 
192  * Encode an image into a JPEG-2000 codestream
193  * i: image to encode
194  * cp: coding parameters
195  * output: destination buffer or name of the output file when cp->intermed_file==1
196  * len: length of destination buffer
197  * index : index file name
198  */
199 LIBJ2K_API int j2k_encode(j2k_image_t * i, j2k_cp_t * cp, char *output,
200                           int len, char *index);
201
202 /* LIBJ2K_API int j2k_encode(j2k_image_t *i, j2k_cp_t *cp,unsigned char *dest, int len); */
203 /*
204  * Decode an image from a JPEG-2000 codestream
205  * src: source buffer
206  * len: length of source buffer
207  * i: decode image
208  * cp: coding parameters that were used to encode the image
209  */
210 LIBJ2K_API int j2k_decode(unsigned char *src, int len, j2k_image_t ** img,
211                           j2k_cp_t ** cp, j2k_option_t option);
212
213
214 /*
215  * Decode an image form a JPT-stream (JPEG 2000, JPIP)
216  * src: source buffer
217  * len: length of source buffer
218  * i: decode image
219  * cp: coding parameters that were used to encode the image
220  *
221  */
222 int j2k_decode_jpt_stream(unsigned char *src, int len, j2k_image_t ** img,
223                           j2k_cp_t ** cp);
224
225 #endif