Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clownacy/clownaudio
Sound engine that is suitable for video games and other multimedia applications.
https://github.com/clownacy/clownaudio
ansi-cpp c99 cplusplus-98 flac libxmp mixer mp3 ogg-vorbis sound-engine wav
Last synced: about 1 month ago
JSON representation
Sound engine that is suitable for video games and other multimedia applications.
- Host: GitHub
- URL: https://github.com/clownacy/clownaudio
- Owner: Clownacy
- License: zlib
- Created: 2019-05-21T22:17:30.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-03T23:06:58.000Z (about 1 month ago)
- Last Synced: 2024-10-12T17:21:11.977Z (about 1 month ago)
- Topics: ansi-cpp, c99, cplusplus-98, flac, libxmp, mixer, mp3, ogg-vorbis, sound-engine, wav
- Language: C
- Homepage:
- Size: 6.7 MB
- Stars: 24
- Watchers: 5
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## About
clownaudio is a stereo sound engine, capable of playing and mixing sounds in a
variety of formats.
Supported formats include...
* Ogg Vorbis
* MP3
* Opus
* FLAC
* WAV
* Various tracker formats ('.it', '.xm', '.mod', etc.)
* PxTone Music
* PxTone Noise
* SNES SPC
clownaudio is a 'full stack' sound engine, meaning that it handles everything
from decoding to playback - the user just has to provide it with sound data to
process.
That said, clownaudio's internals are modular, so you can easily extract
its mixer and use it as part of your own audio system if needed.
## Decoding backends
In order to support a range of audio formats, clownaudio leverages numerous
open-source libraries, dubbed 'decoding backends'. These libraries include...
| Library | Format | Licence | Built-in |
|-----------------|---------------------------------------------------------------------|-----------------------------------|----------|
| libvorbis | Ogg Vorbis | BSD | No |
| stb_vorbis | Ogg Vorbis | Public-domain/MIT | Yes |
| dr_mp3 | MP3 | Public-domain/MIT-0 | Yes |
| libopus | Opus | BSD | No |
| libFLAC | FLAC | BSD | No |
| dr_flac | FLAC | Public-domain/MIT-0 | Yes |
| dr_wav | WAV | Public-domain/MIT-0 | Yes |
| libsndfile | Various (includes Ogg Vorbis, FLAC, WAV, AIFF, and others) | LGPL 2.1 | No |
| libopenmpt | Various (includes .it, .mod, .s3m, .xm, .mptm, and many others) | BSD | No |
| libxmp | Various (includes .it, .mod, .s3m, .xm, and many others) | LGPL 2.1 | Yes |
| libxmp-lite | .it, .mod, .s3m, .xm | MIT | Yes |
| PxTone | PxTone Music/PxTone Noise | Custom (appears to be permissive) | Yes |
| snes_spc | SNES SPC | LGPL 2.1 | Yes |
| oswrapper_audio | Various (OS dependent) | BSD0 | Yes |
clownaudio aims to be bloat-free and dependency-free: each decoding backend can
be toggled at compile-time, and an effort is made to provide multiple backends
for individual formats, to allow the user a choice between standard libraries
(such as libvorbis), and lighter built-in libraries (such as stb_vorbis).
## Playback backends
In addition, clownaudio can utilise one of the following libraries to handle
audio playback:
| Library | Licence | Built-in |
|-----------|---------------------|----------|
| Cubeb | ISC | No |
| CoreAudio | zlib | Yes |
| miniaudio | Public-domain/MIT-0 | Yes |
| PortAudio | MIT | No |
| SDL1.2 | LGPL 2.1 | No |
| SDL2 | zlib | No |
## Building
clownaudio is built with CMake - both shared and static libraries can be
produced. Built libraries can be accessed via `pkg-config` and CMake's
`find_package`.
As an alternative, CMake projects can embed clownaudio directly, using
`add_subdirectory`.
Example software using clownaudio can be found in the `examples` directory.
The CLI example's `Makefile` demonstrates linking clownaudio with `pkg-config`,
and its `CMakeLists.txt` file demonstrates linking with `find_package` and
embedding with `add_subdirectory`.
An effort is made to keep clownaudio's build system requirements simple, so that
projects wishing to embed its source files directly and bypass its CMake build
system can do so. See the CLI example's `Makefile.old` for an example of this.
`PKGBUILD` files for MSYS2 and Arch Linux are provided in the `packages`
directory.
## Licensing
clownaudio itself is under the zlib licence.
Be aware that libraries used by the various backends are subject to
their own licences.