Metadata-Version: 2.5
Name: SimVX-Audio-Miniaudio
Version: 0.0.0.dev3104
Summary: Native audio for SimVX: miniaudio mixes, spatialises and runs the bus effects in C.
Project-URL: Homepage, https://simvx.com
Project-URL: Documentation, https://simvx.com/docs/core/audio.html
Project-URL: Source, https://git.simvx.com/simvx/simvx
Project-URL: Issues, https://git.simvx.com/simvx/simvx/issues
Project-URL: Changelog, https://git.simvx.com/simvx/simvx/commits/branch/main
Author-email: SimVX <contact@simvx.com>
License-Expression: AGPL-3.0-or-later
License-File: LICENSE
License-File: NOTICE
License-File: THIRD_PARTY_LICENSES.md
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: C
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Multimedia :: Sound/Audio
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.14
Requires-Dist: cffi>=1.17
Requires-Dist: numpy
Requires-Dist: simvx-core==0.0.0.dev3104
Description-Content-Type: text/markdown

# SimVX Audio Miniaudio

SimVX's native audio: [miniaudio](https://miniaud.io) mixes, spatialises and runs the bus effects in
C on its own thread. Most users want `simvx`, which includes it where a wheel exists.

> **Pre-alpha.** SimVX publishes development releases only (`0.0.0.devN`) and is under active
> development; the API changes between builds. Once stable versions ship to PyPI, development
> builds continue on pypi.simvx.com.

## Install

```bash
pip install --pre simvx
```

Latest development build: add `--extra-index-url https://pypi.simvx.com/`.

## Use

Nothing to configure: when installed it is used, and `AudioPlayer`, `AudioPlayer2D` and
`AudioPlayer3D` play through it. Without it, desktop audio runs on core's Python mixer, at higher
latency and without bus effects, and the log says so once.

What it adds:

- Mixing, 3D spatialisation and Doppler in native code, unaffected by the GIL.
- Every bus effect: gain, biquad filters, parametric EQ, delay, reverb, soft clip and compressor.
- Streaming of Ogg Vorbis, MP3 and FLAC decoded in C.

Platforms: wheels for Linux x86_64 and aarch64 and Windows x86_64; only Linux x86_64 is tested.
There is no macOS build, so macOS uses the Python mixer. The library is loaded through cffi's ABI mode and the wheel is tagged
`py3-none-<platform>`, so one wheel per platform serves every CPython 3.14 build, free-threaded
included.

[Documentation](https://simvx.com/docs/core/audio.html) ·
[Source](https://git.simvx.com/simvx/simvx/src/branch/main/packages/audio-miniaudio) ·
Licence: AGPL-3.0-or-later with [Additional Terms](https://git.simvx.com/simvx/simvx/src/branch/main/LICENSE-ADDENDUM.md),
including the Game-Distribution Exception. Vendored: miniaudio (public domain or MIT-0) and
stb_vorbis (public domain or MIT).
