Refactor SpeechInputManager between chrome/ and content/.

chrome/browser/speech/chrome_speech_input_manager.cc

 // 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.
 
 #include "chrome/browser/speech/chrome_speech_input_manager.h"
 
 #include <string>
 
 #include "base/synchronization/lock.h"
 #include "base/threading/thread_restrictions.h"
 #include "base/utf_string_conversions.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/prefs/pref_service.h"
 #include "chrome/browser/tab_contents/tab_util.h"
-#include "chrome/common/chrome_switches.h"
 #include "chrome/common/pref_names.h"
 #include "content/browser/browser_thread.h"
 #include "grit/generated_resources.h"
 #include "media/audio/audio_manager.h"
 #include "ui/base/l10n/l10n_util.h"
 
 #if defined(OS_WIN)
 #include "chrome/installer/util/wmi.h"
 #endif
 
@@ skipping 44 matching lines @@
     base::AutoLock lock(lock_);
     return value_;
   }
 
   bool can_report_metrics() {
     base::AutoLock lock(lock_);
     return can_report_metrics_;
   }
 
  private:
+  friend class base::RefCountedThreadSafe<OptionalRequestInfo>;
+
+  ~OptionalRequestInfo() {}
+
   base::Lock lock_;
   std::string value_;
   bool can_report_metrics_;
 
   DISALLOW_COPY_AND_ASSIGN(OptionalRequestInfo);
 };
 
 ChromeSpeechInputManager::SpeechInputRequest::SpeechInputRequest() {
 }
 
 ChromeSpeechInputManager::SpeechInputRequest::~SpeechInputRequest() {
 }
 
 ChromeSpeechInputManager* ChromeSpeechInputManager::GetInstance() {
   return Singleton<ChromeSpeechInputManager>::get();
 }
 
 ChromeSpeechInputManager::ChromeSpeechInputManager()
