History

doc formating

lieff committed 8 years ago

Commit ce29e101 parent 81106721 file · +5 −1Browse files

Unified · Split

README.md+5−1
@@ -88,16 +88,20 @@ Size of consumed MP3 data returned in the mp3dec_frame_info_t::frame_bytes field · 87 unmodified lines
8888 Application must remove mp3dec_frame_info_t::frame_bytes bytes from input buffer before next decoder invocation.
8989
9090 Decode function returns # of decoded samples; following cases are possible:
91− 0 - No MP3 data was found in the input buffer
91+
92+- 0 - No MP3 data was found in the input buffer
9293 384 - Layer 1
9394 576 - MPEG 2 Layer 3
9495 1152 - otherwise
9596
9697 Description of returned #samples and mp3dec_frame_info_t::frame_bytes combination:
98+
99+-
97100 #samples > 0 && frame_bytes > 0 - succesful decode
98101 #samples == 0 && frame_bytes > 0 - decoder skip ID3 or invalid data
99102 #samples == 0 && frame_bytes == 0 - insufficied data, application must supply more data
100103 #samples > 0 && frame_bytes == 0 - impossible combination
104+
101105 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.
102106
103107 Application may call mp3dec_init() when changing decode position, however, it is not necessary.

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t