001: /*
002: * $RCSfile: CodedCBlkDataSrcDec.java,v $
003: * $Revision: 1.1 $
004: * $Date: 2005/02/11 05:02:06 $
005: * $State: Exp $
006: *
007: * Class: CodedCBlkDataSrcDec
008: *
009: * Description: Interface that defines a source of entropy coded
010: * data that is transferred in a code-block by
011: * code-block basis (decoder side).
012: *
013: *
014: *
015: * COPYRIGHT:
016: *
017: * This software module was originally developed by Raphaël Grosbois and
018: * Diego Santa Cruz (Swiss Federal Institute of Technology-EPFL); Joel
019: * Askelöf (Ericsson Radio Systems AB); and Bertrand Berthelot, David
020: * Bouchard, Félix Henry, Gerard Mozelle and Patrice Onno (Canon Research
021: * Centre France S.A) in the course of development of the JPEG2000
022: * standard as specified by ISO/IEC 15444 (JPEG 2000 Standard). This
023: * software module is an implementation of a part of the JPEG 2000
024: * Standard. Swiss Federal Institute of Technology-EPFL, Ericsson Radio
025: * Systems AB and Canon Research Centre France S.A (collectively JJ2000
026: * Partners) agree not to assert against ISO/IEC and users of the JPEG
027: * 2000 Standard (Users) any of their rights under the copyright, not
028: * including other intellectual property rights, for this software module
029: * with respect to the usage by ISO/IEC and Users of this software module
030: * or modifications thereof for use in hardware or software products
031: * claiming conformance to the JPEG 2000 Standard. Those intending to use
032: * this software module in hardware or software products are advised that
033: * their use may infringe existing patents. The original developers of
034: * this software module, JJ2000 Partners and ISO/IEC assume no liability
035: * for use of this software module or modifications thereof. No license
036: * or right to this software module is granted for non JPEG 2000 Standard
037: * conforming products. JJ2000 Partners have full right to use this
038: * software module for his/her own purpose, assign or donate this
039: * software module to any third party and to inhibit third parties from
040: * using this software module for non JPEG 2000 Standard conforming
041: * products. This copyright notice must be included in all copies or
042: * derivative works of this software module.
043: *
044: * Copyright (c) 1999/2000 JJ2000 Partners.
045: * */
046: package jj2000.j2k.entropy.decoder;
047:
048: import java.awt.Point;
049:
050: import jj2000.j2k.wavelet.synthesis.*;
051: import jj2000.j2k.image.*;
052:
053: /**
054: * This interface defines a source of entropy coded data and methods to
055: * transfer it in a code-block by code-block basis. In each call to
056: * 'geCodeBlock()' a specified coded code-block is returned.
057: *
058: * <P>This interface is the source of data for the entropy decoder. See the
059: * 'EntropyDecoder' class.
060: *
061: * <P>For each coded-code-block the entropy-coded data is returned along with
062: * its truncation point information in a 'DecLyrdCBlk' object.
063: *
064: * @see EntropyDecoder
065: *
066: * @see DecLyrdCBlk
067: *
068: * @see jj2000.j2k.codestream.reader.BitstreamReaderAgent
069: * */
070: public interface CodedCBlkDataSrcDec extends InvWTData {
071:
072: /**
073: * Returns the specified coded code-block, for the specified component, in
074: * the current tile. The first layer to return is indicated by 'fl'. The
075: * number of layers that is returned depends on 'nl' and the amount of
076: * data available.
077: *
078: * <P>The argument 'fl' is to be used by subsequent calls to this method
079: * for the same code-block. In this way supplamental data can be retrieved
080: * at a later time. The fact that data from more than one layer can be
081: * returned means that several packets from the same code-block, of the
082: * same component, and the same tile, have been concatenated.
083: *
084: * <P>The returned compressed code-block can have its progressive
085: * attribute set. If this attribute is set it means that more data can be
086: * obtained by subsequent calls to this method (subject to transmission
087: * delays, etc). If the progressive attribute is not set it means that the
088: * returned data is all the data that can be obtained for the specified
089: * subblock.
090: *
091: * <P>The compressed code-block is uniquely specified by the current tile,
092: * the component (identified by 'c'), the subband (indentified by 'sb')
093: * and the code-bock vertical and horizontal indexes 'm' and 'n'.
094: *
095: * <P>The 'ulx' and 'uly' members of the returned 'DecLyrdCBlk' object
096: * contain the coordinates of the top-left corner of the block, with
097: * respect to the tile, not the subband.
098: *
099: * @param c The index of the component, from 0 to N-1.
100: *
101: * @param m The vertical index of the code-block to return, in the
102: * specified subband.
103: *
104: * @param n The horizontal index of the code-block to return, in the
105: * specified subband.
106: *
107: * @param sb The subband in whic the requested code-block is.
108: *
109: * @param fl The first layer to return.
110: *
111: * @param nl The number of layers to return, if negative all available
112: * layers are returned, starting at 'fl'.
113: *
114: * @param ccb If not null this object is used to return the compressed
115: * code-block. If null a new object is created and returned. If the data
116: * array in ccb is not null then it can be reused to return the compressed
117: * data.
118: *
119: * @return The compressed code-block, with a certain number of layers
120: * determined by the available data and 'nl'.
121: * */
122: public DecLyrdCBlk getCodeBlock(int c, int m, int n, SubbandSyn sb,
123: int fl, int nl, DecLyrdCBlk ccb);
124: }
|