Mirage Manual

This page has lots of information about how to use Mirage. See also our Troubleshooting page, Install Libraries page and changelog.

Quick Tips

Use Tooltips

Hover your cursor over a control to see a description of what the control does. You can toggle whether or not you want to see these by clicking the Show Tooltips option in the settings menu (three-dots icon at the top).

Double-click on Knobs

Double-click on knobs to open a text field allowing you to set the value by typing it in.

Double-click presets on the Preset Browser

By double-clicking on a preset in the preset browser you load the preset and close the browser. Single-clicking leaves the browser open.


Mirage Glossary

  • Layer: One of the three sound-generating parts that can be controlled and modulated. The effects rack is applied to the mix of these three layers.
  • Library: A collection of sampled instruments that are bundled together into a pack. Libraries can only be created by FrozenPlain - there currently are no capabilities for users to make libraries. Wraith is an example of a library.
  • Instrument: A sample-based playable instrument - meaning the sound is generated from audio files rather than algorithms or wavetables. An instrument can be selected for each layer. Instruments are either multi-sampled or just a single sample.
  • Preset: A saved Mirage configuration. Mirage can load any .mirage-something preset. The filename ending will be different depending on what library the preset uses.
  • Preset Folder: This is the folder that Mirage keeps track of. Preset files within this folder (and its subfolders) can be browsed via Mirage's preset browser.
  • Settings Menu: The popup menu found by clicking on the three-dots icon at the top of the Mirage GUI.
  • MDATA: The proprietary file format that Mirage libraries are stored in. An MDATA file contains all of the audio files that make up the sample library, as well as various other pieces of configuration data. These files can be over a GB in size.

The Three Layers

Mirage is built around an architecture of three layers. These are displayed in three columns starting from the left of the main panel. Each layer is identical. Mirage's layers are the first things in the processing chain; each layer is processed in parallel, and then the three streams of audio are mixed together and fed through the effects rack, from top to bottom.

Instruments

The topmost control of each layer is perhaps the most important: the instrument picker menu. These are often multi-sampled instruments, but also sometimes just a single sample that is playable across the keyboard. What instruments are available for you to pick is determined by which library is loaded.

Depending on which instrument is loaded, you might notice minor differences in what controls are available; this is normal.


Libraries

