001: /*
002: * $RCSfile: CodedCBlkDataSrcEnc.java,v $
003: * $Revision: 1.1 $
004: * $Date: 2005/02/11 05:02:08 $
005: * $State: Exp $
006: *
007: * Class: CodedCBlkDataSrcEnc
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.
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: *
047: *
048: */
049:
050: package jj2000.j2k.entropy.encoder;
051:
052: import java.awt.Point;
053:
054: import jj2000.j2k.wavelet.analysis.*;
055: import jj2000.j2k.image.*;
056:
057: /**
058: * This interface defines a source of entropy coded data and methods to
059: * transfer it in a code-block by code-block basis. In each call to
060: * 'getNextCodeBlock()' a new coded code-block is returned. The code-block are
061: * retruned in no specific-order.
062: *
063: * <P>This interface is the source of data for the rate allocator. See the
064: * 'PostCompRateAllocator' class.
065: *
066: * <P>For each coded-code-block the entropy-coded data is returned along with
067: * the rate-distortion statistics in a 'CBlkRateDistStats' object.
068: *
069: * @see PostCompRateAllocator
070: *
071: * @see CBlkRateDistStats
072: *
073: * @see EntropyCoder
074: * */
075: public interface CodedCBlkDataSrcEnc extends ForwWTDataProps {
076:
077: /**
078: * Returns the next coded code-block in the current tile for the specified
079: * component, as a copy (see below). The order in which code-blocks are
080: * returned is not specified. However each code-block is returned only
081: * once and all code-blocks will be returned if the method is called 'N'
082: * times, where 'N' is the number of code-blocks in the tile. After all
083: * the code-blocks have been returned for the current tile calls to this
084: * method will return 'null'.
085: *
086: * <P>When changing the current tile (through 'setTile()' or 'nextTile()')
087: * this method will always return the first code-block, as if this method
088: * was never called before for the new current tile.
089: *
090: * <P>The data returned by this method is always a copy of the internal
091: * data of this object, if any, and it can be modified "in place" without
092: * any problems after being returned.
093: *
094: * @param c The component for which to return the next code-block.
095: *
096: * @param ccb If non-null this object might be used in returning the coded
097: * code-block in this or any subsequent call to this method. If null a new
098: * one is created and returned. If the 'data' array of 'cbb' is not null
099: * it may be reused to return the compressed data.
100: *
101: * @return The next coded code-block in the current tile for component
102: * 'n', or null if all code-blocks for the current tile have been
103: * returned.
104: *
105: * @see CBlkRateDistStats
106: *
107: *
108: * */
109: public CBlkRateDistStats getNextCodeBlock(int c,
110: CBlkRateDistStats ccb);
111:
112: /**
113: * Returns the width of a packet for the specified tile-
114: * component and resolution level.
115: *
116: * @param t The tile
117: *
118: * @param c The component
119: *
120: * @param r The resolution level
121: *
122: * @return The width of a packet for the specified tile-
123: * component and resolution level.
124: *
125: * */
126: public int getPPX(int t, int c, int r);
127:
128: /**
129: * Returns the height of a packet for the specified tile-
130: * component and resolution level.
131: *
132: * @param t The tile
133: *
134: * @param c The component
135: *
136: * @param r The resolution level
137: *
138: * @return The height of a packet for the specified tile-
139: * component and resolution level.
140: *
141: * */
142: public int getPPY(int t, int c, int r);
143:
144: /**
145: * Returns true if the precinct partition is used for the
146: * specified component and tile, returns false otherwise
147: *
148: * @param c The component
149: *
150: * @param t The tile
151: *
152: */
153: public boolean precinctPartitionUsed(int c, int t);
154: }
|