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