Home | History | Annotate | Download | only in client 
      1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
      2 // Use of this source code is governed by a BSD-style license that can be
      3 // found in the LICENSE file.
      4 
      5 #ifndef REMOTING_CLIENT_RECTANGLE_UPDATE_DECODER_H_
      6 #define REMOTING_CLIENT_RECTANGLE_UPDATE_DECODER_H_
      7 
      8 #include <list>
      9 
     10 #include "base/callback_forward.h"
     11 #include "base/memory/ref_counted.h"
     12 #include "base/memory/scoped_ptr.h"
     13 #include "remoting/codec/video_decoder.h"
     14 #include "remoting/client/chromoting_stats.h"
     15 #include "remoting/client/frame_consumer_proxy.h"
     16 #include "remoting/client/frame_producer.h"
     17 #include "remoting/protocol/video_stub.h"
     18 #include "third_party/webrtc/modules/desktop_capture/desktop_geometry.h"
     19 
     20 namespace base {
     21 class SingleThreadTaskRunner;
     22 }  // namespace base
     23 
     24 namespace remoting {
     25 
     26 class ChromotingStats;
     27 
     28 namespace protocol {
     29 class SessionConfig;
     30 }  // namespace protocol
     31 
     32 // TODO(ajwong): Re-examine this API, especially with regards to how error
     33 // conditions on each step are reported.  Should they be CHECKs? Logs? Other?
     34 // TODO(sergeyu): Rename this class.
     35 class RectangleUpdateDecoder
     36     : public base::RefCountedThreadSafe<RectangleUpdateDecoder>,
     37       public FrameProducer,
     38       public protocol::VideoStub {
     39  public:
     40   // Creates an update decoder on |main_task_runner_| and |decode_task_runner_|,
     41   // outputting to |consumer|. The |main_task_runner_| is responsible for
     42   // receiving and queueing packets. The |decode_task_runner_| is responsible
     43   // for decoding the video packets.
     44   // TODO(wez): Replace the ref-counted proxy with an owned FrameConsumer.
     45   RectangleUpdateDecoder(
     46       scoped_refptr<base::SingleThreadTaskRunner> main_task_runner,
     47       scoped_refptr<base::SingleThreadTaskRunner> decode_task_runner,
     48       scoped_refptr<FrameConsumerProxy> consumer);
     49 
     50   // Initializes decoder with the information from the protocol config.
     51   void Initialize(const protocol::SessionConfig& config);
     52 
     53   // FrameProducer implementation.  These methods may be called before we are
     54   // Initialize()d, or we know the source screen size.
     55   virtual void DrawBuffer(webrtc::DesktopFrame* buffer) OVERRIDE;
     56   virtual void InvalidateRegion(const webrtc::DesktopRegion& region) OVERRIDE;
     57   virtual void RequestReturnBuffers(const base::Closure& done) OVERRIDE;
     58   virtual void SetOutputSizeAndClip(
     59       const webrtc::DesktopSize& view_size,
     60       const webrtc::DesktopRect& clip_area) OVERRIDE;
     61   virtual const webrtc::DesktopRegion* GetBufferShape() OVERRIDE;
     62 
     63   // VideoStub implementation.
     64   virtual void ProcessVideoPacket(scoped_ptr<VideoPacket> packet,
     65                                   const base::Closure& done) OVERRIDE;
     66 
     67   // Return the stats recorded by this client.
     68   ChromotingStats* GetStats();
     69 
     70  private:
     71   friend class base::RefCountedThreadSafe<RectangleUpdateDecoder>;
     72   virtual ~RectangleUpdateDecoder();
     73 
     74   // Paints the invalidated region to the next available buffer and returns it
     75   // to the consumer.
     76   void SchedulePaint();
     77   void DoPaint();
     78 
     79   // Decodes the contents of |packet|. DecodePacket may keep a reference to
     80   // |packet| so the |packet| must remain alive and valid until |done| is
     81   // executed.
     82   void DecodePacket(scoped_ptr<VideoPacket> packet, const base::Closure& done);
     83 
     84   // Callback method when a VideoPacket is processed. |decode_start| contains
     85   // the timestamp when the packet will start to be processed.
     86   void OnPacketDone(base::Time decode_start, const base::Closure& done);
     87 
     88   scoped_refptr<base::SingleThreadTaskRunner> main_task_runner_;
     89   scoped_refptr<base::SingleThreadTaskRunner> decode_task_runner_;
     90   scoped_refptr<FrameConsumerProxy> consumer_;
     91   scoped_ptr<VideoDecoder> decoder_;
     92 
     93   // Remote screen size in pixels.
     94   webrtc::DesktopSize source_size_;
     95 
     96   // Vertical and horizontal DPI of the remote screen.
     97   webrtc::DesktopVector source_dpi_;
     98 
     99   // The current dimensions of the frame consumer view.
    100   webrtc::DesktopSize view_size_;
    101   webrtc::DesktopRect clip_area_;
    102 
    103   // The drawing buffers supplied by the frame consumer.
    104   std::list<webrtc::DesktopFrame*> buffers_;
    105 
    106   // Flag used to coalesce runs of SchedulePaint()s into a single DoPaint().
    107   bool paint_scheduled_;
    108 
    109   ChromotingStats stats_;
    110 
    111   // Keep track of the most recent sequence number bounced back from the host.
    112   int64 latest_sequence_number_;
    113 };
    114 
    115 }  // namespace remoting
    116 
    117 #endif  // REMOTING_CLIENT_RECTANGLE_UPDATE_DECODER_H_
    118