https://github.com/realnc/sdl_audiolib

An audio decoding, resampling and mixing library for SDL.
https://github.com/realnc/sdl_audiolib

audio-library c-plus-plus decoding mixing-library resampling sdl sdl-audiolib sdl2

Last synced: 3 months ago
JSON representation

An audio decoding, resampling and mixing library for SDL.

• Host: GitHub
• URL: https://github.com/realnc/sdl_audiolib
• Owner: realnc
• License: lgpl-3.0
• Created: 2014-06-17T06:08:02.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2023-02-25T09:43:34.000Z (almost 2 years ago)
• Last Synced: 2024-10-13T20:12:23.276Z (4 months ago)
• Topics: audio-library, c-plus-plus, decoding, mixing-library, resampling, sdl, sdl-audiolib, sdl2
• Language: C++
• Homepage:
• Size: 2.52 MB
• Stars: 43
• Watchers: 5
• Forks: 8
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

        
SDL_audiolib - An audio decoding, resampling and mixing library.

This is a small and simple to use C++ library for playing various audio 

formats. It is a thin (-ish) wrapper around existing resampling (like SRC or 

SoX) and decoding libraries (like libmpg123 or libvorbis.)

I wrote it as my personal replacement for SDL_mixer, due to SDL_mixer's lack 

of multiple music streams, limited audio format support and poor resampling 

quality.

The API and ABI are not finalized (not sure if they'll ever be) and it's 

C++-only at the moment. You will find what looks to be the beginnings of an 

SDL_mixer drop-in replacement implementation, but it's not actually 

implemented to any useful extent and will probably be removed in the future.

As the name implies, it uses [SDL](http://www.libsdl.org) to access the audio 

hardware.

Most popular audio formats are supported:

  * Vorbis (libvorbisfile or libsndfile)

  * Opus (libopusfile or libsndfile)

  * MP3 (built-in through bundled

    [dr_mp3](https://github.com/mackron/dr_libs), or through external

    libmpg123)

  * Musepack (libmpcdec)

  * FLAC (built-in through bundled

    [dr_flac](https://mackron.github.io/dr_flac), or through external

    libFLAC or libsndfile)

  * WAV and related formats (built-in through bundled

    [dr_wav](https://mackron.github.io/dr_wav), or through external

    libsndfile)

  * MIDI (FluidSynth, BASSMIDI, WildMIDI or libADLMIDI)

  * MOD-based music formats (libopenmpt, libxmp or libmodplug)

You can also write your own decoders and resamplers by subclassing 

`Aulib::Decoder` and `Aulib::Resampler`.

Using the library is fairly simple:

```c++

#include 

#include 

#include 

#include 

#include 

int main()

{

    // The library uses std::chrono for durations, seeking and fading.

    using namespace std::chrono_literals;

    // Initialize the SDL_audiolib library. Set the output sample rate to

    // 44.1kHz, the audio format to 16-bit signed, use 2 output channels

    // (stereo), and an 8kB output buffer.

    if (Aulib::init(44100, AUDIO_S16SYS, 2, 8192) != 0) {

        std::cerr << "Couldn't initialize audio: " << SDL_GetError() << '\n';

        return EXIT_FAILURE;

    }

    // Create an audio stream that will play our Vorbis file using a Vorbis

    // decoder and a Speex resampler.

    Aulib::Stream music("music.ogg",

                        std::make_unique(),

                        std::make_unique());

    // Play it once with a fade-in of 700 milliseconds.

    music.play(1, 700ms);

    // Wait while the music is still playing.

    while (music.isPlaying()) {

        SDL_Delay(200);

    }

    

    // Shut down and clean up. Calling this manually is optional, since the

    // library will call this automatically when the program exits.

    Aulib::quit();

}

```

For further details, read the 

[API reference](http://realnc.github.io/SDL_audiolib).