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