Class GenericRefinementRegionDecodingProcedure


  • public class GenericRefinementRegionDecodingProcedure
    extends java.lang.Object
    Implements the JBIG2 Generic Refinement Region decoding procedure as defined in ITU-T T.88, §6.3 including the core decoding loop defined in §6.3.5.6.

    This class is purely algorithmic. It has no knowledge of how its inputs are obtained and no dependency on segment headers or input streams. The entry point is the static decode() method; callers supply the ArithmeticDecoder and CX context model directly, so they decide whether to create fresh instances or share existing ones:

    • GenericRefinementRegion — creates its own ArithmeticDecoder and CX, then calls decode().
    • Symbol dictionary refinement (§6.5.8.2) — passes the parent dictionary's shared ArithmeticDecoder and CX.
    • Text region refinement (§6.4) — passes the parent text region's shared ArithmeticDecoder and CX.

    This class cannot be instantiated by callers. The private constructor and the internal run(int, int, short, boolean, org.apache.pdfbox.jbig2.Bitmap, int, int, short[], short[]) method exist solely to let the many private helper methods share state through fields rather than through long parameter lists.

    • Constructor Detail

      • GenericRefinementRegionDecodingProcedure

        private GenericRefinementRegionDecodingProcedure​(ArithmeticDecoder arithDecoder,
                                                         CX cx)
    • Method Detail

      • decode

        public static Bitmap decode​(ArithmeticDecoder arithDecoder,
                                    CX cx,
                                    int width,
                                    int height,
                                    short grTemplate,
                                    boolean isTPGROn,
                                    Bitmap referenceBitmap,
                                    int referenceDX,
                                    int referenceDY,
                                    short[] grAtX,
                                    short[] grAtY)
                             throws java.io.IOException
        Executes the Generic Refinement Region decoding procedure (§6.3.5.6) and returns the decoded bitmap.

        A short-lived instance is created internally so that the many private helper methods can share state through fields rather than through long parameter lists. No state survives the return of this method.

        Parameters:
        arithDecoder - the arithmetic decoder — shared with the parent when called from a symbol dictionary or text region, or freshly created when called from a standalone segment; must not be null
        cx - the context model — shared or fresh, as above; must not be null
        width - decoded bitmap width (GRW); must be > 0
        height - decoded bitmap height (GRH); must be > 0
        grTemplate - template index: must be 0 or 1 (GRTEMPLATE)
        isTPGROn - whether typical prediction is enabled (TPGRON)
        referenceBitmap - the reference / base bitmap (GRREFERENCE); must not be null
        referenceDX - horizontal offset of reference bitmap (GRREFERENCEDX)
        referenceDY - vertical offset of reference bitmap (GRREFERENCEDY)
        grAtX - AT pixel X offsets; required for grTemplate == 0, must be a non-null array of length 2 in that case; ignored for grTemplate == 1
        grAtY - AT pixel Y offsets; same requirements as grAtX
        Returns:
        the decoded bitmap
        Throws:
        java.lang.IllegalArgumentException - if any parameter constraint above is violated
        java.io.IOException - if an underlying I/O operation fails
      • run

        private Bitmap run​(int width,
                           int height,
                           short grTemplate,
                           boolean isTPGROn,
                           Bitmap referenceBitmap,
                           int referenceDX,
                           int referenceDY,
                           short[] grAtX,
                           short[] grAtY)
                    throws java.io.IOException
        Throws:
        java.io.IOException
      • getPixelSafe

        private int getPixelSafe​(Bitmap bitmap,
                                 int x,
                                 int y)
      • getReferenceBit

        private int getReferenceBit​(int x,
                                    int y)
      • getRegionBit

        private int getRegionBit​(int x,
                                 int y)
      • buildContextT1

        private int buildContextT1​(int x,
                                   int y)
      • decodeLineExplicitT1

        private void decodeLineExplicitT1​(int y,
                                          int width)
                                   throws java.io.IOException
        Throws:
        java.io.IOException
      • decodeLineTPGRT1

        private void decodeLineTPGRT1​(int y,
                                      int width)
                               throws java.io.IOException
        Throws:
        java.io.IOException
      • decodeSLTP

        private int decodeSLTP()
                        throws java.io.IOException
        Throws:
        java.io.IOException
      • decodeOptimized

        private void decodeOptimized​(int lineNumber,
                                     int width,
                                     int rowStride,
                                     int refRowStride,
                                     int paddedWidth,
                                     int deltaRefStride,
                                     int lineOffset)
                              throws java.io.IOException
        Throws:
        java.io.IOException
      • decodeTemplate

        private void decodeTemplate​(int lineNumber,
                                    int width,
                                    int rowStride,
                                    int refRowStride,
                                    int paddedWidth,
                                    int deltaRefStride,
                                    int lineOffset,
                                    int byteIndex,
                                    int currentLine,
                                    int refByteIndex,
                                    GenericRefinementRegionDecodingProcedure.Template templateFormation)
                             throws java.io.IOException
        Throws:
        java.io.IOException
      • updateOverride

        private void updateOverride()
      • decodeTypicalPredictedLine

        private void decodeTypicalPredictedLine​(int lineNumber,
                                                int width,
                                                int rowStride,
                                                int refRowStride,
                                                int paddedWidth,
                                                int deltaRefStride)
                                         throws java.io.IOException
        Throws:
        java.io.IOException
      • decodeTypicalPredictedLineTemplate0

        private void decodeTypicalPredictedLineTemplate0​(int lineNumber,
                                                         int width,
                                                         int rowStride,
                                                         int refRowStride,
                                                         int paddedWidth,
                                                         int deltaRefStride,
                                                         int byteIndex,
                                                         int currentLine,
                                                         int refByteIndex)
                                                  throws java.io.IOException
        Throws:
        java.io.IOException
      • decodeTypicalPredictedLineTemplate1

        private void decodeTypicalPredictedLineTemplate1​(int lineNumber,
                                                         int width,
                                                         int rowStride,
                                                         int refRowStride,
                                                         int paddedWidth,
                                                         int deltaRefStride,
                                                         int byteIndex,
                                                         int currentLine,
                                                         int refByteIndex)
                                                  throws java.io.IOException
        Throws:
        java.io.IOException
      • overrideAtTemplate0

        private int overrideAtTemplate0​(int context,
                                        int x,
                                        int y,
                                        int result,
                                        int minorX)