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