public void CreateRtpAndControlSocketsDuplicateStartPortUnitTest()
{
logger.LogDebug("--> " + System.Reflection.MethodBase.GetCurrentMethod().Name);
logger.BeginScope(System.Reflection.MethodBase.GetCurrentMethod().Name);
List <Socket> sockets = new List <Socket>();
for (int i = 0; i < 20; i++)
{
Socket rtpSocket = null;
Socket controlSocket = null;
NetServices.CreateRtpSocket(49152, 65534, 51277, true, null, out rtpSocket, out controlSocket);
Assert.NotNull(rtpSocket);
Assert.NotNull(controlSocket);
sockets.Add(rtpSocket);
sockets.Add(controlSocket);
}
foreach (var socket in sockets)
{
socket.Close();
}
}
public void CheckFailsOnDuplicateForIP6AnyThenIPv4AnyUnitTest()
{
logger.LogDebug("--> " + System.Reflection.MethodBase.GetCurrentMethod().Name);
logger.BeginScope(System.Reflection.MethodBase.GetCurrentMethod().Name);
if (Socket.OSSupportsIPv6 && NetServices.SupportsDualModeIPv4PacketInfo)
{
Socket rtpSocket = null;
Socket controlSocket = null;
NetServices.CreateRtpSocket(true, IPAddress.IPv6Any, out rtpSocket, out controlSocket);
Assert.NotNull(rtpSocket);
Assert.NotNull(controlSocket);
Assert.Throws <ApplicationException>(() => NetServices.CreateBoundUdpSocket((rtpSocket.LocalEndPoint as IPEndPoint).Port, IPAddress.Any));
rtpSocket.Close();
controlSocket.Close();
}
else
{
logger.LogDebug("Test skipped as IPv6 dual mode sockets are not in use on this OS.");
}
}
public void CreateRtpAndControlMultipleSocketsUnitTest()
{
logger.LogDebug("--> " + System.Reflection.MethodBase.GetCurrentMethod().Name);
logger.BeginScope(System.Reflection.MethodBase.GetCurrentMethod().Name);
List <Socket> sockets = new List <Socket>();
for (int i = 0; i < 20; i++)
{
Socket rtpSocket = null;
Socket controlSocket = null;
NetServices.CreateRtpSocket(true, null, out rtpSocket, out controlSocket);
Assert.NotNull(rtpSocket);
Assert.NotNull(controlSocket);
Assert.True((rtpSocket.LocalEndPoint as IPEndPoint).Port % 2 == 0);
Assert.False((controlSocket.LocalEndPoint as IPEndPoint).Port % 2 == 0);
sockets.Add(rtpSocket);
sockets.Add(controlSocket);
}
foreach (var socket in sockets)
{
socket.Close();
}
}
private void GetIceCandidates(ManualResetEvent iceGatheringCompleteMRE)
{
IceNegotiationStartedAt = DateTime.Now;
LocalIceCandidates = new List <IceCandidate>();
var addresses = System.Net.NetworkInformation.IPGlobalProperties.GetIPGlobalProperties().GetUnicastAddresses()
.Where(x =>
x.Address.AddressFamily == AddressFamily.InterNetwork && // Exclude IPv6 at this stage.
IPAddress.IsLoopback(x.Address) == false &&
(x.Address != null && x.Address.ToString().StartsWith(AUTOMATIC_PRIVATE_ADRRESS_PREFIX) == false));
foreach (var address in addresses)
{
logger.Debug("Attempting to create RTP socket with IP address " + address.Address + ".");
Socket rtpSocket = null;
Socket controlSocket = null;
NetServices.CreateRtpSocket(address.Address, WEBRTC_START_PORT, WEBRTC_END_PORT, false, out rtpSocket, out controlSocket);
if (rtpSocket != null)
{
logger.Debug("RTP socket successfully created on " + rtpSocket.LocalEndPoint + ".");
var iceCandidate = new IceCandidate()
{
LocalAddress = address.Address,
Port = ((IPEndPoint)rtpSocket.LocalEndPoint).Port,
LocalRtpSocket = rtpSocket,
LocalControlSocket = controlSocket,
TurnServer = (_turnServerEndPoint != null) ? new TurnServer()
{
ServerEndPoint = _turnServerEndPoint
} : null
};
LocalIceCandidates.Add(iceCandidate);
var listenerTask = Task.Run(() => { StartWebRtcRtpListener(iceCandidate); });
iceCandidate.RtpListenerTask = listenerTask;
if (_turnServerEndPoint != null)
{
var stunBindingTask = Task.Run(() => { SendInitialStunBindingRequest(iceCandidate, iceGatheringCompleteMRE); });
}
else
{
iceCandidate.IsGatheringComplete = true;
// Potentially save a few seconds if all the ICE candidates are now ready.
if (LocalIceCandidates.All(x => x.IsGatheringComplete))
{
iceGatheringCompleteMRE.Set();
}
}
}
}
}
/// <summary>
/// Creates a new UDP transport capable of encapsulating SCTP packets.
/// </summary>
/// <param name="udpEncapPort">The port to bind to for the UDP encapsulation socket.</param>
public SctpUdpTransport(int udpEncapPort = 0)
{
NetServices.CreateRtpSocket(false, IPAddress.IPv6Any, udpEncapPort, out _udpEncapSocket, out _);
UdpReceiver udpReceiver = new UdpReceiver(_udpEncapSocket);
udpReceiver.OnPacketReceived += OnEncapsulationSocketPacketReceived;
udpReceiver.OnClosed += OnEncapsulationSocketClosed;
udpReceiver.BeginReceiveFrom();
}
/// <summary>
/// Sends two separate RTP streams to an application like ffplay.
///
/// ffplay -i ffplay_av.sdp -protocol_whitelist "file,rtp,udp" -loglevel debug
///
/// The SDP that describes the streams is:
///
/// v=0
/// o=- 1129870806 2 IN IP4 127.0.0.1
/// s=-
/// c=IN IP4 192.168.11.50
/// t=0 0
/// m=audio 4040 RTP/AVP 0
/// a=rtpmap:0 PCMU/8000
/// m=video 4042 RTP/AVP 100
/// a=rtpmap:100 VP8/90000
/// </summary>
private void SendSamplesAsRtp(IPEndPoint dstBaseEndPoint)
{
try
{
Socket videoSrcRtpSocket = null;
Socket videoSrcControlSocket = null;
Socket audioSrcRtpSocket = null;
Socket audioSrcControlSocket = null;
// WebRtc multiplexes all the RTP and RTCP sessions onto a single UDP connection.
// The approach needed for ffplay is the original way where each media type has it's own UDP connection and the RTCP
// also require a separate UDP connection on RTP port + 1.
IPAddress localIPAddress = IPAddress.Any;
IPEndPoint audioRtpEP = dstBaseEndPoint;
IPEndPoint audioRtcpEP = new IPEndPoint(dstBaseEndPoint.Address, dstBaseEndPoint.Port + 1);
IPEndPoint videoRtpEP = new IPEndPoint(dstBaseEndPoint.Address, dstBaseEndPoint.Port + 2);
IPEndPoint videoRtcpEP = new IPEndPoint(dstBaseEndPoint.Address, dstBaseEndPoint.Port + 3);
RTPSession audioRtpSession = new RTPSession((int)RTPPayloadTypesEnum.PCMU, null, null);
RTPSession videoRtpSession = new RTPSession(VP8_PAYLOAD_TYPE_ID, null, null);
DateTime lastRtcpSenderReportSentAt = DateTime.Now;
NetServices.CreateRtpSocket(localIPAddress, RAW_RTP_START_PORT_RANGE, RAW_RTP_END_PORT_RANGE, true, out audioSrcRtpSocket, out audioSrcControlSocket);
NetServices.CreateRtpSocket(localIPAddress, ((IPEndPoint)audioSrcRtpSocket.LocalEndPoint).Port, RAW_RTP_END_PORT_RANGE, true, out videoSrcRtpSocket, out videoSrcControlSocket);
OnMediaSampleReady += (mediaType, timestamp, sample) =>
{
if (mediaType == MediaSampleTypeEnum.VP8)
{
videoRtpSession.SendVp8Frame(videoSrcRtpSocket, videoRtpEP, timestamp, sample);
}
else
{
audioRtpSession.SendAudioFrame(audioSrcRtpSocket, audioRtpEP, timestamp, sample);
}
// Deliver periodic RTCP sender reports. This helps the receiver to sync the audio and video stream timestamps.
// If there are gaps in the media, silence supression etc. then the sender repors shouldn't be triggered from the media samples.
// In this case the samples are from an mp4 file which provides a constant uninterrupted stream.
if (DateTime.Now.Subtract(lastRtcpSenderReportSentAt).TotalSeconds >= RTCP_SR_PERIOD_SECONDS)
{
videoRtpSession.SendRtcpSenderReport(videoSrcControlSocket, videoRtcpEP, _vp8Timestamp);
audioRtpSession.SendRtcpSenderReport(audioSrcControlSocket, audioRtcpEP, _mulawTimestamp);
lastRtcpSenderReportSentAt = DateTime.Now;
}
};
}
catch (Exception excp)
{
logger.Error("Exception SendSamplesAsRtp. " + excp);
}
}
public void CreateRtpAndControlSocketsUnitTest()
{
logger.LogDebug("--> " + System.Reflection.MethodBase.GetCurrentMethod().Name);
logger.BeginScope(System.Reflection.MethodBase.GetCurrentMethod().Name);
Socket rtpSocket = null;
Socket controlSocket = null;
NetServices.CreateRtpSocket(10000, 20000, 13677, true, null, out rtpSocket, out controlSocket);
Assert.NotNull(rtpSocket);
Assert.NotNull(controlSocket);
}
public void CreateRtpAndControlSocketsOnIP4AnyUnitTest()
{
logger.LogDebug("--> " + System.Reflection.MethodBase.GetCurrentMethod().Name);
logger.BeginScope(System.Reflection.MethodBase.GetCurrentMethod().Name);
Socket rtpSocket = null;
Socket controlSocket = null;
NetServices.CreateRtpSocket(true, IPAddress.Any, out rtpSocket, out controlSocket);
Assert.NotNull(rtpSocket);
Assert.NotNull(controlSocket);
rtpSocket.Close();
controlSocket.Close();
}
public MockTurnServer(IPAddress listenAddress, int port)
{
_listenAddress = listenAddress;
_listenPort = port;
NetServices.CreateRtpSocket(false, _listenAddress, 0, out _clientSocket, out _);
ListeningEndPoint = _clientSocket.LocalEndPoint as IPEndPoint;
logger.LogDebug($"MockTurnServer listening on {ListeningEndPoint}.");
_listener = new UdpReceiver(_clientSocket);
_listener.OnPacketReceived += OnPacketReceived;
_listener.OnClosed += (reason) => logger.LogDebug($"MockTurnServer on {ListeningEndPoint} closed.");
_listener.BeginReceiveFrom();
}
/// <summary>
/// Creates a new RTP channel. The RTP and optionally RTCP sockets will be bound in the constructor.
/// They do not start receiving until the Start method is called.
/// </summary>
/// <param name="createControlSocket">Set to true if a separate RTCP control socket should be created. If RTP and
/// RTCP are being multiplexed (as they are for WebRTC) there's no need to a separate control socket.</param>
/// <param name="rtpRemoteEndPoint">The remote end point that the RTP socket is sending to.</param>
/// <param name="controlEndPoint">The remote end point that the RTCP control socket is sending to.</param>
/// <param name="mediaStartPort">The media start port.</param>
/// <param name="mediaEndPort">The media end port.</param>
public RTPChannel(IPAddress localAddress,
bool createControlSocket,
IPEndPoint rtpRemoteEndPoint = null,
IPEndPoint controlEndPoint = null,
int mediaStartPort = MEDIA_PORT_START,
int mediaEndPort = MEDIA_PORT_END)
{
NetServices.CreateRtpSocket(localAddress, mediaStartPort, mediaEndPort, createControlSocket, out m_rtpSocket, out m_controlSocket);
RTPLocalEndPoint = m_rtpSocket.LocalEndPoint as IPEndPoint;
RTPPort = RTPLocalEndPoint.Port;
ControlLocalEndPoint = m_controlSocket.LocalEndPoint as IPEndPoint;
ControlPort = ControlLocalEndPoint.Port;
LastRtpDestination = rtpRemoteEndPoint;
LastControlDestination = controlEndPoint;
}
/// <summary>
/// Creates a new RTP channel. The RTP and optionally RTCP sockets will be bound in the constructor.
/// They do not start receiving until the Start method is called.
/// </summary>
/// <param name="createControlSocket">Set to true if a separate RTCP control socket should be created. If RTP and
/// RTCP are being multiplexed (as they are for WebRTC) there's no need to a separate control socket.</param>
/// <param name="bindAddress">Optional. An IP address belonging to a local interface that will be used to bind
/// the RTP and control sockets to. If left empty then the IPv6 any address will be used if IPv6 is supported
/// and fallback to the IPv4 any address.</param>
/// <param name="bindPort">Optional. The specific port to attempt to bind the RTP port on.</param>
public RTPChannel(bool createControlSocket, IPAddress bindAddress, int bindPort = 0)
{
NetServices.CreateRtpSocket(createControlSocket, bindAddress, bindPort, out var rtpSocket, out m_controlSocket);
if (rtpSocket == null)
{
throw new ApplicationException("The RTP channel was not able to create an RTP socket.");
}
else if (createControlSocket && m_controlSocket == null)
{
throw new ApplicationException("The RTP channel was not able to create a Control socket.");
}
RtpSocket = rtpSocket;
RTPLocalEndPoint = RtpSocket.LocalEndPoint as IPEndPoint;
RTPPort = RTPLocalEndPoint.Port;
ControlLocalEndPoint = (m_controlSocket != null) ? m_controlSocket.LocalEndPoint as IPEndPoint : null;
ControlPort = (m_controlSocket != null) ? ControlLocalEndPoint.Port : 0;
}
/// <summary>
/// Creates a new RTP channel. The RTP and optionally RTCP sockets will be bound in the constructor.
/// They do not start receiving until the Start method is called.
/// </summary>
/// <param name="createControlSocket">Set to true if a separate RTCP control socket should be created. If RTP and
/// RTCP are being multiplexed (as they are for WebRTC) there's no need to a separate control socket.</param>
/// <param name="rtpRemoteEndPoint">The remote end point that the RTP socket is sending to.</param>
/// <param name="controlEndPoint">The remote end point that the RTCP control socket is sending to.</param>
/// <param name="mediaStartPort">The media start port.</param>
/// <param name="mediaEndPort">The media end port.</param>
public RTPChannel(bool createControlSocket,
IPEndPoint rtpRemoteEndPoint = null,
IPEndPoint controlEndPoint = null,
int mediaStartPort = RTP_PORT_START,
int mediaEndPort = RTP_PORT_END)
{
int startFrom = Crypto.GetRandomInt(RTP_PORT_START, RTP_PORT_END);
NetServices.CreateRtpSocket(mediaStartPort, mediaEndPort, startFrom, createControlSocket, null, out var rtpSocket, out m_controlSocket);
RtpSocket = rtpSocket;
RTPLocalEndPoint = RtpSocket.LocalEndPoint as IPEndPoint;
RTPPort = RTPLocalEndPoint.Port;
ControlLocalEndPoint = (m_controlSocket != null) ? m_controlSocket.LocalEndPoint as IPEndPoint : null;
ControlPort = (m_controlSocket != null) ? ControlLocalEndPoint.Port : 0;
LastRtpDestination = rtpRemoteEndPoint;
LastControlDestination = controlEndPoint;
}
static void Main()
{
Console.WriteLine("SIPSorcery client user agent server example.");
Console.WriteLine("Press ctrl-c to exit.");
// Logging configuration. Can be ommitted if internal SIPSorcery debug and warning messages are not required.
var loggerFactory = new Microsoft.Extensions.Logging.LoggerFactory();
var loggerConfig = new LoggerConfiguration()
.Enrich.FromLogContext()
.MinimumLevel.Is(Serilog.Events.LogEventLevel.Debug)
.WriteTo.Console()
.CreateLogger();
loggerFactory.AddSerilog(loggerConfig);
SIPSorcery.Sys.Log.LoggerFactory = loggerFactory;
// Set up a default SIP transport.
var sipTransport = new SIPTransport();
sipTransport.ContactHost = Dns.GetHostName();
sipTransport.AddSIPChannel(new SIPUDPChannel(new IPEndPoint(IPAddress.Any, SIP_LISTEN_PORT)));
//sipTransport.AddSIPChannel(new SIPUDPChannel(new IPEndPoint(IPAddress.IPv6Any, SIP_LISTEN_PORT)));
//sipTransport.AddSIPChannel(new SIPTCPChannel(new IPEndPoint(IPAddress.Any, SIP_LISTEN_PORT)));
//sipTransport.AddSIPChannel(new SIPTCPChannel(new IPEndPoint(IPAddress.IPv6Any, SIP_LISTEN_PORT)));
//if (File.Exists("localhost.pfx"))
//{
// var certificate = new X509Certificate2(@"localhost.pfx", "");
// sipTransport.AddSIPChannel(new SIPTLSChannel(certificate, new IPEndPoint(IPAddress.Any, SIPS_LISTEN_PORT)));
// sipTransport.AddSIPChannel(new SIPTLSChannel(certificate, new IPEndPoint(IPAddress.IPv6Any, SIPS_LISTEN_PORT)));
//}
//EnableTraceLogs(sipTransport);
// To keep things a bit simpler this example only supports a single call at a time and the SIP server user agent
// acts as a singleton
SIPServerUserAgent uas = null;
CancellationTokenSource rtpCts = null; // Cancellation token to stop the RTP stream.
// Because this is a server user agent the SIP transport must start listening for client user agents.
sipTransport.SIPTransportRequestReceived += async(SIPEndPoint localSIPEndPoint, SIPEndPoint remoteEndPoint, SIPRequest sipRequest) =>
{
if (sipRequest.Method == SIPMethodsEnum.INVITE)
{
SIPSorcery.Sys.Log.Logger.LogInformation("Incoming call request: " + localSIPEndPoint + "<-" + remoteEndPoint + " " + sipRequest.URI.ToString() + ".");
//SIPSorcery.Sys.Log.Logger.LogDebug(sipRequest.ToString());
// If there's already a call in progress hang it up. Of course this is not ideal for a real softphone or server but it
// means this example can be kept simpler.
if (uas?.IsHungup == false)
{
uas?.Hangup(false);
}
rtpCts?.Cancel();
UASInviteTransaction uasTransaction = sipTransport.CreateUASTransaction(sipRequest, remoteEndPoint, localSIPEndPoint, null);
uas = new SIPServerUserAgent(sipTransport, null, null, null, SIPCallDirection.In, null, null, null, uasTransaction);
rtpCts = new CancellationTokenSource();
// In practice there could be a number of reasons to reject the call. Unsupported extensions, mo matching codecs etc. etc.
if (sipRequest.Header.HasUnknownRequireExtension)
{
// The caller requires an extension that we don't support.
SIPSorcery.Sys.Log.Logger.LogWarning($"Rejecting incoming call due to one or more required exensions not being supported, required extensions: {sipRequest.Header.Require}.");
uas.Reject(SIPResponseStatusCodesEnum.NotImplemented, "Unsupported Require Extension", null);
}
else
{
uas.Progress(SIPResponseStatusCodesEnum.Trying, null, null, null, null);
uas.Progress(SIPResponseStatusCodesEnum.Ringing, null, null, null, null);
// Simulating answer delay to test provisional response retransmits.
await Task.Delay(2000);
// Initialise an RTP session to receive the RTP packets from the remote SIP server.
Socket rtpSocket = null;
Socket controlSocket = null;
NetServices.CreateRtpSocket(localSIPEndPoint.Address, 49000, 49100, false, out rtpSocket, out controlSocket);
IPEndPoint rtpEndPoint = rtpSocket.LocalEndPoint as IPEndPoint;
IPEndPoint dstRtpEndPoint = SDP.GetSDPRTPEndPoint(sipRequest.Body);
var rtpSession = new RTPSession((int)RTPPayloadTypesEnum.PCMU, null, null);
var rtpTask = Task.Run(() => SendRecvRtp(rtpSocket, rtpSession, dstRtpEndPoint, AUDIO_FILE, rtpCts))
.ContinueWith(_ => { if (uas?.IsHungup == false)
{
uas?.Hangup(false);
}
});
uas.Answer(SDP.SDP_MIME_CONTENTTYPE, GetSDP(rtpEndPoint).ToString(), null, SIPDialogueTransferModesEnum.NotAllowed);
}
}
else if (sipRequest.Method == SIPMethodsEnum.BYE)
{
SIPSorcery.Sys.Log.Logger.LogInformation("Call hungup.");
SIPNonInviteTransaction byeTransaction = sipTransport.CreateNonInviteTransaction(sipRequest, remoteEndPoint, localSIPEndPoint, null);
SIPResponse byeResponse = SIPTransport.GetResponse(sipRequest, SIPResponseStatusCodesEnum.Ok, null);
byeTransaction.SendFinalResponse(byeResponse);
uas?.Hangup(true);
rtpCts?.Cancel();
}
else if (sipRequest.Method == SIPMethodsEnum.OPTIONS)
{
try
{
SIPSorcery.Sys.Log.Logger.LogInformation($"{localSIPEndPoint.ToString()}<-{remoteEndPoint.ToString()}: {sipRequest.StatusLine}");
//SIPSorcery.Sys.Log.Logger.LogDebug(sipRequest.ToString());
SIPResponse optionsResponse = SIPTransport.GetResponse(sipRequest, SIPResponseStatusCodesEnum.Ok, null);
sipTransport.SendResponse(optionsResponse);
}
catch (Exception optionsExcp)
{
SIPSorcery.Sys.Log.Logger.LogWarning($"Failed to send SIP OPTIONS response. {optionsExcp.Message}");
}
}
};
Console.CancelKeyPress += delegate(object sender, ConsoleCancelEventArgs e)
{
e.Cancel = true;
SIPSorcery.Sys.Log.Logger.LogInformation("Exiting...");
rtpCts?.Cancel();
if (uas?.IsHungup == false)
{
uas?.Hangup(false);
// Give the BYE or CANCEL request time to be transmitted.
SIPSorcery.Sys.Log.Logger.LogInformation("Waiting 1s for call to hangup...");
Task.Delay(1000).Wait();
}
if (sipTransport != null)
{
SIPSorcery.Sys.Log.Logger.LogInformation("Shutting down SIP transport...");
sipTransport.Shutdown();
}
};
}
private void GetIceCandidates(ManualResetEvent iceGatheringCompleteMRE)
{
IceNegotiationStartedAt = DateTime.Now;
LocalIceCandidates = new List <IceCandidate>();
if (_localIPAddresses.Count == 0)
{
// CAUTION: GetUnicastAddresses can take up to 60 seconds to return if the machine has IP addresses in the IpDadStateTentative state,
// such as DHCP addresses still checking for their lease. More info at: https://msdn.microsoft.com/en-us/library/windows/desktop/aa814507(v=vs.85).aspx
//var addresses = System.Net.NetworkInformation.IPGlobalProperties.GetIPGlobalProperties().GetUnicastAddresses()
// .Where(x =>
// x.Address.AddressFamily == AddressFamily.InterNetwork && // Exclude IPv6 at this stage.
// IPAddress.IsLoopback(x.Address) == false &&
// (x.Address != null && x.Address.ToString().StartsWith(AUTOMATIC_PRIVATE_ADRRESS_PREFIX) == false));
foreach (NetworkInterface ni in NetworkInterface.GetAllNetworkInterfaces())
{
if (ni.OperationalStatus == OperationalStatus.Up)
{
foreach (UnicastIPAddressInformation ip in ni.GetIPProperties().UnicastAddresses)
{
if (ip.Address.AddressFamily == System.Net.Sockets.AddressFamily.InterNetwork && IPAddress.IsLoopback(ip.Address) == false && ip.IsTransient == false)
{
//Console.WriteLine(ip.Address.ToString());
_localIPAddresses.Add(ip.Address);
}
}
}
}
}
foreach (var address in _localIPAddresses)
{
logger.LogDebug("Attempting to create RTP socket with IP address " + address + ".");
Socket rtpSocket = null;
Socket controlSocket = null;
NetServices.CreateRtpSocket(address, WEBRTC_START_RTP_PORT, WEBRTC_END_RTP_PORT, false, out rtpSocket, out controlSocket);
if (rtpSocket != null)
{
logger.LogDebug("RTP socket successfully created on " + rtpSocket.LocalEndPoint + ".");
var iceCandidate = new IceCandidate()
{
LocalAddress = address,
Port = ((IPEndPoint)rtpSocket.LocalEndPoint).Port,
LocalRtpSocket = rtpSocket,
LocalControlSocket = controlSocket,
TurnServer = (_turnServerEndPoint != null) ? new TurnServer()
{
ServerEndPoint = _turnServerEndPoint
} : null,
MediaType = RtpMediaTypesEnum.Multiple
};
LocalIceCandidates.Add(iceCandidate);
var listenerTask = Task.Run(() => { StartWebRtcRtpListener(iceCandidate); });
iceCandidate.RtpListenerTask = listenerTask;
if (_turnServerEndPoint != null)
{
var stunBindingTask = Task.Run(() => { SendInitialStunBindingRequest(iceCandidate, iceGatheringCompleteMRE); });
}
else
{
iceCandidate.IsGatheringComplete = true;
// Potentially save a few seconds if all the ICE candidates are now ready.
if (LocalIceCandidates.All(x => x.IsGatheringComplete))
{
iceGatheringCompleteMRE.Set();
}
}
}
}
}
static void Main(string[] args)
{
Console.WriteLine("SIPSorcery call hold example.");
Console.WriteLine("Press ctrl-c to exit.");
// Plumbing code to facilitate a graceful exit.
CancellationTokenSource exitCts = new CancellationTokenSource(); // Cancellation token to stop the SIP transport and RTP stream.
bool isCallHungup = false;
bool hasCallFailed = false;
AddConsoleLogger();
// Check whether an override desination has been entered on the command line.
SIPURI callUri = SIPURI.ParseSIPURI(DEFAULT_DESTINATION_SIP_URI);
if (args != null && args.Length > 0)
{
if (!SIPURI.TryParse(args[0]))
{
Log.LogWarning($"Command line argument could not be parsed as a SIP URI {args[0]}");
}
else
{
callUri = SIPURI.ParseSIPURIRelaxed(args[0]);
}
}
Log.LogInformation($"Call destination {callUri}.");
// Set up a default SIP transport.
_sipTransport = new SIPTransport();
_sipTransport.AddSIPChannel(new SIPUDPChannel(new IPEndPoint(IPAddress.Any, 0)));
EnableTraceLogs(_sipTransport);
var lookupResult = SIPDNSManager.ResolveSIPService(callUri, false);
Log.LogDebug($"DNS lookup result for {callUri}: {lookupResult?.GetSIPEndPoint()}.");
var dstAddress = lookupResult.GetSIPEndPoint().Address;
IPAddress localIPAddress = NetServices.GetLocalAddressForRemote(dstAddress);
// Initialise an RTP session to receive the RTP packets from the remote SIP server.
_ourRtpSocket = null;
Socket controlSocket = null;
NetServices.CreateRtpSocket(localIPAddress, 48000, 48100, false, out _ourRtpSocket, out controlSocket);
var rtpRecvSession = new RTPSession((int)RTPPayloadTypesEnum.PCMU, null, null);
var rtpSendSession = new RTPSession((int)RTPPayloadTypesEnum.PCMU, null, null);
_ourSDP = GetSDP(_ourRtpSocket.LocalEndPoint as IPEndPoint, RTP_ATTRIBUTE_SENDRECV);
// Create a client/server user agent to place a call to a remote SIP server along with event handlers for the different stages of the call.
var userAgent = new SIPUserAgent(_sipTransport, null);
userAgent.ClientCallTrying += (uac, resp) =>
{
Log.LogInformation($"{uac.CallDescriptor.To} Trying: {resp.StatusCode} {resp.ReasonPhrase}.");
};
userAgent.ClientCallRinging += (uac, resp) => Log.LogInformation($"{uac.CallDescriptor.To} Ringing: {resp.StatusCode} {resp.ReasonPhrase}.");
userAgent.ClientCallFailed += (uac, err) =>
{
Log.LogWarning($"{uac.CallDescriptor.To} Failed: {err}");
hasCallFailed = true;
exitCts.Cancel();
};
userAgent.ClientCallAnswered += (uac, resp) =>
{
if (resp.Status == SIPResponseStatusCodesEnum.Ok)
{
Log.LogInformation($"{uac.CallDescriptor.To} Answered: {resp.StatusCode} {resp.ReasonPhrase}.");
// Only set the remote RTP end point if there hasn't already been a packet received on it.
if (_remoteRtpEndPoint == null)
{
_remoteRtpEndPoint = SDP.GetSDPRTPEndPoint(resp.Body);
Log.LogDebug($"Remote RTP socket {_remoteRtpEndPoint}.");
}
}
else
{
Log.LogWarning($"{uac.CallDescriptor.To} Answered: {resp.StatusCode} {resp.ReasonPhrase}.");
}
};
userAgent.CallHungup += () =>
{
Log.LogInformation($"Call hungup by remote party.");
exitCts.Cancel();
};
userAgent.OnReinviteRequest += ReinviteRequestReceived;
// The only incoming requests that need to be explicitly in this example program are in-dialog
// re-INVITE requests that are being used to place the call on/off hold.
_sipTransport.SIPTransportRequestReceived += (localSIPEndPoint, remoteEndPoint, sipRequest) =>
{
try
{
if (sipRequest.Header.From != null &&
sipRequest.Header.From.FromTag != null &&
sipRequest.Header.To != null &&
sipRequest.Header.To.ToTag != null)
{
userAgent.InDialogRequestReceivedAsync(sipRequest).Wait();
}
else if (sipRequest.Method == SIPMethodsEnum.OPTIONS)
{
SIPResponse optionsResponse = SIPTransport.GetResponse(sipRequest, SIPResponseStatusCodesEnum.Ok, null);
_sipTransport.SendResponse(optionsResponse);
}
}
catch (Exception excp)
{
Log.LogError($"Exception processing request. {excp.Message}");
}
};
// It's a good idea to start the RTP receiving socket before the call request is sent.
// A SIP server will generally start sending RTP as soon as it has processed the incoming call request and
// being ready to receive will stop any ICMP error response being generated.
Task.Run(() => RecvRtp(_ourRtpSocket, rtpRecvSession, exitCts));
Task.Run(() => SendRtp(_ourRtpSocket, rtpSendSession, exitCts));
// Start the thread that places the call.
SIPCallDescriptor callDescriptor = new SIPCallDescriptor(
SIP_USERNAME,
SIP_PASSWORD,
callUri.ToString(),
$"sip:{SIP_USERNAME}@localhost",
callUri.CanonicalAddress,
null, null, null,
SIPCallDirection.Out,
SDP.SDP_MIME_CONTENTTYPE,
_ourSDP.ToString(),
null);
userAgent.Call(callDescriptor);
// At this point the call has been initiated and everything will be handled in an event handler.
Task.Run(() =>
{
try
{
while (!exitCts.Token.WaitHandle.WaitOne(0))
{
var keyProps = Console.ReadKey();
if (keyProps.KeyChar == 'h')
{
// Place call on/off hold.
if (userAgent.IsAnswered)
{
if (_holdStatus == HoldStatus.None)
{
Log.LogInformation("Placing the remote call party on hold.");
_holdStatus = HoldStatus.WePutOnHold;
_ourSDP = GetSDP(_ourRtpSocket.LocalEndPoint as IPEndPoint, RTP_ATTRIBUTE_SENDONLY);
userAgent.SendReInviteRequest(_ourSDP);
}
else if (_holdStatus == HoldStatus.WePutOnHold)
{
Log.LogInformation("Removing the remote call party from hold.");
_holdStatus = HoldStatus.None;
_ourSDP = GetSDP(_ourRtpSocket.LocalEndPoint as IPEndPoint, RTP_ATTRIBUTE_SENDRECV);
userAgent.SendReInviteRequest(_ourSDP);
}
else
{
Log.LogInformation("Sorry we're already on hold by the remote call party.");
}
}
}
else if (keyProps.KeyChar == 'q')
{
// Quit application.
exitCts.Cancel();
}
}
}
catch (Exception excp)
{
SIPSorcery.Sys.Log.Logger.LogError($"Exception Key Press listener. {excp.Message}.");
}
});
// Ctrl-c will gracefully exit the call at any point.
Console.CancelKeyPress += delegate(object sender, ConsoleCancelEventArgs e)
{
e.Cancel = true;
exitCts.Cancel();
};
// Wait for a signal saying the call failed, was cancelled with ctrl-c or completed.
exitCts.Token.WaitHandle.WaitOne();
#region Cleanup.
Log.LogInformation("Exiting...");
_ourRtpSocket?.Close();
controlSocket?.Close();
if (!isCallHungup && userAgent != null)
{
if (userAgent.IsAnswered)
{
Log.LogInformation($"Hanging up call to {userAgent?.CallDescriptor?.To}.");
userAgent.Hangup();
}
else if (!hasCallFailed)
{
Log.LogInformation($"Cancelling call to {userAgent?.CallDescriptor?.To}.");
userAgent.Cancel();
}
// Give the BYE or CANCEL request time to be transmitted.
Log.LogInformation("Waiting 1s for call to clean up...");
Task.Delay(1000).Wait();
}
SIPSorcery.Net.DNSManager.Stop();
if (_sipTransport != null)
{
Log.LogInformation("Shutting down SIP transport...");
_sipTransport.Shutdown();
}
#endregion
}
static void Main(string[] args)
{
Console.WriteLine("SIPSorcery user agent server example.");
Console.WriteLine("Press h to hangup a call or ctrl-c to exit.");
EnableConsoleLogger();
IPAddress listenAddress = IPAddress.Any;
IPAddress listenIPv6Address = IPAddress.IPv6Any;
if (args != null && args.Length > 0)
{
if (!IPAddress.TryParse(args[0], out var customListenAddress))
{
Log.LogWarning($"Command line argument could not be parsed as an IP address \"{args[0]}\"");
listenAddress = IPAddress.Any;
}
else
{
if (customListenAddress.AddressFamily == AddressFamily.InterNetwork)
{
listenAddress = customListenAddress;
}
if (customListenAddress.AddressFamily == AddressFamily.InterNetworkV6)
{
listenIPv6Address = customListenAddress;
}
}
}
// Set up a default SIP transport.
var sipTransport = new SIPTransport();
var localhostCertificate = new X509Certificate2("localhost.pfx");
// IPv4 channels.
sipTransport.AddSIPChannel(new SIPUDPChannel(new IPEndPoint(listenAddress, SIP_LISTEN_PORT)));
sipTransport.AddSIPChannel(new SIPTCPChannel(new IPEndPoint(listenAddress, SIP_LISTEN_PORT)));
sipTransport.AddSIPChannel(new SIPTLSChannel(localhostCertificate, new IPEndPoint(listenAddress, SIPS_LISTEN_PORT)));
sipTransport.AddSIPChannel(new SIPWebSocketChannel(IPAddress.Any, SIP_WEBSOCKET_LISTEN_PORT));
sipTransport.AddSIPChannel(new SIPWebSocketChannel(IPAddress.Any, SIP_SECURE_WEBSOCKET_LISTEN_PORT, localhostCertificate));
// IPv6 channels.
sipTransport.AddSIPChannel(new SIPUDPChannel(new IPEndPoint(listenIPv6Address, SIP_LISTEN_PORT)));
sipTransport.AddSIPChannel(new SIPTCPChannel(new IPEndPoint(listenIPv6Address, SIP_LISTEN_PORT)));
sipTransport.AddSIPChannel(new SIPTLSChannel(localhostCertificate, new IPEndPoint(listenIPv6Address, SIPS_LISTEN_PORT)));
sipTransport.AddSIPChannel(new SIPWebSocketChannel(IPAddress.IPv6Any, SIP_WEBSOCKET_LISTEN_PORT));
sipTransport.AddSIPChannel(new SIPWebSocketChannel(IPAddress.IPv6Any, SIP_SECURE_WEBSOCKET_LISTEN_PORT, localhostCertificate));
EnableTraceLogs(sipTransport);
// To keep things a bit simpler this example only supports a single call at a time and the SIP server user agent
// acts as a singleton
SIPServerUserAgent uas = null;
CancellationTokenSource rtpCts = null; // Cancellation token to stop the RTP stream.
Socket rtpSocket = null;
Socket controlSocket = null;
// Because this is a server user agent the SIP transport must start listening for client user agents.
sipTransport.SIPTransportRequestReceived += (SIPEndPoint localSIPEndPoint, SIPEndPoint remoteEndPoint, SIPRequest sipRequest) =>
{
try
{
if (sipRequest.Method == SIPMethodsEnum.INVITE)
{
SIPSorcery.Sys.Log.Logger.LogInformation($"Incoming call request: {localSIPEndPoint}<-{remoteEndPoint} {sipRequest.URI}.");
// Check there's a codec we support in the INVITE offer.
var offerSdp = SDP.ParseSDPDescription(sipRequest.Body);
IPEndPoint dstRtpEndPoint = SDP.GetSDPRTPEndPoint(sipRequest.Body);
RTPSession rtpSession = null;
string audioFile = null;
if (offerSdp.Media.Any(x => x.Media == SDPMediaTypesEnum.audio && x.HasMediaFormat((int)RTPPayloadTypesEnum.G722)))
{
Log.LogDebug($"Using G722 RTP media type and audio file {AUDIO_FILE_G722}.");
rtpSession = new RTPSession((int)RTPPayloadTypesEnum.G722, null, null);
audioFile = AUDIO_FILE_G722;
}
else if (offerSdp.Media.Any(x => x.Media == SDPMediaTypesEnum.audio && x.HasMediaFormat((int)RTPPayloadTypesEnum.PCMU)))
{
Log.LogDebug($"Using PCMU RTP media type and audio file {AUDIO_FILE_PCMU}.");
rtpSession = new RTPSession((int)RTPPayloadTypesEnum.PCMU, null, null);
audioFile = AUDIO_FILE_PCMU;
}
if (rtpSession == null)
{
// Didn't get a match on the codecs we support.
SIPResponse noMatchingCodecResponse = SIPTransport.GetResponse(sipRequest, SIPResponseStatusCodesEnum.NotAcceptableHere, null);
sipTransport.SendResponse(noMatchingCodecResponse);
}
else
{
// If there's already a call in progress hang it up. Of course this is not ideal for a real softphone or server but it
// means this example can be kept simpler.
if (uas?.IsHungup == false)
{
uas?.Hangup(false);
}
rtpCts?.Cancel();
UASInviteTransaction uasTransaction = sipTransport.CreateUASTransaction(sipRequest, null);
uas = new SIPServerUserAgent(sipTransport, null, null, null, SIPCallDirection.In, null, null, null, uasTransaction);
rtpCts = new CancellationTokenSource();
uas.Progress(SIPResponseStatusCodesEnum.Trying, null, null, null, null);
uas.Progress(SIPResponseStatusCodesEnum.Ringing, null, null, null, null);
// Initialise an RTP session to receive the RTP packets from the remote SIP server.
NetServices.CreateRtpSocket(dstRtpEndPoint.AddressFamily == AddressFamily.InterNetworkV6 ? IPAddress.IPv6Any : IPAddress.Any, RTP_PORT_START, RTP_PORT_END, false, out rtpSocket, out controlSocket);
// The RTP socket is listening on IPAddress.Any but the IP address placed into the SDP needs to be one the caller can reach.
IPAddress rtpAddress = NetServices.GetLocalAddressForRemote(dstRtpEndPoint.Address);
IPEndPoint rtpEndPoint = new IPEndPoint(rtpAddress, (rtpSocket.LocalEndPoint as IPEndPoint).Port);
var rtpTask = Task.Run(() => SendRecvRtp(rtpSocket, rtpSession, dstRtpEndPoint, audioFile, rtpCts))
.ContinueWith(_ =>
{
if (uas?.IsHungup == false)
{
uas?.Hangup(false);
}
});
uas.Answer(SDP.SDP_MIME_CONTENTTYPE, GetSDP(rtpEndPoint).ToString(), null, SIPDialogueTransferModesEnum.NotAllowed);
}
}
else if (sipRequest.Method == SIPMethodsEnum.BYE)
{
SIPSorcery.Sys.Log.Logger.LogInformation("Call hungup.");
SIPNonInviteTransaction byeTransaction = sipTransport.CreateNonInviteTransaction(sipRequest, null);
SIPResponse byeResponse = SIPTransport.GetResponse(sipRequest, SIPResponseStatusCodesEnum.Ok, null);
byeTransaction.SendFinalResponse(byeResponse);
uas?.Hangup(true);
rtpCts?.Cancel();
rtpSocket?.Close();
controlSocket?.Close();
}
else if (sipRequest.Method == SIPMethodsEnum.SUBSCRIBE)
{
SIPResponse notAllowededResponse = SIPTransport.GetResponse(sipRequest, SIPResponseStatusCodesEnum.MethodNotAllowed, null);
sipTransport.SendResponse(notAllowededResponse);
}
else if (sipRequest.Method == SIPMethodsEnum.OPTIONS || sipRequest.Method == SIPMethodsEnum.REGISTER)
{
SIPResponse optionsResponse = SIPTransport.GetResponse(sipRequest, SIPResponseStatusCodesEnum.Ok, null);
sipTransport.SendResponse(optionsResponse);
}
}
catch (Exception reqExcp)
{
SIPSorcery.Sys.Log.Logger.LogWarning($"Exception handling {sipRequest.Method}. {reqExcp.Message}");
}
};
ManualResetEvent exitMre = new ManualResetEvent(false);
Console.CancelKeyPress += delegate(object sender, ConsoleCancelEventArgs e)
{
e.Cancel = true;
SIPSorcery.Sys.Log.Logger.LogInformation("Exiting...");
Hangup(uas).Wait();
rtpCts?.Cancel();
rtpSocket?.Close();
controlSocket?.Close();
if (sipTransport != null)
{
SIPSorcery.Sys.Log.Logger.LogInformation("Shutting down SIP transport...");
sipTransport.Shutdown();
}
exitMre.Set();
};
Task.Run(() =>
{
try
{
while (!exitMre.WaitOne(0))
{
var keyProps = Console.ReadKey();
if (keyProps.KeyChar == 'h' || keyProps.KeyChar == 'q')
{
Console.WriteLine();
Console.WriteLine("Hangup requested by user...");
Hangup(uas).Wait();
rtpCts?.Cancel();
rtpSocket?.Close();
controlSocket?.Close();
}
if (keyProps.KeyChar == 'q')
{
SIPSorcery.Sys.Log.Logger.LogInformation("Quitting...");
if (sipTransport != null)
{
SIPSorcery.Sys.Log.Logger.LogInformation("Shutting down SIP transport...");
sipTransport.Shutdown();
}
exitMre.Set();
}
}
}
catch (Exception excp)
{
SIPSorcery.Sys.Log.Logger.LogError($"Exception Key Press listener. {excp.Message}.");
}
});
exitMre.WaitOne();
}
static void Main()
{
Console.WriteLine("SIPSorcery client user agent example.");
Console.WriteLine("Press ctrl-c to exit.");
// Plumbing code to facilitate a graceful exit.
CancellationTokenSource rtpCts = new CancellationTokenSource(); // Cancellation token to stop the RTP stream.
bool isCallHungup = false;
bool hasCallFailed = false;
AddConsoleLogger();
SIPURI callUri = SIPURI.ParseSIPURI(DEFAULT_DESTINATION_SIP_URI);
Log.LogInformation($"Call destination {callUri}.");
// Set up a default SIP transport.
var sipTransport = new SIPTransport();
int port = SIPConstants.DEFAULT_SIP_PORT + 1000;
sipTransport.AddSIPChannel(new SIPUDPChannel(new IPEndPoint(IPAddress.Any, port)));
// Uncomment this line to see each SIP message sent and received.
EnableTraceLogs(sipTransport);
// Send an OPTIONS request to determine the local IP address to use for the RTP socket.
var optionsTask = SendOptionsTaskAsync(sipTransport, callUri);
var result = Task.WhenAny(optionsTask, Task.Delay(SIP_REQUEST_TIMEOUT_MILLISECONDS));
result.Wait();
if (optionsTask.IsCompletedSuccessfully == false || optionsTask.Result == null)
{
Log.LogError($"OPTIONS request to {callUri} failed.");
}
else
{
IPAddress localIPAddress = optionsTask.Result;
// Initialise an RTP session to receive the RTP packets from the remote SIP server.
Socket rtpSocket = null;
Socket controlSocket = null;
NetServices.CreateRtpSocket(localIPAddress, 49000, 49100, false, out rtpSocket, out controlSocket);
var rtpRecvSession = new RTPSession((int)RTPPayloadTypesEnum.PCMU, null, null);
var rtpSendSession = new RTPSession((int)RTPPayloadTypesEnum.PCMU, null, null);
// Create a client user agent to place a call to a remote SIP server along with event handlers for the different stages of the call.
var uac = new SIPClientUserAgent(sipTransport);
uac.CallTrying += (uac, resp) =>
{
Log.LogInformation($"{uac.CallDescriptor.To} Trying: {resp.StatusCode} {resp.ReasonPhrase}.");
Log.LogDebug(resp.ToString());
};
uac.CallRinging += (uac, resp) => Log.LogInformation($"{uac.CallDescriptor.To} Ringing: {resp.StatusCode} {resp.ReasonPhrase}.");
uac.CallFailed += (uac, err) =>
{
Log.LogWarning($"{uac.CallDescriptor.To} Failed: {err}");
hasCallFailed = true;
};
uac.CallAnswered += (uac, resp) =>
{
if (resp.Status == SIPResponseStatusCodesEnum.Ok)
{
Log.LogInformation($"{uac.CallDescriptor.To} Answered: {resp.StatusCode} {resp.ReasonPhrase}.");
_remoteRtpEndPoint = SDP.GetSDPRTPEndPoint(resp.Body);
Log.LogDebug($"Remote RTP socket {_remoteRtpEndPoint}.");
}
else
{
Log.LogWarning($"{uac.CallDescriptor.To} Answered: {resp.StatusCode} {resp.ReasonPhrase}.");
}
};
// The only incoming request that needs to be explicitly handled for this example is if the remote end hangs up the call.
sipTransport.SIPTransportRequestReceived += (SIPEndPoint localSIPEndPoint, SIPEndPoint remoteEndPoint, SIPRequest sipRequest) =>
{
if (sipRequest.Method == SIPMethodsEnum.BYE)
{
SIPNonInviteTransaction byeTransaction = sipTransport.CreateNonInviteTransaction(sipRequest, remoteEndPoint, localSIPEndPoint, null);
SIPResponse byeResponse = SIPTransport.GetResponse(sipRequest, SIPResponseStatusCodesEnum.Ok, null);
byeTransaction.SendFinalResponse(byeResponse);
if (uac.IsUACAnswered)
{
Log.LogInformation("Call was hungup by remote server.");
isCallHungup = true;
rtpCts.Cancel();
}
}
};
// It's a good idea to start the RTP receiving socket before the call request is sent.
// A SIP server will generally start sending RTP as soon as it has processed the incoming call request and
// being ready to receive will stop any ICMP error response being generated.
Task.Run(() => RecvRtp(rtpSocket, rtpRecvSession, rtpCts));
Task.Run(() => SendRtp(rtpSocket, rtpSendSession, rtpCts));
// Start the thread that places the call.
SIPCallDescriptor callDescriptor = new SIPCallDescriptor(
SIPConstants.SIP_DEFAULT_USERNAME,
null,
callUri.ToString(),
SIPConstants.SIP_DEFAULT_FROMURI,
null, null, null, null,
SIPCallDirection.Out,
SDP.SDP_MIME_CONTENTTYPE,
GetSDP(rtpSocket.LocalEndPoint as IPEndPoint).ToString(),
null);
uac.Call(callDescriptor);
// Ctrl-c will gracefully exit the call at any point.
Console.CancelKeyPress += delegate(object sender, ConsoleCancelEventArgs e)
{
e.Cancel = true;
rtpCts.Cancel();
};
// At this point the call is established. We'll wait for a few seconds and then transfer.
Task.Delay(DELAY_UNTIL_TRANSFER_MILLISECONDS).Wait();
SIPRequest referRequest = GetReferRequest(uac, SIPURI.ParseSIPURI(TRANSFER_DESTINATION_SIP_URI));
SIPNonInviteTransaction referTx = sipTransport.CreateNonInviteTransaction(referRequest, referRequest.RemoteSIPEndPoint, referRequest.LocalSIPEndPoint, null);
referTx.NonInviteTransactionFinalResponseReceived += (SIPEndPoint localSIPEndPoint, SIPEndPoint remoteEndPoint, SIPTransaction sipTransaction, SIPResponse sipResponse) =>
{
if (sipResponse.Header.CSeqMethod == SIPMethodsEnum.REFER && sipResponse.Status == SIPResponseStatusCodesEnum.Accepted)
{
Log.LogInformation("Call transfer was accepted by remote server.");
isCallHungup = true;
rtpCts.Cancel();
}
};
referTx.SendReliableRequest();
// At this point the call transfer has been initiated and everything will be handled in an event handler or on the RTP
// receive task. The code below is to gracefully exit.
// Wait for a signal saying the call failed, was cancelled with ctrl-c or completed.
rtpCts.Token.WaitHandle.WaitOne();
Log.LogInformation("Exiting...");
rtpSocket?.Close();
controlSocket?.Close();
if (!isCallHungup && uac != null)
{
if (uac.IsUACAnswered)
{
Log.LogInformation($"Hanging up call to {uac.CallDescriptor.To}.");
uac.Hangup();
}
else if (!hasCallFailed)
{
Log.LogInformation($"Cancelling call to {uac.CallDescriptor.To}.");
uac.Cancel();
}
// Give the BYE or CANCEL request time to be transmitted.
Log.LogInformation("Waiting 1s for call to clean up...");
Task.Delay(1000).Wait();
}
}
SIPSorcery.Net.DNSManager.Stop();
if (sipTransport != null)
{
Log.LogInformation("Shutting down SIP transport...");
sipTransport.Shutdown();
}
}
private static ConcurrentQueue <RTPEvent> _dtmfEvents = new ConcurrentQueue <RTPEvent>(); // Add a DTMF event to this queue to have the it sent
static void Main()
{
Console.WriteLine("SIPSorcery client user agent example.");
Console.WriteLine("Press ctrl-c to exit.");
// Plumbing code to facilitate a graceful exit.
CancellationTokenSource rtpCts = new CancellationTokenSource(); // Cancellation token to stop the RTP stream.
bool isCallHungup = false;
bool hasCallFailed = false;
AddConsoleLogger();
SIPURI callUri = SIPURI.ParseSIPURI(DEFAULT_DESTINATION_SIP_URI);
Log.LogInformation($"Call destination {callUri}.");
// Set up a default SIP transport.
var sipTransport = new SIPTransport();
sipTransport.AddSIPChannel(new SIPUDPChannel(new IPEndPoint(IPAddress.Any, 0)));
// Un/comment this line to see/hide each SIP message sent and received.
EnableTraceLogs(sipTransport);
// Note this relies on the callURI host being an IP address. If it's a hostname a DNS lookup is required.
IPAddress localIPAddress = NetServices.GetLocalAddressForRemote(callUri.ToSIPEndPoint().Address);
// Initialise an RTP session to receive the RTP packets from the remote SIP server.
Socket rtpSocket = null;
Socket controlSocket = null;
NetServices.CreateRtpSocket(localIPAddress, 49000, 49100, false, out rtpSocket, out controlSocket);
var rtpRecvSession = new RTPSession((int)RTPPayloadTypesEnum.PCMU, null, null);
var rtpSendSession = new RTPSession((int)RTPPayloadTypesEnum.PCMU, null, null);
// Create a client user agent to place a call to a remote SIP server along with event handlers for the different stages of the call.
var uac = new SIPClientUserAgent(sipTransport);
uac.CallTrying += (uac, resp) =>
{
Log.LogInformation($"{uac.CallDescriptor.To} Trying: {resp.StatusCode} {resp.ReasonPhrase}.");
};
uac.CallRinging += (uac, resp) => Log.LogInformation($"{uac.CallDescriptor.To} Ringing: {resp.StatusCode} {resp.ReasonPhrase}.");
uac.CallFailed += (uac, err) =>
{
Log.LogWarning($"{uac.CallDescriptor.To} Failed: {err}");
hasCallFailed = true;
};
uac.CallAnswered += (uac, resp) =>
{
if (resp.Status == SIPResponseStatusCodesEnum.Ok)
{
Log.LogInformation($"{uac.CallDescriptor.To} Answered: {resp.StatusCode} {resp.ReasonPhrase}.");
_remoteRtpEndPoint = SDP.GetSDPRTPEndPoint(resp.Body);
Log.LogDebug($"Remote RTP socket {_remoteRtpEndPoint}.");
}
else
{
Log.LogWarning($"{uac.CallDescriptor.To} Answered: {resp.StatusCode} {resp.ReasonPhrase}.");
}
};
// The only incoming request that needs to be explicitly handled for this example is if the remote end hangs up the call.
sipTransport.SIPTransportRequestReceived += (SIPEndPoint localSIPEndPoint, SIPEndPoint remoteEndPoint, SIPRequest sipRequest) =>
{
if (sipRequest.Method == SIPMethodsEnum.BYE)
{
SIPNonInviteTransaction byeTransaction = sipTransport.CreateNonInviteTransaction(sipRequest, null);
SIPResponse byeResponse = SIPTransport.GetResponse(sipRequest, SIPResponseStatusCodesEnum.Ok, null);
byeTransaction.SendFinalResponse(byeResponse);
if (uac.IsUACAnswered)
{
Log.LogInformation("Call was hungup by remote server.");
isCallHungup = true;
rtpCts.Cancel();
}
}
};
// It's a good idea to start the RTP receiving socket before the call request is sent.
// A SIP server will generally start sending RTP as soon as it has processed the incoming call request and
// being ready to receive will stop any ICMP error response being generated.
Task.Run(() => RecvRtp(rtpSocket, rtpRecvSession, rtpCts));
Task.Run(() => SendRtp(rtpSocket, rtpSendSession, rtpCts));
// Start the thread that places the call.
SIPCallDescriptor callDescriptor = new SIPCallDescriptor(
SIPConstants.SIP_DEFAULT_USERNAME,
null,
callUri.ToString(),
SIPConstants.SIP_DEFAULT_FROMURI,
null, null, null, null,
SIPCallDirection.Out,
SDP.SDP_MIME_CONTENTTYPE,
GetSDP(rtpSocket.LocalEndPoint as IPEndPoint, RTPPayloadTypesEnum.PCMU).ToString(),
null);
uac.Call(callDescriptor);
// Ctrl-c will gracefully exit the call at any point.
Console.CancelKeyPress += delegate(object sender, ConsoleCancelEventArgs e)
{
e.Cancel = true;
rtpCts.Cancel();
};
// At this point the call has been initiated and everything will be handled in an event handler or on the RTP
// receive task. The code below is to gracefully exit.
Task.Delay(3000).Wait();
// Add some DTMF events to the queue. These will be transmitted by the SendRtp thread.
_dtmfEvents.Enqueue(new RTPEvent(0x05, false, RTPEvent.DEFAULT_VOLUME, 1200, DTMF_EVENT_PAYLOAD_ID));
Task.Delay(2000, rtpCts.Token).Wait();
_dtmfEvents.Enqueue(new RTPEvent(0x09, false, RTPEvent.DEFAULT_VOLUME, 1200, DTMF_EVENT_PAYLOAD_ID));
Task.Delay(2000, rtpCts.Token).Wait();
_dtmfEvents.Enqueue(new RTPEvent(0x02, false, RTPEvent.DEFAULT_VOLUME, 1200, DTMF_EVENT_PAYLOAD_ID));
Task.Delay(2000, rtpCts.Token).Wait();
Log.LogInformation("Exiting...");
rtpCts.Cancel();
rtpSocket?.Close();
controlSocket?.Close();
if (!isCallHungup && uac != null)
{
if (uac.IsUACAnswered)
{
Log.LogInformation($"Hanging up call to {uac.CallDescriptor.To}.");
uac.Hangup();
}
else if (!hasCallFailed)
{
Log.LogInformation($"Cancelling call to {uac.CallDescriptor.To}.");
uac.Cancel();
}
// Give the BYE or CANCEL request time to be transmitted.
Log.LogInformation("Waiting 1s for call to clean up...");
Task.Delay(1000).Wait();
}
SIPSorcery.Net.DNSManager.Stop();
if (sipTransport != null)
{
Log.LogInformation("Shutting down SIP transport...");
sipTransport.Shutdown();
}
}
private static readonly int RTP_REPORTING_PERIOD_SECONDS = 5; // Period at which to write RTP stats.
static void Main()
{
Console.WriteLine("SIPSorcery client user agent server example.");
Console.WriteLine("Press ctrl-c to exit.");
// Logging configuration. Can be ommitted if internal SIPSorcery debug and warning messages are not required.
var loggerFactory = new Microsoft.Extensions.Logging.LoggerFactory();
var loggerConfig = new LoggerConfiguration()
.Enrich.FromLogContext()
.MinimumLevel.Is(Serilog.Events.LogEventLevel.Debug)
.WriteTo.Console()
.CreateLogger();
loggerFactory.AddSerilog(loggerConfig);
SIPSorcery.Sys.Log.LoggerFactory = loggerFactory;
// Set up a default SIP transport.
IPAddress defaultAddr = LocalIPConfig.GetDefaultIPv4Address();
var sipTransport = new SIPTransport(SIPDNSManager.ResolveSIPService, new SIPTransactionEngine());
int port = FreePort.FindNextAvailableUDPPort(SIPConstants.DEFAULT_SIP_PORT);
var sipChannel = new SIPUDPChannel(new IPEndPoint(defaultAddr, port));
sipTransport.AddSIPChannel(sipChannel);
// To keep things a bit simpler this example only supports a single call at a time and the SIP server user agent
// acts as a singleton
SIPServerUserAgent uas = null;
CancellationTokenSource uasCts = null;
// Because this is a server user agent the SIP transport must start listening for client user agents.
sipTransport.SIPTransportRequestReceived += (SIPEndPoint localSIPEndPoint, SIPEndPoint remoteEndPoint, SIPRequest sipRequest) =>
{
if (sipRequest.Method == SIPMethodsEnum.INVITE)
{
SIPSorcery.Sys.Log.Logger.LogInformation("Incoming call request: " + localSIPEndPoint + "<-" + remoteEndPoint + " " + sipRequest.URI.ToString() + ".");
// If there's already a call in progress hang it up. Of course this is not ideal for a real softphone or server but it
// means this example can be kept a little it simpler.
uas?.Hangup();
UASInviteTransaction uasTransaction = sipTransport.CreateUASTransaction(sipRequest, remoteEndPoint, localSIPEndPoint, null);
uas = new SIPServerUserAgent(sipTransport, null, null, null, SIPCallDirection.In, null, null, null, uasTransaction);
uasCts = new CancellationTokenSource();
uas.Progress(SIPResponseStatusCodesEnum.Trying, null, null, null, null);
uas.Progress(SIPResponseStatusCodesEnum.Ringing, null, null, null, null);
// Initialise an RTP session to receive the RTP packets from the remote SIP server.
Socket rtpSocket = null;
Socket controlSocket = null;
NetServices.CreateRtpSocket(defaultAddr, 49000, 49100, false, out rtpSocket, out controlSocket);
IPEndPoint rtpEndPoint = rtpSocket.LocalEndPoint as IPEndPoint;
IPEndPoint dstRtpEndPoint = SDP.GetSDPRTPEndPoint(sipRequest.Body);
var rtpSession = new RTPSession((int)RTPPayloadTypesEnum.PCMU, null, null);
var rtpTask = Task.Run(() => SendRecvRtp(rtpSocket, rtpSession, dstRtpEndPoint, AUDIO_FILE, uasCts))
.ContinueWith(_ => { if (uas?.IsHungup == false)
{
uas?.Hangup();
}
});
uas.Answer(SDP.SDP_MIME_CONTENTTYPE, GetSDP(rtpEndPoint).ToString(), null, SIPDialogueTransferModesEnum.NotAllowed);
}
else if (sipRequest.Method == SIPMethodsEnum.BYE)
{
SIPSorcery.Sys.Log.Logger.LogInformation("Call hungup.");
SIPNonInviteTransaction byeTransaction = sipTransport.CreateNonInviteTransaction(sipRequest, remoteEndPoint, localSIPEndPoint, null);
SIPResponse byeResponse = SIPTransport.GetResponse(sipRequest, SIPResponseStatusCodesEnum.Ok, null);
byeTransaction.SendFinalResponse(byeResponse);
uas?.Hangup();
uasCts?.Cancel();
}
};
Console.CancelKeyPress += delegate(object sender, ConsoleCancelEventArgs e)
{
e.Cancel = true;
SIPSorcery.Sys.Log.Logger.LogInformation("Exiting...");
if (uas?.IsHungup == false)
{
uas?.Hangup();
}
uasCts?.Cancel();
if (sipTransport != null)
{
SIPSorcery.Sys.Log.Logger.LogInformation("Shutting down SIP transport...");
sipTransport.Shutdown();
}
};
}
static void Main()
{
Console.WriteLine("SIPSorcery client user agent example.");
Console.WriteLine("Press ctrl-c to exit.");
CancellationTokenSource exitCts = new CancellationTokenSource(); // Cancellation token to stop the SIP transport and RTP stream.
AddConsoleLogger();
// Set up a default SIP transport.
var sipTransport = new SIPTransport();
sipTransport.AddSIPChannel(new SIPUDPChannel(new IPEndPoint(IPAddress.Any, SIP_LISTEN_PORT)));
// Un/comment this line to see/hide each SIP message sent and received.
EnableTraceLogs(sipTransport);
// To keep things a bit simpler this example only supports a single call at a time and the SIP server user agent
// acts as a singleton
SIPUserAgent userAgent = new SIPUserAgent(sipTransport, null);
CancellationTokenSource rtpCts = null; // Cancellation token to stop the RTP stream.
Socket rtpSocket = null;
Socket controlSocket = null;
// Because this is a server user agent the SIP transport must start listening for client user agents.
sipTransport.SIPTransportRequestReceived += (SIPEndPoint localSIPEndPoint, SIPEndPoint remoteEndPoint, SIPRequest sipRequest) =>
{
try
{
if (sipRequest.Header.From != null &&
sipRequest.Header.From.FromTag != null &&
sipRequest.Header.To != null &&
sipRequest.Header.To.ToTag != null)
{
userAgent.InDialogRequestReceivedAsync(sipRequest).Wait();
}
if (sipRequest.Method == SIPMethodsEnum.INVITE)
{
SIPSorcery.Sys.Log.Logger.LogInformation($"Incoming call request: {localSIPEndPoint}<-{remoteEndPoint} {sipRequest.URI}.");
// Check there's a codec we support in the INVITE offer.
var offerSdp = SDP.ParseSDPDescription(sipRequest.Body);
IPEndPoint dstRtpEndPoint = SDP.GetSDPRTPEndPoint(sipRequest.Body);
RTPSession rtpSession = null;
string audioFile = null;
if (offerSdp.Media.Any(x => x.Media == SDPMediaTypesEnum.audio && x.HasMediaFormat((int)RTPPayloadTypesEnum.PCMU)))
{
Log.LogDebug($"Using PCMU RTP media type and audio file {AUDIO_FILE_PCMU}.");
rtpSession = new RTPSession((int)RTPPayloadTypesEnum.PCMU, null, null);
audioFile = AUDIO_FILE_PCMU;
}
if (rtpSession == null)
{
// Didn't get a match on the codecs we support.
SIPResponse noMatchingCodecResponse = SIPTransport.GetResponse(sipRequest, SIPResponseStatusCodesEnum.NotAcceptableHere, null);
sipTransport.SendResponse(noMatchingCodecResponse);
}
else
{
// If there's already a call in progress hang it up. Of course this is not ideal for a real softphone or server but it
// means this example can be kept simpler.
if (userAgent?.IsAnswered == true)
{
userAgent?.Hangup();
}
rtpCts?.Cancel();
UASInviteTransaction uasTransaction = sipTransport.CreateUASTransaction(sipRequest, null);
if (userAgent.AcceptCall(uasTransaction))
{
rtpCts = new CancellationTokenSource();
// The RTP socket is listening on IPAddress.Any but the IP address placed into the SDP needs to be one the caller can reach.
IPAddress rtpAddress = NetServices.GetLocalAddressForRemote(dstRtpEndPoint.Address);
// Initialise an RTP session to receive the RTP packets from the remote SIP server.
NetServices.CreateRtpSocket(rtpAddress, RTP_PORT_START, RTP_PORT_END, false, out rtpSocket, out controlSocket);
var rtpRecvSession = new RTPSession((int)RTPPayloadTypesEnum.PCMU, null, null);
var rtpSendSession = new RTPSession((int)RTPPayloadTypesEnum.PCMU, null, null);
rtpSendSession.DestinationEndPoint = dstRtpEndPoint;
rtpRecvSession.OnReceiveFromEndPointChanged += (oldEP, newEP) =>
{
Log.LogDebug($"RTP destination end point changed from {oldEP} to {newEP}.");
rtpSendSession.DestinationEndPoint = newEP;
};
Task.Run(() => RecvRtp(rtpSocket, rtpRecvSession, rtpCts));
Task.Run(() => SendRtp(rtpSocket, rtpSendSession, rtpCts));
userAgent.Answer(GetSDP(rtpSocket.LocalEndPoint as IPEndPoint));
}
}
}
else if (sipRequest.Method == SIPMethodsEnum.SUBSCRIBE)
{
SIPResponse notAllowededResponse = SIPTransport.GetResponse(sipRequest, SIPResponseStatusCodesEnum.MethodNotAllowed, null);
sipTransport.SendResponse(notAllowededResponse);
}
else if (sipRequest.Method == SIPMethodsEnum.OPTIONS || sipRequest.Method == SIPMethodsEnum.REGISTER)
{
SIPResponse optionsResponse = SIPTransport.GetResponse(sipRequest, SIPResponseStatusCodesEnum.Ok, null);
sipTransport.SendResponse(optionsResponse);
}
}
catch (Exception reqExcp)
{
SIPSorcery.Sys.Log.Logger.LogWarning($"Exception handling {sipRequest.Method}. {reqExcp.Message}");
}
};
// Ctrl-c will gracefully exit the call at any point.
Console.CancelKeyPress += delegate(object sender, ConsoleCancelEventArgs e)
{
e.Cancel = true;
exitCts.Cancel();
rtpCts?.Cancel();
};
// At this point the call has been initiated and everything will be handled in an event handler.
Task.Run(async() =>
{
try
{
while (!exitCts.Token.WaitHandle.WaitOne(0))
{
var keyProps = Console.ReadKey();
if (keyProps.KeyChar == 't')
{
// Initiate a transfer.
bool transferResult = await userAgent.Transfer(SIPURI.ParseSIPURI(TRANSFER_DESTINATION_SIP_URI), new TimeSpan(0, 0, TRANSFER_TIMEOUT_SECONDS), exitCts.Token);
if (transferResult)
{
// If the transfer was accepted the original call will already have been hungup.
userAgent = null;
exitCts.Cancel();
}
else
{
Log.LogWarning($"Transfer to {TRANSFER_DESTINATION_SIP_URI} failed.");
}
}
else if (keyProps.KeyChar == 'q')
{
// Quit application.
exitCts.Cancel();
}
}
}
catch (Exception excp)
{
Log.LogError($"Exception Key Press listener. {excp.Message}.");
}
});
// Wait for a signal saying the call failed, was cancelled with ctrl-c or completed.
exitCts.Token.WaitHandle.WaitOne();
Log.LogInformation("Exiting...");
rtpSocket?.Close();
controlSocket?.Close();
if (userAgent != null)
{
if (userAgent.IsAnswered)
{
Log.LogInformation($"Hanging up call to {userAgent?.CallDescriptor?.To}.");
userAgent.Hangup();
}
// Give the final request time to be transmitted.
Log.LogInformation("Waiting 1s for call to clean up...");
Task.Delay(1000).Wait();
}
SIPSorcery.Net.DNSManager.Stop();
if (sipTransport != null)
{
Log.LogInformation("Shutting down SIP transport...");
sipTransport.Shutdown();
}
}
private void OnPacketReceived(UdpReceiver receiver, int localPort, IPEndPoint remoteEndPoint, byte[] packet)
{
STUNMessage stunMessage = STUNMessage.ParseSTUNMessage(packet, packet.Length);
switch (stunMessage.Header.MessageType)
{
case STUNMessageTypesEnum.Allocate:
logger.LogDebug($"MockTurnServer received Allocate request from {remoteEndPoint}.");
if (_relaySocket == null)
{
_clientEndPoint = remoteEndPoint;
// Create a new relay socket.
NetServices.CreateRtpSocket(false, _listenAddress, 0, out _relaySocket, out _);
_relayEndPoint = _relaySocket.LocalEndPoint as IPEndPoint;
logger.LogDebug($"MockTurnServer created relay socket on {_relayEndPoint}.");
_relayListener = new UdpReceiver(_relaySocket);
_relayListener.OnPacketReceived += OnRelayPacketReceived;
_relayListener.OnClosed += (reason) => logger.LogDebug($"MockTurnServer relay on {_relayEndPoint} closed.");
_relayListener.BeginReceiveFrom();
}
STUNMessage allocateResponse = new STUNMessage(STUNMessageTypesEnum.AllocateSuccessResponse);
allocateResponse.Header.TransactionId = stunMessage.Header.TransactionId;
allocateResponse.AddXORMappedAddressAttribute(remoteEndPoint.Address, remoteEndPoint.Port);
allocateResponse.AddXORAddressAttribute(STUNAttributeTypesEnum.XORRelayedAddress, _relayEndPoint.Address, _relayEndPoint.Port);
_clientSocket.SendTo(allocateResponse.ToByteBuffer(null, false), remoteEndPoint);
break;
case STUNMessageTypesEnum.BindingRequest:
logger.LogDebug($"MockTurnServer received Binding request from {remoteEndPoint}.");
STUNMessage stunResponse = new STUNMessage(STUNMessageTypesEnum.BindingSuccessResponse);
stunResponse.Header.TransactionId = stunMessage.Header.TransactionId;
stunResponse.AddXORMappedAddressAttribute(remoteEndPoint.Address, remoteEndPoint.Port);
_clientSocket.SendTo(stunResponse.ToByteBuffer(null, false), remoteEndPoint);
break;
case STUNMessageTypesEnum.CreatePermission:
logger.LogDebug($"MockTurnServer received CreatePermission request from {remoteEndPoint}.");
STUNMessage permResponse = new STUNMessage(STUNMessageTypesEnum.CreatePermissionSuccessResponse);
permResponse.Header.TransactionId = stunMessage.Header.TransactionId;
_clientSocket.SendTo(permResponse.ToByteBuffer(null, false), remoteEndPoint);
break;
case STUNMessageTypesEnum.SendIndication:
logger.LogDebug($"MockTurnServer received SendIndication request from {remoteEndPoint}.");
var buffer = stunMessage.Attributes.Single(x => x.AttributeType == STUNAttributeTypesEnum.Data).Value;
var destEP = (stunMessage.Attributes.Single(x => x.AttributeType == STUNAttributeTypesEnum.XORPeerAddress) as STUNXORAddressAttribute).GetIPEndPoint();
logger.LogDebug($"MockTurnServer relaying {buffer.Length} bytes to {destEP}.");
_relaySocket.SendTo(buffer, destEP);
break;
default:
logger.LogDebug($"MockTurnServer received unknown STUN message from {remoteEndPoint}.");
break;
}
}
static void Main(string[] args)
{
Console.WriteLine("SIPSorcery client user agent example.");
Console.WriteLine("Press ctrl-c to exit.");
// Plumbing code to facilitate a graceful exit.
CancellationTokenSource rtpCts = new CancellationTokenSource(); // Cancellation token to stop the RTP stream.
bool isCallHungup = false;
bool hasCallFailed = false;
// Logging configuration. Can be ommitted if internal SIPSorcery debug and warning messages are not required.
var loggerFactory = new Microsoft.Extensions.Logging.LoggerFactory();
var loggerConfig = new LoggerConfiguration()
.Enrich.FromLogContext()
.MinimumLevel.Is(Serilog.Events.LogEventLevel.Debug)
.WriteTo.Console()
.CreateLogger();
loggerFactory.AddSerilog(loggerConfig);
SIPSorcery.Sys.Log.LoggerFactory = loggerFactory;
SIPURI callUri = SIPURI.ParseSIPURI(DEFAULT_DESTINATION_SIP_URI);
if (args != null && args.Length > 0)
{
if (!SIPURI.TryParse(args[0]))
{
Log.LogWarning($"Command line argument could not be parsed as a SIP URI {args[0]}");
}
else
{
callUri = SIPURI.ParseSIPURIRelaxed(args[0]);
}
}
Log.LogInformation($"Call destination {callUri}.");
// Set up a default SIP transport.
var sipTransport = new SIPTransport();
int port = SIPConstants.DEFAULT_SIP_PORT + 1000;
IPAddress localAddress = sipTransport.GetLocalAddress(IPAddress.Parse("8.8.8.8"));
sipTransport.AddSIPChannel(new SIPUDPChannel(new IPEndPoint(localAddress, port)));
//sipTransport.AddSIPChannel(new SIPUDPChannel(new IPEndPoint(IPAddress.Any, port)));
//sipTransport.AddSIPChannel(new SIPUDPChannel(new IPEndPoint(IPAddress.IPv6Any, port)));
//EnableTraceLogs(sipTransport);
// Select the IP address to use for RTP based on the destination SIP URI.
var endPointForCall = callUri.ToSIPEndPoint() == null?sipTransport.GetDefaultSIPEndPoint(callUri.Protocol) : sipTransport.GetDefaultSIPEndPoint(callUri.ToSIPEndPoint());
// Initialise an RTP session to receive the RTP packets from the remote SIP server.
Socket rtpSocket = null;
Socket controlSocket = null;
// TODO (find something better): If the SIP endpoint is using 0.0.0.0 for SIP use loopback for RTP.
IPAddress rtpAddress = localAddress;
NetServices.CreateRtpSocket(rtpAddress, 49000, 49100, false, out rtpSocket, out controlSocket);
var rtpSendSession = new RTPSession((int)RTPPayloadTypesEnum.PCMU, null, null);
// Create a client user agent to place a call to a remote SIP server along with event handlers for the different stages of the call.
var uac = new SIPClientUserAgent(sipTransport);
uac.CallTrying += (uac, resp) =>
{
Log.LogInformation($"{uac.CallDescriptor.To} Trying: {resp.StatusCode} {resp.ReasonPhrase}.");
};
uac.CallRinging += (uac, resp) => Log.LogInformation($"{uac.CallDescriptor.To} Ringing: {resp.StatusCode} {resp.ReasonPhrase}.");
uac.CallFailed += (uac, err) =>
{
Log.LogWarning($"{uac.CallDescriptor.To} Failed: {err}");
hasCallFailed = true;
};
uac.CallAnswered += (uac, resp) =>
{
if (resp.Status == SIPResponseStatusCodesEnum.Ok)
{
Log.LogInformation($"{uac.CallDescriptor.To} Answered: {resp.StatusCode} {resp.ReasonPhrase}.");
IPEndPoint remoteRtpEndPoint = SDP.GetSDPRTPEndPoint(resp.Body);
Log.LogDebug($"Sending initial RTP packet to remote RTP socket {remoteRtpEndPoint}.");
// Send a dummy packet to open the NAT session on the RTP path.
rtpSendSession.SendAudioFrame(rtpSocket, remoteRtpEndPoint, 0, new byte[] { 0x00 });
}
else
{
Log.LogWarning($"{uac.CallDescriptor.To} Answered: {resp.StatusCode} {resp.ReasonPhrase}.");
}
};
// The only incoming request that needs to be explicitly handled for this example is if the remote end hangs up the call.
sipTransport.SIPTransportRequestReceived += (SIPEndPoint localSIPEndPoint, SIPEndPoint remoteEndPoint, SIPRequest sipRequest) =>
{
if (sipRequest.Method == SIPMethodsEnum.BYE)
{
SIPNonInviteTransaction byeTransaction = sipTransport.CreateNonInviteTransaction(sipRequest, remoteEndPoint, localSIPEndPoint, null);
SIPResponse byeResponse = SIPTransport.GetResponse(sipRequest, SIPResponseStatusCodesEnum.Ok, null);
byeTransaction.SendFinalResponse(byeResponse);
if (uac.IsUACAnswered)
{
Log.LogInformation("Call was hungup by remote server.");
isCallHungup = true;
rtpCts.Cancel();
}
}
};
// It's a good idea to start the RTP receiving socket before the call request is sent.
// A SIP server will generally start sending RTP as soon as it has processed the incoming call request and
// being ready to receive will stop any ICMP error response being generated.
Task.Run(() => SendRecvRtp(rtpSocket, rtpSendSession, rtpCts));
// Start the thread that places the call.
SIPCallDescriptor callDescriptor = new SIPCallDescriptor(
SIPConstants.SIP_DEFAULT_USERNAME,
null,
callUri.ToString(),
SIPConstants.SIP_DEFAULT_FROMURI,
null, null, null, null,
SIPCallDirection.Out,
SDP.SDP_MIME_CONTENTTYPE,
GetSDP(rtpSocket.LocalEndPoint as IPEndPoint).ToString(),
null);
uac.Call(callDescriptor);
// Ctrl-c will gracefully exit the call at any point.
Console.CancelKeyPress += delegate(object sender, ConsoleCancelEventArgs e)
{
e.Cancel = true;
rtpCts.Cancel();
};
// At this point the call has been initiated and everything will be handled in an event handler or on the RTP
// receive task. The code below is to gracefully exit.
// Wait for a signal saying the call failed, was cancelled with ctrl-c or completed.
rtpCts.Token.WaitHandle.WaitOne();
Log.LogInformation("Exiting...");
rtpSocket?.Close();
controlSocket?.Close();
if (!isCallHungup && uac != null)
{
if (uac.IsUACAnswered)
{
Log.LogInformation($"Hanging up call to {uac.CallDescriptor.To}.");
uac.Hangup();
}
else if (!hasCallFailed)
{
Log.LogInformation($"Cancelling call to {uac.CallDescriptor.To}.");
uac.Cancel();
}
// Give the BYE or CANCEL request time to be transmitted.
Log.LogInformation("Waiting 1s for call to clean up...");
Task.Delay(1000).Wait();
}
SIPSorcery.Net.DNSManager.Stop();
if (sipTransport != null)
{
Log.LogInformation("Shutting down SIP transport...");
sipTransport.Shutdown();
}
}
private static readonly int RTP_REPORTING_PERIOD_SECONDS = 5; // Period at which to write RTP stats.
static void Main()
{
Console.WriteLine("SIPSorcery client user agent example.");
Console.WriteLine("Press ctrl-c to exit.");
// Plumbing code to facilitate a graceful exit.
CancellationTokenSource cts = new CancellationTokenSource();
bool isCallHungup = false;
bool hasCallFailed = false;
// Logging configuration. Can be ommitted if internal SIPSorcery debug and warning messages are not required.
var loggerFactory = new Microsoft.Extensions.Logging.LoggerFactory();
var loggerConfig = new LoggerConfiguration()
.Enrich.FromLogContext()
.MinimumLevel.Is(Serilog.Events.LogEventLevel.Debug)
.WriteTo.Console()
.CreateLogger();
loggerFactory.AddSerilog(loggerConfig);
SIPSorcery.Sys.Log.LoggerFactory = loggerFactory;
// Set up a default SIP transport.
IPAddress defaultAddr = LocalIPConfig.GetDefaultIPv4Address();
var sipTransport = new SIPTransport(SIPDNSManager.ResolveSIPService, new SIPTransactionEngine());
int port = FreePort.FindNextAvailableUDPPort(SIPConstants.DEFAULT_SIP_PORT + 2);
var sipChannel = new SIPUDPChannel(new IPEndPoint(defaultAddr, port));
sipTransport.AddSIPChannel(sipChannel);
// Initialise an RTP session to receive the RTP packets from the remote SIP server.
Socket rtpSocket = null;
Socket controlSocket = null;
NetServices.CreateRtpSocket(defaultAddr, 49000, 49100, false, out rtpSocket, out controlSocket);
var rtpSendSession = new RTPSession((int)RTPPayloadTypesEnum.PCMU, null, null);
// Create a client user agent to place a call to a remote SIP server along with event handlers for the different stages of the call.
var uac = new SIPClientUserAgent(sipTransport);
uac.CallTrying += (uac, resp) => SIPSorcery.Sys.Log.Logger.LogInformation($"{uac.CallDescriptor.To} Trying: {resp.StatusCode} {resp.ReasonPhrase}.");
uac.CallRinging += (uac, resp) => SIPSorcery.Sys.Log.Logger.LogInformation($"{uac.CallDescriptor.To} Ringing: {resp.StatusCode} {resp.ReasonPhrase}.");
uac.CallFailed += (uac, err) =>
{
SIPSorcery.Sys.Log.Logger.LogWarning($"{uac.CallDescriptor.To} Failed: {err}");
hasCallFailed = true;
};
uac.CallAnswered += (uac, resp) =>
{
if (resp.Status == SIPResponseStatusCodesEnum.Ok)
{
SIPSorcery.Sys.Log.Logger.LogInformation($"{uac.CallDescriptor.To} Answered: {resp.StatusCode} {resp.ReasonPhrase}.");
IPEndPoint remoteRtpEndPoint = SDP.GetSDPRTPEndPoint(resp.Body);
SIPSorcery.Sys.Log.Logger.LogDebug($"Sending initial RTP packet to remote RTP socket {remoteRtpEndPoint}.");
// Send a dummy packet to open the NAT session on the RTP path.
rtpSendSession.SendAudioFrame(rtpSocket, remoteRtpEndPoint, 0, new byte[] { 0x00 });
}
else
{
SIPSorcery.Sys.Log.Logger.LogWarning($"{uac.CallDescriptor.To} Answered: {resp.StatusCode} {resp.ReasonPhrase}.");
}
};
// The only incoming request that needs to be explicitly handled for this example is if the remote end hangs up the call.
sipTransport.SIPTransportRequestReceived += (SIPEndPoint localSIPEndPoint, SIPEndPoint remoteEndPoint, SIPRequest sipRequest) =>
{
if (sipRequest.Method == SIPMethodsEnum.BYE)
{
SIPNonInviteTransaction byeTransaction = sipTransport.CreateNonInviteTransaction(sipRequest, remoteEndPoint, localSIPEndPoint, null);
SIPResponse byeResponse = SIPTransport.GetResponse(sipRequest, SIPResponseStatusCodesEnum.Ok, null);
byeTransaction.SendFinalResponse(byeResponse);
if (uac.IsUACAnswered)
{
SIPSorcery.Sys.Log.Logger.LogInformation("Call was hungup by remote server.");
isCallHungup = true;
cts.Cancel();
}
}
};
// It's a good idea to start the RTP receiving socket before the call request is sent.
// A SIP server will generally start sending RTP as soon as it has processed the incoming call request and
// being ready to receive will stop any ICMP error response being generated.
Task.Run(() => SendRecvRtp(rtpSocket, rtpSendSession, cts));
// Start the thread that places the call.
SIPCallDescriptor callDescriptor = new SIPCallDescriptor(
SIPConstants.SIP_DEFAULT_USERNAME,
null,
DESTINATION_SIP_URI,
SIPConstants.SIP_DEFAULT_FROMURI,
null, null, null, null,
SIPCallDirection.Out,
SDP.SDP_MIME_CONTENTTYPE,
GetSDP(rtpSocket.LocalEndPoint as IPEndPoint).ToString(),
null);
uac.Call(callDescriptor);
// At this point the call has been initiated and everything will be handled in an event handler or on the RTP
// receive task. The code below is to gracefully exit.
// Ctrl-c will gracefully exit the call at any point.
Console.CancelKeyPress += async delegate(object sender, ConsoleCancelEventArgs e)
{
e.Cancel = true;
cts.Cancel();
SIPSorcery.Sys.Log.Logger.LogInformation("Exiting...");
rtpSocket?.Close();
controlSocket?.Close();
if (!isCallHungup && uac != null)
{
if (uac.IsUACAnswered)
{
SIPSorcery.Sys.Log.Logger.LogInformation($"Hanging up call to {uac.CallDescriptor.To}.");
uac.Hangup();
}
else if (!hasCallFailed)
{
SIPSorcery.Sys.Log.Logger.LogInformation($"Cancelling call to {uac.CallDescriptor.To}.");
uac.Cancel();
}
// Give the BYE or CANCEL request time to be transmitted.
SIPSorcery.Sys.Log.Logger.LogInformation("Waiting 1s for call to clean up...");
await Task.Delay(1000);
}
SIPSorcery.Net.DNSManager.Stop();
if (sipTransport != null)
{
SIPSorcery.Sys.Log.Logger.LogInformation("Shutting down SIP transport...");
sipTransport.Shutdown();
}
};
}
static void Main()
{
Console.WriteLine("SIPSorcery call hold example.");
Console.WriteLine("Press ctrl-c to exit.");
// Plumbing code to facilitate a graceful exit.
CancellationTokenSource exitCts = new CancellationTokenSource(); // Cancellation token to stop the SIP trnasport and RTP stream.
bool isCallHungup = false;
bool hasCallFailed = false;
AddConsoleLogger();
SIPURI callUri = SIPURI.ParseSIPURI(DEFAULT_DESTINATION_SIP_URI);
Log.LogInformation($"Call destination {callUri}.");
// Set up a default SIP transport.
var sipTransport = new SIPTransport();
sipTransport.AddSIPChannel(new SIPUDPChannel(new IPEndPoint(IPAddress.Any, 0)));
EnableTraceLogs(sipTransport);
var lookupResult = SIPDNSManager.ResolveSIPService(callUri, false);
Log.LogDebug($"DNS lookup result for {callUri}: {lookupResult?.GetSIPEndPoint()}.");
var dstAddress = lookupResult.GetSIPEndPoint().Address;
IPAddress localIPAddress = NetServices.GetLocalAddressForRemote(dstAddress);
// Initialise an RTP session to receive the RTP packets from the remote SIP server.
Socket rtpSocket = null;
Socket controlSocket = null;
NetServices.CreateRtpSocket(localIPAddress, 48000, 48100, false, out rtpSocket, out controlSocket);
var rtpRecvSession = new RTPSession((int)RTPPayloadTypesEnum.PCMU, null, null);
var rtpSendSession = new RTPSession((int)RTPPayloadTypesEnum.PCMU, null, null);
// Create a client user agent to place a call to a remote SIP server along with event handlers for the different stages of the call.
var uac = new SIPClientUserAgent(sipTransport);
uac.CallTrying += (uac, resp) =>
{
Log.LogInformation($"{uac.CallDescriptor.To} Trying: {resp.StatusCode} {resp.ReasonPhrase}.");
};
uac.CallRinging += (uac, resp) => Log.LogInformation($"{uac.CallDescriptor.To} Ringing: {resp.StatusCode} {resp.ReasonPhrase}.");
uac.CallFailed += (uac, err) =>
{
Log.LogWarning($"{uac.CallDescriptor.To} Failed: {err}");
hasCallFailed = true;
};
uac.CallAnswered += (uac, resp) =>
{
if (resp.Status == SIPResponseStatusCodesEnum.Ok)
{
Log.LogInformation($"{uac.CallDescriptor.To} Answered: {resp.StatusCode} {resp.ReasonPhrase}.");
// Only set the remote RTP end point if there hasn't already been a packet received on it.
if (_remoteRtpEndPoint == null)
{
_remoteRtpEndPoint = SDP.GetSDPRTPEndPoint(resp.Body);
Log.LogDebug($"Remote RTP socket {_remoteRtpEndPoint}.");
}
}
else
{
Log.LogWarning($"{uac.CallDescriptor.To} Answered: {resp.StatusCode} {resp.ReasonPhrase}.");
}
};
// The only incoming request that needs to be explicitly handled for this example is if the remote end hangs up the call.
sipTransport.SIPTransportRequestReceived += (SIPEndPoint localSIPEndPoint, SIPEndPoint remoteEndPoint, SIPRequest sipRequest) =>
{
if (sipRequest.Method == SIPMethodsEnum.BYE)
{
SIPNonInviteTransaction byeTransaction = sipTransport.CreateNonInviteTransaction(sipRequest, null);
SIPResponse byeResponse = SIPTransport.GetResponse(sipRequest, SIPResponseStatusCodesEnum.Ok, null);
byeTransaction.SendFinalResponse(byeResponse);
if (uac.IsUACAnswered)
{
Log.LogInformation("Call was hungup by remote server.");
isCallHungup = true;
exitCts.Cancel();
}
}
};
// It's a good idea to start the RTP receiving socket before the call request is sent.
// A SIP server will generally start sending RTP as soon as it has processed the incoming call request and
// being ready to receive will stop any ICMP error response being generated.
Task.Run(() => RecvRtp(rtpSocket, rtpRecvSession, exitCts));
Task.Run(() => SendRtp(rtpSocket, rtpSendSession, exitCts));
// Start the thread that places the call.
SIPCallDescriptor callDescriptor = new SIPCallDescriptor(
SIP_USERNAME,
SIP_PASSWORD,
callUri.ToString(),
$"sip:{SIP_USERNAME}@localhost",
callUri.CanonicalAddress,
null, null, null,
SIPCallDirection.Out,
SDP.SDP_MIME_CONTENTTYPE,
GetSDP(rtpSocket.LocalEndPoint as IPEndPoint).ToString(),
null);
uac.Call(callDescriptor);
// Ctrl-c will gracefully exit the call at any point.
Console.CancelKeyPress += delegate(object sender, ConsoleCancelEventArgs e)
{
e.Cancel = true;
exitCts.Cancel();
};
// At this point the call has been initiated and everything will be handled in an event handler.
Task.Run(() =>
{
try
{
while (!exitCts.Token.WaitHandle.WaitOne(0))
{
var keyProps = Console.ReadKey();
if (keyProps.KeyChar == 'h')
{
}
else if (keyProps.KeyChar == 'q')
{
Console.WriteLine();
Console.WriteLine("Hangup requested by user...");
uac.Hangup();
exitCts.Cancel();
rtpSocket?.Close();
controlSocket?.Close();
SIPSorcery.Sys.Log.Logger.LogInformation("Quitting...");
if (sipTransport != null)
{
SIPSorcery.Sys.Log.Logger.LogInformation("Shutting down SIP transport...");
sipTransport.Shutdown();
}
}
}
}
catch (Exception excp)
{
SIPSorcery.Sys.Log.Logger.LogError($"Exception Key Press listener. {excp.Message}.");
}
});
// Wait for a signal saying the call failed, was cancelled with ctrl-c or completed.
exitCts.Token.WaitHandle.WaitOne();
Log.LogInformation("Exiting...");
rtpSocket?.Close();
controlSocket?.Close();
if (!isCallHungup && uac != null)
{
if (uac.IsUACAnswered)
{
Log.LogInformation($"Hanging up call to {uac.CallDescriptor.To}.");
uac.Hangup();
}
else if (!hasCallFailed)
{
Log.LogInformation($"Cancelling call to {uac.CallDescriptor.To}.");
uac.Cancel();
}
// Give the BYE or CANCEL request time to be transmitted.
Log.LogInformation("Waiting 1s for call to clean up...");
Task.Delay(1000).Wait();
}
SIPSorcery.Net.DNSManager.Stop();
if (sipTransport != null)
{
Log.LogInformation("Shutting down SIP transport...");
sipTransport.Shutdown();
}
}