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#if ENABLE(SPEECH_SYNTHESIS) 30 31#include "PlatformSpeechSynthesisVoice.h" 32#include <wtf/PassOwnPtr.h> 33#include <wtf/Vector.h> 34 35#if PLATFORM(MAC) 36#include <wtf/RetainPtr.h> 37OBJC_CLASS WebSpeechSynthesisWrapper; 38#endif 39 40namespace WebCore { 41 42enum SpeechBoundary { 43 SpeechWordBoundary, 44 SpeechSentenceBoundary 45}; 46 47class PlatformSpeechSynthesisUtterance; 48 49class PlatformSpeechSynthesizerClient { 50public: 51 virtual void didStartSpeaking(PassRefPtr<PlatformSpeechSynthesisUtterance>) = 0; 52 virtual void didFinishSpeaking(PassRefPtr<PlatformSpeechSynthesisUtterance>) = 0; 53 virtual void didPauseSpeaking(PassRefPtr<PlatformSpeechSynthesisUtterance>) = 0; 54 virtual void didResumeSpeaking(PassRefPtr<PlatformSpeechSynthesisUtterance>) = 0; 55 virtual void speakingErrorOccurred(PassRefPtr<PlatformSpeechSynthesisUtterance>) = 0; 56 virtual void boundaryEventOccurred(PassRefPtr<PlatformSpeechSynthesisUtterance>, SpeechBoundary, unsigned charIndex) = 0; 57 virtual void voicesDidChange() = 0; 58protected: 59 virtual ~PlatformSpeechSynthesizerClient() { } 60}; 61 62class PlatformSpeechSynthesizer { 63public: 64 static PassOwnPtr<PlatformSpeechSynthesizer> create(PlatformSpeechSynthesizerClient*); 65 66 // FIXME: We have multiple virtual functions just so we can support a mock for testing. 67 // Seems wasteful. Would be nice to find a better way. 68 virtual ~PlatformSpeechSynthesizer(); 69 70 const Vector<RefPtr<PlatformSpeechSynthesisVoice> >& voiceList() const; 71 virtual void speak(PassRefPtr<PlatformSpeechSynthesisUtterance>); 72 virtual void pause(); 73 virtual void resume(); 74 virtual void cancel(); 75 76 PlatformSpeechSynthesizerClient* client() const { return m_speechSynthesizerClient; } 77 78protected: 79 explicit PlatformSpeechSynthesizer(PlatformSpeechSynthesizerClient*); 80 81 Vector<RefPtr<PlatformSpeechSynthesisVoice> > m_voiceList; 82 83private: 84 virtual void initializeVoiceList(); 85 86 bool m_voiceListIsInitialized; 87 PlatformSpeechSynthesizerClient* m_speechSynthesizerClient; 88 89#if PLATFORM(MAC) 90 RetainPtr<WebSpeechSynthesisWrapper> m_platformSpeechWrapper; 91#endif 92}; 93 94} // namespace WebCore 95 96#endif // ENABLE(SPEECH_SYNTHESIS) 97 98#endif // PlatformSpeechSynthesizer_h 99