src/lib/openmj2/jp2.h

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