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 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 SpeechSynthesis_h
27#define SpeechSynthesis_h
28
29#include "bindings/v8/ScriptWrappable.h"
30#include "core/platform/PlatformSpeechSynthesisUtterance.h"
31#include "core/platform/PlatformSpeechSynthesizer.h"
32#include "modules/speech/SpeechSynthesisUtterance.h"
33#include "modules/speech/SpeechSynthesisVoice.h"
34#include "wtf/Deque.h"
35#include "wtf/PassRefPtr.h"
36#include "wtf/RefCounted.h"
37#include "wtf/RefPtr.h"
38
39namespace WebCore {
40
41class PlatformSpeechSynthesizerClient;
42class SpeechSynthesisVoice;
43
44class SpeechSynthesis : public PlatformSpeechSynthesizerClient, public ScriptWrappable, public RefCounted<SpeechSynthesis> {
45public:
46    static PassRefPtr<SpeechSynthesis> create();
47
48    bool pending() const;
49    bool speaking() const;
50    bool paused() const;
51
52    void speak(SpeechSynthesisUtterance*);
53    void cancel();
54    void pause();
55    void resume();
56
57    const Vector<RefPtr<SpeechSynthesisVoice> >& getVoices();
58
59    // Used in testing to use a mock platform synthesizer
60    void setPlatformSynthesizer(PassOwnPtr<PlatformSpeechSynthesizer>);
61
62private:
63    SpeechSynthesis();
64
65    // PlatformSpeechSynthesizerClient override methods.
66    virtual void voicesDidChange() OVERRIDE;
67    virtual void didStartSpeaking(PassRefPtr<PlatformSpeechSynthesisUtterance>) OVERRIDE;
68    virtual void didPauseSpeaking(PassRefPtr<PlatformSpeechSynthesisUtterance>) OVERRIDE;
69    virtual void didResumeSpeaking(PassRefPtr<PlatformSpeechSynthesisUtterance>) OVERRIDE;
70    virtual void didFinishSpeaking(PassRefPtr<PlatformSpeechSynthesisUtterance>) OVERRIDE;
71    virtual void speakingErrorOccurred(PassRefPtr<PlatformSpeechSynthesisUtterance>) OVERRIDE;
72    virtual void boundaryEventOccurred(PassRefPtr<PlatformSpeechSynthesisUtterance>, SpeechBoundary, unsigned charIndex) OVERRIDE;
73
74    void startSpeakingImmediately(SpeechSynthesisUtterance*);
75    void handleSpeakingCompleted(SpeechSynthesisUtterance*, bool errorOccurred);
76    void fireEvent(const AtomicString& type, SpeechSynthesisUtterance*, unsigned long charIndex, const String& name);
77
78    OwnPtr<PlatformSpeechSynthesizer> m_platformSpeechSynthesizer;
79    Vector<RefPtr<SpeechSynthesisVoice> > m_voiceList;
80    SpeechSynthesisUtterance* m_currentSpeechUtterance;
81    Deque<RefPtr<SpeechSynthesisUtterance> > m_utteranceQueue;
82    bool m_isPaused;
83};
84
85} // namespace WebCore
86
87#endif // SpeechSynthesisEvent_h
88