Changes

Jump to navigation Jump to search
m
Line 2: Line 2:  
=General Concepts=
 
=General Concepts=
   −
[[File:zynthian_controllers.png|430px|right]]
+
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 Zynthian UI is displayed on a touch display and controlled by 4 knobs (rotary-encoders with push-switches).
+
The 4 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 knobs are used to navigate between the different screens/menus, select options and change the instrument parameters, acting as MIDI/OSC controllers. You can emulate the knob's behaviour using the touch-display, but it's sub-optimal and accessing some features could be tricky.
+
 
 +
[[File:Zynthian v4 top legend.png|600px|center]]
    
There are two main screen-layout types:
 
There are two main screen-layout types:
   −
* '''Selector Screen''': a list of items that you can scroll and select with the SELECT (4) knob
+
* '''Selector Screen''': a list of items that you can scroll and select with the SELECT knob (CTRL-4)
* '''Controller Screen''': 4 control widgets in the corners (one for each knob), with label and value indicators (graphic and numeric). In the middle there is a list of controller maps, which you can use to change the parameters controlled by the knobs.
+
* '''Controller Screen''': 4 control widgets in the corners (one for each knob), with label and value indicators (graphic and numeric). In the middle there is a list of controller screens, each one mapping 4 controllers which you can use to change the engine parameters.
   −
Almost every Zynthian UI screen is of one of these 2 types, however, other screen-layouts do exist:
+
Most of Zynthian UI screens belongs to one of these 2 categories, however, other screen-layouts do exist:
    
* '''Confirmation Screen''': It will ask you to confirm some operation.
 
* '''Confirmation Screen''': It will ask you to confirm some operation.
 
* '''XY Controller Screen''': It allows to modify 2 parameters at once using the touch interface.
 
* '''XY Controller Screen''': It allows to modify 2 parameters at once using the touch interface.
* '''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.
 +
* etc.
 +
 
 +
There are 3 types of push actions that can be performed, depending on how long you hold down the knob/button (or hold your finger on the touch-display).
 +
 
 +
* '''Short push:''' Less than 0.3 seconds
 +
* '''Bold push:''' Between 0.3 and 2 seconds
 +
* '''Long push:''' More than 2 seconds (until the long-action is triggered!)
   −
There are 3 types of clicks (push-switch actions) that can be performed, depending on how long you hold down the knob (or hold your finger on the touch-display):
+
These timing values are the default ones. You can adjust them to your personal feeling from the webconf's UI options.
   −
* '''short click:''' less than 0.3 seconds
+
Some push actions depends of context. The SELECT knob is mainly used to navigate and a short push on it will select an item on a "Selector Screen". Inside a "Controller Screen", short pushes can be used to rotate between layers (LAYER knob) or between controller pages (SELECT knob). "Bold-pushes" are normally intended as shortcuts for jumping to specific screen like "layer options", "main menu", etc. Pushing the BACK knob generally close the current modal-screen or jumps to the previous screen in the workflow sequence.
* '''bold click:''' between 0.3 and 2 seconds
  −
* '''long click:''' more than 2 seconds
     −
Click actions for each knob are context dependent. The SELECT knob is mainly used to navigate, and a short click on it will select an item on a "Selector Screen". Inside a "Controller Screen", short clicks can be used to rotate between layers (LAYER knob) or between controller pages (SELECT knob). "Bold-clicks" are intended as shortcuts for jumping to some specific screens. Clicking the BACK knob generally jumps to the previous screen in the workflow sequence.
+
Although some push actions depend of context (current screen), there are some actions that are global and will work from any screen:
   −
Most of the actions depend of context (current screen), but there are some actions that are global and will work from any screen:
+
* '''Bold-Back''': Main Menu
 +
* '''Long-Layer''': Step Sequencer
 +
* '''Long-Back''': Admin Menu
 +
* '''Long-Learn''': Audio Levels
 +
* '''Long-Select''': Power Off
   −
* '''bold-back''': Main menu
+
Latest versions of zynthian kits include 4 extra push buttons, labelled as S1 to S4. By default, these buttons are assigned to MIDI Program Change 1-4, but this can be easily changed from the webconf's [[Configuration_Users_Guide#Wiring_Layout|Wiring Layout menu]].
* '''bold-snapshot''': Load Snapshot menu
  −
* '''long-layer''': ALSA Mixer app
  −
* '''long-back''': Admin menu
  −
* '''long-snapshot''': Audio Recorder
  −
* '''long-select''': Power Off
      
<br clear=all>
 
<br clear=all>
    +
=The Title Bar=
 
[[File:zynthian_ui_control_status.png|400px|right]]
 
[[File:zynthian_ui_control_status.png|400px|right]]
   −
=The Title Bar=
   
The title bar have 2 functions:
 
The title bar have 2 functions:
   −
* Kind of Breadcrumb, normally showing the screen title or layer information: MIDI channel, engine, bank & preset
+
* Kind of Breadcrumb, normally showing the screen title or current layer information: MIDI channel, engine, bank & preset
* Back-button, when using the touch-interface. I know, it's far from intuitive, but Zynthian-UI was not designed with touch-navigation in mind.  
+
* Back-button, when using the touch-interface. It's far from intuitive, but Zynthian-UI was not designed with touch-navigation in mind.
 +
 
 +
<br clear=all>
    
=The Status Area=
 
=The Status Area=
 +
[[File:Status display.png|400px|right]]
    
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:
   −
* Audio Peak-meter or CPU-load => 1 or 2 small horizontal bars on the top right.
+
* '''Audio peak-meter''' or '''CPU load-bar''' => 1 or 2 small horizontal bars on the top.
* MIDI-IN => '''Blue M''' flag
+
* '''Status Icons''' => Displayed under the peak-meter.
* Xrun => '''Red Warning''' flag
+
 
* Under-voltage => '''Red Lightning''' flag
+
{| class="wikitable"
* Over-temperature => '''Red Thermometer''' flag
+
!colspan="3"|Status Icons Legend
* Recording Audio => '''Red Circle''' flag
+
|-
* Playing Audio => '''Green Play''' flag
+
|style="padding:10px"|<span style="color:#8080FF">'''m'''</span>
 +
|style="padding:10px;width: 200px;|'''MIDI-IN'''
 +
|style="padding:10px"|It's shown when MIDI messages are received.
 +
|-
 +
|style="padding:10px"|<span style="color:#FF0000">{{#fas:exclamation-triangle}}</span>
 +
|style="padding:10px"|'''XRun'''
 +
|style="padding:10px"|It's shown when there are Xruns. If many, you should hear clicks and pops too. This means the CPU can't process audio fast enough and you should consider disabling some CPU-hungry option (like VNC, headphones, etc.) or reducing the complexity of your layer setup.
 +
|-
 +
|style="padding:10px"|<span style="color:#FF0000">{{#fas:bolt}}</span>
 +
|style="padding:10px"|'''Under-voltage'''
 +
|style="padding:10px"|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 that icon and if you do so, you should consider looking for a better power source.
 +
|-
 +
|style="padding:10px"|<span style="color:#FF0000">{{#fas:temperature-high}}</span>
 +
|style="padding:10px"|'''Over-temperature'''
 +
|style="padding:10px"|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 that icon and if you do so, you should improve heat dissipation (using a heat sink, etc.)
 +
|-
 +
|style="padding:10px"|<span style="color:#b00000">{{#fas:circle}}</span>
 +
|style="padding:10px"|'''Recording Audio/MIDI'''
 +
|style="padding:10px"|An audio or MIDI recording is going on.
 +
|-
 +
|style="padding:10px"|<span style="color:#00b000">{{#fas:play}}</span>
 +
|style="padding:10px"|'''Playing Audio/MIDI'''
 +
|style="padding:10px"|An audio or MIDI track is being played.
 +
|}
    
===The Peak-meter===
 
===The Peak-meter===
Line 65: Line 97:  
* The red segment covers the range -3dBFS to 0dBFS.
 
* 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.  
+
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 can be 200 ms delay in peak being displayed.
 
(*) Meter is updated 5 times per second so there can 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:
+
Alternately, the "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 Flags===
  −
 
  −
* 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 Warning''' flag is shown when there are Xruns. You should hear clicks and pops too.
  −
 
  −
