libopenjpeg/t2.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) 2001-2003, David Janssens
   5  * Copyright (c) 2002-2003, Yannick Verschueren
   6  * Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe
   7  * Copyright (c) 2005, Herve Drolon, FreeImage Team
   8  * All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29  * POSSIBILITY OF SUCH DAMAGE.
  30  */
  31 #ifndef __T2_H
  32 #define __T2_H
  33 /**
  34 @file t2.h
  35 @brief Implementation of a tier-2 coding (packetization of code-block data) (T2)
  36
  37 */
  38
  39 /** @defgroup T2 T2 - Implementation of a tier-2 coding */
  40 /*@{*/
  41
  42 /**
  43 Tier-2 coding
  44 */
  45 typedef struct opj_t2 {
  46         /** codec context */
  47         opj_common_ptr cinfo;
  48
  49         /** Encoding: pointer to the src image. Decoding: pointer to the dst image. */
  50         opj_image_t *image;
  51         /** pointer to the image coding parameters */
  52         opj_cp_t *cp;
  53 } opj_t2_t;
  54
  55 /**
  56 Tier-2 coding
  57 */
  58 typedef struct opj_t2_v2 {
  59         /** codec context */
  60         opj_common_ptr cinfo;
  61
  62         /** Encoding: pointer to the src image. Decoding: pointer to the dst image. */
  63         opj_image_t *image;
  64         /** pointer to the image coding parameters */
  65         opj_cp_v2_t *cp;
  66 } opj_t2_v2_t;
  67
  68 /** @name Exported functions */
  69 /*@{*/
  70 /* ----------------------------------------------------------------------- */
  71
  72 /**
  73 Encode the packets of a tile to a destination buffer
  74 @param t2 T2 handle
  75 @param tileno number of the tile encoded
  76 @param tile the tile for which to write the packets
  77 @param maxlayers maximum number of layers
  78 @param dest the destination buffer
  79 @param len the length of the destination buffer
  80 @param cstr_info Codestream information structure
  81 @param tpnum Tile part number of the current tile
  82 @param tppos The position of the tile part flag in the progression order
  83 @param pino
  84 @param t2_mode If == 0 In Threshold calculation ,If == 1 Final pass
  85 @param cur_totnum_tp The total number of tile parts in the current tile
  86 */
  87 int t2_encode_packets(opj_t2_t* t2,int tileno, opj_tcd_tile_t *tile, int maxlayers, unsigned char *dest, int len, opj_codestream_info_t *cstr_info,int tpnum, int tppos,int pino,J2K_T2_MODE t2_mode,int cur_totnum_tp);
  88
  89 /**
  90 Encode the packets of a tile to a destination buffer
  91 @param t2 T2 handle
  92 @param tileno number of the tile encoded
  93 @param tile the tile for which to write the packets
  94 @param maxlayers maximum number of layers
  95 @param dest the destination buffer
  96 @param len the length of the destination buffer
  97 @param cstr_info Codestream information structure
  98 @param tpnum Tile part number of the current tile
  99 @param tppos The position of the tile part flag in the progression order
 100 @param t2_mode If == 0 In Threshold calculation ,If == 1 Final pass
 101 */
 102 opj_bool t2_encode_packets_v2(  opj_t2_v2_t* t2,
 103                                                                 OPJ_UINT32 tileno,
 104                                                                 struct opj_tcd_tile_v2 *tile,
 105                                                                 OPJ_UINT32 maxlayers,
 106                                                                 OPJ_BYTE *dest,
 107                                                                 OPJ_UINT32 * p_data_written,
 108                                                                 OPJ_UINT32 len,
 109                                                                 struct opj_codestream_info *cstr_info,
 110                                                                 OPJ_UINT32 tpnum,
 111                                                                 OPJ_INT32 tppos,
 112                                                                 OPJ_UINT32 pino,
 113                                                                 J2K_T2_MODE t2_mode);
 114
 115 /**
 116 Decode the packets of a tile from a source buffer
 117 @param t2 T2 handle
 118 @param src the source buffer
 119 @param len length of the source buffer
 120 @param tileno number that identifies the tile for which to decode the packets
 121 @param tile tile for which to decode the packets
 122 @param cstr_info Codestream information structure
 123  */
 124 int t2_decode_packets(opj_t2_t *t2, unsigned char *src, int len, int tileno, opj_tcd_tile_t *tile, opj_codestream_info_t *cstr_info);
 125
 126 /**
 127 Decode the packets of a tile from a source buffer
 128 @param t2 T2 handle
 129 @param src the source buffer
 130 @param len length of the source buffer
 131 @param tileno number that identifies the tile for which to decode the packets
 132 @param tile tile for which to decode the packets
 133  */
 134 opj_bool t2_decode_packets_v2(  opj_t2_v2_t *t2,
 135                                                                 OPJ_UINT32 tileno,
 136                                                                 struct opj_tcd_tile_v2 *tile,
 137                                                                 OPJ_BYTE *src, OPJ_UINT32 * p_data_read,
 138                                                                 OPJ_UINT32 len,
 139                                                                 opj_codestream_index_t *cstr_info);
 140
 141 /**
 142  * Creates a Tier 2 handle
 143  *
 144  * @param       p_image         Source or destination image
 145  * @param       p_cp            Image coding parameters.
 146  * @return              a new T2 handle if successful, NULL otherwise.
 147 */
 148 opj_t2_v2_t* t2_create_v2(opj_image_t *p_image, opj_cp_v2_t *p_cp);
 149
 150 /**
 151 Create a T2 handle
 152 @param cinfo Codec context info
 153 @param image Source or destination image
 154 @param cp Image coding parameters
 155 @return Returns a new T2 handle if successful, returns NULL otherwise
 156 */
 157 opj_t2_t* t2_create(opj_common_ptr cinfo, opj_image_t *image, opj_cp_t *cp);
 158 /**
 159 Destroy a T2 handle
 160 @param t2 T2 handle to destroy
 161 */
 162 void t2_destroy(opj_t2_t *t2);
 163
 164 /**
 165 Destroy a T2 handle
 166 @param t2 T2 handle to destroy
 167 */
 168 void t2_destroy_v2(opj_t2_v2_t *t2);
 169
 170 /* ----------------------------------------------------------------------- */
 171 /*@}*/
 172
 173 /*@}*/
 174
 175 #endif /* __T2_H */