1 /*
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 "api/array_view.h"
21 #include "api/call/transport.h"
22 #include "api/crypto/frame_encryptor_interface.h"
23 #include "api/rtc_event_log/rtc_event_log.h"
24 #include "api/sequence_checker.h"
25 #include "audio/channel_send_frame_transformer_delegate.h"
26 #include "audio/utility/audio_frame_operations.h"
27 #include "call/rtp_transport_controller_send_interface.h"
28 #include "logging/rtc_event_log/events/rtc_event_audio_playout.h"
29 #include "modules/audio_coding/audio_network_adaptor/include/audio_network_adaptor_config.h"
30 #include "modules/audio_coding/include/audio_coding_module.h"
31 #include "modules/audio_processing/rms_level.h"
32 #include "modules/pacing/packet_router.h"
33 #include "modules/rtp_rtcp/source/rtp_rtcp_impl2.h"
34 #include "rtc_base/checks.h"
35 #include "rtc_base/event.h"
36 #include "rtc_base/logging.h"
37 #include "rtc_base/numerics/safe_conversions.h"
38 #include "rtc_base/race_checker.h"
39 #include "rtc_base/rate_limiter.h"
40 #include "rtc_base/synchronization/mutex.h"
41 #include "rtc_base/task_queue.h"
42 #include "rtc_base/time_utils.h"
43 #include "rtc_base/trace_event.h"
44 #include "system_wrappers/include/clock.h"
45 #include "system_wrappers/include/metrics.h"
46
47 namespace webrtc {
48 namespace voe {
49
50 namespace {
51
52 constexpr int64_t kMaxRetransmissionWindowMs = 1000;
53 constexpr int64_t kMinRetransmissionWindowMs = 30;
54
55 class RtpPacketSenderProxy;
56 class TransportSequenceNumberProxy;
57 class VoERtcpObserver;
58
59 class ChannelSend : public ChannelSendInterface,
60 public AudioPacketizationCallback, // receive encoded
61 // packets from the ACM
62 public RtcpPacketTypeCounterObserver {
63 public:
64 ChannelSend(Clock* clock,
65 TaskQueueFactory* task_queue_factory,
66 Transport* rtp_transport,
67 RtcpRttStats* rtcp_rtt_stats,
68 RtcEventLog* rtc_event_log,
69 FrameEncryptorInterface* frame_encryptor,
70 const webrtc::CryptoOptions& crypto_options,
71 bool extmap_allow_mixed,
72 int rtcp_report_interval_ms,
73 uint32_t ssrc,
74 rtc::scoped_refptr<FrameTransformerInterface> frame_transformer,
75 TransportFeedbackObserver* feedback_observer,
76 const FieldTrialsView& field_trials);
77
78 ~ChannelSend() override;
79
80 // Send using this encoder, with this payload type.
81 void SetEncoder(int payload_type,
82 std::unique_ptr<AudioEncoder> encoder) override;
83 void ModifyEncoder(rtc::FunctionView<void(std::unique_ptr<AudioEncoder>*)>
84 modifier) override;
85 void CallEncoder(rtc::FunctionView<void(AudioEncoder*)> modifier) override;
86
87 // API methods
88 void StartSend() override;
89 void StopSend() override;
90
91 // Codecs
92 void OnBitrateAllocation(BitrateAllocationUpdate update) override;
93 int GetTargetBitrate() const override;
94
95 // Network
96 void ReceivedRTCPPacket(const uint8_t* data, size_t length) override;
97
98 // Muting, Volume and Level.
99 void SetInputMute(bool enable) override;
100
101 // Stats.
102 ANAStats GetANAStatistics() const override;
103
104 // Used by AudioSendStream.
105 RtpRtcpInterface* GetRtpRtcp() const override;
106
107 void RegisterCngPayloadType(int payload_type, int payload_frequency) override;
108
109 // DTMF.
110 bool SendTelephoneEventOutband(int event, int duration_ms) override;
111 void SetSendTelephoneEventPayloadType(int payload_type,
112 int payload_frequency) override;
113
114 // RTP+RTCP
115 void SetSendAudioLevelIndicationStatus(bool enable, int id) override;
116
117 void RegisterSenderCongestionControlObjects(
118 RtpTransportControllerSendInterface* transport,
119 RtcpBandwidthObserver* bandwidth_observer) override;
120 void ResetSenderCongestionControlObjects() override;
121 void SetRTCP_CNAME(absl::string_view c_name) override;
122 std::vector<ReportBlock> GetRemoteRTCPReportBlocks() const override;
123 CallSendStatistics GetRTCPStatistics() const override;
124
125 // ProcessAndEncodeAudio() posts a task on the shared encoder task queue,
126 // which in turn calls (on the queue) ProcessAndEncodeAudioOnTaskQueue() where
127 // the actual processing of the audio takes place. The processing mainly
128 // consists of encoding and preparing the result for sending by adding it to a
129 // send queue.
130 // The main reason for using a task queue here is to release the native,
131 // OS-specific, audio capture thread as soon as possible to ensure that it
132 // can go back to sleep and be prepared to deliver an new captured audio
133 // packet.
134 void ProcessAndEncodeAudio(std::unique_ptr<AudioFrame> audio_frame) override;
135
136 int64_t GetRTT() const override;
137
138 // E2EE Custom Audio Frame Encryption
139 void SetFrameEncryptor(
140 rtc::scoped_refptr<FrameEncryptorInterface> frame_encryptor) override;
141
142 // Sets a frame transformer between encoder and packetizer, to transform
143 // encoded frames before sending them out the network.
144 void SetEncoderToPacketizerFrameTransformer(
145 rtc::scoped_refptr<webrtc::FrameTransformerInterface> frame_transformer)
146 override;
147
148 // RtcpPacketTypeCounterObserver.
149 void RtcpPacketTypesCounterUpdated(
150 uint32_t ssrc,
151 const RtcpPacketTypeCounter& packet_counter) override;
152
153 void OnUplinkPacketLossRate(float packet_loss_rate);
154
155 private:
156 // From AudioPacketizationCallback in the ACM
157 int32_t SendData(AudioFrameType frameType,
158 uint8_t payloadType,
159 uint32_t rtp_timestamp,
160 const uint8_t* payloadData,
161 size_t payloadSize,
162 int64_t absolute_capture_timestamp_ms) override;
163
164 bool InputMute() const;
165
166 int32_t SendRtpAudio(AudioFrameType frameType,
167 uint8_t payloadType,
168 uint32_t rtp_timestamp,
169 rtc::ArrayView<const uint8_t> payload,
170 int64_t absolute_capture_timestamp_ms)
171 RTC_RUN_ON(encoder_queue_);
172
173 void OnReceivedRtt(int64_t rtt_ms);
174
175 void InitFrameTransformerDelegate(
176 rtc::scoped_refptr<webrtc::FrameTransformerInterface> frame_transformer);
177
178 // Thread checkers document and lock usage of some methods on voe::Channel to
179 // specific threads we know about. The goal is to eventually split up
180 // voe::Channel into parts with single-threaded semantics, and thereby reduce
181 // the need for locks.
182 SequenceChecker worker_thread_checker_;
183 // Methods accessed from audio and video threads are checked for sequential-
184 // only access. We don't necessarily own and control these threads, so thread
185 // checkers cannot be used. E.g. Chromium may transfer "ownership" from one
186 // audio thread to another, but access is still sequential.
187 rtc::RaceChecker audio_thread_race_checker_;
188
189 mutable Mutex volume_settings_mutex_;
190
191 const uint32_t ssrc_;
192 bool sending_ RTC_GUARDED_BY(&worker_thread_checker_) = false;
193
194 RtcEventLog* const event_log_;
195
196 std::unique_ptr<ModuleRtpRtcpImpl2> rtp_rtcp_;
197 std::unique_ptr<RTPSenderAudio> rtp_sender_audio_;
198
199 std::unique_ptr<AudioCodingModule> audio_coding_;
200 uint32_t _timeStamp RTC_GUARDED_BY(encoder_queue_);
201
202 // uses
203 RmsLevel rms_level_ RTC_GUARDED_BY(encoder_queue_);
204 bool input_mute_ RTC_GUARDED_BY(volume_settings_mutex_);
205 bool previous_frame_muted_ RTC_GUARDED_BY(encoder_queue_);
206 // VoeRTP_RTCP
207 // TODO(henrika): can today be accessed on the main thread and on the
208 // task queue; hence potential race.
209 bool _includeAudioLevelIndication;
210
211 // RtcpBandwidthObserver
212 const std::unique_ptr<VoERtcpObserver> rtcp_observer_;
213
214 PacketRouter* packet_router_ RTC_GUARDED_BY(&worker_thread_checker_) =
215 nullptr;
216 TransportFeedbackObserver* const feedback_observer_;
217 const std::unique_ptr<RtpPacketSenderProxy> rtp_packet_pacer_proxy_;
218 const std::unique_ptr<RateLimiter> retransmission_rate_limiter_;
219
220 SequenceChecker construction_thread_;
221
222 bool encoder_queue_is_active_ RTC_GUARDED_BY(encoder_queue_) = false;
223
224 // E2EE Audio Frame Encryption
225 rtc::scoped_refptr<FrameEncryptorInterface> frame_encryptor_
226 RTC_GUARDED_BY(encoder_queue_);
227 // E2EE Frame Encryption Options
228 const webrtc::CryptoOptions crypto_options_;
229
230 // Delegates calls to a frame transformer to transform audio, and
231 // receives callbacks with the transformed frames; delegates calls to
232 // ChannelSend::SendRtpAudio to send the transformed audio.
233 rtc::scoped_refptr<ChannelSendFrameTransformerDelegate>
234 frame_transformer_delegate_ RTC_GUARDED_BY(encoder_queue_);
235
236 const bool fixing_timestamp_stall_;
237
238 mutable Mutex rtcp_counter_mutex_;
239 RtcpPacketTypeCounter rtcp_packet_type_counter_
240 RTC_GUARDED_BY(rtcp_counter_mutex_);
241
242 // Defined last to ensure that there are no running tasks when the other
243 // members are destroyed.
244 rtc::TaskQueue encoder_queue_;
245 };
246
247 const int kTelephoneEventAttenuationdB = 10;
248
249 class RtpPacketSenderProxy : public RtpPacketSender {
250 public:
RtpPacketSenderProxy()251 RtpPacketSenderProxy() : rtp_packet_pacer_(nullptr) {}
252
SetPacketPacer(RtpPacketSender * rtp_packet_pacer)253 void SetPacketPacer(RtpPacketSender* rtp_packet_pacer) {
254 RTC_DCHECK(thread_checker_.IsCurrent());
255 MutexLock lock(&mutex_);
256 rtp_packet_pacer_ = rtp_packet_pacer;
257 }
258
EnqueuePackets(std::vector<std::unique_ptr<RtpPacketToSend>> packets)259 void EnqueuePackets(
260 std::vector<std::unique_ptr<RtpPacketToSend>> packets) override {
261 MutexLock lock(&mutex_);
262 rtp_packet_pacer_->EnqueuePackets(std::move(packets));
263 }
264
265 private:
266 SequenceChecker thread_checker_;
267 Mutex mutex_;
268 RtpPacketSender* rtp_packet_pacer_ RTC_GUARDED_BY(&mutex_);
269 };
270
271 class VoERtcpObserver : public RtcpBandwidthObserver {
272 public:
VoERtcpObserver(ChannelSend * owner)273 explicit VoERtcpObserver(ChannelSend* owner)
274 : owner_(owner), bandwidth_observer_(nullptr) {}
~VoERtcpObserver()275 ~VoERtcpObserver() override {}
276
SetBandwidthObserver(RtcpBandwidthObserver * bandwidth_observer)277 void SetBandwidthObserver(RtcpBandwidthObserver* bandwidth_observer) {
278 MutexLock lock(&mutex_);
279 bandwidth_observer_ = bandwidth_observer;
280 }
281
OnReceivedEstimatedBitrate(uint32_t bitrate)282 void OnReceivedEstimatedBitrate(uint32_t bitrate) override {
283 MutexLock lock(&mutex_);
284 if (bandwidth_observer_) {
285 bandwidth_observer_->OnReceivedEstimatedBitrate(bitrate);
286 }
287 }
288
OnReceivedRtcpReceiverReport(const ReportBlockList & report_blocks,int64_t rtt,int64_t now_ms)289 void OnReceivedRtcpReceiverReport(const ReportBlockList& report_blocks,
290 int64_t rtt,
291 int64_t now_ms) override {
292 {
293 MutexLock lock(&mutex_);
294 if (bandwidth_observer_) {
295 bandwidth_observer_->OnReceivedRtcpReceiverReport(report_blocks, rtt,
296 now_ms);
297 }
298 }
299 // TODO(mflodman): Do we need to aggregate reports here or can we jut send
300 // what we get? I.e. do we ever get multiple reports bundled into one RTCP
301 // report for VoiceEngine?
302 if (report_blocks.empty())
303 return;
304
305 int fraction_lost_aggregate = 0;
306 int total_number_of_packets = 0;
307
308 // If receiving multiple report blocks, calculate the weighted average based
309 // on the number of packets a report refers to.
310 for (ReportBlockList::const_iterator block_it = report_blocks.begin();
311 block_it != report_blocks.end(); ++block_it) {
312 // Find the previous extended high sequence number for this remote SSRC,
313 // to calculate the number of RTP packets this report refers to. Ignore if
314 // we haven't seen this SSRC before.
315 std::map<uint32_t, uint32_t>::iterator seq_num_it =
316 extended_max_sequence_number_.find(block_it->source_ssrc);
317 int number_of_packets = 0;
318 if (seq_num_it != extended_max_sequence_number_.end()) {
319 number_of_packets =
320 block_it->extended_highest_sequence_number - seq_num_it->second;
321 }
322 fraction_lost_aggregate += number_of_packets * block_it->fraction_lost;
323 total_number_of_packets += number_of_packets;
324
325 extended_max_sequence_number_[block_it->source_ssrc] =
326 block_it->extended_highest_sequence_number;
327 }
328 int weighted_fraction_lost = 0;
329 if (total_number_of_packets > 0) {
330 weighted_fraction_lost =
331 (fraction_lost_aggregate + total_number_of_packets / 2) /
332 total_number_of_packets;
333 }
334 owner_->OnUplinkPacketLossRate(weighted_fraction_lost / 255.0f);
335 }
336
337 private:
338 ChannelSend* owner_;
339 // Maps remote side ssrc to extended highest sequence number received.
340 std::map<uint32_t, uint32_t> extended_max_sequence_number_;
341 Mutex mutex_;
342 RtcpBandwidthObserver* bandwidth_observer_ RTC_GUARDED_BY(mutex_);
343 };
344
SendData(AudioFrameType frameType,uint8_t payloadType,uint32_t rtp_timestamp,const uint8_t * payloadData,size_t payloadSize,int64_t absolute_capture_timestamp_ms)345 int32_t ChannelSend::SendData(AudioFrameType frameType,
346 uint8_t payloadType,
347 uint32_t rtp_timestamp,
348 const uint8_t* payloadData,
349 size_t payloadSize,
350 int64_t absolute_capture_timestamp_ms) {
351 RTC_DCHECK_RUN_ON(&encoder_queue_);
352 rtc::ArrayView<const uint8_t> payload(payloadData, payloadSize);
353 if (frame_transformer_delegate_) {
354 // Asynchronously transform the payload before sending it. After the payload
355 // is transformed, the delegate will call SendRtpAudio to send it.
356 frame_transformer_delegate_->Transform(
357 frameType, payloadType, rtp_timestamp, rtp_rtcp_->StartTimestamp(),
358 payloadData, payloadSize, absolute_capture_timestamp_ms,
359 rtp_rtcp_->SSRC());
360 return 0;
361 }
362 return SendRtpAudio(frameType, payloadType, rtp_timestamp, payload,
363 absolute_capture_timestamp_ms);
364 }
365
SendRtpAudio(AudioFrameType frameType,uint8_t payloadType,uint32_t rtp_timestamp,rtc::ArrayView<const uint8_t> payload,int64_t absolute_capture_timestamp_ms)366 int32_t ChannelSend::SendRtpAudio(AudioFrameType frameType,
367 uint8_t payloadType,
368 uint32_t rtp_timestamp,
369 rtc::ArrayView<const uint8_t> payload,
370 int64_t absolute_capture_timestamp_ms) {
371 if (_includeAudioLevelIndication) {
372 // Store current audio level in the RTP sender.
373 // The level will be used in combination with voice-activity state
374 // (frameType) to add an RTP header extension
375 rtp_sender_audio_->SetAudioLevel(rms_level_.Average());
376 }
377
378 // E2EE Custom Audio Frame Encryption (This is optional).
379 // Keep this buffer around for the lifetime of the send call.
380 rtc::Buffer encrypted_audio_payload;
381 // We don't invoke encryptor if payload is empty, which means we are to send
382 // DTMF, or the encoder entered DTX.
383 // TODO(minyue): see whether DTMF packets should be encrypted or not. In
384 // current implementation, they are not.
385 if (!payload.empty()) {
386 if (frame_encryptor_ != nullptr) {
387 // TODO([email protected]) - Allocate enough to always encrypt inline.
388 // Allocate a buffer to hold the maximum possible encrypted payload.
389 size_t max_ciphertext_size = frame_encryptor_->GetMaxCiphertextByteSize(
390 cricket::MEDIA_TYPE_AUDIO, payload.size());
391 encrypted_audio_payload.SetSize(max_ciphertext_size);
392
393 // Encrypt the audio payload into the buffer.
394 size_t bytes_written = 0;
395 int encrypt_status = frame_encryptor_->Encrypt(
396 cricket::MEDIA_TYPE_AUDIO, rtp_rtcp_->SSRC(),
397 /*additional_data=*/nullptr, payload, encrypted_audio_payload,
398 &bytes_written);
399 if (encrypt_status != 0) {
400 RTC_DLOG(LS_ERROR)
401 << "Channel::SendData() failed encrypt audio payload: "
402 << encrypt_status;
403 return -1;
404 }
405 // Resize the buffer to the exact number of bytes actually used.
406 encrypted_audio_payload.SetSize(bytes_written);
407 // Rewrite the payloadData and size to the new encrypted payload.
408 payload = encrypted_audio_payload;
409 } else if (crypto_options_.sframe.require_frame_encryption) {
410 RTC_DLOG(LS_ERROR) << "Channel::SendData() failed sending audio payload: "
411 "A frame encryptor is required but one is not set.";
412 return -1;
413 }
414 }
415
416 // Push data from ACM to RTP/RTCP-module to deliver audio frame for
417 // packetization.
418 if (!rtp_rtcp_->OnSendingRtpFrame(rtp_timestamp,
419 // Leaving the time when this frame was
420 // received from the capture device as
421 // undefined for voice for now.
422 -1, payloadType,
423 /*force_sender_report=*/false)) {
424 return -1;
425 }
426
427 // RTCPSender has it's own copy of the timestamp offset, added in
428 // RTCPSender::BuildSR, hence we must not add the in the offset for the above
429 // call.
430 // TODO(nisse): Delete RTCPSender:timestamp_offset_, and see if we can confine
431 // knowledge of the offset to a single place.
432
433 // This call will trigger Transport::SendPacket() from the RTP/RTCP module.
434 if (!rtp_sender_audio_->SendAudio(
435 frameType, payloadType, rtp_timestamp + rtp_rtcp_->StartTimestamp(),
436 payload.data(), payload.size(), absolute_capture_timestamp_ms)) {
437 RTC_DLOG(LS_ERROR)
438 << "ChannelSend::SendData() failed to send data to RTP/RTCP module";
439 return -1;
440 }
441
442 return 0;
443 }
444
ChannelSend(Clock * clock,TaskQueueFactory * task_queue_factory,Transport * rtp_transport,RtcpRttStats * rtcp_rtt_stats,RtcEventLog * rtc_event_log,FrameEncryptorInterface * frame_encryptor,const webrtc::CryptoOptions & crypto_options,bool extmap_allow_mixed,int rtcp_report_interval_ms,uint32_t ssrc,rtc::scoped_refptr<FrameTransformerInterface> frame_transformer,TransportFeedbackObserver * feedback_observer,const FieldTrialsView & field_trials)445 ChannelSend::ChannelSend(
446 Clock* clock,
447 TaskQueueFactory* task_queue_factory,
448 Transport* rtp_transport,
449 RtcpRttStats* rtcp_rtt_stats,
450 RtcEventLog* rtc_event_log,
451 FrameEncryptorInterface* frame_encryptor,
452 const webrtc::CryptoOptions& crypto_options,
453 bool extmap_allow_mixed,
454 int rtcp_report_interval_ms,
455 uint32_t ssrc,
456 rtc::scoped_refptr<FrameTransformerInterface> frame_transformer,
457 TransportFeedbackObserver* feedback_observer,
458 const FieldTrialsView& field_trials)
459 : ssrc_(ssrc),
460 event_log_(rtc_event_log),
461 _timeStamp(0), // This is just an offset, RTP module will add it's own
462 // random offset
463 input_mute_(false),
464 previous_frame_muted_(false),
465 _includeAudioLevelIndication(false),
466 rtcp_observer_(new VoERtcpObserver(this)),
467 feedback_observer_(feedback_observer),
468 rtp_packet_pacer_proxy_(new RtpPacketSenderProxy()),
469 retransmission_rate_limiter_(
470 new RateLimiter(clock, kMaxRetransmissionWindowMs)),
471 frame_encryptor_(frame_encryptor),
472 crypto_options_(crypto_options),
473 fixing_timestamp_stall_(
474 field_trials.IsDisabled("WebRTC-Audio-FixTimestampStall")),
475 encoder_queue_(task_queue_factory->CreateTaskQueue(
476 "AudioEncoder",
477 TaskQueueFactory::Priority::NORMAL)) {
478 audio_coding_.reset(AudioCodingModule::Create(AudioCodingModule::Config()));
479
480 RtpRtcpInterface::Configuration configuration;
481 configuration.bandwidth_callback = rtcp_observer_.get();
482 configuration.transport_feedback_callback = feedback_observer_;
483 configuration.clock = (clock ? clock : Clock::GetRealTimeClock());
484 configuration.audio = true;
485 configuration.outgoing_transport = rtp_transport;
486
487 configuration.paced_sender = rtp_packet_pacer_proxy_.get();
488
489 configuration.event_log = event_log_;
490 configuration.rtt_stats = rtcp_rtt_stats;
491 configuration.retransmission_rate_limiter =
492 retransmission_rate_limiter_.get();
493 configuration.extmap_allow_mixed = extmap_allow_mixed;
494 configuration.rtcp_report_interval_ms = rtcp_report_interval_ms;
495 configuration.rtcp_packet_type_counter_observer = this;
496
497 configuration.local_media_ssrc = ssrc;
498
499 rtp_rtcp_ = ModuleRtpRtcpImpl2::Create(configuration);
500 rtp_rtcp_->SetSendingMediaStatus(false);
501
502 rtp_sender_audio_ = std::make_unique<RTPSenderAudio>(configuration.clock,
503 rtp_rtcp_->RtpSender());
504
505 // Ensure that RTCP is enabled by default for the created channel.
506 rtp_rtcp_->SetRTCPStatus(RtcpMode::kCompound);
507
508 int error = audio_coding_->RegisterTransportCallback(this);
509 RTC_DCHECK_EQ(0, error);
510 if (frame_transformer)
511 InitFrameTransformerDelegate(std::move(frame_transformer));
512 }
513
~ChannelSend()514 ChannelSend::~ChannelSend() {
515 RTC_DCHECK(construction_thread_.IsCurrent());
516
517 // Resets the delegate's callback to ChannelSend::SendRtpAudio.
518 if (frame_transformer_delegate_)
519 frame_transformer_delegate_->Reset();
520
521 StopSend();
522 int error = audio_coding_->RegisterTransportCallback(NULL);
523 RTC_DCHECK_EQ(0, error);
524 }
525
StartSend()526 void ChannelSend::StartSend() {
527 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
528 RTC_DCHECK(!sending_);
529 sending_ = true;
530
531 RTC_DCHECK(packet_router_);
532 packet_router_->AddSendRtpModule(rtp_rtcp_.get(), /*remb_candidate=*/false);
533 rtp_rtcp_->SetSendingMediaStatus(true);
534 int ret = rtp_rtcp_->SetSendingStatus(true);
535 RTC_DCHECK_EQ(0, ret);
536
537 // It is now OK to start processing on the encoder task queue.
538 encoder_queue_.PostTask([this] {
539 RTC_DCHECK_RUN_ON(&encoder_queue_);
540 encoder_queue_is_active_ = true;
541 });
542 }
543
StopSend()544 void ChannelSend::StopSend() {
545 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
546 if (!sending_) {
547 return;
548 }
549 sending_ = false;
550
551 rtc::Event flush;
552 encoder_queue_.PostTask([this, &flush]() {
553 RTC_DCHECK_RUN_ON(&encoder_queue_);
554 encoder_queue_is_active_ = false;
555 flush.Set();
556 });
557 flush.Wait(rtc::Event::kForever);
558
559 // Reset sending SSRC and sequence number and triggers direct transmission
560 // of RTCP BYE
561 if (rtp_rtcp_->SetSendingStatus(false) == -1) {
562 RTC_DLOG(LS_ERROR) << "StartSend() RTP/RTCP failed to stop sending";
563 }
564 rtp_rtcp_->SetSendingMediaStatus(false);
565
566 RTC_DCHECK(packet_router_);
567 packet_router_->RemoveSendRtpModule(rtp_rtcp_.get());
568 }
569
SetEncoder(int payload_type,std::unique_ptr<AudioEncoder> encoder)570 void ChannelSend::SetEncoder(int payload_type,
571 std::unique_ptr<AudioEncoder> encoder) {
572 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
573 RTC_DCHECK_GE(payload_type, 0);
574 RTC_DCHECK_LE(payload_type, 127);
575
576 // The RTP/RTCP module needs to know the RTP timestamp rate (i.e. clockrate)
577 // as well as some other things, so we collect this info and send it along.
578 rtp_rtcp_->RegisterSendPayloadFrequency(payload_type,
579 encoder->RtpTimestampRateHz());
580 rtp_sender_audio_->RegisterAudioPayload("audio", payload_type,
581 encoder->RtpTimestampRateHz(),
582 encoder->NumChannels(), 0);
583
584 audio_coding_->SetEncoder(std::move(encoder));
585 }
586
ModifyEncoder(rtc::FunctionView<void (std::unique_ptr<AudioEncoder> *)> modifier)587 void ChannelSend::ModifyEncoder(
588 rtc::FunctionView<void(std::unique_ptr<AudioEncoder>*)> modifier) {
589 // This method can be called on the worker thread, module process thread
590 // or network thread. Audio coding is thread safe, so we do not need to
591 // enforce the calling thread.
592 audio_coding_->ModifyEncoder(modifier);
593 }
594
CallEncoder(rtc::FunctionView<void (AudioEncoder *)> modifier)595 void ChannelSend::CallEncoder(rtc::FunctionView<void(AudioEncoder*)> modifier) {
596 ModifyEncoder([modifier](std::unique_ptr<AudioEncoder>* encoder_ptr) {
597 if (*encoder_ptr) {
598 modifier(encoder_ptr->get());
599 } else {
600 RTC_DLOG(LS_WARNING) << "Trying to call unset encoder.";
601 }
602 });
603 }
604
OnBitrateAllocation(BitrateAllocationUpdate update)605 void ChannelSend::OnBitrateAllocation(BitrateAllocationUpdate update) {
606 // This method can be called on the worker thread, module process thread
607 // or on a TaskQueue via VideoSendStreamImpl::OnEncoderConfigurationChanged.
608 // TODO(solenberg): Figure out a good way to check this or enforce calling
609 // rules.
610 // RTC_DCHECK(worker_thread_checker_.IsCurrent() ||
611 // module_process_thread_checker_.IsCurrent());
612 CallEncoder([&](AudioEncoder* encoder) {
613 encoder->OnReceivedUplinkAllocation(update);
614 });
615 retransmission_rate_limiter_->SetMaxRate(update.target_bitrate.bps());
616 }
617
GetTargetBitrate() const618 int ChannelSend::GetTargetBitrate() const {
619 return audio_coding_->GetTargetBitrate();
620 }
621
OnUplinkPacketLossRate(float packet_loss_rate)622 void ChannelSend::OnUplinkPacketLossRate(float packet_loss_rate) {
623 CallEncoder([&](AudioEncoder* encoder) {
624 encoder->OnReceivedUplinkPacketLossFraction(packet_loss_rate);
625 });
626 }
627
ReceivedRTCPPacket(const uint8_t * data,size_t length)628 void ChannelSend::ReceivedRTCPPacket(const uint8_t* data, size_t length) {
629 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
630
631 // Deliver RTCP packet to RTP/RTCP module for parsing
632 rtp_rtcp_->IncomingRtcpPacket(data, length);
633
634 int64_t rtt = GetRTT();
635 if (rtt == 0) {
636 // Waiting for valid RTT.
637 return;
638 }
639
640 int64_t nack_window_ms = rtt;
641 if (nack_window_ms < kMinRetransmissionWindowMs) {
642 nack_window_ms = kMinRetransmissionWindowMs;
643 } else if (nack_window_ms > kMaxRetransmissionWindowMs) {
644 nack_window_ms = kMaxRetransmissionWindowMs;
645 }
646 retransmission_rate_limiter_->SetWindowSize(nack_window_ms);
647
648 OnReceivedRtt(rtt);
649 }
650
SetInputMute(bool enable)651 void ChannelSend::SetInputMute(bool enable) {
652 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
653 MutexLock lock(&volume_settings_mutex_);
654 input_mute_ = enable;
655 }
656
InputMute() const657 bool ChannelSend::InputMute() const {
658 MutexLock lock(&volume_settings_mutex_);
659 return input_mute_;
660 }
661
SendTelephoneEventOutband(int event,int duration_ms)662 bool ChannelSend::SendTelephoneEventOutband(int event, int duration_ms) {
663 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
664 RTC_DCHECK_LE(0, event);
665 RTC_DCHECK_GE(255, event);
666 RTC_DCHECK_LE(0, duration_ms);
667 RTC_DCHECK_GE(65535, duration_ms);
668 if (!sending_) {
669 return false;
670 }
671 if (rtp_sender_audio_->SendTelephoneEvent(
672 event, duration_ms, kTelephoneEventAttenuationdB) != 0) {
673 RTC_DLOG(LS_ERROR) << "SendTelephoneEvent() failed to send event";
674 return false;
675 }
676 return true;
677 }
678
RegisterCngPayloadType(int payload_type,int payload_frequency)679 void ChannelSend::RegisterCngPayloadType(int payload_type,
680 int payload_frequency) {
681 rtp_rtcp_->RegisterSendPayloadFrequency(payload_type, payload_frequency);
682 rtp_sender_audio_->RegisterAudioPayload("CN", payload_type, payload_frequency,
683 1, 0);
684 }
685
SetSendTelephoneEventPayloadType(int payload_type,int payload_frequency)686 void ChannelSend::SetSendTelephoneEventPayloadType(int payload_type,
687 int payload_frequency) {
688 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
689 RTC_DCHECK_LE(0, payload_type);
690 RTC_DCHECK_GE(127, payload_type);
691 rtp_rtcp_->RegisterSendPayloadFrequency(payload_type, payload_frequency);
692 rtp_sender_audio_->RegisterAudioPayload("telephone-event", payload_type,
693 payload_frequency, 0, 0);
694 }
695
SetSendAudioLevelIndicationStatus(bool enable,int id)696 void ChannelSend::SetSendAudioLevelIndicationStatus(bool enable, int id) {
697 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
698 _includeAudioLevelIndication = enable;
699 if (enable) {
700 rtp_rtcp_->RegisterRtpHeaderExtension(AudioLevel::Uri(), id);
701 } else {
702 rtp_rtcp_->DeregisterSendRtpHeaderExtension(AudioLevel::Uri());
703 }
704 }
705
RegisterSenderCongestionControlObjects(RtpTransportControllerSendInterface * transport,RtcpBandwidthObserver * bandwidth_observer)706 void ChannelSend::RegisterSenderCongestionControlObjects(
707 RtpTransportControllerSendInterface* transport,
708 RtcpBandwidthObserver* bandwidth_observer) {
709 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
710 RtpPacketSender* rtp_packet_pacer = transport->packet_sender();
711 PacketRouter* packet_router = transport->packet_router();
712
713 RTC_DCHECK(rtp_packet_pacer);
714 RTC_DCHECK(packet_router);
715 RTC_DCHECK(!packet_router_);
716 rtcp_observer_->SetBandwidthObserver(bandwidth_observer);
717 rtp_packet_pacer_proxy_->SetPacketPacer(rtp_packet_pacer);
718 rtp_rtcp_->SetStorePacketsStatus(true, 600);
719 packet_router_ = packet_router;
720 }
721
ResetSenderCongestionControlObjects()722 void ChannelSend::ResetSenderCongestionControlObjects() {
723 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
724 RTC_DCHECK(packet_router_);
725 rtp_rtcp_->SetStorePacketsStatus(false, 600);
726 rtcp_observer_->SetBandwidthObserver(nullptr);
727 packet_router_ = nullptr;
728 rtp_packet_pacer_proxy_->SetPacketPacer(nullptr);
729 }
730
SetRTCP_CNAME(absl::string_view c_name)731 void ChannelSend::SetRTCP_CNAME(absl::string_view c_name) {
732 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
733 // Note: SetCNAME() accepts a c string of length at most 255.
734 const std::string c_name_limited(c_name.substr(0, 255));
735 int ret = rtp_rtcp_->SetCNAME(c_name_limited.c_str()) != 0;
736 RTC_DCHECK_EQ(0, ret) << "SetRTCP_CNAME() failed to set RTCP CNAME";
737 }
738
GetRemoteRTCPReportBlocks() const739 std::vector<ReportBlock> ChannelSend::GetRemoteRTCPReportBlocks() const {
740 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
741 // Get the report blocks from the latest received RTCP Sender or Receiver
742 // Report. Each element in the vector contains the sender's SSRC and a
743 // report block according to RFC 3550.
744 std::vector<ReportBlock> report_blocks;
745 for (const ReportBlockData& data : rtp_rtcp_->GetLatestReportBlockData()) {
746 ReportBlock report_block;
747 report_block.sender_SSRC = data.report_block().sender_ssrc;
748 report_block.source_SSRC = data.report_block().source_ssrc;
749 report_block.fraction_lost = data.report_block().fraction_lost;
750 report_block.cumulative_num_packets_lost = data.report_block().packets_lost;
751 report_block.extended_highest_sequence_number =
752 data.report_block().extended_highest_sequence_number;
753 report_block.interarrival_jitter = data.report_block().jitter;
754 report_block.last_SR_timestamp =
755 data.report_block().last_sender_report_timestamp;
756 report_block.delay_since_last_SR =
757 data.report_block().delay_since_last_sender_report;
758 report_blocks.push_back(report_block);
759 }
760 return report_blocks;
761 }
762
GetRTCPStatistics() const763 CallSendStatistics ChannelSend::GetRTCPStatistics() const {
764 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
765 CallSendStatistics stats = {0};
766 stats.rttMs = GetRTT();
767
768 StreamDataCounters rtp_stats;
769 StreamDataCounters rtx_stats;
770 rtp_rtcp_->GetSendStreamDataCounters(&rtp_stats, &rtx_stats);
771 stats.payload_bytes_sent =
772 rtp_stats.transmitted.payload_bytes + rtx_stats.transmitted.payload_bytes;
773 stats.header_and_padding_bytes_sent =
774 rtp_stats.transmitted.padding_bytes + rtp_stats.transmitted.header_bytes +
775 rtx_stats.transmitted.padding_bytes + rtx_stats.transmitted.header_bytes;
776
777 // TODO(https://crbug.com/webrtc/10555): RTX retransmissions should show up in
778 // separate outbound-rtp stream objects.
779 stats.retransmitted_bytes_sent = rtp_stats.retransmitted.payload_bytes;
780 stats.packetsSent =
781 rtp_stats.transmitted.packets + rtx_stats.transmitted.packets;
782 stats.total_packet_send_delay = rtp_stats.transmitted.total_packet_delay;
783 stats.retransmitted_packets_sent = rtp_stats.retransmitted.packets;
784 stats.report_block_datas = rtp_rtcp_->GetLatestReportBlockData();
785
786 {
787 MutexLock lock(&rtcp_counter_mutex_);
788 stats.nacks_rcvd = rtcp_packet_type_counter_.nack_packets;
789 }
790
791 return stats;
792 }
793
RtcpPacketTypesCounterUpdated(uint32_t ssrc,const RtcpPacketTypeCounter & packet_counter)794 void ChannelSend::RtcpPacketTypesCounterUpdated(
795 uint32_t ssrc,
796 const RtcpPacketTypeCounter& packet_counter) {
797 if (ssrc != ssrc_) {
798 return;
799 }
800 MutexLock lock(&rtcp_counter_mutex_);
801 rtcp_packet_type_counter_ = packet_counter;
802 }
803
ProcessAndEncodeAudio(std::unique_ptr<AudioFrame> audio_frame)804 void ChannelSend::ProcessAndEncodeAudio(
805 std::unique_ptr<AudioFrame> audio_frame) {
806 TRACE_EVENT0("webrtc", "ChannelSend::ProcessAndEncodeAudio");
807
808 RTC_DCHECK_RUNS_SERIALIZED(&audio_thread_race_checker_);
809 RTC_DCHECK_GT(audio_frame->samples_per_channel_, 0);
810 RTC_DCHECK_LE(audio_frame->num_channels_, 8);
811
812 // Profile time between when the audio frame is added to the task queue and
813 // when the task is actually executed.
814 audio_frame->UpdateProfileTimeStamp();
815 encoder_queue_.PostTask(
816 [this, audio_frame = std::move(audio_frame)]() mutable {
817 RTC_DCHECK_RUN_ON(&encoder_queue_);
818 if (!encoder_queue_is_active_) {
819 if (fixing_timestamp_stall_) {
820 _timeStamp +=
821 static_cast<uint32_t>(audio_frame->samples_per_channel_);
822 }
823 return;
824 }
825 // Measure time between when the audio frame is added to the task queue
826 // and when the task is actually executed. Goal is to keep track of
827 // unwanted extra latency added by the task queue.
828 RTC_HISTOGRAM_COUNTS_10000("WebRTC.Audio.EncodingTaskQueueLatencyMs",
829 audio_frame->ElapsedProfileTimeMs());
830
831 bool is_muted = InputMute();
832 AudioFrameOperations::Mute(audio_frame.get(), previous_frame_muted_,
833 is_muted);
834
835 if (_includeAudioLevelIndication) {
836 size_t length =
837 audio_frame->samples_per_channel_ * audio_frame->num_channels_;
838 RTC_CHECK_LE(length, AudioFrame::kMaxDataSizeBytes);
839 if (is_muted && previous_frame_muted_) {
840 rms_level_.AnalyzeMuted(length);
841 } else {
842 rms_level_.Analyze(
843 rtc::ArrayView<const int16_t>(audio_frame->data(), length));
844 }
845 }
846 previous_frame_muted_ = is_muted;
847
848 // Add 10ms of raw (PCM) audio data to the encoder @ 32kHz.
849
850 // The ACM resamples internally.
851 audio_frame->timestamp_ = _timeStamp;
852 // This call will trigger AudioPacketizationCallback::SendData if
853 // encoding is done and payload is ready for packetization and
854 // transmission. Otherwise, it will return without invoking the
855 // callback.
856 if (audio_coding_->Add10MsData(*audio_frame) < 0) {
857 RTC_DLOG(LS_ERROR) << "ACM::Add10MsData() failed.";
858 return;
859 }
860
861 _timeStamp += static_cast<uint32_t>(audio_frame->samples_per_channel_);
862 });
863 }
864
GetANAStatistics() const865 ANAStats ChannelSend::GetANAStatistics() const {
866 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
867 return audio_coding_->GetANAStats();
868 }
869
GetRtpRtcp() const870 RtpRtcpInterface* ChannelSend::GetRtpRtcp() const {
871 return rtp_rtcp_.get();
872 }
873
GetRTT() const874 int64_t ChannelSend::GetRTT() const {
875 std::vector<ReportBlockData> report_blocks =
876 rtp_rtcp_->GetLatestReportBlockData();
877 if (report_blocks.empty()) {
878 return 0;
879 }
880
881 // We don't know in advance the remote ssrc used by the other end's receiver
882 // reports, so use the first report block for the RTT.
883 return report_blocks.front().last_rtt_ms();
884 }
885
SetFrameEncryptor(rtc::scoped_refptr<FrameEncryptorInterface> frame_encryptor)886 void ChannelSend::SetFrameEncryptor(
887 rtc::scoped_refptr<FrameEncryptorInterface> frame_encryptor) {
888 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
889 encoder_queue_.PostTask([this, frame_encryptor]() mutable {
890 RTC_DCHECK_RUN_ON(&encoder_queue_);
891 frame_encryptor_ = std::move(frame_encryptor);
892 });
893 }
894
SetEncoderToPacketizerFrameTransformer(rtc::scoped_refptr<webrtc::FrameTransformerInterface> frame_transformer)895 void ChannelSend::SetEncoderToPacketizerFrameTransformer(
896 rtc::scoped_refptr<webrtc::FrameTransformerInterface> frame_transformer) {
897 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
898 if (!frame_transformer)
899 return;
900
901 encoder_queue_.PostTask(
902 [this, frame_transformer = std::move(frame_transformer)]() mutable {
903 RTC_DCHECK_RUN_ON(&encoder_queue_);
904 InitFrameTransformerDelegate(std::move(frame_transformer));
905 });
906 }
907
OnReceivedRtt(int64_t rtt_ms)908 void ChannelSend::OnReceivedRtt(int64_t rtt_ms) {
909 // Invoke audio encoders OnReceivedRtt().
910 CallEncoder(
911 [rtt_ms](AudioEncoder* encoder) { encoder->OnReceivedRtt(rtt_ms); });
912 }
913
InitFrameTransformerDelegate(rtc::scoped_refptr<webrtc::FrameTransformerInterface> frame_transformer)914 void ChannelSend::InitFrameTransformerDelegate(
915 rtc::scoped_refptr<webrtc::FrameTransformerInterface> frame_transformer) {
916 RTC_DCHECK_RUN_ON(&encoder_queue_);
917 RTC_DCHECK(frame_transformer);
918 RTC_DCHECK(!frame_transformer_delegate_);
919
920 // Pass a callback to ChannelSend::SendRtpAudio, to be called by the delegate
921 // to send the transformed audio.
922 ChannelSendFrameTransformerDelegate::SendFrameCallback send_audio_callback =
923 [this](AudioFrameType frameType, uint8_t payloadType,
924 uint32_t rtp_timestamp, rtc::ArrayView<const uint8_t> payload,
925 int64_t absolute_capture_timestamp_ms) {
926 RTC_DCHECK_RUN_ON(&encoder_queue_);
927 return SendRtpAudio(frameType, payloadType, rtp_timestamp, payload,
928 absolute_capture_timestamp_ms);
929 };
930 frame_transformer_delegate_ =
931 rtc::make_ref_counted<ChannelSendFrameTransformerDelegate>(
932 std::move(send_audio_callback), std::move(frame_transformer),
933 &encoder_queue_);
934 frame_transformer_delegate_->Init();
935 }
936
937 } // namespace
938
CreateChannelSend(Clock * clock,TaskQueueFactory * task_queue_factory,Transport * rtp_transport,RtcpRttStats * rtcp_rtt_stats,RtcEventLog * rtc_event_log,FrameEncryptorInterface * frame_encryptor,const webrtc::CryptoOptions & crypto_options,bool extmap_allow_mixed,int rtcp_report_interval_ms,uint32_t ssrc,rtc::scoped_refptr<FrameTransformerInterface> frame_transformer,TransportFeedbackObserver * feedback_observer,const FieldTrialsView & field_trials)939 std::unique_ptr<ChannelSendInterface> CreateChannelSend(
940 Clock* clock,
941 TaskQueueFactory* task_queue_factory,
942 Transport* rtp_transport,
943 RtcpRttStats* rtcp_rtt_stats,
944 RtcEventLog* rtc_event_log,
945 FrameEncryptorInterface* frame_encryptor,
946 const webrtc::CryptoOptions& crypto_options,
947 bool extmap_allow_mixed,
948 int rtcp_report_interval_ms,
949 uint32_t ssrc,
950 rtc::scoped_refptr<FrameTransformerInterface> frame_transformer,
951 TransportFeedbackObserver* feedback_observer,
952 const FieldTrialsView& field_trials) {
953 return std::make_unique<ChannelSend>(
954 clock, task_queue_factory, rtp_transport, rtcp_rtt_stats, rtc_event_log,
955 frame_encryptor, crypto_options, extmap_allow_mixed,
956 rtcp_report_interval_ms, ssrc, std::move(frame_transformer),
957 feedback_observer, field_trials);
958 }
959
960 } // namespace voe
961 } // namespace webrtc
962