Changeset 64042 in webkit

Timestamp:

Jul 26, 2010 4:52:50 AM (14 years ago)

Author:

commit-queue@webkit.org

Message:

2010-07-26 Satish Sampath <​satish@chromium.org>

Reviewed by Steve Block.

Add WebKit plumbing to connect speech requests and callbacks between WebCore and the embedder.
​https://bugs.webkit.org/show_bug.cgi?id=42367

No new tests, the relevant LayoutTestController bindings will be added in the next patch.

• page/SpeechInput.cpp: renamed a method.
• page/SpeechInput.h: renamed a method.
• page/SpeechInputClient.h: added an extra method to optionally let users stop recording once they have spoken.
• page/SpeechInputClientListener.h: renamed a method.
• page/SpeechInputListener.h: renamed a method.

2010-07-26 Satish Sampath <​satish@chromium.org>

Reviewed by Steve Block.

Add WebKit plumbing to connect speech requests and callbacks between WebCore and the embedder.
​https://bugs.webkit.org/show_bug.cgi?id=42367

No new tests, the relevant LayoutTestController bindings and tests will be added in the next patch.

• public/WebSpeechInputController.h: Added new interface, implemented by embedder and called by WebKit (WebKit::WebSpeechInputController::~WebSpeechInputController):
• public/WebSpeechInputListener.h: Added new interface, implemented by WebKit and called by embedder. (WebKit::WebSpeechInputListener::~WebSpeechInputListener):
• public/WebViewClient.h: (WebKit::WebViewClient::createSpeechInputClient): New method to get the embedder's speech input client interface.
• src/SpeechInputClientImpl.cpp: Added new class, implementation of a two way connector between WebCore and the embedder for requests and responses. (WebKit::SpeechInputClientImpl::SpeechInputClientImpl): (WebKit::SpeechInputClientImpl::~SpeechInputClientImpl): (WebKit::SpeechInputClientImpl::startRecognition): (WebKit::SpeechInputClientImpl::stopRecording): (WebKit::SpeechInputClientImpl::didCompleteRecording): (WebKit::SpeechInputClientImpl::setRecognitionResult): (WebKit::SpeechInputClientImpl::didCompleteRecognition):
• src/SpeechInputClientImpl.h: Added.
• src/WebViewImpl.cpp: (WebKit::WebViewImpl::WebViewImpl): Pass on the above mentioned speech input connector to WebCore.
• src/WebViewImpl.h:

Location:

trunk

Files:

• WebCore/ChangeLog (modified) (1 diff)
• WebCore/page/SpeechInput.cpp (modified) (1 diff)
• WebCore/page/SpeechInput.h (modified) (1 diff)
• WebCore/page/SpeechInputClient.h (modified) (1 diff)
• WebCore/page/SpeechInputClientListener.h (modified) (1 diff)
• WebCore/page/SpeechInputListener.h (modified) (1 diff)
• WebCore/rendering/TextControlInnerElements.cpp (modified) (1 diff)
• WebCore/rendering/TextControlInnerElements.h (modified) (1 diff)
• WebKit/chromium/ChangeLog (modified) (1 diff)
• WebKit/chromium/WebKit.gyp (modified) (2 diffs)
• WebKit/chromium/public/WebSpeechInputController.h (copied) (copied from trunk/WebCore/page/SpeechInputClientListener.h) (1 diff)
• WebKit/chromium/public/WebSpeechInputListener.h (added)
• WebKit/chromium/public/WebViewClient.h (modified) (2 diffs)
• WebKit/chromium/src/SpeechInputClientImpl.cpp (copied) (copied from trunk/WebCore/page/SpeechInput.cpp) (1 diff)
• WebKit/chromium/src/SpeechInputClientImpl.h (copied) (copied from trunk/WebCore/page/SpeechInputClient.h) (1 diff)
• WebKit/chromium/src/WebViewImpl.cpp (modified) (2 diffs)
• WebKit/chromium/src/WebViewImpl.h (modified) (2 diffs)

trunk/WebCore/ChangeLog

@@ +1 @@
+2010-07-26  Satish Sampath  <satish@chromium.org>
+
+        Reviewed by Steve Block.
+
+        Add WebKit plumbing to connect speech requests and callbacks between WebCore and the embedder.
+        https://bugs.webkit.org/show_bug.cgi?id=42367
+
+        No new tests, the relevant LayoutTestController bindings will be added in the next patch.
+
+        * page/SpeechInput.cpp: renamed a method.
+        * page/SpeechInput.h: renamed a method.
+        * page/SpeechInputClient.h: added an extra method to optionally let users stop recording once they have spoken.
+        * page/SpeechInputClientListener.h: renamed a method.
+        * page/SpeechInputListener.h: renamed a method.
+
 2010-07-26  Andreas Kling  <andreas.kling@nokia.com>
 

