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#pragma once
27
28#if ENABLE(SPEECH_SYNTHESIS)
29
30#include "PlatformSpeechSynthesisVoice.h"
31#include <wtf/MonotonicTime.h>
32
33namespace WebCore {
34
35class PlatformSpeechSynthesisUtteranceClient {
36};
37
38class PlatformSpeechSynthesisUtterance : public RefCounted<PlatformSpeechSynthesisUtterance> {
39public:
40 WEBCORE_EXPORT static Ref<PlatformSpeechSynthesisUtterance> create(PlatformSpeechSynthesisUtteranceClient&);
41
42 const String& text() const { return m_text; }
43 void setText(const String& text) { m_text = text; }
44
45 const String& lang() const { return m_lang; }
46 void setLang(const String& lang) { m_lang = lang; }
47
48 PlatformSpeechSynthesisVoice* voice() const { return m_voice.get(); }
49 void setVoice(PlatformSpeechSynthesisVoice* voice) { m_voice = voice; }
50
51 // Range = [0, 1] where 1 is the default.
52 float volume() const { return m_volume; }
53 void setVolume(float volume) { m_volume = std::max(std::min(1.0f, volume), 0.0f); }
54
55 // Range = [0.1, 10] where 1 is the default.
56 float rate() const { return m_rate; }
57 void setRate(float rate) { m_rate = std::max(std::min(10.0f, rate), 0.1f); }
58
59 // Range = [0, 2] where 1 is the default.
60 float pitch() const { return m_pitch; }
61 void setPitch(float pitch) { m_pitch = std::max(std::min(2.0f, pitch), 0.0f); }
62
63 MonotonicTime startTime() const { return m_startTime; }
64 void setStartTime(MonotonicTime startTime) { m_startTime = startTime; }
65
66 PlatformSpeechSynthesisUtteranceClient* client() const { return m_client; }
67 void setClient(PlatformSpeechSynthesisUtteranceClient* client) { m_client = client; }
68
69private:
70 explicit PlatformSpeechSynthesisUtterance(PlatformSpeechSynthesisUtteranceClient&);
71
72 PlatformSpeechSynthesisUtteranceClient* m_client;
73 String m_text;
74 String m_lang;
75 RefPtr<PlatformSpeechSynthesisVoice> m_voice;
76 float m_volume { 1 };
77 float m_rate { 1 };
78 float m_pitch { 1 };
79 MonotonicTime m_startTime;
80};
81
82} // namespace WebCore
83
84#endif // ENABLE(SPEECH_SYNTHESIS)
85