* When the '''Red Lightning''' or '''Red 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 Circle''' and '''Green Play''' flags show the status of audio/MIDI capture: recording / playing
  −
 
  −
<br clear=all>
      
=The Zynthian UI Workflow=
 
=The Zynthian UI Workflow=
Line 91: Line 111:     
<gallery mode="slideshow" widths="240" heights="320">
 
<gallery mode="slideshow" widths="240" heights="320">
Image:zynthian_ui_workflow__main.png|''[[commons:Main Sequence|Main Sequence]]''
+
Image:zynthian_ui_workflow_main.png|''[[commons:Main Sequence|Main Sequence]]''
Image:zynthian_ui_workflow__layer_options.png|''[[commons:Layer Options|Layer Options]]''
+
Image:zynthian_ui_workflow_layer_options.png|''[[commons:Layer Options|Layer Options]]''
Image:zynthian_ui_workflow__snapshots.png|''[[commons:Snapshots|Snapshots]]''
+
Image:zynthian_ui_workflow_snapshots.png|''[[commons:Snapshots|Snapshots]]''
Image:zynthian_ui_workflow__midi_learning.png|''[[commons:MIDI Learning|MIDI Learning]]''
+
Image:zynthian_ui_workflow_midi_learning.png|''[[commons:MIDI Learning|MIDI Learning]]''
 
</gallery>
 
</gallery>
   −
