rtp

package module
v0.0.0-...-269b3d7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 31, 2026 License: MIT Imports: 8 Imported by: 0

README


Pion RTP

A Go implementation of RTP

Pion RTP Sourcegraph Widget Slack Widget
GitHub Workflow Status Go Reference Coverage Status Go Report Card


Roadmap

The library is used as a part of our WebRTC implementation. Please refer to that roadmap to track our major milestones.

Community

Pion has an active community on the Slack.

Follow the Pion Twitter for project updates and important WebRTC news.

We are always looking to support your projects. Please reach out if you have something to build! If you need commercial support or don't want to use public methods you can contact us at team@pion.ly

Contributing

Check out the contributing wiki to join the group of amazing people making this project possible: AUTHORS.txt

License

MIT License - see LICENSE for full text

Documentation

Overview

Package rtp provides RTP packetizer and depacketizer

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AbsCaptureTimeExtension 

type AbsCaptureTimeExtension struct {
	Timestamp                   uint64
	EstimatedCaptureClockOffset *int64
}

AbsCaptureTimeExtension is a extension payload format in http://www.webrtc.org/experiments/rtp-hdrext/abs-capture-time 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | ID | len=7 | absolute capture timestamp (bit 0-23) | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | absolute capture timestamp (bit 24-55) | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | ... (56-63) | +-+-+-+-+-+-+-+-+

func NewAbsCaptureTimeExtension 

func NewAbsCaptureTimeExtension(captureTime time.Time) *AbsCaptureTimeExtension

NewAbsCaptureTimeExtension makes new AbsCaptureTimeExtension from time.Time.

func NewAbsCaptureTimeExtensionWithCaptureClockOffset 

func NewAbsCaptureTimeExtensionWithCaptureClockOffset(captureTime time.Time, captureClockOffset time.Duration) *AbsCaptureTimeExtension

NewAbsCaptureTimeExtensionWithCaptureClockOffset makes new AbsCaptureTimeExtension from time.Time and a clock offset.

func (AbsCaptureTimeExtension) CaptureTime 

func (t AbsCaptureTimeExtension) CaptureTime() time.Time

CaptureTime produces the estimated time.Time represented by this extension.

func (AbsCaptureTimeExtension) EstimatedCaptureClockOffsetDuration 

func (t AbsCaptureTimeExtension) EstimatedCaptureClockOffsetDuration() *time.Duration

EstimatedCaptureClockOffsetDuration produces the estimated time.Duration represented by this extension.

func (AbsCaptureTimeExtension) Marshal 

func (t AbsCaptureTimeExtension) Marshal() ([]byte, error)

Marshal serializes the members to buffer.

func (*AbsCaptureTimeExtension) Unmarshal 

func (t *AbsCaptureTimeExtension) Unmarshal(rawData []byte) error

Unmarshal parses the passed byte slice and stores the result in the members.

type AbsSendTimeExtension 

type AbsSendTimeExtension struct {
	Timestamp uint64
}

AbsSendTimeExtension is a extension payload format in http://www.webrtc.org/experiments/rtp-hdrext/abs-send-time

func NewAbsSendTimeExtension 

func NewAbsSendTimeExtension(sendTime time.Time) *AbsSendTimeExtension

NewAbsSendTimeExtension makes new AbsSendTimeExtension from time.Time.

func (*AbsSendTimeExtension) Estimate 

func (t *AbsSendTimeExtension) Estimate(receive time.Time) time.Time

Estimate absolute send time according to the receive time. Note that if the transmission delay is larger than 64 seconds, estimated time will be wrong.

func (AbsSendTimeExtension) Marshal 

func (t AbsSendTimeExtension) Marshal() ([]byte, error)

Marshal serializes the members to buffer.

func (*AbsSendTimeExtension) Unmarshal 

func (t *AbsSendTimeExtension) Unmarshal(rawData []byte) error

Unmarshal parses the passed byte slice and stores the result in the members.

type AudioLevelExtension 

type AudioLevelExtension struct {
	Level uint8
	Voice bool
}

AudioLevelExtension is a extension payload format described in https://tools.ietf.org/html/rfc6464

Implementation based on: https://chromium.googlesource.com/external/webrtc/+/e2a017725570ead5946a4ca8235af27470ca0df9/webrtc/modules/rtp_rtcp/source/rtp_header_extensions.cc#49

