ref: 82124b44babae68b83dd8e36ba9f35b76bd009b8
parent: a6ab0c92e0ce06c0eed7885b966f44e1816424b9
author: lieff <lieff@users.noreply.github.com>
date: Wed May 6 09:25:00 EDT 2020
readme: clarification to free format sync procedure
--- a/README.md
+++ b/README.md
@@ -113,6 +113,13 @@
of the input buffer, the more reliable the sync procedure. We recommend having
as many as 10 consecutive MP3 frames (~16KB) in the input buffer at a time.
+At end of stream just pass rest of the buffer, sync procedure should work even
+with just 1 frame in stream (except for free format and garbage at the end can
+mess things up, so id3v1 and ape tags must be removed first).
+
+For free format there minimum 3 frames needed to do proper sync: 2 frames to
+detect frame length and 1 next frame to check detect is good.
+
The size of the consumed MP3 data is returned in the ``mp3dec_frame_info_t``
field of the ``frame_bytes`` struct; you must remove the data corresponding to
the ``frame_bytes`` field from the input buffer before the next decoder