remoting/protocol/webrtc_frame_scheduler.h

// Copyright 2016 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_PROTOCOL_WEBRTC_FRAME_SCHEDULER_H_
#define REMOTING_PROTOCOL_WEBRTC_FRAME_SCHEDULER_H_

#include "base/callback_forward.h"
#include "base/memory/weak_ptr.h"
#include "remoting/codec/webrtc_video_encoder.h"

namespace remoting {
namespace protocol {

struct HostFrameStats;
class WebrtcDummyVideoEncoderFactory;

// An abstract interface for frame schedulers, which are responsible for
// scheduling when video frames are captured and for defining encoding
// parameters for each frame.
class WebrtcFrameScheduler {
 public:
  WebrtcFrameScheduler() {}
  virtual ~WebrtcFrameScheduler() {}

  // Starts the scheduler. |capture_callback| will be called whenever a new
  // frame should be captured.
  virtual void Start(WebrtcDummyVideoEncoderFactory* video_encoder_factory,
                     const base::Closure& capture_callback) = 0;

  // Pause and resumes the scheduler.
  virtual void Pause(bool pause) = 0;

  // Called after |frame| has been captured to get encoding parameters for the
  // frame. Returns false if the frame should be dropped (e.g. when there are no
  // changes), true otherwise. |frame| may be set to nullptr if the capture
  // request failed.
  virtual bool OnFrameCaptured(const webrtc::DesktopFrame* frame,
                               WebrtcVideoEncoder::FrameParams* params_out) = 0;

  // Called after a frame has been encoded and passed to the sender.
  // |encoded_frame| may be nullptr. If |frame_stats| is not null then sets
  // send_pending_delay, rtt_estimate and bandwidth_estimate_kbps fields.
  virtual void OnFrameEncoded(
      const WebrtcVideoEncoder::EncodedFrame* encoded_frame,
      HostFrameStats* frame_stats) = 0;
};

}  // namespace protocol
}  // namespace remoting

#endif  // REMOTING_PROTOCOL_WEBRTC_FRAME_SCHEDULER_H_