One byte format: 0 1 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | ID | len=0 |V| level | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Two byte format: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | ID | len=1 |V| level | 0 (pad) | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

func (AudioLevelExtension) Marshal 

func (a AudioLevelExtension) Marshal() ([]byte, error)

Marshal serializes the members to buffer

func (*AudioLevelExtension) Unmarshal 

func (a *AudioLevelExtension) Unmarshal(rawData []byte) error

Unmarshal parses the passed byte slice and stores the result in the members

type DTMFEvent 

type DTMFEvent struct {
	Event    byte   // 0-15 (0-9, *, #, A-D)
	End      bool   // end-of-event flag
	Volume   byte   // 0-63
	Duration uint16 // in timestamp units
}

DTMFEvent represents a DTMF telephony event as defined in RFC 4733.

type DTMFPacketizer 

type DTMFPacketizer struct {
	// contains filtered or unexported fields
}

DTMFPacketizer creates RTP packets for DTMF events (RFC 4733). It shares a Sequencer with the audio packetizer so that sequence numbers remain monotonically increasing across both streams.

func NewDTMFPacketizer 

func NewDTMFPacketizer(pt uint8, ssrc uint32, sequencer Sequencer) *DTMFPacketizer

NewDTMFPacketizer returns a new DTMFPacketizer. The sequencer should be shared with the audio Packetizer so that RTP sequence numbers are continuous.

func (*DTMFPacketizer) PacketizeEvent 

func (d *DTMFPacketizer) PacketizeEvent(event DTMFEvent, marker bool) *Packet

PacketizeEvent builds a single RTP packet carrying a 4-byte RFC 4733 telephony-event payload. The caller controls the marker bit (should be true for the first packet of an event).

func (*DTMFPacketizer) StartEvent 

func (d *DTMFPacketizer) StartEvent(timestamp uint32)

StartEvent records the RTP timestamp that marks the beginning of a new DTMF event. All packets belonging to this event will carry this timestamp as required by RFC 4733.

type Depacketizer 

type Depacketizer interface {
	Unmarshal(packet []byte) ([]byte, error)
	// Checks if the packet is at the beginning of a partition.  This
	// should return false if the result could not be determined, in
	// which case the caller will detect timestamp discontinuities.
	IsPartitionHead(payload []byte) bool
	// Checks if the packet is at the end of a partition.  This should
	// return false if the result could not be determined.
	IsPartitionTail(marker bool, payload []byte) bool
}

Depacketizer depacketizes a RTP payload, removing any RTP specific data from the payload

type Extension 

type Extension struct {
	// contains filtered or unexported fields
}

Extension RTP Header extension 

type Header struct {
	Version          uint8
	Padding          bool
	Extension        bool
	Marker           bool
	PayloadType      uint8
	SequenceNumber   uint16
	Timestamp        uint32
	SSRC             uint32
	CSRC             []uint32
	ExtensionProfile uint16
	Extensions       []Extension

	// Deprecated: will be removed in a future version.
	PayloadOffset int
}

Header represents an RTP packet header

func (Header) Clone 

func (h Header) Clone() Header

Clone returns a deep copy h.

func (*Header) DelExtension 

func (h *Header) DelExtension(id uint8) error

DelExtension Removes an RTP Header extension

func (*Header) GetExtension 

func (h *Header) GetExtension(id uint8) []byte

GetExtension returns an RTP header extension

func (*Header) GetExtensionIDs 

func (h *Header) GetExtensionIDs() []uint8

GetExtensionIDs returns an extension id array

func (Header) Marshal 

func (h Header) Marshal() (buf []byte, err error)

Marshal serializes the header into bytes.

func (Header) MarshalSize 

func (h Header) MarshalSize() int

MarshalSize returns the size of the header once marshaled.

func (Header) MarshalTo 

func (h Header) MarshalTo(buf []byte) (n int, err error)

MarshalTo serializes the header and writes to the buffer.

func (*Header) SetExtension 

func (h *Header) SetExtension(id uint8, payload []byte) error

SetExtension sets an RTP header extension

func (*Header) Unmarshal 

func (h *Header) Unmarshal(buf []byte) (n int, err error)

Unmarshal parses the passed byte slice and stores the result in the Header. It returns the number of bytes read n and any error.

type HeaderExtension 

type HeaderExtension interface {
	Set(id uint8, payload []byte) error
	GetIDs() []uint8
	Get(id uint8) []byte
	Del(id uint8) error

	Unmarshal(buf []byte) (int, error)
	Marshal() ([]byte, error)
	MarshalTo(buf []byte) (int, error)
	MarshalSize() int
}

