Home | History | Annotate | Download | only in speech
      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 
     38 namespace WebCore {
     39 
     40 class IntRect;
     41 class SecurityOrigin;
     42 class SpeechInputListener;
     43 class Page;
     44 
     45 // Provides an interface for SpeechInput to call into the embedder.
     46 class SpeechInputClient {
     47 public:
     48     // This is the first call made by a listener, registering itself for future callbacks.
     49     // When the listener no longer needs speech input (for e.g. when it gets destroyed),
     50     // it should set a null listener to stop receiving callbacks.
     51     // The client does not take ownership of the pointer.
     52     virtual void setListener(SpeechInputListener*) = 0;
     53 
     54     // Starts speech recognition and audio recording. elementRect is the position
     55     // of the element where the user clicked in the RootView coordinate system.
     56     virtual bool startRecognition(int requestId, const IntRect& elementRect, const AtomicString& language, const String& grammar, SecurityOrigin*) = 0;
     57 
     58     // Stops audio recording and performs recognition with the audio recorded until now
     59     // (does not discard audio).
     60     virtual void stopRecording(int requestId) = 0;
     61 
     62     // Cancels an ongoing recognition and discards any audio recorded so far. No partial
     63     // recognition results are returned to the listener.
     64     virtual void cancelRecognition(int requestId) = 0;
     65 
     66 protected:
     67     virtual ~SpeechInputClient() { }
     68 };
     69 
     70 void provideSpeechInputTo(Page*, SpeechInputClient*);
     71 
     72 } // namespace WebCore
     73 
     74 #endif // ENABLE(INPUT_SPEECH)
     75 
     76 #endif // SpeechInputClient_h
     77