ScummVM API documentation
windows-text-to-speech.h
1/* ScummVM - Graphic Adventure Engine
2 *
3 * ScummVM is the legal property of its developers, whose names
4 * are too numerous to list here. Please refer to the COPYRIGHT
5 * file distributed with this source distribution.
6 *
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 *
20 */
21
22#ifndef BACKENDS_TEXT_TO_SPEECH_WINDOWS_H
23#define BACKENDS_TEXT_TO_SPEECH_WINDOWS_H
24
25#include "common/scummsys.h"
26
27#if defined(USE_TTS) && defined(WIN32)
28
29#include "common/text-to-speech.h"
30#include "common/str.h"
31#include "common/ustr.h"
32#include "common/list.h"
33
34
35class WindowsTextToSpeechManager final : public Common::TextToSpeechManager {
36public:
37 enum SpeechState {
38 READY,
39 PAUSED,
40 SPEAKING,
41 BROKEN,
42 NO_VOICE
43 };
44
45 struct SpeechParameters {
47 SpeechState *state;
48 HANDLE *mutex;
49 };
50
51 WindowsTextToSpeechManager();
52 ~WindowsTextToSpeechManager() override;
53
54 bool say(const Common::U32String &str, Action action) override;
55
56 bool stop() override;
57 bool pause() override;
58 bool resume() override;
59
60 bool isSpeaking() override;
61 bool isPaused() override;
62 bool isReady() override;
63
64 void setVoice(unsigned index) override;
65
66 void setRate(int rate) override;
67
68 void setPitch(int pitch) override;
69
70 void setVolume(unsigned volume) override;
71
72 void setLanguage(Common::String language) override;
73
74 void freeVoiceData(void *data) override;
75
76private:
77 void init();
78 void updateVoices() override;
79 void createVoice(void *cpVoiceToken);
80 Common::String lcidToLocale(LCID locale);
81 SpeechState _speechState;
82 Common::String _lastSaid;
83 HANDLE _thread;
84 Common::List<WCHAR *> _speechQueue;
85 SpeechParameters _threadParams;
86 HANDLE _speechMutex;
87};
88
89
90#endif
91
92#endif // BACKENDS_UPDATES_WINDOWS_H
Definition: list.h:44
Definition: str.h:59
Definition: text-to-speech.h:150
virtual bool isPaused()
Definition: text-to-speech.h:239
virtual void setLanguage(String language)
virtual bool stop()
Definition: text-to-speech.h:215
virtual void freeVoiceData(void *data)
Definition: text-to-speech.h:343
virtual void setRate(int rate)
Definition: text-to-speech.h:263
virtual void setVolume(unsigned volume)
Definition: text-to-speech.h:287
virtual bool pause()
Definition: text-to-speech.h:220
virtual void setPitch(int pitch)
Definition: text-to-speech.h:275
virtual bool isReady()
Definition: text-to-speech.h:244
virtual void setVoice(unsigned index)
Definition: text-to-speech.h:251
virtual bool say(const U32String &str, Action action)
Definition: text-to-speech.h:183
virtual bool isSpeaking()
Definition: text-to-speech.h:234
virtual bool resume()
Definition: text-to-speech.h:229
Definition: ustr.h:57