8191384: WaveFloatFileReader never closes the data stream
authorserb
Thu, 23 Nov 2017 23:05:52 -0800
changeset 47973 d5774c36c605
parent 47972 18dbd2ae7eca
child 47974 9ec74010cadf
8191384: WaveFloatFileReader never closes the data stream Reviewed-by: amenkov
src/java.desktop/share/classes/com/sun/media/sound/RIFFReader.java
test/jdk/javax/sound/midi/Gervill/RiffReaderWriter/Close.java
test/jdk/javax/sound/sampled/spi/AudioFileReader/AudioInputStreamClose.java
--- a/src/java.desktop/share/classes/com/sun/media/sound/RIFFReader.java	Thu Nov 23 10:44:29 2017 +0530
+++ b/src/java.desktop/share/classes/com/sun/media/sound/RIFFReader.java	Thu Nov 23 23:05:52 2017 -0800
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2007, 2016, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2007, 2017, 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
@@ -41,7 +41,7 @@
     private final String fourcc;
     private String riff_type = null;
     private final long ckSize;
-    private InputStream stream;
+    private final InputStream stream;
     private long avail = 0xffffffffL; // MAX_UNSIGNED_INT
     private RIFFReader lastiterator = null;
 
@@ -338,8 +338,6 @@
     @Override
     public void close() throws IOException {
         finish();
-        if (this == root)
-            stream.close();
-        stream = null;
+        stream.close();
     }
 }
--- a/test/jdk/javax/sound/midi/Gervill/RiffReaderWriter/Close.java	Thu Nov 23 10:44:29 2017 +0530
+++ b/test/jdk/javax/sound/midi/Gervill/RiffReaderWriter/Close.java	Thu Nov 23 23:05:52 2017 -0800
@@ -22,6 +22,7 @@
  */
 
 /* @test
+   @bug 8191384
    @summary Test RiffReader close method
    @modules java.desktop/com.sun.media.sound
 */
@@ -54,6 +55,8 @@
             FileInputStream fis = new FileInputStream(tempfile);
             reader = new RIFFReader(fis);
             reader.close();
+            // second close should not throw any exceptions
+            reader.close();
             reader = null;
         }
         finally
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/test/jdk/javax/sound/sampled/spi/AudioFileReader/AudioInputStreamClose.java	Thu Nov 23 23:05:52 2017 -0800
@@ -0,0 +1,161 @@
+/*
+ * Copyright (c) 2017, 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.
+ */
+
+import java.io.BufferedInputStream;
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.ArrayList;
+import java.util.List;
+
+import javax.sound.sampled.AudioFileFormat;
+import javax.sound.sampled.AudioFormat;
+import javax.sound.sampled.AudioInputStream;
+import javax.sound.sampled.UnsupportedAudioFileException;
+import javax.sound.sampled.spi.AudioFileReader;
+import javax.sound.sampled.spi.AudioFileWriter;
+
+import static java.util.ServiceLoader.load;
+import static javax.sound.sampled.AudioFileFormat.Type.AIFC;
+import static javax.sound.sampled.AudioFileFormat.Type.AIFF;
+import static javax.sound.sampled.AudioFileFormat.Type.AU;
+import static javax.sound.sampled.AudioFileFormat.Type.SND;
+import static javax.sound.sampled.AudioFileFormat.Type.WAVE;
+import static javax.sound.sampled.AudioSystem.NOT_SPECIFIED;
+
+/**
+ * @test
+ * @bug 8191384
+ * @summary the stream returned by AudioFileReader should close its data stream
+ */
+public final class AudioInputStreamClose {
+
+    static final class StreamWrapper extends BufferedInputStream {
+
+        private boolean open = true;
+
+        StreamWrapper(final InputStream in) {
+            super(in);
+        }
+
+        @Override
+        public void close() throws IOException {
+            super.close();
+            open = false;
+        }
+
+        boolean isOpen() {
+            return open;
+        }
+    }
+
+    /**
+     * We will try to use all formats, in this case all our providers will be
+     * covered by supported/unsupported formats.
+     */
+    private static final List<AudioFormat> formats = new ArrayList<>(23000);
+
+    private static final AudioFormat.Encoding[] encodings = {
+            AudioFormat.Encoding.ALAW, AudioFormat.Encoding.ULAW,
+            AudioFormat.Encoding.PCM_SIGNED, AudioFormat.Encoding.PCM_UNSIGNED,
+            AudioFormat.Encoding.PCM_FLOAT, new AudioFormat.Encoding("Test")
+    };
+
+    private static final int[] sampleBits = {1, 4, 8, 11, 16, 20, 24, 32};
+
+    private static final int[] channels = {1, 2, 3, 4, 5};
+
+    private static final AudioFileFormat.Type[] types = {
+            WAVE, AU, AIFF, AIFC, SND,
+            new AudioFileFormat.Type("TestName", "TestExt")
+    };
+
+    private static final int FRAME_LENGTH = 10;
+
+    static {
+        for (final int sampleSize : sampleBits) {
+            for (final int channel : channels) {
+                for (final AudioFormat.Encoding enc : encodings) {
+                    final int frameSize = ((sampleSize + 7) / 8) * channel;
+                    formats.add(new AudioFormat(enc, 44100, sampleSize, channel,
+                                                frameSize, 44100, true));
+                    formats.add(new AudioFormat(enc, 44100, sampleSize, channel,
+                                                frameSize, 44100, false));
+                }
+            }
+        }
+    }
+
+    public static void main(final String[] args) throws IOException {
+        for (final AudioFileWriter afw : load(AudioFileWriter.class)) {
+            for (final AudioFileReader afr : load(AudioFileReader.class)) {
+                for (final AudioFileFormat.Type type : types) {
+                    for (final AudioFormat from : formats) {
+                        test(afw, afr, type, getStream(from, true));
+                        test(afw, afr, type, getStream(from, false));
+                    }
+                }
+            }
+        }
+    }
+
+    /**
+     * Writes and reads the data to/from the stream.
+     */
+    private static void test(final AudioFileWriter afw,
+                             final AudioFileReader afr,
+                             final AudioFileFormat.Type type,
+                             final AudioInputStream ais)
+            throws IOException {
+        try {
+            final ByteArrayOutputStream out = new ByteArrayOutputStream();
+            afw.write(ais, type, out);
+            final InputStream input = new ByteArrayInputStream(out.toByteArray());
+            final StreamWrapper wrapper = new StreamWrapper(input);
+
+            // the wrapper should be closed as well
+            afr.getAudioInputStream(wrapper).close();
+
+            if (wrapper.isOpen()) {
+                System.err.println("Writer = " + afw);
+                System.err.println("Reader = " + afr);
+                throw new RuntimeException("Stream was not closed");
+            }
+        } catch (IOException | IllegalArgumentException |
+                UnsupportedAudioFileException ignored) {
+        }
+    }
+
+    private static AudioInputStream getStream(final AudioFormat format,
+                                              final boolean frameLength) {
+        final int dataSize = FRAME_LENGTH * format.getFrameSize();
+        byte[] buf = new byte[dataSize];
+        final InputStream in = new ByteArrayInputStream(buf);
+        if (frameLength) {
+            return new AudioInputStream(in, format, FRAME_LENGTH);
+        } else {
+            return new AudioInputStream(in, format, NOT_SPECIFIED);
+        }
+    }
+}