remove deprecated v1 style function j2k_read_cod

[openjpeg.git] / libopenjpeg / pi.h

diff --git a/libopenjpeg/pi.h b/libopenjpeg/pi.h
index 6ed2b94b4185492b2031389d61b8d033cec7bd5b..d1c8abf50954988cfae52407b1d189dff4b18c22 100644 (file)
--- a/libopenjpeg/pi.h
+++ b/libopenjpeg/pi.h
@@ -65,6 +65,8 @@ typedef struct opj_pi_comp {
 Packet iterator 
 */
 typedef struct opj_pi_iterator {
+       /** Enabling Tile part generation*/
+       char tp_on;
        /** precise if the packet has been already used (usefull for progression order change) */
        short int *include;
        /** layer step used to localize the packet in the include vector */
@@ -87,9 +89,9 @@ typedef struct opj_pi_iterator {
        int first;
        /** progression order change information */
        opj_poc_t poc;
-       /** */
+       /** number of components in the image */
        int numcomps;
-       /** */
+       /** Components*/
        opj_pi_comp_t *comps;
        int tx0, ty0, tx1, ty1;
        int x, y, dx, dy;
@@ -99,14 +101,89 @@ typedef struct opj_pi_iterator {
 /*@{*/
 /* ----------------------------------------------------------------------- */
 /**
-Create a packet iterator
+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
 */
-opj_pi_iterator_t *pi_create(opj_image_t * image, opj_cp_t * cp, int tileno);
+opj_pi_iterator_t *pi_initialise_encode(opj_image_t *image, opj_cp_t *cp, int tileno,J2K_T2_MODE t2_mode);
+
+/**
+ * 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_v2(    const struct opj_image *image,
+                                                                                       struct opj_cp_v2 *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_v2 *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  
+@param cp Coding parameters
+@param tileno Number that identifies the tile for which to list the packets
+@param pino Iterator index for pi
+@param tpnum Tile part number of the current tile
+@param tppos The position of the tile part flag in the progression order
+@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
+@return Returns true if an error is detected 
+*/
+opj_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);
+
+/**
+Modify the packet iterator for enabling tile part generation
+@param pi Handle to the packet iterator generated in pi_initialise_encode
+@param cp Coding parameters
+@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
+*/
+void pi_create_encode_v2( opj_pi_iterator_t *pi, struct opj_cp_v2 *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
+@param cp Coding parameters
+@param tileno Number that identifies the tile for which to list the packets
+@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);
+
+
+/**
+Create a packet iterator for Decoder
+@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
+@return Returns a packet iterator that points to the first packet of the tile
+@see pi_destroy
+*/
+opj_pi_iterator_t *pi_create_decode_v2(struct opj_image * image, struct opj_cp_v2 * cp, OPJ_UINT32 tileno);
+
 
 /**
 Destroy a packet iterator
@@ -117,12 +194,23 @@ Destroy a packet iterator
 */
 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_v2(
+                               opj_pi_iterator_t *p_pi,
+                               OPJ_UINT32 p_nb_elements);
+
 /**
 Modify the packet iterator to point to the next packet
 @param pi Packet iterator to modify
 @return Returns false if pi pointed to the last packet or else returns true 
 */
-bool pi_next(opj_pi_iterator_t * pi);
+opj_bool pi_next(opj_pi_iterator_t * pi);
 /* ----------------------------------------------------------------------- */
 /*@}*/