1/*
2 * Copyright (C) 2010 Google 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 are
6 * met:
7 *
8 * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *     * Redistributions in binary form must reproduce the above
11 * copyright notice, this list of conditions and the following disclaimer
12 * in the documentation and/or other materials provided with the
13 * distribution.
14 *     * Neither the name of Google Inc. nor the names of its
15 * contributors may be used to endorse or promote products derived from
16 * this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31#ifndef SpeechInputClient_h
32#define SpeechInputClient_h
33
34#include <wtf/Forward.h>
35
36#if ENABLE(INPUT_SPEECH)
37
38namespace WebCore {
39
40class IntRect;
41class SecurityOrigin;
42class SpeechInputListener;
43
44// Provides an interface for SpeechInput to call into the embedder.
45class SpeechInputClient {
46public:
47    // This is the first call made by a listener, registering itself for future callbacks.
48    // When the listener no longer needs speech input (for e.g. when it gets destroyed),
49    // it should set a null listener to stop receiving callbacks.
50    // The client does not take ownership of the pointer.
51    virtual void setListener(SpeechInputListener*) = 0;
52
53    // Starts speech recognition and audio recording.
54    virtual bool startRecognition(int requestId, const IntRect& elementRect, const AtomicString& language, const String& grammar, SecurityOrigin*) = 0;
55
56    // Stops audio recording and performs recognition with the audio recorded until now
57    // (does not discard audio).
58    virtual void stopRecording(int requestId) = 0;
59
60    // Cancels an ongoing recognition and discards any audio recorded so far. No partial
61    // recognition results are returned to the listener.
62    virtual void cancelRecognition(int requestId) = 0;
63
64protected:
65    virtual ~SpeechInputClient() { }
66};
67
68} // namespace WebCore
69
70#endif // ENABLE(INPUT_SPEECH)
71
72#endif // SpeechInputClient_h
73