Package com.twelvemonkeys.imageio

Class ImageReaderBase

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected javax.imageio.stream.ImageInputStream imageInput
      For convenience.
      private static long MAX_IMAGE_BYTES  
      private static java.lang.String MAX_IMAGE_BYTES_PROPERTY
      System property ("com.twelvemonkeys.imageio.maxImageBytes") overriding the maximum size, in bytes, of a destination image allocated from declared dimensions when the input length is unknown.
      private static java.awt.Point ORIGIN  

      • Fields inherited from class javax.imageio.ImageReader

        availableLocales, ignoreMetadata, input, locale, minIndex, originatingProvider, progressListeners, seekForwardOnly, updateListeners, warningListeners, warningLocales

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected ImageReaderBase​(javax.imageio.spi.ImageReaderSpi provider)
      Constructs an ImageReader and sets its originatingProvider field to the supplied value.

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected void assertInput()
      Makes sure input is set.
      protected void checkBounds​(int index)
      Convenience method to make sure image index is within bounds.
      (package private) static long computeByteSize​(javax.imageio.ImageTypeSpecifier specifier, int width, int height)  
      (package private) static long defaultMaxImageBytes()  
      void dispose()  
      protected static java.awt.image.BufferedImage fakeAOI​(java.awt.image.BufferedImage pImage, javax.imageio.ImageReadParam pParam)
      Utility method for getting the area of interest (AOI) of an image.
      protected static java.awt.Image fakeSubsampling​(java.awt.Image pImage, javax.imageio.ImageReadParam pParam)
      Utility method for getting the subsampled image.
      static java.awt.image.BufferedImage getDestination​(javax.imageio.ImageReadParam param, java.util.Iterator<javax.imageio.ImageTypeSpecifier> types, int width, int height)
      Returns the BufferedImage to which decoded pixel data should be written.
      javax.imageio.metadata.IIOMetadata getImageMetadata​(int imageIndex)
      Default implementation that always returns null.
      int getNumImages​(boolean allowSearch)
      Default implementation that always returns 1.
      javax.imageio.metadata.IIOMetadata getStreamMetadata()
      Default implementation that always returns null.
      protected static boolean hasExplicitDestination​(javax.imageio.ImageReadParam pParam)
      Tests if param has explicit destination.
      static void main​(java.lang.String[] pArgs)  
      void reset()  
      protected abstract void resetMembers()
      Resets all member variables.
      private static long resolveMaxImageBytes()  
      private static long saturatedMultiply​(long a, long b)  
      void setInput​(java.lang.Object input, boolean seekForwardOnly, boolean ignoreMetadata)
      Overrides setInput, to allow easy access to the input, in case it is an ImageInputStream.
      protected static void showIt​(java.awt.image.BufferedImage pImage, java.lang.String pTitle)  
      static void validateSourceSize​(long declaredByteSize, long inputLength, int maxExpansionRatio)
      Validates that the declared byte size of a source image (typically computed as width * height * samples per pixel * bytes per sample) is reasonable compared to (ie.
      (package private) static void validateSourceSize​(long declaredBytes, long inputLength, int maxExpansionRatio, long maxImageBytes)  
      static void validateSourceSize​(javax.imageio.ImageTypeSpecifier rawType, int width, int height, long inputLength, int maxExpansionRatio)
      Validates that the source image size, based on the image type specifier and dimensions, is reasonable compared to (ie.

      • Methods inherited from class javax.imageio.ImageReader

        abort, abortRequested, addIIOReadProgressListener, addIIOReadUpdateListener, addIIOReadWarningListener, canReadRaster, checkReadParamBandSettings, clearAbortRequest, computeRegions, getAspectRatio, getAvailableLocales, getDefaultReadParam, getFormatName, getHeight, getImageMetadata, getImageTypes, getInput, getLocale, getMinIndex, getNumThumbnails, getOriginatingProvider, getRawImageType, getSourceRegion, getStreamMetadata, getThumbnailHeight, getThumbnailWidth, getTileGridXOffset, getTileGridYOffset, getTileHeight, getTileWidth, getWidth, hasThumbnails, isIgnoringMetadata, isImageTiled, isRandomAccessEasy, isSeekForwardOnly, processImageComplete, processImageProgress, processImageStarted, processImageUpdate, processPassComplete, processPassStarted, processReadAborted, processSequenceComplete, processSequenceStarted, processThumbnailComplete, processThumbnailPassComplete, processThumbnailPassStarted, processThumbnailProgress, processThumbnailStarted, processThumbnailUpdate, processWarningOccurred, processWarningOccurred, read, read, readAll, readAll, readAsRenderedImage, readerSupportsThumbnails, readRaster, readThumbnail, readTile, readTileRaster, removeAllIIOReadProgressListeners, removeAllIIOReadUpdateListeners, removeAllIIOReadWarningListeners, removeIIOReadProgressListener, removeIIOReadUpdateListener, removeIIOReadWarningListener, setInput, setInput, setLocale

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • ORIGIN

        private static final java.awt.Point ORIGIN

      • MAX_IMAGE_BYTES_PROPERTY

        private static final java.lang.String MAX_IMAGE_BYTES_PROPERTY
        System property ("com.twelvemonkeys.imageio.maxImageBytes") overriding the maximum size, in bytes, of a destination image allocated from declared dimensions when the input length is unknown. Read once at class initialization, so it must be set as a launch -D option. When unset, the default is half the maximum heap, capped at 512 MB and floored at 64 MB.
        See Also:
        Constant Field Values

      • MAX_IMAGE_BYTES

        private static final long MAX_IMAGE_BYTES

      • imageInput

        protected javax.imageio.stream.ImageInputStream imageInput
        For convenience. Only set if the input is an ImageInputStream.
        See Also:
        setInput(Object, boolean, boolean)

    • Constructor Detail

      • ImageReaderBase

        protected ImageReaderBase​(javax.imageio.spi.ImageReaderSpi provider)
        Constructs an ImageReader and sets its originatingProvider field to the supplied value.

        Subclasses that make use of extensions should provide a constructor with signature (ImageReaderSpi, Object) in order to retrieve the extension object. If the extension object is unsuitable, an IllegalArgumentException should be thrown.

        Parameters:
        provider - the ImageReaderSpi that is invoking this constructor, or null.

    • Method Detail

      • setInput

        public void setInput​(java.lang.Object input,
                     boolean seekForwardOnly,
                     boolean ignoreMetadata)
        Overrides setInput, to allow easy access to the input, in case it is an ImageInputStream.
        Overrides:
        setInput in class javax.imageio.ImageReader
        Parameters:
        input - the ImageInputStream or other Object to use for future decoding.
        seekForwardOnly - if true, images and metadata may only be read in ascending order from this input source.
        ignoreMetadata - if true, metadata may be ignored during reads.
        Throws:
        java.lang.IllegalArgumentException - if input is not an instance of one of the classes returned by the originating service provider's getInputTypes method, or is not an ImageInputStream.
        See Also:
        ImageInputStream

      • dispose

        public void dispose()
        Overrides:
        dispose in class javax.imageio.ImageReader

      • reset

        public void reset()
        Overrides:
        reset in class javax.imageio.ImageReader

      • getImageMetadata

        public javax.imageio.metadata.IIOMetadata getImageMetadata​(int imageIndex)
                                                    throws java.io.IOException
        Default implementation that always returns null.
        Specified by:
        getImageMetadata in class javax.imageio.ImageReader
        Parameters:
        imageIndex - ignored, unless overridden
        Returns:
        null, unless overridden
        Throws:
        java.io.IOException - never, unless overridden.

      • getStreamMetadata

        public javax.imageio.metadata.IIOMetadata getStreamMetadata()
                                                     throws java.io.IOException
        Default implementation that always returns null.
        Specified by:
        getStreamMetadata in class javax.imageio.ImageReader
        Returns:
        null, unless overridden
        Throws:
        java.io.IOException - never, unless overridden.

      • getNumImages

        public int getNumImages​(boolean allowSearch)
                 throws java.io.IOException
        Default implementation that always returns 1.
        Specified by:
        getNumImages in class javax.imageio.ImageReader
        Parameters:
        allowSearch - ignored, unless overridden
        Returns:
        1, unless overridden
        Throws:
        java.io.IOException - never, unless overridden

      • checkBounds

        protected void checkBounds​(int index)
                    throws java.io.IOException
        Convenience method to make sure image index is within bounds.
        Parameters:
        index - the image index
        Throws:
        java.io.IOException - if an error occurs during reading
        java.lang.IndexOutOfBoundsException - if not minIndex <= index < numImages

      • assertInput

        protected void assertInput()
        Makes sure input is set.
        Throws:
        java.lang.IllegalStateException - if getInput() == null.

      • getDestination

        public static java.awt.image.BufferedImage getDestination​(javax.imageio.ImageReadParam param,
                                                          java.util.Iterator<javax.imageio.ImageTypeSpecifier> types,
                                                          int width,
                                                          int height)
                                                   throws javax.imageio.IIOException
        Returns the BufferedImage to which decoded pixel data should be written.

        As ImageReader.getDestination(javax.imageio.ImageReadParam, java.util.Iterator<javax.imageio.ImageTypeSpecifier>, int, int) but tests if the explicit destination image (if set) is valid according to the ImageTypeSpecifiers given in types.

        Parameters:
        param - an ImageReadParam to be used to get the destination image or image type, or null.
        types - an Iterator of ImageTypeSpecifiers indicating the legal image types, with the default first.
        width - the true width of the image or tile begin decoded.
        height - the true width of the image or tile being decoded.
        Returns:
        the BufferedImage to which decoded pixel data should be written.
        Throws:
        javax.imageio.IIOException - if the ImageTypeSpecifier or BufferedImage specified by param does not match any of the legal ones from types.
        java.lang.IllegalArgumentException - if types is null or empty, or if an object not of type ImageTypeSpecifier is retrieved from it. Or, if the resulting image would have a width or height less than 1, or if the product of width and height of the resulting image is greater than Integer.MAX_VALUE.

      • computeByteSize

        static long computeByteSize​(javax.imageio.ImageTypeSpecifier specifier,
                            int width,
                            int height)

      • validateSourceSize

        public static void validateSourceSize​(javax.imageio.ImageTypeSpecifier rawType,
                                      int width,
                                      int height,
                                      long inputLength,
                                      int maxExpansionRatio)
                               throws javax.imageio.IIOException
        Validates that the source image size, based on the image type specifier and dimensions, is reasonable compared to (ie. not larger than) the input length multiplied by a format specific expansion ratio. If the input length is unknown, the source size is compared to a best-effort ceiling from the "com.twelvemonkeys.imageio.maxImageBytes" system property instead.
        Parameters:
        rawType - the type which most closely represents the "raw" internal format of the source image.
        width - the width of the source image.
        height - the height of the source image.
        inputLength - the length of the input, if known, -1 otherwise.
        maxExpansionRatio - the maximum reasonable expansion ratio for the format. This typically depends on the compression being used.
        Throws:
        javax.imageio.IIOException - if the computed byte size exceeds the allowed size
        See Also:
        ImageReader.getRawImageType(int)

      • validateSourceSize

        public static void validateSourceSize​(long declaredByteSize,
                                      long inputLength,
                                      int maxExpansionRatio)
                               throws javax.imageio.IIOException
        Validates that the declared byte size of a source image (typically computed as width * height * samples per pixel * bytes per sample) is reasonable compared to (ie. not larger than) the input length multiplied by a format specific expansion ratio. If the input length is unknown, the source size is compared to a best-effort ceiling from the "com.twelvemonkeys.imageio.maxImageBytes" system property instead.
        Parameters:
        declaredByteSize - the declared size of the image.
        inputLength - the length of the input, if known, -1 otherwise.
        maxExpansionRatio - the maximum reasonable expansion ratio for the format. This typically depends on the compression being used.
        Throws:
        javax.imageio.IIOException - if the computed byte size exceeds the allowed size

      • validateSourceSize

        static void validateSourceSize​(long declaredBytes,
                               long inputLength,
                               int maxExpansionRatio,
                               long maxImageBytes)
                        throws javax.imageio.IIOException
        Throws:
        javax.imageio.IIOException

      • resolveMaxImageBytes

        private static long resolveMaxImageBytes()

      • defaultMaxImageBytes

        static long defaultMaxImageBytes()

      • saturatedMultiply

        private static long saturatedMultiply​(long a,
                                      long b)

      • fakeAOI

        protected static java.awt.image.BufferedImage fakeAOI​(java.awt.image.BufferedImage pImage,
                                                      javax.imageio.ImageReadParam pParam)
        Utility method for getting the area of interest (AOI) of an image. The AOI is defined by the IIOParam.setSourceRegion(java.awt.Rectangle) method.

        Note: If it is possible for the reader to read the AOI directly, such a method should be used instead, for efficiency.

        Parameters:
        pImage - the image to get AOI from
        pParam - the param optionally specifying the AOI
        Returns:
        a BufferedImage containing the area of interest (source region), or the original image, if no source region was set, or pParam was null

      • fakeSubsampling

        protected static java.awt.Image fakeSubsampling​(java.awt.Image pImage,
                                                javax.imageio.ImageReadParam pParam)
        Utility method for getting the subsampled image. The subsampling is defined by the IIOParam.setSourceSubsampling(int, int, int, int) method.

        NOTE: This method does not take the subsampling offsets into consideration.

        Note: If it is possible for the reader to subsample directly, such a method should be used instead, for efficiency.

        Parameters:
        pImage - the image to subsample
        pParam - the param optionally specifying subsampling
        Returns:
        an Image containing the subsampled image, or the original image, if no subsampling was specified, or pParam was null

      • hasExplicitDestination

        protected static boolean hasExplicitDestination​(javax.imageio.ImageReadParam pParam)
        Tests if param has explicit destination.
        Parameters:
        pParam - the image read parameter, or null
        Returns:
        true if pParam is non-null and either its getDestination, getDestinationType returns a non-null value, or getDestinationOffset returns a Point that is not the upper left corner (0, 0).

      • main

        public static void main​(java.lang.String[] pArgs)
                 throws java.io.IOException
        Throws:
        java.io.IOException

      • showIt

        protected static void showIt​(java.awt.image.BufferedImage pImage,
                             java.lang.String pTitle)