summaryrefslogtreecommitdiff
path: root/libopenjpeg/pi.h
diff options
context:
space:
mode:
authorAntonin Descampe <antonin@gmail.com>2008-07-31 18:47:41 +0000
committerAntonin Descampe <antonin@gmail.com>2008-07-31 18:47:41 +0000
commit7caaea18b728ead4e45226aafc09dba01e514a2d (patch)
tree1d5d19df20b82cee63a7de94fc8e04e8426cb7c7 /libopenjpeg/pi.h
parent8407e057c9e10c8fc2b5f4be56e603fae3f9063d (diff)
Deleting obsolete files and directories, adding v2-specific files and directories, updating existing files to v2. See README.v2 for more info
Diffstat (limited to 'libopenjpeg/pi.h')
-rw-r--r--libopenjpeg/pi.h107
1 files changed, 67 insertions, 40 deletions
diff --git a/libopenjpeg/pi.h b/libopenjpeg/pi.h
index b5e0f6a4..a8abbf74 100644
--- a/libopenjpeg/pi.h
+++ b/libopenjpeg/pi.h
@@ -5,6 +5,7 @@
* Copyright (c) 2002-2003, Yannick Verschueren
* Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe
* Copyright (c) 2005, Herve Drolon, FreeImage Team
+ * Copyright (c) 2008, Jerome Fimes, Communications & Systemes <jerome.fimes@c-s.fr>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
@@ -39,25 +40,29 @@ The functions in PI.C have for goal to realize a packet iterator that permits to
packet following the progression order and change of it. The functions in PI.C are used
by some function in T2.C.
*/
-
+#include "openjpeg.h"
+#include "t2.h"
/** @defgroup PI PI - Implementation of a packet iterator */
/*@{*/
+struct opj_poc;
+struct opj_image;
+struct opj_cp;
/**
FIXME: documentation
*/
typedef struct opj_pi_resolution {
- int pdx, pdy;
- int pw, ph;
+ OPJ_UINT32 pdx, pdy;
+ OPJ_UINT32 pw, ph;
} opj_pi_resolution_t;
/**
FIXME: documentation
*/
typedef struct opj_pi_comp {
- int dx, dy;
+ OPJ_UINT32 dx, dy;
/** number of resolution levels */
- int numresolutions;
+ OPJ_UINT32 numresolutions;
opj_pi_resolution_t *resolutions;
} opj_pi_comp_t;
@@ -66,50 +71,67 @@ Packet iterator
*/
typedef struct opj_pi_iterator {
/** Enabling Tile part generation*/
- char tp_on;
+ OPJ_BYTE tp_on;
/** precise if the packet has been already used (usefull for progression order change) */
- short int *include;
+ OPJ_INT16 *include;
/** layer step used to localize the packet in the include vector */
- int step_l;
+ OPJ_UINT32 step_l;
/** resolution step used to localize the packet in the include vector */
- int step_r;
+ OPJ_UINT32 step_r;
/** component step used to localize the packet in the include vector */
- int step_c;
+ OPJ_UINT32 step_c;
/** precinct step used to localize the packet in the include vector */
- int step_p;
+ OPJ_UINT32 step_p;
/** component that identify the packet */
- int compno;
+ OPJ_UINT32 compno;
/** resolution that identify the packet */
- int resno;
+ OPJ_UINT32 resno;
/** precinct that identify the packet */
- int precno;
+ OPJ_UINT32 precno;
/** layer that identify the packet */
- int layno;
- /** 0 if the first packet */
- int first;
+ OPJ_UINT32 layno;
/** progression order change information */
- opj_poc_t poc;
+ struct opj_poc poc;
/** number of components in the image */
- int numcomps;
+ OPJ_UINT32 numcomps;
/** Components*/
opj_pi_comp_t *comps;
- int tx0, ty0, tx1, ty1;
- int x, y, dx, dy;
+ OPJ_INT32 tx0, ty0, tx1, ty1;
+ OPJ_INT32 x, y;
+ OPJ_UINT32 dx, dy;
+ /** 0 if the first packet */
+ OPJ_UINT32 first : 1;
} opj_pi_iterator_t;
/** @name Exported functions */
/*@{*/
/* ----------------------------------------------------------------------- */
/**
-Create a packet iterator for Encoder
-@param image Raw image for which the packets will be listed
-@param cp Coding parameters
-@param tileno Number that identifies the tile for which to list the packets
-@param t2_mode If == 0 In Threshold calculation ,If == 1 Final pass
-@return Returns a packet iterator that points to the first packet of the tile
-@see pi_destroy
+ * Creates a packet iterator for encoding.
+ *
+ * @param p_image the image being encoded.
+ * @param p_cp the coding parameters.
+ * @param p_tile_no index of the tile being encoded.
+ * @param p_t2_mode the type of pass for generating the packet iterator
+ * @return a list of packet iterator that points to the first packet of the tile (not true).
*/
-opj_pi_iterator_t *pi_initialise_encode(opj_image_t *image, opj_cp_t *cp, int tileno,J2K_T2_MODE t2_mode);
+opj_pi_iterator_t *pi_initialise_encode(const struct opj_image *image,struct opj_cp *cp, OPJ_UINT32 tileno,J2K_T2_MODE t2_mode);
+
+/**
+ * Updates the encoding parameters of the codec.
+ *
+ * @param p_image the image being encoded.
+ * @param p_cp the coding parameters.
+ * @param p_tile_no index of the tile being encoded.
+*/
+void pi_update_encoding_parameters(
+ const struct opj_image *p_image,
+ struct opj_cp *p_cp,
+ OPJ_UINT32 p_tile_no
+ );
+
+
+
/**
Modify the packet iterator for enabling tile part generation
@param pi Handle to the packet iterator generated in pi_initialise_encode
@@ -117,10 +139,10 @@ Modify the packet iterator for enabling tile part generation
@param tileno Number that identifies the tile for which to list the packets
@param tpnum Tile part number of the current tile
@param tppos The position of the tile part flag in the progression order
-@param cur_totnum_tp The total number of tile parts in the current tile
-@return Returns true if an error is detected
*/
-bool pi_create_encode(opj_pi_iterator_t *pi, opj_cp_t *cp,int tileno, int pino,int tpnum, int tppos, J2K_T2_MODE t2_mode,int cur_totnum_tp);
+void pi_create_encode( opj_pi_iterator_t *pi, struct opj_cp *cp,OPJ_UINT32 tileno, OPJ_UINT32 pino,OPJ_UINT32 tpnum, OPJ_INT32 tppos, J2K_T2_MODE t2_mode);
+
+
/**
Create a packet iterator for Decoder
@param image Raw image for which the packets will be listed
@@ -129,16 +151,19 @@ Create a packet iterator for Decoder
@return Returns a packet iterator that points to the first packet of the tile
@see pi_destroy
*/
-opj_pi_iterator_t *pi_create_decode(opj_image_t * image, opj_cp_t * cp, int tileno);
+opj_pi_iterator_t *pi_create_decode(struct opj_image * image, struct opj_cp * cp, OPJ_UINT32 tileno);
+
+
/**
-Destroy a packet iterator
-@param pi Previously created packet iterator
-@param cp Coding parameters
-@param tileno Number that identifies the tile for which the packets were listed
-@see pi_create
-*/
-void pi_destroy(opj_pi_iterator_t *pi, opj_cp_t *cp, int tileno);
+ * Destroys a packet iterator array.
+ *
+ * @param p_pi the packet iterator array to destroy.
+ * @param p_nb_elements the number of elements in the array.
+ */
+void pi_destroy(
+ opj_pi_iterator_t *p_pi,
+ OPJ_UINT32 p_nb_elements);
/**
Modify the packet iterator to point to the next packet
@@ -146,6 +171,8 @@ Modify the packet iterator to point to the next packet
@return Returns false if pi pointed to the last packet or else returns true
*/
bool pi_next(opj_pi_iterator_t * pi);
+
+
/* ----------------------------------------------------------------------- */
/*@}*/