Skip to main content

Asyncio RTP/RTCP audio and video library for Python

Project description

aiortp

CI

Asyncio RTP/RTCP library for Python — audio and video.

Plain RTP/RTCP for audio and video — no WebRTC, no ICE, no DTLS. Built for telephony, VoIP, and video streaming applications where you need direct control over RTP streams.

Portions derived from aiortc by Jeremy Lainé (BSD-3-Clause).

Features

  • Pure Python — zero required dependencies, Python >=3.11
  • AsyncIO native — built on asyncio.DatagramProtocol
  • Audio codecs — G.711 µ-law/A-law, L16, G.722 (pip install aiortp[g722]), Opus (pip install aiortp[opus])
  • Video codecs — H.264 (RFC 6184), VP8 (RFC 7741), VP9 (RFC 9628) depacketization/packetization
  • RTCP — Sender Reports (with real RTP timestamps), Receiver Reports, SDES, BYE, PLI, NACK (retransmission on by default for video, opt-in for audio via nack_retransmit=True)
  • DTMF — RFC 4733 telephone-event send/receive with redundant end packets
  • Jitter buffer — reordering for both audio (timestamp boundaries) and video (marker-bit frame detection)
  • Adaptive clocked playout — opt-in playout=True: audio delivered on a steady 20 ms media clock from an adaptive jitter buffer that follows measured network jitter
  • Paced sending — opt-in paced=True: outgoing frames queued and transmitted one per ptime, silence encoded as timestamp jumps, await session.drain()
  • Packet loss concealment — confirmed-lost audio replaced with native Opus PLC or generic fade-out repetition, keeping the delivered stream temporally continuous
  • Auto-timestamps — optional automatic RTP timestamp generation for audio and video
  • Port allocationPortAllocator for managed even/odd RTP/RTCP port pairs
  • STUN — inline Binding Responses (IPv4/IPv6, no MESSAGE-INTEGRITY) for simple connectivity probes — not a full ICE agent
  • Symmetric RTP — opt-in remote address latching from inbound packets (RFC 4961) for NAT traversal
  • Fully typed — PEP 561 py.typed marker included

Installation

pip install aiortp

With optional codecs:

pip install aiortp[opus]   # Opus support
pip install aiortp[g722]   # G.722 wideband

Quick Start — Audio

import asyncio
from aiortp import RTPSession, PayloadType

async def main():
    session_a = await RTPSession.create(
        local_addr=("127.0.0.1", 10000),
        remote_addr=("127.0.0.1", 10002),
        payload_type=PayloadType.PCMU,
    )

    session_b = await RTPSession.create(
        local_addr=("127.0.0.1", 10002),
        remote_addr=("127.0.0.1", 10000),
        payload_type=PayloadType.PCMU,
    )

    def on_audio(data: bytes, timestamp: int) -> None:
        print(f"Received {len(data)} bytes, ts={timestamp}")

    session_b.on_audio = on_audio

    # Send with auto-incrementing timestamps (160 samples/frame for PCMU)
    pcm = b"\x00" * 320  # 160 samples of silence (20ms at 8kHz)
    for i in range(10):
        session_a.send_audio_pcm_auto(pcm)

    await asyncio.sleep(1)
    await session_a.close()
    await session_b.close()

asyncio.run(main())

Quick Start — Video

import asyncio
from aiortp import VideoRTPSession

async def main():
    sender = await VideoRTPSession.create(
        local_addr=("127.0.0.1", 20000),
        remote_addr=("127.0.0.1", 20002),
        codec="h264",  # also "vp8" or "vp9"
        fps=30,
    )

    receiver = await VideoRTPSession.create(
        local_addr=("127.0.0.1", 20002),
        remote_addr=("127.0.0.1", 20000),
        codec="h264",
    )

    def on_frame(data: bytes, timestamp: int, is_keyframe: bool) -> None:
        print(f"Frame: {len(data)} bytes, keyframe={is_keyframe}")

    receiver.on_frame = on_frame

    # Send H.264 NAL units with auto-incrementing timestamps
    sps = bytes([0x67, 0x42, 0x00, 0x1E])
    pps = bytes([0x68, 0xCE, 0x38, 0x80])
    idr = bytes([0x65]) + b"\x00" * 100
    sender.send_frame_auto([sps, pps, idr], keyframe=True)

    await asyncio.sleep(1)
    await sender.close()
    await receiver.close()

asyncio.run(main())

DTMF

# Send
session.send_dtmf("1", duration_ms=160, timestamp=0)

# Receive
def on_dtmf(digit: str, duration: int) -> None:
    print(f"Got DTMF: {digit}")

session.on_dtmf = on_dtmf

Packet Loss Concealment

With skip_audio_gaps=True, the jitter buffer confirms losses by sequence-number analysis (sender pauses such as DTMF or VAD suppression are never treated as loss). Confirmed-lost packets are replaced with concealment PCM before on_audio, so the delivered stream stays temporally continuous — recordings and AEC alignment are preserved. Opus uses native libopus PLC; other codecs fall back to a generic concealer (last-frame repetition fading to silence over 60 ms, then silence).

