Refactoring of chrome speech recognition architecture (CL1.2)

chrome/browser/speech/speech_input_extension_manager.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef CHROME_BROWSER_SPEECH_SPEECH_INPUT_EXTENSION_MANAGER_H_
 #define CHROME_BROWSER_SPEECH_SPEECH_INPUT_EXTENSION_MANAGER_H_
 #pragma once
 
 #include <string>
 
 #include "base/callback_forward.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/synchronization/lock.h"
 #include "content/public/browser/notification_observer.h"
-#include "content/public/browser/speech_recognizer_delegate.h"
+#include "content/public/browser/speech_recognition_event_listener.h"
 
 class Extension;
 class Profile;
 class SpeechInputExtensionNotification;
 
 namespace content {
 class NotificationRegistrar;
 class SpeechRecognizer;
 }
 
 namespace net {
 class URLRequestContextGetter;
 }
 
 // Used for API tests.
 class SpeechInputExtensionInterface {
  public:
   SpeechInputExtensionInterface();
   virtual ~SpeechInputExtensionInterface();
 
   // Called from the IO thread.
   virtual void StartRecording(
-      content::SpeechRecognizerDelegate* delegate,
+      content::SpeechRecognitionEventListener* delegate,

[hans, 2012/03/13 14:32:46]

rename the parameter to "listener" or "event_listener"?

[Primiano Tucci (use gerrit), 2012/03/14 09:40:35]

Done.

       net::URLRequestContextGetter* context_getter,
       int caller_id,

[Satish, 2012/03/13 15:30:15]

change caller_id to session_id throughout

[Primiano Tucci (use gerrit), 2012/03/14 09:40:35]

Hmm, I think I'll name all caller_id (below) for now. This is a spoiler,
"Session" will be invented only in the next CLs.

       const std::string& language,
       const std::string& grammar,
       bool filter_profanities) = 0;
 
   virtual void StopRecording(bool recognition_failed) = 0;
   virtual bool HasAudioInputDevices() = 0;
   virtual bool IsCapturingAudio() = 0;
 
   // Called from the UI thread.
   virtual bool HasValidRecognizer() = 0;
 };
 
 // Manages the speech input requests and responses from the extensions
 // associated to the given profile.
 class SpeechInputExtensionManager
     : public base::RefCountedThreadSafe<SpeechInputExtensionManager>,
-      public content::SpeechRecognizerDelegate,
+      public content::SpeechRecognitionEventListener,
       public content::NotificationObserver,
       private SpeechInputExtensionInterface {
  public:
   enum State {
     kIdle = 0,
     kStarting,
     kRecording,
     kStopping,
     kShutdown // Internal sink state when the profile is destroyed on shutdown.
   };
@@ skipping 38 matching lines @@
   void IsRecording(const IsRecordingCallback& callback);
 
   // Called by internal ProfileKeyedService class.
   void ShutdownOnUIThread();
 
   // Methods from content::NotificationObserver.
   virtual void Observe(int type,
                        const content::NotificationSource& source,
                        const content::NotificationDetails& details) OVERRIDE;
 
-  // Methods from SpeechRecognizerDelegate.
-  virtual void SetRecognitionResult(
-      int caller_id,
-      const content::SpeechRecognitionResult& result) OVERRIDE;
-
-  virtual void DidStartReceivingAudio(int caller_id) OVERRIDE;
-  virtual void DidCompleteRecording(int caller_id) OVERRIDE;
-  virtual void DidCompleteRecognition(int caller_id) OVERRIDE;
-  virtual void DidStartReceivingSpeech(int caller_id) OVERRIDE;
-  virtual void DidStopReceivingSpeech(int caller_id) OVERRIDE;
-  virtual void OnRecognizerError(int caller_id,
-                                 content::SpeechRecognitionErrorCode error)
-                                 OVERRIDE;
-  virtual void DidCompleteEnvironmentEstimation(int caller_id) OVERRIDE;
-  virtual void SetInputVolume(int caller_id, float volume,
-                              float noise_volume) OVERRIDE;
+  // Methods from SpeechRecognitionEventListener.
+  virtual void OnRecognitionStart(int session_id) OVERRIDE;
+  virtual void OnAudioStart(int session_id) OVERRIDE;
+  virtual void OnEnvironmentEstimationComplete(int session_id) OVERRIDE;
+  virtual void OnSoundStart(int session_id) OVERRIDE;
+  virtual void OnSoundEnd(int session_id) OVERRIDE;
+  virtual void OnAudioEnd(int session_id) OVERRIDE;
+  virtual void OnRecognitionResult(
+      int session_id, const content::SpeechRecognitionResult& result) OVERRIDE;
+  virtual void OnRecognitionError(
+      int session_id,
+      const content::SpeechRecognitionErrorCode& error) OVERRIDE;
+  virtual void OnAudioLevelsChanged(int session_id, float volume,
+                                    float noise_volume) OVERRIDE;
+  virtual void OnRecognitionEnd(int session_id, bool success) OVERRIDE;
 
   // Methods for API testing.
   void SetSpeechInputExtensionInterface(
       SpeechInputExtensionInterface* interface);
   SpeechInputExtensionInterface* GetSpeechInputExtensionInterface();
 
  private:
   // SpeechInputExtensionInterface methods:
   virtual bool IsCapturingAudio() OVERRIDE;
   virtual bool HasAudioInputDevices() OVERRIDE;
   virtual bool HasValidRecognizer() OVERRIDE;
   virtual void StartRecording(
-      content::SpeechRecognizerDelegate* delegate,
+      content::SpeechRecognitionEventListener* delegate,

[hans, 2012/03/13 14:32:46]

dito

[Primiano Tucci (use gerrit), 2012/03/14 09:40:35]

Done.

       net::URLRequestContextGetter* context_getter,
       int caller_id,
       const std::string& language,
       const std::string& grammar,
       bool filter_profanities) OVERRIDE;
 
   virtual void StopRecording(bool recognition_failed) OVERRIDE;
 
   // Internal methods.
   void StartOnIOThread(
@@ skipping 41 matching lines @@
   // Used in the UI thread.
   scoped_ptr<content::NotificationRegistrar> registrar_;
   SpeechInputExtensionInterface* speech_interface_;
   scoped_ptr<SpeechInputExtensionNotification> notification_;
 
   // Used in the IO thread.
   scoped_refptr<content::SpeechRecognizer> recognizer_;
 };
 
 #endif  // CHROME_BROWSER_SPEECH_SPEECH_INPUT_EXTENSION_MANAGER_H_