Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat/handle_hex_audiodata #145

Merged
merged 3 commits into from
Oct 18, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 35 additions & 13 deletions ovos_workshop/skills/ovos.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import binascii
import datetime
import os
import re
import sys
import time
Expand All @@ -15,12 +17,13 @@
from json_database import JsonStorage
from lingua_franca.format import pronounce_number, join_list
from lingua_franca.parse import yes_or_no, extract_number
from ovos_config.config import Configuration
from ovos_config.locations import get_xdg_config_save_path

from ovos_backend_client.api import EmailApi, MetricsApi
from ovos_bus_client import MessageBusClient
from ovos_bus_client.message import Message, dig_for_message
from ovos_bus_client.session import SessionManager, Session
from ovos_config.config import Configuration
from ovos_config.locations import get_xdg_config_save_path
from ovos_plugin_manager.language import OVOSLangTranslationFactory, OVOSLangDetectionFactory
from ovos_utils import camel_case_split, classproperty
from ovos_utils.dialog import get_dialog, MustacheDialogRenderer
Expand Down Expand Up @@ -1056,7 +1059,8 @@ def _handle_converse_ack(self, message: Message):
@param message: `{self.skill_id}.converse.ping` Message
"""
if message.msg_type == "skill.converse.ping":
log_deprecation("Support for message type `skill.converse.ping` is deprecated, use `{skill_id}.converse.ping`", "0.0.9")
log_deprecation(
"Support for message type `skill.converse.ping` is deprecated, use `{skill_id}.converse.ping`", "0.0.9")
if message.data.get("skill_id") != self.skill_id:
return # not for us!

Expand All @@ -1073,26 +1077,28 @@ def _handle_converse_request(self, message: Message):
@param message: `{self.skill_id}.converse.request` Message
"""
if message.msg_type == "skill.converse.request":
log_deprecation("Support for message type `skill.converse.request` is deprecated, use `{skill_id}.converse.request`", "0.0.9")
log_deprecation(
"Support for message type `skill.converse.request` is deprecated, use `{skill_id}.converse.request`",
"0.0.9")
if message.data.get("skill_id") != self.skill_id:
return # not for us!

try:
# converse can have multiple signatures
params = signature(self.converse).parameters
kwargs = {"message": message,
"utterances": message.data['utterances'],
"lang": message.data['lang']}
"utterances": message.data['utterances'],
"lang": message.data['lang']}
kwargs = {k: v for k, v in kwargs.items() if k in params}
result = self.converse(**kwargs)
self.bus.emit(message.reply('skill.converse.response',
{"skill_id": self.skill_id,
"result": result}))
"result": result}))
except Exception as e:
LOG.error(e)
self.bus.emit(message.reply('skill.converse.response',
{"skill_id": self.skill_id,
"result": False}))
"result": False}))

def _handle_collect_resting(self, message: Optional[Message] = None):
"""
Expand Down Expand Up @@ -1534,12 +1540,26 @@ def play_audio(self, filename: str, instant: bool = False):
@param instant: if True audio will be played instantly instead of queued with TTS
"""
message = dig_for_message() or Message("")
# if running in docker we need to send binary data to the ovos-audio container
# if sessions is not default we also need to do it since
# it likely is a remote client such as hivemind
send_binary = os.environ.get("IS_OVOS_CONTAINER") or \
SessionManager.get(message).session_id != "default"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the default session ID guaranteed to always be 'default', or should this reference SessionManager.default_session?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it is guaranteed to be "default"


if instant:
self.bus.emit(message.forward("mycroft.audio.play_sound",
{"uri": filename}))
mtype = "mycroft.audio.play_sound"
else:
self.bus.emit(message.forward("mycroft.audio.queue",
{"uri": filename}))
mtype = "mycroft.audio.queue"

if not send_binary:
data = {"uri": filename}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be excluded from binary messages? The URI could be useful for non-default sessions running with a shared file system

Copy link
Member Author

@JarbasAl JarbasAl Oct 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it is not used and further reinforces (to humans debugging) that a different code path is used

i'd rather not send a path that is supposed to be invalid, i'd argue if its running on same device then a non-default session should not be used, but i can imagine a case where a different device still has a shared file system so no strong feelings either way

could also argue this is leaking information about host system (unwanted in some scenarios) and increasing message size/bandwidth usage for no reason

else:
with open(filename, "rb") as f:
bindata = binascii.hexlify(f.read()).decode('utf-8')
data = {"audio_ext": filename.split(".")[-1],
"binary_data": bindata}

self.bus.emit(message.forward(mtype, data))

def __get_response_v1(self, session=None):
"""Helper to get a response from the user
Expand Down Expand Up @@ -1594,7 +1614,9 @@ def __handle_get_response(self, message):
sent from the intent service
"""
if message.msg_type == "skill.converse.get_response":
log_deprecation("Support for message type `skill.converse.get_response` is deprecated, use `{skill_id}.converse.get_response`", "0.0.9")
log_deprecation(
"Support for message type `skill.converse.get_response` is deprecated, use `{skill_id}.converse.get_response`",
"0.0.9")
if message.data.get("skill_id") != self.skill_id:
return # not for us!

Expand Down
Loading