[Chromoting] Refactoring DesktopEnvironment and moving screen/audio recorders to ClientSession.

remoting/host/chromoting_host.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 "remoting/host/chromoting_host.h"
 
 #include "base/bind.h"
 #include "base/callback.h"
 #include "base/logging.h"
 #include "base/message_loop_proxy.h"
 #include "build/build_config.h"
 #include "remoting/base/constants.h"
 #include "remoting/codec/audio_encoder.h"
 #include "remoting/codec/audio_encoder_speex.h"
 #include "remoting/codec/audio_encoder_verbatim.h"
 #include "remoting/codec/video_encoder.h"
 #include "remoting/codec/video_encoder_row_based.h"
 #include "remoting/codec/video_encoder_vp8.h"
 #include "remoting/host/audio_capturer.h"

[Sergey Ulanov, 2012/09/11 22:30:16]

Please remove this icnlude.

[alexeypa (please no reviews), 2012/09/11 22:56:51]

Done.

 #include "remoting/host/audio_scheduler.h"
 #include "remoting/host/chromoting_host_context.h"
 #include "remoting/host/desktop_environment.h"
+#include "remoting/host/desktop_environment_factory.h"
 #include "remoting/host/event_executor.h"
 #include "remoting/host/host_config.h"
-#include "remoting/host/screen_recorder.h"
 #include "remoting/protocol/connection_to_client.h"
 #include "remoting/protocol/client_stub.h"
 #include "remoting/protocol/host_stub.h"
 #include "remoting/protocol/input_stub.h"
 #include "remoting/protocol/session_config.h"
 
 using remoting::protocol::ConnectionToClient;
 using remoting::protocol::InputStub;
 
 namespace remoting {
@@ skipping 24 matching lines @@
 
   // Don't use initial delay unless the last request was an error.
   false,
 };
 
 }  // namespace
 
 ChromotingHost::ChromotingHost(
     ChromotingHostContext* context,
     SignalStrategy* signal_strategy,
-    DesktopEnvironment* environment,
+    DesktopEnvironmentFactory* desktop_environment_factory,
     scoped_ptr<protocol::SessionManager> session_manager)
     : context_(context),
-      desktop_environment_(environment),
+      desktop_environment_factory_(desktop_environment_factory),
       session_manager_(session_manager.Pass()),
       signal_strategy_(signal_strategy),
