package/gortsplib
1
0
Fork 0
mirror of https://github.com/aler9/gortsplib synced 2025-10-05 15:16:51 +08:00
Code Issues Packages Projects Releases Wiki Activity

deprecate rtpav1.Decoder.Decode, rtph264.Decoder.Decode, rtph265.Decoder.Decode

Browse Source
This commit is contained in:
aler9
2023-08-14 13:22:26 +02:00
committed by Alessandro Ros
parent 482b047999
commit 8857e25353
13 changed files with 46 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
examples/client-read-format-h264-convert-to-jpeg/main.go
View File

@@ -101,7 +101,7 @@ func main() {
saveCount := 0 saveCount := 0
c.OnPacketRTP(medi, forma, func(pkt *rtp.Packet) { c.OnPacketRTP(medi, forma, func(pkt *rtp.Packet) {
// extract access units from RTP packets // extract access units from RTP packets
au, _, err := rtpDec.Decode(pkt) au, _, err := rtpDec.DecodeUntilMarker(pkt)
if err != nil { if err != nil {
if err != rtph264.ErrNonStartingPacketAndNoPrevious && err != rtph264.ErrMorePacketsNeeded { if err != rtph264.ErrNonStartingPacketAndNoPrevious && err != rtph264.ErrMorePacketsNeeded {
log.Printf("ERR: %v", err) log.Printf("ERR: %v", err)

1
examples/client-read-format-h264-save-to-disk/main.go
View File

@@ -65,7 +65,6 @@ func main() {
// called when a RTP packet arrives // called when a RTP packet arrives
c.OnPacketRTP(medi, forma, func(pkt *rtp.Packet) { c.OnPacketRTP(medi, forma, func(pkt *rtp.Packet) {
// extract access unit from RTP packets // extract access unit from RTP packets
// DecodeUntilMarker is necessary for the DTS extractor to work
au, pts, err := rtpDec.DecodeUntilMarker(pkt) au, pts, err := rtpDec.DecodeUntilMarker(pkt)
if err != nil { if err != nil {
if err != rtph264.ErrNonStartingPacketAndNoPrevious && err != rtph264.ErrMorePacketsNeeded { if err != rtph264.ErrNonStartingPacketAndNoPrevious && err != rtph264.ErrMorePacketsNeeded {

2
examples/client-read-format-h264/main.go
View File

@@ -77,7 +77,7 @@ func main() {
// called when a RTP packet arrives // called when a RTP packet arrives
c.OnPacketRTP(medi, forma, func(pkt *rtp.Packet) { c.OnPacketRTP(medi, forma, func(pkt *rtp.Packet) {
// extract access units from RTP packets // extract access units from RTP packets
au, pts, err := rtpDec.Decode(pkt) au, pts, err := rtpDec.DecodeUntilMarker(pkt)
if err != nil { if err != nil {
if err != rtph264.ErrNonStartingPacketAndNoPrevious && err != rtph264.ErrMorePacketsNeeded { if err != rtph264.ErrNonStartingPacketAndNoPrevious && err != rtph264.ErrMorePacketsNeeded {
log.Printf("ERR: %v", err) log.Printf("ERR: %v", err)

2
examples/client-read-format-h265/main.go
View File

@@ -59,7 +59,7 @@ func main() {
// called when a RTP packet arrives // called when a RTP packet arrives
c.OnPacketRTP(medi, forma, func(pkt *rtp.Packet) { c.OnPacketRTP(medi, forma, func(pkt *rtp.Packet) {
// extract access units from RTP packets // extract access units from RTP packets
au, pts, err := rtpDec.Decode(pkt) au, pts, err := rtpDec.DecodeUntilMarker(pkt)
if err != nil { if err != nil {
if err != rtph265.ErrNonStartingPacketAndNoPrevious && err != rtph265.ErrMorePacketsNeeded { if err != rtph265.ErrNonStartingPacketAndNoPrevious && err != rtph265.ErrMorePacketsNeeded {
log.Printf("ERR: %v", err) log.Printf("ERR: %v", err)

2
pkg/formats/av1_test.go
View File

@@ -29,7 +29,7 @@ func TestAV1DecEncoder(t *testing.T) {
dec, err := format.CreateDecoder2() dec, err := format.CreateDecoder2()
require.NoError(t, err) require.NoError(t, err)
byts, _, err := dec.Decode(pkts[0]) byts, _, err := dec.DecodeUntilMarker(pkts[0])
require.NoError(t, err) require.NoError(t, err)
require.Equal(t, [][]byte{{0x01, 0x02, 0x03, 0x04}}, byts) require.Equal(t, [][]byte{{0x01, 0x02, 0x03, 0x04}}, byts)
} }

2
pkg/formats/h264_test.go
View File

@@ -57,7 +57,7 @@ func TestH264DecEncoder(t *testing.T) {
dec, err := format.CreateDecoder2() dec, err := format.CreateDecoder2()
require.NoError(t, err) require.NoError(t, err)
byts, _, err := dec.Decode(pkts[0]) byts, _, err := dec.DecodeUntilMarker(pkts[0])
require.NoError(t, err) require.NoError(t, err)
require.Equal(t, [][]byte{{0x01, 0x02, 0x03, 0x04}}, byts) require.Equal(t, [][]byte{{0x01, 0x02, 0x03, 0x04}}, byts)
} }

2
pkg/formats/h265_test.go
View File

@@ -60,7 +60,7 @@ func TestH265DecEncoder(t *testing.T) {
dec, err := format.CreateDecoder2() dec, err := format.CreateDecoder2()
require.NoError(t, err) require.NoError(t, err)
byts, _, err := dec.Decode(pkts[0]) byts, _, err := dec.DecodeUntilMarker(pkts[0])
require.NoError(t, err) require.NoError(t, err)
require.Equal(t, [][]byte{{0x01, 0x02, 0x03, 0x04}}, byts) require.Equal(t, [][]byte{{0x01, 0x02, 0x03, 0x04}}, byts)
} }

12
pkg/formats/rtpav1/decoder.go
View File

@@ -52,7 +52,13 @@ func (d *Decoder) Init() error {
} }
// Decode decodes OBUs from a RTP packet. // Decode decodes OBUs from a RTP packet.
//
// Deprecated: this method returns incomplete temporal units.
func (d *Decoder) Decode(pkt *rtp.Packet) ([][]byte, time.Duration, error) { func (d *Decoder) Decode(pkt *rtp.Packet) ([][]byte, time.Duration, error) {
return d.decodeOBUs(pkt)
}
func (d *Decoder) decodeOBUs(pkt *rtp.Packet) ([][]byte, time.Duration, error) {
var av1header codecs.AV1Packet var av1header codecs.AV1Packet
_, err := av1header.Unmarshal(pkt.Payload) _, err := av1header.Unmarshal(pkt.Payload)
if err != nil { if err != nil {
@@ -126,11 +132,9 @@ func (d *Decoder) Decode(pkt *rtp.Packet) ([][]byte, time.Duration, error) {
return obus, d.timeDecoder.Decode(pkt.Timestamp), nil return obus, d.timeDecoder.Decode(pkt.Timestamp), nil
} }
// DecodeUntilMarker decodes OBUs from a RTP packet and puts them in a buffer. // DecodeUntilMarker decodes a temporal unit from a RTP packet.
// When a packet has the marker flag (meaning that all OBUs with the same PTS have
// been received), the buffer is returned.
func (d *Decoder) DecodeUntilMarker(pkt *rtp.Packet) ([][]byte, time.Duration, error) { func (d *Decoder) DecodeUntilMarker(pkt *rtp.Packet) ([][]byte, time.Duration, error) {
obus, pts, err := d.Decode(pkt) obus, pts, err := d.decodeOBUs(pkt)
if err != nil { if err != nil {
return nil, 0, err return nil, 0, err
} }

6
pkg/formats/rtpav1/decoder_test.go
View File

@@ -18,7 +18,7 @@ func TestDecode(t *testing.T) {
var obus [][]byte var obus [][]byte
for _, pkt := range ca.pkts { for _, pkt := range ca.pkts {
addOBUs, _, err := d.Decode(pkt) addOBUs, _, err := d.DecodeUntilMarker(pkt)
if err == ErrMorePacketsNeeded { if err == ErrMorePacketsNeeded {
continue continue
} }
@@ -59,7 +59,7 @@ func FuzzDecoder(f *testing.F) {
d := &Decoder{} d := &Decoder{}
d.Init() //nolint:errcheck d.Init() //nolint:errcheck
d.Decode(&rtp.Packet{ //nolint:errcheck d.DecodeUntilMarker(&rtp.Packet{ //nolint:errcheck
Header: rtp.Header{ Header: rtp.Header{
Version: 2, Version: 2,
Marker: am, Marker: am,
@@ -71,7 +71,7 @@ func FuzzDecoder(f *testing.F) {
Payload: a, Payload: a,
}) })
d.Decode(&rtp.Packet{ //nolint:errcheck d.DecodeUntilMarker(&rtp.Packet{ //nolint:errcheck
Header: rtp.Header{ Header: rtp.Header{
Version: 2, Version: 2,
Marker: bm, Marker: bm,

12
pkg/formats/rtph264/decoder.go
View File

@@ -60,7 +60,13 @@ func (d *Decoder) Init() error {
} }
// Decode decodes NALUs from a RTP packet. // Decode decodes NALUs from a RTP packet.
//
// Deprecated: this method returns incomplete access units.
func (d *Decoder) Decode(pkt *rtp.Packet) ([][]byte, time.Duration, error) { func (d *Decoder) Decode(pkt *rtp.Packet) ([][]byte, time.Duration, error) {
return d.decodeNALUs(pkt)
}
func (d *Decoder) decodeNALUs(pkt *rtp.Packet) ([][]byte, time.Duration, error) {
if len(pkt.Payload) < 1 { if len(pkt.Payload) < 1 {
d.fragments = d.fragments[:0] // discard pending fragments d.fragments = d.fragments[:0] // discard pending fragments
return nil, 0, fmt.Errorf("payload is too short") return nil, 0, fmt.Errorf("payload is too short")
@@ -170,11 +176,9 @@ func (d *Decoder) Decode(pkt *rtp.Packet) ([][]byte, time.Duration, error) {
return nalus, d.timeDecoder.Decode(pkt.Timestamp), nil return nalus, d.timeDecoder.Decode(pkt.Timestamp), nil
} }
// DecodeUntilMarker decodes NALUs from a RTP packet and puts them in a buffer. // DecodeUntilMarker decodes an access unit from a RTP packet.
// When a packet has the marker flag (meaning that all the NALUs with the same PTS have
// been received), the buffer is returned.
func (d *Decoder) DecodeUntilMarker(pkt *rtp.Packet) ([][]byte, time.Duration, error) { func (d *Decoder) DecodeUntilMarker(pkt *rtp.Packet) ([][]byte, time.Duration, error) {
nalus, pts, err := d.Decode(pkt) nalus, pts, err := d.decodeNALUs(pkt)
if err != nil { if err != nil {
return nil, 0, err return nil, 0, err
} }

20
pkg/formats/rtph264/decoder_test.go
View File

@@ -21,7 +21,7 @@ func TestDecode(t *testing.T) {
for _, pkt := range ca.pkts { for _, pkt := range ca.pkts {
clone := pkt.Clone() clone := pkt.Clone()
addNALUs, _, err := d.Decode(pkt) addNALUs, _, err := d.DecodeUntilMarker(pkt)
// test input integrity // test input integrity
require.Equal(t, clone, pkt) require.Equal(t, clone, pkt)
@@ -44,10 +44,10 @@ func TestDecodeCorruptedFragment(t *testing.T) {
err := d.Init() err := d.Init()
require.NoError(t, err) require.NoError(t, err)
_, _, err = d.Decode(&rtp.Packet{ _, _, err = d.DecodeUntilMarker(&rtp.Packet{
Header: rtp.Header{ Header: rtp.Header{
Version: 2, Version: 2,
Marker: false, Marker: true,
PayloadType: 96, PayloadType: 96,
SequenceNumber: 17645, SequenceNumber: 17645,
Timestamp: 2289527317, Timestamp: 2289527317,
@@ -63,10 +63,10 @@ func TestDecodeCorruptedFragment(t *testing.T) {
}) })
require.Equal(t, ErrMorePacketsNeeded, err) require.Equal(t, ErrMorePacketsNeeded, err)
nalus, _, err := d.Decode(&rtp.Packet{ nalus, _, err := d.DecodeUntilMarker(&rtp.Packet{
Header: rtp.Header{ Header: rtp.Header{
Version: 2, Version: 2,
Marker: false, Marker: true,
PayloadType: 96, PayloadType: 96,
SequenceNumber: 17646, SequenceNumber: 17646,
Timestamp: 2289527317, Timestamp: 2289527317,
@@ -100,7 +100,7 @@ func TestDecodeSTAPAWithPadding(t *testing.T) {
}, },
} }
nalus, _, err := d.Decode(&pkt) nalus, _, err := d.DecodeUntilMarker(&pkt)
require.NoError(t, err) require.NoError(t, err)
require.Equal(t, [][]byte{ require.Equal(t, [][]byte{
{0xaa, 0xbb}, {0xaa, 0xbb},
@@ -113,7 +113,7 @@ func TestDecodeAnnexB(t *testing.T) {
err := d.Init() err := d.Init()
require.NoError(t, err) require.NoError(t, err)
nalus, _, err := d.Decode(&rtp.Packet{ nalus, _, err := d.DecodeUntilMarker(&rtp.Packet{
Header: rtp.Header{ Header: rtp.Header{
Version: 2, Version: 2,
Marker: true, Marker: true,
@@ -132,7 +132,7 @@ func TestDecodeAnnexB(t *testing.T) {
}, nalus) }, nalus)
for i := 0; i < 2; i++ { for i := 0; i < 2; i++ {
nalus, _, err := d.Decode(&rtp.Packet{ nalus, _, err := d.DecodeUntilMarker(&rtp.Packet{
Header: rtp.Header{ Header: rtp.Header{
Version: 2, Version: 2,
Marker: true, Marker: true,
@@ -217,7 +217,7 @@ func FuzzDecoder(f *testing.F) {
d := &Decoder{} d := &Decoder{}
d.Init() //nolint:errcheck d.Init() //nolint:errcheck
d.Decode(&rtp.Packet{ //nolint:errcheck d.DecodeUntilMarker(&rtp.Packet{ //nolint:errcheck
Header: rtp.Header{ Header: rtp.Header{
Version: 2, Version: 2,
Marker: false, Marker: false,
@@ -229,7 +229,7 @@ func FuzzDecoder(f *testing.F) {
Payload: a, Payload: a,
}) })
d.Decode(&rtp.Packet{ //nolint:errcheck d.DecodeUntilMarker(&rtp.Packet{ //nolint:errcheck
Header: rtp.Header{ Header: rtp.Header{
Version: 2, Version: 2,
Marker: false, Marker: false,

12
pkg/formats/rtph265/decoder.go
View File

@@ -58,7 +58,13 @@ func (d *Decoder) Init() error {
} }
// Decode decodes NALUs from a RTP packet. // Decode decodes NALUs from a RTP packet.
//
// Deprecated: this method returns incomplete access units.
func (d *Decoder) Decode(pkt *rtp.Packet) ([][]byte, time.Duration, error) { func (d *Decoder) Decode(pkt *rtp.Packet) ([][]byte, time.Duration, error) {
return d.decodeNALUs(pkt)
}
func (d *Decoder) decodeNALUs(pkt *rtp.Packet) ([][]byte, time.Duration, error) {
if len(pkt.Payload) < 2 { if len(pkt.Payload) < 2 {
d.fragments = d.fragments[:0] // discard pending fragments d.fragments = d.fragments[:0] // discard pending fragments
return nil, 0, fmt.Errorf("payload is too short") return nil, 0, fmt.Errorf("payload is too short")
@@ -161,11 +167,9 @@ func (d *Decoder) Decode(pkt *rtp.Packet) ([][]byte, time.Duration, error) {
return nalus, d.timeDecoder.Decode(pkt.Timestamp), nil return nalus, d.timeDecoder.Decode(pkt.Timestamp), nil
} }
// DecodeUntilMarker decodes NALUs from a RTP packet and puts them in a buffer. // DecodeUntilMarker decodes an access unit from a RTP packet.
// When a packet has the marker flag (meaning that all the NALUs with the same PTS have
// been received), the buffer is returned.
func (d *Decoder) DecodeUntilMarker(pkt *rtp.Packet) ([][]byte, time.Duration, error) { func (d *Decoder) DecodeUntilMarker(pkt *rtp.Packet) ([][]byte, time.Duration, error) {
nalus, pts, err := d.Decode(pkt) nalus, pts, err := d.decodeNALUs(pkt)
if err != nil { if err != nil {
return nil, 0, err return nil, 0, err
} }

6
pkg/formats/rtph265/decoder_test.go
View File

@@ -20,7 +20,7 @@ func TestDecode(t *testing.T) {
for _, pkt := range ca.pkts { for _, pkt := range ca.pkts {
clone := pkt.Clone() clone := pkt.Clone()
addNALUs, _, err := d.Decode(pkt) addNALUs, _, err := d.DecodeUntilMarker(pkt)
// test input integrity // test input integrity
require.Equal(t, clone, pkt) require.Equal(t, clone, pkt)
@@ -65,7 +65,7 @@ func FuzzDecoder(f *testing.F) {
d := &Decoder{} d := &Decoder{}
d.Init() //nolint:errcheck d.Init() //nolint:errcheck
d.Decode(&rtp.Packet{ //nolint:errcheck d.DecodeUntilMarker(&rtp.Packet{ //nolint:errcheck
Header: rtp.Header{ Header: rtp.Header{
Version: 2, Version: 2,
Marker: false, Marker: false,
@@ -77,7 +77,7 @@ func FuzzDecoder(f *testing.F) {
Payload: a, Payload: a,
}) })
d.Decode(&rtp.Packet{ //nolint:errcheck d.DecodeUntilMarker(&rtp.Packet{ //nolint:errcheck
Header: rtp.Header{ Header: rtp.Header{
Version: 2, Version: 2,
Marker: false, Marker: false,