From 2c9f7bf926de1a0b98b7c43cf272aebfb04674bf Mon Sep 17 00:00:00 2001
From: Juliusz Chroboczek <jch@irif.fr>
Date: Mon, 15 Apr 2024 18:52:57 +0200
Subject: [PATCH] Mark ReadFrames as being deprecated

This function's interface is mis-designed, since it relies on the
AV1Packet retaining the whole list of OBUs.
---
 codecs/av1/frame/av1.go | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/codecs/av1/frame/av1.go b/codecs/av1/frame/av1.go
index 1e001a3..7da69e3 100644
--- a/codecs/av1/frame/av1.go
+++ b/codecs/av1/frame/av1.go
@@ -30,6 +30,9 @@ func (f *AV1) pushOBUElement(isFirstOBUFragment *bool, obuElement []byte, obuLis
 }
 
 // ReadFrames processes the codecs.AV1Packet and returns fully constructed frames
+//
+// Deprecated: this depends on the depreacted OBUElements field being set
+// by the caller.
 func (f *AV1) ReadFrames(pkt *codecs.AV1Packet) ([][]byte, error) {
 	OBUs := [][]byte{}
 	isFirstOBUFragment := pkt.Z