src/third_party/WebKit/Source/modules/speech/SpeechSynthesis.h

   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 "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"
  36
  37 namespace blink {
  38
  39 class ExceptionState;
  40 class PlatformSpeechSynthesizerClient;
  41
  42 class SpeechSynthesis FINAL : public RefCountedGarbageCollectedWillBeGarbageCollectedFinalized<SpeechSynthesis>, public PlatformSpeechSynthesizerClient, public ContextLifecycleObserver, public EventTargetWithInlineData {
  43     DEFINE_EVENT_TARGET_REFCOUNTING_WILL_BE_REMOVED(RefCountedGarbageCollected<SpeechSynthesis>);
  44     USING_GARBAGE_COLLECTED_MIXIN(SpeechSynthesis);
  45 public:
  46     static SpeechSynthesis* create(ExecutionContext*);
  47
  48     bool pending() const;
  49     bool speaking() const;
  50     bool paused() const;
  51
  52     void speak(SpeechSynthesisUtterance*, ExceptionState&);
  53     void cancel();
  54     void pause();
  55     void resume();
  56
  57     const HeapVector<Member<SpeechSynthesisVoice> >& getVoices();
  58
  59     // Used in testing to use a mock platform synthesizer
  60     void setPlatformSynthesizer(PlatformSpeechSynthesizer*);
  61
  62     DEFINE_ATTRIBUTE_EVENT_LISTENER(voiceschanged);
  63
  64     virtual ExecutionContext* executionContext() const OVERRIDE;
  65
  66     virtual void trace(Visitor*) OVERRIDE;
  67
  68 private:
  69     explicit SpeechSynthesis(ExecutionContext*);
  70
  71     // PlatformSpeechSynthesizerClient override methods.
  72     virtual void voicesDidChange() OVERRIDE;
  73     virtual void didStartSpeaking(PlatformSpeechSynthesisUtterance*) OVERRIDE;
  74     virtual void didPauseSpeaking(PlatformSpeechSynthesisUtterance*) OVERRIDE;
  75     virtual void didResumeSpeaking(PlatformSpeechSynthesisUtterance*) OVERRIDE;
  76     virtual void didFinishSpeaking(PlatformSpeechSynthesisUtterance*) OVERRIDE;
  77     virtual void speakingErrorOccurred(PlatformSpeechSynthesisUtterance*) OVERRIDE;
  78     virtual void boundaryEventOccurred(PlatformSpeechSynthesisUtterance*, SpeechBoundary, unsigned charIndex) OVERRIDE;
  79
  80     void startSpeakingImmediately();
  81     void handleSpeakingCompleted(SpeechSynthesisUtterance*, bool errorOccurred);
  82     void fireEvent(const AtomicString& type, SpeechSynthesisUtterance*, unsigned long charIndex, const String& name);
  83
  84     // Returns the utterance at the front of the queue.
  85     SpeechSynthesisUtterance* currentSpeechUtterance() const;
  86
  87     Member<PlatformSpeechSynthesizer> m_platformSpeechSynthesizer;
  88     HeapVector<Member<SpeechSynthesisVoice> > m_voiceList;
  89     HeapDeque<Member<SpeechSynthesisUtterance> > m_utteranceQueue;
  90     bool m_isPaused;
  91
  92     // EventTarget
  93     virtual const AtomicString& interfaceName() const OVERRIDE;
  94 };
  95
  96 } // namespace blink
  97
  98 #endif // SpeechSynthesisEvent_h