Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Sign in / Register
Toggle navigation
M
miniaudio
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Locked Files
Issues
0
Issues
0
List
Boards
Labels
Service Desk
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Security & Compliance
Security & Compliance
Dependency List
License Compliance
Packages
Packages
List
Container Registry
Analytics
Analytics
CI / CD
Code Review
Insights
Issues
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
MyCard
miniaudio
Commits
bb904ae6
Commit
bb904ae6
authored
Jul 01, 2018
by
David Reid
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update readme.
parent
d52e710b
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
17 additions
and
11 deletions
+17
-11
README.md
README.md
+17
-11
No files found.
README.md
View file @
bb904ae6
...
@@ -6,20 +6,15 @@ and released into the public domain.
...
@@ -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 c
hannel c
onversion (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
...
@@ -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
...
@@ -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.
...
@@ -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.
\ No newline at end of file
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment