olcPGEX_MiniAudio

This extension abstracts the very robust and powerful miniaudio library. It provides simple loading and playback of WAV and MP3 files. Because it's built on top of miniaudio, it requires next to no additional build configurations in order to be built for cross-platform.

See the emscripten versions of the demos here:

• Main Demo.
• Spatialization Demo.
• Waveform Demo.
• Synthesis Demo.

This is an olc::PixelGameEngine Extension

This is an extension module for the awesome and wonderful olcPixelGameEngine by Javidx9.

It relies on the equally amazing sound library miniaudio by Mackron.

Go show them lots of love, they work hard for it!

Features

Cross-Platform, out-of-the-box. Easily use in your Linux, Windows, MacOS, and Emscripten projects.

Loading Features

• Loads WAV files
• Loads MP3 files
• Use olc::ResourcePack (as of v2.0)

Configuration Features

• Background Playback

Playback Features

• Play a sample, normal, looping, one-off and unload modes.
• Stop a sample and reset it for future playback.
• Pause a sample.
• Toggle (Play/Pause), convenience function.

Seeking Features

• Seek to a position in the sample by milliseconds, or by float.
• Seek forward from current position by milliseconds.
• Seek back (rewind) from current position by milliseconds.

Expression Features

• Set volume of a sample, by float 0.0f is mute, 1.0f is full
• Set pan of a sample, by float -1.0f is left, 1.0f is right, 0.0f is center
• Set pitch of a sample, by float 1.0f is normal pitch

Misc Getter Features

• Get the current position in the sample, in milliseconds.
• Get the current position in the sample, as float 0.0f is start, 1.0f is end.

Waveform Features (as of v1.7)

• Create sine, square, sawtooth, and triangle waves.
• Load and play multiple waveform channels at the same time.
• Modify waveform amplitudes, frequencies, and types in realtime.

Noise Generation Features (as of v1.7)

• Set a callback function to send and play raw audio data for potential sound synthesis.
• Send raw data for both left and right stereo channels.
• Track passage of audio frame time for oscillators / time-sensitive applications.

Advanced Features, for those who want to use more of miniaudio

• Get a pointer to the ma_device
• Get a pointer to the ma_engine
• Get a pointer to the ma_resource_manager (as of v2.0)
• Get pointers to waveforms and sounds

Usage

Add miniaudio.h and olcPGEX_MiniAudio.h to your project. (THE PGEX EXPECTS miniaudio.h to be either in the same directory, or in the include path of your toolchain)

Excerpts from demo.cpp, for full example click here.

#define OLC_PGE_APPLICATION
#include "olcPixelGameEngine.h"

#define OLC_PGEX_MINIAUDIO
#include "olcPGEX_MiniAudio.h"

Declare an instance of the PGEX in your PGE derived class like so..

    // The instance of the audio engine, no fancy config required.
    olc::MiniAudio ma;
    
    // To keep track of our sample ID
    int song1;

In OnUserCreate, load your sounds

    bool OnUserCreate() override
    {
        // Load a sample from a file, currently decodes WAV and MP3
        // files, out-of-the-box without further coding or configuration.
        // returns a sample ID (int), for future control calls.
        song1 = ma.LoadSound("assets/sounds/song1.mp3");

        return true;
    }

Then use them in your OnUserUpdate, like so

        if(GetKey(olc::SPACE).bPressed)
            ma.Toggle(song1);

Building In Your Projects

For Windows MSVC the instructions match any other olcPixelGameEngine!

For Emscripten, add -sSTACK_SIZE=131072 to the build command. This doubles the default stack size used by emscripten. Without it, emscripten runs out of stack space causing it enter a forever loop with "index out of bounds" errors and exception!

For Linux, add -ldl to the build command..

TODO: instructions for MacOS, I'm not a Mac user and have no way to test it!

That's it!

Building The Demos

To build the demos for Linux, MacOS, or Windows:

cmake . -B build
cmake --build build

To build the demos for emscripten:

cmake . -B emscripten-build
cmake --build emscripten-build

Acknowledgements

I'd like to give a special thanks for JavidX9 (aka OneLoneCoder), AniCator, JustinRichardsMusic, and everybody else who was a part of that audiophile conversation when I asked for help! Your patience and feedback made this project possible. Thank you!

I'd also like to single out sigonasr2 (Dense Dance 2π) for the waveform functionality and for crafting the demos for them!