blob: dfbbb5799f830c01cb92efc59a3f3aebb2e41ff8 [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"
Steve Anton10542f22019-01-11 09:11:00 -080023#include "api/crypto/frame_encryptor_interface.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"
26#include "logging/rtc_event_log/events/rtc_event_audio_playout.h"
27#include "logging/rtc_event_log/rtc_event_log.h"
28#include "modules/audio_coding/audio_network_adaptor/include/audio_network_adaptor_config.h"
Niels Möllerdced9f62018-11-19 10:27:07 +010029#include "modules/audio_coding/include/audio_coding_module.h"
30#include "modules/audio_processing/rms_level.h"
Niels Möller530ead42018-10-04 14:28:39 +020031#include "modules/pacing/packet_router.h"
32#include "modules/utility/include/process_thread.h"
33#include "rtc_base/checks.h"
Steve Anton10542f22019-01-11 09:11:00 -080034#include "rtc_base/critical_section.h"
Yves Gerey2e00abc2018-10-05 15:39:24 +020035#include "rtc_base/event.h"
Niels Möller530ead42018-10-04 14:28:39 +020036#include "rtc_base/format_macros.h"
37#include "rtc_base/location.h"
38#include "rtc_base/logging.h"
Niels Möller26815232018-11-16 09:32:40 +010039#include "rtc_base/numerics/safe_conversions.h"
Niels Möllerdced9f62018-11-19 10:27:07 +010040#include "rtc_base/race_checker.h"
Niels Möller530ead42018-10-04 14:28:39 +020041#include "rtc_base/rate_limiter.h"
42#include "rtc_base/task_queue.h"
43#include "rtc_base/thread_checker.h"
Steve Anton10542f22019-01-11 09:11:00 -080044#include "rtc_base/time_utils.h"
Niels Möller530ead42018-10-04 14:28:39 +020045#include "system_wrappers/include/field_trial.h"
46#include "system_wrappers/include/metrics.h"
47
48namespace webrtc {
49namespace voe {
50
51namespace {
52
53constexpr int64_t kMaxRetransmissionWindowMs = 1000;
54constexpr int64_t kMinRetransmissionWindowMs = 30;
55
Niels Möller7d76a312018-10-26 12:57:07 +020056MediaTransportEncodedAudioFrame::FrameType
57MediaTransportFrameTypeForWebrtcFrameType(webrtc::FrameType frame_type) {
58 switch (frame_type) {
59 case kAudioFrameSpeech:
60 return MediaTransportEncodedAudioFrame::FrameType::kSpeech;
61 break;
62
63 case kAudioFrameCN:
64 return MediaTransportEncodedAudioFrame::FrameType::
65 kDiscontinuousTransmission;
66 break;
67
68 default:
69 RTC_CHECK(false) << "Unexpected frame type=" << frame_type;
70 break;
71 }
72}
73
Niels Möllerdced9f62018-11-19 10:27:07 +010074class RtpPacketSenderProxy;
75class TransportFeedbackProxy;
76class TransportSequenceNumberProxy;
77class VoERtcpObserver;
78
Niels Möllerdced9f62018-11-19 10:27:07 +010079class ChannelSend
80 : public ChannelSendInterface,
Niels Möllerdced9f62018-11-19 10:27:07 +010081 public AudioPacketizationCallback, // receive encoded packets from the
82 // ACM
83 public TargetTransferRateObserver {
84 public:
85 // TODO(nisse): Make OnUplinkPacketLossRate public, and delete friend
86 // declaration.
87 friend class VoERtcpObserver;
88
89 ChannelSend(rtc::TaskQueue* encoder_queue,
90 ProcessThread* module_process_thread,
91 MediaTransportInterface* media_transport,
Anton Sukhanov626015d2019-02-04 15:16:06 -080092 OverheadObserver* overhead_observer,
Niels Möllere9771992018-11-26 10:55:07 +010093 Transport* rtp_transport,
Niels Möllerdced9f62018-11-19 10:27:07 +010094 RtcpRttStats* rtcp_rtt_stats,
95 RtcEventLog* rtc_event_log,
96 FrameEncryptorInterface* frame_encryptor,
97 const webrtc::CryptoOptions& crypto_options,
98 bool extmap_allow_mixed,
99 int rtcp_report_interval_ms);
100
101 ~ChannelSend() override;
102
103 // Send using this encoder, with this payload type.
104 bool SetEncoder(int payload_type,
105 std::unique_ptr<AudioEncoder> encoder) override;
106 void ModifyEncoder(rtc::FunctionView<void(std::unique_ptr<AudioEncoder>*)>
107 modifier) override;
108
109 // API methods
Niels Möllerdced9f62018-11-19 10:27:07 +0100110 void StartSend() override;
111 void StopSend() override;
112
113 // Codecs
Sebastian Jansson254d8692018-11-21 19:19:00 +0100114 void OnBitrateAllocation(BitrateAllocationUpdate update) override;
Niels Möllerdced9f62018-11-19 10:27:07 +0100115 int GetBitrate() const override;
116
117 // Network
Niels Möllerdced9f62018-11-19 10:27:07 +0100118 bool ReceivedRTCPPacket(const uint8_t* data, size_t length) override;
119
120 // Muting, Volume and Level.
121 void SetInputMute(bool enable) override;
122
123 // Stats.
124 ANAStats GetANAStatistics() const override;
125
126 // Used by AudioSendStream.
127 RtpRtcp* GetRtpRtcp() const override;
128
129 // DTMF.
130 bool SendTelephoneEventOutband(int event, int duration_ms) override;
131 bool SetSendTelephoneEventPayloadType(int payload_type,
132 int payload_frequency) override;
133
134 // RTP+RTCP
135 void SetLocalSSRC(uint32_t ssrc) override;
Amit Hilbuch77938e62018-12-21 09:23:38 -0800136 void SetRid(const std::string& rid,
137 int extension_id,
138 int repaired_extension_id) override;
Niels Möllerdced9f62018-11-19 10:27:07 +0100139 void SetMid(const std::string& mid, int extension_id) override;
140 void SetExtmapAllowMixed(bool extmap_allow_mixed) override;
141 void SetSendAudioLevelIndicationStatus(bool enable, int id) override;
142 void EnableSendTransportSequenceNumber(int id) override;
143
144 void RegisterSenderCongestionControlObjects(
145 RtpTransportControllerSendInterface* transport,
146 RtcpBandwidthObserver* bandwidth_observer) override;
147 void ResetSenderCongestionControlObjects() override;
148 void SetRTCP_CNAME(absl::string_view c_name) override;
149 std::vector<ReportBlock> GetRemoteRTCPReportBlocks() const override;
150 CallSendStatistics GetRTCPStatistics() const override;
Niels Möllerdced9f62018-11-19 10:27:07 +0100151
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
Niels Möllerdced9f62018-11-19 10:27:07 +0100163 // The existence of this function alongside OnUplinkPacketLossRate is
164 // a compromise. We want the encoder to be agnostic of the PLR source, but
165 // we also don't want it to receive conflicting information from TWCC and
166 // from RTCP-XR.
167 void OnTwccBasedUplinkPacketLossRate(float packet_loss_rate) override;
168
169 void OnRecoverableUplinkPacketLossRate(
170 float recoverable_packet_loss_rate) override;
171
172 int64_t GetRTT() const override;
173
174 // E2EE Custom Audio Frame Encryption
175 void SetFrameEncryptor(
176 rtc::scoped_refptr<FrameEncryptorInterface> frame_encryptor) override;
177
178 private:
179 class ProcessAndEncodeAudioTask;
180
181 // From AudioPacketizationCallback in the ACM
182 int32_t SendData(FrameType frameType,
183 uint8_t payloadType,
184 uint32_t timeStamp,
185 const uint8_t* payloadData,
186 size_t payloadSize,
187 const RTPFragmentationHeader* fragmentation) override;
188
Niels Möllerdced9f62018-11-19 10:27:07 +0100189 void OnUplinkPacketLossRate(float packet_loss_rate);
190 bool InputMute() const;
191
Niels Möllerdced9f62018-11-19 10:27:07 +0100192 int SetSendRtpHeaderExtension(bool enable, RTPExtensionType type, int id);
193
Niels Möllerdced9f62018-11-19 10:27:07 +0100194 int32_t SendRtpAudio(FrameType frameType,
195 uint8_t payloadType,
196 uint32_t timeStamp,
197 rtc::ArrayView<const uint8_t> payload,
198 const RTPFragmentationHeader* fragmentation);
199
200 int32_t SendMediaTransportAudio(FrameType frameType,
201 uint8_t payloadType,
202 uint32_t timeStamp,
203 rtc::ArrayView<const uint8_t> payload,
204 const RTPFragmentationHeader* fragmentation);
205
206 // Return media transport or nullptr if using RTP.
207 MediaTransportInterface* media_transport() { return media_transport_; }
208
209 // Called on the encoder task queue when a new input audio frame is ready
210 // for encoding.
211 void ProcessAndEncodeAudioOnTaskQueue(AudioFrame* audio_input);
212
213 void OnReceivedRtt(int64_t rtt_ms);
214
215 void OnTargetTransferRate(TargetTransferRate) override;
216
217 // Thread checkers document and lock usage of some methods on voe::Channel to
218 // specific threads we know about. The goal is to eventually split up
219 // voe::Channel into parts with single-threaded semantics, and thereby reduce
220 // the need for locks.
221 rtc::ThreadChecker worker_thread_checker_;
222 rtc::ThreadChecker module_process_thread_checker_;
223 // Methods accessed from audio and video threads are checked for sequential-
224 // only access. We don't necessarily own and control these threads, so thread
225 // checkers cannot be used. E.g. Chromium may transfer "ownership" from one
226 // audio thread to another, but access is still sequential.
227 rtc::RaceChecker audio_thread_race_checker_;
228
Niels Möllerdced9f62018-11-19 10:27:07 +0100229 rtc::CriticalSection volume_settings_critsect_;
230
Niels Möller26e88b02018-11-19 15:08:13 +0100231 bool sending_ RTC_GUARDED_BY(&worker_thread_checker_) = false;
Niels Möllerdced9f62018-11-19 10:27:07 +0100232
233 RtcEventLog* const event_log_;
234
235 std::unique_ptr<RtpRtcp> _rtpRtcpModule;
236
237 std::unique_ptr<AudioCodingModule> audio_coding_;
238 uint32_t _timeStamp RTC_GUARDED_BY(encoder_queue_);
239
Niels Möllerdced9f62018-11-19 10:27:07 +0100240 // uses
Niels Möller985a1f32018-11-19 16:08:42 +0100241 ProcessThread* const _moduleProcessThreadPtr;
Niels Möllerdced9f62018-11-19 10:27:07 +0100242 RmsLevel rms_level_ RTC_GUARDED_BY(encoder_queue_);
243 bool input_mute_ RTC_GUARDED_BY(volume_settings_critsect_);
244 bool previous_frame_muted_ RTC_GUARDED_BY(encoder_queue_);
245 // VoeRTP_RTCP
246 // TODO(henrika): can today be accessed on the main thread and on the
247 // task queue; hence potential race.
248 bool _includeAudioLevelIndication;
Anton Sukhanov626015d2019-02-04 15:16:06 -0800249
Niels Möllerdced9f62018-11-19 10:27:07 +0100250 // RtcpBandwidthObserver
Niels Möller985a1f32018-11-19 16:08:42 +0100251 const std::unique_ptr<VoERtcpObserver> rtcp_observer_;
Niels Möllerdced9f62018-11-19 10:27:07 +0100252
Niels Möller985a1f32018-11-19 16:08:42 +0100253 PacketRouter* packet_router_ RTC_GUARDED_BY(&worker_thread_checker_) =
254 nullptr;
255 const std::unique_ptr<TransportFeedbackProxy> feedback_observer_proxy_;
256 const std::unique_ptr<TransportSequenceNumberProxy> seq_num_allocator_proxy_;
257 const std::unique_ptr<RtpPacketSenderProxy> rtp_packet_sender_proxy_;
258 const std::unique_ptr<RateLimiter> retransmission_rate_limiter_;
Niels Möllerdced9f62018-11-19 10:27:07 +0100259
260 rtc::ThreadChecker construction_thread_;
261
262 const bool use_twcc_plr_for_ana_;
263
264 rtc::CriticalSection encoder_queue_lock_;
265 bool encoder_queue_is_active_ RTC_GUARDED_BY(encoder_queue_lock_) = false;
Niels Möller985a1f32018-11-19 16:08:42 +0100266 rtc::TaskQueue* const encoder_queue_ = nullptr;
Niels Möllerdced9f62018-11-19 10:27:07 +0100267
268 MediaTransportInterface* const media_transport_;
269 int media_transport_sequence_number_ RTC_GUARDED_BY(encoder_queue_) = 0;
270
271 rtc::CriticalSection media_transport_lock_;
272 // Currently set by SetLocalSSRC.
273 uint64_t media_transport_channel_id_ RTC_GUARDED_BY(&media_transport_lock_) =
274 0;
275 // Cache payload type and sampling frequency from most recent call to
276 // SetEncoder. Needed to set MediaTransportEncodedAudioFrame metadata, and
277 // invalidate on encoder change.
278 int media_transport_payload_type_ RTC_GUARDED_BY(&media_transport_lock_);
279 int media_transport_sampling_frequency_
280 RTC_GUARDED_BY(&media_transport_lock_);
281
282 // E2EE Audio Frame Encryption
283 rtc::scoped_refptr<FrameEncryptorInterface> frame_encryptor_;
284 // E2EE Frame Encryption Options
Niels Möller985a1f32018-11-19 16:08:42 +0100285 const webrtc::CryptoOptions crypto_options_;
Niels Möllerdced9f62018-11-19 10:27:07 +0100286
287 rtc::CriticalSection bitrate_crit_section_;
288 int configured_bitrate_bps_ RTC_GUARDED_BY(bitrate_crit_section_) = 0;
289};
Niels Möller530ead42018-10-04 14:28:39 +0200290
291const int kTelephoneEventAttenuationdB = 10;
292
293class TransportFeedbackProxy : public TransportFeedbackObserver {
294 public:
295 TransportFeedbackProxy() : feedback_observer_(nullptr) {
296 pacer_thread_.DetachFromThread();
297 network_thread_.DetachFromThread();
298 }
299
300 void SetTransportFeedbackObserver(
301 TransportFeedbackObserver* feedback_observer) {
302 RTC_DCHECK(thread_checker_.CalledOnValidThread());
303 rtc::CritScope lock(&crit_);
304 feedback_observer_ = feedback_observer;
305 }
306
307 // Implements TransportFeedbackObserver.
308 void AddPacket(uint32_t ssrc,
309 uint16_t sequence_number,
310 size_t length,
311 const PacedPacketInfo& pacing_info) override {
312 RTC_DCHECK(pacer_thread_.CalledOnValidThread());
313 rtc::CritScope lock(&crit_);
314 if (feedback_observer_)
315 feedback_observer_->AddPacket(ssrc, sequence_number, length, pacing_info);
316 }
317
318 void OnTransportFeedback(const rtcp::TransportFeedback& feedback) override {
319 RTC_DCHECK(network_thread_.CalledOnValidThread());
320 rtc::CritScope lock(&crit_);
321 if (feedback_observer_)
322 feedback_observer_->OnTransportFeedback(feedback);
323 }
324
325 private:
326 rtc::CriticalSection crit_;
327 rtc::ThreadChecker thread_checker_;
328 rtc::ThreadChecker pacer_thread_;
329 rtc::ThreadChecker network_thread_;
330 TransportFeedbackObserver* feedback_observer_ RTC_GUARDED_BY(&crit_);
331};
332
333class TransportSequenceNumberProxy : public TransportSequenceNumberAllocator {
334 public:
335 TransportSequenceNumberProxy() : seq_num_allocator_(nullptr) {
336 pacer_thread_.DetachFromThread();
337 }
338
339 void SetSequenceNumberAllocator(
340 TransportSequenceNumberAllocator* seq_num_allocator) {
341 RTC_DCHECK(thread_checker_.CalledOnValidThread());
342 rtc::CritScope lock(&crit_);
343 seq_num_allocator_ = seq_num_allocator;
344 }
345
346 // Implements TransportSequenceNumberAllocator.
347 uint16_t AllocateSequenceNumber() override {
348 RTC_DCHECK(pacer_thread_.CalledOnValidThread());
349 rtc::CritScope lock(&crit_);
350 if (!seq_num_allocator_)
351 return 0;
352 return seq_num_allocator_->AllocateSequenceNumber();
353 }
354
355 private:
356 rtc::CriticalSection crit_;
357 rtc::ThreadChecker thread_checker_;
358 rtc::ThreadChecker pacer_thread_;
359 TransportSequenceNumberAllocator* seq_num_allocator_ RTC_GUARDED_BY(&crit_);
360};
361
362class RtpPacketSenderProxy : public RtpPacketSender {
363 public:
364 RtpPacketSenderProxy() : rtp_packet_sender_(nullptr) {}
365
366 void SetPacketSender(RtpPacketSender* rtp_packet_sender) {
367 RTC_DCHECK(thread_checker_.CalledOnValidThread());
368 rtc::CritScope lock(&crit_);
369 rtp_packet_sender_ = rtp_packet_sender;
370 }
371
372 // Implements RtpPacketSender.
373 void InsertPacket(Priority priority,
374 uint32_t ssrc,
375 uint16_t sequence_number,
376 int64_t capture_time_ms,
377 size_t bytes,
378 bool retransmission) override {
379 rtc::CritScope lock(&crit_);
380 if (rtp_packet_sender_) {
381 rtp_packet_sender_->InsertPacket(priority, ssrc, sequence_number,
382 capture_time_ms, bytes, retransmission);
383 }
384 }
385
386 void SetAccountForAudioPackets(bool account_for_audio) override {
387 RTC_NOTREACHED();
388 }
389
390 private:
391 rtc::ThreadChecker thread_checker_;
392 rtc::CriticalSection crit_;
393 RtpPacketSender* rtp_packet_sender_ RTC_GUARDED_BY(&crit_);
394};
395
396class VoERtcpObserver : public RtcpBandwidthObserver {
397 public:
398 explicit VoERtcpObserver(ChannelSend* owner)
399 : owner_(owner), bandwidth_observer_(nullptr) {}
Mirko Bonadeife055c12019-01-29 22:53:28 +0100400 ~VoERtcpObserver() override {}
Niels Möller530ead42018-10-04 14:28:39 +0200401
402 void SetBandwidthObserver(RtcpBandwidthObserver* bandwidth_observer) {
403 rtc::CritScope lock(&crit_);
404 bandwidth_observer_ = bandwidth_observer;
405 }
406
407 void OnReceivedEstimatedBitrate(uint32_t bitrate) override {
408 rtc::CritScope lock(&crit_);
409 if (bandwidth_observer_) {
410 bandwidth_observer_->OnReceivedEstimatedBitrate(bitrate);
411 }
412 }
413
414 void OnReceivedRtcpReceiverReport(const ReportBlockList& report_blocks,
415 int64_t rtt,
416 int64_t now_ms) override {
417 {
418 rtc::CritScope lock(&crit_);
419 if (bandwidth_observer_) {
420 bandwidth_observer_->OnReceivedRtcpReceiverReport(report_blocks, rtt,
421 now_ms);
422 }
423 }
424 // TODO(mflodman): Do we need to aggregate reports here or can we jut send
425 // what we get? I.e. do we ever get multiple reports bundled into one RTCP
426 // report for VoiceEngine?
427 if (report_blocks.empty())
428 return;
429
430 int fraction_lost_aggregate = 0;
431 int total_number_of_packets = 0;
432
433 // If receiving multiple report blocks, calculate the weighted average based
434 // on the number of packets a report refers to.
435 for (ReportBlockList::const_iterator block_it = report_blocks.begin();
436 block_it != report_blocks.end(); ++block_it) {
437 // Find the previous extended high sequence number for this remote SSRC,
438 // to calculate the number of RTP packets this report refers to. Ignore if
439 // we haven't seen this SSRC before.
440 std::map<uint32_t, uint32_t>::iterator seq_num_it =
441 extended_max_sequence_number_.find(block_it->source_ssrc);
442 int number_of_packets = 0;
443 if (seq_num_it != extended_max_sequence_number_.end()) {
444 number_of_packets =
445 block_it->extended_highest_sequence_number - seq_num_it->second;
446 }
447 fraction_lost_aggregate += number_of_packets * block_it->fraction_lost;
448 total_number_of_packets += number_of_packets;
449
450 extended_max_sequence_number_[block_it->source_ssrc] =
451 block_it->extended_highest_sequence_number;
452 }
453 int weighted_fraction_lost = 0;
454 if (total_number_of_packets > 0) {
455 weighted_fraction_lost =
456 (fraction_lost_aggregate + total_number_of_packets / 2) /
457 total_number_of_packets;
458 }
459 owner_->OnUplinkPacketLossRate(weighted_fraction_lost / 255.0f);
460 }
461
462 private:
463 ChannelSend* owner_;
464 // Maps remote side ssrc to extended highest sequence number received.
465 std::map<uint32_t, uint32_t> extended_max_sequence_number_;
466 rtc::CriticalSection crit_;
467 RtcpBandwidthObserver* bandwidth_observer_ RTC_GUARDED_BY(crit_);
468};
469
470class ChannelSend::ProcessAndEncodeAudioTask : public rtc::QueuedTask {
471 public:
472 ProcessAndEncodeAudioTask(std::unique_ptr<AudioFrame> audio_frame,
473 ChannelSend* channel)
474 : audio_frame_(std::move(audio_frame)), channel_(channel) {
475 RTC_DCHECK(channel_);
476 }
477
478 private:
479 bool Run() override {
480 RTC_DCHECK_RUN_ON(channel_->encoder_queue_);
481 channel_->ProcessAndEncodeAudioOnTaskQueue(audio_frame_.get());
482 return true;
483 }
484
485 std::unique_ptr<AudioFrame> audio_frame_;
486 ChannelSend* const channel_;
487};
488
489int32_t ChannelSend::SendData(FrameType frameType,
490 uint8_t payloadType,
491 uint32_t timeStamp,
492 const uint8_t* payloadData,
493 size_t payloadSize,
494 const RTPFragmentationHeader* fragmentation) {
495 RTC_DCHECK_RUN_ON(encoder_queue_);
Niels Möller7d76a312018-10-26 12:57:07 +0200496 rtc::ArrayView<const uint8_t> payload(payloadData, payloadSize);
497
498 if (media_transport() != nullptr) {
499 return SendMediaTransportAudio(frameType, payloadType, timeStamp, payload,
500 fragmentation);
501 } else {
502 return SendRtpAudio(frameType, payloadType, timeStamp, payload,
503 fragmentation);
504 }
505}
506
507int32_t ChannelSend::SendRtpAudio(FrameType frameType,
508 uint8_t payloadType,
509 uint32_t timeStamp,
510 rtc::ArrayView<const uint8_t> payload,
511 const RTPFragmentationHeader* fragmentation) {
512 RTC_DCHECK_RUN_ON(encoder_queue_);
Niels Möller530ead42018-10-04 14:28:39 +0200513 if (_includeAudioLevelIndication) {
514 // Store current audio level in the RTP/RTCP module.
515 // The level will be used in combination with voice-activity state
516 // (frameType) to add an RTP header extension
517 _rtpRtcpModule->SetAudioLevel(rms_level_.Average());
518 }
519
Benjamin Wright84583f62018-10-04 14:22:34 -0700520 // E2EE Custom Audio Frame Encryption (This is optional).
521 // Keep this buffer around for the lifetime of the send call.
522 rtc::Buffer encrypted_audio_payload;
523 if (frame_encryptor_ != nullptr) {
524 // TODO(benwright@webrtc.org) - Allocate enough to always encrypt inline.
525 // Allocate a buffer to hold the maximum possible encrypted payload.
526 size_t max_ciphertext_size = frame_encryptor_->GetMaxCiphertextByteSize(
Niels Möller7d76a312018-10-26 12:57:07 +0200527 cricket::MEDIA_TYPE_AUDIO, payload.size());
Benjamin Wright84583f62018-10-04 14:22:34 -0700528 encrypted_audio_payload.SetSize(max_ciphertext_size);
529
530 // Encrypt the audio payload into the buffer.
531 size_t bytes_written = 0;
532 int encrypt_status = frame_encryptor_->Encrypt(
533 cricket::MEDIA_TYPE_AUDIO, _rtpRtcpModule->SSRC(),
Niels Möller7d76a312018-10-26 12:57:07 +0200534 /*additional_data=*/nullptr, payload, encrypted_audio_payload,
535 &bytes_written);
Benjamin Wright84583f62018-10-04 14:22:34 -0700536 if (encrypt_status != 0) {
537 RTC_DLOG(LS_ERROR) << "Channel::SendData() failed encrypt audio payload: "
538 << encrypt_status;
539 return -1;
540 }
541 // Resize the buffer to the exact number of bytes actually used.
542 encrypted_audio_payload.SetSize(bytes_written);
543 // Rewrite the payloadData and size to the new encrypted payload.
Niels Möller7d76a312018-10-26 12:57:07 +0200544 payload = encrypted_audio_payload;
Benjamin Wrightbfb444c2018-10-15 10:20:24 -0700545 } else if (crypto_options_.sframe.require_frame_encryption) {
546 RTC_DLOG(LS_ERROR) << "Channel::SendData() failed sending audio payload: "
547 << "A frame encryptor is required but one is not set.";
548 return -1;
Benjamin Wright84583f62018-10-04 14:22:34 -0700549 }
550
Niels Möller530ead42018-10-04 14:28:39 +0200551 // Push data from ACM to RTP/RTCP-module to deliver audio frame for
552 // packetization.
553 // This call will trigger Transport::SendPacket() from the RTP/RTCP module.
Niels Möller7d76a312018-10-26 12:57:07 +0200554 if (!_rtpRtcpModule->SendOutgoingData((FrameType&)frameType, payloadType,
555 timeStamp,
556 // Leaving the time when this frame was
557 // received from the capture device as
558 // undefined for voice for now.
559 -1, payload.data(), payload.size(),
560 fragmentation, nullptr, nullptr)) {
Niels Möller530ead42018-10-04 14:28:39 +0200561 RTC_DLOG(LS_ERROR)
562 << "ChannelSend::SendData() failed to send data to RTP/RTCP module";
563 return -1;
564 }
565
566 return 0;
567}
568
Niels Möller7d76a312018-10-26 12:57:07 +0200569int32_t ChannelSend::SendMediaTransportAudio(
570 FrameType frameType,
571 uint8_t payloadType,
572 uint32_t timeStamp,
573 rtc::ArrayView<const uint8_t> payload,
574 const RTPFragmentationHeader* fragmentation) {
575 RTC_DCHECK_RUN_ON(encoder_queue_);
576 // TODO(nisse): Use null _transportPtr for MediaTransport.
577 // RTC_DCHECK(_transportPtr == nullptr);
578 uint64_t channel_id;
579 int sampling_rate_hz;
580 {
581 rtc::CritScope cs(&media_transport_lock_);
582 if (media_transport_payload_type_ != payloadType) {
583 // Payload type is being changed, media_transport_sampling_frequency_,
584 // no longer current.
585 return -1;
586 }
587 sampling_rate_hz = media_transport_sampling_frequency_;
588 channel_id = media_transport_channel_id_;
589 }
590 const MediaTransportEncodedAudioFrame frame(
591 /*sampling_rate_hz=*/sampling_rate_hz,
592
593 // TODO(nisse): Timestamp and sample index are the same for all supported
594 // audio codecs except G722. Refactor audio coding module to only use
595 // sample index, and leave translation to RTP time, when needed, for
596 // RTP-specific code.
597 /*starting_sample_index=*/timeStamp,
598
599 // Sample count isn't conveniently available from the AudioCodingModule,
600 // and needs some refactoring to wire up in a good way. For now, left as
601 // zero.
602 /*sample_count=*/0,
603
604 /*sequence_number=*/media_transport_sequence_number_,
605 MediaTransportFrameTypeForWebrtcFrameType(frameType), payloadType,
606 std::vector<uint8_t>(payload.begin(), payload.end()));
607
608 // TODO(nisse): Introduce a MediaTransportSender object bound to a specific
609 // channel id.
610 RTCError rtc_error =
611 media_transport()->SendAudioFrame(channel_id, std::move(frame));
612
613 if (!rtc_error.ok()) {
614 RTC_LOG(LS_ERROR) << "Failed to send frame, rtc_error="
615 << ToString(rtc_error.type()) << ", "
616 << rtc_error.message();
617 return -1;
618 }
619
620 ++media_transport_sequence_number_;
621
622 return 0;
623}
624
Niels Möller530ead42018-10-04 14:28:39 +0200625ChannelSend::ChannelSend(rtc::TaskQueue* encoder_queue,
626 ProcessThread* module_process_thread,
Niels Möller7d76a312018-10-26 12:57:07 +0200627 MediaTransportInterface* media_transport,
Anton Sukhanov626015d2019-02-04 15:16:06 -0800628 OverheadObserver* overhead_observer,
Niels Möllere9771992018-11-26 10:55:07 +0100629 Transport* rtp_transport,
Niels Möller530ead42018-10-04 14:28:39 +0200630 RtcpRttStats* rtcp_rtt_stats,
Benjamin Wright84583f62018-10-04 14:22:34 -0700631 RtcEventLog* rtc_event_log,
Benjamin Wrightbfb444c2018-10-15 10:20:24 -0700632 FrameEncryptorInterface* frame_encryptor,
Johannes Kron9190b822018-10-29 11:22:05 +0100633 const webrtc::CryptoOptions& crypto_options,
Jiawei Ou55718122018-11-09 13:17:39 -0800634 bool extmap_allow_mixed,
635 int rtcp_report_interval_ms)
Niels Möller530ead42018-10-04 14:28:39 +0200636 : event_log_(rtc_event_log),
637 _timeStamp(0), // This is just an offset, RTP module will add it's own
638 // random offset
Niels Möller530ead42018-10-04 14:28:39 +0200639 _moduleProcessThreadPtr(module_process_thread),
Niels Möller530ead42018-10-04 14:28:39 +0200640 input_mute_(false),
641 previous_frame_muted_(false),
642 _includeAudioLevelIndication(false),
Niels Möller530ead42018-10-04 14:28:39 +0200643 rtcp_observer_(new VoERtcpObserver(this)),
644 feedback_observer_proxy_(new TransportFeedbackProxy()),
645 seq_num_allocator_proxy_(new TransportSequenceNumberProxy()),
646 rtp_packet_sender_proxy_(new RtpPacketSenderProxy()),
647 retransmission_rate_limiter_(new RateLimiter(Clock::GetRealTimeClock(),
648 kMaxRetransmissionWindowMs)),
649 use_twcc_plr_for_ana_(
650 webrtc::field_trial::FindFullName("UseTwccPlrForAna") == "Enabled"),
Benjamin Wright84583f62018-10-04 14:22:34 -0700651 encoder_queue_(encoder_queue),
Niels Möller7d76a312018-10-26 12:57:07 +0200652 media_transport_(media_transport),
Benjamin Wrightbfb444c2018-10-15 10:20:24 -0700653 frame_encryptor_(frame_encryptor),
654 crypto_options_(crypto_options) {
Niels Möller530ead42018-10-04 14:28:39 +0200655 RTC_DCHECK(module_process_thread);
656 RTC_DCHECK(encoder_queue);
Niels Möllerdced9f62018-11-19 10:27:07 +0100657 module_process_thread_checker_.DetachFromThread();
658
Niels Möller530ead42018-10-04 14:28:39 +0200659 audio_coding_.reset(AudioCodingModule::Create(AudioCodingModule::Config()));
660
661 RtpRtcp::Configuration configuration;
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -0800662
663 // We gradually remove codepaths that depend on RTP when using media
664 // transport. All of this logic should be moved to the future
665 // RTPMediaTransport. In this case it means that overhead and bandwidth
666 // observers should not be called when using media transport.
667 if (!media_transport_) {
Anton Sukhanov626015d2019-02-04 15:16:06 -0800668 // TODO(sukhanov): Overhead observer is only needed for RTP path, because in
669 // media transport audio overhead is currently considered constant (see
670 // getter MediaTransportInterface::GetAudioPacketOverhead). In the future
671 // when we introduce RTP media transport we should make audio overhead
672 // interface consistent and work for both RTP and non-RTP implementations.
673 configuration.overhead_observer = overhead_observer;
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -0800674 configuration.bandwidth_callback = rtcp_observer_.get();
675 configuration.transport_feedback_callback = feedback_observer_proxy_.get();
676 }
677
Niels Möller530ead42018-10-04 14:28:39 +0200678 configuration.audio = true;
Fredrik Solenberg3d2ed192018-12-18 09:18:33 +0100679 configuration.outgoing_transport = rtp_transport;
Niels Möller530ead42018-10-04 14:28:39 +0200680
681 configuration.paced_sender = rtp_packet_sender_proxy_.get();
682 configuration.transport_sequence_number_allocator =
683 seq_num_allocator_proxy_.get();
Niels Möller530ead42018-10-04 14:28:39 +0200684
685 configuration.event_log = event_log_;
686 configuration.rtt_stats = rtcp_rtt_stats;
687 configuration.retransmission_rate_limiter =
688 retransmission_rate_limiter_.get();
Johannes Kron9190b822018-10-29 11:22:05 +0100689 configuration.extmap_allow_mixed = extmap_allow_mixed;
Jiawei Ou8b5d9d82018-11-15 16:44:37 -0800690 configuration.rtcp_report_interval_ms = rtcp_report_interval_ms;
Niels Möller530ead42018-10-04 14:28:39 +0200691
692 _rtpRtcpModule.reset(RtpRtcp::CreateRtpRtcp(configuration));
693 _rtpRtcpModule->SetSendingMediaStatus(false);
Niels Möller530ead42018-10-04 14:28:39 +0200694
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -0800695 // We want to invoke the 'TargetRateObserver' and |OnOverheadChanged|
696 // callbacks after the audio_coding_ is fully initialized.
697 if (media_transport_) {
698 RTC_DLOG(LS_INFO) << "Setting media_transport_ rate observers.";
699 media_transport_->AddTargetTransferRateObserver(this);
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -0800700 } else {
701 RTC_DLOG(LS_INFO) << "Not setting media_transport_ rate observers.";
702 }
703
Niels Möller530ead42018-10-04 14:28:39 +0200704 _moduleProcessThreadPtr->RegisterModule(_rtpRtcpModule.get(), RTC_FROM_HERE);
705
Niels Möller530ead42018-10-04 14:28:39 +0200706 // Ensure that RTCP is enabled by default for the created channel.
707 // Note that, the module will keep generating RTCP until it is explicitly
708 // disabled by the user.
709 // After StopListen (when no sockets exists), RTCP packets will no longer
710 // be transmitted since the Transport object will then be invalid.
711 // RTCP is enabled by default.
712 _rtpRtcpModule->SetRTCPStatus(RtcpMode::kCompound);
713
Fredrik Solenbergeb134842018-11-19 14:13:15 +0100714 int error = audio_coding_->RegisterTransportCallback(this);
Niels Möller530ead42018-10-04 14:28:39 +0200715 RTC_DCHECK_EQ(0, error);
716}
717
Fredrik Solenberg645a3af2018-11-16 12:51:15 +0100718ChannelSend::~ChannelSend() {
Niels Möller530ead42018-10-04 14:28:39 +0200719 RTC_DCHECK(construction_thread_.CalledOnValidThread());
Niels Möller530ead42018-10-04 14:28:39 +0200720
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -0800721 if (media_transport_) {
722 media_transport_->RemoveTargetTransferRateObserver(this);
723 }
724
Niels Möller530ead42018-10-04 14:28:39 +0200725 StopSend();
Niels Möller530ead42018-10-04 14:28:39 +0200726 int error = audio_coding_->RegisterTransportCallback(NULL);
727 RTC_DCHECK_EQ(0, error);
728
Niels Möller530ead42018-10-04 14:28:39 +0200729 if (_moduleProcessThreadPtr)
730 _moduleProcessThreadPtr->DeRegisterModule(_rtpRtcpModule.get());
Niels Möller530ead42018-10-04 14:28:39 +0200731}
732
Niels Möller26815232018-11-16 09:32:40 +0100733void ChannelSend::StartSend() {
Niels Möller26e88b02018-11-19 15:08:13 +0100734 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Fredrik Solenbergeb134842018-11-19 14:13:15 +0100735 RTC_DCHECK(!sending_);
736 sending_ = true;
Niels Möller530ead42018-10-04 14:28:39 +0200737
Niels Möller530ead42018-10-04 14:28:39 +0200738 _rtpRtcpModule->SetSendingMediaStatus(true);
Niels Möller26815232018-11-16 09:32:40 +0100739 int ret = _rtpRtcpModule->SetSendingStatus(true);
740 RTC_DCHECK_EQ(0, ret);
Niels Möller530ead42018-10-04 14:28:39 +0200741 {
742 // It is now OK to start posting tasks to the encoder task queue.
743 rtc::CritScope cs(&encoder_queue_lock_);
744 encoder_queue_is_active_ = true;
745 }
Niels Möller530ead42018-10-04 14:28:39 +0200746}
747
748void ChannelSend::StopSend() {
Niels Möller26e88b02018-11-19 15:08:13 +0100749 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Fredrik Solenbergeb134842018-11-19 14:13:15 +0100750 if (!sending_) {
Niels Möller530ead42018-10-04 14:28:39 +0200751 return;
752 }
Fredrik Solenbergeb134842018-11-19 14:13:15 +0100753 sending_ = false;
Niels Möller530ead42018-10-04 14:28:39 +0200754
755 // Post a task to the encoder thread which sets an event when the task is
756 // executed. We know that no more encoding tasks will be added to the task
757 // queue for this channel since sending is now deactivated. It means that,
758 // if we wait for the event to bet set, we know that no more pending tasks
759 // exists and it is therfore guaranteed that the task queue will never try
760 // to acccess and invalid channel object.
761 RTC_DCHECK(encoder_queue_);
762
Niels Möllerc572ff32018-11-07 08:43:50 +0100763 rtc::Event flush;
Niels Möller530ead42018-10-04 14:28:39 +0200764 {
765 // Clear |encoder_queue_is_active_| under lock to prevent any other tasks
766 // than this final "flush task" to be posted on the queue.
767 rtc::CritScope cs(&encoder_queue_lock_);
768 encoder_queue_is_active_ = false;
769 encoder_queue_->PostTask([&flush]() { flush.Set(); });
770 }
771 flush.Wait(rtc::Event::kForever);
772
Niels Möller530ead42018-10-04 14:28:39 +0200773 // Reset sending SSRC and sequence number and triggers direct transmission
774 // of RTCP BYE
775 if (_rtpRtcpModule->SetSendingStatus(false) == -1) {
776 RTC_DLOG(LS_ERROR) << "StartSend() RTP/RTCP failed to stop sending";
777 }
778 _rtpRtcpModule->SetSendingMediaStatus(false);
779}
780
781bool ChannelSend::SetEncoder(int payload_type,
782 std::unique_ptr<AudioEncoder> encoder) {
Niels Möller26e88b02018-11-19 15:08:13 +0100783 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +0200784 RTC_DCHECK_GE(payload_type, 0);
785 RTC_DCHECK_LE(payload_type, 127);
Niels Möller530ead42018-10-04 14:28:39 +0200786
787 // The RTP/RTCP module needs to know the RTP timestamp rate (i.e. clockrate)
788 // as well as some other things, so we collect this info and send it along.
Fredrik Solenbergf693bfa2018-12-11 12:22:10 +0100789 _rtpRtcpModule->RegisterAudioSendPayload(payload_type,
790 "audio",
791 encoder->RtpTimestampRateHz(),
792 encoder->NumChannels(),
793 0);
Niels Möller530ead42018-10-04 14:28:39 +0200794
Niels Möller7d76a312018-10-26 12:57:07 +0200795 if (media_transport_) {
796 rtc::CritScope cs(&media_transport_lock_);
797 media_transport_payload_type_ = payload_type;
798 // TODO(nisse): Currently broken for G722, since timestamps passed through
799 // encoder use RTP clock rather than sample count, and they differ for G722.
800 media_transport_sampling_frequency_ = encoder->RtpTimestampRateHz();
801 }
Niels Möller530ead42018-10-04 14:28:39 +0200802 audio_coding_->SetEncoder(std::move(encoder));
803 return true;
804}
805
806void ChannelSend::ModifyEncoder(
807 rtc::FunctionView<void(std::unique_ptr<AudioEncoder>*)> modifier) {
Anton Sukhanov626015d2019-02-04 15:16:06 -0800808 // This method can be called on the worker thread, module process thread
809 // or network thread. Audio coding is thread safe, so we do not need to
810 // enforce the calling thread.
Niels Möller530ead42018-10-04 14:28:39 +0200811 audio_coding_->ModifyEncoder(modifier);
812}
813
Sebastian Jansson254d8692018-11-21 19:19:00 +0100814void ChannelSend::OnBitrateAllocation(BitrateAllocationUpdate update) {
Niels Möllerdced9f62018-11-19 10:27:07 +0100815 // This method can be called on the worker thread, module process thread
816 // or on a TaskQueue via VideoSendStreamImpl::OnEncoderConfigurationChanged.
817 // TODO(solenberg): Figure out a good way to check this or enforce calling
818 // rules.
819 // RTC_DCHECK(worker_thread_checker_.CalledOnValidThread() ||
820 // module_process_thread_checker_.CalledOnValidThread());
Piotr (Peter) Slatala1eebec92018-11-16 09:03:35 -0800821 rtc::CritScope lock(&bitrate_crit_section_);
Niels Möllerdced9f62018-11-19 10:27:07 +0100822
Niels Möller530ead42018-10-04 14:28:39 +0200823 audio_coding_->ModifyEncoder([&](std::unique_ptr<AudioEncoder>* encoder) {
824 if (*encoder) {
Sebastian Jansson254d8692018-11-21 19:19:00 +0100825 (*encoder)->OnReceivedUplinkAllocation(update);
Niels Möller530ead42018-10-04 14:28:39 +0200826 }
827 });
Sebastian Jansson254d8692018-11-21 19:19:00 +0100828 retransmission_rate_limiter_->SetMaxRate(update.target_bitrate.bps());
829 configured_bitrate_bps_ = update.target_bitrate.bps();
Sebastian Jansson359d60a2018-10-25 16:22:02 +0200830}
831
Niels Möllerdced9f62018-11-19 10:27:07 +0100832int ChannelSend::GetBitrate() const {
Piotr (Peter) Slatala1eebec92018-11-16 09:03:35 -0800833 rtc::CritScope lock(&bitrate_crit_section_);
Sebastian Jansson359d60a2018-10-25 16:22:02 +0200834 return configured_bitrate_bps_;
Niels Möller530ead42018-10-04 14:28:39 +0200835}
836
837void ChannelSend::OnTwccBasedUplinkPacketLossRate(float packet_loss_rate) {
Niels Möller26e88b02018-11-19 15:08:13 +0100838 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +0200839 if (!use_twcc_plr_for_ana_)
840 return;
841 audio_coding_->ModifyEncoder([&](std::unique_ptr<AudioEncoder>* encoder) {
842 if (*encoder) {
843 (*encoder)->OnReceivedUplinkPacketLossFraction(packet_loss_rate);
844 }
845 });
846}
847
848void ChannelSend::OnRecoverableUplinkPacketLossRate(
849 float recoverable_packet_loss_rate) {
Niels Möller26e88b02018-11-19 15:08:13 +0100850 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +0200851 audio_coding_->ModifyEncoder([&](std::unique_ptr<AudioEncoder>* encoder) {
852 if (*encoder) {
853 (*encoder)->OnReceivedUplinkRecoverablePacketLossFraction(
854 recoverable_packet_loss_rate);
855 }
856 });
857}
858
859void ChannelSend::OnUplinkPacketLossRate(float packet_loss_rate) {
860 if (use_twcc_plr_for_ana_)
861 return;
862 audio_coding_->ModifyEncoder([&](std::unique_ptr<AudioEncoder>* encoder) {
863 if (*encoder) {
864 (*encoder)->OnReceivedUplinkPacketLossFraction(packet_loss_rate);
865 }
866 });
867}
868
Niels Möller26815232018-11-16 09:32:40 +0100869// TODO(nisse): Delete always-true return value.
870bool ChannelSend::ReceivedRTCPPacket(const uint8_t* data, size_t length) {
Niels Möllerdced9f62018-11-19 10:27:07 +0100871 // May be called on either worker thread or network thread.
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -0800872 if (media_transport_) {
873 // Ignore RTCP packets while media transport is used.
874 // Those packets should not arrive, but we are seeing occasional packets.
875 return 0;
876 }
877
Niels Möller530ead42018-10-04 14:28:39 +0200878 // Deliver RTCP packet to RTP/RTCP module for parsing
879 _rtpRtcpModule->IncomingRtcpPacket(data, length);
880
881 int64_t rtt = GetRTT();
882 if (rtt == 0) {
883 // Waiting for valid RTT.
Niels Möller26815232018-11-16 09:32:40 +0100884 return true;
Niels Möller530ead42018-10-04 14:28:39 +0200885 }
886
887 int64_t nack_window_ms = rtt;
888 if (nack_window_ms < kMinRetransmissionWindowMs) {
889 nack_window_ms = kMinRetransmissionWindowMs;
890 } else if (nack_window_ms > kMaxRetransmissionWindowMs) {
891 nack_window_ms = kMaxRetransmissionWindowMs;
892 }
893 retransmission_rate_limiter_->SetWindowSize(nack_window_ms);
894
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -0800895 OnReceivedRtt(rtt);
Niels Möller26815232018-11-16 09:32:40 +0100896 return true;
Niels Möller530ead42018-10-04 14:28:39 +0200897}
898
899void ChannelSend::SetInputMute(bool enable) {
Niels Möller26e88b02018-11-19 15:08:13 +0100900 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +0200901 rtc::CritScope cs(&volume_settings_critsect_);
902 input_mute_ = enable;
903}
904
905bool ChannelSend::InputMute() const {
906 rtc::CritScope cs(&volume_settings_critsect_);
907 return input_mute_;
908}
909
Niels Möller26815232018-11-16 09:32:40 +0100910bool ChannelSend::SendTelephoneEventOutband(int event, int duration_ms) {
Niels Möller26e88b02018-11-19 15:08:13 +0100911 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +0200912 RTC_DCHECK_LE(0, event);
913 RTC_DCHECK_GE(255, event);
914 RTC_DCHECK_LE(0, duration_ms);
915 RTC_DCHECK_GE(65535, duration_ms);
Fredrik Solenbergeb134842018-11-19 14:13:15 +0100916 if (!sending_) {
Niels Möller26815232018-11-16 09:32:40 +0100917 return false;
Niels Möller530ead42018-10-04 14:28:39 +0200918 }
919 if (_rtpRtcpModule->SendTelephoneEventOutband(
920 event, duration_ms, kTelephoneEventAttenuationdB) != 0) {
921 RTC_DLOG(LS_ERROR) << "SendTelephoneEventOutband() failed to send event";
Niels Möller26815232018-11-16 09:32:40 +0100922 return false;
Niels Möller530ead42018-10-04 14:28:39 +0200923 }
Niels Möller26815232018-11-16 09:32:40 +0100924 return true;
Niels Möller530ead42018-10-04 14:28:39 +0200925}
926
Niels Möller26815232018-11-16 09:32:40 +0100927bool ChannelSend::SetSendTelephoneEventPayloadType(int payload_type,
928 int payload_frequency) {
Niels Möller26e88b02018-11-19 15:08:13 +0100929 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +0200930 RTC_DCHECK_LE(0, payload_type);
931 RTC_DCHECK_GE(127, payload_type);
Fredrik Solenbergf693bfa2018-12-11 12:22:10 +0100932 _rtpRtcpModule->RegisterAudioSendPayload(payload_type, "telephone-event",
933 payload_frequency, 0, 0);
Niels Möller26815232018-11-16 09:32:40 +0100934 return true;
Niels Möller530ead42018-10-04 14:28:39 +0200935}
936
Niels Möllerdced9f62018-11-19 10:27:07 +0100937void ChannelSend::SetLocalSSRC(uint32_t ssrc) {
Niels Möller26e88b02018-11-19 15:08:13 +0100938 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Fredrik Solenbergeb134842018-11-19 14:13:15 +0100939 RTC_DCHECK(!sending_);
Niels Möller26815232018-11-16 09:32:40 +0100940
Niels Möller7d76a312018-10-26 12:57:07 +0200941 if (media_transport_) {
942 rtc::CritScope cs(&media_transport_lock_);
943 media_transport_channel_id_ = ssrc;
944 }
Niels Möller530ead42018-10-04 14:28:39 +0200945 _rtpRtcpModule->SetSSRC(ssrc);
Niels Möller530ead42018-10-04 14:28:39 +0200946}
947
Amit Hilbuch77938e62018-12-21 09:23:38 -0800948void ChannelSend::SetRid(const std::string& rid,
949 int extension_id,
950 int repaired_extension_id) {
951 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
952 if (extension_id != 0) {
953 int ret = SetSendRtpHeaderExtension(!rid.empty(), kRtpExtensionRtpStreamId,
954 extension_id);
955 RTC_DCHECK_EQ(0, ret);
956 }
957 if (repaired_extension_id != 0) {
958 int ret = SetSendRtpHeaderExtension(!rid.empty(), kRtpExtensionRtpStreamId,
959 repaired_extension_id);
960 RTC_DCHECK_EQ(0, ret);
961 }
962 _rtpRtcpModule->SetRid(rid);
963}
964
Niels Möller530ead42018-10-04 14:28:39 +0200965void ChannelSend::SetMid(const std::string& mid, int extension_id) {
Niels Möller26e88b02018-11-19 15:08:13 +0100966 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +0200967 int ret = SetSendRtpHeaderExtension(true, kRtpExtensionMid, extension_id);
968 RTC_DCHECK_EQ(0, ret);
969 _rtpRtcpModule->SetMid(mid);
970}
971
Johannes Kron9190b822018-10-29 11:22:05 +0100972void ChannelSend::SetExtmapAllowMixed(bool extmap_allow_mixed) {
Niels Möller26e88b02018-11-19 15:08:13 +0100973 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Johannes Kron9190b822018-10-29 11:22:05 +0100974 _rtpRtcpModule->SetExtmapAllowMixed(extmap_allow_mixed);
975}
976
Niels Möller26815232018-11-16 09:32:40 +0100977void ChannelSend::SetSendAudioLevelIndicationStatus(bool enable, int id) {
Niels Möller26e88b02018-11-19 15:08:13 +0100978 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +0200979 _includeAudioLevelIndication = enable;
Niels Möller26815232018-11-16 09:32:40 +0100980 int ret = SetSendRtpHeaderExtension(enable, kRtpExtensionAudioLevel, id);
981 RTC_DCHECK_EQ(0, ret);
Niels Möller530ead42018-10-04 14:28:39 +0200982}
983
984void ChannelSend::EnableSendTransportSequenceNumber(int id) {
Niels Möller26e88b02018-11-19 15:08:13 +0100985 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +0200986 int ret =
987 SetSendRtpHeaderExtension(true, kRtpExtensionTransportSequenceNumber, id);
988 RTC_DCHECK_EQ(0, ret);
989}
990
991void ChannelSend::RegisterSenderCongestionControlObjects(
992 RtpTransportControllerSendInterface* transport,
993 RtcpBandwidthObserver* bandwidth_observer) {
Niels Möller26e88b02018-11-19 15:08:13 +0100994 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +0200995 RtpPacketSender* rtp_packet_sender = transport->packet_sender();
996 TransportFeedbackObserver* transport_feedback_observer =
997 transport->transport_feedback_observer();
998 PacketRouter* packet_router = transport->packet_router();
999
1000 RTC_DCHECK(rtp_packet_sender);
1001 RTC_DCHECK(transport_feedback_observer);
1002 RTC_DCHECK(packet_router);
1003 RTC_DCHECK(!packet_router_);
1004 rtcp_observer_->SetBandwidthObserver(bandwidth_observer);
1005 feedback_observer_proxy_->SetTransportFeedbackObserver(
1006 transport_feedback_observer);
1007 seq_num_allocator_proxy_->SetSequenceNumberAllocator(packet_router);
1008 rtp_packet_sender_proxy_->SetPacketSender(rtp_packet_sender);
1009 _rtpRtcpModule->SetStorePacketsStatus(true, 600);
1010 constexpr bool remb_candidate = false;
1011 packet_router->AddSendRtpModule(_rtpRtcpModule.get(), remb_candidate);
1012 packet_router_ = packet_router;
1013}
1014
1015void ChannelSend::ResetSenderCongestionControlObjects() {
Niels Möller26e88b02018-11-19 15:08:13 +01001016 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +02001017 RTC_DCHECK(packet_router_);
1018 _rtpRtcpModule->SetStorePacketsStatus(false, 600);
1019 rtcp_observer_->SetBandwidthObserver(nullptr);
1020 feedback_observer_proxy_->SetTransportFeedbackObserver(nullptr);
1021 seq_num_allocator_proxy_->SetSequenceNumberAllocator(nullptr);
1022 packet_router_->RemoveSendRtpModule(_rtpRtcpModule.get());
1023 packet_router_ = nullptr;
1024 rtp_packet_sender_proxy_->SetPacketSender(nullptr);
1025}
1026
Niels Möller26815232018-11-16 09:32:40 +01001027void ChannelSend::SetRTCP_CNAME(absl::string_view c_name) {
Niels Möller26e88b02018-11-19 15:08:13 +01001028 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller26815232018-11-16 09:32:40 +01001029 // Note: SetCNAME() accepts a c string of length at most 255.
1030 const std::string c_name_limited(c_name.substr(0, 255));
1031 int ret = _rtpRtcpModule->SetCNAME(c_name_limited.c_str()) != 0;
1032 RTC_DCHECK_EQ(0, ret) << "SetRTCP_CNAME() failed to set RTCP CNAME";
Niels Möller530ead42018-10-04 14:28:39 +02001033}
1034
Niels Möller26815232018-11-16 09:32:40 +01001035std::vector<ReportBlock> ChannelSend::GetRemoteRTCPReportBlocks() const {
Niels Möller26e88b02018-11-19 15:08:13 +01001036 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +02001037 // Get the report blocks from the latest received RTCP Sender or Receiver
1038 // Report. Each element in the vector contains the sender's SSRC and a
1039 // report block according to RFC 3550.
1040 std::vector<RTCPReportBlock> rtcp_report_blocks;
Niels Möller530ead42018-10-04 14:28:39 +02001041
Niels Möller26815232018-11-16 09:32:40 +01001042 int ret = _rtpRtcpModule->RemoteRTCPStat(&rtcp_report_blocks);
1043 RTC_DCHECK_EQ(0, ret);
1044
1045 std::vector<ReportBlock> report_blocks;
Niels Möller530ead42018-10-04 14:28:39 +02001046
1047 std::vector<RTCPReportBlock>::const_iterator it = rtcp_report_blocks.begin();
1048 for (; it != rtcp_report_blocks.end(); ++it) {
1049 ReportBlock report_block;
1050 report_block.sender_SSRC = it->sender_ssrc;
1051 report_block.source_SSRC = it->source_ssrc;
1052 report_block.fraction_lost = it->fraction_lost;
1053 report_block.cumulative_num_packets_lost = it->packets_lost;
1054 report_block.extended_highest_sequence_number =
1055 it->extended_highest_sequence_number;
1056 report_block.interarrival_jitter = it->jitter;
1057 report_block.last_SR_timestamp = it->last_sender_report_timestamp;
1058 report_block.delay_since_last_SR = it->delay_since_last_sender_report;
Niels Möller26815232018-11-16 09:32:40 +01001059 report_blocks.push_back(report_block);
Niels Möller530ead42018-10-04 14:28:39 +02001060 }
Niels Möller26815232018-11-16 09:32:40 +01001061 return report_blocks;
Niels Möller530ead42018-10-04 14:28:39 +02001062}
1063
Niels Möller26815232018-11-16 09:32:40 +01001064CallSendStatistics ChannelSend::GetRTCPStatistics() const {
Niels Möller26e88b02018-11-19 15:08:13 +01001065 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller26815232018-11-16 09:32:40 +01001066 CallSendStatistics stats = {0};
Niels Möller530ead42018-10-04 14:28:39 +02001067 stats.rttMs = GetRTT();
1068
Niels Möller530ead42018-10-04 14:28:39 +02001069 size_t bytesSent(0);
1070 uint32_t packetsSent(0);
1071
1072 if (_rtpRtcpModule->DataCountersRTP(&bytesSent, &packetsSent) != 0) {
1073 RTC_DLOG(LS_WARNING)
1074 << "GetRTPStatistics() failed to retrieve RTP datacounters"
1075 << " => output will not be complete";
1076 }
1077
1078 stats.bytesSent = bytesSent;
1079 stats.packetsSent = packetsSent;
1080
Niels Möller26815232018-11-16 09:32:40 +01001081 return stats;
Niels Möller530ead42018-10-04 14:28:39 +02001082}
1083
Niels Möller530ead42018-10-04 14:28:39 +02001084void ChannelSend::ProcessAndEncodeAudio(
1085 std::unique_ptr<AudioFrame> audio_frame) {
Niels Möllerdced9f62018-11-19 10:27:07 +01001086 RTC_DCHECK_RUNS_SERIALIZED(&audio_thread_race_checker_);
Niels Möller530ead42018-10-04 14:28:39 +02001087 // Avoid posting any new tasks if sending was already stopped in StopSend().
1088 rtc::CritScope cs(&encoder_queue_lock_);
1089 if (!encoder_queue_is_active_) {
1090 return;
1091 }
1092 // Profile time between when the audio frame is added to the task queue and
1093 // when the task is actually executed.
1094 audio_frame->UpdateProfileTimeStamp();
1095 encoder_queue_->PostTask(std::unique_ptr<rtc::QueuedTask>(
1096 new ProcessAndEncodeAudioTask(std::move(audio_frame), this)));
1097}
1098
1099void ChannelSend::ProcessAndEncodeAudioOnTaskQueue(AudioFrame* audio_input) {
1100 RTC_DCHECK_RUN_ON(encoder_queue_);
1101 RTC_DCHECK_GT(audio_input->samples_per_channel_, 0);
1102 RTC_DCHECK_LE(audio_input->num_channels_, 2);
1103
1104 // Measure time between when the audio frame is added to the task queue and
1105 // when the task is actually executed. Goal is to keep track of unwanted
1106 // extra latency added by the task queue.
1107 RTC_HISTOGRAM_COUNTS_10000("WebRTC.Audio.EncodingTaskQueueLatencyMs",
1108 audio_input->ElapsedProfileTimeMs());
1109
1110 bool is_muted = InputMute();
1111 AudioFrameOperations::Mute(audio_input, previous_frame_muted_, is_muted);
1112
1113 if (_includeAudioLevelIndication) {
1114 size_t length =
1115 audio_input->samples_per_channel_ * audio_input->num_channels_;
1116 RTC_CHECK_LE(length, AudioFrame::kMaxDataSizeBytes);
1117 if (is_muted && previous_frame_muted_) {
1118 rms_level_.AnalyzeMuted(length);
1119 } else {
1120 rms_level_.Analyze(
1121 rtc::ArrayView<const int16_t>(audio_input->data(), length));
1122 }
1123 }
1124 previous_frame_muted_ = is_muted;
1125
1126 // Add 10ms of raw (PCM) audio data to the encoder @ 32kHz.
1127
1128 // The ACM resamples internally.
1129 audio_input->timestamp_ = _timeStamp;
1130 // This call will trigger AudioPacketizationCallback::SendData if encoding
1131 // is done and payload is ready for packetization and transmission.
1132 // Otherwise, it will return without invoking the callback.
1133 if (audio_coding_->Add10MsData(*audio_input) < 0) {
1134 RTC_DLOG(LS_ERROR) << "ACM::Add10MsData() failed.";
1135 return;
1136 }
1137
1138 _timeStamp += static_cast<uint32_t>(audio_input->samples_per_channel_);
1139}
1140
Niels Möller530ead42018-10-04 14:28:39 +02001141ANAStats ChannelSend::GetANAStatistics() const {
Niels Möller26e88b02018-11-19 15:08:13 +01001142 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +02001143 return audio_coding_->GetANAStats();
1144}
1145
1146RtpRtcp* ChannelSend::GetRtpRtcp() const {
Niels Möllerdced9f62018-11-19 10:27:07 +01001147 RTC_DCHECK(module_process_thread_checker_.CalledOnValidThread());
Niels Möller530ead42018-10-04 14:28:39 +02001148 return _rtpRtcpModule.get();
1149}
1150
1151int ChannelSend::SetSendRtpHeaderExtension(bool enable,
1152 RTPExtensionType type,
Niels Möller26815232018-11-16 09:32:40 +01001153 int id) {
Niels Möller530ead42018-10-04 14:28:39 +02001154 int error = 0;
1155 _rtpRtcpModule->DeregisterSendRtpHeaderExtension(type);
1156 if (enable) {
Niels Möller26815232018-11-16 09:32:40 +01001157 // TODO(nisse): RtpRtcp::RegisterSendRtpHeaderExtension to take an int
1158 // argument. Currently it wants an uint8_t.
1159 error = _rtpRtcpModule->RegisterSendRtpHeaderExtension(
1160 type, rtc::dchecked_cast<uint8_t>(id));
Niels Möller530ead42018-10-04 14:28:39 +02001161 }
1162 return error;
1163}
1164
Niels Möller530ead42018-10-04 14:28:39 +02001165int64_t ChannelSend::GetRTT() const {
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -08001166 if (media_transport_) {
1167 // GetRTT is generally used in the RTCP codepath, where media transport is
1168 // not present and so it shouldn't be needed. But it's also invoked in
1169 // 'GetStats' method, and for now returning media transport RTT here gives
1170 // us "free" rtt stats for media transport.
1171 auto target_rate = media_transport_->GetLatestTargetTransferRate();
1172 if (target_rate.has_value()) {
1173 return target_rate.value().network_estimate.round_trip_time.ms();
1174 }
1175
1176 return 0;
1177 }
Niels Möller530ead42018-10-04 14:28:39 +02001178 RtcpMode method = _rtpRtcpModule->RTCP();
1179 if (method == RtcpMode::kOff) {
1180 return 0;
1181 }
1182 std::vector<RTCPReportBlock> report_blocks;
1183 _rtpRtcpModule->RemoteRTCPStat(&report_blocks);
1184
1185 if (report_blocks.empty()) {
1186 return 0;
1187 }
1188
1189 int64_t rtt = 0;
1190 int64_t avg_rtt = 0;
1191 int64_t max_rtt = 0;
1192 int64_t min_rtt = 0;
1193 // We don't know in advance the remote ssrc used by the other end's receiver
1194 // reports, so use the SSRC of the first report block for calculating the RTT.
1195 if (_rtpRtcpModule->RTT(report_blocks[0].sender_ssrc, &rtt, &avg_rtt,
1196 &min_rtt, &max_rtt) != 0) {
1197 return 0;
1198 }
1199 return rtt;
1200}
1201
Benjamin Wright78410ad2018-10-25 09:52:57 -07001202void ChannelSend::SetFrameEncryptor(
1203 rtc::scoped_refptr<FrameEncryptorInterface> frame_encryptor) {
Niels Möller26e88b02018-11-19 15:08:13 +01001204 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Benjamin Wright84583f62018-10-04 14:22:34 -07001205 rtc::CritScope cs(&encoder_queue_lock_);
1206 if (encoder_queue_is_active_) {
Mirko Bonadei80a86872019-02-04 15:01:43 +01001207 encoder_queue_->PostTask([this, frame_encryptor]() mutable {
Benjamin Wright78410ad2018-10-25 09:52:57 -07001208 this->frame_encryptor_ = std::move(frame_encryptor);
Benjamin Wright84583f62018-10-04 14:22:34 -07001209 });
1210 } else {
Benjamin Wright78410ad2018-10-25 09:52:57 -07001211 frame_encryptor_ = std::move(frame_encryptor);
Benjamin Wright84583f62018-10-04 14:22:34 -07001212 }
1213}
1214
Anton Sukhanov626015d2019-02-04 15:16:06 -08001215// TODO(sukhanov): Consider moving TargetTransferRate observer to
1216// AudioSendStream. Since AudioSendStream owns encoder and configures ANA, it
1217// makes sense to consolidate all rate (and overhead) calculation there.
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -08001218void ChannelSend::OnTargetTransferRate(TargetTransferRate rate) {
1219 RTC_DCHECK(media_transport_);
1220 OnReceivedRtt(rate.network_estimate.round_trip_time.ms());
1221}
1222
1223void ChannelSend::OnReceivedRtt(int64_t rtt_ms) {
1224 // Invoke audio encoders OnReceivedRtt().
1225 audio_coding_->ModifyEncoder(
1226 [rtt_ms](std::unique_ptr<AudioEncoder>* encoder) {
1227 if (*encoder) {
1228 (*encoder)->OnReceivedRtt(rtt_ms);
1229 }
1230 });
1231}
1232
Niels Möllerdced9f62018-11-19 10:27:07 +01001233} // namespace
1234
1235std::unique_ptr<ChannelSendInterface> CreateChannelSend(
1236 rtc::TaskQueue* encoder_queue,
1237 ProcessThread* module_process_thread,
1238 MediaTransportInterface* media_transport,
Anton Sukhanov626015d2019-02-04 15:16:06 -08001239 OverheadObserver* overhead_observer,
Niels Möllere9771992018-11-26 10:55:07 +01001240 Transport* rtp_transport,
Niels Möllerdced9f62018-11-19 10:27:07 +01001241 RtcpRttStats* rtcp_rtt_stats,
1242 RtcEventLog* rtc_event_log,
1243 FrameEncryptorInterface* frame_encryptor,
1244 const webrtc::CryptoOptions& crypto_options,
1245 bool extmap_allow_mixed,
1246 int rtcp_report_interval_ms) {
1247 return absl::make_unique<ChannelSend>(
Anton Sukhanov626015d2019-02-04 15:16:06 -08001248 encoder_queue, module_process_thread, media_transport, overhead_observer,
1249 rtp_transport, rtcp_rtt_stats, rtc_event_log, frame_encryptor,
1250 crypto_options, extmap_allow_mixed, rtcp_report_interval_ms);
Niels Möllerdced9f62018-11-19 10:27:07 +01001251}
1252
Niels Möller530ead42018-10-04 14:28:39 +02001253} // namespace voe
1254} // namespace webrtc