Niels Möller | 530ead4 | 2018-10-04 14:28:39 +0200 | [diff] [blame] | 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 | #ifndef AUDIO_CHANNEL_SEND_H_ |
| 12 | #define AUDIO_CHANNEL_SEND_H_ |
| 13 | |
Niels Möller | 530ead4 | 2018-10-04 14:28:39 +0200 | [diff] [blame] | 14 | #include <memory> |
| 15 | #include <string> |
| 16 | #include <vector> |
| 17 | |
| 18 | #include "api/audio/audio_frame.h" |
| 19 | #include "api/audio_codecs/audio_encoder.h" |
Steve Anton | 10542f2 | 2019-01-11 09:11:00 -0800 | [diff] [blame] | 20 | #include "api/crypto/crypto_options.h" |
Artem Titov | 741daaf | 2019-03-21 14:37:36 +0100 | [diff] [blame] | 21 | #include "api/function_view.h" |
Sebastian Jansson | 44dd9f2 | 2019-03-08 14:50:30 +0100 | [diff] [blame] | 22 | #include "api/task_queue/task_queue_factory.h" |
Henrik Boström | 6e436d1 | 2019-05-27 12:19:33 +0200 | [diff] [blame] | 23 | #include "modules/rtp_rtcp/include/report_block_data.h" |
Niels Möller | 530ead4 | 2018-10-04 14:28:39 +0200 | [diff] [blame] | 24 | #include "modules/rtp_rtcp/include/rtp_rtcp.h" |
Niels Möller | ee5ccbc | 2019-03-06 16:47:29 +0100 | [diff] [blame] | 25 | #include "modules/rtp_rtcp/source/rtp_sender_audio.h" |
Niels Möller | 530ead4 | 2018-10-04 14:28:39 +0200 | [diff] [blame] | 26 | |
| 27 | namespace webrtc { |
| 28 | |
Benjamin Wright | 84583f6 | 2018-10-04 14:22:34 -0700 | [diff] [blame] | 29 | class FrameEncryptorInterface; |
Niels Möller | 530ead4 | 2018-10-04 14:28:39 +0200 | [diff] [blame] | 30 | class ProcessThread; |
Niels Möller | 530ead4 | 2018-10-04 14:28:39 +0200 | [diff] [blame] | 31 | class RtcEventLog; |
| 32 | class RtpRtcp; |
| 33 | class RtpTransportControllerSendInterface; |
| 34 | |
Niels Möller | 530ead4 | 2018-10-04 14:28:39 +0200 | [diff] [blame] | 35 | struct CallSendStatistics { |
| 36 | int64_t rttMs; |
Niels Möller | ac0a4cb | 2019-10-09 15:01:33 +0200 | [diff] [blame] | 37 | int64_t payload_bytes_sent; |
| 38 | int64_t header_and_padding_bytes_sent; |
Henrik Boström | cf96e0f | 2019-04-17 13:51:53 +0200 | [diff] [blame] | 39 | // https://w3c.github.io/webrtc-stats/#dom-rtcoutboundrtpstreamstats-retransmittedbytessent |
| 40 | uint64_t retransmitted_bytes_sent; |
Niels Möller | 530ead4 | 2018-10-04 14:28:39 +0200 | [diff] [blame] | 41 | int packetsSent; |
Henrik Boström | cf96e0f | 2019-04-17 13:51:53 +0200 | [diff] [blame] | 42 | // https://w3c.github.io/webrtc-stats/#dom-rtcoutboundrtpstreamstats-retransmittedpacketssent |
| 43 | uint64_t retransmitted_packets_sent; |
Henrik Boström | 6e436d1 | 2019-05-27 12:19:33 +0200 | [diff] [blame] | 44 | // A snapshot of Report Blocks with additional data of interest to statistics. |
| 45 | // Within this list, the sender-source SSRC pair is unique and per-pair the |
| 46 | // ReportBlockData represents the latest Report Block that was received for |
| 47 | // that pair. |
| 48 | std::vector<ReportBlockData> report_block_datas; |
Niels Möller | 530ead4 | 2018-10-04 14:28:39 +0200 | [diff] [blame] | 49 | }; |
| 50 | |
| 51 | // See section 6.4.2 in http://www.ietf.org/rfc/rfc3550.txt for details. |
| 52 | struct ReportBlock { |
| 53 | uint32_t sender_SSRC; // SSRC of sender |
| 54 | uint32_t source_SSRC; |
| 55 | uint8_t fraction_lost; |
| 56 | int32_t cumulative_num_packets_lost; |
| 57 | uint32_t extended_highest_sequence_number; |
| 58 | uint32_t interarrival_jitter; |
| 59 | uint32_t last_SR_timestamp; |
| 60 | uint32_t delay_since_last_SR; |
| 61 | }; |
| 62 | |
| 63 | namespace voe { |
| 64 | |
Niels Möller | dced9f6 | 2018-11-19 10:27:07 +0100 | [diff] [blame] | 65 | class ChannelSendInterface { |
Niels Möller | 530ead4 | 2018-10-04 14:28:39 +0200 | [diff] [blame] | 66 | public: |
Niels Möller | dced9f6 | 2018-11-19 10:27:07 +0100 | [diff] [blame] | 67 | virtual ~ChannelSendInterface() = default; |
Niels Möller | 530ead4 | 2018-10-04 14:28:39 +0200 | [diff] [blame] | 68 | |
Niels Möller | 8fb1a6a | 2019-03-05 14:29:42 +0100 | [diff] [blame] | 69 | virtual void ReceivedRTCPPacket(const uint8_t* packet, size_t length) = 0; |
Niels Möller | 530ead4 | 2018-10-04 14:28:39 +0200 | [diff] [blame] | 70 | |
Niels Möller | dced9f6 | 2018-11-19 10:27:07 +0100 | [diff] [blame] | 71 | virtual CallSendStatistics GetRTCPStatistics() const = 0; |
Niels Möller | 530ead4 | 2018-10-04 14:28:39 +0200 | [diff] [blame] | 72 | |
Niels Möller | 8fb1a6a | 2019-03-05 14:29:42 +0100 | [diff] [blame] | 73 | virtual void SetEncoder(int payload_type, |
Niels Möller | dced9f6 | 2018-11-19 10:27:07 +0100 | [diff] [blame] | 74 | std::unique_ptr<AudioEncoder> encoder) = 0; |
| 75 | virtual void ModifyEncoder( |
| 76 | rtc::FunctionView<void(std::unique_ptr<AudioEncoder>*)> modifier) = 0; |
Sebastian Jansson | 14a7cf9 | 2019-02-13 15:11:42 +0100 | [diff] [blame] | 77 | virtual void CallEncoder(rtc::FunctionView<void(AudioEncoder*)> modifier) = 0; |
Niels Möller | 530ead4 | 2018-10-04 14:28:39 +0200 | [diff] [blame] | 78 | |
Amit Hilbuch | 77938e6 | 2018-12-21 09:23:38 -0800 | [diff] [blame] | 79 | // Use 0 to indicate that the extension should not be registered. |
Niels Möller | dced9f6 | 2018-11-19 10:27:07 +0100 | [diff] [blame] | 80 | virtual void SetRTCP_CNAME(absl::string_view c_name) = 0; |
Niels Möller | dced9f6 | 2018-11-19 10:27:07 +0100 | [diff] [blame] | 81 | virtual void SetSendAudioLevelIndicationStatus(bool enable, int id) = 0; |
Niels Möller | dced9f6 | 2018-11-19 10:27:07 +0100 | [diff] [blame] | 82 | virtual void RegisterSenderCongestionControlObjects( |
Niels Möller | 530ead4 | 2018-10-04 14:28:39 +0200 | [diff] [blame] | 83 | RtpTransportControllerSendInterface* transport, |
Niels Möller | dced9f6 | 2018-11-19 10:27:07 +0100 | [diff] [blame] | 84 | RtcpBandwidthObserver* bandwidth_observer) = 0; |
| 85 | virtual void ResetSenderCongestionControlObjects() = 0; |
| 86 | virtual std::vector<ReportBlock> GetRemoteRTCPReportBlocks() const = 0; |
| 87 | virtual ANAStats GetANAStatistics() const = 0; |
Niels Möller | ee5ccbc | 2019-03-06 16:47:29 +0100 | [diff] [blame] | 88 | virtual void RegisterCngPayloadType(int payload_type, |
| 89 | int payload_frequency) = 0; |
Niels Möller | 8fb1a6a | 2019-03-05 14:29:42 +0100 | [diff] [blame] | 90 | virtual void SetSendTelephoneEventPayloadType(int payload_type, |
Niels Möller | dced9f6 | 2018-11-19 10:27:07 +0100 | [diff] [blame] | 91 | int payload_frequency) = 0; |
| 92 | virtual bool SendTelephoneEventOutband(int event, int duration_ms) = 0; |
Sebastian Jansson | 254d869 | 2018-11-21 19:19:00 +0100 | [diff] [blame] | 93 | virtual void OnBitrateAllocation(BitrateAllocationUpdate update) = 0; |
Niels Möller | dced9f6 | 2018-11-19 10:27:07 +0100 | [diff] [blame] | 94 | virtual int GetBitrate() const = 0; |
| 95 | virtual void SetInputMute(bool muted) = 0; |
Niels Möller | 530ead4 | 2018-10-04 14:28:39 +0200 | [diff] [blame] | 96 | |
Niels Möller | dced9f6 | 2018-11-19 10:27:07 +0100 | [diff] [blame] | 97 | virtual void ProcessAndEncodeAudio( |
| 98 | std::unique_ptr<AudioFrame> audio_frame) = 0; |
Niels Möller | dced9f6 | 2018-11-19 10:27:07 +0100 | [diff] [blame] | 99 | virtual RtpRtcp* GetRtpRtcp() const = 0; |
Niels Möller | 530ead4 | 2018-10-04 14:28:39 +0200 | [diff] [blame] | 100 | |
Piotr (Peter) Slatala | 179a392 | 2018-11-16 09:57:58 -0800 | [diff] [blame] | 101 | // In RTP we currently rely on RTCP packets (|ReceivedRTCPPacket|) to inform |
| 102 | // about RTT. |
| 103 | // In media transport we rely on the TargetTransferRateObserver instead. |
| 104 | // In other words, if you are using RTP, you should expect |
| 105 | // |ReceivedRTCPPacket| to be called, if you are using media transport, |
| 106 | // |OnTargetTransferRate| will be called. |
| 107 | // |
| 108 | // In future, RTP media will move to the media transport implementation and |
| 109 | // these conditions will be removed. |
Niels Möller | dced9f6 | 2018-11-19 10:27:07 +0100 | [diff] [blame] | 110 | // Returns the RTT in milliseconds. |
| 111 | virtual int64_t GetRTT() const = 0; |
| 112 | virtual void StartSend() = 0; |
| 113 | virtual void StopSend() = 0; |
Piotr (Peter) Slatala | 179a392 | 2018-11-16 09:57:58 -0800 | [diff] [blame] | 114 | |
Niels Möller | dced9f6 | 2018-11-19 10:27:07 +0100 | [diff] [blame] | 115 | // E2EE Custom Audio Frame Encryption (Optional) |
| 116 | virtual void SetFrameEncryptor( |
| 117 | rtc::scoped_refptr<FrameEncryptorInterface> frame_encryptor) = 0; |
Niels Möller | 530ead4 | 2018-10-04 14:28:39 +0200 | [diff] [blame] | 118 | }; |
| 119 | |
Niels Möller | dced9f6 | 2018-11-19 10:27:07 +0100 | [diff] [blame] | 120 | std::unique_ptr<ChannelSendInterface> CreateChannelSend( |
Sebastian Jansson | 977b335 | 2019-03-04 17:43:34 +0100 | [diff] [blame] | 121 | Clock* clock, |
Sebastian Jansson | 44dd9f2 | 2019-03-08 14:50:30 +0100 | [diff] [blame] | 122 | TaskQueueFactory* task_queue_factory, |
Niels Möller | dced9f6 | 2018-11-19 10:27:07 +0100 | [diff] [blame] | 123 | ProcessThread* module_process_thread, |
Anton Sukhanov | 626015d | 2019-02-04 15:16:06 -0800 | [diff] [blame] | 124 | OverheadObserver* overhead_observer, |
Niels Möller | e977199 | 2018-11-26 10:55:07 +0100 | [diff] [blame] | 125 | Transport* rtp_transport, |
Niels Möller | dced9f6 | 2018-11-19 10:27:07 +0100 | [diff] [blame] | 126 | RtcpRttStats* rtcp_rtt_stats, |
| 127 | RtcEventLog* rtc_event_log, |
| 128 | FrameEncryptorInterface* frame_encryptor, |
| 129 | const webrtc::CryptoOptions& crypto_options, |
| 130 | bool extmap_allow_mixed, |
Erik Språng | 4c2c412 | 2019-07-11 15:20:15 +0200 | [diff] [blame] | 131 | int rtcp_report_interval_ms, |
| 132 | uint32_t ssrc); |
Niels Möller | dced9f6 | 2018-11-19 10:27:07 +0100 | [diff] [blame] | 133 | |
Niels Möller | 530ead4 | 2018-10-04 14:28:39 +0200 | [diff] [blame] | 134 | } // namespace voe |
| 135 | } // namespace webrtc |
| 136 | |
| 137 | #endif // AUDIO_CHANNEL_SEND_H_ |