src/gdcmopenjpeg/libopenjpeg/jp2.h

   1 /*\r
   2  * Copyright (c) 2004, Yannick Verschueren\r
   3  * Copyright (c) 2005, Hervé Drolon, FreeImage Team\r
   4  * Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium\r
   5  * All rights reserved.\r
   6  *\r
   7  * Redistribution and use in source and binary forms, with or without\r
   8  * modification, are permitted provided that the following conditions\r
   9  * are met:\r
  10  * 1. Redistributions of source code must retain the above copyright\r
  11  *    notice, this list of conditions and the following disclaimer.\r
  12  * 2. Redistributions in binary form must reproduce the above copyright\r
  13  *    notice, this list of conditions and the following disclaimer in the\r
  14  *    documentation and/or other materials provided with the distribution.\r
  15  *\r
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'\r
  17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\r
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE\r
  20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR\r
  21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF\r
  22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS\r
  23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN\r
  24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)\r
  25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE\r
  26  * POSSIBILITY OF SUCH DAMAGE.\r
  27  */\r
  28 #ifndef __JP2_H\r
  29 #define __JP2_H\r
  30 /**\r
  31 @file jp2.h\r
  32 @brief The JPEG-2000 file format Reader/Writer (JP2)\r
  33 \r
  34 */\r
  35 \r
  36 /** @defgroup JP2 JP2 - JPEG-2000 file format reader/writer */\r
  37 /*@{*/\r
  38 \r
  39 #define JPIP_JPIP 0x6a706970\r
  40 \r
  41 #define JP2_JP   0x6a502020    /**< JPEG 2000 signature box */\r
  42 #define JP2_FTYP 0x66747970    /**< File type box */\r
  43 #define JP2_JP2H 0x6a703268    /**< JP2 header box */\r
  44 #define JP2_IHDR 0x69686472    /**< Image header box */\r
  45 #define JP2_COLR 0x636f6c72    /**< Colour specification box */\r
  46 #define JP2_JP2C 0x6a703263    /**< Contiguous codestream box */\r
  47 #define JP2_URL  0x75726c20    /**< URL box */\r
  48 #define JP2_DBTL 0x6474626c    /**< ??? */\r
  49 #define JP2_BPCC 0x62706363    /**< Bits per component box */\r
  50 #define JP2_JP2  0x6a703220    /**< File type fields */\r
  51 \r
  52 /* ----------------------------------------------------------------------- */\r
  53 \r
  54 /** \r
  55 JP2 component\r
  56 */\r
  57 typedef struct opj_jp2_comps {\r
  58   int depth;      \r
  59   int sgnd;       \r
  60   int bpcc;\r
  61 } opj_jp2_comps_t;\r
  62 \r
  63 /**\r
  64 JPEG-2000 file format reader/writer\r
  65 */\r
  66 typedef struct opj_jp2 {\r
  67   /** codec context */\r
  68   opj_common_ptr cinfo;\r
  69   /** handle to the J2K codec  */\r
  70   opj_j2k_t *j2k;\r
  71   unsigned int w;\r
  72   unsigned int h;\r
  73   unsigned int numcomps;\r
  74   unsigned int bpc;\r
  75   unsigned int C;\r
  76   unsigned int UnkC;\r
  77   unsigned int IPR;\r
  78   unsigned int meth;\r
  79   unsigned int approx;\r
  80   unsigned int enumcs;\r
  81   unsigned int precedence;\r
  82   unsigned int brand;\r
  83   unsigned int minversion;\r
  84   unsigned int numcl;\r
  85   unsigned int *cl;\r
  86   opj_jp2_comps_t *comps;\r
  87   opj_image_t *image;\r
  88   unsigned int j2k_codestream_offset;\r
  89   unsigned int j2k_codestream_length;\r
  90 } opj_jp2_t;\r
  91 \r
  92 /**\r
  93 JP2 Box\r
  94 */\r
  95 typedef struct opj_jp2_box {\r
  96   int length;\r
  97   int type;\r
  98   int init_pos;\r
  99 } opj_jp2_box_t;\r
 100 \r
 101 /** @name Exported functions */\r
 102 /*@{*/\r
 103 /* ----------------------------------------------------------------------- */\r
 104 /**\r
 105 Creates a JP2 decompression structure\r
 106 @param cinfo Codec context info\r
 107 @return Returns a handle to a JP2 decompressor if successful, returns NULL otherwise\r
 108 */\r
 109 opj_jp2_t* jp2_create_decompress(opj_common_ptr cinfo);\r
 110 /**\r
 111 Destroy a JP2 decompressor handle\r
 112 @param jp2 JP2 decompressor handle to destroy\r
 113 */\r
 114 void jp2_destroy_decompress(opj_jp2_t *jp2);\r
 115 /**\r
 116 Setup the decoder decoding parameters using user parameters.\r
 117 Decoding parameters are returned in jp2->j2k->cp. \r
 118 @param jp2 JP2 decompressor handle\r
 119 @param parameters decompression parameters\r
 120 */\r
 121 void jp2_setup_decoder(opj_jp2_t *jp2, opj_dparameters_t *parameters);\r
 122 /**\r
 123 Decode an image from a JPEG-2000 file stream\r
 124 @param jp2 JP2 decompressor handle\r
 125 @param cio Input buffer stream\r
 126 @return Returns a decoded image if successful, returns NULL otherwise\r
 127 */\r
 128 opj_image_t* jp2_decode(opj_jp2_t *jp2, opj_cio_t *cio);\r
 129 /**\r
 130 Creates a JP2 compression structure\r
 131 @param cinfo Codec context info\r
 132 @return Returns a handle to a JP2 compressor if successful, returns NULL otherwise\r
 133 */\r
 134 opj_jp2_t* jp2_create_compress(opj_common_ptr cinfo);\r
 135 /**\r
 136 Destroy a JP2 compressor handle\r
 137 @param jp2 JP2 compressor handle to destroy\r
 138 */\r
 139 void jp2_destroy_compress(opj_jp2_t *jp2);\r
 140 /**\r
 141 Setup the encoder parameters using the current image and using user parameters. \r
 142 Coding parameters are returned in jp2->j2k->cp. \r
 143 @param jp2 JP2 compressor handle\r
 144 @param parameters compression parameters\r
 145 @param image input filled image\r
 146 */\r
 147 void jp2_setup_encoder(opj_jp2_t *jp2, opj_cparameters_t *parameters, opj_image_t *image);\r
 148 /**\r
 149 Encode an image into a JPEG-2000 file stream\r
 150 @param jp2 JP2 compressor handle\r
 151 @param cio Output buffer stream\r
 152 @param image Image to encode\r
 153 @param index Name of the index file if required, NULL otherwise\r
 154 @return Returns true if successful, returns false otherwise\r
 155 */\r
 156 bool jp2_encode(opj_jp2_t *jp2, opj_cio_t *cio, opj_image_t *image, char *index);\r
 157 /* ----------------------------------------------------------------------- */\r
 158 /*@}*/\r
 159 \r
 160 /*@}*/\r
 161 \r
 162 #endif /* __JP2_H */\r
 163 \r