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 
     36 enum SpeechBoundary {
     37     SpeechWordBoundary,
     38     SpeechSentenceBoundary
     39 };
     40 
     41 class PlatformSpeechSynthesisUtterance;
     42 class WebSpeechSynthesizer;
     43 class WebSpeechSynthesizerClientImpl;
     44 
     45 class PlatformSpeechSynthesizerClient : public GarbageCollectedMixin {
     46 public:
     47     virtual void didStartSpeaking(PlatformSpeechSynthesisUtterance*) = 0;
     48     virtual void didFinishSpeaking(PlatformSpeechSynthesisUtterance*) = 0;
     49     virtual void didPauseSpeaking(PlatformSpeechSynthesisUtterance*) = 0;
     50     virtual void didResumeSpeaking(PlatformSpeechSynthesisUtterance*) = 0;
     51     virtual void speakingErrorOccurred(PlatformSpeechSynthesisUtterance*) = 0;
     52     virtual void boundaryEventOccurred(PlatformSpeechSynthesisUtterance*, SpeechBoundary, unsigned charIndex) = 0;
     53     virtual void voicesDidChange() = 0;
     54 
     55 protected:
     56     virtual ~PlatformSpeechSynthesizerClient() { }
     57 };
     58 
     59 class PLATFORM_EXPORT PlatformSpeechSynthesizer : public GarbageCollectedFinalized<PlatformSpeechSynthesizer> {
     60     WTF_MAKE_NONCOPYABLE(PlatformSpeechSynthesizer);
     61 public:
     62     static PlatformSpeechSynthesizer* create(PlatformSpeechSynthesizerClient*);
     63 
     64     virtual ~PlatformSpeechSynthesizer();
     65 
     66     const HeapVector<Member<PlatformSpeechSynthesisVoice> >& voiceList() const { return m_voiceList; }
     67     virtual void speak(PlatformSpeechSynthesisUtterance*);
     68     virtual void pause();
     69     virtual void resume();
     70     virtual void cancel();
     71 
     72     PlatformSpeechSynthesizerClient* client() const { return m_speechSynthesizerClient; }
     73 
     74     void setVoiceList(HeapVector<Member<PlatformSpeechSynthesisVoice> >&);
     75 
     76     virtual void trace(Visitor*);
     77 
     78 protected:
     79     explicit PlatformSpeechSynthesizer(PlatformSpeechSynthesizerClient*);
     80 
     81     virtual void initializeVoiceList();
     82 
     83     HeapVector<Member<PlatformSpeechSynthesisVoice> > m_voiceList;
     84 
     85 private:
     86     Member<PlatformSpeechSynthesizerClient> m_speechSynthesizerClient;
     87 
     88     OwnPtr<WebSpeechSynthesizer> m_webSpeechSynthesizer;
     89     Member<WebSpeechSynthesizerClientImpl> m_webSpeechSynthesizerClient;
     90 };
     91 
     92 } // namespace blink
     93 
     94 #endif // PlatformSpeechSynthesizer_h
     95