! : changed
+ : added
+December 3, 2011
+* [mathieu] Doxygen fix (Brad Hards on mailing list)
+
December 2, 2011
+ [mathieu] Adding CPack mechanism
* [mathieu] remove hack with bash around kdu_expand
*
*/
void opj_procedure_list_clear (opj_procedure_list_t * p_validation_list);
-
+/*@}*/
#endif /* __FUNCTION_LIST_H */
/**
* Reads a IHDR box - Image Header box
*
- * @param p_image_header_data pointer to actual data (already read from file)
* @param jp2 the jpeg2000 file codec.
+ * @param p_image_header_data pointer to actual data (already read from file)
* @param p_image_header_size the size of the image header
- * @param p_image_header_max_size maximum size of the header, any size bigger than this value should result the function to output false.
* @param p_manager the user event manager.
*
* @return true if the image header is valid, fale else.
/**
* Reads a Bit per Component box.
*
- * @param p_bpc_header_data pointer to actual data (already read from file)
* @param jp2 the jpeg2000 file codec.
+ * @param p_bpc_header_data pointer to actual data (already read from file)
* @param p_bpc_header_size pointer that will hold the size of the bpc header
- * @param p_bpc_header_max_size maximum size of the header, any size bigger than this value should result the function to output false.
* @param p_manager the user event manager.
*
- * @return true if the bpc header is valid, fale else.
+ * @return true if the bpc header is valid, false otherwise.
*/
opj_bool jp2_read_bpcc_v2( opj_jp2_v2_t *jp2,
unsigned char * p_bpc_header_data,
/**
* Reads a palette box.
*
- * @param p_bpc_header_data pointer to actual data (already read from file)
* @param jp2 the jpeg2000 file codec.
- * @param p_bpc_header_size pointer that will hold the size of the bpc header
- * @param p_bpc_header_max_size maximum size of the header, any size bigger than this value should result the function to output false.
+ * @param p_pclr_header_data pointer to actual data (already read from file)
+ * @param p_pclr_header_size pointer that will hold the size of the PCLR header
* @param p_manager the user event manager.
*
* @return true if the bpc header is valid, fale else.
/**
* Get the decoded tile.
*
- * @param p_jp2 the jpeg2000 codec.
+ * @param jp2 the jpeg2000 codec.
* @param p_stream input_stream
* @param p_image output image. .
* @param p_manager the user event manager
/**
* Helper function.
* Sets the stream to be a file stream. The FILE must have been open previously.
- * @param p_stream the stream to modify
- * @param p_file handler to an already open file.
+ * @param p_file the file stream to operate on
+ * @param p_is_read_stream whether the stream is a read stream (true) or not (false)
*/
OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create_default_file_stream (FILE * p_file, opj_bool p_is_read_stream);
OPJ_API opj_stream_t* OPJ_CALLCONV opj_stream_create_file_stream (FILE * p_file, OPJ_UINT32 p_buffer_size, opj_bool p_is_read_stream);
/**
* Decode an image from a JPEG-2000 codestream
- * @param dinfo decompressor handle
+ * @param p_decompressor decompressor handle
* @param cio Input buffer stream
- * @return Returns a decoded image if successful, returns NULL otherwise
+ * @param p_image the decoded image
+ * @return Returns a true on success, otherwise false
* */
OPJ_API opj_bool OPJ_CALLCONV opj_decode_v2(opj_codec_t *p_decompressor,
opj_stream_t * cio,
/**
* Destroy a decompressor handle
*
- * @param dinfo decompressor handle to destroy
+ * @param p_codec decompressor handle to destroy
*/
OPJ_API void OPJ_CALLCONV opj_destroy_codec(opj_codec_t * p_codec);
* @param p_ty1 pointer that will hold the Y1 parameter for the tile
* @param p_max_prec pointer that will hold the the maximum precision for all the bands of the tile
* @param p_max_res pointer that will hold the the maximum number of resolutions for all the poc inside the tile.
- * @param dx_min pointer that will hold the the minimum dx of all the components of all the resolutions for the tile.
- * @param dy_min pointer that will hold the the minimum dy of all the components of all the resolutions for the tile.
+ * @param p_dx_min pointer that will hold the the minimum dx of all the components of all the resolutions for the tile.
+ * @param p_dy_min pointer that will hold the the minimum dy of all the components of all the resolutions for the tile.
* @param p_resolutions pointer to an area corresponding to the one described above.
*/
void get_all_encoding_parameters(
* Allocates memory for a packet iterator. Data and data sizes are set by this operation.
* No other data is set. The include section of the packet iterator is not allocated.
*
- * @param p_image the image used to initialize the packet iterator (in fact only the number of components is relevant.
- * @param p_cp the coding parameters.
- * @param p_tile_no the index of the tile from which creating the packet iterator.
+ * @param image the image used to initialize the packet iterator (only the number of components is relevant).
+ * @param cp the coding parameters.
+ * @param tileno the index of the tile from which creating the packet iterator.
*/
opj_pi_iterator_t * pi_create( const opj_image_t *image,
const opj_cp_v2_t *cp,
* @param p_ty1 pointer that will hold the Y1 parameter for the tile
* @param p_max_prec pointer that will hold the the maximum precision for all the bands of the tile
* @param p_max_res pointer that will hold the the maximum number of resolutions for all the poc inside the tile.
- * @param dx_min pointer that will hold the the minimum dx of all the components of all the resolutions for the tile.
- * @param dy_min pointer that will hold the the minimum dy of all the components of all the resolutions for the tile.
+ * @param p_dx_min pointer that will hold the the minimum dx of all the components of all the resolutions for the tile.
+ * @param p_dy_min pointer that will hold the the minimum dy of all the components of all the resolutions for the tile.
* @param p_resolutions pointer to an area corresponding to the one described above.
*/
void get_all_encoding_parameters(
* Allocates memory for a packet iterator. Data and data sizes are set by this operation.
* No other data is set. The include section of the packet iterator is not allocated.
*
- * @param p_image the image used to initialize the packet iterator (in fact only the number of components is relevant.
- * @param p_cp the coding parameters.
- * @param p_tile_no the index of the tile from which creating the packet iterator.
+ * @param image the image used to initialize the packet iterator (only the number of components is relevant.
+ * @param cp the coding parameters.
+ * @param tileno the index of the tile from which creating the packet iterator.
*/
opj_pi_iterator_t * pi_create( const opj_image_t *image,
const opj_cp_v2_t *cp,
/**
Decode a packet of a tile from a source buffer
@param t2 T2 handle
-@param src Source buffer
-@param len Length of the source buffer
@param tile Tile for which to write the packets
@param tcp Tile coding parameters
@param pi Packet identity
+@param src Source buffer
+@param pack_info Packet information
+
@return
*/
static opj_bool t2_decode_packet_v2(
- opj_t2_v2_t* p_t2,
- opj_tcd_tile_v2_t *p_tile,
- opj_tcp_v2_t *p_tcp,
- opj_pi_iterator_t *p_pi,
- OPJ_BYTE *p_src,
- OPJ_UINT32 * p_data_read,
- OPJ_UINT32 p_max_length,
- opj_packet_info_t *p_pack_info);
+ opj_t2_v2_t* t2,
+ opj_tcd_tile_v2_t *tile,
+ opj_tcp_v2_t *tcp,
+ opj_pi_iterator_t *pi,
+ OPJ_BYTE *src,
+ OPJ_UINT32 * data_read,
+ OPJ_UINT32 max_length,
+ opj_packet_info_t *pack_info);
static opj_bool t2_skip_packet(
opj_t2_v2_t* p_t2,
opj_packet_info_t *pack_info);
/**
-@param seg
+@param cblk
+@param index
@param cblksty
@param first
*/
@file tcd.h
@brief Implementation of a tile coder/decoder (TCD)
-The functions in TCD.C have for goal to encode or decode each tile independently from
-each other. The functions in TCD.C are used by some function in J2K.C.
+The functions in TCD.C encode or decode each tile independently from
+each other. The functions in TCD.C are used by other functions in J2K.C.
*/
/** @defgroup TCD TCD - Implementation of a tile coder/decoder */
typedef struct opj_tcd_cblk_dec {
unsigned char* data; /* Data */
- opj_tcd_seg_t* segs; /* segments informations */
+ opj_tcd_seg_t* segs; /* segments information */
int x0, y0, x1, y1; /* dimension of the code-blocks : left upper corner (x0, y0) right low corner (x1,y1) */
int numbps;
int numlenbits;
typedef struct opj_tcd_cblk_dec_v2 {
OPJ_BYTE * data; /* Data */
- opj_tcd_seg_t* segs; /* segments informations */
+ opj_tcd_seg_t* segs; /* segments information */
OPJ_INT32 x0, y0, x1, y1; /* dimension of the code-blocks : left upper corner (x0, y0) right low corner (x1,y1) */
OPJ_UINT32 numbps;
OPJ_UINT32 numlenbits;
*/
typedef struct opj_tcd_precinct {
int x0, y0, x1, y1; /* dimension of the precinct : left upper corner (x0, y0) right low corner (x1,y1) */
- int cw, ch; /* number of precinct in width and heigth */
- union{ /* code-blocks informations */
+ int cw, ch; /* number of precinct in width and height */
+ union{ /* code-blocks information */
opj_tcd_cblk_enc_t* enc;
opj_tcd_cblk_dec_t* dec;
} cblks;
typedef struct opj_tcd_precinct_v2 {
OPJ_INT32 x0, y0, x1, y1; /* dimension of the precinct : left upper corner (x0, y0) right low corner (x1,y1) */
- OPJ_UINT32 cw, ch; /* number of precinct in width and heigth */
- union{ /* code-blocks informations */
+ OPJ_UINT32 cw, ch; /* number of precinct in width and height */
+ union{ /* code-blocks information */
opj_tcd_cblk_enc_v2_t* enc;
opj_tcd_cblk_dec_v2_t* dec;
} cblks;
FIXME: documentation
*/
typedef struct opj_tcd_image {
- int tw, th; /* number of tiles in width and heigth */
+ int tw, th; /* number of tiles in width and height */
opj_tcd_tile_t *tiles; /* Tiles information */
} opj_tcd_image_t;
void tcd_destroy_v2(opj_tcd_v2_t *tcd);
/**
- * Initialize the tile coder and may reuse some meory.
+ * Initialize the tile coder and may reuse some memory.
* @param p_tcd TCD handle.
* @param p_image raw image.
* @param p_cp coding parameters.
- * @param p_tile_no current tile index to encode.
*
* @return true if the encoding values could be set (false otherwise).
*/
* Allocates memory for decoding a specific tile.
*
* @param p_tcd the tile decoder.
- * @param p_image the image to decode.
- * @param p_cp the decoding parameters.
- * @param p_tile_no the index of the tile received in sequence. This not necesseraly lead to the
+ * @param p_tile_no the index of the tile received in sequence. This not necessarily lead to the
* tile at index p_tile_no.
- * @param p_cstr_info codestream info (if any).
*
- * @return true if the remaining data is sufficient.s
+ * @return true if the remaining data is sufficient.
*/
opj_bool tcd_init_decode_tile(
opj_tcd_v2_t *p_tcd,
projects / openjpeg.git / commitdiff