Rename VideoScheduler->VideoFramePipe.

remoting/host/video_frame_pump.h

-// Copyright (c) 2012 The Chromium Authors. All rights reserved.
+// Copyright 2015 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_VIDEO_SCHEDULER_H_
-#define REMOTING_HOST_VIDEO_SCHEDULER_H_
+#ifndef REMOTING_HOST_VIDEO_FRAME_PUMP_H_
+#define REMOTING_HOST_VIDEO_FRAME_PUMP_H_
 
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/time/time.h"
 #include "base/timer/timer.h"
 #include "remoting/codec/video_encoder.h"
 #include "remoting/proto/video.pb.h"
 #include "third_party/webrtc/modules/desktop_capture/desktop_capturer.h"
 #include "third_party/webrtc/modules/desktop_capture/mouse_cursor_monitor.h"
 
 namespace base {
 class SingleThreadTaskRunner;
 }  // namespace base
 
 namespace media {
 class DesktopCapturer;
 }  // namespace media
 
 namespace remoting {
 
 class CaptureScheduler;
-class CursorShapeInfo;
 
 namespace protocol {
 class CursorShapeInfo;
 class CursorShapeStub;
 class VideoStub;
 }  // namespace protocol
 
 // Class responsible for scheduling frame captures from a
 // webrtc::DesktopCapturer, delivering them to a VideoEncoder to encode, and
 // finally passing the encoded video packets to the specified VideoStub to send
@@ skipping 19 matching lines @@
 // |    ............. ............ ..........
 // |    .  Capture  . .          . .  Send  .
 // |    ............. .          . ..........
 // |                  .  Encode  .
 // |                  .          .
 // |                  .          .
 // |                  ............
 // | Time
 // v
 //
-// VideoScheduler would ideally schedule captures so as to saturate the slowest
+// VideoFramePump would ideally schedule captures so as to saturate the slowest
 // of the capture, encode and network processes.  However, it also needs to
 // rate-limit captures to avoid overloading the host system, either by consuming
 // too much CPU, or hogging the host's graphics subsystem.
 //
-// TODO(sergeyu): Rename this class to VideoFramePipe.
-class VideoScheduler : public base::RefCountedThreadSafe<VideoScheduler>,
+// TODO(sergeyu): Rename this class to VideoFramePump.
+class VideoFramePump : public base::RefCountedThreadSafe<VideoFramePump>,
                        public webrtc::DesktopCapturer::Callback,
                        public webrtc::MouseCursorMonitor::Callback {
  public:
   // Enables timestamps for generated frames. Used for testing.
   static void EnableTimestampsForTests();
 
-  // Creates a VideoScheduler running capture, encode and network tasks on the
+  // Creates a VideoFramePump running capture, encode and network tasks on the
   // supplied TaskRunners.  Video and cursor shape updates will be pumped to
   // |video_stub| and |client_stub|, which must remain valid until Stop() is
   // called. |capturer| is used to capture frames.
-  VideoScheduler(
+  VideoFramePump(
       scoped_refptr<base::SingleThreadTaskRunner> capture_task_runner,
       scoped_refptr<base::SingleThreadTaskRunner> encode_task_runner,
       scoped_refptr<base::SingleThreadTaskRunner> network_task_runner,
       scoped_ptr<webrtc::DesktopCapturer> capturer,
       scoped_ptr<webrtc::MouseCursorMonitor> mouse_cursor_monitor,
       scoped_ptr<VideoEncoder> encoder,
       protocol::CursorShapeStub* cursor_stub,
       protocol::VideoStub* video_stub);
 
   // Starts scheduling frame captures.
@@ skipping 10 matching lines @@
   // Updates event timestamp from the last event received from the client. This
   // value is sent back to the client for roundtrip latency estimates.
   void SetLatestEventTimestamp(int64 latest_event_timestamp);
 
   // Sets whether the video encoder should be requested to encode losslessly,
   // or to use a lossless color space (typically requiring higher bandwidth).
   void SetLosslessEncode(bool want_lossless);
   void SetLosslessColor(bool want_lossless);
 
  private:
-  friend class base::RefCountedThreadSafe<VideoScheduler>;
-  ~VideoScheduler() override;
+  friend class base::RefCountedThreadSafe<VideoFramePump>;
+  ~VideoFramePump() override;
 
   // Capturer thread ----------------------------------------------------------
 
   // TODO(sergeyu): Move all methods that run on the capture thread to a
-  // separate class and make VideoScheduler not ref-counted.
+  // separate class and make VideoFramePump not ref-counted.
 
   // webrtc::DesktopCapturer::Callback implementation.
   webrtc::SharedMemory* CreateSharedMemory(size_t size) override;
   void OnCaptureCompleted(webrtc::DesktopFrame* frame) override;
 
   // webrtc::MouseCursorMonitor::Callback implementation.
   void OnMouseCursor(webrtc::MouseCursor* mouse_cursor) override;
   void OnMouseCursorPosition(webrtc::MouseCursorMonitor::CursorState state,
                              const webrtc::DesktopVector& position) override;
 
@@ skipping 46 matching lines @@
   // Used to encode captured frames. Always accessed on the encode thread.
   scoped_ptr<VideoEncoder> encoder_;
 
   // Interfaces through which video frames and cursor shapes are passed to the
   // client. These members are always accessed on the network thread.
   protocol::CursorShapeStub* cursor_stub_;
   protocol::VideoStub* video_stub_;
 
   // Timer used to ensure that we send empty keep-alive frames to the client
   // even when the video stream is paused or encoder is busy.
-  scoped_ptr<base::DelayTimer<VideoScheduler> > keep_alive_timer_;
+  scoped_ptr<base::DelayTimer<VideoFramePump> > keep_alive_timer_;
 
   // Number updated by the caller to trace performance.
   int64 latest_event_timestamp_;
 
   scoped_ptr<CaptureScheduler> capture_scheduler_;
 
-  DISALLOW_COPY_AND_ASSIGN(VideoScheduler);
+  DISALLOW_COPY_AND_ASSIGN(VideoFramePump);
 };
 
 }  // namespace remoting
 
-#endif  // REMOTING_HOST_VIDEO_SCHEDULER_H_
+#endif  // REMOTING_HOST_VIDEO_FRAME_PUMP_H_