src/lib/openmj2/jp2.h

   1 /*
   2  * Copyright (c) 2002-2007, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
   3  * Copyright (c) 2002-2007, Professor Benoit Macq
   4  * Copyright (c) 2002-2003, Yannick Verschueren
   5  * Copyright (c) 2005, Herve Drolon, FreeImage Team
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  27  * POSSIBILITY OF SUCH DAMAGE.
  28  */
  29 #ifndef __JP2_H
  30 #define __JP2_H
  31 /**
  32 @file jp2.h
  33 @brief The JPEG-2000 file format Reader/Writer (JP2)
  34
  35 */
  36
  37 /** @defgroup JP2 JP2 - JPEG-2000 file format reader/writer */
  38 /*@{*/
  39
  40 #define JP2_JP   0x6a502020             /**< JPEG 2000 signature box */
  41 #define JP2_FTYP 0x66747970             /**< File type box */
  42 #define JP2_JP2H 0x6a703268             /**< JP2 header box */
  43 #define JP2_IHDR 0x69686472             /**< Image header box */
  44 #define JP2_COLR 0x636f6c72             /**< Colour specification box */
  45 #define JP2_JP2C 0x6a703263             /**< Contiguous codestream box */
  46 #define JP2_URL  0x75726c20             /**< URL box */
  47 #define JP2_DTBL 0x6474626c             /**< Data Reference box */
  48 #define JP2_BPCC 0x62706363             /**< Bits per component box */
  49 #define JP2_JP2  0x6a703220             /**< File type fields */
  50 #define JP2_PCLR 0x70636c72             /**< Palette box */
  51 #define JP2_CMAP 0x636d6170             /**< Component Mapping box */
  52 #define JP2_CDEF 0x63646566             /**< Channel Definition box */
  53
  54 /* ----------------------------------------------------------------------- */
  55 /**
  56 Channel description: channel index, type, assocation
  57 */
  58 typedef struct opj_jp2_cdef_info
  59 {
  60     unsigned short cn, typ, asoc;
  61 } opj_jp2_cdef_info_t;
  62
  63 /**
  64 Channel descriptions and number of descriptions
  65 */
  66 typedef struct opj_jp2_cdef
  67 {
  68     opj_jp2_cdef_info_t *info;
  69     unsigned short n;
  70 } opj_jp2_cdef_t;
  71
  72 /**
  73 Component mappings: channel index, mapping type, palette index
  74 */
  75 typedef struct opj_jp2_cmap_comp
  76 {
  77     unsigned short cmp;
  78     unsigned char mtyp, pcol;
  79 } opj_jp2_cmap_comp_t;
  80
  81 /**
  82 Palette data: table entries, palette columns
  83 */
  84 typedef struct opj_jp2_pclr
  85 {
  86     unsigned int *entries;
  87     unsigned char *channel_sign;
  88     unsigned char *channel_size;
  89     opj_jp2_cmap_comp_t *cmap;
  90     unsigned short nr_entries, nr_channels;
  91 } opj_jp2_pclr_t;
  92
  93 /**
  94 Collector for ICC profile, palette, component mapping, channel description
  95 */
  96 typedef struct opj_jp2_color
  97 {
  98     unsigned char *icc_profile_buf;
  99     int icc_profile_len;
 100
 101     opj_jp2_cdef_t *jp2_cdef;
 102     opj_jp2_pclr_t *jp2_pclr;
 103     unsigned char jp2_has_colr;
 104 } opj_jp2_color_t;
 105
 106 /**
 107 JP2 component
 108 */
 109 typedef struct opj_jp2_comps {
 110   int depth;
 111   int sgnd;
 112   int bpcc;
 113 } opj_jp2_comps_t;
 114
 115 /**
 116 JPEG-2000 file format reader/writer
 117 */
 118 typedef struct opj_jp2 {
 119         /** codec context */
 120         opj_common_ptr cinfo;
 121         /** handle to the J2K codec  */
 122         opj_j2k_t *j2k;
 123         unsigned int w;
 124         unsigned int h;
 125         unsigned int numcomps;
 126         unsigned int bpc;
 127         unsigned int C;
 128         unsigned int UnkC;
 129         unsigned int IPR;
 130         unsigned int meth;
 131         unsigned int approx;
 132         unsigned int enumcs;
 133         unsigned int precedence;
 134         unsigned int brand;
 135         unsigned int minversion;
 136         unsigned int numcl;
 137         unsigned int *cl;
 138         opj_jp2_comps_t *comps;
 139         unsigned int j2k_codestream_offset;
 140         unsigned int j2k_codestream_length;
 141         opj_bool ignore_pclr_cmap_cdef;
 142 } opj_jp2_t;
 143
 144 /**
 145 JP2 Box
 146 */
 147 typedef struct opj_jp2_box {
 148   int length;
 149   int type;
 150   int init_pos;
 151 } opj_jp2_box_t;
 152
 153 /** @name Exported functions */
 154 /*@{*/
 155 /* ----------------------------------------------------------------------- */
 156 /**
 157 Write the JP2H box - JP2 Header box (used in MJ2)
 158 @param jp2 JP2 handle
 159 @param cio Output buffer stream
 160 */
 161 void jp2_write_jp2h(opj_jp2_t *jp2, opj_cio_t *cio);
 162 /**
 163 Read the JP2H box - JP2 Header box (used in MJ2)
 164 @param jp2 JP2 handle
 165 @param cio Input buffer stream
 166 @param ext Collector for profile, cdef and pclr data
 167 @return Returns true if successful, returns false otherwise
 168 */
 169 opj_bool jp2_read_jp2h(opj_jp2_t *jp2, opj_cio_t *cio, opj_jp2_color_t *color);
 170 /**
 171 Creates a JP2 decompression structure
 172 @param cinfo Codec context info
 173 @return Returns a handle to a JP2 decompressor if successful, returns NULL otherwise
 174 */
 175 opj_jp2_t* jp2_create_decompress(opj_common_ptr cinfo);
 176 /**
 177 Destroy a JP2 decompressor handle
 178 @param jp2 JP2 decompressor handle to destroy
 179 */
 180 void jp2_destroy_decompress(opj_jp2_t *jp2);
 181 /**
 182 Setup the decoder decoding parameters using user parameters.
 183 Decoding parameters are returned in jp2->j2k->cp.
 184 @param jp2 JP2 decompressor handle
 185 @param parameters decompression parameters
 186 */
 187 void jp2_setup_decoder(opj_jp2_t *jp2, opj_dparameters_t *parameters);
 188 /**
 189 Decode an image from a JPEG-2000 file stream
 190 @param jp2 JP2 decompressor handle
 191 @param cio Input buffer stream
 192 @param cstr_info Codestream information structure if required, NULL otherwise
 193 @return Returns a decoded image if successful, returns NULL otherwise
 194 */
 195 opj_image_t* opj_jp2_decode(opj_jp2_t *jp2, opj_cio_t *cio, opj_codestream_info_t *cstr_info);
 196 /**
 197 Creates a JP2 compression structure
 198 @param cinfo Codec context info
 199 @return Returns a handle to a JP2 compressor if successful, returns NULL otherwise
 200 */
 201 opj_jp2_t* jp2_create_compress(opj_common_ptr cinfo);
 202 /**
 203 Destroy a JP2 compressor handle
 204 @param jp2 JP2 compressor handle to destroy
 205 */
 206 void jp2_destroy_compress(opj_jp2_t *jp2);
 207 /**
 208 Setup the encoder parameters using the current image and using user parameters.
 209 Coding parameters are returned in jp2->j2k->cp.
 210 @param jp2 JP2 compressor handle
 211 @param parameters compression parameters
 212 @param image input filled image
 213 */
 214 void jp2_setup_encoder(opj_jp2_t *jp2, opj_cparameters_t *parameters, opj_image_t *image);
 215 /**
 216 Encode an image into a JPEG-2000 file stream
 217 @param jp2 JP2 compressor handle
 218 @param cio Output buffer stream
 219 @param image Image to encode
 220 @param cstr_info Codestream information structure if required, NULL otherwise
 221 @return Returns true if successful, returns false otherwise
 222 */
 223 opj_bool opj_jp2_encode(opj_jp2_t *jp2, opj_cio_t *cio, opj_image_t *image, opj_codestream_info_t *cstr_info);
 224
 225 /* ----------------------------------------------------------------------- */
 226 /*@}*/
 227
 228 /*@}*/
 229
 230 #endif /* __JP2_H */
 231