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