2,706
edits
Changes
Jump to navigation
Jump to search
Line 1:
Line 1: + − [[File:zynthian_ui_workflow_1.png|400px|thumb]] − [[File:zynthian_ui_workflow_2.png|400px|thumb]] Line 38:
Line 37: − + + + + + + + + − + − + + + Line 95:
Line 103: − + Line 167:
Line 175: − + − + + + − + − + − + − + − + Line 223:
Line 233: − + − + + Line 237:
Line 248: + + − + − + − + Line 252:
Line 265: − + − + − + − + +
Zynthian UI User Guide (oldstable-2109) (view source)
Revision as of 11:22, 17 January 2019
, 11:22, 17 January 2019→The Zynthian UI Workflow
=General Concepts=
=General Concepts=
[[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 rotary-encoders with switches (push).
The Zynthian UI is displayed on a touch display and controlled by 4 rotary-encoders with switches (push).
The next flowcharts show the different "screens" or "menus" and the way to reach each one using the 4 switches.
The next flowcharts show the different "screens" or "menus" and the way to reach each one using the 4 switches.
It could be a good idea to print these 2 flowcharts and keep it near of your Zynthian Box until you memorize the workflow and the spirit of Zynthian UI got inside you ;-)
It could be a good idea to print these flowcharts and keep it near of your Zynthian Box until you memorize the workflow and the spirit of Zynthian UI got inside you ;-)
<gallery mode="slideshow" widths="240" heights="320">
Image:zynthian_ui_workflow__main.svg|''[[commons:Main Sequence|Main Sequence]]''
Image:zynthian_ui_workflow__layer_options.svg|''[[commons:Layer Options|Layer Options]]''
Image:zynthian_ui_workflow__snapshots.svg|''[[commons:Snapshots|Snapshots]]''
Image:zynthian_ui_workflow__midi_learning.svg|''[[commons:MIDI Learning|MIDI Learning]]''
</gallery>
If you want to contribute improving these flowcharts, you can edit using the Google Documents Tools:
If you want to contribute improving these flowcharts, you can edit using the Google Documents Tools:
- [https://docs.google.com/drawings/d/1jmt3zrJjPkbqj3hpzCIwRgFIKxiX2UptebBA_GN8e5I/edit?usp=sharing Main sequence: zynthian_ui_workflow_1]
- [https://docs.google.com/drawings/d/1jmt3zrJjPkbqj3hpzCIwRgFIKxiX2UptebBA_GN8e5I Main sequence: zynthian_ui_workflow_main]
- [https://docs.google.com/drawings/d/1Um1HVCvvb4gZF_X-vcIN9cTxYIBRCtZ5oxniUdSTB3c/edit?usp=sharing Aux. Sequences: zynthian_ui_workflow_2]
- [https://docs.google.com/drawings/d/1C8kfovwXxuabl1u-UlrnHY8xzFFNiqiQWt1mmD5UXak Layer Options: zynthian_ui_workflow_layer_options]
- [https://docs.google.com/drawings/d/1Um1HVCvvb4gZF_X-vcIN9cTxYIBRCtZ5oxniUdSTB3c Snapshots: zynthian_ui_workflow_snapshots]
- [https://docs.google.com/drawings/d/1I0ArYVr3zGtzcSgOy19fHlIh8VF15rmsll9wZi-aXaI MIDI Learning: zynthian_ui_workflow_midi_learning]
<br clear=all>
<br clear=all>
==Engine Selection==
==Engine Selection==
[[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 about 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 clik on the list,
When you create a new layer, you are asked about 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 click on the list,
the zynthian logo on the top-right will be animated while the engine is being started.
the zynthian logo on the top-right will be animated while the engine is being started.
<br clear=all>
<br clear=all>
==Load/Save Snapshot==
==Snapshots==
[[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]]
You can enter the ''Load Snapshot'' screen by clicking the snapshot switch (from control screen you have to use bold-click!). Another click and you will be in the ''Save Snapshot'' screen. You can also use bold-click to go directly to the Save Snapshot screen.
Snapshots are used for saving/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 control screen you have to use bold-click. A second click and you will be in the ''Save Snapshot'' screen. You can also use bold-click to go directly to the Save Snapshot screen (not from control screen!).
Obviously, before loading any snapshot, you should save one, and for save a snapshot, you should create some layer. Zynthian UI will use numbers for naming the banks and snapshots. Later, using the webconf tool you can rename the snapshots to something more explicit.
Obviously, before loading any snapshot, you should save one, and for saving a snapshot, you should create some layers, etc. Zynthian UI will use numbers for naming the banks and snapshots. Later, using the webconf tool you can rename the snapshots to something more explicit.
====Snapshot Banks====
====Snapshot Banks====
By default, snapshots are stored as a single list and bank-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.
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 snapshots to banks, you should use the ".." entry in the list. The Back button won't work here.
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====
====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 do it from command line.
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====
====Restore Last State====
If "Restore last state on startup" option is enabled on webconf, then state will be saved when poweroff (using long-click select or from Admin Menu) and restored on next boot. This option has priority over the "Default Snapshot".
If "Restore last state on startup" option is enabled on webconf (and it's enabled by default!), then state will be saved when poweroff (using long-click select or from Admin Menu) and restored on next boot. This option has priority over the "Default Snapshot".
<br clear=all>
<br clear=all>
====MIDI CC====
====MIDI CC====
[[File:Zynthian_ui_midi_cc_learn_01.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.)''
[[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:
Learning a MIDI-CC is quite easy:
'''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.
'''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====
====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.
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:
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…”
'''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.
'''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.
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:
Every zs3 includes:
Layer ID
- Layer ID
Bank
- Bank
Preset
- Preset
Controller values
- 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 must be started.
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 must be started.
<br clear=all>
====MIDI-CC Learning with touch interface====
====MIDI-CC Learning with touch interface====