blob: cefd2c32daa73854a09ac6265f6710847d2ecc5f [file] [log] [blame]
Niels Möller530ead42018-10-04 14:28:39 +02001/*
2 * Copyright (c) 2012 The WebRTC project authors. All Rights Reserved.
3 *
4 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
9 */
10
11#include "audio/channel_send.h"
12
13#include <algorithm>
14#include <map>
15#include <memory>
16#include <string>
17#include <utility>
18#include <vector>
19
20#include "absl/memory/memory.h"
21#include "api/array_view.h"
Niels Möllerdced9f62018-11-19 10:27:07 +010022#include "api/call/transport.h"
Steve Anton10542f22019-01-11 09:11:00 -080023#include "api/crypto/frame_encryptor_interface.h"
Niels Möller530ead42018-10-04 14:28:39 +020024#include "audio/utility/audio_frame_operations.h"
25#include "call/rtp_transport_controller_send_interface.h"
26#include "logging/rtc_event_log/events/rtc_event_audio_playout.h"
27#include "logging/rtc_event_log/rtc_event_log.h"
28#include "modules/audio_coding/audio_network_adaptor/include/audio_network_adaptor_config.h"
Niels Möllerdced9f62018-11-19 10:27:07 +010029#include "modules/audio_coding/include/audio_coding_module.h"
30#include "modules/audio_processing/rms_level.h"
Niels Möller530ead42018-10-04 14:28:39 +020031#include "modules/pacing/packet_router.h"
32#include "modules/utility/include/process_thread.h"
33#include "rtc_base/checks.h"
Steve Anton10542f22019-01-11 09:11:00 -080034#include "rtc_base/critical_section.h"
Yves Gerey2e00abc2018-10-05 15:39:24 +020035#include "rtc_base/event.h"
Niels Möller530ead42018-10-04 14:28:39 +020036#include "rtc_base/format_macros.h"
37#include "rtc_base/location.h"
38#include "rtc_base/logging.h"
Niels Möller26815232018-11-16 09:32:40 +010039#include "rtc_base/numerics/safe_conversions.h"
Niels Möllerdced9f62018-11-19 10:27:07 +010040#include "rtc_base/race_checker.h"
Niels Möller530ead42018-10-04 14:28:39 +020041#include "rtc_base/rate_limiter.h"
42#include "rtc_base/task_queue.h"
43#include "rtc_base/thread_checker.h"
Steve Anton10542f22019-01-11 09:11:00 -080044#include "rtc_base/time_utils.h"
Niels Möller530ead42018-10-04 14:28:39 +020045#include "system_wrappers/include/field_trial.h"
46#include "system_wrappers/include/metrics.h"
47
48namespace webrtc {
49namespace voe {
50
51namespace {
52
53constexpr int64_t kMaxRetransmissionWindowMs = 1000;
54constexpr int64_t kMinRetransmissionWindowMs = 30;
55
Niels Möller7d76a312018-10-26 12:57:07 +020056MediaTransportEncodedAudioFrame::FrameType
57MediaTransportFrameTypeForWebrtcFrameType(webrtc::FrameType frame_type) {
58 switch (frame_type) {
59 case kAudioFrameSpeech:
60 return MediaTransportEncodedAudioFrame::FrameType::kSpeech;
61 break;
62
63 case kAudioFrameCN:
64 return MediaTransportEncodedAudioFrame::FrameType::
65 kDiscontinuousTransmission;
66 break;
67
68 default:
69 RTC_CHECK(false) << "Unexpected frame type=" << frame_type;
70 break;
71 }
72}
73
Niels Möllerdced9f62018-11-19 10:27:07 +010074class RtpPacketSenderProxy;
75class TransportFeedbackProxy;
76class TransportSequenceNumberProxy;
77class VoERtcpObserver;
78
Niels Möllerdced9f62018-11-19 10:27:07 +010079class ChannelSend
80 : public ChannelSendInterface,
Niels Möllerdced9f62018-11-19 10:27:07 +010081 public AudioPacketizationCallback, // receive encoded packets from the
82 // ACM
83 public TargetTransferRateObserver {
84 public:
85 // TODO(nisse): Make OnUplinkPacketLossRate public, and delete friend
86 // declaration.
87 friend class VoERtcpObserver;
88
89 ChannelSend(rtc::TaskQueue* encoder_queue,
90 ProcessThread* module_process_thread,
91 MediaTransportInterface* media_transport,
Anton Sukhanov626015d2019-02-04 15:16:06 -080092 OverheadObserver* overhead_observer,
Niels Möllere9771992018-11-26 10:55:07 +010093 Transport* rtp_transport,
Niels Möllerdced9f62018-11-19 10:27:07 +010094 RtcpRttStats* rtcp_rtt_stats,
95 RtcEventLog* rtc_event_log,
96 FrameEncryptorInterface* frame_encryptor,
97 const webrtc::CryptoOptions& crypto_options,
98 bool extmap_allow_mixed,
99 int rtcp_report_interval_ms);
100
101 ~ChannelSend() override;
102
103 // Send using this encoder, with this payload type.
104 bool SetEncoder(int payload_type,
105 std::unique_ptr<AudioEncoder> encoder) override;
106 void ModifyEncoder(rtc::FunctionView<void(std::unique_ptr<AudioEncoder>*)>
107 modifier) override;
Sebastian Jansson14a7cf92019-02-13 15:11:42 +0100108 void CallEncoder(rtc::FunctionView<void(AudioEncoder*)> modifier) override;
Niels Möllerdced9f62018-11-19 10:27:07 +0100109
110 // API methods
Niels Möllerdced9f62018-11-19 10:27:07 +0100111 void StartSend() override;
112 void StopSend() override;
113
114 // Codecs
Sebastian Jansson254d8692018-11-21 19:19:00 +0100115 void OnBitrateAllocation(BitrateAllocationUpdate update) override;
Niels Möllerdced9f62018-11-19 10:27:07 +0100116 int GetBitrate() const override;
117
118 // Network
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;
Amit Hilbuch77938e62018-12-21 09:23:38 -0800137 void SetRid(const std::string& rid,
138 int extension_id,
139 int repaired_extension_id) override;
Niels Möllerdced9f62018-11-19 10:27:07 +0100140 void SetMid(const std::string& mid, int extension_id) override;
141 void SetExtmapAllowMixed(bool extmap_allow_mixed) override;
142 void SetSendAudioLevelIndicationStatus(bool enable, int id) override;
143 void EnableSendTransportSequenceNumber(int id) override;
144
145 void RegisterSenderCongestionControlObjects(
146 RtpTransportControllerSendInterface* transport,
147 RtcpBandwidthObserver* bandwidth_observer) override;
148 void ResetSenderCongestionControlObjects() override;
149 void SetRTCP_CNAME(absl::string_view c_name) override;
150 std::vector<ReportBlock> GetRemoteRTCPReportBlocks() const override;
151 CallSendStatistics GetRTCPStatistics() const override;
Niels Möllerdced9f62018-11-19 10:27:07 +0100152
153 // ProcessAndEncodeAudio() posts a task on the shared encoder task queue,
154 // which in turn calls (on the queue) ProcessAndEncodeAudioOnTaskQueue() where
155 // the actual processing of the audio takes place. The processing mainly
156 // consists of encoding and preparing the result for sending by adding it to a
157 // send queue.
158 // The main reason for using a task queue here is to release the native,
159 // OS-specific, audio capture thread as soon as possible to ensure that it
160 // can go back to sleep and be prepared to deliver an new captured audio
161 // packet.
162 void ProcessAndEncodeAudio(std::unique_ptr<AudioFrame> audio_frame) override;
163
Niels Möllerdced9f62018-11-19 10:27:07 +0100164 // The existence of this function alongside OnUplinkPacketLossRate is
165 // a compromise. We want the encoder to be agnostic of the PLR source, but
166 // we also don't want it to receive conflicting information from TWCC and
167 // from RTCP-XR.
168 void OnTwccBasedUplinkPacketLossRate(float packet_loss_rate) override;
169
170 void OnRecoverableUplinkPacketLossRate(
171 float recoverable_packet_loss_rate) override;
172
173 int64_t GetRTT() const override;
174
175 // E2EE Custom Audio Frame Encryption
176 void SetFrameEncryptor(
177 rtc::scoped_refptr<FrameEncryptorInterface> frame_encryptor) override;
178
179 private:
180 class ProcessAndEncodeAudioTask;
181
182 // From AudioPacketizationCallback in the ACM
183 int32_t SendData(FrameType frameType,
184 uint8_t payloadType,
185 uint32_t timeStamp,
186 const uint8_t* payloadData,
187 size_t payloadSize,
188 const RTPFragmentationHeader* fragmentation) override;
189
Niels Möllerdced9f62018-11-19 10:27:07 +0100190 void OnUplinkPacketLossRate(float packet_loss_rate);
191 bool InputMute() const;
192
Niels Möllerdced9f62018-11-19 10:27:07 +0100193 int SetSendRtpHeaderExtension(bool enable, RTPExtensionType type, int id);
194
Niels Möllerdced9f62018-11-19 10:27:07 +0100195 int32_t SendRtpAudio(FrameType frameType,
196 uint8_t payloadType,
197 uint32_t timeStamp,
198 rtc::ArrayView<const uint8_t> payload,
199 const RTPFragmentationHeader* fragmentation);
200
201 int32_t SendMediaTransportAudio(FrameType frameType,
202 uint8_t payloadType,
203 uint32_t timeStamp,
204 rtc::ArrayView<const uint8_t> payload,
205 const RTPFragmentationHeader* fragmentation);
206
207 // Return media transport or nullptr if using RTP.
208 MediaTransportInterface* media_transport() { return media_transport_; }
209
210 // Called on the encoder task queue when a new input audio frame is ready
211 // for encoding.
212 void ProcessAndEncodeAudioOnTaskQueue(AudioFrame* audio_input);
213
214 void OnReceivedRtt(int64_t rtt_ms);
215
216 void OnTargetTransferRate(TargetTransferRate) override;
217
218 // Thread checkers document and lock usage of some methods on voe::Channel to
219 // specific threads we know about. The goal is to eventually split up
220 // voe::Channel into parts with single-threaded semantics, and thereby reduce
221 // the need for locks.
222 rtc::ThreadChecker worker_thread_checker_;
223 rtc::ThreadChecker module_process_thread_checker_;
224 // Methods accessed from audio and video threads are checked for sequential-
225 // only access. We don't necessarily own and control these threads, so thread
226 // checkers cannot be used. E.g. Chromium may transfer "ownership" from one
227 // audio thread to another, but access is still sequential.
228 rtc::RaceChecker audio_thread_race_checker_;
229
Niels Möllerdced9f62018-11-19 10:27:07 +0100230 rtc::CriticalSection volume_settings_critsect_;
231
Niels Möller26e88b02018-11-19 15:08:13 +0100232 bool sending_ RTC_GUARDED_BY(&worker_thread_checker_) = false;
Niels Möllerdced9f62018-11-19 10:27:07 +0100233
234 RtcEventLog* const event_log_;
235
236 std::unique_ptr<RtpRtcp> _rtpRtcpModule;
237
238 std::unique_ptr<AudioCodingModule> audio_coding_;
239 uint32_t _timeStamp RTC_GUARDED_BY(encoder_queue_);
240
Niels Möllerdced9f62018-11-19 10:27:07 +0100241 // uses
Niels Möller985a1f32018-11-19 16:08:42 +0100242 ProcessThread* const _moduleProcessThreadPtr;
Niels Möllerdced9f62018-11-19 10:27:07 +0100243 RmsLevel rms_level_ RTC_GUARDED_BY(encoder_queue_);
244 bool input_mute_ RTC_GUARDED_BY(volume_settings_critsect_);
245 bool previous_frame_muted_ RTC_GUARDED_BY(encoder_queue_);
246 // VoeRTP_RTCP
247 // TODO(henrika): can today be accessed on the main thread and on the
248 // task queue; hence potential race.
249 bool _includeAudioLevelIndication;
Anton Sukhanov626015d2019-02-04 15:16:06 -0800250
Niels Möllerdced9f62018-11-19 10:27:07 +0100251 // RtcpBandwidthObserver
Niels Möller985a1f32018-11-19 16:08:42 +0100252 const std::unique_ptr<VoERtcpObserver> rtcp_observer_;
Niels Möllerdced9f62018-11-19 10:27:07 +0100253
Niels Möller985a1f32018-11-19 16:08:42 +0100254 PacketRouter* packet_router_ RTC_GUARDED_BY(&worker_thread_checker_) =
255 nullptr;
256 const std::unique_ptr<TransportFeedbackProxy> feedback_observer_proxy_;
257 const std::unique_ptr<TransportSequenceNumberProxy> seq_num_allocator_proxy_;
258 const std::unique_ptr<RtpPacketSenderProxy> rtp_packet_sender_proxy_;
259 const std::unique_ptr<RateLimiter> retransmission_rate_limiter_;
Niels Möllerdced9f62018-11-19 10:27:07 +0100260
261 rtc::ThreadChecker construction_thread_;
262
263 const bool use_twcc_plr_for_ana_;
264
265 rtc::CriticalSection encoder_queue_lock_;
266 bool encoder_queue_is_active_ RTC_GUARDED_BY(encoder_queue_lock_) = false;
Niels Möller985a1f32018-11-19 16:08:42 +0100267 rtc::TaskQueue* const encoder_queue_ = nullptr;
Niels Möllerdced9f62018-11-19 10:27:07 +0100268
269 MediaTransportInterface* const media_transport_;
270 int media_transport_sequence_number_ RTC_GUARDED_BY(encoder_queue_) = 0;
271
272 rtc::CriticalSection media_transport_lock_;
273 // Currently set by SetLocalSSRC.
274 uint64_t media_transport_channel_id_ RTC_GUARDED_BY(&media_transport_lock_) =
275 0;
276 // Cache payload type and sampling frequency from most recent call to
277 // SetEncoder. Needed to set MediaTransportEncodedAudioFrame metadata, and
278 // invalidate on encoder change.
279 int media_transport_payload_type_ RTC_GUARDED_BY(&media_transport_lock_);
280 int media_transport_sampling_frequency_
281 RTC_GUARDED_BY(&media_transport_lock_);
282
283 // E2EE Audio Frame Encryption
284 rtc::scoped_refptr<FrameEncryptorInterface> frame_encryptor_;
285 // E2EE Frame Encryption Options
Niels Möller985a1f32018-11-19 16:08:42 +0100286 const webrtc::CryptoOptions crypto_options_;
Niels Möllerdced9f62018-11-19 10:27:07 +0100287
288 rtc::CriticalSection bitrate_crit_section_;
289 int configured_bitrate_bps_ RTC_GUARDED_BY(bitrate_crit_section_) = 0;
290};
Niels Möller530ead42018-10-04 14:28:39 +0200291
292const int kTelephoneEventAttenuationdB = 10;
293
294class TransportFeedbackProxy : public TransportFeedbackObserver {
295 public:
296 TransportFeedbackProxy() : feedback_observer_(nullptr) {
297 pacer_thread_.DetachFromThread();
298 network_thread_.DetachFromThread();
299 }
300
301 void SetTransportFeedbackObserver(
302 TransportFeedbackObserver* feedback_observer) {
303 RTC_DCHECK(thread_checker_.CalledOnValidThread());
304 rtc::CritScope lock(&crit_);
305 feedback_observer_ = feedback_observer;
306 }
307
308 // Implements TransportFeedbackObserver.
309 void AddPacket(uint32_t ssrc,
310 uint16_t sequence_number,
311 size_t length,
312 const PacedPacketInfo& pacing_info) override {
313 RTC_DCHECK(pacer_thread_.CalledOnValidThread());
314 rtc::CritScope lock(&crit_);
315 if (feedback_observer_)
316 feedback_observer_->AddPacket(ssrc, sequence_number, length, pacing_info);
317 }
318
319 void OnTransportFeedback(const rtcp::TransportFeedback& feedback) override {
320 RTC_DCHECK(network_thread_.CalledOnValidThread());
321 rtc::CritScope lock(&crit_);
322 if (feedback_observer_)
323 feedback_observer_->OnTransportFeedback(feedback);
324 }
325
326 private:
327 rtc::CriticalSection crit_;
328 rtc::ThreadChecker thread_checker_;
329 rtc::ThreadChecker pacer_thread_;
330 rtc::ThreadChecker network_thread_;
331 TransportFeedbackObserver* feedback_observer_ RTC_GUARDED_BY(&crit_);
332};
333
334class TransportSequenceNumberProxy : public TransportSequenceNumberAllocator {
335 public:
336 TransportSequenceNumberProxy() : seq_num_allocator_(nullptr) {
337 pacer_thread_.DetachFromThread();
338 }
339
340 void SetSequenceNumberAllocator(
341 TransportSequenceNumberAllocator* seq_num_allocator) {
342 RTC_DCHECK(thread_checker_.CalledOnValidThread());
343 rtc::CritScope lock(&crit_);
344 seq_num_allocator_ = seq_num_allocator;
345 }
346
347 // Implements TransportSequenceNumberAllocator.
348 uint16_t AllocateSequenceNumber() override {
349 RTC_DCHECK(pacer_thread_.CalledOnValidThread());
350 rtc::CritScope lock(&crit_);
351 if (!seq_num_allocator_)
352 return 0;
353 return seq_num_allocator_->AllocateSequenceNumber();
354 }
355
356 private:
357 rtc::CriticalSection crit_;
358 rtc::ThreadChecker thread_checker_;
359 rtc::ThreadChecker pacer_thread_;
360 TransportSequenceNumberAllocator* seq_num_allocator_ RTC_GUARDED_BY(&crit_);
361};
362
363class RtpPacketSenderProxy : public RtpPacketSender {
364 public:
365 RtpPacketSenderProxy() : rtp_packet_sender_(nullptr) {}
366
367 void SetPacketSender(RtpPacketSender* rtp_packet_sender) {
368 RTC_DCHECK(thread_checker_.CalledOnValidThread());
369 rtc::CritScope lock(&crit_);
370 rtp_packet_sender_ = rtp_packet_sender;
371 }
372
373 // Implements RtpPacketSender.
374 void InsertPacket(Priority priority,
375 uint32_t ssrc,
376 uint16_t sequence_number,
377 int64_t capture_time_ms,
378 size_t bytes,
379 bool retransmission) override {
380 rtc::CritScope lock(&crit_);
381 if (rtp_packet_sender_) {
382 rtp_packet_sender_->InsertPacket(priority, ssrc, sequence_number,
383 capture_time_ms, bytes, retransmission);
384 }
385 }
386
387 void SetAccountForAudioPackets(bool account_for_audio) override {
388 RTC_NOTREACHED();
389 }
390
391 private:
392 rtc::ThreadChecker thread_checker_;
393 rtc::CriticalSection crit_;
394 RtpPacketSender* rtp_packet_sender_ RTC_GUARDED_BY(&crit_);
395};
396
397class VoERtcpObserver : public RtcpBandwidthObserver {
398 public:
399 explicit VoERtcpObserver(ChannelSend* owner)
400 : owner_(owner), bandwidth_observer_(nullptr) {}
Mirko Bonadeife055c12019-01-29 22:53:28 +0100401 ~VoERtcpObserver() override {}
Niels Möller530ead42018-10-04 14:28:39 +0200402
403 void SetBandwidthObserver(RtcpBandwidthObserver* bandwidth_observer) {
404 rtc::CritScope lock(&crit_);
405 bandwidth_observer_ = bandwidth_observer;
406 }
407
408 void OnReceivedEstimatedBitrate(uint32_t bitrate) override {
409 rtc::CritScope lock(&crit_);
410 if (bandwidth_observer_) {
411 bandwidth_observer_->OnReceivedEstimatedBitrate(bitrate);
412 }
413 }
414
415 void OnReceivedRtcpReceiverReport(const ReportBlockList& report_blocks,
416 int64_t rtt,
417 int64_t now_ms) override {
418 {
419 rtc::CritScope lock(&crit_);
420 if (bandwidth_observer_) {
421 bandwidth_observer_->OnReceivedRtcpReceiverReport(report_blocks, rtt,
422 now_ms);
423 }
424 }
425 // TODO(mflodman): Do we need to aggregate reports here or can we jut send
426 // what we get? I.e. do we ever get multiple reports bundled into one RTCP
427 // report for VoiceEngine?
428 if (report_blocks.empty())
429 return;
430
431 int fraction_lost_aggregate = 0;
432 int total_number_of_packets = 0;
433
434 // If receiving multiple report blocks, calculate the weighted average based
435 // on the number of packets a report refers to.
436 for (ReportBlockList::const_iterator block_it = report_blocks.begin();
437 block_it != report_blocks.end(); ++block_it) {
438 // Find the previous extended high sequence number for this remote SSRC,
439 // to calculate the number of RTP packets this report refers to. Ignore if
440 // we haven't seen this SSRC before.
441 std::map<uint32_t, uint32_t>::iterator seq_num_it =
442 extended_max_sequence_number_.find(block_it->source_ssrc);
443 int number_of_packets = 0;
444 if (seq_num_it != extended_max_sequence_number_.end()) {
445 number_of_packets =
446 block_it->extended_highest_sequence_number - seq_num_it->second;
447 }
448 fraction_lost_aggregate += number_of_packets * block_it->fraction_lost;
449 total_number_of_packets += number_of_packets;
450
451 extended_max_sequence_number_[block_it->source_ssrc] =
452 block_it->extended_highest_sequence_number;
453 }
454 int weighted_fraction_lost = 0;
455 if (total_number_of_packets > 0) {
456 weighted_fraction_lost =
457 (fraction_lost_aggregate + total_number_of_packets / 2) /
458 total_number_of_packets;
459 }
460 owner_->OnUplinkPacketLossRate(weighted_fraction_lost / 255.0f);
461 }
462
463 private:
464 ChannelSend* owner_;
465 // Maps remote side ssrc to extended highest sequence number received.
466 std::map<uint32_t, uint32_t> extended_max_sequence_number_;
467 rtc::CriticalSection crit_;
468 RtcpBandwidthObserver* bandwidth_observer_ RTC_GUARDED_BY(crit_);
469};
470
471class ChannelSend::ProcessAndEncodeAudioTask : public rtc::QueuedTask {
472 public:
473 ProcessAndEncodeAudioTask(std::unique_ptr<AudioFrame> audio_frame,
474 ChannelSend* channel)
475 : audio_frame_(std::move(audio_frame)), channel_(channel) {
476 RTC_DCHECK(channel_);
477 }
478
479 private:
480 bool Run() override {
481 RTC_DCHECK_RUN_ON(channel_->encoder_queue_);
482 channel_->ProcessAndEncodeAudioOnTaskQueue(audio_frame_.get());
483 return true;
484 }
485
486 std::unique_ptr<AudioFrame> audio_frame_;
487 ChannelSend* const channel_;
488};
489
490int32_t ChannelSend::SendData(FrameType frameType,
491 uint8_t payloadType,
492 uint32_t timeStamp,
493 const uint8_t* payloadData,
494 size_t payloadSize,
495 const RTPFragmentationHeader* fragmentation) {
496 RTC_DCHECK_RUN_ON(encoder_queue_);
Niels Möller7d76a312018-10-26 12:57:07 +0200497 rtc::ArrayView<const uint8_t> payload(payloadData, payloadSize);
498
499 if (media_transport() != nullptr) {
500 return SendMediaTransportAudio(frameType, payloadType, timeStamp, payload,
501 fragmentation);
502 } else {
503 return SendRtpAudio(frameType, payloadType, timeStamp, payload,
504 fragmentation);
505 }
506}
507
508int32_t ChannelSend::SendRtpAudio(FrameType frameType,
509 uint8_t payloadType,
510 uint32_t timeStamp,
511 rtc::ArrayView<const uint8_t> payload,
512 const RTPFragmentationHeader* fragmentation) {
513 RTC_DCHECK_RUN_ON(encoder_queue_);
Niels Möller530ead42018-10-04 14:28:39 +0200514 if (_includeAudioLevelIndication) {
515 // Store current audio level in the RTP/RTCP module.
516 // The level will be used in combination with voice-activity state
517 // (frameType) to add an RTP header extension
518 _rtpRtcpModule->SetAudioLevel(rms_level_.Average());
519 }
520
Benjamin Wright84583f62018-10-04 14:22:34 -0700521 // E2EE Custom Audio Frame Encryption (This is optional).
522 // Keep this buffer around for the lifetime of the send call.
523 rtc::Buffer encrypted_audio_payload;
524 if (frame_encryptor_ != nullptr) {
525 // TODO(benwright@webrtc.org) - Allocate enough to always encrypt inline.
526 // Allocate a buffer to hold the maximum possible encrypted payload.
527 size_t max_ciphertext_size = frame_encryptor_->GetMaxCiphertextByteSize(
Niels Möller7d76a312018-10-26 12:57:07 +0200528 cricket::MEDIA_TYPE_AUDIO, payload.size());
Benjamin Wright84583f62018-10-04 14:22:34 -0700529 encrypted_audio_payload.SetSize(max_ciphertext_size);
530
531 // Encrypt the audio payload into the buffer.
532 size_t bytes_written = 0;
533 int encrypt_status = frame_encryptor_->Encrypt(
534 cricket::MEDIA_TYPE_AUDIO, _rtpRtcpModule->SSRC(),
Niels Möller7d76a312018-10-26 12:57:07 +0200535 /*additional_data=*/nullptr, payload, encrypted_audio_payload,
536 &bytes_written);
Benjamin Wright84583f62018-10-04 14:22:34 -0700537 if (encrypt_status != 0) {
538 RTC_DLOG(LS_ERROR) << "Channel::SendData() failed encrypt audio payload: "
539 << encrypt_status;
540 return -1;
541 }
542 // Resize the buffer to the exact number of bytes actually used.
543 encrypted_audio_payload.SetSize(bytes_written);
544 // Rewrite the payloadData and size to the new encrypted payload.
Niels Möller7d76a312018-10-26 12:57:07 +0200545 payload = encrypted_audio_payload;
Benjamin Wrightbfb444c2018-10-15 10:20:24 -0700546 } else if (crypto_options_.sframe.require_frame_encryption) {
547 RTC_DLOG(LS_ERROR) << "Channel::SendData() failed sending audio payload: "
548 << "A frame encryptor is required but one is not set.";
549 return -1;
Benjamin Wright84583f62018-10-04 14:22:34 -0700550 }
551
Niels Möller530ead42018-10-04 14:28:39 +0200552 // Push data from ACM to RTP/RTCP-module to deliver audio frame for
553 // packetization.
554 // This call will trigger Transport::SendPacket() from the RTP/RTCP module.
Niels Möller7d76a312018-10-26 12:57:07 +0200555 if (!_rtpRtcpModule->SendOutgoingData((FrameType&)frameType, payloadType,
556 timeStamp,
557 // Leaving the time when this frame was
558 // received from the capture device as
559 // undefined for voice for now.
560 -1, payload.data(), payload.size(),
561 fragmentation, nullptr, nullptr)) {
Niels Möller530ead42018-10-04 14:28:39 +0200562 RTC_DLOG(LS_ERROR)
563 << "ChannelSend::SendData() failed to send data to RTP/RTCP module";
564 return -1;
565 }
566
567 return 0;
568}
569
Niels Möller7d76a312018-10-26 12:57:07 +0200570int32_t ChannelSend::SendMediaTransportAudio(
571 FrameType frameType,
572 uint8_t payloadType,
573 uint32_t timeStamp,
574 rtc::ArrayView<const uint8_t> payload,
575 const RTPFragmentationHeader* fragmentation) {
576 RTC_DCHECK_RUN_ON(encoder_queue_);
577 // TODO(nisse): Use null _transportPtr for MediaTransport.
578 // RTC_DCHECK(_transportPtr == nullptr);
579 uint64_t channel_id;
580 int sampling_rate_hz;
581 {
582 rtc::CritScope cs(&media_transport_lock_);
583 if (media_transport_payload_type_ != payloadType) {
584 // Payload type is being changed, media_transport_sampling_frequency_,
585 // no longer current.
586 return -1;
587 }
588 sampling_rate_hz = media_transport_sampling_frequency_;
589 channel_id = media_transport_channel_id_;
590 }
Mirko Bonadei1c546052019-02-04 14:50:38 +0100591 MediaTransportEncodedAudioFrame frame(
Niels Möller7d76a312018-10-26 12:57:07 +0200592 /*sampling_rate_hz=*/sampling_rate_hz,
593
594 // TODO(nisse): Timestamp and sample index are the same for all supported
595 // audio codecs except G722. Refactor audio coding module to only use
596 // sample index, and leave translation to RTP time, when needed, for
597 // RTP-specific code.
598 /*starting_sample_index=*/timeStamp,
599
600 // Sample count isn't conveniently available from the AudioCodingModule,
601 // and needs some refactoring to wire up in a good way. For now, left as
602 // zero.
603 /*sample_count=*/0,
604
605 /*sequence_number=*/media_transport_sequence_number_,
606 MediaTransportFrameTypeForWebrtcFrameType(frameType), payloadType,
607 std::vector<uint8_t>(payload.begin(), payload.end()));
608
609 // TODO(nisse): Introduce a MediaTransportSender object bound to a specific
610 // channel id.
611 RTCError rtc_error =
612 media_transport()->SendAudioFrame(channel_id, std::move(frame));
613
614 if (!rtc_error.ok()) {
615 RTC_LOG(LS_ERROR) << "Failed to send frame, rtc_error="
616 << ToString(rtc_error.type()) << ", "
617 << rtc_error.message();
618 return -1;
619 }
620
621 ++media_transport_sequence_number_;
622
623 return 0;
624}
625
Niels Möller530ead42018-10-04 14:28:39 +0200626ChannelSend::ChannelSend(rtc::TaskQueue* encoder_queue,
627 ProcessThread* module_process_thread,
Niels Möller7d76a312018-10-26 12:57:07 +0200628 MediaTransportInterface* media_transport,
Anton Sukhanov626015d2019-02-04 15:16:06 -0800629 OverheadObserver* overhead_observer,
Niels Möllere9771992018-11-26 10:55:07 +0100630 Transport* rtp_transport,
Niels Möller530ead42018-10-04 14:28:39 +0200631 RtcpRttStats* rtcp_rtt_stats,
Benjamin Wright84583f62018-10-04 14:22:34 -0700632 RtcEventLog* rtc_event_log,
Benjamin Wrightbfb444c2018-10-15 10:20:24 -0700633 FrameEncryptorInterface* frame_encryptor,
Johannes Kron9190b822018-10-29 11:22:05 +0100634 const webrtc::CryptoOptions& crypto_options,
Jiawei Ou55718122018-11-09 13:17:39 -0800635 bool extmap_allow_mixed,
636 int rtcp_report_interval_ms)
Niels Möller530ead42018-10-04 14:28:39 +0200637 : event_log_(rtc_event_log),
638 _timeStamp(0), // This is just an offset, RTP module will add it's own
639 // random offset
Niels Möller530ead42018-10-04 14:28:39 +0200640 _moduleProcessThreadPtr(module_process_thread),
Niels Möller530ead42018-10-04 14:28:39 +0200641 input_mute_(false),
642 previous_frame_muted_(false),
643 _includeAudioLevelIndication(false),
Niels Möller530ead42018-10-04 14:28:39 +0200644 rtcp_observer_(new VoERtcpObserver(this)),
645 feedback_observer_proxy_(new TransportFeedbackProxy()),
646 seq_num_allocator_proxy_(new TransportSequenceNumberProxy()),
647 rtp_packet_sender_proxy_(new RtpPacketSenderProxy()),
648 retransmission_rate_limiter_(new RateLimiter(Clock::GetRealTimeClock(),
649 kMaxRetransmissionWindowMs)),
650 use_twcc_plr_for_ana_(
651 webrtc::field_trial::FindFullName("UseTwccPlrForAna") == "Enabled"),
Benjamin Wright84583f62018-10-04 14:22:34 -0700652 encoder_queue_(encoder_queue),
Niels Möller7d76a312018-10-26 12:57:07 +0200653 media_transport_(media_transport),
Benjamin Wrightbfb444c2018-10-15 10:20:24 -0700654 frame_encryptor_(frame_encryptor),
655 crypto_options_(crypto_options) {
Niels Möller530ead42018-10-04 14:28:39 +0200656 RTC_DCHECK(module_process_thread);
657 RTC_DCHECK(encoder_queue);
Niels Möllerdced9f62018-11-19 10:27:07 +0100658 module_process_thread_checker_.DetachFromThread();
659
Niels Möller530ead42018-10-04 14:28:39 +0200660 audio_coding_.reset(AudioCodingModule::Create(AudioCodingModule::Config()));
661
662 RtpRtcp::Configuration configuration;
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -0800663
664 // We gradually remove codepaths that depend on RTP when using media
665 // transport. All of this logic should be moved to the future
666 // RTPMediaTransport. In this case it means that overhead and bandwidth
667 // observers should not be called when using media transport.
668 if (!media_transport_) {
Anton Sukhanov626015d2019-02-04 15:16:06 -0800669 // TODO(sukhanov): Overhead observer is only needed for RTP path, because in
670 // media transport audio overhead is currently considered constant (see
671 // getter MediaTransportInterface::GetAudioPacketOverhead). In the future
672 // when we introduce RTP media transport we should make audio overhead
673 // interface consistent and work for both RTP and non-RTP implementations.
674 configuration.overhead_observer = overhead_observer;
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -0800675 configuration.bandwidth_callback = rtcp_observer_.get();
676 configuration.transport_feedback_callback = feedback_observer_proxy_.get();
677 }
678
Niels Möller530ead42018-10-04 14:28:39 +0200679 configuration.audio = true;
Fredrik Solenberg3d2ed192018-12-18 09:18:33 +0100680 configuration.outgoing_transport = rtp_transport;
Niels Möller530ead42018-10-04 14:28:39 +0200681
682 configuration.paced_sender = rtp_packet_sender_proxy_.get();
683 configuration.transport_sequence_number_allocator =
684 seq_num_allocator_proxy_.get();
Niels Möller530ead42018-10-04 14:28:39 +0200685
686 configuration.event_log = event_log_;
687 configuration.rtt_stats = rtcp_rtt_stats;
688 configuration.retransmission_rate_limiter =
689 retransmission_rate_limiter_.get();
Johannes Kron9190b822018-10-29 11:22:05 +0100690 configuration.extmap_allow_mixed = extmap_allow_mixed;
Jiawei Ou8b5d9d82018-11-15 16:44:37 -0800691 configuration.rtcp_report_interval_ms = rtcp_report_interval_ms;
Niels Möller530ead42018-10-04 14:28:39 +0200692
693 _rtpRtcpModule.reset(RtpRtcp::CreateRtpRtcp(configuration));
694 _rtpRtcpModule->SetSendingMediaStatus(false);
Niels Möller530ead42018-10-04 14:28:39 +0200695
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -0800696 // We want to invoke the 'TargetRateObserver' and |OnOverheadChanged|
697 // callbacks after the audio_coding_ is fully initialized.
698 if (media_transport_) {
699 RTC_DLOG(LS_INFO) << "Setting media_transport_ rate observers.";
700 media_transport_->AddTargetTransferRateObserver(this);
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -0800701 } else {
702 RTC_DLOG(LS_INFO) << "Not setting media_transport_ rate observers.";
703 }
704
Niels Möller530ead42018-10-04 14:28:39 +0200705 _moduleProcessThreadPtr->RegisterModule(_rtpRtcpModule.get(), RTC_FROM_HERE);
706
Niels Möller530ead42018-10-04 14:28:39 +0200707 // Ensure that RTCP is enabled by default for the created channel.
708 // Note that, the module will keep generating RTCP until it is explicitly
709 // disabled by the user.
710 // After StopListen (when no sockets exists), RTCP packets will no longer
711 // be transmitted since the Transport object will then be invalid.
712 // RTCP is enabled by default.
713 _rtpRtcpModule->SetRTCPStatus(RtcpMode::kCompound);
714
Fredrik Solenbergeb134842018-11-19 14:13:15 +0100715 int error = audio_coding_->RegisterTransportCallback(this);
Niels Möller530ead42018-10-04 14:28:39 +0200716 RTC_DCHECK_EQ(0, error);
717}
718
Fredrik Solenberg645a3af2018-11-16 12:51:15 +0100719ChannelSend::~ChannelSend() {
Niels Möller530ead42018-10-04 14:28:39 +0200720 RTC_DCHECK(construction_thread_.CalledOnValidThread());
Niels Möller530ead42018-10-04 14:28:39 +0200721
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -0800722 if (media_transport_) {
723 media_transport_->RemoveTargetTransferRateObserver(this);
724 }
725
Niels Möller530ead42018-10-04 14:28:39 +0200726 StopSend();
Niels Möller530ead42018-10-04 14:28:39 +0200727 int error = audio_coding_->RegisterTransportCallback(NULL);
728 RTC_DCHECK_EQ(0, error);
729
Niels Möller530ead42018-10-04 14:28:39 +0200730 if (_moduleProcessThreadPtr)
731 _moduleProcessThreadPtr->DeRegisterModule(_rtpRtcpModule.get());
Niels Möller530ead42018-10-04 14:28:39 +0200732}
733
Niels Möller26815232018-11-16 09:32:40 +0100734void ChannelSend::StartSend() {
Niels Möller26e88b02018-11-19 15:08:13 +0100735 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Fredrik Solenbergeb134842018-11-19 14:13:15 +0100736 RTC_DCHECK(!sending_);
737 sending_ = true;
Niels Möller530ead42018-10-04 14:28:39 +0200738
Niels Möller530ead42018-10-04 14:28:39 +0200739 _rtpRtcpModule->SetSendingMediaStatus(true);
Niels Möller26815232018-11-16 09:32:40 +0100740 int ret = _rtpRtcpModule->SetSendingStatus(true);
741 RTC_DCHECK_EQ(0, ret);
Niels Möller530ead42018-10-04 14:28:39 +0200742 {
743 // It is now OK to start posting tasks to the encoder task queue.
744 rtc::CritScope cs(&encoder_queue_lock_);
745 encoder_queue_is_active_ = true;
746 }
Niels Möller530ead42018-10-04 14:28:39 +0200747}
748
749void ChannelSend::StopSend() {
Niels Möller26e88b02018-11-19 15:08:13 +0100750 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Fredrik Solenbergeb134842018-11-19 14:13:15 +0100751 if (!sending_) {
Niels Möller530ead42018-10-04 14:28:39 +0200752 return;
753 }
Fredrik Solenbergeb134842018-11-19 14:13:15 +0100754 sending_ = false;
Niels Möller530ead42018-10-04 14:28:39 +0200755
756 // Post a task to the encoder thread which sets an event when the task is
757 // executed. We know that no more encoding tasks will be added to the task
758 // queue for this channel since sending is now deactivated. It means that,
759 // if we wait for the event to bet set, we know that no more pending tasks
760 // exists and it is therfore guaranteed that the task queue will never try
761 // to acccess and invalid channel object.
762 RTC_DCHECK(encoder_queue_);
763
Niels Möllerc572ff32018-11-07 08:43:50 +0100764 rtc::Event flush;
Niels Möller530ead42018-10-04 14:28:39 +0200765 {
766 // Clear |encoder_queue_is_active_| under lock to prevent any other tasks
767 // than this final "flush task" to be posted on the queue.
768 rtc::CritScope cs(&encoder_queue_lock_);
769 encoder_queue_is_active_ = false;
770 encoder_queue_->PostTask([&flush]() { flush.Set(); });
771 }
772 flush.Wait(rtc::Event::kForever);
773
Niels Möller530ead42018-10-04 14:28:39 +0200774 // Reset sending SSRC and sequence number and triggers direct transmission
775 // of RTCP BYE
776 if (_rtpRtcpModule->SetSendingStatus(false) == -1) {
777 RTC_DLOG(LS_ERROR) << "StartSend() RTP/RTCP failed to stop sending";
778 }
779 _rtpRtcpModule->SetSendingMediaStatus(false);
780}
781
782bool ChannelSend::SetEncoder(int payload_type,
783 std::unique_ptr<AudioEncoder> encoder) {
Niels Möller26e88b02018-11-19 15:08:13 +0100784 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +0200785 RTC_DCHECK_GE(payload_type, 0);
786 RTC_DCHECK_LE(payload_type, 127);
Niels Möller530ead42018-10-04 14:28:39 +0200787
788 // The RTP/RTCP module needs to know the RTP timestamp rate (i.e. clockrate)
789 // as well as some other things, so we collect this info and send it along.
Fredrik Solenbergf693bfa2018-12-11 12:22:10 +0100790 _rtpRtcpModule->RegisterAudioSendPayload(payload_type,
791 "audio",
792 encoder->RtpTimestampRateHz(),
793 encoder->NumChannels(),
794 0);
Niels Möller530ead42018-10-04 14:28:39 +0200795
Niels Möller7d76a312018-10-26 12:57:07 +0200796 if (media_transport_) {
797 rtc::CritScope cs(&media_transport_lock_);
798 media_transport_payload_type_ = payload_type;
799 // TODO(nisse): Currently broken for G722, since timestamps passed through
800 // encoder use RTP clock rather than sample count, and they differ for G722.
801 media_transport_sampling_frequency_ = encoder->RtpTimestampRateHz();
802 }
Niels Möller530ead42018-10-04 14:28:39 +0200803 audio_coding_->SetEncoder(std::move(encoder));
804 return true;
805}
806
807void ChannelSend::ModifyEncoder(
808 rtc::FunctionView<void(std::unique_ptr<AudioEncoder>*)> modifier) {
Anton Sukhanov626015d2019-02-04 15:16:06 -0800809 // This method can be called on the worker thread, module process thread
810 // or network thread. Audio coding is thread safe, so we do not need to
811 // enforce the calling thread.
Niels Möller530ead42018-10-04 14:28:39 +0200812 audio_coding_->ModifyEncoder(modifier);
813}
814
Sebastian Jansson14a7cf92019-02-13 15:11:42 +0100815void ChannelSend::CallEncoder(rtc::FunctionView<void(AudioEncoder*)> modifier) {
816 ModifyEncoder([modifier](std::unique_ptr<AudioEncoder>* encoder_ptr) {
817 if (*encoder_ptr) {
818 modifier(encoder_ptr->get());
819 } else {
820 RTC_DLOG(LS_WARNING) << "Trying to call unset encoder.";
821 }
822 });
823}
824
Sebastian Jansson254d8692018-11-21 19:19:00 +0100825void ChannelSend::OnBitrateAllocation(BitrateAllocationUpdate update) {
Niels Möllerdced9f62018-11-19 10:27:07 +0100826 // This method can be called on the worker thread, module process thread
827 // or on a TaskQueue via VideoSendStreamImpl::OnEncoderConfigurationChanged.
828 // TODO(solenberg): Figure out a good way to check this or enforce calling
829 // rules.
830 // RTC_DCHECK(worker_thread_checker_.CalledOnValidThread() ||
831 // module_process_thread_checker_.CalledOnValidThread());
Piotr (Peter) Slatala1eebec92018-11-16 09:03:35 -0800832 rtc::CritScope lock(&bitrate_crit_section_);
Niels Möllerdced9f62018-11-19 10:27:07 +0100833
Sebastian Jansson14a7cf92019-02-13 15:11:42 +0100834 CallEncoder([&](AudioEncoder* encoder) {
835 encoder->OnReceivedUplinkAllocation(update);
Niels Möller530ead42018-10-04 14:28:39 +0200836 });
Sebastian Jansson254d8692018-11-21 19:19:00 +0100837 retransmission_rate_limiter_->SetMaxRate(update.target_bitrate.bps());
838 configured_bitrate_bps_ = update.target_bitrate.bps();
Sebastian Jansson359d60a2018-10-25 16:22:02 +0200839}
840
Niels Möllerdced9f62018-11-19 10:27:07 +0100841int ChannelSend::GetBitrate() const {
Piotr (Peter) Slatala1eebec92018-11-16 09:03:35 -0800842 rtc::CritScope lock(&bitrate_crit_section_);
Sebastian Jansson359d60a2018-10-25 16:22:02 +0200843 return configured_bitrate_bps_;
Niels Möller530ead42018-10-04 14:28:39 +0200844}
845
846void ChannelSend::OnTwccBasedUplinkPacketLossRate(float packet_loss_rate) {
Niels Möller26e88b02018-11-19 15:08:13 +0100847 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +0200848 if (!use_twcc_plr_for_ana_)
849 return;
Sebastian Jansson14a7cf92019-02-13 15:11:42 +0100850 CallEncoder([&](AudioEncoder* encoder) {
851 encoder->OnReceivedUplinkPacketLossFraction(packet_loss_rate);
Niels Möller530ead42018-10-04 14:28:39 +0200852 });
853}
854
855void ChannelSend::OnRecoverableUplinkPacketLossRate(
856 float recoverable_packet_loss_rate) {
Niels Möller26e88b02018-11-19 15:08:13 +0100857 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Sebastian Jansson14a7cf92019-02-13 15:11:42 +0100858 CallEncoder([&](AudioEncoder* encoder) {
859 encoder->OnReceivedUplinkRecoverablePacketLossFraction(
860 recoverable_packet_loss_rate);
Niels Möller530ead42018-10-04 14:28:39 +0200861 });
862}
863
864void ChannelSend::OnUplinkPacketLossRate(float packet_loss_rate) {
865 if (use_twcc_plr_for_ana_)
866 return;
Sebastian Jansson14a7cf92019-02-13 15:11:42 +0100867 CallEncoder([&](AudioEncoder* encoder) {
868 encoder->OnReceivedUplinkPacketLossFraction(packet_loss_rate);
Niels Möller530ead42018-10-04 14:28:39 +0200869 });
870}
871
Niels Möller26815232018-11-16 09:32:40 +0100872// TODO(nisse): Delete always-true return value.
873bool ChannelSend::ReceivedRTCPPacket(const uint8_t* data, size_t length) {
Niels Möllerdced9f62018-11-19 10:27:07 +0100874 // May be called on either worker thread or network thread.
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -0800875 if (media_transport_) {
876 // Ignore RTCP packets while media transport is used.
877 // Those packets should not arrive, but we are seeing occasional packets.
878 return 0;
879 }
880
Niels Möller530ead42018-10-04 14:28:39 +0200881 // Deliver RTCP packet to RTP/RTCP module for parsing
882 _rtpRtcpModule->IncomingRtcpPacket(data, length);
883
884 int64_t rtt = GetRTT();
885 if (rtt == 0) {
886 // Waiting for valid RTT.
Niels Möller26815232018-11-16 09:32:40 +0100887 return true;
Niels Möller530ead42018-10-04 14:28:39 +0200888 }
889
890 int64_t nack_window_ms = rtt;
891 if (nack_window_ms < kMinRetransmissionWindowMs) {
892 nack_window_ms = kMinRetransmissionWindowMs;
893 } else if (nack_window_ms > kMaxRetransmissionWindowMs) {
894 nack_window_ms = kMaxRetransmissionWindowMs;
895 }
896 retransmission_rate_limiter_->SetWindowSize(nack_window_ms);
897
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -0800898 OnReceivedRtt(rtt);
Niels Möller26815232018-11-16 09:32:40 +0100899 return true;
Niels Möller530ead42018-10-04 14:28:39 +0200900}
901
902void ChannelSend::SetInputMute(bool enable) {
Niels Möller26e88b02018-11-19 15:08:13 +0100903 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +0200904 rtc::CritScope cs(&volume_settings_critsect_);
905 input_mute_ = enable;
906}
907
908bool ChannelSend::InputMute() const {
909 rtc::CritScope cs(&volume_settings_critsect_);
910 return input_mute_;
911}
912
Niels Möller26815232018-11-16 09:32:40 +0100913bool ChannelSend::SendTelephoneEventOutband(int event, int duration_ms) {
Niels Möller26e88b02018-11-19 15:08:13 +0100914 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +0200915 RTC_DCHECK_LE(0, event);
916 RTC_DCHECK_GE(255, event);
917 RTC_DCHECK_LE(0, duration_ms);
918 RTC_DCHECK_GE(65535, duration_ms);
Fredrik Solenbergeb134842018-11-19 14:13:15 +0100919 if (!sending_) {
Niels Möller26815232018-11-16 09:32:40 +0100920 return false;
Niels Möller530ead42018-10-04 14:28:39 +0200921 }
922 if (_rtpRtcpModule->SendTelephoneEventOutband(
923 event, duration_ms, kTelephoneEventAttenuationdB) != 0) {
924 RTC_DLOG(LS_ERROR) << "SendTelephoneEventOutband() failed to send event";
Niels Möller26815232018-11-16 09:32:40 +0100925 return false;
Niels Möller530ead42018-10-04 14:28:39 +0200926 }
Niels Möller26815232018-11-16 09:32:40 +0100927 return true;
Niels Möller530ead42018-10-04 14:28:39 +0200928}
929
Niels Möller26815232018-11-16 09:32:40 +0100930bool ChannelSend::SetSendTelephoneEventPayloadType(int payload_type,
931 int payload_frequency) {
Niels Möller26e88b02018-11-19 15:08:13 +0100932 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +0200933 RTC_DCHECK_LE(0, payload_type);
934 RTC_DCHECK_GE(127, payload_type);
Fredrik Solenbergf693bfa2018-12-11 12:22:10 +0100935 _rtpRtcpModule->RegisterAudioSendPayload(payload_type, "telephone-event",
936 payload_frequency, 0, 0);
Niels Möller26815232018-11-16 09:32:40 +0100937 return true;
Niels Möller530ead42018-10-04 14:28:39 +0200938}
939
Niels Möllerdced9f62018-11-19 10:27:07 +0100940void ChannelSend::SetLocalSSRC(uint32_t ssrc) {
Niels Möller26e88b02018-11-19 15:08:13 +0100941 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Fredrik Solenbergeb134842018-11-19 14:13:15 +0100942 RTC_DCHECK(!sending_);
Niels Möller26815232018-11-16 09:32:40 +0100943
Niels Möller7d76a312018-10-26 12:57:07 +0200944 if (media_transport_) {
945 rtc::CritScope cs(&media_transport_lock_);
946 media_transport_channel_id_ = ssrc;
947 }
Niels Möller530ead42018-10-04 14:28:39 +0200948 _rtpRtcpModule->SetSSRC(ssrc);
Niels Möller530ead42018-10-04 14:28:39 +0200949}
950
Amit Hilbuch77938e62018-12-21 09:23:38 -0800951void ChannelSend::SetRid(const std::string& rid,
952 int extension_id,
953 int repaired_extension_id) {
954 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
955 if (extension_id != 0) {
956 int ret = SetSendRtpHeaderExtension(!rid.empty(), kRtpExtensionRtpStreamId,
957 extension_id);
958 RTC_DCHECK_EQ(0, ret);
959 }
960 if (repaired_extension_id != 0) {
961 int ret = SetSendRtpHeaderExtension(!rid.empty(), kRtpExtensionRtpStreamId,
962 repaired_extension_id);
963 RTC_DCHECK_EQ(0, ret);
964 }
965 _rtpRtcpModule->SetRid(rid);
966}
967
Niels Möller530ead42018-10-04 14:28:39 +0200968void ChannelSend::SetMid(const std::string& mid, int extension_id) {
Niels Möller26e88b02018-11-19 15:08:13 +0100969 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +0200970 int ret = SetSendRtpHeaderExtension(true, kRtpExtensionMid, extension_id);
971 RTC_DCHECK_EQ(0, ret);
972 _rtpRtcpModule->SetMid(mid);
973}
974
Johannes Kron9190b822018-10-29 11:22:05 +0100975void ChannelSend::SetExtmapAllowMixed(bool extmap_allow_mixed) {
Niels Möller26e88b02018-11-19 15:08:13 +0100976 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Johannes Kron9190b822018-10-29 11:22:05 +0100977 _rtpRtcpModule->SetExtmapAllowMixed(extmap_allow_mixed);
978}
979
Niels Möller26815232018-11-16 09:32:40 +0100980void ChannelSend::SetSendAudioLevelIndicationStatus(bool enable, int id) {
Niels Möller26e88b02018-11-19 15:08:13 +0100981 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +0200982 _includeAudioLevelIndication = enable;
Niels Möller26815232018-11-16 09:32:40 +0100983 int ret = SetSendRtpHeaderExtension(enable, kRtpExtensionAudioLevel, id);
984 RTC_DCHECK_EQ(0, ret);
Niels Möller530ead42018-10-04 14:28:39 +0200985}
986
987void ChannelSend::EnableSendTransportSequenceNumber(int id) {
Niels Möller26e88b02018-11-19 15:08:13 +0100988 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +0200989 int ret =
990 SetSendRtpHeaderExtension(true, kRtpExtensionTransportSequenceNumber, id);
991 RTC_DCHECK_EQ(0, ret);
992}
993
994void ChannelSend::RegisterSenderCongestionControlObjects(
995 RtpTransportControllerSendInterface* transport,
996 RtcpBandwidthObserver* bandwidth_observer) {
Niels Möller26e88b02018-11-19 15:08:13 +0100997 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +0200998 RtpPacketSender* rtp_packet_sender = transport->packet_sender();
999 TransportFeedbackObserver* transport_feedback_observer =
1000 transport->transport_feedback_observer();
1001 PacketRouter* packet_router = transport->packet_router();
1002
1003 RTC_DCHECK(rtp_packet_sender);
1004 RTC_DCHECK(transport_feedback_observer);
1005 RTC_DCHECK(packet_router);
1006 RTC_DCHECK(!packet_router_);
1007 rtcp_observer_->SetBandwidthObserver(bandwidth_observer);
1008 feedback_observer_proxy_->SetTransportFeedbackObserver(
1009 transport_feedback_observer);
1010 seq_num_allocator_proxy_->SetSequenceNumberAllocator(packet_router);
1011 rtp_packet_sender_proxy_->SetPacketSender(rtp_packet_sender);
1012 _rtpRtcpModule->SetStorePacketsStatus(true, 600);
1013 constexpr bool remb_candidate = false;
1014 packet_router->AddSendRtpModule(_rtpRtcpModule.get(), remb_candidate);
1015 packet_router_ = packet_router;
1016}
1017
1018void ChannelSend::ResetSenderCongestionControlObjects() {
Niels Möller26e88b02018-11-19 15:08:13 +01001019 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +02001020 RTC_DCHECK(packet_router_);
1021 _rtpRtcpModule->SetStorePacketsStatus(false, 600);
1022 rtcp_observer_->SetBandwidthObserver(nullptr);
1023 feedback_observer_proxy_->SetTransportFeedbackObserver(nullptr);
1024 seq_num_allocator_proxy_->SetSequenceNumberAllocator(nullptr);
1025 packet_router_->RemoveSendRtpModule(_rtpRtcpModule.get());
1026 packet_router_ = nullptr;
1027 rtp_packet_sender_proxy_->SetPacketSender(nullptr);
1028}
1029
Niels Möller26815232018-11-16 09:32:40 +01001030void ChannelSend::SetRTCP_CNAME(absl::string_view c_name) {
Niels Möller26e88b02018-11-19 15:08:13 +01001031 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller26815232018-11-16 09:32:40 +01001032 // Note: SetCNAME() accepts a c string of length at most 255.
1033 const std::string c_name_limited(c_name.substr(0, 255));
1034 int ret = _rtpRtcpModule->SetCNAME(c_name_limited.c_str()) != 0;
1035 RTC_DCHECK_EQ(0, ret) << "SetRTCP_CNAME() failed to set RTCP CNAME";
Niels Möller530ead42018-10-04 14:28:39 +02001036}
1037
Niels Möller26815232018-11-16 09:32:40 +01001038std::vector<ReportBlock> ChannelSend::GetRemoteRTCPReportBlocks() const {
Niels Möller26e88b02018-11-19 15:08:13 +01001039 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +02001040 // Get the report blocks from the latest received RTCP Sender or Receiver
1041 // Report. Each element in the vector contains the sender's SSRC and a
1042 // report block according to RFC 3550.
1043 std::vector<RTCPReportBlock> rtcp_report_blocks;
Niels Möller530ead42018-10-04 14:28:39 +02001044
Niels Möller26815232018-11-16 09:32:40 +01001045 int ret = _rtpRtcpModule->RemoteRTCPStat(&rtcp_report_blocks);
1046 RTC_DCHECK_EQ(0, ret);
1047
1048 std::vector<ReportBlock> report_blocks;
Niels Möller530ead42018-10-04 14:28:39 +02001049
1050 std::vector<RTCPReportBlock>::const_iterator it = rtcp_report_blocks.begin();
1051 for (; it != rtcp_report_blocks.end(); ++it) {
1052 ReportBlock report_block;
1053 report_block.sender_SSRC = it->sender_ssrc;
1054 report_block.source_SSRC = it->source_ssrc;
1055 report_block.fraction_lost = it->fraction_lost;
1056 report_block.cumulative_num_packets_lost = it->packets_lost;
1057 report_block.extended_highest_sequence_number =
1058 it->extended_highest_sequence_number;
1059 report_block.interarrival_jitter = it->jitter;
1060 report_block.last_SR_timestamp = it->last_sender_report_timestamp;
1061 report_block.delay_since_last_SR = it->delay_since_last_sender_report;
Niels Möller26815232018-11-16 09:32:40 +01001062 report_blocks.push_back(report_block);
Niels Möller530ead42018-10-04 14:28:39 +02001063 }
Niels Möller26815232018-11-16 09:32:40 +01001064 return report_blocks;
Niels Möller530ead42018-10-04 14:28:39 +02001065}
1066
Niels Möller26815232018-11-16 09:32:40 +01001067CallSendStatistics ChannelSend::GetRTCPStatistics() const {
Niels Möller26e88b02018-11-19 15:08:13 +01001068 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller26815232018-11-16 09:32:40 +01001069 CallSendStatistics stats = {0};
Niels Möller530ead42018-10-04 14:28:39 +02001070 stats.rttMs = GetRTT();
1071
Niels Möller530ead42018-10-04 14:28:39 +02001072 size_t bytesSent(0);
1073 uint32_t packetsSent(0);
1074
1075 if (_rtpRtcpModule->DataCountersRTP(&bytesSent, &packetsSent) != 0) {
1076 RTC_DLOG(LS_WARNING)
1077 << "GetRTPStatistics() failed to retrieve RTP datacounters"
1078 << " => output will not be complete";
1079 }
1080
1081 stats.bytesSent = bytesSent;
1082 stats.packetsSent = packetsSent;
1083
Niels Möller26815232018-11-16 09:32:40 +01001084 return stats;
Niels Möller530ead42018-10-04 14:28:39 +02001085}
1086
Niels Möller530ead42018-10-04 14:28:39 +02001087void ChannelSend::ProcessAndEncodeAudio(
1088 std::unique_ptr<AudioFrame> audio_frame) {
Niels Möllerdced9f62018-11-19 10:27:07 +01001089 RTC_DCHECK_RUNS_SERIALIZED(&audio_thread_race_checker_);
Niels Möller530ead42018-10-04 14:28:39 +02001090 // Avoid posting any new tasks if sending was already stopped in StopSend().
1091 rtc::CritScope cs(&encoder_queue_lock_);
1092 if (!encoder_queue_is_active_) {
1093 return;
1094 }
1095 // Profile time between when the audio frame is added to the task queue and
1096 // when the task is actually executed.
1097 audio_frame->UpdateProfileTimeStamp();
1098 encoder_queue_->PostTask(std::unique_ptr<rtc::QueuedTask>(
1099 new ProcessAndEncodeAudioTask(std::move(audio_frame), this)));
1100}
1101
1102void ChannelSend::ProcessAndEncodeAudioOnTaskQueue(AudioFrame* audio_input) {
1103 RTC_DCHECK_RUN_ON(encoder_queue_);
1104 RTC_DCHECK_GT(audio_input->samples_per_channel_, 0);
1105 RTC_DCHECK_LE(audio_input->num_channels_, 2);
1106
1107 // Measure time between when the audio frame is added to the task queue and
1108 // when the task is actually executed. Goal is to keep track of unwanted
1109 // extra latency added by the task queue.
1110 RTC_HISTOGRAM_COUNTS_10000("WebRTC.Audio.EncodingTaskQueueLatencyMs",
1111 audio_input->ElapsedProfileTimeMs());
1112
1113 bool is_muted = InputMute();
1114 AudioFrameOperations::Mute(audio_input, previous_frame_muted_, is_muted);
1115
1116 if (_includeAudioLevelIndication) {
1117 size_t length =
1118 audio_input->samples_per_channel_ * audio_input->num_channels_;
1119 RTC_CHECK_LE(length, AudioFrame::kMaxDataSizeBytes);
1120 if (is_muted && previous_frame_muted_) {
1121 rms_level_.AnalyzeMuted(length);
1122 } else {
1123 rms_level_.Analyze(
1124 rtc::ArrayView<const int16_t>(audio_input->data(), length));
1125 }
1126 }
1127 previous_frame_muted_ = is_muted;
1128
1129 // Add 10ms of raw (PCM) audio data to the encoder @ 32kHz.
1130
1131 // The ACM resamples internally.
1132 audio_input->timestamp_ = _timeStamp;
1133 // This call will trigger AudioPacketizationCallback::SendData if encoding
1134 // is done and payload is ready for packetization and transmission.
1135 // Otherwise, it will return without invoking the callback.
1136 if (audio_coding_->Add10MsData(*audio_input) < 0) {
1137 RTC_DLOG(LS_ERROR) << "ACM::Add10MsData() failed.";
1138 return;
1139 }
1140
1141 _timeStamp += static_cast<uint32_t>(audio_input->samples_per_channel_);
1142}
1143
Niels Möller530ead42018-10-04 14:28:39 +02001144ANAStats ChannelSend::GetANAStatistics() const {
Niels Möller26e88b02018-11-19 15:08:13 +01001145 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Niels Möller530ead42018-10-04 14:28:39 +02001146 return audio_coding_->GetANAStats();
1147}
1148
1149RtpRtcp* ChannelSend::GetRtpRtcp() const {
Niels Möllerdced9f62018-11-19 10:27:07 +01001150 RTC_DCHECK(module_process_thread_checker_.CalledOnValidThread());
Niels Möller530ead42018-10-04 14:28:39 +02001151 return _rtpRtcpModule.get();
1152}
1153
1154int ChannelSend::SetSendRtpHeaderExtension(bool enable,
1155 RTPExtensionType type,
Niels Möller26815232018-11-16 09:32:40 +01001156 int id) {
Niels Möller530ead42018-10-04 14:28:39 +02001157 int error = 0;
1158 _rtpRtcpModule->DeregisterSendRtpHeaderExtension(type);
1159 if (enable) {
Niels Möller26815232018-11-16 09:32:40 +01001160 // TODO(nisse): RtpRtcp::RegisterSendRtpHeaderExtension to take an int
1161 // argument. Currently it wants an uint8_t.
1162 error = _rtpRtcpModule->RegisterSendRtpHeaderExtension(
1163 type, rtc::dchecked_cast<uint8_t>(id));
Niels Möller530ead42018-10-04 14:28:39 +02001164 }
1165 return error;
1166}
1167
Niels Möller530ead42018-10-04 14:28:39 +02001168int64_t ChannelSend::GetRTT() const {
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -08001169 if (media_transport_) {
1170 // GetRTT is generally used in the RTCP codepath, where media transport is
1171 // not present and so it shouldn't be needed. But it's also invoked in
1172 // 'GetStats' method, and for now returning media transport RTT here gives
1173 // us "free" rtt stats for media transport.
1174 auto target_rate = media_transport_->GetLatestTargetTransferRate();
1175 if (target_rate.has_value()) {
1176 return target_rate.value().network_estimate.round_trip_time.ms();
1177 }
1178
1179 return 0;
1180 }
Niels Möller530ead42018-10-04 14:28:39 +02001181 RtcpMode method = _rtpRtcpModule->RTCP();
1182 if (method == RtcpMode::kOff) {
1183 return 0;
1184 }
1185 std::vector<RTCPReportBlock> report_blocks;
1186 _rtpRtcpModule->RemoteRTCPStat(&report_blocks);
1187
1188 if (report_blocks.empty()) {
1189 return 0;
1190 }
1191
1192 int64_t rtt = 0;
1193 int64_t avg_rtt = 0;
1194 int64_t max_rtt = 0;
1195 int64_t min_rtt = 0;
1196 // We don't know in advance the remote ssrc used by the other end's receiver
1197 // reports, so use the SSRC of the first report block for calculating the RTT.
1198 if (_rtpRtcpModule->RTT(report_blocks[0].sender_ssrc, &rtt, &avg_rtt,
1199 &min_rtt, &max_rtt) != 0) {
1200 return 0;
1201 }
1202 return rtt;
1203}
1204
Benjamin Wright78410ad2018-10-25 09:52:57 -07001205void ChannelSend::SetFrameEncryptor(
1206 rtc::scoped_refptr<FrameEncryptorInterface> frame_encryptor) {
Niels Möller26e88b02018-11-19 15:08:13 +01001207 RTC_DCHECK_RUN_ON(&worker_thread_checker_);
Benjamin Wright84583f62018-10-04 14:22:34 -07001208 rtc::CritScope cs(&encoder_queue_lock_);
1209 if (encoder_queue_is_active_) {
Mirko Bonadei80a86872019-02-04 15:01:43 +01001210 encoder_queue_->PostTask([this, frame_encryptor]() mutable {
Benjamin Wright78410ad2018-10-25 09:52:57 -07001211 this->frame_encryptor_ = std::move(frame_encryptor);
Benjamin Wright84583f62018-10-04 14:22:34 -07001212 });
1213 } else {
Benjamin Wright78410ad2018-10-25 09:52:57 -07001214 frame_encryptor_ = std::move(frame_encryptor);
Benjamin Wright84583f62018-10-04 14:22:34 -07001215 }
1216}
1217
Anton Sukhanov626015d2019-02-04 15:16:06 -08001218// TODO(sukhanov): Consider moving TargetTransferRate observer to
1219// AudioSendStream. Since AudioSendStream owns encoder and configures ANA, it
1220// makes sense to consolidate all rate (and overhead) calculation there.
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -08001221void ChannelSend::OnTargetTransferRate(TargetTransferRate rate) {
1222 RTC_DCHECK(media_transport_);
1223 OnReceivedRtt(rate.network_estimate.round_trip_time.ms());
1224}
1225
1226void ChannelSend::OnReceivedRtt(int64_t rtt_ms) {
1227 // Invoke audio encoders OnReceivedRtt().
Sebastian Jansson14a7cf92019-02-13 15:11:42 +01001228 CallEncoder(
1229 [rtt_ms](AudioEncoder* encoder) { encoder->OnReceivedRtt(rtt_ms); });
Piotr (Peter) Slatala179a3922018-11-16 09:57:58 -08001230}
1231
Niels Möllerdced9f62018-11-19 10:27:07 +01001232} // namespace
1233
1234std::unique_ptr<ChannelSendInterface> CreateChannelSend(
1235 rtc::TaskQueue* encoder_queue,
1236 ProcessThread* module_process_thread,
1237 MediaTransportInterface* media_transport,
Anton Sukhanov626015d2019-02-04 15:16:06 -08001238 OverheadObserver* overhead_observer,
Niels Möllere9771992018-11-26 10:55:07 +01001239 Transport* rtp_transport,
Niels Möllerdced9f62018-11-19 10:27:07 +01001240 RtcpRttStats* rtcp_rtt_stats,
1241 RtcEventLog* rtc_event_log,
1242 FrameEncryptorInterface* frame_encryptor,
1243 const webrtc::CryptoOptions& crypto_options,
1244 bool extmap_allow_mixed,
1245 int rtcp_report_interval_ms) {
1246 return absl::make_unique<ChannelSend>(
Anton Sukhanov626015d2019-02-04 15:16:06 -08001247 encoder_queue, module_process_thread, media_transport, overhead_observer,
1248 rtp_transport, rtcp_rtt_stats, rtc_event_log, frame_encryptor,
1249 crypto_options, extmap_allow_mixed, rtcp_report_interval_ms);
Niels Möllerdced9f62018-11-19 10:27:07 +01001250}
1251
Niels Möller530ead42018-10-04 14:28:39 +02001252} // namespace voe
1253} // namespace webrtc