001/*
002 * $RCSfile: PktInfo.java,v $
003 * $Revision: 1.1 $
004 * $Date: 2005/02/11 05:02:02 $
005 * $State: Exp $
006 *
007 * Class:                   PktInfo
008 *
009 * Description:             Object containing packet informations.
010 *
011 *
012 *
013 * COPYRIGHT:
014 *
015 * This software module was originally developed by Raphaël Grosbois and
016 * Diego Santa Cruz (Swiss Federal Institute of Technology-EPFL); Joel
017 * Askelöf (Ericsson Radio Systems AB); and Bertrand Berthelot, David
018 * Bouchard, Félix Henry, Gerard Mozelle and Patrice Onno (Canon Research
019 * Centre France S.A) in the course of development of the JPEG2000
020 * standard as specified by ISO/IEC 15444 (JPEG 2000 Standard). This
021 * software module is an implementation of a part of the JPEG 2000
022 * Standard. Swiss Federal Institute of Technology-EPFL, Ericsson Radio
023 * Systems AB and Canon Research Centre France S.A (collectively JJ2000
024 * Partners) agree not to assert against ISO/IEC and users of the JPEG
025 * 2000 Standard (Users) any of their rights under the copyright, not
026 * including other intellectual property rights, for this software module
027 * with respect to the usage by ISO/IEC and Users of this software module
028 * or modifications thereof for use in hardware or software products
029 * claiming conformance to the JPEG 2000 Standard. Those intending to use
030 * this software module in hardware or software products are advised that
031 * their use may infringe existing patents. The original developers of
032 * this software module, JJ2000 Partners and ISO/IEC assume no liability
033 * for use of this software module or modifications thereof. No license
034 * or right to this software module is granted for non JPEG 2000 Standard
035 * conforming products. JJ2000 Partners have full right to use this
036 * software module for his/her own purpose, assign or donate this
037 * software module to any third party and to inhibit third parties from
038 * using this software module for non JPEG 2000 Standard conforming
039 * products. This copyright notice must be included in all copies or
040 * derivative works of this software module.
041 *
042 * Copyright (c) 1999/2000 JJ2000 Partners.
043 * */
044package jj2000.j2k.codestream.reader;
045
046
047/**
048 * This class defines an object used to countain informations about a packet
049 * to which the current code-block belongs.
050 *
051 * @see CBlkInfo
052 * */
053public class PktInfo{
054
055    /** Index of the packet */
056    public int packetIdx;
057
058    /** The layer associated with the current code-block in this packet. */
059    public int layerIdx;
060
061    /** The code-block offset in the codestream (for this packet) */
062    public int cbOff = 0;
063
064    /** The length of the code-block in this packet (in bytes) */
065    public int cbLength;
066
067    /**
068     * The length of each terminated segment in the packet. The total is the
069     * same as 'cbLength'. It can be null if there is only one terminated
070     * segment, in which case 'cbLength' holds the legth of that segment
071     * */
072    public int segLengths[];
073
074    /**
075     * The number of truncation points that appear in this packet, and all
076     * previous packets, for this code-block. This is the number of passes
077     * that can be decoded with the information in this packet and all
078     * previous ones.
079     * */
080    public int numTruncPnts;
081
082    /**
083     * Classe's constructor.
084     *
085     * @param lyIdx The layer index for the code-block in this packet
086     *
087     * @param pckIdx The packet index
088     * */
089    public PktInfo(int lyIdx, int pckIdx){
090        layerIdx = lyIdx;
091        packetIdx = pckIdx;
092    }
093
094    /**
095     * Object information in a string.
096     *
097     * @return Object information
098     * */
099    public String toString(){
100        return "packet "+packetIdx+" (lay:"+layerIdx+", off:"+cbOff+", len:"+
101            cbLength+", numTruncPnts:"+numTruncPnts+")\n";
102    }
103}