rtp

package module
v1.7.13 Latest Latest
Warning

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

 Go to latest Published: Apr 12, 2022 License: MIT Imports: 8 Imported by: 1,752

README


Pion RTP

A Go implementation of RTP

Pion RTP Sourcegraph Widget Slack Widget
Build Status GoDoc 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 Golang Slack. Sign up and join the #pion channel for discussions and support. You can also use Pion mailing list.

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:

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 AbsSendTimeExtension added in v1.4.0 

type AbsSendTimeExtension struct {
	Timestamp uint64
}

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

func NewAbsSendTimeExtension added in v1.5.4 

func NewAbsSendTimeExtension(sendTime time.Time) *AbsSendTimeExtension

NewAbsSendTimeExtension makes new AbsSendTimeExtension from time.Time.

func (*AbsSendTimeExtension) Estimate added in v1.4.0 

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 added in v1.4.0 

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

Marshal serializes the members to buffer.

func (*AbsSendTimeExtension) Unmarshal added in v1.4.0 

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

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

type AudioLevelExtension added in v1.5.0 

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 added in v1.5.0 

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

Marshal serializes the members to buffer

func (*AudioLevelExtension) Unmarshal added in v1.5.0 

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

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

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 added in v1.5.0 

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
}

Header represents an RTP packet header

func (Header) Clone added in v1.7.1 

func (h Header) Clone() Header

Clone returns a deep copy h.

func (*Header) DelExtension added in v1.5.2 

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

DelExtension Removes an RTP Header extension

func (*Header) GetExtension added in v1.5.0 

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

GetExtension returns an RTP header extension

func (*Header) GetExtensionIDs added in v1.6.2 

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 added in v1.5.0 

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 added in v1.7.8 

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 added in v1.7.8 

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

OneByteHeaderExtension is an RFC8285 one-byte header extension.

func (*OneByteHeaderExtension) Del added in v1.7.8 

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

Del deletes the extension with the specified ID.

func (*OneByteHeaderExtension) Get added in v1.7.8 

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

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

func (*OneByteHeaderExtension) GetIDs added in v1.7.8 

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

GetIDs returns the available IDs.

func (OneByteHeaderExtension) Marshal added in v1.7.8 

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

Marshal returns the extension payload.

func (OneByteHeaderExtension) MarshalSize added in v1.7.8 

func (e OneByteHeaderExtension) MarshalSize() int

MarshalSize returns the size of the extension payload.

func (OneByteHeaderExtension) MarshalTo added in v1.7.8 

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

MarshalTo writes the extension payload to the given buffer.

func (*OneByteHeaderExtension) Set added in v1.7.8 

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

Set sets the extension payload for the specified ID.

func (*OneByteHeaderExtension) Unmarshal added in v1.7.8 

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

Unmarshal parses the extension payload.

type Packet 

type Packet struct {
	Header
	Payload     []byte
	PaddingSize byte
}

Packet represents an RTP Packet

func (Packet) Clone added in v1.7.1 

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)
}

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 added in v1.2.0 

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 RawExtension added in v1.7.8 

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

RawExtension represents an RFC3550 header extension.

func (*RawExtension) Del added in v1.7.8 

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

Del deletes the extension with the specified ID.

func (*RawExtension) Get added in v1.7.8 

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

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

func (*RawExtension) GetIDs added in v1.7.8 

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

GetIDs returns the available IDs.

func (RawExtension) Marshal added in v1.7.8 

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

Marshal returns the raw extension payload.

func (RawExtension) MarshalSize added in v1.7.8 

func (e RawExtension) MarshalSize() int

MarshalSize returns the size of the extension when marshaled.

func (RawExtension) MarshalTo added in v1.7.8 

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

MarshalTo marshals the extension to the given buffer.

func (*RawExtension) Set added in v1.7.8 

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

Set sets the extension payload for the specified ID.

func (*RawExtension) Unmarshal added in v1.7.8 

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 added in v1.2.1 

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 added in v1.2.1 

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

Marshal serializes the members to buffer

func (*TransportCCExtension) Unmarshal added in v1.2.1 

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

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

type TwoByteHeaderExtension added in v1.7.8 

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

TwoByteHeaderExtension is an RFC8285 two-byte header extension.

func (*TwoByteHeaderExtension) Del added in v1.7.8 

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

Del deletes the extension with the specified ID.

func (*TwoByteHeaderExtension) Get added in v1.7.8 

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

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

func (*TwoByteHeaderExtension) GetIDs added in v1.7.8 

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

GetIDs returns the available IDs.

func (TwoByteHeaderExtension) Marshal added in v1.7.8 

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

Marshal returns the extension payload.

func (TwoByteHeaderExtension) MarshalSize added in v1.7.8 

func (e TwoByteHeaderExtension) MarshalSize() int

MarshalSize returns the size of the extension payload.

func (TwoByteHeaderExtension) MarshalTo added in v1.7.8 

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

MarshalTo marshals the extension to the given buffer.

func (*TwoByteHeaderExtension) Set added in v1.7.8 

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

Set sets the extension payload for the specified ID.

func (*TwoByteHeaderExtension) Unmarshal added in v1.7.8 

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
pkg
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
obu
Package obu implements tools for working with the "Open Bitstream Unit"
 Package obu implements tools for working with the "Open Bitstream Unit"

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.