1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
/*
* Copyright (C) 2013 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#if ENABLE(SPEECH_SYNTHESIS)
#include "PlatformSpeechSynthesisUtterance.h"
#include "PlatformSpeechSynthesizer.h"
#include "SpeechSynthesisClient.h"
#include "SpeechSynthesisErrorCode.h"
#include "SpeechSynthesisUtterance.h"
#include "SpeechSynthesisVoice.h"
#include <wtf/Deque.h>
#include <wtf/RefCounted.h>
namespace WebCore {
class Document;
class PlatformSpeechSynthesizerClient;
class SpeechSynthesisVoice;
class SpeechSynthesis : public PlatformSpeechSynthesizerClient, public SpeechSynthesisClientObserver, public RefCounted<SpeechSynthesis>, public ActiveDOMObject, public EventTarget {
WTF_MAKE_TZONE_OR_ISO_ALLOCATED(SpeechSynthesis);
public:
static Ref<SpeechSynthesis> create(ScriptExecutionContext&);
virtual ~SpeechSynthesis();
void ref() const final { RefCounted::ref(); }
void deref() const final { RefCounted::deref(); }
bool pending() const;
bool speaking() const;
bool paused() const;
void speak(SpeechSynthesisUtterance&);
void cancel();
void pause();
void resumeSynthesis();
const Vector<Ref<SpeechSynthesisVoice>>& getVoices();
// Used in testing to use a mock platform synthesizer
WEBCORE_EXPORT void setPlatformSynthesizer(Ref<PlatformSpeechSynthesizer>&&);
// Restrictions to change default behaviors.
enum BehaviorRestrictionFlags {
NoRestrictions = 0,
RequireUserGestureForSpeechStartRestriction = 1 << 0,
};
typedef unsigned BehaviorRestrictions;
bool userGestureRequiredForSpeechStart() const { return m_restrictions & RequireUserGestureForSpeechStartRestriction; }
void removeBehaviorRestriction(BehaviorRestrictions restriction) { m_restrictions &= ~restriction; }
WEBCORE_EXPORT void simulateVoicesListChange();
private:
SpeechSynthesis(ScriptExecutionContext&);
RefPtr<SpeechSynthesisUtterance> protectedCurrentSpeechUtterance();
// PlatformSpeechSynthesizerClient
void voicesDidChange() override;
void didStartSpeaking(PlatformSpeechSynthesisUtterance&) override;
void didPauseSpeaking(PlatformSpeechSynthesisUtterance&) override;
void didResumeSpeaking(PlatformSpeechSynthesisUtterance&) override;
void didFinishSpeaking(PlatformSpeechSynthesisUtterance&) override;
void speakingErrorOccurred(PlatformSpeechSynthesisUtterance&) override;
void boundaryEventOccurred(PlatformSpeechSynthesisUtterance&, SpeechBoundary, unsigned charIndex, unsigned charLength) override;
// SpeechSynthesisClientObserver
void didStartSpeaking() override;
void didFinishSpeaking() override;
void didPauseSpeaking() override;
void didResumeSpeaking() override;
void speakingErrorOccurred() override;
void boundaryEventOccurred(bool wordBoundary, unsigned charIndex, unsigned charLength) override;
void voicesChanged() override;
// ActiveDOMObject
bool virtualHasPendingActivity() const final;
void startSpeakingImmediately(SpeechSynthesisUtterance&);
void handleSpeakingCompleted(SpeechSynthesisUtterance&, bool errorOccurred);
// EventTarget
ScriptExecutionContext* scriptExecutionContext() const final { return ActiveDOMObject::scriptExecutionContext(); }
enum EventTargetInterfaceType eventTargetInterface() const final { return EventTargetInterfaceType::SpeechSynthesis; }
void refEventTarget() final { ref(); }
void derefEventTarget() final { deref(); }
void eventListenersDidChange() final;
PlatformSpeechSynthesizer& ensurePlatformSpeechSynthesizer();
RefPtr<PlatformSpeechSynthesizer> m_platformSpeechSynthesizer;
std::optional<Vector<Ref<SpeechSynthesisVoice>>> m_voiceList;
std::unique_ptr<SpeechSynthesisUtteranceActivity> m_currentSpeechUtterance;
Deque<Ref<SpeechSynthesisUtterance>> m_utteranceQueue;
bool m_isPaused;
BehaviorRestrictions m_restrictions;
WeakPtr<SpeechSynthesisClient> m_speechSynthesisClient;
bool m_hasEventListener { false };
};
} // namespace WebCore
#endif // ENABLE(SPEECH_SYNTHESIS)
|
