2,705
edits
Changes
Jump to navigation
Jump to search
Line 1:
Line 1: − + Line 8:
Line 8: − + − # '''Selector Screen''': a list of items that you can scroll and select with the SELECT (4) knob+ − # '''Controller Screen''': In the corners, 4 control widgets (one for each knob), with label and value indicator (graphic and numeric). In the middle, a list of controller maps which you can use to change or rotate using the SELECT (4) knob.+ + + + + + + + + − And there are 3 types of clicks (push) that can be performed, depending on how long you hold down the knob: Line 20:
Line 27: − Loading and Saving snapshots: If you click SNAPSHOT (3) once, you get the Load Snapshot menu, another click and you will be in the Save Snapshot menu. If you bold-click SNAPSHOT then you will go directly to the Save Snapshot menu. The Snapshot menu have 2 levels: bank selection (directory) and snapshot (file).+ + + + + + + Line 32:
Line 45: + − + − Most of actions depends on context (the current menu screen), but there are some actions that are global and will work from any menu screen:+ + + − * '''long-back''': go to the admin menu+ − + + + + − Snapshot actions are also global an will work from any point in the workflow. These actions are explained below.+ − ==Layer List==+ − + − This is the first screen you see when you power on and no screenshots are stored yet. A layer is a synth engine preset assigned to one (or all) MIDI Channel. Choose New Layer to get started.+ − <br clear=all>+ + + + + − [[File:Zynthian_ui_layer_list.png|400px|right]] − You can create up to 16 layers. Several layers can be assigned to the same MIDI Channel. Line 57:
Line 78: − + − + − + − + + Line 66:
Line 88: + + + + + + + + + Line 82:
Line 113: − + + + + Line 88:
Line 122: + + − + − Turning each of the 4 knobs change the values of the synth parameters displayed in the squares at the sides of the screen. The list in the center of the screen allows you to choose the page of parameters. You can step one page by clicking select. Line 134:
Line 169: − +
Zynthian UI User Guide (oldstable-2109) (view source)
Revision as of 18:07, 21 March 2018
, 18:07, 21 March 2018→Layer List
=The Zynthian's Hardware User Interface=
=The Zynthian's Hardware User Interface=
[[File:zynthian_controllers.png|400px|right]]
[[File:zynthian_controllers.png|430px|right]]
[[File:zynthian_ui_workflow_1.png|400px|thumb]]
[[File:zynthian_ui_workflow_1.png|400px|thumb]]
[[File:zynthian_ui_workflow_2.png|400px|thumb]]
[[File:zynthian_ui_workflow_2.png|400px|thumb]]
The encoders/switch knobs are used to navigate between the different screens/menus, select options and change the instrument parameters, acting as MIDI/OSC controllers.
The encoders/switch knobs are used to navigate between the different screens/menus, select options and change the instrument parameters, acting as MIDI/OSC controllers.
Currently there are two screen types (layouts):
Currently there are two main screen types (layouts):
* '''Selector Screen''': a list of items that you can scroll and select with the SELECT (4) knob
* '''Controller Screen''': In the corners, 4 control widgets (one for each knob), with label and value indicator (graphic and numeric). In the middle, a list of controller maps which you can use to change or rotate using the SELECT (4) knob.
Almost every Zynthian UI screen fits in one of these 2 types, however, other screen types does exist:
* '''XY Controller Screen''': It allows to modify 2 parameters at once using the touch interface.
* '''Info''': It display info about some operation, like "Update Software", or "Network Info"
* '''Sequencer''': It's a planned feature not implemented yet ;-)
There are 3 types of clicks (push) that can be performed, depending on how long you hold down the knob:
* '''short:''' less than 0.3 seconds
* '''short:''' less than 0.3 seconds
* '''bold:''' between 0.3 and 2 seconds
* '''bold:''' between 0.3 and 2 seconds
Actions for each knob and click type are context dependent. Generally, the SELECT knob and a short click is used to navigate and select items on a "Selector Screen". Inside a "Controller Screen", short clicks can be used to rotate between layers (LAYER) or between controller pages (SELECT). "Bold" clicks are intended as shortcuts for jumping to some specific screens. Clicking the BACK knob generally jumps to the previous screen in the sequence.
Actions for each knob and click type are context dependent. Generally, the SELECT knob and a short click is used to navigate and select items on a "Selector Screen". Inside a "Controller Screen", short clicks can be used to rotate between layers (LAYER) or between controller pages (SELECT). "Bold" clicks are intended as shortcuts for jumping to some specific screens. Clicking the BACK knob generally jumps to the previous screen in the sequence.
Most of actions depends on context (the current screen), but there are some actions that are global and will work from any menu screen:
* '''long-back''': go to the admin menu
* '''long-select''': power off
Snapshot actions are also global an will work from any point in the workflow. If you click SNAPSHOT (3) once, you get the Load Snapshot menu, another click and you will be in the Save Snapshot menu. If you bold-click SNAPSHOT then you will go directly to the Save Snapshot screen. The Snapshot screen have 2 levels: bank selection (directory) and snapshot (file). These actions are better explained below.
=The Zynthian UI Workflow=
=The Zynthian UI Workflow=
- [https://docs.google.com/drawings/d/1Um1HVCvvb4gZF_X-vcIN9cTxYIBRCtZ5oxniUdSTB3c/edit?usp=sharing Aux. Sequences: zynthian_ui_workflow_2]
- [https://docs.google.com/drawings/d/1Um1HVCvvb4gZF_X-vcIN9cTxYIBRCtZ5oxniUdSTB3c/edit?usp=sharing Aux. Sequences: zynthian_ui_workflow_2]
<br clear=all>
=The UI Menus=
=The UI Screens=
==Layer List==
[[File:Zynthian_ui_new_layer.png|400px|right]]
This is the first screen you see when you power on and no screenshots are stored yet. A layer is a synth engine preset assigned to one (or all) MIDI Channel. Choose New Layer to get started.
There are 4 options in this screen:
* '''long-select''': power off
* '''New Layer''' => Create a new Layer
* '''Remove All Layers''' => Remove all layers, returning to the initial state.
* '''All Notes Off''' => All notes are released (note-off) by sending CC#123 to all channels.
* '''All Sounds Off''' => All sounds are stopped abruptly by sending CC#120 to all channels.
The 2 last options (All Notes/Sounds Off) can be triggered by short-clicking CTRL-1 (layer) from the layer screen (contextual actions). In such a way you can trigger the actions from any point in the workflow by simply clicking twice CTRL-1.
<br clear=all>
<br clear=all>
[[File:Zynthian_ui_layer_list.png|400px|right]]
[[File:Zynthian_ui_new_layer.png|400px|right]]
You can create up to 16 layers. Several layers can be assigned to the same MIDI Channel, but when you do so, these layers are MIDI-bond because it receive the same MIDI messages. This can be a problem when trying to adjust volume (CC#7) or other parameters assigned to standard MIDI CCs. There are plans to make layers receive separated MIDI data-flows, but it's not implemented yet.
Some engines have special behavior regarding layers and MIDI channels:
+ '''setBfree''': it ALWAYS creates 3 layers assigned to several MIDI channels (1, 2 & 3), each corresponding to the upper, lower and pedals sections of the Hammond B3 emmulation.
+ '''Pianoteq Stage''': Only one layer is allowed to be created, assigned to the MIDI channel you like.
+ '''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 inside the MOD-UI patch. There are plans for improving this behavior.
<br clear=all>
<br clear=all>
If you bold-press the select switch, the "Layer Options" menu will be opened for the selected layer. This menu allows to:
If you bold-press the select switch, the "Layer Options" menu will be opened for the selected layer. This menu allows to:
* change the assigned MIDI Channel
* '''MIDI chan''' => change the assigned MIDI Channel
* transpose the layer up and down, by semitones.
* '''Transpose''' => transpose the layer up and down, by semitones.
* route the layer's engine audio output to MOD-UI audio input, for audio processing
* '''Audio => MOD-UI''' => route ''the layer's engine audio output'' to MOD-UI audio input, allowing post-processing the audio with it
* delete the layer
* '''Remove Layer''' => Remove the layer
<br clear=all>
<br clear=all>
[[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 the engine synth you want to use for the new layer. You will see the list of synth engines to choose from. The zynthian logo on the right is animated while engine is being loaded.
When you create a new layer, you are asked about the engine synth you want to use for the new layer. You will see the list of synth engines to choose from. The zynthian logo on the right is animated while engine is being loaded.
Some engines have special behavior regarding layers and MIDI channels:
* '''setBfree''': It alwais creates 3 layers assigned to several MIDI channels (1, 2 & 3), each one corresponding to the upper, lower and pedals sections of the Hammond B3 emmulation.
* '''Pianoteq Stage''': Only one layer is allowed to be created, assigned to the MIDI channel you like.
* '''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 inside the MOD-UI patch. There are plans for improving this behavior.
<br clear=all>
<br clear=all>
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, 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 "pre-load on note-on" feature is enabled, you can pre-load the presets by playing notes. The highlighted preset will be pre-loaded before select.
If the "pre-load on note-on" feature is enabled, you can pre-load 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.
<br clear=all>
<br clear=all>
[[File:Zynthian_ui_instrument_control_01.png|400px|right]]
[[File:Zynthian_ui_instrument_control_01.png|400px|right]]
This screen is shown after you have chosen a preset. Your instrument is now playable and you can modify the parameters.
This screen is shown after you have chosen a preset. Your instrument is now playable and you can modify the parameters.
Turning each of the 4 knobs change the values of the synth parameters displayed in the squares at the sides of the screen. You also can use the touch interface for changing 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. You can navigate the page of parameters by clicking short-select to step one page.
<br clear=all>
<br clear=all>
You can "emulate" the switches by tapping the controller widgets (squares in the 4 corners of a Controller screen). There are short, bold and long actions. Exactly the same workflow as with hardware knobs. When the "back" widget is not available, you can go back by tapping the top bar.
You can "emulate" the switches by tapping the controller widgets (squares in the 4 corners of a Controller screen). There are short, bold and long actions. Exactly the same workflow as with hardware knobs. When the "back" widget is not available, you can go back by tapping the top bar.
You can change the values of the controllers by "sliding" over the widgets. This is the same as turning the knob.
You can change the values of the controllers by "sliding" over the widgets. This is the same as turning the knob. If you are using a mouse, the mouse wheel also modifies the parameter.
When clicking (tapping/touching) the topbar, a "back" event is triggered. It's a quick & dirty fix and probably it will change in the future, but meanwhile it will enable you to fully control Zynthian using the touchscreen if you don't have knob hardware.
When clicking (tapping/touching) the topbar, a "back" event is triggered. It's a quick & dirty fix and probably it will change in the future, but meanwhile it will enable you to fully control Zynthian using the touchscreen if you don't have knob hardware.