Merge pull request #37 from OpenVoiceOS/release-1.0.8a1

Release 1.0.8a1

CHANGELOG.md

@@ -1,12 +1,16 @@
 # Changelog
 
-## [1.0.7a1](https://github.com/OpenVoiceOS/ovos-ocp-pipeline-plugin/tree/1.0.7a1) (2024-11-19)
+## [1.0.8a1](https://github.com/OpenVoiceOS/ovos-ocp-pipeline-plugin/tree/1.0.8a1) (2024-11-22)
 
-[Full Changelog](https://github.com/OpenVoiceOS/ovos-ocp-pipeline-plugin/compare/1.0.6...1.0.7a1)
+[Full Changelog](https://github.com/OpenVoiceOS/ovos-ocp-pipeline-plugin/compare/1.0.7...1.0.8a1)
+
+**Fixed bugs:**
+
+- Potential hanging during URI extraction in  function [\#35](https://github.com/OpenVoiceOS/ovos-ocp-pipeline-plugin/issues/35)
 
 **Merged pull requests:**
 
-- fix:allow\_workshop\_300 [\#32](https://github.com/OpenVoiceOS/ovos-ocp-pipeline-plugin/pull/32) ([JarbasAl](https://github.com/JarbasAl))
+- improve OCP detection + speed up legacy playback start [\#34](https://github.com/OpenVoiceOS/ovos-ocp-pipeline-plugin/pull/34) ([JarbasAl](https://github.com/JarbasAl))
 
 
 

ocp_pipeline/opm.py

@@ -4,7 +4,7 @@
 from dataclasses import dataclass
 from os.path import join, dirname
 from threading import RLock
-from typing import Tuple, Optional, Dict, List, Union
+from typing import Tuple, Optional, Dict, List, Union, Any
 
 from langcodes import closest_match
 from ovos_bus_client.apis.ocp import ClassicAudioServiceInterface
@@ -38,6 +38,11 @@ class OCPPlayerProxy:
     media_type: MediaType = MediaType.GENERIC
 
 
+# for easier typing
+RawResultsList = List[Union[MediaEntry, Playlist, PluginStream, Dict[str, Any]]]
+NormalizedResultsList = List[Union[MediaEntry, Playlist, PluginStream]]
+
+
 class OCPPipelineMatcher(ConfidenceMatcherPipeline, OVOSAbstractApplication):
     intents = ["play.intent", "open.intent", "media_stop.intent",
                "next.intent", "prev.intent", "pause.intent", "play_favorites.intent",
@@ -145,7 +150,6 @@ def register_ocp_api_events(self):
     @classmethod
     def load_intent_files(cls):
         intent_files = cls.load_resource_files()
-
         for lang, intent_data in intent_files.items():
             lang = standardize_lang_tag(lang)
             cls.intent_matchers[lang] = IntentContainer()
@@ -756,6 +760,31 @@ def _should_resume(self, phrase: str, lang: str, message: Optional[Message] = No
         return False
 
     # search
+    def _player_sync(self, player: OCPPlayerProxy, message: Optional[Message] = None, timeout=1) -> OCPPlayerProxy:
+
+        if not self.config.get("legacy"):  # force legacy audio in config
+            ev = threading.Event()
+
+            def handle_m(m):
+                nonlocal player
+                s = SessionManager.get(m)
+                if s.session_id == player.session_id:
+                    player.available_extractors = m.data["SEI"]
+                    player.ocp_available = True
+                    self.update_player_proxy(player)
+                    ev.set()
+                    LOG.info(f"Session: {player.session_id} Available stream extractor plugins: {m.data['SEI']}")
+
+            self.bus.on("ovos.common_play.SEI.get.response", handle_m)
+            message = message or dig_for_message() or Message("")  # get message.context to forward
+            self.bus.emit(message.forward("ovos.common_play.SEI.get"))
+            ev.wait(timeout)
+            self.bus.remove("ovos.common_play.SEI.get.response", handle_m)
+
+            if not ev.is_set():
+                LOG.warning(f"Player synchronization timed out after {timeout} seconds")
+
+        return player
     def get_player(self, message: Optional[Message] = None, timeout=1) -> OCPPlayerProxy:
         """get a PlayerProxy object, containing info such as player state and the available stream extractors from OCP
         this is tracked per Session, if needed requests the info from the client"""
@@ -764,27 +793,15 @@ def get_player(self, message: Optional[Message] = None, timeout=1) -> OCPPlayerP
             player = OCPPlayerProxy(available_extractors=available_extractors(),
                                     ocp_available=False,
                                     session_id=sess.session_id)
-            if not self.config.get("legacy"):  # force legacy audio in config
-                ev = threading.Event()
-
-                def handle_m(m):
-                    s = SessionManager.get(m)
-                    if s.session_id == player.session_id:
-                        player.available_extractors = m.data["SEI"]
-                        player.ocp_available = True
-                        ev.set()
-                        LOG.info(f"Session: {player.session_id} Available stream extractor plugins: {m.data['SEI']}")
-
-                self.bus.on("ovos.common_play.SEI.get.response", handle_m)
-                message = message or dig_for_message() or Message("")  # get message.context to forward
-                self.bus.emit(message.forward("ovos.common_play.SEI.get"))
-                ev.wait(timeout)
-                self.bus.remove("ovos.common_play.SEI.get.response", handle_m)
-            self.update_player_proxy(player)
-
-        return self.ocp_sessions[sess.session_id]
+        else:
+            player = self.ocp_sessions[sess.session_id]
+        if not player.ocp_available and not self.config.get("legacy"):
+            # OCP might have loaded meanwhile
+            player = self._player_sync(player, message, timeout)
+        return player
 
-    def normalize_results(self, results: list) -> List[Union[MediaEntry, Playlist, PluginStream]]:
+    @staticmethod
+    def normalize_results(results: RawResultsList) -> NormalizedResultsList:
         # support Playlist and MediaEntry objects in tracks
         for idx, track in enumerate(results):
             if isinstance(track, dict):
@@ -975,29 +992,40 @@ def select_best(results: list, message: Message) -> Union[MediaEntry, Playlist,
 
     ##################
     # Legacy Audio subsystem API
-    def legacy_play(self, results: List[Union[MediaEntry, Playlist, PluginStream]], phrase="",
+    def legacy_play(self, results: NormalizedResultsList, phrase="",
                     message: Optional[Message] = None):
-        res = []
-        for r in results:
+        player = self.get_player(message)
+        player.media_state = MediaState.LOADING_MEDIA
+        playing = False
+        for idx, r in enumerate(results):
+            real_uri = None
             if not (r.playback == PlaybackType.AUDIO or r.media_type in OCPQuery.cast2audio):
                 # we need to filter video results
                 continue
             if isinstance(r, Playlist):
                 # get internal entries from the playlist
-                for e in r.entries:
-                    res.append(e.uri)
+                real_uri = [e.uri for e in r.entries]
             elif isinstance(r, MediaEntry):
-                res.append(r.uri)
+                real_uri = r.uri
             elif isinstance(r, PluginStream):
                 # for legacy audio service we need to do stream extraction here
-                res.append(r.extract_uri(video=False))
-
-        self.legacy_api.play(res, utterance=phrase, source_message=message)
+                LOG.debug(f"extracting uri: {r.stream}")
+                # TODO - apparently it can hang here forever ???
+                # happens with https://www.cbc.ca/podcasting/includes/hourlynews.xml from news skill
+                try:
+                    real_uri = r.extract_uri(video=False)
+                except Exception as e:
+                    LOG.exception(f"extraction failed: {r}")
+            if not real_uri:
+                continue
+            if not playing:
+                playing = True
+                self.legacy_api.play(real_uri, utterance=phrase, source_message=message)
+                player.player_state = PlayerState.PLAYING
+                self.update_player_proxy(player)
+            else:
+                self.legacy_api.queue(real_uri, source_message=message)
 
-        player = self.get_player(message)
-        player.player_state = PlayerState.PLAYING
-        player.media_state = MediaState.LOADING_MEDIA
-        self.update_player_proxy(player)
 
     def _handle_legacy_audio_stop(self, message: Message):
         player = self.get_player(message)

ocp_pipeline/version.py

@@ -1,6 +1,6 @@
 # START_VERSION_BLOCK
 VERSION_MAJOR = 1
 VERSION_MINOR = 0
-VERSION_BUILD = 7
-VERSION_ALPHA = 0
+VERSION_BUILD = 8
+VERSION_ALPHA = 1
 # END_VERSION_BLOCK