Latest revision as of 10:19, 22 March 2022

Plugin

Renoise has the ability to load in and make use of external plugin instruments (VST, AU, DSSI). Besides the common MIDI properties, they also offer a custom GUI, audio routing options and can be rendered down to sample-based instruments. Plugins can normally only be played in a single track at a time, though multi-channel Plugins can be set up to use audio routing to play in multiple tracks.

Plugins can be used in the Phrase Editor to compose musical phrases that will be activated when specific notes are played. Clicking on the Phrases and Editor buttons will switch between those two sections.

You may find it useful to watch our video covering both plugin instruments and effects.

Plugin Instrument Properties

- Enable to pin the plugin's external editor to the Renoise window.
- Set up compatibility options for the plugin. Hovering the mouse over this button will display some information about the plugin, such as latency, where the file is loaded from etc.

Instrument: The plugin instrument which you would like to use. This will initially display "None". Click to show a list of available plugins. Please note that any VST & VST3 plugins will be split into their own separate categories.
Program: When available, select a specific preset for the plugin. Note that some plugins only allow changing and setting up presets in their external editor.

- Load, save or rename the currently active preset.
- Load or save all presets as a bank.

Channel: The MIDI channel that will be used to trigger the plugin. For most plugins any channel will do, but when using multi-timbral plug-ins you can use multiple channels to play different sounds from a single plugin instance.
Transpose: Transpose note playback in semi-tonal increments.

Auto Suspend: When enabled, Renoise will completely shut off the plugin when it is no longer producing sound. This is mainly done to reduce CPU usage. While plugins are Auto Suspended they will automatically wake up as soon as they are triggered again by playing notes or automation. Note: when suspended, some older plugins will be unable to use the virtual keyboard in the custom GUI.
Volume: The overall playback volume of the instrument.

Render to Samples: Render the plugin (freeze it) to a sample-based instrument. Left-clicking will replace the current plugin, while right-clicking creates a brand new instrument. See Render or Freeze Plugin Instruments to Samples for a detailed description and/or watch our video on the subject.

MIDI Routing: Allows you to route the MIDI output of the current plugin into another instrument beneath it in the Instrument Selector. This target instrument can be another plugin with its own MIDI output (allowing you to chain MIDI-generating plugins together), a 'normal' plugin (one that just generates sound) or even the built-in sampler in Renoise. The only real limitation is that you can’t trigger instrument phrases via a MIDI plugin.

Audio Routing: Click the button at the right to open the panel. By setting up track routing you can force each Output Bus to be bound to a single track, no matter which track you send the notes from. This can be useful if you want to route different aliases to different tracks to keep things organised, or route multiple instruments to the same track to use its effect chain. The method of assigning these outputs from within the plugin will be different for each one, so please refer to their manual for more information.

You can also load in plugins and change the program via the Instrument Properties section under the Instrument Selector.

Setting Up VST Paths

Plugins (VSTs or Audio Units) are external components that are installed on your computer. Renoise will try to locate them automatically, but is sometimes unable to do so. If you have plugins installed but they don't appear in Renoise, you can specify directories where Renoise will look via the "Edit->Preferences->Plug/Misc" menu. See the Plugins/Misc section of the Preferences for more information.

Selecting a Plugin

Initially, the Instrument box will show "None". Click on it to select, search and organize plug-ins. To select a plugin, double click on its name. To unload it, select "None" from the list.

As soon as the plugin list is opened, you can start typing in the search field. If, for example, you want to load a plugin called "Filter Modulator", then typing "Filter" will list only plugins which have the term "Filter" in their plugin category or name. To select a plugin using the keyboard, hit the "TAB" key to set the focus on the plugin list, then navigate with the arrow keys to the desired plugin and hit "ENTER". Hitting "ESCAPE" will close the list without selecting anything.

Organising/Customising the Plugin List

Right-clicking on a plugin name will bring up a context menu with the following options:

Add To Favorites: Adds the selected plugin or vendor to your favorites list.

