blob: f84bced45d5e79a700099e78cdfbf7fc4c1a1ab5 [file] [log] [blame]
pbos@webrtc.org29d58392013-05-16 12:08:03 +00001/*
2 * Copyright (c) 2013 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
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020011#include "video/video_receive_stream.h"
pbos@webrtc.org29d58392013-05-16 12:08:03 +000012
pbos@webrtc.org12dc1a32013-08-05 16:22:53 +000013#include <stdlib.h>
Yves Gerey3e707812018-11-28 16:47:49 +010014#include <string.h>
Niels Möller46879152019-01-07 15:54:47 +010015#include <algorithm>
mflodmand1590b22015-12-09 07:07:59 -080016#include <set>
mflodman@webrtc.orgb429e512013-12-18 09:46:22 +000017#include <string>
Erik Språng737336d2016-07-29 12:59:36 +020018#include <utility>
mflodman@webrtc.orgb429e512013-12-18 09:46:22 +000019
Karl Wiberg918f50c2018-07-05 11:40:33 +020020#include "absl/memory/memory.h"
Danil Chapovalovb9b146c2018-06-15 12:28:07 +020021#include "absl/types/optional.h"
Yves Gerey3e707812018-11-28 16:47:49 +010022#include "api/array_view.h"
Steve Anton10542f22019-01-11 09:11:00 -080023#include "api/crypto/frame_decryptor_interface.h"
Yves Gerey3e707812018-11-28 16:47:49 +010024#include "api/video/encoded_image.h"
25#include "api/video_codecs/sdp_video_format.h"
26#include "api/video_codecs/video_codec.h"
Niels Möllercbcbc222018-09-28 09:07:24 +020027#include "api/video_codecs/video_decoder_factory.h"
Yves Gerey3e707812018-11-28 16:47:49 +010028#include "api/video_codecs/video_encoder.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020029#include "call/rtp_stream_receiver_controller_interface.h"
30#include "call/rtx_receive_stream.h"
Yves Gerey3e707812018-11-28 16:47:49 +010031#include "common_types.h" // NOLINT(build/include)
Patrik Höglundbe214a22018-01-04 12:14:35 +010032#include "common_video/include/incoming_video_stream.h"
Yves Gerey3e707812018-11-28 16:47:49 +010033#include "media/base/h264_profile_level_id.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020034#include "modules/utility/include/process_thread.h"
Yves Gerey3e707812018-11-28 16:47:49 +010035#include "modules/video_coding/include/video_codec_interface.h"
36#include "modules/video_coding/include/video_coding_defines.h"
37#include "modules/video_coding/include/video_error_codes.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020038#include "modules/video_coding/jitter_estimator.h"
39#include "modules/video_coding/timing.h"
Niels Möller147013a2018-10-01 15:56:33 +020040#include "modules/video_coding/utility/vp8_header_parser.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020041#include "rtc_base/checks.h"
42#include "rtc_base/location.h"
43#include "rtc_base/logging.h"
Erik Språng96965ae2018-10-23 15:42:37 +020044#include "rtc_base/platform_file.h"
45#include "rtc_base/strings/string_builder.h"
Steve Anton10542f22019-01-11 09:11:00 -080046#include "rtc_base/time_utils.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020047#include "rtc_base/trace_event.h"
48#include "system_wrappers/include/clock.h"
49#include "system_wrappers/include/field_trial.h"
50#include "video/call_stats.h"
Erik Språng96965ae2018-10-23 15:42:37 +020051#include "video/frame_dumping_decoder.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020052#include "video/receive_statistics_proxy.h"
pbos@webrtc.org29d58392013-05-16 12:08:03 +000053
54namespace webrtc {
mflodmana20de202015-10-18 22:08:19 -070055
pbos@webrtc.org776e6f22014-10-29 15:28:39 +000056namespace {
Ruslan Burakov493a6502019-02-27 15:32:48 +010057constexpr int kMinBaseMinimumDelayMs = 0;
58constexpr int kMaxBaseMinimumDelayMs = 10000;
59
pbos@webrtc.org776e6f22014-10-29 15:28:39 +000060VideoCodec CreateDecoderVideoCodec(const VideoReceiveStream::Decoder& decoder) {
61 VideoCodec codec;
62 memset(&codec, 0, sizeof(codec));
63
64 codec.plType = decoder.payload_type;
Niels Möllercb7e1d22018-09-11 15:56:04 +020065 codec.codecType = PayloadStringToCodecType(decoder.video_format.name);
pbos@webrtc.org776e6f22014-10-29 15:28:39 +000066
67 if (codec.codecType == kVideoCodecVP8) {
hta257dc392016-10-25 09:05:06 -070068 *(codec.VP8()) = VideoEncoder::GetDefaultVp8Settings();
ivica05cfcd32015-09-07 06:04:16 -070069 } else if (codec.codecType == kVideoCodecVP9) {
hta257dc392016-10-25 09:05:06 -070070 *(codec.VP9()) = VideoEncoder::GetDefaultVp9Settings();
pbos@webrtc.org776e6f22014-10-29 15:28:39 +000071 } else if (codec.codecType == kVideoCodecH264) {
hta257dc392016-10-25 09:05:06 -070072 *(codec.H264()) = VideoEncoder::GetDefaultH264Settings();
magjede69a1a92016-11-25 10:06:31 -080073 codec.H264()->profile =
Niels Möllercb7e1d22018-09-11 15:56:04 +020074 H264::ParseSdpProfileLevelId(decoder.video_format.parameters)->profile;
Emircan Uysalerd7ae3c32018-01-25 13:01:09 -080075 } else if (codec.codecType == kVideoCodecMultiplex) {
Emircan Uysaler0a375472017-12-11 12:21:02 +053076 VideoReceiveStream::Decoder associated_decoder = decoder;
Niels Möllercb7e1d22018-09-11 15:56:04 +020077 associated_decoder.video_format =
78 SdpVideoFormat(CodecTypeToPayloadString(kVideoCodecVP9));
Emircan Uysaler0a375472017-12-11 12:21:02 +053079 VideoCodec associated_codec = CreateDecoderVideoCodec(associated_decoder);
Emircan Uysalerd7ae3c32018-01-25 13:01:09 -080080 associated_codec.codecType = kVideoCodecMultiplex;
Emircan Uysaler0a375472017-12-11 12:21:02 +053081 return associated_codec;
pbos@webrtc.org776e6f22014-10-29 15:28:39 +000082 }
83
84 codec.width = 320;
85 codec.height = 180;
stefanb4bc65b2016-11-02 10:10:20 -070086 const int kDefaultStartBitrate = 300;
pbos@webrtc.org776e6f22014-10-29 15:28:39 +000087 codec.startBitrate = codec.minBitrate = codec.maxBitrate =
stefanb4bc65b2016-11-02 10:10:20 -070088 kDefaultStartBitrate;
pbos@webrtc.org776e6f22014-10-29 15:28:39 +000089
90 return codec;
91}
Niels Möllercbcbc222018-09-28 09:07:24 +020092
93// Video decoder class to be used for unknown codecs. Doesn't support decoding
94// but logs messages to LS_ERROR.
95class NullVideoDecoder : public webrtc::VideoDecoder {
96 public:
97 int32_t InitDecode(const webrtc::VideoCodec* codec_settings,
98 int32_t number_of_cores) override {
99 RTC_LOG(LS_ERROR) << "Can't initialize NullVideoDecoder.";
100 return WEBRTC_VIDEO_CODEC_OK;
101 }
102
103 int32_t Decode(const webrtc::EncodedImage& input_image,
104 bool missing_frames,
Jeroen de Borst2c7b9822019-03-07 19:40:07 +0000105 const webrtc::CodecSpecificInfo* codec_specific_info,
Niels Möllercbcbc222018-09-28 09:07:24 +0200106 int64_t render_time_ms) override {
107 RTC_LOG(LS_ERROR) << "The NullVideoDecoder doesn't support decoding.";
108 return WEBRTC_VIDEO_CODEC_OK;
109 }
110
111 int32_t RegisterDecodeCompleteCallback(
112 webrtc::DecodedImageCallback* callback) override {
113 RTC_LOG(LS_ERROR)
114 << "Can't register decode complete callback on NullVideoDecoder.";
115 return WEBRTC_VIDEO_CODEC_OK;
116 }
117
118 int32_t Release() override { return WEBRTC_VIDEO_CODEC_OK; }
119
120 const char* ImplementationName() const override { return "NullVideoDecoder"; }
121};
122
Niels Möller46879152019-01-07 15:54:47 +0100123// Inherit video_coding::EncodedFrame, which is the class used by
124// video_coding::FrameBuffer and other components in the receive pipeline. It's
125// a subclass of EncodedImage, and it always owns the buffer.
126class EncodedFrameForMediaTransport : public video_coding::EncodedFrame {
127 public:
128 explicit EncodedFrameForMediaTransport(
129 MediaTransportEncodedVideoFrame frame) {
Niels Möller938dd9f2019-02-07 00:02:17 +0100130 // TODO(nisse): This is ugly. We copy the EncodedImage (a base class of
131 // ours, in several steps), to get all the meta data. We should be using
132 // std::move in some way. Then we also need to handle the case of an unowned
133 // buffer, in which case we need to make an owned copy.
Niels Möller46879152019-01-07 15:54:47 +0100134 *static_cast<class EncodedImage*>(this) = frame.encoded_image();
Niels Möller46879152019-01-07 15:54:47 +0100135
Niels Möller69bb3af2019-02-13 10:05:49 +0100136 // If we don't already own the buffer, make a copy.
137 Retain();
Niels Möller46879152019-01-07 15:54:47 +0100138
139 _payloadType = static_cast<uint8_t>(frame.payload_type());
140
141 // TODO(nisse): frame_id and picture_id are probably not the same thing. For
142 // a single layer, this should be good enough.
143 id.picture_id = frame.frame_id();
144 id.spatial_layer = frame.encoded_image().SpatialIndex().value_or(0);
145 num_references = std::min(static_cast<size_t>(kMaxFrameReferences),
146 frame.referenced_frame_ids().size());
147 for (size_t i = 0; i < num_references; i++) {
148 references[i] = frame.referenced_frame_ids()[i];
149 }
150 }
151
152 // TODO(nisse): Implement. Not sure how they are used.
153 int64_t ReceivedTime() const override { return 0; }
154 int64_t RenderTime() const override { return 0; }
155};
156
Ilya Nikolaevskiye6a2d942018-11-07 14:32:28 +0100157// TODO(https://bugs.webrtc.org/9974): Consider removing this workaround.
158// Maximum time between frames before resetting the FrameBuffer to avoid RTP
159// timestamps wraparound to affect FrameBuffer.
160constexpr int kInactiveStreamThresholdMs = 600000; // 10 minutes.
161
pbos@webrtc.org776e6f22014-10-29 15:28:39 +0000162} // namespace
pbos@webrtc.org29d58392013-05-16 12:08:03 +0000163
Peter Boströmca835252016-02-11 15:59:46 +0100164namespace internal {
tommi2e82f382016-06-21 00:26:43 -0700165
nisse0f15f922017-06-21 01:05:22 -0700166VideoReceiveStream::VideoReceiveStream(
Sebastian Jansson74682c12019-03-01 11:50:20 +0100167 TaskQueueFactory* task_queue_factory,
nisse0f15f922017-06-21 01:05:22 -0700168 RtpStreamReceiverControllerInterface* receiver_controller,
169 int num_cpu_cores,
170 PacketRouter* packet_router,
171 VideoReceiveStream::Config config,
172 ProcessThread* process_thread,
Ruslan Burakov493a6502019-02-27 15:32:48 +0100173 CallStats* call_stats,
174 Clock* clock,
175 VCMTiming* timing)
Sebastian Jansson74682c12019-03-01 11:50:20 +0100176 : task_queue_factory_(task_queue_factory),
177 transport_adapter_(config.rtcp_send_transport),
Tommi733b5472016-06-10 17:58:01 +0200178 config_(std::move(config)),
sprang113bdca2016-10-11 03:10:10 -0700179 num_cpu_cores_(num_cpu_cores),
Peter Boström1d04ac62016-02-05 11:25:46 +0100180 process_thread_(process_thread),
Ruslan Burakov493a6502019-02-27 15:32:48 +0100181 clock_(clock),
tommic8ece432017-06-20 02:44:38 -0700182 decode_thread_(&DecodeThreadFunction,
183 this,
184 "DecodingThread",
185 rtc::kHighestPriority),
Peter Boström1d04ac62016-02-05 11:25:46 +0100186 call_stats_(call_stats),
Danil Chapovalov8ce0d2b2018-11-23 11:03:25 +0100187 stats_proxy_(&config_, clock_),
188 rtp_receive_statistics_(
189 ReceiveStatistics::Create(clock_, &stats_proxy_, &stats_proxy_)),
Ruslan Burakov493a6502019-02-27 15:32:48 +0100190 timing_(timing),
191 video_receiver_(clock_,
192 timing_.get(),
193 this, // NackSender
194 this), // KeyFrameRequestSender
Sebastian Jansson8026d602019-03-04 19:39:01 +0100195 rtp_video_stream_receiver_(clock_,
196 &transport_adapter_,
Tommi38c5d932018-03-27 23:11:09 +0200197 call_stats,
nisseb1f2ff92017-06-09 04:01:55 -0700198 packet_router,
199 &config_,
nisseca5706d2017-09-11 02:32:16 -0700200 rtp_receive_statistics_.get(),
nisseb1f2ff92017-06-09 04:01:55 -0700201 &stats_proxy_,
202 process_thread_,
Benjamin Wright192eeec2018-10-17 17:27:25 -0700203 this, // NackSender
204 this, // KeyFrameRequestSender
205 this, // OnCompleteFrameCallback
206 config_.frame_decryptor),
philipela45102f2017-02-22 05:30:39 -0800207 rtp_stream_sync_(this) {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100208 RTC_LOG(LS_INFO) << "VideoReceiveStream: " << config_.ToString();
pbos@webrtc.org29d58392013-05-16 12:08:03 +0000209
Rasmus Brandt1e27fec2019-01-23 09:47:50 +0100210 RTC_DCHECK(config_.renderer);
Stefan Holmer58c664c2016-02-08 14:31:30 +0100211 RTC_DCHECK(process_thread_);
Stefan Holmer58c664c2016-02-08 14:31:30 +0100212 RTC_DCHECK(call_stats_);
mflodmancfc8e3b2016-05-03 21:22:04 -0700213
eladalona28122f2017-08-18 04:02:48 -0700214 module_process_sequence_checker_.Detach();
Ruslan Burakov493a6502019-02-27 15:32:48 +0100215 network_sequence_checker_.Detach();
solenberg3ebbcb52017-01-31 03:58:40 -0800216
henrikg91d6ede2015-09-17 00:24:34 -0700217 RTC_DCHECK(!config_.decoders.empty());
Peter Boström521af4e2015-11-27 16:35:04 +0100218 std::set<int> decoder_payload_types;
Peter Boströmb1ae3a42016-02-15 17:52:40 +0100219 for (const Decoder& decoder : config_.decoders) {
Niels Möllercbcbc222018-09-28 09:07:24 +0200220 RTC_CHECK(decoder.decoder_factory);
Peter Boström521af4e2015-11-27 16:35:04 +0100221 RTC_CHECK(decoder_payload_types.find(decoder.payload_type) ==
222 decoder_payload_types.end())
223 << "Duplicate payload type (" << decoder.payload_type
224 << ") for different decoders.";
225 decoder_payload_types.insert(decoder.payload_type);
pbos@webrtc.org0181b5f2013-09-09 08:26:30 +0000226 }
227
nisseca5706d2017-09-11 02:32:16 -0700228 video_receiver_.SetRenderDelay(config_.render_delay_ms);
Peter Boström1d04ac62016-02-05 11:25:46 +0100229
philipela45102f2017-02-22 05:30:39 -0800230 jitter_estimator_.reset(new VCMJitterEstimator(clock_));
231 frame_buffer_.reset(new video_coding::FrameBuffer(
232 clock_, jitter_estimator_.get(), timing_.get(), &stats_proxy_));
philipelfd5a20f2016-11-15 00:57:57 -0800233
tommidea489f2017-03-03 03:20:24 -0800234 process_thread_->RegisterModule(&rtp_stream_sync_, RTC_FROM_HERE);
nisse0f15f922017-06-21 01:05:22 -0700235
Niels Möller46879152019-01-07 15:54:47 +0100236 if (config_.media_transport) {
237 config_.media_transport->SetReceiveVideoSink(this);
238 config_.media_transport->AddRttObserver(this);
Niels Möller5304a322018-08-27 13:27:05 +0200239 } else {
Niels Möller46879152019-01-07 15:54:47 +0100240 // Register with RtpStreamReceiverController.
241 media_receiver_ = receiver_controller->CreateReceiver(
242 config_.rtp.remote_ssrc, &rtp_video_stream_receiver_);
243 if (config_.rtp.rtx_ssrc) {
244 rtx_receive_stream_ = absl::make_unique<RtxReceiveStream>(
245 &rtp_video_stream_receiver_, config.rtp.rtx_associated_payload_types,
246 config_.rtp.remote_ssrc, rtp_receive_statistics_.get());
247 rtx_receiver_ = receiver_controller->CreateReceiver(
248 config_.rtp.rtx_ssrc, rtx_receive_stream_.get());
249 } else {
250 rtp_receive_statistics_->EnableRetransmitDetection(config.rtp.remote_ssrc,
251 true);
252 }
nisse0f15f922017-06-21 01:05:22 -0700253 }
pbos@webrtc.org29d58392013-05-16 12:08:03 +0000254}
255
Ruslan Burakov493a6502019-02-27 15:32:48 +0100256VideoReceiveStream::VideoReceiveStream(
Sebastian Jansson74682c12019-03-01 11:50:20 +0100257 TaskQueueFactory* task_queue_factory,
Ruslan Burakov493a6502019-02-27 15:32:48 +0100258 RtpStreamReceiverControllerInterface* receiver_controller,
259 int num_cpu_cores,
260 PacketRouter* packet_router,
261 VideoReceiveStream::Config config,
262 ProcessThread* process_thread,
Sebastian Jansson8026d602019-03-04 19:39:01 +0100263 CallStats* call_stats,
264 Clock* clock)
Sebastian Jansson74682c12019-03-01 11:50:20 +0100265 : VideoReceiveStream(task_queue_factory,
266 receiver_controller,
Ruslan Burakov493a6502019-02-27 15:32:48 +0100267 num_cpu_cores,
268 packet_router,
269 std::move(config),
270 process_thread,
271 call_stats,
Sebastian Jansson8026d602019-03-04 19:39:01 +0100272 clock,
273 new VCMTiming(clock)) {}
Ruslan Burakov493a6502019-02-27 15:32:48 +0100274
pbos@webrtc.org29d58392013-05-16 12:08:03 +0000275VideoReceiveStream::~VideoReceiveStream() {
eladalona28122f2017-08-18 04:02:48 -0700276 RTC_DCHECK_CALLED_SEQUENTIALLY(&worker_sequence_checker_);
Mirko Bonadei675513b2017-11-09 11:09:25 +0100277 RTC_LOG(LS_INFO) << "~VideoReceiveStream: " << config_.ToString();
Peter Boströmca835252016-02-11 15:59:46 +0100278 Stop();
Niels Möller46879152019-01-07 15:54:47 +0100279 if (config_.media_transport) {
280 config_.media_transport->SetReceiveVideoSink(nullptr);
281 config_.media_transport->RemoveRttObserver(this);
282 }
mflodman4cd27902016-08-05 06:28:45 -0700283 process_thread_->DeRegisterModule(&rtp_stream_sync_);
pbos@webrtc.org29d58392013-05-16 12:08:03 +0000284}
285
pbos1ba8d392016-05-01 20:18:34 -0700286void VideoReceiveStream::SignalNetworkState(NetworkState state) {
eladalona28122f2017-08-18 04:02:48 -0700287 RTC_DCHECK_CALLED_SEQUENTIALLY(&worker_sequence_checker_);
nisseb1f2ff92017-06-09 04:01:55 -0700288 rtp_video_stream_receiver_.SignalNetworkState(state);
pbos1ba8d392016-05-01 20:18:34 -0700289}
290
pbos1ba8d392016-05-01 20:18:34 -0700291bool VideoReceiveStream::DeliverRtcp(const uint8_t* packet, size_t length) {
nisseb1f2ff92017-06-09 04:01:55 -0700292 return rtp_video_stream_receiver_.DeliverRtcp(packet, length);
pbos1ba8d392016-05-01 20:18:34 -0700293}
294
solenberg3ebbcb52017-01-31 03:58:40 -0800295void VideoReceiveStream::SetSync(Syncable* audio_syncable) {
eladalona28122f2017-08-18 04:02:48 -0700296 RTC_DCHECK_CALLED_SEQUENTIALLY(&worker_sequence_checker_);
solenberg3ebbcb52017-01-31 03:58:40 -0800297 rtp_stream_sync_.ConfigureSync(audio_syncable);
brandtr090c9402017-01-25 08:28:02 -0800298}
299
pbos@webrtc.orga5c8d2c2014-04-24 11:13:21 +0000300void VideoReceiveStream::Start() {
eladalona28122f2017-08-18 04:02:48 -0700301 RTC_DCHECK_CALLED_SEQUENTIALLY(&worker_sequence_checker_);
brandtrfb45c6c2017-01-27 06:47:55 -0800302
Rasmus Brandt1e27fec2019-01-23 09:47:50 +0100303 if (decode_thread_.IsRunning()) {
304 return;
305 }
306
307 const bool protected_by_fec = config_.rtp.protected_by_flexfec ||
308 rtp_video_stream_receiver_.IsUlpfecEnabled();
brandtrfb45c6c2017-01-27 06:47:55 -0800309
philipela45102f2017-02-22 05:30:39 -0800310 frame_buffer_->Start();
philipelfd5a20f2016-11-15 00:57:57 -0800311
nisseb1f2ff92017-06-09 04:01:55 -0700312 if (rtp_video_stream_receiver_.IsRetransmissionsEnabled() &&
313 protected_by_fec) {
philipela45102f2017-02-22 05:30:39 -0800314 frame_buffer_->SetProtectionMode(kProtectionNackFEC);
philipelfd5a20f2016-11-15 00:57:57 -0800315 }
philipela45102f2017-02-22 05:30:39 -0800316
sprang@webrtc.orgd9b95602014-01-27 13:03:02 +0000317 transport_adapter_.Enable();
tommi2e82f382016-06-21 00:26:43 -0700318 rtc::VideoSinkInterface<VideoFrame>* renderer = nullptr;
Rasmus Brandt1e27fec2019-01-23 09:47:50 +0100319 if (config_.enable_prerenderer_smoothing) {
Sebastian Jansson74682c12019-03-01 11:50:20 +0100320 incoming_video_stream_.reset(new IncomingVideoStream(
321 task_queue_factory_, config_.render_delay_ms, this));
Rasmus Brandt1e27fec2019-01-23 09:47:50 +0100322 renderer = incoming_video_stream_.get();
323 } else {
324 renderer = this;
tommi2e82f382016-06-21 00:26:43 -0700325 }
326
sprang113bdca2016-10-11 03:10:10 -0700327 for (const Decoder& decoder : config_.decoders) {
Niels Möllercbcbc222018-09-28 09:07:24 +0200328 std::unique_ptr<VideoDecoder> video_decoder =
329 decoder.decoder_factory->LegacyCreateVideoDecoder(decoder.video_format,
330 config_.stream_id);
331 // If we still have no valid decoder, we have to create a "Null" decoder
332 // that ignores all calls. The reason we can get into this state is that the
333 // old decoder factory interface doesn't have a way to query supported
334 // codecs.
335 if (!video_decoder) {
336 video_decoder = absl::make_unique<NullVideoDecoder>();
337 }
Erik Språng96965ae2018-10-23 15:42:37 +0200338
339 std::string decoded_output_file =
340 field_trial::FindFullName("WebRTC-DecoderDataDumpDirectory");
Ilya Nikolaevskiyc0321092019-03-11 11:18:26 +0100341 // Because '/' can't be used inside a field trial parameter, we use ':'
342 // instead.
343 std::replace(decoded_output_file.begin(), decoded_output_file.end(), ':',
344 '/');
Erik Språng96965ae2018-10-23 15:42:37 +0200345 if (!decoded_output_file.empty()) {
346 char filename_buffer[256];
347 rtc::SimpleStringBuilder ssb(filename_buffer);
348 ssb << decoded_output_file << "/webrtc_receive_stream_"
Ilya Nikolaevskiyc0321092019-03-11 11:18:26 +0100349 << this->config_.rtp.remote_ssrc << "-" << rtc::TimeMicros()
350 << ".ivf";
Erik Språng96965ae2018-10-23 15:42:37 +0200351 video_decoder = absl::make_unique<FrameDumpingDecoder>(
Niels Möllerb7edf692019-02-08 16:40:53 +0100352 std::move(video_decoder), FileWrapper::OpenWriteOnly(ssb.str()));
Erik Språng96965ae2018-10-23 15:42:37 +0200353 }
354
Niels Möllercbcbc222018-09-28 09:07:24 +0200355 video_decoders_.push_back(std::move(video_decoder));
356
357 video_receiver_.RegisterExternalDecoder(video_decoders_.back().get(),
sprang113bdca2016-10-11 03:10:10 -0700358 decoder.payload_type);
sprang113bdca2016-10-11 03:10:10 -0700359 VideoCodec codec = CreateDecoderVideoCodec(decoder);
Niels Möllercb7e1d22018-09-11 15:56:04 +0200360 rtp_video_stream_receiver_.AddReceiveCodec(codec,
361 decoder.video_format.parameters);
sprang113bdca2016-10-11 03:10:10 -0700362 RTC_CHECK_EQ(VCM_OK, video_receiver_.RegisterReceiveCodec(
363 &codec, num_cpu_cores_, false));
364 }
365
Rasmus Brandt1e27fec2019-01-23 09:47:50 +0100366 RTC_DCHECK(renderer != nullptr);
tommi2e82f382016-06-21 00:26:43 -0700367 video_stream_decoder_.reset(new VideoStreamDecoder(
nisseb1f2ff92017-06-09 04:01:55 -0700368 &video_receiver_, &rtp_video_stream_receiver_,
369 &rtp_video_stream_receiver_,
370 rtp_video_stream_receiver_.IsRetransmissionsEnabled(), protected_by_fec,
nisse76bc8e82017-02-07 09:37:41 -0800371 &stats_proxy_, renderer));
tommic8ece432017-06-20 02:44:38 -0700372
Tommief3e28a2018-03-30 08:42:39 +0200373 // Make sure we register as a stats observer *after* we've prepared the
374 // |video_stream_decoder_|.
375 call_stats_->RegisterStatsObserver(this);
376
tommic8ece432017-06-20 02:44:38 -0700377 process_thread_->RegisterModule(&video_receiver_, RTC_FROM_HERE);
378
Peter Boströmca835252016-02-11 15:59:46 +0100379 // Start the decode thread
Tommifbf3bce2018-02-21 15:56:05 +0100380 video_receiver_.DecoderThreadStarting();
Tommi132e28e2018-02-24 17:57:33 +0100381 stats_proxy_.DecoderThreadStarting();
Peter Boströmca835252016-02-11 15:59:46 +0100382 decode_thread_.Start();
nisseb1f2ff92017-06-09 04:01:55 -0700383 rtp_video_stream_receiver_.StartReceive();
pbos@webrtc.org29d58392013-05-16 12:08:03 +0000384}
385
pbos@webrtc.orga5c8d2c2014-04-24 11:13:21 +0000386void VideoReceiveStream::Stop() {
eladalona28122f2017-08-18 04:02:48 -0700387 RTC_DCHECK_CALLED_SEQUENTIALLY(&worker_sequence_checker_);
nisseb1f2ff92017-06-09 04:01:55 -0700388 rtp_video_stream_receiver_.StopReceive();
philipelfd5a20f2016-11-15 00:57:57 -0800389
Ilya Nikolaevskiyd397a0d2018-02-21 15:57:09 +0100390 stats_proxy_.OnUniqueFramesCounted(
391 rtp_video_stream_receiver_.GetUniqueFramesSeen());
392
philipela45102f2017-02-22 05:30:39 -0800393 frame_buffer_->Stop();
philipele21be1d2017-09-25 06:37:12 -0700394 call_stats_->DeregisterStatsObserver(this);
tommic8ece432017-06-20 02:44:38 -0700395 process_thread_->DeRegisterModule(&video_receiver_);
philipelfd5a20f2016-11-15 00:57:57 -0800396
sprang0d348d62016-10-07 08:28:39 -0700397 if (decode_thread_.IsRunning()) {
tommic8ece432017-06-20 02:44:38 -0700398 // TriggerDecoderShutdown will release any waiting decoder thread and make
399 // it stop immediately, instead of waiting for a timeout. Needs to be called
400 // before joining the decoder thread.
401 video_receiver_.TriggerDecoderShutdown();
402
sprang0d348d62016-10-07 08:28:39 -0700403 decode_thread_.Stop();
Tommifbf3bce2018-02-21 15:56:05 +0100404 video_receiver_.DecoderThreadStopped();
Tommi132e28e2018-02-24 17:57:33 +0100405 stats_proxy_.DecoderThreadStopped();
sprang0d348d62016-10-07 08:28:39 -0700406 // Deregister external decoders so they are no longer running during
407 // destruction. This effectively stops the VCM since the decoder thread is
408 // stopped, the VCM is deregistered and no asynchronous decoder threads are
409 // running.
410 for (const Decoder& decoder : config_.decoders)
411 video_receiver_.RegisterExternalDecoder(nullptr, decoder.payload_type);
412 }
philipelfd5a20f2016-11-15 00:57:57 -0800413
tommi2e82f382016-06-21 00:26:43 -0700414 video_stream_decoder_.reset();
415 incoming_video_stream_.reset();
sprang@webrtc.orgd9b95602014-01-27 13:03:02 +0000416 transport_adapter_.Disable();
pbos@webrtc.org29d58392013-05-16 12:08:03 +0000417}
418
sprang@webrtc.org9510e532014-02-07 15:32:45 +0000419VideoReceiveStream::Stats VideoReceiveStream::GetStats() const {
Peter Boströmf751bf82016-02-05 14:00:53 +0100420 return stats_proxy_.GetStats();
sprang@webrtc.org09315702014-02-07 12:06:29 +0000421}
422
eladalonc0d481a2017-08-02 07:39:07 -0700423void VideoReceiveStream::AddSecondarySink(RtpPacketSinkInterface* sink) {
424 rtp_video_stream_receiver_.AddSecondarySink(sink);
425}
426
427void VideoReceiveStream::RemoveSecondarySink(
428 const RtpPacketSinkInterface* sink) {
429 rtp_video_stream_receiver_.RemoveSecondarySink(sink);
430}
431
Ruslan Burakov493a6502019-02-27 15:32:48 +0100432bool VideoReceiveStream::SetBaseMinimumPlayoutDelayMs(int delay_ms) {
433 RTC_DCHECK_CALLED_SEQUENTIALLY(&worker_sequence_checker_);
434 if (delay_ms < kMinBaseMinimumDelayMs || delay_ms > kMaxBaseMinimumDelayMs) {
435 return false;
436 }
437
438 rtc::CritScope cs(&playout_delay_lock_);
439 base_minimum_playout_delay_ms_ = delay_ms;
440 UpdatePlayoutDelays();
441 return true;
442}
443
444int VideoReceiveStream::GetBaseMinimumPlayoutDelayMs() const {
445 RTC_DCHECK_CALLED_SEQUENTIALLY(&worker_sequence_checker_);
446
447 rtc::CritScope cs(&playout_delay_lock_);
448 return base_minimum_playout_delay_ms_;
449}
450
tommi2e82f382016-06-21 00:26:43 -0700451// TODO(tommi): This method grabs a lock 6 times.
Tommibd3380f2016-06-10 17:38:17 +0200452void VideoReceiveStream::OnFrame(const VideoFrame& video_frame) {
asaperssonf8cdd182016-03-15 01:00:47 -0700453 int64_t sync_offset_ms;
asaperssonde9e5ff2016-11-02 07:14:03 -0700454 double estimated_freq_khz;
tommi2e82f382016-06-21 00:26:43 -0700455 // TODO(tommi): GetStreamSyncOffsetInMs grabs three locks. One inside the
456 // function itself, another in GetChannel() and a third in
457 // GetPlayoutTimestamp. Seems excessive. Anyhow, I'm assuming the function
458 // succeeds most of the time, which leads to grabbing a fourth lock.
Yves Gerey665174f2018-06-19 15:03:05 +0200459 if (rtp_stream_sync_.GetStreamSyncOffsetInMs(
460 video_frame.timestamp(), video_frame.render_time_ms(),
461 &sync_offset_ms, &estimated_freq_khz)) {
tommi2e82f382016-06-21 00:26:43 -0700462 // TODO(tommi): OnSyncOffsetUpdated grabs a lock.
asaperssonde9e5ff2016-11-02 07:14:03 -0700463 stats_proxy_.OnSyncOffsetUpdated(sync_offset_ms, estimated_freq_khz);
tommi2e82f382016-06-21 00:26:43 -0700464 }
tommi2e82f382016-06-21 00:26:43 -0700465 config_.renderer->OnFrame(video_frame);
pbos@webrtc.org29d58392013-05-16 12:08:03 +0000466
tommi2e82f382016-06-21 00:26:43 -0700467 // TODO(tommi): OnRenderFrame grabs a lock too.
asapersson1490f7a2016-09-23 02:09:46 -0700468 stats_proxy_.OnRenderedFrame(video_frame);
pbos@webrtc.org29d58392013-05-16 12:08:03 +0000469}
pbos@webrtc.org26c0c412014-09-03 16:17:12 +0000470
brandtr090c9402017-01-25 08:28:02 -0800471void VideoReceiveStream::SendNack(
472 const std::vector<uint16_t>& sequence_numbers) {
nisseb1f2ff92017-06-09 04:01:55 -0700473 rtp_video_stream_receiver_.RequestPacketRetransmit(sequence_numbers);
brandtr090c9402017-01-25 08:28:02 -0800474}
475
476void VideoReceiveStream::RequestKeyFrame() {
Niels Möller46879152019-01-07 15:54:47 +0100477 if (config_.media_transport) {
478 config_.media_transport->RequestKeyFrame(config_.rtp.remote_ssrc);
479 } else {
480 rtp_video_stream_receiver_.RequestKeyFrame();
481 }
brandtr090c9402017-01-25 08:28:02 -0800482}
483
484void VideoReceiveStream::OnCompleteFrame(
philipele7c891f2018-02-22 14:35:06 +0100485 std::unique_ptr<video_coding::EncodedFrame> frame) {
Ruslan Burakov493a6502019-02-27 15:32:48 +0100486 RTC_DCHECK_CALLED_SEQUENTIALLY(&network_sequence_checker_);
Ilya Nikolaevskiye6a2d942018-11-07 14:32:28 +0100487 // TODO(https://bugs.webrtc.org/9974): Consider removing this workaround.
488 int64_t time_now_ms = rtc::TimeMillis();
489 if (last_complete_frame_time_ms_ > 0 &&
490 time_now_ms - last_complete_frame_time_ms_ > kInactiveStreamThresholdMs) {
491 frame_buffer_->Clear();
492 }
493 last_complete_frame_time_ms_ = time_now_ms;
494
Ruslan Burakov493a6502019-02-27 15:32:48 +0100495 const PlayoutDelay& playout_delay = frame->EncodedImage().playout_delay_;
496 if (playout_delay.min_ms >= 0) {
497 rtc::CritScope cs(&playout_delay_lock_);
498 frame_minimum_playout_delay_ms_ = playout_delay.min_ms;
499 UpdatePlayoutDelays();
500 }
501
502 if (playout_delay.max_ms >= 0) {
503 rtc::CritScope cs(&playout_delay_lock_);
504 frame_maximum_playout_delay_ms_ = playout_delay.max_ms;
505 UpdatePlayoutDelays();
506 }
507
philipel1610f942017-12-12 13:58:31 +0100508 int64_t last_continuous_pid = frame_buffer_->InsertFrame(std::move(frame));
brandtr090c9402017-01-25 08:28:02 -0800509 if (last_continuous_pid != -1)
nisseb1f2ff92017-06-09 04:01:55 -0700510 rtp_video_stream_receiver_.FrameContinuous(last_continuous_pid);
brandtr090c9402017-01-25 08:28:02 -0800511}
512
Niels Möller46879152019-01-07 15:54:47 +0100513void VideoReceiveStream::OnData(uint64_t channel_id,
514 MediaTransportEncodedVideoFrame frame) {
515 OnCompleteFrame(
516 absl::make_unique<EncodedFrameForMediaTransport>(std::move(frame)));
517}
518
philipele21be1d2017-09-25 06:37:12 -0700519void VideoReceiveStream::OnRttUpdate(int64_t avg_rtt_ms, int64_t max_rtt_ms) {
Tommi81de14f2018-03-25 22:19:25 +0200520 RTC_DCHECK_CALLED_SEQUENTIALLY(&module_process_sequence_checker_);
philipele21be1d2017-09-25 06:37:12 -0700521 frame_buffer_->UpdateRtt(max_rtt_ms);
Tommi81de14f2018-03-25 22:19:25 +0200522 rtp_video_stream_receiver_.UpdateRtt(max_rtt_ms);
philipele21be1d2017-09-25 06:37:12 -0700523}
524
Niels Möller46879152019-01-07 15:54:47 +0100525void VideoReceiveStream::OnRttUpdated(int64_t rtt_ms) {
526 frame_buffer_->UpdateRtt(rtt_ms);
527}
528
solenberg3ebbcb52017-01-31 03:58:40 -0800529int VideoReceiveStream::id() const {
eladalona28122f2017-08-18 04:02:48 -0700530 RTC_DCHECK_CALLED_SEQUENTIALLY(&worker_sequence_checker_);
solenberg3ebbcb52017-01-31 03:58:40 -0800531 return config_.rtp.remote_ssrc;
532}
533
Danil Chapovalovb9b146c2018-06-15 12:28:07 +0200534absl::optional<Syncable::Info> VideoReceiveStream::GetInfo() const {
eladalona28122f2017-08-18 04:02:48 -0700535 RTC_DCHECK_CALLED_SEQUENTIALLY(&module_process_sequence_checker_);
Niels Möllerdf9e9ae2018-07-31 08:29:53 +0200536 absl::optional<Syncable::Info> info =
537 rtp_video_stream_receiver_.GetSyncInfo();
solenberg3ebbcb52017-01-31 03:58:40 -0800538
Niels Möllerdf9e9ae2018-07-31 08:29:53 +0200539 if (!info)
Danil Chapovalovb9b146c2018-06-15 12:28:07 +0200540 return absl::nullopt;
solenberg3ebbcb52017-01-31 03:58:40 -0800541
Niels Möllerdf9e9ae2018-07-31 08:29:53 +0200542 info->current_delay_ms = video_receiver_.Delay();
Oskar Sundbom8e07c132018-01-08 16:45:42 +0100543 return info;
solenberg3ebbcb52017-01-31 03:58:40 -0800544}
545
546uint32_t VideoReceiveStream::GetPlayoutTimestamp() const {
547 RTC_NOTREACHED();
548 return 0;
549}
550
551void VideoReceiveStream::SetMinimumPlayoutDelay(int delay_ms) {
eladalona28122f2017-08-18 04:02:48 -0700552 RTC_DCHECK_CALLED_SEQUENTIALLY(&module_process_sequence_checker_);
Ruslan Burakov493a6502019-02-27 15:32:48 +0100553 rtc::CritScope cs(&playout_delay_lock_);
554 syncable_minimum_playout_delay_ms_ = delay_ms;
555 UpdatePlayoutDelays();
solenberg3ebbcb52017-01-31 03:58:40 -0800556}
557
tommic8ece432017-06-20 02:44:38 -0700558void VideoReceiveStream::DecodeThreadFunction(void* ptr) {
559 while (static_cast<VideoReceiveStream*>(ptr)->Decode()) {
560 }
Peter Boströmca835252016-02-11 15:59:46 +0100561}
562
philipel2dfea3e2017-02-28 07:19:43 -0800563bool VideoReceiveStream::Decode() {
tommidb23ea62017-03-03 07:21:18 -0800564 TRACE_EVENT0("webrtc", "VideoReceiveStream::Decode");
philipela45102f2017-02-22 05:30:39 -0800565 static const int kMaxWaitForFrameMs = 3000;
philipel3042c2d2017-08-18 04:55:02 -0700566 static const int kMaxWaitForKeyFrameMs = 200;
567
568 int wait_ms = keyframe_required_ ? kMaxWaitForKeyFrameMs : kMaxWaitForFrameMs;
philipele7c891f2018-02-22 14:35:06 +0100569 std::unique_ptr<video_coding::EncodedFrame> frame;
philipel3042c2d2017-08-18 04:55:02 -0700570 // TODO(philipel): Call NextFrame with |keyframe_required| argument when
571 // downstream project has been fixed.
guidouc3372582017-04-04 07:16:21 -0700572 video_coding::FrameBuffer::ReturnReason res =
philipel3042c2d2017-08-18 04:55:02 -0700573 frame_buffer_->NextFrame(wait_ms, &frame);
philipelfd5a20f2016-11-15 00:57:57 -0800574
guidouc3372582017-04-04 07:16:21 -0700575 if (res == video_coding::FrameBuffer::ReturnReason::kStopped) {
philipel2dfea3e2017-02-28 07:19:43 -0800576 return false;
guidouc3372582017-04-04 07:16:21 -0700577 }
philipelfd5a20f2016-11-15 00:57:57 -0800578
philipela45102f2017-02-22 05:30:39 -0800579 if (frame) {
philipel48462b62017-09-26 02:54:58 -0700580 int64_t now_ms = clock_->TimeInMilliseconds();
tommic8ece432017-06-20 02:44:38 -0700581 RTC_DCHECK_EQ(res, video_coding::FrameBuffer::ReturnReason::kFrameFound);
Niels Möller147013a2018-10-01 15:56:33 +0200582
583 // Current OnPreDecode only cares about QP for VP8.
584 int qp = -1;
585 if (frame->CodecSpecific()->codecType == kVideoCodecVP8) {
Niels Möller9c843902019-01-11 10:21:35 +0100586 if (!vp8::GetQp(frame->data(), frame->size(), &qp)) {
Niels Möller147013a2018-10-01 15:56:33 +0200587 RTC_LOG(LS_WARNING) << "Failed to extract QP from VP8 video frame";
588 }
589 }
590 stats_proxy_.OnPreDecode(frame->CodecSpecific()->codecType, qp);
591
philipel49b46e02017-12-11 14:52:58 +0100592 int decode_result = video_receiver_.Decode(frame.get());
593 if (decode_result == WEBRTC_VIDEO_CODEC_OK ||
594 decode_result == WEBRTC_VIDEO_CODEC_OK_REQUEST_KEYFRAME) {
philipel3042c2d2017-08-18 04:55:02 -0700595 keyframe_required_ = false;
596 frame_decoded_ = true;
philipel0fa82a62018-03-19 15:34:53 +0100597 rtp_video_stream_receiver_.FrameDecoded(frame->id.picture_id);
philipel49b46e02017-12-11 14:52:58 +0100598
599 if (decode_result == WEBRTC_VIDEO_CODEC_OK_REQUEST_KEYFRAME)
600 RequestKeyFrame();
philipel48462b62017-09-26 02:54:58 -0700601 } else if (!frame_decoded_ || !keyframe_required_ ||
602 (last_keyframe_request_ms_ + kMaxWaitForKeyFrameMs < now_ms)) {
philipel3042c2d2017-08-18 04:55:02 -0700603 keyframe_required_ = true;
604 // TODO(philipel): Remove this keyframe request when downstream project
605 // has been fixed.
606 RequestKeyFrame();
philipel48462b62017-09-26 02:54:58 -0700607 last_keyframe_request_ms_ = now_ms;
philipel3042c2d2017-08-18 04:55:02 -0700608 }
philipelfd5a20f2016-11-15 00:57:57 -0800609 } else {
tommic8ece432017-06-20 02:44:38 -0700610 RTC_DCHECK_EQ(res, video_coding::FrameBuffer::ReturnReason::kTimeout);
philipel3184f8e2017-05-18 08:08:53 -0700611 int64_t now_ms = clock_->TimeInMilliseconds();
Danil Chapovalovb9b146c2018-06-15 12:28:07 +0200612 absl::optional<int64_t> last_packet_ms =
nisseb1f2ff92017-06-09 04:01:55 -0700613 rtp_video_stream_receiver_.LastReceivedPacketMs();
Danil Chapovalovb9b146c2018-06-15 12:28:07 +0200614 absl::optional<int64_t> last_keyframe_packet_ms =
nisseb1f2ff92017-06-09 04:01:55 -0700615 rtp_video_stream_receiver_.LastReceivedKeyframePacketMs();
philipel3184f8e2017-05-18 08:08:53 -0700616
617 // To avoid spamming keyframe requests for a stream that is not active we
618 // check if we have received a packet within the last 5 seconds.
619 bool stream_is_active = last_packet_ms && now_ms - *last_packet_ms < 5000;
sprang3e86e7e2017-08-22 09:23:28 -0700620 if (!stream_is_active)
621 stats_proxy_.OnStreamInactive();
philipel3184f8e2017-05-18 08:08:53 -0700622
philipel3042c2d2017-08-18 04:55:02 -0700623 // If we recently have been receiving packets belonging to a keyframe then
624 // we assume a keyframe is currently being received.
philipel3184f8e2017-05-18 08:08:53 -0700625 bool receiving_keyframe =
626 last_keyframe_packet_ms &&
philipel3042c2d2017-08-18 04:55:02 -0700627 now_ms - *last_keyframe_packet_ms < kMaxWaitForKeyFrameMs;
philipel3184f8e2017-05-18 08:08:53 -0700628
Benjamin Wright52426ed2019-03-01 11:01:59 -0800629 if (stream_is_active && !receiving_keyframe &&
630 (!config_.crypto_options.sframe.require_frame_encryption ||
631 rtp_video_stream_receiver_.IsDecryptable())) {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100632 RTC_LOG(LS_WARNING) << "No decodable frame in " << wait_ms
633 << " ms, requesting keyframe.";
philipel3184f8e2017-05-18 08:08:53 -0700634 RequestKeyFrame();
635 }
philipelfd5a20f2016-11-15 00:57:57 -0800636 }
philipel2dfea3e2017-02-28 07:19:43 -0800637 return true;
Peter Boströmca835252016-02-11 15:59:46 +0100638}
Jonas Oreland49ac5952018-09-26 16:04:32 +0200639
Ruslan Burakov493a6502019-02-27 15:32:48 +0100640void VideoReceiveStream::UpdatePlayoutDelays() const {
641 const int minimum_delay_ms =
642 std::max({frame_minimum_playout_delay_ms_, base_minimum_playout_delay_ms_,
643 syncable_minimum_playout_delay_ms_});
644 if (minimum_delay_ms >= 0) {
645 timing_->set_min_playout_delay(minimum_delay_ms);
646 }
647
648 const int maximum_delay_ms = frame_maximum_playout_delay_ms_;
649 if (maximum_delay_ms >= 0) {
650 timing_->set_max_playout_delay(maximum_delay_ms);
651 }
652}
653
Jonas Oreland49ac5952018-09-26 16:04:32 +0200654std::vector<webrtc::RtpSource> VideoReceiveStream::GetSources() const {
655 return rtp_video_stream_receiver_.GetSources();
656}
657
mflodman@webrtc.orgf3973e82013-12-13 09:40:45 +0000658} // namespace internal
659} // namespace webrtc