Metadata-Version: 2.1
Name: neon-speech
Version: 0.3.2
Summary: Neon Speech Module
Home-page: https://github.com/NeonGeckoCom/neon_speech
Author: Neongecko
Author-email: developers@neon.ai
License: BSD-3-Clause
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: requests
Requires-Dist: pyaudio
Requires-Dist: mycroft-messagebus-client (!=0.9.2,>=0.8.4)
Requires-Dist: SpeechRecognition (==3.8.1)
Requires-Dist: ovos-utils (~=0.0.8)
Requires-Dist: ovos-plugin-manager (~=0.0.1)
Requires-Dist: neon-utils (>=0.7.2)
Requires-Dist: pydub (~=0.23)
Requires-Dist: phoneme-guesser (~=0.1)

# Neon Speech
Speech (Voice) Module for Neon Core. This module can be treated as a replacement for the
[mycroft-core](https://github.com/MycroftAI/mycroft-core) speech module. This module handles input audio, performs STT, 
and optionally returns the text or forwards it to the skills module for intent parsing.

## Neon Enhancements
`neon-speech` extends `mycroft-speech` with the following added functionality:
* Support for continuous STT without a wake word
* Audio processing module plugin system to modify audio and extract context
* Messagebus API listeners to handle outside requests for STT or inputs to the skills module
* Arbitrary configuration supported by passing at module init


## Compatibility
Mycroft STT and Wake Word plugins are compatible with `neon-speech`, with the exception of skipping wake words,
which is currently only supported by Neon STT plugins.

## Running in Docker
The included `Dockerfile` may be used to build a docker container for the neon_speech module. The below command may be used
to start the container.

```shell
docker run -d \
--network=host \
--name=neon_speech \
-v ${NEON_DATA_DIR}:/home/neon/.local/share/neon:rw \
-v ${NEON_CONFIG_DIR}:/home/neon/.config/neon:rw \
-v ~/.config/pulse/cookie:/home/neon/.config/pulse/cookie:ro \
-v ${XDG_RUNTIME_DIR}/pulse:${XDG_RUNTIME_DIR}/pulse:ro \
-v /tmp:/tmp:rw \
--device=/dev/snd:/dev/snd \
-e PULSE_SERVER=unix:${XDG_RUNTIME_DIR}/pulse/native \
-e PULSE_COOKIE=/home/neon/.config/pulse/cookie \
neon_speech
```

>*Note:* The above example assumes Docker data locations are specified in the `NEON_DATA_DIR` and `NEON_CONFIG_DIR`
> environment variables.


