/*
- * Copyright (c) 2002-2007, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
- * Copyright (c) 2002-2007, Professor Benoit Macq
+ * The copyright in this software is being made available under the 2-clauses
+ * BSD License, included below. This software may be subject to other third
+ * party and contributor rights, including patent rights, and no such rights
+ * are granted under this license.
+ *
+ * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
+ * Copyright (c) 2002-2014, 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) 2003-2007, Francois-Olivier Devaux
+ * Copyright (c) 2003-2014, Antonin Descampe
* Copyright (c) 2005, Herve Drolon, FreeImage Team
* All rights reserved.
*
Packet iterator
*/
typedef struct opj_pi_iterator {
- /** Enabling Tile part generation*/
- OPJ_BYTE tp_on;
- /** precise if the packet has been already used (usefull for progression order change) */
- OPJ_INT16 *include;
- /** layer step used to localize the packet in the include vector */
- OPJ_UINT32 step_l;
- /** resolution step used to localize the packet in the include vector */
- OPJ_UINT32 step_r;
- /** component step used to localize the packet in the include vector */
- OPJ_UINT32 step_c;
- /** precinct step used to localize the packet in the include vector */
- OPJ_UINT32 step_p;
- /** component that identify the packet */
- OPJ_UINT32 compno;
- /** resolution that identify the packet */
- OPJ_UINT32 resno;
- /** precinct that identify the packet */
- OPJ_UINT32 precno;
- /** layer that identify the packet */
- OPJ_UINT32 layno;
- /** 0 if the first packet TODO MSD xhange to opj_bool*/
- int first;
- /** progression order change information */
- opj_poc_t poc;
- /** number of components in the image */
- OPJ_UINT32 numcomps;
- /** Components*/
- opj_pi_comp_t *comps;
- /** FIXME DOC*/
- OPJ_INT32 tx0, ty0, tx1, ty1;
- /** FIXME DOC*/
- OPJ_INT32 x, y;
- /** FIXME DOC*/
- OPJ_UINT32 dx, dy;
+ /** Enabling Tile part generation*/
+ OPJ_BYTE tp_on;
+ /** precise if the packet has been already used (useful for progression order change) */
+ OPJ_INT16 *include;
+ /** layer step used to localize the packet in the include vector */
+ OPJ_UINT32 step_l;
+ /** resolution step used to localize the packet in the include vector */
+ OPJ_UINT32 step_r;
+ /** component step used to localize the packet in the include vector */
+ OPJ_UINT32 step_c;
+ /** precinct step used to localize the packet in the include vector */
+ OPJ_UINT32 step_p;
+ /** component that identify the packet */
+ OPJ_UINT32 compno;
+ /** resolution that identify the packet */
+ OPJ_UINT32 resno;
+ /** precinct that identify the packet */
+ OPJ_UINT32 precno;
+ /** layer that identify the packet */
+ OPJ_UINT32 layno;
+ /** 0 if the first packet */
+ OPJ_BOOL first;
+ /** progression order change information */
+ opj_poc_t poc;
+ /** number of components in the image */
+ OPJ_UINT32 numcomps;
+ /** Components*/
+ opj_pi_comp_t *comps;
+ /** FIXME DOC*/
+ OPJ_INT32 tx0, ty0, tx1, ty1;
+ /** FIXME DOC*/
+ OPJ_INT32 x, y;
+ /** FIXME DOC*/
+ OPJ_UINT32 dx, dy;
} opj_pi_iterator_t;
/** @name Exported functions */
@param pi Packet iterator to modify
@return Returns false if pi pointed to the last packet or else returns true
*/
-opj_bool opj_pi_next(opj_pi_iterator_t * pi);
+OPJ_BOOL opj_pi_next(opj_pi_iterator_t * pi);
/* ----------------------------------------------------------------------- */
/*@}*/