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 SpeechInput_h 32#define SpeechInput_h 33 34#if ENABLE(INPUT_SPEECH) 35 36#include "Page.h" 37#include "SpeechInputListener.h" 38#include <wtf/Forward.h> 39#include <wtf/HashMap.h> 40 41namespace WebCore { 42 43class IntRect; 44class SecurityOrigin; 45class SpeechInputClient; 46class SpeechInputListener; 47 48// This class connects the input elements requiring speech input with the platform specific 49// speech recognition engine. It provides methods for the input elements to activate speech 50// recognition and methods for the speech recognition engine to return back the results. 51class SpeechInput : public SpeechInputListener, 52 public Supplement<Page> { 53 WTF_MAKE_NONCOPYABLE(SpeechInput); 54public: 55 virtual ~SpeechInput(); 56 57 static PassOwnPtr<SpeechInput> create(SpeechInputClient*); 58 static const char* supplementName(); 59 static SpeechInput* from(Page* page) { return static_cast<SpeechInput*>(Supplement<Page>::from(page, supplementName())); } 60 61 // Generates a unique ID for the given listener to be used for speech requests. 62 // This should be the first call made by listeners before anything else. 63 int registerListener(SpeechInputListener*); 64 65 // Invoked when the listener is done with recording or getting destroyed. 66 // Failure to unregister may result in crashes if there were any pending speech events. 67 void unregisterListener(int); 68 69 // Methods invoked by the input elements. 70 bool startRecognition(int listenerId, const IntRect& elementRect, const AtomicString& language, const String& grammar, SecurityOrigin*); 71 void stopRecording(int); 72 void cancelRecognition(int); 73 74 // SpeechInputListener methods. 75 virtual void didCompleteRecording(int); 76 virtual void didCompleteRecognition(int); 77 virtual void setRecognitionResult(int, const SpeechInputResultArray&); 78 79private: 80 explicit SpeechInput(SpeechInputClient*); 81 82 SpeechInputClient* m_client; 83 HashMap<int, SpeechInputListener*> m_listeners; 84 int m_nextListenerId; 85}; 86 87} // namespace WebCore 88 89#endif // ENABLE(INPUT_SPEECH) 90 91#endif // SpeechInput_h 92