Changes

* '''Audio Levels''' adjust hardware audio parameters

* '''Audio Levels''' adjust hardware audio parameters

* '''Admin''' access configuration menu

* '''Admin''' access configuration menu

* '''PANIC! All Notes OFF''' resets all MIDI modules

* '''PANIC! All Notes OFF''' resets all MIDI engines

<br clear=all>

<br clear=all>

Chains are a key concept of the Zynthian. The first thing you do after powering on your Zynthian is probably to create a chain. (It does little without any chains.)

Chains are a key concept of the Zynthian. The first thing you do after powering on your Zynthian is probably to create a chain. (It does little without any chains.)

A chain is one or more interconnected modules capable of generating or processing audio or MIDI. Each chain is normally assigned to a MIDI channel. These modules are chained in the same order they are created, but you can change the order from the '''Chain Options''' menu. The first module in a chain is the '''root''' and it determines the chain's type:

A chain is one or more interconnected engines capable of generating or processing audio or MIDI. Each chain is normally assigned to a MIDI channel. These engines are chained in the same order they are created, but you can change the order from the '''Chain Options''' menu. The first engine in a chain is the '''root''' and it determines the chain's type:

* '''Synth Chain''' => Receives MIDI note-events and generate audio output

* '''Synth Chain''' => Receives MIDI note-events and generate audio output

* '''Special Chain''' => Does not fit any other chain type, e.g. MOD-UI pedalboard, Pure Data patch, etc.

* '''Special Chain''' => Does not fit any other chain type, e.g. MOD-UI pedalboard, Pure Data patch, etc.

The root module can't be re-arranged or changed. MIDI effects can be added to the start of a chain and audio effects can be added to the end of a chain. These can be arranged as serial or parallel paths.

The root engine can't be re-arranged or changed. MIDI effects can be added to the start of a chain and audio effects can be added to the end of a chain. These can be arranged as serial or parallel paths.

All modules in a chain receive all the MIDI events on the assigned channel. Some special chains (MOD-UI) don't have an assigned MIDI channel and receive all MIDI channels.

All engines in a chain receive all the MIDI events on the assigned channel. Some special chains (MOD-UI) don't have an assigned MIDI channel and receive all MIDI channels.

<br clear=all>

<br clear=all>

#TODO: Upload engine screenshot

#TODO: Upload engine screenshot

When you select '''NEW Chain''', you create a new root module (first module of a chain), choosing a free MIDI channel and if available, a preset from a bank of presets. You can create up to 16* chains, one per MIDI channel, each having a independent MIDI and audio effect chains. After creating a chain its Control View is shown.

When you select '''NEW Chain''', you create a new root engine (first engine of a chain), choosing a free MIDI channel and if available, a preset from a bank of presets. You can create up to 16* chains, one per MIDI channel, each having a independent MIDI and audio effect chains. After creating a chain its Control View is shown.

* If '''Master Channel''' is enabled then only 15 chains can be created.

* If '''Master Channel''' is enabled then only 15 chains can be created.

==Engine Selector==

==Engine Selector==

[[File:Zynthian_ui_engine_list.png|400px|right]]

[[File:Zynthian_ui_engine_list.png|400px|right]]

When you create a new chain, you are asked which engine or plugin you want to use for it. An engine is a module that creates or processes MIDI or audio. A list of engines to choose from is displayed. They can be synthesizers, effects, generators or special engines, depending on the type of chain 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 chain, you are asked which engine or plugin you want to use for it. An engine creates or processes MIDI or audio. A list of engines to choose from is displayed. They can be synthesizers, effects, generators or special engines, depending on the type of chain 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.

Some engines have special behavior regarding chains and MIDI channels:

Some engines have special behavior regarding chains and MIDI channels:

Once you have chosen a bank, the preset screen will be shown. Choose a preset to load the instrument / sound / patch and the Control View will be shown.

Once you have chosen a bank, the preset screen will be shown. Choose a preset to load the instrument / sound / patch and the Control View will be shown.

To change preset of an existing module, navigate to its Control View then short press BACK to access the list of presets. Use the SELECT encoder to highlight the required preset and short press SELECT or tap on the required preset in the list on the touchscreen to select the preset. The module will configure with the preset values and the Control View will be displayed.

