ScummVM API documentation
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 HOLLYWOOD_RUNAWAY_SPEECH_H
23#define HOLLYWOOD_RUNAWAY_SPEECH_H
24
25#include "hollywood/runaway/animation.h"
26#include "hollywood/runaway/audio.h"
27
28namespace Hollywood {
29
30// Playback of one line; scenes retain their cue ordering and speaker changes.
32public:
33 enum LipSync { kNoLipSync, kTextLipSync, kRecordedLipSync };
34 RunawaySpeech(RunawayAudio &audio, Common::RandomSource &random, LipSync mode = kRecordedLipSync) :
35 _audio(audio), _random(random), _mode(mode) {}
36 void start(const Common::U32String &text, uint16 sample, bool global, uint32 now, uint minimumDuration = 1000);
37 void stop();
38 // Scene preparation must not stop audio belonging to the active scene.
39 void reset();
40 bool finished(uint32 now) const { return (int32)(now - _deadline) >= 0; }
41 const Common::U32String &subtitle() const { return _subtitle; }
42 byte frame(uint32 now) const { return _lipSync.frame(now); }
43 uint frameDuration() const { return _lipSync.frameDuration(); }
44
45private:
46 RunawayAudio &_audio;
47 Common::RandomSource &_random;
48 const LipSync _mode;
49 RunawayLipSync _lipSync;
50 Common::U32String _subtitle;
51 uint32 _deadline = 0;
52};
53
54} // End of namespace Hollywood
55
56#endif // HOLLYWOOD_RUNAWAY_SPEECH_H
Definition: random.h:44
Definition: ustr.h:57
Definition: audio.h:29
Definition: animation.h:33
Definition: speech.h:31