mirror/miniaudio
1
0
Fork 0
mirror of https://github.com/mackron/miniaudio.git synced 2026-04-24 01:04:02 +02:00
Code Issues Packages Projects Releases Wiki Activity

Small documentation update.

Browse Source
This commit is contained in:
David Reid
2019-12-22 09:01:57 +10:00
parent 28093e5c29
commit 11c0af38f5
1 changed files with 18 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
miniaudio.h
+18 -1
View File
@@ -3211,6 +3211,10 @@ float ma_gain_db_to_factor(float gain);
/************************************************************************************************************************************************************ /************************************************************************************************************************************************************
Decoding Decoding
========
Decoders are independent of the main device API. Decoding APIs can be called freely inside the device's data callback, but they are not thread safe unless
you do your own synchronization.
************************************************************************************************************************************************************/ ************************************************************************************************************************************************************/
#ifndef MA_NO_DECODING #ifndef MA_NO_DECODING
@@ -3313,11 +3317,24 @@ If the length is unknown or an error occurs, 0 will be returned.
This will always return 0 for Vorbis decoders. This is due to a limitation with stb_vorbis in push mode which is what miniaudio This will always return 0 for Vorbis decoders. This is due to a limitation with stb_vorbis in push mode which is what miniaudio
uses internally. uses internally.
This will run in linear time for MP3 decoders. Do not call this in time critical scenarios. For MP3's, this will decode the entire file. Do not call this in time critical scenarios.
This function is not thread safe without your own synchronization.
*/ */
ma_uint64 ma_decoder_get_length_in_pcm_frames(ma_decoder* pDecoder); ma_uint64 ma_decoder_get_length_in_pcm_frames(ma_decoder* pDecoder);
/*
Reads PCM frames from the given decoder.
This is not thread safe without your own synchronization.
*/
ma_uint64 ma_decoder_read_pcm_frames(ma_decoder* pDecoder, void* pFramesOut, ma_uint64 frameCount); ma_uint64 ma_decoder_read_pcm_frames(ma_decoder* pDecoder, void* pFramesOut, ma_uint64 frameCount);
/*
Seeks to a PCM frame based on it's absolute index.
This is not thread safe without your own synchronization.
*/
ma_result ma_decoder_seek_to_pcm_frame(ma_decoder* pDecoder, ma_uint64 frameIndex); ma_result ma_decoder_seek_to_pcm_frame(ma_decoder* pDecoder, ma_uint64 frameIndex);
/* /*