blob: 001fd6cf1ba01a88c0ded39b7957da3a5db5e882 [file] [log] [blame]
Niels Möller530ead42018-10-04 14:28:39 +02001/*
2 * Copyright (c) 2012 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#include "audio/channel_send.h"
12
13#include <algorithm>
14#include <map>
15#include <memory>
16#include <string>
17#include <utility>
18#include <vector>
19
20#include "absl/memory/memory.h"
21#include "api/array_view.h"
Niels Möllerdced9f62018-11-19 10:27:07 +010022#include "api/call/transport.h"
Benjamin Wright84583f62018-10-04 14:22:34 -070023#include "api/crypto/frameencryptorinterface.h"
Niels Möller530ead42018-10-04 14:28:39 +020024#include "audio/utility/audio_frame_operations.h"
25#include "call/rtp_transport_controller_send_interface.h"
Niels Möllerdced9f62018-11-19 10:27:07 +010026#include "common_types.h" // NOLINT(build/include)
Niels Möller530ead42018-10-04 14:28:39 +020027#include "logging/rtc_event_log/events/rtc_event_audio_playout.h"
28#include "logging/rtc_event_log/rtc_event_log.h"
29#include "modules/audio_coding/audio_network_adaptor/include/audio_network_adaptor_config.h"
Niels Möllerdced9f62018-11-19 10:27:07 +010030#include "modules/audio_coding/include/audio_coding_module.h"
31#include "modules/audio_processing/rms_level.h"
Niels Möller530ead42018-10-04 14:28:39 +020032#include "modules/pacing/packet_router.h"
33#include "modules/utility/include/process_thread.h"
34#include "rtc_base/checks.h"
35#include "rtc_base/criticalsection.h"
Yves Gerey2e00abc2018-10-05 15:39:24 +020036#include "rtc_base/event.h"
Niels Möller530ead42018-10-04 14:28:39 +020037#include "rtc_base/format_macros.h"
38#include "rtc_base/location.h"
39#include "rtc_base/logging.h"
Niels Möller26815232018-11-16 09:32:40 +010040#include "rtc_base/numerics/safe_conversions.h"
Niels Möllerdced9f62018-11-19 10:27:07 +010041#include "rtc_base/race_checker.h"
Niels Möller530ead42018-10-04 14:28:39 +020042#include "rtc_base/rate_limiter.h"
43#include "rtc_base/task_queue.h"
44#include "rtc_base/thread_checker.h"
45#include "rtc_base/timeutils.h"
46#include "system_wrappers/include/field_trial.h"
47#include "system_wrappers/include/metrics.h"
48
49namespace webrtc {
50namespace voe {
51
52namespace {
53
54constexpr int64_t kMaxRetransmissionWindowMs = 1000;
55constexpr int64_t kMinRetransmissionWindowMs = 30;
56
Niels Möller7d76a312018-10-26 12:57:07 +020057MediaTransportEncodedAudioFrame::FrameType
58MediaTransportFrameTypeForWebrtcFrameType(webrtc::FrameType frame_type) {
59 switch (frame_type) {
60 case kAudioFrameSpeech:
61 return MediaTransportEncodedAudioFrame::FrameType::kSpeech;
62 break;
63
64 case kAudioFrameCN:
65 return MediaTransportEncodedAudioFrame::FrameType::
66 kDiscontinuousTransmission;
67 break;
68
69 default:
70 RTC_CHECK(false) << "Unexpected frame type=" << frame_type;
71 break;
72 }
73}
74
Niels Möllerdced9f62018-11-19 10:27:07 +010075class RtpPacketSenderProxy;
76class TransportFeedbackProxy;
77class TransportSequenceNumberProxy;
78class VoERtcpObserver;
79
Niels Möllerdced9f62018-11-19 10:27:07 +010080class ChannelSend
81 : public ChannelSendInterface,
82 public Transport,
83 public OverheadObserver,
84 public AudioPacketizationCallback, // receive encoded packets from the
85 // ACM
86 public TargetTransferRateObserver {
87 public:
88 // TODO(nisse): Make OnUplinkPacketLossRate public, and delete friend
89 // declaration.
90 friend class VoERtcpObserver;
91
92 ChannelSend(rtc::TaskQueue* encoder_queue,
93 ProcessThread* module_process_thread,
94 MediaTransportInterface* media_transport,
95 RtcpRttStats* rtcp_rtt_stats,
96 RtcEventLog* rtc_event_log,
97 FrameEncryptorInterface* frame_encryptor,
98 const webrtc::CryptoOptions& crypto_options,
99 bool extmap_allow_mixed,
100 int rtcp_report_interval_ms);
101
102 ~ChannelSend() override;
103
104 // Send using this encoder, with this payload type.
105 bool SetEncoder(int payload_type,
106 std::unique_ptr<AudioEncoder> encoder) override;
107 void ModifyEncoder(rtc::FunctionView<void(std::unique_ptr<AudioEncoder>*)>
108 modifier) override;
109
110 // API methods
Niels Möllerdced9f62018-11-19 10:27:07 +0100111 void StartSend() override;
112 void StopSend() override;
113
114 // Codecs
115 void SetBitrate(int bitrate_bps, int64_t probing_interval_ms) override;
116 int GetBitrate() const override;
117
118 // Network
119 void RegisterTransport(Transport* transport) override;
Niels Möllerdced9f62018-11-19 10:27:07 +0100120 bool ReceivedRTCPPacket(const uint8_t* data, size_t length) override;
121
122 // Muting, Volume and Level.
123 void SetInputMute(bool enable) override;
124
125 // Stats.
126 ANAStats GetANAStatistics() const override;
127
128 // Used by AudioSendStream.
129 RtpRtcp* GetRtpRtcp() const override;
130
131 // DTMF.
132 bool SendTelephoneEventOutband(int event, int duration_ms) override;
133 bool SetSendTelephoneEventPayloadType(int payload_type,
134 int payload_frequency) override;
135
136 // RTP+RTCP
137 void SetLocalSSRC(uint32_t ssrc) override;
Niels Möllerdced9f62018-11-19 10:27:07 +0100138 void SetMid(const std::string& mid, int extension_id) override;
139 void SetExtmapAllowMixed(bool extmap_allow_mixed) override;
140 void SetSendAudioLevelIndicationStatus(bool enable, int id) override;
141 void EnableSendTransportSequenceNumber(int id) override;
142
143 void RegisterSenderCongestionControlObjects(
144 RtpTransportControllerSendInterface* transport,
145 RtcpBandwidthObserver* bandwidth_observer) override;
146 void ResetSenderCongestionControlObjects() override;
147 void SetRTCP_CNAME(absl::string_view c_name) override;
148 std::vector<ReportBlock> GetRemoteRTCPReportBlocks() const override;
149 CallSendStatistics GetRTCPStatistics() const override;
150 void SetNACKStatus(bool enable, int max_packets) override;
151
152 // ProcessAndEncodeAudio() posts a task on the shared encoder task queue,
153 // which in turn calls (on the queue) ProcessAndEncodeAudioOnTaskQueue() where
154 // the actual processing of the audio takes place. The processing mainly
155 // consists of encoding and preparing the result for sending by adding it to a
156 // send queue.
157 // The main reason for using a task queue here is to release the native,
158 // OS-specific, audio capture thread as soon as possible to ensure that it
159 // can go back to sleep and be prepared to deliver an new captured audio
160 // packet.
161 void ProcessAndEncodeAudio(std::unique_ptr<AudioFrame> audio_frame) override;
162
163 void SetTransportOverhead(size_t transport_overhead_per_packet) override;
164
165 // The existence of this function alongside OnUplinkPacketLossRate is
166 // a compromise. We want the encoder to be agnostic of the PLR source, but
167 // we also don't want it to receive conflicting information from TWCC and
168 // from RTCP-XR.
169 void OnTwccBasedUplinkPacketLossRate(float packet_loss_rate) override;
170
171 void OnRecoverableUplinkPacketLossRate(
172 float recoverable_packet_loss_rate) override;
173
174 int64_t GetRTT() const override;
175
176 // E2EE Custom Audio Frame Encryption
177 void SetFrameEncryptor(
178 rtc::scoped_refptr<FrameEncryptorInterface> frame_encryptor) override;
179
180 private:
181 class ProcessAndEncodeAudioTask;
182
183 // From AudioPacketizationCallback in the ACM
184 int32_t SendData(FrameType frameType,
185 uint8_t payloadType,
186 uint32_t timeStamp,
187 const uint8_t* payloadData,
188 size_t payloadSize,
189 const RTPFragmentationHeader* fragmentation) override;
190
191 // From Transport (called by the RTP/RTCP module)
192 bool SendRtp(const uint8_t* data,
193 size_t len,
194 const PacketOptions& packet_options) override;
195 bool SendRtcp(const uint8_t* data, size_t len) override;
196
Niels Möllerdced9f62018-11-19 10:27:07 +0100197 // From OverheadObserver in the RTP/RTCP module
198 void OnOverheadChanged(size_t overhead_bytes_per_packet) override;
199
200 void OnUplinkPacketLossRate(float packet_loss_rate);
201 bool InputMute() const;
202
203 int ResendPackets(const uint16_t* sequence_numbers, int length);
204
205 int SetSendRtpHeaderExtension(bool enable, RTPExtensionType type, int id);
206
207 void UpdateOverheadForEncoder()
208 RTC_EXCLUSIVE_LOCKS_REQUIRED(overhead_per_packet_lock_);
209
210 int GetRtpTimestampRateHz() const;
211
212 int32_t SendRtpAudio(FrameType frameType,
213 uint8_t payloadType,
214 uint32_t timeStamp,
215 rtc::ArrayView<const uint8_t> payload,
216 const RTPFragmentationHeader* fragmentation);
217
218 int32_t SendMediaTransportAudio(FrameType frameType,
219 uint8_t payloadType,
220 uint32_t timeStamp,
221 rtc::ArrayView<const uint8_t> payload,
222 const RTPFragmentationHeader* fragmentation);
223
224 // Return media transport or nullptr if using RTP.
225 MediaTransportInterface* media_transport() { return media_transport_; }
226
227 // Called on the encoder task queue when a new input audio frame is ready
228 // for encoding.
229 void ProcessAndEncodeAudioOnTaskQueue(AudioFrame* audio_input);
230
231 void OnReceivedRtt(int64_t rtt_ms);
232
233 void OnTargetTransferRate(TargetTransferRate) override;
234
235 // Thread checkers document and lock usage of some methods on voe::Channel to
236 // specific threads we know about. The goal is to eventually split up
237 // voe::Channel into parts with single-threaded semantics, and thereby reduce
238 // the need for locks.
239 rtc::ThreadChecker worker_thread_checker_;
240 rtc::ThreadChecker module_process_thread_checker_;
241 // Methods accessed from audio and video threads are checked for sequential-
242 // only access. We don't necessarily own and control these threads, so thread
243 // checkers cannot be used. E.g. Chromium may transfer "ownership" from one
244 // audio thread to another, but access is still sequential.
245 rtc::RaceChecker audio_thread_race_checker_;
246
247 rtc::CriticalSection _callbackCritSect;
248 rtc::CriticalSection volume_settings_critsect_;
249
Fredrik Solenbergeb134842018-11-19 14:13:15 +0100250 bool sending_ = false;
Niels Möllerdced9f62018-11-19 10:27:07 +0100251
252 RtcEventLog* const event_log_;
253
254 std::unique_ptr<RtpRtcp> _rtpRtcpModule;
255
256 std::unique_ptr<AudioCodingModule> audio_coding_;
257 uint32_t _timeStamp RTC_GUARDED_BY(encoder_queue_);
258
259 uint16_t send_sequence_number_;
260
261 // uses
262 ProcessThread* _moduleProcessThreadPtr;
263 Transport* _transportPtr; // WebRtc socket or external transport
264 RmsLevel rms_level_ RTC_GUARDED_BY(encoder_queue_);
265 bool input_mute_ RTC_GUARDED_BY(volume_settings_critsect_);
266 bool previous_frame_muted_ RTC_GUARDED_BY(encoder_queue_);
267 // VoeRTP_RTCP
268 // TODO(henrika): can today be accessed on the main thread and on the
269 // task queue; hence potential race.
270 bool _includeAudioLevelIndication;
271 size_t transport_overhead_per_packet_
272 RTC_GUARDED_BY(overhead_per_packet_lock_);
273 size_t rtp_overhead_per_packet_ RTC_GUARDED_BY(overhead_per_packet_lock_);
274 rtc::CriticalSection overhead_per_packet_lock_;
275 // RtcpBandwidthObserver
276 std::unique_ptr<VoERtcpObserver> rtcp_observer_;
277
278 PacketRouter* packet_router_ = nullptr;
279 std::unique_ptr<TransportFeedbackProxy> feedback_observer_proxy_;
280 std::unique_ptr<TransportSequenceNumberProxy> seq_num_allocator_proxy_;
281 std::unique_ptr<RtpPacketSenderProxy> rtp_packet_sender_proxy_;
282 std::unique_ptr<RateLimiter> retransmission_rate_limiter_;
283
284 rtc::ThreadChecker construction_thread_;
285
286 const bool use_twcc_plr_for_ana_;
287
288 rtc::CriticalSection encoder_queue_lock_;
289 bool encoder_queue_is_active_ RTC_GUARDED_BY(encoder_queue_lock_) = false;
290 rtc::TaskQueue* encoder_queue_ = nullptr;
291
292 MediaTransportInterface* const media_transport_;
293 int media_transport_sequence_number_ RTC_GUARDED_BY(encoder_queue_) = 0;
294
295 rtc::CriticalSection media_transport_lock_;
296 // Currently set by SetLocalSSRC.
297 uint64_t media_transport_channel_id_ RTC_GUARDED_BY(&media_transport_lock_) =
298 0;
299 // Cache payload type and sampling frequency from most recent call to
300 // SetEncoder. Needed to set MediaTransportEncodedAudioFrame metadata, and
301 // invalidate on encoder change.
302 int media_transport_payload_type_ RTC_GUARDED_BY(&media_transport_lock_);
303 int media_transport_sampling_frequency_
304 RTC_GUARDED_BY(&media_transport_lock_);
305
306 // E2EE Audio Frame Encryption
307 rtc::scoped_refptr<FrameEncryptorInterface> frame_encryptor_;
308 // E2EE Frame Encryption Options
309 webrtc::CryptoOptions crypto_options_;
310
311 rtc::CriticalSection bitrate_crit_section_;
312 int configured_bitrate_bps_ RTC_GUARDED_BY(bitrate_crit_section_) = 0;
313};
Niels Möller530ead42018-10-04 14:28:39 +0200314
315const int kTelephoneEventAttenuationdB = 10;
316
317class TransportFeedbackProxy : public TransportFeedbackObserver {
318 public:
319 TransportFeedbackProxy() : feedback_observer_(nullptr) {
320 pacer_thread_.DetachFromThread();
321 network_thread_.DetachFromThread();
322 }
323
324 void SetTransportFeedbackObserver(
325 TransportFeedbackObserver* feedback_observer) {
326 RTC_DCHECK(thread_checker_.CalledOnValidThread());
327 rtc::CritScope lock(&crit_);
328 feedback_observer_ = feedback_observer;
329 }
330
331 // Implements TransportFeedbackObserver.
332 void AddPacket(uint32_t ssrc,
333 uint16_t sequence_number,
334 size_t length,
335 const PacedPacketInfo& pacing_info) override {
336 RTC_DCHECK(pacer_thread_.CalledOnValidThread());
337 rtc::CritScope lock(&crit_);
338 if (feedback_observer_)
339 feedback_observer_->AddPacket(ssrc, sequence_number, length, pacing_info);
340 }
341
342 void OnTransportFeedback(const rtcp::TransportFeedback& feedback) override {
343 RTC_DCHECK(network_thread_.CalledOnValidThread());
344 rtc::CritScope lock(&crit_);
345 if (feedback_observer_)
346 feedback_observer_->OnTransportFeedback(feedback);
347 }
348
349 private:
350 rtc::CriticalSection crit_;
351 rtc::ThreadChecker thread_checker_;
352 rtc::ThreadChecker pacer_thread_;
353 rtc::ThreadChecker network_thread_;
354 TransportFeedbackObserver* feedback_observer_ RTC_GUARDED_BY(&crit_);
355};
356
357class TransportSequenceNumberProxy : public TransportSequenceNumberAllocator {
358 public:
359 TransportSequenceNumberProxy() : seq_num_allocator_(nullptr) {
360 pacer_thread_.DetachFromThread();
361 }
362
363 void SetSequenceNumberAllocator(
364 TransportSequenceNumberAllocator* seq_num_allocator) {
365 RTC_DCHECK(thread_checker_.CalledOnValidThread());
366 rtc::CritScope lock(&crit_);
367 seq_num_allocator_ = seq_num_allocator;
368 }
369
370 // Implements TransportSequenceNumberAllocator.
371 uint16_t AllocateSequenceNumber() override {
372 RTC_DCHECK(pacer_thread_.CalledOnValidThread());
373 rtc::CritScope lock(&crit_);
374 if (!seq_num_allocator_)
375 return 0;
376 return seq_num_allocator_->AllocateSequenceNumber();
377 }
378
379 private:
380 rtc::CriticalSection crit_;
381 rtc::ThreadChecker thread_checker_;
382 rtc::ThreadChecker pacer_thread_;
383 TransportSequenceNumberAllocator* seq_num_allocator_ RTC_GUARDED_BY(&crit_);
384};
385
386class RtpPacketSenderProxy : public RtpPacketSender {
387 public:
388 RtpPacketSenderProxy() : rtp_packet_sender_(nullptr) {}
389
390 void SetPacketSender(RtpPacketSender* rtp_packet_sender) {
391 RTC_DCHECK(thread_checker_.CalledOnValidThread());
392 rtc::CritScope lock(&crit_);
393 rtp_packet_sender_ = rtp_packet_sender;
394 }
395
396 // Implements RtpPacketSender.
397 void InsertPacket(Priority priority,
398 uint32_t ssrc,
399 uint16_t sequence_number,
400 int64_t capture_time_ms,
401 size_t bytes,
402 bool retransmission) override {
403 rtc::CritScope lock(&crit_);
404 if (rtp_packet_sender_) {
405 rtp_packet_sender_->InsertPacket(priority, ssrc, sequence_number,
406 capture_time_ms, bytes, retransmission);
407 }
408 }
409
410 void SetAccountForAudioPackets(bool account_for_audio) override {
411 RTC_NOTREACHED();
412 }
413
414 private:
415 rtc::ThreadChecker thread_checker_;
416 rtc::CriticalSection crit_;
417 RtpPacketSender* rtp_packet_sender_ RTC_GUARDED_BY(&crit_);
418};
419
420class VoERtcpObserver : public RtcpBandwidthObserver {
421 public:
422 explicit VoERtcpObserver(ChannelSend* owner)
423 : owner_(owner), bandwidth_observer_(nullptr) {}
424 virtual ~VoERtcpObserver() {}
425
426 void SetBandwidthObserver(RtcpBandwidthObserver* bandwidth_observer) {
427 rtc::CritScope lock(&crit_);
428 bandwidth_observer_ = bandwidth_observer;
429 }
430
431 void OnReceivedEstimatedBitrate(uint32_t bitrate) override {
432 rtc::CritScope lock(&crit_);
433 if (bandwidth_observer_) {
434 bandwidth_observer_->OnReceivedEstimatedBitrate(bitrate);
435 }
436 }
437
438 void OnReceivedRtcpReceiverReport(const ReportBlockList& report_blocks,
439 int64_t rtt,
440 int64_t now_ms) override {
441 {
442 rtc::CritScope lock(&crit_);
443 if (bandwidth_observer_) {
444 bandwidth_observer_->OnReceivedRtcpReceiverReport(report_blocks, rtt,
445 now_ms);
446 }
447 }
448 // TODO(mflodman): Do we need to aggregate reports here or can we jut send
449 // what we get? I.e. do we ever get multiple reports bundled into one RTCP
450 // report for VoiceEngine?
451 if (report_blocks.empty())
452 return;
453
454 int fraction_lost_aggregate = 0;
455 int total_number_of_packets = 0;
456
457 // If receiving multiple report blocks, calculate the weighted average based
458 // on the number of packets a report refers to.
459 for (ReportBlockList::const_iterator block_it = report_blocks.begin();
460 block_it != report_blocks.end(); ++block_it) {
461 // Find the previous extended high sequence number for this remote SSRC,
462 // to calculate the number of RTP packets this report refers to. Ignore if
463 // we haven't seen this SSRC before.
464 std::map<uint32_t, uint32_t>::iterator seq_num_it =
465 extended_max_sequence_number_.find(block_it->source_ssrc);
466 int number_of_packets = 0;
467 if (seq_num_it != extended_max_sequence_number_.end()) {
468 number_of_packets =
469 block_it->extended_highest_sequence_number - seq_num_it->second;
470 }
471 fraction_lost_aggregate += number_of_packets * block_it->fraction_lost;
472 total_number_of_packets += number_of_packets;
473
474 extended_max_sequence_number_[block_it->source_ssrc] =
475 block_it->extended_highest_sequence_number;
476 }
477 int weighted_fraction_lost = 0;
478 if (total_number_of_packets > 0) {
479 weighted_fraction_lost =
480 (fraction_lost_aggregate + total_number_of_packets / 2) /
481 total_number_of_packets;
482 }
483 owner_->OnUplinkPacketLossRate(weighted_fraction_lost / 255.0f);
484 }
485
486 private:
487 ChannelSend* owner_;
488 // Maps remote side ssrc to extended highest sequence number received.
489 std::map<uint32_t, uint32_t> extended_max_sequence_number_;
490 rtc::CriticalSection crit_;
491 RtcpBandwidthObserver* bandwidth_observer_ RTC_GUARDED_BY(crit_);
492};
493
494class ChannelSend::ProcessAndEncodeAudioTask : public rtc::QueuedTask {
495 public:
496 ProcessAndEncodeAudioTask(std::unique_ptr<AudioFrame> audio_frame,
497 ChannelSend* channel)
498 : audio_frame_(std::move(audio_frame)), channel_(channel) {
499 RTC_DCHECK(channel_);
500 }
501
502 private:
503 bool Run() override {
504 RTC_DCHECK_RUN_ON(channel_->encoder_queue_);
505 channel_->ProcessAndEncodeAudioOnTaskQueue(audio_frame_.get());
506 return true;
507 }
508
509 std::unique_ptr<AudioFrame> audio_frame_;
510 ChannelSend* const channel_;
511};
512
513int32_t ChannelSend::SendData(FrameType frameType,
514 uint8_t payloadType,
515 uint32_t timeStamp,
516 const uint8_t* payloadData,
517 size_t payloadSize,
518 const RTPFragmentationHeader* fragmentation) {
519 RTC_DCHECK_RUN_ON(encoder_queue_);
Niels Möller7d76a312018-10-26 12:57:07 +0200520 rtc::ArrayView<const uint8_t> payload(payloadData, payloadSize);
521
522 if (media_transport() != nullptr) {
523 return SendMediaTransportAudio(frameType, payloadType, timeStamp, payload,
524 fragmentation);
525 } else {
526 return SendRtpAudio(frameType, payloadType, timeStamp, payload,
527 fragmentation);
528 }
529}
530
531int32_t ChannelSend::SendRtpAudio(FrameType frameType,
532 uint8_t payloadType,
533 uint32_t timeStamp,
534 rtc::ArrayView<const uint8_t> payload,
535 const RTPFragmentationHeader* fragmentation) {
536 RTC_DCHECK_RUN_ON(encoder_queue_);
Niels Möller530ead42018-10-04 14:28:39 +0200537 if (_includeAudioLevelIndication) {
538 // Store current audio level in the RTP/RTCP module.
539 // The level will be used in combination with voice-activity state
540 // (frameType) to add an RTP header extension
541 _rtpRtcpModule->SetAudioLevel(rms_level_.Average());
542 }
543
Benjamin Wright84583f62018-10-04 14:22:34 -0700544 // E2EE Custom Audio Frame Encryption (This is optional).
545 // Keep this buffer around for the lifetime of the send call.
546 rtc::Buffer encrypted_audio_payload;
547 if (frame_encryptor_ != nullptr) {
548 // TODO(benwright@webrtc.org) - Allocate enough to always encrypt inline.
549 // Allocate a buffer to hold the maximum possible encrypted payload.
550 size_t max_ciphertext_size = frame_encryptor_->GetMaxCiphertextByteSize(
Niels Möller7d76a312018-10-26 12:57:07 +0200551 cricket::MEDIA_TYPE_AUDIO, payload.size());
Benjamin Wright84583f62018-10-04 14:22:34 -0700552 encrypted_audio_payload.SetSize(max_ciphertext_size);
553
554 // Encrypt the audio payload into the buffer.
555 size_t bytes_written = 0;
556 int encrypt_status = frame_encryptor_->Encrypt(
557 cricket::MEDIA_TYPE_AUDIO, _rtpRtcpModule->SSRC(),
Niels Möller7d76a312018-10-26 12:57:07 +0200558 /*additional_data=*/nullptr, payload, encrypted_audio_payload,
559 &bytes_written);
Benjamin Wright84583f62018-10-04 14:22:34 -0700560 if (encrypt_status != 0) {
561 RTC_DLOG(LS_ERROR) << "Channel::SendData() failed encrypt audio payload: "
562 << encrypt_status;
563 return -1;
564 }
565 // Resize the buffer to the exact number of bytes actually used.
566 encrypted_audio_payload.SetSize(bytes_written);
567 // Rewrite the payloadData and size to the new encrypted payload.
Niels Möller7d76a312018-10-26 12:57:07 +0200568 payload = encrypted_audio_payload;
Benjamin Wrightbfb444c2018-10-15 10:20:24 -0700569 } else if (crypto_options_.sframe.require_frame_encryption) {
570 RTC_DLOG(LS_ERROR) << "Channel::SendData() failed sending audio payload: "
571 << "A frame encryptor is required but one is not set.";
572 return -1;
Benjamin Wright84583f62018-10-04 14:22:34 -0700573 }
574
Niels Möller530ead42018-10-04 14:28:39 +0200575 // Push data from ACM to RTP/RTCP-module to deliver audio frame for
576 // packetization.
577 // This call will trigger Transport::SendPacket() from the RTP/RTCP module.
Niels Möller7d76a312018-10-26 12:57:07 +0200578 if (!_rtpRtcpModule->SendOutgoingData((FrameType&)frameType, payloadType,
579 timeStamp,
580 // Leaving the time when this frame was
581 // received from the capture device as
582 // undefined for voice for now.
583 -1, payload.data(), payload.size(),
584 fragmentation, nullptr, nullptr)) {
Niels Möller530ead42018-10-04 14:28:39 +0200585 RTC_DLOG(LS_ERROR)
586 << "ChannelSend::SendData() failed to send data to RTP/RTCP module";
587 return -1;
588 }
589
590 return 0;
591}
592
Niels Möller7d76a312018-10-26 12:57:07 +0200593int32_t ChannelSend::SendMediaTransportAudio(
594 FrameType frameType,
595 uint8_t payloadType,
596 uint32_t timeStamp,
597 rtc::ArrayView<const uint8_t> payload,
598 const RTPFragmentationHeader* fragmentation) {
599 RTC_DCHECK_RUN_ON(encoder_queue_);
600 // TODO(nisse): Use null _transportPtr for MediaTransport.
601 // RTC_DCHECK(_transportPtr == nullptr);
602 uint64_t channel_id;
603 int sampling_rate_hz;
604 {
605 rtc::CritScope cs(&media_transport_lock_);
606 if (media_transport_payload_type_ != payloadType) {
607 // Payload type is being changed, media_transport_sampling_frequency_,
608 // no longer current.
609 return -1;
610 }
611 sampling_rate_hz = media_transport_sampling_frequency_;
612 channel_id = media_transport_channel_id_;
613 }
614 const MediaTransportEncodedAudioFrame frame(
615 /*sampling_rate_hz=*/sampling_rate_hz,
616
617 // TODO(nisse): Timestamp and sample index are the same for all supported
618 // audio codecs except G722. Refactor audio coding module to only use
619 // sample index, and leave translation to RTP time, when needed, for
620 // RTP-specific code.
621 /*starting_sample_index=*/timeStamp,
622
623 // Sample count isn't conveniently available from the AudioCodingModule,
624 // and needs some refactoring to wire up in a good way. For now, left as
625 // zero.
626 /*sample_count=*/0,
627
628 /*sequence_number=*/media_transport_sequence_number_,
629 MediaTransportFrameTypeForWebrtcFrameType(frameType), payloadType,
630 std::vector<uint8_t>(payload.begin(), payload.end()));
631
632 // TODO(nisse): Introduce a MediaTransportSender object bound to a specific
633 // channel id.
634 RTCError rtc_error =
635 media_transport()->SendAudioFrame(channel_id, std::move(frame));
636
637 if (!rtc_error.ok()) {
638 RTC_LOG(LS_ERROR) << "Failed to send frame, rtc_error="
639 << ToString(rtc_error.type()) << ", "
640 << rtc_error.message();
641 return -1;
642 }
643
644 ++media_transport_sequence_number_;
645
646 return 0;
647}
648
Niels Möller530ead42018-10-04 14:28:39 +0200649bool ChannelSend::SendRtp(const uint8_t* data,
650 size_t len,
651 const PacketOptions& options) {
Niels Möller7d76a312018-10-26 12:57:07 +0200652 // We should not be sending RTP packets if media transport is available.
653 RTC_CHECK(!media_transport());
654
Niels Möller530ead42018-10-04 14:28:39 +0200655 rtc::CritScope cs(&_callbackCritSect);
656
657 if (_transportPtr == NULL) {
658 RTC_DLOG(LS_ERROR)
659 << "ChannelSend::SendPacket() failed to send RTP packet due to"
660 << " invalid transport object";
661 return false;
662 }
663
664 if (!_transportPtr->SendRtp(data, len, options)) {
665 RTC_DLOG(LS_ERROR) << "ChannelSend::SendPacket() RTP transmission failed";
666 return false;
667 }
668 return true;
669}
670
671bool ChannelSend::SendRtcp(const uint8_t* data, size_t len) {
672 rtc::CritScope cs(&_callbackCritSect);
673 if (_transportPtr == NULL) {
674 RTC_DLOG(LS_ERROR)
675 << "ChannelSend::SendRtcp() failed to send RTCP packet due to"
676 << " invalid transport object";
677 return false;
678 }
679
680 int n = _transportPtr->SendRtcp(data, len);
681 if (n < 0) {
682 RTC_DLOG(LS_ERROR) << "ChannelSend::SendRtcp() transmission failed";
683 return false;
684 }
685 return true;
686}
687
Niels Möller530ead42018-10-04 14:28:39 +0200688ChannelSend::ChannelSend(rtc::TaskQueue* encoder_queue,
689 ProcessThread* module_process_thread,
Niels Möller7d76a312018-10-26 12:57:07 +0200690 MediaTransportInterface* media_transport,
Niels Möller530ead42018-10-04 14:28:39 +0200691 RtcpRttStats* rtcp_rtt_stats,
Benjamin Wright84583f62018-10-04 14:22:34 -0700692 RtcEventLog* rtc_event_log,
Benjamin Wrightbfb444c2018-10-15 10:20:24 -0700693 FrameEncryptorInterface* frame_encryptor,
Johannes Kron9190b822018-10-29 11:22:05 +0100694 const webrtc::CryptoOptions& crypto_options,
Jiawei Ou55718122018-11-09 13:17:39 -0800695 bool extmap_allow_mixed,
696 int rtcp_report_interval_ms)
Niels Möller530ead42018-10-04 14:28:39 +0200697 : event_log_(rtc_event_log),
698 _timeStamp(0), // This is just an offset, RTP module will add it's own
699 // random offset
700 send_sequence_number_(0),
701 _moduleProcessThreadPtr(module_process_thread),
702 _transportPtr(NULL),
703 input_mute_(false),
704 previous_frame_muted_(false),
705 _includeAudioLevelIndication(false),
706 transport_overhead_per_packet_(0),
707 rtp_overhead_per_packet_(0),
708 rtcp_observer_(new VoERtcpObserver(this)),
709 feedback_observer_proxy_(new TransportFeedbackProxy()),
710 seq_num_allocator_proxy_(new TransportSequenceNumberProxy()),
711 rtp_packet_sender_proxy_(new RtpPacketSenderProxy()),
712 retransmission_rate_limiter_(new RateLimiter(Clock::GetRealTimeClock(),
713 kMaxRetransmissionWindowMs)),
714 use_twcc_plr_for_ana_(
715 webrtc::field_trial::FindFullName("UseTwccPlrForAna") == "Enabled"),
Benjamin Wright84583f62018-10-04 14:22:34 -0700716 encoder_queue_(encoder_queue),
Niels Möller7d76a312018-10-26 12:57:07 +0200717 media_transport_(media_transport),
Benjamin Wrightbfb444c2018-10-15 10:20:24 -0700718 frame_encryptor_(frame_encryptor),
719 crypto_options_(crypto_options) {
Niels Möller530ead42018-10-04 14:28:39 +0200720 RTC_DCHECK(module_process_thread);
721 RTC_DCHECK(encoder_queue);
Niels Möllerdced9f62018-11-19 10:27:07 +0100722 module_process_thread_checker_.DetachFromThread();
723
Niels Möller530ead42018-10-04 14:28:39 +0200724 audio_coding_.reset(AudioCodingModule::Create(AudioCodingModule::Config()));
725
726 RtpRtcp::Configuration configuration;
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -0800727
728 // We gradually remove codepaths that depend on RTP when using media
729 // transport. All of this logic should be moved to the future
730 // RTPMediaTransport. In this case it means that overhead and bandwidth
731 // observers should not be called when using media transport.
732 if (!media_transport_) {
733 configuration.overhead_observer = this;
734 configuration.bandwidth_callback = rtcp_observer_.get();
735 configuration.transport_feedback_callback = feedback_observer_proxy_.get();
736 }
737
Niels Möller530ead42018-10-04 14:28:39 +0200738 configuration.audio = true;
739 configuration.outgoing_transport = this;
Niels Möller530ead42018-10-04 14:28:39 +0200740
741 configuration.paced_sender = rtp_packet_sender_proxy_.get();
742 configuration.transport_sequence_number_allocator =
743 seq_num_allocator_proxy_.get();
Niels Möller530ead42018-10-04 14:28:39 +0200744
745 configuration.event_log = event_log_;
746 configuration.rtt_stats = rtcp_rtt_stats;
747 configuration.retransmission_rate_limiter =
748 retransmission_rate_limiter_.get();
Johannes Kron9190b822018-10-29 11:22:05 +0100749 configuration.extmap_allow_mixed = extmap_allow_mixed;
Jiawei Ou55718122018-11-09 13:17:39 -0800750 configuration.rtcp_interval_config.audio_interval_ms =
751 rtcp_report_interval_ms;
Niels Möller530ead42018-10-04 14:28:39 +0200752
753 _rtpRtcpModule.reset(RtpRtcp::CreateRtpRtcp(configuration));
754 _rtpRtcpModule->SetSendingMediaStatus(false);
Niels Möller530ead42018-10-04 14:28:39 +0200755
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -0800756 // We want to invoke the 'TargetRateObserver' and |OnOverheadChanged|
757 // callbacks after the audio_coding_ is fully initialized.
758 if (media_transport_) {
759 RTC_DLOG(LS_INFO) << "Setting media_transport_ rate observers.";
760 media_transport_->AddTargetTransferRateObserver(this);
761 OnOverheadChanged(media_transport_->GetAudioPacketOverhead());
762 } else {
763 RTC_DLOG(LS_INFO) << "Not setting media_transport_ rate observers.";
764 }
765
Niels Möller530ead42018-10-04 14:28:39 +0200766 _moduleProcessThreadPtr->RegisterModule(_rtpRtcpModule.get(), RTC_FROM_HERE);
767
Niels Möller530ead42018-10-04 14:28:39 +0200768 // Ensure that RTCP is enabled by default for the created channel.
769 // Note that, the module will keep generating RTCP until it is explicitly
770 // disabled by the user.
771 // After StopListen (when no sockets exists), RTCP packets will no longer
772 // be transmitted since the Transport object will then be invalid.
773 // RTCP is enabled by default.
774 _rtpRtcpModule->SetRTCPStatus(RtcpMode::kCompound);
775
Fredrik Solenbergeb134842018-11-19 14:13:15 +0100776 int error = audio_coding_->RegisterTransportCallback(this);
Niels Möller530ead42018-10-04 14:28:39 +0200777 RTC_DCHECK_EQ(0, error);
778}
779
Fredrik Solenberg645a3af2018-11-16 12:51:15 +0100780ChannelSend::~ChannelSend() {
Niels Möller530ead42018-10-04 14:28:39 +0200781 RTC_DCHECK(construction_thread_.CalledOnValidThread());
Niels Möller530ead42018-10-04 14:28:39 +0200782
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -0800783 if (media_transport_) {
784 media_transport_->RemoveTargetTransferRateObserver(this);
785 }
786
Niels Möller530ead42018-10-04 14:28:39 +0200787 StopSend();
788
Niels Möller530ead42018-10-04 14:28:39 +0200789 int error = audio_coding_->RegisterTransportCallback(NULL);
790 RTC_DCHECK_EQ(0, error);
791
Niels Möller530ead42018-10-04 14:28:39 +0200792 if (_moduleProcessThreadPtr)
793 _moduleProcessThreadPtr->DeRegisterModule(_rtpRtcpModule.get());
Niels Möller530ead42018-10-04 14:28:39 +0200794}
795
Niels Möller26815232018-11-16 09:32:40 +0100796void ChannelSend::StartSend() {
Niels Möllerdced9f62018-11-19 10:27:07 +0100797 RTC_DCHECK(worker_thread_checker_.CalledOnValidThread());
Fredrik Solenbergeb134842018-11-19 14:13:15 +0100798 RTC_DCHECK(!sending_);
799 sending_ = true;
Niels Möller530ead42018-10-04 14:28:39 +0200800
801 // Resume the previous sequence number which was reset by StopSend(). This
802 // needs to be done before |sending| is set to true on the RTP/RTCP module.
803 if (send_sequence_number_) {
804 _rtpRtcpModule->SetSequenceNumber(send_sequence_number_);
805 }
806 _rtpRtcpModule->SetSendingMediaStatus(true);
Niels Möller26815232018-11-16 09:32:40 +0100807 int ret = _rtpRtcpModule->SetSendingStatus(true);
808 RTC_DCHECK_EQ(0, ret);
Niels Möller530ead42018-10-04 14:28:39 +0200809 {
810 // It is now OK to start posting tasks to the encoder task queue.
811 rtc::CritScope cs(&encoder_queue_lock_);
812 encoder_queue_is_active_ = true;
813 }
Niels Möller530ead42018-10-04 14:28:39 +0200814}
815
816void ChannelSend::StopSend() {
Niels Möllerdced9f62018-11-19 10:27:07 +0100817 RTC_DCHECK(worker_thread_checker_.CalledOnValidThread());
Fredrik Solenbergeb134842018-11-19 14:13:15 +0100818 if (!sending_) {
Niels Möller530ead42018-10-04 14:28:39 +0200819 return;
820 }
Fredrik Solenbergeb134842018-11-19 14:13:15 +0100821 sending_ = false;
Niels Möller530ead42018-10-04 14:28:39 +0200822
823 // Post a task to the encoder thread which sets an event when the task is
824 // executed. We know that no more encoding tasks will be added to the task
825 // queue for this channel since sending is now deactivated. It means that,
826 // if we wait for the event to bet set, we know that no more pending tasks
827 // exists and it is therfore guaranteed that the task queue will never try
828 // to acccess and invalid channel object.
829 RTC_DCHECK(encoder_queue_);
830
Niels Möllerc572ff32018-11-07 08:43:50 +0100831 rtc::Event flush;
Niels Möller530ead42018-10-04 14:28:39 +0200832 {
833 // Clear |encoder_queue_is_active_| under lock to prevent any other tasks
834 // than this final "flush task" to be posted on the queue.
835 rtc::CritScope cs(&encoder_queue_lock_);
836 encoder_queue_is_active_ = false;
837 encoder_queue_->PostTask([&flush]() { flush.Set(); });
838 }
839 flush.Wait(rtc::Event::kForever);
840
841 // Store the sequence number to be able to pick up the same sequence for
842 // the next StartSend(). This is needed for restarting device, otherwise
843 // it might cause libSRTP to complain about packets being replayed.
844 // TODO(xians): Remove this workaround after RtpRtcpModule's refactoring
845 // CL is landed. See issue
846 // https://code.google.com/p/webrtc/issues/detail?id=2111 .
847 send_sequence_number_ = _rtpRtcpModule->SequenceNumber();
848
849 // Reset sending SSRC and sequence number and triggers direct transmission
850 // of RTCP BYE
851 if (_rtpRtcpModule->SetSendingStatus(false) == -1) {
852 RTC_DLOG(LS_ERROR) << "StartSend() RTP/RTCP failed to stop sending";
853 }
854 _rtpRtcpModule->SetSendingMediaStatus(false);
855}
856
857bool ChannelSend::SetEncoder(int payload_type,
858 std::unique_ptr<AudioEncoder> encoder) {
Niels Möllerdced9f62018-11-19 10:27:07 +0100859 RTC_DCHECK(worker_thread_checker_.CalledOnValidThread());
Niels Möller530ead42018-10-04 14:28:39 +0200860 RTC_DCHECK_GE(payload_type, 0);
861 RTC_DCHECK_LE(payload_type, 127);
862 // TODO(ossu): Make CodecInsts up, for now: one for the RTP/RTCP module and
863 // one for for us to keep track of sample rate and number of channels, etc.
864
865 // The RTP/RTCP module needs to know the RTP timestamp rate (i.e. clockrate)
866 // as well as some other things, so we collect this info and send it along.
867 CodecInst rtp_codec;
868 rtp_codec.pltype = payload_type;
869 strncpy(rtp_codec.plname, "audio", sizeof(rtp_codec.plname));
870 rtp_codec.plname[sizeof(rtp_codec.plname) - 1] = 0;
871 // Seems unclear if it should be clock rate or sample rate. CodecInst
872 // supposedly carries the sample rate, but only clock rate seems sensible to
873 // send to the RTP/RTCP module.
874 rtp_codec.plfreq = encoder->RtpTimestampRateHz();
875 rtp_codec.pacsize = rtc::CheckedDivExact(
876 static_cast<int>(encoder->Max10MsFramesInAPacket() * rtp_codec.plfreq),
877 100);
878 rtp_codec.channels = encoder->NumChannels();
879 rtp_codec.rate = 0;
880
881 if (_rtpRtcpModule->RegisterSendPayload(rtp_codec) != 0) {
882 _rtpRtcpModule->DeRegisterSendPayload(payload_type);
883 if (_rtpRtcpModule->RegisterSendPayload(rtp_codec) != 0) {
884 RTC_DLOG(LS_ERROR)
885 << "SetEncoder() failed to register codec to RTP/RTCP module";
886 return false;
887 }
888 }
889
Niels Möller7d76a312018-10-26 12:57:07 +0200890 if (media_transport_) {
891 rtc::CritScope cs(&media_transport_lock_);
892 media_transport_payload_type_ = payload_type;
893 // TODO(nisse): Currently broken for G722, since timestamps passed through
894 // encoder use RTP clock rather than sample count, and they differ for G722.
895 media_transport_sampling_frequency_ = encoder->RtpTimestampRateHz();
896 }
Niels Möller530ead42018-10-04 14:28:39 +0200897 audio_coding_->SetEncoder(std::move(encoder));
898 return true;
899}
900
901void ChannelSend::ModifyEncoder(
902 rtc::FunctionView<void(std::unique_ptr<AudioEncoder>*)> modifier) {
Niels Möllerdced9f62018-11-19 10:27:07 +0100903 RTC_DCHECK(worker_thread_checker_.CalledOnValidThread());
Niels Möller530ead42018-10-04 14:28:39 +0200904 audio_coding_->ModifyEncoder(modifier);
905}
906
Niels Möllerdced9f62018-11-19 10:27:07 +0100907void ChannelSend::SetBitrate(int bitrate_bps, int64_t probing_interval_ms) {
908 // This method can be called on the worker thread, module process thread
909 // or on a TaskQueue via VideoSendStreamImpl::OnEncoderConfigurationChanged.
910 // TODO(solenberg): Figure out a good way to check this or enforce calling
911 // rules.
912 // RTC_DCHECK(worker_thread_checker_.CalledOnValidThread() ||
913 // module_process_thread_checker_.CalledOnValidThread());
Piotr (Peter) Slatala1eebec92018-11-16 09:03:35 -0800914 rtc::CritScope lock(&bitrate_crit_section_);
Niels Möllerdced9f62018-11-19 10:27:07 +0100915
Niels Möller530ead42018-10-04 14:28:39 +0200916 audio_coding_->ModifyEncoder([&](std::unique_ptr<AudioEncoder>* encoder) {
917 if (*encoder) {
918 (*encoder)->OnReceivedUplinkBandwidth(bitrate_bps, probing_interval_ms);
919 }
920 });
921 retransmission_rate_limiter_->SetMaxRate(bitrate_bps);
Sebastian Jansson359d60a2018-10-25 16:22:02 +0200922 configured_bitrate_bps_ = bitrate_bps;
923}
924
Niels Möllerdced9f62018-11-19 10:27:07 +0100925int ChannelSend::GetBitrate() const {
Piotr (Peter) Slatala1eebec92018-11-16 09:03:35 -0800926 rtc::CritScope lock(&bitrate_crit_section_);
Sebastian Jansson359d60a2018-10-25 16:22:02 +0200927 return configured_bitrate_bps_;
Niels Möller530ead42018-10-04 14:28:39 +0200928}
929
930void ChannelSend::OnTwccBasedUplinkPacketLossRate(float packet_loss_rate) {
Niels Möllerdced9f62018-11-19 10:27:07 +0100931 RTC_DCHECK(worker_thread_checker_.CalledOnValidThread());
Niels Möller530ead42018-10-04 14:28:39 +0200932 if (!use_twcc_plr_for_ana_)
933 return;
934 audio_coding_->ModifyEncoder([&](std::unique_ptr<AudioEncoder>* encoder) {
935 if (*encoder) {
936 (*encoder)->OnReceivedUplinkPacketLossFraction(packet_loss_rate);
937 }
938 });
939}
940
941void ChannelSend::OnRecoverableUplinkPacketLossRate(
942 float recoverable_packet_loss_rate) {
Niels Möllerdced9f62018-11-19 10:27:07 +0100943 RTC_DCHECK(worker_thread_checker_.CalledOnValidThread());
Niels Möller530ead42018-10-04 14:28:39 +0200944 audio_coding_->ModifyEncoder([&](std::unique_ptr<AudioEncoder>* encoder) {
945 if (*encoder) {
946 (*encoder)->OnReceivedUplinkRecoverablePacketLossFraction(
947 recoverable_packet_loss_rate);
948 }
949 });
950}
951
952void ChannelSend::OnUplinkPacketLossRate(float packet_loss_rate) {
953 if (use_twcc_plr_for_ana_)
954 return;
955 audio_coding_->ModifyEncoder([&](std::unique_ptr<AudioEncoder>* encoder) {
956 if (*encoder) {
957 (*encoder)->OnReceivedUplinkPacketLossFraction(packet_loss_rate);
958 }
959 });
960}
961
Niels Möller530ead42018-10-04 14:28:39 +0200962void ChannelSend::RegisterTransport(Transport* transport) {
Niels Möllerdced9f62018-11-19 10:27:07 +0100963 RTC_DCHECK(worker_thread_checker_.CalledOnValidThread());
Niels Möller530ead42018-10-04 14:28:39 +0200964 rtc::CritScope cs(&_callbackCritSect);
965 _transportPtr = transport;
966}
967
Niels Möller26815232018-11-16 09:32:40 +0100968// TODO(nisse): Delete always-true return value.
969bool ChannelSend::ReceivedRTCPPacket(const uint8_t* data, size_t length) {
Niels Möllerdced9f62018-11-19 10:27:07 +0100970 // May be called on either worker thread or network thread.
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -0800971 if (media_transport_) {
972 // Ignore RTCP packets while media transport is used.
973 // Those packets should not arrive, but we are seeing occasional packets.
974 return 0;
975 }
976
Niels Möller530ead42018-10-04 14:28:39 +0200977 // Deliver RTCP packet to RTP/RTCP module for parsing
978 _rtpRtcpModule->IncomingRtcpPacket(data, length);
979
980 int64_t rtt = GetRTT();
981 if (rtt == 0) {
982 // Waiting for valid RTT.
Niels Möller26815232018-11-16 09:32:40 +0100983 return true;
Niels Möller530ead42018-10-04 14:28:39 +0200984 }
985
986 int64_t nack_window_ms = rtt;
987 if (nack_window_ms < kMinRetransmissionWindowMs) {
988 nack_window_ms = kMinRetransmissionWindowMs;
989 } else if (nack_window_ms > kMaxRetransmissionWindowMs) {
990 nack_window_ms = kMaxRetransmissionWindowMs;
991 }
992 retransmission_rate_limiter_->SetWindowSize(nack_window_ms);
993
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -0800994 OnReceivedRtt(rtt);
Niels Möller26815232018-11-16 09:32:40 +0100995 return true;
Niels Möller530ead42018-10-04 14:28:39 +0200996}
997
998void ChannelSend::SetInputMute(bool enable) {
Niels Möllerdced9f62018-11-19 10:27:07 +0100999 RTC_DCHECK(worker_thread_checker_.CalledOnValidThread());
Niels Möller530ead42018-10-04 14:28:39 +02001000 rtc::CritScope cs(&volume_settings_critsect_);
1001 input_mute_ = enable;
1002}
1003
1004bool ChannelSend::InputMute() const {
1005 rtc::CritScope cs(&volume_settings_critsect_);
1006 return input_mute_;
1007}
1008
Niels Möller26815232018-11-16 09:32:40 +01001009bool ChannelSend::SendTelephoneEventOutband(int event, int duration_ms) {
Niels Möllerdced9f62018-11-19 10:27:07 +01001010 RTC_DCHECK(worker_thread_checker_.CalledOnValidThread());
Niels Möller530ead42018-10-04 14:28:39 +02001011 RTC_DCHECK_LE(0, event);
1012 RTC_DCHECK_GE(255, event);
1013 RTC_DCHECK_LE(0, duration_ms);
1014 RTC_DCHECK_GE(65535, duration_ms);
Fredrik Solenbergeb134842018-11-19 14:13:15 +01001015 if (!sending_) {
Niels Möller26815232018-11-16 09:32:40 +01001016 return false;
Niels Möller530ead42018-10-04 14:28:39 +02001017 }
1018 if (_rtpRtcpModule->SendTelephoneEventOutband(
1019 event, duration_ms, kTelephoneEventAttenuationdB) != 0) {
1020 RTC_DLOG(LS_ERROR) << "SendTelephoneEventOutband() failed to send event";
Niels Möller26815232018-11-16 09:32:40 +01001021 return false;
Niels Möller530ead42018-10-04 14:28:39 +02001022 }
Niels Möller26815232018-11-16 09:32:40 +01001023 return true;
Niels Möller530ead42018-10-04 14:28:39 +02001024}
1025
Niels Möller26815232018-11-16 09:32:40 +01001026bool ChannelSend::SetSendTelephoneEventPayloadType(int payload_type,
1027 int payload_frequency) {
Niels Möllerdced9f62018-11-19 10:27:07 +01001028 RTC_DCHECK(worker_thread_checker_.CalledOnValidThread());
Niels Möller530ead42018-10-04 14:28:39 +02001029 RTC_DCHECK_LE(0, payload_type);
1030 RTC_DCHECK_GE(127, payload_type);
1031 CodecInst codec = {0};
1032 codec.pltype = payload_type;
1033 codec.plfreq = payload_frequency;
1034 memcpy(codec.plname, "telephone-event", 16);
1035 if (_rtpRtcpModule->RegisterSendPayload(codec) != 0) {
1036 _rtpRtcpModule->DeRegisterSendPayload(codec.pltype);
1037 if (_rtpRtcpModule->RegisterSendPayload(codec) != 0) {
1038 RTC_DLOG(LS_ERROR)
1039 << "SetSendTelephoneEventPayloadType() failed to register "
1040 "send payload type";
Niels Möller26815232018-11-16 09:32:40 +01001041 return false;
Niels Möller530ead42018-10-04 14:28:39 +02001042 }
1043 }
Niels Möller26815232018-11-16 09:32:40 +01001044 return true;
Niels Möller530ead42018-10-04 14:28:39 +02001045}
1046
Niels Möllerdced9f62018-11-19 10:27:07 +01001047void ChannelSend::SetLocalSSRC(uint32_t ssrc) {
1048 RTC_DCHECK(worker_thread_checker_.CalledOnValidThread());
Fredrik Solenbergeb134842018-11-19 14:13:15 +01001049 RTC_DCHECK(!sending_);
Niels Möller26815232018-11-16 09:32:40 +01001050
Niels Möller7d76a312018-10-26 12:57:07 +02001051 if (media_transport_) {
1052 rtc::CritScope cs(&media_transport_lock_);
1053 media_transport_channel_id_ = ssrc;
1054 }
Niels Möller530ead42018-10-04 14:28:39 +02001055 _rtpRtcpModule->SetSSRC(ssrc);
Niels Möller530ead42018-10-04 14:28:39 +02001056}
1057
1058void ChannelSend::SetMid(const std::string& mid, int extension_id) {
Niels Möllerdced9f62018-11-19 10:27:07 +01001059 RTC_DCHECK(worker_thread_checker_.CalledOnValidThread());
Niels Möller530ead42018-10-04 14:28:39 +02001060 int ret = SetSendRtpHeaderExtension(true, kRtpExtensionMid, extension_id);
1061 RTC_DCHECK_EQ(0, ret);
1062 _rtpRtcpModule->SetMid(mid);
1063}
1064
Johannes Kron9190b822018-10-29 11:22:05 +01001065void ChannelSend::SetExtmapAllowMixed(bool extmap_allow_mixed) {
Niels Möllerdced9f62018-11-19 10:27:07 +01001066 RTC_DCHECK(worker_thread_checker_.CalledOnValidThread());
Johannes Kron9190b822018-10-29 11:22:05 +01001067 _rtpRtcpModule->SetExtmapAllowMixed(extmap_allow_mixed);
1068}
1069
Niels Möller26815232018-11-16 09:32:40 +01001070void ChannelSend::SetSendAudioLevelIndicationStatus(bool enable, int id) {
Niels Möllerdced9f62018-11-19 10:27:07 +01001071 RTC_DCHECK(worker_thread_checker_.CalledOnValidThread());
Niels Möller530ead42018-10-04 14:28:39 +02001072 _includeAudioLevelIndication = enable;
Niels Möller26815232018-11-16 09:32:40 +01001073 int ret = SetSendRtpHeaderExtension(enable, kRtpExtensionAudioLevel, id);
1074 RTC_DCHECK_EQ(0, ret);
Niels Möller530ead42018-10-04 14:28:39 +02001075}
1076
1077void ChannelSend::EnableSendTransportSequenceNumber(int id) {
Niels Möllerdced9f62018-11-19 10:27:07 +01001078 RTC_DCHECK(worker_thread_checker_.CalledOnValidThread());
Niels Möller530ead42018-10-04 14:28:39 +02001079 int ret =
1080 SetSendRtpHeaderExtension(true, kRtpExtensionTransportSequenceNumber, id);
1081 RTC_DCHECK_EQ(0, ret);
1082}
1083
1084void ChannelSend::RegisterSenderCongestionControlObjects(
1085 RtpTransportControllerSendInterface* transport,
1086 RtcpBandwidthObserver* bandwidth_observer) {
Niels Möllerdced9f62018-11-19 10:27:07 +01001087 RTC_DCHECK(worker_thread_checker_.CalledOnValidThread());
Niels Möller530ead42018-10-04 14:28:39 +02001088 RtpPacketSender* rtp_packet_sender = transport->packet_sender();
1089 TransportFeedbackObserver* transport_feedback_observer =
1090 transport->transport_feedback_observer();
1091 PacketRouter* packet_router = transport->packet_router();
1092
1093 RTC_DCHECK(rtp_packet_sender);
1094 RTC_DCHECK(transport_feedback_observer);
1095 RTC_DCHECK(packet_router);
1096 RTC_DCHECK(!packet_router_);
1097 rtcp_observer_->SetBandwidthObserver(bandwidth_observer);
1098 feedback_observer_proxy_->SetTransportFeedbackObserver(
1099 transport_feedback_observer);
1100 seq_num_allocator_proxy_->SetSequenceNumberAllocator(packet_router);
1101 rtp_packet_sender_proxy_->SetPacketSender(rtp_packet_sender);
1102 _rtpRtcpModule->SetStorePacketsStatus(true, 600);
1103 constexpr bool remb_candidate = false;
1104 packet_router->AddSendRtpModule(_rtpRtcpModule.get(), remb_candidate);
1105 packet_router_ = packet_router;
1106}
1107
1108void ChannelSend::ResetSenderCongestionControlObjects() {
Niels Möllerdced9f62018-11-19 10:27:07 +01001109 RTC_DCHECK(worker_thread_checker_.CalledOnValidThread());
Niels Möller530ead42018-10-04 14:28:39 +02001110 RTC_DCHECK(packet_router_);
1111 _rtpRtcpModule->SetStorePacketsStatus(false, 600);
1112 rtcp_observer_->SetBandwidthObserver(nullptr);
1113 feedback_observer_proxy_->SetTransportFeedbackObserver(nullptr);
1114 seq_num_allocator_proxy_->SetSequenceNumberAllocator(nullptr);
1115 packet_router_->RemoveSendRtpModule(_rtpRtcpModule.get());
1116 packet_router_ = nullptr;
1117 rtp_packet_sender_proxy_->SetPacketSender(nullptr);
1118}
1119
Niels Möller26815232018-11-16 09:32:40 +01001120void ChannelSend::SetRTCP_CNAME(absl::string_view c_name) {
Niels Möllerdced9f62018-11-19 10:27:07 +01001121 RTC_DCHECK(worker_thread_checker_.CalledOnValidThread());
Niels Möller26815232018-11-16 09:32:40 +01001122 // Note: SetCNAME() accepts a c string of length at most 255.
1123 const std::string c_name_limited(c_name.substr(0, 255));
1124 int ret = _rtpRtcpModule->SetCNAME(c_name_limited.c_str()) != 0;
1125 RTC_DCHECK_EQ(0, ret) << "SetRTCP_CNAME() failed to set RTCP CNAME";
Niels Möller530ead42018-10-04 14:28:39 +02001126}
1127
Niels Möller26815232018-11-16 09:32:40 +01001128std::vector<ReportBlock> ChannelSend::GetRemoteRTCPReportBlocks() const {
Niels Möllerdced9f62018-11-19 10:27:07 +01001129 RTC_DCHECK(worker_thread_checker_.CalledOnValidThread());
Niels Möller530ead42018-10-04 14:28:39 +02001130 // Get the report blocks from the latest received RTCP Sender or Receiver
1131 // Report. Each element in the vector contains the sender's SSRC and a
1132 // report block according to RFC 3550.
1133 std::vector<RTCPReportBlock> rtcp_report_blocks;
Niels Möller530ead42018-10-04 14:28:39 +02001134
Niels Möller26815232018-11-16 09:32:40 +01001135 int ret = _rtpRtcpModule->RemoteRTCPStat(&rtcp_report_blocks);
1136 RTC_DCHECK_EQ(0, ret);
1137
1138 std::vector<ReportBlock> report_blocks;
Niels Möller530ead42018-10-04 14:28:39 +02001139
1140 std::vector<RTCPReportBlock>::const_iterator it = rtcp_report_blocks.begin();
1141 for (; it != rtcp_report_blocks.end(); ++it) {
1142 ReportBlock report_block;
1143 report_block.sender_SSRC = it->sender_ssrc;
1144 report_block.source_SSRC = it->source_ssrc;
1145 report_block.fraction_lost = it->fraction_lost;
1146 report_block.cumulative_num_packets_lost = it->packets_lost;
1147 report_block.extended_highest_sequence_number =
1148 it->extended_highest_sequence_number;
1149 report_block.interarrival_jitter = it->jitter;
1150 report_block.last_SR_timestamp = it->last_sender_report_timestamp;
1151 report_block.delay_since_last_SR = it->delay_since_last_sender_report;
Niels Möller26815232018-11-16 09:32:40 +01001152 report_blocks.push_back(report_block);
Niels Möller530ead42018-10-04 14:28:39 +02001153 }
Niels Möller26815232018-11-16 09:32:40 +01001154 return report_blocks;
Niels Möller530ead42018-10-04 14:28:39 +02001155}
1156
Niels Möller26815232018-11-16 09:32:40 +01001157CallSendStatistics ChannelSend::GetRTCPStatistics() const {
Niels Möllerdced9f62018-11-19 10:27:07 +01001158 RTC_DCHECK(worker_thread_checker_.CalledOnValidThread());
Niels Möller26815232018-11-16 09:32:40 +01001159 CallSendStatistics stats = {0};
Niels Möller530ead42018-10-04 14:28:39 +02001160 stats.rttMs = GetRTT();
1161
Niels Möller530ead42018-10-04 14:28:39 +02001162 size_t bytesSent(0);
1163 uint32_t packetsSent(0);
1164
1165 if (_rtpRtcpModule->DataCountersRTP(&bytesSent, &packetsSent) != 0) {
1166 RTC_DLOG(LS_WARNING)
1167 << "GetRTPStatistics() failed to retrieve RTP datacounters"
1168 << " => output will not be complete";
1169 }
1170
1171 stats.bytesSent = bytesSent;
1172 stats.packetsSent = packetsSent;
1173
Niels Möller26815232018-11-16 09:32:40 +01001174 return stats;
Niels Möller530ead42018-10-04 14:28:39 +02001175}
1176
Niels Möllerdced9f62018-11-19 10:27:07 +01001177void ChannelSend::SetNACKStatus(bool enable, int max_packets) {
1178 RTC_DCHECK(worker_thread_checker_.CalledOnValidThread());
Niels Möller530ead42018-10-04 14:28:39 +02001179 // None of these functions can fail.
1180 if (enable)
Niels Möllerdced9f62018-11-19 10:27:07 +01001181 audio_coding_->EnableNack(max_packets);
Niels Möller530ead42018-10-04 14:28:39 +02001182 else
1183 audio_coding_->DisableNack();
1184}
1185
1186// Called when we are missing one or more packets.
1187int ChannelSend::ResendPackets(const uint16_t* sequence_numbers, int length) {
1188 return _rtpRtcpModule->SendNACK(sequence_numbers, length);
1189}
1190
1191void ChannelSend::ProcessAndEncodeAudio(
1192 std::unique_ptr<AudioFrame> audio_frame) {
Niels Möllerdced9f62018-11-19 10:27:07 +01001193 RTC_DCHECK_RUNS_SERIALIZED(&audio_thread_race_checker_);
Niels Möller530ead42018-10-04 14:28:39 +02001194 // Avoid posting any new tasks if sending was already stopped in StopSend().
1195 rtc::CritScope cs(&encoder_queue_lock_);
1196 if (!encoder_queue_is_active_) {
1197 return;
1198 }
1199 // Profile time between when the audio frame is added to the task queue and
1200 // when the task is actually executed.
1201 audio_frame->UpdateProfileTimeStamp();
1202 encoder_queue_->PostTask(std::unique_ptr<rtc::QueuedTask>(
1203 new ProcessAndEncodeAudioTask(std::move(audio_frame), this)));
1204}
1205
1206void ChannelSend::ProcessAndEncodeAudioOnTaskQueue(AudioFrame* audio_input) {
1207 RTC_DCHECK_RUN_ON(encoder_queue_);
1208 RTC_DCHECK_GT(audio_input->samples_per_channel_, 0);
1209 RTC_DCHECK_LE(audio_input->num_channels_, 2);
1210
1211 // Measure time between when the audio frame is added to the task queue and
1212 // when the task is actually executed. Goal is to keep track of unwanted
1213 // extra latency added by the task queue.
1214 RTC_HISTOGRAM_COUNTS_10000("WebRTC.Audio.EncodingTaskQueueLatencyMs",
1215 audio_input->ElapsedProfileTimeMs());
1216
1217 bool is_muted = InputMute();
1218 AudioFrameOperations::Mute(audio_input, previous_frame_muted_, is_muted);
1219
1220 if (_includeAudioLevelIndication) {
1221 size_t length =
1222 audio_input->samples_per_channel_ * audio_input->num_channels_;
1223 RTC_CHECK_LE(length, AudioFrame::kMaxDataSizeBytes);
1224 if (is_muted && previous_frame_muted_) {
1225 rms_level_.AnalyzeMuted(length);
1226 } else {
1227 rms_level_.Analyze(
1228 rtc::ArrayView<const int16_t>(audio_input->data(), length));
1229 }
1230 }
1231 previous_frame_muted_ = is_muted;
1232
1233 // Add 10ms of raw (PCM) audio data to the encoder @ 32kHz.
1234
1235 // The ACM resamples internally.
1236 audio_input->timestamp_ = _timeStamp;
1237 // This call will trigger AudioPacketizationCallback::SendData if encoding
1238 // is done and payload is ready for packetization and transmission.
1239 // Otherwise, it will return without invoking the callback.
1240 if (audio_coding_->Add10MsData(*audio_input) < 0) {
1241 RTC_DLOG(LS_ERROR) << "ACM::Add10MsData() failed.";
1242 return;
1243 }
1244
1245 _timeStamp += static_cast<uint32_t>(audio_input->samples_per_channel_);
1246}
1247
1248void ChannelSend::UpdateOverheadForEncoder() {
1249 size_t overhead_per_packet =
1250 transport_overhead_per_packet_ + rtp_overhead_per_packet_;
1251 audio_coding_->ModifyEncoder([&](std::unique_ptr<AudioEncoder>* encoder) {
1252 if (*encoder) {
1253 (*encoder)->OnReceivedOverhead(overhead_per_packet);
1254 }
1255 });
1256}
1257
1258void ChannelSend::SetTransportOverhead(size_t transport_overhead_per_packet) {
Niels Möllerdced9f62018-11-19 10:27:07 +01001259 RTC_DCHECK(worker_thread_checker_.CalledOnValidThread());
Niels Möller530ead42018-10-04 14:28:39 +02001260 rtc::CritScope cs(&overhead_per_packet_lock_);
1261 transport_overhead_per_packet_ = transport_overhead_per_packet;
1262 UpdateOverheadForEncoder();
1263}
1264
1265// TODO(solenberg): Make AudioSendStream an OverheadObserver instead.
1266void ChannelSend::OnOverheadChanged(size_t overhead_bytes_per_packet) {
1267 rtc::CritScope cs(&overhead_per_packet_lock_);
1268 rtp_overhead_per_packet_ = overhead_bytes_per_packet;
1269 UpdateOverheadForEncoder();
1270}
1271
1272ANAStats ChannelSend::GetANAStatistics() const {
Niels Möllerdced9f62018-11-19 10:27:07 +01001273 RTC_DCHECK(worker_thread_checker_.CalledOnValidThread());
Niels Möller530ead42018-10-04 14:28:39 +02001274 return audio_coding_->GetANAStats();
1275}
1276
1277RtpRtcp* ChannelSend::GetRtpRtcp() const {
Niels Möllerdced9f62018-11-19 10:27:07 +01001278 RTC_DCHECK(module_process_thread_checker_.CalledOnValidThread());
Niels Möller530ead42018-10-04 14:28:39 +02001279 return _rtpRtcpModule.get();
1280}
1281
1282int ChannelSend::SetSendRtpHeaderExtension(bool enable,
1283 RTPExtensionType type,
Niels Möller26815232018-11-16 09:32:40 +01001284 int id) {
Niels Möller530ead42018-10-04 14:28:39 +02001285 int error = 0;
1286 _rtpRtcpModule->DeregisterSendRtpHeaderExtension(type);
1287 if (enable) {
Niels Möller26815232018-11-16 09:32:40 +01001288 // TODO(nisse): RtpRtcp::RegisterSendRtpHeaderExtension to take an int
1289 // argument. Currently it wants an uint8_t.
1290 error = _rtpRtcpModule->RegisterSendRtpHeaderExtension(
1291 type, rtc::dchecked_cast<uint8_t>(id));
Niels Möller530ead42018-10-04 14:28:39 +02001292 }
1293 return error;
1294}
1295
1296int ChannelSend::GetRtpTimestampRateHz() const {
1297 const auto format = audio_coding_->ReceiveFormat();
1298 // Default to the playout frequency if we've not gotten any packets yet.
1299 // TODO(ossu): Zero clockrate can only happen if we've added an external
1300 // decoder for a format we don't support internally. Remove once that way of
1301 // adding decoders is gone!
1302 return (format && format->clockrate_hz != 0)
1303 ? format->clockrate_hz
1304 : audio_coding_->PlayoutFrequency();
1305}
1306
1307int64_t ChannelSend::GetRTT() const {
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -08001308 if (media_transport_) {
1309 // GetRTT is generally used in the RTCP codepath, where media transport is
1310 // not present and so it shouldn't be needed. But it's also invoked in
1311 // 'GetStats' method, and for now returning media transport RTT here gives
1312 // us "free" rtt stats for media transport.
1313 auto target_rate = media_transport_->GetLatestTargetTransferRate();
1314 if (target_rate.has_value()) {
1315 return target_rate.value().network_estimate.round_trip_time.ms();
1316 }
1317
1318 return 0;
1319 }
Niels Möller530ead42018-10-04 14:28:39 +02001320 RtcpMode method = _rtpRtcpModule->RTCP();
1321 if (method == RtcpMode::kOff) {
1322 return 0;
1323 }
1324 std::vector<RTCPReportBlock> report_blocks;
1325 _rtpRtcpModule->RemoteRTCPStat(&report_blocks);
1326
1327 if (report_blocks.empty()) {
1328 return 0;
1329 }
1330
1331 int64_t rtt = 0;
1332 int64_t avg_rtt = 0;
1333 int64_t max_rtt = 0;
1334 int64_t min_rtt = 0;
1335 // We don't know in advance the remote ssrc used by the other end's receiver
1336 // reports, so use the SSRC of the first report block for calculating the RTT.
1337 if (_rtpRtcpModule->RTT(report_blocks[0].sender_ssrc, &rtt, &avg_rtt,
1338 &min_rtt, &max_rtt) != 0) {
1339 return 0;
1340 }
1341 return rtt;
1342}
1343
Benjamin Wright78410ad2018-10-25 09:52:57 -07001344void ChannelSend::SetFrameEncryptor(
1345 rtc::scoped_refptr<FrameEncryptorInterface> frame_encryptor) {
Niels Möllerdced9f62018-11-19 10:27:07 +01001346 RTC_DCHECK(worker_thread_checker_.CalledOnValidThread());
Benjamin Wright84583f62018-10-04 14:22:34 -07001347 rtc::CritScope cs(&encoder_queue_lock_);
1348 if (encoder_queue_is_active_) {
1349 encoder_queue_->PostTask([this, frame_encryptor]() {
Benjamin Wright78410ad2018-10-25 09:52:57 -07001350 this->frame_encryptor_ = std::move(frame_encryptor);
Benjamin Wright84583f62018-10-04 14:22:34 -07001351 });
1352 } else {
Benjamin Wright78410ad2018-10-25 09:52:57 -07001353 frame_encryptor_ = std::move(frame_encryptor);
Benjamin Wright84583f62018-10-04 14:22:34 -07001354 }
1355}
1356
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -08001357void ChannelSend::OnTargetTransferRate(TargetTransferRate rate) {
1358 RTC_DCHECK(media_transport_);
1359 OnReceivedRtt(rate.network_estimate.round_trip_time.ms());
1360}
1361
1362void ChannelSend::OnReceivedRtt(int64_t rtt_ms) {
1363 // Invoke audio encoders OnReceivedRtt().
1364 audio_coding_->ModifyEncoder(
1365 [rtt_ms](std::unique_ptr<AudioEncoder>* encoder) {
1366 if (*encoder) {
1367 (*encoder)->OnReceivedRtt(rtt_ms);
1368 }
1369 });
1370}
1371
Niels Möllerdced9f62018-11-19 10:27:07 +01001372} // namespace
1373
1374std::unique_ptr<ChannelSendInterface> CreateChannelSend(
1375 rtc::TaskQueue* encoder_queue,
1376 ProcessThread* module_process_thread,
1377 MediaTransportInterface* media_transport,
1378 RtcpRttStats* rtcp_rtt_stats,
1379 RtcEventLog* rtc_event_log,
1380 FrameEncryptorInterface* frame_encryptor,
1381 const webrtc::CryptoOptions& crypto_options,
1382 bool extmap_allow_mixed,
1383 int rtcp_report_interval_ms) {
1384 return absl::make_unique<ChannelSend>(
1385 encoder_queue, module_process_thread, media_transport, rtcp_rtt_stats,
1386 rtc_event_log, frame_encryptor, crypto_options, extmap_allow_mixed,
1387 rtcp_report_interval_ms);
1388}
1389
Niels Möller530ead42018-10-04 14:28:39 +02001390} // namespace voe
1391} // namespace webrtc