Class SymbolDictionary

java.lang.Object

org.apache.pdfbox.jbig2.segments.SymbolDictionary

All Implemented Interfaces:

Dictionary, SegmentData

public class SymbolDictionary
extends Object
implements Dictionary

This class represents the data of segment type "Symbol dictionary". Parsing is described in 7.4.2.1.1 - 7.4.1.1.5 and decoding procedure is described in 6.5.

Field Summary

Fields

Modifier and Type	Field	Description
private HuffmanTable	aggInstTable
private int	amountOfDecodedSymbols
private int	amountOfExportSymbolss	Number of exported symbols, 7.4.2.1.4
private int	amountOfImportedSymbolss
private int	amountOfNewSymbols	Number of new symbols, 7.4.2.1.5
private ArithmeticDecoder	arithmeticDecoder
private HuffmanTable	bmSizeTable
private CX	cx
private CX	cxIAAI
private CX	cxIADH
private CX	cxIADT
private CX	cxIADW
private CX	cxIAEX
protected CX	cxIAID
private CX	cxIARDX
private CX	cxIARDY
private HuffmanTable	dhTable	User-supplied tables *
private HuffmanTable	dwTable
private ArrayList<Bitmap>	exportSymbols	Return value of that segment
private GenericRefinementRegion	genericRefinementRegion
private GenericRegion	genericRegion
private ArithmeticIntegerDecoder	iDecoder
private ArrayList<Bitmap>	importSymbols
private boolean	isCodingContextRetained
private boolean	isCodingContextUsed
private boolean	isHuffmanEncoded
private Bitmap[]	newSymbols
private ArrayList<Bitmap>	sbSymbols
private int	sbSymCodeLen
private short[]	sdATX	Symbol dictionary AT flags, 7.4.2.1.2
private short[]	sdATY
private short	sdHuffAggInstanceSelection
private short	sdHuffBMSizeSelection
private short	sdHuffDecodeHeightSelection
private short	sdHuffDecodeWidthSelection
private short[]	sdrATX	Symbol dictionary refinement AT flags, 7.4.2.1.3
private short[]	sdrATY
private short	sdrTemplate	Symbol dictionary flags, 7.4.2.1.1
private byte	sdTemplate
private SegmentHeader	segmentHeader	Further parameters
private SubInputStream	subInputStream
private TextRegion	textRegion
private boolean	useRefinementAggregation

Constructor Summary

Constructors

Constructor	Description
SymbolDictionary()
SymbolDictionary(SubInputStream subInputStream, SegmentHeader segmentHeader)

Method Summary

Modifier and Type	Method	Description
private final void	addSymbol(Region region)
private void	checkInput()
private final void	decodeAggregate(int symbolWidth, int heightClassHeight)
private final long	decodeDifferenceWidth()
private final void	decodeDirectlyThroughGenericRegion(int symWidth, int hcHeight)
private final void	decodeHeightClassBitmap(Bitmap heightClassCollectiveBitmap, int heightClassFirstSymbol, int heightClassHeight, int[] newSymbolsWidths)
private final Bitmap	decodeHeightClassCollectiveBitmap(long bmSize, int heightClassHeight, int totalWidth)
private final long	decodeHeightClassDeltaHeight()
private final long	decodeHeightClassDeltaHeightWithHuffman()	6.5.6 if isHuffmanEncoded
private final void	decodeNewSymbols(int symWidth, int hcHeight, Bitmap ibo, int rdx, int rdy)
private final void	decodeRefinedSymbol(int symbolWidth, int heightClassHeight)
private final void	decodeThroughTextRegion(int symbolWidth, int heightClassHeight, long amountOfRefinementAggregationInstances)
ArrayList<Bitmap>	getDictionary()	6.5.5 Decoding the symbol dictionary
private int	getSbSymCodeLen()	6.5.8.2.3 - Setting SBSYMCODES and SBSYMCODELEN
private int[]	getToExportFlags()
private HuffmanTable	getUserTable(int tablePosition)
private final long	huffDecodeBmSize()
private final long	huffDecodeRefAggNInst()
void	init(SegmentHeader header, SubInputStream sis)	Parse the stream and read information of header.
private void	parseHeader()
private void	readAmountOfExportedSymbols()
private void	readAmountOfNewSymbols()
private void	readAtPixels(int amountOfPixels)
private void	readRefinementAtPixels(int amountOfAtPixels)
private void	readRegionFlags()
private void	retrieveImportSymbols()	Concatenates symbols from all referred-to segments.
private void	setAtPixels()
private void	setCodingStatistics()
private void	setExportedSymbols(int[] toExportFlags)
private void	setInSyms()
private void	setRefinementAtPixels()
private void	setRetainedCodingContexts(SymbolDictionary sd)
private final void	setSymbolsArray()	6.5.8.2.4 - Setting SBSYMS

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

subInputStream

private SubInputStream subInputStream

sdrTemplate

private short sdrTemplate

Symbol dictionary flags, 7.4.2.1.1