-    : recording_caller_id_(0),
-      bubble_controller_(new SpeechInputBubbleController(
+    : bubble_controller_(new SpeechInputBubbleController(
           ALLOW_THIS_IN_INITIALIZER_LIST(this))) {
 }
 
 ChromeSpeechInputManager::~ChromeSpeechInputManager() {
-  while (requests_.begin() != requests_.end())
-    CancelRecognition(requests_.begin()->first);
 }
 
-bool ChromeSpeechInputManager::HasPendingRequest(int caller_id) const {
-  return requests_.find(caller_id) != requests_.end();
-}
-
-SpeechInputManagerDelegate* ChromeSpeechInputManager::GetDelegate(
-    int caller_id) const {
-  return requests_.find(caller_id)->second.delegate;
-}
-
-void ChromeSpeechInputManager::StartRecognition(
-    SpeechInputManagerDelegate* delegate,
+void ChromeSpeechInputManager::CreateBubble(
     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) {
-  DCHECK(!HasPendingRequest(caller_id));
+    const gfx::Rect& element_rect) {
+  bubble_controller_->CreateBubble(caller_id, render_process_id,
+                                   render_view_id, element_rect);
+}
 
-  bubble_controller_->CreateBubble(caller_id, render_process_id, render_view_id,
-                                   element_rect);
-
+void ChromeSpeechInputManager::FetchRequestInfo() {
   if (!optional_request_info_.get()) {
     optional_request_info_ = new OptionalRequestInfo();
     // Since hardware info is optional with speech input requests, we start an
     // asynchronous fetch here and move on with recording audio. This first
     // speech input request would send an empty string for hardware info and
     // subsequent requests may have the hardware info available if the fetch
     // completed before them. This way we don't end up stalling the user with
     // a long wait and disk seeks when they click on a UI element and start
     // speaking.
     optional_request_info_->Refresh();
   }
-
-  SpeechInputRequest* request = &requests_[caller_id];
-  request->delegate = delegate;
-  request->recognizer = new SpeechRecognizer(
-      this, caller_id, language, grammar, censor_results(),
-      optional_request_info_->value(),
-      optional_request_info_->can_report_metrics() ? origin_url : "");
-  request->is_active = false;
-
-  StartRecognitionForRequest(caller_id);
+  request_info_ = optional_request_info_->value();

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

instead of directly setting the member vars of the base class, can these be
returned to the caller so those variables can be made private?

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

Done.

+  can_report_metrics_ = optional_request_info_->can_report_metrics();
 }
 
-void ChromeSpeechInputManager::StartRecognitionForRequest(int caller_id) {
-  DCHECK(HasPendingRequest(caller_id));
-
-  // If we are currently recording audio for another caller, abort that cleanly.
-  if (recording_caller_id_)
-    CancelRecognitionAndInformDelegate(recording_caller_id_);
-
-  if (!AudioManager::GetAudioManager()->HasAudioInputDevices()) {
-    bubble_controller_->SetBubbleMessage(
-        caller_id, l10n_util::GetStringUTF16(IDS_SPEECH_INPUT_NO_MIC));
-  } else {
-    recording_caller_id_ = caller_id;
-    requests_[caller_id].is_active = true;
-    requests_[caller_id].recognizer->StartRecording();
-    bubble_controller_->SetBubbleWarmUpMode(caller_id);
-  }
+void ChromeSpeechInputManager::NoMicBubbleMessage(int caller_id) {
+  bubble_controller_->SetBubbleMessage(
+      caller_id, l10n_util::GetStringUTF16(IDS_SPEECH_INPUT_NO_MIC));
 }
 
-void ChromeSpeechInputManager::CancelRecognition(int caller_id) {
-  DCHECK(HasPendingRequest(caller_id));
-  if (requests_[caller_id].is_active)
-    requests_[caller_id].recognizer->CancelRecognition();
-  requests_.erase(caller_id);
-  if (recording_caller_id_ == caller_id)
-    recording_caller_id_ = 0;
+void ChromeSpeechInputManager::SetBubbleWarmUpMode(int caller_id) {
+  bubble_controller_->SetBubbleWarmUpMode(caller_id);
+}
+
+void ChromeSpeechInputManager::CloseBubble(int caller_id) {
   bubble_controller_->CloseBubble(caller_id);
 }
 
-void ChromeSpeechInputManager::CancelAllRequestsWithDelegate(
-    SpeechInputManagerDelegate* delegate) {
-  SpeechRecognizerMap::iterator it = requests_.begin();
-  while (it != requests_.end()) {
-    if (it->second.delegate == delegate) {
-      CancelRecognition(it->first);
-      // This map will have very few elements so it is simpler to restart.
-      it = requests_.begin();
-    } else {
-      ++it;
-    }
-  }
-}
-
-void ChromeSpeechInputManager::StopRecording(int caller_id) {
-  DCHECK(HasPendingRequest(caller_id));
-  requests_[caller_id].recognizer->StopRecording();
-}
-
-void ChromeSpeechInputManager::SetRecognitionResult(
-    int caller_id, bool error, const SpeechInputResultArray& result) {
-  DCHECK(HasPendingRequest(caller_id));
-  GetDelegate(caller_id)->SetRecognitionResult(caller_id, result);
-}
-
-void ChromeSpeechInputManager::DidCompleteRecording(int caller_id) {
-  DCHECK(recording_caller_id_ == caller_id);
-  DCHECK(HasPendingRequest(caller_id));
-  recording_caller_id_ = 0;
-  GetDelegate(caller_id)->DidCompleteRecording(caller_id);
+void ChromeSpeechInputManager::SetBubbleRecognizingMode(int caller_id) {
   bubble_controller_->SetBubbleRecognizingMode(caller_id);
 }
 
-void ChromeSpeechInputManager::DidCompleteRecognition(int caller_id) {
-  GetDelegate(caller_id)->DidCompleteRecognition(caller_id);
-  requests_.erase(caller_id);
-  bubble_controller_->CloseBubble(caller_id);
+void ChromeSpeechInputManager::SetBubbleRecordingMode(int caller_id) {
+  bubble_controller_->SetBubbleRecordingMode(caller_id);
 }
 
-void ChromeSpeechInputManager::OnRecognizerError(
+void ChromeSpeechInputManager::SetBubbleInputVolume(
+    int caller_id, float volume, float noise_volume) {
+  bubble_controller_->SetBubbleInputVolume(caller_id, volume, noise_volume);
+}
+
+void ChromeSpeechInputManager::HandleRecognizerError(
     int caller_id, SpeechRecognizer::ErrorCode error) {
-  if (caller_id == recording_caller_id_)
-    recording_caller_id_ = 0;
-
-  requests_[caller_id].is_active = false;
-
   struct ErrorMessageMapEntry {
     SpeechRecognizer::ErrorCode error;
     int message_id;
   };
   ErrorMessageMapEntry error_message_map[] = {
     {
       SpeechRecognizer::RECOGNIZER_ERROR_CAPTURE, IDS_SPEECH_INPUT_MIC_ERROR
     }, {
       SpeechRecognizer::RECOGNIZER_ERROR_NO_SPEECH, IDS_SPEECH_INPUT_NO_SPEECH
     }, {
       SpeechRecognizer::RECOGNIZER_ERROR_NO_RESULTS, IDS_SPEECH_INPUT_NO_RESULTS
     }, {
       SpeechRecognizer::RECOGNIZER_ERROR_NETWORK, IDS_SPEECH_INPUT_NET_ERROR
     }
   };
   for (size_t i = 0; i < ARRAYSIZE_UNSAFE(error_message_map); ++i) {
     if (error_message_map[i].error == error) {
       bubble_controller_->SetBubbleMessage(
           caller_id,
           l10n_util::GetStringUTF16(error_message_map[i].message_id));
       return;
     }
   }
 
   NOTREACHED() << "unknown error " << error;
 }
 
-void ChromeSpeechInputManager::DidStartReceivingAudio(int caller_id) {
-  DCHECK(HasPendingRequest(caller_id));
-  DCHECK(recording_caller_id_ == caller_id);
-  bubble_controller_->SetBubbleRecordingMode(caller_id);
-}
-
-void ChromeSpeechInputManager::DidCompleteEnvironmentEstimation(int caller_id) {
-  DCHECK(HasPendingRequest(caller_id));
-  DCHECK(recording_caller_id_ == caller_id);
-}
-
-void ChromeSpeechInputManager::SetInputVolume(int caller_id, float volume,
-                                              float noise_volume) {
-  DCHECK(HasPendingRequest(caller_id));
-  DCHECK_EQ(recording_caller_id_, caller_id);
-
-  bubble_controller_->SetBubbleInputVolume(caller_id, volume, noise_volume);
-}
-
-void ChromeSpeechInputManager::CancelRecognitionAndInformDelegate(
-    int caller_id) {
-  SpeechInputManagerDelegate* cur_delegate = GetDelegate(caller_id);
-  CancelRecognition(caller_id);
-  cur_delegate->DidCompleteRecording(caller_id);
-  cur_delegate->DidCompleteRecognition(caller_id);
-}
-
 void ChromeSpeechInputManager::InfoBubbleButtonClicked(
     int caller_id, SpeechInputBubble::Button button) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
   // Ignore if the caller id was not in our active recognizers list because the
   // user might have clicked more than once, or recognition could have been
   // cancelled due to other reasons before the user click was processed.
   if (!HasPendingRequest(caller_id))
     return;
 
   if (button == SpeechInputBubble::BUTTON_CANCEL) {
     CancelRecognitionAndInformDelegate(caller_id);
   } else if (button == SpeechInputBubble::BUTTON_TRY_AGAIN) {
     StartRecognitionForRequest(caller_id);
   }
 }
 
 void ChromeSpeechInputManager::InfoBubbleFocusChanged(int caller_id) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
-  // Ignore if the caller id was not in our active recognizers list because the
-  // user might have clicked more than once, or recognition could have been
-  // ended due to other reasons before the user click was processed.
-  if (HasPendingRequest(caller_id)) {
-    // If this is an ongoing recording or if we were displaying an error message
-    // to the user, abort it since user has switched focus. Otherwise
-    // recognition has started and keep that going so user can start speaking to
-    // another element while this gets the results in parallel.
-    if (recording_caller_id_ == caller_id || !requests_[caller_id].is_active) {
-      CancelRecognitionAndInformDelegate(caller_id);
-    }
-  }
+  OnFocusChanged(caller_id);
 }
 
 }  // namespace speech_input