org.apache.pdfbox.jbig2.segments

Class GenericRefinementRegion

java.lang.Object

org.apache.pdfbox.jbig2.segments.GenericRefinementRegion

All Implemented Interfaces:

Region, SegmentData

public class GenericRefinementRegion
extends Object
implements Region

Handles a JBIG2 Generic Refinement Region segment (§7.4.7).

This class is responsible for segment-level concerns only: parsing the region segment information and flags from the bitstream, resolving the reference bitmap, and delegating pixel decoding to GenericRefinementRegionDecodingProcedure, which implements the pure algorithm defined in §6.3.5.6.

Segment types (§7.4.7)

The three generic refinement region segment types — intermediate, immediate, and immediate lossless — share an identical data encoding. They differ only in how the decoded bitmap is acted upon during page image composition (§8.2):

• Intermediate generic refinement region — the decoded bitmap is stored but not yet composited onto the page buffer.
• Immediate generic refinement region — the decoded bitmap is composited onto the page buffer immediately using lossy encoding.
• Immediate lossless generic refinement region — as above but using lossless encoding.

Usage modes

• Header-driven (standalone segment): Initialise via init(SegmentHeader, SubInputStream). The reference bitmap is resolved from referred-to segments or, if none are present, from the current page buffer (§7.4.7.4). Per Table 35, GRREFERENCEDX and GRREFERENCEDY are implicitly zero in this mode.
• Parameter-driven: Call setParameters(CX, ArithmeticDecoder, short, int, int, Bitmap, int, int, boolean, short[], short[]) to supply the shared ArithmeticDecoder, CX, reference bitmap, and offsets before calling getRegionBitmap().
  Deprecated: callers should migrate to invoking GenericRefinementRegionDecodingProcedure.decode( ArithmeticDecoder, CX, int, int, short, boolean, Bitmap, int, int, short[], short[]) directly.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GenericRefinementRegion.Template Deprecated. Moved to GenericRefinementRegionDecodingProcedure.Template. This declaration will be removed in the next major release.

Constructor Summary

Constructors

Constructor and Description
GenericRefinementRegion()
GenericRefinementRegion(SubInputStream subInputStream)
GenericRefinementRegion(SubInputStream subInputStream, SegmentHeader segmentHeader)

Method Summary

Modifier and Type	Method and Description
Bitmap	getRegionBitmap() Decode using a template and arithmetic coding, as described in 6.3.5.6
RegionSegmentInformation	getRegionInfo() Simply returns the RegionSegmentInformation.
void	init(SegmentHeader header, SubInputStream sis) Parse the stream and read information of header.
void	setPageBitmap(Bitmap pageBitmap) Call this to pass the page bitmap in case there is no reference bitmap.
protected void	setParameters(CX cx, ArithmeticDecoder arithmeticDecoder, short grTemplate, int regionWidth, int regionHeight, Bitmap grReference, int grReferenceDX, int grReferenceDY, boolean isTPGRon, short[] grAtX, short[] grAtY) Deprecated. Use GenericRefinementRegionDecodingProcedure.decode( ArithmeticDecoder, CX, int, int, short, boolean, Bitmap, int, int, short[], short[]) directly, supplying the shared ArithmeticDecoder and CX as arguments. This method will be removed in the next major release.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericRefinementRegion

public GenericRefinementRegion()

GenericRefinementRegion

public GenericRefinementRegion(SubInputStream subInputStream)

GenericRefinementRegion

public GenericRefinementRegion(SubInputStream subInputStream,
                               SegmentHeader segmentHeader)

Method Detail

getRegionBitmap

public Bitmap getRegionBitmap()
                       throws IOException,
                              IntegerMaxValueException,
                              InvalidHeaderValueException

Decode using a template and arithmetic coding, as described in 6.3.5.6

Specified by:

getRegionBitmap in interface Region

Returns:

The decoded region as Bitmap.

Throws:

IOException - if an underlying IO operation fails

InvalidHeaderValueException - if a segment header value is invalid

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

setPageBitmap

public void setPageBitmap(Bitmap pageBitmap)

Call this to pass the page bitmap in case there is no reference bitmap.

Parameters:

pageBitmap -

init

public void init(SegmentHeader header,
                 SubInputStream sis)
          throws 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:

IOException - if an underlying IO operation fails

setParameters

@Deprecated
protected void setParameters(CX cx,
                                         ArithmeticDecoder arithmeticDecoder,
                                         short grTemplate,
                                         int regionWidth,
                                         int regionHeight,
                                         Bitmap grReference,
                                         int grReferenceDX,
                                         int grReferenceDY,
                                         boolean isTPGRon,
                                         short[] grAtX,
                                         short[] grAtY)

Deprecated. Use GenericRefinementRegionDecodingProcedure.decode( ArithmeticDecoder, CX, int, int, short, boolean, Bitmap, int, int, short[], short[]) directly, supplying the shared ArithmeticDecoder and CX as arguments. This method will be removed in the next major release.

getRegionInfo

public RegionSegmentInformation getRegionInfo()

Description copied from interface: Region

Simply returns the RegionSegmentInformation.

Specified by:

getRegionInfo in interface Region

Returns:

The RegionSegmentInformation.