88
edits
Changes
Jump to navigation
Jump to search
Line 74:
Line 74: − + − + − + − + Line 93:
Line 93: − + Line 102:
Line 102: − + Line 131:
Line 131: − + − + − + − + Line 151:
Line 151: − + Line 168:
Line 168: − + − − + − + Line 200:
Line 199: − + − + Line 212:
Line 211: − + Line 225:
Line 224: − + − + − + Line 237:
Line 236: − + Line 243:
Line 242: − + − + − Obviously, before loading any snapshot, you should save one, and for saving a snapshot, you should create some layers, etc. Zynthian UI will use numbers for naming the banks and snapshots. Later, using the webconf tool you can rename the snapshots to something more explicit.+ Line 258:
Line 257: − + Line 290:
Line 289: − + − + − + Line 307:
Line 306: − + Line 323:
Line 322: − + − + − + Line 337:
Line 336: − + − + Line 385:
Line 384: − + − + − + Line 402:
Line 401: − + Line 498:
Line 497: − +
Zynthian UI User Guide (oldstable-2109) (view source)
Revision as of 12:23, 13 January 2020
, 12:23, 13 January 2020→Controlling the UI with MIDI messages
[[File:Zynthian_ui_mixer_layers.png|400px|right]]
[[File:Zynthian_ui_mixer_layers.png|400px|right]]
Layers are a key concept on Zynthian-UI: the first thing you do when you power-on your zynthian is create a layer ;-)
Layers are a key concept on Zynthian-UI: the first thing you do when you power-on your zynthian is create a layer.
A layer is an '''Audio Processing Chain''', normally assigned to a MIDI channel, that can be composed of one or several Audio Processing Units. This units are chained by default, although you can customize the audio routing. The first unit in a layer is the '''root''' and determines the layer's type:
A layer is an '''Audio Processing Chain''', normally assigned to a MIDI channel, which can be composed of one or more Audio Processing Units. these units are chained by default, although you can customize the audio routing. The first unit in a layer is the '''root''' which determines the layer's type:
* '''Synth Layer''' => Receives MIDI note-events and generate audio output.
* '''Synth Layer''' => Receives MIDI note-events and generate audio output.
* '''FX Layer''' => Receives audio-input and generates audio-output.
* '''FX Layer''' => Receives audio-input and generates audio-output.
* '''Generator Layer''' => Auto-generate audio output using some algorithm.
* '''Generator Layer''' => Auto-generate audio output using an algorithm.
* '''Special Layer''' => MOD-UI pedalboard, Pure Data patch, etc.
* '''Special Layer''' => MOD-UI pedalboard, Pure Data patch, etc.
The rest of units in a layer normally are FX units that process the audio coming-out from the first unit (root).
The rest of units in a layer are usually FX units which process the audio coming from the first unit (root).
All units in a layer receive all the MIDI events coming from the assigned channel. Some special layers (MOD-UI) don't have an assigned MIDI channel and receive all MIDI channels.
All units in a layer receive all the MIDI events coming from the assigned channel. Some special layers (MOD-UI) don't have an assigned MIDI channel and receive all MIDI channels.
[[File:zynthian_ui_mixer_control.png|400px|right]]
[[File:zynthian_ui_mixer_control.png|400px|right]]
Although the '''MIXER''' is shown in the layer list, it's not a real layer. This pseudo-layer allows to adjust the soundcard output/input levels and other audio-hardware related options. Technically speaking, it's a user interface for the ALSA (Audio Linux Sound Architecture) mixer ;-)
Although the '''MIXER''' is shown in the layer list, it's not a real layer. This pseudo-layer allows to adjust the soundcard output/input levels and other audio-hardware related options. Technically speaking, it's a user interface for the ALSA (Audio Linux Sound Architecture) mixer.
You can configure the available mixer controllers from the webconf audio config menu.
You can configure the available mixer controllers from the webconf audio config menu.
The following flowcharts show the different "screens" or "menus" and how to reach each one using the 4 switches.
The following flowcharts show the different "screens" or "menus" and how to reach each one using the 4 switches.
It would be a good idea to print these flowcharts and keep them near your Zynthian Box until you memorize the workflow and the spirit of the Zynthian UI gets inside you ;-)
It would be a good idea to print these flowcharts and keep them near your Zynthian Box until you memorize the workflow.
<gallery mode="slideshow" widths="240" heights="320">
<gallery mode="slideshow" widths="240" heights="320">
* '''NEW Effect Layer''' => Create a new Effect Layer that will be connected to soundcard's Audio Input.
* '''NEW Effect Layer''' => Create a new Effect Layer that will be connected to soundcard's Audio Input.
* '''NEW Generator Layer''' => Create a new Generator Layer that self-generates audio or midi.
* '''NEW Generator Layer''' => Create a new Generator Layer that self-generates audio or midi.
* '''NEW Special Layer''' => Create a new Special Layer that will receive all MIDI channels.
* '''NEW Special Layer''' => Create a new Special Layer which will receive all MIDI channels.
* '''REMOVE ALL''' => Remove all Layers (Root layers and its associated Effect-Chains), returning to the initial state.
* '''REMOVE ALL''' => Remove all Layers (Root layers and its associated Effect-Chains), returning to the initial state.
* '''PANIC! All Notes/Sounds Off''' => All notes and sounds are stopped abruptly by sending CC#123 and CC#120 to all channels.
* '''PANIC! All Notes/Sounds Off''' => All notes and sounds are stopped abruptly by sending CC#123 and CC#120 to all channels.
The last option, ''All Notes/Sounds Off'', can be triggered by bold clicking CTRL-1 (layer) from the layer screen (contextual action). You can trigger this actions from any point in the workflow by simply bold-clicking twice CTRL-1. Also, you can add a ''panic-button'' to your zynthian using the extra pins from the AllInOne circuit or the Zynscreen. [[Adding Extra Switches|Read this for a detailed explanation about how to add a panic button to your Zynthian]].
The last option, ''All Notes/Sounds Off'', can be triggered by bold clicking CTRL-1 (layer) from the layer screen (contextual action). You can trigger this actions from any point in the workflow by simply bold-clicking CTRL-1 twice. You can also add a ''panic-button'' to your zynthian using the extra pins from the AllInOne circuit or the Zynscreen. [[Adding Extra Switches|Read this for a detailed explanation about how to add a panic button to your Zynthian]].
<br clear=all>
<br clear=all>
[[File:Zynthian_ui_layer_list_mixer.png|400px|right]]
[[File:Zynthian_ui_layer_list_mixer.png|400px|right]]
When you select '''NEW Synth/Effect/Generator Layer''', you create a new root-layer (first of a chain), choosing a free MIDI channel for it. You can create up to 16 layers (as many as MIDI channels), each one having an independent effect-chain.
When you select '''NEW Synth/Effect/Generator Layer''', you create a new root-layer (first of a chain), choosing a free MIDI channel for it. You can create up to 16 layers (as many there are MIDI channels), each one having an independent effect-chain.
Having several layers in the same MIDI channel is not allowed. If you want two or more layers playing unison (like being in the same MIDI channel), you should use the "Clone" feature, that allows you to bind several layers while keeping MIDI CCs and other MIDI messages (Program Change, Channel Pressure, etc.) independent.
Having several layers in the same MIDI channel is not allowed. If you want two or more layers playing unison (like being in the same MIDI channel), you should use the "Clone" feature, which allow you to bind several layers while keeping MIDI CCs and other MIDI messages (Program Change, Channel Pressure, etc.) independent.
<br clear=all>
<br clear=all>
* '''Clone MIDI to...''' => clone the '''layer's MIDI channel''' messages to other MIDI channels. Note that only note on/off, pitch-bending, and key-press messages are cloned, while the rest are kept independent (CC, channel-pressure, program change, ...)
* '''Clone MIDI to...''' => clone the '''layer's MIDI channel''' messages to other MIDI channels. Note that only note on/off, pitch-bending, and key-press messages are cloned, while the rest are kept independent (CC, channel-pressure, program change, ...)
* '''Transpose''' => transpose the '''layer's MIDI channel''' up and down, by semitones.
* '''Transpose''' => transpose the '''layer's MIDI channel''' up and down, by semitones.
* '''Audio Routing''' => route the '''layer's''' audio output to available audio input ports, allowing to process the audio in any way you imagine. You can use this feature for creating your own customized/bizarre FX chains. If this is not enough for you, try MOD-UI engine with the MOD-UI web GUI. ;-)
* '''Audio Routing''' => route the '''layer's''' audio output to the available audio input ports, allowing to process the audio in any way you imagine. You can use this feature for creating your own customized/bizarre FX chains. If this is not enough for you, try MOD-UI engine with the MOD-UI web GUI.
* '''MIDI chan''' => change the MIDI Channel assigned.
* '''MIDI chan''' => change the MIDI Channel assigned.
* '''Remove Layer''' => Remove the layer.
* '''Remove Layer''' => Remove the layer.
==Engine Selection==
==Engine Selection==
[[File:Zynthian_ui_engine_list.png|400px|right]]
[[File:Zynthian_ui_engine_list.png|400px|right]]
When you create a new layer, you are asked about which engine/plugin you want to use for it. A list of engines to choose from is displayed. They can be synthesizers, effects, generators or special engines, depending on the type of layer you are creating. When you select an element from the list,
When you create a new layer, you are asked which engine/plugin you want to use for it. A list of engines to choose from is displayed. They can be synthesizers, effects, generators or special engines, depending on the type of layer you are creating. When you select an element from the list, the zynthian logo on the top-right will be animated while the engine is being started.
the zynthian logo on the top-right will be animated while the engine is being started.
Some engines have special behavior regarding layers and MIDI channels:
Some engines have special behavior regarding layers and MIDI channels:
* '''setBfree''': This engine can create 1, 2 or 3 layers assigned to the several MIDI channels starting at selected channel, each one corresponding to the upper, lower and pedals sections of the Hammond B3 emulation.
* '''setBfree''': This engine can create 1, 2 or 3 layers assigned to the several MIDI channels starting at selected channel, each one corresponding to the upper, lower and pedals sections of the Hammond B3 emulation.
* '''Pianoteq''': Only one layer is allowed to be created, assigned to the MIDI channel you choose.
* '''Pianoteq''': Only one layer can be created, assigned to the MIDI channel you choose.
* '''Aeolus''': By default, 4 layers are created, assigned to different MIDI channels (1,2,3 & 4), each one corresponding to the 3 manuals + 1 pedal of the Aeolus default instrument definition. You can change the MIDI channel assignments from the Aeolus native UI. If you want to use a different instrument definition, you will have to tweak the engine's code a little bit. Ask in the forum ;-)
* '''Aeolus''': By default, 4 layers are created, assigned to different MIDI channels (1,2,3 & 4), each one corresponding to the 3 manuals + 1 pedal of the Aeolus default instrument definition. You can change the MIDI channel assignments from the Aeolus native UI. If you want to use a different instrument definition, you will have to tweak the engine's code a little bit.
* '''MOD-UI''': Only one layer of this type is allowed and it will receive ALL MIDI channels. If you want to filter the messages by channel, you can do it within the MOD-UI patch. (There are plans for improving this behavior.)
* '''MOD-UI''': Only one layer of this type is allowed and it will receive ALL MIDI channels. If you want to filter the messages by channel, you can do it within the MOD-UI patch. (There are plans for improving this behavior.)
==Preset selection==
==Preset selection==
[[File:Zynthian_ui_preset_list.png|400px|right]]
[[File:Zynthian_ui_preset_list.png|400px|right]]
Once you have chosen a bank, Preset Screen will be shown. Choose a preset to load the instrument/sound/patch you want and the Control Instrument screen will be shown.
Once you have chosen a bank, the preset screen will be shown. Choose a preset to load the instrument/sound/patch you want and the Control Instrument screen will be shown.
If the '''preload with note-on''' feature is enabled, you can preload the presets by playing notes. When you do so, the highlighted preset will be pre-loaded before clicking select.
If the '''preload with note-on''' feature is enabled, you can preload the presets by playing notes. When you do so, the highlighted preset will be pre-loaded before clicking select.
You can return to the control screen directly, without selecting any preset, by clicking "bold-back". In such a case, the previously selected instrument will be restored in case you pre-loaded some preset.
You can return to the control screen directly, without selecting any preset, by clicking "bold-back". In that case, the previously selected instrument will be restored in case you pre-loaded some preset.
<br clear=all>
<br clear=all>
This screen is shown after you have chosen a preset. Your instrument is now enabled and playable and you can modify the parameters.
This screen is shown after you have chosen a preset. Your instrument is now enabled and playable and you can modify the parameters.
Turning any of the 4 knobs changes the values of the parameters displayed in the boxes at the sides of the screen adjacent to each knob. You also can use the touch interface to change the values. See below.
Turning any of the 4 knobs will change the value of the parameter displayed in the boxes adjacent to each knob. You also can use the touch interface to change the values. See below.
<br clear=all>
<br clear=all>
====XY-Controller====
====XY-Controller====
[[File:Zynthian_ui_xy_select.png|400px|right]]
[[File:Zynthian_ui_xy_select.png|400px|right]]
If you click 2 switches at once, you enter XY-control mode. The 2 controllers you clicked are green and you can choose the desired parameters to control by rotating the controller. Of course, you can navigate the controller pages by clicking select, etc. so you can select parameters from different pages.
If you click 2 knobs at once, you enter XY-control mode. The 2 controllers you clicked are green, and you can choose the desired parameters to control by rotating the controller. You can also navigate the controller pages by clicking select and so on. So you can select parameters from different pages.
<br clear=all>
<br clear=all>
[[File:Zynthian_ui_xy_controller.png|400px|right]]
[[File:Zynthian_ui_xy_controller.png|400px|right]]
Once you have selected the right parameters, touch the screen for entering the XY-control-pad (using the touchscreen ala Kaoss Pad).
Once you have selected the right parameters, touch the screen to enter the XY-control-pad (using the touchscreen ala Kaoss Pad).
Click ''back'' for returning to XY-select or bold-click ''back'' for returning to control screen.
Click ''back'' to return to XY-select or bold-click ''back'' to return to the control screen.
<br clear=all>
<br clear=all>
You can press the Layer switch to step over the layer list. If you bold-press, the layer list screen will be shown.
You can press the Layer switch to step over the layer list. If you bold-press, the layer list screen will be shown.
Press the Back switch to return to previous screen. If you press bold-Back, then you will go 2 screens backwards.
Press the Back switch to return to previous screen. If you press bold-Back, you will go 2 screens backwards.
<br clear=all>
<br clear=all>
[[File:Zynthian_ui_snapshot_load.png|400px|right]]
[[File:Zynthian_ui_snapshot_load.png|400px|right]]
[[File:Zynthian_ui_snapshot_save.png|400px|right]]
[[File:Zynthian_ui_snapshot_save.png|400px|right]]
Snapshots are used for saving/restoring the status of Zynthian. A snapshot includes the full state, including layers, effects, parameter values, MIDI-learning, etc.
Snapshots are used for saving and restoring the status of Zynthian. A snapshot includes the full state, including layers, effects, parameter values, MIDI-learning, etc.
You can enter the ''Load Snapshot'' screen by clicking the snapshot switch. From control screen you have to use bold-click. A second click and you will be in the ''Save Snapshot'' screen. You can also use bold-click to go directly to the Save Snapshot screen (not from control screen!).
You can enter the ''Load Snapshot'' screen by clicking the snapshot switch. From the control screen you have to use bold-click. A second click and you will be at the ''Save Snapshot'' screen. You can also use bold-click to go directly to the Save Snapshot screen (not from control screen!).
Before loading any snapshot, you should save one, and to save a snapshot, you should create some layers, etc. The Zynthian UI will use numbers for naming the banks and snapshots. You can rename the snapshots to something more specific using the webconf tool.
====Snapshot Banks====
====Snapshot Banks====
====Restore Last State====
====Restore Last State====
If "Restore last state on startup" option is enabled on webconf (and it's enabled by default!), then state will be saved when poweroff (using long-click select or from Admin Menu) and restored on next boot. This option has priority over the "Default Snapshot".
If "Restore last state on startup" option is enabled on webconf (it's enabled by default), then the state will be saved when powering off (using long-click select or from Admin Menu) and restored on next boot. This option has priority over the "Default Snapshot".
<br clear=all>
<br clear=all>
[[File:zynthian_ui_midi_recorder.png|400px|right]]
[[File:zynthian_ui_midi_recorder.png|400px|right]]
From the Admin menu you can access to the Audio & MIDI recording tools. These 2 simple tools allows you to record Audio & MIDI tracks easily, using the internal SD-card or an USB memory stick for storing the files.
From the Admin menu you can access to the Audio & MIDI recording tools. These simple tools allow you to record Audio & MIDI tracks easily, using the internal SD-card or an USB memory stick for storing the files.
'''WARNING!''' Using the internal SD card for storing the captured files increase the risk of corruption. You should avoid it by simply plugging an USB memory stick instead.
'''WARNING!''' Using the internal SD card to store the captured files will increase the risk of corruption. You should use a USB memory stick instead.
===Recording===
===Recording===
1. Press "Start Recording" for starting a new capture.
1. Press "Start Recording" to start a new capture.
2. The red circle should appear in the top-right status area, indicating that a recording is going on.
2. The red circle should appear in the top-right status area, indicating that a recording is going on.
For looping the file, turn on the "Loop Play" switch before playing.
For looping the file, turn on the "Loop Play" switch before playing.
'''NOTE:''' You can play a file in any moment. Recording and playing can take place simultaneously.
'''NOTE:''' You can play a file at any moment. Recording and playing can take place simultaneously.
When playing audio, a volume control will be shown. When playing MIDI, a BPM control will be shown for adjusting the transport speed.
When playing audio, a volume control will be shown. When playing MIDI, a BPM control will be shown for adjusting the transport speed.
* rename recordings
* rename recordings
* delete recordings
* delete recordings
* convert audio recordings to ogg format
* convert audio recordings to .ogg format
* downloading recordings to your computer
* downloading recordings to your computer
* reproduce the audio recordings in your browser. If wav doesn't work in your browser, try converting to ogg.
* reproduce the audio recordings in your browser. If .wav files doesn't work in your browser, try converting to ogg.
It is a good idea to rename your recordings so that they can be easily identified.
It is a good idea to rename your recordings so they can be easily identified.
[[File:Zynthian_webconf_captures_02.png|600px|border|left]]
[[File:Zynthian_webconf_captures_02.png|600px|border|left]]
You can navigate and control the Zynthian UI without knobs/encoders/switches at all, using only the touchscreen.
You can navigate and control the Zynthian UI without knobs/encoders/switches at all, using only the touchscreen.
You can "emulate" the switches by tapping the controller widgets (squares in the 4 corners of the screen). There are short, bold and long actions, same behaviour than rotary encoders work-flow. The only screen having the 4 controller widgets is the "Instrument Control" screen. Most of screens are selector ones, that only have 1 controller widget. On those screens you can click the '''zynthian logo''' (top-right) for emulating the "snapshot" switch, and you can go back by tapping the '''top-bar''' area.
You can "emulate" the switches by tapping the controller widgets (squares in the 4 corners of the screen). There are short, bold and long actions, same behaviour than rotary encoders work-flow. The only screen having the 4 controller widgets is the "Instrument Control" screen. Most of screens are selectors, which only have 1 controller widget. On those screens you can click the '''zynthian logo''' (top-right) to emulate the "snapshot" switch, and you can go back by tapping the '''top-bar''' area.
You can change the controller values by "sliding" up/down over the widgets. (see the green arrow in the figure here) This is the same as turning the knob. If you are using a mouse, the mouse wheel also can be used for changing the controller value.
You can change the controller values by "sliding" up/down over the widgets. (see the green arrow in the figure) This is the same as turning the knob. If you are using a mouse, the mouse wheel also can be used to change the controller value.
<br clear=all>
<br clear=all>
- Controller values
- Controller values
As you can see, it has sense in a SnapShot context, where a set of layers are defined. Zs3 changing is very fast, as no engine must be started.
As you can see, it has sense in a SnapShot context, where a set of layers are defined. Zs3 changing is very fast, as no engine have to be started.
<br clear=all>
<br clear=all>
====MIDI-CC Learning with touch interface====
====MIDI-CC Learning with a touch interface====
First, you need a working touch interface in your display. If you don't have a touchscreen, you could use a mouse ...
First, you need a working touch interface in your display. If you don't have a touchscreen, you could use a mouse.
[[File:Zynthian_ui_midi_learning.png|400px|right]]
[[File:Zynthian_ui_midi_learning.png|400px|right]]
'''Unlearning:'''
'''Unlearning:'''
1. In the "Instrument Control" screen, navigate through the parameter screen list until you get to the parameter you want to unlearn.
1. In the "Instrument Control" screen, navigate through the parameter screen list until you get to the parameter you want to unlearn.
2. In the parameter/controller area, slide with your fingernail from '''right to left'''. The tiny number, indicating the current CC assignment, should disappear or change. If the parameter is an engine-specific controlled engine, the number will disappear. If the parameter is a hardcoded MIDI-mapped parameter, then the number will change.
2. In the parameter/controller area, slide with your fingernail from '''right to left'''. The tiny number, indicating the current CC assignment, should disappear or change. If the parameter is an engine-specific controlled engine, the number will disappear. If the parameter is a hardcoded MIDI-mapped parameter, the number will change.
<br clear=all>
<br clear=all>
0x00 (Velocity/parameter)
0x00 (Velocity/parameter)
or play the C-1 key, if your keyboard has it ;-)
or play the C-1 key, if your keyboard has it.
This is the full list:
This is the full list: