Added CrOS startup sound.

chrome/browser/chromeos/login/login_display_host_impl.cc

 // 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.
 
 #include "chrome/browser/chromeos/login/login_display_host_impl.h"
 
 #include <vector>
 
 #include "ash/desktop_background/desktop_background_controller.h"
 #include "ash/desktop_background/user_wallpaper_delegate.h"
@@ skipping 65 matching lines @@
 #include "ui/compositor/scoped_layer_animation_settings.h"
 #include "ui/events/event_utils.h"
 #include "ui/gfx/rect.h"
 #include "ui/gfx/transform.h"
 #include "ui/views/focus/focus_manager.h"
 #include "ui/views/widget/widget.h"
 #include "url/gurl.h"
 
 namespace {
 
-const int kStartupSoundInitialDelayMs = 500;
+// Following delays specify time window for startup sound.
+const int kMinDelayAfterLoginPromptVisibleMs = 500;
+
+const int kMaxDelayAfterLoginPromptVisibleMs = 2000;

[dzhioev (left Google), 2013/12/03 08:28:32]

Rename these constants to names containing 'Sound'.

[ygorshenin1, 2013/12/03 09:03:28]

Done.

 
 // URL which corresponds to the login WebUI.
 const char kLoginURL[] = "chrome://oobe/login";
 
 // URL which corresponds to the OOBE WebUI.
 const char kOobeURL[] = "chrome://oobe/oobe";
 
 // URL which corresponds to the user adding WebUI.
 const char kUserAddingURL[] = "chrome://oobe/user-adding";
 
@@ skipping 160 matching lines @@
       login_view_(NULL),
       webui_login_display_(NULL),
       is_showing_login_(false),
       is_wallpaper_loaded_(false),
       status_area_saved_visibility_(false),
       crash_count_(0),
       restore_path_(RESTORE_UNKNOWN),
       auto_enrollment_check_done_(false),
       finalize_animation_type_(ANIMATION_WORKSPACE),
       animation_weak_ptr_factory_(this),
-      startup_sound_requested_(false),
       startup_sound_played_(false),
       startup_sound_honors_spoken_feedback_(false) {
   DBusThreadManager::Get()->GetSessionManagerClient()->AddObserver(this);
+  CrasAudioHandler::Get()->AddAudioObserver(this);
 
   // We need to listen to CLOSE_ALL_BROWSERS_REQUEST but not APP_TERMINATING
   // because/ APP_TERMINATING will never be fired as long as this keeps
   // ref-count. CLOSE_ALL_BROWSERS_REQUEST is safe here because there will be no
   // browser instance that will block the shutdown.
   registrar_.Add(this,
                  chrome::NOTIFICATION_CLOSE_ALL_BROWSERS_REQUEST,
                  content::NotificationService::AllSources());
 
   // NOTIFICATION_BROWSER_OPENED is issued after browser is created, but
@@ skipping 65 matching lines @@
     registrar_.Add(this, chrome::NOTIFICATION_LOGIN_OR_LOCK_WEBUI_VISIBLE,
                    content::NotificationService::AllSources());
     registrar_.Add(this, chrome::NOTIFICATION_LOGIN_NETWORK_ERROR_SHOWN,
                    content::NotificationService::AllSources());
   }
   LOG(WARNING) << "Login WebUI >> "
                << "zero_delay: " << zero_delay_enabled
                << " wait_for_wp_load_: " << waiting_for_wallpaper_load_
                << " wait_for_pods_: " << waiting_for_user_pods_
                << " init_webui_hidden_: " << initialize_webui_hidden_;
+
+  ui::ResourceBundle& bundle = ui::ResourceBundle::GetSharedInstance();
+  std::vector<base::StringPiece> sound_resources(

[dzhioev (left Google), 2013/12/03 08:28:32]

I think it's safer to use std::map instead of std::vector (in case if somebody
change SoundsManager::Sound enum).

[ygorshenin1, 2013/12/03 09:03:28]

We have a separate issue for this: crbug.com/321335.

On 2013/12/03 08:28:32, dzhioev wrote:

+      media::SoundsManager::SOUND_COUNT);
+  sound_resources[media::SoundsManager::SOUND_STARTUP] =
+      bundle.GetRawDataResource(IDR_SOUND_STARTUP_WAV);
+  sound_resources[media::SoundsManager::SOUND_LOCK] =
+      bundle.GetRawDataResource(IDR_SOUND_LOCK_WAV);
+  sound_resources[media::SoundsManager::SOUND_UNLOCK] =
+      bundle.GetRawDataResource(IDR_SOUND_UNLOCK_WAV);
+  sound_resources[media::SoundsManager::SOUND_SHUTDOWN] =

