863 lines
35 KiB
Swift
863 lines
35 KiB
Swift
//
|
|
// Copyright (c) 2017 Open Whisper Systems. All rights reserved.
|
|
//
|
|
|
|
import Foundation
|
|
import PromiseKit
|
|
import WebRTC
|
|
import SignalServiceKit
|
|
|
|
// HACK - Seeing crazy SEGFAULTs on iOS9 when accessing these objc externs.
|
|
// iOS10 seems unaffected. Reproducible for ~1 in 3 calls.
|
|
// Binding them to a file constant seems to work around the problem.
|
|
let kAudioTrackType = kRTCMediaStreamTrackKindAudio
|
|
let kVideoTrackType = kRTCMediaStreamTrackKindVideo
|
|
let kMediaConstraintsMinWidth = kRTCMediaConstraintsMinWidth
|
|
let kMediaConstraintsMaxWidth = kRTCMediaConstraintsMaxWidth
|
|
let kMediaConstraintsMinHeight = kRTCMediaConstraintsMinHeight
|
|
let kMediaConstraintsMaxHeight = kRTCMediaConstraintsMaxHeight
|
|
|
|
/**
|
|
* The PeerConnectionClient notifies it's delegate (the CallService) of key events in the call signaling life cycle
|
|
*
|
|
* The delegate's methods will always be called on the main thread.
|
|
*/
|
|
protocol PeerConnectionClientDelegate: class {
|
|
|
|
/**
|
|
* The connection has been established. The clients can now communicate.
|
|
*/
|
|
func peerConnectionClientIceConnected(_ peerconnectionClient: PeerConnectionClient)
|
|
|
|
/**
|
|
* The connection failed to establish. The clients will not be able to communicate.
|
|
*/
|
|
func peerConnectionClientIceFailed(_ peerconnectionClient: PeerConnectionClient)
|
|
|
|
/**
|
|
* During the Signaling process each client generates IceCandidates locally, which contain information about how to
|
|
* reach the local client via the internet. The delegate must shuttle these IceCandates to the other (remote) client
|
|
* out of band, as part of establishing a connection over WebRTC.
|
|
*/
|
|
func peerConnectionClient(_ peerconnectionClient: PeerConnectionClient, addedLocalIceCandidate iceCandidate: RTCIceCandidate)
|
|
|
|
/**
|
|
* Once the peerconnection is established, we can receive messages via the data channel, and notify the delegate.
|
|
*/
|
|
func peerConnectionClient(_ peerconnectionClient: PeerConnectionClient, received dataChannelMessage: OWSWebRTCProtosData)
|
|
|
|
/**
|
|
* Fired whenever the local video track become active or inactive.
|
|
*/
|
|
func peerConnectionClient(_ peerconnectionClient: PeerConnectionClient, didUpdateLocal videoTrack: RTCVideoTrack?)
|
|
|
|
/**
|
|
* Fired whenever the remote video track become active or inactive.
|
|
*/
|
|
func peerConnectionClient(_ peerconnectionClient: PeerConnectionClient, didUpdateRemote videoTrack: RTCVideoTrack?)
|
|
}
|
|
|
|
/**
|
|
* `PeerConnectionClient` is our interface to WebRTC.
|
|
*
|
|
* It is primarily a wrapper around `RTCPeerConnection`, which is responsible for sending and receiving our call data
|
|
* including audio, video, and some post-connected signaling (hangup, add video)
|
|
*/
|
|
class PeerConnectionClient: NSObject, RTCPeerConnectionDelegate, RTCDataChannelDelegate {
|
|
|
|
let TAG = "[PeerConnectionClient]"
|
|
enum Identifiers: String {
|
|
case mediaStream = "ARDAMS",
|
|
videoTrack = "ARDAMSv0",
|
|
audioTrack = "ARDAMSa0",
|
|
dataChannelSignaling = "signaling"
|
|
}
|
|
|
|
// A state in this class should only be accessed on this queue in order to
|
|
// serialize access.
|
|
//
|
|
// This queue is also used to perform expensive calls to the WebRTC API.
|
|
private static let signalingQueue = DispatchQueue(label: "CallServiceSignalingQueue")
|
|
|
|
// Delegate is notified of key events in the call lifecycle.
|
|
private weak var delegate: PeerConnectionClientDelegate!
|
|
|
|
func setDelegate(delegate: PeerConnectionClientDelegate?) {
|
|
PeerConnectionClient.signalingQueue.async {
|
|
self.delegate = delegate
|
|
}
|
|
}
|
|
|
|
// Connection
|
|
|
|
private var peerConnection: RTCPeerConnection!
|
|
private let iceServers: [RTCIceServer]
|
|
private let connectionConstraints: RTCMediaConstraints
|
|
private let configuration: RTCConfiguration
|
|
private let factory = RTCPeerConnectionFactory()
|
|
|
|
// DataChannel
|
|
|
|
private var dataChannel: RTCDataChannel?
|
|
|
|
// Audio
|
|
|
|
private var audioSender: RTCRtpSender?
|
|
private var audioTrack: RTCAudioTrack?
|
|
private var audioConstraints: RTCMediaConstraints
|
|
|
|
// Video
|
|
|
|
private var videoCaptureSession: AVCaptureSession?
|
|
private var videoSender: RTCRtpSender?
|
|
private var localVideoTrack: RTCVideoTrack?
|
|
// RTCVideoTrack is fragile and prone to throwing exceptions and/or
|
|
// causing deadlock in its destructor. Therefore we take great care
|
|
// with this property.
|
|
//
|
|
// We synchronize access to this property and ensure that we never
|
|
// set or use a strong reference to the remote video track if
|
|
// peerConnection is nil.
|
|
private var remoteVideoTrack: RTCVideoTrack?
|
|
private var cameraConstraints: RTCMediaConstraints
|
|
|
|
init(iceServers: [RTCIceServer], delegate: PeerConnectionClientDelegate, callDirection: CallDirection, useTurnOnly: Bool) {
|
|
AssertIsOnMainThread()
|
|
|
|
self.iceServers = iceServers
|
|
self.delegate = delegate
|
|
|
|
configuration = RTCConfiguration()
|
|
configuration.iceServers = iceServers
|
|
configuration.bundlePolicy = .maxBundle
|
|
configuration.rtcpMuxPolicy = .require
|
|
if useTurnOnly {
|
|
Logger.debug("\(TAG) using iceTransportPolicy: relay")
|
|
configuration.iceTransportPolicy = .relay
|
|
} else {
|
|
Logger.debug("\(TAG) using iceTransportPolicy: default")
|
|
}
|
|
|
|
let connectionConstraintsDict = ["DtlsSrtpKeyAgreement": "true"]
|
|
connectionConstraints = RTCMediaConstraints(mandatoryConstraints: nil, optionalConstraints: connectionConstraintsDict)
|
|
|
|
audioConstraints = RTCMediaConstraints(mandatoryConstraints: nil, optionalConstraints:nil)
|
|
cameraConstraints = RTCMediaConstraints(mandatoryConstraints: nil, optionalConstraints: nil)
|
|
|
|
super.init()
|
|
|
|
peerConnection = factory.peerConnection(with: configuration,
|
|
constraints: connectionConstraints,
|
|
delegate: self)
|
|
createAudioSender()
|
|
createVideoSender()
|
|
|
|
if callDirection == .outgoing {
|
|
// When placing an outgoing call, it's our responsibility to create the DataChannel.
|
|
// Recipient will not have to do this explicitly.
|
|
createSignalingDataChannel()
|
|
}
|
|
}
|
|
|
|
// MARK: - Media Streams
|
|
|
|
private func createSignalingDataChannel() {
|
|
AssertIsOnMainThread()
|
|
|
|
let configuration = RTCDataChannelConfiguration()
|
|
// Insist upon an "ordered" TCP data channel for delivery reliability.
|
|
configuration.isOrdered = true
|
|
let dataChannel = peerConnection.dataChannel(forLabel: Identifiers.dataChannelSignaling.rawValue,
|
|
configuration: configuration)
|
|
dataChannel.delegate = self
|
|
|
|
assert(self.dataChannel == nil)
|
|
self.dataChannel = dataChannel
|
|
}
|
|
|
|
// MARK: Video
|
|
|
|
fileprivate func createVideoSender() {
|
|
AssertIsOnMainThread()
|
|
|
|
Logger.debug("\(TAG) in \(#function)")
|
|
assert(self.videoSender == nil, "\(#function) should only be called once.")
|
|
|
|
guard !Platform.isSimulator else {
|
|
Logger.warn("\(TAG) Refusing to create local video track on simulator which has no capture device.")
|
|
return
|
|
}
|
|
|
|
// TODO: We could cap the maximum video size.
|
|
let cameraConstraints = RTCMediaConstraints(mandatoryConstraints:nil,
|
|
optionalConstraints:nil)
|
|
|
|
// TODO: Revisit the cameraConstraints.
|
|
let videoSource = factory.avFoundationVideoSource(with: cameraConstraints)
|
|
self.videoCaptureSession = videoSource.captureSession
|
|
videoSource.useBackCamera = false
|
|
|
|
let localVideoTrack = factory.videoTrack(with: videoSource, trackId: Identifiers.videoTrack.rawValue)
|
|
self.localVideoTrack = localVideoTrack
|
|
|
|
// Disable by default until call is connected.
|
|
// FIXME - do we require mic permissions at this point?
|
|
// if so maybe it would be better to not even add the track until the call is connected
|
|
// instead of creating it and disabling it.
|
|
localVideoTrack.isEnabled = false
|
|
|
|
let videoSender = peerConnection.sender(withKind: kVideoTrackType, streamId: Identifiers.mediaStream.rawValue)
|
|
videoSender.track = localVideoTrack
|
|
self.videoSender = videoSender
|
|
}
|
|
|
|
public func setLocalVideoEnabled(enabled: Bool) {
|
|
AssertIsOnMainThread()
|
|
|
|
PeerConnectionClient.signalingQueue.async {
|
|
guard self.peerConnection != nil else {
|
|
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client")
|
|
return
|
|
}
|
|
guard let localVideoTrack = self.localVideoTrack else {
|
|
let action = enabled ? "enable" : "disable"
|
|
Logger.error("\(self.TAG)) trying to \(action) videoTrack which doesn't exist")
|
|
return
|
|
}
|
|
guard let videoCaptureSession = self.videoCaptureSession else {
|
|
Logger.debug("\(self.TAG) videoCaptureSession was unexpectedly nil")
|
|
return
|
|
}
|
|
|
|
localVideoTrack.isEnabled = enabled
|
|
|
|
if enabled {
|
|
Logger.debug("\(self.TAG) in \(#function) starting videoCaptureSession")
|
|
videoCaptureSession.startRunning()
|
|
} else {
|
|
Logger.debug("\(self.TAG) in \(#function) stopping videoCaptureSession")
|
|
videoCaptureSession.stopRunning()
|
|
}
|
|
|
|
if let delegate = self.delegate {
|
|
DispatchQueue.main.async { [weak self, weak localVideoTrack] in
|
|
guard let strongSelf = self else { return }
|
|
guard let strongLocalVideoTrack = localVideoTrack else { return }
|
|
delegate.peerConnectionClient(strongSelf, didUpdateLocal: enabled ? strongLocalVideoTrack : nil)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// MARK: Audio
|
|
|
|
fileprivate func createAudioSender() {
|
|
AssertIsOnMainThread()
|
|
|
|
Logger.debug("\(TAG) in \(#function)")
|
|
assert(self.audioSender == nil, "\(#function) should only be called once.")
|
|
|
|
let audioSource = factory.audioSource(with: self.audioConstraints)
|
|
|
|
let audioTrack = factory.audioTrack(with: audioSource, trackId: Identifiers.audioTrack.rawValue)
|
|
self.audioTrack = audioTrack
|
|
|
|
// Disable by default until call is connected.
|
|
// FIXME - do we require mic permissions at this point?
|
|
// if so maybe it would be better to not even add the track until the call is connected
|
|
// instead of creating it and disabling it.
|
|
audioTrack.isEnabled = false
|
|
|
|
let audioSender = peerConnection.sender(withKind: kAudioTrackType, streamId: Identifiers.mediaStream.rawValue)
|
|
audioSender.track = audioTrack
|
|
self.audioSender = audioSender
|
|
}
|
|
|
|
public func setAudioEnabled(enabled: Bool) {
|
|
AssertIsOnMainThread()
|
|
|
|
PeerConnectionClient.signalingQueue.async {
|
|
guard self.peerConnection != nil else {
|
|
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client")
|
|
return
|
|
}
|
|
guard let audioTrack = self.audioTrack else {
|
|
let action = enabled ? "enable" : "disable"
|
|
Logger.error("\(self.TAG) trying to \(action) audioTrack which doesn't exist.")
|
|
return
|
|
}
|
|
|
|
audioTrack.isEnabled = enabled
|
|
}
|
|
}
|
|
|
|
// MARK: - Session negotiation
|
|
|
|
private var defaultOfferConstraints: RTCMediaConstraints {
|
|
let mandatoryConstraints = [
|
|
"OfferToReceiveAudio": "true",
|
|
"OfferToReceiveVideo": "true"
|
|
]
|
|
return RTCMediaConstraints(mandatoryConstraints:mandatoryConstraints, optionalConstraints:nil)
|
|
}
|
|
|
|
public func createOffer() -> Promise<HardenedRTCSessionDescription> {
|
|
AssertIsOnMainThread()
|
|
|
|
return Promise { fulfill, reject in
|
|
AssertIsOnMainThread()
|
|
|
|
PeerConnectionClient.signalingQueue.async {
|
|
guard self.peerConnection != nil else {
|
|
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client")
|
|
reject(NSError(domain:"Obsolete client", code:0, userInfo:nil))
|
|
return
|
|
}
|
|
|
|
self.peerConnection.offer(for: self.defaultOfferConstraints, completionHandler: { (sdp: RTCSessionDescription?, error: Error?) in
|
|
PeerConnectionClient.signalingQueue.async {
|
|
guard self.peerConnection != nil else {
|
|
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client")
|
|
reject(NSError(domain:"Obsolete client", code:0, userInfo:nil))
|
|
return
|
|
}
|
|
guard error == nil else {
|
|
reject(error!)
|
|
return
|
|
}
|
|
|
|
guard let sessionDescription = sdp else {
|
|
Logger.error("\(self.TAG) No session description was obtained, even though there was no error reported.")
|
|
let error = OWSErrorMakeUnableToProcessServerResponseError()
|
|
reject(error)
|
|
return
|
|
}
|
|
|
|
fulfill(HardenedRTCSessionDescription(rtcSessionDescription: sessionDescription))
|
|
}
|
|
})
|
|
}
|
|
}
|
|
}
|
|
|
|
public func setLocalSessionDescriptionInternal(_ sessionDescription: HardenedRTCSessionDescription) -> Promise<Void> {
|
|
return PromiseKit.wrap { resolve in
|
|
self.assertOnSignalingQueue()
|
|
Logger.verbose("\(self.TAG) setting local session description: \(sessionDescription)")
|
|
self.peerConnection.setLocalDescription(sessionDescription.rtcSessionDescription, completionHandler:resolve)
|
|
}
|
|
}
|
|
|
|
public func setLocalSessionDescription(_ sessionDescription: HardenedRTCSessionDescription) -> Promise<Void> {
|
|
AssertIsOnMainThread()
|
|
|
|
return Promise { fulfill, reject in
|
|
PeerConnectionClient.signalingQueue.async {
|
|
guard self.peerConnection != nil else {
|
|
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client")
|
|
reject(NSError(domain:"Obsolete client", code:0, userInfo:nil))
|
|
return
|
|
}
|
|
Logger.verbose("\(self.TAG) setting local session description: \(sessionDescription)")
|
|
self.peerConnection.setLocalDescription(sessionDescription.rtcSessionDescription,
|
|
completionHandler: { error in
|
|
guard error == nil else {
|
|
reject(error!)
|
|
return
|
|
}
|
|
fulfill()
|
|
})
|
|
}
|
|
}
|
|
}
|
|
|
|
public func negotiateSessionDescription(remoteDescription: RTCSessionDescription, constraints: RTCMediaConstraints) -> Promise<HardenedRTCSessionDescription> {
|
|
AssertIsOnMainThread()
|
|
|
|
return setRemoteSessionDescription(remoteDescription)
|
|
.then(on: PeerConnectionClient.signalingQueue) {
|
|
return self.negotiateAnswerSessionDescription(constraints: constraints)
|
|
}
|
|
}
|
|
|
|
public func setRemoteSessionDescription(_ sessionDescription: RTCSessionDescription) -> Promise<Void> {
|
|
AssertIsOnMainThread()
|
|
|
|
return Promise { fulfill, reject in
|
|
PeerConnectionClient.signalingQueue.async {
|
|
guard self.peerConnection != nil else {
|
|
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client")
|
|
reject(NSError(domain:"Obsolete client", code:0, userInfo:nil))
|
|
return
|
|
}
|
|
Logger.verbose("\(self.TAG) setting remote description: \(sessionDescription)")
|
|
self.peerConnection.setRemoteDescription(sessionDescription,
|
|
completionHandler: { error in
|
|
guard error == nil else {
|
|
reject(error!)
|
|
return
|
|
}
|
|
fulfill()
|
|
})
|
|
}
|
|
}
|
|
}
|
|
|
|
private func negotiateAnswerSessionDescription(constraints: RTCMediaConstraints) -> Promise<HardenedRTCSessionDescription> {
|
|
assertOnSignalingQueue()
|
|
|
|
return Promise { fulfill, reject in
|
|
assertOnSignalingQueue()
|
|
|
|
guard self.peerConnection != nil else {
|
|
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client")
|
|
reject(NSError(domain:"Obsolete client", code:0, userInfo:nil))
|
|
return
|
|
}
|
|
|
|
Logger.debug("\(self.TAG) negotiating answer session.")
|
|
|
|
peerConnection.answer(for: constraints, completionHandler: { (sdp: RTCSessionDescription?, error: Error?) in
|
|
PeerConnectionClient.signalingQueue.async {
|
|
guard self.peerConnection != nil else {
|
|
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client")
|
|
reject(NSError(domain:"Obsolete client", code:0, userInfo:nil))
|
|
return
|
|
}
|
|
guard error == nil else {
|
|
reject(error!)
|
|
return
|
|
}
|
|
|
|
guard let sessionDescription = sdp else {
|
|
Logger.error("\(self.TAG) unexpected empty session description, even though no error was reported.")
|
|
let error = OWSErrorMakeUnableToProcessServerResponseError()
|
|
reject(error)
|
|
return
|
|
}
|
|
|
|
let hardenedSessionDescription = HardenedRTCSessionDescription(rtcSessionDescription: sessionDescription)
|
|
|
|
self.setLocalSessionDescriptionInternal(hardenedSessionDescription)
|
|
.then(on: PeerConnectionClient.signalingQueue) {
|
|
fulfill(hardenedSessionDescription)
|
|
}.catch { error in
|
|
reject(error)
|
|
}
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
public func addRemoteIceCandidate(_ candidate: RTCIceCandidate) {
|
|
PeerConnectionClient.signalingQueue.async {
|
|
guard self.peerConnection != nil else {
|
|
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client")
|
|
return
|
|
}
|
|
Logger.info("\(self.TAG) adding remote ICE candidate: \(candidate.sdp)")
|
|
self.peerConnection.add(candidate)
|
|
}
|
|
}
|
|
|
|
public func terminate() {
|
|
AssertIsOnMainThread()
|
|
Logger.debug("\(TAG) in \(#function)")
|
|
|
|
PeerConnectionClient.signalingQueue.async {
|
|
assert(self.peerConnection != nil)
|
|
self.terminateInternal()
|
|
}
|
|
}
|
|
|
|
private func terminateInternal() {
|
|
assertOnSignalingQueue()
|
|
|
|
Logger.debug("\(TAG) in \(#function)")
|
|
|
|
// Some notes on preventing crashes while disposing of peerConnection for video calls
|
|
// from: https://groups.google.com/forum/#!searchin/discuss-webrtc/objc$20crash$20dealloc%7Csort:relevance/discuss-webrtc/7D-vk5yLjn8/rBW2D6EW4GYJ
|
|
// The sequence to make it work appears to be
|
|
//
|
|
// [capturer stop]; // I had to add this as a method to RTCVideoCapturer
|
|
// [localRenderer stop];
|
|
// [remoteRenderer stop];
|
|
// [peerConnection close];
|
|
|
|
// audioTrack is a strong property because we need access to it to mute/unmute, but I was seeing it
|
|
// become nil when it was only a weak property. So we retain it and manually nil the reference here, because
|
|
// we are likely to crash if we retain any peer connection properties when the peerconnection is released
|
|
|
|
// See the comments on the remoteVideoTrack property.
|
|
objc_sync_enter(self)
|
|
localVideoTrack?.isEnabled = false
|
|
remoteVideoTrack?.isEnabled = false
|
|
|
|
dataChannel = nil
|
|
audioSender = nil
|
|
audioTrack = nil
|
|
videoSender = nil
|
|
localVideoTrack = nil
|
|
remoteVideoTrack = nil
|
|
|
|
peerConnection.delegate = nil
|
|
peerConnection.close()
|
|
peerConnection = nil
|
|
objc_sync_exit(self)
|
|
|
|
delegate = nil
|
|
}
|
|
|
|
// MARK: - Data Channel
|
|
|
|
// should only be accessed on PeerConnectionClient.signalingQueue
|
|
var pendingDataChannelMessages: [PendingDataChannelMessage] = []
|
|
struct PendingDataChannelMessage {
|
|
let data: Data
|
|
let description: String
|
|
let isCritical: Bool
|
|
}
|
|
|
|
public func sendDataChannelMessage(data: Data, description: String, isCritical: Bool) {
|
|
AssertIsOnMainThread()
|
|
|
|
PeerConnectionClient.signalingQueue.async {
|
|
guard self.peerConnection != nil else {
|
|
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client: \(description)")
|
|
return
|
|
}
|
|
|
|
guard let dataChannel = self.dataChannel else {
|
|
if isCritical {
|
|
Logger.info("\(self.TAG) in \(#function) enqueuing critical data channel message for after we have a dataChannel: \(description)")
|
|
self.pendingDataChannelMessages.append(PendingDataChannelMessage(data: data, description: description, isCritical: isCritical))
|
|
} else {
|
|
Logger.error("\(self.TAG) in \(#function) ignoring sending \(data) for nil dataChannel: \(description)")
|
|
}
|
|
return
|
|
}
|
|
|
|
Logger.debug("\(self.TAG) sendDataChannelMessage trying: \(description)")
|
|
|
|
let buffer = RTCDataBuffer(data: data, isBinary: false)
|
|
let result = dataChannel.sendData(buffer)
|
|
|
|
if result {
|
|
Logger.debug("\(self.TAG) sendDataChannelMessage succeeded: \(description)")
|
|
} else {
|
|
Logger.warn("\(self.TAG) sendDataChannelMessage failed: \(description)")
|
|
if isCritical {
|
|
OWSProdError(OWSAnalyticsEvents.peerConnectionClientErrorSendDataChannelMessageFailed(), file:#file, function:#function, line:#line)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// MARK: RTCDataChannelDelegate
|
|
|
|
/** The data channel state changed. */
|
|
internal func dataChannelDidChangeState(_ dataChannel: RTCDataChannel) {
|
|
Logger.debug("\(TAG) dataChannelDidChangeState: \(dataChannel)")
|
|
}
|
|
|
|
/** The data channel successfully received a data buffer. */
|
|
internal func dataChannel(_ dataChannel: RTCDataChannel, didReceiveMessageWith buffer: RTCDataBuffer) {
|
|
PeerConnectionClient.signalingQueue.async {
|
|
guard self.peerConnection != nil else {
|
|
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client")
|
|
return
|
|
}
|
|
Logger.debug("\(self.TAG) dataChannel didReceiveMessageWith buffer:\(buffer)")
|
|
|
|
guard let dataChannelMessage = OWSWebRTCProtosData.parse(from:buffer.data) else {
|
|
// TODO can't proto parsings throw an exception? Is it just being lost in the Objc->Swift?
|
|
Logger.error("\(self.TAG) failed to parse dataProto")
|
|
return
|
|
}
|
|
|
|
if let delegate = self.delegate {
|
|
DispatchQueue.main.async { [weak self] in
|
|
guard let strongSelf = self else { return }
|
|
delegate.peerConnectionClient(strongSelf, received: dataChannelMessage)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/** The data channel's |bufferedAmount| changed. */
|
|
internal func dataChannel(_ dataChannel: RTCDataChannel, didChangeBufferedAmount amount: UInt64) {
|
|
Logger.debug("\(TAG) didChangeBufferedAmount: \(amount)")
|
|
}
|
|
|
|
// MARK: - RTCPeerConnectionDelegate
|
|
|
|
/** Called when the SignalingState changed. */
|
|
internal func peerConnection(_ peerConnection: RTCPeerConnection, didChange stateChanged: RTCSignalingState) {
|
|
Logger.debug("\(TAG) didChange signalingState:\(stateChanged.debugDescription)")
|
|
}
|
|
|
|
/** Called when media is received on a new stream from remote peer. */
|
|
internal func peerConnection(_ peerConnection: RTCPeerConnection, didAdd stream: RTCMediaStream) {
|
|
guard stream.videoTracks.count > 0 else {
|
|
return
|
|
}
|
|
let remoteVideoTrack = stream.videoTracks[0]
|
|
Logger.debug("\(self.TAG) didAdd stream:\(stream) video tracks: \(stream.videoTracks.count) audio tracks: \(stream.audioTracks.count)")
|
|
|
|
// See the comments on the remoteVideoTrack property.
|
|
//
|
|
// We only set the remoteVideoTrack property if peerConnection is non-nil.
|
|
objc_sync_enter(self)
|
|
if self.peerConnection != nil {
|
|
self.remoteVideoTrack = remoteVideoTrack
|
|
}
|
|
objc_sync_exit(self)
|
|
|
|
PeerConnectionClient.signalingQueue.async {
|
|
guard self.peerConnection != nil else {
|
|
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client")
|
|
return
|
|
}
|
|
|
|
if let delegate = self.delegate {
|
|
DispatchQueue.main.async { [weak self] in
|
|
guard let strongSelf = self else { return }
|
|
|
|
// See the comments on the remoteVideoTrack property.
|
|
//
|
|
// We only access the remoteVideoTrack property if peerConnection is non-nil.
|
|
var remoteVideoTrack: RTCVideoTrack?
|
|
objc_sync_enter(strongSelf)
|
|
if strongSelf.peerConnection != nil {
|
|
remoteVideoTrack = strongSelf.remoteVideoTrack
|
|
}
|
|
objc_sync_exit(strongSelf)
|
|
|
|
delegate.peerConnectionClient(strongSelf, didUpdateRemote: remoteVideoTrack)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/** Called when a remote peer closes a stream. */
|
|
internal func peerConnection(_ peerConnection: RTCPeerConnection, didRemove stream: RTCMediaStream) {
|
|
Logger.debug("\(TAG) didRemove Stream:\(stream)")
|
|
}
|
|
|
|
/** Called when negotiation is needed, for example ICE has restarted. */
|
|
internal func peerConnectionShouldNegotiate(_ peerConnection: RTCPeerConnection) {
|
|
Logger.debug("\(TAG) shouldNegotiate")
|
|
}
|
|
|
|
/** Called any time the IceConnectionState changes. */
|
|
internal func peerConnection(_ peerConnection: RTCPeerConnection, didChange newState: RTCIceConnectionState) {
|
|
PeerConnectionClient.signalingQueue.async {
|
|
guard self.peerConnection != nil else {
|
|
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client")
|
|
return
|
|
}
|
|
Logger.debug("\(self.TAG) didChange IceConnectionState:\(newState.debugDescription)")
|
|
switch newState {
|
|
case .connected, .completed:
|
|
if let delegate = self.delegate {
|
|
DispatchQueue.main.async { [weak self] in
|
|
guard let strongSelf = self else { return }
|
|
delegate.peerConnectionClientIceConnected(strongSelf)
|
|
}
|
|
}
|
|
case .failed:
|
|
Logger.warn("\(self.TAG) RTCIceConnection failed.")
|
|
if let delegate = self.delegate {
|
|
DispatchQueue.main.async { [weak self] in
|
|
guard let strongSelf = self else { return }
|
|
delegate.peerConnectionClientIceFailed(strongSelf)
|
|
}
|
|
}
|
|
case .disconnected:
|
|
Logger.warn("\(self.TAG) RTCIceConnection disconnected.")
|
|
default:
|
|
Logger.debug("\(self.TAG) ignoring change IceConnectionState:\(newState.debugDescription)")
|
|
}
|
|
}
|
|
}
|
|
|
|
/** Called any time the IceGatheringState changes. */
|
|
internal func peerConnection(_ peerConnection: RTCPeerConnection, didChange newState: RTCIceGatheringState) {
|
|
Logger.debug("\(TAG) didChange IceGatheringState:\(newState.debugDescription)")
|
|
}
|
|
|
|
/** New ice candidate has been found. */
|
|
internal func peerConnection(_ peerConnection: RTCPeerConnection, didGenerate candidate: RTCIceCandidate) {
|
|
PeerConnectionClient.signalingQueue.async {
|
|
guard self.peerConnection != nil else {
|
|
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client")
|
|
return
|
|
}
|
|
Logger.info("\(self.TAG) adding local ICE candidate:\(candidate.sdp)")
|
|
if let delegate = self.delegate {
|
|
DispatchQueue.main.async { [weak self] in
|
|
guard let strongSelf = self else { return }
|
|
delegate.peerConnectionClient(strongSelf, addedLocalIceCandidate: candidate)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/** Called when a group of local Ice candidates have been removed. */
|
|
internal func peerConnection(_ peerConnection: RTCPeerConnection, didRemove candidates: [RTCIceCandidate]) {
|
|
Logger.debug("\(TAG) didRemove IceCandidates:\(candidates)")
|
|
}
|
|
|
|
/** New data channel has been opened. */
|
|
internal func peerConnection(_ peerConnection: RTCPeerConnection, didOpen dataChannel: RTCDataChannel) {
|
|
PeerConnectionClient.signalingQueue.async {
|
|
guard self.peerConnection != nil else {
|
|
Logger.debug("\(self.TAG) \(#function) Ignoring obsolete event in terminated client")
|
|
return
|
|
}
|
|
Logger.debug("\(self.TAG) didOpen dataChannel:\(dataChannel)")
|
|
assert(self.dataChannel == nil)
|
|
self.dataChannel = dataChannel
|
|
dataChannel.delegate = self
|
|
|
|
let pendingMessages = self.pendingDataChannelMessages
|
|
self.pendingDataChannelMessages = []
|
|
DispatchQueue.main.async { [weak self] in
|
|
guard let strongSelf = self else { return }
|
|
|
|
pendingMessages.forEach { message in
|
|
strongSelf.sendDataChannelMessage(data: message.data, description: message.description, isCritical: message.isCritical)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// MARK: Helpers
|
|
|
|
/**
|
|
* We synchronize access to state in this class using this queue.
|
|
*/
|
|
private func assertOnSignalingQueue() {
|
|
assertOnQueue(type(of: self).signalingQueue)
|
|
}
|
|
|
|
// MARK: Test-only accessors
|
|
|
|
internal func peerConnectionForTests() -> RTCPeerConnection {
|
|
AssertIsOnMainThread()
|
|
|
|
var result: RTCPeerConnection? = nil
|
|
PeerConnectionClient.signalingQueue.sync {
|
|
result = peerConnection
|
|
Logger.info("\(self.TAG) called \(#function)")
|
|
}
|
|
return result!
|
|
}
|
|
|
|
internal func dataChannelForTests() -> RTCDataChannel {
|
|
AssertIsOnMainThread()
|
|
|
|
var result: RTCDataChannel? = nil
|
|
PeerConnectionClient.signalingQueue.sync {
|
|
result = dataChannel
|
|
Logger.info("\(self.TAG) called \(#function)")
|
|
}
|
|
return result!
|
|
}
|
|
|
|
internal func flushSignalingQueueForTests() {
|
|
AssertIsOnMainThread()
|
|
|
|
PeerConnectionClient.signalingQueue.sync {
|
|
// Noop.
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Restrict an RTCSessionDescription to more secure parameters
|
|
*/
|
|
class HardenedRTCSessionDescription {
|
|
let rtcSessionDescription: RTCSessionDescription
|
|
var sdp: String { return rtcSessionDescription.sdp }
|
|
|
|
init(rtcSessionDescription: RTCSessionDescription) {
|
|
self.rtcSessionDescription = HardenedRTCSessionDescription.harden(rtcSessionDescription: rtcSessionDescription)
|
|
}
|
|
|
|
/**
|
|
* Set some more secure parameters for the session description
|
|
*/
|
|
class func harden(rtcSessionDescription: RTCSessionDescription) -> RTCSessionDescription {
|
|
var description = rtcSessionDescription.sdp
|
|
|
|
// Enforce Constant bit rate.
|
|
let cbrRegex = try! NSRegularExpression(pattern:"(a=fmtp:111 ((?!cbr=).)*)\r?\n", options:.caseInsensitive)
|
|
description = cbrRegex.stringByReplacingMatches(in: description, options: [], range: NSMakeRange(0, description.characters.count), withTemplate: "$1;cbr=1\r\n")
|
|
|
|
// Strip plaintext audio-level details
|
|
// https://tools.ietf.org/html/rfc6464
|
|
let audioLevelRegex = try! NSRegularExpression(pattern:".+urn:ietf:params:rtp-hdrext:ssrc-audio-level.*\r?\n", options:.caseInsensitive)
|
|
description = audioLevelRegex.stringByReplacingMatches(in: description, options: [], range: NSMakeRange(0, description.characters.count), withTemplate: "")
|
|
|
|
return RTCSessionDescription.init(type: rtcSessionDescription.type, sdp: description)
|
|
}
|
|
}
|
|
|
|
// Mark: Pretty Print Objc enums.
|
|
|
|
fileprivate extension RTCSignalingState {
|
|
var debugDescription: String {
|
|
switch self {
|
|
case .stable:
|
|
return "stable"
|
|
case .haveLocalOffer:
|
|
return "haveLocalOffer"
|
|
case .haveLocalPrAnswer:
|
|
return "haveLocalPrAnswer"
|
|
case .haveRemoteOffer:
|
|
return "haveRemoteOffer"
|
|
case .haveRemotePrAnswer:
|
|
return "haveRemotePrAnswer"
|
|
case .closed:
|
|
return "closed"
|
|
}
|
|
}
|
|
}
|
|
|
|
fileprivate extension RTCIceGatheringState {
|
|
var debugDescription: String {
|
|
switch self {
|
|
case .new:
|
|
return "new"
|
|
case .gathering:
|
|
return "gathering"
|
|
case .complete:
|
|
return "complete"
|
|
}
|
|
}
|
|
}
|
|
|
|
fileprivate extension RTCIceConnectionState {
|
|
var debugDescription: String {
|
|
switch self {
|
|
case .new:
|
|
return "new"
|
|
case .checking:
|
|
return "checking"
|
|
case .connected:
|
|
return "connected"
|
|
case .completed:
|
|
return "completed"
|
|
case .failed:
|
|
return "failed"
|
|
case .disconnected:
|
|
return "disconnected"
|
|
case .closed:
|
|
return "closed"
|
|
case .count:
|
|
return "count"
|
|
}
|
|
}
|
|
}
|