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