prevent audio playing between mic record and utt handling

mycroft/audio/audioservice.py

@@ -190,7 +190,8 @@ def load_services_callback(self):
         self.bus.on('recognizer_loop:audio_output_start', self._lower_volume)
         self.bus.on('recognizer_loop:record_begin', self._lower_volume)
         self.bus.on('recognizer_loop:audio_output_end', self._restore_volume)
-        self.bus.on('recognizer_loop:record_end', self._restore_volume)
+        self.bus.on('recognizer_loop:record_end',
+                    self._restore_volume_after_record)
 
     def track_start(self, track):
         """Callback method called from the services to indicate start of
@@ -294,6 +295,46 @@ def _restore_volume(self, message=None):
             if not self.volume_is_low:
                 self.current.restore_volume()
 
+    def _restore_volume_after_record(self, message=None):
+        """
+            Restores the volume when Mycroft is done recording.
+            If no utterance detected, restore immediately.
+            If no response is made in reasonable time, then also restore.
+
+            Args:
+                message: message bus message, not used but required
+        """
+        def __restore_volume():
+            LOG.debug('restoring volume')
+            self.current.restore_volume()
+
+        def wait_for_speak(bus, timeout=8):
+            """Wait for a speak Message on the bus.
+
+            Arguments:
+                bus (Mycroft MessageBus): Bus instance to listen on
+                timeout (int): how long to wait, defaults to 8 sec
+            """
+            self.speak_msg_detected = False
+
+            def detected_speak(message=None):
+                self.speak_msg_detected = True
+            self.bus.on('speak', detected_speak)
+            time.sleep(timeout)
+            self.bus.remove('speak', detected_speak)
+            return self.speak_msg_detected
+
+        if self.current is None:
+            LOG.debug("No audio service to restore volume of")
+            return None
+        self.bus.on('recognizer_loop:speech.recognition.unknown',
+                    __restore_volume)
+        speak_msg_detected = wait_for_speak(self.bus)
+        if not speak_msg_detected:
+            __restore_volume()
+        self.bus.remove('recognizer_loop:speech.recognition.unknown',
+                        __restore_volume)
+
     def play(self, tracks, prefered_service, repeat=False):
         """
             play starts playing the audio on the prefered service if it
@@ -440,4 +481,5 @@ def shutdown(self):
         self.bus.remove('recognizer_loop:record_begin', self._lower_volume)
         self.bus.remove('recognizer_loop:audio_output_end',
                         self._restore_volume)
-        self.bus.remove('recognizer_loop:record_end', self._restore_volume)
+        self.bus.remove('recognizer_loop:record_end',
+                        self._restore_volume_after_record)