f16216e270
Functions should only have formal documentation in one place, and preferably in the declaration (i.e. repeated documentaiton should not be at both the declaration and the definition, because it causes too much maintenance to keep them syncronized). In cases where the definition is also the declaration (as is often the case for static functions in the .c files) the documentation was preserved at the first use of the function signature. Functions that are formally documented should contain documentation for each function argument. The clang 3.1 compiler issues documentation warnings when the documentation block with @params preceeding a declaration does not match the argument list. This patch set follows a convention used elsewere in openjpeg to add a placeholder FIXME DOC description where one was previously missing. Thanks to Hans Johnson.
183 lines
6.2 KiB
C
183 lines
6.2 KiB
C
/*
|
|
* Copyright (c) 2002-2007, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
|
|
* Copyright (c) 2002-2007, Professor Benoit Macq
|
|
* Copyright (c) 2001-2003, David Janssens
|
|
* Copyright (c) 2002-2003, Yannick Verschueren
|
|
* Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe
|
|
* Copyright (c) 2005, Herve Drolon, FreeImage Team
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
|
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
#ifndef __T2_H
|
|
#define __T2_H
|
|
/**
|
|
@file t2.h
|
|
@brief Implementation of a tier-2 coding (packetization of code-block data) (T2)
|
|
|
|
*/
|
|
|
|
/** @defgroup T2 T2 - Implementation of a tier-2 coding */
|
|
/*@{*/
|
|
|
|
/**
|
|
Tier-2 coding
|
|
*/
|
|
typedef struct opj_t2 {
|
|
/** codec context */
|
|
opj_common_ptr cinfo;
|
|
|
|
/** Encoding: pointer to the src image. Decoding: pointer to the dst image. */
|
|
opj_image_t *image;
|
|
/** pointer to the image coding parameters */
|
|
opj_cp_t *cp;
|
|
} opj_t2_t;
|
|
|
|
/**
|
|
Tier-2 coding
|
|
*/
|
|
typedef struct opj_t2_v2 {
|
|
/** codec context */
|
|
opj_common_ptr cinfo;
|
|
|
|
/** Encoding: pointer to the src image. Decoding: pointer to the dst image. */
|
|
opj_image_t *image;
|
|
/** pointer to the image coding parameters */
|
|
opj_cp_v2_t *cp;
|
|
} opj_t2_v2_t;
|
|
|
|
/** @name Exported functions */
|
|
/*@{*/
|
|
/* ----------------------------------------------------------------------- */
|
|
|
|
/**
|
|
Encode the packets of a tile to a destination buffer
|
|
@param t2 T2 handle
|
|
@param tileno number of the tile encoded
|
|
@param tile the tile for which to write the packets
|
|
@param maxlayers maximum number of layers
|
|
@param dest the destination buffer
|
|
@param len the length of the destination buffer
|
|
@param cstr_info Codestream information structure
|
|
@param tpnum Tile part number of the current tile
|
|
@param tppos The position of the tile part flag in the progression order
|
|
@param pino
|
|
@param t2_mode If == 0 In Threshold calculation ,If == 1 Final pass
|
|
@param cur_totnum_tp The total number of tile parts in the current tile
|
|
*/
|
|
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);
|
|
|
|
/**
|
|
Encode the packets of a tile to a destination buffer
|
|
@param t2 T2 handle
|
|
@param tileno number of the tile encoded
|
|
@param tile the tile for which to write the packets
|
|
@param maxlayers maximum number of layers
|
|
@param dest the destination buffer
|
|
@param p_data_written FIXME DOC
|
|
@param len the length of the destination buffer
|
|
@param cstr_info Codestream information structure
|
|
@param tpnum Tile part number of the current tile
|
|
@param tppos The position of the tile part flag in the progression order
|
|
@param pino FIXME DOC
|
|
@param t2_mode If == 0 In Threshold calculation ,If == 1 Final pass
|
|
*/
|
|
opj_bool t2_encode_packets_v2( opj_t2_v2_t* t2,
|
|
OPJ_UINT32 tileno,
|
|
struct opj_tcd_tile_v2 *tile,
|
|
OPJ_UINT32 maxlayers,
|
|
OPJ_BYTE *dest,
|
|
OPJ_UINT32 * p_data_written,
|
|
OPJ_UINT32 len,
|
|
struct opj_codestream_info *cstr_info,
|
|
OPJ_UINT32 tpnum,
|
|
OPJ_INT32 tppos,
|
|
OPJ_UINT32 pino,
|
|
J2K_T2_MODE t2_mode);
|
|
|
|
/**
|
|
Decode the packets of a tile from a source buffer
|
|
@param t2 T2 handle
|
|
@param src the source buffer
|
|
@param len length of the source buffer
|
|
@param tileno number that identifies the tile for which to decode the packets
|
|
@param tile tile for which to decode the packets
|
|
@param cstr_info Codestream information structure
|
|
*/
|
|
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);
|
|
|
|
/**
|
|
Decode the packets of a tile from a source buffer
|
|
@param t2 T2 handle
|
|
@param tileno number that identifies the tile for which to decode the packets
|
|
@param tile tile for which to decode the packets
|
|
@param src FIXME DOC
|
|
@param p_data_read the source buffer
|
|
@param len length of the source buffer
|
|
@param cstr_info FIXME DOC
|
|
|
|
@return FIXME DOC
|
|
*/
|
|
opj_bool t2_decode_packets_v2( opj_t2_v2_t *t2,
|
|
OPJ_UINT32 tileno,
|
|
struct opj_tcd_tile_v2 *tile,
|
|
OPJ_BYTE *src,
|
|
OPJ_UINT32 * p_data_read,
|
|
OPJ_UINT32 len,
|
|
opj_codestream_index_t *cstr_info);
|
|
|
|
/**
|
|
* Creates a Tier 2 handle
|
|
*
|
|
* @param p_image Source or destination image
|
|
* @param p_cp Image coding parameters.
|
|
* @return a new T2 handle if successful, NULL otherwise.
|
|
*/
|
|
opj_t2_v2_t* t2_create_v2(opj_image_t *p_image, opj_cp_v2_t *p_cp);
|
|
|
|
/**
|
|
Create a T2 handle
|
|
@param cinfo Codec context info
|
|
@param image Source or destination image
|
|
@param cp Image coding parameters
|
|
@return Returns a new T2 handle if successful, returns NULL otherwise
|
|
*/
|
|
opj_t2_t* t2_create(opj_common_ptr cinfo, opj_image_t *image, opj_cp_t *cp);
|
|
/**
|
|
Destroy a T2 handle
|
|
@param t2 T2 handle to destroy
|
|
*/
|
|
void t2_destroy(opj_t2_t *t2);
|
|
|
|
/**
|
|
Destroy a T2 handle
|
|
@param t2 T2 handle to destroy
|
|
*/
|
|
void t2_destroy_v2(opj_t2_v2_t *t2);
|
|
|
|
/* ----------------------------------------------------------------------- */
|
|
/*@}*/
|
|
|
|
/*@}*/
|
|
|
|
#endif /* __T2_H */
|