Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2020 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 PC_CONNECTION_CONTEXT_H_ |
| 12 | #define PC_CONNECTION_CONTEXT_H_ |
| 13 | |
| 14 | #include <memory> |
| 15 | #include <string> |
| 16 | |
Danil Chapovalov | 7eaa9dc | 2023-11-27 14:00:21 | [diff] [blame] | 17 | #include "api/environment/environment.h" |
Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 18 | #include "api/media_stream_interface.h" |
| 19 | #include "api/peer_connection_interface.h" |
Tommi | 86ee89f | 2021-04-20 14:58:01 | [diff] [blame] | 20 | #include "api/ref_counted_base.h" |
Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 21 | #include "api/scoped_refptr.h" |
Artem Titov | d15a575 | 2021-02-10 13:31:24 | [diff] [blame] | 22 | #include "api/sequence_checker.h" |
Harald Alvestrand | ffd5dc7 | 2020-10-20 15:35:31 | [diff] [blame] | 23 | #include "api/transport/sctp_transport_factory_interface.h" |
Harald Alvestrand | ffd5dc7 | 2020-10-20 15:35:31 | [diff] [blame] | 24 | #include "media/base/media_engine.h" |
Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 25 | #include "p2p/base/basic_packet_socket_factory.h" |
Harald Alvestrand | ffd5dc7 | 2020-10-20 15:35:31 | [diff] [blame] | 26 | #include "rtc_base/checks.h" |
| 27 | #include "rtc_base/network.h" |
| 28 | #include "rtc_base/network_monitor_factory.h" |
Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 29 | #include "rtc_base/rtc_certificate_generator.h" |
Harald Alvestrand | c24a218 | 2022-02-23 13:44:59 | [diff] [blame] | 30 | #include "rtc_base/socket_factory.h" |
Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 31 | #include "rtc_base/thread.h" |
Harald Alvestrand | ffd5dc7 | 2020-10-20 15:35:31 | [diff] [blame] | 32 | #include "rtc_base/thread_annotations.h" |
Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 33 | |
| 34 | namespace rtc { |
Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 35 | class BasicPacketSocketFactory; |
Harald Alvestrand | c3fa7c3 | 2022-05-22 10:57:01 | [diff] [blame] | 36 | class UniqueRandomIdGenerator; |
Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 37 | } // namespace rtc |
| 38 | |
| 39 | namespace webrtc { |
| 40 | |
Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 41 | // This class contains resources needed by PeerConnection and associated |
| 42 | // objects. A reference to this object is passed to each PeerConnection. The |
| 43 | // methods on this object are assumed not to change the state in any way that |
| 44 | // interferes with the operation of other PeerConnections. |
Harald Alvestrand | ffd5dc7 | 2020-10-20 15:35:31 | [diff] [blame] | 45 | // |
| 46 | // This class must be created and destroyed on the signaling thread. |
Tommi | 86ee89f | 2021-04-20 14:58:01 | [diff] [blame] | 47 | class ConnectionContext final |
| 48 | : public rtc::RefCountedNonVirtual<ConnectionContext> { |
Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 49 | public: |
Harald Alvestrand | ffd5dc7 | 2020-10-20 15:35:31 | [diff] [blame] | 50 | // Creates a ConnectionContext. May return null if initialization fails. |
| 51 | // The Dependencies class allows simple management of all new dependencies |
| 52 | // being added to the ConnectionContext. |
| 53 | static rtc::scoped_refptr<ConnectionContext> Create( |
Danil Chapovalov | 7eaa9dc | 2023-11-27 14:00:21 | [diff] [blame] | 54 | const Environment& env, |
Harald Alvestrand | ffd5dc7 | 2020-10-20 15:35:31 | [diff] [blame] | 55 | PeerConnectionFactoryDependencies* dependencies); |
| 56 | |
Harald Alvestrand | 4244b5f | 2020-10-15 12:57:05 | [diff] [blame] | 57 | // This class is not copyable or movable. |
| 58 | ConnectionContext(const ConnectionContext&) = delete; |
| 59 | ConnectionContext& operator=(const ConnectionContext&) = delete; |
| 60 | |
Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 61 | // Functions called from PeerConnection and friends |
| 62 | SctpTransportFactoryInterface* sctp_transport_factory() const { |
Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 63 | return sctp_factory_.get(); |
| 64 | } |
| 65 | |
Harald Alvestrand | c3fa7c3 | 2022-05-22 10:57:01 | [diff] [blame] | 66 | cricket::MediaEngineInterface* media_engine() const { |
| 67 | return media_engine_.get(); |
| 68 | } |
Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 69 | |
Harald Alvestrand | 4244b5f | 2020-10-15 12:57:05 | [diff] [blame] | 70 | rtc::Thread* signaling_thread() { return signaling_thread_; } |
| 71 | const rtc::Thread* signaling_thread() const { return signaling_thread_; } |
Harald Alvestrand | 00579e8 | 2022-05-03 11:37:34 | [diff] [blame] | 72 | rtc::Thread* worker_thread() { return worker_thread_.get(); } |
| 73 | const rtc::Thread* worker_thread() const { return worker_thread_.get(); } |
Harald Alvestrand | 4244b5f | 2020-10-15 12:57:05 | [diff] [blame] | 74 | rtc::Thread* network_thread() { return network_thread_; } |
| 75 | const rtc::Thread* network_thread() const { return network_thread_; } |
Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 76 | |
Danil Chapovalov | 3bdb49b | 2023-11-30 07:59:39 | [diff] [blame] | 77 | // Environment associated with the PeerConnectionFactory. |
| 78 | // Note: environments are different for different PeerConnections, |
| 79 | // but they are not supposed to change after creating the PeerConnection. |
| 80 | const Environment& env() const { return env_; } |
| 81 | |
Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 82 | // Accessors only used from the PeerConnectionFactory class |
Niels Möller | dcb5a58 | 2022-06-20 13:33:59 | [diff] [blame] | 83 | rtc::NetworkManager* default_network_manager() { |
Harald Alvestrand | 4244b5f | 2020-10-15 12:57:05 | [diff] [blame] | 84 | RTC_DCHECK_RUN_ON(signaling_thread_); |
Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 85 | return default_network_manager_.get(); |
| 86 | } |
Niels Möller | 573b145 | 2022-06-21 09:37:29 | [diff] [blame] | 87 | rtc::PacketSocketFactory* default_socket_factory() { |
Harald Alvestrand | 4244b5f | 2020-10-15 12:57:05 | [diff] [blame] | 88 | RTC_DCHECK_RUN_ON(signaling_thread_); |
Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 89 | return default_socket_factory_.get(); |
| 90 | } |
Danil Chapovalov | fe66dda | 2023-12-04 11:05:38 | [diff] [blame] | 91 | MediaFactory* call_factory() { |
Harald Alvestrand | 00579e8 | 2022-05-03 11:37:34 | [diff] [blame] | 92 | RTC_DCHECK_RUN_ON(worker_thread()); |
Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 93 | return call_factory_.get(); |
| 94 | } |
Harald Alvestrand | c3fa7c3 | 2022-05-22 10:57:01 | [diff] [blame] | 95 | rtc::UniqueRandomIdGenerator* ssrc_generator() { return &ssrc_generator_; } |
| 96 | // Note: There is lots of code that wants to know whether or not we |
| 97 | // use RTX, but so far, no code has been found that sets it to false. |
| 98 | // Kept in the API in order to ease introduction if we want to resurrect |
| 99 | // the functionality. |
Joachim Reiersen | 45a985c | 2023-08-24 17:00:01 | [diff] [blame] | 100 | bool use_rtx() { return use_rtx_; } |
| 101 | |
| 102 | // For use by tests. |
| 103 | void set_use_rtx(bool use_rtx) { use_rtx_ = use_rtx; } |
Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 104 | |
| 105 | protected: |
Danil Chapovalov | 7eaa9dc | 2023-11-27 14:00:21 | [diff] [blame] | 106 | ConnectionContext(const Environment& env, |
| 107 | PeerConnectionFactoryDependencies* dependencies); |
Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 108 | |
Tommi | 86ee89f | 2021-04-20 14:58:01 | [diff] [blame] | 109 | friend class rtc::RefCountedNonVirtual<ConnectionContext>; |
| 110 | ~ConnectionContext(); |
Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 111 | |
| 112 | private: |
Harald Alvestrand | 4244b5f | 2020-10-15 12:57:05 | [diff] [blame] | 113 | // The following three variables are used to communicate between the |
| 114 | // constructor and the destructor, and are never exposed externally. |
Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 115 | bool wraps_current_thread_; |
Niels Möller | b02e1ac | 2022-02-04 13:29:50 | [diff] [blame] | 116 | std::unique_ptr<rtc::SocketFactory> owned_socket_factory_; |
Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 117 | std::unique_ptr<rtc::Thread> owned_network_thread_ |
Harald Alvestrand | 4244b5f | 2020-10-15 12:57:05 | [diff] [blame] | 118 | RTC_GUARDED_BY(signaling_thread_); |
Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 119 | rtc::Thread* const network_thread_; |
Harald Alvestrand | 00579e8 | 2022-05-03 11:37:34 | [diff] [blame] | 120 | AlwaysValidPointer<rtc::Thread> const worker_thread_; |
Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 121 | rtc::Thread* const signaling_thread_; |
Jonas Oreland | ed99dae | 2022-03-09 08:28:10 | [diff] [blame] | 122 | |
Danil Chapovalov | 7eaa9dc | 2023-11-27 14:00:21 | [diff] [blame] | 123 | const Environment env_; |
Jonas Oreland | ed99dae | 2022-03-09 08:28:10 | [diff] [blame] | 124 | |
Peter Hanspers | 3e1e831 | 2023-09-05 15:55:34 | [diff] [blame] | 125 | // This object is const over the lifetime of the ConnectionContext, and is |
| 126 | // only altered in the destructor. |
| 127 | std::unique_ptr<cricket::MediaEngineInterface> media_engine_; |
Harald Alvestrand | 0ac50b9 | 2022-05-18 07:51:34 | [diff] [blame] | 128 | |
| 129 | // This object should be used to generate any SSRC that is not explicitly |
| 130 | // specified by the user (or by the remote party). |
| 131 | // TODO(bugs.webrtc.org/12666): This variable is used from both the signaling |
| 132 | // and worker threads. See if we can't restrict usage to a single thread. |
| 133 | rtc::UniqueRandomIdGenerator ssrc_generator_; |
Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 134 | std::unique_ptr<rtc::NetworkMonitorFactory> const network_monitor_factory_ |
Harald Alvestrand | 4244b5f | 2020-10-15 12:57:05 | [diff] [blame] | 135 | RTC_GUARDED_BY(signaling_thread_); |
Niels Möller | dcb5a58 | 2022-06-20 13:33:59 | [diff] [blame] | 136 | std::unique_ptr<rtc::NetworkManager> default_network_manager_ |
Harald Alvestrand | 4244b5f | 2020-10-15 12:57:05 | [diff] [blame] | 137 | RTC_GUARDED_BY(signaling_thread_); |
Danil Chapovalov | fe66dda | 2023-12-04 11:05:38 | [diff] [blame] | 138 | std::unique_ptr<MediaFactory> const call_factory_ |
Harald Alvestrand | 00579e8 | 2022-05-03 11:37:34 | [diff] [blame] | 139 | RTC_GUARDED_BY(worker_thread()); |
Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 140 | |
Niels Möller | 573b145 | 2022-06-21 09:37:29 | [diff] [blame] | 141 | std::unique_ptr<rtc::PacketSocketFactory> default_socket_factory_ |
Harald Alvestrand | 4244b5f | 2020-10-15 12:57:05 | [diff] [blame] | 142 | RTC_GUARDED_BY(signaling_thread_); |
Tommi | c3257d0 | 2021-02-10 17:40:08 | [diff] [blame] | 143 | std::unique_ptr<SctpTransportFactoryInterface> const sctp_factory_; |
Joachim Reiersen | 45a985c | 2023-08-24 17:00:01 | [diff] [blame] | 144 | |
| 145 | // Controls whether to announce support for the the rfc4588 payload format |
| 146 | // for retransmitted video packets. |
| 147 | bool use_rtx_; |
Harald Alvestrand | a39689c | 2020-10-15 08:34:31 | [diff] [blame] | 148 | }; |
| 149 | |
| 150 | } // namespace webrtc |
| 151 | |
| 152 | #endif // PC_CONNECTION_CONTEXT_H_ |