Home | History | Annotate | Download | only in speech 
      1 /*
      2  * Copyright (C) 2013 Apple Computer, 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 PlatformSpeechSynthesizer_h
     27 #define PlatformSpeechSynthesizer_h
     28 
     29 #include "platform/PlatformExport.h"
     30 #include "platform/heap/Handle.h"
     31 #include "platform/speech/PlatformSpeechSynthesisVoice.h"
     32 #include "wtf/Vector.h"
     33 
     34 namespace blink {
     35 class WebSpeechSynthesizer;
     36 class WebSpeechSynthesizerClient;
     37 }
     38 
     39 namespace WebCore {
     40 
     41 enum SpeechBoundary {
     42     SpeechWordBoundary,
     43     SpeechSentenceBoundary
     44 };
     45 
     46 class PlatformSpeechSynthesisUtterance;
     47 class WebSpeechSynthesizerClientImpl;
     48 
     49 class PlatformSpeechSynthesizerClient : public GarbageCollectedMixin {
     50 public:
     51     virtual void didStartSpeaking(PlatformSpeechSynthesisUtterance*) = 0;
     52     virtual void didFinishSpeaking(PlatformSpeechSynthesisUtterance*) = 0;
     53     virtual void didPauseSpeaking(PlatformSpeechSynthesisUtterance*) = 0;
     54     virtual void didResumeSpeaking(PlatformSpeechSynthesisUtterance*) = 0;
     55     virtual void speakingErrorOccurred(PlatformSpeechSynthesisUtterance*) = 0;
     56     virtual void boundaryEventOccurred(PlatformSpeechSynthesisUtterance*, SpeechBoundary, unsigned charIndex) = 0;
     57     virtual void voicesDidChange() = 0;
     58 
     59     virtual void trace(Visitor*) { }
     60 protected:
     61     virtual ~PlatformSpeechSynthesizerClient() { }
     62 };
     63 
     64 class PLATFORM_EXPORT PlatformSpeechSynthesizer : public GarbageCollectedFinalized<PlatformSpeechSynthesizer> {
     65     WTF_MAKE_NONCOPYABLE(PlatformSpeechSynthesizer);
     66 public:
     67     static PlatformSpeechSynthesizer* create(PlatformSpeechSynthesizerClient*);
     68 
     69     virtual ~PlatformSpeechSynthesizer();
     70 
     71     const HeapVector<Member<PlatformSpeechSynthesisVoice> >& voiceList() const { return m_voiceList; }
     72     virtual void speak(PlatformSpeechSynthesisUtterance*);
     73     virtual void pause();
     74     virtual void resume();
     75     virtual void cancel();
     76 
     77     PlatformSpeechSynthesizerClient* client() const { return m_speechSynthesizerClient; }
     78 
     79     void setVoiceList(HeapVector<Member<PlatformSpeechSynthesisVoice> >&);
     80 
     81     virtual void trace(Visitor*);
     82 
     83 protected:
     84     explicit PlatformSpeechSynthesizer(PlatformSpeechSynthesizerClient*);
     85 
     86     virtual void initializeVoiceList();
     87 
     88     HeapVector<Member<PlatformSpeechSynthesisVoice> > m_voiceList;
     89 
     90 private:
     91     Member<PlatformSpeechSynthesizerClient> m_speechSynthesizerClient;
     92 
     93     OwnPtr<blink::WebSpeechSynthesizer> m_webSpeechSynthesizer;
     94     Member<WebCore::WebSpeechSynthesizerClientImpl> m_webSpeechSynthesizerClient;
     95 };
     96 
     97 } // namespace WebCore
     98 
     99 #endif // PlatformSpeechSynthesizer_h
    100