;;;; -*- coding: utf-8; fill-column: 78 -*-
This documents the current status of the trunk code. It's meant as a
high-level overview of what to expect if you compile Benben using the code in
the current checkout.
=======
Overall
=======
Only partially working, lots of bugs or incomplete things. Expect the program
to be fragile.
KNOWN ISSUE: When playing a module, using Ctrl-C can cause the entire Lisp
instance to die when in Slime. This doesn't seem to happen when Benben is a
command line program.
=======
Loading
=======
* VGM loading: working
* Module loading: working
* MIDI: not working
* SoundFonts: not working
* MP1/2/3: working
* FLAC: working
* Opus: not working
* Vorbis: not working
* WAV/Au: not working
* QOA: working
* XQAF: working
* WavPack: Working
* XSPF/JSPF: working
* SID: not working
* Local files: working
=============
Audio/Formats
=============
* VGMs: working
* Modules (libxmp): working
* MIDI (Haematite): not working
* MP1/2/3 (libmpg123): working
* FLAC (RemiAudio): working
* Opus (libopus): not working
* Vorbis (libvorbis): not working
* WAV/Au (RemiAudio): not working
* QOA: working
* XQAF: working
* WavPack: working
* SID: not working
* Seeking: partially working, will eventually work for WAV/Au, modules, QOA, XQAF, MPEG-1, Opus, and Vorbis only
* Resampling: working
======
Config
======
* Overall: working
* Song-specific configs: partially working
* Song-carryovers: partially working, not properly resetting in many cases
=========
Rendering
=========
* VGMs: not working
* Modules (libxmp): not working
* MIDI (Haematite): not working
* MP1/2/3 (libmpg123): not working
* FLAC (RemiAudio): not working
* Opus (libopus): not working
* Vorbis (libvorbis): not working
* WAV/Au (RemiAudio): not working
* QOA: not working
* XQAF: not working
* SID: not working
* WavPack: not working
* CUE writing: not working
* Normalization: not working
* Auto-directories: not working
* QOA encoding: not working
* WavPack encoding: not working
=======================
Original User Interface
=======================
* Overall: mostly working
* Input: working
* Tags: working
* VU: working
* Themes: working
* Total time display: not working
* Song queue: working
NOTE: A few things aren't working, such as 1) the lines above/below
the banner are not animating, and 2) the progress bar does not report
when a song is using a song-specific config.
=======================
Minimal User Interface
=======================
* Overall: working
* Input: not applicable
* Tags: working
* VU: not applicable
* Themes: not applicable
* Total time display: working
* Song queue: not applicable
=======
Effects
=======
* EQ: working
* Reverb: working
* Soft clipping: working
* Stereo enhancer: working
* DC offset filter: working
NOTE: There is a bug in RemiAudio where MVerb cannot reliably play back files
at or below a sample rate of 23465 Hz. If you need to play files at or below
this rate, use Zita for a reverb effect for the time being until this is fixed
in RemiAudio. It's assumed this carried over into the Common Lisp code. The
upstream ticket is here:
https://chiselapp.com/user/MistressRemilia/repository/remiaudio/tktview/2d98cef604baaece841e5d6fa4580dcd184e3023
===============
Error Reporting
===============
* Startup errors: working
* Initial file checking errors: working
* Errors loading songs during playback: working
* Redirect stderr: not working
==============
Remote Control
==============
* Server-side: working
* CLI program: working (not ported)