Changeset 2348

Timestamp:

08/12/08 08:32:18 (5 months ago)

Author:

bzr

Message:

Merge nvwaveImprovements branch.

nvwave.WavePlayer?:

• Close the output device when idle, rather than always keeping it open.
  • This means that if using the default output device (wave mapper) and the default output device changes (e.g. due to plugging in an external sound card), the new device will be used. Users will notice this for eSpeak and tones.
  • This also fixes the issue where the last chunk of audio would be cut off when using NVDA with eSpeak on a Remote Desktop server.
  • Note that tones may exhibit some strange effects when issued rapidly.
• When stopping audio, pause first before resetting the output device. This is bizarre, but it seems to improve performance with some Vista audio drivers.
• Other efficiency and reliability fixes.

Location:

trunk

Files:

• . (modified) (3 props)
• source/nvwave.py (modified) (10 diffs)
• source/synthDrivers/_espeak.py (modified) (1 diff)

trunk

@@ -176 +176 @@
 2145 jamie@jantrid.net-20080807065623-wh0xcx1l34f41h39
 2146 jamie@jantrid.net-20080812020217-6ofbi1u1q3sbq7ni
+2147 jamie@jantrid.net-20080812071342-5fqd45cc29z5ugh6
-timestamp: 2008-08-12 12:02:17.473999977 +1000
+timestamp: 2008-08-12 17:13:42.000000000 +1000
 committer: James Teh <jamie@jantrid.net>
 properties: 
 mick@kulgan.net-20080701041209-fd196zokjqabm0u6
 jamie@jantrid.net-20080702061732-274iwmap8bkwbp8b
+jamie@jantrid.net-20080810101432-te9chzpil51jwjtd

@@ -176 +176 @@
 2145 jamie@jantrid.net-20080807065623-wh0xcx1l34f41h39
 2146 jamie@jantrid.net-20080812020217-6ofbi1u1q3sbq7ni
+2147 jamie@jantrid.net-20080812071342-5fqd45cc29z5ugh6

@@ -1 @@
-timestamp: 2008-08-12 12:02:17.473999977 +1000
+timestamp: 2008-08-12 17:13:42.000000000 +1000
 committer: James Teh <jamie@jantrid.net>
 properties: 

@@ -8 +8 @@
 mick@kulgan.net-20080701041209-fd196zokjqabm0u6
 jamie@jantrid.net-20080702061732-274iwmap8bkwbp8b
+jamie@jantrid.net-20080810101432-te9chzpil51jwjtd

trunk/source/nvwave.py

@@ -9 +9 @@
 
 from __future__ import with_statement
-import time
 import threading
 from ctypes import *
@@ -19 +18 @@
 
 winmm = windll.winmm
+kernel32 = windll.kernel32
+
+INFINITE = 0xffffffff
 
 HWAVEOUT = HANDLE
@@ -56 +58 @@
 CALLBACK_NULL = 0
 #CALLBACK_FUNCTION = 0x30000
+CALLBACK_EVENT = 0x50000
 #waveOutProc = CFUNCTYPE(HANDLE, UINT, DWORD, DWORD, DWORD)
 #WOM_DONE = 0x3bd
@@ -93 +96 @@
         """
 
-        def __init__(self, channels, samplesPerSec, bitsPerSample, outputDevice=WAVE_MAPPER):
+        def __init__(self, channels, samplesPerSec, bitsPerSample, outputDevice=WAVE_MAPPER, closeWhenIdle=True):
                 """Constructor.
                 @param channels: The number of channels of audio; e.g. 2 for stereo, 1 for mono.
@@ -103 +106 @@
                 @param outputDevice: The device ID or name of the audio output device to use.
                 @type outputDevice: int or basestring
+                @param closeWhenIdle: If C{True}, close the output device when no audio is being played.
+                @type closeWhenIdle: bool
                 @note: If C{outputDevice} is a name and no such device exists, the default device will be used.
                 @raise WindowsError: If there was an error opening the audio output device.
