1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
/*
* Copyright (c) 2018 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 VIDEO_VIDEO_STREAM_ENCODER_OBSERVER_H_
#define VIDEO_VIDEO_STREAM_ENCODER_OBSERVER_H_
#include <string>
#include <vector>
#include "api/video/video_adaptation_counters.h"
#include "api/video/video_adaptation_reason.h"
#include "api/video/video_bitrate_allocation.h"
#include "api/video_codecs/video_encoder.h"
#include "video/config/video_encoder_config.h"
namespace webrtc {
// TODO(nisse): Used for the OnSendEncodedImage callback below. The callback
// wants metadata such as size, encode timing, qp, but doesn't need actual
// encoded data. So use some other type to represent that.
class EncodedImage;
struct EncoderImplementation {
const std::string& name;
bool is_hardware_accelerated;
};
// Broken out into a base class, with public inheritance below, only to ease
// unit testing of the internal class OveruseFrameDetector.
class CpuOveruseMetricsObserver {
public:
virtual ~CpuOveruseMetricsObserver() = default;
virtual void OnEncodedFrameTimeMeasured(int encode_duration_ms,
int encode_usage_percent) = 0;
};
class VideoStreamEncoderObserver : public CpuOveruseMetricsObserver {
public:
struct AdaptationSettings {
AdaptationSettings()
: resolution_scaling_enabled(false), framerate_scaling_enabled(false) {}
AdaptationSettings(bool resolution_scaling_enabled,
bool framerate_scaling_enabled)
: resolution_scaling_enabled(resolution_scaling_enabled),
framerate_scaling_enabled(framerate_scaling_enabled) {}
bool resolution_scaling_enabled;
bool framerate_scaling_enabled;
};
enum class DropReason {
kSource,
kEncoderQueue,
kEncoder,
kMediaOptimization,
kCongestionWindow
};
~VideoStreamEncoderObserver() override = default;
virtual void OnIncomingFrame(int width, int height) = 0;
// TODO(bugs.webrtc.org/8504): Merge into one callback per encoded frame.
using CpuOveruseMetricsObserver::OnEncodedFrameTimeMeasured;
virtual void OnSendEncodedImage(const EncodedImage& encoded_image,
const CodecSpecificInfo* codec_info) = 0;
virtual void OnEncoderImplementationChanged(
EncoderImplementation implementation) = 0;
virtual void OnFrameDropped(DropReason reason) = 0;
// Used to indicate change in content type, which may require a change in
// how stats are collected and set the configured preferred media bitrate.
virtual void OnEncoderReconfigured(
const VideoEncoderConfig& encoder_config,
const std::vector<VideoStream>& streams) = 0;
virtual void OnAdaptationChanged(
VideoAdaptationReason reason,
const VideoAdaptationCounters& cpu_steps,
const VideoAdaptationCounters& quality_steps) = 0;
virtual void ClearAdaptationStats() = 0;
virtual void UpdateAdaptationSettings(
AdaptationSettings cpu_settings,
AdaptationSettings quality_settings) = 0;
virtual void OnMinPixelLimitReached() = 0;
virtual void OnInitialQualityResolutionAdaptDown() = 0;
virtual void OnSuspendChange(bool is_suspended) = 0;
virtual void OnBitrateAllocationUpdated(
const VideoCodec& codec,
const VideoBitrateAllocation& allocation) {}
// Informes observer if an internal encoder scaler has reduced video
// resolution or not. `is_scaled` is a flag indicating if the video is scaled
// down.
virtual void OnEncoderInternalScalerUpdate(bool is_scaled) {}
// TODO(bugs.webrtc.org/14246): VideoStreamEncoder wants to query the stats,
// which makes this not a pure observer. GetInputFrameRate is needed for the
// cpu adaptation, so can be deleted if that responsibility is moved out to a
// VideoStreamAdaptor class.
virtual int GetInputFrameRate() const = 0;
};
} // namespace webrtc
#endif // VIDEO_VIDEO_STREAM_ENCODER_OBSERVER_H_
|
