Fredrik Solenberg | 23fba1f | 2015-04-29 15:24:01 +0200 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2015 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 | |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 11 | #ifndef CALL_AUDIO_RECEIVE_STREAM_H_ |
| 12 | #define CALL_AUDIO_RECEIVE_STREAM_H_ |
Fredrik Solenberg | 23fba1f | 2015-04-29 15:24:01 +0200 | [diff] [blame] | 13 | |
Fredrik Solenberg | 04f4931 | 2015-06-08 13:04:56 +0200 | [diff] [blame] | 14 | #include <map> |
kwiberg | fffa42b | 2016-02-23 10:46:32 -0800 | [diff] [blame] | 15 | #include <memory> |
Fredrik Solenberg | 23fba1f | 2015-04-29 15:24:01 +0200 | [diff] [blame] | 16 | #include <string> |
| 17 | #include <vector> |
| 18 | |
Danil Chapovalov | b9b146c | 2018-06-15 12:28:07 +0200 | [diff] [blame] | 19 | #include "absl/types/optional.h" |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 20 | #include "api/audio_codecs/audio_decoder_factory.h" |
| 21 | #include "api/call/transport.h" |
Steve Anton | 10542f2 | 2019-01-11 09:11:00 -0800 | [diff] [blame] | 22 | #include "api/crypto/crypto_options.h" |
Niels Möller | a837030 | 2019-09-02 15:16:49 +0200 | [diff] [blame] | 23 | #include "api/crypto/frame_decryptor_interface.h" |
Marina Ciocea | 3e9af7f | 2020-04-01 07:46:16 +0200 | [diff] [blame] | 24 | #include "api/frame_transformer_interface.h" |
Steve Anton | 10542f2 | 2019-01-11 09:11:00 -0800 | [diff] [blame] | 25 | #include "api/rtp_parameters.h" |
Mirko Bonadei | d970807 | 2019-01-25 20:26:48 +0100 | [diff] [blame] | 26 | #include "api/scoped_refptr.h" |
Niels Möller | a837030 | 2019-09-02 15:16:49 +0200 | [diff] [blame] | 27 | #include "api/transport/rtp/rtp_source.h" |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 28 | #include "call/rtp_config.h" |
Fredrik Solenberg | 23fba1f | 2015-04-29 15:24:01 +0200 | [diff] [blame] | 29 | |
| 30 | namespace webrtc { |
Tommi | f888bb5 | 2015-12-12 01:37:01 +0100 | [diff] [blame] | 31 | class AudioSinkInterface; |
Fredrik Solenberg | 04f4931 | 2015-06-08 13:04:56 +0200 | [diff] [blame] | 32 | |
pbos | 1ba8d39 | 2016-05-01 20:18:34 -0700 | [diff] [blame] | 33 | class AudioReceiveStream { |
Fredrik Solenberg | 23fba1f | 2015-04-29 15:24:01 +0200 | [diff] [blame] | 34 | public: |
Fredrik Solenberg | 4f4ec0a | 2015-10-22 10:49:27 +0200 | [diff] [blame] | 35 | struct Stats { |
Paulina Hensman | 11b34f4 | 2018-04-09 14:24:52 +0200 | [diff] [blame] | 36 | Stats(); |
| 37 | ~Stats(); |
Fredrik Solenberg | 4f4ec0a | 2015-10-22 10:49:27 +0200 | [diff] [blame] | 38 | uint32_t remote_ssrc = 0; |
Niels Möller | ac0a4cb | 2019-10-09 15:01:33 +0200 | [diff] [blame] | 39 | int64_t payload_bytes_rcvd = 0; |
| 40 | int64_t header_and_padding_bytes_rcvd = 0; |
Fredrik Solenberg | 4f4ec0a | 2015-10-22 10:49:27 +0200 | [diff] [blame] | 41 | uint32_t packets_rcvd = 0; |
Ivo Creusen | 8d8ffdb | 2019-04-30 09:45:21 +0200 | [diff] [blame] | 42 | uint64_t fec_packets_received = 0; |
| 43 | uint64_t fec_packets_discarded = 0; |
Fredrik Solenberg | 4f4ec0a | 2015-10-22 10:49:27 +0200 | [diff] [blame] | 44 | uint32_t packets_lost = 0; |
Fredrik Solenberg | 4f4ec0a | 2015-10-22 10:49:27 +0200 | [diff] [blame] | 45 | std::string codec_name; |
Danil Chapovalov | b9b146c | 2018-06-15 12:28:07 +0200 | [diff] [blame] | 46 | absl::optional<int> codec_payload_type; |
Fredrik Solenberg | 4f4ec0a | 2015-10-22 10:49:27 +0200 | [diff] [blame] | 47 | uint32_t jitter_ms = 0; |
| 48 | uint32_t jitter_buffer_ms = 0; |
| 49 | uint32_t jitter_buffer_preferred_ms = 0; |
| 50 | uint32_t delay_estimate_ms = 0; |
| 51 | int32_t audio_level = -1; |
Gustaf Ullberg | 9a2e906 | 2017-09-18 09:28:20 +0200 | [diff] [blame] | 52 | // Stats below correspond to similarly-named fields in the WebRTC stats |
| 53 | // spec. https://w3c.github.io/webrtc-stats/#dom-rtcmediastreamtrackstats |
zstein | e76bd3a | 2017-07-14 12:17:49 -0700 | [diff] [blame] | 54 | double total_output_energy = 0.0; |
Steve Anton | 2dbc69f | 2017-08-24 17:15:13 -0700 | [diff] [blame] | 55 | uint64_t total_samples_received = 0; |
zstein | e76bd3a | 2017-07-14 12:17:49 -0700 | [diff] [blame] | 56 | double total_output_duration = 0.0; |
Steve Anton | 2dbc69f | 2017-08-24 17:15:13 -0700 | [diff] [blame] | 57 | uint64_t concealed_samples = 0; |
Ivo Creusen | 8d8ffdb | 2019-04-30 09:45:21 +0200 | [diff] [blame] | 58 | uint64_t silent_concealed_samples = 0; |
Gustaf Ullberg | 9a2e906 | 2017-09-18 09:28:20 +0200 | [diff] [blame] | 59 | uint64_t concealment_events = 0; |
Gustaf Ullberg | b0a0207 | 2017-10-02 12:00:34 +0200 | [diff] [blame] | 60 | double jitter_buffer_delay_seconds = 0.0; |
Chen Xing | 0acffb5 | 2019-01-15 15:46:29 +0100 | [diff] [blame] | 61 | uint64_t jitter_buffer_emitted_count = 0; |
Artem Titov | e618cc9 | 2020-03-11 11:18:54 +0100 | [diff] [blame] | 62 | double jitter_buffer_target_delay_seconds = 0.0; |
Ivo Creusen | 8d8ffdb | 2019-04-30 09:45:21 +0200 | [diff] [blame] | 63 | uint64_t inserted_samples_for_deceleration = 0; |
| 64 | uint64_t removed_samples_for_acceleration = 0; |
Gustaf Ullberg | 9a2e906 | 2017-09-18 09:28:20 +0200 | [diff] [blame] | 65 | // Stats below DO NOT correspond directly to anything in the WebRTC stats |
Fredrik Solenberg | 4f4ec0a | 2015-10-22 10:49:27 +0200 | [diff] [blame] | 66 | float expand_rate = 0.0f; |
| 67 | float speech_expand_rate = 0.0f; |
| 68 | float secondary_decoded_rate = 0.0f; |
minyue-webrtc | 0e320ec | 2017-08-28 13:51:27 +0200 | [diff] [blame] | 69 | float secondary_discarded_rate = 0.0f; |
Fredrik Solenberg | 4f4ec0a | 2015-10-22 10:49:27 +0200 | [diff] [blame] | 70 | float accelerate_rate = 0.0f; |
| 71 | float preemptive_expand_rate = 0.0f; |
Jakob Ivarsson | 352ce5c | 2018-11-27 12:52:16 +0100 | [diff] [blame] | 72 | uint64_t delayed_packet_outage_samples = 0; |
Fredrik Solenberg | 4f4ec0a | 2015-10-22 10:49:27 +0200 | [diff] [blame] | 73 | int32_t decoding_calls_to_silence_generator = 0; |
| 74 | int32_t decoding_calls_to_neteq = 0; |
| 75 | int32_t decoding_normal = 0; |
Alex Narest | 5b5d97c | 2019-08-07 18:15:08 +0200 | [diff] [blame] | 76 | // TODO(alexnarest): Consider decoding_neteq_plc for consistency |
Fredrik Solenberg | 4f4ec0a | 2015-10-22 10:49:27 +0200 | [diff] [blame] | 77 | int32_t decoding_plc = 0; |
Alex Narest | 5b5d97c | 2019-08-07 18:15:08 +0200 | [diff] [blame] | 78 | int32_t decoding_codec_plc = 0; |
Fredrik Solenberg | 4f4ec0a | 2015-10-22 10:49:27 +0200 | [diff] [blame] | 79 | int32_t decoding_cng = 0; |
| 80 | int32_t decoding_plc_cng = 0; |
henrik.lundin | 6348978 | 2016-09-20 01:47:12 -0700 | [diff] [blame] | 81 | int32_t decoding_muted_output = 0; |
Fredrik Solenberg | 4f4ec0a | 2015-10-22 10:49:27 +0200 | [diff] [blame] | 82 | int64_t capture_start_ntp_time_ms = 0; |
Henrik Boström | 01738c6 | 2019-04-15 17:32:00 +0200 | [diff] [blame] | 83 | // The timestamp at which the last packet was received, i.e. the time of the |
| 84 | // local clock when it was received - not the RTP timestamp of that packet. |
| 85 | // https://w3c.github.io/webrtc-stats/#dom-rtcinboundrtpstreamstats-lastpacketreceivedtimestamp |
| 86 | absl::optional<int64_t> last_packet_received_timestamp_ms; |
Ruslan Burakov | 8af8896 | 2018-11-22 17:21:10 +0100 | [diff] [blame] | 87 | uint64_t jitter_buffer_flushes = 0; |
Jakob Ivarsson | 232b3fd | 2019-03-06 09:18:40 +0100 | [diff] [blame] | 88 | double relative_packet_arrival_delay_seconds = 0.0; |
Henrik Lundin | 44125fa | 2019-04-29 17:00:46 +0200 | [diff] [blame] | 89 | int32_t interruption_count = 0; |
| 90 | int32_t total_interruption_duration_ms = 0; |
Åsa Persson | fcf79cc | 2019-10-22 15:23:44 +0200 | [diff] [blame] | 91 | // https://w3c.github.io/webrtc-stats/#dom-rtcinboundrtpstreamstats-estimatedplayouttimestamp |
| 92 | absl::optional<int64_t> estimated_playout_ntp_timestamp_ms; |
Fredrik Solenberg | 4f4ec0a | 2015-10-22 10:49:27 +0200 | [diff] [blame] | 93 | }; |
Fredrik Solenberg | 04f4931 | 2015-06-08 13:04:56 +0200 | [diff] [blame] | 94 | |
Fredrik Solenberg | 23fba1f | 2015-04-29 15:24:01 +0200 | [diff] [blame] | 95 | struct Config { |
Paulina Hensman | 11b34f4 | 2018-04-09 14:24:52 +0200 | [diff] [blame] | 96 | Config(); |
| 97 | ~Config(); |
| 98 | |
Fredrik Solenberg | 23fba1f | 2015-04-29 15:24:01 +0200 | [diff] [blame] | 99 | std::string ToString() const; |
| 100 | |
| 101 | // Receive-stream specific RTP settings. |
| 102 | struct Rtp { |
Paulina Hensman | 11b34f4 | 2018-04-09 14:24:52 +0200 | [diff] [blame] | 103 | Rtp(); |
| 104 | ~Rtp(); |
| 105 | |
Fredrik Solenberg | 23fba1f | 2015-04-29 15:24:01 +0200 | [diff] [blame] | 106 | std::string ToString() const; |
| 107 | |
| 108 | // Synchronization source (stream identifier) to be received. |
Fredrik Solenberg | 04f4931 | 2015-06-08 13:04:56 +0200 | [diff] [blame] | 109 | uint32_t remote_ssrc = 0; |
| 110 | |
| 111 | // Sender SSRC used for sending RTCP (such as receiver reports). |
| 112 | uint32_t local_ssrc = 0; |
Fredrik Solenberg | 23fba1f | 2015-04-29 15:24:01 +0200 | [diff] [blame] | 113 | |
Stefan Holmer | 3842c5c | 2016-01-12 13:55:00 +0100 | [diff] [blame] | 114 | // Enable feedback for send side bandwidth estimation. |
| 115 | // See |
| 116 | // https://tools.ietf.org/html/draft-holmer-rmcat-transport-wide-cc-extensions |
| 117 | // for details. |
| 118 | bool transport_cc = false; |
| 119 | |
solenberg | 8189b02 | 2016-06-14 12:13:00 -0700 | [diff] [blame] | 120 | // See NackConfig for description. |
| 121 | NackConfig nack; |
| 122 | |
Fredrik Solenberg | 23fba1f | 2015-04-29 15:24:01 +0200 | [diff] [blame] | 123 | // RTP header extensions used for the received stream. |
| 124 | std::vector<RtpExtension> extensions; |
| 125 | } rtp; |
Fredrik Solenberg | 04f4931 | 2015-06-08 13:04:56 +0200 | [diff] [blame] | 126 | |
solenberg | cf18b34 | 2015-10-01 08:13:42 -0700 | [diff] [blame] | 127 | Transport* rtcp_send_transport = nullptr; |
| 128 | |
Fredrik Solenberg | 8f5787a | 2018-01-11 13:52:30 +0100 | [diff] [blame] | 129 | // NetEq settings. |
Jakob Ivarsson | 647d5e6 | 2019-03-15 10:37:31 +0100 | [diff] [blame] | 130 | size_t jitter_buffer_max_packets = 200; |
Fredrik Solenberg | 8f5787a | 2018-01-11 13:52:30 +0100 | [diff] [blame] | 131 | bool jitter_buffer_fast_accelerate = false; |
Jakob Ivarsson | 10403ae | 2018-11-27 15:45:20 +0100 | [diff] [blame] | 132 | int jitter_buffer_min_delay_ms = 0; |
Jakob Ivarsson | 53eae87 | 2019-01-10 15:58:36 +0100 | [diff] [blame] | 133 | bool jitter_buffer_enable_rtx_handling = false; |
Fredrik Solenberg | 8f5787a | 2018-01-11 13:52:30 +0100 | [diff] [blame] | 134 | |
pbos | 8fc7fa7 | 2015-07-15 08:02:58 -0700 | [diff] [blame] | 135 | // Identifier for an A/V synchronization group. Empty string to disable. |
| 136 | // TODO(pbos): Synchronize streams in a sync group, not just one video |
| 137 | // stream to one audio stream. Tracked by issue webrtc:4762. |
| 138 | std::string sync_group; |
| 139 | |
kwiberg | d32bf75 | 2017-01-19 07:03:59 -0800 | [diff] [blame] | 140 | // Decoder specifications for every payload type that we can receive. |
| 141 | std::map<int, SdpAudioFormat> decoder_map; |
ossu | 29b1a8d | 2016-06-13 07:34:51 -0700 | [diff] [blame] | 142 | |
| 143 | rtc::scoped_refptr<AudioDecoderFactory> decoder_factory; |
Karl Wiberg | 0812634 | 2018-03-20 19:18:55 +0100 | [diff] [blame] | 144 | |
Danil Chapovalov | b9b146c | 2018-06-15 12:28:07 +0200 | [diff] [blame] | 145 | absl::optional<AudioCodecPairId> codec_pair_id; |
Benjamin Wright | 84583f6 | 2018-10-04 14:22:34 -0700 | [diff] [blame] | 146 | |
Benjamin Wright | bfb444c | 2018-10-15 10:20:24 -0700 | [diff] [blame] | 147 | // Per PeerConnection crypto options. |
| 148 | webrtc::CryptoOptions crypto_options; |
| 149 | |
Benjamin Wright | 84583f6 | 2018-10-04 14:22:34 -0700 | [diff] [blame] | 150 | // An optional custom frame decryptor that allows the entire frame to be |
| 151 | // decrypted in whatever way the caller choses. This is not required by |
| 152 | // default. |
| 153 | rtc::scoped_refptr<webrtc::FrameDecryptorInterface> frame_decryptor; |
Marina Ciocea | 3e9af7f | 2020-04-01 07:46:16 +0200 | [diff] [blame] | 154 | |
| 155 | // An optional frame transformer used by insertable streams to transform |
| 156 | // encoded frames. |
| 157 | rtc::scoped_refptr<webrtc::FrameTransformerInterface> frame_transformer; |
Fredrik Solenberg | 23fba1f | 2015-04-29 15:24:01 +0200 | [diff] [blame] | 158 | }; |
| 159 | |
Fredrik Solenberg | 3b903d0 | 2018-01-10 15:17:10 +0100 | [diff] [blame] | 160 | // Reconfigure the stream according to the Configuration. |
| 161 | virtual void Reconfigure(const Config& config) = 0; |
| 162 | |
pbos | 1ba8d39 | 2016-05-01 20:18:34 -0700 | [diff] [blame] | 163 | // Starts stream activity. |
| 164 | // When a stream is active, it can receive, process and deliver packets. |
| 165 | virtual void Start() = 0; |
| 166 | // Stops stream activity. |
| 167 | // When a stream is stopped, it can't receive, process or deliver packets. |
| 168 | virtual void Stop() = 0; |
| 169 | |
Fredrik Solenberg | 04f4931 | 2015-06-08 13:04:56 +0200 | [diff] [blame] | 170 | virtual Stats GetStats() const = 0; |
Tommi | f888bb5 | 2015-12-12 01:37:01 +0100 | [diff] [blame] | 171 | |
| 172 | // Sets an audio sink that receives unmixed audio from the receive stream. |
Fredrik Solenberg | 8f5787a | 2018-01-11 13:52:30 +0100 | [diff] [blame] | 173 | // Ownership of the sink is managed by the caller. |
deadbeef | 884f585 | 2016-01-15 09:20:04 -0800 | [diff] [blame] | 174 | // Only one sink can be set and passing a null sink clears an existing one. |
Tommi | f888bb5 | 2015-12-12 01:37:01 +0100 | [diff] [blame] | 175 | // NOTE: Audio must still somehow be pulled through AudioTransport for audio |
| 176 | // to stream through this sink. In practice, this happens if mixed audio |
| 177 | // is being pulled+rendered and/or if audio is being pulled for the purposes |
| 178 | // of feeding to the AEC. |
Fredrik Solenberg | 8f5787a | 2018-01-11 13:52:30 +0100 | [diff] [blame] | 179 | virtual void SetSink(AudioSinkInterface* sink) = 0; |
pbos | 1ba8d39 | 2016-05-01 20:18:34 -0700 | [diff] [blame] | 180 | |
solenberg | 217fb66 | 2016-06-17 08:30:54 -0700 | [diff] [blame] | 181 | // Sets playback gain of the stream, applied when mixing, and thus after it |
| 182 | // is potentially forwarded to any attached AudioSinkInterface implementation. |
| 183 | virtual void SetGain(float gain) = 0; |
| 184 | |
Ruslan Burakov | 3b50f9f | 2019-02-06 09:45:56 +0100 | [diff] [blame] | 185 | // Sets a base minimum for the playout delay. Base minimum delay sets lower |
| 186 | // bound on minimum delay value determining lower bound on playout delay. |
| 187 | // |
| 188 | // Returns true if value was successfully set, false overwise. |
| 189 | virtual bool SetBaseMinimumPlayoutDelayMs(int delay_ms) = 0; |
| 190 | |
| 191 | // Returns current value of base minimum delay in milliseconds. |
| 192 | virtual int GetBaseMinimumPlayoutDelayMs() const = 0; |
| 193 | |
hbos | 8d609f6 | 2017-04-10 07:39:05 -0700 | [diff] [blame] | 194 | virtual std::vector<RtpSource> GetSources() const = 0; |
| 195 | |
pbos | 1ba8d39 | 2016-05-01 20:18:34 -0700 | [diff] [blame] | 196 | protected: |
| 197 | virtual ~AudioReceiveStream() {} |
Fredrik Solenberg | 23fba1f | 2015-04-29 15:24:01 +0200 | [diff] [blame] | 198 | }; |
Fredrik Solenberg | 23fba1f | 2015-04-29 15:24:01 +0200 | [diff] [blame] | 199 | } // namespace webrtc |
| 200 | |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 201 | #endif // CALL_AUDIO_RECEIVE_STREAM_H_ |