1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
|
/*
* Copyright (c) 2019 The WebRTC project authors. All Rights Reserved.
*
* Use of this source code is governed by a BSD-style license
* that can be found in the LICENSE file in the root of the source
* tree. An additional intellectual property rights grant can be found
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
*/
#ifndef TEST_PEER_SCENARIO_PEER_SCENARIO_CLIENT_H_
#define TEST_PEER_SCENARIO_PEER_SCENARIO_CLIENT_H_
#include <functional>
#include <list>
#include <map>
#include <memory>
#include <optional>
#include <string>
#include <vector>
#include "api/audio_options.h"
#include "api/candidate.h"
#include "api/data_channel_interface.h"
#include "api/environment/environment.h"
#include "api/jsep.h"
#include "api/media_stream_interface.h"
#include "api/peer_connection_interface.h"
#include "api/rtp_receiver_interface.h"
#include "api/rtp_sender_interface.h"
#include "api/rtp_transceiver_interface.h"
#include "api/scoped_refptr.h"
#include "api/sequence_checker.h"
#include "api/test/network_emulation/network_emulation_interfaces.h"
#include "api/test/network_emulation_manager.h"
#include "api/video/video_frame.h"
#include "api/video/video_sink_interface.h"
#include "pc/test/frame_generator_capturer_video_track_source.h"
#include "rtc_base/thread.h"
#include "rtc_base/thread_annotations.h"
#include "system_wrappers/include/clock.h"
#include "test/create_frame_generator_capturer.h"
#include "test/frame_generator_capturer.h"
#include "test/logging/log_writer.h"
namespace webrtc {
namespace test {
// Wrapper for a PeerConnection for use in PeerScenario tests. It's intended to
// be a minimal wrapper for a peer connection that's simple to use in testing.
// In particular the constructor hides a lot of the required setup for a peer
// connection.
class PeerScenarioClient {
public:
struct CallbackHandlers {
std::vector<std::function<void(PeerConnectionInterface::SignalingState)>>
on_signaling_change;
std::vector<
std::function<void(webrtc::scoped_refptr<DataChannelInterface>)>>
on_data_channel;
std::vector<std::function<void()>> on_renegotiation_needed;
std::vector<
std::function<void(PeerConnectionInterface::IceConnectionState)>>
on_standardized_ice_connection_change;
std::vector<
std::function<void(PeerConnectionInterface::PeerConnectionState)>>
on_connection_change;
std::vector<std::function<void(PeerConnectionInterface::IceGatheringState)>>
on_ice_gathering_change;
std::vector<std::function<void(const IceCandidateInterface*)>>
on_ice_candidate;
std::vector<std::function<void(const std::string&,
int,
const std::string&,
int,
const std::string&)>>
on_ice_candidate_error;
std::vector<std::function<void(const std::vector<webrtc::Candidate>&)>>
on_ice_candidates_removed;
std::vector<std::function<void(
webrtc::scoped_refptr<RtpReceiverInterface>,
const std::vector<webrtc::scoped_refptr<MediaStreamInterface>>&)>>
on_add_track;
std::vector<
std::function<void(webrtc::scoped_refptr<RtpTransceiverInterface>)>>
on_track;
std::vector<
std::function<void(webrtc::scoped_refptr<RtpReceiverInterface>)>>
on_remove_track;
};
struct Config {
// WebRTC only support one audio device that is setup up on construction, so
// we provide the audio generator configuration here rather than on creation
// of the tracks. This is unlike video, where multiple capture sources can
// be used at the same time.
struct AudioSource {
int sample_rate = 48000;
int channels = 1;
struct PulsedNoise {
double amplitude = 0.1;
};
std::optional<PulsedNoise> pulsed_noise = PulsedNoise();
} audio;
struct Video {
bool use_fake_codecs = false;
} video;
// The created endpoints can be accessed using the map key as `index` in
// PeerScenarioClient::endpoint(index).
std::map<int, EmulatedEndpointConfig> endpoints = {
{0, EmulatedEndpointConfig()}};
CallbackHandlers handlers;
PeerConnectionInterface::RTCConfiguration rtc_config;
bool disable_encryption = false;
Config() { rtc_config.sdp_semantics = SdpSemantics::kUnifiedPlan; }
};
struct VideoSendTrackConfig {
FrameGeneratorCapturerConfig generator;
bool screencast = false;
};
struct AudioSendTrack {
scoped_refptr<AudioTrackInterface> track;
scoped_refptr<RtpSenderInterface> sender;
};
struct VideoSendTrack {
// Raw pointer to the capturer owned by `source`.
FrameGeneratorCapturer* capturer;
scoped_refptr<FrameGeneratorCapturerVideoTrackSource> source;
scoped_refptr<VideoTrackInterface> track;
scoped_refptr<RtpSenderInterface> sender;
};
PeerScenarioClient(
NetworkEmulationManager* net,
Thread* signaling_thread,
std::unique_ptr<LogWriterFactoryInterface> log_writer_factory,
Config config);
PeerConnectionFactoryInterface* factory() { return pc_factory_.get(); }
PeerConnectionInterface* pc() {
RTC_DCHECK_RUN_ON(signaling_thread_);
return peer_connection_.get();
}
Thread* thread() { return signaling_thread_; }
Clock* clock() { return Clock::GetRealTimeClock(); }
// Returns the endpoint created from the EmulatedEndpointConfig with the same
// index in PeerScenarioClient::config.
EmulatedEndpoint* endpoint(int index = 0);
AudioSendTrack CreateAudio(std::string track_id, AudioOptions options);
VideoSendTrack CreateVideo(std::string track_id, VideoSendTrackConfig config);
void AddVideoReceiveSink(std::string track_id,
VideoSinkInterface<VideoFrame>* video_sink);
CallbackHandlers* handlers() { return &handlers_; }
// The `munge_offer` function can be used to munge the SDP, i.e. modify a
// local description afer creating it but before setting it. Note that this is
// legacy behavior. It's added here only to be able to have test coverage for
// scenarios even if they are not spec compliant.
void CreateAndSetSdp(
std::function<void(SessionDescriptionInterface*)> munge_offer,
std::function<void(std::string)> offer_handler);
void SetSdpOfferAndGetAnswer(std::string remote_offer,
std::function<void()> remote_description_set,
std::function<void(std::string)> answer_handler);
void SetSdpAnswer(
std::string remote_answer,
std::function<void(const SessionDescriptionInterface& answer)>
done_handler);
// Adds the given ice candidate when the peer connection is ready.
void AddIceCandidate(std::unique_ptr<IceCandidateInterface> candidate);
private:
const Environment env_;
const std::map<int, EmulatedEndpoint*> endpoints_;
Thread* const signaling_thread_;
const std::unique_ptr<LogWriterFactoryInterface> log_writer_factory_;
const std::unique_ptr<Thread> worker_thread_;
CallbackHandlers handlers_ RTC_GUARDED_BY(signaling_thread_);
const std::unique_ptr<PeerConnectionObserver> observer_;
std::map<std::string, std::vector<VideoSinkInterface<VideoFrame>*>>
track_id_to_video_sinks_ RTC_GUARDED_BY(signaling_thread_);
std::list<std::unique_ptr<IceCandidateInterface>> pending_ice_candidates_
RTC_GUARDED_BY(signaling_thread_);
scoped_refptr<PeerConnectionFactoryInterface> pc_factory_;
scoped_refptr<PeerConnectionInterface> peer_connection_
RTC_GUARDED_BY(signaling_thread_);
};
} // namespace test
} // namespace webrtc
#endif // TEST_PEER_SCENARIO_PEER_SCENARIO_CLIENT_H_
|