@timchurches timchurches released this Apr 26, 2015 · 79 commits to master since this release

Assets 4

This is the final, production release of Bees-in-the-Trees v4.1. It is thought to be free of bugs and safe to use. If you do find something that seems to be a bug, please let me know.

Documentation for v4.1 can be found at https://timchurches.github.io/Mutated-Mutables/

The original goal for v4.1 was to add a presets capability, so that up to 10 sets of Bees-in-the-Trees settings could be saved and recalled. However, after many, many hours of experimentation, I abandoned this idea, for three reasons. The first is that the Braids UI (user interface) just isn't adequate for the more complicated menuing system which storing, deleting, editing and copying presets requires. I did manage to implement a menu scheme, but within a few minutes of starting to use it, I was quite confused about which preset I was using and what was stored where. Furthermore, the use of presets would mean that saving settings would need to be a deliberate action which users would need to remember to do, before swapping from one preset to the next, and before powering down. Due to concerns over flash wear, an auto-save mechanism was not considered viable. Having to remember to save settings was unlikely to work in practice. Finally, saving presets required all sorts of hairy memory shuffling, due to the very tight memory on the Braids processor (it only has 20kB, and all but a few hundred bytes are used). Olivier Gillet very helpfully suggested some work-arounds, but it added quite a bit of extra code and was messy and thus a large source of potential bugs, given my modest C++ coding skills. Thus, the presets idea has been abandoned.

However, in v4.1, by way of partial compensation, I have added a new menu setting, WRAP, which when set to ON makes the value lists for each menu setting wrap around. Thus, if the value range for a setting is 0 to 127, then with WRAP set to ON, one more increment of the encoder takes you back to 0. This works for categorical values as well, including the oscillator model selection, so it becomes a continuous circle of models, rather than a linear list.

A few of the menu settings have been moved in v4.1, in particular, FTUN and OCTV have been placed right next to SAVE because they are very commonly used.

Finally, one more bytebeat oscillator model has been added, BYT3, which uses the equation (((((t_ >> p0) | t_) | (t_ >> p0)) * 10) & ((5 * t_) | (t_ >> 10)) ) | (t_ ^ (t_ % p1)). This was created by Xi Feng and can be found at http://xifeng.weebly.com/bytebeats.html A quick-and-dirty demo of the BYT3 model can be heard at https://soundcloud.com/bennelong-bicyclist/bees-in-th-trees-v4-1-bytebeat

One other change: if you set OSYN=OFF, then when using the WTX4 oscillator model with an trigger, the slight but noticeable clicks which occur when a trigger is received (due to the phase being set to a random value to "thicken" the sound) are suppressed. These click exist in the WTX4 model with the vanilla Braids firmware as well, BTW. OSYNC=OFF allows you to suppress them.

Installation Notes

NOTE: after installing v4.1, if your coarse tune knob doesn't work, don't panic! Just do a settings reset, using RST=DFLT (so you won't need to re-calibrate the module), and it will then work again. Not sure why this occurs, but I noticed it happen once when upgrading my Braids to v4.1. A settings reset cures it immediately and permanently.

Like the Mutable Instruments Braids firmware on which it is based, Bees-in-the-Trees is completely open-source, and is available at no cost. Like most open-source software, including the official Braids firmware itself, Bees-in-the-Trees comes with with no warranty or guarantee whatsoever, and you use it at your own risk.

Before installing Bees-in-the-Trees on your Braids module, please take time to read the warnings in the Installation and De-installation section of the documentation careful, and if you still wish to proceed, follow the instructions given there very carefully. If you do that, you should not encounter any problems installing Bees-in-the-Trees, nor any problems re-installing the official Braids v1.7 (or later) firmware should you wish to. At the time of this release, lots of people have installed development versions of Bees-in-the_trees successfully and without incident or mishap - no-one has "bricked" their Braids yet by installing it, as far as I am aware. However, I have added contact information to the documentation for people in North America and Europe who have kindly agreed to offer an unblocking service, for a small fee and on a best-effort basis, in the unlikely event that you do brick your Braids while installing Bees-in-the-Trees.