1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
|
"""Voice over IP (VoIP) implementation."""
import asyncio
import logging
import socket
import struct
import time
from abc import ABC, abstractmethod
from dataclasses import dataclass
from functools import partial
from typing import Any, Callable, Optional, Set
from .const import OPUS_PAYLOAD_TYPE
from .rtp_audio import RtpOpusInput, RtpOpusOutput
from .sip import CallInfo, SdpInfo, SipDatagramProtocol
_LOGGER = logging.getLogger(__name__)
_RTCP_BYE = 203
@dataclass
class RtcpState:
"""State of a call according to RTCP packets received."""
bye_callback: Optional[Callable[[], None]] = None
CallProtocolFactory = Callable[[CallInfo, RtcpState], asyncio.Protocol]
class VoipDatagramProtocol(SipDatagramProtocol):
"""UDP server for Voice over IP (VoIP)."""
def __init__(
self,
sdp_info: SdpInfo,
valid_protocol_factory: CallProtocolFactory,
invalid_protocol_factory: Optional[CallProtocolFactory] = None,
) -> None:
"""Set up VoIP call handler."""
super().__init__(sdp_info)
self.valid_protocol_factory = valid_protocol_factory
self.invalid_protocol_factory = invalid_protocol_factory
self._tasks: Set[asyncio.Future[Any]] = set()
def is_valid_call(self, call_info: CallInfo) -> bool:
"""Filter calls."""
return True
def on_call(self, call_info: CallInfo):
"""Answer incoming calls and start RTP server on a random port."""
protocol_factory = (
self.valid_protocol_factory
if self.is_valid_call(call_info)
else self.invalid_protocol_factory
)
if protocol_factory is None:
_LOGGER.debug("Call rejected: %s", call_info)
return
rtp_ip = ""
if call_info.local_rtp_port is None:
# Find free RTP/RTCP ports
rtp_port = 0
while True:
sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
sock.setblocking(False)
# Bind to a random UDP port
sock.bind(("", 0))
rtp_ip, rtp_port = sock.getsockname()
# Close socket to free port for re-use
sock.close()
# Check that the next port up is available for RTCP
sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
try:
sock.bind(("", rtp_port + 1))
# Will be opened again below
sock.close()
# Found our ports
break
except OSError:
# RTCP port is taken
pass
else:
rtp_ip = call_info.local_rtp_ip if call_info.local_rtp_ip else ""
rtp_port = call_info.local_rtp_port
_LOGGER.debug(
"Starting RTP server on ip=%s, rtp_port=%s, rtcp_port=%s",
rtp_ip,
rtp_port,
rtp_port + 1,
)
# Handle RTP packets in RTP server
rtp_task = asyncio.create_task(
self._create_rtp_server(protocol_factory, call_info, rtp_ip, rtp_port)
)
self._tasks.add(rtp_task)
rtp_task.add_done_callback(self._tasks.remove)
# Tell caller to start sending/receiving RTP audio
self.answer(call_info, rtp_port)
async def _create_rtp_server(
self,
protocol_factory: CallProtocolFactory,
call_info: CallInfo,
rtp_ip: str,
rtp_port: int,
):
# Shared state between RTP/RTCP servers
rtcp_state = RtcpState()
loop = asyncio.get_running_loop()
# RTCP server
await loop.create_datagram_endpoint(
lambda: RtcpDatagramProtocol(rtcp_state),
(rtp_ip, rtp_port + 1),
)
# RTP server
await loop.create_datagram_endpoint(
partial(protocol_factory, call_info, rtcp_state),
(rtp_ip, rtp_port),
)
class RtpDatagramProtocol(asyncio.DatagramProtocol, ABC):
"""Handle RTP audio input/output for a VoIP call."""
def __init__(
self,
rate: int = 16000,
width: int = 2,
channels: int = 1,
opus_payload_type: int = OPUS_PAYLOAD_TYPE,
rtcp_state: Optional[RtcpState] = None,
) -> None:
"""Set up RTP server."""
self.rtcp_state = rtcp_state
if self.rtcp_state is not None:
# Automatically disconnect when BYE is received over RTCP
self.rtcp_state.bye_callback = self.disconnect
# Desired format for input audio
self.rate = rate
self.width = width
self.channels = channels
self.transport = None
self.addr = None
self._audio_queue: "asyncio.Queue[bytes]" = asyncio.Queue()
self._rtp_input = RtpOpusInput(opus_payload_type=opus_payload_type)
self._rtp_output = RtpOpusOutput(opus_payload_type=opus_payload_type)
self._is_connected: bool = False
def disconnect(self):
self._is_connected = False
if self.transport is not None:
self.transport.close()
self.transport = None
def connection_made(self, transport):
"""Server is ready."""
self.transport = transport
self._is_connected = True
def datagram_received(self, data, addr):
"""Decode RTP + OPUS into raw audio."""
if not self._is_connected:
return
self.addr = addr
try:
# STT expects 16Khz mono with 16-bit samples
audio_bytes = self._rtp_input.process_packet(
data,
self.rate,
self.width,
self.channels,
)
self.on_chunk(audio_bytes)
except Exception as err:
self.disconnect()
raise err
@abstractmethod
def on_chunk(self, audio_bytes: bytes) -> None:
"""Handle raw audio chunk."""
def send_audio(
self,
audio_bytes: bytes,
rate: int,
width: int,
channels: int,
addr: Any = None,
sleep_ratio: float = 1.0,
silence_before: float = 0.0,
) -> None:
"""Send audio from WAV file in chunks over RTP."""
if not self._is_connected:
_LOGGER.debug("Not connected, can't send audio")
return
addr = addr or self.addr
if addr is None:
_LOGGER.debug("No destination address, can't send audio")
raise ValueError("Destination address not set")
bytes_per_sample = width * channels
bytes_per_frame = self._rtp_output.opus_frame_size * bytes_per_sample
# Generate all RTP packets up front
sample_offset = 0
samples_left = len(audio_bytes) // bytes_per_sample
rtp_packets: list[bytes] = []
while samples_left > 0:
_LOGGER.debug("Preparing audio chunk to send")
bytes_offset = sample_offset * bytes_per_sample
chunk = audio_bytes[bytes_offset : bytes_offset + bytes_per_frame]
samples_in_chunk = len(chunk) // bytes_per_sample
samples_left -= samples_in_chunk
for rtp_bytes in self._rtp_output.process_audio(
chunk,
rate,
width,
channels,
is_end=samples_left <= 0,
):
rtp_packets.append(rtp_bytes)
sample_offset += samples_in_chunk
# Pause before sending to allow time for user to pick up phone.
_LOGGER.debug("Pause before sending")
time.sleep(silence_before)
# Send RTP in a steady stream, delaying between each packet to simulate real-time audio
seconds_per_rtp = self._rtp_output.opus_frame_size / self._rtp_output.opus_rate
for rtp_bytes in rtp_packets:
if not self._is_connected:
break
if self.transport is not None:
self.transport.sendto(rtp_bytes, addr)
# Wait almost the full amount of time for the chunk.
#
# Sending too fast will cause the phone to skip chunks,
# since it doesn't seem to have a very large buffer.
#
# Sending too slow will cause audio artifacts if there is
# network jitter, which is why programs like GStreamer are
# much better at this.
time.sleep(seconds_per_rtp * sleep_ratio)
class RtcpDatagramProtocol(asyncio.DatagramProtocol, ABC):
"""UDP server for the Real-time Transport Control Protocol (RTCP)."""
def __init__(self, state: RtcpState) -> None:
"""Set up RTCP server."""
self.transport = None
self.state = state
self._is_connected = False
def connection_made(self, transport):
"""Server ready."""
self.transport = transport
self._is_connected = True
def disconnect(self):
self._is_connected = False
if self.transport is not None:
self.transport.close()
self.transport = None
def datagram_received(self, data: bytes, addr):
"""Handle INVITE SIP messages."""
if not self._is_connected:
return
try:
if len(data) < 8:
raise ValueError("RTCP packet is too small")
# See: https://en.wikipedia.org/wiki/RTP_Control_Protocol#Packet_header
_flags, packet_type, _packet_length, _ssrc = struct.unpack(
">BBHL", data[:8]
)
if packet_type == _RTCP_BYE:
_LOGGER.debug("Received BYE message via RTCP from %s", addr)
self.disconnect()
if self.state.bye_callback is not None:
self.state.bye_callback()
except Exception:
_LOGGER.exception("Unexpected error handling RTCP packet")
|