libopenjpeg/jp2.h

   1 /*
   2  * Copyright (c) 2004, Yannick Verschueren
   3  * Copyright (c) 2005, Herv� Drolon, FreeImage Team
   4  * Copyright (c) 2002-2005, 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 #ifndef __JP2_H
  29 #define __JP2_H
  30 /**
  31 @file jp2.h
  32 @brief The JPEG-2000 file format Reader/Writer (JP2)
  33
  34 */
  35
  36 /** @defgroup JP2 JP2 - JPEG-2000 file format reader/writer */
  37 /*@{*/
  38
  39 #define JPIP_JPIP 0x6a706970
  40
  41 #define JP2_JP   0x6a502020   /**< JPEG 2000 signature box */
  42 #define JP2_FTYP 0x66747970   /**< File type box */
  43 #define JP2_JP2H 0x6a703268   /**< JP2 header box */
  44 #define JP2_IHDR 0x69686472   /**< Image header box */
  45 #define JP2_COLR 0x636f6c72   /**< Colour specification box */
  46 #define JP2_JP2C 0x6a703263   /**< Contiguous codestream box */
  47 #define JP2_URL  0x75726c20   /**< URL box */
  48 #define JP2_DBTL 0x6474626c   /**< ??? */
  49 #define JP2_BPCC 0x62706363   /**< Bits per component box */
  50 #define JP2_JP2  0x6a703220   /**< File type fields */
  51
  52 /* ----------------------------------------------------------------------- */
  53
  54 /**
  55 JP2 component
  56 */
  57 typedef struct opj_jp2_comps {
  58   int depth;
  59   int sgnd;
  60   int bpcc;
  61 } opj_jp2_comps_t;
  62
  63 /**
  64 JPEG-2000 file format reader/writer
  65 */
  66 typedef struct opj_jp2 {
  67   /** codec context */
  68   opj_common_ptr cinfo;
  69   /** handle to the J2K codec  */
  70   opj_j2k_t *j2k;
  71   unsigned int w;
  72   unsigned int h;
  73   unsigned int numcomps;
  74   unsigned int bpc;
  75   unsigned int C;
  76   unsigned int UnkC;
  77   unsigned int IPR;
  78   unsigned int meth;
  79   unsigned int approx;
  80   unsigned int enumcs;
  81   unsigned int precedence;
  82   unsigned int brand;
  83   unsigned int minversion;
  84   unsigned int numcl;
  85   unsigned int *cl;
  86   opj_jp2_comps_t *comps;
  87   opj_image_t *image;
  88   unsigned int j2k_codestream_offset;
  89   unsigned int j2k_codestream_length;
  90 } opj_jp2_t;
  91
  92 /**
  93 JP2 Box
  94 */
  95 typedef struct opj_jp2_box {
  96   int length;
  97   int type;
  98   int init_pos;
  99 } opj_jp2_box_t;
 100
 101 /** @name Local static functions */
 102 /*@{*/
 103 /* ----------------------------------------------------------------------- */
 104 /**
 105 Read box headers
 106 @param cinfo Codec context info
 107 @param cio Input stream
 108 @param box
 109 @return Returns true if successful, returns false otherwise
 110 */
 111 static bool jp2_read_boxhdr(opj_common_ptr cinfo, opj_cio_t *cio, opj_jp2_box_t *box);
 112 static void jp2_write_url(opj_cio_t *cio, char *Idx_file);
 113 /**
 114 Read the IHDR box - Image Header box
 115 @param jp2 JP2 handle
 116 @param cio Input buffer stream
 117 @return Returns true if successful, returns false otherwise
 118 */
 119 static bool jp2_read_ihdr(opj_jp2_t *jp2, opj_cio_t *cio);
 120 static void jp2_write_ihdr(opj_jp2_t *jp2, opj_cio_t *cio);
 121 static void jp2_write_bpcc(opj_jp2_t *jp2, opj_cio_t *cio);
 122 static bool jp2_read_bpcc(opj_jp2_t *jp2, opj_cio_t *cio);
 123 static void jp2_write_colr(opj_jp2_t *jp2, opj_cio_t *cio);
 124 static bool jp2_read_colr(opj_jp2_t *jp2, opj_cio_t *cio);
 125 /**
 126 Write the JP2H box - JP2 Header box
 127 @param jp2 JP2 handle
 128 @param cio Output buffer stream
 129 */
 130 static void jp2_write_jp2h(opj_jp2_t *jp2, opj_cio_t *cio);
 131 /**
 132 Read the JP2H box - JP2 Header box
 133 @param jp2 JP2 handle
 134 @param cio Input buffer stream
 135 @return Returns true if successful, returns false otherwise
 136 */
 137 static bool jp2_read_jp2h(opj_jp2_t *jp2, opj_cio_t *cio);
 138 /**
 139 Write the FTYP box - File type box
 140 @param jp2 JP2 handle
 141 @param cio Output buffer stream
 142 */
 143 static void jp2_write_ftyp(opj_jp2_t *jp2, opj_cio_t *cio);
 144 /**
 145 Read the FTYP box - File type box
 146 @param jp2 JP2 handle
 147 @param cio Input buffer stream
 148 @return Returns true if successful, returns false otherwise
 149 */
 150 static bool jp2_read_ftyp(opj_jp2_t *jp2, opj_cio_t *cio);
 151 static int jp2_write_jp2c(opj_jp2_t *jp2, opj_cio_t *cio, char *index);
 152 static bool jp2_read_jp2c(opj_jp2_t *jp2, opj_cio_t *cio, unsigned int *j2k_codestream_length, unsigned int *j2k_codestream_offset);
 153 static void jp2_write_jp(opj_cio_t *cio);
 154 /**
 155 Read the JP box - JPEG 2000 signature
 156 @param jp2 JP2 handle
 157 @param cio Input buffer stream
 158 @return Returns true if successful, returns false otherwise
 159 */
 160 static bool jp2_read_jp(opj_jp2_t *jp2, opj_cio_t *cio);
 161 /**
 162 Decode the structure of a JP2 file
 163 @param jp2 JP2 handle
 164 @param cio Input buffer stream
 165 @return Returns true if successful, returns false otherwise
 166 */
 167 static bool jp2_read_struct(opj_jp2_t *jp2, opj_cio_t *cio);
 168 /* ----------------------------------------------------------------------- */
 169 /*@}*/
 170
 171 /** @name Exported functions */
 172 /*@{*/
 173 /* ----------------------------------------------------------------------- */
 174 /**
 175 Creates a JP2 decompression structure
 176 @param cinfo Codec context info
 177 @return Returns a handle to a JP2 decompressor if successful, returns NULL otherwise
 178 */
 179 opj_jp2_t* jp2_create_decompress(opj_common_ptr cinfo);
 180 /**
 181 Destroy a JP2 decompressor handle
 182 @param jp2 JP2 decompressor handle to destroy
 183 */
 184 void jp2_destroy_decompress(opj_jp2_t *jp2);
 185 /**
 186 Setup the decoder decoding parameters using user parameters.
 187 Decoding parameters are returned in jp2->j2k->cp.
 188 @param jp2 JP2 decompressor handle
 189 @param parameters decompression parameters
 190 */
 191 void jp2_setup_decoder(opj_jp2_t *jp2, opj_dparameters_t *parameters);
 192 /**
 193 Decode an image from a JPEG-2000 file stream
 194 @param jp2 JP2 decompressor handle
 195 @param cio Input buffer stream
 196 @return Returns a decoded image if successful, returns NULL otherwise
 197 */
 198 opj_image_t* jp2_decode(opj_jp2_t *jp2, opj_cio_t *cio);
 199 /**
 200 Creates a JP2 compression structure
 201 @param cinfo Codec context info
 202 @return Returns a handle to a JP2 compressor if successful, returns NULL otherwise
 203 */
 204 opj_jp2_t* jp2_create_compress(opj_common_ptr cinfo);
 205 /**
 206 Destroy a JP2 compressor handle
 207 @param jp2 JP2 compressor handle to destroy
 208 */
 209 void jp2_destroy_compress(opj_jp2_t *jp2);
 210 /**
 211 Setup the encoder parameters using the current image and using user parameters.
 212 Coding parameters are returned in jp2->j2k->cp.
 213 @param jp2 JP2 compressor handle
 214 @param parameters compression parameters
 215 @param image input filled image
 216 */
 217 void jp2_setup_encoder(opj_jp2_t *jp2, opj_cparameters_t *parameters, opj_image_t *image);
 218 /**
 219 Encode an image into a JPEG-2000 file stream
 220 @param jp2 JP2 compressor handle
 221 @param cio Output buffer stream
 222 @param image Image to encode
 223 @param index Name of the index file if required, NULL otherwise
 224 @return Returns true if successful, returns false otherwise
 225 */
 226 bool jp2_encode(opj_jp2_t *jp2, opj_cio_t *cio, opj_image_t *image, char *index);
 227 /* ----------------------------------------------------------------------- */
 228 /*@}*/
 229
 230 /*@}*/
 231
 232 #endif /* __JP2_H */
 233