[dzhioev (left Google), 2013/12/03 08:28:32]

Do we need load all the sounds? We play only SOUND_STARTUP as I can see? Can't
we load them lazily?

[ygorshenin1, 2013/12/03 09:03:28]

We have a separate issue for this: crbug.com/321335.

On 2013/12/03 08:28:32, dzhioev wrote:

+      bundle.GetRawDataResource(IDR_SOUND_SHUTDOWN_WAV);
+  for (size_t i = 0; i < sound_resources.size(); ++i) {
+    DCHECK(!sound_resources[i].empty()) << "System sound " << i << " "
+                                        << "missing.";
+  }
+  if (!media::SoundsManager::Get()->Initialize(sound_resources))

[dzhioev (left Google), 2013/12/03 08:28:32]

Why SoundsManager can't initialize by itself? I mean load all needed resources.

[ygorshenin1, 2013/12/03 09:03:28]

Because it lives in media/ and has no idea about resource bundle.

On 2013/12/03 08:28:32, dzhioev wrote:

+    LOG(ERROR) << "Failed to initialize SoundsManager.";
 }
 
 LoginDisplayHostImpl::~LoginDisplayHostImpl() {
   DBusThreadManager::Get()->GetSessionManagerClient()->RemoveObserver(this);
+  CrasAudioHandler::Get()->RemoveAudioObserver(this);
 
   views::FocusManager::set_arrow_key_traversal_enabled(false);
   ResetLoginWindowAndView();
 
   // Let chrome process exit after login/oobe screen if needed.
   chrome::EndKeepAlive();
 
   default_host_ = NULL;
   // TODO(dzhioev): find better place for starting tutorial.
   CommandLine* command_line = CommandLine::ForCurrentProcess();
@@ skipping 111 matching lines @@
                  auto_enrollment_client_->should_auto_enroll());
     return;
   }
 
   get_auto_enrollment_result_callbacks_.push_back(callback);
 }
 
 void LoginDisplayHostImpl::StartWizard(
     const std::string& first_screen_name,
     scoped_ptr<DictionaryValue> screen_parameters) {
-  TryToPlayStartupSound(false);
+  startup_sound_honors_spoken_feedback_ = false;
+  TryToPlayStartupSound();
 
   // Keep parameters to restore if renderer crashes.
   restore_path_ = RESTORE_WIZARD;
   wizard_first_screen_name_ = first_screen_name;
   if (screen_parameters.get())
     wizard_screen_parameters_.reset(screen_parameters->DeepCopy());
   else
     wizard_screen_parameters_.reset();
   is_showing_login_ = false;
 
@@ skipping 54 matching lines @@
   sign_in_controller_->Init(
       chromeos::UserManager::Get()->GetUsersAdmittedForMultiProfile());
   CHECK(webui_login_display_);
   GetOobeUI()->ShowSigninScreen(LoginScreenContext(),
                                 webui_login_display_,
                                 webui_login_display_);
 }
 
 void LoginDisplayHostImpl::StartSignInScreen(
     const LoginScreenContext& context) {
-  TryToPlayStartupSound(true);
+  startup_sound_honors_spoken_feedback_ = true;
+  TryToPlayStartupSound();
 
   restore_path_ = RESTORE_SIGN_IN;
   is_showing_login_ = true;
   finalize_animation_type_ = ANIMATION_WORKSPACE;
 
   PrewarmAuthentication();
 
   if (waiting_for_wallpaper_load_ && !initialize_webui_hidden_) {
     LOG(WARNING) << "Login WebUI >> sign in postponed";
     return;
@@ skipping 73 matching lines @@
     webui_login_display_->OnPreferencesChanged();
 }
 
 void LoginDisplayHostImpl::PrewarmAuthentication() {
   auth_prewarmer_.reset(new AuthPrewarmer());
   auth_prewarmer_->PrewarmAuthentication(
       base::Bind(&LoginDisplayHostImpl::OnAuthPrewarmDone,
                  pointer_factory_.GetWeakPtr()));
 }
 
 void LoginDisplayHostImpl::StartAppLaunch(const std::string& app_id) {

[dzhioev (left Google), 2013/12/03 08:28:32]

What's about this method?

[ygorshenin1, 2013/12/03 09:03:28]

Could you please paraphrase your question?

On 2013/12/03 08:28:32, dzhioev wrote:

[dzhioev (left Google), 2013/12/03 09:14:29]

Don't we want to play startup sound in this mode? I suspect that it's Kiosk mode
but don't sure.

[ygorshenin1, 2013/12/03 09:24:51]

As you can see from the bug description (crbug.com/315108) this sound should be
played at OOBE and signin screen, moreover, at signin screen it's played iff
spoken feedback is enabled. So I'm not sure that it should be played in the
kiosk mode.

On 2013/12/03 09:14:29, dzhioev wrote:

   LOG(WARNING) << "Login WebUI >> start app launch.";
   SetStatusAreaVisible(false);
   finalize_animation_type_ = ANIMATION_FADE_OUT;
   if (!login_window_)
     LoadURL(GURL(kAppLaunchSplashURL));
 
   login_view_->set_should_emit_login_prompt_visible(false);
 
   app_launch_controller_.reset(new AppLaunchController(
       app_id, this, GetOobeUI()));
@@ skipping 109 matching lines @@
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // LoginDisplayHostImpl, chromeos::SessionManagerClient::Observer
 // implementation:
 
 void LoginDisplayHostImpl::EmitLoginPromptVisibleCalled() {
   OnLoginPromptVisible();
 }
 
+void LoginDisplayHostImpl::OnActiveOutputNodeChanged() {
+  TryToPlayStartupSound();
+}
+
 ////////////////////////////////////////////////////////////////////////////////
 // LoginDisplayHostImpl, private
 
 void LoginDisplayHostImpl::ShutdownDisplayHost(bool post_quit_task) {
   if (shutting_down_)
     return;
 
   shutting_down_ = true;
   registrar_.RemoveAll();
   base::MessageLoop::current()->DeleteSoon(FROM_HERE, this);
@@ skipping 203 matching lines @@
 }
 
 void LoginDisplayHostImpl::NotifyAutoEnrollmentCheckResult(
     bool should_auto_enroll) {
   std::vector<GetAutoEnrollmentCheckResultCallback> callbacks;
   callbacks.swap(get_auto_enrollment_result_callbacks_);
   for (size_t i = 0; i < callbacks.size(); ++i)
     callbacks[i].Run(should_auto_enroll);
 }
 
-void LoginDisplayHostImpl::TryToPlayStartupSound(bool honor_spoken_feedback) {
-  if (startup_sound_requested_)
+void LoginDisplayHostImpl::TryToPlayStartupSound() {
+  if (login_prompt_visible_time_.is_null())
     return;
-  startup_sound_requested_ = true;
-  startup_sound_honors_spoken_feedback_ = honor_spoken_feedback;
-  if (!login_prompt_visible_time_.is_null())
-    PlayStartupSound();
+  if (!CrasAudioHandler::Get()->GetActiveOutputNode())
+    return;
+  PlayStartupSound();
 }
 
 void LoginDisplayHostImpl::OnLoginPromptVisible() {
   if (!login_prompt_visible_time_.is_null())
     return;
-
-  ui::ResourceBundle& bundle = ui::ResourceBundle::GetSharedInstance();
-  std::vector<base::StringPiece> sound_resources(
-      media::SoundsManager::SOUND_COUNT);
-  sound_resources[media::SoundsManager::SOUND_STARTUP] =
-      bundle.GetRawDataResource(IDR_SOUND_STARTUP_WAV);
-  sound_resources[media::SoundsManager::SOUND_LOCK] =
-      bundle.GetRawDataResource(IDR_SOUND_LOCK_WAV);
-  sound_resources[media::SoundsManager::SOUND_UNLOCK] =
-      bundle.GetRawDataResource(IDR_SOUND_UNLOCK_WAV);
-  sound_resources[media::SoundsManager::SOUND_SHUTDOWN] =
-      bundle.GetRawDataResource(IDR_SOUND_SHUTDOWN_WAV);
-  for (size_t i = 0; i < sound_resources.size(); ++i) {
-    DCHECK(!sound_resources[i].empty()) << "System sound " << i << " "
-                                        << "missing.";
-  }
-  if (!media::SoundsManager::Get()->Initialize(sound_resources))
-    LOG(ERROR) << "Failed to initialize SoundsManager.";
-
   login_prompt_visible_time_ = base::TimeTicks::Now();
-  if (startup_sound_requested_ && !startup_sound_played_)
-    PlayStartupSound();
+  TryToPlayStartupSound();
 }
 
 void LoginDisplayHostImpl::PlayStartupSound() {

[dzhioev (left Google), 2013/12/03 08:28:32]

Why it's called PlayStartupSound if it doesn't play sound every call? How did
you choose which conditions to place in TryPlayStartupSound and which to place
here?

[ygorshenin1, 2013/12/03 09:03:28]

Good point, done.

   if (startup_sound_played_)
     return;
   startup_sound_played_ = true;
 
-  // TODO (ygorshenin@): remove this as soon as crbug.com/315108 will
-  // be fixed.
-  return;
-
   const base::TimeDelta delay =
-      base::TimeDelta::FromMilliseconds(kStartupSoundInitialDelayMs);
+      base::TimeDelta::FromMilliseconds(kMinDelayAfterLoginPromptVisibleMs);
   const base::TimeDelta delta =

[dzhioev (left Google), 2013/12/03 08:28:32]

Please rename delay and delta to something more meaningful. 

[ygorshenin1, 2013/12/03 09:03:28]

Done.

       base::TimeTicks::Now() - login_prompt_visible_time_;
 
+  // Don't play startup sound if login prompt is already visible for a
+  // long time.
+  if (delta >
+      base::TimeDelta::FromMilliseconds(kMaxDelayAfterLoginPromptVisibleMs)) {
+    return;
+  }
+
   // Cras audio server starts initialization after
   // login-prompt-visible signal from session manager. Alas, but it
   // doesn't send notifications after initialization. Thus, we're
   // trying to play startup sound after some delay.
   if (delta > delay) {

[ygorshenin1, 2013/12/03 09:03:28]

I thought these variables will be equal with probability 0.

On 2013/12/03 08:28:32, dzhioev wrote:

     PlayStartupSoundHelper(startup_sound_honors_spoken_feedback_);

[dzhioev (left Google), 2013/12/03 08:28:32]

It's a bad name for function. Please rename.

[ygorshenin1, 2013/12/03 09:03:28]

Done.

   } else {
     base::MessageLoop::current()->PostDelayedTask(
         FROM_HERE,
         base::Bind(&PlayStartupSoundHelper,
                    startup_sound_honors_spoken_feedback_),
         delay - delta);
   }
 }
 
 ////////////////////////////////////////////////////////////////////////////////
@@ skipping 119 matching lines @@
 
   scoped_ptr<locale_util::SwitchLanguageCallback> callback(
       new locale_util::SwitchLanguageCallback(
           base::Bind(&OnLanguageSwitchedCallback, base::Passed(data.Pass()))));
 
   // Do not load locale keyboards here.
   locale_util::SwitchLanguage(locale, false, callback.Pass());
 }
 
 }  // namespace chromeos