Configurable webrtcSTUNGatherTimeout (#4221)

apidocs/openapi.yaml

@@ -290,6 +290,8 @@ components:
           type: string
         webrtcTrackGatherTimeout:
           type: string
+        webrtcSTUNGatherTimeout:
+          type: string
 
         # SRT server
         srt:

internal/conf/conf.go

@@ -280,6 +280,7 @@ type Conf struct {
 	WebRTCICEServers2           WebRTCICEServers `json:"webrtcICEServers2"`
 	WebRTCHandshakeTimeout      Duration         `json:"webrtcHandshakeTimeout"`
 	WebRTCTrackGatherTimeout    Duration         `json:"webrtcTrackGatherTimeout"`
+	WebRTCSTUNGatherTimeout     Duration         `json:"webrtcSTUNGatherTimeout"`
 	WebRTCICEUDPMuxAddress      *string          `json:"webrtcICEUDPMuxAddress,omitempty"`  // deprecated
 	WebRTCICETCPMuxAddress      *string          `json:"webrtcICETCPMuxAddress,omitempty"`  // deprecated
 	WebRTCICEHostNAT1To1IPs     *[]string        `json:"webrtcICEHostNAT1To1IPs,omitempty"` // deprecated
@@ -405,6 +406,7 @@ func (conf *Conf) setDefaults() {
 	conf.WebRTCICEServers2 = []WebRTCICEServer{}
 	conf.WebRTCHandshakeTimeout = 10 * Duration(time.Second)
 	conf.WebRTCTrackGatherTimeout = 2 * Duration(time.Second)
+	conf.WebRTCSTUNGatherTimeout = 5 * Duration(time.Second)
 
 	// SRT server
 	conf.SRT = true

internal/core/core.go

@@ -549,6 +549,7 @@ func (p *Core) createResources(initial bool) error {
 			AdditionalHosts:       p.conf.WebRTCAdditionalHosts,
 			ICEServers:            p.conf.WebRTCICEServers2,
 			HandshakeTimeout:      p.conf.WebRTCHandshakeTimeout,
+			STUNGatherTimeout:     p.conf.WebRTCSTUNGatherTimeout,
 			TrackGatherTimeout:    p.conf.WebRTCTrackGatherTimeout,
 			ExternalCmdPool:       p.externalCmdPool,
 			PathManager:           p.pathManager,
@@ -816,6 +817,7 @@ func (p *Core) closeResources(newConf *conf.Conf, calledByAPI bool) {
 		!reflect.DeepEqual(newConf.WebRTCAdditionalHosts, p.conf.WebRTCAdditionalHosts) ||
 		!reflect.DeepEqual(newConf.WebRTCICEServers2, p.conf.WebRTCICEServers2) ||
 		newConf.WebRTCHandshakeTimeout != p.conf.WebRTCHandshakeTimeout ||
+		newConf.WebRTCSTUNGatherTimeout != p.conf.WebRTCSTUNGatherTimeout ||
 		newConf.WebRTCTrackGatherTimeout != p.conf.WebRTCTrackGatherTimeout ||
 		closeMetrics ||
 		closePathManager ||

internal/protocols/webrtc/peer_connection.go

@@ -74,6 +74,7 @@ type PeerConnection struct {
 	ICETCPMux             ice.TCPMux
 	HandshakeTimeout      conf.Duration
 	TrackGatherTimeout    conf.Duration
+	STUNGatherTimeout     conf.Duration
 	LocalRandomUDP        bool
 	IPsFromInterfaces     bool
 	IPsFromInterfacesList []string
@@ -136,6 +137,7 @@ func (co *PeerConnection) Start() error {
 	}
 
 	settingsEngine.SetNetworkTypes(networkTypes)
+	settingsEngine.SetSTUNGatherTimeout(time.Duration(co.STUNGatherTimeout))
 
 	mediaEngine := &webrtc.MediaEngine{}
 

internal/protocols/webrtc/peer_connection_test.go

@@ -16,6 +16,7 @@ func TestPeerConnectionCloseImmediately(t *testing.T) {
 	pc := &PeerConnection{
 		HandshakeTimeout:   conf.Duration(10 * time.Second),
 		TrackGatherTimeout: conf.Duration(2 * time.Second),
+		STUNGatherTimeout:  conf.Duration(5 * time.Second),
 		LocalRandomUDP:     true,
 		IPsFromInterfaces:  true,
 		Publish:            false,

internal/servers/webrtc/server.go

@@ -190,6 +190,7 @@ type Server struct {
 	ICEServers            []conf.WebRTCICEServer
 	HandshakeTimeout      conf.Duration
 	TrackGatherTimeout    conf.Duration
+	STUNGatherTimeout     conf.Duration
 	ExternalCmdPool       *externalcmd.Pool
 	PathManager           serverPathManager
 	Parent                serverParent

internal/servers/webrtc/server_test.go

@@ -99,6 +99,7 @@ func initializeTestServer(t *testing.T) *Server {
 		ICEServers:            []conf.WebRTCICEServer{},
 		HandshakeTimeout:      conf.Duration(10 * time.Second),
 		TrackGatherTimeout:    conf.Duration(2 * time.Second),
+		STUNGatherTimeout:     conf.Duration(5 * time.Second),
 		ExternalCmdPool:       nil,
 		PathManager:           pm,
 		Parent:                test.NilLogger,
@@ -187,6 +188,7 @@ func TestServerOptionsICEServer(t *testing.T) {
 		}},
 		HandshakeTimeout:   conf.Duration(10 * time.Second),
 		TrackGatherTimeout: conf.Duration(2 * time.Second),
+		STUNGatherTimeout:  conf.Duration(5 * time.Second),
 		ExternalCmdPool:    nil,
 		PathManager:        pathManager,
 		Parent:             test.NilLogger,
@@ -257,6 +259,7 @@ func TestServerPublish(t *testing.T) {
 		ICEServers:            []conf.WebRTCICEServer{},
 		HandshakeTimeout:      conf.Duration(10 * time.Second),
 		TrackGatherTimeout:    conf.Duration(2 * time.Second),
+		STUNGatherTimeout:     conf.Duration(5 * time.Second),
 		ExternalCmdPool:       nil,
 		PathManager:           pathManager,
 		Parent:                test.NilLogger,
@@ -544,6 +547,7 @@ func TestServerRead(t *testing.T) {
 				ICEServers:            []conf.WebRTCICEServer{},
 				HandshakeTimeout:      conf.Duration(10 * time.Second),
 				TrackGatherTimeout:    conf.Duration(2 * time.Second),
+				STUNGatherTimeout:     conf.Duration(5 * time.Second),
 				ExternalCmdPool:       nil,
 				PathManager:           pathManager,
 				Parent:                test.NilLogger,
@@ -632,6 +636,7 @@ func TestServerReadNotFound(t *testing.T) {
 		ICEServers:            []conf.WebRTCICEServer{},
 		HandshakeTimeout:      conf.Duration(10 * time.Second),
 		TrackGatherTimeout:    conf.Duration(2 * time.Second),
+		STUNGatherTimeout:     conf.Duration(5 * time.Second),
 		ExternalCmdPool:       nil,
 		PathManager:           pm,
 		Parent:                test.NilLogger,

internal/servers/webrtc/session.go

@@ -154,6 +154,7 @@ func (s *session) runPublish() (int, error) {
 		ICEServers:            iceServers,
 		HandshakeTimeout:      s.parent.HandshakeTimeout,
 		TrackGatherTimeout:    s.parent.TrackGatherTimeout,
+		STUNGatherTimeout:     s.parent.STUNGatherTimeout,
 		IPsFromInterfaces:     s.ipsFromInterfaces,
 		IPsFromInterfacesList: s.ipsFromInterfacesList,
 		AdditionalHosts:       s.additionalHosts,
@@ -271,6 +272,7 @@ func (s *session) runRead() (int, error) {
 		ICEServers:            iceServers,
 		HandshakeTimeout:      s.parent.HandshakeTimeout,
 		TrackGatherTimeout:    s.parent.TrackGatherTimeout,
+		STUNGatherTimeout:     s.parent.STUNGatherTimeout,
 		IPsFromInterfaces:     s.ipsFromInterfaces,
 		IPsFromInterfacesList: s.ipsFromInterfacesList,
 		AdditionalHosts:       s.additionalHosts,

internal/staticsources/webrtc/source_test.go

@@ -41,6 +41,7 @@ func TestSource(t *testing.T) {
 		Publish:            true,
 		HandshakeTimeout:   conf.Duration(10 * time.Second),
 		TrackGatherTimeout: conf.Duration(2 * time.Second),
+		STUNGatherTimeout:  conf.Duration(5 * time.Second),
 		OutgoingTracks:     outgoingTracks,
 		Log:                test.NilLogger,
 	}

mediamtx.yml

@@ -387,6 +387,8 @@ webrtcICEServers2: []
 webrtcHandshakeTimeout: 10s
 # Maximum time to gather video tracks.
 webrtcTrackGatherTimeout: 2s
+# The maximum time to gather STUN candidates.
+webrtcSTUNGatherTimeout: 5s
 
 ###############################################
 # Global settings -> SRT server