Home | History | Annotate | Download | only in platform 
      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 "core/platform/PlatformSpeechSynthesisVoice.h"
     30 #include "wtf/PassOwnPtr.h"
     31 #include "wtf/Vector.h"
     32 
     33 namespace WebKit {
     34 class WebSpeechSynthesizer;
     35 class WebSpeechSynthesizerClient;
     36 }
     37 
     38 namespace WebCore {
     39 
     40 enum SpeechBoundary {
     41     SpeechWordBoundary,
     42     SpeechSentenceBoundary
     43 };
     44 
     45 class PlatformSpeechSynthesisUtterance;
     46 
     47 class PlatformSpeechSynthesizerClient {
     48 public:
     49     virtual void didStartSpeaking(PassRefPtr<PlatformSpeechSynthesisUtterance>) = 0;
     50     virtual void didFinishSpeaking(PassRefPtr<PlatformSpeechSynthesisUtterance>) = 0;
     51     virtual void didPauseSpeaking(PassRefPtr<PlatformSpeechSynthesisUtterance>) = 0;
     52     virtual void didResumeSpeaking(PassRefPtr<PlatformSpeechSynthesisUtterance>) = 0;
     53     virtual void speakingErrorOccurred(PassRefPtr<PlatformSpeechSynthesisUtterance>) = 0;
     54     virtual void boundaryEventOccurred(PassRefPtr<PlatformSpeechSynthesisUtterance>, SpeechBoundary, unsigned charIndex) = 0;
     55     virtual void voicesDidChange() = 0;
     56 protected:
     57     virtual ~PlatformSpeechSynthesizerClient() { }
     58 };
     59 
     60 class PlatformSpeechSynthesizer {
     61 public:
     62     static PassOwnPtr<PlatformSpeechSynthesizer> create(PlatformSpeechSynthesizerClient*);
     63 
     64     virtual ~PlatformSpeechSynthesizer();
     65 
     66     const Vector<RefPtr<PlatformSpeechSynthesisVoice> >& voiceList() const { return m_voiceList; }
     67     virtual void speak(PassRefPtr<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(Vector<RefPtr<PlatformSpeechSynthesisVoice> >&);
     75 
     76 protected:
     77     virtual void initializeVoiceList();
     78     explicit PlatformSpeechSynthesizer(PlatformSpeechSynthesizerClient*);
     79     Vector<RefPtr<PlatformSpeechSynthesisVoice> > m_voiceList;
     80 
     81 private:
     82     PlatformSpeechSynthesizerClient* m_speechSynthesizerClient;
     83 
     84     OwnPtr<WebKit::WebSpeechSynthesizer> m_webSpeechSynthesizer;
     85     OwnPtr<WebKit::WebSpeechSynthesizerClient> m_webSpeechSynthesizerClient;
     86 };
     87 
     88 } // namespace WebCore
     89 
     90 #endif // PlatformSpeechSynthesizer_h
     91