2,705
edits
Changes
Jump to navigation
Jump to search
Line 42:
Line 42: − + − + − + − + − + − + − + − + + + + + + + + + + + − + − + − + − + Line 68:
Line 78: − + − + − + − + − + − Line 114:
Line 123: − + Line 130:
Line 139: − + Line 137:
Line 146: − + Line 147:
Line 156: − + Line 156:
Line 165: − + − + Line 183:
Line 192: − + Line 191:
Line 200: − + − + − + Line 243:
Line 252: + Line 259:
Line 269: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Line 333:
Line 387: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Zynthian UI User Guide (oldstable-2109) (view source)
Revision as of 20:42, 14 November 2019
, 20:42, 14 November 2019→Key Bindings: Controlling the UI with a computer keyboard
On the top-right corner there is a small area where some useful information is displayed in real time:
On the top-right corner there is a small area where some useful information is displayed in real time:
* CPU-load => A small horizontal bar on the top right.
* Audio Peak-meter or CPU-load => 1 or 2 small horizontal bars on the top right.
* MIDI-IN => Green '''M''' flag
* MIDI-IN => Blue '''M''' flag
* Xrun => Red '''X''' flag
* Xrun => Red '''warning''' flag
* Under-voltage => Red '''V''' flag
* Under-voltage => Red '''ray''' flag
* Over-temperature => Red '''T''' flag
* Over-temperature => Red '''thermometer''' flag
* Recording Audio => Red '''R''' flag
* Recording Audio => Red '''circle''' flag
* Playing Audio => Red '''>''' flag
* Playing Audio => Green '''play''' flag
The CPU-load bar shows the CPU usage as calculated by the Jack Audio Server:
By default, Audio Peak-meter is shown. The meter covers the range -50dBFS to 0dBFS, i.e. maximum permissible level at full scale (far right) down to 50dB below that at 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 could be 200 ms delay in peak being displayed.
Alternately, CPU-load bar can be enabled from webconf, replacing the Audio Peak-meter. The CPU-load bar shows the CPU usage as calculated by the Jack Audio Server:
This is a running average of the time it takes to execute a full process cycle for all clients as a percentage of the real time available per cycle determined by the buffer size and sample rate.
This is a running average of the time it takes to execute a full process cycle for all clients as a percentage of the real time available per cycle determined by the buffer size and sample rate.
The green M flag is shown when MIDI messages pass thru the MIDI router. Not all messages are detected. Only CC, Program Change and Note On/Off.
The blue M flag is shown when MIDI messages pass thru the MIDI router. Not all messages are detected. Only CC, Program Change and Note On/Off.
The red X flag is shown when there are Xruns. You should hear clicks and pops too ;-)
The red "warning" flag is shown when there are Xruns. You should hear clicks and pops too ;-)
When the red V or T flag is shown, your 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 any of them and if you do so, you should consider looking for a better power source (under-voltage) or using a heat sink (over-temperature).
When the red "ray" or "thermometer" flag is shown, your 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 any of them and if you do so, you should consider looking for a better power source (under-voltage) or using a heat sink (over-temperature).
Finally, the red '''R''' and '''>''' flags show the status of audio capture: recording/playing
Finally, the red '''circle''' and '''play''' flags show the status of audio/MIDI capture: recording / playing
=Layers=
=Layers=
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, 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:
* 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 some 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 normally are FX units that process the audio coming-out from the first unit (root).
All units in a layer receive all the MIDI events coming from the assigned channel. Special layers 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.
=The Zynthian UI Workflow=
=The Zynthian UI Workflow=
* '''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. [[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 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]].
<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, whats allows processing the audio in any way you imagine. You can use this feature for creating your own customized/bizarre FX chains.
* '''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. ;-)
* '''MIDI chan''' => change the MIDI Channel assigned.
* '''MIDI chan''' => change the MIDI Channel assigned.
* '''Remove Layer''' => Remove the layer.
* '''Remove Layer''' => Remove the layer.
* '''Remove All Effects''' => Clean the FX-chain, deleting all the effects.
* '''Remove All Effects''' => Clean the FX-chain, deleting all the effects.
* '''Effect List''' => The list of effects in the layer's FX-chain. By bold-clicking on an effect, you will access the Effect's Options:
* '''Effect List''' => The list of effects in the layer's FX-chain. By bold-clicking on an effect and you will access the Effect's Options:
** '''Effect Presets'''
** '''Effect Presets'''
** '''Move Upchain'''
** '''Move Upchain'''
==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 click on the list,
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,
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.
* '''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. Ask in the forum ;-)
* '''MOD-UI''': Only one layer is allowed to be created and it's assigned to 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.)
* '''PureData''': Only one layer is allowed to be created and it's assigned to ALL MIDI channels. If you want to filter the messages by channel, you can do it within the PD patch. (There are plans for improving this behavior.)
* '''PureData''': Only one layer of this type is allowed, but it can be assigned to a MIDI channel.
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 loaded again in case you pre-loaded some preset.
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.
<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 synth parameters displayed in the squares 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 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.
<br clear=all>
<br clear=all>
[[File:Zynthian_ui_instrument_control_02.png|400px|right]]
[[File:Zynthian_ui_instrument_control_02.png|400px|right]]
The central list shows the different pages of parameters that you may alter. You can navigate the page of parameters by clicking short-Select to step by one page.
The central list shows the different pages of parameters that you may alter. You can navigate the page of parameters by clicking short-select to step by one page.
<br clear=all>
<br clear=all>
[[File:Zynthian_ui_instrument_control_03.png|400px|right]]
[[File:Zynthian_ui_instrument_control_03.png|400px|right]]
If the page list is long, you can "bold click" the Select switch to navigate the list using the Select knob.
If the page list is long, you can "bold click" the ''select'' switch to navigate the list using the ''select'' knob.
<br clear=all>
<br clear=all>
==Admin Menu==
==Admin Menu==
[[File:Zynthian_ui_admin.png|400px|right]]
[[File:Zynthian_ui_admin.png|400px|right]]
[[File:Zynthian_ui_admin_02.png|400px|right]]
Pressing the Back knob, when you are in the Layer List screen, brings you to the Admin menu.
Pressing the Back knob, when you are in the Layer List screen, brings you to the Admin menu.
* Reboot
* Reboot
* Power Off
* Power Off
<br clear=all>
==Audio & MIDI Recording==
[[File:zynthian_audio_recorder_01.png|400px|right]]
[[File:zynthian_audio_recorder_02.png|400px|right]]
[[File:zynthian_audio_recorder_03.png|400px|right]]
[[File:zynthian_audio_recorder_04.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.
'''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.
===Recording===
1. Press "Start Recording" for starting a new capture.
2. The red circle should appear in the top-right status area, indicating that a recording is going on.
3. Press "Stop Recording" for finishing the capture. The red circle will disappear and the recorded file will be added to the list. The filename is generated automatically and should be something like "jack_capture_01". The prefix "SDC" or "USB" indicates where the file is stored.
===Playing===
You can play files by simply selecting and clicking the file. The "play" symbol will be displayed in the UI status area.
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.
===Deleting===
A bold press will delete the selected file, but you will be asked to confirm the action.
===Managing recordings from your computer===
Audio & MIDI recordings can be managed from your computer by accessing the webconf's captures section. From this section you can:
* rename recordings
* delete recordings
* downloading recordings to your computer
* reproduce the audio recordings in your browser, if it supports wav file playing.
It is a good idea to rename your recordings so that they can be easily identified.
[[File:Zynthian_webconf_captures_01.png|600px|border|left]]
<br clear=all>
<br clear=all>
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, then the number will change.
<br clear=all>
<br clear=all>
=CUIA: Callable UI Actions=
The Zynthian UI can be controlled remotely using a set of commands called CUIA: Callable UI Actions. These CUIA are available on several interfaces: Key Bindings, MIDI, OSC, etc.
==Key Bindings: Controlling the UI with a computer keyboard==
The user interface may be driven using a USB keyboard, e.g. QWERTY, Dvorak, etc.
{| class="wikitable"
|-
!Key
!Modifier
!Function
|-
|Enter||None||SELECT
|-
|Enter||Shift||Bold SELECT
|-
|Enter||Ctrl||Long SELECT
|-
|Backspace||None||BACK
|-
|Backspace||Shift||Bold BACK
|-
|Backspace||Ctrl||Long BACK
|-
|Escape||None||BACK
|-
|Escape||Shift||Bold BACK
|-
|Escape||Ctrl||Long BACK
|-
|L||None||LAYER
|-
|L||Shift||Bold LAYER
|-
|L||Ctrl||Long LAYER
|-
|S||None||SNAPSHOT
|-
|S||Shift||Bold SNAPSHOT
|-
|S||Ctrl||Long SNAPSHOT
|-
|A||None||Start audio Record
|-
|A||Shift||Stop audio Record
|-
|A||Alt||Toggle audio Record
|-
|A||Ctrl||Start audio Play
|-
|A||Ctrl+Shift||Stop audio Play
|-
|M||None||Start MIDI Record
|-
|M||Shift||Stop MIDI Record
|-
|M||Ctrl||Start MIDI Play
|-
|M||Ctrl+Shift||Stop MIDI Play
|-
|Space||None||All Notes Off
|-
|Space||Shift||All Sounds Off
|-
|Space||Ctrl||All off
|-
|Home||Shift||Restart UI
|-
|Insert||Ctrl||Reload MIDI Config
|-
|Home||Ctrl||Reboot
|-
|End||Ctrl||Power Off
|-
|Up||None||Listbox Up
|-
|Down||None||Listbox Down
|-
|Left||None||BACK
|-
|Right||None||SELECT
|}
==Controlling the UI with MIDI messages==
These actions are available using MIDI messages on the Master Channel (default 16, but configurable with the webconf tool), specifically, note-on messages (0x9) are used so you can use a MIDI keyboard for controlling the Zynthian UI. For instance, to Power Off the zynthian, you send this message:
0x9F (Channel 16 Note ON)
0x00 (Note code for POWER_OFF as below)
0x00 (Velocity/parameter)
or play the C-1 key, if your keyboard has it ;-)
This is the full list:
'''Num''' '''CUIA''' '''Note''' '''System'''
0 POWER_OFF C-1
1 REBOOT C#-1
2 RESTART_UI D-1
3 RELOAD_MIDI_CONFIG D#-1
10 ALL_NOTES_OFF A#-1
11 ALL_SOUNDS_OFF B-1
12 ALL_OFF C0
23 TOGGLE_AUDIO_RECORD B1
24 START_AUDIO_RECORD C1
25 STOP_AUDIO_RECORD C#1
26 START_AUDIO_PLAY D1
27 STOP_AUDIO_PLAY D#1
35 TOGGLE_MIDI_RECORD B2
36 START_MIDI_RECORD C2
37 STOP_MIDI_RECORD C#2
38 START_MIDI_PLAY D2 Start/Continue: 0xFA, 0xFB
39 STOP_MIDI_PLAY D#2 Stop: 0xFC
51 SELECT D#3/Eb3
52 SELECT_UP E3
53 SELECT_DOWN F3
64 SWITCH_BACK_SHORT E4
63 SWITCH_BACK_BOLD D#4/Eb4
62 SWITCH_BACK_LONG D4
65 SWITCH_SELECT_SHORT F4
66 SWITCH_SELECT_BOLD F#4/Gb4
67 SWITCH_SELECT_LONG G4
60 SWITCH_LAYER_SHORT C4
61 SWITCH_LAYER_BOLD C#4/Db4
59 SWITCH_LAYER_LONG B4
71 SWITCH_SNAPSHOT_SHORT B5
72 SWITCH_SNAPSHOT_BOLD C5
73 SWITCH_SNAPSHOT_LONG C#5/Db5
[[File:2Oct_Keyboard_CUIA.png|600px|Keyboard]]
[[File:Midi-note-chart.jpg]]