Skip to content

Commit

Permalink
8301846: Invalid TargetDataLine after screen lock when using JFileCho…
Browse files Browse the repository at this point in the history
…oser or COM library

Reviewed-by: serb, aivanov
  • Loading branch information
Renjithkannath authored and aivanov-jdk committed Oct 31, 2023
1 parent 613d32c commit 613a3cc
Show file tree
Hide file tree
Showing 2 changed files with 167 additions and 1 deletion.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2003, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2003, 2023, 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
Expand Down Expand Up @@ -184,6 +184,12 @@ INT32 DAUDIO_GetDirectAudioDeviceCount() {
return 0;
}

HRESULT hr = ::CoInitializeEx(NULL, COINIT_MULTITHREADED | COINIT_DISABLE_OLE1DDE);
if (FAILED(hr) && hr != RPC_E_CHANGED_MODE) {
DS_unlockCache();
return 0;
}

if (g_lastCacheRefreshTime == 0
|| (UINT64) timeGetTime() > (UINT64) (g_lastCacheRefreshTime + WAIT_BETWEEN_CACHE_REFRESH_MILLIS)) {
/* first, initialize any old cache items */
Expand Down Expand Up @@ -224,6 +230,11 @@ INT32 DAUDIO_GetDirectAudioDeviceCount() {

g_lastCacheRefreshTime = (UINT64) timeGetTime();
}

if (hr != RPC_E_CHANGED_MODE) {
::CoUninitialize();
}

DS_unlockCache();
/*TRACE1("DirectSound: %d installed devices\n", g_mixerCount);*/
return g_mixerCount;
Expand Down Expand Up @@ -258,6 +269,13 @@ INT32 DAUDIO_GetDirectAudioDeviceDescription(INT32 mixerIndex, DirectAudioDevice
DS_unlockCache();
return FALSE;
}

HRESULT hr = ::CoInitializeEx(NULL, COINIT_MULTITHREADED | COINIT_DISABLE_OLE1DDE);
if (FAILED(hr) && hr != RPC_E_CHANGED_MODE) {
DS_unlockCache();
return 0;
}

desc->maxSimulLines = 0;
if (g_audioDeviceCache[desc->deviceID].isSource) {
DirectSoundEnumerateW((LPDSENUMCALLBACKW) DS_GetDescEnum, desc);
Expand All @@ -267,6 +285,10 @@ INT32 DAUDIO_GetDirectAudioDeviceDescription(INT32 mixerIndex, DirectAudioDevice
strncpy(desc->description, "DirectSound Capture", DAUDIO_STRING_LENGTH);
}

if (hr != RPC_E_CHANGED_MODE) {
::CoUninitialize();
}

/*desc->vendor;
desc->version;*/

Expand Down
144 changes: 144 additions & 0 deletions test/jdk/javax/sound/sampled/Lines/OpenLineAfterScreenLock.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
/*
* Copyright (c) 2023, 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.awt.BorderLayout;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;
import java.util.Arrays;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;

import javax.sound.sampled.AudioSystem;
import javax.sound.sampled.Line;
import javax.sound.sampled.LineUnavailableException;
import javax.sound.sampled.Mixer;
import javax.sound.sampled.TargetDataLine;
import javax.swing.JButton;
import javax.swing.JFileChooser;
import javax.swing.JFrame;
import javax.swing.JScrollPane;
import javax.swing.JTextArea;

import static javax.swing.SwingUtilities.invokeAndWait;

/*
* @test
* @bug 8301846
* @requires (os.family == "windows")
* @summary Sound recording fails after screen lock and unlock.
* @run main/manual OpenLineAfterScreenLock
*/
public class OpenLineAfterScreenLock {

private static final String INSTRUCTIONS = """
This test verifies it can record sound from the first sound capture device after
locking and unlocking the screen. The first part of the test has already completed.
Lock the screen and unlock it. Then click Continue to complete the test.
The test will finish automatically.
""";

private static final CountDownLatch latch = new CountDownLatch(1);

private static JFrame frame;

public static void main(String[] args) throws Exception {
try {
runTest();

// Creating JFileChooser initializes COM
// which affects ability to open audio lines
new JFileChooser();

invokeAndWait(OpenLineAfterScreenLock::createInstructionsUI);
if (!latch.await(2, TimeUnit.MINUTES)) {
throw new RuntimeException("Test failed: Test timed out!!");
}

runTest();
} finally {
invokeAndWait(() -> {
if (frame != null) {
frame.dispose();
}
});
}
System.out.println("Test Passed");
}

private static void runTest() {
try {
Mixer mixer = getMixer();
TargetDataLine line =
(TargetDataLine) mixer.getLine(mixer.getTargetLineInfo()[0]);
line.open();
line.close();
} catch (LineUnavailableException e) {
throw new RuntimeException("Test failed: Line unavailable", e);
}
}

private static Mixer getMixer() {
return Arrays.stream(AudioSystem.getMixerInfo())
.map(AudioSystem::getMixer)
.filter(OpenLineAfterScreenLock::isRecordingDevice)
.skip(1) // Skip the primary driver and choose one directly
.findAny()
.orElseThrow();
}

private static boolean isRecordingDevice(Mixer mixer) {
Line.Info[] lineInfos = mixer.getTargetLineInfo();
return lineInfos.length > 0
&& lineInfos[0].getLineClass() == TargetDataLine.class;
}

private static void createInstructionsUI() {
frame = new JFrame("Instructions for OpenLineAfterScreenLock");

JTextArea textArea = new JTextArea(INSTRUCTIONS);
textArea.setEditable(false);

JScrollPane pane = new JScrollPane(textArea);
frame.getContentPane().add(pane, BorderLayout.NORTH);

JButton button = new JButton("Continue");
button.addActionListener(e -> latch.countDown());
frame.getContentPane().add(button, BorderLayout.PAGE_END);

frame.pack();
frame.setLocationRelativeTo(null);

frame.addWindowListener(new CloseWindowHandler());
frame.setVisible(true);
}

private static class CloseWindowHandler extends WindowAdapter {
@Override
public void windowClosing(WindowEvent e) {
latch.countDown();
throw new RuntimeException("Test window closed abruptly");
}
}
}

9 comments on commit 613a3cc

@openjdk-notifier
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Renjithkannath
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/backport jdk21u

@openjdk
Copy link

@openjdk openjdk bot commented on 613a3cc Nov 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Renjithkannath To use the /backport command, you need to be in the OpenJDK census and your GitHub account needs to be linked with your OpenJDK username (how to associate your GitHub account with your OpenJDK username).

@Renjithkannath
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/backport jdk21u

@openjdk
Copy link

@openjdk openjdk bot commented on 613a3cc Nov 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Renjithkannath the backport was successfully created on the branch Renjithkannath-backport-613a3cc6 in my personal fork of openjdk/jdk21u. To create a pull request with this backport targeting openjdk/jdk21u:master, just click the following link:

➡️ Create pull request

The title of the pull request is automatically filled in correctly and below you find a suggestion for the pull request body:

Hi all,

This pull request contains a backport of commit 613a3cc6 from the openjdk/jdk repository.

The commit being backported was authored by Renjith Kannath Pariyangad on 31 Oct 2023 and was reviewed by Sergey Bylokhov and Alexey Ivanov.

Thanks!

If you need to update the source branch of the pull then run the following commands in a local clone of your personal fork of openjdk/jdk21u:

$ git fetch https://github.com/openjdk-bots/jdk21u.git Renjithkannath-backport-613a3cc6:Renjithkannath-backport-613a3cc6
$ git checkout Renjithkannath-backport-613a3cc6
# make changes
$ git add paths/to/changed/files
$ git commit --message 'Describe additional changes made'
$ git push https://github.com/openjdk-bots/jdk21u.git Renjithkannath-backport-613a3cc6

@mrserb
Copy link
Member

@mrserb mrserb commented on 613a3cc Nov 16, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/backport jdk17u-dev

@mrserb
Copy link
Member

@mrserb mrserb commented on 613a3cc Nov 16, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/backport jdk11u-dev

@openjdk
Copy link

@openjdk openjdk bot commented on 613a3cc Nov 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mrserb the backport was successfully created on the branch mrserb-backport-613a3cc6 in my personal fork of openjdk/jdk11u-dev. To create a pull request with this backport targeting openjdk/jdk11u-dev:master, just click the following link:

➡️ Create pull request

The title of the pull request is automatically filled in correctly and below you find a suggestion for the pull request body:

Hi all,

This pull request contains a backport of commit 613a3cc6 from the openjdk/jdk repository.

The commit being backported was authored by Renjith Kannath Pariyangad on 31 Oct 2023 and was reviewed by Sergey Bylokhov and Alexey Ivanov.

Thanks!

If you need to update the source branch of the pull then run the following commands in a local clone of your personal fork of openjdk/jdk11u-dev:

$ git fetch https://github.com/openjdk-bots/jdk11u-dev.git mrserb-backport-613a3cc6:mrserb-backport-613a3cc6
$ git checkout mrserb-backport-613a3cc6
# make changes
$ git add paths/to/changed/files
$ git commit --message 'Describe additional changes made'
$ git push https://github.com/openjdk-bots/jdk11u-dev.git mrserb-backport-613a3cc6

@openjdk
Copy link

@openjdk openjdk bot commented on 613a3cc Nov 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mrserb the backport was successfully created on the branch mrserb-backport-613a3cc6 in my personal fork of openjdk/jdk17u-dev. To create a pull request with this backport targeting openjdk/jdk17u-dev:master, just click the following link:

➡️ Create pull request

The title of the pull request is automatically filled in correctly and below you find a suggestion for the pull request body:

Hi all,

This pull request contains a backport of commit 613a3cc6 from the openjdk/jdk repository.

The commit being backported was authored by Renjith Kannath Pariyangad on 31 Oct 2023 and was reviewed by Sergey Bylokhov and Alexey Ivanov.

Thanks!

If you need to update the source branch of the pull then run the following commands in a local clone of your personal fork of openjdk/jdk17u-dev:

$ git fetch https://github.com/openjdk-bots/jdk17u-dev.git mrserb-backport-613a3cc6:mrserb-backport-613a3cc6
$ git checkout mrserb-backport-613a3cc6
# make changes
$ git add paths/to/changed/files
$ git commit --message 'Describe additional changes made'
$ git push https://github.com/openjdk-bots/jdk17u-dev.git mrserb-backport-613a3cc6

Please sign in to comment.