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

Update readme.

Browse Source
This commit is contained in:
David Reid
2018-07-01 20:14:49 +10:00
parent d52e710b7d
commit bb904ae6b9
1 changed files with 17 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+17 -11
View File
@@ -6,20 +6,15 @@ and released into the public domain.
Features Features
======== ========
- Public domain.
- Single file.
- Compilable as both C and C++.
- A simple build system. - A simple build system.
- It should Just Work out of the box, without the need to download and install any dependencies. - It should Just Work out of the box, without the need to download and install any dependencies.
- Does not require linking to anything for the Windows build and only -ldl, -lpthread and -lm for Linux.
- The header section does not include any platform specific headers.
- A simple API. - A simple API.
- Transparent data structures with direct access to internal data. - Transparent data structures with direct access to internal data.
- Supports both playback and capture on all backends. - Supports both playback and capture on all backends.
- Automatic data conversion. - Automatic data conversion.
- Format conversion, with optional dithering where appropriate. - Sample format conversion, with optional dithering.
- Sample rate conversion. - Sample rate conversion.
- Channel mapping and conversion (stereo to 5.1, etc.) - Channel mapping and channel conversion (stereo to 5.1, etc.)
- MP3, Vorbis, FLAC and WAV decoding. - MP3, Vorbis, FLAC and WAV decoding.
- This depends on external single file libraries which can be found in the "extras" folder. - This depends on external single file libraries which can be found in the "extras" folder.
@@ -27,21 +22,20 @@ Features
Supported Platforms Supported Platforms
=================== ===================
- Windows (XP+) - Windows (XP+)
- macOS
- Linux - Linux
- BSD - BSD
- Android - Android
- Raspberry Pi - Raspberry Pi
- Emscripten / HTML5 - Emscripten / HTML5
macOS and iOS support is coming soon(ish) via Core Audio. Unofficial support is enabled via the
PulseAudio, JACK, OpenAL and SDL backends, however I have not tested these personally.
Backends Backends
======== ========
- WASAPI - WASAPI
- DirectSound - DirectSound
- WinMM - WinMM
- Core Audio
- ALSA - ALSA
- PulseAudio - PulseAudio
- JACK - JACK
@@ -52,6 +46,18 @@ Backends
- Null (Silence) - Null (Silence)
Building
======
Do the following in one source file:
```
#define MINI_AL_IMPLEMENTATION
#include "mini_al.h"
```
Then just compile. There's no need to install any dependencies. On Windows and macOS there's no need to link
to anything. On Linux, just link to -lpthread, -ldl and -lm. Link to -lossaudio on OpenBSD and NetBSD (FreeBSD
does not require linking to anything).
Simple Playback Example Simple Playback Example
======================= =======================
@@ -207,4 +213,4 @@ etc.
``` ```
The `mal_decoder_init_file()` API will try using the file extension to determine which decoding The `mal_decoder_init_file()` API will try using the file extension to determine which decoding
backend to prefer. backend to prefer.