1 /* 2 * Copyright (C) 2013 Apple Inc. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 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. 12 * 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. 24 */ 25 26 #ifndef SpeechSynthesis_h 27 #define SpeechSynthesis_h 28 29 #include "bindings/v8/ScriptWrappable.h" 30 #include "core/dom/ContextLifecycleObserver.h" 31 #include "modules/EventTargetModules.h" 32 #include "modules/speech/SpeechSynthesisUtterance.h" 33 #include "modules/speech/SpeechSynthesisVoice.h" 34 #include "platform/heap/Handle.h" 35 #include "platform/speech/PlatformSpeechSynthesisUtterance.h" 36 #include "platform/speech/PlatformSpeechSynthesizer.h" 37 38 namespace WebCore { 39 40 class ExceptionState; 41 class PlatformSpeechSynthesizerClient; 42 43 class SpeechSynthesis FINAL : public RefCountedGarbageCollectedWillBeGarbageCollectedFinalized<SpeechSynthesis>, public PlatformSpeechSynthesizerClient, public ScriptWrappable, public ContextLifecycleObserver, public EventTargetWithInlineData { 44 DEFINE_EVENT_TARGET_REFCOUNTING_WILL_BE_REMOVED(RefCountedGarbageCollected<SpeechSynthesis>); 45 USING_GARBAGE_COLLECTED_MIXIN(SpeechSynthesis); 46 public: 47 static SpeechSynthesis* create(ExecutionContext*); 48 49 bool pending() const; 50 bool speaking() const; 51 bool paused() const; 52 53 void speak(SpeechSynthesisUtterance*, ExceptionState&); 54 void cancel(); 55 void pause(); 56 void resume(); 57 58 const HeapVector<Member<SpeechSynthesisVoice> >& getVoices(); 59 60 // Used in testing to use a mock platform synthesizer 61 void setPlatformSynthesizer(PlatformSpeechSynthesizer*); 62 63 DEFINE_ATTRIBUTE_EVENT_LISTENER(voiceschanged); 64 65 virtual ExecutionContext* executionContext() const OVERRIDE; 66 67 virtual void trace(Visitor*) OVERRIDE; 68 69 private: 70 explicit SpeechSynthesis(ExecutionContext*); 71 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; 80 81 void startSpeakingImmediately(); 82 void handleSpeakingCompleted(SpeechSynthesisUtterance*, bool errorOccurred); 83 void fireEvent(const AtomicString& type, SpeechSynthesisUtterance*, unsigned long charIndex, const String& name); 84 85 // Returns the utterance at the front of the queue. 86 SpeechSynthesisUtterance* currentSpeechUtterance() const; 87 88 Member<PlatformSpeechSynthesizer> m_platformSpeechSynthesizer; 89 HeapVector<Member<SpeechSynthesisVoice> > m_voiceList; 90 HeapDeque<Member<SpeechSynthesisUtterance> > m_utteranceQueue; 91 bool m_isPaused; 92 93 // EventTarget 94 virtual const AtomicString& interfaceName() const OVERRIDE; 95 }; 96 97 } // namespace WebCore 98 99 #endif // SpeechSynthesisEvent_h 100