Changes

Jump to navigation Jump to search
Line 199: Line 199:  
<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.  
Line 215: Line 215:  
<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:
Line 225: Line 225:  
<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.  
Line 236: Line 236:  
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.
Line 266: Line 268:  
<br clear=all>
 
<br clear=all>
   −
====Tips====
+
==MIDI-learning==
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.
+
MIDI-learning allows you to easily bind specific MIDI events with Zynthian-UI actions. There are 2 types of MIDI events you can learn:
<br clear=all>
     −
==Snapshots==
+
====MIDI CC====
[[File:Zynthian_ui_snapshot_load.png|400px|right]]
+
[[File:Zynthian_ui_midi_cc_learn_01.png|400px|right]]
[[File:Zynthian_ui_snapshot_save.png|400px|right]]
+
[[File:Zynthian_ui_midi_cc_learn_02.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 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.
   −
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!).
+
Learning a MIDI-CC is quite easy:
   −
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.
+
'''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.
   −
====Snapshot Banks====
+
'''2.''' Move a zynthian controller. Its tiny “???” will change to green while the other 3 will go back to normal state.
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.
+
'''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 "???".
   −
====Default Snapshot====
+
Of course, MIDI-learning configuration, including CC mappings, is stored and restored with snapshots.
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====
+
'''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.
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".
      
<br clear=all>
 
<br clear=all>
   −
==Admin Menu==
+
====MIDI Program Change====
[[File:Zynthian_ui_admin.png|400px|right]]
+
[[File:Zynthian_ui_midi_zs3_learn.png|400px|right]]
[[File:Zynthian_ui_admin_02.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.
Pressing the Back knob, when you are in the Layer List screen, brings you to the Admin menu.  
+
 
 +
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.  
   −
The last item is how you safely power off the Zynthian without corrupting data files.
+
Every zs3 includes:
   −
* Network Info - displays the IP address (ifconfig inet addr)
+
    - Layer ID
* Start WIFI - Starts or Stops WIFI (toggle)
+
    - Bank
* Start Audio Recording
+
    - Preset
* Start TouchOSC bridge
+
    - Controller values
* 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
      +
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.
 
<br clear=all>
 
<br clear=all>
   −
==ALSA Mixer==
+
==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.
   −
[[File:zynthian_ui_mixer_control.png|400px|right]]
+
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.
   −
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.
+
====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.
   −
For accessing the '''ALSA-Mixer''' app, you have 2 options:
+
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.
   −
* Selecting "ALSA-Mixer" option from the Main menu
+
====Default Snapshot====
* '''Long-pushing the layer knob (CTRL-1)'''
+
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.
   −
You can configure the mixer controllers from the webconf's hardware->audio menu. Simply click the '''+''' button on the "Mixer Controls" text area.  
+
====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".
    
<br clear=all>
 
<br clear=all>
Line 337: Line 341:  
[[File:zynthian_ui_midi_recorder.png|400px|right]]
 
[[File:zynthian_ui_midi_recorder.png|400px|right]]
   −
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.  
+
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.
Line 380: Line 392:  
<br clear=all>
 
<br clear=all>
   −
= Touch Screen UI=
+
==ALSA Mixer==
[[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.
     −
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.
+
[[File:zynthian_ui_mixer_control.png|400px|right]]
   −
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.
+
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.
   −
<br clear=all>
+
For accessing the '''ALSA-Mixer''' app, you have 2 options:
   −
=MIDI-learning=
+
* Selecting "ALSA-Mixer" option from the Main menu
 +
* '''Long-pushing the layer knob (CTRL-1)'''
   −
MIDI-learning allows you to easily bind specific MIDI events with Zynthian-UI actions. There are 2 types of MIDI events you can learn:
+
You can configure the mixer controllers from the webconf's hardware->audio menu. Simply click the '''+''' button on the "Mixer Controls" text area.  
   −
====MIDI CC====
+
<br clear=all>
[[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:
+
==Admin Menu==
   −
'''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.
+
[[File:Zynthian_ui_admin.png|400px|right]]
 
+
[[File:Zynthian_ui_admin_02.png|400px|right]]
'''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 "???".
+
The Admin menu give access to some configuration options (most of them also accessible from the webconf tool).
   −
Of course, MIDI-learning configuration, including CC mappings, is stored and restored with snapshots.
+
For accessing this menu:
   −
'''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.
+
* From any place, '''long-back'''
 +
* From Main menu
    
<br clear=all>
 
<br clear=all>
   −
====MIDI Program Change====
+
= Touch Screen UI=
[[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:
+
[[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).
   −
'''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…”
+
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.
   −
'''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.
+
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.
 
  −
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.
   
<br clear=all>
 
<br clear=all>
    
====MIDI-CC Learning with a touch interface====
 
====MIDI-CC Learning with a touch interface====
  −
First, you need a working touch interface in your display. If you don't have a touchscreen, you could use a mouse.
      
[[File:Zynthian_ui_midi_learning.png|400px|right]]
 
[[File:Zynthian_ui_midi_learning.png|400px|right]]

Navigation menu