To change preset of an existing engine, navigate to its Control View then short press BACK to access the list of presets. Use the SELECT encoder to highlight the required preset and short press SELECT or tap on the required preset in the list on the touchscreen to select the preset. The engine will configure with the preset values and the Control View will be displayed.

Bold press SELECT or touch and hold a preset on the touchscreen will show the Preset Options menu. A preset may be added to or removed from a list of favorites, renamed or deleted. Some modules do not allow presets to be manipulated and will only show the Favourite option. (Saving presets is performed in the chain options menu described later.)

Bold press SELECT or touch and hold a preset on the touchscreen will show the Preset Options menu. A preset may be added to or removed from a list of favorites, renamed or deleted. Some engines do not allow presets to be manipulated and will only show the Favourite option. (Saving presets is performed in the chain options menu described later.)

If the '''preload with note-on''' feature is enabled in the admin menu or webconf, you can audition the presets by playing notes. When you do so, the highlighted preset will be pre-loaded without pressing SELECT. N.B. Some engines may be slow to load presets in which case it may be necessary to play the note more than once to hear the new preset sound.

If the '''preload with note-on''' feature is enabled in the admin menu or webconf, you can audition the presets by playing notes. When you do so, the highlighted preset will be pre-loaded without pressing SELECT. N.B. Some engines may be slow to load presets in which case it may be necessary to play the note more than once to hear the new preset sound.

==Control View==

==Control View==

[[File:Zynthian_ui_instrument_control_01.png|400px|right]]

[[File:Zynthian_ui_instrument_control_01.png|400px|right]]

The Control View shows the controls available for each module within a chain. It is shown after adding a chain, adding a module to a chain or by short press SELECT or tapping the bottom legend strip in the mixer view. Your instrument is now enabled and playable and you can modify its parameters.

The Control View shows the controls available for each engine within a chain. It is shown after adding a chain, adding an engine to a chain or by short press SELECT or tapping the bottom legend strip in the mixer view. Your instrument is now enabled and playable and you can modify its parameters.

The controls are shown in groups of four (or fewer) on several pages. Each hardware knob controls a parameter displayed in the control view or the control may be dragged up and down on the touchscreen. Controls may toggle between two values, e.g. on / off, lists of values, e.g. sine, square, triangle or continuously adjustable values, e.g. 0%..100%. If there are a lot of possible values the hardware knobs will accelerate progress if rotated fast, e.g. stepping by one value when turned slowly and stepping by 10 values when rotated fast. This allows fine and coarse selection of a parameter from a single knob.

The controls are shown in groups of four (or fewer) on several pages. Each hardware knob controls a parameter displayed in the control view or the control may be dragged up and down on the touchscreen. Controls may toggle between two values, e.g. on / off, lists of values, e.g. sine, square, triangle or continuously adjustable values, e.g. 0%..100%. If there are a lot of possible values the hardware knobs will accelerate progress if rotated fast, e.g. stepping by one value when turned slowly and stepping by 10 values when rotated fast. This allows fine and coarse selection of a parameter from a single knob.

[[File:Zynthian_ui_instrument_control_03.png|400px|right]]

[[File:Zynthian_ui_instrument_control_03.png|400px|right]]

To change page, short press SELECT - the list of pages turns grey, rotate SELECT to highlight the required page then short press again to select the page. If there are fewer than three pages then short press SELECT will step through each page. Alternatively, tap the required page on the touchscreen. When a page is selected its controls will be shown. Depending on the configuration, some pages may have fewer than four controls and some modules have no adjustable parameters in which case there will be no control pages.

To change page, short press SELECT - the list of pages turns grey, rotate SELECT to highlight the required page then short press again to select the page. If there are fewer than three pages then short press SELECT will step through each page. Alternatively, tap the required page on the touchscreen. When a page is selected its controls will be shown. Depending on the configuration, some pages may have fewer than four controls and some engines have no adjustable parameters in which case there will be no control pages.

The pages for the controls for each module within a chain are shown separated by a title indicating to which module subsequent pages belong.

The pages for the controls for each engine within a chain are shown separated by a title indicating to which engine subsequent pages belong.

<br clear=all>

<br clear=all>

#TODO: Upload screenshot of control view with gui widget

