/*  * CVS identifier: *  * $Id: CodedCBlkDataSrcDec.java,v 1.16 2001/02/14 17:33:53 grosbois Exp $ *  * Class:                   CodedCBlkDataSrcDec *  * Description:             Interface that defines a source of entropy coded *                          data that is transferred in a code-block by *                          code-block basis (decoder side). *  *  *  * COPYRIGHT: *  * This software module was originally developed by Rapha雔 Grosbois and * Diego Santa Cruz (Swiss Federal Institute of Technology-EPFL); Joel * Askel鰂 (Ericsson Radio Systems AB); and Bertrand Berthelot, David * Bouchard, F閘ix Henry, Gerard Mozelle and Patrice Onno (Canon Research * Centre France S.A) in the course of development of the JPEG2000 * standard as specified by ISO/IEC 15444 (JPEG 2000 Standard). This * software module is an implementation of a part of the JPEG 2000 * Standard. Swiss Federal Institute of Technology-EPFL, Ericsson Radio * Systems AB and Canon Research Centre France S.A (collectively JJ2000 * Partners) agree not to assert against ISO/IEC and users of the JPEG * 2000 Standard (Users) any of their rights under the copyright, not * including other intellectual property rights, for this software module * with respect to the usage by ISO/IEC and Users of this software module * or modifications thereof for use in hardware or software products * claiming conformance to the JPEG 2000 Standard. Those intending to use * this software module in hardware or software products are advised that * their use may infringe existing patents. The original developers of * this software module, JJ2000 Partners and ISO/IEC assume no liability * for use of this software module or modifications thereof. No license * or right to this software module is granted for non JPEG 2000 Standard * conforming products. JJ2000 Partners have full right to use this * software module for his/her own purpose, assign or donate this * software module to any third party and to inhibit third parties from * using this software module for non JPEG 2000 Standard conforming * products. This copyright notice must be included in all copies or * derivative works of this software module. *  * Copyright (c) 1999/2000 JJ2000 Partners. *  */package jj2000.j2k.entropy.decoder;import jj2000.j2k.wavelet.synthesis.*;import jj2000.j2k.image.*;/** * This interface defines a source of entropy coded data and methods to * transfer it in a code-block by code-block basis. In each call to * 'geCodeBlock()' a specified coded code-block is returned. * * <P>This interface is the source of data for the entropy decoder. See the * 'EntropyDecoder' class. * * <P>For each coded-code-block the entropy-coded data is returned along with * its truncation point information in a 'DecLyrdCBlk' object. * * @see EntropyDecoder * * @see DecLyrdCBlk * * @see jj2000.j2k.codestream.reader.BitstreamReaderAgent * */public interface CodedCBlkDataSrcDec extends InvWTData {    /**     * Returns the number of code-blocks in a subband, along the horizontal     * and vertical dimensions.     *     * @param sb The subband for which to return the number of blocks.     *     * @param c The component where the subband is.     *     * @param co If not null the values are returned in this object. If null a     * new object is allocated and returned.     *     * @return The number of code-blocks along the horizontal dimension in     * 'Coord.x' and the number of code-blocks along the vertical dimension in     * 'Coord.y'.     * */    public Coord getNumCodeBlocks(SubbandSyn sb, int c, Coord co);    /**     * Returns the specified coded code-block, for the specified component, in     * the current tile. The first layer to return is indicated by 'fl'. The     * number of layers that is returned depends on 'nl' and the amount of     * data available.     *     * <P>The argument 'fl' is to be used by subsequent calls to this method     * for the same code-block. In this way supplamental data can be retrieved     * at a later time. The fact that data from more than one layer can be     * returned means that several packets from the same code-block, of the     * same component, and the same tile, have been concatenated.     *     * <P>The returned compressed code-block can have its progressive     * attribute set. If this attribute is set it means that more data can be     * obtained by subsequent calls to this method (subject to transmission     * delays, etc). If the progressive attribute is not set it means that the     * returned data is all the data that can be obtained for the specified     * subblock.     *     * <P>The compressed code-block is uniquely specified by the current tile,     * the component (identified by 'c'), the subband (indentified by 'sb')     * and the code-bock vertical and horizontal indexes 'm' and 'n'.     *     * <P>The 'ulx' and 'uly' members of the returned 'DecLyrdCBlk' object     * contain the coordinates of the top-left corner of the block, with     * respect to the tile, not the subband.     *     * @param c The index of the component, from 0 to N-1.     *     * @param m The vertical index of the code-block to return, in the     * specified subband.     *     * @param n The horizontal index of the code-block to return, in the     * specified subband.     *     * @param sb The subband in whic the requested code-block is.     *     * @param fl The first layer to return.     *     * @param nl The number of layers to return, if negative all available     * layers are returned, starting at 'fl'.     *     * @param ccb If not null this object is used to return the compressed     * code-block. If null a new object is created and returned. If the data     * array in ccb is not null then it can be reused to return the compressed     * data.     *     * @return The compressed code-block, with a certain number of layers     * determined by the available data and 'nl'.     * */    public DecLyrdCBlk getCodeBlock(int c, int m, int n,                                         SubbandSyn sb, int fl, int nl,                                         DecLyrdCBlk ccb);}