rtpav1

Documentation

Overview

Package rtpav1 contains a RTP/AV1 decoder and encoder.

Index

• Variables
• type Decoder
  • func (d *Decoder) Decode(pkt *rtp.Packet) ([][]byte, time.Duration, error)
  • func (d *Decoder) DecodeUntilMarker(pkt *rtp.Packet) ([][]byte, time.Duration, error)
  • func (d *Decoder) Init() error
• type Encoder
  • func (e *Encoder) Encode(obus [][]byte, pts time.Duration) ([]*rtp.Packet, error)
  • func (e *Encoder) Init() error

Variables

var ErrMorePacketsNeeded = errors.New("need more packets")

ErrMorePacketsNeeded is returned when more packets are needed.

var ErrNonStartingPacketAndNoPrevious = errors.New(
	"received a non-starting fragment without any previous starting fragment")

ErrNonStartingPacketAndNoPrevious is returned when we received a non-starting packet of a fragmented NALU and we didn't received anything before. It's normal to receive this when decoding a stream that has been already running for some time.

Types

type Decoder

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

Decoder is a RTP/AV1 decoder. Specification: https://aomediacodec.github.io/av1-rtp-spec/

func (*Decoder) Decode

func (d *Decoder) Decode(pkt *rtp.Packet) ([][]byte, time.Duration, error)

Decode decodes OBUs from a RTP packet.

func (*Decoder) DecodeUntilMarker

func (d *Decoder) DecodeUntilMarker(pkt *rtp.Packet) ([][]byte, time.Duration, error)

DecodeUntilMarker decodes OBUs from a RTP packet and puts them in a buffer. When a packet has the marker flag (meaning that all OBUs with the same PTS have been received), the buffer is returned.

func (*Decoder) Init

func (d *Decoder) Init() error

Init initializes the decoder.

type Encoder

type Encoder struct {
	// payload type of packets.
	PayloadType uint8

	// SSRC of packets (optional).
	// It defaults to a random value.
	SSRC *uint32

	// initial sequence number of packets (optional).
	// It defaults to a random value.
	InitialSequenceNumber *uint16

	// initial timestamp of packets (optional).
	// It defaults to a random value.
	InitialTimestamp *uint32

	// maximum size of packet payloads (optional).
	// It defaults to 1460.
	PayloadMaxSize int
	// contains filtered or unexported fields
}

Encoder is a RTP/AV1 encoder. Specification: https://aomediacodec.github.io/av1-rtp-spec/

func (*Encoder) Encode

func (e *Encoder) Encode(obus [][]byte, pts time.Duration) ([]*rtp.Packet, error)

Encode encodes OBUs into RTP packets.

func (*Encoder) Init

func (e *Encoder) Init() error

Init initializes the encoder.