8266421: Deadlock in Sound System

Reviewed-by: prr, azvegint

Author: mrserb

src/java.desktop/share/classes/com/sun/media/sound/AbstractDataLine.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1999, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2021, 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
@@ -295,13 +295,7 @@ final void setActive(boolean active) {
         //boolean sendEvents = false;
         //long position = getLongFramePosition();
 
-        synchronized (this) {
-
-            if (this.active != active) {
-                this.active = active;
-                //sendEvents = true;
-            }
-        }
+        this.active = active;
 
         // $$kk: 11.19.99: take ACTIVE / INACTIVE / EOM events out;
         // putting them in is technically an API change.
@@ -324,12 +318,9 @@ final void setStarted(boolean started) {
         boolean sendEvents = false;
         long position = getLongFramePosition();
 
-        synchronized (this) {
-
-            if (this.started != started) {
-                this.started = started;
-                sendEvents = true;
-            }
+        if (this.started != started) {
+            this.started = started;
+            sendEvents = true;
         }
 
         if (sendEvents) {

src/java.desktop/share/classes/com/sun/media/sound/AbstractLine.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1999, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2021, 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
@@ -159,11 +159,9 @@ final void setOpen(boolean open) {
         boolean sendEvents = false;
         long position = getLongFramePosition();
 
-        synchronized (this) {
-            if (this.open != open) {
-                this.open = open;
-                sendEvents = true;
-            }
+        if (this.open != open) {
+            this.open = open;
+            sendEvents = true;
         }
 
         if (sendEvents) {

src/java.desktop/share/classes/com/sun/media/sound/DirectAudioDevice.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2002, 2020, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2002, 2021, 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
@@ -1192,7 +1192,7 @@ public long getLongFramePosition() {
         }
 
         @Override
-        public synchronized void setMicrosecondPosition(long microseconds) {
+        public void setMicrosecondPosition(long microseconds) {
             long frames = Toolkit.micros2frames(getFormat(), microseconds);
             setFramePosition((int) frames);
         }

test/jdk/javax/sound/sampled/Clip/SetPositionHang.java

@@ -0,0 +1,106 @@
+/*
+ * Copyright (c) 2021, 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 javax.sound.sampled.AudioFormat;
+import javax.sound.sampled.AudioSystem;
+import javax.sound.sampled.Clip;
+import javax.sound.sampled.LineUnavailableException;
+
+/**
+ * @test
+ * @bug 8266421
+ * @summary Tests that Clip.setFramePosition/setMicrosecondPosition do not hang.
+ */
+public final class SetPositionHang implements Runnable {
+
+    private static volatile boolean testFramePosition;
+    private final Clip clip;
+    private final String thread;
+
+    private SetPositionHang(String thread, Clip clip) {
+        this.thread = thread;
+        this.clip = clip;
+    }
+
+    public static void main(String[] args) throws Exception {
+        testFramePosition = false;
+        test();
+        testFramePosition = true;
+        test();
+    }
+
+    private static void test() throws InterruptedException {
+        try (Clip clip = AudioSystem.getClip()) {
+            // prepare audio data
+            int frameCount = 441000; // lets say 10 seconds
+            AudioFormat format = new AudioFormat(44100.0f, 16, 2, true, false);
+            byte[] bytes = new byte[frameCount * format.getFrameSize()];
+
+            clip.open(format, bytes, 0, frameCount);
+            Thread t1 = new Thread(new SetPositionHang("1", clip));
+            Thread t2 = new Thread(new SetPositionHang("2", clip));
+            Thread t3 = new Thread(new SetPositionHang("3", clip));
+            Thread t4 = new Thread(new SetPositionHang("4", clip));
+            Thread t5 = new Thread(new SetPositionHang("5", clip));
+            t1.start();
+            t2.start();
+            t3.start();
+            t4.start();
+            t5.start();
+            t1.join();
+            t2.join();
+            t3.join();
+            t4.join();
+            t5.join();
+        } catch (LineUnavailableException | IllegalArgumentException ignored) {
+            // the test is not applicable
+        }
+    }
+
+    public void run() {
+        System.out.println("Thread " + thread + " Start");
+        for (int i = 0; i < 100; i++) {
+//            System.out.println("Thread " + thread + " Play " +
+//                               System.currentTimeMillis() % 100000);
+            playSound();
+            try {
+                Thread.sleep(i);
+            } catch (InterruptedException e) {
+                throw new RuntimeException(e);
+            }
+        }
+        System.out.println("Thread " + thread + " Finish");
+    }
+
+    private void playSound() {
+        if (clip.isRunning()) {
+            clip.stop();
+        }
+        if (testFramePosition) {
+            clip.setFramePosition(0);
+        } else {
+            clip.setMicrosecondPosition(0);
+        }
+        clip.start();
+    }
+}