rtpmjpeg

Documentation

Overview

Package rtpmjpeg contains a RTP/M-JPEG decoder and encoder.

Index

• Variables
• type Decoder
  • func (d *Decoder) Decode(pkt *rtp.Packet) ([]byte, error)
  • func (d *Decoder) Init() error
• type Encoder
  • func (e *Encoder) Encode(image []byte) ([]*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 fragment of an image 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/M-JPEG decoder. Specification: https://datatracker.ietf.org/doc/html/rfc2435

func (*Decoder) Decode

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

Decode decodes an image from a RTP packet.

func (*Decoder) Init

func (d *Decoder) Init() error

Init initializes the decoder.

type Encoder

type Encoder struct {
	// 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

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

Encoder is a RTP/M-JPEG encoder. Specification: https://datatracker.ietf.org/doc/html/rfc2435

func (*Encoder) Encode

func (e *Encoder) Encode(image []byte) ([]*rtp.Packet, error)

Encode encodes an image into RTP/M-JPEG packets.

func (*Encoder) Init

func (e *Encoder) Init() error

Init initializes the encoder.