rtp

README

Pion RTP

A Go implementation of RTP

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:

• John Bradley - Original Author
• Sean DuBois - Original Author
• Woodrow Douglass RTCP, RTP improvements, G.722 support, Bugfixes
• Michael MacDonald
• Luke Curley Performance
• Antoine Baché Fixed crashes
• Hugo Arregui
• Raphael Derosso Pereira
• Atsushi Watanabe
• adwpc add transport-cc extension
• Bao Nguyen *add VP9 noop, bug fixes.

License

MIT License - see LICENSE for full text

Documentation

Overview

Package rtp provides RTP packetizer and depacketizer

Index

• type Depacketizer
• type Header
  • func (h *Header) Marshal() (buf []byte, err error)
  • func (h *Header) MarshalSize() int
  • func (h *Header) MarshalTo(buf []byte) (n int, err error)
  • func (h *Header) Unmarshal(rawPacket []byte) error
• type Packet
  • func (p *Packet) Marshal() (buf []byte, err error)
  • func (p *Packet) MarshalSize() int
  • func (p *Packet) MarshalTo(buf []byte) (n int, err error)
  • func (p Packet) String() string
  • func (p *Packet) Unmarshal(rawPacket []byte) error
• type Packetizer
  • func NewPacketizer(mtu int, pt uint8, ssrc uint32, payloader Payloader, sequencer Sequencer, ...) Packetizer
• type PartitionHeadChecker
• type Payloader
• type Sequencer
  • func NewFixedSequencer(s uint16) Sequencer
  • func NewRandomSequencer() Sequencer
• type TransportCCExtension
  • func (t *TransportCCExtension) Marshal() ([]byte, error)
  • func (t *TransportCCExtension) Unmarshal(rawData []byte) error

Types

type Depacketizer

type Depacketizer interface {
	Unmarshal(packet []byte) ([]byte, error)
}

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

type Header

type Header struct {
	Version          uint8
	Padding          bool
	Extension        bool
	Marker           bool
	PayloadOffset    int
	PayloadType      uint8
	SequenceNumber   uint16
	Timestamp        uint32
	SSRC             uint32
	CSRC             []uint32
	ExtensionProfile uint16
	ExtensionPayload []byte
}

Header represents an RTP packet header NOTE: PayloadOffset is populated by Marshal/Unmarshal and should not be modified

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

func (h *Header) Unmarshal(rawPacket []byte) error

Unmarshal parses the passed byte slice and stores the result in the Header this method is called upon

type Packet

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

Packet represents an RTP Packet NOTE: Raw is populated by Marshal/Unmarshal and should not be modified

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(rawPacket []byte) error

Unmarshal parses the passed byte slice and stores the result in the Packet this method is called upon

type Packetizer

type Packetizer interface {
	Packetize(payload []byte, samples uint32) []*Packet
	EnableAbsSendTime(value int)
}

Packetizer packetizes a payload

func NewPacketizer

func NewPacketizer(mtu int, 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 int, payload []byte) [][]byte
}

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

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 {
	ID                uint8
	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