Refactor SpeechInputManager between chrome/ and content/.

content/browser/speech/speech_input_manager.h

 // Copyright (c) 2011 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 CONTENT_BROWSER_SPEECH_SPEECH_INPUT_MANAGER_H_
 #define CONTENT_BROWSER_SPEECH_SPEECH_INPUT_MANAGER_H_
 
+#include <map>
+#include <string>
+
 #include "base/basictypes.h"
+#include "content/browser/speech/speech_recognizer.h"
 #include "content/common/speech_input_result.h"
 #include "ui/gfx/rect.h"
 
 namespace speech_input {
 
 // This is the gatekeeper for speech recognition in the browser process. It
 // handles requests received from various render views and makes sure only one
 // of them can use speech recognition at a time. It also sends recognition
 // results and status events to the render views when required.
-class SpeechInputManager {
+class SpeechInputManager : public SpeechRecognizerDelegate {
  public:
   // Implemented by the dispatcher host to relay events to the render views.
   class Delegate {
    public:
     virtual void SetRecognitionResult(
         int caller_id,
         const SpeechInputResultArray& result) = 0;
     virtual void DidCompleteRecording(int caller_id) = 0;
     virtual void DidCompleteRecognition(int caller_id) = 0;
 
@@ skipping 10 matching lines @@
   virtual ~SpeechInputManager();
 
   // Handlers for requests from render views.
 
   // |delegate| is a weak pointer and should remain valid until
   // its |DidCompleteRecognition| method is called or recognition is cancelled.
   // |render_process_id| is the ID of the renderer process initiating the
   // request.
   // |element_rect| is the display bounds of the html element requesting speech
   // input (in page coordinates).
-  virtual void StartRecognition(Delegate* delegate,
-                                int caller_id,
-                                int render_process_id,
-                                int render_view_id,
-                                const gfx::Rect& element_rect,
-                                const std::string& language,
-                                const std::string& grammar,
-                                const std::string& origin_url)  = 0;
-  virtual void CancelRecognition(int caller_id) = 0;
-  virtual void StopRecording(int caller_id) = 0;
+  void StartRecognition(Delegate* delegate,
+                        int caller_id,
+                        int render_process_id,
+                        int render_view_id,
+                        const gfx::Rect& element_rect,
+                        const std::string& language,
+                        const std::string& grammar,
+                        const std::string& origin_url);
+  void CancelRecognition(int caller_id);
+  void CancelAllRequestsWithDelegate(Delegate* delegate);
+  void StopRecording(int caller_id);
 
-  virtual void CancelAllRequestsWithDelegate(Delegate* delegate) = 0;
+  // SpeechRecognizer::Delegate methods.
+  virtual void DidStartReceivingAudio(int caller_id);
+  virtual void SetRecognitionResult(int caller_id,
+                                    bool error,
+                                    const SpeechInputResultArray& result);
+  virtual void DidCompleteRecording(int caller_id);
+  virtual void DidCompleteRecognition(int caller_id);
+  virtual void OnRecognizerError(int caller_id,
+                                 SpeechRecognizer::ErrorCode error);
+  virtual void DidCompleteEnvironmentEstimation(int caller_id);
+  virtual void SetInputVolume(int caller_id, float volume, float noise_volume);
 
   void set_censor_results(bool censor) { censor_results_ = censor; }
 
   bool censor_results() { return censor_results_; }
 
+ protected:
+  virtual void CreateBubble(int caller_id,

[Satish, 2011/09/12 12:23:05]

add comments for each of these explaining what they should do?

[allanwoj, 2011/09/19 18:30:38]

Done.

+                            int render_process_id,
+                            int render_view_id,
+                            const gfx::Rect& element_rect) = 0;
+  virtual void FetchRequestInfo() = 0;
+  virtual void NoMicBubbleMessage(int caller_id) = 0;

[Satish, 2011/09/12 12:23:05]

perhaps rename this to HandleNoMicError() similar to HandleRecognizerError()
below?

[allanwoj, 2011/09/19 18:30:38]

Done.

+  virtual void CloseBubble(int caller_id) = 0;

[Satish, 2011/09/12 12:23:05]

Since we are separating chrome/ from content/, we should probably change mention
of 'bubble' to something else in these virtuals. 

[allanwoj, 2011/09/19 18:30:38]

Done.

+  virtual void SetBubbleWarmUpMode(int caller_id) = 0;
+  virtual void SetBubbleRecognizingMode(int caller_id) = 0;
+  virtual void SetBubbleRecordingMode(int caller_id) = 0;
+  virtual void SetBubbleInputVolume(int caller_id,
+                                    float volume,
+                                    float noise_volume) = 0;
+  virtual void HandleRecognizerError(int caller_id,
+                                     SpeechRecognizer::ErrorCode error) = 0;
+
+  void OnFocusChanged(int caller_id);

[Satish, 2011/09/12 12:23:05]

add explanatory comment since this is used by the derived class as well.

Should the name change to OnBubbleFocusChanged ?

[allanwoj, 2011/09/19 18:30:38]

Added comment but left the name as it is, as I have removed all mention of
bubble.

+
+  bool HasPendingRequest(int caller_id) const;
+
+  // Starts/restarts recognition for an existing request.
+  void StartRecognitionForRequest(int caller_id);
+
+  void CancelRecognitionAndInformDelegate(int caller_id);
+
+  std::string request_info_;
+  bool can_report_metrics_;
+
  private:
+  struct SpeechInputRequest {
+    SpeechInputRequest();
+    ~SpeechInputRequest();
+
+    Delegate* delegate;
+    scoped_refptr<SpeechRecognizer> recognizer;
+    bool is_active;  // Set to true when recording or recognition is going on.
+  };
+
+  Delegate* GetDelegate(int caller_id) const;
+
+  typedef std::map<int, SpeechInputRequest> SpeechRecognizerMap;
+  SpeechRecognizerMap requests_;
+  int recording_caller_id_;
   bool censor_results_;
 };
 
 // This typedef is to workaround the issue with certain versions of
 // Visual Studio where it gets confused between multiple Delegate
 // classes and gives a C2500 error. (I saw this error on the try bots -
 // the workaround was not needed for my machine).
 typedef SpeechInputManager::Delegate SpeechInputManagerDelegate;
 
 }  // namespace speech_input
 
 #endif  // CONTENT_BROWSER_SPEECH_SPEECH_INPUT_MANAGER_H_