Mirage is an engine that can load MDATA sample libraries (FrozenPlain's custom format). At the moment, these libraries can only be created by FrozenPlain.

Mirage can only load one library at a time. When you first open a new instance of Mirage, no library will be loaded; choosing a library will be your first step. Simply click on the library in the side panel. This side panel can be opened and closed with the three-lines icon at the top-left of Mirage's GUI.

How Mirage tracks libraries

See the Troubleshooting page for more information on how Mirage tracks libraries.


Preset Files

Mirage uses the same preset format regardless of what library is loaded. However, the preset file name will end differently depending on what library the preset refers to. For example, a Mirage preset which uses Wraith might be called preset.mirage-wraith. Mirage can load any preset file that ends with .mirage-something.

The Preset Folder

Mirage keeps track of a single dedicated presets folder. Mirage scans this folder (and its subfolders) for .mirage-something files. These are then displayed in the preset browser GUI, and can be conveniently loaded in various ways.

Your Preset Folder is most likely C:/Users/name/FrozenPlain/Mirage/Presets on Windows or /Library/Application Support/FrozenPlain/Mirage Presets on Mac.

You can manually organise this folder in any way you like. By default, presets are grouped into which library they are from and whether they are factory or user presets.

You can select an alternate folder by clicking on the preset text at the top of the GUI and then clicking on the folder that is shown at the top of the shown window. On Mac, it is recommended to not change your preset folder. DAWs such as GarageBand are strict regarding which folders a plugin is allowed to access.

Preset Browser

Mirage features a browser for conveniently navigating and loading presets from your Preset Folder. This browser has two panels. The panel on the left is used to select the folder to browse. The panel on the right is used to load presets from within the selected folder and its subfolders. You can use the arrow keys on your keyboard to move to different presets on the right panel.

You can also search for folders or files by typing into the search bar on this panel. Your search term is compared against each filepath of every preset in the currently shown folder.

Randomising Presets

Mirage has a multi-mode 'randomise preset' button. This button can be found in the top panel of Mirage's GUI. To the left of this button is a downwards arrow icon. By clicking on this arrow you can select the mode of the randomise button. These are the options:

  • Randomise Any: Loads any Mirage preset in the presets folder (included any presets in subfolders). The preset could be for any library.
  • Randomise Library: Loads any Mirage preset that is for the same library that is currently loaded. For example, if you have the Wraith library loaded, this button will load another Wraith preset.
  • Randomise Folder: Loads any Mirage preset that is in the same folder as the current one. For example, if your current loaded preset is in a folder called 'Pads', another preset from 'Pads' will be loaded.
  • Randomise based on filter text: Loads a folder that matches the filtered folders and search text that you have typed into the preset browser. This button works the same as the randomise button that is adjacent to the search bar on the preset browser panel.

Installing New Presets

When you install a new library, its presets will be placed into your Preset Folder. This will most likely be C:/Users/Public/FrozenPlain/Mirage/Presets on Windows, and /Library/Application Support/FrozenPlain/Mirage Presets on Mac.

If you have manually set an alternate Preset Folder (using the Set Presets Folder button on Mirage), it will be that location instead.

You can manually add new presets to your Preset Folder or rearrange the directories. Mirage will update to reflect any change you make.

Presets can also exist elsewhere on your computer. However, these will not automatically appear in the preset browser menus. These must be loaded by clicking on the file icon on the presets browser panel and then navigating to the individual file.

Making Your Own Preset Packs

You can save presets by clicking on the floppy disk icon at the top of Mirage's GUI. To make these into a pack for distribution online, bundle the presets files together (the ZIP format is common for this), and point whoever is installing them to this manual. You are allowed to share or sell Mirage presets, but you may not share or sell any other type of Mirage file.


MIDI Learn

All automatable parameters in Mirage can be easily assigned to a MIDI CC. Perhaps the most common MIDI CC used is the mod-wheel, which is CC number 1.

Any CC number can be used to control any parameter of Mirage. This is done by right-clicking on a parameter on the GUI and then selecting MIDI learn from the menu that pops up. Next, move the knob/slider on your physical MIDI controller - Mirage will detect this movement and bind the CC number to the parameter in Mirage. The mapping is now set: whenever you move that knob, the parameter in Mirage will move too. This binding can be undone by right-clicking the parameter and selecting Remove MIDI Learn.

This relationship lasts for as long Mirage exists in your DAW - if you remove and then re-add Mirage, this MIDI CC relationship will be lost. However, this relationship is preserved when you save or load your DAW project.

Always set a MIDI CC to a parameter

Alongside the MIDI learn functionality, you can set up a more permanent relationship between parameters in Mirage and sliders/knobs on your MIDI controller. To do this, MIDI Learn a parameter, as explained above. Once completed, when you right-click the parameter, you will see a new toggleable option for Always set MIDI CC to this. You can toggle this option to set the permanent relationship. If enabled, whenever you load up a new instance of Mirage, the CC number will be bound to the parameter.

By default, MIDI CC1 (AKA the mod-wheel) is set up to control the Dynamics slider in Mirage in this semi-permanent fashion.

It's worth clarifying that these settings are stored in different places. MIDI CC-to-parameters are stored/loaded when you save/load your DAW project; they are not saved/loaded when saving/loading presets. The option for permanent MIDI CC-to-parameter mapping is neither saved in preset files nor in your DAW project. Instead, it's saved in a preferences-file on your computer.

Sustain Pedal

Mirage can be controlled with a sustain pedal. A sustain pedal is a special kind of MIDI controller that sends MIDI CC-64 messages. These messages represent an on or off state.

When Mirage receives a sustain pedal on message, all notes that are currently held will sustain until a corresponding sustain pedal off message is received. The notes will persist even if the notes are released from the keyboard. Only releasing the sustain pedal will trigger them to stop. This is a common behaviour for synths and samplers alike. It roughly simulates the behaviour of a real piano sustain pedal.

Sustain Pedal Retrigger Mode

Each layer in Mirage has a switch that changes the behaviour when pressing the same note multiple times while the sustain pedal is held down. This parameter can be found in the MIDI tab of each layer and is called 'CC64 Retrig'.

When 'CC64 Retrig' is turned off, and you are holding the sustain pedal down, nothing happens if you press the same key multiple times - the new up and down is ignored - the sound continues to sustain just as it did before.

However, when 'CC64 Retrig' is on, the note is retriggered (the sound ends and a new one starts); this behaviour tends to be the more intuitive option. Note that this switch is per-layer, not global. This allows for more powerful customisation of a preset.


Effects

Mirage has a selection of simple effects that can be applied to the audio. These effects are applied to the mix of the three layers. The effects are shown in a list on the right-hand side of the main panel. You can change the ordering of the effects by dragging and dropping.


Mirage's Parameters

Master Parameters

Parameters at the top level of Mirage.

NameTypeDescriptionID
VolKnobMaster volumeMastVol
VeloKnobThe amount that the MIDI velocity affects the volume of notes; 100% means notes will be silent when the velocity is very soft, and 0% means that notes will play full volume regardless of the velocityMastVel
DynKnobThe intensity of the sound. Not every instrument contains dynamics information; instruments that do will be highlighted when you click on this knob.MastDyn

Layer Parameters

The parameters for each of the 3 layers of Mirage.

Top
NameTypeDescriptionID
VolumeKnobLayer volumeL0Vol
MuteSwitchMute this layerL0Mute
SoloSwitchMute all other layersL0Solo
PanKnobLeft/right balanceL0Pan
DetuneKnobLayer pitch in cents; hold shift for finer adjustmentL0Detune
PitchNumberLayer pitch in semitonesL0Pitch
Main
NameTypeDescriptionID
LoopSwitchThe mode for looping the instrument samplesL0LpOn
StartKnobLoop-startL0LpStrt
EndKnobLoop-endL0LpEnd
XFadeKnobCrossfade length; this smooths the transition from the loop-end to the loop-startL0LpXf
Ping PongSwitchnot usedL0LpPP
StartKnobChange the starting point of the sampleL0Offs
ReverseSwitchPlay the sound in reverseL0Rev
Volume EnvelopeSwitchEnable/disable the volume envelope; when disabled, each sound will play out entirely, or until the key is pressed againL0VlEnOn
AttackKnobVolume fade-in lengthL0Att
DecayKnobVolume ramp-down length (after the attack)L0Dec
SustainKnobVolume level to sustain (after decay)L0Sus
ReleaseKnobVolume fade-out length (after the note is released)L0Rel
Filter
NameTypeDescriptionID
FilterSwitchEnable/disable the filterL0FlOn
CutoffKnobThe frequency at which the filter should take effectL0FlCut
ResoKnobThe intensity of the volume peak at the cutoff frequencyL0FfRes
TypeMenuFilter typeL0FlTy
EnvelopeKnobHow strongly the envelope should control the filter cutoffL0FlAm
AttackKnobLength of initial ramp-upL0FlAtt
DecayKnobLength ramp-down after attackL0FLDec
SustainKnobLevel to sustain after decay has completedL0FlSus
ReleaseKnobLength of ramp-down after note is releasedL0FlRel
LFO
NameTypeDescriptionID
LFOSwitchEnable/disable the Low Frequency Oscillator (LFO)L0LfoOn
ShapeMenuOscillator shapeL0LfoSh
ModeMenuOscillator phase mode. Retrigger: each voice has its own phase, Free: all voices that are playing simultaneously will have the same phaseL0LfoMd
AmountKnobIntensity of the LFO effectL0LfoAm
TargetMenuThe parameter that the LFO will modulateL0LfoTg
TimeMenuLFO rate (synced to the host)L0LfoSyt
TimeKnobLFO rate (in Hz)L0LfoHZ
SyncSwitchSync the LFO speed to the hostL0LfoSyO
EQ
NameTypeDescriptionID
EQSwitchTurn on or off the equaliser effect for this layerL0EqOn
FreqKnobBand 1: frequency of this bandL0EqFr0
ResoKnobBand 1: sharpness of the peakL0EqRs0
GainKnobBand 1: volume gain at the frequencyL0EqGn0
TypeMenuBand 1: type of EQ bandL0EqTy0
FreqKnobBand 2: frequency of this bandL0EqFr1
ResoKnobBand 2: sharpness of the peakL0EqRs1
GainKnobBand 2: volume gain at the frequencyL0EqGn1
TypeMenuBand 2: type of EQ bandL0EqTy1
MIDI
NameTypeDescriptionID
Velocity MappingKnobChoose how MIDI velocity should affect the volume of this layer. There are 6 modes that can be selected for this parameter via the buttons on the GUI. By setting one layer to be quiet at high velocities and another layer to be quiet at low velocities you can create an instrument that sounds different based on how hard the notes are played. (0) Ignore velocity, always play full volume. (1) Loudest at high velocity, quietest at low velocity (2) Loudest at low velocity, quietest at high velocity (3) Loudest at high velocity, quietest at middle velocity and below (4) Loudest at middle velocity, quietest at both high and low velocities (5) Loudest at bottom velocity, quietest at middle velocity and above,L0Vel
KeytrackSwitchTune the sound to match the key played; if disabled it will always play the sound at its root pitchL0KTr
MonophonicSwitchOnly allow one voice of each sound to play at a timeL0Mono
CC64 RetriggerSwitchWhen the sustain pedal (CC64) is held, keys that are pressed again are retriggeredL0SusRe
TransposeNumberTranspose the mapping of samples by the given semitone offset, meaning a higher/lower sample may be triggered instead of stretching/shrinking the audio by large amounts (only useful if the instrument is multi-sampled)L0Trn

Distortion Parameters

Distort the audio using various algorithms.

NameTypeDescriptionID
TypeMenuDistortion algorithm typeDistType
DriveKnobDistortion amountDistDrive
DistortionSwitchEnable/disable the distortion effectDistOn

Bit Crush Parameters

Apply a lo-fi effect to the signal by either reducing the sample rate or by reducing the sample resolution. Doing either distorts the signal.

NameTypeDescriptionID
BitsKnobAudio resolutionBitcBits
Samp RateKnobSample rateBitcRate
WetKnobProcessed signal volumeBitcWet
DryKnobUnprocessed signal volumeBitcDry
Bit CrushSwitchEnable/disable the bitcrush effectBitcOn

Compressor Parameters

Compress the signal to make the quiet sections louder.

NameTypeDescriptionID
ThresholdKnobThe threshold that the audio has to pass above before the compression should start taking placeCompThr
RatioKnobThe intensity of compression (high ratios mean more compression)CompRt
GainKnobAdditional control for volume after compressionCompGain
Auto GainSwitchAutomatically re-adjust the gain to stay consistent regardless of compression intensityCompAuto
CompressorSwitchEnable/disable the compression effectCompOn

Filter Parameters

Adjust the volume frequency bands in the signal, or cut out frequency bands altogether. The filter type can be selected with the menu.

NameTypeDescriptionID
FilterSwitchEnable/disable the filterFlOn
CutoffKnobFrequency of filter effectFlCut
ResoKnobThe intensity of the volume peak at the cutoff frequencyFlRes
GainKnobVolume gain of shelf filterFlGain
TypeMenuFilter typeFlType

Stereo Widen Parameters

Increase or decrease the stereo width of the signal.

NameTypeDescriptionID
WidthKnobIncrease or decrease the stereo widthSterWd
Stereo Widen OnSwitchTurn the stereo widen effect on or offSterOn

Chorus Parameters

An effect that changes the character of the signal by adding a modulated and pitch-varying duplicate signal.

NameTypeDescriptionID
RateKnobChorus modulation rateChorRate
High-passKnobHigh-pass filter cutoffChorHP
DepthKnobChorus effect intensityChorDpth
WetKnobProcessed signal volumeChorWet
DryKnobUnprocessed signal volumeChorDry
ChorusSwitchEnable/disable the chorus effectChorOn

Reverb Parameters

Algorithmically simulate the reflections and reverberations of a real room.

NameTypeDescriptionID
DryKnobUnprocessed signal volumeRvDry
SizeKnobVirtual space sizeRvSize
ReverbSwitchEnable/disable the reverb effectRvOn
Legacy ModeSwitchEnable/disable the legacy version of the algorithmRvLeg
PredelayKnobDelay before reverb effect happensSvRvPre
Mod RateKnobRate of pitch modulationSvRvMs
DepthKnobIntensity of pitch modulationSvRvMd
FilterKnobLow/high frequency reductionSvRvDm
WetKnobProcessed signal volumeSvRvWet
Legacy
NameTypeDescriptionID
DampingKnobHigh frequency reduction amountRvDamp
WidthKnobStereo widthRvWidth
WetKnobProcessed signal volumeRvWet

Delay Parameters

Simulate an echo effect, as if the sound is reflecting off of a distant surface.

NameTypeDescriptionID
Time LMenuLeft delay time (synced to the host tempo)DlSyncL
Time RMenuRight delay time (synced to the host tempo)DlSyncR
FeedbackKnobHow much the signal repeatsDlFeed
Tempo SyncSwitchSynchronise timings to the host's BPMDlSyncOn
WetKnobLevel of processed signalDlWet
DelaySwitchEnable/disable the delay effectDlOn
Legacy ModeSwitchEnable/disable the legacy version of the algorithmDlLeg
ModeMenuDelay typeSvDlMode
Time LKnobLeft delay time (in milliseconds)SvDlMsL
Time RKnobRight delay time (in milliseconds)SvDlMsR
FilterKnobHigh/low frequency reductionSvDlFl
Legacy
NameTypeDescriptionID
Time LKnobLeft delay time (in milliseconds)DlMsL
Time RKnobRight delay time (in milliseconds)DlMsR
DampKnobAmount of high frequency reductionDlDamp

Phaser Parameters

Modulate the sound using a series of moving filters

NameTypeDescriptionID
FreqKnobBase frequency of the effectSvPhFr
RateKnobFilter movement rateSvPhMf
DepthKnobFilter movement amountSvPhMd
FeedbackKnobIntensitySvPhFd
StagesKnobNumber of filtersSvPhSg
Mod StereoSwitchStereoise the filter movementSvPhSt
WetKnobProcessed signal volumeSvPhWet
DryKnobUnprocessed signal volumeSvPhDry
PhaserSwitchEnable/disable the phaser effectSvPhOn

Convolution Reverb Parameters

The Convolution reverb effect applies a reverb to the signal. The characteristic of the reverb is determined by the impulse response (IR). The IR can be selected from the menu.

NameTypeDescriptionID
ImpulseThe impulse response (IR) that defines the character of the reverberationConvIR
High-passKnobWet high-pass filter cutoffConvHP
WetKnobProcessed signal volumeConvWet
DryKnobUnprocessed signal volumeConvDry
Convol ReverbSwitchEnable/disable the convolution reverb effectConvOn