1 /* 2 * The copyright in this software is being made available under the 2-clauses 3 * BSD License, included below. This software may be subject to other third 4 * party and contributor rights, including patent rights, and no such rights 5 * are granted under this license. 6 * 7 * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium 8 * Copyright (c) 2002-2014, Professor Benoit Macq 9 * Copyright (c) 2001-2003, David Janssens 10 * Copyright (c) 2002-2003, Yannick Verschueren 11 * Copyright (c) 2003-2007, Francois-Olivier Devaux 12 * Copyright (c) 2003-2014, Antonin Descampe 13 * Copyright (c) 2005, Herve Drolon, FreeImage Team 14 * Copyright (c) 2008, 2011-2012, Centre National d'Etudes Spatiales (CNES), FR 15 * Copyright (c) 2012, CS Systemes d'Information, France 16 * All rights reserved. 17 * 18 * Redistribution and use in source and binary forms, with or without 19 * modification, are permitted provided that the following conditions 20 * are met: 21 * 1. Redistributions of source code must retain the above copyright 22 * notice, this list of conditions and the following disclaimer. 23 * 2. Redistributions in binary form must reproduce the above copyright 24 * notice, this list of conditions and the following disclaimer in the 25 * documentation and/or other materials provided with the distribution. 26 * 27 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS' 28 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 30 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 31 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 37 * POSSIBILITY OF SUCH DAMAGE. 38 */ 39 #ifndef __T2_H 40 #define __T2_H 41 /** 42 @file t2.h 43 @brief Implementation of a tier-2 coding (packetization of code-block data) (T2) 44 45 */ 46 47 /** @defgroup T2 T2 - Implementation of a tier-2 coding */ 48 /*@{*/ 49 50 /** 51 Tier-2 coding 52 */ 53 typedef struct opj_t2 { 54 55 /** Encoding: pointer to the src image. Decoding: pointer to the dst image. */ 56 opj_image_t *image; 57 /** pointer to the image coding parameters */ 58 opj_cp_t *cp; 59 } opj_t2_t; 60 61 /** @name Exported functions */ 62 /*@{*/ 63 /* ----------------------------------------------------------------------- */ 64 65 /** 66 Encode the packets of a tile to a destination buffer 67 @param t2 T2 handle 68 @param tileno number of the tile encoded 69 @param tile the tile for which to write the packets 70 @param maxlayers maximum number of layers 71 @param dest the destination buffer 72 @param p_data_written FIXME DOC 73 @param len the length of the destination buffer 74 @param cstr_info Codestream information structure 75 @param tpnum Tile part number of the current tile 76 @param tppos The position of the tile part flag in the progression order 77 @param pino FIXME DOC 78 @param t2_mode If == 0 In Threshold calculation ,If == 1 Final pass 79 */ 80 OPJ_BOOL opj_t2_encode_packets( opj_t2_t* t2, 81 OPJ_UINT32 tileno, 82 opj_tcd_tile_t *tile, 83 OPJ_UINT32 maxlayers, 84 OPJ_BYTE *dest, 85 OPJ_UINT32 * p_data_written, 86 OPJ_UINT32 len, 87 opj_codestream_info_t *cstr_info, 88 OPJ_UINT32 tpnum, 89 OPJ_INT32 tppos, 90 OPJ_UINT32 pino, 91 J2K_T2_MODE t2_mode); 92 93 /** 94 Decode the packets of a tile from a source buffer 95 @param t2 T2 handle 96 @param tileno number that identifies the tile for which to decode the packets 97 @param tile tile for which to decode the packets 98 @param src FIXME DOC 99 @param p_data_read the source buffer 100 @param len length of the source buffer 101 @param cstr_info FIXME DOC 102 103 @return FIXME DOC 104 */ 105 OPJ_BOOL opj_t2_decode_packets( opj_t2_t *t2, 106 OPJ_UINT32 tileno, 107 opj_tcd_tile_t *tile, 108 OPJ_BYTE *src, 109 OPJ_UINT32 * p_data_read, 110 OPJ_UINT32 len, 111 opj_codestream_index_t *cstr_info, 112 opj_event_mgr_t *p_manager); 113 114 /** 115 * Creates a Tier 2 handle 116 * 117 * @param p_image Source or destination image 118 * @param p_cp Image coding parameters. 119 * @return a new T2 handle if successful, NULL otherwise. 120 */ 121 opj_t2_t* opj_t2_create(opj_image_t *p_image, opj_cp_t *p_cp); 122 123 /** 124 Destroy a T2 handle 125 @param t2 T2 handle to destroy 126 */ 127 void opj_t2_destroy(opj_t2_t *t2); 128 129 /* ----------------------------------------------------------------------- */ 130 /*@}*/ 131 132 /*@}*/ 133 134 #endif /* __T2_H */ 135