#TODO: Upload screenshot of control view with gui widget

Some modules have a graphical representation of controls / monitoring available. This will be shown in place of the list of pages. Pages can still be selected in the same manner as described above except the list is not available for touchscreens.

Some engines have a graphical representation of controls / monitoring available. This will be shown in place of the list of pages. Pages can still be selected in the same manner as described above except the list is not available for touchscreens.

Tapping (and not dragging) one of the four controls on a touchscreen will simulate pressing its associated knob, i.e. tap on the bottom right control to show the list of pages.

Tapping (and not dragging) one of the four controls on a touchscreen will simulate pressing its associated knob, i.e. tap on the bottom right control to show the list of pages.

Short press BACK in the Presets view will show the list of banks. (Some modules do not support banks in which case this will return you to the Control View without changing the configuration.) Selecting a bank will show the list of presets within the bank.

Short press BACK in the Presets view will show the list of banks. (Some engines do not support banks in which case this will return you to the Control View without changing the configuration.) Selecting a bank will show the list of presets within the bank.

Bold press SELECT or touch and hold a bank on the touchscreen will show the Bank Options menu. A bank may be renamed or deleted. Some modules do not allow banks to be manipulated in which case this will have no effect.

Bold press SELECT or touch and hold a bank on the touchscreen will show the Bank Options menu. A bank may be renamed or deleted. Some engines do not allow banks to be manipulated in which case this will have no effect.

Short press BACK to return to the Control View without changing the module's configuration.

Short press BACK to return to the Control View without changing the engine's configuration.

Bold press SELECT when in the Mixer View or Control View will show the Chain Options menu. Manipulation of the chain is possible:

Bold press SELECT when in the Mixer View or Control View will show the Chain Options menu. Manipulation of the chain is possible:

* '''Save Preset''' will allow saving of a module's configuration as a preset that may later be selected from the preset list. This is only available if the module supports manipulation of presets. If a chain has several modules then a list of modules will be displayed before naming the preset.

* '''Save Preset''' will allow saving of a engine's configuration as a preset that may later be selected from the preset list. This is only available if the engine supports manipulation of presets. If a chain has several engines then a list of engines will be displayed before naming the preset.

* '''Note Range & Transpose''' allows configuration of the key-range and transpose by octaves or semitones applied to the chain.

* '''Note Range & Transpose''' allows configuration of the key-range and transpose by octaves or semitones applied to the chain.

* '''Clone MIDI to...''' allows MIDI events targetted at this chain to be sent to other MIDI channels. By default only note-on, note-off, pitchbend and key-pressure messages are cloned. CC, channel-pressure, program change, etc. can be enabled by bold SELECT on a channel within the Clone menu

* '''Clone MIDI to...''' allows MIDI events targetted at this chain to be sent to other MIDI channels. By default only note-on, note-off, pitchbend and key-pressure messages are cloned. CC, channel-pressure, program change, etc. can be enabled by bold SELECT on a channel within the Clone menu

* '''MIDI Routing''' => Select the destiny of the chain's MIDI output. This option is only available on MIDI-FX chains.

* '''MIDI Routing''' => Select the destiny of the chain's MIDI output. This option is only available on MIDI-FX chains.

* '''MIDI Channel''' allows changing of the chain's MIDI Channel. Only MIDI channels not assigned to other chains are available.

* '''MIDI Channel''' allows changing of the chain's MIDI Channel. Only MIDI channels not assigned to other chains are available.

* '''Replace Synth''' allows a synth module to be replaced by another synth module.

* '''Replace Synth''' allows a synth engine to be replaced by another synth engine.

* '''Remove Chain''' will remove the chain.

* '''Remove Chain''' will remove the chain.

* '''Add MIDI-FX''' adds a MIDI effect to the chain. The MIDI effect will be inserted before synth modules.

* '''Add MIDI-FX''' adds a MIDI effect to the chain. The MIDI effect will be inserted before synth engines.

* '''Remove All MIDI-FX''' removes all MIDI effects from the chain

* '''Remove All MIDI-FX''' removes all MIDI effects from the chain

* The list of MIDI effects in the chain is displayed with arrows representing their relative position

* The list of MIDI effects in the chain is displayed with arrows representing their relative position