ovos-media-plugin-cli 0.0.3a1__tar.gz

ovos_media_plugin_cli-0.0.3a1/LICENSE

@@ -0,0 +1,203 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022 Casimiro Ferreira
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

ovos_media_plugin_cli-0.0.3a1/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: ovos-media-plugin-cli
+Version: 0.0.3a1
+Summary: Generic CLI-command playback plugin for ovos-media (and the legacy ovos-audio service)
+Author-email: JarbasAi <jarbasai@mailfence.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/OpenVoiceOS/ovos-media-plugin-cli
+Keywords: ovos,audio,OCP,plugin,cli
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ovos-plugin-manager<3.0.0,>=2.1.0
+Requires-Dist: requests
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: ovoscope[media]>=0.20.0a1; extra == "test"
+Dynamic: license-file
+
+# ovos-media-plugin-cli
+
+Generic **command-line playback** plugin for
+[ovos-media](https://github.com/OpenVoiceOS/ovos-media), and for the legacy
+`ovos-audio` service.
+
+The plugin plays a track by running a command-line media player as a
+subprocess. Point it at any player command, or let it auto-detect the best
+available one for your platform.
+
+- **Explicit command**: set `command` (for example `"mpv --no-terminal"`,
+  `"cvlc --play-and-exit"`, `"ffplay -nodisp -autoexit"`). The plugin appends
+  the track URI as the final argument.
+- **Auto-detect** (default): when you do not set a command, the plugin picks
+  the best available player for your platform through `shutil.which`. It
+  prefers `sox` (`play`), then tries `mpg123`, `paplay`, or `aplay` on Linux,
+  and `afplay` on macOS.
+
+Pause and resume use process signals (`SIGSTOP`/`SIGCONT`). Stop terminates
+the child process.
+
+## Install
+
+```bash
+pip install ovos-media-plugin-cli
+```
+
+Install `sox` too. It gives the widest format and URL coverage when the
+plugin auto-detects a player.
+
+## Configuration
+
+New `ovos-media`:
+
+```json
+{
+  "media": {
+    "preferred_audio_services": ["mplayer", "vlc", "cli"],
+    "audio_players": {
+      "cli": {
+        "module": "ovos-media-audio-plugin-cli",
+        "aliases": ["Command line", "CLI Player"],
+        "active": true,
+        "command": "mpv --no-terminal"
+      }
+    }
+  }
+}
+```
+
+Omit `command` to auto-detect. Legacy `ovos-audio`:
+
+```json
+{
+  "Audio": {
+    "backends": {
+      "cli": { "type": "cli", "active": true, "command": "mpv --no-terminal" }
+    }
+  }
+}
+```
+
+### Keys
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| `command` (alias `play_cmd`) | str | _auto-detect_ | CLI player command. The plugin appends the URI as the last argument. |
+| `active` | bool | `true` | Enable or disable this backend instance. |
+
+## Entry points
+
+| Group | Name | Object |
+|-------|------|--------|
+| `opm.media.audio` | `ovos-media-audio-plugin-cli` | `ovos_media_plugin_cli:CLIAudioService` |
+| `mycroft.plugin.audioservice` | `ovos_cli` | `ovos_media_plugin_cli.audio` |
+
+## Related projects
+
+- [ovos-media](https://github.com/OpenVoiceOS/ovos-media): the media service this plugin's `opm.media.audio` entry point serves.
+- [ovos-plugin-manager](https://github.com/OpenVoiceOS/ovos-plugin-manager): defines the `MediaBackend`/`AudioPlayerBackend` and legacy `AudioBackend` base classes this plugin implements.
+- [ovos-media-plugin-mpv](https://github.com/OpenVoiceOS/ovos-media-plugin-mpv), [ovos-media-plugin-vlc](https://github.com/OpenVoiceOS/ovos-media-plugin-vlc), [ovos-media-plugin-mplayer](https://github.com/OpenVoiceOS/ovos-media-plugin-mplayer), and [ovos-media-plugin-ffplay](https://github.com/OpenVoiceOS/ovos-media-plugin-ffplay): sibling audio-playback plugins for one specific player, instead of the generic CLI command this plugin wraps.
+
+## License
+
+Apache-2.0, see [LICENSE](LICENSE).

ovos_media_plugin_cli-0.0.3a1/README.md

@@ -0,0 +1,85 @@
+# ovos-media-plugin-cli
+
+Generic **command-line playback** plugin for
+[ovos-media](https://github.com/OpenVoiceOS/ovos-media), and for the legacy
+`ovos-audio` service.
+
+The plugin plays a track by running a command-line media player as a
+subprocess. Point it at any player command, or let it auto-detect the best
+available one for your platform.
+
+- **Explicit command**: set `command` (for example `"mpv --no-terminal"`,
+  `"cvlc --play-and-exit"`, `"ffplay -nodisp -autoexit"`). The plugin appends
+  the track URI as the final argument.
+- **Auto-detect** (default): when you do not set a command, the plugin picks
+  the best available player for your platform through `shutil.which`. It
+  prefers `sox` (`play`), then tries `mpg123`, `paplay`, or `aplay` on Linux,
+  and `afplay` on macOS.
+
+Pause and resume use process signals (`SIGSTOP`/`SIGCONT`). Stop terminates
+the child process.
+
+## Install
+
+```bash
+pip install ovos-media-plugin-cli
+```
+
+Install `sox` too. It gives the widest format and URL coverage when the
+plugin auto-detects a player.
+
+## Configuration
+
+New `ovos-media`:
+
+```json
+{
+  "media": {
+    "preferred_audio_services": ["mplayer", "vlc", "cli"],
+    "audio_players": {
+      "cli": {
+        "module": "ovos-media-audio-plugin-cli",
+        "aliases": ["Command line", "CLI Player"],
+        "active": true,
+        "command": "mpv --no-terminal"
+      }
+    }
+  }
+}
+```
+
+Omit `command` to auto-detect. Legacy `ovos-audio`:
+
+```json
+{
+  "Audio": {
+    "backends": {
+      "cli": { "type": "cli", "active": true, "command": "mpv --no-terminal" }
+    }
+  }
+}
+```
+
+### Keys
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| `command` (alias `play_cmd`) | str | _auto-detect_ | CLI player command. The plugin appends the URI as the last argument. |
+| `active` | bool | `true` | Enable or disable this backend instance. |
+
+## Entry points
+
+| Group | Name | Object |
+|-------|------|--------|
+| `opm.media.audio` | `ovos-media-audio-plugin-cli` | `ovos_media_plugin_cli:CLIAudioService` |
+| `mycroft.plugin.audioservice` | `ovos_cli` | `ovos_media_plugin_cli.audio` |
+
+## Related projects
+
+- [ovos-media](https://github.com/OpenVoiceOS/ovos-media): the media service this plugin's `opm.media.audio` entry point serves.
+- [ovos-plugin-manager](https://github.com/OpenVoiceOS/ovos-plugin-manager): defines the `MediaBackend`/`AudioPlayerBackend` and legacy `AudioBackend` base classes this plugin implements.
+- [ovos-media-plugin-mpv](https://github.com/OpenVoiceOS/ovos-media-plugin-mpv), [ovos-media-plugin-vlc](https://github.com/OpenVoiceOS/ovos-media-plugin-vlc), [ovos-media-plugin-mplayer](https://github.com/OpenVoiceOS/ovos-media-plugin-mplayer), and [ovos-media-plugin-ffplay](https://github.com/OpenVoiceOS/ovos-media-plugin-ffplay): sibling audio-playback plugins for one specific player, instead of the generic CLI command this plugin wraps.
+
+## License
+
+Apache-2.0, see [LICENSE](LICENSE).

ovos_media_plugin_cli-0.0.3a1/ovos_media_plugin_cli/__init__.py

@@ -0,0 +1,283 @@
+import mimetypes
+import platform
+import re
+import shutil
+import signal
+import subprocess
+import time
+from time import sleep
+
+from ovos_plugin_manager.templates.media import MediaBackend, AudioPlayerBackend
+from ovos_utils.log import LOG
+from requests import Session
+
+
+def find_mime(path):
+    mime = None
+    if path.startswith('http'):
+        response = Session().head(path, allow_redirects=True)
+        if 200 <= response.status_code < 300:
+            mime = response.headers['content-type']
+    if not mime:
+        mime = mimetypes.guess_type(path)[0]
+    # Remove any http address arguments
+    if not mime:
+        mime = mimetypes.guess_type(re.sub(r'\?.*$', '', path))[0]
+
+    if mime:
+        return mime.split('/')
+    else:
+        return (None, None)
+
+
+def play_audio(uri, play_cmd):
+    """ Play a audio file.
+
+        Returns: subprocess.Popen object
+    """
+    play_wav_cmd = play_cmd.split() + [uri]
+
+    try:
+        return subprocess.Popen(play_wav_cmd)
+    except Exception as e:
+        LOG.error(f"Failed to play: {play_wav_cmd}")
+        LOG.debug(f"Error: {e}")
+        return None
+
+
+class CLIBaseService(MediaBackend):
+    """Framework-agnostic subprocess-based audio player.
+
+    Holds all the playback logic (spawning/stopping a CLI player such as
+    ``play``/``paplay``/``aplay``/``mpg123``, pause/resume via process signals,
+    position estimation). It is shared by both backend flavours:
+
+    * new ``ovos-media`` — :class:`CLIAudioService` (``AudioPlayerBackend``)
+    * legacy ``ovos-audio`` — :class:`~ovos_media_plugin_cli.audio.CLIOldAudioService`
+      (``AudioBackend``)
+
+    so the two entry points drive the same engine with no duplicated logic.
+    """
+    sox_play = shutil.which("play")
+    pulse_play = shutil.which("paplay")
+    alsa_play = shutil.which("aplay")
+    mpg123_play = shutil.which("mpg123")
+    afplay = shutil.which("afplay")  # macOS
+
+    def __init__(self, config, bus=None):
+        super().__init__(config, bus)
+        self.process = None
+        self._stop_signal = False
+        self._is_playing = False
+        self._paused = False
+        self.ts = 0
+
+        self.supports_mime_hints = True
+        mimetypes.init()
+
+    def on_track_start(self):
+        self.ts = time.time()
+        # Indicate to audio service which track is being played
+        if self._track_start_callback:
+            self._track_start_callback(self._now_playing)
+
+    def on_track_end(self):
+        self._is_playing = False
+        self._paused = False
+        self.process = None
+        self.ts = 0
+        if self._track_start_callback:
+            self._track_start_callback(None)
+
+    def on_track_error(self):
+        self._is_playing = False
+        self._paused = False
+        self.process = None
+        self.ts = 0
+        self.ocp_error()
+
+    # player internals
+    def _get_track(self, track_data):
+        if isinstance(track_data, list):
+            track = track_data[0]
+            mime = track_data[1]
+            mime = mime.split('/')
+        else:  # Assume string
+            track = track_data
+            mime = find_mime(track)
+        return track, mime
+
+    def _is_process_running(self):
+        return self.process and self.process.poll() is None
+
+    def _stop_running_process(self):
+        if self._is_process_running():
+            if self._paused:
+                # The child process must be "unpaused" in order to be stopped
+                self.process.send_signal(signal.SIGCONT)
+            self.process.terminate()
+            countdown = 10
+            while self._is_process_running() and countdown > 0:
+                sleep(0.1)
+                countdown -= 1
+
+            if self._is_process_running():
+                # Failed to shutdown when asked nicely.  Force the issue.
+                LOG.debug("Killing currently playing audio...")
+                self.process.kill()
+        self.process = None
+
+    @property
+    def player_cmd(self):
+        """The CLI command used to play a stream.
+
+        Resolution order:
+
+        1. an explicit command from config (``command`` / ``play_cmd``) — the
+           generic case: any CLI player you want, e.g. ``"mpv --no-terminal"`` or
+           ``"cvlc --play-and-exit"``. The track URI is appended as the last arg.
+        2. otherwise, the best available player is auto-detected for this platform
+           via :func:`shutil.which` (sox ``play`` → mpg123/paplay/aplay on Linux,
+           ``afplay`` on macOS).
+        """
+        # 1. explicit, user-configured command — fully generic
+        cmd = self.config.get("command") or self.config.get("play_cmd")
+        if cmd:
+            return cmd
+
+        # 2. auto-detect the best CLI player for this platform
+        # sox should handle almost every format, but fails on some urls
+        if self.sox_play:
+            track = self._now_playing
+            # NOTE: some urls like youtube streams will cause extension detection
+            # to fail, let's handle it explicitly
+            ext = track.split("?")[0].split(".")[-1]
+            return self.sox_play + f" --type {ext}"
+
+        # macOS
+        if platform.system() == "Darwin" and self.afplay:
+            return self.afplay
+
+        track, mime = self._get_track(self._now_playing)
+        LOG.debug(f'Mime info: {mime}')
+        player = None
+        if 'wav' in mime[1]:
+            player = self.pulse_play
+        elif self.mpg123_play:
+            player = self.mpg123_play
+        # fallback to alsa, only wav files will play correctly
+        return player or self.alsa_play
+
+    # audio service
+    def supported_uris(self):
+        uris = ['file', 'http']
+        if self.sox_play:
+            uris.append("https")
+        return uris
+
+    def play(self, repeat=False):
+        """ Play the track via the configured/auto-detected CLI command. """
+        # Stop any existing audio playback
+        self._stop_running_process()
+
+        self._is_playing = True
+        self._paused = False
+
+        # Replace file:// uri's with normal paths
+        uri = self._now_playing.replace('file://', '')
+
+        self.on_track_start()
+        try:
+            self.process = play_audio(uri, self.player_cmd)
+        except FileNotFoundError as e:
+            LOG.error(f'Couldn\'t play audio, {e}')
+            self.process = None
+            self.on_track_error()
+        except Exception as e:
+            LOG.exception(repr(e))
+            self.process = None
+            self.on_track_error()
+
+        # Wait for completion or stop request
+        while (self._is_process_running() and not self._stop_signal):
+            sleep(0.25)
+
+        if self._stop_signal:
+            self._stop_running_process()
+
+        self.on_track_end()
+
+    def stop(self):
+        """ Stop playback. """
+        LOG.info('CLI player stop')
+        if self._is_playing:
+            self._stop_signal = True
+            while self._is_playing:
+                sleep(0.1)
+            self._stop_signal = False
+            return True
+        return False
+
+    def pause(self):
+        """ Pause playback. """
+        if self.process and not self._paused:
+            # Suspend the playback process
+            self.process.send_signal(signal.SIGSTOP)
+            self._paused = True
+
+    def resume(self):
+        """ Resume paused playback. """
+        if self.process and self._paused:
+            # Resume the playback process
+            self.process.send_signal(signal.SIGCONT)
+            self._paused = False
+
+    def lower_volume(self):
+        """Lower volume.
+
+        This method is used to implement audio ducking. It will be called when
+        OpenVoiceOS is listening or speaking to make sure the media playing isn't
+        interfering.
+        """
+        # Not available in this plugin
+
+    def restore_volume(self):
+        """Restore normal volume.
+
+        Called when to restore the playback volume to previous level after
+        OpenVoiceOS has lowered it using lower_volume().
+        """
+        # Not available in this plugin
+
+    def get_track_length(self) -> int:
+        """
+        getting the duration of the audio in milliseconds
+        """
+        # we only can estimate how much we already played as a minimum value
+        return self.get_track_position()
+
+    def get_track_position(self) -> int:
+        """
+        get current position in milliseconds
+        """
+        # approximate given timestamp of playback start
+        if self.ts:
+            return int((time.time() - self.ts) * 1000)
+        return 0
+
+    def set_track_position(self, milliseconds):
+        """
+        go to position in milliseconds
+          Args:
+                milliseconds (int): number of milliseconds of final position
+        """
+        # Not available in this plugin
+
+
+class CLIAudioService(AudioPlayerBackend, CLIBaseService):
+    """Subprocess CLI-command audio backend for the new ovos-media service.
+
+    ``CLIBaseService`` is listed second; its concrete methods satisfy the
+    abstract playback methods declared on ``AudioPlayerBackend``. All behaviour
+    lives in :class:`CLIBaseService`.
+    """

ovos_media_plugin_cli-0.0.3a1/ovos_media_plugin_cli/audio.py

@@ -0,0 +1,50 @@
+"""Legacy ``ovos-audio`` (mycroft.plugin.audioservice) adapter.
+
+The same subprocess player engine as the new ovos-media
+:class:`~ovos_media_plugin_cli.CLIAudioService`, exposed under the legacy
+audio-service contract so this plugin works on both stacks:
+
+* new ``ovos-media`` — ``opm.media.audio`` → :class:`~ovos_media_plugin_cli.CLIAudioService`
+* legacy ``ovos-audio`` — ``mycroft.plugin.audioservice`` → :class:`CLIOldAudioService`
+  (discovered via :func:`load_service`)
+"""
+from ovos_plugin_manager.templates.audio import AudioBackend
+from ovos_utils.log import LOG
+
+from ovos_media_plugin_cli import CLIBaseService
+
+
+class CLIOldAudioService(CLIBaseService, AudioBackend):
+    """Subprocess CLI-command backend for the legacy ovos-audio service.
+
+    Reuses every playback method (``play``/``stop``/``pause``/``resume``/
+    seek/volume/position) from :class:`CLIBaseService`; only the constructor
+    differs because the legacy ``AudioBackend`` takes a ``name``.
+
+    ``CLIBaseService`` is listed first so its concrete methods satisfy the
+    abstract playback methods declared on ``AudioBackend`` (MRO order matters).
+    """
+
+    def __init__(self, config, bus=None, name='cli'):
+        AudioBackend.__init__(self, config, bus, name)
+        # set up the shared subprocess player engine without the new
+        # MediaBackend constructor
+        self.process = None
+        self._stop_signal = False
+        self._is_playing = False
+        self._paused = False
+        self.ts = 0
+        self.supports_mime_hints = True
+        import mimetypes
+        mimetypes.init()
+
+
+def load_service(base_config, bus):
+    backends = base_config.get('backends', {})
+    services = [(b, backends[b]) for b in backends
+                if backends[b].get('type') in ['cli', 'ovos_cli'] and
+                backends[b].get('active', True)]
+    instances = [CLIOldAudioService(s[1], bus, s[0]) for s in services]
+    if len(instances) == 0:
+        LOG.warning("No CLI backends have been configured")
+    return instances

ovos_media_plugin_cli-0.0.3a1/ovos_media_plugin_cli/version.py

@@ -0,0 +1,11 @@
+# The following lines are replaced during the release process.
+# START_VERSION_BLOCK
+VERSION_MAJOR = 0
+VERSION_MINOR = 0
+VERSION_BUILD = 3
+VERSION_ALPHA = 1
+# END_VERSION_BLOCK
+
+__version__ = f"{VERSION_MAJOR}.{VERSION_MINOR}.{VERSION_BUILD}"
+if VERSION_ALPHA:
+    __version__ += f"a{VERSION_ALPHA}"

ovos_media_plugin_cli-0.0.3a1/ovos_media_plugin_cli.egg-info/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: ovos-media-plugin-cli
+Version: 0.0.3a1
+Summary: Generic CLI-command playback plugin for ovos-media (and the legacy ovos-audio service)
+Author-email: JarbasAi <jarbasai@mailfence.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/OpenVoiceOS/ovos-media-plugin-cli
+Keywords: ovos,audio,OCP,plugin,cli
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ovos-plugin-manager<3.0.0,>=2.1.0
+Requires-Dist: requests
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: ovoscope[media]>=0.20.0a1; extra == "test"
+Dynamic: license-file
+
+# ovos-media-plugin-cli
+
+Generic **command-line playback** plugin for
+[ovos-media](https://github.com/OpenVoiceOS/ovos-media), and for the legacy
+`ovos-audio` service.
+
+The plugin plays a track by running a command-line media player as a
+subprocess. Point it at any player command, or let it auto-detect the best
+available one for your platform.
+
+- **Explicit command**: set `command` (for example `"mpv --no-terminal"`,
+  `"cvlc --play-and-exit"`, `"ffplay -nodisp -autoexit"`). The plugin appends
+  the track URI as the final argument.
+- **Auto-detect** (default): when you do not set a command, the plugin picks
+  the best available player for your platform through `shutil.which`. It
+  prefers `sox` (`play`), then tries `mpg123`, `paplay`, or `aplay` on Linux,
+  and `afplay` on macOS.
+
+Pause and resume use process signals (`SIGSTOP`/`SIGCONT`). Stop terminates
+the child process.
+
+## Install
+
+```bash
+pip install ovos-media-plugin-cli
+```
+
+Install `sox` too. It gives the widest format and URL coverage when the
+plugin auto-detects a player.
+
+## Configuration
+
+New `ovos-media`:
+
+```json
+{
+  "media": {
+    "preferred_audio_services": ["mplayer", "vlc", "cli"],
+    "audio_players": {
+      "cli": {
+        "module": "ovos-media-audio-plugin-cli",
+        "aliases": ["Command line", "CLI Player"],
+        "active": true,
+        "command": "mpv --no-terminal"
+      }
+    }
+  }
+}
+```
+
+Omit `command` to auto-detect. Legacy `ovos-audio`:
+
+```json
+{
+  "Audio": {
+    "backends": {
+      "cli": { "type": "cli", "active": true, "command": "mpv --no-terminal" }
+    }
+  }
+}
+```
+
+### Keys
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| `command` (alias `play_cmd`) | str | _auto-detect_ | CLI player command. The plugin appends the URI as the last argument. |
+| `active` | bool | `true` | Enable or disable this backend instance. |
+
+## Entry points
+
+| Group | Name | Object |
+|-------|------|--------|
+| `opm.media.audio` | `ovos-media-audio-plugin-cli` | `ovos_media_plugin_cli:CLIAudioService` |
+| `mycroft.plugin.audioservice` | `ovos_cli` | `ovos_media_plugin_cli.audio` |
+
+## Related projects
+
+- [ovos-media](https://github.com/OpenVoiceOS/ovos-media): the media service this plugin's `opm.media.audio` entry point serves.
+- [ovos-plugin-manager](https://github.com/OpenVoiceOS/ovos-plugin-manager): defines the `MediaBackend`/`AudioPlayerBackend` and legacy `AudioBackend` base classes this plugin implements.
+- [ovos-media-plugin-mpv](https://github.com/OpenVoiceOS/ovos-media-plugin-mpv), [ovos-media-plugin-vlc](https://github.com/OpenVoiceOS/ovos-media-plugin-vlc), [ovos-media-plugin-mplayer](https://github.com/OpenVoiceOS/ovos-media-plugin-mplayer), and [ovos-media-plugin-ffplay](https://github.com/OpenVoiceOS/ovos-media-plugin-ffplay): sibling audio-playback plugins for one specific player, instead of the generic CLI command this plugin wraps.
+
+## License
+
+Apache-2.0, see [LICENSE](LICENSE).

ovos_media_plugin_cli-0.0.3a1/ovos_media_plugin_cli.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+README.md
+pyproject.toml
+ovos_media_plugin_cli/__init__.py
+ovos_media_plugin_cli/audio.py
+ovos_media_plugin_cli/version.py
+ovos_media_plugin_cli.egg-info/PKG-INFO
+ovos_media_plugin_cli.egg-info/SOURCES.txt
+ovos_media_plugin_cli.egg-info/dependency_links.txt
+ovos_media_plugin_cli.egg-info/entry_points.txt
+ovos_media_plugin_cli.egg-info/requires.txt
+ovos_media_plugin_cli.egg-info/top_level.txt
+test/test_e2e.py

ovos_media_plugin_cli-0.0.3a1/ovos_media_plugin_cli.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ovos_media_plugin_cli-0.0.3a1/ovos_media_plugin_cli.egg-info/entry_points.txt

@@ -0,0 +1,5 @@
+[mycroft.plugin.audioservice]
+ovos_cli = ovos_media_plugin_cli.audio
+
+[opm.media.audio]
+ovos-media-audio-plugin-cli = ovos_media_plugin_cli:CLIAudioService

ovos_media_plugin_cli-0.0.3a1/ovos_media_plugin_cli.egg-info/requires.txt

@@ -0,0 +1,6 @@
+ovos-plugin-manager<3.0.0,>=2.1.0
+requests
+
+[test]
+pytest
+ovoscope[media]>=0.20.0a1

ovos_media_plugin_cli-0.0.3a1/ovos_media_plugin_cli.egg-info/top_level.txt

@@ -0,0 +1 @@
+ovos_media_plugin_cli

ovos_media_plugin_cli-0.0.3a1/pyproject.toml

@@ -0,0 +1,47 @@
+[build-system]
+requires = ["setuptools>=61", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ovos-media-plugin-cli"
+dynamic = ["version"]
+description = "Generic CLI-command playback plugin for ovos-media (and the legacy ovos-audio service)"
+readme = "README.md"
+license = { text = "Apache-2.0" }
+authors = [
+    { name = "JarbasAi", email = "jarbasai@mailfence.com" },
+]
+keywords = ["ovos", "audio", "OCP", "plugin", "cli"]
+dependencies = [
+    "ovos-plugin-manager>=2.1.0,<3.0.0",
+    "requests",
+]
+
+[project.urls]
+Homepage = "https://github.com/OpenVoiceOS/ovos-media-plugin-cli"
+
+[project.optional-dependencies]
+test = [
+    "pytest",
+    # end-to-end harness: drives the real backend through a real OCPMediaPlayer.
+    # [media] (the OCPPlayerHarness) lands in ovoscope 0.20.x; floor-pin so pip
+    # resolves it without --pre once published.
+    "ovoscope[media]>=0.20.0a1",
+]
+
+[project.entry-points."opm.media.audio"]
+ovos-media-audio-plugin-cli = "ovos_media_plugin_cli:CLIAudioService"
+
+# legacy ovos-audio service backend (so the plugin works on both stacks)
+[project.entry-points."mycroft.plugin.audioservice"]
+ovos_cli = "ovos_media_plugin_cli.audio"
+
+[tool.setuptools.dynamic]
+version = { attr = "ovos_media_plugin_cli.version.__version__" }
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["ovos_media_plugin_cli*"]
+
+[tool.setuptools.package-data]
+"*" = ["*.json", "*.voc", "*.intent", "*.dialog"]

ovos_media_plugin_cli-0.0.3a1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ovos_media_plugin_cli-0.0.3a1/test/test_e2e.py

@@ -0,0 +1,85 @@
+"""End-to-end tests: drive the real CLI OCP backend through a real
+``OCPMediaPlayer`` on a FakeBus via ovoscope's media harness.
+
+The plugin shells out to a CLI player via ``subprocess.Popen``, so
+``ovos_media_plugin_cli.subprocess`` is mocked: no real player is launched.
+The spawned (mocked) process reports itself as already finished
+(``poll()`` -> 0) so the backend's blocking ``play()`` loop returns promptly
+instead of waiting on a real child. Everything else is real: the OCP player
+routes the play/pause/stop requests to ``CLIAudioService`` exactly as
+ovos-media would at runtime. A deterministic ``command`` is configured so
+``player_cmd`` never depends on which players happen to be installed.
+
+Requires ``ovoscope[media]`` (pulls ovos-media).
+"""
+import unittest
+from unittest.mock import MagicMock, patch
+
+try:
+    from ovoscope import OCPPlayerHarness
+    from ovos_utils.ocp import MediaEntry, PlaybackType, PlayerState
+    HAVE_HARNESS = True
+except Exception:
+    HAVE_HARNESS = False
+
+import ovos_media_plugin_cli
+from ovos_media_plugin_cli import CLIAudioService
+
+URI = "http://example.com/song.mp3"
+# a real, always-present no-op command so player_cmd is deterministic
+CONFIG = {"command": "true"}
+
+
+def _factory(bus):
+    """Build the real CLI audio backend for injection into the OCP player."""
+    return CLIAudioService(CONFIG, bus)
+
+
+def _mock_subprocess():
+    """A subprocess mock whose spawned process reports itself as finished.
+
+    ``poll()`` returning a non-``None`` value makes ``_is_process_running()``
+    False, so the backend's blocking ``play()`` loop exits immediately (the bus
+    handler that calls ``play()`` runs synchronously, so a live process would
+    deadlock the harness).
+    """
+    sub = MagicMock()
+    sub.Popen.return_value.poll.return_value = 0
+    return sub
+
+
+@unittest.skipUnless(HAVE_HARNESS, "ovoscope[media] not installed")
+class TestCLIEndToEnd(unittest.TestCase):
+    def test_play_pause_resume_stop_through_ocp(self):
+        mock_sub = _mock_subprocess()
+        with patch.object(ovos_media_plugin_cli, "subprocess", mock_sub):
+            with OCPPlayerHarness(backend_factory=_factory) as h:
+                entry = MediaEntry(uri=URI, playback=PlaybackType.AUDIO)
+
+                h.play(entry)
+                h.assert_player_state(PlayerState.PLAYING)
+                h.assert_now_playing_uri(URI)
+                # the real backend actually shelled out via its (mocked) engine
+                mock_sub.Popen.assert_called()
+                self.assertIn(URI, mock_sub.Popen.call_args[0][0])
+
+                h.pause()
+                h.assert_player_state(PlayerState.PAUSED)
+
+                h.resume()
+                h.assert_player_state(PlayerState.PLAYING)
+
+                h.stop()
+                h.assert_player_state(PlayerState.STOPPED)
+
+    def test_backend_is_the_real_cli_plugin(self):
+        with patch.object(ovos_media_plugin_cli, "subprocess", _mock_subprocess()):
+            with OCPPlayerHarness(backend_factory=_factory) as h:
+                self.assertIsInstance(h.backend, CLIAudioService)
+                self.assertEqual(h.backend.player_cmd, "true")
+                self.assertIn("file", h.backend.supported_uris())
+                self.assertIn("http", h.backend.supported_uris())
+
+
+if __name__ == "__main__":
+    unittest.main()