Add To Group: Opens a new dialog box where you enter a name for the group. If it is a new name, then the group will be created and the selected plugin(s) moved under it. If the group already exists, then the plugin(s) will be moved over to the group.
Ungroup: (Only available when clicking on an existing group or vendor name) Removes the selected group from the effects list.

Rename: (Unavailable for native effects) Opens a new dialog box where you can change the plugin or vendor name. Any changes made here will only be saved within Renoise; the actual plugin name remains the same, since it may be used by other applications.
Hide: Excludes a plugin or a category of plugins from the list. This can be useful if you no longer use a plugin, but don't want to uninstall it because old songs still use it. To make a hidden plugin visible again, enable the "Show Hidden Devices" option, then simply "Unhide" it again.

Collapse Whole Tree: Collapses the entire effects list, showing only the Favorites (if any exist), Native and VST categories. Handy if you need to show just a few effects.
Expand Whole Tree: The effects list will expand back to its full size again.

Show Hidden Devices: Enables hidden plugins to become visible again.
Show Short Names: Instead of sorting plugins by vendor, you can also display them as a single list. With this option enabled you can still categorise the plugins by renaming them as described above.

Favorites List

To add a plugin to your custom favorites list, click the star icon to the right of it. Your favorites are located at the very top of the instruments list. To remove a plugin from your favorites, simply click the star icon again.

Plugin Aliases (multi-timbral plugins)

Some plugins allow the use of multiple MIDI channels to play different sounds from a single plugin instance. This is not absolutely necessary, as you can always load a separate instance of a plugin to use a different sound, but it can be helpful to save on CPU consumption. To find out if your plugin supports this, search for the keyword "multi-timbral" or "routing" in the plugin's manual.

