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

remoting/host/client_session.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 REMOTING_HOST_CLIENT_SESSION_H_
 #define REMOTING_HOST_CLIENT_SESSION_H_
 
 #include <list>
 
 #include "base/time.h"
 #include "base/timer.h"
 #include "base/threading/non_thread_safe.h"
 #include "remoting/host/remote_input_filter.h"
 #include "remoting/protocol/clipboard_echo_filter.h"
 #include "remoting/protocol/clipboard_filter.h"
 #include "remoting/protocol/clipboard_stub.h"
 #include "remoting/protocol/connection_to_client.h"
 #include "remoting/protocol/host_stub.h"
 #include "remoting/protocol/input_event_tracker.h"
 #include "remoting/protocol/input_filter.h"
 #include "remoting/protocol/input_stub.h"
 #include "remoting/protocol/mouse_input_filter.h"
 #include "third_party/skia/include/core/SkPoint.h"
 
+namespace base {
+class SingleThreadTaskRunner;
+}  // namespace base
+
 namespace remoting {
 
+class AudioEncoder;
+class AudioScheduler;
+class DesktopEnvironment;
+class Encoder;
+class ScreenRecorder;
 class VideoFrameCapturer;
 
 // A ClientSession keeps a reference to a connection to a client, and maintains
 // per-client state.
 class ClientSession : public protocol::HostStub,
                       public protocol::InputStub,
                       public protocol::ConnectionToClient::EventHandler,
                       public base::NonThreadSafe {
  public:
   // Callback interface for passing events to the ChromotingHost.
@@ skipping 23 matching lines @@
     virtual void OnSessionRouteChange(
         ClientSession* client,
         const std::string& channel_name,
         const protocol::TransportRoute& route) = 0;
 
    protected:
     virtual ~EventHandler() {}
   };
 
   ClientSession(EventHandler* event_handler,
+                scoped_refptr<base::SingleThreadTaskRunner> capture_task_runner,
+                scoped_refptr<base::SingleThreadTaskRunner> encode_task_runner,
+                scoped_refptr<base::SingleThreadTaskRunner> network_task_runner,
                 scoped_ptr<protocol::ConnectionToClient> connection,
-                protocol::ClipboardStub* host_clipboard_stub,
-                protocol::InputStub* host_input_stub,
-                VideoFrameCapturer* capturer,
+                scoped_ptr<DesktopEnvironment> desktop_environment,
                 const base::TimeDelta& max_duration);
   virtual ~ClientSession();
 
   // protocol::InputStub interface.
   virtual void InjectKeyEvent(const protocol::KeyEvent& event) OVERRIDE;
   virtual void InjectMouseEvent(const protocol::MouseEvent& event) OVERRIDE;
 
   // protocol::HostStub interface.
   virtual void NotifyClientDimensions(
       const protocol::ClientDimensions& dimensions) OVERRIDE;
@@ skipping 13 matching lines @@
       protocol::ConnectionToClient* connection,
       const std::string& channel_name,
       const protocol::TransportRoute& route) OVERRIDE;
 
   // Disconnects the session and destroys the transport. Event handler
   // is guaranteed not to be called after this method is called. Can
   // be called multiple times. The object should not be used after
   // this method returns.
   void Disconnect();
 
+  void StopAndDelete();

[simonmorris, 2012/09/04 18:47:21]

Add a comment explaining how this is used, and, in particular, whether a
ClientSession must/should be deleted using this method.

Should the ClientSession dtor be protected? It's easy to imagine a CL that leads
to a StopAndDelete() followed by a ~ClientSession().

[alexeypa (please no reviews), 2012/09/05 22:53:29]

Done.

+
   protocol::ConnectionToClient* connection() const {
     return connection_.get();
   }
 
+  DesktopEnvironment* desktop_environment() const {
+    return desktop_environment_.get();
+  }
+
   const std::string& client_jid() { return client_jid_; }
 
   bool is_authenticated() { return is_authenticated_;  }
 
   // Indicate that local mouse activity has been detected. This causes remote
   // inputs to be ignored for a short time so that the local user will always
   // have the upper hand in 'pointer wars'.
   void LocalMouseMoved(const SkIPoint& new_pos);
 
   // Disable handling of input events from this client. If the client has any
   // keys or mouse buttons pressed then these will be released.
   void SetDisableInputs(bool disable_inputs);
 
   // Creates a proxy for sending clipboard events to the client.
   scoped_ptr<protocol::ClipboardStub> CreateClipboardProxy();
 
  private:
+  // Creates encoder for the specified configuration.
+  static Encoder* CreateEncoder(const protocol::SessionConfig& config);
+
+  // Creates an audio encoder for the specified configuration.
+  static scoped_ptr<AudioEncoder> CreateAudioEncoder(
+      const protocol::SessionConfig& config);
+
+  void OnRecorderStopped();
+  void StopAudioScheduler();
+  void StopScreenRecorder();
+
   EventHandler* event_handler_;
 
   // The connection to the client.
   scoped_ptr<protocol::ConnectionToClient> connection_;
 
+  // The desktop environment used by this session.
+  scoped_ptr<DesktopEnvironment> desktop_environment_;
+
   std::string client_jid_;
   bool is_authenticated_;
 
   // The host clipboard and input stubs to which this object delegates.
   // These are the final elements in the clipboard & input pipelines, which
   // appear in order below.
   protocol::ClipboardStub* host_clipboard_stub_;
   protocol::InputStub* host_input_stub_;
 
   // Tracker used to release pressed keys and buttons when disconnecting.
@@ skipping 29 matching lines @@
   VideoFrameCapturer* capturer_;
 
   // The maximum duration of this session.
   // There is no maximum if this value is <= 0.
   base::TimeDelta max_duration_;
 
   // A timer that triggers a disconnect when the maximum session duration
   // is reached.
   base::OneShotTimer<ClientSession> max_duration_timer_;
 
+  scoped_refptr<base::SingleThreadTaskRunner> capture_task_runner_;
+  scoped_refptr<base::SingleThreadTaskRunner> encode_task_runner_;
+  scoped_refptr<base::SingleThreadTaskRunner> network_task_runner_;
+
+  // Schedulers for audio and video capture.
+  scoped_refptr<AudioScheduler> audio_scheduler_;
+  scoped_refptr<ScreenRecorder> video_recorder_;
+
+  // Number of screen recorders and audio schedulers that are currently being
+  // used or shutdown. Used to delay shutdown if one or more
+  // recorders/schedulers are asynchronously shutting down.
+  int active_recorders_;
+
   DISALLOW_COPY_AND_ASSIGN(ClientSession);
 };
 
 }  // namespace remoting
 
 #endif  // REMOTING_HOST_CLIENT_SESSION_H_