snapshot of https://github.com/pion/webrtc.git (main, 2026-09-15; blobs > 131072B omitted)
Some checks failed
REUSE Compliance Check / lint (push) Failing after 0s
Browser E2E / Test (push) Failing after 3s
Test / test (1.24) (push) Failing after 0s
Test / test-i386 (1.25) (push) Failing after 0s
Test / test-i386 (1.24) (push) Failing after 0s
Test / test-windows (1.25) (push) Failing after 0s
Test / test-windows (1.24) (push) Failing after 0s
Test / test (1.25) (push) Failing after 0s
Examples Tests / Test (push) Failing after 3s
Test / test-macos (1.25) (push) Failing after 0s
Test / test-macos (1.24) (push) Failing after 0s
Go mod tidy / tidy (push) Failing after 0s
Test / test-wasm (push) Failing after 0s
CodeQL / analyze (push) Failing after 1s
Fuzz / fuzz (push) Failing after 0s

This commit is contained in:
upstream-mirror
2026-09-15 20:06:07 +05:00
commit 8acb1a3a29
394 changed files with 78746 additions and 0 deletions

View File

@@ -0,0 +1,406 @@
// SPDX-FileCopyrightText: 2026 The Pion community <https://pion.ly>
// SPDX-License-Identifier: MIT
// Package ivfwriter implements IVF media container writer
package ivfwriter
import (
"encoding/binary"
"errors"
"io"
"os"
"github.com/pion/rtp"
"github.com/pion/rtp/codecs"
"github.com/pion/rtp/codecs/av1/obu"
)
var (
errFileNotOpened = errors.New("file not opened")
errInvalidNilPacket = errors.New("invalid nil packet")
errCodecUnset = errors.New("codec is unset")
errCodecAlreadySet = errors.New("codec is already set")
errNoSuchCodec = errors.New("no codec for this MimeType")
errInvalidMediaTimebase = errors.New("invalid media timebase")
)
type (
codec int
// IVFWriter is used to take RTP packets and write them to an IVF on disk.
IVFWriter struct {
ioWriter io.Writer
count uint64
seenKeyFrame bool
codec codec
timebaseDenominator uint32
timebaseNumerator uint32
firstFrameTimestamp uint32
clockRate uint64
videoWidth uint16
videoHeight uint16
directPTS bool
// VP8, VP9
currentFrame []byte
// AV1
av1Depacketizer *codecs.AV1Depacketizer
}
)
const (
codecUnset codec = iota
codecVP8
codecVP9
codecAV1
mimeTypeVP8 = "video/VP8"
mimeTypeVP9 = "video/VP9"
mimeTypeAV1 = "video/AV1"
)
// New builds a new IVF writer.
func New(fileName string, opts ...Option) (*IVFWriter, error) {
file, err := os.Create(fileName) //nolint:gosec
if err != nil {
return nil, err
}
writer, err := NewWith(file, opts...)
if err != nil {
return nil, err
}
writer.ioWriter = file
return writer, nil
}
// NewWith initialize a new IVF writer with an io.Writer output.
func NewWith(out io.Writer, opts ...Option) (*IVFWriter, error) {
if out == nil {
return nil, errFileNotOpened
}
writer := &IVFWriter{
ioWriter: out,
seenKeyFrame: false,
timebaseDenominator: 30,
timebaseNumerator: 1,
clockRate: 90000,
videoWidth: 640,
videoHeight: 480,
}
for _, o := range opts {
if err := o(writer); err != nil {
return nil, err
}
}
if writer.codec == codecUnset {
writer.codec = codecVP8
}
if err := writer.writeHeader(); err != nil {
return nil, err
}
if writer.timebaseDenominator == 0 {
return nil, errInvalidMediaTimebase
}
return writer, nil
}
func (i *IVFWriter) writeHeader() error {
header := make([]byte, 32)
copy(header[0:], "DKIF") // DKIF
binary.LittleEndian.PutUint16(header[4:], 0) // Version
binary.LittleEndian.PutUint16(header[6:], 32) // Header size
// FOURCC
switch i.codec {
case codecVP8:
copy(header[8:], "VP80")
case codecVP9:
copy(header[8:], "VP90")
case codecAV1:
copy(header[8:], "AV01")
default:
return errCodecUnset
}
binary.LittleEndian.PutUint16(header[12:], i.videoWidth) // Width in pixels
binary.LittleEndian.PutUint16(header[14:], i.videoHeight) // Height in pixels
binary.LittleEndian.PutUint32(header[16:], i.timebaseDenominator) // Framerate denominator
binary.LittleEndian.PutUint32(header[20:], i.timebaseNumerator) // Framerate numerator
binary.LittleEndian.PutUint32(header[24:], 900) // Frame count, will be updated on first Close() call
binary.LittleEndian.PutUint32(header[28:], 0) // Unused
_, err := i.ioWriter.Write(header)
return err
}
func (i *IVFWriter) timestampToPts(timestamp uint64) uint64 {
return timestamp * uint64(i.timebaseNumerator) / uint64(i.timebaseDenominator)
}
func (i *IVFWriter) writeFrame(frame []byte, timestamp uint64) error {
frameHeader := make([]byte, 12)
//nolint:gosec // G115
binary.LittleEndian.PutUint32(frameHeader[0:], uint32(len(frame))) // Frame length
var pts uint64
if i.directPTS {
// Direct PTS mode: use timestamp directly as PTS.
pts = timestamp
} else {
// Existing behavior: convert using timebase.
pts = i.timestampToPts(timestamp)
}
binary.LittleEndian.PutUint64(frameHeader[4:], pts) // PTS
i.count++
if _, err := i.ioWriter.Write(frameHeader); err != nil {
return err
}
_, err := i.ioWriter.Write(frame)
return err
}
// WriteRTP adds a new packet and writes the appropriate headers for it.
func (i *IVFWriter) WriteRTP(packet *rtp.Packet) error {
if i.ioWriter == nil {
return errFileNotOpened
} else if len(packet.Payload) == 0 {
return nil
}
if i.count == 0 {
i.firstFrameTimestamp = packet.Timestamp
}
var timestamp uint64
if i.directPTS {
// Direct PTS mode: use RTP timestamp directly (no millisecond conversion).
timestamp = uint64(packet.Timestamp - i.firstFrameTimestamp)
} else {
// Existing behavior: convert to milliseconds first.
timestamp = 1000 * uint64(packet.Timestamp-i.firstFrameTimestamp) / i.clockRate
}
switch i.codec {
case codecVP8:
return i.writeVP8(packet, timestamp)
case codecVP9:
return i.writeVP9(packet, timestamp)
case codecAV1:
return i.writeAV1(packet, timestamp)
default:
return errCodecUnset
}
}
func (i *IVFWriter) writeVP8(packet *rtp.Packet, timestamp uint64) error {
vp8Packet := codecs.VP8Packet{}
if _, err := vp8Packet.Unmarshal(packet.Payload); err != nil {
return err
}
// a payload that carries only the VP8 descriptor has nothing to write.
if len(vp8Packet.Payload) == 0 {
return nil
}
isKeyFrame := (vp8Packet.Payload[0] & 0x01) == 0
switch {
case !i.seenKeyFrame && !isKeyFrame:
return nil
case i.currentFrame == nil && vp8Packet.S != 1:
return nil
}
i.seenKeyFrame = true
i.currentFrame = append(i.currentFrame, vp8Packet.Payload[0:]...)
if !packet.Marker {
return nil
} else if len(i.currentFrame) == 0 {
return nil
}
if err := i.writeFrame(i.currentFrame, timestamp); err != nil {
return err
}
i.currentFrame = nil
return nil
}
func (i *IVFWriter) writeVP9(packet *rtp.Packet, timestamp uint64) error {
vp9Packet := codecs.VP9Packet{}
if _, err := vp9Packet.Unmarshal(packet.Payload); err != nil {
return err
}
switch {
case !i.seenKeyFrame && vp9Packet.P:
return nil
case i.currentFrame == nil && !vp9Packet.B:
return nil
}
i.seenKeyFrame = true
i.currentFrame = append(i.currentFrame, vp9Packet.Payload[0:]...)
if !packet.Marker {
return nil
} else if len(i.currentFrame) == 0 {
return nil
}
// the timestamp must be sequential. webrtc mandates a clock rate of 90000
// and we've assumed 30fps in the header.
if err := i.writeFrame(i.currentFrame, timestamp); err != nil {
return err
}
i.currentFrame = nil
return nil
}
func (i *IVFWriter) writeAV1(packet *rtp.Packet, timestamp uint64) error {
if i.av1Depacketizer == nil {
i.av1Depacketizer = &codecs.AV1Depacketizer{}
}
payload, err := i.av1Depacketizer.Unmarshal(packet.Payload)
if err != nil {
return err
}
if !i.seenKeyFrame {
isKeyFrame := i.av1Depacketizer.N || (len(payload) > 0 && obu.Type((payload[0]&0x78)>>3) == obu.OBUSequenceHeader)
if !isKeyFrame {
return nil
}
i.seenKeyFrame = true
}
i.currentFrame = append(i.currentFrame, payload...)
if !packet.Marker {
return nil
}
delimiter := obu.Header{
Type: obu.OBUTemporalDelimiter,
HasSizeField: true,
}
frame := append(delimiter.Marshal(), 0)
frame = append(frame, i.currentFrame...)
if err := i.writeFrame(frame, timestamp); err != nil {
return err
}
i.currentFrame = nil
return nil
}
// Close stops the recording.
func (i *IVFWriter) Close() error {
if i.ioWriter == nil {
// Returns no error as it may be convenient to call
// Close() multiple times
return nil
}
defer func() {
i.ioWriter = nil
}()
if ws, ok := i.ioWriter.(io.WriteSeeker); ok {
// Update the framecount
if _, err := ws.Seek(24, 0); err != nil {
return err
}
buff := make([]byte, 4)
binary.LittleEndian.PutUint32(buff, uint32(i.count)) //nolint:gosec // G115
if _, err := ws.Write(buff); err != nil {
return err
}
}
if closer, ok := i.ioWriter.(io.Closer); ok {
return closer.Close()
}
return nil
}
// An Option configures a SampleBuilder.
type Option func(i *IVFWriter) error
// WithCodec configures if IVFWriter is writing AV1 or VP8 packets to disk.
func WithCodec(mimeType string) Option {
return func(i *IVFWriter) error {
if i.codec != codecUnset {
return errCodecAlreadySet
}
switch mimeType {
case mimeTypeVP8:
i.codec = codecVP8
case mimeTypeVP9:
i.codec = codecVP9
case mimeTypeAV1:
i.codec = codecAV1
default:
return errNoSuchCodec
}
return nil
}
}
func WithWidthAndHeight(width, height uint16) Option {
return func(i *IVFWriter) error {
i.videoWidth = width
i.videoHeight = height
return nil
}
}
func WithFrameRate(numerator, denominator uint32) Option {
return func(i *IVFWriter) error {
i.timebaseNumerator = numerator
i.timebaseDenominator = denominator
return nil
}
}
// WithDirectPTS enables direct use of RTP timestamps as PTS values
// without millisecond conversion.
//
// When this option is used, RTP timestamps are written directly as PTS values,
// preserving full timestamp precision. Use WithFrameRate to set the appropriate
// timebase (e.g., WithFrameRate(1, 90000) for standard 90kHz RTP clock).
//
// Example usage for standard RTP video (90kHz clock rate):
//
// NewWith(file, WithFrameRate(1, 90000), WithDirectPTS())
func WithDirectPTS() Option {
return func(i *IVFWriter) error {
i.directPTS = true
return nil
}
}

