334
edits
Changes
Jump to navigation
Jump to search
Line 2:
Line 2: − + − + Line 106:
Line 106: + − + + + + Line 123:
Line 127: + + + + + + + Line 128:
Line 139: − + Line 159:
Line 170: − + Line 174:
Line 185: − + Line 182:
Line 193: − + Line 190:
Line 201: − + − + − #TODO: Upload engine screenshot+ − When you select '''NEW Chain''', you create a new root module (first module of a chain), choosing a free MIDI channel and if available, a preset from a bank of presets. You can create up to 16* chains, one per MIDI channel, each having a independent MIDI and audio effect chains. After creating a chain its Control View is shown.+ − − Line 208:
Line 217: − + Line 237:
Line 246: − + + − Not all engines support banks. If no banks are configured then this screen is not shown.+ + + Line 245:
Line 257: + − + − + Line 257:
Line 270: − − + − + + − [[File:Zynthian_ui_instrument_control_03.png|400px|right]]+ − 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 modules have no adjustable parameters in which case there will be no control pages.+ − The pages for the controls for each module within a chain are shown separated by a title indicating to which module subsequent pages belong.+ + − − #TODO: Upload screenshot of control view with gui widget − − Some modules have a graphical representation of controls / monitoring available. This will be shown in place of the list of pages. Pages can still be selected in the same manner as described above except the list is not available for touchscreens. − + − − − − #TODO: Upload preset & bank screenshot − − − Short press BACK in the Presets view will show the list of banks. (Some modules do not support banks in which case this will return you to the Control View without changing the configuration.) Selecting a bank will show the list of presets within the bank. − − 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 modules do not allow banks to be manipulated in which case this will have no effect. − − Short press BACK to return to the Control View without changing the module's configuration. − − + − #TODO: Uploade chain options screenshot − − + Line 309:
Line 305: − + − + Line 318:
Line 314: − + − MIDI and audio effects can be added in series or parallel to the last corresponding (MIDI or audio) effect in the chain. Short press SELECT or tapping on an effect in the list will allow manipulation of the effect:+ + + + + + + − #TODO:+ − + − − − By bold-clicking on an FX-unit (Audio or MIDI) from the list, you will access the FX's Options: − − * '''Presets''' − * '''Replace''' − * '''Move Upchain''' − * '''Move Downchain''' − * '''Remove''' − − Note that not all these options will be available all the time. For instance, if there is only one effect in the chain, "Move" options won't be shown. Same if the FX has not presets, etc. + − ====XY-Controller====+ Line 446:
Line 438: + + Line 452:
Line 446: − − ZS3 behavior depends of the mode your zynthian is working on: − − #TODO: Validate this behaviour: − * '''Stage Mode''': ZS3 list shows all the ZS3s stored, no matter the chain. Recalling a ZS3 changes the active chain, so the chain associated with the recalled ZS3 will receive *ALL* the MIDI input. Only 127 ZS3s can be stored. − * '''Multi-timbral Mode''': ZS3 list shows the ZS3 of the currently active chain only. Recalling a ZS3 changes the active chain, but every chain receives MIDI input from its channel. You can use several keyboards on different channels and store 127 ZS3s by MIDI channel. − − − Line 502:
Line 487: − #TODO: Upload audio player screenshot+
Zynthian UI User Guide - V1/V4 (view source)
Revision as of 16:10, 1 September 2022
, 16:10, 1 September 2022→MIDI Program Change & ZS3 (SubSnapShots)
=General Concepts=
=General Concepts=
The Zynthian UI is displayed on a display and controlled by 4 knobs with switches. You can also control the UI with a touch-display, a mouse or a keyboard (computer keyboard or MIDI keyboard, both!)
The core Zynthian UI consists of a display and four knobs with push switches. You can also control the UI with a touchscreen, a mouse or a keyboard (computer keyboard or MIDI keyboard, both!)
The four knobs & switches are the primary control mechanism to navigate the UI: selecting options on menus and adjusting the instrument parameters. The knobs can act as assignable MIDI / OSC controllers for the instrument's parameters (frequently lots of them!). You can emulate the knob's behaviour using the touch-display, but it's sub-optimal and accessing some features could be tricky.
The four knobs & switches are the primary control mechanism to navigate the UI: selecting options on menus and adjusting parameters. The knobs can act as assignable MIDI / OSC controllers for parameters (frequently lots of them!). Most operations may be performed with the touchscreen but some may not be intuitive. See the section on [[#Touch_Screen_UI|touchscreen]] and comments throughout this documentation.
[[File:Zynthian v4 top legend.png|600px|center]]
[[File:Zynthian v4 top legend.png|600px|center]]
=The Zynthian UI Workflow=
=The Zynthian UI Workflow=
Zynthian workflow is based around chains of audio generators / processors feeding an audio summing mixer.
Zynthian workflow is based around chains of audio generators / processors feeding an audio summing mixer. The main (home) screen is the Audio Mixer. This consists of several vertical strips, each representing an input chain and a strip representing the main mixbus (output) chain.
[[File:Zynthian Signal Flow.png|800px]]
<br clear=all>
The main (home) screen is the Audio Mixer. This consists of several vertical strips, each representing an input chain and a strip representing the main mixbus (output) chain.
Navigation between views is performed by pressing buttons or using the touchscreen.
Navigation between views is performed by pressing buttons or using the touchscreen.
<br clear=all>
<br clear=all>
==Stage and Multitimbral Modes==
By default Zynthian starts in multitimbral mode. Each external MIDI controller will drive the chain that is assigned to that controller's MIDI channel, e.g. a chain assigned to MIDI channel 1 will listen for MIDI messages on MIDI channel 1 only<sup>*</sup>.
<sup>*</sup>MIDI Continuous Controllers are handled differently. See section on [[#MIDI-learning_.2F_binding|MIDI Learning & binding]].
Stage Mode changes the behaviour of Zynthian so that all MIDI messages are sent to the currently selected chain. This allows multiple external MIDI controllers to drive one chain at a time.
=The UI Screens=
=The UI Screens=
==Audio Mixer==
==Audio Mixer==
[[File:Audio mixer.png|thumb|Audio Mixer View]]
[[File:Audio mixer.png|400px|right]]
The audio mixer view is the main or home screen. Bold press BACK will navigate to this screen from most locations within the Zynthian UI. It displays a mixer strip (or equivalent) 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 audio mixer view is the main or home screen. Bold press BACK will navigate to this screen from most locations within the Zynthian UI. It displays a mixer strip (or equivalent) 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.
==Main Menu==
==Main Menu==
[[File:Main menu.png|thumb|Main Menu]]
[[File:Main menu.png|400px|right]]
This is the first screen you would see when you power on your zynthian for first time and no default or last-state snapshot has been saved yet.
This is the first screen you would see when you power on your zynthian for first time and no default or last-state snapshot has been saved yet.
The Main Menu gives easy access to the Zynthian-UI's main features:
The Main Menu gives easy access to the Zynthian-UI's main features:
* '''Audio Levels''' adjust hardware audio parameters
* '''Audio Levels''' adjust hardware audio parameters
* '''Admin''' access configuration menu
* '''Admin''' access configuration menu
* '''PANIC! All Notes OFF''' resets all MIDI modules
* '''PANIC! All Notes OFF''' resets all MIDI engines
<br clear=all>
<br clear=all>
Chains are a key concept of the Zynthian. The first thing you do after powering on your Zynthian is probably to create a chain. (It does little without any chains.)
Chains are a key concept of the Zynthian. The first thing you do after powering on your Zynthian is probably to create a chain. (It does little without any chains.)
A chain is one or more interconnected modules capable of generating or processing audio or MIDI. Each chain is normally assigned to a MIDI channel. These modules are chained in the same order they are created, but you can change the order from the '''Chain Options''' menu. The first module in a chain is the '''root''' and it determines the chain's type:
A chain is one or more interconnected engines capable of generating or processing audio or MIDI. Each chain is normally assigned to a MIDI channel. These engines are chained in the same order they are created, but you can change the order from the '''Chain Options''' menu. The first engine in a chain is the '''root''' and it determines the chain's type:
* '''Synth Chain''' => Receives MIDI note-events and generate audio output
* '''Synth Chain''' => Receives MIDI note-events and generate audio output
* '''Special Chain''' => Does not fit any other chain type, e.g. MOD-UI pedalboard, Pure Data patch, etc.
* '''Special Chain''' => Does not fit any other chain type, e.g. MOD-UI pedalboard, Pure Data patch, etc.
The root module can't be re-arranged or changed. MIDI effects can be added to the start of a chain and audio effects can be added to the end of a chain. These can be arranged as serial or parallel paths.
The root engine can't be re-arranged or changed. MIDI effects can be added to the start of a chain and audio effects can be added to the end of a chain. These can be arranged as serial or parallel paths.
All modules in a chain receive all the MIDI events on the assigned channel. Some special chains (MOD-UI) don't have an assigned MIDI channel and receive all MIDI channels.
All engines in a chain receive all the MIDI events on the assigned channel. Some special chains (MOD-UI) don't have an assigned MIDI channel and receive all MIDI channels.
<br clear=all>
<br clear=all>
When you select '''NEW Chain''', you create a new chain, choosing its root engine (first engine of the chain), a free MIDI channel and if available, a preset from a bank of presets. You can create up to 16<sup>*</sup> chains, one per MIDI channel, each having an independent MIDI chain and audio effect chain.
<sup>*</sup> If '''Master Channel''' is enabled then only 15 chains can be created.
* If '''Master Channel''' is enabled then only 15 chains can be created.
Having several chains on the same MIDI channel is not allowed. 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 allow you to bind several chains while keeping MIDI CCs and other MIDI messages (Program Change, Channel Pressure, etc.) independent.
Having several chains on the same MIDI channel is not allowed. 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 allow you to bind several chains while keeping MIDI CCs and other MIDI messages (Program Change, Channel Pressure, etc.) independent.
==Engine Selector==
==Engine Selector==
[[File:Zynthian_ui_engine_list.png|400px|right]]
[[File:Zynthian_ui_engine_list.png|400px|right]]
When you create a new chain, you are asked which engine or plugin you want to use for it. An engine is a module that creates or processes MIDI or audio. A list of engines to choose from is displayed. They can be synthesizers, effects, generators or special engines, depending on the type of chain 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.
When you create a new chain, you are asked which engine or plugin you want to use for it. An engine creates or processes MIDI or audio. A list of engines to choose from is displayed. They can be synthesizers, effects, generators or special engines, depending on the type of chain 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.
Some engines have special behavior regarding chains and MIDI channels:
Some engines have special behavior regarding chains and MIDI channels:
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. Choose a bank to see the list of presets for the engine.
You can return to the Control View without selecting a bank by short press BACK.
<br clear=all>
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.
Short press BACK to return to the Control View without changing the engine's configuration.
<br clear=all>
<br clear=all>
[[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 and the Control View will be shown.
<br clear=all>
To change preset of an existing module, 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 module will configure with the preset values and the Control View will be displayed.
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.
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 modules 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 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.)
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. 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.
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.
<br clear=all>
<br clear=all>
==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 module within a chain. It is shown after adding a chain, adding a module 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 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 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.
<br clear=all>
<br clear=all>
[[File:Zynthian_ui_instrument_control_02.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.
The pages for the controls for each engine within a chain are shown separated by a title indicating to which engine subsequent pages belong.
<br clear=all>
[[File:Sooperlooper.png|400px|right]]
Some engines have a graphical representation of controls / monitoring available. This will be shown in place of the list of pages. Pages can still be selected in the same manner as described above except the list is not available for touchscreens.
<br clear=all>
<br clear=all>
Tapping (and not dragging) one of the four controls on a touchscreen will simulate pressing its associated knob, i.e. tap on the bottom right control to show the list of pages.
Tapping (and not dragging) one of the four controls on a touchscreen will simulate pressing its associated knob, i.e. tap on the bottom right control to show the list of pages.
<br clear=all>
==Presets==
==Chain Options==
==Chain Options==
[[File:Chain options.png|400px|right]]
Bold press SELECT when in the Mixer View or Control View will show the Chain Options menu. Manipulation of the chain is possible:
Bold press SELECT when in the Mixer View or Control View will show the Chain Options menu. Manipulation of the chain is possible:
* '''Save Preset''' will allow saving of a module's configuration as a preset that may later be selected from the preset list. This is only available if the module supports manipulation of presets. If a chain has several modules then a list of modules 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.
* '''Note Range & Transpose''' allows configuration of the key-range and transpose by octaves or semitones applied to the chain.
* '''Note Range & Transpose''' allows configuration of the key-range and transpose by octaves or semitones applied to the chain.
* '''Clone MIDI to...''' allows MIDI events targetted at this chain to be sent to other MIDI channels. By default only note-on, note-off, pitchbend and key-pressure messages are cloned. CC, channel-pressure, program change, etc. can be enabled by bold SELECT on a channel within the Clone menu
* '''Clone MIDI to...''' allows MIDI events targetted at this chain to be sent to other MIDI channels. By default only note-on, note-off, pitchbend and key-pressure messages are cloned. CC, channel-pressure, program change, etc. can be enabled by bold SELECT on a channel within the Clone menu
* '''MIDI Routing''' => Select the destiny of the chain's MIDI output. This option is only available on MIDI-FX chains.
* '''MIDI Routing''' => Select the destiny of the chain's MIDI output. This option is only available on MIDI-FX chains.
* '''MIDI Channel''' allows changing of the chain's MIDI Channel. Only MIDI channels not assigned to other chains are available.
* '''MIDI Channel''' allows changing of the chain's MIDI Channel. Only MIDI channels not assigned to other chains are available.
* '''Replace Synth''' allows a synth module to be replaced by another synth module.
* '''Replace Synth''' allows a synth engine to be replaced by another synth engine.
* '''Remove Chain''' will remove the chain.
* '''Remove Chain''' will remove the chain.
* '''Add MIDI-FX''' adds a MIDI effect to the chain. The MIDI effect will be inserted before synth modules.
* '''Add MIDI-FX''' adds a MIDI effect to the chain. The MIDI effect will be inserted before synth engines.
* '''Remove All MIDI-FX''' removes all MIDI effects from the chain
* '''Remove All MIDI-FX''' removes all MIDI effects from the chain
* The list of MIDI effects in the chain is displayed with arrows representing their relative position
* The list of MIDI effects in the chain is displayed with arrows representing their relative position
* '''Add Audio-FX''' adds an audio effect to the end of the chain. This option is not available for MIDI Chains.
* '''Add Audio-FX''' adds an audio effect to the end of the chain. This option is not available for MIDI Chains.
* '''Remove All Audio-FX''' removes all audio effects from the chain.
* '''Remove All Audio-FX''' removes all audio effects from the chain.
* The list of audio effects in the chain is displayed with arrows representing their relative position
* The list of audio effects in the chain is displayed with arrows representing their relative position. MIDI and audio effects can be added in series or parallel to the last corresponding (MIDI or audio) effect in the chain.
<br clear=all>
[[File:Zynthian_ui_layer_effect_options.png|400px|right]]
Short press SELECT or tapping on an effect in the list will allow manipulation of the effect:
* '''Presets''' shows list of available presets for the effect
* '''Replace''' offers the list of available effects to replace the effect in the chain
* '''Replace''' offers the list of available effects to replace the effect in the chain
* '''Move up chain''' moves the effect closer to the start of the chain. Only available if space in front of effect.
* '''Move up chain''' moves the effect closer to the start of the chain. Only available if space in front of effect.
* '''Move down chain''' moves the effect closer to the end of the chain. Only available if space behind effect.
* '''Move down chain''' moves the effect closer to the end of the chain. Only available if space behind effect.
* '''Remove''' removes the effect from the chain
* '''Remove''' removes the effect from the chain
Note that not all these options will be available all the time. For instance, if there is only one effect in the chain, "Move" options won't be shown. Same if the FX has not presets, etc.
<br clear=all>
<br clear=all>
==Note Range & Transpose==
==Note Range & Transpose==
[[File:Range transpose.png|400px|right]]
The MIDI sent to a chain may be transposed +/-5 octaves and +/-12 semitones. The range of MIDI notes that it will respond to can be limited. The Mote Range & Transpose View has controller knobs to adjust the octave transpose, semitone transpose and lower & upper key range limits. The key range is displayed on an onscreen piano keyboard that can be dragged with the touchscreen to set the range.
[[File:Zynthian_ui_layer_effect_options.png|400px|right]]
Short press LEARN will enable MIDI learning. MIDI notes will set the limits of the note range.
<br clear=all>
<br clear=all>
==XY-Controller==
[[File:Zynthian_ui_xy_select.png|400px|right]]
[[File:Zynthian_ui_xy_select.png|400px|right]]
You can recall the stored ZS3 by sending the same MIDI Program Change or selecting it from the ZS3 list. ZS3s are saved and restored within snapshots so remember to save the snapshot.
You can recall the stored ZS3 by sending the same MIDI Program Change or selecting it from the ZS3 list. ZS3s are saved and restored within snapshots so remember to save the snapshot.
ZS3 will restore configuration for all chains in multitimbral mode and for the currently selected (active) chain only in stage mode.
Bold press SELECT to manipulate ZS3:
Bold press SELECT to manipulate ZS3:
* '''Update''' replaces the ZS3 with the current configuration
* '''Update''' replaces the ZS3 with the current configuration
* '''Delete''' removes the ZS3
* '''Delete''' removes the ZS3
<br clear=all>
<br clear=all>
==MIDI Recording and Playback==
==MIDI Recording and Playback==
==Audio Recording and Playback==
==Audio Recording and Playback==
[[File:Audio player.png|400px|right]]
Zynthian has an audio recorder that will, by default record the stereo output of the audio mixer's main mixbus output (post effects, post fader).
Zynthian has an audio recorder that will, by default record the stereo output of the audio mixer's main mixbus output (post effects, post fader).