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         unsigned int j2k_codestream_offset;
  88         unsigned int j2k_codestream_length;
  89 } opj_jp2_t;
  90
  91 /**
  92 JP2 Box
  93 */
  94 typedef struct opj_jp2_box {
  95   int length;
  96   int type;
  97   int init_pos;
  98 } opj_jp2_box_t;
  99
 100 /** @name Exported functions */
 101 /*@{*/
 102 /* ----------------------------------------------------------------------- */
 103 /**
 104 Creates a JP2 decompression structure
 105 @param cinfo Codec context info
 106 @return Returns a handle to a JP2 decompressor if successful, returns NULL otherwise
 107 */
 108 opj_jp2_t* jp2_create_decompress(opj_common_ptr cinfo);
 109 /**
 110 Destroy a JP2 decompressor handle
 111 @param jp2 JP2 decompressor handle to destroy
 112 */
 113 void jp2_destroy_decompress(opj_jp2_t *jp2);
 114 /**
 115 Setup the decoder decoding parameters using user parameters.
 116 Decoding parameters are returned in jp2->j2k->cp.
 117 @param jp2 JP2 decompressor handle
 118 @param parameters decompression parameters
 119 */
 120 void jp2_setup_decoder(opj_jp2_t *jp2, opj_dparameters_t *parameters);
 121 /**
 122 Decode an image from a JPEG-2000 file stream
 123 @param jp2 JP2 decompressor handle
 124 @param cio Input buffer stream
 125 @return Returns a decoded image if successful, returns NULL otherwise
 126 */
 127 opj_image_t* jp2_decode(opj_jp2_t *jp2, opj_cio_t *cio);
 128 /**
 129 Creates a JP2 compression structure
 130 @param cinfo Codec context info
 131 @return Returns a handle to a JP2 compressor if successful, returns NULL otherwise
 132 */
 133 opj_jp2_t* jp2_create_compress(opj_common_ptr cinfo);
 134 /**
 135 Destroy a JP2 compressor handle
 136 @param jp2 JP2 compressor handle to destroy
 137 */
 138 void jp2_destroy_compress(opj_jp2_t *jp2);
 139 /**
 140 Setup the encoder parameters using the current image and using user parameters.
 141 Coding parameters are returned in jp2->j2k->cp.
 142 @param jp2 JP2 compressor handle
 143 @param parameters compression parameters
 144 @param image input filled image
 145 */
 146 void jp2_setup_encoder(opj_jp2_t *jp2, opj_cparameters_t *parameters, opj_image_t *image);
 147 /**
 148 Encode an image into a JPEG-2000 file stream
 149 @param jp2 JP2 compressor handle
 150 @param cio Output buffer stream
 151 @param image Image to encode
 152 @param index Name of the index file if required, NULL otherwise
 153 @return Returns true if successful, returns false otherwise
 154 */
 155 bool jp2_encode(opj_jp2_t *jp2, opj_cio_t *cio, opj_image_t *image, char *index);
 156 /* ----------------------------------------------------------------------- */
 157 /*@}*/
 158
 159 /*@}*/
 160
 161 #endif /* __JP2_H */
 162