Pythonic Audio Library and Codecs Environment https://mcsinyx.github.io/palace
Go to file
Ngô Xuân Minh e62989fa2b
Intuitively implement properties of ChorusEffect (#90)
Intuitively implement properties of ChorusEffect and add docstrings.
2020-04-28 23:15:22 +07:00
.ci [Travis] Build for macOS 2020-03-01 16:20:44 +07:00
examples Make effects properties more intuitive (fix GH-85) 2020-04-25 21:33:17 +07:00
src Intuitively implement properties of ChorusEffect (#90) 2020-04-28 23:15:22 +07:00
tests Intuitively implement properties of ChorusEffect (#90) 2020-04-28 23:15:22 +07:00
.appveyor.yml Update CI/CD 2020-04-22 00:29:53 +07:00
.gitignore [Travis] Build for macOS 2020-03-01 16:20:44 +07:00
.travis.yml Opt macOS out of automated testing entirely 2020-04-24 20:14:24 +07:00
CMakeLists.txt Make build more portable and compatible with manylinux2014 2020-02-01 14:29:06 +07:00
LICENSE Initial commit 2019-12-22 14:42:53 +07:00
MANIFEST.in Implement MessageHandler 2020-02-15 14:27:06 +07:00
README.md Add notice for credits 2020-04-28 22:43:42 +07:00
pyproject.toml Make build more portable and compatible with manylinux2014 2020-02-01 14:29:06 +07:00
setup.cfg Update version number for new release 2020-04-28 22:46:24 +07:00
setup.py Update CI/CD 2020-04-22 00:29:53 +07:00
tox.ini Make effects properties more intuitive (fix GH-85) 2020-04-25 21:33:17 +07:00

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, with context 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.

Credits to the works bundled with palace can be found in our user documentation.