View File

@@ -0,0 +1,619 @@
// SPDX-FileCopyrightText: 2026 The Pion community <https://pion.ly>
// SPDX-License-Identifier: MIT
package ivfwriter
import (
"bytes"
"io"
"testing"
"github.com/pion/rtp"
"github.com/pion/rtp/codecs"
"github.com/stretchr/testify/assert"
)
type ivfWriterPacketTest struct {
buffer io.Writer
message string
messageClose string
packet *rtp.Packet
writer *IVFWriter
err error
closeErr error
}
func TestIVFWriter_Basic(t *testing.T) {
assert := assert.New(t)
addPacketTestCase := []ivfWriterPacketTest{
{
buffer: &bytes.Buffer{},
message: "IVFWriter shouldn't be able to write something to a closed file",
messageClose: "IVFWriter should be able to close an already closed file",
packet: nil,
err: errFileNotOpened,
closeErr: nil,
},
{
buffer: &bytes.Buffer{},
message: "IVFWriter shouldn't be able to write something an empty packet",
messageClose: "IVFWriter should be able to close the file",
packet: &rtp.Packet{},
err: errInvalidNilPacket,
closeErr: nil,
},
{
buffer: nil,
message: "IVFWriter shouldn't be able to write something to a closed file",
messageClose: "IVFWriter should be able to close an already closed file",
packet: nil,
err: errFileNotOpened,
closeErr: nil,
},
}
// First test case has a 'nil' file descriptor
writer, err := NewWith(addPacketTestCase[0].buffer)
assert.Nil(err, "IVFWriter should be created")
assert.NotNil(writer, "Writer shouldn't be nil")
assert.False(writer.seenKeyFrame, "Writer's seenKeyFrame should initialize false")
assert.Equal(uint64(0), writer.count, "Writer's packet count should initialize 0")
err = writer.Close()
assert.Nil(err, "IVFWriter should be able to close the stream")
writer.ioWriter = nil
addPacketTestCase[0].writer = writer
// Second test tries to write an empty packet
writer, err = NewWith(addPacketTestCase[1].buffer)
assert.Nil(err, "IVFWriter should be created")
assert.NotNil(writer, "Writer shouldn't be nil")
assert.False(writer.seenKeyFrame, "Writer's seenKeyFrame should initialize false")
assert.Equal(uint64(0), writer.count, "Writer's packet count should initialize 0")
addPacketTestCase[1].writer = writer
// Fourth test tries to write to a nil stream
writer, err = NewWith(addPacketTestCase[2].buffer)
assert.NotNil(err, "IVFWriter shouldn't be created")
assert.Nil(writer, "Writer should be nil")
addPacketTestCase[2].writer = writer
}
func TestIVFWriter_VP8(t *testing.T) {
// Construct valid packet
rawValidPkt := []byte{
0x90, 0xe0, 0x69, 0x8f, 0xd9, 0xc2, 0x93, 0xda, 0x1c, 0x64,
0x27, 0x82, 0x00, 0x01, 0x00, 0x01, 0xFF, 0xFF, 0xFF, 0xFF, 0x98, 0x36, 0xbe, 0x89, 0x9e,
}
validPacket := &rtp.Packet{
Header: rtp.Header{
Marker: true,
Extension: true,
ExtensionProfile: 1,
Version: 2,
PayloadType: 96,
SequenceNumber: 27023,
Timestamp: 3653407706,
SSRC: 476325762,
CSRC: []uint32{},
},
Payload: rawValidPkt[20:],
}
assert.NoError(t, validPacket.SetExtension(0, []byte{0xFF, 0xFF, 0xFF, 0xFF}))
// Construct mid partition packet
rawMidPartPkt := []byte{
0x90, 0xe0, 0x69, 0x8f, 0xd9, 0xc2, 0x93, 0xda, 0x1c, 0x64,
0x27, 0x82, 0x00, 0x01, 0x00, 0x01, 0xFF, 0xFF, 0xFF, 0xFF, 0x88, 0x36, 0xbe, 0x89, 0x9e,
}
midPartPacket := &rtp.Packet{
Header: rtp.Header{
Marker: true,
Extension: true,
ExtensionProfile: 1,
Version: 2,
PayloadType: 96,
SequenceNumber: 27023,
Timestamp: 3653407706,
SSRC: 476325762,
CSRC: []uint32{},
},
Payload: rawMidPartPkt[20:],
}
assert.NoError(t, midPartPacket.SetExtension(0, []byte{0xFF, 0xFF, 0xFF, 0xFF}))
// Construct keyframe packet
rawKeyframePkt := []byte{
0x90, 0xe0, 0x69, 0x8f, 0xd9, 0xc2, 0x93, 0xda, 0x1c, 0x64,
0x27, 0x82, 0x00, 0x01, 0x00, 0x01, 0xFF, 0xFF, 0xFF, 0xFF, 0x98, 0x36, 0xbe, 0x88, 0x9e,
}
keyframePacket := &rtp.Packet{
Header: rtp.Header{
Marker: true,
Extension: true,
ExtensionProfile: 1,
Version: 2,
PayloadType: 96,
SequenceNumber: 27023,
Timestamp: 3653407706,
SSRC: 476325762,
CSRC: []uint32{},
},
Payload: rawKeyframePkt[20:],
}
assert.NoError(t, keyframePacket.SetExtension(0, []byte{0xFF, 0xFF, 0xFF, 0xFF}))
assert := assert.New(t)
// Check valid packet parameters
vp8Packet := codecs.VP8Packet{}
_, err := vp8Packet.Unmarshal(validPacket.Payload)
assert.Nil(err, "Packet did not process")
assert.Equal(uint8(1), vp8Packet.S, "Start packet S value should be 1")
assert.Equal(uint8(1), vp8Packet.Payload[0]&0x01, "Non Keyframe packet P value should be 1")
// Check mid partition packet parameters
vp8Packet = codecs.VP8Packet{}
_, err = vp8Packet.Unmarshal(midPartPacket.Payload)
assert.Nil(err, "Packet did not process")
assert.Equal(uint8(0), vp8Packet.S, "Mid Partition packet S value should be 0")
assert.Equal(uint8(1), vp8Packet.Payload[0]&0x01, "Non Keyframe packet P value should be 1")
// Check keyframe packet parameters
vp8Packet = codecs.VP8Packet{}
_, err = vp8Packet.Unmarshal(keyframePacket.Payload)
assert.Nil(err, "Packet did not process")
assert.Equal(uint8(1), vp8Packet.S, "Start packet S value should be 1")
assert.Equal(uint8(0), vp8Packet.Payload[0]&0x01, "Keyframe packet P value should be 0")
// The linter misbehave and thinks this code is the same as the tests in oggwriter_test
// nolint:dupl
addPacketTestCase := []ivfWriterPacketTest{
{
buffer: &bytes.Buffer{},
message: "IVFWriter should be able to write an IVF packet",
messageClose: "IVFWriter should be able to close the file",
packet: validPacket,
err: nil,
closeErr: nil,
},
{
buffer: &bytes.Buffer{},
message: "IVFWriter should be able to write a Keframe IVF packet",
messageClose: "IVFWriter should be able to close the file",
packet: keyframePacket,
err: nil,
closeErr: nil,
},
}
// first test tries to write a valid VP8 packet
writer, err := NewWith(addPacketTestCase[0].buffer, WithCodec(mimeTypeVP8))
assert.Nil(err, "IVFWriter should be created")
assert.NotNil(writer, "Writer shouldn't be nil")
assert.False(writer.seenKeyFrame, "Writer's seenKeyFrame should initialize false")
assert.Equal(uint64(0), writer.count, "Writer's packet count should initialize 0")
addPacketTestCase[0].writer = writer
// second test tries to write a keyframe packet
writer, err = NewWith(addPacketTestCase[1].buffer)
assert.Nil(err, "IVFWriter should be created")
assert.NotNil(writer, "Writer shouldn't be nil")
assert.False(writer.seenKeyFrame, "Writer's seenKeyFrame should initialize false")
assert.Equal(uint64(0), writer.count, "Writer's packet count should initialize 0")
addPacketTestCase[1].writer = writer
for _, t := range addPacketTestCase {
if t.writer != nil {
res := t.writer.WriteRTP(t.packet)
assert.Equal(res, t.err, t.message)
}
}
// Third test tries to write a valid VP8 packet - No Keyframe
assert.False(addPacketTestCase[0].writer.seenKeyFrame, "Writer's seenKeyFrame should remain false")
assert.Equal(uint64(0), addPacketTestCase[0].writer.count, "Writer's packet count should remain 0")
// add a mid partition packet
assert.Equal(nil, addPacketTestCase[0].writer.WriteRTP(midPartPacket), "Write packet failed")
assert.Equal(uint64(0), addPacketTestCase[0].writer.count, "Writer's packet count should remain 0")
// Fifth test tries to write a keyframe packet
assert.True(addPacketTestCase[1].writer.seenKeyFrame, "Writer's seenKeyFrame should now be true")
assert.Equal(uint64(1), addPacketTestCase[1].writer.count, "Writer's packet count should now be 1")
// add a mid partition packet
assert.Equal(nil, addPacketTestCase[1].writer.WriteRTP(midPartPacket), "Write packet failed")
assert.Equal(uint64(1), addPacketTestCase[1].writer.count, "Writer's packet count should remain 1")
// add a valid packet
assert.Equal(nil, addPacketTestCase[1].writer.WriteRTP(validPacket), "Write packet failed")
assert.Equal(uint64(2), addPacketTestCase[1].writer.count, "Writer's packet count should now be 2")
for _, t := range addPacketTestCase {
if t.writer != nil {
res := t.writer.Close()
assert.Equal(res, t.closeErr, t.messageClose)
}
}
}
func TestIVFWriter_EmptyPayload(t *testing.T) {
buffer := &bytes.Buffer{}
writer, err := NewWith(buffer)
assert.NoError(t, err)
assert.NoError(t, writer.WriteRTP(&rtp.Packet{Payload: []byte{}}))
}
func TestIVFWriter_VP8DescriptorOnlyPayload(t *testing.T) {
// a VP8 payload can legally consist of the descriptor alone, which leaves
// the depacketized payload empty.
for _, payload := range [][]byte{
{0x10},
{0x90, 0x00},
{0x90, 0x80, 0x05},
} {
buffer := &bytes.Buffer{}
writer, err := NewWith(buffer)
assert.NoError(t, err)
assert.NoError(t, writer.WriteRTP(&rtp.Packet{
Header: rtp.Header{Marker: true},
Payload: payload,
}))
assert.Equal(t, 32, buffer.Len()) // only the IVF file header
}
}
func TestIVFWriter_Errors(t *testing.T) {
// Creating a Writer with AV1 and VP8
_, err := NewWith(&bytes.Buffer{}, WithCodec(mimeTypeAV1), WithCodec(mimeTypeAV1))
assert.ErrorIs(t, err, errCodecAlreadySet)
// Creating a Writer with Invalid Codec
_, err = NewWith(&bytes.Buffer{}, WithCodec(""))
assert.ErrorIs(t, err, errNoSuchCodec)
}
func TestIVFWriter_AV1(t *testing.T) {
t.Run("Unfragmented", func(t *testing.T) {
buffer := &bytes.Buffer{}
writer, err := NewWith(buffer, WithCodec(mimeTypeAV1))
assert.NoError(t, err)
assert.NoError(
t,
writer.WriteRTP(
&rtp.Packet{
Header: rtp.Header{Marker: true},
// N = 1, Length = 1, OBU_TYPE = 4
Payload: []byte{0x08, 0x01, 0x20},
}),
)
assert.NoError(t, writer.Close())
assert.Equal(t, buffer.Bytes(), []byte{
0x44, 0x4b, 0x49, 0x46, 0x0, 0x0, 0x20, 0x0, 0x41, 0x56, 0x30, 0x31,
0x80, 0x2, 0xe0, 0x1, 0x1e, 0x0, 0x0, 0x0, 0x1, 0x0, 0x0, 0x0, 0x84,
0x3, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x4, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0,
0x0, 0x0, 0x0, 0x0, 0x0, 0x12, 0x0, 0x22, 0x0,
})
})
t.Run("Fragmented", func(t *testing.T) {
buffer := &bytes.Buffer{}
writer, err := NewWith(buffer, WithCodec(mimeTypeAV1))
assert.NoError(t, err)
for _, p := range [][]byte{
{0x48, 0x02, 0x00, 0x01}, // Y=true
{0xc0, 0x02, 0x02, 0x03}, // Z=true, Y=true
{0xc0, 0x02, 0x04, 0x04}, // Z=true, Y=true
{0x80, 0x01, 0x05}, // Z=true, Y=false (But we still don't set Marker to true)
} {
assert.NoError(t, writer.WriteRTP(&rtp.Packet{Payload: p, Header: rtp.Header{Marker: false}}))
assert.Equal(t, buffer.Bytes(), []byte{
0x44, 0x4b, 0x49, 0x46, 0x0,
0x0, 0x20, 0x0, 0x41, 0x56, 0x30,
0x31, 0x80, 0x2, 0xe0, 0x1, 0x1e,
0x0, 0x0, 0x0, 0x1, 0x0, 0x0,
0x0, 0x84, 0x3, 0x0, 0x0, 0x0, 0x0,
0x0, 0x0,
})
}
assert.NoError(t, writer.WriteRTP(&rtp.Packet{Payload: []byte{0x08, 0x01, 0x20}, Header: rtp.Header{Marker: true}}))
assert.Equal(t, buffer.Bytes(), []byte{
0x44, 0x4b, 0x49, 0x46, 0x0, 0x0, 0x20, 0x0, 0x41, 0x56, 0x30, 0x31, 0x80, 0x2, 0xe0, 0x1, 0x1e,
0x0, 0x0, 0x0, 0x1, 0x0, 0x0, 0x0, 0x84, 0x3, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0xc, 0x0, 0x0, 0x0,
0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x12, 0x0, 0x2, 0x6, 0x1, 0x2, 0x3, 0x4, 0x4, 0x5, 0x22, 0x0,
})
assert.NoError(t, writer.Close())
})
t.Run("Invalid OBU", func(t *testing.T) {
buffer := &bytes.Buffer{}
writer, err := NewWith(buffer, WithCodec(mimeTypeAV1))
assert.NoError(t, err)
assert.Error(t, writer.WriteRTP(&rtp.Packet{Payload: []byte{0x08, 0x02, 0xff}}))
assert.Error(t, writer.WriteRTP(&rtp.Packet{Payload: []byte{0x08, 0x01, 0xff}}))
})
t.Run("Skips middle sequence start", func(t *testing.T) {
buffer := &bytes.Buffer{}
writer, err := NewWith(buffer, WithCodec(mimeTypeAV1))
assert.NoError(t, err)
assert.NoError(t, writer.WriteRTP(&rtp.Packet{Header: rtp.Header{Marker: true}, Payload: []byte{0x00, 0x01, 0x20}}))
assert.NoError(
t,
writer.WriteRTP(
&rtp.Packet{
Header: rtp.Header{Marker: true},
// N = 1, Length = 1, OBU_TYPE = 4
Payload: []byte{0x08, 0x01, 0x20},
},
),
)
assert.NoError(t, writer.Close())
assert.Equal(t, buffer.Bytes(), []byte{
0x44, 0x4b, 0x49, 0x46, 0x0, 0x0, 0x20, 0x0, 0x41, 0x56, 0x30, 0x31,
0x80, 0x2, 0xe0, 0x1, 0x1e, 0x0, 0x0, 0x0, 0x1, 0x0, 0x0, 0x0, 0x84,
0x3, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x4, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0,
0x0, 0x0, 0x0, 0x0, 0x0, 0x12, 0x0, 0x22, 0x0,
})
})
}
func TestIVFWriter_VP9(t *testing.T) {
buffer := &bytes.Buffer{}
writer, err := NewWith(buffer, WithCodec(mimeTypeVP9))
assert.NoError(t, err)
// No keyframe yet, ignore non-keyframe packets (P)
assert.NoError(t, writer.WriteRTP(&rtp.Packet{Payload: []byte{0xD0, 0x02, 0xAA}}))
assert.Equal(t, buffer.Bytes(), []byte{
0x44, 0x4b, 0x49, 0x46, 0x00, 0x00, 0x20, 0x00, 0x56, 0x50, 0x39, 0x30, 0x80, 0x02, 0xe0, 0x01,
0x1e, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x84, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
})
// No current frame, ignore packets that don't start a frame (B)
assert.NoError(t, writer.WriteRTP(&rtp.Packet{Payload: []byte{0x00, 0xAA}}))
assert.Equal(t, buffer.Bytes(), []byte{
0x44, 0x4b, 0x49, 0x46, 0x00, 0x00, 0x20, 0x00, 0x56, 0x50, 0x39, 0x30, 0x80, 0x02, 0xe0, 0x01,
0x1e, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x84, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
})
// B packet, no marker bit
assert.NoError(t, writer.WriteRTP(&rtp.Packet{Payload: []byte{0x08, 0xAA}}))
assert.Equal(t, buffer.Bytes(), []byte{
0x44, 0x4b, 0x49, 0x46, 0x00, 0x00, 0x20, 0x00, 0x56, 0x50, 0x39, 0x30, 0x80, 0x02, 0xe0, 0x01,
0x1e, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x84, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
})
// B packet, Marker Bit
assert.NoError(t, writer.WriteRTP(&rtp.Packet{Header: rtp.Header{Marker: true}, Payload: []byte{0x08, 0xAB}}))
assert.Equal(t, buffer.Bytes(), []byte{
0x44, 0x4b, 0x49, 0x46, 0x00, 0x00, 0x20, 0x00, 0x56, 0x50, 0x39, 0x30, 0x80, 0x02, 0xe0, 0x01,
0x1e, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x84, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xaa, 0xab,
})
}
func TestIVFWriter_WithWidthAndHeight(t *testing.T) {
buffer := &bytes.Buffer{}
writer, err := NewWith(buffer, WithWidthAndHeight(789, 652))
assert.NoError(t, err)
assert.NoError(t, writer.WriteRTP(&rtp.Packet{Payload: []byte{}}))
assert.NoError(t, writer.Close())
assert.Equal(t, []byte{
0x44, 0x4b, 0x49, 0x46, 0x00, 0x00, 0x20, 0x00, 0x56, 0x50, 0x38, 0x30, 0x15, 0x03, 0x8c, 0x02,
0x1e, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x84, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
}, buffer.Bytes())
}
func TestIVFWriter_WithFrameRate(t *testing.T) {
buffer := &bytes.Buffer{}
writer, err := NewWith(buffer, WithFrameRate(60, 1))
assert.NoError(t, err)
assert.NoError(t, writer.WriteRTP(&rtp.Packet{Payload: []byte{}}))
assert.NoError(t, writer.Close())
assert.Equal(t, []byte{
0x44, 0x4b, 0x49, 0x46, 0x00, 0x00, 0x20, 0x00, 0x56, 0x50, 0x38, 0x30, 0x80, 0x02, 0xe0, 0x01,
0x01, 0x00, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x00, 0x84, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
}, buffer.Bytes())
}
func TestIVFWriter_WithDirectPTS(t *testing.T) {
buffer := &bytes.Buffer{}
writer, err := NewWith(buffer, WithFrameRate(1, 90000), WithDirectPTS())
assert.NoError(t, err)
assert.True(t, writer.directPTS)
assert.Equal(t, uint32(1), writer.timebaseNumerator)
assert.Equal(t, uint32(90000), writer.timebaseDenominator)
assert.NoError(t, writer.Close())
}
func TestIVFWriter_DirectPTS_VP8(t *testing.T) {
buffer := &bytes.Buffer{}
writer, err := NewWith(buffer, WithCodec(mimeTypeVP8), WithFrameRate(1, 90000), WithDirectPTS())
assert.NoError(t, err)
// Write keyframe with timestamp 0.
keyframePacket := &rtp.Packet{
Header: rtp.Header{
Marker: true,
Timestamp: 0,
},
// VP8 keyframe: S=1, P=0
Payload: []byte{0x10, 0x00, 0x00, 0x9d, 0x01, 0x2a},
}
assert.NoError(t, writer.WriteRTP(keyframePacket))
assert.Equal(t, uint64(1), writer.count)
// Write second frame with timestamp 6000 (15fps at 90kHz clock).
frame2 := &rtp.Packet{
Header: rtp.Header{
Marker: true,
Timestamp: 6000,
},
// VP8 interframe: S=1, P=1
Payload: []byte{0x10, 0x01, 0x00, 0x9d, 0x01, 0x2a},
}
assert.NoError(t, writer.WriteRTP(frame2))
assert.Equal(t, uint64(2), writer.count)
// Write third frame with timestamp 12000.
frame3 := &rtp.Packet{
Header: rtp.Header{
Marker: true,
Timestamp: 12000,
},
Payload: []byte{0x10, 0x01, 0x00, 0x9d, 0x01, 0x2a},
}
assert.NoError(t, writer.WriteRTP(frame3))
assert.Equal(t, uint64(3), writer.count)
assert.NoError(t, writer.Close())
// Verify IVF structure.
data := buffer.Bytes()
assert.True(t, len(data) > 32, "Buffer should contain header + frames")
// Check IVF header timebase (offset 16-20: denominator, offset 20-24: numerator).
timebaseDenom := uint32(data[16]) | uint32(data[17])<<8 | uint32(data[18])<<16 | uint32(data[19])<<24
timebaseNum := uint32(data[20]) | uint32(data[21])<<8 | uint32(data[22])<<16 | uint32(data[23])<<24
assert.Equal(t, uint32(90000), timebaseDenom)
assert.Equal(t, uint32(1), timebaseNum)
// Verify PTS values in frame headers.
// Frame 1: PTS should be 0.
pts1 := uint64(data[36]) | uint64(data[37])<<8 | uint64(data[38])<<16 | uint64(data[39])<<24 |
uint64(data[40])<<32 | uint64(data[41])<<40 | uint64(data[42])<<48 | uint64(data[43])<<56
assert.Equal(t, uint64(0), pts1, "First frame PTS should be 0")
// Frame 2: PTS should be 6000 (RTP timestamp directly).
frameSize1 := uint32(data[32]) | uint32(data[33])<<8 | uint32(data[34])<<16 | uint32(data[35])<<24
frame2Offset := 32 + 12 + int(frameSize1)
pts2 := uint64(data[frame2Offset+4]) | uint64(data[frame2Offset+5])<<8 |
uint64(data[frame2Offset+6])<<16 | uint64(data[frame2Offset+7])<<24 |
uint64(data[frame2Offset+8])<<32 | uint64(data[frame2Offset+9])<<40 |
uint64(data[frame2Offset+10])<<48 | uint64(data[frame2Offset+11])<<56
assert.Equal(t, uint64(6000), pts2, "Second frame PTS should be 6000")
}
func TestIVFWriter_DirectPTS_Precision(t *testing.T) {
buffer := &bytes.Buffer{}
writer, err := NewWith(buffer, WithCodec(mimeTypeVP8), WithFrameRate(1, 90000), WithDirectPTS())
assert.NoError(t, err)
// Simulate 15fps video (6000 RTP ticks per frame at 90kHz).
// 225 frames = 15 seconds.
timestamps := make([]uint32, 225)
for idx := range timestamps {
timestamps[idx] = uint32(idx) * 6000 //nolint:gosec // Test code with known safe values.
}
for idx, ts := range timestamps {
packet := &rtp.Packet{
Header: rtp.Header{
Marker: true,
Timestamp: ts,
},
// VP8 keyframe for first, interframe for rest.
Payload: []byte{0x10, 0x00, 0x00, 0x9d, 0x01, 0x2a},
}
if idx > 0 {
packet.Payload[1] = 0x01 // Set non-keyframe flag.
}
assert.NoError(t, writer.WriteRTP(packet))
}
assert.NoError(t, writer.Close())
// Verify frame count.
assert.Equal(t, uint64(225), writer.count)
// Verify last frame PTS is exactly 224 * 6000 = 1344000.
data := buffer.Bytes()
offset := 32 // Start after IVF header.
var lastPTS uint64
for range 225 {
frameSize := uint32(data[offset]) | uint32(data[offset+1])<<8 |
uint32(data[offset+2])<<16 | uint32(data[offset+3])<<24
lastPTS = uint64(data[offset+4]) | uint64(data[offset+5])<<8 |
uint64(data[offset+6])<<16 | uint64(data[offset+7])<<24 |
uint64(data[offset+8])<<32 | uint64(data[offset+9])<<40 |
uint64(data[offset+10])<<48 | uint64(data[offset+11])<<56
offset += 12 + int(frameSize)
}
// Last frame should have PTS = 224 * 6000 = 1344000.
assert.Equal(t, uint64(224*6000), lastPTS, "Last frame PTS should be exactly 1344000")
}
func TestIVFWriter_BackwardCompatibility(t *testing.T) {
// Test that default behavior (without WithDirectPTS) remains unchanged.
buffer := &bytes.Buffer{}
writer, err := NewWith(buffer, WithCodec(mimeTypeVP8))
assert.NoError(t, err)
assert.False(t, writer.directPTS, "Default should not use direct PTS mode")
// Write keyframe.
keyframePacket := &rtp.Packet{
Header: rtp.Header{
Marker: true,
Timestamp: 90000, // 1 second at 90kHz.
},
Payload: []byte{0x10, 0x00, 0x00, 0x9d, 0x01, 0x2a},
}
assert.NoError(t, writer.WriteRTP(keyframePacket))
// Write second frame at 2 seconds.
frame2 := &rtp.Packet{
Header: rtp.Header{
Marker: true,
Timestamp: 180000, // 2 seconds at 90kHz.
},
Payload: []byte{0x10, 0x01, 0x00, 0x9d, 0x01, 0x2a},
}
assert.NoError(t, writer.WriteRTP(frame2))
assert.NoError(t, writer.Close())
// Verify PTS uses millisecond conversion (legacy behavior).
data := buffer.Bytes()
// First frame PTS should be 0.
pts1 := uint64(data[36]) | uint64(data[37])<<8 | uint64(data[38])<<16 | uint64(data[39])<<24 |
uint64(data[40])<<32 | uint64(data[41])<<40 | uint64(data[42])<<48 | uint64(data[43])<<56
assert.Equal(t, uint64(0), pts1)
// Second frame: (180000-90000)/90000 * 1000 = 1000ms, then 1000 * 1 / 30 = 33 PTS.
frameSize1 := uint32(data[32]) | uint32(data[33])<<8 | uint32(data[34])<<16 | uint32(data[35])<<24
frame2Offset := 32 + 12 + int(frameSize1)
pts2 := uint64(data[frame2Offset+4]) | uint64(data[frame2Offset+5])<<8 |
uint64(data[frame2Offset+6])<<16 | uint64(data[frame2Offset+7])<<24 |
uint64(data[frame2Offset+8])<<32 | uint64(data[frame2Offset+9])<<40 |
uint64(data[frame2Offset+10])<<48 | uint64(data[frame2Offset+11])<<56
assert.Equal(t, uint64(33), pts2, "Legacy mode: PTS should be 33 (1000ms * 1/30)")
}