ryujinx/libsoundio
1
0
Fork 0
mirror of https://github.com/Ryujinx/libsoundio.git synced 2024-12-22 19:05:37 +00:00
Code Issues Packages Projects Releases Wiki Activity
C library for cross-platform real-time audio input and output
33 commits 6 branches 6 tags 867 KiB
C 97.1%
CMake 2.6%
C++ 0.3%
Go to file
Andrew Kelley 5048d7aa57 ring buffer works on windows
2015-07-06 16:02:20 -07:00
cmake skeleton 2015-06-30 14:04:45 -07:00
example add and export a ring buffer implementation 2015-07-06 01:05:22 -07:00
src ring buffer works on windows 2015-07-06 16:02:20 -07:00
test ring buffer works on windows 2015-07-06 16:02:20 -07:00
.gitignore closer to building on windows 2015-07-02 03:48:27 -07:00
CMakeLists.txt ring buffer works on windows 2015-07-06 16:02:20 -07:00
LICENSE add LICENSE 2015-06-30 14:12:52 -07:00
README.md POSIX ring buffer works on OSX and is simpler 2015-07-06 14:10:26 -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.

Why libsoundio?

  • PortAudio
    • It does not support PulseAudio.
    • It logs messages to stdio and you can't turn that off.
    • It is not written by me.
  • rtaudio
    • It is not a C library.
    • It uses exceptions.
    • It is not written by me.
  • SDL
    • It comes with a bunch of other baggage - display, windowing, input handling, and lots more.
    • It is not designed with real-time low latency audio in mind.
    • Listing audio devices is broken.
    • It does not support recording devices.
    • It is not written by me.

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. pipe record to playback example working with dummy linux, osx, windows
  2. pipe record to playback example working with pulseaudio linux
  3. implement CoreAudio (OSX) backend, get examples working
  4. implement DirectSound (Windows) backend, get examples working
  5. implement ALSA (Linux) backend, get examples working
  6. implement JACK backend, get examples working
  7. Avoid calling panic in PulseAudio.
  8. implement ASIO (Windows) backend, get examples working
  9. clean up API and improve documentation
  10. use a documentation generator and host the docs somewhere
  11. -fvisibility=hidden and then explicitly export stuff
  12. Integrate into libgroove and test with Groove Basin
  13. Consider testing on FreeBSD

Planned Uses for libsoundio