To create an alias, first load your chosen plugin into an instrument slot, use the Instrument Selector to select another instrument slot and then open the plugin list again. You will see at the top of the list is the new category, "VST Aliases" (or "AU Aliases" if you've used an Audio Unit). The aliases refer to the previously loaded plugin. Double-click on one of the aliases in the list to create it, then change the channel number to use it.

The instrument is shown in the Instrument Selector with its alias name:

Note that any changes made to the options in the plugin properties panel, except for "Channel" and "Transpose", will be applied to all of the aliases, as well as the original plugin. Furthermore, deleting the original plugin will also delete all of the aliases. The Audio Routing option is used to assign different plugin sounds to different outputs.

Plugin Effect Aliases

It is also possible to create aliases for track effect plugins, which allows you to control the plugin in ways that are not normally possible by sending MIDI data.

Plugin Compatibility Options

This dialog will appear after clicking on the button in the plugin properties after a plugin instrument is loaded. In most cases these options will already have the correct settings, as Renoise comes with a database which sets the defaults for you. If you are experiencing any of the problems described in the dialog, then you might want to try altering the settings.

Typing Text Into A Plugin

Some plugins allow you type text into their window, but if you find Renoise is not allowing this and is playing notes instead, then you can enable typing by clicking the 'Enable Keyboard' option at the bottom-left of the plugin window.

@@ Line 1: / Line 1: @@
 = Plugin =
+[[Image:3.2_tab-plugin.png]]
-== Plugin Instrument (VST/AU) Properties ==
+Renoise has the ability to load in and make use of external plugin instruments (VST, AU, DSSI). Besides the common MIDI properties, they also offer a custom GUI, audio routing options and can be [[Render_or_Freeze_Plugin_Instruments_to_Samples|rendered down to sample-based instruments]]. Plugins can normally only be played in a single [[Pattern Editor#Tracks|track]] at a time, though multi-channel Plugins can be set up to use [[#Plugin Instrument Properties|audio routing]] to play in multiple tracks.
-VST or Audio Unit plugins are basically MIDI instruments that run within Renoise - like a built in software synthesizer. This means that they behave as described in the [[#External MIDI Properties|External MIDI Properties]] section below. Besides the common MIDI properties, they also offer a custom GUI, audio routing options and can be rendered down to sample-based instruments.
+Plugins can be used in the [[Phrase Editor]] to compose musical phrases that will be activated when specific notes are played. Clicking on the Phrases and Editor buttons will switch between those two sections.
-[[Image:2.7_instrument_settings_plugins_general.png]]
+You may find it useful to watch [https://youtu.be/U2fQcXP4I5s our video covering both plugin instruments and effects].
-* '''Ext. Editor:''' Opens the editor window. This can either be a Renoise-alike dialog box or a custom GUI provided by the plugin.
+[[Image:3.4_plugin.png]]
-* '''Instrument:''' The plugin instrument which you would like to use. This will initially display ''"None"''. Click to show a list of available plugins.
-* '''Program:''' When available, select a specific patch in the plugin. Note that some plugins only allow changing and setting up patches in their external editor.
+== Plugin Instrument Properties ==
-* '''Channel No.:''' The MIDI channel that will be used to trigger the plugin. For most plugins any channel will do, but when using [[#Plugin Aliases (multi-timbral plugins)|multi-timbral plug-ins]] you can play multiple sounds with one plugin instance.
+[[Image:3.3_plugin-properties.png]]
-* '''Transpose:''' Transpose note playback in semi-tonal increments.
+* [[Image:3.0_plugin-pin.png|text-bottom]] - Enable to pin the plugin's external editor to the Renoise window.
+* [[Image:3.1_interface-dropdown.png|text-bottom]] - Set up [[#Plugin Compatibility Options|compatibility options]] for the plugin. Hovering the mouse over this button will display some information about the plugin, such as latency, where the file is loaded from etc.
+* '''Instrument:''' The plugin instrument which you would like to use. This will initially display ''"None"''. Click to show a list of available plugins. Please note that any VST & VST3 plugins will be split into their own separate categories.
+* '''Program:''' When available, select a specific preset for the plugin. Note that some plugins only allow changing and setting up presets in their external editor.
-* '''Preset (Load/Save/Rename):''' Load or save the currently active preset to a file for later use.
+* [[Image:3.3_plugin-presets.png|text-bottom]] - Load, save or rename the currently active preset.
+* [[Image:3.0_plugin-banks.png|text-bottom]] - Load or save all presets as a bank.
-* '''Bank (Load/Save):''' Load or save all currently active presets to a file for later use.
+* '''Channel:''' The MIDI channel that will be used to trigger the plugin. For most plugins any channel will do, but when using [[#Plugin Aliases (multi-timbral plugins)|multi-timbral plug-ins]] you can use multiple channels to play different sounds from a single plugin instance.
+* '''Transpose:''' Transpose note playback in semi-tonal increments.
+* '''Auto Suspend:''' When enabled, Renoise will completely shut off the plugin when it is no longer producing sound. This is mainly done to reduce CPU usage. While plugins are Auto Suspended they will automatically wake up as soon as they are triggered again by playing notes or automation. Note: when suspended, some older plugins will be unable to use the virtual keyboard in the custom GUI.
 * '''Volume:''' The overall playback volume of the instrument.
-* '''? :''' Set up compatibility options for the plugin. Hovering the mouse over this button will display some information about the plugin, such as latency, where the file is loaded from etc.
+* '''Render to Samples:''' Render the plugin (freeze it) to a sample-based instrument. Left-clicking will replace the current plugin, while right-clicking creates a brand new instrument. See [[Render or Freeze Plugin Instruments to Samples]] for a detailed description and/or watch [https://youtu.be/MtuX_SSWeFU our video on the subject].
-* '''Auto Suspend:''' When enabled, Renoise will completely shut off the plugin when it is no longer producing sound. This is mainly done to reduce CPU usage. While plugins are Auto Suspended they will automatically wake up as soon as they are triggered again by playing notes or automation. Additionally, while suspended you will be unable to play the plugin by clicking on the virtual piano keys in its custom GUI.
-* '''Plugin Grabber:''' Render the plugin (freeze it) to a sample-based instrument. Left-clicking will replace the current plugin, while right-clicking creates a brand new instrument. See [[Render or Freeze Plugin Instruments to Samples]] for a detailed description.
+* '''MIDI Routing:''' Allows you to route the MIDI output of the current plugin into another instrument beneath it in the [[Instrument Selector]]. This target instrument can be another plugin with its own MIDI output (allowing you to chain MIDI-generating plugins together), a 'normal' plugin (one that just generates sound) or even the built-in sampler in Renoise. The only real limitation is that you can’t trigger instrument phrases via a MIDI plugin.
-* '''Output panel:''' Click the button at the top to open the panel. When using '''Plugin Aliases''' it may be useful to play the instruments in multiple tracks to keep things better organised. By setting up track routing you can force the plugin's output to be bound to a single track, no matter which track you send the notes from. This can be useful if you wish all of the instruments to use the same effects present in that one track.
+* '''Audio Routing:''' Click the [[Image:3.0_downopen.png|text-bottom]] button at the right to open the panel. By setting up track routing you can force each Output Bus to be bound to a single track, no matter which track you send the notes from. This can be useful if you want to route different [[#Plugin_Aliases_.28multi-timbral_plugins.29|aliases]] to different tracks to keep things organised, or route multiple instruments to the same track to use its [[Effect Chains|effect chain]]. The method of assigning these outputs from within the plugin will be different for each one, so please refer to their manual for more information.
 You can also load in plugins and change the program via the Instrument Properties section under the [[Instrument_Selector#Instrument_Properties|Instrument Selector]].
-=== Setting Up VST Paths ===
+== Setting Up VST Paths ==
-Plugins (VSTs or Audio Units) are external components that are installed on your computer. Renoise will try locate them automatically, but on occasion may be unable to do so. If you have plugins installed but they don't appear in Renoise, you can specify directories where Renoise will look via the ''"Edit->Preferences->Plug/Misc"'' menu. See the [[Preferences#Plugins/Misc|Plugins/Misc]] section of the Preferences for more information.
+Plugins (VSTs or Audio Units) are external components that are installed on your computer. Renoise will try to locate them automatically, but is sometimes unable to do so. If you have plugins installed but they don't appear in Renoise, you can specify directories where Renoise will look via the ''"Edit->Preferences->Plug/Misc"'' menu. See the [[Preferences#Plugins/Misc|Plugins/Misc]] section of the Preferences for more information.
-=== Selecting a Plugin ===
+[[Image:3.0_plugin-selecting.png]]
-[[Image:2.7_instrument_settings_plugins_vst_list.png]]
+=== Selecting a Plugin ===
-==== Selecting a plugin ====
 Initially, the Instrument box will show ''"None"''. Click on it to select, search and organize plug-ins. To select a plugin, double click on its name. To unload it, select ''"None"'' from the list.
-==== Quickly searching and selecting a plugin with the keyboard ====
 As soon as the plugin list is opened, you can start typing in the search field. If, for example, you want to load a plugin called ''"Filter Modulator"'', then typing ''"Filter"'' will list only plugins which have the term "''Filter"'' in their plugin category or name. To select a plugin using the keyboard, hit the ''"TAB"'' key to set the focus on the plugin list, then navigate with the arrow keys to the desired plugin and hit ''"ENTER"''. Hitting ''"ESCAPE"'' will close the list without selecting anything.
-==== Organising/customising the plugin list ====
+=== Organising/Customising the Plugin List ===
 Right-clicking on a plugin name will bring up a context menu with the following options:
@@ Line 57: / Line 58: @@
 * '''Add To Favorites:''' Adds the selected plugin or vendor to your [[#Favorites List|favorites list]].
-* '''Add To Group:''' Opens a new dialog box, where you enter a name for the group. If it is a new name, then the group will be created and the selected plugin(s) moved under it. If the group already exists, then the plugin(s) will be moved over to the group.
+* '''Add To Group:''' Opens a new dialog box where you enter a name for the group. If it is a new name, then the group will be created and the selected plugin(s) moved under it. If the group already exists, then the plugin(s) will be moved over to the group.
 * '''Ungroup:''' ''(Only available when clicking on an existing group or vendor name)'' Removes the selected group from the effects list.
-* '''Rename:''' ''(Unavailable for native effects)'' Opens a new dialog box, where you can change the plugin or vendor name. Any changes made here will only be saved within Renoise; the actual plugin name remains the same, since it may be used by other applications.
+* '''Rename:''' ''(Unavailable for native effects)'' Opens a new dialog box where you can change the plugin or vendor name. Any changes made here will only be saved within Renoise; the actual plugin name remains the same, since it may be used by other applications.
 * '''Hide:''' Excludes a plugin or a category of plugins from the list. This can be useful if you no longer use a plugin, but don't want to uninstall it because old songs still use it. To make a hidden plugin visible again, enable the ''"Show Hidden Devices"'' option, then simply ''"Unhide"'' it again.
-* '''Collapse Whole Tree:''' Collapses the entire effects list, showing only the Favorites (if any exist) Native, VST categories. Handy if you need to show just a few effects.
+* '''Collapse Whole Tree:''' Collapses the entire effects list, showing only the Favorites (if any exist), Native and VST categories. Handy if you need to show just a few effects.
 * '''Expand Whole Tree:''' The effects list will expand back to its full size again.
 * '''Show Hidden Devices:''' Enables hidden plugins to become visible again.
 * '''Show Short Names:''' Instead of sorting plugins by vendor, you can also display them as a single list. With this option enabled you can still categorise the plugins by renaming them as described above.
-==== Favorites List ====
+=== Favorites List ===
 To add a plugin to your custom favorites list, click the star icon to the right of it. Your favorites are located at the very top of the instruments list. To remove a plugin from your favorites, simply click the star icon again.
-=== Plugin Aliases (multi-timbral plugins) ===
-Some plugins allow the playback of multiple sounds from a single instance of the instrument. This is achieved by channelling them through different MIDI channels. This is not absolutely necessary, as you can always create a new plugin instrument for a new sound, but it can be helpful to save on CPU consumption. To find out if your plugin supports this, search for the keyword "multi-timbral" or "routing" in the plugin's manual.
+== Plugin Aliases (multi-timbral plugins) ==
-To make use of this feature in Renoise, use '''Plugin Aliases''':
+Some plugins allow the use of multiple [[#Plugin Instrument Properties|MIDI channels]] to play different sounds from a single plugin instance. This is not absolutely necessary, as you can always load a separate instance of a plugin to use a different sound, but it can be helpful to save on CPU consumption. To find out if your plugin supports this, search for the keyword "multi-timbral" or "routing" in the plugin's manual.
-First load your chosen plugin in any empty instrument slot that you want to use for it, then select another free instrument slot in the [[Instrument Selector]]. In the new instrument slot, click again on the plugin list in the instrument properties panel and notice at the top of the list is the new category, ''"VST Aliases"'' (or ''"AU Aliases"'' if you've used an Audio Unit). The aliases refer to the previously loaded plugin. Double-click on one of the aliases in the list to create it.
+To create an alias, first load your chosen plugin into an instrument slot, use the [[Instrument Selector]] to select another instrument slot and then open the plugin list again. You will see at the top of the list is the new category, ''"VST Aliases"'' (or ''"AU Aliases"'' if you've used an Audio Unit). The aliases refer to the previously loaded plugin. Double-click on one of the aliases in the list to create it, then change the [[#Plugin Instrument Properties|channel number]] to use it.
-[[image:2.7_instrument_settings_plugins_alias_selection.png]]
+[[Image:3.0_plugin-alias.png]]
-To use the alias, simply change the channel number:
-[[image:2.7_instrument_settings_plugins_alias_channel_selection.png]]
 The instrument is shown in the Instrument Selector with its alias name:
-[[image:2.7_instrument_list_plugins_alias.png]]
+[[image:3.0_instrumentselector-alias.png]]
-Note that any changes made to the options in the Instrument Settings > Plugin panel, except for ''"Channel No."'' and ''"Transpose"'', will be applied to all of the aliases, as well as the original plugin. Furthermore, deleting the original plugin will also delete all of the aliases.
-=== Plugin FX Aliases (routing MIDI to existing plugin effects) ===
-You can also create and control aliases for existing plugin devices in [[Effects In Renoise|Track Effect]] chains.
-[[Image:2.7_instrument_settings_plugins_fx_alias_selection.png]]
-Most plugin effects do not support notes or other MIDI events. Those that do, use them to control more advanced features, such as vocoders. Other possible uses include preset or parameter switching with notes or sending MIDI CC messages to plugins.
-[[Image:2.7_instrument_settings_plugins_fx_alias.png]]
-Once you've set up an alias to an effect, you can play and record with it just like a normal instrument. You can also use a [[Meta Devices#*MIDI Control Device|*MIDI Control Device]] to automate it with MIDI.
-=== Plugin Routing ===
-Plugin instruments which have more than one output channel will contain multiple path selectors in the Output panel on the right of the plugin property-panel.
-[[Image:2.7_instrument_settings_plugins_output_fold.png]]
+Note that any changes made to the options in the plugin properties panel, except for ''"Channel"'' and ''"Transpose"'', will be applied to all of the aliases, as well as the original plugin. Furthermore, deleting the original plugin will also delete all of the aliases. The [[Plugin#Plugin_Instrument_Properties|Audio Routing]] option is used to assign different plugin sounds to different outputs.
+=== Plugin Effect Aliases ===
-Expanding the panel by clicking on the arrow will display the following options:
+It is also [[Plugin Effects#Plugin Effect Aliasing|possible to create aliases]] for [[Effect Chains|track effect]] plugins, which allows you to control the plugin in ways that are not normally possible by sending MIDI data.
-* enable/disable output channels for the plugin
-* name/rename a bus
-* set up track routing in Renoise for the individual plugin channels
-The left section allows you to activate any or all available audio buses for the instrument. By default, only the first bus is enabled. With the right section you can lock each bus to a specific Renoise track. When enabled, a drop-down box appears listing the currently available tracks, including the Master Track. When disabled, Renoise will automatically use the currently selected track (where the cursor is located).
-[[image:2.8_instrumentsettings-plugin.png]]
+== Plugin Compatibility Options ==
-Each bus also indicates whether it is Stereo ([[image:vvoois_renoise_multi_out_stereo_symbol.png]]) or Mono ([[image:vvoois_renoise_multi_out_mono_symbol.png]]).
+[[Image:3.2_plugineffects-compatibilityoptions.png]]
+This dialog will appear after clicking on the [[Image:3.1_interface-dropdown.png|text-bottom]] button in the [[#Plugin Instrument Properties|plugin properties]] after a plugin instrument is loaded. In most cases these options will already have the correct settings, as Renoise comes with a database which sets the defaults for you. If you are experiencing any of the problems described in the dialog, then you might want to try altering the settings.
-=== Plugin Compatibility Settings ===
-[[Image:vvoois_renoise_plugin_options.png]]
+== Typing Text Into A Plugin ==
-This dialog will appear after clicking on the '''''"?"''''' button in the VST Instrument Properties section after a plugin is loaded.
+Some plugins allow you type text into their window, but if you find Renoise is not allowing this and is playing notes instead, then you can enable typing by clicking the 'Enable Keyboard' option at the bottom-left of the plugin window.
-In most cases these options will already have the correct settings, as Renoise comes with a database which sets the defaults for you. If you are experiencing any of the problems described in the dialog, then you might want to try altering the settings.
+[[Image:3.2_plugin-enablekeyboard.png]]

Plugin: Difference between revisions