blob: f86dd16db28ac30e0f4a136c04c5b53a9a9532bc [file] [log] [blame]
philipel5ab4c6d2016-03-08 03:36:15 -08001/*
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
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020011#ifndef MODULES_VIDEO_CODING_NACK_MODULE_H_
12#define MODULES_VIDEO_CODING_NACK_MODULE_H_
philipel5ab4c6d2016-03-08 03:36:15 -080013
14#include <map>
philipel5ab4c6d2016-03-08 03:36:15 -080015#include <set>
Yves Gerey665174f2018-06-19 15:03:05 +020016#include <vector>
philipel5ab4c6d2016-03-08 03:36:15 -080017
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020018#include "modules/include/module.h"
Ilya Nikolaevskiy8643b782018-06-07 16:15:40 +020019#include "modules/include/module_common_types.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020020#include "modules/video_coding/histogram.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020021#include "rtc_base/criticalsection.h"
Bjorn Tereliusa194e582017-10-25 13:07:09 +020022#include "rtc_base/numerics/sequence_number_util.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020023#include "rtc_base/thread_annotations.h"
24#include "system_wrappers/include/clock.h"
philipel5ab4c6d2016-03-08 03:36:15 -080025
26namespace webrtc {
27
28class NackModule : public Module {
29 public:
30 NackModule(Clock* clock,
31 NackSender* nack_sender,
32 KeyFrameRequestSender* keyframe_request_sender);
33
Niels Möllerbc010472018-03-23 13:22:29 +010034 int OnReceivedPacket(uint16_t seq_num, bool is_keyframe);
Ying Wangb32bb952018-10-31 10:12:27 +010035 int OnReceivedPacket(uint16_t seq_num, bool is_keyframe, bool is_recovered);
36
philipel5ab4c6d2016-03-08 03:36:15 -080037 void ClearUpTo(uint16_t seq_num);
38 void UpdateRtt(int64_t rtt_ms);
philipel83f831a2016-03-12 03:30:23 -080039 void Clear();
philipel5ab4c6d2016-03-08 03:36:15 -080040
41 // Module implementation
42 int64_t TimeUntilNextProcess() override;
43 void Process() override;
44
45 private:
46 // Which fields to consider when deciding which packet to nack in
47 // GetNackBatch.
48 enum NackFilterOptions { kSeqNumOnly, kTimeOnly, kSeqNumAndTime };
49
50 // This class holds the sequence number of the packet that is in the nack list
51 // as well as the meta data about when it should be nacked and how many times
52 // we have tried to nack this packet.
53 struct NackInfo {
54 NackInfo();
Ying Wang0367d1a2018-11-02 14:51:15 +010055 NackInfo(uint16_t seq_num,
56 uint16_t send_at_seq_num,
57 int64_t created_at_time);
philipel5ab4c6d2016-03-08 03:36:15 -080058
59 uint16_t seq_num;
60 uint16_t send_at_seq_num;
Ying Wang0367d1a2018-11-02 14:51:15 +010061 int64_t created_at_time;
philipel5ab4c6d2016-03-08 03:36:15 -080062 int64_t sent_at_time;
63 int retries;
64 };
philipel5ab4c6d2016-03-08 03:36:15 -080065 void AddPacketsToNack(uint16_t seq_num_start, uint16_t seq_num_end)
danilchap56359be2017-09-07 07:53:45 -070066 RTC_EXCLUSIVE_LOCKS_REQUIRED(crit_);
philipel5ab4c6d2016-03-08 03:36:15 -080067
68 // Removes packets from the nack list until the next keyframe. Returns true
69 // if packets were removed.
danilchap56359be2017-09-07 07:53:45 -070070 bool RemovePacketsUntilKeyFrame() RTC_EXCLUSIVE_LOCKS_REQUIRED(crit_);
philipel5ab4c6d2016-03-08 03:36:15 -080071 std::vector<uint16_t> GetNackBatch(NackFilterOptions options)
danilchap56359be2017-09-07 07:53:45 -070072 RTC_EXCLUSIVE_LOCKS_REQUIRED(crit_);
philipel5ab4c6d2016-03-08 03:36:15 -080073
74 // Update the reordering distribution.
75 void UpdateReorderingStatistics(uint16_t seq_num)
danilchap56359be2017-09-07 07:53:45 -070076 RTC_EXCLUSIVE_LOCKS_REQUIRED(crit_);
philipel5ab4c6d2016-03-08 03:36:15 -080077
78 // Returns how many packets we have to wait in order to receive the packet
79 // with probability |probabilty| or higher.
80 int WaitNumberOfPackets(float probability) const
danilchap56359be2017-09-07 07:53:45 -070081 RTC_EXCLUSIVE_LOCKS_REQUIRED(crit_);
philipel5ab4c6d2016-03-08 03:36:15 -080082
83 rtc::CriticalSection crit_;
84 Clock* const clock_;
85 NackSender* const nack_sender_;
86 KeyFrameRequestSender* const keyframe_request_sender_;
87
tommif284b7f2017-02-27 01:59:36 -080088 // TODO(philipel): Some of the variables below are consistently used on a
89 // known thread (e.g. see |initialized_|). Those probably do not need
90 // synchronized access.
philipel1a830c22016-05-13 11:12:00 +020091 std::map<uint16_t, NackInfo, DescendingSeqNumComp<uint16_t>> nack_list_
danilchap56359be2017-09-07 07:53:45 -070092 RTC_GUARDED_BY(crit_);
philipel1a830c22016-05-13 11:12:00 +020093 std::set<uint16_t, DescendingSeqNumComp<uint16_t>> keyframe_list_
danilchap56359be2017-09-07 07:53:45 -070094 RTC_GUARDED_BY(crit_);
Ying Wangb32bb952018-10-31 10:12:27 +010095 std::set<uint16_t, DescendingSeqNumComp<uint16_t>> recovered_list_
96 RTC_GUARDED_BY(crit_);
danilchap56359be2017-09-07 07:53:45 -070097 video_coding::Histogram reordering_histogram_ RTC_GUARDED_BY(crit_);
98 bool initialized_ RTC_GUARDED_BY(crit_);
99 int64_t rtt_ms_ RTC_GUARDED_BY(crit_);
100 uint16_t newest_seq_num_ RTC_GUARDED_BY(crit_);
tommif284b7f2017-02-27 01:59:36 -0800101
102 // Only touched on the process thread.
103 int64_t next_process_time_ms_;
Ying Wang0367d1a2018-11-02 14:51:15 +0100104
105 // Adds a delay before send nack on packet received.
106 const int64_t send_nack_delay_ms_;
philipel5ab4c6d2016-03-08 03:36:15 -0800107};
108
109} // namespace webrtc
110
Mirko Bonadei92ea95e2017-09-15 06:47:31 +0200111#endif // MODULES_VIDEO_CODING_NACK_MODULE_H_