Merge 565fb45 into 5d1b0e8

jcsteh · web-flow · commit 77cb061a32de · 2023-07-04T10:52:28.000+10:00
diff --git a/nvdaHelper/local/nvdaHelperLocal.def b/nvdaHelper/local/nvdaHelperLocal.def
@@ -70,6 +70,7 @@ EXPORTS
 	wasPlay_create
 	wasPlay_destroy
 	wasPlay_open
+	wasPlay_close
 	wasPlay_feed
 	wasPlay_stop
 	wasPlay_sync
diff --git a/nvdaHelper/local/wasapi.cpp b/nvdaHelper/local/wasapi.cpp
@@ -161,6 +161,8 @@ class WasapiPlayer {
 	 */
 	HRESULT open(bool force=false);
 
+	HRESULT close();
+
 	/**
 	 * Feed a chunk of audio.
 	 * If not null, id will be set to a number used to identify the audio
@@ -277,6 +279,13 @@ HRESULT WasapiPlayer::open(bool force) {
 	return S_OK;
 }
 
+HRESULT WasapiPlayer::close() {
+	client = nullptr;
+	render = nullptr;
+	clock = nullptr;
+	return S_OK;
+}
+
 HRESULT WasapiPlayer::feed(unsigned char* data, unsigned int size,
 	unsigned int* id
 ) {
@@ -530,6 +539,10 @@ HRESULT wasPlay_open(WasapiPlayer* player) {
 	return player->open();
 }
 
+HRESULT wasPlay_close(WasapiPlayer* player) {
+	return player->close();
+}
+
 HRESULT wasPlay_feed(WasapiPlayer* player, unsigned char* data,
 	unsigned int size, unsigned int* id
 ) {
diff --git a/source/nvwave.py b/source/nvwave.py
@@ -40,6 +40,7 @@
 from comtypes.hresult import S_OK
 import atexit
 import weakref
+import time
 import garbageHandler
 import winKernel
 import wave
@@ -48,6 +49,7 @@
 import os.path
 import extensionPoints
 import NVDAHelper
+import core
 
 
 __all__ = (
@@ -759,6 +761,13 @@ class WasapiWavePlayer(garbageHandler.TrackedObject):
 	#: This allows us to have a single callback in the class rather than on
 	#: each instance, which prevents reference cycles.
 	_instances = weakref.WeakValueDictionary()
+	#: How long (in seconds) to wait before closing an audio stream that hasn't
+	#: played.
+	_STREAM_CLOSE_TIMEOUT: int = 60
+	#: How often (in ms) to check whether streams should be closed.
+	_STREAM_CLOSE_CHECK_INTERVAL: int = 20000
+	#: Whether there is a pending stream close check.
+	_isStreamCloseCheckPending: bool = False
 
 	def __init__(
 			self,
@@ -807,7 +816,9 @@ def __init__(
 		)
 		self._doneCallbacks = {}
 		self._instances[self._player] = self
+		self._isOpen: bool
 		self.open()
+		self._lastActiveTime: float = time.time()
 
 	@wasPlay_callback
 	def _callback(cppPlayer, feedId):
@@ -845,11 +856,16 @@ def open(self):
 			raise
 		WasapiWavePlayer.audioDeviceError_static = False
 		self._setVolumeFromConfig()
+		self._isOpen = True
 
 	def close(self):
-		"""For WASAPI, this just stops playback.
+		"""Close the output device.
 		"""
+		if not self._isOpen:
+			return
 		self.stop()
+		NVDAHelper.localLib.wasPlay_close(self._player)
+		self._isOpen = False
 
 	def feed(
 			self,
@@ -868,6 +884,7 @@ def feed(
 		@param onDone: Function to call when this chunk has finished playing.
 		@raise WindowsError: If there was an error playing the audio.
 		"""
+		self.open()
 		if self._audioDucker:
 			self._audioDucker.enable()
 		feedId = c_uint() if onDone else None
@@ -879,6 +896,8 @@ def feed(
 		)
 		if onDone:
 			self._doneCallbacks[feedId.value] = onDone
+		self._lastActiveTime = time.time()
+		self._scheduleStreamCloseCheck()
 
 	def sync(self):
 		"""Synchronise with playback.
@@ -897,6 +916,8 @@ def idle(self):
 	def stop(self):
 		"""Stop playback.
 		"""
+		if not self._isOpen:
+			return
 		if self._audioDucker:
 			self._audioDucker.disable()
 		NVDAHelper.localLib.wasPlay_stop(self._player)
@@ -950,6 +971,45 @@ def _setVolumeFromConfig(self):
 				volume = synth.volume
 		self.setVolume(all=volume / 100)
 
+	@classmethod
+	def _scheduleStreamCloseCheck(cls):
+		if not cls._isStreamCloseCheckPending:
+			core.callLater(
+				cls._STREAM_CLOSE_CHECK_INTERVAL,
+				cls._streamCloseCheck
+			)
+			cls._isStreamCloseCheckPending = True
+
+	@classmethod
+	def _streamCloseCheck(cls):
+		"""Check whether there are open audio streams that should be considered
+		inactive. If there are any, close them. If there are open streams that
+		aren't ready to be closed yet, schedule another check.
+		This is necessary because holding streams open can prevent sleep on some
+		systems.
+		We do this in a single, class-wide check rather than separately for each
+		instance to avoid continually resetting a timer for each call to feed().
+		Resetting timers from another thread involves queuing to the main thread.
+		Doing that for every chunk of audio would not be very efficient.
+		Doing this with a class-wide check means that some checks might not take any
+		action and some streams might be kept open for a little longer than the
+		timeout, but this isn't problematic for our purposes.
+		"""
+		cls._isStreamCloseCheckPending = False
+		threshold = time.time() - cls._STREAM_CLOSE_TIMEOUT
+		stillOpenStream = False
+		for player in cls._instances.values():
+			if not player._isOpen:
+				continue
+			if player._lastActiveTime <= threshold:
+				player.close()
+			else:
+				stillOpenStream = True
+		if stillOpenStream:
+			# There's still at least one open stream that wasn't ready to be closed.
+			# Schedule another check here in case feed isn't called for a while.
+			cls._scheduleStreamCloseCheck()
+
 	@staticmethod
 	def _getDevices():
 		rawDevs = BSTR()
@@ -988,6 +1048,7 @@ def initialize():
 	for func in (
 		NVDAHelper.localLib.wasPlay_startup,
 		NVDAHelper.localLib.wasPlay_open,
+		NVDAHelper.localLib.wasPlay_close,
 		NVDAHelper.localLib.wasPlay_feed,
 		NVDAHelper.localLib.wasPlay_stop,
 		NVDAHelper.localLib.wasPlay_sync,
