Line data    Source code

       1             : /*
       2             :  *  Copyright (c) 2016 The WebRTC project authors. All Rights Reserved.
       3             :  *
       4             :  *  Use of this source code is governed by a BSD-style license
       5             :  *  that can be found in the LICENSE file in the root of the source
       6             :  *  tree. An additional intellectual property rights grant can be found
       7             :  *  in the file PATENTS.  All contributing project authors may
       8             :  *  be found in the AUTHORS file in the root of the source tree.
       9             :  */
      10             : 
      11             : #ifndef WEBRTC_MEDIA_BASE_VIDEOSOURCEINTERFACE_H_
      12             : #define WEBRTC_MEDIA_BASE_VIDEOSOURCEINTERFACE_H_
      13             : 
      14             : #include "webrtc/media/base/videosinkinterface.h"
      15             : #include "webrtc/base/optional.h"
      16             : 
      17             : namespace rtc {
      18             : 
      19             : // VideoSinkWants is used for notifying the source of properties a video frame
      20             : // should have when it is delivered to a certain sink.
      21           0 : struct VideoSinkWants {
      22             :   // Tells the source whether the sink wants frames with rotation applied.
      23             :   // By default, any rotation must be applied by the sink.
      24             :   bool rotation_applied = false;
      25             : 
      26             :   // Tells the source that the sink only wants black frames.
      27             :   bool black_frames = false;
      28             : 
      29             :   // Tells the source the maximum number of pixels the sink wants.
      30             :   rtc::Optional<int> max_pixel_count;
      31             :   // Like |max_pixel_count| but relative to the given value. The source is
      32             :   // requested to produce frames with a resolution one "step up" from the given
      33             :   // value. In practice, this means that the sink can consume this amount of
      34             :   // pixels but wants more and the source should produce a resolution one
      35             :   // "step" higher than this but not higher.
      36             :   rtc::Optional<int> max_pixel_count_step_up;
      37             : };
      38             : 
      39             : template <typename VideoFrameT>
      40           0 : class VideoSourceInterface {
      41             :  public:
      42             :   virtual void AddOrUpdateSink(VideoSinkInterface<VideoFrameT>* sink,
      43             :                                const VideoSinkWants& wants) = 0;
      44             :   // RemoveSink must guarantee that at the time the method returns,
      45             :   // there is no current and no future calls to VideoSinkInterface::OnFrame.
      46             :   virtual void RemoveSink(VideoSinkInterface<VideoFrameT>* sink) = 0;
      47             : 
      48             :  protected:
      49           0 :   virtual ~VideoSourceInterface() {}
      50             : };
      51             : 
      52             : }  // namespace rtc
      53             : #endif  // WEBRTC_MEDIA_BASE_VIDEOSOURCEINTERFACE_H_