From a3a07ab19047c8b08c83b1c0a360fb0e43475ad8 Mon Sep 17 00:00:00 2001 From: JarbasAI <33701864+JarbasAl@users.noreply.github.com> Date: Thu, 12 Sep 2024 03:58:52 +0100 Subject: [PATCH 1/6] documentation:readme (#99) * documentation:readme * Update README.md * Update README.md * Update README.md --- README.md | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 7402e83..3d64e0e 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,9 @@ Handles TTS generation and sounds playback ## Install -`pip install ovos-audio[extras]` to install this package and the default -plugins. +`pip install ovos-audio[extras]` to install this package and the default plugins. -Without `extras`, you will also need to manually install, -and possibly configure TTS modules as described below. +Without `extras`, you will also need to manually install, and possibly configure TTS modules as described below. # Configuration @@ -51,7 +49,7 @@ under mycroft.conf The legacy audio service supports audio playback via the old mycroft api ([@mycroft](https://github.com/MycroftAI/mycroft-core/blob/dev/mycroft/skills/audioservice.py#L43) [@ovos](https://github.com/OpenVoiceOS/ovos-bus-client/blob/dev/ovos_bus_client/apis/ocp.py#L51)) -by default OCP acts as a translation layer for this api and no action is needed, but if you want to disable ocp this api remains available +by default OCP delegates to the legacy audio service when necessary and no action is needed, but if you want to disable ocp this api can be used as the sole media playback provider > **NOTE:** once ovos-media is released OCP and this api will be disabled by default and deprecated! @@ -77,16 +75,16 @@ by default OCP acts as a translation layer for this api and no action is needed, ``` legacy plugins: -- [ocp](https://github.com/OpenVoiceOS/ovos-ocp-audio-plugin) - [vlc](https://github.com/OpenVoiceOS/ovos-vlc-plugin) - [simple](https://github.com/OpenVoiceOS/ovos-audio-plugin-simple) (no https support) +- [mpv](https://github.com/OpenVoiceOS/ovos-audio-plugin-mpv) <- recommended default +- [chromecast](https://github.com/OpenVoiceOS/ovos-media-plugin-chromecast) +- [spotify](https://github.com/OpenVoiceOS/ovos-media-plugin-spotify) **OCP technical details:** -- OCP was developed for mycroft-core under this legacy system -- OCP will pose as a legacy plugin and translate the received bus events to the [OCP api](https://github.com/OpenVoiceOS/ovos-bus-client/blob/dev/ovos_bus_client/apis/ocp.py#L228) +- OCP was developed for mycroft-core under the legacy audio service system - OCP is **always** the default audio plugin, unless you set `"disable_ocp": true` in config -- OCP uses the legacy api internally, to delegate playback when GUI is not available (or configured to do so) -- this does **NOT** bring support for old Mycroft CommonPlay skills, that is related to skills service not ovos-audio -- this brings support for [OCP skills](https://openvoiceos.github.io/ovos-technical-manual/OCP_skills) to OVOS until [ovos-media](https://github.com/OpenVoiceOS/ovos-media) is finished -- [ovos-media](https://github.com/OpenVoiceOS/ovos-media) will fully replace OCP in **ovos-audio 0.2.0** +- OCP uses the legacy api internally, to delegate playback when GUI is not available (or when configured to do so) +- does **NOT** bring support for old Mycroft CommonPlay skills, that is achieved by using the `"ocp_legacy"` pipeline with ovos-core +- [ovos-media](https://github.com/OpenVoiceOS/ovos-media) will fully replace OCP in **ovos-audio 1.0.0** From 7275c5ebc9f947d81f8b54acd4ca34aed39e461f Mon Sep 17 00:00:00 2001 From: JarbasAl Date: Thu, 12 Sep 2024 02:59:07 +0000 Subject: [PATCH 2/6] Increment Version to 0.2.2a1 --- ovos_audio/version.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ovos_audio/version.py b/ovos_audio/version.py index a210c75..90b2793 100644 --- a/ovos_audio/version.py +++ b/ovos_audio/version.py @@ -1,6 +1,6 @@ # START_VERSION_BLOCK VERSION_MAJOR = 0 VERSION_MINOR = 2 -VERSION_BUILD = 1 -VERSION_ALPHA = 0 +VERSION_BUILD = 2 +VERSION_ALPHA = 1 # END_VERSION_BLOCK From b1604883c545fa9f85fa880c388fb0a84bb46dd4 Mon Sep 17 00:00:00 2001 From: JarbasAl Date: Thu, 12 Sep 2024 02:59:30 +0000 Subject: [PATCH 3/6] Update Changelog --- CHANGELOG.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7f29962..e17a87b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,16 +1,12 @@ # Changelog -## [0.2.1a1](https://github.com/OpenVoiceOS/ovos-audio/tree/0.2.1a1) (2024-09-12) +## [0.2.2a1](https://github.com/OpenVoiceOS/ovos-audio/tree/0.2.2a1) (2024-09-12) -[Full Changelog](https://github.com/OpenVoiceOS/ovos-audio/compare/0.2.0...0.2.1a1) - -**Fixed bugs:** - -- OCP extractors failing when OCP is set to legacy audio service [\#81](https://github.com/OpenVoiceOS/ovos-audio/issues/81) +[Full Changelog](https://github.com/OpenVoiceOS/ovos-audio/compare/0.2.1...0.2.2a1) **Merged pull requests:** -- fix:stream extraction [\#97](https://github.com/OpenVoiceOS/ovos-audio/pull/97) ([JarbasAl](https://github.com/JarbasAl)) +- documentation:readme [\#99](https://github.com/OpenVoiceOS/ovos-audio/pull/99) ([JarbasAl](https://github.com/JarbasAl)) From 5d3fb0f65d4c8f436e2b5c8d18ce93efded47bee Mon Sep 17 00:00:00 2001 From: JarbasAI <33701864+JarbasAl@users.noreply.github.com> Date: Tue, 17 Sep 2024 16:41:24 +0100 Subject: [PATCH 4/6] fix:extras (#102) include spotify and chromecast plugins, this makes the cli scripts to set them up available by default --- requirements/extras.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/requirements/extras.txt b/requirements/extras.txt index b9a7908..6281597 100644 --- a/requirements/extras.txt +++ b/requirements/extras.txt @@ -4,6 +4,8 @@ ovos-tts-plugin-server>=0.0.2, <1.0.0 # Media Playback plugins ovos_audio_plugin_simple>=0.1.0, <1.0.0 ovos-audio-plugin-mpv>=0.0.1, <1.0.0 +ovos-media-plugin-spotify>=0.2.3, <1.0.0 +ovos-media-plugin-chromecast>=0.1.0, <1.0.0 ovos_plugin_common_play>=0.0.7, <1.0.0 # OCP plugins From b9668bc0ea9a03c977b8caba8b41dad3b2d69852 Mon Sep 17 00:00:00 2001 From: JarbasAl Date: Tue, 17 Sep 2024 15:41:39 +0000 Subject: [PATCH 5/6] Increment Version to 0.2.3a1 --- ovos_audio/version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ovos_audio/version.py b/ovos_audio/version.py index 90b2793..f245d8d 100644 --- a/ovos_audio/version.py +++ b/ovos_audio/version.py @@ -1,6 +1,6 @@ # START_VERSION_BLOCK VERSION_MAJOR = 0 VERSION_MINOR = 2 -VERSION_BUILD = 2 +VERSION_BUILD = 3 VERSION_ALPHA = 1 # END_VERSION_BLOCK From d34ab8c3cc1d5878aa1fb6cbb04310fe0dadcc9d Mon Sep 17 00:00:00 2001 From: JarbasAl Date: Tue, 17 Sep 2024 15:42:06 +0000 Subject: [PATCH 6/6] Update Changelog --- CHANGELOG.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index e17a87b..ce168fb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## [0.2.3a1](https://github.com/OpenVoiceOS/ovos-audio/tree/0.2.3a1) (2024-09-17) + +[Full Changelog](https://github.com/OpenVoiceOS/ovos-audio/compare/0.2.2a1...0.2.3a1) + +**Merged pull requests:** + +- fix:extras [\#102](https://github.com/OpenVoiceOS/ovos-audio/pull/102) ([JarbasAl](https://github.com/JarbasAl)) + ## [0.2.2a1](https://github.com/OpenVoiceOS/ovos-audio/tree/0.2.2a1) (2024-09-12) [Full Changelog](https://github.com/OpenVoiceOS/ovos-audio/compare/0.2.1...0.2.2a1)