src/lib/openjp2/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 JPIP_JPIP 0x6a706970
  41
  42 #define     JP2_JP   0x6a502020         /**< JPEG 2000 signature box */
  43 #define     JP2_FTYP 0x66747970         /**< File type box */
  44 #define     JP2_JP2H 0x6a703268         /**< JP2 header box (super-box) */
  45 #define         JP2_IHDR 0x69686472             /**< Image header box */
  46 #define         JP2_COLR 0x636f6c72             /**< Colour specification box */
  47 #define     JP2_JP2C 0x6a703263         /**< Contiguous codestream box */
  48 #define         JP2_URL  0x75726c20             /**< Data entry URL box */
  49 #define         JP2_PCLR 0x70636c72             /**< Palette box */
  50 #define         JP2_CMAP 0x636d6170             /**< Component Mapping box */
  51 #define         JP2_CDEF 0x63646566             /**< Channel Definition 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
  56 /* For the future */
  57 /* #define JP2_RES 0x72657320 */        /**< Resolution box (super-box) */
  58 /* #define JP2_JP2I 0x6a703269 */       /**< Intellectual property box */
  59 /* #define JP2_XML  0x786d6c20 */       /**< XML box */
  60 /* #define JP2_UUID 0x75756994 */       /**< UUID box */
  61 /* #define JP2_UINF 0x75696e66 */       /**< UUID info box (super-box) */
  62 /* #define JP2_ULST 0x756c7374 */       /**< UUID list box */
  63
  64 /* ----------------------------------------------------------------------- */
  65
  66 typedef enum
  67 {
  68         JP2_STATE_NONE                  = 0x0,
  69         JP2_STATE_SIGNATURE             = 0x1,
  70         JP2_STATE_FILE_TYPE             = 0x2,
  71         JP2_STATE_HEADER                = 0x4,
  72         JP2_STATE_CODESTREAM    = 0x8,
  73         JP2_STATE_END_CODESTREAM        = 0x10,
  74         JP2_STATE_UNKNOWN               = 0x7fffffff /* ISO C restricts enumerator values to range of 'int' */
  75 }
  76 JP2_STATE;
  77
  78 typedef enum
  79 {
  80         JP2_IMG_STATE_NONE                      = 0x0,
  81         JP2_IMG_STATE_UNKNOWN           = 0x7fffffff
  82 }
  83 JP2_IMG_STATE;
  84
  85 /**
  86 Channel description: channel index, type, assocation
  87 */
  88 typedef struct opj_jp2_cdef_info
  89 {
  90     OPJ_UINT16 cn, typ, asoc;
  91 } opj_jp2_cdef_info_t;
  92
  93 /**
  94 Channel descriptions and number of descriptions
  95 */
  96 typedef struct opj_jp2_cdef
  97 {
  98     opj_jp2_cdef_info_t *info;
  99     OPJ_UINT16 n;
 100 } opj_jp2_cdef_t;
 101
 102 /**
 103 Component mappings: channel index, mapping type, palette index
 104 */
 105 typedef struct opj_jp2_cmap_comp
 106 {
 107     OPJ_UINT16 cmp;
 108     OPJ_BYTE mtyp, pcol;
 109 } opj_jp2_cmap_comp_t;
 110
 111 /**
 112 Palette data: table entries, palette columns
 113 */
 114 typedef struct opj_jp2_pclr
 115 {
 116     OPJ_UINT32 *entries;
 117     OPJ_BYTE *channel_sign;
 118     OPJ_BYTE *channel_size;
 119     opj_jp2_cmap_comp_t *cmap;
 120     OPJ_UINT16 nr_entries;
 121     OPJ_BYTE nr_channels;
 122 } opj_jp2_pclr_t;
 123
 124 /**
 125 Collector for ICC profile, palette, component mapping, channel description
 126 */
 127 typedef struct opj_jp2_color
 128 {
 129     OPJ_BYTE *icc_profile_buf;
 130     OPJ_UINT32 icc_profile_len;
 131
 132     opj_jp2_cdef_t *jp2_cdef;
 133     opj_jp2_pclr_t *jp2_pclr;
 134     OPJ_BYTE jp2_has_colr;
 135 } opj_jp2_color_t;
 136
 137 /**
 138 JP2 component
 139 */
 140 typedef struct opj_jp2_comps {
 141   int depth;
 142   int sgnd;
 143   OPJ_UINT32 bpcc;
 144 } opj_jp2_comps_t;
 145
 146 /**
 147 JPEG-2000 file format reader/writer
 148 */
 149 typedef struct opj_jp2 {
 150         /** codec context */
 151         opj_common_ptr cinfo;
 152         /** handle to the J2K codec  */
 153         opj_j2k_t *j2k;
 154         unsigned int w;
 155         unsigned int h;
 156         unsigned int numcomps;
 157         unsigned int bpc;
 158         unsigned int C;
 159         unsigned int UnkC;
 160         unsigned int IPR;
 161         unsigned int meth;
 162         unsigned int approx;
 163         unsigned int enumcs;
 164         unsigned int precedence;
 165         unsigned int brand;
 166         unsigned int minversion;
 167         unsigned int numcl;
 168         unsigned int *cl;
 169         opj_jp2_comps_t *comps;
 170         unsigned int j2k_codestream_offset;
 171         unsigned int j2k_codestream_length;
 172         opj_bool jpip_on;
 173         opj_bool ignore_pclr_cmap_cdef;
 174 } opj_jp2_t;
 175
 176 /**
 177 JPEG-2000 file format reader/writer
 178 */
 179 typedef struct opj_jp2_v2
 180 {
 181         /** handle to the J2K codec  */
 182         struct opj_j2k_v2 *j2k;
 183         /** list of validation procedures */
 184         struct opj_procedure_list * m_validation_list;
 185         /** list of execution procedures */
 186         struct opj_procedure_list * m_procedure_list;
 187
 188         /* width of image */
 189         OPJ_UINT32 w;
 190         /* height of image */
 191         OPJ_UINT32 h;
 192         /* number of components in the image */
 193         OPJ_UINT32 numcomps;
 194         OPJ_UINT32 bpc;
 195         OPJ_UINT32 C;
 196         OPJ_UINT32 UnkC;
 197         OPJ_UINT32 IPR;
 198         OPJ_UINT32 meth;
 199         OPJ_UINT32 approx;
 200         OPJ_UINT32 enumcs;
 201         OPJ_UINT32 precedence;
 202         OPJ_UINT32 brand;
 203         OPJ_UINT32 minversion;
 204         OPJ_UINT32 numcl;
 205         OPJ_UINT32 *cl;
 206         opj_jp2_comps_t *comps;
 207     OPJ_OFF_T j2k_codestream_offset;
 208     OPJ_OFF_T jpip_iptr_offset;
 209         OPJ_UINT32 jp2_state;
 210         OPJ_UINT32 jp2_img_state;
 211
 212         opj_jp2_color_t color;
 213
 214     opj_bool ignore_pclr_cmap_cdef;
 215 }
 216 opj_jp2_v2_t;
 217
 218 /**
 219 JP2 Box
 220 */
 221 typedef struct opj_jp2_box {
 222     OPJ_UINT32 length;
 223     OPJ_UINT32 type;
 224     OPJ_INT32 init_pos;
 225 } opj_jp2_box_t;
 226
 227 typedef struct opj_jp2_header_handler
 228 {
 229         /* marker value */
 230         OPJ_UINT32 id;
 231         /* action linked to the marker */
 232         opj_bool (*handler) (   opj_jp2_v2_t *jp2,
 233                             OPJ_BYTE *p_header_data,
 234                             OPJ_UINT32 p_header_size,
 235                             opj_event_mgr_t * p_manager);
 236 }
 237 opj_jp2_header_handler_t;
 238
 239
 240 typedef struct opj_jp2_img_header_writer_handler
 241 {
 242         /* action to perform */
 243         OPJ_BYTE*   (*handler) (opj_jp2_v2_t *jp2, OPJ_UINT32 * p_data_size);
 244         /* result of the action : data */
 245         OPJ_BYTE*   m_data;
 246         /* size of data */
 247         OPJ_UINT32  m_size;
 248 }
 249 opj_jp2_img_header_writer_handler_t;
 250
 251 /** @name Exported functions */
 252 /*@{*/
 253 /* ----------------------------------------------------------------------- */
 254
 255 /**
 256  * Writes the Jpeg2000 file Header box - JP2 Header box (warning, this is a super box).
 257  *
 258  * @param       jp2                     the jpeg2000 file codec.
 259  * @param       stream                  the stream to write data to.
 260  * @param       p_manager       user event manager.
 261  *
 262  * @return true if writing was successful.
 263 */
 264 opj_bool opj_jp2_write_jp2h(opj_jp2_v2_t *jp2,
 265                             opj_stream_private_t *stream,
 266                             opj_event_mgr_t * p_manager );
 267
 268 /**
 269 Setup the decoder decoding parameters using user parameters.
 270 Decoding parameters are returned in jp2->j2k->cp.
 271 @param jp2 JP2 decompressor handle
 272 @param parameters decompression parameters
 273 */
 274 void opj_jp2_setup_decoder(opj_jp2_v2_t *jp2, opj_dparameters_t *parameters);
 275
 276 /**
 277  * Decode an image from a JPEG-2000 file stream
 278  * @param jp2 JP2 decompressor handle
 279  * @param p_stream  FIXME DOC
 280  * @param p_image   FIXME DOC
 281  * @param p_manager FIXME DOC
 282  *
 283  * @return Returns a decoded image if successful, returns NULL otherwise
 284 */
 285 opj_bool opj_jp2_decode(opj_jp2_v2_t *jp2,
 286                         opj_stream_private_t *p_stream,
 287                                                 opj_image_t* p_image,
 288                                                 opj_event_mgr_t * p_manager);
 289
 290 /**
 291  * Setup the encoder parameters using the current image and using user parameters.
 292  * Coding parameters are returned in jp2->j2k->cp.
 293  *
 294  * @param jp2 JP2 compressor handle
 295  * @param parameters compression parameters
 296  * @param image input filled image
 297  * @param p_manager  FIXME DOC
 298 */
 299 void opj_jp2_setup_encoder(     opj_jp2_v2_t *jp2,
 300                             opj_cparameters_t *parameters,
 301                             opj_image_t *image,
 302                             opj_event_mgr_t * p_manager);
 303
 304 /**
 305 Encode an image into a JPEG-2000 file stream
 306 @param jp2                      JP2 compressor handle
 307 @param stream           Output buffer stream
 308 @param p_manager        event manager
 309 @return Returns true if successful, returns false otherwise
 310 */
 311 opj_bool opj_jp2_encode(        opj_jp2_v2_t *jp2,
 312                                                         opj_stream_private_t *stream,
 313                                                         opj_event_mgr_t * p_manager);
 314
 315
 316 /**
 317  * Starts a compression scheme, i.e. validates the codec parameters, writes the header.
 318  *
 319  * @param       jp2             the jpeg2000 file codec.
 320  * @param       stream          the stream object.
 321  * @param       p_image   FIXME DOC
 322  * @param p_manager FIXME DOC
 323  *
 324  * @return true if the codec is valid.
 325  */
 326 opj_bool opj_jp2_start_compress(opj_jp2_v2_t *jp2,
 327                                 opj_stream_private_t *stream,
 328                                 opj_image_t * p_image,
 329                                 opj_event_mgr_t * p_manager);
 330
 331
 332 /**
 333  * Ends the compression procedures and possibiliy add data to be read after the
 334  * codestream.
 335  */
 336 opj_bool opj_jp2_end_compress(  opj_jp2_v2_t *jp2,
 337                                                             opj_stream_private_t *cio,
 338                                                             opj_event_mgr_t * p_manager);
 339
 340 /* ----------------------------------------------------------------------- */
 341
 342 /**
 343  * Ends the decompression procedures and possibiliy add data to be read after the
 344  * codestream.
 345  */
 346 opj_bool opj_jp2_end_decompress(opj_jp2_v2_t *jp2,
 347                                 opj_stream_private_t *cio,
 348                                 opj_event_mgr_t * p_manager);
 349
 350 /**
 351  * Reads a jpeg2000 file header structure.
 352  *
 353  * @param p_stream the stream to read data from.
 354  * @param jp2 the jpeg2000 file header structure.
 355  * @param p_image   FIXME DOC
 356  * @param p_manager the user event manager.
 357  *
 358  * @return true if the box is valid.
 359  */
 360 opj_bool opj_jp2_read_header(   opj_stream_private_t *p_stream,
 361                                 opj_jp2_v2_t *jp2,
 362                                 opj_image_t ** p_image,
 363                                 opj_event_mgr_t * p_manager );
 364
 365 /**
 366  * Reads a tile header.
 367  * @param       p_jp2         the jpeg2000 codec.
 368  * @param       p_tile_index  FIXME DOC
 369  * @param       p_data_size   FIXME DOC
 370  * @param       p_tile_x0     FIXME DOC
 371  * @param       p_tile_y0     FIXME DOC
 372  * @param       p_tile_x1     FIXME DOC
 373  * @param       p_tile_y1     FIXME DOC
 374  * @param       p_nb_comps    FIXME DOC
 375  * @param       p_go_on       FIXME DOC
 376  * @param       p_stream      the stream to write data to.
 377  * @param       p_manager     the user event manager.
 378  */
 379 opj_bool opj_jp2_read_tile_header ( opj_jp2_v2_t * p_jp2,
 380                                     OPJ_UINT32 * p_tile_index,
 381                                     OPJ_UINT32 * p_data_size,
 382                                     OPJ_INT32 * p_tile_x0,
 383                                     OPJ_INT32 * p_tile_y0,
 384                                     OPJ_INT32 * p_tile_x1,
 385                                     OPJ_INT32 * p_tile_y1,
 386                                     OPJ_UINT32 * p_nb_comps,
 387                                     opj_bool * p_go_on,
 388                                     opj_stream_private_t *p_stream,
 389                                     opj_event_mgr_t * p_manager );
 390
 391 /**
 392  * Writes a tile.
 393  *
 394  * @param       p_jp2           the jpeg2000 codec.
 395  * @param p_tile_index  FIXME DOC
 396  * @param p_data        FIXME DOC
 397  * @param p_data_size   FIXME DOC
 398  * @param       p_stream                        the stream to write data to.
 399  * @param       p_manager       the user event manager.
 400  */
 401 opj_bool opj_jp2_write_tile (   opj_jp2_v2_t *p_jp2,
 402                                                             OPJ_UINT32 p_tile_index,
 403                                                             OPJ_BYTE * p_data,
 404                                                             OPJ_UINT32 p_data_size,
 405                                                             opj_stream_private_t *p_stream,
 406                                                             opj_event_mgr_t * p_manager );
 407
 408 /**
 409  * Decode tile data.
 410  * @param       p_jp2           the jpeg2000 codec.
 411  * @param       p_tile_index FIXME DOC
 412  * @param       p_data       FIXME DOC
 413  * @param       p_data_size  FIXME DOC
 414  * @param       p_stream                        the stream to write data to.
 415  * @param       p_manager       the user event manager.
 416  *
 417  * @return FIXME DOC
 418  */
 419 opj_bool opj_jp2_decode_tile (  opj_jp2_v2_t * p_jp2,
 420                                 OPJ_UINT32 p_tile_index,
 421                                 OPJ_BYTE * p_data,
 422                                 OPJ_UINT32 p_data_size,
 423                                 opj_stream_private_t *p_stream,
 424                                 opj_event_mgr_t * p_manager );
 425
 426 /**
 427  * Creates a jpeg2000 file decompressor.
 428  *
 429  * @return      an empty jpeg2000 file codec.
 430  */
 431 opj_jp2_v2_t* opj_jp2_create (opj_bool p_is_decoder);
 432
 433 /**
 434 Destroy a JP2 decompressor handle
 435 @param jp2 JP2 decompressor handle to destroy
 436 */
 437 void opj_jp2_destroy(opj_jp2_v2_t *jp2);
 438
 439
 440 /**
 441  * Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading.
 442  *
 443  * @param       p_jp2                   the jpeg2000 codec.
 444  * @param       p_image     FIXME DOC
 445  * @param       p_start_x   the left position of the rectangle to decode (in image coordinates).
 446  * @param       p_start_y               the up position of the rectangle to decode (in image coordinates).
 447  * @param       p_end_x                 the right position of the rectangle to decode (in image coordinates).
 448  * @param       p_end_y                 the bottom position of the rectangle to decode (in image coordinates).
 449  * @param       p_manager               the user event manager
 450  *
 451  * @return      true                    if the area could be set.
 452  */
 453 opj_bool opj_jp2_set_decode_area(       opj_jp2_v2_t *p_jp2,
 454                                                                     opj_image_t* p_image,
 455                                                                     OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,
 456                                                                     OPJ_INT32 p_end_x, OPJ_INT32 p_end_y,
 457                                                                     opj_event_mgr_t * p_manager );
 458
 459  /**
 460  *
 461  */
 462 opj_bool opj_jp2_get_tile(      opj_jp2_v2_t *p_jp2,
 463                             opj_stream_private_t *p_stream,
 464                             opj_image_t* p_image,
 465                             opj_event_mgr_t * p_manager,
 466                             OPJ_UINT32 tile_index );
 467
 468
 469 /**
 470  *
 471  */
 472 opj_bool opj_jp2_set_decoded_resolution_factor(opj_jp2_v2_t *p_jp2,
 473                                                OPJ_UINT32 res_factor,
 474                                                opj_event_mgr_t * p_manager);
 475
 476
 477 /* TODO MSD: clean these 3 functions */
 478 /**
 479  * Dump some elements from the JP2 decompression structure .
 480  *
 481  *@param p_jp2                          the jp2 codec.
 482  *@param flag                           flag to describe what elments are dump.
 483  *@param out_stream                     output stream where dump the elements.
 484  *
 485 */
 486 void jp2_dump (opj_jp2_v2_t* p_jp2, OPJ_INT32 flag, FILE* out_stream);
 487
 488 /**
 489  * Get the codestream info from a JPEG2000 codec.
 490  *
 491  *@param        p_jp2                           jp2 codec.
 492  *
 493  *@return       the codestream information extract from the jpg2000 codec
 494  */
 495 opj_codestream_info_v2_t* jp2_get_cstr_info(opj_jp2_v2_t* p_jp2);
 496
 497 /**
 498  * Get the codestream index from a JPEG2000 codec.
 499  *
 500  *@param        p_jp2                           jp2 codec.
 501  *
 502  *@return       the codestream index extract from the jpg2000 codec
 503  */
 504 opj_codestream_index_t* jp2_get_cstr_index(opj_jp2_v2_t* p_jp2);
 505
 506
 507 /*@}*/
 508
 509 /*@}*/
 510
 511 #endif /* __JP2_H */
 512