session = await RTPSession.create(
    local_addr=("0.0.0.0", 10000),
    remote_addr=("10.0.0.1", 10000),
    payload_type=PayloadType.PCMU,
    skip_audio_gaps=True,  # required: loss is confirmed by the jitter buffer
    plc=True,              # default — set False to skip lost audio silently
)

print(session.stats["concealed_frames"])  # packets replaced by concealment

Clocked Playout & Paced Sending

With playout=True, on_audio fires on a steady ptime clock (20 ms ticks) instead of on packet arrival. Frames wait in an adaptive playout buffer whose target depth follows measured network jitter (bounded by playout_max_delay_ms, default 200 ms): sustained jitter grows the buffer by inserting a concealment frame, calm networks shrink it by dropping one. Missing frames are concealed at their deadline (native Opus PLC or fade-out); after 120 ms of continuous concealment the gap is treated as a sender pause (DTX, hold, DTMF) and delivery suspends until the stream resumes.

With paced=True, send_audio_auto / send_audio_pcm_auto enqueue frames and the session transmits one per ptime on its media clock — push faster than real time (e.g. a whole file) and the wire stays correctly paced. Silence is a timestamp jump, not stale packets.

session = await RTPSession.create(
    local_addr=("0.0.0.0", 10000),
    remote_addr=("10.0.0.1", 10000),
    payload_type=PayloadType.PCMU,
    playout=True,   # clocked receive: on_audio every 20 ms
    paced=True,     # clocked send: one frame per 20 ms
)

session.on_audio = lambda pcm, ts: sink.write(pcm)

for frame in pcm_frames:          # any rate — even all at once
    session.send_audio_pcm_auto(frame)
await session.drain()             # wait until everything is on the wire

print(session.stats["playout_delay_ms"], session.stats["playout_target_ms"])

Video RTCP Feedback

# Request a keyframe from the remote sender
receiver.request_keyframe()

# Get notified when the remote side requests a keyframe
def on_keyframe_needed() -> None:
    print("Remote requested a keyframe")

sender.on_keyframe_needed = on_keyframe_needed

Port Allocator

from aiortp import PortAllocator, RTPSession

allocator = PortAllocator(port_range=(10000, 20000))

# Session will use an even/odd port pair from the allocator
session = await RTPSession.create(
    local_addr=("0.0.0.0", 0),
    remote_addr=("10.0.0.1", 10000),
    payload_type=0,
    port_allocator=allocator,
)
# Ports are released automatically on close

Codec Registry

from aiortp import get_codec, PayloadType

codec = get_codec(PayloadType.PCMU)  # or PCMA, L16, G722
encoded = codec.encode(pcm_bytes)
decoded = codec.decode(encoded)

Low-Level Packets

from aiortp import RtpPacket, RtcpPacket, is_rtcp

# Parse
packet = RtpPacket.parse(data)
print(packet.sequence_number, packet.timestamp, packet.payload_type)

# Build
packet = RtpPacket(
    payload_type=0,
    sequence_number=1000,
    timestamp=8000,
    ssrc=0xDEADBEEF,
    payload=b"\x80" * 160,
)
data = packet.serialize()

# Demux RTP vs RTCP
if is_rtcp(data):
    rtcp_packets = RtcpPacket.parse(data)

Video Depacketizers (Standalone)

from aiortp import H264Depacketizer, VP8Depacketizer, VP9Depacketizer

# H.264: feed RTP payloads, get NAL units
depkt = H264Depacketizer()
nals = depkt.feed(rtp_payload, marker=is_last_packet)

# VP8/VP9: feed RTP payloads, get (frame_data, is_keyframe) tuples
depkt = VP8Depacketizer()
frames = depkt.feed(rtp_payload, marker=is_last_packet)

Examples

See the examples/ directory:

  • loopback.py — two sessions exchanging G.711 audio on localhost
  • dtmf.py — sending and receiving DTMF digits
  • codec_roundtrip.py — encode/decode with each built-in codec
  • raw_packets.py — low-level RTP/RTCP packet construction
  • send_wav.py — stream a WAV file over RTP

License

MIT. See LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aiortp-0.5.0.tar.gz (73.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aiortp-0.5.0-py3-none-any.whl (51.7 kB view details)

Uploaded Python 3

File details

Details for the file aiortp-0.5.0.tar.gz.

File metadata

  • Download URL: aiortp-0.5.0.tar.gz
  • Upload date:
  • Size: 73.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for aiortp-0.5.0.tar.gz
Algorithm Hash digest
SHA256 9dec4265b46d9b4aab349fc30b0e7105ab8d12dfce052e19e1ddba98e854b5bd
MD5 4228e24aad565e9fad779cb638f8c9f1
BLAKE2b-256 253a5d330f3523737cf0bba7b7bc4bcb21b642c6535e6fc54d6553bff144f94b

See more details on using hashes here.

File details

Details for the file aiortp-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: aiortp-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 51.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for aiortp-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f0c82beee0220b29449f9f7f776433f0e73c043cafed763f7fc7f495f98451ce
MD5 47413358f6f6e031c82d514b731a55f6
BLAKE2b-256 c3e4287ae7c10aed81b887e3c2aa9432eec5ad63fabc97997ab6e4896af32d83

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page