Difference between revisions of "Supported plug & play MIDI controllers"

From ZynthianWiki
Jump to navigation Jump to search
 
(124 intermediate revisions by 3 users not shown)
Line 1: Line 1:
Zynthian can be connected to almost any existing MIDI device and you can use the MIDI learning mechanism, as described in the [Zynthian_UI_User_Guide_-_V1/V4|UI user's guide], to assign parameters to faders and knobs in your MIDI controller, for instance. You could also assign pad trigger to notes, etc. But MIDI learning process takes time, it's limiting and you can't get feedback easily. Sometimes it's a lot better to plug a well-known (supported) MIDI controller and get everything mapped automatically. For having this, zynthian implements a controller driver API that allows developers to create specific drivers for specific devices.  
+
Zynthian can be connected to almost any existing MIDI device and you can use the MIDI learning mechanism, as described in the [[Zynthian_UI_User_Guide_-_V1/V4|UI user's guide]], to assign parameters to faders and knobs in your MIDI controller, for instance. You could also assign pad trigger to notes, etc. But MIDI learning process takes time, it's limiting and you can't get feedback easily. Sometimes it's a lot better to plug a well-known (supported) MIDI controller and get everything mapped automatically. For having this, zynthian implements a controller driver API that allows developers to create specific drivers for specific devices.  
  
 
This section contain documentation for some of this controller drivers.
 
This section contain documentation for some of this controller drivers.
 
{{NoteBox|This documentation is valid for the "chain_manager" development branch. It's only partially valid for the current testing branch so you could find some differences.}}
 
  
 
<br clear=all>
 
<br clear=all>
Line 9: Line 7:
 
==Akai APC Key25 MK2==
 
==Akai APC Key25 MK2==
  
This device supports two operation modes:
+
This device supports three operation modes:
  
# The default mode (called '''"Mixpad"''' in this section), which controls the ZynMixer and the ZynPad.  
+
* The '''"Mixpad"''' mode (default), which controls the Zynthian's Mixer and ZynPad.
# The '''"Device"''' mode, which handles the Zynthian UI.
+
* The '''"Device"''' mode, which handles the Zynthian UI.
 +
* The '''"Sequencer"''' mode, which handles the Zynthian Step Sequencer.
  
====Key notation====
+
====The Mixpad mode====
  
[[File:akai_apc_key25_mk2.png|800px]]
+
[[File:akai_apc_key25_mk2.png|800px|right]]
  
====The Mixpad mode====
+
This is the default mode, selected automatically on start. You can also change to it pressing <code>SHIFT</code> + <code>VOLUME</code> or <code>SHIFT</code> + <code>PAN</code>. In this mode you can perform the following actions:
  
This is the default mode, selected automatically on start. You can also change to it pressing <code>SHIFT</code> + <code>VOLUME</code> or <code>SHIFT</code> + <code>PAN</code>. In this mode you can perform the following actions:
+
* Tap a pad to '''start/stop a sequence'''. The pad LED will show its status as follows (pad color will always match the sequence color):
 +
** Dim solid: Stopped sequence without content (no notes in patterns).
 +
** Bright solid: Stopped sequence with content.
 +
** Blinking slow: Playing sequence.
 +
** Blinking fast: Recording sequence.
 +
** Pulsing: Syncing to play/stop.
  
* Change controllers' bank. There are '''two banks''' (1 and 2), which are used to handle up to 16 chains (with the eight track buttons/knobs). Bank 1 is for chains 1 to 8 and bank 2 manage chains 9 to 16. To show current selected bank, press and hold <code>SHIFT</code>. One of the track buttons <code>LEFT arrow</code> or <code>RIGHT arrow</code> will light up in red, <code>LEFT arrow</code> is bank 1 and <code>RIGHT arrow</code> is bank 2. You can press one of these buttons while holding <code>SHIFT</code> to change the bank.
+
* Change controller's bank. There are '''two banks''' (1 and 2), which are used to handle up to 16 chains (with the eight track buttons/knobs). Bank 1 is for chains 1 to 8 and bank 2 manage chains 9 to 16. To show current selected bank, press and hold <code>SHIFT</code>. One of the track buttons <code>LEFT arrow</code> or <code>RIGHT arrow</code> will light up in red, <code>LEFT arrow</code> is bank 1 and <code>RIGHT arrow</code> is bank 2. You can press one of these buttons while holding <code>SHIFT</code> to change the bank.
  
 
* Use track buttons to '''perform a function''' on chains. The function is chosen by pressing <code>SHIFT</code> + one of <code>SELECT</code>, <code>MUTE</code> or <code>SOLO</code> soft key buttons. Press and hold <code>SHIFT</code> to see current selected function on soft key buttons (in green). Functions are:
 
* Use track buttons to '''perform a function''' on chains. The function is chosen by pressing <code>SHIFT</code> + one of <code>SELECT</code>, <code>MUTE</code> or <code>SOLO</code> soft key buttons. Press and hold <code>SHIFT</code> to see current selected function on soft key buttons (in green). Functions are:
Line 28: Line 32:
 
** <code>MUTE</code>, used to mute the corresponding chain.
 
** <code>MUTE</code>, used to mute the corresponding chain.
 
** <code>SOLO</code>, used to enable solo in the corresponding chain.
 
** <code>SOLO</code>, used to enable solo in the corresponding chain.
 +
 +
* '''Mute main chain''', pressing <code>SHIFT</code> + <code>PLAY</code>.
  
 
* '''Change current scene''' using the track buttons. You need first to select that function by pressing <code>SHIFT</code> + <code>REC ARM</code> button. This function is affected by bank selection, so you can change up to 16 scenes. When selecting a new scene, the ZynPad will be shown.
 
* '''Change current scene''' using the track buttons. You need first to select that function by pressing <code>SHIFT</code> + <code>REC ARM</code> button. This function is affected by bank selection, so you can change up to 16 scenes. When selecting a new scene, the ZynPad will be shown.
  
* Start/stop all '''sequences of a row''', pressing the corresponding SOFT KEY (without modifiers). If there are any sequence playing, it will stop. If there are no sequences playing, it will start all of them at once. The action to be run is shown by the LED status (lit will stop, off will start).
+
* Start/stop '''sequences of a row''', pressing the corresponding SOFT KEY (without modifiers). If there are any sequence playing, they will stop. If there are no sequences playing, it will start those not empty. The action to be run is shown by the LED status (lit will stop, off will start).
  
* Use knobs to modify '''chains' volume or balance'''. The value modified is given by current KNOB CTRL selected: <code>VOLUME</code> or <code>PAN</code> (for balance). To change the function, press <code>SHIFT</code> + <code>VOLUME</code> or <code>SHIFT</code> + <code>PAN</code>. The knobs are also affected by current controller's bank.
+
* Use the knobs to modify '''chains' volume or balance'''. The function is given by current KNOB CTRL selected: <code>VOLUME</code> or <code>PAN</code> (for balance). To change the function, press <code>SHIFT</code> + <code>VOLUME</code> or <code>SHIFT</code> + <code>PAN</code>. The knobs are also affected by current controller's bank. Each knob will affect a chain, independently of the selected chain. (K1 -> chain 1, K2 -> chain 2, ...)
  
* Use <code>SHIFT</code> + <code>KNOB k1</code> to change volume or balance for main chain (will change the current KNOB CTRL function).
+
* Use <code>SHIFT</code> + <code>KNOB k1</code> to change volume or balance for main chain (what changes is selected by the current KNOB CTRL function).
  
* Press <code>SHIFT</code> + <code>STOP ALL CLIPS</code> to perform the selected track's function (MUTE or SOLO) on main chain.  
+
* Press <code>SHIFT</code> + <code>STOP ALL CLIPS</code> for a ''''panic' stop''', which stops all sequences, audio and midi playback.
  
 
* '''Toggle audio playback''' with <code>PLAY/PAUSE</code> button. If Zynthian's ALT mode is active, it will '''toggle MIDI playback'''.
 
* '''Toggle audio playback''' with <code>PLAY/PAUSE</code> button. If Zynthian's ALT mode is active, it will '''toggle MIDI playback'''.
Line 43: Line 49:
 
* '''Toggle audio record''' with <code>SHIFT</code> + <code>RECORD</code> button. If Zynthian's ALT mode is active, it will '''toggle MIDI recording'''.
 
* '''Toggle audio record''' with <code>SHIFT</code> + <code>RECORD</code> button. If Zynthian's ALT mode is active, it will '''toggle MIDI recording'''.
  
* Tap a pad to '''start/stop a sequence'''. The pad LED will show its status as follows (pad color will always match the sequence color):
+
* '''Stop all sequences''' of current scene (but not audio/midi playback or recording), doing a ''short'' press on <code>STOP ALL CLIPS</code> button; ''bold'' press to stop all sequences on all scenes.  
** Dim solid: Stopped sequence without content (no notes in patterns).
 
** Bright solid: Stopped sequence with content.
 
** Blinking slow: Playing sequence.
 
** Blinking fast: Recording sequence.
 
** Pulsing: Syncing to play/stop.
 
  
* '''Stop all sequences''' (but not audio/midi playback or recording) pressing <code>STOP ALL CLIPS</code> button.  
+
* Open the '''StepSeq mode''' for a given sequence, pressing <code>SHIFT</code> + a pad button.
  
* Open the '''pattern editor''' for a given sequence, pressing <code>SHIFT</code> + a pad button.
+
* '''Clear a sequence''', pressing any track button + the sequence pad.  
  
 
* Start '''recording a pattern'''. For this, press <code>RECORD</code> + a pad button, which will 1) select the chain associated with the group of the sequence, 2) open the pattern editor for that sequence, 3) start playing the sequence and 4) start recording that sequence. If you press the pad again (without holding any other button), the recording will stop. Press again to stop playback too. You can also control the playback/recording with <code>PLAY/PAUSE</code> and <code>RECORD</code> buttons.  
 
* Start '''recording a pattern'''. For this, press <code>RECORD</code> + a pad button, which will 1) select the chain associated with the group of the sequence, 2) open the pattern editor for that sequence, 3) start playing the sequence and 4) start recording that sequence. If you press the pad again (without holding any other button), the recording will stop. Press again to stop playback too. You can also control the playback/recording with <code>PLAY/PAUSE</code> and <code>RECORD</code> buttons.  
  
 
* If the pattern editor is open, press <code>SHIFT</code> + <code>UP arrow</code> to '''go back to ZynPad'''. Press it again to go to mixer screen.
 
* If the pattern editor is open, press <code>SHIFT</code> + <code>UP arrow</code> to '''go back to ZynPad'''. Press it again to go to mixer screen.
 +
 +
* '''Open the ZynPad''' pressing <code>SHIFT</code> + <code>DOWN arrow</code>.
 +
 +
* Open the '''sequence manager''' (also known as the ''Seqman'' sub-mode), pressing <code>SHIFT</code> + <code>CLIP STOP</code>. If this mode is active, the LED of the <code>CLIP STOP</code> button will blink in green, and one of <code>VOLUME</code>, <code>PAN</code> or <code>SEND</code> buttons will also be solid in red, each one related to a specific function:
 +
** <code>SEND</code>: this is CLEAR mode. It will remove all patterns of the sequence when its pad is pressed (leaving only a single empty pattern).
 +
** <code>VOLUME</code>: this is COPY mode. Press the pad of a non-empty sequence to mark it as source (it will blink fast). Press another pad to copy the selected source to it. It will CLEAR the destination sequence, and then copy all the patterns of the source sequence. Press the selected source pad to clear selection.
 +
** <code>PAN</code>: this is MOVE mode. It works like COPY mode, but also CLEARS the source sequence.
 +
** Use <code>LEFT</code> and <code>RIGHT</code> arrows to move from one scene to another. You can also copy/move patterns between scenes.
 +
** Press <code>SHIFT</code> + <code>SELECT</code> to exit this sub-mode.
  
 
====The Device mode====
 
====The Device mode====
 +
 +
[[File:Akai-apc-key-25-mk2-ui-legend.png|800px|right]]
 +
 +
This mode allows you to '''control the Zynthian UI'''. You can enable it by pressing <code>SHIFT</code> + <code>DEVICE</code>. If this mode is active, the button <code>DEVICE</code> will blink in red.
 +
 +
As you can see in the image, this mode mimics the Zynthian V5 hardware interface. The upper four buttons are <code>OPT/ADMIN</code>, <code>MIX/LEVEL</code>, <code>CTRL/PRESET</code> and <code>ZS3/SHOT</code>. Next row is <code>ALT</code>, <code>METRONOME</code> and <code>PAD/STEP</code>. The four buttons at the right side (in white) are <code>F1</code> to <code>F4</code>. In this mode, transport is handled by <code>PLAY/PAUSE</code> and <code>RECORD</code> buttons, and the transport pads are only to show playback/recording status. Navigation buttons are <code>UP</code>, <code>DOWN</code>, <code>LEFT</code>, <code>RIGHT</code>, (in yellow) <code>BACK/NO</code> (in red) and <code>SEL/YES</code> (in green). For the directional keys, you can also use the track keys labelled as such.
 +
 +
The behaviour and status are '''similar of those in the hardware interface''': there is support for short, bold and long press; screen access buttons are blue when no function is selected, green on it's primary and orange on its secondary function; <code>ALT</code> key changes to violet when active (and <code>F1</code>-<code>F4</code> also change).
 +
 +
The nearest four knobs has the functions of '''Knob#1''' to '''Knob#4'''. They can be used to control volume of selected/main chain, move vertically/horizontally in pattern editor or Zynpad, move selected item in menus, etc. Press <code>SHIFT</code> with a knob for a finer (slower) adjustment. The knob press is activated using the first four soft keys to the left (in green), and also has short/bold press support. The mapping is: '''Knob#1''' = (<code>K1</code>, <code>CLIP STOP</code>); '''Knob#2''' = (<code>K5</code>, <code>SOLO</code>); '''Knob#3''' = (<code>K2</code>, <code>MUTE</code>); '''Knob#1''' = (<code>K6</code>, <code>REC ARM</code>). This scheme is very comfortable in the V4 four-corners layout.
 +
 +
<br clear=all>
 +
 +
====The Step Sequencer mode====
 +
 +
<embedvideo alignment="right" dimensions="600" service="youtube" description="Zynthian - Akai APC Key25 mk2 - StepSeq (alpha) demo I">https://www.youtube.com/watch?v=Y4JTWJTz2Q0</embedvideo>
 +
<embedvideo alignment="right" dimensions="600" service="youtube" description="Zynthian - Akai APC Key25 mk2 - StepSeq (alpha) demo II">https://www.youtube.com/watch?v=zprRUIbjHqs</embedvideo>
 +
<embedvideo alignment="right" dimensions="600" service="youtube" description="Zynthian - Akai APC Key25 mk2 - StepSeq (beta) demo III">https://www.youtube.com/watch?v=3EPUusfwmEg</embedvideo>
 +
 +
This mode allows you to control Zynthian's step sequencer (and also the pattern editor). You can activate it by pressing <code>SHIFT</code> + <code>SEND</code>, or in '''Mixpad''' mode pressing <code>SHIFT</code> + a sequence pad. In this mode, the pad matrix is divided in two parts: first four rows (from top to bottom) are '''the steps''' of current pattern. The last row is used to assign notes or '''instruments''' for easy access (called ''NotePads'' in this document). With this mode, you can:
 +
 +
* Press and hold <code>SHIFT</code> to '''show the status''':
 +
** Buttons <code>UP</code>, <code>DOWN</code>, <code>LEFT</code> and <code>RIGHT</code> will lit indicating the current Notepad page selected (1, 2, 3 or 4, respectively).
 +
** Button <code>SEND</code> will lit indicating this mode is selected.
 +
 +
* '''Open the pattern editor''' in Zynthian's UI with the current pattern, pressing <code>SHIFT</code> + <code>DOWN</code>. Press <code>SHIFT</code> + <code>UP</code> to go back.
 +
 +
* '''Assign an instrument''' to a NotePad, by pressing the pad + any key of the key bed (black and white keys). The note will be ''stored'' in that pad, with the velocity you used. It will be lit with a brightness proportional to the velocity. If you press again the NotePad, it will play the note.
 +
 +
* '''Remove a NotePad assignment''', pressing <code>STOP ALL CLIPS</code> + the NotePad. Only the assignment is removed, the steps for that note are kept.
 +
 +
* '''Select the active instrument''', pressing <code>SHIFT</code> + a NotePad. It will start pulsating in the color of the instrument's page.
 +
 +
* '''Change current instruments page''', pressing <code>LEFT</code> and <code>RIGHT</code> arrows. There are 4 pages, each with its own color (1: blue, 2: green, 3: yellow, 4: purple). Upon selecting a new page, one of the first four track buttons will be lit for a second, indicating the active page.
 +
 +
* '''Toggle a step''' in the current pattern, pressing a pad in the upper four rows. If the step is on, it will be lit in red (again, the brightness is proportional to the note velocity). Note that for this to work, you will need to first select an active NotePad.
 +
 +
* '''Extend a step duration''', by pressing an active step, holding it for 0.5 seconds, and then pressing another step (it must be greater in sequence). The source step will increase its duration to fill the space between the two pressed steps (included). The extended duration will be lit in orange. If you press the last pad in orange (while still holding the starting step), it will toggle between full and half step.
 +
 +
* '''Play current sequence''' pressing the <code>PLAY</code> button. You will see the playhead (in white) moving along the steps. Pressing <code>SHIFT</code> + <code>PLAY</code> will start stage-play, which will update the pattern as it moves along the current track (press any pad to stop stage-play). Press <code>PLAY</code> again to stop playing.
 +
 +
<p style="margin: 1em 0 1.5em; padding: 1em; background-color: #fef6e7; display:table-cell">
 +
'''NOTE''': Remember to set the ''clock source'' of Zynthian to '''Internal Send'''. Otherwise, the playhead will not be shown!
 +
</p>
 +
 +
* '''Panic stop''' all sounds, pressing <code>SHIFT</code> + <code>STOP ALL CLIPS</code>. Any sound will stop immediately.
 +
 +
* '''Adjust the tempo''' rotating the knob <code>K1</code>. The TEMPO screen will be shown briefly in the UI. Press <code>SHIFT</code> while rotating for a finer adjustment (0.1 BPM).
 +
 +
* '''Adjust sequence's chain level''' rotating the knob <code>K2</code>. Also, the Mixer screen will be shown briefly in the UI while adjusting. Press <code>SHIFT</code> while rotating for a finer control.
 +
 +
* Change the '''velocity, duration, stutter count or stutter duration''' of a step or NotePad, pressing the corresponding pad and rotating one of the following knobs:
 +
** <code>K1</code>: note duration
 +
** <code>K2</code>: note velocity
 +
** <code>K3</code>: stutter count
 +
** <code>K4</code>: stutter duration
 +
 +
* You can also change these properties using '''control levels'''. With a control level, you will use the columns of the pad matrix to see and change the level of certain property of a step or NotePad. These are the key bindings:
 +
** Press <code>VOLUME</code> + a step/NotePad to activate the control level for '''velocity''' adjustment. <code>VOLUME</code>'s track button will be solid lit in red. Press <code>VOLUME</code> again to exit control level mode.
 +
** Press <code>SEND</code> + a step/NotePad for '''stutter count''' adjustment. <code>SEND</code>'s track button will be solid lit in red.
 +
** In stutter count control level, press again <code>SEND</code> to switch to '''stutter duration''' adjustment. <code>SEND</code>'s track button will blink in red. Press <code>SEND</code> again to exit control level mode.
 +
** If, instead of pressing a pad, you press <code>VOLUME</code> or <code>SEND</code> + one of the 5 soft keys to the right, it will '''open the control level for each step or NotePad''' in that row. Now, just pressing another soft key will switch to the related row.
 +
** You can switch between different control levels by pressing the function that is not currently active (otherwise, it will exit that control level).
 +
** Pressing <code>SHIFT</code> + any pad in the active column will set the property value to zero (or 1, in case of stutter duration).
 +
** Press a pad in any active column to '''change''' the related step/NotePad value. Press top lit pad to switch between full and half value (the brightness will also change). The following table shows the relation between rows and values of each function (rows are from bottom to top, values are for Full/Half):
 +
 +
{| class="wikitable center"
 +
|-
 +
! Row !! Velocity !! Stutter Count !! Stutter Duration
 +
|-
 +
| 1 || 25 / 12 || 2 / 1 || 2 / 1
 +
|-
 +
| 2 || 50 / 38 || 4 / 3 || 4 / 3
 +
|-
 +
| 3 || 76 / 63 || 8 / 6 || 8 / 6
 +
|-
 +
| 4 || 101 / 88 || 12 / 10 || 20 / 10
 +
|-
 +
| 5 || 127 / 114 || 20 / 15 || 40 / 30
 +
|}
 +
 +
* Quick '''change pattern''' in current track, by pressing <code>SHIFT</code> + <code>LEFT</code>/<code>RIGHT</code>. If next pattern (to the right) does not exist, it will be created (up to 8 patterns). The bottom row of the pad matrix will show current pattern (in red), and also where there exists a pattern (bright white) or not (dim white).
 +
 +
* '''Roll current pattern to a side''', pressing <code>SHIFT</code> + <code>SELECT</code> + <code>LEFT</code> or <code>RIGHT</code>. This will copy current pattern to the pattern on the left or right.
 +
 +
* You can also '''enter the arranger sub-mode''' (also called ''PatMan'', for pattern manager), to handle the patterns of current track, pressing <code>SHIFT</code> + <code>SELECT</code>. This mode will also open the arranger in Zynthian's UI. In this sub-mode, you can:
 +
** '''Change''' current pattern, just pressing a pad where there is a pattern (bright white). The selected pattern will be shown in red. You can also move to the left or right using the track buttons.
 +
** '''Clear''' a pattern, pressing <code>MUTE</code> + pattern pad. It will remove all notes on that pattern. The pad will blink briefly in red.
 +
** '''Remove''' a pattern, pressing <code>STOP ALL CLIPS</code> + pattern pad. The pattern will be removed, and all patterns to the right will slide to fill the gap.
 +
** '''Create''' a new empty pattern, if there are no pattern to the right, by pressing <code>SHIFT</code> + <code>RIGHT</code>.
 +
** '''Roll''' current pattern to one side, pressing <code>SHIFT</code> + <code>SELECT</code> + <code>LEFT</code> or <code>RIGHT</code>.
 +
** '''Copy''' a pattern to another pattern, pressing source pattern pad + destination pattern pad. The destination will blink briefly in green.
 +
** To exit this sub-mode, press <code>SELECT</code>. Zynthian's UI will also go to the previous screen.
  
 
<br clear=all>
 
<br clear=all>
Line 65: Line 168:
 
====ZynMixer driver====
 
====ZynMixer driver====
  
[[File:akai_midimix_zynmixer.png|800px|right]]
+
[[File:Akai-midi-mix.jpg|800px|right]]
 +
 
 +
This Akai MIDIMix driver maps the basic mixer's functionality.
 +
Chains are numbered from left to right as shown in the zynmixer screen. Note that these numbers are not MIDI channels! 
 +
 
 +
* '''Bank Left:''' Strips assigned to chains 1-8
 +
* '''Bank Right:''' Strips assigned to chains 9-16
 +
* '''Master Slider:''' Main volume
 +
* '''Strip 1-8:''' Chain's mixer control, depending of bank selection
 +
** '''Upper Knobs:''' The 2 upper knobs are available for MIDI learning. 
 +
** '''Lower Knob:''' Chain's balance
 +
** '''Mute:''' Chain's mute switch
 +
** '''Solo''': Push <code>SOLO</code> to see solo status. Push <code>SOLO</code> + <code>MUTE</code> for toggling solo.   
 +
** '''Rec Arm''': Red light indicates active chain. Push to set active chain.
 +
** '''Slider:''' Chain's volume
 +
 
 +
<br clear=all>
 +
 
 +
==Akai MPK mini MK3==
 +
 
 +
[[File:akai_mpk_mini_mk3_driver_functions.png|800px|right]]
 +
 
 +
The driver for this device has 4 main operation modes:
 +
 
 +
* The '''Mixer''' mode (default) which handles Zynthian's Mixer.
 +
* The '''Device''' mode, to control the Zynthian GUI (Graphical User Interface).
 +
* The '''Pattern''' mode, for controlling the Zynpad and Pattern Editor.
 +
* The '''NotePad''' mode, which is used to assign the notes that the PADs will play in ''note'' mode.
 +
 
 +
There are two more minor modes, which are:
 +
 
 +
* A '''User''' mode, where every PAD and KNOB is available for MIDI learn.
 +
* A '''Config''' mode, used to configure the MPK internal settings, like the channels, the arpeggiator, and more.
 +
 
 +
Each mode is shown in the MPK display when active. <code>PADs 1-4 A</code> are used as direct access to some of Zynthian GUI screens:
 +
* <code>PAD 1 A</code>: toggles between Zynthian's '''mixer''' and audio levels.
 +
* <code>PAD 2 A</code>: cycles between '''Zynpad''', the arranger and pattern editor.
 +
* <code>PAD 3 A</code>: opens the '''tempo''' and metronome screen.
 +
* <code>PAD 4 A</code>: toggles between '''snapshot''' and ZS3 screens.
 +
 
 +
Each one of these functions or modes is available on every operation mode or screen. Just ensure that '''PC''' (PROG CHANGE) is active on the MPK.
 +
 
 +
<br clear=all>
 +
 
 +
====The Mixer mode====
 +
 
 +
[[File:akai_mpk_mini_mk3_mixer_mode.png|800px|right]]
 +
 
 +
This is the default mode, but you can switch back to it with '''PROG CHANGE''':<code>PAD 5 A</code>. You should see <code>Zynthian MIXER</code> in the display of the MPK. In this mode, you can use the Knobs to adjust chains settings. The general rule is: <code>PAD x</code> + <code>Knob y</code> to adjust the setting '''x''' of chain '''y'''. You can adjust chains 1 to 8 in bank A, and chains 9 to 16 in bank B. The functions that you can change are:
 +
 
 +
<p style="margin: 1em 0 1.5em; padding: 1em; background-color: #fef6e7; display:table-cell">
 +
'''NOTE''': Remember to put PAD CONTROLS in '''CC mode'''. The pads in ''note'' mode will only trigger the assigned notes.
 +
</p>
 +
 
 +
* <code>PAD 1 A</code> + <code>KNOBs 1-8</code> to adjust '''level''' of chains 1-8. <code>PAD 1 B</code> for chains 9-16.
 +
* <code>PAD 2 A</code> + <code>KNOBs 1-8</code> for '''balance''' (panning) of chains 1-8. <code>PAD 2 B</code> for chains 9-16.
 +
* <code>PAD 3 A</code> + <code>KNOBs 1-8</code> to toggle '''mute''' of chains 1-8. <code>PAD 3 B</code> for chains 9-16. Clockwise to set mute, counter clockwise to clear mute.
 +
* <code>PAD 4 A</code> + <code>KNOBs 1-8</code> to toggle '''solo''' of chains 1-8. <code>PAD 4 B</code> for chains 9-16. Same rules apply as for muting.
 +
 
 +
The driver will remember the last function pressed, so for adjusting chains 1-8, you can just press the desired PAD (1-4), release it, and then adjust using the knobs. All knobs will affect that PAD's function. For chains 9-16, you need the keep the PAD pressed.
 +
 
 +
In this mode, there is also support for '''transport controls''':
 +
 
 +
* <code>PAD 5 A/B</code> for '''stop all sounds''' (PANIC button).
 +
* <code>PAD 6 A</code> for toggle '''audio record'''. <code>PAD 6 B</code> will toggle '''MIDI record'''.
 +
* <code>PAD 7 A</code> will trigger '''audio stop''', while <code>PAD 7 B</code> will trigger '''MIDI stop'''.
 +
* <code>PAD 8 A</code> is for togging '''audio playback''', and <code>PAD 8 B</code> will toggle '''MIDI playback'''. 
 +
 
 +
If you activate the '''FULL LEVEL''' option in the MPK, then PAD's function changes to '''select''' chain. PADs in bank A will select first 8 chains, and bank B is used to select chains 9-16.
 +
 
 +
The joystick in this mode affects the pitch-bend (in the Y axis), and sends <code>CC</code> messages, <code>CC#32</code> for '''-X''' (left) and <code>CC#33</code> for '''+X''' (right) values, available for MIDI learning.
 +
 
 +
<br clear=all>
 +
 
 +
====The Device mode====
 +
 
 +
[[File:akai_mpk_mini_mk3_device_mode.png|800px|right]]
 +
 
 +
This mode is used to control Zynthian's GUI. You can activate it by pressing '''PROG CHANGE''':<code>PAD 6 A</code> anytime. The MPK display will show the label <code>Zynthian DEVICE</code>. In this mode, you have the following options:
 +
 
 +
<p style="margin: 1em 0 1.5em; padding: 1em; background-color: #fef6e7; display:table-cell">
 +
'''NOTE''': Remember to put PAD CONTROLS in '''CC mode'''. The pads in ''note'' mode will only trigger the assigned notes.
 +
</p>
 +
 
 +
* In '''bank A''':
 +
** Use <code>PADs 1-3</code> and <code>PAD 6</code> to '''move''' around the user interface (up, down, left and right, as shown in the diagram). You can also use the joystick for this.
 +
** '''Cancel''' or '''go back''' with <code>PAD 5</code>.
 +
** '''Accept''' or '''select''' an item, using <code>PAD 7</code>.
 +
** Launch the '''options''' menu, or the '''admin''' menu, by a short press in <code>PAD 8</code>. Each press will toggle between these two screens. With a ''long press'', it will '''shutdown''' the system (a confirm dialog will appear).
 +
** Open the '''controls''' or '''preset''' screen of a chain, doing a short press in <code>PAD 4</code>. In Zynpad, a ''long press'' of <code>PAD 4/7</code> will open the '''pattern editor''' for the selected sequence.
 +
 
 +
* In '''bank B''':
 +
** Upper row of PADs is used for '''transport buttons''', just like in the mixer mode:
 +
*** <code>PAD 5</code>: stop all sounds ('''panic''' button).
 +
*** <code>PAD 6</code>: toggle audio '''record'''.
 +
*** <code>PAD 7</code>: '''stop''' audio.
 +
*** <code>PAD 8</code>: toggle audio '''playback'''.
 +
** Lower row is used as V5 Knob '''press buttons'''. The mapping is from <code>PAD 1</code> to <code>PAD 4</code>, which are used as '''Knob#1''' to '''Knob#4''' press buttons. These buttons are available in CC and PC mode. This is mainly needed for MIDI learning features, where a CC message would establish the control's MIDI learn. CC is needed when a bold/long press is required.
 +
 
 +
This mode also maps the V5 Knobs to <code>K1</code>, <code>K5</code>, <code>K2</code>, <code>K6</code>, in that order.
 +
 
 +
Knob <code>K3</code> is used to adjust '''the tempo'''. When rotated, the Zynthian tempo screen will be shown briefly. This tempo setting is synchronized with the MPK.
 +
 
 +
<p style="margin: 1em 0 1.5em; padding: 1em; background-color: #fef6e7; display:table-cell">
 +
'''NOTE''': The MPK resolution is 1BPM, but Zynthian is 0.1BPM; take this into account to avoid drifting.
 +
</p>
 +
 
 +
<br clear=all>
 +
 
 +
====The Pattern mode====
 +
 
 +
[[File:akai_mpk_mini_mk3_pattern_mode.png|800px|right]]
 +
 
 +
This mode works only in Zynthian's Zynpad, Arranger or Pattern Editor. To activate it, press '''PROG CHANGE''':<code>PAD 7 A</code>. You should see <code>Zynthian PATTERN</code> in the display of your MPK. Note that all the following PADs are assumed to be in '''bank A'''.
 +
 
 +
<p style="margin: 1em 0 1.5em; padding: 1em; background-color: #fef6e7; display:table-cell">
 +
'''NOTE''': Remember to put PAD CONTROLS in '''CC mode'''. The pads in ''note'' mode will only trigger the assigned notes.
 +
</p>
 +
 
 +
In any screen (Zynpad, Arranger or Pattern Editor), you can:
 +
 
 +
* '''Move the cursor''' using the joystick, or <code>K2</code> for vertical and <code>K6</code> for horizontal displacement.
 +
* Press and hold <code>PAD 3</code> as '''SHIFT''', when required.
 +
 
 +
In '''Pattern Editor''', you will have the following functionality:
 +
 
 +
* '''Transport controls''' using the upper row PADs, following the same arrangement as in Mixer mode (<code>PAD 5</code>: stop all sounds, <code>PAD 6</code>: toggle record, <code>PAD 7</code>: stop, <code>PAD 8</code>: toggle playback).
 +
* '''Move along patterns''' of the same track in current sequence. Press <code>PAD 1</code> for previous pattern, and <code>PAD 2</code> for next. If there are no more patterns in current track, you can '''create a new one''' pressing <code>SHIFT</code> + <code>NEXT</code> (i.e: <code>PAD 3</code> + <code>PAD 2</code>) while visiting the last pattern.
 +
* '''Toggle step''' in cursor's position, pressing <code>PAD 4</code>.
 +
* '''Adjust''' the selected step, using the following Knobs:
 +
** Step's '''duration''': <code>K7</code>. It will change in increments of 0.1 steps, or, by pressing <code>SHIFT</code>, in 0.5 steps.
 +
** Step's  '''velocity''': <code>K8</code>.
 +
** Step's '''stutter count''': <code>K3</code>. Ranges from 0 to 32.
 +
** Step's '''stutter duration''': <code>K4</code>. Ranges from 1 to 96, and is measured in clock cycles.
 +
 
 +
In '''Zynpad''', you may:
 +
 
 +
** Toggle '''playing''' the selected sequence, by pressing <code>PAD 4</code>.
 +
** If the MPK is in '''FULL LEVEL''', each PAD can launch/stop a sequence. PADs in bank A, for sequences between 1 and 8, and bank B for sequences 9-16. 
 +
 
 +
<br clear=all>
 +
 
 +
====The NotePad mode====
 +
 
 +
[[File:akai_mpk_mini_mk3_notepad_mode.png|800px|right]]
 +
 
 +
The purpose of this mode is to modify the notes that the PADs will send in ''note'' mode (i.e. neither CC or PROG CHANGE active). You can switch to this mode by pressing '''PROG CHANGE''':<code>PAD 8 A</code>. You should see <code>Zynthian NOTEPAD</code> in the display of the MPK.
 +
 
 +
<p style="margin: 1em 0 1.5em; padding: 1em; background-color: #fef6e7; display:table-cell">
 +
'''NOTE''': Unlike the other modes, this mode only works if PAD CONTROLS are in '''note mode'''.
 +
</p>
 +
 
 +
To '''assign a note''' to a PAD, press that PAD and, without releasing it, press any key of the KeyBed. Press the pad again to check the note (it may be sent to a different chain, depending on PAD/KeyBed channels and Zynthian settings). In this mode, both banks A and B are available for note binding.
 +
 
 +
You can '''remove a note''' from a PAD pressing that PAD and, without releasing it, turning <code>K8</code> counter clock-wise. The removal will be done when you release the PAD, so, if you didn't want to remove it (and didn't release the PAD), just turn the Knob clock-wise again.
 +
 
 +
Using the Knob <code>K7</code> on a PAD will adjust its pitch (note) by a semitone, up and down the scale.
 +
 
 +
<br clear=all>
 +
 
 +
====The User mode====
 +
 
 +
This is a special mode, with no other purpose that letting you all the available controls for '''MIDI learning'''. Only PC 0-7 and 12,13 are NOT available (as they are used for changing modes and Zynthian's shortcuts). You can switch to this mode by pressing '''PROG CHANGE''':<code>PAD 5 B</code>. You should see <code>Zynthian USER</code> in the display of the MPK.
 +
 
 +
This is the available configuration:
 +
 
 +
* PADs channel is the assigned in Config mode (see below).
 +
* PAD notes are the assigned in NotePad.
 +
* PAD CCs are in range [40-47] for bank A, and [48-55] for bank B.
 +
* PC PADs 1, 2, 3, 4, 7 and 8 (all in bank B) are available.
 +
* All Knobs are available, and their CCs goes from 56 to 63.
 +
* Joystick Y channel is mapped as pitchbend.
 +
* Joystick X channel is set as dual mode, with CCs 64 (left side) and 65 (right side).
 +
 
 +
<br clear=all>
 +
 
 +
====The Config mode====
 +
 
 +
[[File:akai_mpk_mini_mk3_config_mode.png|800px|right]]
 +
 
 +
This is also a special mode, used to '''configure the MPK device''' internal settings, like the channel where the PADs will send their notes, or the '''arpeggiator''' settings.
 +
 
 +
'''Rationale:''' while you can use the MPK arpeggiator or NOTE REPEAT buttons to change some of these settings, they will be overwritten on next mode change (as they are inside the MPK and could not be retrieved). Moreover, there are settings that could only be changed using the MPK Program Editor, so this mode will help you in that case. Zynthian will store the changes you made here per snapshot basis, so that's another reason for using this mode.
 +
 
 +
<p style="margin: 1em 0 1.5em; padding: 1em; background-color: #fef6e7; display:table-cell">
 +
'''NOTE''': Remember to put PAD CONTROLS in '''CC mode'''. The pads in ''note'' mode will only trigger the assigned notes. ALSO, ensure that KeyBed octave is '''in the middle''' (neither <code>OCT+</code> nor <code>OCT-</code> is brightly lit).
 +
</p>
 +
 
 +
In this mode, all notes of the KeyBed are used as shortcuts for the '''arpeggiator settings'''. See the MPK KeyBed labels to check the purpose of each one. Also note that:
 +
 
 +
* <code>PAD 3 A</code> in CC mode is used as '''SHIFT'''.
 +
* <code>PAD 4 A</code> in CC mode toggles '''on/off''' the arpeggiator.
 +
 
 +
For other settings, you can use the Knobs. Move a Knob to see in the MPK display its function (but it won't change anything), and <code>SHIFT</code> + move Knob to actually change that property (changes are applied on <code>SHIFT</code> release). This is the settings mapping:
 +
 
 +
* <code>K1</code>: changes '''tempo taps''', the number of times you need to press the button <code>TAP TEMPO</code> to change it. Ranges from 2 to 4.
 +
* <code>K2</code>: to modify the '''arpeggiator swing''', giving you a finer adjustment than using the KeyBed shortcuts.
 +
* <code>K3</code>: to change the '''PADs aftertouch''' settings. Values are 0: Off, 1: Channel Aftertouch, 2: Polyphonic Aftetouch.
 +
* <code>K4</code>: for changing the KeyBed octave. A value of 4 is the default middle octave, less than 4 is for lowering the octave, and bigger that 4 increases the octave. '''NOTE:''' If you want to change this value, please note that it will affect the KeyBed immediately, so any shortcut that you use later on would be displaced. Just adjust this as the last value, or reset octave before using the shortcuts.
 +
* <code>K6</code>: for setting the '''arpeggiator clock''' source as EXT (external). Set it to 1 for using an external clock, or 0 to use the internal clock.
 +
* <code>K7</code>: lets you change the '''channel of the PADs'''.
 +
* <code>K8</code>: to modify the '''channel of the KeyBed'''.
  
 
<br clear=all>
 
<br clear=all>
Line 87: Line 391:
  
 
[[File:novation_launchpad_pro_mk2_zynpad.png|800px|right]]
 
[[File:novation_launchpad_pro_mk2_zynpad.png|800px|right]]
 +
 +
It works much like the Launchpad Mini MK3.
  
 
<br clear=all>
 
<br clear=all>
Line 94: Line 400:
  
 
[[File:novation_launchpad_pro_mk3_zynpad.png|800px|right]]
 
[[File:novation_launchpad_pro_mk3_zynpad.png|800px|right]]
 +
 +
It works much like the Launchpad Mini MK3.
  
 
<br clear=all>
 
<br clear=all>
Line 101: Line 409:
  
 
[[File:novation_launchpad_x_zynpad.png|800px|right]]
 
[[File:novation_launchpad_x_zynpad.png|800px|right]]
 +
 +
It works much like the Launchpad Mini MK3.
  
 
<br clear=all>
 
<br clear=all>
Line 113: Line 423:
 
==Behringer MOTÖR 61 / 49 ==
 
==Behringer MOTÖR 61 / 49 ==
  
[[File:behringer_motor.png|800px|right]]
+
====ZynPad driver====
 +
 
 +
[[File:behringer_motor.jpg|800px|right]]
 +
 
 +
====ZynMixer driver====
 +
 
 +
<br clear=all>
 +
 
 +
==Korg nanoKONTROL ==
 +
 
 +
====ZynMixer driver====
 +
 
 +
[[File:NanoKONTROL1.png|800px|right]]
 +
 
 +
<br clear=all>
 +
 
 +
==Korg nanoKONTROL-2  ==
 +
 
 +
====ZynMixer driver====
 +
 
 +
[[File:NanoKONTROL2.png|800px|right]]
 +
 
 +
This Korg nanoKONTROL2 driver maps the mixer screen and transport buttons basic functionality.
 +
Chains are numbered from left to right as shown in the zynmixer screen. Note that these numbers are not MIDI channels! 
 +
 
 +
=====Common buttons=====
 +
 
 +
* '''Cycle:''' SHIFT mode button. Toggle alternate functions as described below.
 +
* '''Track Left:''' UI Left arrow
 +
* '''Track Right:''' UI RIGHT arrow
 +
* '''Marker Set:''' UI SELECT button
 +
* '''Marker Left:''' UI UP arrow
 +
* '''Marker Right:''' UI DOWN arrow
 +
 
 +
* '''Transport FRWD (Left):''' Bank 1. Strips assigned to chains 1-8. When light, it acts as the UI BACK button.
 +
* '''Transport FFWD (Right):''' Bank 2. Strips assigned to chains 9-16
 +
 
 +
=====NORMAL mode=====
 +
 
 +
* '''Transport STOP:''' Stop audio play and reset play position.
 +
* '''Transport PLAY:''' Start/Resume/Pause audio play. Light indicates playing state.
 +
* '''Transport REC:''' Start/Stop audio recording. Light indicates recording state.
 +
 
 +
* '''Strip 1-8:''' Chain's mixer control, depending of bank selection
 +
** '''Knob:''' Chain's balance
 +
** '''Slider:''' Chain's volume
 +
** '''M:''' Chain's mute switch
 +
** '''S''': Chain's solo switch
 +
** '''R''': Red light indicates active chain. Push to set active chain.
 +
 
 +
=====SHIFT mode=====
 +
 
 +
* '''Transport STOP:''' Stop MIDI play and reset play position.
 +
* '''Transport PLAY:''' Start/Resume/Pause MIDI play. Light indicates playing state.
 +
* '''Transport REC:''' Start/Stop MIDI recording. Light indicates recording state.
 +
 
 +
* '''Knobs 1-8:''' Available for engine control (MIDI learning).
 +
 
 +
* '''Strip 1-7:''' Chain's mixer control, depending of bank selection
 +
** '''Slider:''' Chain's volume
 +
** '''M:''' Chain's mute switch
 +
** '''S''': Chain's solo switch
 +
** '''R''': Chain's recorder arm switch
 +
 
 +
* '''Strip 8:''' Main mixer control
 +
** '''Slider:''' Main volume
 +
** '''M:''' Main mute switch
 +
** '''S''': Global solo indication. Switch does nothing.
 +
** '''R''': Main recorder arm switch
  
 
<br clear=all>
 
<br clear=all>
Line 119: Line 497:
 
==Mackie Control==
 
==Mackie Control==
  
[[File:mackie_control.png|800px|right]]
+
[[File:mackie_control.jpg|800px|right]]
  
 
<br clear=all>
 
<br clear=all>

Latest revision as of 16:27, 20 November 2024

Zynthian can be connected to almost any existing MIDI device and you can use the MIDI learning mechanism, as described in the UI user's guide, to assign parameters to faders and knobs in your MIDI controller, for instance. You could also assign pad trigger to notes, etc. But MIDI learning process takes time, it's limiting and you can't get feedback easily. Sometimes it's a lot better to plug a well-known (supported) MIDI controller and get everything mapped automatically. For having this, zynthian implements a controller driver API that allows developers to create specific drivers for specific devices.

This section contain documentation for some of this controller drivers.


1 Akai APC Key25 MK2

This device supports three operation modes:

  • The "Mixpad" mode (default), which controls the Zynthian's Mixer and ZynPad.
  • The "Device" mode, which handles the Zynthian UI.
  • The "Sequencer" mode, which handles the Zynthian Step Sequencer.

1.1 The Mixpad mode

Akai apc key25 mk2.png

This is the default mode, selected automatically on start. You can also change to it pressing SHIFT + VOLUME or SHIFT + PAN. In this mode you can perform the following actions:

  • Tap a pad to start/stop a sequence. The pad LED will show its status as follows (pad color will always match the sequence color):
    • Dim solid: Stopped sequence without content (no notes in patterns).
    • Bright solid: Stopped sequence with content.
    • Blinking slow: Playing sequence.
    • Blinking fast: Recording sequence.
    • Pulsing: Syncing to play/stop.
  • Change controller's bank. There are two banks (1 and 2), which are used to handle up to 16 chains (with the eight track buttons/knobs). Bank 1 is for chains 1 to 8 and bank 2 manage chains 9 to 16. To show current selected bank, press and hold SHIFT. One of the track buttons LEFT arrow or RIGHT arrow will light up in red, LEFT arrow is bank 1 and RIGHT arrow is bank 2. You can press one of these buttons while holding SHIFT to change the bank.
  • Use track buttons to perform a function on chains. The function is chosen by pressing SHIFT + one of SELECT, MUTE or SOLO soft key buttons. Press and hold SHIFT to see current selected function on soft key buttons (in green). Functions are:
    • SELECT, used to change the selected chain. The key bed (black and white keys) will play on that chain.
    • MUTE, used to mute the corresponding chain.
    • SOLO, used to enable solo in the corresponding chain.
  • Mute main chain, pressing SHIFT + PLAY.
  • Change current scene using the track buttons. You need first to select that function by pressing SHIFT + REC ARM button. This function is affected by bank selection, so you can change up to 16 scenes. When selecting a new scene, the ZynPad will be shown.
  • Start/stop sequences of a row, pressing the corresponding SOFT KEY (without modifiers). If there are any sequence playing, they will stop. If there are no sequences playing, it will start those not empty. The action to be run is shown by the LED status (lit will stop, off will start).
  • Use the knobs to modify chains' volume or balance. The function is given by current KNOB CTRL selected: VOLUME or PAN (for balance). To change the function, press SHIFT + VOLUME or SHIFT + PAN. The knobs are also affected by current controller's bank. Each knob will affect a chain, independently of the selected chain. (K1 -> chain 1, K2 -> chain 2, ...)
  • Use SHIFT + KNOB k1 to change volume or balance for main chain (what changes is selected by the current KNOB CTRL function).
  • Press SHIFT + STOP ALL CLIPS for a 'panic' stop, which stops all sequences, audio and midi playback.
  • Toggle audio playback with PLAY/PAUSE button. If Zynthian's ALT mode is active, it will toggle MIDI playback.
  • Toggle audio record with SHIFT + RECORD button. If Zynthian's ALT mode is active, it will toggle MIDI recording.
  • Stop all sequences of current scene (but not audio/midi playback or recording), doing a short press on STOP ALL CLIPS button; bold press to stop all sequences on all scenes.
  • Open the StepSeq mode for a given sequence, pressing SHIFT + a pad button.
  • Clear a sequence, pressing any track button + the sequence pad.
  • Start recording a pattern. For this, press RECORD + a pad button, which will 1) select the chain associated with the group of the sequence, 2) open the pattern editor for that sequence, 3) start playing the sequence and 4) start recording that sequence. If you press the pad again (without holding any other button), the recording will stop. Press again to stop playback too. You can also control the playback/recording with PLAY/PAUSE and RECORD buttons.
  • If the pattern editor is open, press SHIFT + UP arrow to go back to ZynPad. Press it again to go to mixer screen.
  • Open the ZynPad pressing SHIFT + DOWN arrow.
  • Open the sequence manager (also known as the Seqman sub-mode), pressing SHIFT + CLIP STOP. If this mode is active, the LED of the CLIP STOP button will blink in green, and one of VOLUME, PAN or SEND buttons will also be solid in red, each one related to a specific function:
    • SEND: this is CLEAR mode. It will remove all patterns of the sequence when its pad is pressed (leaving only a single empty pattern).
    • VOLUME: this is COPY mode. Press the pad of a non-empty sequence to mark it as source (it will blink fast). Press another pad to copy the selected source to it. It will CLEAR the destination sequence, and then copy all the patterns of the source sequence. Press the selected source pad to clear selection.
    • PAN: this is MOVE mode. It works like COPY mode, but also CLEARS the source sequence.
    • Use LEFT and RIGHT arrows to move from one scene to another. You can also copy/move patterns between scenes.
    • Press SHIFT + SELECT to exit this sub-mode.

1.2 The Device mode

Akai-apc-key-25-mk2-ui-legend.png

This mode allows you to control the Zynthian UI. You can enable it by pressing SHIFT + DEVICE. If this mode is active, the button DEVICE will blink in red.

As you can see in the image, this mode mimics the Zynthian V5 hardware interface. The upper four buttons are OPT/ADMIN, MIX/LEVEL, CTRL/PRESET and ZS3/SHOT. Next row is ALT, METRONOME and PAD/STEP. The four buttons at the right side (in white) are F1 to F4. In this mode, transport is handled by PLAY/PAUSE and RECORD buttons, and the transport pads are only to show playback/recording status. Navigation buttons are UP, DOWN, LEFT, RIGHT, (in yellow) BACK/NO (in red) and SEL/YES (in green). For the directional keys, you can also use the track keys labelled as such.

The behaviour and status are similar of those in the hardware interface: there is support for short, bold and long press; screen access buttons are blue when no function is selected, green on it's primary and orange on its secondary function; ALT key changes to violet when active (and F1-F4 also change).

The nearest four knobs has the functions of Knob#1 to Knob#4. They can be used to control volume of selected/main chain, move vertically/horizontally in pattern editor or Zynpad, move selected item in menus, etc. Press SHIFT with a knob for a finer (slower) adjustment. The knob press is activated using the first four soft keys to the left (in green), and also has short/bold press support. The mapping is: Knob#1 = (K1, CLIP STOP); Knob#2 = (K5, SOLO); Knob#3 = (K2, MUTE); Knob#1 = (K6, REC ARM). This scheme is very comfortable in the V4 four-corners layout.


1.3 The Step Sequencer mode

Zynthian - Akai APC Key25 mk2 - StepSeq (alpha) demo I
Zynthian - Akai APC Key25 mk2 - StepSeq (alpha) demo II
Zynthian - Akai APC Key25 mk2 - StepSeq (beta) demo III

This mode allows you to control Zynthian's step sequencer (and also the pattern editor). You can activate it by pressing SHIFT + SEND, or in Mixpad mode pressing SHIFT + a sequence pad. In this mode, the pad matrix is divided in two parts: first four rows (from top to bottom) are the steps of current pattern. The last row is used to assign notes or instruments for easy access (called NotePads in this document). With this mode, you can:

  • Press and hold SHIFT to show the status:
    • Buttons UP, DOWN, LEFT and RIGHT will lit indicating the current Notepad page selected (1, 2, 3 or 4, respectively).
    • Button SEND will lit indicating this mode is selected.
  • Open the pattern editor in Zynthian's UI with the current pattern, pressing SHIFT + DOWN. Press SHIFT + UP to go back.
  • Assign an instrument to a NotePad, by pressing the pad + any key of the key bed (black and white keys). The note will be stored in that pad, with the velocity you used. It will be lit with a brightness proportional to the velocity. If you press again the NotePad, it will play the note.
  • Remove a NotePad assignment, pressing STOP ALL CLIPS + the NotePad. Only the assignment is removed, the steps for that note are kept.
  • Select the active instrument, pressing SHIFT + a NotePad. It will start pulsating in the color of the instrument's page.
  • Change current instruments page, pressing LEFT and RIGHT arrows. There are 4 pages, each with its own color (1: blue, 2: green, 3: yellow, 4: purple). Upon selecting a new page, one of the first four track buttons will be lit for a second, indicating the active page.
  • Toggle a step in the current pattern, pressing a pad in the upper four rows. If the step is on, it will be lit in red (again, the brightness is proportional to the note velocity). Note that for this to work, you will need to first select an active NotePad.
  • Extend a step duration, by pressing an active step, holding it for 0.5 seconds, and then pressing another step (it must be greater in sequence). The source step will increase its duration to fill the space between the two pressed steps (included). The extended duration will be lit in orange. If you press the last pad in orange (while still holding the starting step), it will toggle between full and half step.
  • Play current sequence pressing the PLAY button. You will see the playhead (in white) moving along the steps. Pressing SHIFT + PLAY will start stage-play, which will update the pattern as it moves along the current track (press any pad to stop stage-play). Press PLAY again to stop playing.

NOTE: Remember to set the clock source of Zynthian to Internal Send. Otherwise, the playhead will not be shown!

  • Panic stop all sounds, pressing SHIFT + STOP ALL CLIPS. Any sound will stop immediately.
  • Adjust the tempo rotating the knob K1. The TEMPO screen will be shown briefly in the UI. Press SHIFT while rotating for a finer adjustment (0.1 BPM).
  • Adjust sequence's chain level rotating the knob K2. Also, the Mixer screen will be shown briefly in the UI while adjusting. Press SHIFT while rotating for a finer control.
  • Change the velocity, duration, stutter count or stutter duration of a step or NotePad, pressing the corresponding pad and rotating one of the following knobs:
    • K1: note duration
    • K2: note velocity
    • K3: stutter count
    • K4: stutter duration
  • You can also change these properties using control levels. With a control level, you will use the columns of the pad matrix to see and change the level of certain property of a step or NotePad. These are the key bindings:
    • Press VOLUME + a step/NotePad to activate the control level for velocity adjustment. VOLUME's track button will be solid lit in red. Press VOLUME again to exit control level mode.
    • Press SEND + a step/NotePad for stutter count adjustment. SEND's track button will be solid lit in red.
    • In stutter count control level, press again SEND to switch to stutter duration adjustment. SEND's track button will blink in red. Press SEND again to exit control level mode.
    • If, instead of pressing a pad, you press VOLUME or SEND + one of the 5 soft keys to the right, it will open the control level for each step or NotePad in that row. Now, just pressing another soft key will switch to the related row.
    • You can switch between different control levels by pressing the function that is not currently active (otherwise, it will exit that control level).
    • Pressing SHIFT + any pad in the active column will set the property value to zero (or 1, in case of stutter duration).
    • Press a pad in any active column to change the related step/NotePad value. Press top lit pad to switch between full and half value (the brightness will also change). The following table shows the relation between rows and values of each function (rows are from bottom to top, values are for Full/Half):
Row Velocity Stutter Count Stutter Duration
1 25 / 12 2 / 1 2 / 1
2 50 / 38 4 / 3 4 / 3
3 76 / 63 8 / 6 8 / 6
4 101 / 88 12 / 10 20 / 10
5 127 / 114 20 / 15 40 / 30
  • Quick change pattern in current track, by pressing SHIFT + LEFT/RIGHT. If next pattern (to the right) does not exist, it will be created (up to 8 patterns). The bottom row of the pad matrix will show current pattern (in red), and also where there exists a pattern (bright white) or not (dim white).
  • Roll current pattern to a side, pressing SHIFT + SELECT + LEFT or RIGHT. This will copy current pattern to the pattern on the left or right.
  • You can also enter the arranger sub-mode (also called PatMan, for pattern manager), to handle the patterns of current track, pressing SHIFT + SELECT. This mode will also open the arranger in Zynthian's UI. In this sub-mode, you can:
    • Change current pattern, just pressing a pad where there is a pattern (bright white). The selected pattern will be shown in red. You can also move to the left or right using the track buttons.
    • Clear a pattern, pressing MUTE + pattern pad. It will remove all notes on that pattern. The pad will blink briefly in red.
    • Remove a pattern, pressing STOP ALL CLIPS + pattern pad. The pattern will be removed, and all patterns to the right will slide to fill the gap.
    • Create a new empty pattern, if there are no pattern to the right, by pressing SHIFT + RIGHT.
    • Roll current pattern to one side, pressing SHIFT + SELECT + LEFT or RIGHT.
    • Copy a pattern to another pattern, pressing source pattern pad + destination pattern pad. The destination will blink briefly in green.
    • To exit this sub-mode, press SELECT. Zynthian's UI will also go to the previous screen.


2 Akai MIDI MIX

2.1 ZynMixer driver

Akai-midi-mix.jpg

This Akai MIDIMix driver maps the basic mixer's functionality. Chains are numbered from left to right as shown in the zynmixer screen. Note that these numbers are not MIDI channels!

  • Bank Left: Strips assigned to chains 1-8
  • Bank Right: Strips assigned to chains 9-16
  • Master Slider: Main volume
  • Strip 1-8: Chain's mixer control, depending of bank selection
    • Upper Knobs: The 2 upper knobs are available for MIDI learning.
    • Lower Knob: Chain's balance
    • Mute: Chain's mute switch
    • Solo: Push SOLO to see solo status. Push SOLO + MUTE for toggling solo.
    • Rec Arm: Red light indicates active chain. Push to set active chain.
    • Slider: Chain's volume


3 Akai MPK mini MK3

Akai mpk mini mk3 driver functions.png

The driver for this device has 4 main operation modes:

  • The Mixer mode (default) which handles Zynthian's Mixer.
  • The Device mode, to control the Zynthian GUI (Graphical User Interface).
  • The Pattern mode, for controlling the Zynpad and Pattern Editor.
  • The NotePad mode, which is used to assign the notes that the PADs will play in note mode.

There are two more minor modes, which are:

  • A User mode, where every PAD and KNOB is available for MIDI learn.
  • A Config mode, used to configure the MPK internal settings, like the channels, the arpeggiator, and more.

Each mode is shown in the MPK display when active. PADs 1-4 A are used as direct access to some of Zynthian GUI screens:

  • PAD 1 A: toggles between Zynthian's mixer and audio levels.
  • PAD 2 A: cycles between Zynpad, the arranger and pattern editor.
  • PAD 3 A: opens the tempo and metronome screen.
  • PAD 4 A: toggles between snapshot and ZS3 screens.

Each one of these functions or modes is available on every operation mode or screen. Just ensure that PC (PROG CHANGE) is active on the MPK.


3.1 The Mixer mode

Akai mpk mini mk3 mixer mode.png

This is the default mode, but you can switch back to it with PROG CHANGE:PAD 5 A. You should see Zynthian MIXER in the display of the MPK. In this mode, you can use the Knobs to adjust chains settings. The general rule is: PAD x + Knob y to adjust the setting x of chain y. You can adjust chains 1 to 8 in bank A, and chains 9 to 16 in bank B. The functions that you can change are:

NOTE: Remember to put PAD CONTROLS in CC mode. The pads in note mode will only trigger the assigned notes.

  • PAD 1 A + KNOBs 1-8 to adjust level of chains 1-8. PAD 1 B for chains 9-16.
  • PAD 2 A + KNOBs 1-8 for balance (panning) of chains 1-8. PAD 2 B for chains 9-16.
  • PAD 3 A + KNOBs 1-8 to toggle mute of chains 1-8. PAD 3 B for chains 9-16. Clockwise to set mute, counter clockwise to clear mute.
  • PAD 4 A + KNOBs 1-8 to toggle solo of chains 1-8. PAD 4 B for chains 9-16. Same rules apply as for muting.

The driver will remember the last function pressed, so for adjusting chains 1-8, you can just press the desired PAD (1-4), release it, and then adjust using the knobs. All knobs will affect that PAD's function. For chains 9-16, you need the keep the PAD pressed.

In this mode, there is also support for transport controls:

  • PAD 5 A/B for stop all sounds (PANIC button).
  • PAD 6 A for toggle audio record. PAD 6 B will toggle MIDI record.
  • PAD 7 A will trigger audio stop, while PAD 7 B will trigger MIDI stop.
  • PAD 8 A is for togging audio playback, and PAD 8 B will toggle MIDI playback.

If you activate the FULL LEVEL option in the MPK, then PAD's function changes to select chain. PADs in bank A will select first 8 chains, and bank B is used to select chains 9-16.

The joystick in this mode affects the pitch-bend (in the Y axis), and sends CC messages, CC#32 for -X (left) and CC#33 for +X (right) values, available for MIDI learning.


3.2 The Device mode

Akai mpk mini mk3 device mode.png

This mode is used to control Zynthian's GUI. You can activate it by pressing PROG CHANGE:PAD 6 A anytime. The MPK display will show the label Zynthian DEVICE. In this mode, you have the following options:

NOTE: Remember to put PAD CONTROLS in CC mode. The pads in note mode will only trigger the assigned notes.

  • In bank A:
    • Use PADs 1-3 and PAD 6 to move around the user interface (up, down, left and right, as shown in the diagram). You can also use the joystick for this.
    • Cancel or go back with PAD 5.
    • Accept or select an item, using PAD 7.
    • Launch the options menu, or the admin menu, by a short press in PAD 8. Each press will toggle between these two screens. With a long press, it will shutdown the system (a confirm dialog will appear).
    • Open the controls or preset screen of a chain, doing a short press in PAD 4. In Zynpad, a long press of PAD 4/7 will open the pattern editor for the selected sequence.
  • In bank B:
    • Upper row of PADs is used for transport buttons, just like in the mixer mode:
      • PAD 5: stop all sounds (panic button).
      • PAD 6: toggle audio record.
      • PAD 7: stop audio.
      • PAD 8: toggle audio playback.
    • Lower row is used as V5 Knob press buttons. The mapping is from PAD 1 to PAD 4, which are used as Knob#1 to Knob#4 press buttons. These buttons are available in CC and PC mode. This is mainly needed for MIDI learning features, where a CC message would establish the control's MIDI learn. CC is needed when a bold/long press is required.

This mode also maps the V5 Knobs to K1, K5, K2, K6, in that order.

Knob K3 is used to adjust the tempo. When rotated, the Zynthian tempo screen will be shown briefly. This tempo setting is synchronized with the MPK.

NOTE: The MPK resolution is 1BPM, but Zynthian is 0.1BPM; take this into account to avoid drifting.


3.3 The Pattern mode

Akai mpk mini mk3 pattern mode.png

This mode works only in Zynthian's Zynpad, Arranger or Pattern Editor. To activate it, press PROG CHANGE:PAD 7 A. You should see Zynthian PATTERN in the display of your MPK. Note that all the following PADs are assumed to be in bank A.

NOTE: Remember to put PAD CONTROLS in CC mode. The pads in note mode will only trigger the assigned notes.

In any screen (Zynpad, Arranger or Pattern Editor), you can:

  • Move the cursor using the joystick, or K2 for vertical and K6 for horizontal displacement.
  • Press and hold PAD 3 as SHIFT, when required.

In Pattern Editor, you will have the following functionality:

  • Transport controls using the upper row PADs, following the same arrangement as in Mixer mode (PAD 5: stop all sounds, PAD 6: toggle record, PAD 7: stop, PAD 8: toggle playback).
  • Move along patterns of the same track in current sequence. Press PAD 1 for previous pattern, and PAD 2 for next. If there are no more patterns in current track, you can create a new one pressing SHIFT + NEXT (i.e: PAD 3 + PAD 2) while visiting the last pattern.
  • Toggle step in cursor's position, pressing PAD 4.
  • Adjust the selected step, using the following Knobs:
    • Step's duration: K7. It will change in increments of 0.1 steps, or, by pressing SHIFT, in 0.5 steps.
    • Step's velocity: K8.
    • Step's stutter count: K3. Ranges from 0 to 32.
    • Step's stutter duration: K4. Ranges from 1 to 96, and is measured in clock cycles.

In Zynpad, you may:

    • Toggle playing the selected sequence, by pressing PAD 4.
    • If the MPK is in FULL LEVEL, each PAD can launch/stop a sequence. PADs in bank A, for sequences between 1 and 8, and bank B for sequences 9-16.


3.4 The NotePad mode

Akai mpk mini mk3 notepad mode.png

The purpose of this mode is to modify the notes that the PADs will send in note mode (i.e. neither CC or PROG CHANGE active). You can switch to this mode by pressing PROG CHANGE:PAD 8 A. You should see Zynthian NOTEPAD in the display of the MPK.

NOTE: Unlike the other modes, this mode only works if PAD CONTROLS are in note mode.

To assign a note to a PAD, press that PAD and, without releasing it, press any key of the KeyBed. Press the pad again to check the note (it may be sent to a different chain, depending on PAD/KeyBed channels and Zynthian settings). In this mode, both banks A and B are available for note binding.

You can remove a note from a PAD pressing that PAD and, without releasing it, turning K8 counter clock-wise. The removal will be done when you release the PAD, so, if you didn't want to remove it (and didn't release the PAD), just turn the Knob clock-wise again.

Using the Knob K7 on a PAD will adjust its pitch (note) by a semitone, up and down the scale.


3.5 The User mode

This is a special mode, with no other purpose that letting you all the available controls for MIDI learning. Only PC 0-7 and 12,13 are NOT available (as they are used for changing modes and Zynthian's shortcuts). You can switch to this mode by pressing PROG CHANGE:PAD 5 B. You should see Zynthian USER in the display of the MPK.

This is the available configuration:

  • PADs channel is the assigned in Config mode (see below).
  • PAD notes are the assigned in NotePad.
  • PAD CCs are in range [40-47] for bank A, and [48-55] for bank B.
  • PC PADs 1, 2, 3, 4, 7 and 8 (all in bank B) are available.
  • All Knobs are available, and their CCs goes from 56 to 63.
  • Joystick Y channel is mapped as pitchbend.
  • Joystick X channel is set as dual mode, with CCs 64 (left side) and 65 (right side).


3.6 The Config mode

Akai mpk mini mk3 config mode.png

This is also a special mode, used to configure the MPK device internal settings, like the channel where the PADs will send their notes, or the arpeggiator settings.

Rationale: while you can use the MPK arpeggiator or NOTE REPEAT buttons to change some of these settings, they will be overwritten on next mode change (as they are inside the MPK and could not be retrieved). Moreover, there are settings that could only be changed using the MPK Program Editor, so this mode will help you in that case. Zynthian will store the changes you made here per snapshot basis, so that's another reason for using this mode.

NOTE: Remember to put PAD CONTROLS in CC mode. The pads in note mode will only trigger the assigned notes. ALSO, ensure that KeyBed octave is in the middle (neither OCT+ nor OCT- is brightly lit).

In this mode, all notes of the KeyBed are used as shortcuts for the arpeggiator settings. See the MPK KeyBed labels to check the purpose of each one. Also note that:

  • PAD 3 A in CC mode is used as SHIFT.
  • PAD 4 A in CC mode toggles on/off the arpeggiator.

For other settings, you can use the Knobs. Move a Knob to see in the MPK display its function (but it won't change anything), and SHIFT + move Knob to actually change that property (changes are applied on SHIFT release). This is the settings mapping:

  • K1: changes tempo taps, the number of times you need to press the button TAP TEMPO to change it. Ranges from 2 to 4.
  • K2: to modify the arpeggiator swing, giving you a finer adjustment than using the KeyBed shortcuts.
  • K3: to change the PADs aftertouch settings. Values are 0: Off, 1: Channel Aftertouch, 2: Polyphonic Aftetouch.
  • K4: for changing the KeyBed octave. A value of 4 is the default middle octave, less than 4 is for lowering the octave, and bigger that 4 increases the octave. NOTE: If you want to change this value, please note that it will affect the KeyBed immediately, so any shortcut that you use later on would be displaced. Just adjust this as the last value, or reset octave before using the shortcuts.
  • K6: for setting the arpeggiator clock source as EXT (external). Set it to 1 for using an external clock, or 0 to use the internal clock.
  • K7: lets you change the channel of the PADs.
  • K8: to modify the channel of the KeyBed.


4 Novation LAUNCHPAD MINI MK1

4.1 ZynPad driver

Novation launchpad mini mk1 zynpad.png


5 Novation LAUNCHPAD MINI MK3

5.1 ZynPad driver

Novation launchpad mini mk3 zynpad.png


6 Novation LAUNCHPAD PRO MK2

6.1 ZynPad driver

It works much like the Launchpad Mini MK3.


7 Novation LAUNCHPAD PRO MK3

7.1 ZynPad driver

It works much like the Launchpad Mini MK3.


8 Novation LAUNCHPAD X

8.1 ZynPad driver

It works much like the Launchpad Mini MK3.


9 Novation LAUNCHKEY MINI MK3

9.1 ZynPad driver


10 Behringer MOTÖR 61 / 49

10.1 ZynPad driver

Behringer motor.jpg

10.2 ZynMixer driver


11 Korg nanoKONTROL

11.1 ZynMixer driver

NanoKONTROL1.png


12 Korg nanoKONTROL-2

12.1 ZynMixer driver

NanoKONTROL2.png

This Korg nanoKONTROL2 driver maps the mixer screen and transport buttons basic functionality. Chains are numbered from left to right as shown in the zynmixer screen. Note that these numbers are not MIDI channels!

12.1.1 Common buttons
  • Cycle: SHIFT mode button. Toggle alternate functions as described below.
  • Track Left: UI Left arrow
  • Track Right: UI RIGHT arrow
  • Marker Set: UI SELECT button
  • Marker Left: UI UP arrow
  • Marker Right: UI DOWN arrow
  • Transport FRWD (Left): Bank 1. Strips assigned to chains 1-8. When light, it acts as the UI BACK button.
  • Transport FFWD (Right): Bank 2. Strips assigned to chains 9-16
12.1.2 NORMAL mode
  • Transport STOP: Stop audio play and reset play position.
  • Transport PLAY: Start/Resume/Pause audio play. Light indicates playing state.
  • Transport REC: Start/Stop audio recording. Light indicates recording state.
  • Strip 1-8: Chain's mixer control, depending of bank selection
    • Knob: Chain's balance
    • Slider: Chain's volume
    • M: Chain's mute switch
    • S: Chain's solo switch
    • R: Red light indicates active chain. Push to set active chain.
12.1.3 SHIFT mode
  • Transport STOP: Stop MIDI play and reset play position.
  • Transport PLAY: Start/Resume/Pause MIDI play. Light indicates playing state.
  • Transport REC: Start/Stop MIDI recording. Light indicates recording state.
  • Knobs 1-8: Available for engine control (MIDI learning).
  • Strip 1-7: Chain's mixer control, depending of bank selection
    • Slider: Chain's volume
    • M: Chain's mute switch
    • S: Chain's solo switch
    • R: Chain's recorder arm switch
  • Strip 8: Main mixer control
    • Slider: Main volume
    • M: Main mute switch
    • S: Global solo indication. Switch does nothing.
    • R: Main recorder arm switch


13 Mackie Control

Mackie control.jpg