-      stopping_recorders_(0),
+      clients_count_(0),
       state_(kInitial),
       protocol_config_(protocol::CandidateSessionConfig::CreateDefault()),
       login_backoff_(&kDefaultBackoffPolicy),
       authenticating_client_(false),
       reject_authenticating_client_(false) {
   DCHECK(context_);
   DCHECK(signal_strategy);
-  DCHECK(desktop_environment_);
   DCHECK(context_->network_task_runner()->BelongsToCurrentThread());
 
-  if (!AudioCapturer::IsSupported()) {
+  if (!desktop_environment_factory_->SupportsAudioCapture()) {
     // Disable audio by replacing our list of supported audio configurations
     // with the NONE config.
     protocol_config_->mutable_audio_configs()->clear();
     protocol_config_->mutable_audio_configs()->push_back(
         protocol::ChannelConfig());
   }
 }
 
 ChromotingHost::~ChromotingHost() {
   DCHECK(clients_.empty());
@@ skipping 37 matching lines @@
       // We are already stopping. Just save the task.
       if (!shutdown_task.is_null())
         shutdown_tasks_.push_back(shutdown_task);
       break;
 
     case kStarted:
       if (!shutdown_task.is_null())
         shutdown_tasks_.push_back(shutdown_task);
       state_ = kStopping;
 
-      // Disconnect all of the clients, implicitly stopping the ScreenRecorder.
+      // Disconnect all of the clients.
       while (!clients_.empty()) {
         clients_.front()->Disconnect();
       }
-      DCHECK(!recorder_.get());
-      DCHECK(!audio_scheduler_.get());
 
-      // Destroy session manager.
-      session_manager_.reset();
+      // Run the remaining shutdown tasks.
+      if (state_ == kStopping && !clients_count_)
+        ShutdownFinish();
 
-      if (!stopping_recorders_)
-        ShutdownFinish();
       break;
   }
 }
 
 void ChromotingHost::AddStatusObserver(HostStatusObserver* observer) {
   DCHECK(context_->network_task_runner()->BelongsToCurrentThread());
   status_observers_.AddObserver(observer);
 }
 
 void ChromotingHost::RemoveStatusObserver(HostStatusObserver* observer) {
@@ skipping 23 matching lines @@
   DCHECK(context_->network_task_runner()->BelongsToCurrentThread());
 
   login_backoff_.Reset();
 
   // Disconnect all other clients.
   // Iterate over a copy of the list of clients, to avoid mutating the list
   // while iterating over it.
   ClientList clients_copy(clients_);
   for (ClientList::const_iterator other_client = clients_copy.begin();
        other_client != clients_copy.end(); ++other_client) {
-    if ((*other_client) != client) {
+    if (other_client->get() != client) {
       (*other_client)->Disconnect();
     }
   }
 
   // Disconnects above must have destroyed all other clients and |recorder_|.
   DCHECK_EQ(clients_.size(), 1U);
-  DCHECK(!recorder_.get());
-  DCHECK(!audio_scheduler_.get());
 
   // Notify observers that there is at least one authenticated client.
   const std::string& jid = client->client_jid();
 
   reject_authenticating_client_ = false;
 
   authenticating_client_ = true;
   FOR_EACH_OBSERVER(HostStatusObserver, status_observers_,
                     OnClientAuthenticated(jid));
   authenticating_client_ = false;
 
   if (reject_authenticating_client_) {
     client->Disconnect();
   }
 }
 
 void ChromotingHost::OnSessionChannelsConnected(ClientSession* client) {
   DCHECK(context_->network_task_runner()->BelongsToCurrentThread());
 
-  // Then we create a ScreenRecorder passing the message loops that
-  // it should run on.
-  VideoEncoder* video_encoder =
-      CreateVideoEncoder(client->connection()->session()->config());
-
-  recorder_ = new ScreenRecorder(context_->capture_task_runner(),
-                                 context_->encode_task_runner(),
-                                 context_->network_task_runner(),
-                                 desktop_environment_->capturer(),
-                                 video_encoder);
-  if (client->connection()->session()->config().is_audio_enabled()) {
-    scoped_ptr<AudioEncoder> audio_encoder =
-        CreateAudioEncoder(client->connection()->session()->config());
-    audio_scheduler_ = new AudioScheduler(
-        context_->audio_task_runner(),
-        context_->network_task_runner(),
-        desktop_environment_->audio_capturer(),
-        audio_encoder.Pass(),
-        client->connection()->audio_stub());
-  }
-
-  // Immediately add the connection and start the session.
-  recorder_->AddConnection(client->connection());
-  recorder_->Start();
-  desktop_environment_->OnSessionStarted(client->CreateClipboardProxy());
-
+  // Notify observers.
   FOR_EACH_OBSERVER(HostStatusObserver, status_observers_,
                     OnClientConnected(client->client_jid()));
 }
 
 void ChromotingHost::OnSessionAuthenticationFailed(ClientSession* client) {
   DCHECK(context_->network_task_runner()->BelongsToCurrentThread());
 
   // Notify observers.
   FOR_EACH_OBSERVER(HostStatusObserver, status_observers_,
                     OnAccessDenied(client->client_jid()));
 }
 
 void ChromotingHost::OnSessionClosed(ClientSession* client) {
   DCHECK(context_->network_task_runner()->BelongsToCurrentThread());
 
-  scoped_ptr<ClientSession> client_destroyer(client);
+  for (ClientList::iterator it = clients_.begin(); it != clients_.end(); ++it) {
+    if (it->get() == client) {
+      if (client->is_authenticated()) {

[Sergey Ulanov, 2012/09/11 22:30:16]

It's better to move this if and the Stop() call outside of the for loop -
otherwise this code reads as if you stop all clients.
Move erase() call outside of the loop may also improve readability

[alexeypa (please no reviews), 2012/09/11 22:56:51]

Done.

+        FOR_EACH_OBSERVER(HostStatusObserver, status_observers_,
+                          OnClientDisconnected(client->client_jid()));
+      }
 
-  ClientList::iterator it = std::find(clients_.begin(), clients_.end(), client);
-  CHECK(it != clients_.end());
-  clients_.erase(it);
-
-  if (recorder_.get()) {
-    recorder_->RemoveConnection(client->connection());
+      client->Stop(base::Bind(&ChromotingHost::OnClientStopped, this));
+      clients_.erase(it);
+      return;
+    }
   }
 
-  if (audio_scheduler_.get()) {
-    audio_scheduler_->OnClientDisconnected();
-    StopAudioScheduler();
-  }
-
-  if (client->is_authenticated()) {
-    FOR_EACH_OBSERVER(HostStatusObserver, status_observers_,
-                      OnClientDisconnected(client->client_jid()));
-
-    // TODO(sergeyu): This teardown logic belongs to ClientSession
-    // class. It should start/stop screen recorder or tell the host
-    // when to do it.
-    if (recorder_.get()) {
-      // Currently we don't allow more than one simultaneous connection,
-      // so we need to shutdown recorder when a client disconnects.
-      StopScreenRecorder();
-    }
-    desktop_environment_->OnSessionFinished();
-  }
+  CHECK(!"Could not find the client session.");

[Sergey Ulanov, 2012/09/11 22:30:16]

NOTREACHED()? 
Or if you need a message
  NOTREACHED() << "Could not find the client session.".
if you need it to be compiled in release builds then use LOG(FATAL) 

[alexeypa (please no reviews), 2012/09/11 22:56:51]

I restored the old CHECK after moving the logic out of the loop.

 }
 
 void ChromotingHost::OnSessionSequenceNumber(ClientSession* session,
                                              int64 sequence_number) {
   DCHECK(context_->network_task_runner()->BelongsToCurrentThread());
-  if (recorder_.get())
-    recorder_->UpdateSequenceNumber(sequence_number);
 }
 
 void ChromotingHost::OnSessionRouteChange(
     ClientSession* session,
     const std::string& channel_name,
     const protocol::TransportRoute& route) {
   DCHECK(context_->network_task_runner()->BelongsToCurrentThread());
   FOR_EACH_OBSERVER(HostStatusObserver, status_observers_,
                     OnClientRouteChange(session->client_jid(), channel_name,
                                         route));
@@ skipping 33 matching lines @@
     *response = protocol::SessionManager::INCOMPATIBLE;
     return;
   }
 
   session->set_config(config);
 
   *response = protocol::SessionManager::ACCEPT;
 
   LOG(INFO) << "Client connected: " << session->jid();
 
+  // Create the desktop integration implementation for the client to use.
+  scoped_ptr<DesktopEnvironment> desktop_environment =
+      desktop_environment_factory_->Create(context_);
+
   // Create a client object.
   scoped_ptr<protocol::ConnectionToClient> connection(
       new protocol::ConnectionToClient(session));
-  ClientSession* client = new ClientSession(
+  scoped_refptr<ClientSession> client = new ClientSession(
       this,
+      context_->capture_task_runner(),
+      context_->encode_task_runner(),
+      context_->network_task_runner(),
       connection.Pass(),
-      desktop_environment_->event_executor(),
-      desktop_environment_->event_executor(),
-      desktop_environment_->capturer(),
+      desktop_environment.Pass(),
       max_session_duration_);
   clients_.push_back(client);
+  clients_count_++;
 }
 
 void ChromotingHost::set_protocol_config(
     protocol::CandidateSessionConfig* config) {
   DCHECK(context_->network_task_runner()->BelongsToCurrentThread());
   DCHECK(config);
   DCHECK_EQ(state_, kInitial);
   protocol_config_.reset(config);
 }
 
@@ skipping 38 matching lines @@
   }
 }
 
 void ChromotingHost::SetUiStrings(const UiStrings& ui_strings) {
   DCHECK(context_->network_task_runner()->BelongsToCurrentThread());
   DCHECK_EQ(state_, kInitial);
 
   ui_strings_ = ui_strings;
 }
 
