334
edits
Changes
Jump to navigation
Jump to search
Line 4:
Line 4: − + − 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.+ + − + Line 18:
Line 19: − + + + Line 31:
Line 34: − + Line 48:
Line 51: + + Line 91:
Line 96: − + − + − + − + Line 160:
Line 165: − + Line 199:
Line 204: − + Line 215:
Line 220: − + Line 225:
Line 230: − + − + Line 236:
Line 241: − + + + − + Line 257:
Line 264: − 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. − <br clear=all> − [[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). − Click ''back'' to return to XY-select or bold-click ''back'' to return to the control screen.+ − ====Tips====+ − You can press the Layer switch to step over the layer list. If you bold-press, the layer list screen will be shown.+ − Press the Back switch to return to previous screen. If you press bold-Back, you will go 2 screens backwards.+ − + − + Line 294:
Line 298: − + − + − + − Pressing the Back knob, when you are in the Layer List screen, brings you to the Admin menu. + + + + + + + + + + + + + − The last item is how you safely power off the Zynthian without corrupting data files.+ − * Network Info - displays the IP address (ifconfig inet addr)+ − * Start WIFI - Starts or Stops WIFI (toggle) − * Start Audio Recording − * Start TouchOSC bridge − * Start Audio -> MIDI − * Test MIDI - plays the test.mid file − * Test Audio - plays the (long) test.mp3 file − * Update Zynthian Software - downloads and installs the latest software − * Update Zynthian Library - downloads the latest instruments − * Restart GUI − * Reboot − * Power Off − + + + + + + + + + + + + + + + + + + − [[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.+ − For accessing the '''ALSA-Mixer''' app, you have 2 options:+ − * Selecting "ALSA-Mixer" option from the Main menu+ − * '''Long-pushing the layer knob (CTRL-1)''' − You can configure the mixer controllers from the webconf's hardware->audio menu. Simply click the '''+''' button on the "Mixer Controls" text area. + + Line 337:
Line 359: − From the Admin menu you can gain access to the Audio & MIDI recording tools. ( Short Press on the L/S encoder will lead you to the Appsmenu page. 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. + + + + + + + + + Line 363:
Line 393: + + + + Line 376:
Line 410: − + + + + + + + + + + + + + + − + − + − You can navigate and control the Zynthian UI without knobs/encoders/switches at all, using only the touchscreen.+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + − You can "emulate" the switches by tapping the controller widgets (squares in the 4 corners of the screen). There are short, bold and long actions, same behaviour than rotary encoders work-flow. The only screen having the 4 controller widgets is the "Instrument Control" screen. Most of screens are selectors, which only have 1 controller widget. On those screens you can click the '''zynthian logo''' (top-right) to emulate the "snapshot" switch, and you can go back by tapping the '''top-bar''' area.+ − You can change the controller values by "sliding" up/down over the widgets. (see the green arrow in the figure) This is the same as turning the knob. If you are using a mouse, the mouse wheel also can be used to change the controller value.+ + − <br clear=all>+ + + + + − =MIDI-learning=+ − + + − + − [[File:Zynthian_ui_midi_cc_learn_01.png|400px|right]]+ − [[File:Zynthian_ui_midi_cc_learn_02.png|400px|right]]+ − You can map any parameter in the Zynthian UI to a CC knob/slider on your external MIDI controller. I intend to extend this feature to other MIDI messages, but currently only CC messages are supported. Until then, MIDI-filter rules can be used instead.+ − Learning a MIDI-CC is quite easy:+ + + + + − + − '''2.''' Move a zynthian controller. Its tiny “???” will change to green while the other 3 will go back to normal state.+ + − + + + + + − Of course, MIDI-learning configuration, including CC mappings, is stored and restored with snapshots.+ + + + + + − '''Technical Note:''' MIDI-CC learning works with all the engines. It uses the engine’s native MIDI-learning capabilities when available. Zynthian’s MIDI-filter mappings are used for the rest. To be more explicit, native MIDI-learning is used for MOD-UI and ZynAddSubFX OSC parameters. All the other parameters are managed by Zynthian’s MIDI-filter mapping.+ − <br clear=all>+ + − ====MIDI Program Change====+ − [[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. − Learning a SubSnapShot is obscenely easy:+ − '''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…”+ − '''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.+ − 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. + + − Every zs3 includes:+ − - Layer ID+ − - 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. − − First, you need a working touch interface in your display. If you don't have a touchscreen, you could use a mouse. Line 594:
Line 944: + + + + + + + + + + + + +
Zynthian UI User Guide (oldstable-2109) (view source)
Revision as of 13:18, 28 May 2020
, 13:18, 28 May 2020→Playing ZynPad
[[File:zynthian_controllers.png|430px|right]]
[[File:zynthian_controllers.png|430px|right]]
The Zynthian UI is displayed on a touch display and controlled by 4 knobs (rotary-encoders with push-switches).
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!)
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.
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 maps, which you can use to change the parameters controlled by the knobs.
* '''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"
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):
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).
* '''short click:''' less than 0.3 seconds
* '''short click:''' less than 0.3 seconds
* '''bold click:''' between 0.3 and 2 seconds
* '''bold click:''' between 0.3 and 2 seconds
* '''long click:''' more than 2 seconds
* '''long click:''' more than 2 seconds
These timing values are the default ones. You can adjust them to your personal feeling from the UI options on the webconf tool.
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.
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.
* '''bold-snapshot''': Load Snapshot menu
* '''bold-snapshot''': Load Snapshot menu
* '''long-layer''': ALSA Mixer app
* '''long-layer''': ALSA Mixer app
* '''long-back''': Admin menu
* '''long-back''': PANIC! All Notes Off
* '''long-snapshot''': Audio Recorder
* '''long-snapshot''': Audio Recorder
* '''long-select''': Power Off
* '''long-select''': Power Off
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:
[[File:Status display.png|400px|right]]
* Audio Peak-meter or CPU-load => 1 or 2 small horizontal bars on the top right.
* Audio Peak-meter or CPU-load => 1 or 2 small horizontal bars on the top right.
<gallery mode="slideshow" widths="240" heights="320">
<gallery mode="slideshow" widths="240" heights="320">
Image:zynthian_ui_workflow__main.svg|''[[commons:Main Sequence|Main Sequence]]''
Image:zynthian_ui_workflow__main.png|''[[commons:Main Sequence|Main Sequence]]''
Image:zynthian_ui_workflow__layer_options.svg|''[[commons:Layer Options|Layer Options]]''
Image:zynthian_ui_workflow__layer_options.png|''[[commons:Layer Options|Layer Options]]''
Image:zynthian_ui_workflow__snapshots.svg|''[[commons:Snapshots|Snapshots]]''
Image:zynthian_ui_workflow__snapshots.png|''[[commons:Snapshots|Snapshots]]''
Image:zynthian_ui_workflow__midi_learning.svg|''[[commons:MIDI Learning|MIDI Learning]]''
Image:zynthian_ui_workflow__midi_learning.png|''[[commons:MIDI Learning|MIDI Learning]]''
</gallery>
</gallery>
* '''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>
<br clear=all>
<br clear=all>
==Engine Selection==
==Engine Selector==
[[File:Zynthian_ui_engine_list.png|400px|right]]
[[File:Zynthian_ui_engine_list.png|400px|right]]
When you create a new layer, you are asked which engine/plugin you want to use for it. A list of engines to choose from is displayed. They can be synthesizers, effects, generators or special engines, depending on the type of layer 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 layer, you are asked which engine/plugin you want to use for it. A list of engines to choose from is displayed. They can be synthesizers, effects, generators or special engines, depending on the type of layer 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.
<br clear=all>
<br clear=all>
==MIDI Channel selection==
==MIDI Channel selector==
[[File:Zynthian_ui_midi_channel.png|400px|right]]
[[File:Zynthian_ui_midi_channel.png|400px|right]]
This screen is shown in various contexts:
This screen is shown in various contexts:
<br clear=all>
<br clear=all>
== Bank selection==
== Bank selector==
[[File:Zynthian_ui_bank_list.png|400px|right]]
[[File:Zynthian_ui_bank_list.png|400px|right]]
Presets (instruments, patches, or sound designs) for a synth engine are organized into banks. Choose a bank to see the list of presets you can pick from within that bank.
Presets (instruments, patches, or sound designs) for a synth engine are organized into banks. Choose a bank to see the list of presets you can pick from within that bank.
<br clear=all>
<br clear=all>
==Preset selection==
==Preset selector==
[[File:Zynthian_ui_preset_list.png|400px|right]]
[[File:Zynthian_ui_preset_list.png|400px|right]]
Once you have chosen a bank, the preset screen will be shown. Choose a preset to load the instrument/sound/patch you want and the Control Instrument screen will be shown.
Once you have chosen a bank, the preset screen will be shown. Choose a preset to load the instrument/sound/patch you want and the Control Instrument screen will be shown.
If the '''preload with note-on''' feature is enabled, you can preload the presets by playing notes. When you do so, the highlighted preset will be pre-loaded before clicking select.
If the '''preload with note-on''' feature is enabled, you can preload the presets by playing notes. When you do so, the highlighted preset will be pre-loaded before clicking select.
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'''.
<br clear=all>
<br clear=all>
==Instrument Control screen==
==Control screen==
[[File:Zynthian_ui_instrument_control_01.png|400px|right]]
[[File:Zynthian_ui_instrument_control_01.png|400px|right]]
This screen is shown after you have chosen a preset. Your instrument is now enabled and playable and you can modify the parameters.
This screen is shown after you have chosen a preset. Your instrument is now enabled and playable and you can modify the parameters.
====XY-Controller====
====XY-Controller====
[[File:Zynthian_ui_xy_select.png|400px|right]]
[[File:Zynthian_ui_xy_select.png|400px|right]]
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, navigating through the controller pages if needed.
<br clear=all>
<br clear=all>
[[File:Zynthian_ui_xy_controller.png|400px|right]]
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>
<br clear=all>
==Snapshots==
==Load/Save Snapshot==
[[File:Zynthian_ui_snapshot_load.png|400px|right]]
[[File:Zynthian_ui_snapshot_load.png|400px|right]]
[[File:Zynthian_ui_snapshot_save.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.
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 by clicking the snapshot switch. From the control screen you have to use bold-click. A second click and you will be at the ''Save Snapshot'' screen. You can also use bold-click to go directly to the Save Snapshot screen (not from control screen!).
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.
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.
<br clear=all>
<br clear=all>
==Admin Menu==
==MIDI-learning==
[[File:Zynthian_ui_admin.png|400px|right]]
[[File:Zynthian_ui_admin_02.png|400px|right]]
MIDI-learning allows you to easily bind specific MIDI events with Zynthian-UI actions. There are 2 types of MIDI events you can learn:
====MIDI CC====
[[File:Zynthian_ui_midi_cc_learn_01.png|400px|right]]
[[File:Zynthian_ui_midi_cc_learn_02.png|400px|right]]
You can map any parameter in the Zynthian UI to a CC knob/slider on your external MIDI controller. I intend to extend this feature to other MIDI messages, but currently only CC messages are supported. Until then, MIDI-filter rules can be used instead.
Learning a MIDI-CC is quite easy:
'''1.''' From the control screen, you click the snapshot button. You will be in CC MIDI-learn screen. It’s identical to the Control screen except that all the controllers have a tiny yellow “???” in the bottom.
'''2.''' Move a zynthian controller. Its tiny “???” will change to green while the other 3 will go back to normal state.
'''3.''' Finally, move a knob/fader in your MIDI keyboard/controller and the binding is done. The new CC number should appear in the bottom of the learned controller, replacing the tiny "???".
Of course, MIDI-learning configuration, including CC mappings, is stored and restored with snapshots.
'''Technical Note:''' MIDI-CC learning works with all the engines. It uses the engine’s native MIDI-learning capabilities when available. Zynthian’s MIDI-filter mappings are used for the rest. To be more explicit, native MIDI-learning is used for MOD-UI and ZynAddSubFX OSC parameters. All the other parameters are managed by Zynthian’s MIDI-filter mapping.
<br clear=all>
<br clear=all>
==ALSA Mixer==
====MIDI Program Change: ZS3 (SubSnapShots)====
[[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.
Every ZS3 includes:
- Layer ID
- Bank Name
- Preset Name
- Controller Values
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.
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…”
'''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.
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.
ZS3 behavior depends of the "Single Active Layer" option:
* '''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.
* '''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.
<br clear=all>
<br clear=all>
[[File:zynthian_ui_midi_recorder.png|400px|right]]
[[File:zynthian_ui_midi_recorder.png|400px|right]]
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.
For accessing the Audio & MIDI recording tools:
* From the '''Main menu''', select Audio Recorder
* From any place, '''long-snapshot'''
When you are in, '''short-snapshot''' for switching between Audio & MIDI Recorder.
'''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 USB memory stick instead.
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|600px|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:
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>
==ALSA Mixer==
[[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.
For accessing the '''ALSA-Mixer''' app, you have 2 options:
* Selecting "ALSA-Mixer" option from the Main menu
* '''Long-pushing the layer knob (CTRL-1)'''
You can configure the mixer controllers from the webconf's hardware->audio menu. Simply click the '''+''' button on the "Mixer Controls" text area.
<br clear=all>
<br clear=all>
= Touch Screen UI=
==Step Sequencer==
[[File:Zynthian_ui_top_bar.png|400px|right]]
'''Note: Step Sequencer is alpha software'''
Zynthian has a step sequencer which provides:
* Pattern editor
* Song editor
* Pad triggers (ZynPad)
The step sequencer may be accessed from the main Zynthian screen or by a long press of the SNAPSHOT encoder. Access to the editors and players is via a menu.
===Menu Selection===
Short press the LAYER encoder. The menu is displayed.
Use the LAYER or SELECT encoder to highlight a menu entry.
Move beyond the bottom entry to scroll down if more options are available than screen size allows to display.
Short press the LAYER or SELECT encoder to select the menu entry or short press the BACK encoder to cancel.
Menu may also be accessed by clicking the top bar (not the status display on the right) with a pointing device. Menu options are selected by clicking on them and the menu may be scrolled by dragging up and down.
All patterns and songs are saved to a common file.
===Parameter Editor===
Some parameters must be adjusted using the ''parameter editor''. This is a control that appears in the top bar showing the parameter being adjusted, its value and some buttons to allow up / down adjustment of the parameter.
Access the ''parameter editor'' by selecting a menu entry. The parameter editor is displayed with the current parameter name and value.
Use the LAYER or SELECT encoders to adjust the value. Values may have minimum and maximum limits.
Short press the BACK encoder to cancel and close the editor.
Short press the LAYER or SELECT encoder to assert the value and close the editor.
Parameters may be adjusted with a pointing device by clicking on the cancel, up, down and assert buttons.
===Save===
Short press LAYER encoder displays a menu.
Select "Save" menu option. All patterns and songs are immediately saved to disk.
===Load===
Short press LAYER encoder displays a menu.
Select "Load" menu option. All patterns and songs are immediately loaded from disk.
===Pattern Editor===
[[File:PatternEditor.png|400px|right]]
The pattern editor allows the creation of a sequence of MIDI events within a time-boxed period. This period is defined in ''steps''. The quantity of steps may be selected for each pattern. Any quantity of MIDI events may be added to the pattern at each step. The most common MIDI events are notes. The pattern editor displays a grid with horizontal ''tramlines'' indicating black and white notes. There can be a grid indicating time divisions and octaves. There is a pianoroll on the left with each 'C' note indicated by a legend. Clicking on a note with a pointing device will sound the note briefly. Most common workflows are exposed via rotary encoders, push buttons and pointing device input. More options are available via menus.
====Pattern Selection====
There may be up to 999 patterns loaded into the step sequencer. By default pattern 1 is displayed.
Short press LAYER encoder displays a menu.
Select "Pattern" menu option. The ''parameter editor'' is displayed in the top bar.
Use the LAYER or SELECT encoder to select the pattern to edit. The title and grid change to show the pattern that will be selected.
Short press the LAYER or SELECT encoder to select the pattern or short press BACK encoder to cancel.
====Adding Notes====
Use the BACK encoder to select the note to add. The screen will scroll at top and bottom edges.
Use the SELECT encoder to select the step at which the note will start.
Use the LAYER encoder to select the duration of the note. Duration is indicated by the length of the highlight border.
Use the SNAPSHOT encoder to select the velocity of the note. Velocity is indicated by a yellow bar in the bottom left of the screen.
Short press the SELECT encoder to add the note. The note is indicated by a shaded block starting at the required start step with length indicating duration and opacity indicating velocity.
Notes may also be added by clicking on the note / start step if you have a pointing device. To scroll screen with pointing device drag the pianoroll up or down.
====Removing Notes====
Use the BACK encoder to select the note to remove.
Use the SELECT encoder to select the step at which the note starts.
Short press the SELECT encoder to remove the note.
Notes may also be removed by clicking on the note / start step if you have a pointing device.
====Changing Duration====
Use the BACK encoder to select the note to adjust.
Use the SELECT encoder to select the step at which the note starts.
Use the LAYER encoder to adjust the duration of the note.
====Changing Velocity====
Use the BACK encoder to select the note to adjust.
Use the SELECT encoder to select the step at which the note starts.
Use the SNAPSHOT encoder to adjust the velocity of the note.
====Controlling Playback====
Short press the SNAPSHOT encoder to start playback of the pattern. The pattern will resume playback from its previously stopped step, looping when it reaches the end of the pattern.
Short press the SNAPSHOT encoder to pause playback.
Bold press the SNAPSHOT encoder to stop playback and / or recue to start of pattern.
NOTE: When exiting the ''pattern editor'' playback will stop. This is because the ''pattern editor'' is a design tool and not intended for performance.
Playback may also be controlled with a pointing device by pressing the start / pause and stop / recue buttons in the topbar.
Playback may also be controlled via external MIDI transport control (start, stop, continue, locate).
====Changing Pattern Length====
By default each pattern is 16 steps long. This may be adjusted from 1 to 64 steps in each pattern.
Short press LAYER encoder displays a menu.
Select "Steps in pattern" menu option. The ''parameter editor'' is displayed in the top bar.
Use the LAYER or SELECT encoder to adjust the quantity of steps in the pattern. The quantity of grid columns changes to match the step in pattern.
Note: The pattern editor always shows all the steps, i.e. there is no horizontal scrolling or zooming.
====Change Time Divisions====
A user may wish to use the concept of time divisions, e.g. beats in a bar, steps in a beat, etc. This is presented by the display of vertical lines. By default the steps per beat is 4. This may be adjusted from 0 to 24.
Short press LAYER encoder displays a menu.
Select "Steps per beat" menu option. The ''parameter editor'' is displayed in the top bar.
Use the LAYER or SELECT encoder to adjust the quantity of steps per beat. The vertical grid lines move to match the steps per beat.
Setting to zero will hide vertical lines.
Note: The steps per beat is constrained to the values: 0, 1, 2, 3, 4, 6, 8, 12, 24. This is because it must divide exactly into 24 which is the quantity of clock cycles per beat.
====Transpose====
All notes within a pattern may be permanently transposed.
Short press LAYER encoder displays a menu.
Select "Transpose pattern" menu option. The ''parameter editor'' is displayed in the top bar.
Use the LAYER or SELECT encoder to move all notes up or down. The pianoroll scrolls to indicate the transposition.
====Vertical Zoom====
By default 16 note are shown on the pianoroll and corresponding 16 rows in the grid.
Short press LAYER encoder displays a menu.
Select "Vertical zoom" menu option. The ''parameter editor'' is displayed in the top bar.
Use the LAYER or SELECT encoder to adjust the vertical zoom. The quantity of rows in grid (and notes in pianoroll) change to match the vertical zoom value.
====MIDI channel====
The pattern editor plays its sequence of notes out on a single MIDI channel.
Short press LAYER encoder displays a menu.
Select "MIDI channel" menu option. The ''parameter editor'' is displayed in the top bar.
Use the LAYER or SELECT encoder to adjust the MIDI channel between 1 and 16.
====Clocks Per Step====
By default each step within a pattern is advanced after 6 MIDI clock cycles.
Short press LAYER encoder displays a menu.
Select "Clocks per step" menu option. The ''parameter editor'' is displayed in the top bar.
Use the LAYER or SELECT encoder to adjust the clocks per step.
Note: Adjusting the steps per beat will automatically set the clocks per step. Adjustment of clocks per step allows fine control and less common time signatures.
====Clear Pattern====
A pattern may be cleared of its content.
Short press LAYER encoder displays a menu.
Select "Clear pattern" menu option. The ''parameter editor'' is displayed in the top bar.
Short press the LAYER or SELECT encoder to clear pattern or short press BACK encoder to cancel.
====Copy Pattern====
The currently selected pattern may be copied to another pattern location.
Short press LAYER encoder displays a menu.
Select "Copy pattern" menu option. The ''parameter editor'' is displayed in the top bar.
Use the LAYER or SELECT encoder to select the pattern to copy the previous pattern to. The title and grid change to show the pattern that will be overwritten.
Short press the LAYER or SELECT encoder to overwrite pattern with previously selected pattern or short press BACK encoder to cancel.
===Song Editor===
[[File:SongEditor.png|400px|right]]
The song editor allows the assignment of patterns to a variable quantity of tracks. Each song may have any quantity of tracks. A track represents a sequence of patterns. Each track may have any quantity of patterns and hence be any duration. Each pattern may belong to a group (A, B, C...), has a MIDI channel and a play mode. The track group and number are shown on the left with its MIDI channel in brackets and its play mode shown by an icon. Patterns may not overlap on the same track. A timeline is shown along the bottom of the grid. Bar (or ''sync point'') markers are indicated by vertical lines with its time (in time divisions) at the bottom in the timeline. There may up to 999 songs loaded.
====Song Selection====
There may be up to 999 songs loaded into the step sequencer. By default no song is displayed.
Short press LAYER encoder displays a menu.
Select "Song" menu option. The ''parameter editor'' is displayed in the top bar.
Use the LAYER or SELECT encoder to select the song to edit. The title and grid change to show the song that will be selected.
Short press the LAYER or SELECT encoder to select the song or short press BACK encoder to cancel.
====Adding Patterns====
Use the BACK encoder to select the track. The screen will scroll at top and bottom edges.
Use the SELECT encoder to select the time at which the pattern will start. The screen will scroll at left and right edges.
Use the LAYER encoder to select the pattern that will be added. Pattern number is shown in the bottom left of the screen. Pattern duration will be indicated by the selection border.
Short press the SELECT encoder to add the sequence. The sequence is indicated by a shaded block starting at the required start step with length indicating pattern duration.
If the pattern overlaps an existing pattern then the existing pattern will be removed.
Patterns may also be added by clicking on the track / start time if you have a pointing device. To scroll screen with pointing device drag the track list up or down or timeline left and right.
====Removing Patterns====
Use the BACK encoder to select the track.
Use the SELECT encoder to select the time at which the pattern starts.
Short press the SELECT encoder to remove the pattern.
Notes may also be removed by clicking on the pattern within the grid if you have a pointing device.
====Adding Tracks====
Short press LAYER encoder displays a menu.
Select "Add track" menu option. A new track is added to the end of the track list.
====Removing Tracks====
Short press LAYER encoder displays a menu.
Select "Add track" menu option. A new track is added to the end of the track list.
====Controlling Playback====
Short press the SNAPSHOT encoder to start playback of the song. The song will resume playback from its previously stopped step. Playback will continue to run even if playhead passes beyond the end of the last pattern.
Short press the SNAPSHOT encoder to pause playback.
Bold press the SNAPSHOT encoder to stop playback and / or recue to start of song.
Playback may also be controlled with a pointing device by pressing the start / pause and stop / recue buttons in the topbar.
Playback may also be controlled via external MIDI transport control (start, stop, continue, locate).
====Time Divisions====
The timeline is quantised to ''time divisions''. This is the minimum step that may be navigated / pattern positioned.
A user may wish to use the concept of bars (or other larger time divisions). This is presented by the display of vertical lines. By default the time divisions per bar 16. This may be adjusted from 1 to 999. This setting also defines the ''sync point'' for live playout, i.e. the time at which a pattern will start playing after being triggered.
Short press LAYER encoder displays a menu.
Select "Bar / sync" menu option. The ''parameter editor'' is displayed in the top bar.
Use the LAYER or SELECT encoder to adjust the quantity of time division per marker. The vertical grid lines move to match.
====Transpose **NOT YET IMPLEMENTED**====
All notes within a song may be transposed.
Short press LAYER encoder displays a menu.
Select "Transpose pattern" menu option. The ''parameter editor'' is displayed in the top bar.
Use the LAYER or SELECT encoder to move all notes up or down.
Note: This setting is at song level. Patterns are not individually transposed. Playback is transposed.
====Vertical Zoom====
By default up to 16 tracks are shown.
Short press LAYER encoder displays a menu.
Select "Vertical zoom" menu option. The ''parameter editor'' is displayed in the top bar.
Use the LAYER or SELECT encoder to adjust the vertical zoom. The quantity of tracks change to match the vertical zoom value.
====Horizontal Zoom====
By default 64 time divisions are shown.
Short press LAYER encoder displays a menu.
Select "Horizontal zoom" menu option. The ''parameter editor'' is displayed in the top bar.
Use the LAYER or SELECT encoder to adjust the horizontal zoom. The quantity of columns change to match the horizontal zoom value.
====MIDI channel====
Each track may be assigned a MIDI channel.
Use the BACK encoder to select the track.
Short press LAYER encoder displays a menu.
Select "MIDI channel" menu option. The ''parameter editor'' is displayed in the top bar.
Use the LAYER or SELECT encoder to adjust the MIDI channel between 1 and 16. The track title changes to show the MIDI channel in brackets.
====Clocks Per Division====
By default each time division is 6 MIDI clock cycles.
Short press LAYER encoder displays a menu.
Select "Clocks per division" menu option. The ''parameter editor'' is displayed in the top bar.
Use the LAYER or SELECT encoder to adjust the clocks per division.
====Clear Song====
A song may be cleared of its content.
Short press LAYER encoder displays a menu.
Select "Clear song" menu option. The ''parameter editor'' is displayed in the top bar.
Short press the LAYER or SELECT encoder to clear song or short press BACK encoder to cancel.
====Copy Song====
The currently selected song may be copied to another song location.
Short press LAYER encoder displays a menu.
Select "Copy song" menu option. The ''parameter editor'' is displayed in the top bar.
Use the LAYER or SELECT encoder to select the song to copy the previous song to. The title and grid change to show the song that will be overwritten.
Short press the LAYER or SELECT encoder to overwrite pattern with previously selected song or short press BACK encoder to cancel.
====Tempo====
Each song has a master track displayed along the bottom of the screen. The master track may have tempo changes added at any time during the song. By default songs have a tempo of 120 BPM.
Use the SELECT encoder to select the time at which to add a tempo change. The screen will scroll at left and right edges.
Short press LAYER encoder displays a menu.
Select "Tempo" menu option. The ''parameter editor'' is displayed in the top bar.
Use the LAYER or SELECT encoder to select the tempo.
Short press the LAYER or SELECT encoder to add a tempo change to the selected song or short press BACK encoder to cancel. The tempo is displayed in the master track as red text below the timeline.
====Remove Tempo Marker====
Tempo persists until the next ''different'' tempo change. You cannot have consecutive tempo markers with the same value.
Use the SELECT encoder to select the time at which to remove tempo marker. The screen will scroll at left and right edges.
Short press LAYER encoder displays a menu.
Select "Tempo" menu option. The ''parameter editor'' is displayed in the top bar.
Use the LAYER or SELECT encoder to adjust the tempo. The tempo marker changes and will disappear when it is the same as the previous tempo marker.
Short press BACK encoder to cancel.
===ZynPad===
[[File:ZynPad.png|400px|right]]
ZynPad is a performance mode for the step sequencer. It presents a grid of pads that my be tapped to trigger sequences. Each pad may be a member of a mutually exclusive group where pressing a pad in the group will cause other group members to stop playing. Each group is allocated an alternating colour (blue / purple) and is identified by the first character of the pad name, e.g. A, B. C, etc.
A pad will start playing at the next ''sync point'', e.g. at the end of the current bar. This maintains synchronisation between sequences (assuming the sequences have been programmed to be synchronous).
====Playing ZynPad====
Each pad has a colour which indicates its group. Odd groups are blue whilst even groups are purple.
Click a pad to start the pad's sequence running. If the transport is not running then it will be started and the sequence will begin immediately. If the transport is already running then the sequence will begin at the next ''sync point''.
The pad will change to orange whilst it is waiting to start.
The pad will change to green whilst playing.
Click on a pad to stop the sequence playing.
The pad will change to red whilst waiting to stop.
The pad will change to blue or purple (depending on its group) when stopped.
Click a pad in a different group (with different first letter) will start that pad's sequence running synchronously with existing sequences, starting at the next ''sync point''.
group will stop the currently playing sequence (from this group) and start that pad's sequence running synchronously with existing sequences, starting at the next ''sync point''.
An icon on the pad indicates the play mode:
{| class="wikitable" style="background-color:#cccccc;"
|-
!Icon
!Mode
!Description
|-
|||Disabled||No sequence will play
|-
|[[File:ZynPadEndnoline.png]]||Oneshot||Sequence will play only once, stopping immediately when pad clicked
|-
|[[File:ZynPadLoop.png]]||Loop||Sequence will play in a continuous loop, stopping immediately when pad clicked
|-
|[[File:ZynPadEnd.png]]||Oneshot All||Sequence will play only once, 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
|}
The play mode and sync point is set in the song editor.
====ZynPad ''Song'' Selection====
ZynPad is configured by the song editor. Each pad represents a track in a song.
Short press LAYER encoder displays a menu.
Select "Song" menu option. The ''parameter editor'' is displayed in the top bar.
Use the LAYER or SELECT encoder to select the song. ZynPad changes to match the selected song.
Short press LAYER, SELECT to select song.
Short press BACK encoder to cancel.
The quantity of pads is defined by the quantity of tracks in the song. There will always be the same quantity of rows as columns. Extra pads required to fill grid (greater than quantity of tracks) are shown disabled. Text and icons scale to match pad size.
MIDI-learning allows you to easily bind specific MIDI events with Zynthian-UI actions. There are 2 types of MIDI events you can learn:
===MIDI Control===
Zynthian step sequencer may be controlled by external MIDI controllers.
====MIDI CC====
====Transport Control====
MIDI START message will start playback of the currently selected song or the pattern in the pattern editor if shown, from the start of the song or sequence.
MIDI STOP message will stop (pause) playback of the currently selected song or the pattern in the pattern editor if shown. ZynPad sequences will also be stopped.
MIDI CONTINUE message will resume playback of the currently selected song or the pattern in the pattern editor if shown, from the point it was previously stopped (paused) of the song or sequence.
====Clock====
To use an external MIDI clock to synchronise Zynthian:
Navigate to the ''Admin'' page.
Disable ''MIDI Clock Internal''.
Provide an external MIDI clock.
'''1.''' From the control screen, you click the snapshot button. You will be in CC MIDI-learn screen. It’s identical to the Control screen except that all the controllers have a tiny yellow “???” in the bottom.
Sequences will only play after receiving MIDI START / STOP / CONTINUE or being triggered from Zynthian user interface and will play at the rate of the external clock. 6 MIDI clock messages are sent for each ''beat''. A beat is often considered to be a crotchet / quarter note.
====Trigger Sequence **NOT YET IMPLEMENTED**====
Each sequence (pad) within ZynPad may be triggered by MIDI NOTE ON messages. The MIDI channel is configurable.
'''3.''' Finally, move a knob/fader in your MIDI keyboard/controller and the binding is done. The new CC number should appear in the bottom of the learned controller, replacing the tiny "???".
Short press LAYER encoder displays a menu.
Select "MIDI channel" menu option. The ''parameter editor'' is displayed in the top bar.
Use the LAYER or SELECT encoder to select the MIDI channel for external trigger.
Short press LAYER, SELECT to select channel.
Short press BACK encoder to cancel.
Use the BACK encoder to select the track.
Short press LAYER encoder displays a menu.
Select "Trigger note" menu option. The ''parameter editor'' is displayed in the top bar.
Use the LAYER or SELECT encoder to select the note number for external trigger.
Short press LAYER, SELECT to select note.
Short press BACK encoder to cancel.
==Admin Menu==
[[File:Zynthian_ui_admin.png|400px|right]]
[[File:Zynthian_ui_admin_02.png|400px|right]]
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>
= Touch Screen UI=
[[File:Zynthian_ui_top_bar.png|400px|right]]
You can navigate and control the Zynthian UI without knobs/encoders/switches at all, using only the touchscreen (or mouse).
You can "emulate" the switches by tapping the controller widgets (squares in the 4 corners of the screen). There are short, bold and long actions, same behaviour than rotary encoders work-flow. The only screen having the 4 controller widgets is the "Instrument Control" screen. Most of screens are selectors, which only have 1 controller widget. On those screens you can click the '''zynthian logo''' (top-right) to emulate the "snapshot" switch, and you can go back by tapping the '''top-bar''' area.
You can change the controller values by "sliding" up/down over the widgets. (see the green arrow in the figure) This is the same as turning the knob. If you are using a mouse, the mouse wheel also can be used to change the controller value.
<br clear=all>
<br clear=all>
====MIDI-CC Learning with a touch interface====
====MIDI-CC Learning with a touch interface====
[[File:Zynthian_ui_midi_learning.png|400px|right]]
[[File:Zynthian_ui_midi_learning.png|400px|right]]
72 SWITCH_SNAPSHOT_BOLD C5
72 SWITCH_SNAPSHOT_BOLD C5
73 SWITCH_SNAPSHOT_LONG C#5
73 SWITCH_SNAPSHOT_LONG C#5
80 SCREEN_ADMIN 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
[[File:2Oct_Keyboard_CUIA.png|600px|Keyboard]]
[[File:2Oct_Keyboard_CUIA.png|600px|Keyboard]]
[[File:Midi-note-chart.jpg]]
[[File:Midi-note-chart.jpg]]