@@ -112 +117 @@
                         outputDevice = outputDeviceNameToID(outputDevice, True)
                 self.outputDeviceID = outputDevice
-                self._open()
-                self._whdr_lock = threading.RLock()
-
-        def _open(self):
-                wfx = WAVEFORMATEX()
-                wfx.wFormatTag = WAVE_FORMAT_PCM
-                wfx.nChannels = self.channels
-                wfx.nSamplesPerSec = self.samplesPerSec
-                wfx.wBitsPerSample = self.bitsPerSample
-                wfx.nBlockAlign = self.bitsPerSample / 8 * self.channels
-                wfx.nAvgBytesPerSec = self.samplesPerSec * wfx.nBlockAlign
-                waveout = HWAVEOUT(0)
-                winmm.waveOutOpen(byref(waveout), self.outputDeviceID, LPWAVEFORMATEX(wfx), 0, 0, CALLBACK_NULL)
-                self._waveout = waveout.value
-                self._prev_whdr = None
+                #: If C{True}, close the output device when no audio is being played.
+                #: @type: bool
+                self.closeWhenIdle = closeWhenIdle
+                self._waveout = None
+                self._waveout_event = kernel32.CreateEventW(None, False, False, None)
+                self._waveout_lock = threading.RLock()
+                self._lock = threading.RLock()
+                self.open()
+
+        def open(self):
+                """Open the output device.
+                This will be called automatically when required.
+                It is not an error if the output device is already open.
+                """
+                with self._waveout_lock:
+                        if self._waveout:
+                                return
+                        wfx = WAVEFORMATEX()
+                        wfx.wFormatTag = WAVE_FORMAT_PCM
+                        wfx.nChannels = self.channels
+                        wfx.nSamplesPerSec = self.samplesPerSec
+                        wfx.wBitsPerSample = self.bitsPerSample
+                        wfx.nBlockAlign = self.bitsPerSample / 8 * self.channels
+                        wfx.nAvgBytesPerSec = self.samplesPerSec * wfx.nBlockAlign
+                        waveout = HWAVEOUT(0)
+                        winmm.waveOutOpen(byref(waveout), self.outputDeviceID, LPWAVEFORMATEX(wfx), self._waveout_event, 0, CALLBACK_EVENT)
+                        self._waveout = waveout.value
+                        self._prev_whdr = None
 
         def feed(self, data):
@@ -140 +158 @@
                 whdr.lpData = data
                 whdr.dwBufferLength = len(data)
-                winmm.waveOutPrepareHeader(self._waveout, LPWAVEHDR(whdr), sizeof(WAVEHDR))
-                try:
-                        winmm.waveOutWrite(self._waveout, LPWAVEHDR(whdr), sizeof(WAVEHDR))
+                with self._lock:
+                        with self._waveout_lock:
+                                self.open()
+                                winmm.waveOutPrepareHeader(self._waveout, LPWAVEHDR(whdr), sizeof(WAVEHDR))
+                                try:
+                                        winmm.waveOutWrite(self._waveout, LPWAVEHDR(whdr), sizeof(WAVEHDR))
+                                except WindowsError, e:
+                                        self.close()
+                                        raise e
                         self.sync()
-                except WindowsError, e:
-                        self.close()
-                        self._open()
-                        raise e
-                with self._whdr_lock:
                         self._prev_whdr = whdr
 