-// TODO(sergeyu): Move this to SessionManager?
-// static
-VideoEncoder* ChromotingHost::CreateVideoEncoder(
-    const protocol::SessionConfig& config) {
-  const protocol::ChannelConfig& video_config = config.video_config();
+void ChromotingHost::OnClientStopped() {
+  DCHECK(context_->network_task_runner()->BelongsToCurrentThread());
 
-  if (video_config.codec == protocol::ChannelConfig::CODEC_VERBATIM) {
-    return VideoEncoderRowBased::CreateVerbatimEncoder();
-  } else if (video_config.codec == protocol::ChannelConfig::CODEC_ZIP) {
-    return VideoEncoderRowBased::CreateZlibEncoder();
-  } else if (video_config.codec == protocol::ChannelConfig::CODEC_VP8) {
-    return new remoting::VideoEncoderVp8();
-  }
-
-  return NULL;
-}
-
-// static
-scoped_ptr<AudioEncoder> ChromotingHost::CreateAudioEncoder(
-    const protocol::SessionConfig& config) {
-  const protocol::ChannelConfig& audio_config = config.audio_config();
-
-  if (audio_config.codec == protocol::ChannelConfig::CODEC_VERBATIM) {
-    return scoped_ptr<AudioEncoder>(new AudioEncoderVerbatim());
-  } else if (audio_config.codec == protocol::ChannelConfig::CODEC_SPEEX) {
-    return scoped_ptr<AudioEncoder>(new AudioEncoderSpeex());
-  }
-
-  NOTIMPLEMENTED();
-  return scoped_ptr<AudioEncoder>(NULL);
-}
-
-void ChromotingHost::StopScreenRecorder() {
-  DCHECK(context_->network_task_runner()->BelongsToCurrentThread());
-  DCHECK(recorder_.get());
-
-  ++stopping_recorders_;
-  scoped_refptr<ScreenRecorder> recorder = recorder_;
-  recorder_ = NULL;
-  recorder->Stop(base::Bind(&ChromotingHost::OnRecorderStopped, this));
-}
-
-void ChromotingHost::StopAudioScheduler() {
-  DCHECK(context_->network_task_runner()->BelongsToCurrentThread());
-  DCHECK(audio_scheduler_.get());
-
-  ++stopping_recorders_;
-  scoped_refptr<AudioScheduler> recorder = audio_scheduler_;
-  audio_scheduler_ = NULL;
-  recorder->Stop(base::Bind(&ChromotingHost::OnRecorderStopped, this));
-}
-
-void ChromotingHost::OnRecorderStopped() {
-  if (!context_->network_task_runner()->BelongsToCurrentThread()) {
-    context_->network_task_runner()->PostTask(
-        FROM_HERE, base::Bind(&ChromotingHost::OnRecorderStopped, this));
-    return;
-  }
-
-  --stopping_recorders_;
-  DCHECK_GE(stopping_recorders_, 0);
-
-  if (!stopping_recorders_ && state_ == kStopping)
+  --clients_count_;
+  if (state_ == kStopping && !clients_count_)
     ShutdownFinish();
 }
 
 void ChromotingHost::ShutdownFinish() {
   DCHECK(context_->network_task_runner()->BelongsToCurrentThread());
-  DCHECK(!stopping_recorders_);
+  DCHECK_EQ(state_, kStopping);
+
+  // Destroy session manager.
+  session_manager_.reset();
 
   state_ = kStopped;
 
   // Keep reference to |this|, so that we don't get destroyed while
   // sending notifications.
   scoped_refptr<ChromotingHost> self(this);
 
   // Notify observers.
   FOR_EACH_OBSERVER(HostStatusObserver, status_observers_,
                     OnShutdown());
 
   for (std::vector<base::Closure>::iterator it = shutdown_tasks_.begin();
        it != shutdown_tasks_.end(); ++it) {
     it->Run();
   }
   shutdown_tasks_.clear();
 }
 
 }  // namespace remoting