ryujinx/libsoundio
1
0
Fork 0
mirror of https://github.com/Ryujinx/libsoundio.git synced 2024-12-22 19:45:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
C library for cross-platform real-time audio input and output
24 commits 6 branches 6 tags 867 KiB
C 97.1%
CMake 2.6%
C++ 0.3%
Go to file
Andrew Kelley 39cb1d4fde os: implement cond wait and cond timed wait on windows
2015-07-03 01:24:19 -07:00
cmake skeleton 2015-06-30 14:04:45 -07:00
example refactor connect/disconnect API 2015-07-01 02:53:53 -07:00
src os: implement cond wait and cond timed wait on windows 2015-07-03 01:24:19 -07:00
test list_devices example works with dummy backend 2015-07-01 02:37:51 -07:00
.gitignore closer to building on windows 2015-07-02 03:48:27 -07:00
CMakeLists.txt build: try to find optional libs 2015-07-02 15:55:11 -07:00
LICENSE add LICENSE 2015-06-30 14:12:52 -07:00
README.md building on windows 2015-07-02 19:15:09 -07:00

README.md

libsoundio

C library which provides cross-platform audio input and output. The API is suitable for real-time software such as digital audio workstations as well as consumer software such as music players.

This library is an abstraction; however it prioritizes performance and power over API convenience. Features that only exist in some sound backends are exposed.

This library is a work-in-progress.

How It Works

libsoundio tries these backends in order. If unable to connect to that backend, due to the backend not being installed, or the server not running, or the platform is wrong, the next backend is tried.

  1. JACK
  2. PulseAudio
  3. ALSA (Linux)
  4. CoreAudio (OSX)
  5. ASIO (Windows)
  6. DirectSound (Windows)
  7. OSS (BSD)
  8. Dummy

Contributing

libsoundio is programmed in a tiny subset of C++11:

  • No STL.
  • No new or delete.
  • No class. All fields in structs are public.
  • No exceptions or run-time type information.
  • No references.
  • No linking against libstdc++.

Don't get tricked - this is a C library, not a C++ library. We just take advantage of a select few C++11 compiler features such as templates, and then link against libc.

Building

Install the dependencies:

  • cmake
  • ALSA library (optional)
  • libjack2 (optional)
  • libpulseaudio (optional)
mkdir build
cd build
cmake ..
make
sudo make install

Building With MXE

You can build libsoundio with mxe. Follow the requirements section to install the packages necessary on your system. Then somewhere on your file system:

git clone https://github.com/mxe/mxe
cd mxe
make gcc

Then in the libsoundio source directory (replace "/path/to/mxe" with the appropriate path):

mkdir build-win
cd build-win
cmake .. -DCMAKE_TOOLCHAIN_FILE=/path/to/mxe/usr/i686-w64-mingw32.static/share/cmake/mxe-conf.cmake
make

Roadmap

  1. ALSA (Linux)
  2. Avoid calling panic in PulseAudio.
  3. JACK
  4. Dummy
  5. CoreAudio (OSX)
  6. ASIO (Windows)
  7. DirectSound (Windows)
  8. OSS (BSD)
  9. list devices example
  10. sine wave example
  11. record to playback example
  12. clean up API and improve documentation
  13. use a documentation generator and host the docs somewhere
  14. -fvisibility=hidden and then explicitly export stuff

Planned Uses for libsoundio