X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=libopenjpeg%2Fpi.h;h=b5e0f6a4df85060d51be5c85576cd95a90deb9f0;hb=203a264f96b585427f58f88d2d7af3dcd59c905d;hp=f450304a8d291dedc0c03cf280506287b77a5ea9;hpb=bb349b2ceee6027ab19f9fe20ed6d8c6a18a15a2;p=openjpeg.git

diff --git a/libopenjpeg/pi.h b/libopenjpeg/pi.h
index f450304a..b5e0f6a4 100644
--- a/libopenjpeg/pi.h
+++ b/libopenjpeg/pi.h
@@ -1,5 +1,10 @@
 /*
- * Copyright (c) 2001-2002, David Janssens
+ * 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
@@ -26,47 +31,124 @@
 
 #ifndef __PI_H
 #define __PI_H
+/**
+@file pi.h
+@brief Implementation of a packet iterator (PI)
 
-#include "j2k.h"
-#include "tcd.h"
+The functions in PI.C have for goal to realize a packet iterator that permits to get the next
+packet following the progression order and change of it. The functions in PI.C are used
+by some function in T2.C.
+*/
 
-typedef struct {
-	int pdx, pdy;
-	int pw, ph;
-} pi_resolution_t;
+/** @defgroup PI PI - Implementation of a packet iterator */
+/*@{*/
 
-typedef struct {
-	int dx, dy;
-	int numresolutions;
-	pi_resolution_t *resolutions;
-} pi_comp_t;
+/**
+FIXME: documentation
+*/
+typedef struct opj_pi_resolution {
+  int pdx, pdy;
+  int pw, ph;
+} opj_pi_resolution_t;
 
-typedef struct {
-        short int *include;                     /* precise if the packet has been already used (usefull for progression order change) */
-        int step_l, step_r, step_c, step_p;     /* different steps (layer, resolution, component, precinct) to localize the packet in the include vector */ 
-	int compno, resno, precno, layno;	/* component, resolution, precinct and layer that indentify the packet */
-        int first;                              /* 0 if the first packet */
-	j2k_poc_t poc;
+/**
+FIXME: documentation
+*/
+typedef struct opj_pi_comp {
+  int dx, dy;
+  /** number of resolution levels */
+  int numresolutions;
+  opj_pi_resolution_t *resolutions;
+} opj_pi_comp_t;
+
+/** 
+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 */
+	int step_l;
+	/** resolution step used to localize the packet in the include vector */
+	int step_r;	
+	/** component step used to localize the packet in the include vector */
+	int step_c;	
+	/** precinct step used to localize the packet in the include vector */
+	int step_p;	
+	/** component that identify the packet */
+	int compno;
+	/** resolution that identify the packet */
+	int resno;
+	/** precinct that identify the packet */
+	int precno;
+	/** layer that identify the packet */
+	int layno;   
+	/** 0 if the first packet */
+	int first;
+	/** progression order change information */
+	opj_poc_t poc;
+	/** number of components in the image */
 	int numcomps;
-	pi_comp_t *comps;
+	/** Components*/
+	opj_pi_comp_t *comps;
 	int tx0, ty0, tx1, ty1;
 	int x, y, dx, dy;
-} pi_iterator_t;				/* packet iterator */
+} opj_pi_iterator_t;
 
-/*
- * Create a packet iterator
- * img: raw image for which the packets will be listed
- * cp: coding paremeters
- * tileno: number that identifies the tile for which to list the packets
- * return value: returns a packet iterator that points to the first packet of the tile
- */
-pi_iterator_t *pi_create(j2k_image_t * img, j2k_cp_t * cp, int tileno);
+/** @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
+*/
+opj_pi_iterator_t *pi_initialise_encode(opj_image_t *image, opj_cp_t *cp, int tileno,J2K_T2_MODE t2_mode);
+/**
+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
+@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);
+/**
+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);
 
-/* 
- * Modify the packet iterator to point to the next packet
- * pi: packet iterator to modify
- * return value: returns 0 if pi pointed to the last packet or else returns 1 
- */
-int pi_next(pi_iterator_t * pi);
+/**
+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);
+
+/**
+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);
+/* ----------------------------------------------------------------------- */
+/*@}*/
+
+/*@}*/
 
-#endif
+#endif /* __PI_H */