sdTemplate

private byte sdTemplate

isCodingContextRetained

private boolean isCodingContextRetained

isCodingContextUsed

private boolean isCodingContextUsed

sdHuffAggInstanceSelection

private short sdHuffAggInstanceSelection

sdHuffBMSizeSelection

private short sdHuffBMSizeSelection

sdHuffDecodeWidthSelection

private short sdHuffDecodeWidthSelection

sdHuffDecodeHeightSelection

private short sdHuffDecodeHeightSelection

useRefinementAggregation

private boolean useRefinementAggregation

isHuffmanEncoded

private boolean isHuffmanEncoded

sdATX

private short[] sdATX

Symbol dictionary AT flags, 7.4.2.1.2

sdATY

private short[] sdATY

sdrATX

private short[] sdrATX

Symbol dictionary refinement AT flags, 7.4.2.1.3

sdrATY

private short[] sdrATY

amountOfExportSymbolss

private int amountOfExportSymbolss

Number of exported symbols, 7.4.2.1.4

amountOfNewSymbols

private int amountOfNewSymbols

Number of new symbols, 7.4.2.1.5

segmentHeader

private SegmentHeader segmentHeader

Further parameters

amountOfImportedSymbolss

private int amountOfImportedSymbolss

importSymbols

private ArrayList<Bitmap> importSymbols

amountOfDecodedSymbols

private int amountOfDecodedSymbols

newSymbols

private Bitmap[] newSymbols

dhTable

private HuffmanTable dhTable

User-supplied tables *

dwTable

private HuffmanTable dwTable

bmSizeTable

private HuffmanTable bmSizeTable

aggInstTable

private HuffmanTable aggInstTable

exportSymbols

private ArrayList<Bitmap> exportSymbols

Return value of that segment

sbSymbols

private ArrayList<Bitmap> sbSymbols

arithmeticDecoder

private ArithmeticDecoder arithmeticDecoder

iDecoder

private ArithmeticIntegerDecoder iDecoder

textRegion

private TextRegion textRegion

genericRegion

private GenericRegion genericRegion

genericRefinementRegion

private GenericRefinementRegion genericRefinementRegion

cx

private CX cx

cxIADH

private CX cxIADH

cxIADW

private CX cxIADW

cxIAAI

private CX cxIAAI

cxIAEX

private CX cxIAEX

cxIARDX

private CX cxIARDX

cxIARDY

private CX cxIARDY

cxIADT

private CX cxIADT

cxIAID

protected CX cxIAID

sbSymCodeLen

private int sbSymCodeLen

Constructor Details

SymbolDictionary

public SymbolDictionary()

SymbolDictionary

public SymbolDictionary(SubInputStream subInputStream,
 SegmentHeader segmentHeader)
                 throws IOException

Throws:

IOException

Method Details

parseHeader

private void parseHeader()
                  throws IOException,
InvalidHeaderValueException,
IntegerMaxValueException

Throws:

IOException

InvalidHeaderValueException

IntegerMaxValueException

readRegionFlags

private void readRegionFlags()
                      throws IOException

Throws:

IOException

setAtPixels

private void setAtPixels()
                  throws IOException

Throws:

IOException

setRefinementAtPixels

private void setRefinementAtPixels()
                            throws IOException

Throws:

IOException

readAtPixels

private void readAtPixels(int amountOfPixels)
                   throws IOException

Throws:

IOException

readRefinementAtPixels

private void readRefinementAtPixels(int amountOfAtPixels)
                             throws IOException

Throws:

IOException

readAmountOfExportedSymbols

private void readAmountOfExportedSymbols()
                                  throws IOException

Throws:

IOException

readAmountOfNewSymbols

private void readAmountOfNewSymbols()
                             throws IOException

Throws:

IOException

setInSyms

private void setInSyms()
                throws IOException,
InvalidHeaderValueException,
IntegerMaxValueException

Throws:

IOException

InvalidHeaderValueException

IntegerMaxValueException

setRetainedCodingContexts

private void setRetainedCodingContexts(SymbolDictionary sd)

checkInput

private void checkInput()
                 throws InvalidHeaderValueException

Throws:

InvalidHeaderValueException

getDictionary

public ArrayList<Bitmap> getDictionary()
                                throws IOException,
IntegerMaxValueException,
InvalidHeaderValueException

6.5.5 Decoding the symbol dictionary

Specified by:

getDictionary in interface Dictionary

Returns:

List of decoded symbol bitmaps as an ArrayList

Throws:

IOException - if an underlying IO operation fails

IntegerMaxValueException - if the maximum value limit of an integer is exceeded

InvalidHeaderValueException - if the segment header value is invalid

setCodingStatistics

private void setCodingStatistics()
                          throws IOException

Throws:

IOException

decodeHeightClassBitmap

private final void decodeHeightClassBitmap(Bitmap heightClassCollectiveBitmap,
 int heightClassFirstSymbol,
 int heightClassHeight,
 int[] newSymbolsWidths)
                                    throws IntegerMaxValueException,
