blob: 8b680aeb1eda8789fc6456d403f612dff9cbd7de [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
mflodman@webrtc.orgf3973e82013-12-13 09:40:45 +000011#ifndef WEBRTC_VIDEO_VIDEO_RECEIVE_STREAM_H_
12#define WEBRTC_VIDEO_VIDEO_RECEIVE_STREAM_H_
pbos@webrtc.org29d58392013-05-16 12:08:03 +000013
kwiberg27f982b2016-03-01 11:52:33 -080014#include <memory>
pbos@webrtc.org29d58392013-05-16 12:08:03 +000015#include <vector>
16
nissed76b7b22017-06-01 04:02:35 -070017#include "webrtc/call/rtp_packet_sink_interface.h"
solenberg3ebbcb52017-01-31 03:58:40 -080018#include "webrtc/call/syncable.h"
aleloi440b6d92017-08-22 05:43:23 -070019#include "webrtc/call/video_receive_stream.h"
kjellander6f8ce062015-11-16 13:52:24 -080020#include "webrtc/common_video/include/incoming_video_stream.h"
pbos@webrtc.org29d58392013-05-16 12:08:03 +000021#include "webrtc/common_video/libyuv/include/webrtc_libyuv.h"
brandtr4e523862016-10-18 23:50:45 -070022#include "webrtc/modules/rtp_rtcp/include/flexfec_receiver.h"
philipelfd5a20f2016-11-15 00:57:57 -080023#include "webrtc/modules/video_coding/frame_buffer2.h"
Peter Boström0b250722016-04-22 18:23:15 +020024#include "webrtc/modules/video_coding/video_coding_impl.h"
eladalona28122f2017-08-18 04:02:48 -070025#include "webrtc/rtc_base/sequenced_task_checker.h"
Henrik Kjellander98f53512015-10-28 18:17:40 +010026#include "webrtc/system_wrappers/include/clock.h"
sprang@webrtc.org09315702014-02-07 12:06:29 +000027#include "webrtc/video/receive_statistics_proxy.h"
mflodman4cd27902016-08-05 06:28:45 -070028#include "webrtc/video/rtp_streams_synchronizer.h"
nisseb1f2ff92017-06-09 04:01:55 -070029#include "webrtc/video/rtp_video_stream_receiver.h"
charujainbf6a45b2016-11-03 04:21:42 -070030#include "webrtc/video/transport_adapter.h"
mflodmancfc8e3b2016-05-03 21:22:04 -070031#include "webrtc/video/video_stream_decoder.h"
pbos@webrtc.org29d58392013-05-16 12:08:03 +000032
33namespace webrtc {
34
mflodmane3787022015-10-21 13:24:28 +020035class CallStats;
sprang3911c262016-04-15 01:24:14 -070036class IvfFileWriter;
Peter Boströmd1d66ba2016-02-08 14:07:14 +010037class ProcessThread;
mflodman4cd27902016-08-05 06:28:45 -070038class RTPFragmentationHeader;
nisse0f15f922017-06-21 01:05:22 -070039class RtpStreamReceiverInterface;
40class RtpStreamReceiverControllerInterface;
nisseca5706d2017-09-11 02:32:16 -070041class RtxReceiveStream;
philipelfd5a20f2016-11-15 00:57:57 -080042class VCMTiming;
43class VCMJitterEstimator;
pbos@webrtc.org29d58392013-05-16 12:08:03 +000044
45namespace internal {
46
pbos@webrtc.org74fa4892013-08-23 09:19:30 +000047class VideoReceiveStream : public webrtc::VideoReceiveStream,
nisse30f118e2016-05-03 01:09:11 -070048 public rtc::VideoSinkInterface<VideoFrame>,
philipel83f831a2016-03-12 03:30:23 -080049 public EncodedImageCallback,
50 public NackSender,
philipelfd5a20f2016-11-15 00:57:57 -080051 public KeyFrameRequestSender,
solenberg3ebbcb52017-01-31 03:58:40 -080052 public video_coding::OnCompleteFrameCallback,
philipelbdbc8892017-08-22 02:08:51 -070053 public Syncable {
pbos@webrtc.org29d58392013-05-16 12:08:03 +000054 public:
nisse0f15f922017-06-21 01:05:22 -070055 VideoReceiveStream(RtpStreamReceiverControllerInterface* receiver_controller,
56 int num_cpu_cores,
nisse0245da02016-11-30 03:35:20 -080057 PacketRouter* packet_router,
Tommi733b5472016-06-10 17:58:01 +020058 VideoReceiveStream::Config config,
mflodmane3787022015-10-21 13:24:28 +020059 ProcessThread* process_thread,
nisse05843312017-04-18 23:38:35 -070060 CallStats* call_stats);
Jelena Marusiccd670222015-07-16 09:30:09 +020061 ~VideoReceiveStream() override;
pbos@webrtc.org29d58392013-05-16 12:08:03 +000062
brandtr090c9402017-01-25 08:28:02 -080063 const Config& config() const { return config_; }
64
pbos1ba8d392016-05-01 20:18:34 -070065 void SignalNetworkState(NetworkState state);
66 bool DeliverRtcp(const uint8_t* packet, size_t length);
Jelena Marusiccd670222015-07-16 09:30:09 +020067
solenberg3ebbcb52017-01-31 03:58:40 -080068 void SetSync(Syncable* audio_syncable);
brandtr090c9402017-01-25 08:28:02 -080069
70 // Implements webrtc::VideoReceiveStream.
pbos1ba8d392016-05-01 20:18:34 -070071 void Start() override;
72 void Stop() override;
73
Jelena Marusiccd670222015-07-16 09:30:09 +020074 webrtc::VideoReceiveStream::Stats GetStats() const override;
pbos@webrtc.org29d58392013-05-16 12:08:03 +000075
palmkviste75f2042016-09-28 06:19:48 -070076 // Takes ownership of the file, is responsible for closing it later.
77 // Calling this method will close and finalize any current log.
78 // Giving rtc::kInvalidPlatformFileValue disables logging.
79 // If a frame to be written would make the log too large the write fails and
80 // the log is closed and finalized. A |byte_limit| of 0 means no limit.
81 void EnableEncodedFrameRecording(rtc::PlatformFile file,
82 size_t byte_limit) override;
83
eladalonc0d481a2017-08-02 07:39:07 -070084 void AddSecondarySink(RtpPacketSinkInterface* sink) override;
85 void RemoveSecondarySink(const RtpPacketSinkInterface* sink) override;
86
brandtr090c9402017-01-25 08:28:02 -080087 // Implements rtc::VideoSinkInterface<VideoFrame>.
88 void OnFrame(const VideoFrame& video_frame) override;
89
90 // Implements EncodedImageCallback.
91 EncodedImageCallback::Result OnEncodedImage(
92 const EncodedImage& encoded_image,
93 const CodecSpecificInfo* codec_specific_info,
94 const RTPFragmentationHeader* fragmentation) override;
95
96 // Implements NackSender.
97 void SendNack(const std::vector<uint16_t>& sequence_numbers) override;
98
99 // Implements KeyFrameRequestSender.
100 void RequestKeyFrame() override;
101
102 // Implements video_coding::OnCompleteFrameCallback.
103 void OnCompleteFrame(
104 std::unique_ptr<video_coding::FrameObject> frame) override;
105
solenberg3ebbcb52017-01-31 03:58:40 -0800106 // Implements Syncable.
107 int id() const override;
108 rtc::Optional<Syncable::Info> GetInfo() const override;
109 uint32_t GetPlayoutTimestamp() const override;
110 void SetMinimumPlayoutDelay(int delay_ms) override;
111
pbos@webrtc.org29d58392013-05-16 12:08:03 +0000112 private:
tommic8ece432017-06-20 02:44:38 -0700113 static void DecodeThreadFunction(void* ptr);
philipel2dfea3e2017-02-28 07:19:43 -0800114 bool Decode();
Peter Boströmca835252016-02-11 15:59:46 +0100115
eladalona28122f2017-08-18 04:02:48 -0700116 rtc::SequencedTaskChecker worker_sequence_checker_;
117 rtc::SequencedTaskChecker module_process_sequence_checker_;
solenberg3ebbcb52017-01-31 03:58:40 -0800118
pbos@webrtc.orge75a1bf2013-09-18 11:52:42 +0000119 TransportAdapter transport_adapter_;
pbos@webrtc.org6ae48c62014-06-06 10:49:19 +0000120 const VideoReceiveStream::Config config_;
sprang113bdca2016-10-11 03:10:10 -0700121 const int num_cpu_cores_;
Peter Boström1d04ac62016-02-05 11:25:46 +0100122 ProcessThread* const process_thread_;
pbos@webrtc.orgde1429e2014-04-28 13:00:21 +0000123 Clock* const clock_;
pbos@webrtc.org29d58392013-05-16 12:08:03 +0000124
Peter Boströmca835252016-02-11 15:59:46 +0100125 rtc::PlatformThread decode_thread_;
126
mflodmane3787022015-10-21 13:24:28 +0200127 CallStats* const call_stats_;
Peter Boström45553ae2015-05-08 13:54:38 +0200128
nisseca5706d2017-09-11 02:32:16 -0700129 // Shared by media and rtx stream receivers, since the latter has no RtpRtcp
130 // module of its own.
131 const std::unique_ptr<ReceiveStatistics> rtp_receive_statistics_;
132
philipel721d4022016-12-15 07:10:57 -0800133 std::unique_ptr<VCMTiming> timing_; // Jitter buffer experiment.
Peter Boström0b250722016-04-22 18:23:15 +0200134 vcm::VideoReceiver video_receiver_;
tommi2e82f382016-06-21 00:26:43 -0700135 std::unique_ptr<rtc::VideoSinkInterface<VideoFrame>> incoming_video_stream_;
Peter Boströmf751bf82016-02-05 14:00:53 +0100136 ReceiveStatisticsProxy stats_proxy_;
nisseb1f2ff92017-06-09 04:01:55 -0700137 RtpVideoStreamReceiver rtp_video_stream_receiver_;
tommi2e82f382016-06-21 00:26:43 -0700138 std::unique_ptr<VideoStreamDecoder> video_stream_decoder_;
mflodman4cd27902016-08-05 06:28:45 -0700139 RtpStreamsSynchronizer rtp_stream_sync_;
sprang3911c262016-04-15 01:24:14 -0700140
palmkviste75f2042016-09-28 06:19:48 -0700141 rtc::CriticalSection ivf_writer_lock_;
danilchapa37de392017-09-09 04:17:22 -0700142 std::unique_ptr<IvfFileWriter> ivf_writer_ RTC_GUARDED_BY(ivf_writer_lock_);
philipelfd5a20f2016-11-15 00:57:57 -0800143
144 // Members for the new jitter buffer experiment.
philipelfd5a20f2016-11-15 00:57:57 -0800145 std::unique_ptr<VCMJitterEstimator> jitter_estimator_;
146 std::unique_ptr<video_coding::FrameBuffer> frame_buffer_;
nisse0f15f922017-06-21 01:05:22 -0700147
148 std::unique_ptr<RtpStreamReceiverInterface> media_receiver_;
nisseca5706d2017-09-11 02:32:16 -0700149 std::unique_ptr<RtxReceiveStream> rtx_receive_stream_;
nisse0f15f922017-06-21 01:05:22 -0700150 std::unique_ptr<RtpStreamReceiverInterface> rtx_receiver_;
philipel3042c2d2017-08-18 04:55:02 -0700151
152 // Whenever we are in an undecodable state (stream has just started or due to
153 // a decoding error) we require a keyframe to restart the stream.
154 bool keyframe_required_ = true;
155
156 // If we have successfully decoded any frame.
157 bool frame_decoded_ = false;
pbos@webrtc.org29d58392013-05-16 12:08:03 +0000158};
mflodman@webrtc.orgf3973e82013-12-13 09:40:45 +0000159} // namespace internal
160} // namespace webrtc
pbos@webrtc.org29d58392013-05-16 12:08:03 +0000161
mflodman@webrtc.orgf3973e82013-12-13 09:40:45 +0000162#endif // WEBRTC_VIDEO_VIDEO_RECEIVE_STREAM_H_