If you want to contribute to improving these flowcharts, you can edit them using the Google Documents Tools:
+
If you want to contribute to improve these flowcharts, you can edit them using the Google Documents Tools:
    
  - [https://docs.google.com/drawings/d/1jmt3zrJjPkbqj3hpzCIwRgFIKxiX2UptebBA_GN8e5I Main sequence: zynthian_ui_workflow_main]
 
  - [https://docs.google.com/drawings/d/1jmt3zrJjPkbqj3hpzCIwRgFIKxiX2UptebBA_GN8e5I Main sequence: zynthian_ui_workflow_main]
Line 112: Line 132:  
[[File:Zynthian_ui_main.png|400px|right]]
 
[[File:Zynthian_ui_main.png|400px|right]]
   −
This is the first screen you would see when you power on your zynthian for first time and no default snapshot 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 and intuitive access to the Zynthian-UI's main features:
+
The Main menu gives easy access to the Zynthian-UI's main features:
    
* '''Layers'''
 
* '''Layers'''
* '''Snapshots'''
+
* '''Sequencer'''
 +
* '''Audio Levels'''
 
* '''Audio Recorder'''
 
* '''Audio Recorder'''
 
* '''MIDI Recorder'''
 
* '''MIDI Recorder'''
* '''ALSA-Mixer'''
+
* '''Snapshots'''
* '''Auto-EQ'''
+
* '''Clean All'''
 
* '''Admin'''
 
* '''Admin'''
    
You always can access this menu with '''bold-back'''.
 
You always can access this menu with '''bold-back'''.
   −
The Zynthian-UI has a lot of short-cuts and most of the options on the Main menu can be accessed on this way, but until you learn the shortcuts and feel comfortable with them, you will find this menu very useful.  
+
The Zynthian-UI has a lot of short-cuts and most of the options on the main menu can be accessed with them, but until you learn the shortcuts and feel comfortable with them, you will find this menu very useful.  
    
<br clear=all>
 
<br clear=all>
Line 131: Line 152:  
==Layers==
 
==Layers==
   −
Layers are a key concept on Zynthian-UI: the first thing you do when you power-on your zynthian is, probably, create a layer.
+
Layers are a key concept on Zynthian-UI: the first thing you do after poweron your zynthian is, probably, create a layer.
   −
A layer is an '''Audio Processing Chain''', normally assigned to a MIDI channel, which can be composed of one or more Audio Processing Units. These units are chained in the same order they are created, but you can change the order from the '''Layer Options''' menu. The first unit in a layer is the '''root''' and it determines the layer's type:
+
A layer is a '''Processing Chain''', normally assigned to a MIDI channel, which can be composed of one or more Audio or MIDI Processing Units. These units are chained in the same order they are created, but you can change the order from the '''Layer Options''' menu. The first unit in a layer is the '''root''' and it 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.
+
* '''Audio FX Layer''' => Receives audio-input and generates audio-output.
 +
* '''MIDI FX Layer''' => Receives MIDI-input and generates MIDI-output.
 
* '''Generator Layer''' => Auto-generate audio output using an algorithm.
 
* '''Generator Layer''' => Auto-generate audio output using an 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 are usually FX units which process the audio coming from the first unit (root).
+
The root layer can't be re-arranged or changed. When you create pure Audio-FX layers, it's a good idea to use a "Gain" unit as root element, so you can re-arrange/change all the other elements on the chain.
   −
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.
+
All units in a layer's chain 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.
    
You can access the Layer screen:
 
You can access the Layer screen:
Line 151: Line 173:  
[[File:Zynthian_ui_new_layer.png|400px|right]]
 
[[File:Zynthian_ui_new_layer.png|400px|right]]
   −
There are several options on layers screen:
+
There are several options on the layers screen:
   −
* '''NEW Synth Layer''' => Create a new Synthesizer Layer.
+
* '''NEW Synth Layer''' => Create a Synthesizer Layer.
* '''NEW Effect Layer''' => Create a new Effect Layer that will be connected to soundcard's Audio Input. You can route the audio from other layers to an Effect Layer.
+
* '''NEW Audio-FX Layer''' => Create an audio-FX Layer that will be connected to soundcard's Audio Capture. You can route the audio output from other layers to the input of an Audio-FX layer.
* '''NEW Generator Layer''' => Create a new Generator Layer that self-generates audio or midi.
+
* '''NEW MIDI-FX Layer''' => Create a MIDI-FX Layer to process MIDI events. You can route the MIDI output from a MIDI-FX layer to the MIDI input of any other unit or to the zynthian's MIDI output.
 +
* '''NEW Generator Layer''' => Create a new Generator Layer that self-generates audio.
 
* '''NEW Special Layer''' => Create a new Special Layer (MOD-UI, Pure Data, ...).
 
* '''NEW Special Layer''' => Create a new Special Layer (MOD-UI, Pure Data, ...).
 
* '''REMOVE ALL''' => Remove all Layers & Effects, returning to the initial state.
 
* '''REMOVE ALL''' => Remove all Layers & Effects, returning to the initial state.
 
* '''PANIC! All Notes/Sounds Off''' => Stop All Notes and sounds by sending CC#123 and CC#120 to all channels.
 
* '''PANIC! All Notes/Sounds Off''' => Stop All Notes and sounds 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. So, you can trigger this action from any point in the workflow by simply bold-clicking CTRL-1 twice. You can also 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]].
+
The last option, ''All Notes/Sounds Off'', can be triggered with '''long-back''' from any point of the workflow. You can also 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>
Line 172: Line 195:     
[[File:Zynthian_ui_layer_options.png|400px|right]]
 
[[File:Zynthian_ui_layer_options.png|400px|right]]
 +
[[File:Zynthian_ui_layer_options_transpose.png|400px|right]]
 +
[[File:Zynthian_ui_layer_options2.png|400px|right]]
 +
 
If you bold-click the select switch over a layer from the list, the "Layer Options" menu will be displayed for the selected layer. This menu allows you to:
 
If you bold-click the select switch over a layer from the list, the "Layer Options" menu will be displayed for the selected layer. This menu allows you to:
   −
* '''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 by default (CC, channel-pressure, program change, ...). You can select what CC will be cloned by bold-clicking on the channel list.
+
* '''Note Range & Transpose''' => Select the '''layer's''' key-range and transpose by octaves or semitones.
* '''Transpose''' => transpose the '''layer's MIDI channel''' up and down, by semitones.
+
* '''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 by default (CC, channel-pressure, program change, ...). You can select what CC will be cloned by bold-clicking on the channel list.
* '''Audio Routing''' => route the '''layer's''' audio output to the available audio input ports, allowing to process the audio in almost any way you can 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.
+
* '''Audio Output''' => Route the '''layer's''' audio output to any  available audio input port, allowing to process the audio in almost any way you can 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. This option is not available on MIDI-FX layers.
* '''MIDI chan''' => change the MIDI Channel assigned.
+
* '''Audio Capture''' => Select the soundcard's capture channels used for audio processing. This option is only available on Audio-FX layers.
* '''Remove Layer''' => Remove the layer.
+
* '''MIDI Routing''' => Select the destiny of the layer's MIDI output. This option is only available on MIDI-FX layers.
 +
