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

Rearrange some notes to be roughly in order of importance.

Browse Source
This commit is contained in:
David Reid
2020-01-04 08:30:12 +10:00
parent 3f23492294
commit d1f19836ca
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
miniaudio.h
+6 -6
View File
@@ -261,13 +261,8 @@ NOTES
===== =====
- This library uses an asynchronous API for delivering and requesting audio data. Each device will have - This library uses an asynchronous API for delivering and requesting audio data. Each device will have
it's own worker thread which is managed by the library. it's own worker thread which is managed by the library.
- If ma_device_init() is called with a device that's not aligned to the 4 bytes on 32-bit or 8 bytes on
64-bit it will _not_ be thread-safe. The reason for this is that it depends on members of ma_device being
correctly aligned for atomic assignments.
- Sample data is always native-endian and interleaved. For example, ma_format_s16 means signed 16-bit - Sample data is always native-endian and interleaved. For example, ma_format_s16 means signed 16-bit
integer samples, interleaved. Let me know if you need non-interleaved and I'll look into it. integer samples, interleaved.
- The sndio backend is currently only enabled on OpenBSD builds.
- The audio(4) backend is supported on OpenBSD, but you may need to disable sndiod before you can use it.
- Automatic stream routing is enabled on a per-backend basis. Support is explicitly enabled for WASAPI - Automatic stream routing is enabled on a per-backend basis. Support is explicitly enabled for WASAPI
and Core Audio, however other backends such as PulseAudio may naturally support it, though not all have and Core Audio, however other backends such as PulseAudio may naturally support it, though not all have
been tested. been tested.
@@ -277,6 +272,11 @@ NOTES
- By default miniaudio will automatically clip samples. This only applies when the playback sample format - By default miniaudio will automatically clip samples. This only applies when the playback sample format
is configured as ma_format_f32. If you are doing clipping yourself, you can disable this overhead by is configured as ma_format_f32. If you are doing clipping yourself, you can disable this overhead by
setting noClip to true in the device config. setting noClip to true in the device config.
- If ma_device_init() is called with a device that's not aligned to the 4 bytes on 32-bit or 8 bytes on
64-bit it will _not_ be thread-safe. The reason for this is that it depends on members of ma_device being
correctly aligned for atomic assignments.
- The sndio backend is currently only enabled on OpenBSD builds.
- The audio(4) backend is supported on OpenBSD, but you may need to disable sndiod before you can use it.
BACKEND NUANCES BACKEND NUANCES