trunk/WebCore/page/SpeechInput.cpp

@@ -46 +46 @@
 }
 
-void SpeechInput::recordingComplete()
+void SpeechInput::didCompleteRecording()
 {
-    m_listener->recordingComplete();
+    m_listener->didCompleteRecording();
 }
 

trunk/WebCore/page/SpeechInput.h

@@ -55 +55 @@
 
     // SpeechInputClient::Listener methods.
-    virtual void recordingComplete();
+    virtual void didCompleteRecording();
     virtual void setRecognitionResult(const String&);
 

trunk/WebCore/page/SpeechInputClient.h

@@ -43 +43 @@
     virtual bool startRecognition(SpeechInputClientListener* listener) = 0;
 
+    // Stops audio recording and performs recognition with the audio recorded until now
+    // (does not discard audio).
+    virtual void stopRecording() = 0;
+
 protected:
     virtual ~SpeechInputClient() { }

trunk/WebCore/page/SpeechInputClientListener.h

@@ -41 +41 @@
 class SpeechInputClientListener {
 public:
-    virtual void recordingComplete() = 0;
+    // Informs that audio recording has completed and recognition is underway.
+    virtual void didCompleteRecording() = 0;
+
+    // Gives results from speech recognition, either partial or the final results.
+    // This method can potentially get called multiple times if there are partial results
+    // available as the user keeps speaking. If the speech could not be recognized properly
+    // or if there was any other errors in the process, this method may never be called.
     virtual void setRecognitionResult(const String& result) = 0;
 

trunk/WebCore/page/SpeechInputListener.h

@@ -41 +41 @@
 class SpeechInputListener {
 public:
-    virtual void recordingComplete() = 0;
+    // Informs that audio recording has completed and recognition is underway.
+    virtual void didCompleteRecording() = 0;
+
+    // Gives results from speech recognition, either partial or the final results.
+    // This method can potentially get called multiple times if there are partial results
+    // available as the user keeps speaking. If the speech could not be recognized properly
+    // or if there was any other errors in the process, this method may never be called.
     virtual void setRecognitionResult(const String& result) = 0;
 

trunk/WebCore/rendering/TextControlInnerElements.cpp

@@ -398 +398 @@
 }
 
-void InputFieldSpeechButtonElement::recordingComplete()
+void InputFieldSpeechButtonElement::didCompleteRecording()
 {
     // FIXME: Add UI feedback here to indicate that audio recording stopped and recognition is

trunk/WebCore/rendering/TextControlInnerElements.h

@@ -125 +125 @@
 
     // SpeechInputListener methods.
-    void recordingComplete();
+    void didCompleteRecording();
     void setRecognitionResult(const String& result);
 

trunk/WebKit/chromium/ChangeLog

@@ +1 @@
+2010-07-26  Satish Sampath  <satish@chromium.org>
+
+        Reviewed by Steve Block.
+
+        Add WebKit plumbing to connect speech requests and callbacks between WebCore and the embedder.
+        https://bugs.webkit.org/show_bug.cgi?id=42367
+
+        No new tests, the relevant LayoutTestController bindings and tests will be added in the next patch.
+
+        * public/WebSpeechInputController.h: Added new interface, implemented by embedder and called by WebKit
+        (WebKit::WebSpeechInputController::~WebSpeechInputController):
+        * public/WebSpeechInputListener.h: Added new interface, implemented by WebKit and called by embedder.
+        (WebKit::WebSpeechInputListener::~WebSpeechInputListener):
+        * public/WebViewClient.h:
+        (WebKit::WebViewClient::createSpeechInputClient): New method to get the embedder's speech input client interface.
+        * src/SpeechInputClientImpl.cpp: Added new class, implementation of a two way connector between WebCore
+        and the embedder for requests and responses.
+        (WebKit::SpeechInputClientImpl::SpeechInputClientImpl):
+        (WebKit::SpeechInputClientImpl::~SpeechInputClientImpl):
+        (WebKit::SpeechInputClientImpl::startRecognition):
+        (WebKit::SpeechInputClientImpl::stopRecording):
+        (WebKit::SpeechInputClientImpl::didCompleteRecording):
+        (WebKit::SpeechInputClientImpl::setRecognitionResult):
+        (WebKit::SpeechInputClientImpl::didCompleteRecognition):
+        * src/SpeechInputClientImpl.h: Added.
+        * src/WebViewImpl.cpp:
+        (WebKit::WebViewImpl::WebViewImpl): Pass on the above mentioned speech input connector to WebCore.
+        * src/WebViewImpl.h:
+
 2010-07-26  Ilya Tikhonovsky  <loislo@chromium.org>
 

trunk/WebKit/chromium/WebKit.gyp

@@ -235 +235 @@
                 'public/WebSocketStreamHandle.h',
                 'public/WebSocketStreamHandleClient.h',
+                'public/WebSpeechInputController.h',
+                'public/WebSpeechInputListener.h',
                 'public/WebStorageArea.h',
                 'public/WebStorageEventDispatcher.h',
@@ -340 +342 @@
                 'src/SharedWorkerRepository.cpp',
                 'src/SocketStreamHandle.cpp',
+                'src/SpeechInputClientImpl.cpp',
+                'src/SpeechInputClientImpl.h',
                 'src/StorageAreaProxy.cpp',
                 'src/StorageAreaProxy.h',

trunk/WebKit/chromium/public/WebSpeechInputController.h

@@ -29 +29 @@
  */
 
-#ifndef SpeechInputClientListener_h
-#define SpeechInputClientListener_h
+#ifndef WebSpeechInputController_h
+#define WebSpeechInputController_h
 
-#if ENABLE(INPUT_SPEECH)
+#include "WebCommon.h"
 
-namespace WebCore {
+namespace WebKit {
 
-class String;
+// Provides an embedder API called by WebKit.
+class WebSpeechInputController {
+public:
+    // Starts speech recognition. Speech will get recorded until the endpointer detects silence,
+    // runs to the limit or stopRecording is called. Progress indications and the recognized
+    // text are returned via the listener interface.
+    virtual bool startRecognition()
+    {
+         WEBKIT_ASSERT_NOT_REACHED();
+         return false;
+    }
 
-// Provides an interface for the embedder to call into WebCore.
-class SpeechInputClientListener {
-public:
-    virtual void recordingComplete() = 0;
-    virtual void setRecognitionResult(const String& result) = 0;
+    // Cancels an ongoing recognition and discards any audio recorded so far. No partial
+    // recognition results are returned to the listener.
+    virtual void cancelRecognition() { WEBKIT_ASSERT_NOT_REACHED(); }
+
+    // Stops audio recording and performs recognition with the audio recorded until now
+    // (does not discard audio). This is an optional call and is typically invoked if the user
+    // wants to stop recording audio as soon as they finished speaking. Otherwise, the speech
+    // recording 'endpointer' should detect silence in the input and stop recording automatically.
+    // Call startRecognition() to record audio and recognize speech again.
+    virtual void stopRecording() { WEBKIT_ASSERT_NOT_REACHED(); }
 
 protected:
-    virtual ~SpeechInputClientListener() { }
+    virtual ~WebSpeechInputController() { }
 };
 
-} // namespace WebCore
+} // namespace WebKit
 
-#endif // ENABLE(INPUT_SPEECH)
-
-#endif // SpeechInputClientListener_h
+#endif // WebSpeechInputController_h

trunk/WebKit/chromium/public/WebViewClient.h

@@ -56 +56 @@
 class WebNotificationPresenter;
 class WebRange;
+class WebSpeechInputController;
+class WebSpeechInputListener;
 class WebStorageNamespace;
 class WebURL;
@@ -332 +334 @@
 
     // Access the embedder API for geolocation services.
-    virtual WebKit::WebGeolocationService* geolocationService() { return 0; }
+    virtual WebGeolocationService* geolocationService() { return 0; }
+
+    // Speech --------------------------------------------------------------
+
+    // Access the embedder API for speech input services.
+    virtual WebSpeechInputController* speechInputController(
+        WebSpeechInputListener*) { return 0; }
 
 protected:

trunk/WebKit/chromium/src/SpeechInputClientImpl.cpp

@@ -30 +30 @@
 
 #include "config.h"
-#include "SpeechInput.h"
+#include "SpeechInputClientImpl.h"
+
+#include "PlatformString.h"
+#include "WebSpeechInputController.h"
+#include "WebString.h"
+#include "WebViewClient.h"
+#include "page/SpeechInputClientListener.h"
 
 #if ENABLE(INPUT_SPEECH)
 
-#include "Frame.h"
-#include "SpeechInputClient.h"
-#include "SpeechInputListener.h"
+namespace WebKit {
 
-namespace WebCore {
+SpeechInputClientImpl::SpeechInputClientImpl(WebViewClient* web_view_client)
+    : m_controller(web_view_client->speechInputController(this))
+    , m_listener(0)
+{
+    ASSERT(m_controller);
+}
 
-SpeechInput::SpeechInput(SpeechInputClient* client, SpeechInputListener* listener)
-    : m_client(client)
-    , m_listener(listener)
+SpeechInputClientImpl::~SpeechInputClientImpl()
 {
 }
 
-void SpeechInput::recordingComplete()
+bool SpeechInputClientImpl::startRecognition(WebCore::SpeechInputClientListener* listener)
 {
-    m_listener->recordingComplete();
+    // Cancel any ongoing recognition first. No callbacks will be issued to that listener.
+    if (m_listener)
+        m_controller->cancelRecognition();
+
+    m_listener = listener;
+    return m_controller->startRecognition();
 }
 
-void SpeechInput::setRecognitionResult(const String& result)
+void SpeechInputClientImpl::stopRecording()
 {
-    m_listener->setRecognitionResult(result);
+    ASSERT(m_listener);
+    m_controller->stopRecording();
 }
 
-bool SpeechInput::startRecognition()
+void SpeechInputClientImpl::didCompleteRecording()
 {
-    if (m_client)
-        return m_client->startRecognition(this);
-    return false;
+    ASSERT(m_listener);
+    if (m_listener)
+        m_listener->didCompleteRecording();
 }
 
-} // namespace WebCore
+void SpeechInputClientImpl::didCompleteRecognition()
+{
+    ASSERT(m_listener);
+    m_listener = 0;
+}
+
+void SpeechInputClientImpl::setRecognitionResult(const WebString& result)
+{
+    ASSERT(m_listener);
+    if (m_listener)
+        m_listener->setRecognitionResult(result);
+}
+
+} // namespace WebKit
 
 #endif // ENABLE(INPUT_SPEECH)

trunk/WebKit/chromium/src/SpeechInputClientImpl.h

@@ -29 +29 @@
  */
 
-#ifndef SpeechInputClient_h
-#define SpeechInputClient_h
+#ifndef SpeechInputClientImpl_h
+#define SpeechInputClientImpl_h
 
 #if ENABLE(INPUT_SPEECH)
 
+#include "WebSpeechInputListener.h"
+#include "page/SpeechInputClient.h"
+
 namespace WebCore {
+class SpeechInputClientListener;
+}
 
-class SpeechInputClientListener;
+namespace WebKit {
 
-// Provides an interface for SpeechInput to call into the embedder.
-class SpeechInputClient {
+class WebSpeechInputController;
+class WebViewClient;
+
+class SpeechInputClientImpl
+    : public WebCore::SpeechInputClient,
+      public WebSpeechInputListener {
 public:
-    virtual bool startRecognition(SpeechInputClientListener* listener) = 0;
+    SpeechInputClientImpl(WebViewClient*);
+    virtual ~SpeechInputClientImpl();
 
-protected:
-    virtual ~SpeechInputClient() { }
+    // SpeechInputClient methods.
+    bool startRecognition(WebCore::SpeechInputClientListener*);
+    void stopRecording();
+
+    // WebSpeechInputListener methods.
+    void didCompleteRecording();
+    void setRecognitionResult(const WebString&);
+    void didCompleteRecognition();
+
+private:
+    WebSpeechInputController* m_controller; // To call into the embedder.
+    WebCore::SpeechInputClientListener* m_listener; // Valid when recognition is in progress.
 };
 
-} // namespace WebCore
+} // namespace WebKit
 
 #endif // ENABLE(INPUT_SPEECH)
 
-#endif // SpeechInputClient_h
+#endif // SpeechInputClientImpl_h

trunk/WebKit/chromium/src/WebViewImpl.cpp

@@ -259 +259 @@
     , m_isAcceleratedCompositingActive(false)
 #endif
+#if ENABLE(INPUT_SPEECH)
+    , m_speechInputClient(client)
+#endif
     , m_gles2Context(0)
 {
@@ -279 +282 @@
     m_page->backForwardList()->setClient(&m_backForwardListClientImpl);
     m_page->setGroupName(pageGroupName);
+#if ENABLE(INPUT_SPEECH)
+    m_page->setSpeechInputClient(&m_speechInputClient);
+#endif
 
     m_inspectorSettingsMap.set(new SettingsMap);

trunk/WebKit/chromium/src/WebViewImpl.h

@@ -48 +48 @@
 #include "LayerRendererChromium.h"
 #include "NotificationPresenterImpl.h"
+#include "SpeechInputClientImpl.h"
 #include <wtf/OwnPtr.h>
 #include <wtf/RefCounted.h>
@@ -512 +513 @@
     static const WebInputEvent* m_currentInputEvent;
 
+#if ENABLE(INPUT_SPEECH)
+    SpeechInputClientImpl m_speechInputClient;
+#endif
+
     OwnPtr<WebGLES2Context> m_gles2Context;
 };