* '''MIDI Channel''' => Change the assigned MIDI Channel.
 +
* '''Remove Layer''' => Remove the layer, including all chained Audio & MIDI FXs.
 +
 
 +
* '''Add Audio-FX''' => Add an Audio-FX unit to the layer's audio chain.
 +
* '''Remove All AUdio-FX''' => Clean the Audio-FX chain, deleting all the audio effect units.
 +
* '''Audio-FX List''' => The list of audio effects on the layer's chain.
 +
 
 +
* '''Add MIDI-FX''' => Add a MIDI-FX to the layer's chain. If the layer is a Synth layer, the MIDI-FX will be inserted just before the synth engine.
 +
* '''Remove All MIDI-FX''' => Clean the MIDI-FX chain, deleting all the MIDI effect units.
 +
* '''MIDI-FX List''' => The list of MIDI effects on the layer's chain.
   −
* '''Add Effect''' => Add an effect to the FX-chain.
  −
* '''Remove All Effects''' => Clean the FX-chain, deleting all the effects.
  −
* '''Effect List''' => The list of effects in the layer's FX-chain.
   
<br clear=all>
 
<br clear=all>
    
[[File:Zynthian_ui_layer_effect_options.png|400px|right]]
 
[[File:Zynthian_ui_layer_effect_options.png|400px|right]]
   −
By bold-clicking on an effect from the list, you will access the Effect's Options:
+
By bold-clicking on an FX-unit (Audio or MIDI) from the list, you will access the FX's Options:
   −
* '''Replace Effect'''
+
* '''Presets'''
* '''Effect Presets'''
+
* '''Replace'''
 
* '''Move Upchain'''
 
* '''Move Upchain'''
 
* '''Move Downchain'''
 
