4892259: GIF ImageReader does not call passComplete in IIOReadUpdateListener

Reviewed-by: prr, bae

jdk/src/share/classes/com/sun/imageio/plugins/gif/GIFImageReader.java

@@ -790,16 +790,12 @@ public class GIFImageReader extends ImageReader {
     }
 
     private void startPass(int pass) {
-        if (updateListeners == null) {
+        if (updateListeners == null || !imageMetadata.interlaceFlag) {
             return;
         }
 
-        int y = 0;
+        int y = interlaceOffset[interlacePass];
-        int yStep = 1;
+        int yStep = interlaceIncrement[interlacePass];
-        if (imageMetadata.interlaceFlag) {
-            y = interlaceOffset[interlacePass];
-            yStep = interlaceIncrement[interlacePass];
-        }
 
         int[] vals = ReaderUtil.
             computeUpdatedPixels(sourceRegion,

jdk/test/javax/imageio/plugins/gif/GIFPassListenerTest.java

@@ -0,0 +1,127 @@
+/*
+ * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/*
+ * @test
+ * @bug 4892259
+ *
+ * @summary Verify that calls to IIOReadUpdateListener passStarted and
+ * passComplete are consistent.
+ *
+ * @run main GIFPassListenerTest
+ */
+
+import java.awt.image.*;
+import java.io.*;
+import java.util.*;
+import javax.imageio.*;
+import javax.imageio.event.*;
+import javax.imageio.stream.*;
+
+public class GIFPassListenerTest {
+
+    private static ImageInputStream createTestImageStream(boolean progressive) throws IOException {
+        ByteArrayOutputStream output = new ByteArrayOutputStream();
+        Iterator<ImageWriter> writers = ImageIO.getImageWritersByFormatName("gif");
+        if (!writers.hasNext()) {
+            return null;
+        }
+        ImageWriter writer = writers.next();
+        ImageWriteParam param = writer.getDefaultWriteParam();
+        param.setProgressiveMode(progressive ?
+                ImageWriteParam.MODE_DEFAULT : ImageWriteParam.MODE_DISABLED);
+        ImageOutputStream imageOutput = ImageIO.createImageOutputStream(output);
+        writer.setOutput(imageOutput);
+        BufferedImage image = new BufferedImage(100, 100, BufferedImage.TYPE_INT_ARGB);
+        writer.write(null, new IIOImage(image, null, null), param);
+        imageOutput.flush();
+        ByteArrayInputStream input = new ByteArrayInputStream(output.toByteArray());
+        return ImageIO.createImageInputStream(input);
+    }
+
+    private static void checkImage(boolean progressive) throws Exception {
+        ImageInputStream iis = createTestImageStream(progressive);
+        ImageReader reader = ImageIO.getImageReaders(iis).next();
+        reader.setInput(iis);
+        ReadUpdateHandler handler = new ReadUpdateHandler();
+        reader.addIIOReadUpdateListener(handler);
+        reader.readAll(null);
+        if (handler.isPassStarted) {
+            throw new RuntimeException("passStarted without passComplete.");
+        }
+        if (progressive && (handler.numPasses == 0)) {
+            throw new RuntimeException("passStarted wasn't called for progressive image");
+        }
+        if (!progressive && (handler.numPasses != 0)) {
+            throw new RuntimeException("passStarted was called for non-progressive image");
+        }
+        iis.close();
+    }
+
+    public static void main(String args[]) throws Exception {
+        checkImage(true);
+        checkImage(false);
+    }
+
+    private static class ReadUpdateHandler implements IIOReadUpdateListener {
+        public boolean isPassStarted = false;
+        public int numPasses = 0;
+
+        @Override
+        public void imageUpdate(ImageReader source, BufferedImage theImage, int minX, int minY,
+                int width, int height, int periodX, int periodY, int[] bands) {
+        }
+
+        @Override
+        public void passStarted(ImageReader source, BufferedImage theImage, int pass, int minPass,
+                int maxPass, int minX, int minY, int periodX, int periodY, int[] bands) {
+            if (isPassStarted) {
+                throw new RuntimeException("reentered passStarted!");
+            }
+            isPassStarted = true;
+            numPasses++;
+        }
+
+        @Override
+        public void passComplete(ImageReader source, BufferedImage theImage) {
+            if (!isPassStarted) {
+                throw new RuntimeException("passComplete without passStarted!");
+            }
+            isPassStarted = false;
+        }
+
+        @Override
+        public void thumbnailPassStarted(ImageReader source, BufferedImage theThumbnail, int pass,
+                int minPass, int maxPass, int minX, int minY, int periodX, int periodY, int[] bands) {
+        }
+
+        @Override
+        public void thumbnailPassComplete(ImageReader source, BufferedImage theThumbnail) {
+        }
+
+        @Override
+        public void thumbnailUpdate(ImageReader source, BufferedImage theThumbnail, int minX, int minY,
+                int width, int height, int periodX, int periodY, int[] bands) {
+        }
+    }
+}