-----
The themes of this release are:
- New JavaScript version of Radiant Voices.
- Support for new modules, controllers, options, and curves in SunVox 1.9.6c.
- Improved general compatibility with the SunVox file format.
- Improved documentation of the SunVox file format.
- Radiant Voices API improvements.
Major change: ``genrv`` code generator
......................................
To support porting Radiant Voices to more languages than just Python,
and keeping these ports in sync with new versions of SunVox,
this release introduces a new code-generation tool, ``genrv``.
``genrv`` is written in Python, and uses Jinja2 templates to generate
source code in various target languages, based on a spec written in YAML.
The generated code is run through code-formatting tools,
saved directly into the final package structure,
and committed to the git repository as any other code would be.
Base classes for all module types are generated this way.
They include controllers, options, and controller value enums.
The actual classes for each module inherit from these base classes
and add module-specific behavior maintained by hand.
Major change: JavaScript port
.............................
Radiant Voices now has a JavaScript port, written in TypeScript.
It pairs well with the JavaScript/WebAssembly version of the SunVox library.
It is not a 1-to-1 port from the Python version, although
it is designed to allow you to do the same things.
As of this release, each version has strengths and weaknesses compared to the other.
Over time, we will work towards parity as we strive toward 100% compatibility with
SunVox.
Additions (all versions)
........................
- Adds ``Project.receive_sync_midi`` and ``Project.receive_sync_other`` flags.
- Adds ``ADSR`` module.
- Adds ``Ctl2Note`` module.
- Adds ``Pitch Detector`` module.
- Adds ``harmonics`` to enum for ``AnalogGenerator.waveform`` controller.
- Adds new values to enum for ``SpectraVoice.h_type`` controller:
``overtones1+``, ``overtones2+``, ``overtones3+``, ``overtones4+``, ``metal``.
- Adds ``Amplifier.gain`` controller.
- Adds ``AnalogGenerator.true_zero_attack_release`` option.
- Adds new values to enum for ``AnalogGenerator.waveform`` controller:
``noise_with_spline_interpolation``,
``white_noise``,
``pink_noise``,
``red_noise``,
``blue_noise``,
``violet_noise``,
``grey_noise``.
- Adds ``LFO.freq_scale_pct`` controller.
- Adds ``LFO.smooth_transitions`` controller.
- Adds ``Sound2Ctl.send_only_changed_values`` option.
- Adds new options to ``MetaModule``:
``receive_notes_from_keyboard``, ``do_not_receive_notes_from_keyboard``.
- Adds ``PitchShifter.bypass_if_pitch_eq_0`` controller.
- Adds new value to enum for ``Compressor.mode`` controller:
``peak_zero_latency``.
- Adds new values and value names to enum for ``Distortion.type`` controller:
``clipping`` is the new name for ``lim``.
``foldback`` is the new name for ``sat``.
``foldback2``, ``foldback3``, ``overflow`` are new values.
- Adds new value to enum for ``Lfo.waveform`` controller:
``random_interpolated``.
- Adds ``DrumSynth.bass_panning`` controller.
- Adds ``DrumSynth.hihat_panning`` controller.
- Adds ``DrumSynth.snare_panning`` controller.
- Adds ``MultiCtl.response`` controller.
- Adds ``MultiCtl.sample_rate_hz`` controller.
- Increases the maximum value of ``Gpio.pin_in`` and ``Gpio.pin_out``
controllers to ``256``.
- Renames ``Kicker.vol_addition`` controller to ``Kicker.boost``,
to reflect naming in SunVox 1.9.4.
Additions (Python version)
..........................
- Ports all test cases from JavaScript version.
Note: A limited number of test cases are not yet completely ported.
- Adds ``Project.restart_position`` attribute.
- Adds ``Project.detach_module(module)`` method.
- Adds ``patch_decompiler`` tool.
- Adds ``Pattern.project`` attribute, set once attached to a project.
- Adds ``Note.pattern`` and ``Note.project`` to allow notes to be project-aware.
- Adds ``Note.module_index`` property, converts ``Note.module`` to 0-based index.
- Adds ``Note.mod`` property, allows setting a note's module via an actual
`Module` instance (instead of an int).
Changes (All versions)
......................
- Updates module option reading, writing, and setting to reflect
changes in SunVox 1.9.6.
Changes (Python version)
........................
- Uses `dict` instead of `OrderedDict`, as modern Python's built-in `dict`
maintains key order.
- Renames ``incoming_links`` to ``in_links``.
- Renames ``controller_number`` to ``ctl_index``, and ``gain_percentage`` to ``gain_pct``,
to more closely reflect the naming in the JavaScript version.
- Adds type annotations to support static analysis tools and IDEs.
- Renames "dirty waveform" to "drawn waveform".
- Updates default ``sunvox_version`` and ``based_on_version`` of
newly-created ``Project`` containers to reflect file format version 1.9.6.1.
- Updates ``MetaModule.behaviors`` to include ``sends_notes``.
- Now uses black_ to format all Python modules.
.. _black:
https://black.readthedocs.io/en/stable/
- ``Project.attach_module`` now raises ``ModuleOwnershipError``
if the module is already attached to a project.
- ``Project.attach_module`` now re-uses empty module indexes,
instead of always appending to the end.
- ``Project.connect`` now raises ``ModuleOwnershipError`` if modules
do not share a common parent.
- Python 3.8 is now required.
- ``Project.attach_pattern`` now returns the index of the attached pattern.
Fixes (all versions)
....................
- Correctly reads and writes ``SLnK`` chunks,
thus correctly keeping the connection order between modules
that have more than one connection going in or out.
- Renames ``Sample.loop_end`` to ``Sample.loop_len``.
- Fixes how effects embedded into ``Sampler.effect`` are serialized.
- Updates ``out_controller`` of ``Pitch2Ctl``, ``Sound2Ctl``, and ``Velocity2Ctl``
to have correct range of 0..255.
Fixes (Python version)
......................
- Fixes writing of controller values to use signed ints instead of unsigned.
- Fixes reading/writing of ``VorbisPlayer.finetune`` controller values.
- Updates the ``helloworld`` example to use correct APIs.
- Parses chunk IDs in a case-sensitive way, to prevent incorrect
parsing of chunks such as ``SLnK``.