* '''Move Downchain'''
* '''Remove Effect'''
+
* '''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.
+
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>
Line 238: Line 271:  
You can return to the control screen directly, without selecting any preset, by clicking '''bold-back'''. In that case, the previously selected instrument will be restored in case you pre-loaded some preset.
 
You can return to the control screen directly, without selecting any preset, by clicking '''bold-back'''. In that case, the previously selected instrument will be restored in case you pre-loaded some preset.
   −
Use '''bold-select''' for adding a preset to your favorites. You will see a little '''*''' at left. '''Bold-select''' again for removing the preset from favorites.
+
Use '''bold-select''' for adding a preset to your favorites. You will see a little '''*''' at left. '''Bold-select''' again for removing the preset from favorites. For listing only your favorite presets, click '''snapshot'''.   
 
  −
For listing only your favorite presets, use '''bold-snapshot'''.   
      
<br clear=all>
 
<br clear=all>
Line 261: Line 292:  
====XY-Controller====
 
====XY-Controller====
 
[[File:Zynthian_ui_xy_select.png|400px|right]]
 
[[File:Zynthian_ui_xy_select.png|400px|right]]
If you click 2 knobs at once, you enter XY-control mode. The 2 controllers you clicked are green, and you can choose the desired parameters to control by rotating the controller. You can also navigate the controller pages by clicking select and so on. So you can select parameters from different pages.
+
 
 +
From the instrument control screen, if you bold-press two knobs at once, you should enter the XY-select mode.
 +
 
 +
The 2 controllers you pushed will be green, indicating they are pre-selected for XY-control. You can change the pre-selection by rotating any knob. (The knob must be rotated through several values before it will be detected.) Use the ''select'' switch to navigate through the controller pages to select different controllers if needed.
 
<br clear=all>
 
<br clear=all>
    
[[File:Zynthian_ui_xy_controller.png|400px|right]]
 
[[File:Zynthian_ui_xy_controller.png|400px|right]]
Once you have selected the right parameters, touch the screen to enter the XY-control-pad (using the touchscreen ala Kaoss Pad).  
+
Once you have selected the parameters you want, touch the display to enter the XY-control pad and use the touchscreen ala Kaoss-Pad.
 +
 
 +
Click ''back'' to return to XY-select and ''back'' again to return to the control screen.
 +
<br clear=all>
 +
 
 +
==Load/Save Snapshot==
 +
[[File:Zynthian_ui_snapshot_load.png|400px|right]]
 +
[[File:Zynthian_ui_snapshot_save.png|400px|right]]
 +
Snapshots are used for saving and restoring the status of Zynthian. A snapshot includes the full state, including layers, effects, parameter values, MIDI-learning, etc.
 +
 
 +
You can enter the ''Load Snapshot'' screen with '''bold-snapshot'''. It works from any place. A second click and you will be at the ''Save Snapshot'' screen.
 +
 
 +
Before loading any snapshot, you should save one, and to save a snapshot, you should create some layers, etc. The Zynthian UI will use numbers for naming the banks and snapshots. You can rename the snapshots to something more specific using the webconf tool.
 +
 
 +
====Snapshot Banks====
 +
By default, snapshots are stored as a single list and bank-related stuff is not shown by Zynthian-UI. If you want to use banks for organizing your snapshots, you simply create a second bank using the webconf tool and the hidden bank functionality will be enabled.
 +
 
 +
When using snapshot banks, if you want to go up one level (from snapshot list to bank list), you must use the ".." entry. The back button will close the snapshot screen.
 +
 
 +
====Default Snapshot====
 +
You can save the status as "Default Snapshot". This "Default Snapshot" will be loaded automatically at startup. To delete it, you can use the webconf tool or the command line.
 +
 
 +
====Restore Last State====
 +
If "Restore last state on startup" option is enabled on webconf (it's enabled by default), then the state will be saved when powering off (using long-click select or from Admin Menu) and restored on next boot. This option has priority over the "Default Snapshot".
   −
Click ''back'' to return to XY-select or bold-click ''back'' to return to the control screen.
   
<br clear=all>
 
<br clear=all>
   Line 293: Line 349:  
<br clear=all>
 
<br clear=all>
   −
====MIDI Program Change====
+
====MIDI Program Change & ZS3 (SubSnapShots)====
 
[[File:Zynthian_ui_midi_zs3_learn.png|400px|right]]
 
[[File:Zynthian_ui_midi_zs3_learn.png|400px|right]]
You can map "SubSnapshots" (ZS3) to MIDI programs. The idea behind this feature is to have a fast preset-change mechanism that can be used on stage. In combination with the “Single Layer” feature, it turns Zynthian in a “Stage-Beast”. You can prepare a snapshot for the full performance, and use ZS3 for fast changing from a song to another, or between parts inside the same song.
+
A ZS3 (SubSnapShot) saves the state of the active layer in the context of the current snapshot (layer layout). When recalled, the saved state is restored and the active layer is changed.
   −
Learning a SubSnapShot is obscenely easy:
+
Every ZS3 includes:
   −
'''1.''' From the control screen, you click the snapshot button '''twice'''. You will see the current list of ZS3s and a message: “Waiting for Program Change…”
+
    - Layer ID
 +
    - Bank Name
 +
    - Preset Name
 +
    - Controller Values
   −
'''2.''' Simply push a “Program Change” button in your keyboard/controller and the ZS3 will be stored in memory, associated with the Program number you send.
+
Once a set of layers has been created (i.e. loading a snapshot), ZS3 loading is very fast in comparison with loading snapshots, as no engine have to be started. It take less than 1 second in most of cases, and you can map ZS3s to MIDI programs very easily using MIDI learning.
   −
After that, you can recall any stored ZS3 by simply pushing the same PC button again. Of course, the memory-stored zs3s will be saved with your snapshot and restored when loaded again.  
+
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 from a song to another, or between parts inside the same song.
   −
Every zs3 includes:
+
Learning to create a SubSnapShot is obscenely easy:
   −
    - Layer ID
+
'''0.''' Ensure "Program Change ZS3" is enabled in the admin menu.
    - Bank
  −
    - Preset
  −
    - Controller values
     −
As you can see, it has sense in a SnapShot context, where a set of layers are defined. Zs3 changing is very fast, as no engine have to be started.
+
'''1.''' From the Control screen, short click the snapshot button to enter MIDI control learn mode then short click the snapshot button. You will see the current list of ZS3s (initially empty) and a message: “Waiting for Program Change…”
<br clear=all>
     −
==Load/Save Snapshot==
+
'''2.''' Push a “Program Change” button in your keyboard/controller and the ZS3 will be stored in memory, associated with the Program Number you pushed on your keyboard/controller.
[[File:Zynthian_ui_snapshot_load.png|400px|right]]
  −
[[File:Zynthian_ui_snapshot_save.png|400px|right]]
  −
Snapshots are used for saving and restoring the status of Zynthian. A snapshot includes the full state, including layers, effects, parameter values, MIDI-learning, etc.
     −
You can enter the ''Load Snapshot'' screen with '''bold-snapshot'''. It works from any place. A second click and you will be at the ''Save Snapshot'' screen.
+
After that, you can recall the stored ZS3 by pushing the same Program Change button again. Of course, stored ZS3s will be saved with your snapshot and restored on load.  
   −
Before loading any snapshot, you should save one, and to save a snapshot, you should create some layers, etc. The Zynthian UI will use numbers for naming the banks and snapshots. You can rename the snapshots to something more specific using the webconf tool.
+
You can update and delete stored ZS3s by bold-clicking on the list.
   −
====Snapshot Banks====
+
ZS3 behavior depends of the mode your zynthian is working on:
By default, snapshots are stored as a single list and bank-related stuff is not shown by Zynthian-UI. If you want to use banks for organizing your snapshots, you simply create a second bank using the webconf tool and the hidden bank functionality will be enabled.
  −
 
  −
When using snapshot banks, if you want to go up one level (from snapshot list to bank list), you must use the ".." entry. The back button will close the snapshot screen.
  −
 
  −
====Default Snapshot====
  −
You can save the status as "Default Snapshot". This "Default Snapshot" will be loaded automatically at startup. To delete it, you can use the webconf tool or the command line.
     −
====Restore Last State====
+
* '''Stage Mode''': ZS3 list shows all the ZS3s stored, no matter the layer. Recalling a ZS3 changes the active layer, so the layer associated with the recalled ZS3 will receive *ALL* the MIDI input. Only 127 ZS3s can be stored.
If "Restore last state on startup" option is enabled on webconf (it's enabled by default), then the state will be saved when powering off (using long-click select or from Admin Menu) and restored on next boot. This option has priority over the "Default Snapshot".
+
* '''Multi-timbral Mode''': ZS3 list shows the ZS3 of the currently active layer only. Recalling a ZS3 changes the active layer, but every layer 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>
Line 342: Line 388:  
[[File:zynthian_ui_audio_recorder.png|400px|right]]
 
[[File:zynthian_ui_audio_recorder.png|400px|right]]
 
[[File:zynthian_ui_midi_recorder.png|400px|right]]
 
[[File:zynthian_ui_midi_recorder.png|400px|right]]
 +
 +
===Overview===
    
These simple tools allow you to record Audio & MIDI tracks easily, using the internal SD-card or an USB memory stick for storing the files.  
 
These simple tools allow you to record Audio & MIDI tracks easily, using the internal SD-card or an USB memory stick for storing the files.  
 +
 +
It's also used when you want a quick way to upload sound samples to websites via the webconf component detailed below...
 +
 +
Most sites would prefer you to upload compressed files and oggs are perhaps the way forward . . .
    
For accessing the Audio & MIDI recording tools:
 
For accessing the Audio & MIDI recording tools:
Line 353: Line 405:       −
  '''WARNING!''' Using the internal SD card to store the captured files will increase the risk of corruption. You should use a USB memory stick instead.
+
  '''WARNING!''' Using the internal SD card to store the captured files will increase the risk of corruption. You should use a [[External storage|USB memory stick]] instead.
    
===Recording===
 
===Recording===
Line 377: Line 429:     
A bold press will delete the selected file, but you will be asked to confirm the action.
 
A bold press will delete the selected file, but you will be asked to confirm the action.
 +
 +
<br clear=all>
    
===Managing recordings from your computer===
 
===Managing recordings from your computer===
 +
 +
[[File:Zynthian_webconf_captures_02.png|400px|border|right]]
    
Audio & MIDI recordings can be managed from your computer by accessing the webconf's captures section. From this section you can:
 
Audio & MIDI recordings can be managed from your computer by accessing the webconf's captures section. From this section you can:
Line 384: Line 440:  
* rename recordings
 
* rename recordings
 
* delete recordings
 
* delete recordings
* convert audio recordings to .ogg format
+
* convert audio recordings to .ogg format for upload to websites.
 
* downloading recordings to your computer
 
* downloading recordings to your computer
 
* reproduce the audio recordings in your browser. If .wav files doesn't work in your browser, try converting to ogg.
 
* reproduce the audio recordings in your browser. If .wav files doesn't work in your browser, try converting to ogg.
    
It is a good idea to rename your recordings so they can be easily identified.
 
It is a good idea to rename your recordings so they can be easily identified.
  −
[[File:Zynthian_webconf_captures_02.png|600px|border|left]]
      
<br clear=all>
 
<br clear=all>
   −
==ALSA Mixer==
+
==Audio Levels==
    
[[File:zynthian_ui_mixer_control.png|400px|right]]
 
[[File:zynthian_ui_mixer_control.png|400px|right]]
   −
The '''ALSA Mixer''' app is a pseudo-layer that allows to adjust the soundcard output/input levels and other audio-hardware related options. Technically speaking, it's a user interface for the ALSA (Audio Linux Sound Architecture) mixer.
+
The '''Audio Levels''' screen allows to adjust the soundcard output/input levels and other audio-hardware related options. Technically speaking, it's a GUI for the ALSA (Audio Linux Sound Architecture) mixer.
    
For accessing the '''ALSA-Mixer''' app, you have 2 options:
 
For accessing the '''ALSA-Mixer''' app, you have 2 options:
   −
* Selecting "ALSA-Mixer" option from the Main menu
+
* Selecting "Audio Levels" option from the Main menu
* '''Long-pushing the layer knob (CTRL-1)'''
+
* '''Long-pushing the snapshot knob (CTRL-3)'''
   −
You can configure the mixer controllers from the webconf's hardware->audio menu. Simply click the '''+''' button on the "Mixer Controls" text area.  
+
You can configure the Audio Level controllers from the webconf's hardware->audio menu. Simply click the '''+''' button on the "Mixer Controls" text area.  
    
<br clear=all>
 
<br clear=all>
 +
 +
==Step Sequencer==
 +
 +
Zynthian has a step sequencer which provides methods to create patterns and arrange them into sequences.
 +
 +
The step sequencer may be accessed from the main screen or by clicking long-LAYER.
 +
 +
* There may be up to 999 patterns, each with as many simultaneous notes (polphonic) as required over a set of steps and beats that are configurable for each pattern.
 +
* Patterns are arranged into tracks within sequences.
 +
* Sequences may be configured to loop or play once and may be grouped so that starting one sequence stops another. Sequences may start and stop at the start of each bar.
 +
* Note entry can be performed from the Zynthian user interface or using an external MIDI controller.
 +
* Sequences can be started and stopped from the Zynthian user interface or using an external MIDI controller.
 +
 +
These are three main views:
 +
 +
[[File:Zynpad 4x4 playing starting.png|400px|right]]
 +
 +
'''Pads'''<br>
 +
Grid of pads to launch sequences
 +
 +
<br clear=all>
 +
 +
[[File:Arranger.png|400px|right]]
 +
 +
'''Arranger'''<br>
 +
Track / timeline editor for complex manipulation of sequences
 +
 +
<br clear=all>
 +
 +
[[File:Zynseq patterneditor notevelocity.png|400px|right]]
 +
 +
'''Pattern Editor'''<br>
 +
Manipulation of individual events within patterns
 +
 +
<br clear=all>
 +
 +
[[Using ZynSeq]] is a detailed tutorial on the use of the step sequencer.
    
==Admin Menu==
 
==Admin Menu==
Line 414: Line 505:  
[[File:Zynthian_ui_admin_02.png|400px|right]]
 
[[File:Zynthian_ui_admin_02.png|400px|right]]
   −
The Admin menu give access to some configuration options (most of them also accessible from the webconf tool).
+
The Admin menu gives access to some configuration options (most of them also accessible from the webconf tool). Also includes basic testing options for audio and MIDI.
 +
 
 +
You can access this menu from the Main menu.
 +
 
 +
<br clear=all>
 +
 
 +
===Touchscreen Calibration===
 +
 
 +
Zynthian supports touchscreen operation for most operations. To ensure good alignment of the touch interface there is a calibration screen that is accessed from the Admin menu.
 +
 
 +
[[File:Touchscreen_calibration_1.png|400px|right]]
 +
 
 +
When the screen opens it shows a target crosshair in the center of the screen and a countdown timer. If the timer expires the screen will close without applying any calibration. Touch the target to detect the screen and begin calibration.
 +
 
 +
<br clear=all>
 +
 
 +
[[File:Touchscreen_calibration_2.png|400px|right]]
 +
 
 +
The name of the detected display is shown at the bottom of the screen. Further targets will appear. Touch the screen, drag to centre of target and release.
 +
 
 +
When the screen is pressed the target will show red. When released the measurement is taken and the next crosshair target appears white.
 +
 
 +
<br clear=all>
 +
 
 +
[[File:Touchscreen_calibration_3.png|400px|right]]
 +
 
 +
After releasing the last target, calibration is applied and the screen closes. Touch is ignored if too close to previous touch.
 +
 
 +
Use BACK button or wait for timeout to cancel calibration. Timer is reset to 15s when screen is touched and paused until released. The purpose of the timeout is to avoid users of Zynthians without back button being stuck in calibration screen view.
   −
For accessing this menu:
     −
* From any place, '''long-back'''
+
{{NoteBox| The resistive touchscreen works better with a stylus. Finger is too coarse. It's strongly recommended to run the calibration using a stylus. }}
* From Main menu
      
<br clear=all>
 
<br clear=all>
Line 456: Line 573:  
==Key Bindings: Controlling the UI with a computer keyboard==
 
==Key Bindings: Controlling the UI with a computer keyboard==
   −
The user interface may be driven using a USB keyboard, e.g. QWERTY, Dvorak, etc.
+
The user interface may be driven using a USB keyboard, e.g. QWERTY, Dvorak, etc. Key assignment and their combinations can be modified with the webconf tool.
    
{| class="wikitable"
 
{| class="wikitable"
 +
|+ Keyboard shortcuts
 +
|-
 +
! Action !! Modifier !! Key
 +
|-
 +
| ALL_NOTES_OFF || None|| Space
 
|-
 
|-
!Key
+
| ALL_OFF || Ctrl || Space
!Modifier
  −
!Function
   
|-
 
|-
|Enter||None||SELECT
+
| ALL_SOUNDS_OFF || Shift || Space
 
|-
 
|-
|Enter||Shift||Bold SELECT
+
| BACK_DOWN || CapsLock || Down
 
|-
 
|-
|Enter||Ctrl||Long SELECT
+
| BACK_UP || CapsLock || Up
 
|-
 
|-
|Backspace||None||BACK
+
| LAYER_DOWN || Shift || Down
 
|-
 
|-
|Backspace||Shift||Bold BACK
+
| LAYER_UP || Shift || Up
 
|-
 
|-
|Backspace||Ctrl||Long BACK
+
| POWER_OFF || Ctrl || End
 
|-
 
|-
|Escape||None||BACK
+
| REBOOT || Ctrl || Home
 
|-
 
|-
|Escape||Shift||Bold BACK
+
| RELOAD_MIDI_CONFIG || Ctrl || Insert
 
|-
 
|-
|Escape||Ctrl||Long BACK
+
| RESTART_UI || Shift || Home
 
|-
 
|-
|L||None||LAYER
+
| SELECT_DOWN || None || Down
 
|-
 
|-
|L||Shift||Bold LAYER
+
| SELECT_UP || None || Up
 
|-
 
|-
|L||Ctrl||Long LAYER
+
| SNAPSHOT_DOWN || Ctrl || Down
 
|-
 
|-
|S||None||SNAPSHOT
+
| SNAPSHOT_UP || Ctrl || Up
 
|-
 
|-
|S||Shift||Bold SNAPSHOT
+
| START_AUDIO_PLAY || Ctrl || a
 
|-
 
|-
|S||Ctrl||Long SNAPSHOT
+
| START_AUDIO_RECORD || None || a
 
|-
 
|-
|A||None||Start audio Record
+
| START_MIDI_PLAY || Ctrl || m
 
|-
 
|-
|A||Shift||Stop audio Record
+
| START_MIDI_RECORD || None || m
 
|-
 
|-
|A||Alt||Toggle audio Record
+
| STOP_AUDIO_PLAY || Ctrl+Shift|| a
 
|-
 
|-
|A||Ctrl||Start audio Play
+
| STOP_AUDIO_RECORD || Shift || a
 
|-
 
|-
|A||Ctrl+Shift||Stop audio Play
+
| STOP_MIDI_PLAY || Ctrl+Shift || m
 
|-
 
|-
|M||None||Start MIDI Record
+
| STOP_MIDI_RECORD || Shift || m
 
|-
 
|-
|M||Shift||Stop MIDI Record
+
| SWITCH_BACK_BOLD || Shift || BackSpace, Escape, Left
 
|-
 
|-
|M||Ctrl||Start MIDI Play
+
| SWITCH_BACK_LONG || Ctrl || BackSpace, Escape, Left
 
|-
 
|-
|M||Ctrl+Shift||Stop MIDI Play
+
| SWITCH_BACK_SHORT || None || BackSpace, Escape, Left
 
|-
 
|-
|Space||None||All Notes Off
+
| SWITCH_LAYER_BOLD || Shift|| l
 
|-
 
|-
|Space||Shift||All Sounds Off
+
| SWITCH_LAYER_LONG || Ctrl || l
 
|-
 
|-
|Space||Ctrl||All off
+
| SWITCH_LAYER_SHORT || None|| l
 
|-
 
|-
|Home||Shift||Restart UI
+
| SWITCH_SELECT_BOLD || Shift || Return, Right
 
|-
 
|-
|Insert||Ctrl||Reload MIDI Config
+
| SWITCH_SELECT_LONG || Ctrl || Return, Right
 
|-
 
|-
|Home||Ctrl||Reboot
+
| SWITCH_SELECT_SHORT || None || Return, Right
 
|-
 
|-
|End||Ctrl||Power Off
+
| SWITCH_SNAPSHOT_BOLD || Shift || s
 
|-
 
|-
|Up||None||Listbox Up
+
| SWITCH_SNAPSHOT_LONG || Ctrl || s
 
|-
 
|-
|Down||None||Listbox Down
+
| SWITCH_SNAPSHOT_SHORT || None || s
 
|-
 
|-
|Left||None||BACK
+
| TOGGLE_AUDIO_PLAY || CapsLock+Shift || a
 
|-
 
|-
|Right||None||SELECT
+
| TOGGLE_AUDIO_RECORD || CapsLock || a
 +
|-
 +
| TOGGLE_MIDI_PLAY || CapsLock+Shift || m
 +
|-
 +
| TOGGLE_MIDI_RECORD || CapsLock || m
 
|}
 
|}
   Line 545: Line 669:  
or play the C-1 key, if your keyboard has it.
 
or play the C-1 key, if your keyboard has it.
   −
This is the full list:
+
Note that you can use the velocity for sending the CUIA parameter when it's required by the action (SELECT & LAYER_CONTROL).
 +
 
 +
This is the full map of CUIA to MIDI notes:
    
  '''Num'''  '''CUIA'''                      '''Note'''        '''System Real-Time'''
 
  '''Num'''  '''CUIA'''                      '''Note'''        '''System Real-Time'''
Line 552: Line 678:  
  2    RESTART_UI                D-1
 
  2    RESTART_UI                D-1
 
  3    RELOAD_MIDI_CONFIG        D#-1
 
  3    RELOAD_MIDI_CONFIG        D#-1
  4    RELOAD_KEY_CONFIG         E-1
+
  4    RELOAD_KEY_BINDING        E-1
 +
5    LAST_STATE_ACTION         F-1
    
  10    ALL_NOTES_OFF              A#-1
 
  10    ALL_NOTES_OFF              A#-1
Line 575: Line 702:  
  52    SELECT_UP                  E3
 
  52    SELECT_UP                  E3
 
  53    SELECT_DOWN                F3
 
  53    SELECT_DOWN                F3
 +
54    BACK_UP                    F#3
 +
55    BACK_DOWN                  G3
 +
56    LAYER_UP                  G#3
 +
57    LAYER_DOWN                A3
 +
58    SNAPSHOT_UP                A#3
 +
59    SNAPSHOT_DOWN              B3
    
  64    SWITCH_BACK_SHORT          E4
 
  64    SWITCH_BACK_SHORT          E4
Line 591: Line 724:  
  72    SWITCH_SNAPSHOT_BOLD      C5
 
  72    SWITCH_SNAPSHOT_BOLD      C5
 
  73    SWITCH_SNAPSHOT_LONG      C#5
 
  73    SWITCH_SNAPSHOT_LONG      C#5
 +
 +
80    SCREEN_MAIN                G#5
 +
81    SCREEN_LAYER              A5
 +
82    SCREEN_BANK                A#5
 +
83    SCREEN_PRESET              B5
 +
84    SCREEN_CONTROL            C6
 +
 +
90    MODAL_SNAPSHOT_LOAD        F#6
 +
91    MODAL_SNAPSHOT_SAVE        G6
 +
92    MODAL_AUDIO_RECORDER      G#6
 +
93    MODAL_MIDI_RECORDER        A6
 +
94    MODAL_ALSA_MIXER          A#6
 +
95    MODAL_STEPSEQ              B6
 +
96    MODAL_ADMIN                C7
 +
 +
100  LAYER_CONTROL              E7
    
[[File:2Oct_Keyboard_CUIA.png|600px|Keyboard]]
 
[[File:2Oct_Keyboard_CUIA.png|600px|Keyboard]]
    
[[File:Midi-note-chart.jpg]]
 
[[File:Midi-note-chart.jpg]]
 +
 +
==Controlling the UI with OSC messages==
 +
 +
The same CUIA calls are available using OSC on UDP 1370, with the base prefix "/cuia". Take a look to "[[Accessing_Zynthian_from_your_computer#OSC|Calling CUIA with OSC]]".

Navigation menu