modules/video_render/main/source/video_render_frames.h

/*
 *  Copyright (c) 2012 The WebRTC project authors. All Rights Reserved.
 *
 *  Use of this source code is governed by a BSD-style license
 *  that can be found in the LICENSE file in the root of the source
 *  tree. An additional intellectual property rights grant can be found
 *  in the file PATENTS.  All contributing project authors may
 *  be found in the AUTHORS file in the root of the source tree.
 */

#ifndef WEBRTC_MODULES_VIDEO_RENDER_MAIN_SOURCE_VIDEO_RENDER_FRAMES_H_  // NOLINT
#define WEBRTC_MODULES_VIDEO_RENDER_MAIN_SOURCE_VIDEO_RENDER_FRAMES_H_  // NOLINT

#include "modules/video_render/main/interface/video_render.h"
#include "system_wrappers/interface/list_wrapper.h"

namespace webrtc {

// Class definitions
class VideoRenderFrames {
 public:
  VideoRenderFrames();
  ~VideoRenderFrames();

  // Add a frame to the render queue
  WebRtc_Word32 AddFrame(VideoFrame* new_frame);

  // Get a frame for rendering, if it's time to render.
  VideoFrame* FrameToRender();

  // Return an old frame
  WebRtc_Word32 ReturnFrame(VideoFrame* old_frame);

  // Releases all frames
  WebRtc_Word32 ReleaseAllFrames();

  // Returns the number of ms to next frame to render
  WebRtc_UWord32 TimeToNextFrameRelease();

  // Sets estimates delay in renderer
  WebRtc_Word32 SetRenderDelay(const WebRtc_UWord32 render_delay);

 private:
  // 10 seconds for 30 fps.
  enum { KMaxNumberOfFrames = 300 };
  // Don't render frames with timestamp older than 500ms from now.
  enum { KOldRenderTimestampMS = 500 };
  // Don't render frames with timestamp more than 10s into the future.
  enum { KFutureRenderTimestampMS = 10000 };

  // Sorted list with framed to be rendered, oldest first.
  ListWrapper incoming_frames_;
  // Empty frames.
  ListWrapper empty_frames_;

  // Estimated delay from a frame is released until it's rendered.
  WebRtc_UWord32 render_delay_ms_;
};

}  // namespace webrtc

#endif  // WEBRTC_MODULES_VIDEO_RENDER_MAIN_SOURCE_VIDEO_RENDER_FRAMES_H_  // NOLINT