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