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
2019-05-05 21:11:29 +10:00
parent c6b815c2f0
commit 7b9e3ca2b4
1 changed files with 24 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+24 -21
View File
@@ -1,7 +1,7 @@
![miniaudio](http://dred.io/img/miniaudio_wide.png) ![miniaudio](http://dred.io/img/miniaudio_wide.png)
miniaudio (formerly mini_al) is a single file library for audio playback and capture. It's written miniaudio (formerly mini_al) is a single file library for audio playback and capture. It's written
in C (compilable as C++) and released into the public domain. in C89 (compilable as C++) and released into the public domain.
Features Features
@@ -50,7 +50,7 @@ Backends
Building Building
====== ======
Do the following in one source file: Do the following in one source file:
``` ```c
#define MINIAUDIO_IMPLEMENTATION #define MINIAUDIO_IMPLEMENTATION
#include "miniaudio.h" #include "miniaudio.h"
``` ```
@@ -63,11 +63,11 @@ Simple Playback Example
```c ```c
#define DR_FLAC_IMPLEMENTATION #define DR_FLAC_IMPLEMENTATION
#include "../extras/dr_flac.h" // Enables FLAC decoding. #include "../extras/dr_flac.h" /* Enables FLAC decoding. */
#define DR_MP3_IMPLEMENTATION #define DR_MP3_IMPLEMENTATION
#include "../extras/dr_mp3.h" // Enables MP3 decoding. #include "../extras/dr_mp3.h" /* Enables MP3 decoding. */
#define DR_WAV_IMPLEMENTATION #define DR_WAV_IMPLEMENTATION
#include "../extras/dr_wav.h" // Enables WAV decoding. #include "../extras/dr_wav.h" /* Enables WAV decoding. */
#define MINIAUDIO_IMPLEMENTATION #define MINIAUDIO_IMPLEMENTATION
#include "../miniaudio.h" #include "../miniaudio.h"
@@ -88,26 +88,29 @@ void data_callback(ma_device* pDevice, void* pOutput, const void* pInput, ma_uin
int main(int argc, char** argv) int main(int argc, char** argv)
{ {
ma_result result;
ma_decoder decoder;
ma_device_config deviceConfig;
ma_device device;
if (argc < 2) { if (argc < 2) {
printf("No input file.\n"); printf("No input file.\n");
return -1; return -1;
} }
ma_decoder decoder; result = ma_decoder_init_file(argv[1], NULL, &decoder);
ma_result result = ma_decoder_init_file(argv[1], NULL, &decoder);
if (result != MA_SUCCESS) { if (result != MA_SUCCESS) {
return -2; return -2;
} }
ma_device_config config = ma_device_config_init(ma_device_type_playback); deviceConfig = ma_device_config_init(ma_device_type_playback);
config.playback.format = decoder.outputFormat; deviceConfig.playback.format = decoder.outputFormat;
config.playback.channels = decoder.outputChannels; deviceConfig.playback.channels = decoder.outputChannels;
config.sampleRate = decoder.outputSampleRate; deviceConfig.sampleRate = decoder.outputSampleRate;
config.dataCallback = data_callback; deviceConfig.dataCallback = data_callback;
config.pUserData = &decoder; deviceConfig.pUserData = &decoder;
ma_device device; if (ma_device_init(NULL, &deviceConfig, &device) != MA_SUCCESS) {
if (ma_device_init(NULL, &config, &device) != MA_SUCCESS) {
printf("Failed to open playback device.\n"); printf("Failed to open playback device.\n");
ma_decoder_uninit(&decoder); ma_decoder_uninit(&decoder);
return -3; return -3;
@@ -149,7 +152,7 @@ single file libraries I can add to this list, let me know. Preferably public dom
To enable support for a decoding backend, all you need to do is #include the header section of the To enable support for a decoding backend, all you need to do is #include the header section of the
relevant backend library before the implementation of miniaudio, like so: relevant backend library before the implementation of miniaudio, like so:
``` ```c
#include "dr_flac.h" // Enables FLAC decoding. #include "dr_flac.h" // Enables FLAC decoding.
#include "dr_mp3.h" // Enables MP3 decoding. #include "dr_mp3.h" // Enables MP3 decoding.
#include "dr_wav.h" // Enables WAV decoding. #include "dr_wav.h" // Enables WAV decoding.
@@ -162,7 +165,7 @@ A decoder can be initialized from a file with `ma_decoder_init_file()`, a block
`ma_decoder_init_memory()`, or from data delivered via callbacks with `ma_decoder_init()`. Here `ma_decoder_init_memory()`, or from data delivered via callbacks with `ma_decoder_init()`. Here
is an example for loading a decoder from a file: is an example for loading a decoder from a file:
``` ```c
ma_decoder decoder; ma_decoder decoder;
ma_result result = ma_decoder_init_file("MySong.mp3", NULL, &decoder); ma_result result = ma_decoder_init_file("MySong.mp3", NULL, &decoder);
if (result != MA_SUCCESS) { if (result != MA_SUCCESS) {
@@ -178,7 +181,7 @@ When initializing a decoder, you can optionally pass in a pointer to a `ma_decod
(the `NULL` argument in the example above) which allows you to configure the output format, channel (the `NULL` argument in the example above) which allows you to configure the output format, channel
count, sample rate and channel map: count, sample rate and channel map:
``` ```c
ma_decoder_config config = ma_decoder_config_init(ma_format_f32, 2, 48000); ma_decoder_config config = ma_decoder_config_init(ma_format_f32, 2, 48000);
``` ```
@@ -187,13 +190,13 @@ decoding backend.
Data is read from the decoder as PCM frames: Data is read from the decoder as PCM frames:
``` ```c
ma_uint64 framesRead = ma_decoder_read_pcm_frames(pDecoder, pFrames, framesToRead); ma_uint64 framesRead = ma_decoder_read_pcm_frames(pDecoder, pFrames, framesToRead);
``` ```
You can also seek to a specific frame like so: You can also seek to a specific frame like so:
``` ```c
ma_result result = ma_decoder_seek_to_pcm_frame(pDecoder, targetFrame); ma_result result = ma_decoder_seek_to_pcm_frame(pDecoder, targetFrame);
if (result != MA_SUCCESS) { if (result != MA_SUCCESS) {
return false; // An error occurred. return false; // An error occurred.
@@ -204,7 +207,7 @@ When loading a decoder, miniaudio uses a trial and error technique to find the a
backend. This can be unnecessarily inefficient if the type is already known. In this case you can backend. This can be unnecessarily inefficient if the type is already known. In this case you can
use the `_wav`, `_mp3`, etc. varients of the aforementioned initialization APIs: use the `_wav`, `_mp3`, etc. varients of the aforementioned initialization APIs:
``` ```c
ma_decoder_init_wav() ma_decoder_init_wav()
ma_decoder_init_mp3() ma_decoder_init_mp3()
ma_decoder_init_memory_wav() ma_decoder_init_memory_wav()