2 * Copyright (C) 2013 Apple Inc. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
13 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 #ifndef SpeechSynthesis_h
27 #define SpeechSynthesis_h
29 #include "core/dom/ContextLifecycleObserver.h"
30 #include "modules/EventTargetModules.h"
31 #include "modules/speech/SpeechSynthesisUtterance.h"
32 #include "modules/speech/SpeechSynthesisVoice.h"
33 #include "platform/heap/Handle.h"
34 #include "platform/speech/PlatformSpeechSynthesisUtterance.h"
35 #include "platform/speech/PlatformSpeechSynthesizer.h"
40 class PlatformSpeechSynthesizerClient;
42 class SpeechSynthesis final : public RefCountedGarbageCollectedWillBeGarbageCollectedFinalized<SpeechSynthesis>, public PlatformSpeechSynthesizerClient, public ContextLifecycleObserver, public EventTargetWithInlineData {
43 DEFINE_EVENT_TARGET_REFCOUNTING_WILL_BE_REMOVED(RefCountedGarbageCollected<SpeechSynthesis>);
44 DEFINE_WRAPPERTYPEINFO();
45 USING_GARBAGE_COLLECTED_MIXIN(SpeechSynthesis);
47 static SpeechSynthesis* create(ExecutionContext*);
50 bool speaking() const;
53 void speak(SpeechSynthesisUtterance*, ExceptionState&);
58 const HeapVector<Member<SpeechSynthesisVoice> >& getVoices();
60 // Used in testing to use a mock platform synthesizer
61 void setPlatformSynthesizer(PlatformSpeechSynthesizer*);
63 DEFINE_ATTRIBUTE_EVENT_LISTENER(voiceschanged);
65 virtual ExecutionContext* executionContext() const override;
67 virtual void trace(Visitor*) override;
70 explicit SpeechSynthesis(ExecutionContext*);
72 // PlatformSpeechSynthesizerClient override methods.
73 virtual void voicesDidChange() override;
74 virtual void didStartSpeaking(PlatformSpeechSynthesisUtterance*) override;
75 virtual void didPauseSpeaking(PlatformSpeechSynthesisUtterance*) override;
76 virtual void didResumeSpeaking(PlatformSpeechSynthesisUtterance*) override;
77 virtual void didFinishSpeaking(PlatformSpeechSynthesisUtterance*) override;
78 virtual void speakingErrorOccurred(PlatformSpeechSynthesisUtterance*) override;
79 virtual void boundaryEventOccurred(PlatformSpeechSynthesisUtterance*, SpeechBoundary, unsigned charIndex) override;
81 void startSpeakingImmediately();
82 void handleSpeakingCompleted(SpeechSynthesisUtterance*, bool errorOccurred);
83 void fireEvent(const AtomicString& type, SpeechSynthesisUtterance*, unsigned long charIndex, const String& name);
85 // Returns the utterance at the front of the queue.
86 SpeechSynthesisUtterance* currentSpeechUtterance() const;
88 Member<PlatformSpeechSynthesizer> m_platformSpeechSynthesizer;
89 HeapVector<Member<SpeechSynthesisVoice> > m_voiceList;
90 HeapDeque<Member<SpeechSynthesisUtterance> > m_utteranceQueue;
94 virtual const AtomicString& interfaceName() const override;
99 #endif // SpeechSynthesisEvent_h