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>
36OBJC_CLASS WebSpeechSynthesisWrapper;
37#endif
38
39namespace WebCore {
40
41enum class SpeechBoundary : uint8_t {
42 SpeechWordBoundary,
43 SpeechSentenceBoundary
44};
45
46class PlatformSpeechSynthesisUtterance;
47
48class PlatformSpeechSynthesizerClient {
49public:
50 virtual void didStartSpeaking(PlatformSpeechSynthesisUtterance&) = 0;
51 virtual void didFinishSpeaking(PlatformSpeechSynthesisUtterance&) = 0;
52 virtual void didPauseSpeaking(PlatformSpeechSynthesisUtterance&) = 0;
53 virtual void didResumeSpeaking(PlatformSpeechSynthesisUtterance&) = 0;
54 virtual void speakingErrorOccurred(PlatformSpeechSynthesisUtterance&) = 0;
55 virtual void boundaryEventOccurred(PlatformSpeechSynthesisUtterance&, SpeechBoundary, unsigned charIndex) = 0;
56 virtual void voicesDidChange() = 0;
57protected:
58 virtual ~PlatformSpeechSynthesizerClient() = default;
59};
60
61class WEBCORE_EXPORT PlatformSpeechSynthesizer {
62 WTF_MAKE_FAST_ALLOCATED;
63public:
64 WEBCORE_EXPORT explicit PlatformSpeechSynthesizer(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 WEBCORE_EXPORT virtual ~PlatformSpeechSynthesizer();
69
70 const Vector<RefPtr<PlatformSpeechSynthesisVoice>>& voiceList() const;
71 virtual void speak(RefPtr<PlatformSpeechSynthesisUtterance>&&);
72 virtual void pause();
73 virtual void resume();
74 virtual void cancel();
75
76 PlatformSpeechSynthesizerClient* client() const { return m_speechSynthesizerClient; }
77
78protected:
79 Vector<RefPtr<PlatformSpeechSynthesisVoice>> m_voiceList;
80
81private:
82 virtual void initializeVoiceList();
83
84 bool m_voiceListIsInitialized { false };
85 PlatformSpeechSynthesizerClient* m_speechSynthesizerClient;
86
87#if PLATFORM(COCOA)
88 RetainPtr<WebSpeechSynthesisWrapper> m_platformSpeechWrapper;
89#endif
90};
91
92} // namespace WebCore
93
94#endif // ENABLE(SPEECH_SYNTHESIS)
95
96#endif // PlatformSpeechSynthesizer_h
97