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 "bindings/v8/ScriptWrappable.h"
  30 #include "core/dom/ContextLifecycleObserver.h"
  31 #include "core/events/EventTarget.h"
  32 #include "heap/Handle.h"
  33 #include "modules/speech/SpeechSynthesisUtterance.h"
  34 #include "modules/speech/SpeechSynthesisVoice.h"
  35 #include "platform/speech/PlatformSpeechSynthesisUtterance.h"
  36 #include "platform/speech/PlatformSpeechSynthesizer.h"
  37 #include "wtf/Deque.h"
  38 #include "wtf/PassRefPtr.h"
  39 #include "wtf/RefCounted.h"
  40 #include "wtf/RefPtr.h"
  41
  42 namespace WebCore {
  43
  44 class ExceptionState;
  45 class PlatformSpeechSynthesizerClient;
  46
  47 class SpeechSynthesis FINAL : public RefCountedWillBeRefCountedGarbageCollected<SpeechSynthesis>, public PlatformSpeechSynthesizerClient, public ScriptWrappable, public ContextLifecycleObserver, public EventTargetWithInlineData {
  48     DEFINE_EVENT_TARGET_REFCOUNTING(RefCountedWillBeRefCountedGarbageCollected<SpeechSynthesis>);
  49 public:
  50     static PassRefPtrWillBeRawPtr<SpeechSynthesis> create(ExecutionContext*);
  51
  52     bool pending() const;
  53     bool speaking() const;
  54     bool paused() const;
  55
  56     void speak(SpeechSynthesisUtterance*, ExceptionState&);
  57     void cancel();
  58     void pause();
  59     void resume();
  60
  61     const WillBeHeapVector<RefPtrWillBeMember<SpeechSynthesisVoice> >& getVoices();
  62
  63     // Used in testing to use a mock platform synthesizer
  64     void setPlatformSynthesizer(PassOwnPtr<PlatformSpeechSynthesizer>);
  65
  66     DEFINE_ATTRIBUTE_EVENT_LISTENER(voiceschanged);
  67
  68     virtual ExecutionContext* executionContext() const OVERRIDE;
  69
  70     void trace(Visitor*);
  71
  72 private:
  73     explicit SpeechSynthesis(ExecutionContext*);
  74
  75     // PlatformSpeechSynthesizerClient override methods.
  76     virtual void voicesDidChange() OVERRIDE;
  77     virtual void didStartSpeaking(PassRefPtr<PlatformSpeechSynthesisUtterance>) OVERRIDE;
  78     virtual void didPauseSpeaking(PassRefPtr<PlatformSpeechSynthesisUtterance>) OVERRIDE;
  79     virtual void didResumeSpeaking(PassRefPtr<PlatformSpeechSynthesisUtterance>) OVERRIDE;
  80     virtual void didFinishSpeaking(PassRefPtr<PlatformSpeechSynthesisUtterance>) OVERRIDE;
  81     virtual void speakingErrorOccurred(PassRefPtr<PlatformSpeechSynthesisUtterance>) OVERRIDE;
  82     virtual void boundaryEventOccurred(PassRefPtr<PlatformSpeechSynthesisUtterance>, SpeechBoundary, unsigned charIndex) OVERRIDE;
  83
  84     void startSpeakingImmediately();
  85     void handleSpeakingCompleted(SpeechSynthesisUtterance*, bool errorOccurred);
  86     void fireEvent(const AtomicString& type, SpeechSynthesisUtterance*, unsigned long charIndex, const String& name);
  87
  88     // Returns the utterance at the front of the queue.
  89     SpeechSynthesisUtterance* currentSpeechUtterance() const;
  90
  91     OwnPtr<PlatformSpeechSynthesizer> m_platformSpeechSynthesizer;
  92     WillBeHeapVector<RefPtrWillBeMember<SpeechSynthesisVoice> > m_voiceList;
  93     Deque<RefPtrWillBeMember<SpeechSynthesisUtterance> > m_utteranceQueue;
  94     bool m_isPaused;
  95
  96     // EventTarget
  97     virtual const AtomicString& interfaceName() const OVERRIDE;
  98 };
  99
 100 } // namespace WebCore
 101
 102 #endif // SpeechSynthesisEvent_h