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 p_data_written   FIXME DOC
  80 @param len              the length of the destination buffer
  81 @param cstr_info        Codestream information structure
  82 @param tpnum            Tile part number of the current tile
  83 @param tppos            The position of the tile part flag in the progression order
  84 @param pino             FIXME DOC
  85 @param t2_mode          If == 0 In Threshold calculation ,If == 1 Final pass
  86 */
  87 opj_bool opj_t2_encode_packets( opj_t2_v2_t* t2,
  88                                                                 OPJ_UINT32 tileno,
  89                                                                 opj_tcd_tile_v2_t *tile,
  90                                                                 OPJ_UINT32 maxlayers,
  91                                                                 OPJ_BYTE *dest,
  92                                                                 OPJ_UINT32 * p_data_written,
  93                                                                 OPJ_UINT32 len,
  94                                                                 opj_codestream_info_t *cstr_info,
  95                                                                 OPJ_UINT32 tpnum,
  96                                                                 OPJ_INT32 tppos,
  97                                                                 OPJ_UINT32 pino,
  98                                                                 J2K_T2_MODE t2_mode);
  99
 100 /**
 101 Decode the packets of a tile from a source buffer
 102 @param t2 T2 handle
 103 @param tileno number that identifies the tile for which to decode the packets
 104 @param tile tile for which to decode the packets
 105 @param src         FIXME DOC
 106 @param p_data_read the source buffer
 107 @param len length of the source buffer
 108 @param cstr_info   FIXME DOC
 109
 110 @return FIXME DOC
 111  */
 112 opj_bool opj_t2_decode_packets( opj_t2_v2_t *t2,
 113                                 OPJ_UINT32 tileno,
 114                                 opj_tcd_tile_v2_t *tile,
 115                                 OPJ_BYTE *src,
 116                                 OPJ_UINT32 * p_data_read,
 117                                 OPJ_UINT32 len,
 118                                 opj_codestream_index_t *cstr_info);
 119
 120 /**
 121  * Creates a Tier 2 handle
 122  *
 123  * @param       p_image         Source or destination image
 124  * @param       p_cp            Image coding parameters.
 125  * @return              a new T2 handle if successful, NULL otherwise.
 126 */
 127 opj_t2_v2_t* opj_t2_create(opj_image_t *p_image, opj_cp_v2_t *p_cp);
 128
 129 /**
 130 Destroy a T2 handle
 131 @param t2 T2 handle to destroy
 132 */
 133 void opj_t2_destroy(opj_t2_v2_t *t2);
 134
 135 /* ----------------------------------------------------------------------- */
 136 /*@}*/
 137
 138 /*@}*/
 139
 140 #endif /* __T2_H */