@@ -154 +173 @@
                 """Synchronise with playback.
                 This method blocks until the previously fed chunk of audio has finished playing.
-                It need only be called directly if there is no more audio to feed, but synchronisation is nevertheless desired.
-                """
-                with self._whdr_lock:
+                It is called automatically by L{feed}, so usually need not be called directly by the user.
+                """
+                with self._lock:
                         if not self._prev_whdr:
                                 return
-                        # todo: Wait for an event instead of spinning.
+                        assert self._waveout, "waveOut None before wait"
                         while not (self._prev_whdr.dwFlags & WHDR_DONE):
-                                time.sleep(0.005)
-                        winmm.waveOutUnprepareHeader(self._waveout, LPWAVEHDR(self._prev_whdr), sizeof(WAVEHDR))
+                                kernel32.WaitForSingleObject(self._waveout_event, INFINITE)
+                        with self._waveout_lock:
+                                assert self._waveout, "waveOut None after wait"
+                                winmm.waveOutUnprepareHeader(self._waveout, LPWAVEHDR(self._prev_whdr), sizeof(WAVEHDR))
                         self._prev_whdr = None
 
@@ -170 +191 @@
                 @type switch: bool
                 """
-                if switch:
-                        winmm.waveOutPause(self._waveout)
-                else:
-                        winmm.waveOutRestart(self._waveout)
+                with self._waveout_lock:
+                        if not self._waveout:
+                                return
+                        if switch:
+                                winmm.waveOutPause(self._waveout)
+                        else:
+                                winmm.waveOutRestart(self._waveout)
+
+        def idle(self):
+                """Indicate that this player is now idle; i.e. the current continuous segment  of audio is complete.
+                This will first call L{sync} to synchronise with playback.
+                If L{closeWhenIdle} is C{True}, the output device will be closed.
+                A subsequent call to L{feed} will reopen it.
+                """
+                with self._lock:
+                        self.sync()
+                        with self._waveout_lock:
+                                if not self._waveout:
+                                        return
+                                if self.closeWhenIdle:
+                                        self._close()
 
         def stop(self):
                 """Stop playback.
                 """
-                try:
-                        winmm.waveOutReset(self._waveout)
-                except WindowsError:
-                        # waveOutReset seems to fail randomly on some systems.
-                        pass
-                # Unprepare the previous buffer.
-                self.sync()
+                with self._waveout_lock:
+                        if not self._waveout:
+                                return
+                        try:
+                                # Pausing first seems to make waveOutReset respond faster on some systems.
+                                winmm.waveOutPause(self._waveout)
+                                winmm.waveOutReset(self._waveout)
+                        except WindowsError:
+                                # waveOutReset seems to fail randomly on some systems.
+                                pass
+                # Unprepare the previous buffer and close the output device if appropriate.
+                self.idle()
 
         def close(self):
                 """Close the output device.
-                @postcondition: The audio device is closed; this instance is no longer useable.
                 """
                 self.stop()
+                with self._lock:
+                        with self._waveout_lock:
+                                if not self._waveout:
+                                        return
+                                self._close()
+
+        def _close(self):
                 winmm.waveOutClose(self._waveout)
                 self._waveout = None
+
+        def __del__(self):
+                self.close()
+                kernel32.CloseHandle(self._waveout_event)
+                self._waveout_event = None
 
 def _getOutputDevices():
@@ -241 +295 @@
         # No such ID.
         if useDefaultIfInvalid:
-                return -1
+                return WAVE_MAPPER
         else:
                 raise LookupError("No such device name")

trunk/source/synthDrivers/_espeak.py

@@ -122 +122 @@
                 lastIndex = event.contents.user_data
                 if not wav:
-                        player.sync()
+                        player.idle()
                         isSpeaking = False
                         return 0

@@ -176 +176 @@
 2145 jamie@jantrid.net-20080807065623-wh0xcx1l34f41h39
 2146 jamie@jantrid.net-20080812020217-6ofbi1u1q3sbq7ni
+2147 jamie@jantrid.net-20080812071342-5fqd45cc29z5ugh6

@@ -1 @@
-timestamp: 2008-08-12 12:02:17.473999977 +1000
+timestamp: 2008-08-12 17:13:42.000000000 +1000
 committer: James Teh <jamie@jantrid.net>
 properties: 

@@ -8 +8 @@
 mick@kulgan.net-20080701041209-fd196zokjqabm0u6
 jamie@jantrid.net-20080702061732-274iwmap8bkwbp8b
+jamie@jantrid.net-20080810101432-te9chzpil51jwjtd