Cyal - Cython Wrapper for OpenAL

Cyal is a Python wrapper for OpenAL, a cross platform, 3D audio API built by Creative Labs. This project aims to be compatible with any conforming OpenAL 1.1 implementation, but receives the most testing on OpenAL Soft. It is written in Cython.

Installation

Install with pip, just as you would any Python package.

pip install cyal

Binary distributions are available for Windows, macOS and Linux, and include a bundled version of OpenAL Soft.

Building from source

When building from source, CMake will try to detect an existing OpenAL implementation on your system, and will use that if it finds one. If an OpenAL implementation isn't found, OpenAL Soft will be downloaded, compiled, and bundled with Cyal.

Manual installation:

# Clone the repository
git clone https://github.com/lower-elements/cyal
cd cyal
# Install a simple wheel build tool
pip install build
# Build both the sdist and bdist (see the options to build if you only want to build one)
python -m build .
# Install the .whl file in the dist directory

Contributing

This project is hosted on Github. Feel free to submit an issue if you find a bug, open a pull request to contribute, or join our Matrix room, [#cyal:lowerelements.club][matrix-room for Cyal discussion and support.

License

Cyal is licensed under the MIT License.

MIT License

Copyright (c) 2023 Michael Connor Buchan <mikey@blindcomputing.org>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.