ref: ce29e1004fd388c2504485145aea87dc8a8eb64e
parent: 8110672527f093b78ded3a1bff7f3fa91a8dafdf
author: lieff <lieff@users.noreply.github.com>
date: Fri Jan 12 08:31:42 EST 2018
doc formating
--- a/README.md
+++ b/README.md
@@ -88,16 +88,20 @@
Application must remove mp3dec_frame_info_t::frame_bytes bytes from input buffer before next decoder invocation.
Decode function returns # of decoded samples; following cases are possible:
- 0 - No MP3 data was found in the input buffer
+
+- 0 - No MP3 data was found in the input buffer
384 - Layer 1
576 - MPEG 2 Layer 3
1152 - otherwise
Description of returned #samples and mp3dec_frame_info_t::frame_bytes combination:
+
+-
#samples > 0 && frame_bytes > 0 - succesful decode
#samples == 0 && frame_bytes > 0 - decoder skip ID3 or invalid data
#samples == 0 && frame_bytes == 0 - insufficied data, application must supply more data
#samples > 0 && frame_bytes == 0 - impossible combination
+
Also if frame_bytes == 0 other info fields can be uninitialized/not updated, if info.frame_bytes != 0 all info fields available such as info.hz = sample rate, info.channels = mono(1)/stereo(2), info.bitrate_kbps = bitrate in kbits.
Application may call mp3dec_init() when changing decode position, however, it is not necessary.