Realtime Audio Mixer for Python

Warning

This is work in progress!

Goal: Reliable low-latency audio playback and recording with Python, using PortAudio via the sounddevice module.

The audio callback is implemented in C (and compiled with the help of CFFI) and doesn’t invoke the Python interpreter, therefore avoiding waiting for things like garbage collection and the GIL.

All PortAudio platforms and host APIs are supported. Runs on any Python version where CFFI is available.

Online documentation

https://python-rtmixer.readthedocs.io/

Source code repository

https://github.com/spatialaudio/python-rtmixer

Somewhat similar projects

• https://github.com/nwhitehead/swmixer

• https://github.com/nvahalik/PyAudioMixer

• http://www.pygame.org/docs/ref/mixer.html

---

• Features
  • Planned Features
  • Out Of Scope
• Installation
• Usage
• API Documentation
  • Mixer
    • Mixer.actions
    • Mixer.cancel()
    • Mixer.fetch_and_reset_stats()
    • Mixer.play_buffer()
    • Mixer.play_ringbuffer()
    • Mixer.stats
    • Mixer.wait()
  • Recorder
    • Recorder.record_buffer()
    • Recorder.record_ringbuffer()
  • MixerAndRecorder
  • RingBuffer
    • RingBuffer.advance_read_index()
    • RingBuffer.advance_write_index()
    • RingBuffer.elementsize
    • RingBuffer.flush()
    • RingBuffer.get_read_buffers()
    • RingBuffer.get_write_buffers()
    • RingBuffer.read()
    • RingBuffer.read_available
    • RingBuffer.readinto()
    • RingBuffer.write()
    • RingBuffer.write_available
• Contributing
  • Development Installation
  • Building the Documentation
  • Creating a New Release
• Version History

Index