ReaScripts that interface with the FluCoMa tools
Command Line Tools
First, ensure the FluCoMa command line executables are stored in a sensibly located folder. Ideally, this folder would be a
path known to your shell of choice. If you are uncomfortable with these concepts, perservere as there is very little configuration once this stage is sorted out. Put simply, a
path is a directory on your computer often containing executable files and your computer is made aware of this location so when you call a specific command it knows what you are talking about.
path locations that are (to my knowledge) default on MacOS are:
I would recommend placing the FluCoMa command line tools in
/usr/local/bin. Generally, it is a good idea to not pollute the other default paths with user specific stuff.
The reason we have to faff around with this is that in the ReaScripts all of the computation is done in the background on the command line and we simply use the scripts to interface with the outputs of the processes and to update the arrangement view inside of REAPER.
Once you have installed the command line tools the difficult part is over. Pat yourself on the back. Now for the easy part.
- Download all of the files from this repository.
- Unzip the downloaded archive and you will have a folder contaning a number of files ending with the
.luaextension - these are the scripts.
You can have this folder anywhere you want on your machine, REAPER doesn't actually care too much about where a script is launched from and I have made sure that any dependencies are sorted out in-house and not as part of your REAPER installation. The entire thing is very portable.
Once you have followed all the steps of the installation process you can simply execute one of the scripts by doing the following.
Shift + /(or as I like to call it
?;)) to bring up the Action Menu
- Select the action
ReaScript: Run Reascript
- Select the desired script which you have cleverly stored in an easy to find location.
All of the scripts are named to match up the corresponding algorithm. For example, to do harmonic percussive separation, you would need to run the
The first time that you execute any of the scripts you will be asked to provide a path to the location of the command line tools. Dont worry, this only happens once per REAPER installation. If you decided to put the executables in
/usr/local/bin then provide that path to the pop-up box.
What will happen? Is it safe?
So far, all of the slicing based algorithms will directly segment media items in the arrangement. This is not destructive and is like calling the 'Split' action multiple times (
S). You can undo just like any other action and your original media item is restored to its previously unsegmented state. The numerical results are stored in temporary csv files and are deleted as soon as the process is completed.
Any algorithm that should produce new media files,
sines obey the following logic.
Always process the source file and place the resulting files in the same directory as the source with an incremental name.
Please remember this, so I'm not responsible for the loss of the next masterpiece. It is your job to make sure that source files are in a project, or a known location before you go wild with processsing. Given that the output media files will be in your arrangement view on completion you can rapidly process some audio in an unsaved project but make sure that you have a strategy for moving all of the audio into a folder ideally close to the
The results of the process will be appended to a take of the source material.
hpss for example will return you either 2 or 3 new takes containing the harmonic, percussive and in the case of
@maskingmode 2 a residual components. My reason for doing it like this is so that you can quickly audition the results as well as replace source audio with your output process without too much fiddling. (Thanks to everyone on the discourse for the suggestions).
The outlier in thie case is
nmf which by default produces a multichannel audio file containing the components asked for by the user. As such, the result is a multichannel take added to the source item.
Dealing with the ouput
I would recommend you become familiar with two actions:
explode multichannel audio to...
explode takes of items to new tracks
Again, these can be found in the action menu (
Shift + /). This will allow you to explode the output of a FluCoMa process to new tracks for more fine tuned manipulation.
I have not yet implemented the amplitude slicing object because a) I don't understand it and b) I am led to believe there are issues with digital silence with it.
Threading! I'd like to make it so these processes can work in the background rather than locking out REAPER entirely. In so far, my research into making this happen has been discouraging as calling the shell from Lua is a blocking process and to make it non-blocking I would have to set up some additional logic that waits for processes to be finished and returns that information to REAPER.
Thank you to Pierre Alexandre Tremblay for guiding me on the interface of these scripts and how they should work for the user. The tools themselves are not my own work, but a product of the FluCoMa project which can be found here.