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 * Copyright (c) 2017, IntoPIX SA <support@intopix.com>
17 * All rights reserved.
18 *
19 * Redistribution and use in source and binary forms, with or without
20 * modification, are permitted provided that the following conditions
21 * are met:
22 * 1. Redistributions of source code must retain the above copyright
23 * notice, this list of conditions and the following disclaimer.
24 * 2. Redistributions in binary form must reproduce the above copyright
25 * notice, this list of conditions and the following disclaimer in the
26 * documentation and/or other materials provided with the distribution.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
29 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
32 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38 * POSSIBILITY OF SUCH DAMAGE.
39 */
40#ifndef OPJ_T2_H
41#define OPJ_T2_H
42/**
43@file t2.h
44@brief Implementation of a tier-2 coding (packetization of code-block data) (T2)
45
46*/
47
48/** @defgroup T2 T2 - Implementation of a tier-2 coding */
49/*@{*/
50
51/**
52Tier-2 coding
53*/
54typedef struct opj_t2 {
55
56 /** Encoding: pointer to the src image. Decoding: pointer to the dst image. */
57 opj_image_t *image;
58 /** pointer to the image coding parameters */
59 opj_cp_t *cp;
60} opj_t2_t;
61
62/** @name Exported functions */
63/*@{*/
64/* ----------------------------------------------------------------------- */
65
66/**
67Encode the packets of a tile to a destination buffer
68@param t2 T2 handle
69@param tileno number of the tile encoded
70@param tile the tile for which to write the packets
71@param maxlayers maximum number of layers
72@param dest the destination buffer
73@param p_data_written FIXME DOC
74@param len the length of the destination buffer
75@param cstr_info Codestream information structure
76@param tpnum Tile part number of the current tile
77@param tppos The position of the tile part flag in the progression order
78@param pino FIXME DOC
79@param t2_mode If == THRESH_CALC In Threshold calculation ,If == FINAL_PASS Final pass
80@param p_manager the user event manager
81*/
82OPJ_BOOL opj_t2_encode_packets(opj_t2_t* t2,
83 OPJ_UINT32 tileno,
84 opj_tcd_tile_t *tile,
85 OPJ_UINT32 maxlayers,
86 OPJ_BYTE *dest,
87 OPJ_UINT32 * p_data_written,
88 OPJ_UINT32 len,
89 opj_codestream_info_t *cstr_info,
90 OPJ_UINT32 tpnum,
91 OPJ_INT32 tppos,
92 OPJ_UINT32 pino,
93 J2K_T2_MODE t2_mode,
94 opj_event_mgr_t *p_manager);
95
96/**
97Decode the packets of a tile from a source buffer
98@param tcd TCD handle
99@param t2 T2 handle
100@param tileno number that identifies the tile for which to decode the packets
101@param tile tile for which to decode the packets
102@param src FIXME DOC
103@param p_data_read the source buffer
104@param len length of the source buffer
105@param cstr_info FIXME DOC
106@param p_manager the user event manager
107
108@return FIXME DOC
109 */
110OPJ_BOOL opj_t2_decode_packets(opj_tcd_t* tcd,
111 opj_t2_t *t2,
112 OPJ_UINT32 tileno,
113 opj_tcd_tile_t *tile,
114 OPJ_BYTE *src,
115 OPJ_UINT32 * p_data_read,
116 OPJ_UINT32 len,
117 opj_codestream_index_t *cstr_info,
118 opj_event_mgr_t *p_manager);
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*/
127opj_t2_t* opj_t2_create(opj_image_t *p_image, opj_cp_t *p_cp);
128
129/**
130Destroy a T2 handle
131@param t2 T2 handle to destroy
132*/
133void opj_t2_destroy(opj_t2_t *t2);
134
135/* ----------------------------------------------------------------------- */
136/*@}*/
137
138/*@}*/
139
140#endif /* OPJ_T2_H */
141