Changes

Jump to navigation Jump to search
Line 2: Line 2:  
=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]]
Line 106: Line 106:     
=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.  
Line 123: Line 127:     
<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=
Line 128: Line 139:  
==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.
Line 159: Line 170:  
==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:
Line 235: Line 246:  
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.
   −
Not all engines support banks. If no banks are configured then this screen is not shown.
+
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>
   Line 243: Line 257:  
[[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 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 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.
Line 255: Line 270:     
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>
   Line 277: Line 291:     
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==
  −
 
  −
#TODO: Upload preset & bank screenshot
  −
 
  −
 
  −
Short press BACK in the Presets view will show the list of banks. (Some engines 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 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.
  −
 
      
==Chain Options==
 
==Chain Options==
 
+
[[File:Chain options.png|400px|right]]
#TODO: Uploade chain options screenshot
  −
 
   
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:
   Line 313: Line 314:  
* '''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>
   −
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:
+
[[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==
#TODO:
+
[[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]]
  −
 
  −
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.
      +
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====
+
==XY-Controller==
 
[[File:Zynthian_ui_xy_select.png|400px|right]]
 
[[File:Zynthian_ui_xy_select.png|400px|right]]
   Line 441: Line 438:     
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:
Line 447: Line 446:  
* '''Update''' replaces the ZS3 with the current configuration
 
* '''Update''' replaces the ZS3 with the current configuration
 
* '''Delete''' removes the ZS3
 
* '''Delete''' removes the ZS3
  −
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.
  −
   
<br clear=all>
 
<br clear=all>
  −
      
==MIDI Recording and Playback==
 
==MIDI Recording and Playback==
Line 497: Line 487:  
==Audio Recording and Playback==
 
==Audio Recording and Playback==
   −
#TODO: Upload audio player screenshot
+
[[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).
334

edits

Navigation menu