blob: e8b7b32d0be7cd374ba3d4abebdb01d53a87ff44 [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"
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"
34#include "rtc_base/criticalsection.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"
44#include "rtc_base/timeutils.h"
45#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,
81 public Transport,
82 public OverheadObserver,
83 public AudioPacketizationCallback, // receive encoded packets from the
84 // ACM
85 public TargetTransferRateObserver {
86 public:
87 // TODO(nisse): Make OnUplinkPacketLossRate public, and delete friend
88 // declaration.
89 friend class VoERtcpObserver;
90
91 ChannelSend(rtc::TaskQueue* encoder_queue,
92 ProcessThread* module_process_thread,
93 MediaTransportInterface* media_transport,
94 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
114 void SetBitrate(int bitrate_bps, int64_t probing_interval_ms) override;
115 int GetBitrate() const override;
116
117 // Network
118 void RegisterTransport(Transport* transport) override;
Niels Möllerdced9f62018-11-19 10:27:07 +0100119 bool ReceivedRTCPPacket(const uint8_t* data, size_t length) override;
120
121 // Muting, Volume and Level.
122 void SetInputMute(bool enable) override;
123
124 // Stats.
125 ANAStats GetANAStatistics() const override;
126
127 // Used by AudioSendStream.
128 RtpRtcp* GetRtpRtcp() const override;
129
130 // DTMF.
131 bool SendTelephoneEventOutband(int event, int duration_ms) override;
132 bool SetSendTelephoneEventPayloadType(int payload_type,
133 int payload_frequency) override;
134
135 // RTP+RTCP
136 void SetLocalSSRC(uint32_t ssrc) override;
Niels Möllerdced9f62018-11-19 10:27:07 +0100137 void SetMid(const std::string& mid, int extension_id) override;
138 void SetExtmapAllowMixed(bool extmap_allow_mixed) override;
139 void SetSendAudioLevelIndicationStatus(bool enable, int id) override;
140 void EnableSendTransportSequenceNumber(int id) override;
141
142 void RegisterSenderCongestionControlObjects(
143 RtpTransportControllerSendInterface* transport,
144 RtcpBandwidthObserver* bandwidth_observer) override;
145 void ResetSenderCongestionControlObjects() override;
146 void SetRTCP_CNAME(absl::string_view c_name) override;
147 std::vector<ReportBlock> GetRemoteRTCPReportBlocks() const override;
148 CallSendStatistics GetRTCPStatistics() const override;
Niels Möllerdced9f62018-11-19 10:27:07 +0100149
150 // ProcessAndEncodeAudio() posts a task on the shared encoder task queue,
151 // which in turn calls (on the queue) ProcessAndEncodeAudioOnTaskQueue() where
152 // the actual processing of the audio takes place. The processing mainly
153 // consists of encoding and preparing the result for sending by adding it to a
154 // send queue.
155 // The main reason for using a task queue here is to release the native,
156 // OS-specific, audio capture thread as soon as possible to ensure that it
157 // can go back to sleep and be prepared to deliver an new captured audio
158 // packet.
159 void ProcessAndEncodeAudio(std::unique_ptr<AudioFrame> audio_frame) override;
160
161 void SetTransportOverhead(size_t transport_overhead_per_packet) override;
162
163 // 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
189 // From Transport (called by the RTP/RTCP module)
190 bool SendRtp(const uint8_t* data,
191 size_t len,
192 const PacketOptions& packet_options) override;
193 bool SendRtcp(const uint8_t* data, size_t len) override;
194
Niels Möllerdced9f62018-11-19 10:27:07 +0100195 // From OverheadObserver in the RTP/RTCP module
196 void OnOverheadChanged(size_t overhead_bytes_per_packet) override;
197
198 void OnUplinkPacketLossRate(float packet_loss_rate);
199 bool InputMute() const;
200
Niels Möllerdced9f62018-11-19 10:27:07 +0100201 int SetSendRtpHeaderExtension(bool enable, RTPExtensionType type, int id);
202
203 void UpdateOverheadForEncoder()
204 RTC_EXCLUSIVE_LOCKS_REQUIRED(overhead_per_packet_lock_);
205
Niels Möllerdced9f62018-11-19 10:27:07 +0100206 int32_t SendRtpAudio(FrameType frameType,
207 uint8_t payloadType,
208 uint32_t timeStamp,
209 rtc::ArrayView<const uint8_t> payload,
210 const RTPFragmentationHeader* fragmentation);
211
212 int32_t SendMediaTransportAudio(FrameType frameType,
213 uint8_t payloadType,
214 uint32_t timeStamp,
215 rtc::ArrayView<const uint8_t> payload,
216 const RTPFragmentationHeader* fragmentation);
217
218 // Return media transport or nullptr if using RTP.
219 MediaTransportInterface* media_transport() { return media_transport_; }
220
221 // Called on the encoder task queue when a new input audio frame is ready
222 // for encoding.
223 void ProcessAndEncodeAudioOnTaskQueue(AudioFrame* audio_input);
224
225 void OnReceivedRtt(int64_t rtt_ms);
226
227 void OnTargetTransferRate(TargetTransferRate) override;
228
229 // Thread checkers document and lock usage of some methods on voe::Channel to
230 // specific threads we know about. The goal is to eventually split up
231 // voe::Channel into parts with single-threaded semantics, and thereby reduce
232 // the need for locks.
233 rtc::ThreadChecker worker_thread_checker_;
234 rtc::ThreadChecker module_process_thread_checker_;
235 // Methods accessed from audio and video threads are checked for sequential-
236 // only access. We don't necessarily own and control these threads, so thread
237 // checkers cannot be used. E.g. Chromium may transfer "ownership" from one
238 // audio thread to another, but access is still sequential.
239 rtc::RaceChecker audio_thread_race_checker_;
240
241 rtc::CriticalSection _callbackCritSect;
242 rtc::CriticalSection volume_settings_critsect_;
243
Niels Möller26e88b02018-11-19 15:08:13 +0100244 bool sending_ RTC_GUARDED_BY(&worker_thread_checker_) = false;
Niels Möllerdced9f62018-11-19 10:27:07 +0100245
246 RtcEventLog* const event_log_;
247
248 std::unique_ptr<RtpRtcp> _rtpRtcpModule;
249
250 std::unique_ptr<AudioCodingModule> audio_coding_;
251 uint32_t _timeStamp RTC_GUARDED_BY(encoder_queue_);
252
253 uint16_t send_sequence_number_;
254
255 // uses
Niels Möller985a1f32018-11-19 16:08:42 +0100256 ProcessThread* const _moduleProcessThreadPtr;
Niels Möllerdced9f62018-11-19 10:27:07 +0100257 Transport* _transportPtr; // WebRtc socket or external transport
258 RmsLevel rms_level_ RTC_GUARDED_BY(encoder_queue_);
259 bool input_mute_ RTC_GUARDED_BY(volume_settings_critsect_);
260 bool previous_frame_muted_ RTC_GUARDED_BY(encoder_queue_);
261 // VoeRTP_RTCP
262 // TODO(henrika): can today be accessed on the main thread and on the
263 // task queue; hence potential race.
264 bool _includeAudioLevelIndication;
265 size_t transport_overhead_per_packet_
266 RTC_GUARDED_BY(overhead_per_packet_lock_);
267 size_t rtp_overhead_per_packet_ RTC_GUARDED_BY(overhead_per_packet_lock_);
268 rtc::CriticalSection overhead_per_packet_lock_;
269 // RtcpBandwidthObserver
Niels Möller985a1f32018-11-19 16:08:42 +0100270 const std::unique_ptr<VoERtcpObserver> rtcp_observer_;
Niels Möllerdced9f62018-11-19 10:27:07 +0100271
Niels Möller985a1f32018-11-19 16:08:42 +0100272 PacketRouter* packet_router_ RTC_GUARDED_BY(&worker_thread_checker_) =
273 nullptr;
274 const std::unique_ptr<TransportFeedbackProxy> feedback_observer_proxy_;
275 const std::unique_ptr<TransportSequenceNumberProxy> seq_num_allocator_proxy_;
276 const std::unique_ptr<RtpPacketSenderProxy> rtp_packet_sender_proxy_;
277 const std::unique_ptr<RateLimiter> retransmission_rate_limiter_;
Niels Möllerdced9f62018-11-19 10:27:07 +0100278
279 rtc::ThreadChecker construction_thread_;
280
281 const bool use_twcc_plr_for_ana_;
282
283 rtc::CriticalSection encoder_queue_lock_;
284 bool encoder_queue_is_active_ RTC_GUARDED_BY(encoder_queue_lock_) = false;
Niels Möller985a1f32018-11-19 16:08:42 +0100285 rtc::TaskQueue* const encoder_queue_ = nullptr;
Niels Möllerdced9f62018-11-19 10:27:07 +0100286
287 MediaTransportInterface* const media_transport_;
288 int media_transport_sequence_number_ RTC_GUARDED_BY(encoder_queue_) = 0;
289
290 rtc::CriticalSection media_transport_lock_;
291 // Currently set by SetLocalSSRC.
292 uint64_t media_transport_channel_id_ RTC_GUARDED_BY(&media_transport_lock_) =
293 0;
294 // Cache payload type and sampling frequency from most recent call to
295 // SetEncoder. Needed to set MediaTransportEncodedAudioFrame metadata, and
296 // invalidate on encoder change.
297 int media_transport_payload_type_ RTC_GUARDED_BY(&media_transport_lock_);
298 int media_transport_sampling_frequency_
299 RTC_GUARDED_BY(&media_transport_lock_);
300
301 // E2EE Audio Frame Encryption
302 rtc::scoped_refptr<FrameEncryptorInterface> frame_encryptor_;
303 // E2EE Frame Encryption Options
Niels Möller985a1f32018-11-19 16:08:42 +0100304 const webrtc::CryptoOptions crypto_options_;
Niels Möllerdced9f62018-11-19 10:27:07 +0100305
306 rtc::CriticalSection bitrate_crit_section_;
307 int configured_bitrate_bps_ RTC_GUARDED_BY(bitrate_crit_section_) = 0;
308};
Niels Möller530ead42018-10-04 14:28:39 +0200309
310const int kTelephoneEventAttenuationdB = 10;
311
312class TransportFeedbackProxy : public TransportFeedbackObserver {
313 public:
314 TransportFeedbackProxy() : feedback_observer_(nullptr) {
315 pacer_thread_.DetachFromThread();
316 network_thread_.DetachFromThread();
317 }
318
319 void SetTransportFeedbackObserver(
320 TransportFeedbackObserver* feedback_observer) {
321 RTC_DCHECK(thread_checker_.CalledOnValidThread());
322 rtc::CritScope lock(&crit_);
323 feedback_observer_ = feedback_observer;
324 }
325
326 // Implements TransportFeedbackObserver.
327 void AddPacket(uint32_t ssrc,
328 uint16_t sequence_number,
329 size_t length,
330 const PacedPacketInfo& pacing_info) override {
331 RTC_DCHECK(pacer_thread_.CalledOnValidThread());
332 rtc::CritScope lock(&crit_);
333 if (feedback_observer_)
334 feedback_observer_->AddPacket(ssrc, sequence_number, length, pacing_info);
335 }
336
337 void OnTransportFeedback(const rtcp::TransportFeedback& feedback) override {
338 RTC_DCHECK(network_thread_.CalledOnValidThread());
339 rtc::CritScope lock(&crit_);
340 if (feedback_observer_)
341 feedback_observer_->OnTransportFeedback(feedback);
342 }
343
344 private:
345 rtc::CriticalSection crit_;
346 rtc::ThreadChecker thread_checker_;
347 rtc::ThreadChecker pacer_thread_;
348 rtc::ThreadChecker network_thread_;
349 TransportFeedbackObserver* feedback_observer_ RTC_GUARDED_BY(&crit_);
350};
351
352class TransportSequenceNumberProxy : public TransportSequenceNumberAllocator {
353 public:
354 TransportSequenceNumberProxy() : seq_num_allocator_(nullptr) {
355 pacer_thread_.DetachFromThread();
356 }
357
358 void SetSequenceNumberAllocator(
359 TransportSequenceNumberAllocator* seq_num_allocator) {
360 RTC_DCHECK(thread_checker_.CalledOnValidThread());
361 rtc::CritScope lock(&crit_);
362 seq_num_allocator_ = seq_num_allocator;
363 }
364
365 // Implements TransportSequenceNumberAllocator.
366 uint16_t AllocateSequenceNumber() override {
367 RTC_DCHECK(pacer_thread_.CalledOnValidThread());
368 rtc::CritScope lock(&crit_);
369 if (!seq_num_allocator_)
370 return 0;
371 return seq_num_allocator_->AllocateSequenceNumber();
372 }
373
374 private:
375 rtc::CriticalSection crit_;
376 rtc::ThreadChecker thread_checker_;
377 rtc::ThreadChecker pacer_thread_;
378 TransportSequenceNumberAllocator* seq_num_allocator_ RTC_GUARDED_BY(&crit_);
379};
380
381class RtpPacketSenderProxy : public RtpPacketSender {
382 public:
383 RtpPacketSenderProxy() : rtp_packet_sender_(nullptr) {}
384
385 void SetPacketSender(RtpPacketSender* rtp_packet_sender) {
386 RTC_DCHECK(thread_checker_.CalledOnValidThread());
387 rtc::CritScope lock(&crit_);
388 rtp_packet_sender_ = rtp_packet_sender;
389 }
390
391 // Implements RtpPacketSender.
392 void InsertPacket(Priority priority,
393 uint32_t ssrc,
394 uint16_t sequence_number,
395 int64_t capture_time_ms,
396 size_t bytes,
397 bool retransmission) override {
398 rtc::CritScope lock(&crit_);
399 if (rtp_packet_sender_) {
400 rtp_packet_sender_->InsertPacket(priority, ssrc, sequence_number,
401 capture_time_ms, bytes, retransmission);
402 }
403 }
404
405 void SetAccountForAudioPackets(bool account_for_audio) override {
406 RTC_NOTREACHED();
407 }
408
409 private:
410 rtc::ThreadChecker thread_checker_;
411 rtc::CriticalSection crit_;
412 RtpPacketSender* rtp_packet_sender_ RTC_GUARDED_BY(&crit_);
413};
414
415class VoERtcpObserver : public RtcpBandwidthObserver {
416 public:
417 explicit VoERtcpObserver(ChannelSend* owner)
418 : owner_(owner), bandwidth_observer_(nullptr) {}
419 virtual ~VoERtcpObserver() {}
420
421 void SetBandwidthObserver(RtcpBandwidthObserver* bandwidth_observer) {
422 rtc::CritScope lock(&crit_);
423 bandwidth_observer_ = bandwidth_observer;
424 }
425
426 void OnReceivedEstimatedBitrate(uint32_t bitrate) override {
427 rtc::CritScope lock(&crit_);
428 if (bandwidth_observer_) {
429 bandwidth_observer_->OnReceivedEstimatedBitrate(bitrate);
430 }
431 }
432
433 void OnReceivedRtcpReceiverReport(const ReportBlockList& report_blocks,
434 int64_t rtt,
435 int64_t now_ms) override {
436 {
437 rtc::CritScope lock(&crit_);
438 if (bandwidth_observer_) {
439 bandwidth_observer_->OnReceivedRtcpReceiverReport(report_blocks, rtt,
440 now_ms);
441 }
442 }
443 // TODO(mflodman): Do we need to aggregate reports here or can we jut send
444 // what we get? I.e. do we ever get multiple reports bundled into one RTCP
445 // report for VoiceEngine?
446 if (report_blocks.empty())
447 return;
448
449 int fraction_lost_aggregate = 0;
450 int total_number_of_packets = 0;
451
452 // If receiving multiple report blocks, calculate the weighted average based
453 // on the number of packets a report refers to.
454 for (ReportBlockList::const_iterator block_it = report_blocks.begin();
455 block_it != report_blocks.end(); ++block_it) {
456 // Find the previous extended high sequence number for this remote SSRC,
457 // to calculate the number of RTP packets this report refers to. Ignore if
458 // we haven't seen this SSRC before.
459 std::map<uint32_t, uint32_t>::iterator seq_num_it =
460 extended_max_sequence_number_.find(block_it->source_ssrc);
461 int number_of_packets = 0;
462 if (seq_num_it != extended_max_sequence_number_.end()) {
463 number_of_packets =
464 block_it->extended_highest_sequence_number - seq_num_it->second;
465 }
466 fraction_lost_aggregate += number_of_packets * block_it->fraction_lost;
467 total_number_of_packets += number_of_packets;
468
469 extended_max_sequence_number_[block_it->source_ssrc] =
470 block_it->extended_highest_sequence_number;
471 }
472 int weighted_fraction_lost = 0;
473 if (total_number_of_packets > 0) {
474 weighted_fraction_lost =
475 (fraction_lost_aggregate + total_number_of_packets / 2) /
476 total_number_of_packets;
477 }
478 owner_->OnUplinkPacketLossRate(weighted_fraction_lost / 255.0f);
479 }
480
481 private:
482 ChannelSend* owner_;
483 // Maps remote side ssrc to extended highest sequence number received.
484 std::map<uint32_t, uint32_t> extended_max_sequence_number_;
485 rtc::CriticalSection crit_;
486 RtcpBandwidthObserver* bandwidth_observer_ RTC_GUARDED_BY(crit_);
487};
488
489class ChannelSend::ProcessAndEncodeAudioTask : public rtc::QueuedTask {
490 public:
491 ProcessAndEncodeAudioTask(std::unique_ptr<AudioFrame> audio_frame,
492 ChannelSend* channel)
493 : audio_frame_(std::move(audio_frame)), channel_(channel) {
494 RTC_DCHECK(channel_);
495 }
496
497 private:
498 bool Run() override {
499 RTC_DCHECK_RUN_ON(channel_->encoder_queue_);
500 channel_->ProcessAndEncodeAudioOnTaskQueue(audio_frame_.get());
501 return true;
502 }
503
504 std::unique_ptr<AudioFrame> audio_frame_;
505 ChannelSend* const channel_;
506};
507
508int32_t ChannelSend::SendData(FrameType frameType,
509 uint8_t payloadType,
510 uint32_t timeStamp,
511 const uint8_t* payloadData,
512 size_t payloadSize,
513 const RTPFragmentationHeader* fragmentation) {
514 RTC_DCHECK_RUN_ON(encoder_queue_);
Niels Möller7d76a312018-10-26 12:57:07 +0200515 rtc::ArrayView<const uint8_t> payload(payloadData, payloadSize);
516
517 if (media_transport() != nullptr) {
518 return SendMediaTransportAudio(frameType, payloadType, timeStamp, payload,
519 fragmentation);
520 } else {
521 return SendRtpAudio(frameType, payloadType, timeStamp, payload,
522 fragmentation);
523 }
524}
525
526int32_t ChannelSend::SendRtpAudio(FrameType frameType,
527 uint8_t payloadType,
528 uint32_t timeStamp,
529 rtc::ArrayView<const uint8_t> payload,
530 const RTPFragmentationHeader* fragmentation) {
531 RTC_DCHECK_RUN_ON(encoder_queue_);
Niels Möller530ead42018-10-04 14:28:39 +0200532 if (_includeAudioLevelIndication) {
533 // Store current audio level in the RTP/RTCP module.
534 // The level will be used in combination with voice-activity state
535 // (frameType) to add an RTP header extension
536 _rtpRtcpModule->SetAudioLevel(rms_level_.Average());
537 }
538
Benjamin Wright84583f62018-10-04 14:22:34 -0700539 // E2EE Custom Audio Frame Encryption (This is optional).
540 // Keep this buffer around for the lifetime of the send call.
541 rtc::Buffer encrypted_audio_payload;
542 if (frame_encryptor_ != nullptr) {
543 // TODO(benwright@webrtc.org) - Allocate enough to always encrypt inline.
544 // Allocate a buffer to hold the maximum possible encrypted payload.
545 size_t max_ciphertext_size = frame_encryptor_->GetMaxCiphertextByteSize(
Niels Möller7d76a312018-10-26 12:57:07 +0200546 cricket::MEDIA_TYPE_AUDIO, payload.size());
Benjamin Wright84583f62018-10-04 14:22:34 -0700547 encrypted_audio_payload.SetSize(max_ciphertext_size);
548
549 // Encrypt the audio payload into the buffer.
550 size_t bytes_written = 0;
551 int encrypt_status = frame_encryptor_->Encrypt(
552 cricket::MEDIA_TYPE_AUDIO, _rtpRtcpModule->SSRC(),
Niels Möller7d76a312018-10-26 12:57:07 +0200553 /*additional_data=*/nullptr, payload, encrypted_audio_payload,
554 &bytes_written);
Benjamin Wright84583f62018-10-04 14:22:34 -0700555 if (encrypt_status != 0) {
556 RTC_DLOG(LS_ERROR) << "Channel::SendData() failed encrypt audio payload: "
557 << encrypt_status;
558 return -1;
559 }
560 // Resize the buffer to the exact number of bytes actually used.
561 encrypted_audio_payload.SetSize(bytes_written);
562 // Rewrite the payloadData and size to the new encrypted payload.
Niels Möller7d76a312018-10-26 12:57:07 +0200563 payload = encrypted_audio_payload;
Benjamin Wrightbfb444c2018-10-15 10:20:24 -0700564 } else if (crypto_options_.sframe.require_frame_encryption) {
565 RTC_DLOG(LS_ERROR) << "Channel::SendData() failed sending audio payload: "
566 << "A frame encryptor is required but one is not set.";
567 return -1;
Benjamin Wright84583f62018-10-04 14:22:34 -0700568 }
569
Niels Möller530ead42018-10-04 14:28:39 +0200570 // Push data from ACM to RTP/RTCP-module to deliver audio frame for
571 // packetization.
572 // This call will trigger Transport::SendPacket() from the RTP/RTCP module.
Niels Möller7d76a312018-10-26 12:57:07 +0200573 if (!_rtpRtcpModule->SendOutgoingData((FrameType&)frameType, payloadType,
574 timeStamp,
575 // Leaving the time when this frame was
576 // received from the capture device as
577 // undefined for voice for now.
578 -1, payload.data(), payload.size(),
579 fragmentation, nullptr, nullptr)) {
Niels Möller530ead42018-10-04 14:28:39 +0200580 RTC_DLOG(LS_ERROR)
581 << "ChannelSend::SendData() failed to send data to RTP/RTCP module";
582 return -1;
583 }
584
585 return 0;
586}
587
Niels Möller7d76a312018-10-26 12:57:07 +0200588int32_t ChannelSend::SendMediaTransportAudio(
589 FrameType frameType,
590 uint8_t payloadType,
591 uint32_t timeStamp,
592 rtc::ArrayView<const uint8_t> payload,
593 const RTPFragmentationHeader* fragmentation) {
594 RTC_DCHECK_RUN_ON(encoder_queue_);
595 // TODO(nisse): Use null _transportPtr for MediaTransport.
596 // RTC_DCHECK(_transportPtr == nullptr);
597 uint64_t channel_id;
598 int sampling_rate_hz;
599 {
600 rtc::CritScope cs(&media_transport_lock_);
601 if (media_transport_payload_type_ != payloadType) {
602 // Payload type is being changed, media_transport_sampling_frequency_,
603 // no longer current.
604 return -1;
605 }
606 sampling_rate_hz = media_transport_sampling_frequency_;
607 channel_id = media_transport_channel_id_;
608 }
609 const MediaTransportEncodedAudioFrame frame(
610 /*sampling_rate_hz=*/sampling_rate_hz,
611
612 // TODO(nisse): Timestamp and sample index are the same for all supported
613 // audio codecs except G722. Refactor audio coding module to only use
614 // sample index, and leave translation to RTP time, when needed, for
615 // RTP-specific code.
616 /*starting_sample_index=*/timeStamp,
617
618 // Sample count isn't conveniently available from the AudioCodingModule,
619 // and needs some refactoring to wire up in a good way. For now, left as
620 // zero.
621 /*sample_count=*/0,
622
623 /*sequence_number=*/media_transport_sequence_number_,
624 MediaTransportFrameTypeForWebrtcFrameType(frameType), payloadType,
625 std::vector<uint8_t>(payload.begin(), payload.end()));
626
627 // TODO(nisse): Introduce a MediaTransportSender object bound to a specific
628 // channel id.
629 RTCError rtc_error =
630 media_transport()->SendAudioFrame(channel_id, std::move(frame));
631
632 if (!rtc_error.ok()) {
633 RTC_LOG(LS_ERROR) << "Failed to send frame, rtc_error="
634 << ToString(rtc_error.type()) << ", "
635 << rtc_error.message();
636 return -1;
637 }
638
639 ++media_transport_sequence_number_;
640
641 return 0;
642}
643
Niels Möller530ead42018-10-04 14:28:39 +0200644bool ChannelSend::SendRtp(const uint8_t* data,
645 size_t len,
646 const PacketOptions& options) {
Niels Möller7d76a312018-10-26 12:57:07 +0200647 // We should not be sending RTP packets if media transport is available.
648 RTC_CHECK(!media_transport());
649
Niels Möller530ead42018-10-04 14:28:39 +0200650 rtc::CritScope cs(&_callbackCritSect);
651
652 if (_transportPtr == NULL) {
653 RTC_DLOG(LS_ERROR)
654 << "ChannelSend::SendPacket() failed to send RTP packet due to"
655 << " invalid transport object";
656 return false;
657 }
658
659 if (!_transportPtr->SendRtp(data, len, options)) {
660 RTC_DLOG(LS_ERROR) << "ChannelSend::SendPacket() RTP transmission failed";
661 return false;
662 }
663 return true;
664}
665
666bool ChannelSend::SendRtcp(const uint8_t* data, size_t len) {
667 rtc::CritScope cs(&_callbackCritSect);
668 if (_transportPtr == NULL) {
669 RTC_DLOG(LS_ERROR)
670 << "ChannelSend::SendRtcp() failed to send RTCP packet due to"
671 << " invalid transport object";
672 return false;
673 }
674
675 int n = _transportPtr->SendRtcp(data, len);
676 if (n < 0) {
677 RTC_DLOG(LS_ERROR) << "ChannelSend::SendRtcp() transmission failed";
678 return false;
679 }
680 return true;
681}
682
Niels Möller530ead42018-10-04 14:28:39 +0200683ChannelSend::ChannelSend(rtc::TaskQueue* encoder_queue,
684 ProcessThread* module_process_thread,
Niels Möller7d76a312018-10-26 12:57:07 +0200685 MediaTransportInterface* media_transport,
Niels Möller530ead42018-10-04 14:28:39 +0200686 RtcpRttStats* rtcp_rtt_stats,
Benjamin Wright84583f62018-10-04 14:22:34 -0700687 RtcEventLog* rtc_event_log,
Benjamin Wrightbfb444c2018-10-15 10:20:24 -0700688 FrameEncryptorInterface* frame_encryptor,
Johannes Kron9190b822018-10-29 11:22:05 +0100689 const webrtc::CryptoOptions& crypto_options,
Jiawei Ou55718122018-11-09 13:17:39 -0800690 bool extmap_allow_mixed,
691 int rtcp_report_interval_ms)
Niels Möller530ead42018-10-04 14:28:39 +0200692 : event_log_(rtc_event_log),
693 _timeStamp(0), // This is just an offset, RTP module will add it's own
694 // random offset
695 send_sequence_number_(0),
696 _moduleProcessThreadPtr(module_process_thread),
697 _transportPtr(NULL),
698 input_mute_(false),
699 previous_frame_muted_(false),
700 _includeAudioLevelIndication(false),
701 transport_overhead_per_packet_(0),
702 rtp_overhead_per_packet_(0),
703 rtcp_observer_(new VoERtcpObserver(this)),
704 feedback_observer_proxy_(new TransportFeedbackProxy()),
705 seq_num_allocator_proxy_(new TransportSequenceNumberProxy()),
706 rtp_packet_sender_proxy_(new RtpPacketSenderProxy()),
707 retransmission_rate_limiter_(new RateLimiter(Clock::GetRealTimeClock(),
708 kMaxRetransmissionWindowMs)),
709 use_twcc_plr_for_ana_(
710 webrtc::field_trial::FindFullName("UseTwccPlrForAna") == "Enabled"),
Benjamin Wright84583f62018-10-04 14:22:34 -0700711 encoder_queue_(encoder_queue),
Niels Möller7d76a312018-10-26 12:57:07 +0200712 media_transport_(media_transport),
Benjamin Wrightbfb444c2018-10-15 10:20:24 -0700713 frame_encryptor_(frame_encryptor),
714 crypto_options_(crypto_options) {
Niels Möller530ead42018-10-04 14:28:39 +0200715 RTC_DCHECK(module_process_thread);
716 RTC_DCHECK(encoder_queue);
Niels Möllerdced9f62018-11-19 10:27:07 +0100717 module_process_thread_checker_.DetachFromThread();
718
Niels Möller530ead42018-10-04 14:28:39 +0200719 audio_coding_.reset(AudioCodingModule::Create(AudioCodingModule::Config()));
720
721 RtpRtcp::Configuration configuration;
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -0800722
723 // We gradually remove codepaths that depend on RTP when using media
724 // transport. All of this logic should be moved to the future
725 // RTPMediaTransport. In this case it means that overhead and bandwidth
726 // observers should not be called when using media transport.
727 if (!media_transport_) {
728 configuration.overhead_observer = this;
729 configuration.bandwidth_callback = rtcp_observer_.get();
730 configuration.transport_feedback_callback = feedback_observer_proxy_.get();
731 }
732
Niels Möller530ead42018-10-04 14:28:39 +0200733 configuration.audio = true;
734 configuration.outgoing_transport = this;
Niels Möller530ead42018-10-04 14:28:39 +0200735
736 configuration.paced_sender = rtp_packet_sender_proxy_.get();
737 configuration.transport_sequence_number_allocator =
738 seq_num_allocator_proxy_.get();
Niels Möller530ead42018-10-04 14:28:39 +0200739
740 configuration.event_log = event_log_;
741 configuration.rtt_stats = rtcp_rtt_stats;
742 configuration.retransmission_rate_limiter =
743 retransmission_rate_limiter_.get();
Johannes Kron9190b822018-10-29 11:22:05 +0100744 configuration.extmap_allow_mixed = extmap_allow_mixed;
Jiawei Ou8b5d9d82018-11-15 16:44:37 -0800745 configuration.rtcp_report_interval_ms = rtcp_report_interval_ms;
Niels Möller530ead42018-10-04 14:28:39 +0200746
747 _rtpRtcpModule.reset(RtpRtcp::CreateRtpRtcp(configuration));
748 _rtpRtcpModule->SetSendingMediaStatus(false);
Niels Möller530ead42018-10-04 14:28:39 +0200749
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -0800750 // We want to invoke the 'TargetRateObserver' and |OnOverheadChanged|
751 // callbacks after the audio_coding_ is fully initialized.
752 if (media_transport_) {
753 RTC_DLOG(LS_INFO) << "Setting media_transport_ rate observers.";
754 media_transport_->AddTargetTransferRateObserver(this);
755 OnOverheadChanged(media_transport_->GetAudioPacketOverhead());
756 } else {
757 RTC_DLOG(LS_INFO) << "Not setting media_transport_ rate observers.";
758 }
759
Niels Möller530ead42018-10-04 14:28:39 +0200760 _moduleProcessThreadPtr->RegisterModule(_rtpRtcpModule.get(), RTC_FROM_HERE);
761
Niels Möller530ead42018-10-04 14:28:39 +0200762 // Ensure that RTCP is enabled by default for the created channel.
763 // Note that, the module will keep generating RTCP until it is explicitly
764 // disabled by the user.
765 // After StopListen (when no sockets exists), RTCP packets will no longer
766 // be transmitted since the Transport object will then be invalid.
767 // RTCP is enabled by default.
768 _rtpRtcpModule->SetRTCPStatus(RtcpMode::kCompound);
769
Fredrik Solenbergeb134842018-11-19 14:13:15 +0100770 int error = audio_coding_->RegisterTransportCallback(this);
Niels Möller530ead42018-10-04 14:28:39 +0200771 RTC_DCHECK_EQ(0, error);
772}
773
Fredrik Solenberg645a3af2018-11-16 12:51:15 +0100774ChannelSend::~ChannelSend() {
Niels Möller530ead42018-10-04 14:28:39 +0200775 RTC_DCHECK(construction_thread_.CalledOnValidThread());
Niels Möller530ead42018-10-04 14:28:39 +0200776
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -0800777 if (media_transport_) {
778 media_transport_->RemoveTargetTransferRateObserver(this);
779 }
780
Niels Möller530ead42018-10-04 14:28:39 +0200781 StopSend();
782
Niels Möller530ead42018-10-04 14:28:39 +0200783 int error = audio_coding_->RegisterTransportCallback(NULL);
784 RTC_DCHECK_EQ(0, error);
785
Niels Möller530ead42018-10-04 14:28:39 +0200786 if (_moduleProcessThreadPtr)
787 _moduleProcessThreadPtr->DeRegisterModule(_rtpRtcpModule.get());
Niels Möller530ead42018-10-04 14:28:39 +0200788}
789
Niels Möller26815232018-11-16 09:32:40 +0100790void ChannelSend::StartSend() {
Niels Möller26e88b02018-11-19 15:08:13 +0100791 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Fredrik Solenbergeb134842018-11-19 14:13:15 +0100792 RTC_DCHECK(!sending_);
793 sending_ = true;
Niels Möller530ead42018-10-04 14:28:39 +0200794
795 // Resume the previous sequence number which was reset by StopSend(). This
796 // needs to be done before |sending| is set to true on the RTP/RTCP module.
797 if (send_sequence_number_) {
798 _rtpRtcpModule->SetSequenceNumber(send_sequence_number_);
799 }
800 _rtpRtcpModule->SetSendingMediaStatus(true);
Niels Möller26815232018-11-16 09:32:40 +0100801 int ret = _rtpRtcpModule->SetSendingStatus(true);
802 RTC_DCHECK_EQ(0, ret);
Niels Möller530ead42018-10-04 14:28:39 +0200803 {
804 // It is now OK to start posting tasks to the encoder task queue.
805 rtc::CritScope cs(&encoder_queue_lock_);
806 encoder_queue_is_active_ = true;
807 }
Niels Möller530ead42018-10-04 14:28:39 +0200808}
809
810void ChannelSend::StopSend() {
Niels Möller26e88b02018-11-19 15:08:13 +0100811 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Fredrik Solenbergeb134842018-11-19 14:13:15 +0100812 if (!sending_) {
Niels Möller530ead42018-10-04 14:28:39 +0200813 return;
814 }
Fredrik Solenbergeb134842018-11-19 14:13:15 +0100815 sending_ = false;
Niels Möller530ead42018-10-04 14:28:39 +0200816
817 // Post a task to the encoder thread which sets an event when the task is
818 // executed. We know that no more encoding tasks will be added to the task
819 // queue for this channel since sending is now deactivated. It means that,
820 // if we wait for the event to bet set, we know that no more pending tasks
821 // exists and it is therfore guaranteed that the task queue will never try
822 // to acccess and invalid channel object.
823 RTC_DCHECK(encoder_queue_);
824
Niels Möllerc572ff32018-11-07 08:43:50 +0100825 rtc::Event flush;
Niels Möller530ead42018-10-04 14:28:39 +0200826 {
827 // Clear |encoder_queue_is_active_| under lock to prevent any other tasks
828 // than this final "flush task" to be posted on the queue.
829 rtc::CritScope cs(&encoder_queue_lock_);
830 encoder_queue_is_active_ = false;
831 encoder_queue_->PostTask([&flush]() { flush.Set(); });
832 }
833 flush.Wait(rtc::Event::kForever);
834
835 // Store the sequence number to be able to pick up the same sequence for
836 // the next StartSend(). This is needed for restarting device, otherwise
837 // it might cause libSRTP to complain about packets being replayed.
838 // TODO(xians): Remove this workaround after RtpRtcpModule's refactoring
839 // CL is landed. See issue
840 // https://code.google.com/p/webrtc/issues/detail?id=2111 .
841 send_sequence_number_ = _rtpRtcpModule->SequenceNumber();
842
843 // Reset sending SSRC and sequence number and triggers direct transmission
844 // of RTCP BYE
845 if (_rtpRtcpModule->SetSendingStatus(false) == -1) {
846 RTC_DLOG(LS_ERROR) << "StartSend() RTP/RTCP failed to stop sending";
847 }
848 _rtpRtcpModule->SetSendingMediaStatus(false);
849}
850
851bool ChannelSend::SetEncoder(int payload_type,
852 std::unique_ptr<AudioEncoder> encoder) {
Niels Möller26e88b02018-11-19 15:08:13 +0100853 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +0200854 RTC_DCHECK_GE(payload_type, 0);
855 RTC_DCHECK_LE(payload_type, 127);
856 // TODO(ossu): Make CodecInsts up, for now: one for the RTP/RTCP module and
857 // one for for us to keep track of sample rate and number of channels, etc.
858
859 // The RTP/RTCP module needs to know the RTP timestamp rate (i.e. clockrate)
860 // as well as some other things, so we collect this info and send it along.
861 CodecInst rtp_codec;
862 rtp_codec.pltype = payload_type;
863 strncpy(rtp_codec.plname, "audio", sizeof(rtp_codec.plname));
864 rtp_codec.plname[sizeof(rtp_codec.plname) - 1] = 0;
865 // Seems unclear if it should be clock rate or sample rate. CodecInst
866 // supposedly carries the sample rate, but only clock rate seems sensible to
867 // send to the RTP/RTCP module.
868 rtp_codec.plfreq = encoder->RtpTimestampRateHz();
869 rtp_codec.pacsize = rtc::CheckedDivExact(
870 static_cast<int>(encoder->Max10MsFramesInAPacket() * rtp_codec.plfreq),
871 100);
872 rtp_codec.channels = encoder->NumChannels();
873 rtp_codec.rate = 0;
874
875 if (_rtpRtcpModule->RegisterSendPayload(rtp_codec) != 0) {
876 _rtpRtcpModule->DeRegisterSendPayload(payload_type);
877 if (_rtpRtcpModule->RegisterSendPayload(rtp_codec) != 0) {
878 RTC_DLOG(LS_ERROR)
879 << "SetEncoder() failed to register codec to RTP/RTCP module";
880 return false;
881 }
882 }
883
Niels Möller7d76a312018-10-26 12:57:07 +0200884 if (media_transport_) {
885 rtc::CritScope cs(&media_transport_lock_);
886 media_transport_payload_type_ = payload_type;
887 // TODO(nisse): Currently broken for G722, since timestamps passed through
888 // encoder use RTP clock rather than sample count, and they differ for G722.
889 media_transport_sampling_frequency_ = encoder->RtpTimestampRateHz();
890 }
Niels Möller530ead42018-10-04 14:28:39 +0200891 audio_coding_->SetEncoder(std::move(encoder));
892 return true;
893}
894
895void ChannelSend::ModifyEncoder(
896 rtc::FunctionView<void(std::unique_ptr<AudioEncoder>*)> modifier) {
Niels Möller26e88b02018-11-19 15:08:13 +0100897 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +0200898 audio_coding_->ModifyEncoder(modifier);
899}
900
Niels Möllerdced9f62018-11-19 10:27:07 +0100901void ChannelSend::SetBitrate(int bitrate_bps, int64_t probing_interval_ms) {
902 // This method can be called on the worker thread, module process thread
903 // or on a TaskQueue via VideoSendStreamImpl::OnEncoderConfigurationChanged.
904 // TODO(solenberg): Figure out a good way to check this or enforce calling
905 // rules.
906 // RTC_DCHECK(worker_thread_checker_.CalledOnValidThread() ||
907 // module_process_thread_checker_.CalledOnValidThread());
Piotr (Peter) Slatala1eebec92018-11-16 09:03:35 -0800908 rtc::CritScope lock(&bitrate_crit_section_);
Niels Möllerdced9f62018-11-19 10:27:07 +0100909
Niels Möller530ead42018-10-04 14:28:39 +0200910 audio_coding_->ModifyEncoder([&](std::unique_ptr<AudioEncoder>* encoder) {
911 if (*encoder) {
912 (*encoder)->OnReceivedUplinkBandwidth(bitrate_bps, probing_interval_ms);
913 }
914 });
915 retransmission_rate_limiter_->SetMaxRate(bitrate_bps);
Sebastian Jansson359d60a2018-10-25 16:22:02 +0200916 configured_bitrate_bps_ = bitrate_bps;
917}
918
Niels Möllerdced9f62018-11-19 10:27:07 +0100919int ChannelSend::GetBitrate() const {
Piotr (Peter) Slatala1eebec92018-11-16 09:03:35 -0800920 rtc::CritScope lock(&bitrate_crit_section_);
Sebastian Jansson359d60a2018-10-25 16:22:02 +0200921 return configured_bitrate_bps_;
Niels Möller530ead42018-10-04 14:28:39 +0200922}
923
924void ChannelSend::OnTwccBasedUplinkPacketLossRate(float packet_loss_rate) {
Niels Möller26e88b02018-11-19 15:08:13 +0100925 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +0200926 if (!use_twcc_plr_for_ana_)
927 return;
928 audio_coding_->ModifyEncoder([&](std::unique_ptr<AudioEncoder>* encoder) {
929 if (*encoder) {
930 (*encoder)->OnReceivedUplinkPacketLossFraction(packet_loss_rate);
931 }
932 });
933}
934
935void ChannelSend::OnRecoverableUplinkPacketLossRate(
936 float recoverable_packet_loss_rate) {
Niels Möller26e88b02018-11-19 15:08:13 +0100937 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +0200938 audio_coding_->ModifyEncoder([&](std::unique_ptr<AudioEncoder>* encoder) {
939 if (*encoder) {
940 (*encoder)->OnReceivedUplinkRecoverablePacketLossFraction(
941 recoverable_packet_loss_rate);
942 }
943 });
944}
945
946void ChannelSend::OnUplinkPacketLossRate(float packet_loss_rate) {
947 if (use_twcc_plr_for_ana_)
948 return;
949 audio_coding_->ModifyEncoder([&](std::unique_ptr<AudioEncoder>* encoder) {
950 if (*encoder) {
951 (*encoder)->OnReceivedUplinkPacketLossFraction(packet_loss_rate);
952 }
953 });
954}
955
Niels Möller530ead42018-10-04 14:28:39 +0200956void ChannelSend::RegisterTransport(Transport* transport) {
Niels Möller26e88b02018-11-19 15:08:13 +0100957 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +0200958 rtc::CritScope cs(&_callbackCritSect);
959 _transportPtr = transport;
960}
961
Niels Möller26815232018-11-16 09:32:40 +0100962// TODO(nisse): Delete always-true return value.
963bool ChannelSend::ReceivedRTCPPacket(const uint8_t* data, size_t length) {
Niels Möllerdced9f62018-11-19 10:27:07 +0100964 // May be called on either worker thread or network thread.
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -0800965 if (media_transport_) {
966 // Ignore RTCP packets while media transport is used.
967 // Those packets should not arrive, but we are seeing occasional packets.
968 return 0;
969 }
970
Niels Möller530ead42018-10-04 14:28:39 +0200971 // Deliver RTCP packet to RTP/RTCP module for parsing
972 _rtpRtcpModule->IncomingRtcpPacket(data, length);
973
974 int64_t rtt = GetRTT();
975 if (rtt == 0) {
976 // Waiting for valid RTT.
Niels Möller26815232018-11-16 09:32:40 +0100977 return true;
Niels Möller530ead42018-10-04 14:28:39 +0200978 }
979
980 int64_t nack_window_ms = rtt;
981 if (nack_window_ms < kMinRetransmissionWindowMs) {
982 nack_window_ms = kMinRetransmissionWindowMs;
983 } else if (nack_window_ms > kMaxRetransmissionWindowMs) {
984 nack_window_ms = kMaxRetransmissionWindowMs;
985 }
986 retransmission_rate_limiter_->SetWindowSize(nack_window_ms);
987
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -0800988 OnReceivedRtt(rtt);
Niels Möller26815232018-11-16 09:32:40 +0100989 return true;
Niels Möller530ead42018-10-04 14:28:39 +0200990}
991
992void ChannelSend::SetInputMute(bool enable) {
Niels Möller26e88b02018-11-19 15:08:13 +0100993 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +0200994 rtc::CritScope cs(&volume_settings_critsect_);
995 input_mute_ = enable;
996}
997
998bool ChannelSend::InputMute() const {
999 rtc::CritScope cs(&volume_settings_critsect_);
1000 return input_mute_;
1001}
1002
Niels Möller26815232018-11-16 09:32:40 +01001003bool ChannelSend::SendTelephoneEventOutband(int event, int duration_ms) {
Niels Möller26e88b02018-11-19 15:08:13 +01001004 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +02001005 RTC_DCHECK_LE(0, event);
1006 RTC_DCHECK_GE(255, event);
1007 RTC_DCHECK_LE(0, duration_ms);
1008 RTC_DCHECK_GE(65535, duration_ms);
Fredrik Solenbergeb134842018-11-19 14:13:15 +01001009 if (!sending_) {
Niels Möller26815232018-11-16 09:32:40 +01001010 return false;
Niels Möller530ead42018-10-04 14:28:39 +02001011 }
1012 if (_rtpRtcpModule->SendTelephoneEventOutband(
1013 event, duration_ms, kTelephoneEventAttenuationdB) != 0) {
1014 RTC_DLOG(LS_ERROR) << "SendTelephoneEventOutband() failed to send event";
Niels Möller26815232018-11-16 09:32:40 +01001015 return false;
Niels Möller530ead42018-10-04 14:28:39 +02001016 }
Niels Möller26815232018-11-16 09:32:40 +01001017 return true;
Niels Möller530ead42018-10-04 14:28:39 +02001018}
1019
Niels Möller26815232018-11-16 09:32:40 +01001020bool ChannelSend::SetSendTelephoneEventPayloadType(int payload_type,
1021 int payload_frequency) {
Niels Möller26e88b02018-11-19 15:08:13 +01001022 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +02001023 RTC_DCHECK_LE(0, payload_type);
1024 RTC_DCHECK_GE(127, payload_type);
1025 CodecInst codec = {0};
1026 codec.pltype = payload_type;
1027 codec.plfreq = payload_frequency;
1028 memcpy(codec.plname, "telephone-event", 16);
1029 if (_rtpRtcpModule->RegisterSendPayload(codec) != 0) {
1030 _rtpRtcpModule->DeRegisterSendPayload(codec.pltype);
1031 if (_rtpRtcpModule->RegisterSendPayload(codec) != 0) {
1032 RTC_DLOG(LS_ERROR)
1033 << "SetSendTelephoneEventPayloadType() failed to register "
1034 "send payload type";
Niels Möller26815232018-11-16 09:32:40 +01001035 return false;
Niels Möller530ead42018-10-04 14:28:39 +02001036 }
1037 }
Niels Möller26815232018-11-16 09:32:40 +01001038 return true;
Niels Möller530ead42018-10-04 14:28:39 +02001039}
1040
Niels Möllerdced9f62018-11-19 10:27:07 +01001041void ChannelSend::SetLocalSSRC(uint32_t ssrc) {
Niels Möller26e88b02018-11-19 15:08:13 +01001042 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Fredrik Solenbergeb134842018-11-19 14:13:15 +01001043 RTC_DCHECK(!sending_);
Niels Möller26815232018-11-16 09:32:40 +01001044
Niels Möller7d76a312018-10-26 12:57:07 +02001045 if (media_transport_) {
1046 rtc::CritScope cs(&media_transport_lock_);
1047 media_transport_channel_id_ = ssrc;
1048 }
Niels Möller530ead42018-10-04 14:28:39 +02001049 _rtpRtcpModule->SetSSRC(ssrc);
Niels Möller530ead42018-10-04 14:28:39 +02001050}
1051
1052void ChannelSend::SetMid(const std::string& mid, int extension_id) {
Niels Möller26e88b02018-11-19 15:08:13 +01001053 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +02001054 int ret = SetSendRtpHeaderExtension(true, kRtpExtensionMid, extension_id);
1055 RTC_DCHECK_EQ(0, ret);
1056 _rtpRtcpModule->SetMid(mid);
1057}
1058
Johannes Kron9190b822018-10-29 11:22:05 +01001059void ChannelSend::SetExtmapAllowMixed(bool extmap_allow_mixed) {
Niels Möller26e88b02018-11-19 15:08:13 +01001060 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Johannes Kron9190b822018-10-29 11:22:05 +01001061 _rtpRtcpModule->SetExtmapAllowMixed(extmap_allow_mixed);
1062}
1063
Niels Möller26815232018-11-16 09:32:40 +01001064void ChannelSend::SetSendAudioLevelIndicationStatus(bool enable, int id) {
Niels Möller26e88b02018-11-19 15:08:13 +01001065 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +02001066 _includeAudioLevelIndication = enable;
Niels Möller26815232018-11-16 09:32:40 +01001067 int ret = SetSendRtpHeaderExtension(enable, kRtpExtensionAudioLevel, id);
1068 RTC_DCHECK_EQ(0, ret);
Niels Möller530ead42018-10-04 14:28:39 +02001069}
1070
1071void ChannelSend::EnableSendTransportSequenceNumber(int id) {
Niels Möller26e88b02018-11-19 15:08:13 +01001072 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +02001073 int ret =
1074 SetSendRtpHeaderExtension(true, kRtpExtensionTransportSequenceNumber, id);
1075 RTC_DCHECK_EQ(0, ret);
1076}
1077
1078void ChannelSend::RegisterSenderCongestionControlObjects(
1079 RtpTransportControllerSendInterface* transport,
1080 RtcpBandwidthObserver* bandwidth_observer) {
Niels Möller26e88b02018-11-19 15:08:13 +01001081 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +02001082 RtpPacketSender* rtp_packet_sender = transport->packet_sender();
1083 TransportFeedbackObserver* transport_feedback_observer =
1084 transport->transport_feedback_observer();
1085 PacketRouter* packet_router = transport->packet_router();
1086
1087 RTC_DCHECK(rtp_packet_sender);
1088 RTC_DCHECK(transport_feedback_observer);
1089 RTC_DCHECK(packet_router);
1090 RTC_DCHECK(!packet_router_);
1091 rtcp_observer_->SetBandwidthObserver(bandwidth_observer);
1092 feedback_observer_proxy_->SetTransportFeedbackObserver(
1093 transport_feedback_observer);
1094 seq_num_allocator_proxy_->SetSequenceNumberAllocator(packet_router);
1095 rtp_packet_sender_proxy_->SetPacketSender(rtp_packet_sender);
1096 _rtpRtcpModule->SetStorePacketsStatus(true, 600);
1097 constexpr bool remb_candidate = false;
1098 packet_router->AddSendRtpModule(_rtpRtcpModule.get(), remb_candidate);
1099 packet_router_ = packet_router;
1100}
1101
1102void ChannelSend::ResetSenderCongestionControlObjects() {
Niels Möller26e88b02018-11-19 15:08:13 +01001103 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +02001104 RTC_DCHECK(packet_router_);
1105 _rtpRtcpModule->SetStorePacketsStatus(false, 600);
1106 rtcp_observer_->SetBandwidthObserver(nullptr);
1107 feedback_observer_proxy_->SetTransportFeedbackObserver(nullptr);
1108 seq_num_allocator_proxy_->SetSequenceNumberAllocator(nullptr);
1109 packet_router_->RemoveSendRtpModule(_rtpRtcpModule.get());
1110 packet_router_ = nullptr;
1111 rtp_packet_sender_proxy_->SetPacketSender(nullptr);
1112}
1113
Niels Möller26815232018-11-16 09:32:40 +01001114void ChannelSend::SetRTCP_CNAME(absl::string_view c_name) {
Niels Möller26e88b02018-11-19 15:08:13 +01001115 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller26815232018-11-16 09:32:40 +01001116 // Note: SetCNAME() accepts a c string of length at most 255.
1117 const std::string c_name_limited(c_name.substr(0, 255));
1118 int ret = _rtpRtcpModule->SetCNAME(c_name_limited.c_str()) != 0;
1119 RTC_DCHECK_EQ(0, ret) << "SetRTCP_CNAME() failed to set RTCP CNAME";
Niels Möller530ead42018-10-04 14:28:39 +02001120}
1121
Niels Möller26815232018-11-16 09:32:40 +01001122std::vector<ReportBlock> ChannelSend::GetRemoteRTCPReportBlocks() const {
Niels Möller26e88b02018-11-19 15:08:13 +01001123 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +02001124 // Get the report blocks from the latest received RTCP Sender or Receiver
1125 // Report. Each element in the vector contains the sender's SSRC and a
1126 // report block according to RFC 3550.
1127 std::vector<RTCPReportBlock> rtcp_report_blocks;
Niels Möller530ead42018-10-04 14:28:39 +02001128
Niels Möller26815232018-11-16 09:32:40 +01001129 int ret = _rtpRtcpModule->RemoteRTCPStat(&rtcp_report_blocks);
1130 RTC_DCHECK_EQ(0, ret);
1131
1132 std::vector<ReportBlock> report_blocks;
Niels Möller530ead42018-10-04 14:28:39 +02001133
1134 std::vector<RTCPReportBlock>::const_iterator it = rtcp_report_blocks.begin();
1135 for (; it != rtcp_report_blocks.end(); ++it) {
1136 ReportBlock report_block;
1137 report_block.sender_SSRC = it->sender_ssrc;
1138 report_block.source_SSRC = it->source_ssrc;
1139 report_block.fraction_lost = it->fraction_lost;
1140 report_block.cumulative_num_packets_lost = it->packets_lost;
1141 report_block.extended_highest_sequence_number =
1142 it->extended_highest_sequence_number;
1143 report_block.interarrival_jitter = it->jitter;
1144 report_block.last_SR_timestamp = it->last_sender_report_timestamp;
1145 report_block.delay_since_last_SR = it->delay_since_last_sender_report;
Niels Möller26815232018-11-16 09:32:40 +01001146 report_blocks.push_back(report_block);
Niels Möller530ead42018-10-04 14:28:39 +02001147 }
Niels Möller26815232018-11-16 09:32:40 +01001148 return report_blocks;
Niels Möller530ead42018-10-04 14:28:39 +02001149}
1150
Niels Möller26815232018-11-16 09:32:40 +01001151CallSendStatistics ChannelSend::GetRTCPStatistics() const {
Niels Möller26e88b02018-11-19 15:08:13 +01001152 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller26815232018-11-16 09:32:40 +01001153 CallSendStatistics stats = {0};
Niels Möller530ead42018-10-04 14:28:39 +02001154 stats.rttMs = GetRTT();
1155
Niels Möller530ead42018-10-04 14:28:39 +02001156 size_t bytesSent(0);
1157 uint32_t packetsSent(0);
1158
1159 if (_rtpRtcpModule->DataCountersRTP(&bytesSent, &packetsSent) != 0) {
1160 RTC_DLOG(LS_WARNING)
1161 << "GetRTPStatistics() failed to retrieve RTP datacounters"
1162 << " => output will not be complete";
1163 }
1164
1165 stats.bytesSent = bytesSent;
1166 stats.packetsSent = packetsSent;
1167
Niels Möller26815232018-11-16 09:32:40 +01001168 return stats;
Niels Möller530ead42018-10-04 14:28:39 +02001169}
1170
Niels Möller530ead42018-10-04 14:28:39 +02001171void ChannelSend::ProcessAndEncodeAudio(
1172 std::unique_ptr<AudioFrame> audio_frame) {
Niels Möllerdced9f62018-11-19 10:27:07 +01001173 RTC_DCHECK_RUNS_SERIALIZED(&audio_thread_race_checker_);
Niels Möller530ead42018-10-04 14:28:39 +02001174 // Avoid posting any new tasks if sending was already stopped in StopSend().
1175 rtc::CritScope cs(&encoder_queue_lock_);
1176 if (!encoder_queue_is_active_) {
1177 return;
1178 }
1179 // Profile time between when the audio frame is added to the task queue and
1180 // when the task is actually executed.
1181 audio_frame->UpdateProfileTimeStamp();
1182 encoder_queue_->PostTask(std::unique_ptr<rtc::QueuedTask>(
1183 new ProcessAndEncodeAudioTask(std::move(audio_frame), this)));
1184}
1185
1186void ChannelSend::ProcessAndEncodeAudioOnTaskQueue(AudioFrame* audio_input) {
1187 RTC_DCHECK_RUN_ON(encoder_queue_);
1188 RTC_DCHECK_GT(audio_input->samples_per_channel_, 0);
1189 RTC_DCHECK_LE(audio_input->num_channels_, 2);
1190
1191 // Measure time between when the audio frame is added to the task queue and
1192 // when the task is actually executed. Goal is to keep track of unwanted
1193 // extra latency added by the task queue.
1194 RTC_HISTOGRAM_COUNTS_10000("WebRTC.Audio.EncodingTaskQueueLatencyMs",
1195 audio_input->ElapsedProfileTimeMs());
1196
1197 bool is_muted = InputMute();
1198 AudioFrameOperations::Mute(audio_input, previous_frame_muted_, is_muted);
1199
1200 if (_includeAudioLevelIndication) {
1201 size_t length =
1202 audio_input->samples_per_channel_ * audio_input->num_channels_;
1203 RTC_CHECK_LE(length, AudioFrame::kMaxDataSizeBytes);
1204 if (is_muted && previous_frame_muted_) {
1205 rms_level_.AnalyzeMuted(length);
1206 } else {
1207 rms_level_.Analyze(
1208 rtc::ArrayView<const int16_t>(audio_input->data(), length));
1209 }
1210 }
1211 previous_frame_muted_ = is_muted;
1212
1213 // Add 10ms of raw (PCM) audio data to the encoder @ 32kHz.
1214
1215 // The ACM resamples internally.
1216 audio_input->timestamp_ = _timeStamp;
1217 // This call will trigger AudioPacketizationCallback::SendData if encoding
1218 // is done and payload is ready for packetization and transmission.
1219 // Otherwise, it will return without invoking the callback.
1220 if (audio_coding_->Add10MsData(*audio_input) < 0) {
1221 RTC_DLOG(LS_ERROR) << "ACM::Add10MsData() failed.";
1222 return;
1223 }
1224
1225 _timeStamp += static_cast<uint32_t>(audio_input->samples_per_channel_);
1226}
1227
1228void ChannelSend::UpdateOverheadForEncoder() {
1229 size_t overhead_per_packet =
1230 transport_overhead_per_packet_ + rtp_overhead_per_packet_;
1231 audio_coding_->ModifyEncoder([&](std::unique_ptr<AudioEncoder>* encoder) {
1232 if (*encoder) {
1233 (*encoder)->OnReceivedOverhead(overhead_per_packet);
1234 }
1235 });
1236}
1237
1238void ChannelSend::SetTransportOverhead(size_t transport_overhead_per_packet) {
Niels Möller26e88b02018-11-19 15:08:13 +01001239 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +02001240 rtc::CritScope cs(&overhead_per_packet_lock_);
1241 transport_overhead_per_packet_ = transport_overhead_per_packet;
1242 UpdateOverheadForEncoder();
1243}
1244
1245// TODO(solenberg): Make AudioSendStream an OverheadObserver instead.
1246void ChannelSend::OnOverheadChanged(size_t overhead_bytes_per_packet) {
1247 rtc::CritScope cs(&overhead_per_packet_lock_);
1248 rtp_overhead_per_packet_ = overhead_bytes_per_packet;
1249 UpdateOverheadForEncoder();
1250}
1251
1252ANAStats ChannelSend::GetANAStatistics() const {
Niels Möller26e88b02018-11-19 15:08:13 +01001253 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +02001254 return audio_coding_->GetANAStats();
1255}
1256
1257RtpRtcp* ChannelSend::GetRtpRtcp() const {
Niels Möllerdced9f62018-11-19 10:27:07 +01001258 RTC_DCHECK(module_process_thread_checker_.CalledOnValidThread());
Niels Möller530ead42018-10-04 14:28:39 +02001259 return _rtpRtcpModule.get();
1260}
1261
1262int ChannelSend::SetSendRtpHeaderExtension(bool enable,
1263 RTPExtensionType type,
Niels Möller26815232018-11-16 09:32:40 +01001264 int id) {
Niels Möller530ead42018-10-04 14:28:39 +02001265 int error = 0;
1266 _rtpRtcpModule->DeregisterSendRtpHeaderExtension(type);
1267 if (enable) {
Niels Möller26815232018-11-16 09:32:40 +01001268 // TODO(nisse): RtpRtcp::RegisterSendRtpHeaderExtension to take an int
1269 // argument. Currently it wants an uint8_t.
1270 error = _rtpRtcpModule->RegisterSendRtpHeaderExtension(
1271 type, rtc::dchecked_cast<uint8_t>(id));
Niels Möller530ead42018-10-04 14:28:39 +02001272 }
1273 return error;
1274}
1275
Niels Möller530ead42018-10-04 14:28:39 +02001276int64_t ChannelSend::GetRTT() const {
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -08001277 if (media_transport_) {
1278 // GetRTT is generally used in the RTCP codepath, where media transport is
1279 // not present and so it shouldn't be needed. But it's also invoked in
1280 // 'GetStats' method, and for now returning media transport RTT here gives
1281 // us "free" rtt stats for media transport.
1282 auto target_rate = media_transport_->GetLatestTargetTransferRate();
1283 if (target_rate.has_value()) {
1284 return target_rate.value().network_estimate.round_trip_time.ms();
1285 }
1286
1287 return 0;
1288 }
Niels Möller530ead42018-10-04 14:28:39 +02001289 RtcpMode method = _rtpRtcpModule->RTCP();
1290 if (method == RtcpMode::kOff) {
1291 return 0;
1292 }
1293 std::vector<RTCPReportBlock> report_blocks;
1294 _rtpRtcpModule->RemoteRTCPStat(&report_blocks);
1295
1296 if (report_blocks.empty()) {
1297 return 0;
1298 }
1299
1300 int64_t rtt = 0;
1301 int64_t avg_rtt = 0;
1302 int64_t max_rtt = 0;
1303 int64_t min_rtt = 0;
1304 // We don't know in advance the remote ssrc used by the other end's receiver
1305 // reports, so use the SSRC of the first report block for calculating the RTT.
1306 if (_rtpRtcpModule->RTT(report_blocks[0].sender_ssrc, &rtt, &avg_rtt,
1307 &min_rtt, &max_rtt) != 0) {
1308 return 0;
1309 }
1310 return rtt;
1311}
1312
Benjamin Wright78410ad2018-10-25 09:52:57 -07001313void ChannelSend::SetFrameEncryptor(
1314 rtc::scoped_refptr<FrameEncryptorInterface> frame_encryptor) {
Niels Möller26e88b02018-11-19 15:08:13 +01001315 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Benjamin Wright84583f62018-10-04 14:22:34 -07001316 rtc::CritScope cs(&encoder_queue_lock_);
1317 if (encoder_queue_is_active_) {
1318 encoder_queue_->PostTask([this, frame_encryptor]() {
Benjamin Wright78410ad2018-10-25 09:52:57 -07001319 this->frame_encryptor_ = std::move(frame_encryptor);
Benjamin Wright84583f62018-10-04 14:22:34 -07001320 });
1321 } else {
Benjamin Wright78410ad2018-10-25 09:52:57 -07001322 frame_encryptor_ = std::move(frame_encryptor);
Benjamin Wright84583f62018-10-04 14:22:34 -07001323 }
1324}
1325
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -08001326void ChannelSend::OnTargetTransferRate(TargetTransferRate rate) {
1327 RTC_DCHECK(media_transport_);
1328 OnReceivedRtt(rate.network_estimate.round_trip_time.ms());
1329}
1330
1331void ChannelSend::OnReceivedRtt(int64_t rtt_ms) {
1332 // Invoke audio encoders OnReceivedRtt().
1333 audio_coding_->ModifyEncoder(
1334 [rtt_ms](std::unique_ptr<AudioEncoder>* encoder) {
1335 if (*encoder) {
1336 (*encoder)->OnReceivedRtt(rtt_ms);
1337 }
1338 });
1339}
1340
Niels Möllerdced9f62018-11-19 10:27:07 +01001341} // namespace
1342
1343std::unique_ptr<ChannelSendInterface> CreateChannelSend(
1344 rtc::TaskQueue* encoder_queue,
1345 ProcessThread* module_process_thread,
1346 MediaTransportInterface* media_transport,
1347 RtcpRttStats* rtcp_rtt_stats,
1348 RtcEventLog* rtc_event_log,
1349 FrameEncryptorInterface* frame_encryptor,
1350 const webrtc::CryptoOptions& crypto_options,
1351 bool extmap_allow_mixed,
1352 int rtcp_report_interval_ms) {
1353 return absl::make_unique<ChannelSend>(
1354 encoder_queue, module_process_thread, media_transport, rtcp_rtt_stats,
1355 rtc_event_log, frame_encryptor, crypto_options, extmap_allow_mixed,
1356 rtcp_report_interval_ms);
1357}
1358
Niels Möller530ead42018-10-04 14:28:39 +02001359} // namespace voe
1360} // namespace webrtc