InvalidHeaderValueException,
IOException

Throws:

IntegerMaxValueException

InvalidHeaderValueException

IOException

decodeAggregate

private final void decodeAggregate(int symbolWidth,
 int heightClassHeight)
                            throws IOException,
InvalidHeaderValueException,
IntegerMaxValueException

Throws:

IOException

InvalidHeaderValueException

IntegerMaxValueException

huffDecodeRefAggNInst

private final long huffDecodeRefAggNInst()
                                  throws IOException,
InvalidHeaderValueException

Throws:

IOException

InvalidHeaderValueException

decodeThroughTextRegion

private final void decodeThroughTextRegion(int symbolWidth,
 int heightClassHeight,
 long amountOfRefinementAggregationInstances)
                                    throws IOException,
IntegerMaxValueException,
InvalidHeaderValueException

Throws:

IOException

IntegerMaxValueException

InvalidHeaderValueException

decodeRefinedSymbol

private final void decodeRefinedSymbol(int symbolWidth,
 int heightClassHeight)
                                throws IOException,
InvalidHeaderValueException,
IntegerMaxValueException

Throws:

IOException

InvalidHeaderValueException

IntegerMaxValueException

decodeNewSymbols

private final void decodeNewSymbols(int symWidth,
 int hcHeight,
 Bitmap ibo,
 int rdx,
 int rdy)
                             throws IOException,
InvalidHeaderValueException,
IntegerMaxValueException

Throws:

IOException

InvalidHeaderValueException

IntegerMaxValueException

decodeDirectlyThroughGenericRegion

private final void decodeDirectlyThroughGenericRegion(int symWidth,
 int hcHeight)
                                               throws IOException,
IntegerMaxValueException,
InvalidHeaderValueException

Throws:

IOException

IntegerMaxValueException

InvalidHeaderValueException

addSymbol

private final void addSymbol(Region region)
                      throws IntegerMaxValueException,
InvalidHeaderValueException,
IOException

Throws:

IntegerMaxValueException

InvalidHeaderValueException

IOException

decodeDifferenceWidth

private final long decodeDifferenceWidth()
                                  throws IOException,
InvalidHeaderValueException

Throws:

IOException

InvalidHeaderValueException

decodeHeightClassDeltaHeight

private final long decodeHeightClassDeltaHeight()
                                         throws IOException,
InvalidHeaderValueException

Throws:

IOException

InvalidHeaderValueException

decodeHeightClassDeltaHeightWithHuffman

private final long decodeHeightClassDeltaHeightWithHuffman()
                                                    throws IOException,
InvalidHeaderValueException

6.5.6 if isHuffmanEncoded

Returns:

long - Result of decoding HCDH

Throws:

IOException

InvalidHeaderValueException

decodeHeightClassCollectiveBitmap

private final Bitmap decodeHeightClassCollectiveBitmap(long bmSize,
 int heightClassHeight,
 int totalWidth)
                                                throws IOException

Throws:

IOException

setExportedSymbols

private void setExportedSymbols(int[] toExportFlags)

getToExportFlags

private int[] getToExportFlags()
                        throws IOException,
InvalidHeaderValueException

Throws:

IOException

InvalidHeaderValueException

huffDecodeBmSize

private final long huffDecodeBmSize()
                             throws IOException,
InvalidHeaderValueException

Throws:

IOException

InvalidHeaderValueException

getSbSymCodeLen

private int getSbSymCodeLen()
                     throws IOException

6.5.8.2.3 - Setting SBSYMCODES and SBSYMCODELEN

Returns:

Result of computing SBSYMCODELEN

Throws:

IOException

setSymbolsArray

private final void setSymbolsArray()
                            throws IOException,
InvalidHeaderValueException,
IntegerMaxValueException

6.5.8.2.4 - Setting SBSYMS

Throws:

IOException

InvalidHeaderValueException

IntegerMaxValueException

retrieveImportSymbols

private void retrieveImportSymbols()
                            throws IOException,
InvalidHeaderValueException,
IntegerMaxValueException

Concatenates symbols from all referred-to segments.

Throws:

IOException

InvalidHeaderValueException

IntegerMaxValueException

getUserTable

private HuffmanTable getUserTable(int tablePosition)
                           throws InvalidHeaderValueException,
IOException

Throws:

InvalidHeaderValueException

IOException

init

public void init(SegmentHeader header,
 SubInputStream sis)
          throws InvalidHeaderValueException,
IntegerMaxValueException,
IOException

Description copied from interface: SegmentData

Parse the stream and read information of header.

Specified by:

init in interface SegmentData

Parameters:

header - - The segments' header (to make referred-to segments available in data part).

sis - - Wrapped ImageInputStream into SubInputStream.

Throws:

InvalidHeaderValueException - if the segment header value is invalid

IntegerMaxValueException - if the maximum value limit of an integer is exceeded

IOException - if an underlying IO operation fails