Nguyễn Gia Phong
e674ade7e4
This optimizes the execution time of macOS builds and adds initial (no-op) support for Windows. Documentation now admits the issues with macOS wheels. Because of GH-63, CI/CD for Python 3.8 on macOS is temporarily dropped. Build reference for upcoming v0.1.3 |
||
|---|---|---|
| .ci | ||
| examples | ||
| src | ||
| tests | ||
| .appveyor.yml | ||
| .gitignore | ||
| .travis.yml | ||
| CMakeLists.txt | ||
| LICENSE | ||
| MANIFEST.in | ||
| README.md | ||
| pyproject.toml | ||
| setup.cfg | ||
| setup.py | ||
| tox.ini | ||
README.md
palace
Palace is a Python 3D audio API wrapping around alure. To quote alure's README,
It uses OpenAL for audio rendering, and provides common higher-level features such as file loading and decoding, buffer caching, background streaming, and source management for virtually unlimited sound source handles.
Features
In some sense, what palace aimes to be to OpenAL Soft is what ModernGL is to OpenGL (except that all the heavy-lifting are taken are by alure):
- 3D sound rendering
- Environmental audio effects: reverb, atmospheric air absorption, sound occlusion and obstruction
- Binaural (HRTF) rendering
- Out-of-the-box audio decoding of FLAC, MP3, Ogg Vorbis, Opus, WAV, AIFF, etc.
- Modern Pythonic API: snake_case,
@property,withcontext manager, type annotation
Installation
Prerequisites
Palace requires Python 3.6+ for runtime and pip for installation.
Via PyPI
Palace can be install from the Python Package Index via simply
pip install palace
Wheel distributions are built exclusively for amd64. Currently, only GNU/Linux is properly supported. If you want to help packaging for Windows and macOS, see GH-1 and GH-63 respectively on our issues tracker on GitHub.
From source
Aside from the build dependencies listed in pyproject.toml, one will
additionally need compatible Python headers, alure, a C++14 compiler,
CMake 2.6+ (and probably git for fetching the source).
Palace can then be compiled and installed by running
pip install git+https://github.com/McSinyx/palace
Usage
One may start with the examples for sample usage of palace.
For further information, Python's help is your friend and
the API is also available for online reference.
License and Credits
Palace is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
To ensure that palace can run without any dependencies outside of the pip toolchain, the wheels are bundled with dynamically linked libraries from the build machine, which is similar to static linking:
| Library | License |
|---|---|
| Alure | ZLib |
| OpenAL Soft | GNU LGPLv2+ |
| Vorbis | 3-clause BSD |
| Opus | 3-clause BSD |
| libsndfile | GNU LGPL2.1+ |