YARP speech synthesizer backed by the Kokoro Python package. More...
Inheritance diagram for KokoroSpeechSynthesizer:Public Member Functions | |
| KokoroSpeechSynthesizer ()=default | |
| KokoroSpeechSynthesizer (const KokoroSpeechSynthesizer &)=delete | |
| KokoroSpeechSynthesizer (KokoroSpeechSynthesizer &&)=delete | |
| KokoroSpeechSynthesizer & | operator= (const KokoroSpeechSynthesizer &)=delete |
| KokoroSpeechSynthesizer & | operator= (KokoroSpeechSynthesizer &&)=delete |
| ~KokoroSpeechSynthesizer () override | |
| bool | open (yarp::os::Searchable &config) override |
| Open the DeviceDriver. | |
| bool | close () override |
| Close the DeviceDriver. | |
| yarp::dev::ReturnValue | setLanguage (const std::string &language="auto") override |
| Sets the language for speech synthesis. | |
| yarp::dev::ReturnValue | getLanguage (std::string &language) override |
| Gets the current language set for speech synthesis. | |
| yarp::dev::ReturnValue | setVoice (const std::string &voice_name="auto") override |
| Sets the voice set for speech synthesis. | |
| yarp::dev::ReturnValue | getVoice (std::string &voice_name) override |
| Gets the current voice set for speech synthesis. | |
| yarp::dev::ReturnValue | getAvailableVoices (yarp::sig::VectorOfString &voices) override |
| yarp::dev::ReturnValue | setSpeed (double speed=0) override |
| Sets the voice speed for speech synthesis. | |
| yarp::dev::ReturnValue | getSpeed (double &speed) override |
| Gets the current voice speed. | |
| yarp::dev::ReturnValue | setPitch (double pitch) override |
| Sets the pitch for speech synthesis. | |
| yarp::dev::ReturnValue | getPitch (double &pitch) override |
| Gets the current pitch set for speech synthesis. | |
| yarp::dev::ReturnValue | synthesize (const std::string &text, yarp::sig::Sound &sound) override |
| Performs the speech synthesis. | |
Public Member Functions inherited from yarp::dev::DeviceDriver | |
| DeviceDriver () | |
| DeviceDriver (const DeviceDriver &other)=delete | |
| DeviceDriver (DeviceDriver &&other) noexcept=delete | |
| DeviceDriver & | operator= (const DeviceDriver &other)=delete |
| DeviceDriver & | operator= (DeviceDriver &&other) noexcept=delete |
| virtual | ~DeviceDriver () |
| virtual std::string | id () const |
| Return the id assigned to the PolyDriver. | |
| virtual void | setId (const std::string &id) |
| Set the id for this device. | |
| template<class T > | |
| bool | view (T *&x) |
| Get an interface to the device driver. | |
| virtual DeviceDriver * | getImplementation () |
| Some drivers are bureaucrats, pointing at others. | |
Public Member Functions inherited from KokoroSpeechSynthesizer_ParamsParser | |
| KokoroSpeechSynthesizer_ParamsParser () | |
| ~KokoroSpeechSynthesizer_ParamsParser () override=default | |
| bool | parseParams (const yarp::os::Searchable &config) override |
| Parse the DeviceDriver parameters. | |
| std::string | getDeviceClassName () const override |
| Get the name of the DeviceDriver class. | |
| std::string | getDeviceName () const override |
| Get the name of the device (i.e. | |
| std::string | getDocumentationOfDeviceParams () const override |
| Get the documentation of the DeviceDriver's parameters. | |
| std::vector< std::string > | getListOfParams () const override |
| Return a list of all params used by the device. | |
| bool | getParamValue (const std::string ¶mName, std::string ¶mValue) const override |
| Return the value (represented as a string) of the requested parameter. | |
| std::string | getConfiguration () const override |
| Return the configuration of the device. | |
Public Member Functions inherited from yarp::dev::IDeviceDriverParams | |
| virtual | ~IDeviceDriverParams () |
Public Member Functions inherited from yarp::dev::ISpeechSynthesizer | |
| virtual | ~ISpeechSynthesizer () |
Additional Inherited Members | |
Public Attributes inherited from KokoroSpeechSynthesizer_ParamsParser | |
| const std::string | m_device_classname = {"KokoroSpeechSynthesizer"} |
| const std::string | m_device_name = {"kokoroSpeechSynthesizer"} |
| bool | m_parser_is_strict = false |
| const parser_version_type | m_parser_version = {} |
| std::string | m_provided_configuration |
| const std::string | m_python_executable_defaultValue = {"python3"} |
| const std::string | m_worker_script_defaultValue = {""} |
| const std::string | m_model_repository_defaultValue = {"hexgrad/Kokoro-82M"} |
| const std::string | m_torch_device_defaultValue = {""} |
| const std::string | m_language_defaultValue = {"en"} |
| const std::string | m_voice_defaultValue = {"auto"} |
| const std::string | m_speed_defaultValue = {"1"} |
| const std::string | m_pitch_defaultValue = {"0"} |
| std::string | m_python_executable = {"python3"} |
| std::string | m_worker_script = {} |
| std::string | m_model_repository = {"hexgrad/Kokoro-82M"} |
| std::string | m_torch_device = {} |
| std::string | m_language = {"en"} |
| std::string | m_voice = {"auto"} |
| double | m_speed = {1} |
| double | m_pitch = {0} |
YARP speech synthesizer backed by the Kokoro Python package.
The plugin keeps a small Python worker alive and communicates with it through stdin/stdout. This avoids embedding Python in the YARP process while still keeping the Kokoro model loaded between synthesis requests.
Definition at line 32 of file KokoroSpeechSynthesizer.h.
|
default |
|
delete |
|
delete |
|
override |
Definition at line 132 of file KokoroSpeechSynthesizer.cpp.
|
overridevirtual |
Close the DeviceDriver.
Reimplemented from yarp::dev::DeviceDriver.
Definition at line 185 of file KokoroSpeechSynthesizer.cpp.
|
override |
Definition at line 558 of file KokoroSpeechSynthesizer.cpp.
|
overridevirtual |
Gets the current language set for speech synthesis.
| language | the returned string (code) representing the speech language (e.g. ita, eng...). Default value is "auto". |
Implements yarp::dev::ISpeechSynthesizer.
Definition at line 533 of file KokoroSpeechSynthesizer.cpp.
|
overridevirtual |
Gets the current pitch set for speech synthesis.
| pitch | the current voice pitch. |
Implements yarp::dev::ISpeechSynthesizer.
Definition at line 599 of file KokoroSpeechSynthesizer.cpp.
|
overridevirtual |
Gets the current voice speed.
| speed | the current voice speed. |
Implements yarp::dev::ISpeechSynthesizer.
Definition at line 580 of file KokoroSpeechSynthesizer.cpp.
|
overridevirtual |
Gets the current voice set for speech synthesis.
| voice_name | the currently used voice (device dependent). |
Implements yarp::dev::ISpeechSynthesizer.
Definition at line 551 of file KokoroSpeechSynthesizer.cpp.
|
overridevirtual |
Open the DeviceDriver.
| config | is a list of parameters for the device. Which parameters are effective for your device can vary. If there is no example for your device, you can run the "yarpdev" program with the verbose flag set to probe what parameters the device is checking. If that fails too, you'll need to read the source code (please nag one of the yarp developers to add documentation for your device). |
Reimplemented from yarp::dev::DeviceDriver.
Definition at line 137 of file KokoroSpeechSynthesizer.cpp.
|
delete |
|
delete |
|
overridevirtual |
Sets the language for speech synthesis.
| language | a string (code) representing the speech language (e.g. ita, eng...). Default value is "auto". |
Implements yarp::dev::ISpeechSynthesizer.
Definition at line 517 of file KokoroSpeechSynthesizer.cpp.
|
overridevirtual |
Sets the pitch for speech synthesis.
| pitch | the voice pitch. |
Implements yarp::dev::ISpeechSynthesizer.
Definition at line 587 of file KokoroSpeechSynthesizer.cpp.
|
overridevirtual |
Sets the voice speed for speech synthesis.
| speed | the voice speed. |
Implements yarp::dev::ISpeechSynthesizer.
Definition at line 569 of file KokoroSpeechSynthesizer.cpp.
|
overridevirtual |
Sets the voice set for speech synthesis.
| voice_name | the name of of the voice (device dependent). |
Implements yarp::dev::ISpeechSynthesizer.
Definition at line 540 of file KokoroSpeechSynthesizer.cpp.
|
overridevirtual |
Performs the speech synthesis.
| text | the text to synthesize |
| sound | the synthesized audio stream |
Implements yarp::dev::ISpeechSynthesizer.
Definition at line 606 of file KokoroSpeechSynthesizer.cpp.