1/**************************************************************************/
2/* tts_linux.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef TTS_LINUX_H
32#define TTS_LINUX_H
33
34#include "core/os/thread.h"
35#include "core/os/thread_safe.h"
36#include "core/string/ustring.h"
37#include "core/templates/hash_map.h"
38#include "core/templates/list.h"
39#include "core/variant/array.h"
40#include "servers/display_server.h"
41
42#ifdef SOWRAP_ENABLED
43#include "speechd-so_wrap.h"
44#else
45#include <libspeechd.h>
46#endif
47
48class TTS_Linux : public Object {
49 _THREAD_SAFE_CLASS_
50
51 List<DisplayServer::TTSUtterance> queue;
52 SPDConnection *synth = nullptr;
53 bool speaking = false;
54 bool paused = false;
55 int last_msg_id = -1;
56 HashMap<int, int> ids;
57
58 struct VoiceInfo {
59 String language;
60 String variant;
61 };
62 bool voices_loaded = false;
63 HashMap<String, VoiceInfo> voices;
64
65 Thread init_thread;
66
67 static void speech_init_thread_func(void *p_userdata);
68 static void speech_event_callback(size_t p_msg_id, size_t p_client_id, SPDNotificationType p_type);
69 static void speech_event_index_mark(size_t p_msg_id, size_t p_client_id, SPDNotificationType p_type, char *p_index_mark);
70
71 static TTS_Linux *singleton;
72
73protected:
74 void _load_voices();
75 void _speech_event(size_t p_msg_id, size_t p_client_id, int p_type);
76 void _speech_index_mark(size_t p_msg_id, size_t p_client_id, int p_type, const String &p_index_mark);
77
78public:
79 static TTS_Linux *get_singleton();
80
81 bool is_speaking() const;
82 bool is_paused() const;
83 Array get_voices() const;
84
85 void speak(const String &p_text, const String &p_voice, int p_volume = 50, float p_pitch = 1.f, float p_rate = 1.f, int p_utterance_id = 0, bool p_interrupt = false);
86 void pause();
87 void resume();
88 void stop();
89
90 TTS_Linux();
91 ~TTS_Linux();
92};
93
94#endif // TTS_LINUX_H
95