2,705
edits
Changes
Jump to navigation
Jump to search
Line 19:
Line 19: + Line 33:
Line 34: − + Line 43:
Line 44: − + Line 53:
Line 54: − + Line 109:
Line 110: + + + + + + + + + + + + + − The main (home) screen is the Mixer. This consists of several vertical strips, each representing a chain. The last one at right, labeled as '''main''', is the mixbus audio output chain.+ − Navigation between views is performed by pressing buttons or using the touchscreen.+ − Navigation, default actions and common workflows are shown in the following graphs:+ − <gallery mode="slideshow" widths="420" heights="600"> − Image:Main Views.png|''[[commons:Main Views|Main Views]]'' − Image:Add chain workflow.png|''[[commons:Add Chain|Add Chain]]'' − Image:Snapshot workflow.png|''[[commons:Manage Snapshots|Manage Snapshots]]'' − </gallery> − Most destructive changes, e.g. removing chains will request confirmation. Operations that take time to complete may show an animated Zynthian logo representing progress.+ − + Line 132:
Line 141: + + + + + + + + + + + + + + + + + Line 139:
Line 165: − + Line 154:
Line 180: − + − + − + − + − + − + − + − + − + − + − + − + Line 180:
Line 206: − + Line 209:
Line 235: − + − + Line 219:
Line 245: − + − You can access an engine's banks by short press BACK from within its presets list.+ − Bold press SELECT or touch and hold a bank on the touchscreen will show the Bank Options menu. A bank may be renamed or deleted. Some engines do not allow banks to be manipulated in which case this will have no effect.+ − − − + − + − + − + − + − + Line 249:
Line 273: − + Line 256:
Line 280: − + Line 270:
Line 294: − Bold press SELECT when in the Mixer View or Control View will show the Chain Options menu. Manipulation of the chain is possible:+ Line 294:
Line 318: − Short press SELECT or tapping on an effect in the list will allow manipulation of the effect:+ Line 390:
Line 414: − + − − '''Technical Note:''' MIDI-CC learning works with all engines. It uses the engine’s native MIDI-learning capabilities if available otherwise Zynthian’s MIDI-filter mappings are used. To be more explicit, native MIDI-learning is used for MOD-UI and ZynAddSubFX OSC parameters. All the other parameters are managed by Zynthian’s MIDI-filter mapping. Line 398:
Line 420: − + − − ZS3s may be loaded by MIDI Program Change. Line 458:
Line 478: − Line 724:
Line 743: + Line 743:
Line 763: + + + + + + + + + + + + Line 750:
Line 782: − + − + Line 763:
Line 795: − 59 SWITCH_LAYER_LONG B3 + Line 773:
Line 805: − 84 SCREEN_CONTROL C6 − + + + + + + + Line 784:
Line 821: + + + + +
Zynthian UI User Guide - V1/V4 (view source)
Revision as of 01:06, 8 January 2023
, 01:06, 8 January 2023Update MIDI CUIA table to be synced with latest stable
* '''Info Screen''': It displays info about an operation, like "Update Software", or "Network Info".
* '''Info Screen''': It displays info about an operation, like "Update Software", or "Network Info".
* '''Key Range & Transpose Screen''': It allows to choose the key range and transpose notes by octaves or semitones.
* '''Key Range & Transpose Screen''': It allows to choose the key range and transpose notes by octaves or semitones.
* '''Mixer''': The main screen from you manage the chains.
* etc.
* etc.
Although some push actions depend of context (current screen), there are some actions that are global and will work from any screen:
Although some push actions depend of context (current screen), there are some actions that are global and will work from any screen:
* '''Bold-Back''': Audio Mixer
* '''Bold-Back''': Mixer
* '''Long-Layer''': Step Sequencer
* '''Long-Layer''': Step Sequencer
* '''Long-Back''': Admin Menu
* '''Long-Back''': Admin Menu
<br clear=all>
<br clear=all>
=The Title Bar=
==The Title Bar==
[[File:zynthian_ui_control_status.png|400px|right]]
[[File:zynthian_ui_control_status.png|400px|right]]
<br clear=all>
<br clear=all>
=The Status Area=
==The Status Area==
[[File:Status display.png|400px|right]]
[[File:Status display.png|400px|right]]
[[File:Zynthian Signal Flow.png|800px|center]]
[[File:Zynthian Signal Flow.png|800px|center]]
<br clear=all>
<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
* '''Audio Chain''' => Receives audio-input and generates audio-output
* '''MIDI Chain''' => Receives MIDI-input and generates MIDI-output
* '''Generator Chain''' => Generate audio output using an algorithm
* '''Special Chain''' => Does not fit any other chain type, e.g. MOD-UI pedalboard, Pure Data patch, etc.
The chain's type can't be changed. Depending of the chain's type, MIDI effects can be added to the start of the chain and audio effects can be added to the end of the chain. These can be arranged as serial or parallel paths.
All audio effects in a chain receive all the MIDI events on the assigned channel (this should be improved!).
When you select '''NEW Chain''', you create a new chain, choosing its root engine, a free MIDI channel and if available, bank & preset. You can create up to 16<sup>*</sup> chains, one per MIDI channel.
(*) If Master Channel is enabled then only 15 chains can be created.
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>
<br clear=all>
==Stage and Multitimbral Modes==
===Stage and Multitimbral Modes===
By default Zynthian starts in '''stage mode'''. Stage mode is a kind of ''Omni-On'' mode, what means all MIDI messages are sent to the selected chain in your zynthian. You don't need to worry about the MIDI channel your keyboard/controller is using. You can change the instrument you play by selecting it in your zynthian or using ZS3's Programs Change feature (see below).
By default Zynthian starts in '''stage mode'''. Stage mode is a kind of ''Omni-On'' mode, what means all MIDI messages are sent to the selected chain in your zynthian. You don't need to worry about the MIDI channel your keyboard/controller is using. You can change the instrument you play by selecting it in your zynthian or using ZS3's Programs Change feature (see below).
(*) MIDI Continuous Controllers are handled differently. See section on [[#MIDI-learning_.2F_binding|MIDI Learning & binding]].
(*) MIDI Continuous Controllers are handled differently. See section on [[#MIDI-learning_.2F_binding|MIDI Learning & binding]].
<br clear=all>
===Navigation===
The home screen is the Mixer and it's always reachable by pressing bold-Back. Navigation between views is performed by pressing buttons or using the touchscreen. Most destructive changes, e.g. removing chains, will request confirmation. Operations that take time to complete may show an animated zynthian logo representing progress.
Navigation, default actions and common workflows are shown in the following graphs:
<gallery mode="packed" heights="800">
Image:Main Views.png|''[[#The_UI_Screens|Main Views]]''
</gallery>
<gallery mode="packed" heights="1400">
Image:Add chain workflow.png|''[[#Main_Menu|Add Chain]]''
Image:Snapshot workflow.png|''[[#Load_.2F_Save_Snapshot|Manage Snapshots]]''
</gallery>
<br clear=all>
=The UI Screens=
=The UI Screens=
[[File:Audio mixer.png|400px|right]]
[[File:Audio mixer.png|400px|right]]
The mixer view is the main screen and pressing '''bold-BACK''' should always navigate to this screen. It displays a strip for each configured chain plus a strip for the main mixbus. The quantity of strips displayed may be configured using webconf. If there are more chains than can be displayed, the screen can be scrolled horizontally by selecting a higher / lower chain or dragging the bottom legend strip.
The mixer view is the home screen and pressing '''bold-BACK''' should always navigate to this screen. It displays a strip for each configured chain plus a strip for the main mixbus. The quantity of strips displayed may be configured using webconf. If there are more chains than can be displayed, the screen can be scrolled horizontally by selecting a higher / lower chain or dragging the bottom legend strip.
===Audio Chains===
===Audio Chains===
===MIDI Chains===
===MIDI Chains===
MIDI only (non-audio) chains show in the mixer view without any audio mixer controls.
MIDI only (non-audio) chains show in the mixer view without any audio mixer controls nor meter.
===Contextual Actions===
===Contextual Actions===
* Rotate the SELECT knob or tap on a strip to select a chain.
* Rotate '''SELECT knob''' or tap on a strip to select a chain.
* Rotate the LAYER knob or drag the touchscreen to adjust the selected chain's fader.
* Rotate '''LAYER knob''' or drag the touchscreen to adjust the selected chain's fader.
* Rotate the BACK knob to adjust the selected chain's balance / pan.
* Rotate '''BACK knob''' to adjust the selected chain's balance / pan.
* Rotate the LEARN/SHOT knob or drag the touchscreen to adjust the main mixbus fader.
* Rotate '''LEARN/SHOT knob''' or drag the touchscreen to adjust the main mixbus fader.
* Press short-LAYER to toggle solo of the selected chain.
* Press '''short-LAYER''' to toggle solo of the selected chain.
* Press short-BACK to toggle mute of the selected chain.
* Press '''short-BACK''' to toggle mute of the selected chain.
* Press short-LEARN/SHOT to enter MIDI learn mode.
* Press '''short-LEARN/SHOT''' to enter MIDI learn mode.
* Press short-SELECT to access the chain's Control View.
* Press '''short-SELECT''' to access the chain's Control View.
* Press bold-LAYER to access the main menu.
* Press '''bold-LAYER''' to access the main menu.
* Press bold-LEARN/SHOT to access snapshots.
* Press '''bold-LEARN/SHOT''' to access snapshots.
* Press bold-SELECT to access the selected chain's options.
* Press '''bold-SELECT''' to access the selected chain's options.
==Main Menu==
==Main Menu==
* '''New Generator Chain''' adds an audio generator chain
* '''New Generator Chain''' adds an audio generator chain
* '''New Special Chain''' adds a non-standard or special chain
* '''New Special Chain''' adds a non-standard or special chain
* '''Snapshots''' manipulate snapshots
* '''Snapshots''' manage snapshots
* '''Sequencer''' access the step sequencer
* '''Sequencer''' access the step sequencer
* '''MIDI Recorder''' access the standard MIDI file recorder / player
* '''MIDI Recorder''' access the standard MIDI file recorder / player
This screen is shown in various contexts:
This screen is shown in various contexts:
* After you have selected the engine for a new chain. Only unused channels are listed.
* When creating a new chain, after you have selected the engine. Only unused channels are listed.
* When you change the assigned MIDI channel from the Chain Options menu. Only unused channels are listed.
* When you change the assigned MIDI channel from the Chain Options menu. Only unused channels are listed.
* When you clone MIDI for a chain from the Chain Options menu.
* When you clone MIDI for a chain, from the Chain Options menu.
Playing a note on a connected MIDI controller will cause the list to jump to the MIDI channel of the note played. This can assist with assigning chains to controllers.
Playing a note on a connected MIDI controller will cause the list to jump to the MIDI channel of the note played. This can assist with assigning chains to controllers.
== Bank selector==
== Bank selector==
[[File:Zynthian_ui_bank_list.png|400px|right]]
[[File:Zynthian_ui_bank_list.png|400px|right]]
Presets (instruments, patches, sound designs, etc.) for engines may be organized into banks. Choose a bank to see the list of presets for the engine.
Presets (instruments, patches, sound designs, etc.) for engines may be organized into banks. You can access engine's bank list by pressing '''short-BACK''' from within its presets list. Choose ('''short-SELECT''') a bank to see the list of presets on it.
<br clear=all>
<br clear=all>
'''Bold-SELECT''' or touch and hold a bank on the touchscreen will show the '''Bank Options menu'''. User banks may be renamed or deleted. Some engines do not allow banks to be manipulated in which case this will have no effect.
'''Short-BACK''' to return to the Control View without selecting.
Short press BACK to return to the Control View without changing the engine's configuration.
<br clear=all>
<br clear=all>
==Preset selector==
==Preset selector==
[[File:Zynthian_ui_preset_list.png|400px|right]]
[[File:Zynthian_ui_preset_list.png|400px|right]]
Once you have chosen a bank, the preset screen will be shown. Choose a preset to load the instrument / sound / patch and the Control View will be shown.
Once you have chosen a bank, the preset screen will be shown. Choose a preset to load the instrument / sound / patch / etc. and the Control View will be shown.
<br clear=all>
<br clear=all>
To change preset of an existing engine, navigate to its Control View then short press BACK to access the list of presets. Use the SELECT encoder to highlight the required preset and short press SELECT or tap on the required preset in the list on the touchscreen to select the preset. The engine will configure with the preset values and the Control View will be displayed.
To change the selected preset for a engine in a chain, navigate to its Control View then short press BACK to access the list of presets. Use the SELECT encoder to highlight the required preset and '''short-SELECT''' (or tap, if using touchscreen) to select the preset. The engine will configure with the preset values and the Control View will be displayed.
Bold press SELECT or touch and hold a preset on the touchscreen will show the Preset Options menu. A preset may be added to or removed from a list of favorites, renamed or deleted. Some engines do not allow presets to be manipulated and will only show the Favourite option. (Saving presets is performed in the chain options menu described later.)
'''Bold-SELECT''' a preset (or touch and hold on the touchscreen) will show the '''Preset Options menu'''. A preset may be added to or removed from a list of favorites, renamed or deleted. Some engines do not allow presets to be manipulated and will only show the Favourite option. (Saving presets is performed in the chain options menu described later.)
If the '''preload with note-on''' feature is enabled in the admin menu or webconf, you can audition the presets by playing notes. When you do so, the highlighted preset will be pre-loaded without pressing SELECT. N.B. Some engines may be slow to load presets in which case it may be necessary to play the note more than once to hear the new preset sound.
If the '''preload with note-on''' feature is enabled in the admin menu or webconf, you can audition the presets by playing notes. When you do so, the highlighted preset will be pre-loaded without pressing SELECT. Note that some engines may be slow to load presets in which case it may be necessary to play the note more than once to hear the new preset sound.
You can return to the bank screen, without selecting any preset, by short press BACK. The previously selected instrument will be restored, e.g. if a preset has been pre-loaded (auditioned).
You can return to the bank screen, without selecting any preset, by pressing '''short-BACK'''. The previously selected instrument will be restored, e.g. if a preset has been pre-loaded (auditioned).
Press bold SELECT to manipulate the preset including adding to your favorites. The favorites list can be shown by short press LEARN/SHOT in the Bank or Preset View.
Press '''bold-SELECT''' to manage the preset including adding to your favorites. The favorites list can be shown by pressing '''short-LEARN/SHOT''' in the Bank or Preset View.
Not all engines support presets. If no presets are configured then this screen is not shown.
Not all engines support presets. If no presets are configured then this screen is not shown.
==Control View==
==Control View==
[[File:Zynthian_ui_instrument_control_01.png|400px|right]]
[[File:Zynthian_ui_instrument_control_01.png|400px|right]]
The Control View shows the controls available for each engine within a chain. It is shown after adding a chain, adding an engine to a chain or by short press SELECT or tapping the bottom legend strip in the mixer view. Your instrument is now enabled and playable and you can modify its parameters.
The Control View shows the controls available for each engine within a chain. It is shown after adding a chain, adding an engine to a chain or by pressing '''short-SELECT''' (or tapping the bottom legend strip in the mixer view). Your instrument is now enabled and playable and you can modify its parameters.
The controls are shown in groups of four (or fewer) on several pages. Each hardware knob controls a parameter displayed in the control view or the control may be dragged up and down on the touchscreen. Controls may toggle between two values, e.g. on / off, lists of values, e.g. sine, square, triangle or continuously adjustable values, e.g. 0%..100%. If there are a lot of possible values the hardware knobs will accelerate progress if rotated fast, e.g. stepping by one value when turned slowly and stepping by 10 values when rotated fast. This allows fine and coarse selection of a parameter from a single knob.
The controls are shown in groups of four (or fewer) on several pages. Each hardware knob controls a parameter displayed in the control view or the control may be dragged up and down on the touchscreen. Controls may toggle between two values, e.g. on / off, lists of values, e.g. sine, square, triangle or continuously adjustable values, e.g. 0%..100%. If there are a lot of possible values the hardware knobs will accelerate progress if rotated fast, e.g. stepping by one value when turned slowly and stepping by 10 values when rotated fast. This allows fine and coarse selection of a parameter from a single knob.
[[File:Zynthian_ui_instrument_control_03.png|400px|right]]
[[File:Zynthian_ui_instrument_control_03.png|400px|right]]
There is a list that shows the pages of controls available.
There is a list that shows the pages of controls available.
To change page, short press SELECT - the list of pages turns grey, rotate SELECT to highlight the required page then short press again to select the page. If there are fewer than three pages then short press SELECT will step through each page. Alternatively, tap the required page on the touchscreen. When a page is selected its controls will be shown. Depending on the configuration, some pages may have fewer than four controls and some engines have no adjustable parameters in which case there will be no control pages.
To change page, press '''short-SELECT''' - the list of pages turns grey, '''rotate SELECT''' to highlight the required page then short press again to select the page. If there are fewer than three pages then '''short-SELECT''' will step through each page. Alternatively, tap the required page on the touchscreen. When a page is selected its controls will be shown. Depending on the configuration, some pages may have fewer than four controls and some engines have no adjustable parameters in which case there will be no control pages.
The pages for the controls for each engine within a chain are shown separated by a title indicating to which engine subsequent pages belong.
The pages for the controls for each engine within a chain are shown separated by a title indicating to which engine subsequent pages belong.
==Chain Options==
==Chain Options==
[[File:Chain options.png|400px|right]]
[[File:Chain options.png|400px|right]]
Pressing '''bold-SELECT''' when in the '''Mixer View''' or '''Control View''' will show the '''Chain Options menu''', allowing to manipulate the chain:
* '''Save Preset''' will allow saving of a engine's configuration as a preset that may later be selected from the preset list. This is only available if the engine supports manipulation of presets. If a chain has several engines then a list of engines will be displayed before naming the preset.
* '''Save Preset''' will allow saving of a engine's configuration as a preset that may later be selected from the preset list. This is only available if the engine supports manipulation of presets. If a chain has several engines then a list of engines will be displayed before naming the preset.
[[File:Zynthian_ui_layer_effect_options.png|400px|right]]
[[File:Zynthian_ui_layer_effect_options.png|400px|right]]
Select an effect in the list for opening the effect options menu, that allows manipulating chain elements:
* '''Presets''' shows list of available presets for the effect
* '''Presets''' shows list of available presets for the effect
Unlearn operations require confirmation.
Unlearn operations require confirmation.
Of course, MIDI-learning configuration, including CC mappings, is stored and restored with snapshots.
Of course, MIDI-learning configuration, including CC & PC mappings, is stored and restored with snapshots.
<br clear=all>
<br clear=all>
====MIDI Program Change & ZS3 (SubSnapShots)====
====MIDI Program Change & ZS3 (SubSnapShots)====
[[File:Zynthian_ui_midi_zs3_learn.png|400px|right]]
[[File:Zynthian_ui_midi_zs3_learn.png|400px|right]]
A ZS3 (SubSnapShot) saves the zynthian state in the context of the current snapshot. When recalled, the saved state is restored. The chains are defined in the snapshot but their selected preset, parameters and mixer settings are defined in the ZS3. Snapshots can be slow to load as each engine needs to be started. ZS3 is much faster as the presets are restored and parameters adjusted. Some ZS3 may be slower due to the way some engines load presets, e.g. changing instrument within Pianoteq is slower than recalling a preset of the same instrument.
A ZS3 (SubSnapShot) saves the zynthian state in the context of the current snapshot. When recalled from the UI or by MIDI Program Change, the saved state is restored. The chain's layout is defined for the snapshot and it can't be changed across ZS3s, but the rest of state is saved in ZS3: bank/preset, engine parameters, mixer settings, clone & key range settings, etc. Snapshots can be slow to load as each engine needs to be started. ZS3 is much faster as the presets are restored and parameters adjusted. Some ZS3 may be slower due to the way some engines load presets, e.g. changing instrument within Pianoteq is slower than recalling a preset of the same instrument.
The idea behind this feature is to have a fast preset-change mechanism that can be used on stage. In combination with the “Stage Mode” feature, it turns Zynthian into a “Stage-Beast”. You can prepare a snapshot for the full performance, and use ZS3s for fast changes between songs or even within a song.
The idea behind this feature is to have a fast preset-change mechanism that can be used on stage. In combination with the “Stage Mode” feature, it turns Zynthian into a “Stage-Beast”. You can prepare a snapshot for the full performance, and use ZS3s for fast changes between songs or even within a song.
<br clear=all>
<br clear=all>
==Audio Recording and Playback==
==Audio Recording and Playback==
4 RELOAD_KEY_BINDING E-1
4 RELOAD_KEY_BINDING E-1
5 LAST_STATE_ACTION F-1
5 LAST_STATE_ACTION F-1
6 EXIT_UI F#-1
10 ALL_NOTES_OFF A#-1
10 ALL_NOTES_OFF A#-1
40 STOP_MIDI_PLAY E2 Stop: 0xFC
40 STOP_MIDI_PLAY E2 Stop: 0xFC
41 ARROW_UP F2
42 ARROW_DOWN F#2
43 ARROW_RIGHT G2
44 ARROW_LEFT G#2
45 ZYNPOT_UP A2
46 ZYNPOT_DOWN A#2
48 BACK C3
49 NEXT C#3
50 PREV D3
51 SELECT D#3
51 SELECT D#3
52 SELECT_UP E3
52 SELECT_UP E3
53 SELECT_DOWN F3
53 SELECT_DOWN F3
56 LAYER_UP G#3
56 LAYER_UP G#3
57 LAYER_DOWN A3
57 LAYER_DOWN A3
58 SNAPSHOT_UP A#3
58 LEARN_UP A#3
59 SNAPSHOT_DOWN B3
59 LEARN_DOWN B3
64 SWITCH_BACK_SHORT E4
64 SWITCH_BACK_SHORT E4
60 SWITCH_LAYER_SHORT C4
60 SWITCH_LAYER_SHORT C4
61 SWITCH_LAYER_BOLD C#4
61 SWITCH_LAYER_BOLD C#4
68 SWITCH_LAYER_LONG B3
71 SWITCH_SNAPSHOT_SHORT B4
71 SWITCH_SNAPSHOT_SHORT B4
82 SCREEN_BANK A#5
82 SCREEN_BANK A#5
83 SCREEN_PRESET B5
83 SCREEN_PRESET B5
90 MODAL_SNAPSHOT_LOAD F#6
85 SCREEN_MIDI_RECORDER C#6
86 SCREEN_ALSA_MIXER D6
87 SCREEN_STEPSEQ D#6
88 SCREEN_BANK E6
89 SCREEN_PRESET F6
90 SCREEN_CALIBRATE F#6
91 MODAL_SNAPSHOT_SAVE G6
91 MODAL_SNAPSHOT_SAVE G6
92 MODAL_AUDIO_RECORDER G#6
92 MODAL_AUDIO_RECORDER G#6
100 LAYER_CONTROL E7
100 LAYER_CONTROL E7
101 LAYER_OPTIONS F7
102 MENU F#7
103 PRESET G7
104 FAVS G#7
105 ZYNPAD A7
[[File:2Oct_Keyboard_CUIA.png|600px|Keyboard]]
[[File:2Oct_Keyboard_CUIA.png|600px|Keyboard]]