334
edits
Changes
Jump to navigation
Jump to search
Line 4:
Line 4: − + Line 35:
Line 35: − + Line 136:
Line 136: − + − + − + + − + − + Line 156:
Line 157: − + − + − + − + + Line 177:
Line 179: + + − + − + − + − + − + + + + + + + + + + + − * '''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. − + − + − + − 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.+ Line 243:
Line 254: − + Line 321:
Line 332: − + Line 334:
Line 345: − + − + − + − + − + − + − + Line 358:
Line 369: + + + + + + + + Line 369:
Line 388: − + Line 404:
Line 423: − + Line 703:
Line 722: − + Line 709:
Line 728: − + − + − + − + − + Line 773:
Line 792: + + + + + + + + + + + + + + + + + + + + + + + + + + Line 961:
Line 1,006: + + + + +
Zynthian UI User Guide (oldstable-2109) (view source)
Revision as of 08:29, 5 January 2021
, 08:29, 5 January 2021no edit summary
[[File:zynthian_controllers.png|430px|right]]
[[File:zynthian_controllers.png|430px|right]]
The physical Zynthian UI is displayed on a display and controlled by 4 knobs (rotary-encoders with push-switches). You can also control the UI with a touch-display, a mouse or keyboard (computer keyboard or MIDI keyboard, both!)
The Zynthian UI is displayed on a display and controlled by 4 knobs (rotary-encoders with push-switches). You can also control the UI with a touch-display, a mouse or a keyboard (computer keyboard or MIDI keyboard, both!)
Anyway, the 4 knobs+switches are the primary control mechanism used to navigate the UI: selecting options on menus and adjust 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 behavior using the touch-display, but it's sub-optimal and accessing some features could be tricky.
Anyway, the 4 knobs+switches are the primary control mechanism used to navigate the UI: selecting options on menus and adjust 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 behavior using the touch-display, but it's sub-optimal and accessing some features could be tricky.
* '''long-layer''': ALSA Mixer app
* '''long-layer''': ALSA Mixer app
* '''long-back''': PANIC! All Notes Off
* '''long-back''': PANIC! All Notes Off
* '''long-snapshot''': Audio Recorder
* '''long-snapshot''': Step Sequencer
* '''long-select''': Power Off
* '''long-select''': Power Off
==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:
[[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.
[[File:Zynthian_ui_layer_options.png|400px|right]]
[[File:Zynthian_ui_layer_options.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.
* '''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.
* '''Transpose''' => transpose the '''layer's MIDI channel''' up and down, by semitones.
* '''Transpose''' => Transpose the '''layer's MIDI channel''' up and down, by semitones.
* '''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.
<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'''
* '''Replace FX'''
* '''Effect Presets'''
* '''Effect Presets'''
* '''Move Upchain'''
* '''Move Upchain'''
* '''Move Downchain'''
* '''Move Downchain'''
* '''Remove Effect'''
* '''Remove FX'''
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>
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. For listing only your favorite presets, use '''bold-snapshot'''.
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'''.
<br clear=all>
<br clear=all>
<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 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.
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.
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.
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.
The idea behind this feature is to have a fast preset-change mechanism that can be used on stage. In combination with the “Single Active Layer” 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.
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.
Learning to create a SubSnapShot is obscenely easy:
Learning to create a SubSnapShot is obscenely easy:
'''1.''' From the Control screen, click the snapshot button '''twice'''. You will see the current list of ZS3s and a message: “Waiting for Program Change…”
'''1.''' From the Control screen, click the snapshot button '''twice'''. You will see the current list of ZS3s (initially empty) and a message: “Waiting for Program Change…”
'''2.''' Push a “Program Change” button in your keyboard/controller and the ZS3 will be stored in memory, associated with the Program Number you selected.
'''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.
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.
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.
You can update and delete stored ZS3s by bold-clicking on the list. An options menu will be shown with both options.
You can update and delete stored ZS3s by bold-clicking on the list.
ZS3 behavior depends of the "Single Active Layer" option:
ZS3 behavior depends of the mode your zynthian is working on:
* '''Single Active Layer Enabled''': 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.
* '''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.
* '''Single Active Layer Disabled''': ZS3 list shows only the ZS3 of the currently active layer. Recalling a ZS3 changes the active layer, but every layer receives MIDI input for its channel only. You can use several keyboards on different channels and store 127 ZS3s by MIDI channel.
* '''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>
[[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===
[[File:Zynstatio.png|40px]]
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:
'''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===
* 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.
An icon on the pad indicates the play mode:
An icon on the pad indicates the play mode:
{| class="wikitable"
{| class="wikitable" style="background-color:#cccccc;"
|-
|-
!Icon
!Icon
!Description
!Description
|-
|-
|None||Disabled||No sequence will play
|||Disabled||No sequence will play
|-
|-
|endnoline||Oneshot||Sequence will play only once, stopping immediately when pad clicked
|[[File:ZynPadEndnoline.png]]||Oneshot||Sequence will play only once, stopping immediately when pad clicked
|-
|-
|loop||Loop||Sequence will play in a continuous loop, stopping immediately when pad clicked
|[[File:ZynPadLoop.png]]||Loop||Sequence will play in a continuous loop, stopping immediately when pad clicked
|-
|-
|end||Oneshot All||Sequence will play only once, stopping at next sync point after pad clicked
|[[File:ZynPadEnd.png]]||Oneshot All||Sequence will play only once, stopping at next sync point after pad clicked
|-
|-
|loopstop||Loop All||Sequence will play in a continuous loop, stopping at next sync point after pad clicked
|[[File:ZynPadLoopstop.png]]||Loop All||Sequence will play in a continuous loop, stopping at next sync point after pad clicked
|}
|}
You can access this menu from the Main menu.
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|200px|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|200px|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|200px|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.
<br clear=all>
<br clear=all>
[[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]]".