2,718
edits
Changes
→General Concepts
* '''adjusting parameters'''
* '''adjusting parameters'''
Each push button is engraved with a text legend or an icon and backlit with a RGB LED that gives a useful status feedback. The knobs are numbered from top to bottom, so the top one is knob#1 and the bottom one is knob#4. We will refer knobs in this way throughout this guide.
Each push button is engraved with a text legend or icon and backlit with RGB LED that gives status feedback. The knobs are numbered from top to bottom, so the top one is knob#1 and the bottom one is knob#4. We will refer knobs in this way throughout this guide.
Most operations may be performed with the touchscreen but some may not be intuitive or easy to perform with it. On the other hand, some operations are specially optimized for using the touch screen. This will be detailed when explaining the different screens and workflows.
Most operations may be performed with the touchscreen but some may not be intuitive or easy to perform with it. On the other hand, some operations are specially optimized for using the touch screen. This will be detailed when explaining the different screens and workflows.
Like the classic UI, there are 3 types of push actions that can be performed, depending on how long you hold down the button (or knob!):
Like the classic zynthian UI, there are 3 types of push actions that can be performed, depending on how long you hold down the button (or knob!):
* '''short-push:''' Less than 0.3 seconds
* '''short-push:''' Less than 0.3 seconds
<br clear=all>
<br clear=all>
{{NoteBox|Not all buttons have actions assigned to all three push types. You can change these timings from the webconf's UI tab.}}
{{NoteBox|Not all buttons have actions assigned to all three push types. You can change these timings from the [[Web_Configuration_User_Guide#User_Interface|webconf's UI tab]].}}
<br clear=all>
<br clear=all>
The two main differences between the V5 UI and the ''classic'' zynthian UI are:
The two main differences between the V5 UI and the ''classic'' zynthian UI are:
* the big 5x4 silicone button grid, that adds 20 push buttons with RGB LED feedback, allowing huge improvements in usability.
* the big 5x4 silicone button grid, that adds 20 push buttons with RGB LED feedback.
* as a consequence, the 4 knobs are often used in quite a different way.
* as a consequence of the availability of more buttons, the 4 knobs are often used in quite a different way.
Let's start taking a closer look to this!
Let's start taking a closer look to this!
<br clear=all>
===The Title Bar===
In the V5, the title bar acts as a kind of breadcrumb. It normally shows the screen title or current chain information: MIDI channel, engine, bank & preset.
<br clear=all>
===The Status Area===
[[File:Zynthian_Status_Bar.png|400px|right]]
On the top-right corner, aside the title bar, is an area where some useful information is displayed in real time:
* '''Digital audio Peak Meter (DPM)''': horizontal bars indicating digital audio level and peaks
* '''Status Icons''': indication of various zynthian states
Let's see the details:
====Digital audio Peak Meter (DPM)====
The DPM covers the range -50dBFS to 0dBFS, i.e. maximum permissible level at full scale (far right) down to 50dB below (far left):
* The green segment covers the range -50dBFS to -10dBFS.
* The yellow segment covers the range -10dBFS to -3dBFS.
* The red segment covers the range -3dBFS to 0dBFS.
There are independent meters for left and right channels which monitor the system output, i.e. the mix of audio that feeds the Zynthian output. Level decays with a logarithmic rule, taking one second to decay to -200dBFS so will decay to -50dBFS (the displayed range) in about quarter of a second. Peaks are displayed instantly, i.e. the attack of the meter is immediate (*). The peak hold bar remains for two seconds or until a higher peak is reached.
(*) Meter is updated 5 times per second so there can be 200 ms delay in peak being displayed.
====The Status Icons====
{| class="wikitable"
!colspan="3"|1st row: Health & Load
|-
|style="padding:10px"|<span style="color:#00FF00">{{#fas:heart}}</span>
|style="padding:10px;width: 200px;|'''Cpu Load'''
|style="padding:10px"|Heart, indicating CPU load. It displays as green when under 50%, yellow when load is over 50% and red over 75%.
|-
|style="padding:10px"|<span style="color:#00FF00">{{#fas:recycle}}</span>
|style="padding:10px;width: 200px;|'''Software update available'''
|style="padding:10px"|When a software update is available, the green recycle symbol is shown. You can update from the admin menu, webconf or terminal.
|-
|style="padding:10px"|<span style="color:#FF0000">{{#fas:exclamation-triangle}}</span>
|style="padding:10px"|'''XRun'''
|style="padding:10px"|It's shown when there are XRuns. This may be accompanied by clicks and pops on audio output. This means the CPU can't process or transfer audio fast enough and you should consider disabling some CPU-hungry option (like VNC, headphones, etc.) or reducing the complexity of your chains.
|-
|style="padding:10px"|<span style="color:#FF0000">{{#fas:bolt}}</span>
|style="padding:10px"|'''Under-voltage'''
|style="padding:10px"|Zynthian is working in a degraded state, with the CPU frequency capped to 600-800 MHz, trying to stabilize the system and avoid a system crash. You shouldn't see that icon and if you do so, you should consider looking for a better power source.
|-
|style="padding:10px"|<span style="color:#FF0000">{{#fas:temperature-high}}</span>
|style="padding:10px"|'''Over-temperature'''
|style="padding:10px"|Zynthian is working in a degraded state, with the CPU frequency capped to 600-800 MHz, trying to stabilize the system and avoid a system crash. You shouldn't see that icon and if you do so, you should improve heat dissipation (using a heat sink, etc.)
|-
!colspan="3"|2nd row: MIDI activity & Playing/Recording
|-
|style="padding:10px"|<span style="color:#8080FF">'''m'''</span>
|style="padding:10px;width: 200px;|'''MIDI-IN'''
|style="padding:10px"|It's shown when MIDI messages are received. Underscore indicates system message such as MIDI clock.
|-
|style="padding:10px"|<span style="color:#b00000">{{#fas:circle}}</span>
|style="padding:10px"|'''Recording Audio'''
|style="padding:10px"|Audio is being recorded.
|-
|style="padding:10px"|<span style="color:#00b000">{{#fas:play}}</span>
|style="padding:10px"|'''Playing Audio'''
|style="padding:10px"|Audio track is being played.
|-
|style="padding:10px"|<span style="color:#9090FF">{{#fas:circle}}</span>
|style="padding:10px"|'''Recording MIDI'''
|style="padding:10px"|MIDI is being recorded.
|-
|style="padding:10px"|<span style="color:#9090FF">{{#fas:play}}</span>
|style="padding:10px"|'''Playing MIDI'''
|style="padding:10px"|MIDI track is being played.
|-
|style="padding:10px"|<span style="color:#ff9000">{{#fas:circle}}</span>
|style="padding:10px"|'''Recording Pattern'''
|style="padding:10px"|A sequencer's pattern is being recorded.
|-
|style="padding:10px"|<span style="color:#ff9000">{{#fas:play}}</span>
|style="padding:10px"|'''Playing Sequence'''
|style="padding:10px"|A sequence or pattern is being played.
|}
==The Zynthian UI Workflow==
Zynthian workflow is based around chains of audio/MIDI generators & processors feeding an audio summing mixer.
[[File:Zynthian Signal Flow.png|800px|center]]
<br clear=all>
===Chains===
Chains are a key concept of the Zynthian. The first thing you will do after powering-on your Zynthian is probably to create a chain. (It does little without any chains!)
A chain is composed of one or more interconnected blocks, capable of generating or processing audio & MIDI. Each chain is normally assigned to a MIDI channel. These blocks are chained in the same order they are created, but you can change this order from the '''Chain Options''' menu. The first block created in a chain is the '''root''' and it determines the chain's type:
* '''Synth Chain''' => Receives MIDI note-events and generate audio output. It must have a synth processor.
* '''Audio Chain''' => Receives audio-input and generates audio-output. It only has audio-FX processors.
* '''MIDI Chain''' => Receives MIDI-input and generates MIDI-output. It only has MIDI processors.
<!--* (Oram) '''MIDI + Audio Chain''' => Receives MIDI + Audio input and generates MIDI + Audio output. It has MIDI and audio-FX processors.-->
* '''Generator Chain''' => Generate audio output using an algorithm. The first processor is an audio generator.
* '''Special Chain''' => It can contains special processors, like an AudioPlayer (sampler), a MOD-UI pedalboard or a Pure Data patch, etc.
<br>
The chain's type can't be changed. Depending of the chain's type, MIDI processors can be added to the start of the chain and audio processors can be added to the end of the chain. Chain processors can be re-sorted and arranged as serial or parallel paths.
<!--
(Oram) All chain types, except Audio and Generator chains, have a MIDI channel assigned. MIDI channels are not exclusive anymore and you can assign the same MIDI channel to several chains. MIDI and MIDI+Audio chains can receive '''all MIDI channels'''.
(Oram) In MIDI+Audio chains, all audio processors in the chain receive all the MIDI events on the assigned channel (this should be improved!).
-->
(*) If Master Channel is enabled, this is excluded from the MIDI channels available for chain assignment.
Having several chains on the same MIDI channel is not allowed currently. If you want two or more chains to play in unison (like being on the same MIDI channel), you can use the "Clone" feature, which allows you to bind several chains while keeping MIDI CCs and other MIDI messages (Program Change, Channel Pressure, etc.) independent.
<br clear=all>
===MIDI input===
Each chain receive MIDI input from selected devices (keyboards and other MIDI controllers). You can configure the MIDI input devices from the chain's option menu. Use short-push for selecting the devices and bold-push for changing the input mode. All input devices are selected by default when creating a new chain.
Each input device can work in 3 different modes:
* '''ACTI:''' only the active chain receives all MIDI input from the device and all MIDI events are translated to the active chain's MIDI channel. It's the default mode.
* '''OMNI:''' each chain receives all MIDI input from the device and all MIDI events are translated to each chain's MIDI channel.
* '''MULTI:''' each chain receives MIDI from the input device in the configured MIDI channel. No MIDI channel translation is done.
When using ACTI mode you don't need to worry about the MIDI channel your keyboard/controller is using. You change the instrument you play by changing the active chain in your zynthian. You can change the active chain by simply rotating the select knob (#4) in the Mixer view or using the the left/right arrows.
In the other hand, MULTI mode allows receiving and managing separately every MIDI channel. Each MIDI controller will drive the chains assigned to the controller's MIDI channel. If you are using a MIDI controller that can sequence multiple tracks (Beatstep Pro, Keystep Pro, Novation Circuit etc.) then you will generally want to use this mode.
Finally, OMNI mode allows one or several chains to receive all MIDI input from your device translated to chain's MIDI channel. This can be useful for some use-cases. Be warned that this mode will be dropped in the near future so you should avoid it.
Note that MIDI CC (Continuous Controllers) events are handled differently and they are not routed to chains. See section on [[#MIDI-learning_.2F_binding|MIDI Learning & binding]].
<br clear=all>
<br clear=all>
** Admin menu
** Admin menu
* '''MIX/LEVEL'''
* '''MIX/LEVEL'''
** Audio Mixer screen
** Mixer
** Audio Levels screen
** Audio Levels
* '''CTRL/PRESET'''
* '''CTRL/PRESET'''
** Control screen
** Chain Control (Instrument)
** Presets/Banks screen
** Preset/Bank
* '''ZS3/SNAPSHOT'''
* '''ZS3/SNAPSHOT'''
** SubSnapShots management
** SubSnapShots (ZS3s)
** Snapshot management
** Snapshots
* '''METRONOME'''
* '''METRONOME'''
** Tempo screen / Tap-Tempo
** Tempo screen / Tap-Tempo
* '''PAD/STEP'''
* '''PAD/STEP'''
** ZynPad screen
** Scene (ZynPad)
** Pattern editor
** Pattern
** Arranger => Keep pressed to open!
Some buttons have a tertiary function assigned to long-push:
Some buttons have a tertiary function assigned to long-push:
* '''OPT/ADMIN''' => Long-push to power off!
* '''OPT/ADMIN''' => Long-push to power off.
* '''CTRL/PRESET''' => Long-push to enter/leave preset favorites
* '''CTRL/PRESET''' => Long-push to enter/leave preset favorites
* '''PAD/STEP''' => Long-push to access arranger screen
* '''PAD/STEP''' => Long-push to access Arranger
<br clear=all>
<br clear=all>
===<span style="color:#D000D0;">ALT button</span>===
===<span style="color:#D000D0;">ALT button</span>===
[[File:v5_buttons_outlined-4.png|400px|right]]
[[File:v5_buttons_outlined-4.png|400px|right]]
* '''Knob#3'''
* '''Knob#3'''
** ''Rotate'' to move the cursor vertically in grids (zynpad, pattern editor, etc.).
** ''Rotate'' to move the cursor vertically in grids (zynpad, pattern editor, etc.).
<br>
{{NoteBox| MAIN Volume is allways available with one click, push MIX button and '''Knob#3''' rotate is used to change the MAIN volume.}}
<br clear=all>
<br clear=all>
===Chain control screen (Instrument)===
===Chain Control (Instrument)===
[[File:v5_mockup_control_01.png|800px|right]]
* '''Knob#1 - #4'''
* '''Knob#1 - #4'''
** ''rotate'' any knob for controlling the assigned parameters, same as the classic UI. This has not changed.
** ''rotate'' any knob to change the value of the assigned parameter, same as the classic UI. This has not changed.
** ''short-push'' any knob starts MIDI-learning for the associated parameter. Simply move the knob/fader in your MIDI controller and it will be bound.
** ''short-push'' any knob to start MIDI-learning for the associated parameter. Move a knob/fader in your MIDI controller end the learn. Push back to cancel.
** ''bold-push'' any knob opens the options menu for the associated parameter.
** ''bold-push'' any knob to open the options menu for the associated parameter.
<br>
<br>
{{NoteBox|For '''navigating the controller screens''' (select mode), you must '''push the SEL button'''. Bold-pushing knob#4 doesn't work anymore for this. }}
{{NoteBox|To '''navigate the controller screens''' (select mode), you must '''push the SEL button'''. Bold-pushing knob#4 doesn't work anymore for this. }}
<br clear=all>
<br clear=all>
===Mixer screen===
===Mixer===
[[File:v5_mockup_mixer_01.png|800px|right]]
* '''Knob#4'''
* '''Knob#4'''
* '''Knob#3'''
* '''Knob#3'''
** ''rotate'' to change the MAIN volume.
** ''rotate'' to change the MAIN volume.
** ''short-push'' / ''bold-push'' to open the Audio Mixer's MIDI learning menu.
** ''short-push'' / ''bold-push'' to open the Mixer's MIDI learning menu.
* '''Knob#2'''
* '''Knob#2'''
** ''rotate'' to change the pan / balance of the selected chain.
** ''rotate'' to change the pan / balance of the selected chain.
** ''rotate''' to change the volume of the selected chain.
** ''rotate''' to change the volume of the selected chain.
** ''short-push''' to solo the selected chain.
** ''short-push''' to solo the selected chain.
<br clear=all>
<br clear=all>
===Scene screen (ZynPad)===
===Scene (ZynPad)===
[[File:v5_mockup_zynpad_01.png|800px|right]]
* '''Knob#4'''
* '''Knob#4'''
* '''Knob#3'''
* '''Knob#3'''
** ''rotate'' to move cursor vertically.
** ''rotate'' to move cursor vertically.
** ''short-push'' to MIDI learn the current pad by pushing a note in your MIDI controller.
** ''short-push'' to MIDI-learn the current pad by pushing a note in your MIDI controller.
* '''Knob#2'''
* '''Knob#2'''
** ''rotate'' to change the scene.
** ''rotate'' to change the scene.
<br>
<br>
{{NoteBox|Before MIDI-learning pads, you have to select a trigger device. Push OPT to access the zynpad menu and choose your trigger device. Note that if the selected device is already supported (have a driver!), MIDI-learning is not needed at all and the device will be mapped automatically.}}
<br clear=all>
<br clear=all>
===Pattern screen===
===Pattern===
[[File:v5_mockup_pated_01.png|800px|right]]
* '''Knob#4'''
* '''Knob#4'''
** ''rotate'' to move cursor horizontally.
** ''rotate'' to move cursor horizontally.
** ''short-push'' to add/remove a note at cursor position.
** ''short-push'' to add/remove a note at cursor position.
** ''bold-push'' to edit note parameters: use knob#4 to select the parameter and knob#3 & knob#2 to change value (coarse & fine).
** ''bold-push'' to '''edit note parameters''':
*** rotate knob#4 to select the parameter to edit
**** duration
**** velocity
**** stutter count
**** stutter duration
*** rotate knob#3 to change coarse value.
*** rotate knob#2 to change fine value (when available).
*** short-push knob#4 to end editing
*** bold-push knob#4 again to enter EDIT ALL mode
* '''Knob#3'''
* '''Knob#3'''
** ''rotate'' to move cursor vertically.
** ''rotate'' to move cursor vertically.
* '''Knob#2'''
* '''Knob#2'''
** ''rotate'' to select the pattern to edit.
** ''rotate'' to change the pattern to edit.
* '''Knob#1'''
* '''Knob#1'''
** ''rotate'' to adjust tempo BPM.
** ''rotate'' to adjust tempo BPM.
<br>
{{NoteBox| Bold-push in an empty position to edit the default note parameters. These are the values used when adding new notes.}}
<br clear=all>
<br clear=all>
==Workflow==
==The UI Screens==
=== Mixer ===
[[File:Mixer.jpg|center]]
==Learning Pills==
===Basics===
===Basics===
* '''[https://zynthian.org/mockup/index.html?capture=Zynthian_V5:_Creating_a_synth_chain Creating a synth chain]'''
* '''[[Creating a synth chain and adding a MIDI chorder + audio FXs]]''' (tutorial)
* '''[https://zynthian.org/mockup/index.html?capture=Zynthian_V5:_Creating_another_synth_chain Creating another synth chain]'''
* '''[https://zynthian.org/mockup/index.html?capture=Zynthian_V5:_Creating_a_synth_chain Creating a synth chain]''' (workflow capture)
* '''[https://zynthian.org/mockup/index.html?capture=Zynthian_V5:_Audio_Mixer Audio Mixer]'''
* '''[https://zynthian.org/mockup/index.html?capture=Zynthian_V5:_Creating_another_synth_chain Creating another synth chain]''' (alternate workflow capture)
* '''[https://zynthian.org/mockup/index.html?capture=Zynthian_V5:_Audio_Mixer Audio Mixer]''' (workflow capture)
* '''Banks & Presets'''
* '''Banks & Presets'''
* '''Chain Control'''
* '''Chain Control'''