HeaderExtension represents an RTP extension header.

type OneByteHeaderExtension 

type OneByteHeaderExtension struct {
	// contains filtered or unexported fields
}

OneByteHeaderExtension is an RFC8285 one-byte header extension.

func (*OneByteHeaderExtension) Del 

func (e *OneByteHeaderExtension) Del(id uint8) error

Del deletes the extension with the specified ID.

func (*OneByteHeaderExtension) Get 

func (e *OneByteHeaderExtension) Get(id uint8) []byte

Get returns the payload of the extension with the given ID.

func (*OneByteHeaderExtension) GetIDs 

func (e *OneByteHeaderExtension) GetIDs() []uint8

GetIDs returns the available IDs.

func (OneByteHeaderExtension) Marshal 

func (e OneByteHeaderExtension) Marshal() ([]byte, error)

Marshal returns the extension payload.

func (OneByteHeaderExtension) MarshalSize 

func (e OneByteHeaderExtension) MarshalSize() int

MarshalSize returns the size of the extension payload.

func (OneByteHeaderExtension) MarshalTo 

func (e OneByteHeaderExtension) MarshalTo(buf []byte) (int, error)

MarshalTo writes the extension payload to the given buffer.

func (*OneByteHeaderExtension) Set 

func (e *OneByteHeaderExtension) Set(id uint8, buf []byte) error

Set sets the extension payload for the specified ID.

func (*OneByteHeaderExtension) Unmarshal 

func (e *OneByteHeaderExtension) Unmarshal(buf []byte) (int, error)

Unmarshal parses the extension payload.

type Packet 

type Packet struct {
	Header
	Payload     []byte
	PaddingSize byte

	// Deprecated: will be removed in a future version.
	Raw []byte
}

Packet represents an RTP Packet

func (Packet) Clone 

func (p Packet) Clone() *Packet

Clone returns a deep copy of p.

func (Packet) Marshal 

func (p Packet) Marshal() (buf []byte, err error)

Marshal serializes the packet into bytes.

func (Packet) MarshalSize 

func (p Packet) MarshalSize() int

MarshalSize returns the size of the packet once marshaled.

func (*Packet) MarshalTo 

func (p *Packet) MarshalTo(buf []byte) (n int, err error)

MarshalTo serializes the packet and writes to the buffer.

func (Packet) String 

func (p Packet) String() string

String helps with debugging by printing packet information in a readable way

func (*Packet) Unmarshal 

func (p *Packet) Unmarshal(buf []byte) error

Unmarshal parses the passed byte slice and stores the result in the Packet.

type Packetizer 

type Packetizer interface {
	Packetize(payload []byte, samples uint32) []*Packet
	EnableAbsSendTime(value int)
	SkipSamples(skippedSamples uint32)
	SetMarker(val bool)
	CurrentTimestamp() uint32
}

Packetizer packetizes a payload

func NewPacketizer 

func NewPacketizer(mtu uint16, pt uint8, ssrc uint32, payloader Payloader, sequencer Sequencer, clockRate uint32) Packetizer

NewPacketizer returns a new instance of a Packetizer for a specific payloader

type PartitionHeadChecker 

type PartitionHeadChecker interface {
	IsPartitionHead([]byte) bool
}

PartitionHeadChecker is the interface that checks whether the packet is keyframe or not

type Payloader 

type Payloader interface {
	Payload(mtu uint16, payload []byte) [][]byte
}

Payloader payloads a byte array for use as rtp.Packet payloads

type PlayoutDelayExtension 

type PlayoutDelayExtension struct {
	// contains filtered or unexported fields
}

PlayoutDelayExtension is a extension payload format in http://www.webrtc.org/experiments/rtp-hdrext/playout-delay 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | ID | len=2 | MIN delay | MAX delay | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

func (PlayoutDelayExtension) Marshal 

func (p PlayoutDelayExtension) Marshal() ([]byte, error)

Marshal serializes the members to buffer

func (*PlayoutDelayExtension) Unmarshal 

func (p *PlayoutDelayExtension) Unmarshal(rawData []byte) error

Unmarshal parses the passed byte slice and stores the result in the members

type RawExtension 

type RawExtension struct {
	// contains filtered or unexported fields
}

RawExtension represents an RFC3550 header extension.

func (*RawExtension) Del 

func (e *RawExtension) Del(id uint8) error

Del deletes the extension with the specified ID.

func (*RawExtension) Get 

func (e *RawExtension) Get(id uint8) []byte

Get returns the payload of the extension with the given ID.

func (*RawExtension) GetIDs 

func (e *RawExtension) GetIDs() []uint8

GetIDs returns the available IDs.

func (RawExtension) Marshal 

func (e RawExtension) Marshal() ([]byte, error)

Marshal returns the raw extension payload.

func (RawExtension) MarshalSize 

func (e RawExtension) MarshalSize() int

MarshalSize returns the size of the extension when marshaled.

func (RawExtension) MarshalTo 

func (e RawExtension) MarshalTo(buf []byte) (int, error)

MarshalTo marshals the extension to the given buffer.

func (*RawExtension) Set 

func (e *RawExtension) Set(id uint8, payload []byte) error

Set sets the extension payload for the specified ID.

func (*RawExtension) Unmarshal 

func (e *RawExtension) Unmarshal(buf []byte) (int, error)

Unmarshal parses the extension from the given buffer.

type Sequencer 

type Sequencer interface {
	NextSequenceNumber() uint16
	RollOverCount() uint64
}

Sequencer generates sequential sequence numbers for building RTP packets

func NewFixedSequencer 

func NewFixedSequencer(s uint16) Sequencer

NewFixedSequencer returns a new sequencer starting from a specific sequence number

func NewRandomSequencer 

func NewRandomSequencer() Sequencer

NewRandomSequencer returns a new sequencer starting from a random sequence number

type TransportCCExtension 

type TransportCCExtension struct {
	TransportSequence uint16
}

TransportCCExtension is a extension payload format in https://tools.ietf.org/html/draft-holmer-rmcat-transport-wide-cc-extensions-01 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | 0xBE | 0xDE | length=1 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | ID | L=1 |transport-wide sequence number | zero padding | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

func (TransportCCExtension) Marshal 

func (t TransportCCExtension) Marshal() ([]byte, error)

Marshal serializes the members to buffer

func (*TransportCCExtension) Unmarshal 

func (t *TransportCCExtension) Unmarshal(rawData []byte) error

Unmarshal parses the passed byte slice and stores the result in the members

type TwoByteHeaderExtension 

type TwoByteHeaderExtension struct {
	// contains filtered or unexported fields
}

TwoByteHeaderExtension is an RFC8285 two-byte header extension.

func (*TwoByteHeaderExtension) Del 

func (e *TwoByteHeaderExtension) Del(id uint8) error

Del deletes the extension with the specified ID.

func (*TwoByteHeaderExtension) Get 

func (e *TwoByteHeaderExtension) Get(id uint8) []byte

Get returns the payload of the extension with the given ID.

func (*TwoByteHeaderExtension) GetIDs 

func (e *TwoByteHeaderExtension) GetIDs() []uint8

GetIDs returns the available IDs.

func (TwoByteHeaderExtension) Marshal 

func (e TwoByteHeaderExtension) Marshal() ([]byte, error)

Marshal returns the extension payload.

func (TwoByteHeaderExtension) MarshalSize 

func (e TwoByteHeaderExtension) MarshalSize() int

MarshalSize returns the size of the extension payload.

func (TwoByteHeaderExtension) MarshalTo 

func (e TwoByteHeaderExtension) MarshalTo(buf []byte) (int, error)

MarshalTo marshals the extension to the given buffer.

func (*TwoByteHeaderExtension) Set 

func (e *TwoByteHeaderExtension) Set(id uint8, buf []byte) error

Set sets the extension payload for the specified ID.

func (*TwoByteHeaderExtension) Unmarshal 

func (e *TwoByteHeaderExtension) Unmarshal(buf []byte) (int, error)

Unmarshal parses the extension payload.

Source Files

View all Source files

Directories

Path Synopsis
Package codecs implements codec specific RTP payloader/depayloaders
 Package codecs implements codec specific RTP payloader/depayloaders
av1/frame
Package frame provides code to construct complete media frames from packetized media.
 Package frame provides code to construct complete media frames from packetized media.
av1/obu
Package obu implements tools for working with the Open Bitstream Unit.
 Package obu implements tools for working with the Open Bitstream Unit.
pkg
frame
Package frame is deprecated.
 Package frame is deprecated.
obu
Package obu is deprecated.
 Package obu is deprecated.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.