3,632
edits
Changes
Jump to navigation
Jump to search
Line 1:
Line 1: − ==Introduction== − − Welcome to the Zynthian project, an open source hardware and software platform for musical explorers. Zynthian is a capable platform that can serve a range of musical needs from practice tool to sound design to live performance rig and more. You can find out about some of the features on the [[Zynthian Wiki Home|front page]] and [[Zynthian Features|here]]. − − The hardware includes the various official boxes from v1 through to the current (as of May 2026) V5.1. ([[Zynthian_Boxes_Photo_Gallery|See how some early versions evolved]]). On the software side, Zynthian '''Oram''' is the most recent version of zynthianOS, first released in September 2024 but this guide is for the development version that is prone to unannounced changes. − − − === How to get started === − − Just to remind those who are new here, there are '''three ways you can get started with Zynthian:''' − − # You can purchase an [https://zynthian.org/ official kit] for the most complete experience − # If you would like to try Zynthian at the lowest cost, you can grab a Raspberry Pi and a few peripherals and [[No Hardware Build|install a basic setup]] (best with Pi 4b and above) − # If you're more adventurous you can build yourself an [[Building Zynthian MINI V2|unofficial DIY kit]] or try [https://discourse.zynthian.org/t/success-cases/ DIY your own way] − − === Choose your own adventure === − This user guide describes how to start with zynthian but does not delve into much detail. There is built-in help within the zynthian that provides contextural help. Access this at any time by <span class="show_only_v5">'''bold-press''' ALT</span><span class="show_only_v4">'''long-press''' Knob 1</span>. − − <blockquote>'''''You can select the documentation for different hardware types (V5 or V4) with the selector in the top right of the page ↑'''''</blockquote> − If you are using V1-V3 then select V4. If you are using touchscreen only, use V5 with "V5 buttons" enabled. If you have a custom build, then select the version that closest matches your hardware. If your hardware uses features from different official kits then you may wish to check the documentation for each hardware type. − − It is '''strongly recommended that you read section 2 on core concepts''' which explains many aspects of how zynthian works. This provides essential knowledge to improve your understanding and ability to use zynthian. This guide includes details of how to navigate the user interface and some explanation of common workflows. Line 67:
Line 45: − − === The Zynthian Project === − − Zynthian is truly a community effort supported by core developers and the wider group of music makers who contribute in various ways whether by questions, testing (making music & experimentation), contributing code or updating this very wiki site. − − With that in mind, please know this guide is a living document, subject to frequent updates. Some sections may be incomplete and the whole document will improve during the lifetime of Zynthian Vangelis. If you want to get involved in documentation, visit the [https://discourse.zynthian.org/ forum] and request permission to edit the wiki. − − ==Basic concepts== − ===Processors & Chains=== − The fundamental building block of zynthian's sound architecture is the '''''processor'''''. A processor generates or manipulates audio or MIDI signals. Zynthian includes over 1000 processors to choose from. − − Processors are grouped together and interconnected within '''''chains'''''. Chains are a key concept in Zynthian. The first thing you will do after powering-on your zynthian for first time, once you stop celebrating your success, is creating a chain and adding some processors. It does little without any chains! − − Processors may be positioned within the chain in series or in parallel with other processors. The quantity of series or parallel processors is only limited by available processing power and there is no limit to the quantity of chains that may be added. Audio signals from chains by default feed a stereo mixer with typical mixer strip controls: fader, balance, mute, solo, phase reverse, etc. Audio processors may be positioned pre-fader or post-fader. (Note that zynthian treats most audio as stereo.) − − The audio and MIDI signals are routed between physical inputs, chain inputs, chain outputs, physical outputs and processor sidechain inputs. This provides a lot of flexibility whilst maintaining a simple, chain-based approach to signal routing. − <br> − <br> − [[File:Chains processors.png|An example of a chain|center]] − − ====Type of chains==== − When you create a chain, you must choose a '''type''' for it: − <br> − * '''Synth Chain''' => Receives MIDI note-events and generates audio output. It must have a synth processor. − * '''Audio Chain''' => Receives audio-input and generates audio-output. It only has audio-FX processors. − * '''MIDI Chain''' => Receives MIDI-input and generates MIDI-output. It only has MIDI processors. − * '''MIDI + Audio Chain''' => Receives MIDI + Audio input and generates MIDI + Audio output. It has MIDI and audio-FX processors. − * '''Generator Chain''' => Generates audio output using an algorithm. The first processor is an audio generator. − * '''Special Chain''' => It can contain special processors, a MOD-UI pedalboard or a Pure Data patch. It can process audio and MIDI. − <br> − The chain's type can't be changed after creating the chain. Processors can be added, removed and positioned within the chain. − − '''Synth and MIDI chains''' have a '''MIDI channel''' assigned. MIDI channels are not exclusive, so you can assign the same MIDI channel to several chains. − − In '''MIDI+Audio chains''', all audio processors in the chain receive all the MIDI events in the assigned channel. This is very convenient for some processors, like vocoder and auto-tune ones. − − '''MIDI chains''' can be configured to receive '''all MIDI channels'''. This is specially useful when using zynthian as a MIDI router. − − <br clear=all> − − ====Type of processors==== − There are five fundamental types of processor − <br> − * '''Synth''' => Receives MIDI events and generates audio output. − * '''MIDI''' => Receives MIDI events and generates MIDI output. − * '''Audio''' => Receives audio input and generates audio output. − * '''Generator''' => Generates audio output and has no input. − * '''Special''' => Receives MIDI events and audio input and generates MIDI output and audio output. − − Each type of processor is categorised to ease user selection, e.g. Synths have categories: Synth, Sampler, Piano, Organ, Acoustic & Percussion. − − Each processor has parameters that may be controlled with zynthian knobs or mapped to MIDI CC messages. Processors may have presets that may be arranged in banks. − − <br clear=all> − − ===Snapshots=== − [[File:snapshot_structure.png|400px|right]] − − A snapshot is the captured state of zynthian at the time of saving the snapshot. Snapshots are saved in a JSON file with ''.zss'' extension and can be loaded at any time, which effectively restores the state of the zynthian device when the snapshot was saved. Snapshots include: − − * '''chains layout:''' configuration of each chain including its processors and how they are arranged and connected − * '''audio levels:''' (optional) physical audio interface settings − * '''sequencer:''' patterns & sequences − * '''MIDI settings:''' global MIDI settings, USB MIDI port names, etc.!! − * '''multitrack record settings:''' mixer strips armed for multitrack recording − * '''UI state:''' some user interface configuration relevant to the snapshot (most UI is configured globally) − * '''sub-snapshots (ZS3s):''' most other configuration ([[#Sub-snapshots: ZS3|see ZS3]]) − − Each time you overwrite an existing snapshot file, a backup copy is created. Backups can also be restored at any time, which can avoid much suffering. When you feel the panic, remember that zynthian stores the full ''save history'' for '''all''' snapshots! − − <br clear=all> − − {{NoteBox|Many zynthian users like to see snapshots as "zynthian project" files and it's not a a bad approach.}} − − ====Last state snapshot==== − When zynthian starts, it always tries to restore the last state saved as this snapshot. It always tries to save the current state before performing some operations, like: − − * power-off − * restart − * update − * clean all − * etc. − − For convenience, the last state snapshot can also be saved or restored manually. − − ===Sub-snapshots: ZS3=== − ZS3 means '''Z'''ynthian '''S'''ub-'''S'''nap'''S'''hot. A ZS3 is a partial state that is stored in memory and can be recalled very fast. ZS3s can easily be associated (learned) to MIDI Programs (program change events). Of course, all ZS3s are saved and restored with snapshots, including the default state of the snapshot when first loaded (ZS3-0). − − Please bear in mind that in the case of USB-connected MIDI devices there are two settings configured in admin under "MIDI-USB mapped by port" that affect this functionality. − With mapped to port set the learnt settings will apply only to the specific USB Configuration in place at the time of learning. So if you add a USB hub to the rig the ZS3 sub-snapshots won't act. − Turning this off will allow control simply by the MIDI message only. − − When in the ZS3 screen, you can save the current (sub)state to ZS3 by sending a Program Change from any MIDI controller. − − BUT In order to be able to change ZS3 by Program Change, you have to tick the box at − − '''Interface->MIDI-options->Program Change ZS3 (Program Change for SubSnapShots)''' − − ZS3s include: − − * '''chains configuration:''' for each chain, MIDI channel, note-range, transpose, etc. − * '''processors state:''' for each processor, bank, preset & parameter values − * '''mixer settings:''' for each mixer strip, fader, balance, mute, solo, etc. − * '''MIDI devices configuration:''' active / multitimbral mode, etc. − * '''MIDI & Audio routing:''' connections between chains − * '''MIDI learning:''' MIDI bindings to processor and mixer parameters − * '''global settings:''' some global settings that can be changed by ZS3, e.g. MIDI transpose (most global settings are not available to ZS3) − * '''active chain''': chain that was active when the ZS3 was saved − − The key concept to understand how ZS3s work is noting that the '''chains layout is not stored in ZS3s'''. In other words, the chains layout is not modified when restoring ZS3s. You can't add/remove chains or processors by restoring ZS3s because this is a slow operation and ZS3s need to be restored very fast. − − When loading a snapshot that contains ZS3s, all the chains and processors are created. Later, when recalling the ZS3s, the chains layout will remain the same. Although ZS3s can modify routing, splits, banks, presets, etc., the quantity of chains and processors will be unchanged. − − {{NoteBox|For instance, if you are keyboardist that plays with several bands, you could have a snapshot for each band with ZS3s for each song.}} − − <br clear=all> − − <br clear=all> − − ===Signal workflow=== − As introduced above, Zynthian's signal workflow is based around chains of audio & MIDI processors that feed an audio summing mixer and MIDI outputs. This diagram gives an overview of signal paths which may help in understanding the flow of audio and MIDI signals. − − [[File:Zynthian Signal Flow.png|800px|center]] − − <br clear=all> − − ====Last state snapshot==== − When zynthian starts, it always tries to restore the last state saved as this snapshot. It always tries to save the current state before performing some operations, like: − − * power-off − * restart − * update − * clean all − * etc. − − For convenience, the last state snapshot can also be saved or restored manually. − − ==The physical interface== − <div class="show_only_v5"> − [[File:v5_render_zenital_mixer.jpg|1024px|center]] − </div> − <div class="show_only_v4"> − [[File:v4_render_zenital_mixer.jpg|1024px|center]] − </div> − <div class="show_only_touch"> − [[File:zynthian_barebones.png|800px|center]] − </div> − − ===Description=== − − <div class="show_only_v5"> − The V5 physical user interface is composed of: − − * '''4 infinite knobs (rotary encoders) with push switches''' − * '''5x4 silicone push button grid with RGB-LED feedback''' − * '''5 inch display with capacitive touch''' − − The 20 silicone push buttons and the 4 knobs with switches are the primary user input mechanism to navigate the UI: − − * '''access the different views''' − * '''select options on menus and lists''' − * '''modify parameters''' − − Each push button is engraved with a text legend or icon and backlit with RGB LED that gives status feedback. The knobs are numbered from top to bottom, so the top one is knob#1 and the bottom one is knob#4. We will refer to knobs in this way throughout this guide. − </div> − − <div class="show_only_v4"> − The V4 physical user interface is composed of: − − * '''4 infinite knobs (rotary encoders) with push switches''' − * '''4 silicone push buttons''': These buttons doesn't exist in older V1-V3 kit versions. − * '''3,5 inch display with resistive touch''' − − The four knobs with switches are the primary user input mechanism to navigate the UI: − − * '''access the different views''' − * '''select options on menus and lists''' − * '''modify parameters''' − </div> − − <div class="show_only_touch"> − Zynthian can be operated entriely using touch or mouse if touch navigation is enabled in webconf. A minimum display size of 5 inches and capacitive touch is recommended when this is the primary user input method. If using a smaller or resistive touch then a stylus is highly recommended. − − Zynthian UI can also be run head-less, accessed remotely with VNC. − </div> − − ===User interaction=== − <span class="show_only_v4 show_only_v5"> − Users interact with the system by pressing the silicone buttons or knob-switches or rotating the knobs. Touch can be used too for most operations and some interactions are only available from the touch interface, like the X-Y control ''ala kaos pad''. − </span> − <span class="show_only_touch"> − Users interact with the system by touching or clicking the display elements and performing touch or mouse gestures, like drag, horizontal or vertical swipes, pinch-zoom, etc. The topbar and status area also act as touch zones. See sections below for details. If a mouse is used, its wheel can be used to scroll various parts of the UI. − </span> − User actions normally produce some feedback in the display. <span class="show_only_v5">Also, the RBG LEDs give feedback and status info.</span> − </div> − − ===Types of action=== − − <div class="show_only_v4 show_only_v5"> − User actions can be divided in 3 groups: − − * '''Press:''' You can press buttons, knob-switches or display widgets. There are 3 types of press actions, depending on how long you hold down before releasing. − * '''Knob rotation:''' You can rotate knobs, of course ;-) − * '''Touch gestures''' with display's touch surface or mouse: Drag, swipe, pitch-zoom, 2-fingers drag, etc. − </div><div class="show_only_touch"> − User actions can be divided in 2 groups: − − * '''Press:''' You can tap display widgets. There are 3 types of tap (press) actions, depending on how long you hold down before releasing. − * '''Touch gestures''' with display's touch surface or mouse: Drag, swipe, pitch-zoom, 2-fingers drag, etc. − </div> − − These icons are used throughout this guide to indicate UI actions : − − {| class="wikitable show_only_v4 show_only_v5" style="margin:auto" − !colspan="3"|UI actions − |- − |style="padding:10px"|<span style="color:#00FF00">[[File:Ui push short icon.png|35px]]</span> − |style="padding:10px"|'''Short Press''' − |style="padding:10px"|Press and release in less than 0.3 seconds. Normally used to select an item, check/uncheck an option or trigger the default action for the item. − |- − |style="padding:10px"|<span style="color:#008F00">[[File:Ui push bold icon.png|35px]]</span> − |style="padding:10px"|'''Bold Press''' − |style="padding:10px"|Press and hold for longer than 0.3 seconds then release before 2 seconds. Normally used to open options menu, access extra details or edit the item. − |- − |style="padding:10px"|<span style="color:#008F00">[[File:Ui push long icon.png|35px]]</span> − |style="padding:10px"|'''Long Press''' − |style="padding:10px"|Press and hold for longer than 2 seconds. Long-action triggers before release. Used for important functions that are not used very often. − |- − |style="padding:10px"|<span style="color:#008F00">[[File:Ui knob rotate icon.png|35px]]</span> − |style="padding:10px"|'''Knob Rotate''' − |style="padding:10px"|Rotate the knob. Used to change parameter values or move across a list or grid. − |} − {| class="wikitable show_only_touch" style="margin:auto" − !colspan="3"|UI actions − |- − |style="padding:10px"|<span style="color:#008F00">[[File:Ui push short icon.png|35px]]</span> − |style="padding:10px"|'''Short Press''' − |style="padding:10px"|Press and release in less than 0.3 seconds. Normally used to select an item, check/uncheck an option or trigger the default action for the item. − |- − |style="padding:10px"|<span style="color:#008F00">[[File:Ui push bold icon.png|35px]]</span> − |style="padding:10px"|'''Bold Press''' − |style="padding:10px"|Press and hold for longer than 0.3 seconds then release before 2 seconds. Normally used to open options menu, access extra details or edit the item. − |- − |style="padding:10px"|<span style="color:#008F00">[[File:Ui push long icon.png|35px]]</span> − |style="padding:10px"|'''Long Press''' − |style="padding:10px"|Press and hold for longer than 2 seconds. Long-action triggers before release. Used for important functions that are not used very often. − |- − |style="padding:10px"|<span style="color:#008F00">Horizontal Drag</span> − |style="padding:10px"|'''Horizontal Drag''' − |style="padding:10px"|Press and drag horizontally. Must release before you can drag vertically. If still moving when released, a swipe action may occur. − |- − |style="padding:10px"|<span style="color:#008F00">Vertical Drag</span> − |style="padding:10px"|'''Vertical Drag''' − |style="padding:10px"|Press and drag vertically. Must release before you can drag horizontally. If still moving when released, a swipe actin may occur. − |- − |style="padding:10px"|<span style="color:#008F00">2 Finger Horizontal Drag</span> − |style="padding:10px"|'''2 Finger Horizontal Drag''' − |style="padding:10px"|Press with 2 fingers and drag horizontally. Must release before you can drag vertically. If still moving when released, a swipe actin may occur. − |- − |style="padding:10px"|<span style="color:#008F00">2 Finger Vertical Drag</span> − |style="padding:10px"|'''2 Finger Vertical Drag''' − |style="padding:10px"|Press with 2 fingers and drag vertically. Must release before you can drag horizontally. If still moving when released, a swipe actin may occur. − |- − |style="padding:10px"|<span style="color:#008F00">Horizontal Pinch</span> − |style="padding:10px"|'''Horizontal Pinch''' − |style="padding:10px"|Press with two fingers then drag horzontally towards or away from each other. Must release before you can pinch vertically. − |- − |style="padding:10px"|<span style="color:#008F00">Vertical Pinch</span> − |style="padding:10px"|'''Vertical Pinch''' − |style="padding:10px"|Press with two fingers then drag vertically towards or away from each other. Must release before you can pinch horizontally. − |} − − {{NoteBox|You can '''change the timings''' of the ''short/bold/long press'' actions from the [[Web_Configuration_User_Guide#User_Interface|webconf's UI options tab]]. − Not all controls have actions assigned to all three press types. You can modify the assigned actions from the webconf tool, accessing the advanced options in the ''wiring layout'' section.}} − − <div class="show_only_v5 show_only_v4"> − − ===Using the knobs=== − <div class="show_only_v5"> − [[File:v5_render_knobs_numbered.jpg|140px|right]] − The V5 knobs behave quite differently from the V1-V4 knobs. Because of the 20 silicone buttons, there is no need to use the knobs' switches to navigate the UI which now is best achieved with the press buttons, so when appropriate, knobs' switches have been mapped to drive the MIDI learning functionality, which is quite intuitive. The knobs are numbered from top to bottom, so the top one is ''knob#1'' and the bottom one is ''knob#4''. We will refer knobs in this way throughout this guide. − <br> − − '''General rule''' − − Although a knob's behavior is contextual, there is a kind of pattern that can serve as a ''general rule'' and applies to many views: − <br> − * '''Knob#4''' is the '''select knob'''. − ** '''rotate''' to browse lists and move the cursor horizontally in grids. − ** '''short-press''' to select items, like the SEL button. − ** '''bold-press''' to open contextual options, like the OPT button. − * '''Knob#3''' − ** '''rotate''' to move the cursor vertically in grids. − <br> − − {{NoteBox| The MAIN Volume is always available with one click. Press '''MIX button''' and rotate '''Knob#3''' to change the MAIN volume.}} − </div> − − <div class="show_only_v4"> − The V4 knobs (rotaries & switches) are the primary mechanism to navigate the UI. Its functionality is contextual, specially rotate, short and bold-press actions. Long press actions are always global. The knobs' names used in this guide are the names printed in the official V4 aluminum case, but you could find some section using the numbered notation, from top to bottom and left to right: − − * '''layer''' => knob#1 − * '''back''' => knob#2 − * '''learn/shot''' => knob#3 − * '''select''' => knob#4 − − '''General rule''' − − Although a knob's behavior is contextual, there is a kind of pattern that can serve as a ''general rule'' and applies to many views: − <br> − * '''SELECT Knob''' − ** ''rotate'' to browse lists and move the cursor horizontally in grids. − ** ''short-press'' to select items. − * '''BACK Knob''' − ** ''rotate'' to move the cursor vertically in grids. − ** ''short-press'' to go back to previous view. − − This general rule is extended in the next section. − − {{NoteBox| The MAIN Volume is always available with one click. Bold-press '''BACK Knob''' to open the mixer view, then rotate '''Learn/Shot Knob''' to change the MAIN volume.}} − </div> − </div> − − <div class="show_only_v4 show_only_v5"> − − ===Using the push buttons=== − <div class="show_only_v5"> − The V5 push buttons grid is divided in 5 groups: − <br> − <br> − '''<span style="color:#00D000;">View buttons</span>''' − [[File:v5_buttons_outlined.png|400px|right]] − − ''View'' buttons are outlined in green in the image and they allow direct access to the main views. Most of these buttons have 2 different views assigned, with a horizontal line separating two printed labels. The primary view is printed at top and the secondary view is printed at bottom. The "metronome" button is the exception, as it's the tap-tempo button. You press it once to access the '''tempo settings''' view, but you can tap it several times to change the tempo BPM. Try it! − − LED color depends on current view: − − * when the primary view is shown, the button lights green. − * when the secondary view is shown, the button lights orange. − * when none of the button's views are shown, the button lights blue. − − A '''short-press''' on the button will access: − − * the primary view, when the button's primary view is not shown − * the secondary view, when button's primary view is shown − − A '''bold-press''' on the button will '''always''' access the secondary view, no matter what the current view is. − − For instance, if you are in the mixer view and short-press OPT/ADMIN, the ''Main'' menu will be opened. If you short-press it again, the ''Admin'' menu will be opened. Then, if you bold-press the MIX/LEVEL button, the ''Audio Levels'' view will be opened. You press "metronome" button and the ''Tempo settings'' view will be opened. If you tap it several times, the tempo BPM will be changed, e.g. tap twice per second to set tempo to 120BPM. − − The ''View'' buttons are, from left to right and top to bottom: − − [[File:v5_buttons_outlined-3-detail2.png|400px|right]] − − * '''OPT/ADMIN''' − ** '''Options / Menu''': Opens the context menu for the current view. Press again to reach the '''[[#Main_menu|main menu]]'''. − ** '''[[#Admin|Admin menu]]''' − * '''MIX/LEVEL''' − ** '''[[#Mixer|Mixer]]''' − ** '''[[#Audio levels|Audio Levels]]''' − * '''CTRL/PRESET''' − ** '''[[#Chain control|Chain Control]]''' − ** '''[[#Presets|Presets]] / [[#Banks|Banks]]''' − * '''ZS3/SNAPSHOT''' − ** '''[[#ZS3 (sub-snapshots)|ZS3 (sub-snapshots)]]''' − ** '''[[#Snapshots|Snapshots]]''' − * '''METRONOME''' − ** '''[[#Tempo Settings|Tempo Settings / Tap-Tempo]]''' − * '''PAD/STEP''' − ** '''[[#Zynpad (Scene)|Zynpad (Scene)]]''' − ** '''[[#Pattern Editor|Pattern Editor]]''' − − Some buttons have a global tertiary function assigned to '''long-press''': − − * '''OPT/ADMIN''': long-press to '''power off'''. − * '''CTRL/PRESET''': long-press to enter/leave '''preset favorites'''. − * '''PAD/STEP''': long-press to access the '''[[#Arranger|arranger view]]'''. − − <br clear=all> − − '''<span style="color:#D000D0;">ALT button</span>''' − [[File:v5_buttons_outlined-4.png|400px|right]] − − The ALT button toggles the alternate function mode. When you press it, the ALT button and the buttons having an alternate function will change their default color from blue to purple or orange. − ALT mode is contextual, depending on the current view. By default, only transport and custom buttons (F1-F4) have alternate functions, defined like this: − − * '''Transport buttons''' toggle between Audio Player/Recorder <span style="color:#0000F0">(normal)</span> and MIDI Player/Recorder <span style="color:#D000D0">(alternate)</span>. − * '''Customizable F1-F4 buttons''' toggle between Program Change 1-4 <span style="color:#0000F0">(normal)</span> and Program Change 5-8 <span style="color:#D000D0">(alternate)</span>. You could use it, for instance, to learn and recall up to 8 subsnapshots (ZS3s). − − Some views have a '''custom ALT mode''' with specific functionality that partially or totally overrides the defaults. See the details in the sections below. − − <br> − '''<span style="color:#F00000;">Transport buttons</span>''' − [[File:v5_buttons_outlined-3-detail.png|400px|right]] − By default, transport buttons control the '''global audio recorder/player''' and the default color is blue. When the '''ALT''' button is pressed (ALT mode enabled), transport buttons control the '''MIDI recorder/player''' and the color is purple. − − * '''short-press REC''' (solid circle) to start/stop a recording. When a recording is in progress, the record button lights red and you should also see the rec icon in the display status area, at top-right. − − * '''short-press PLAY''' (solid triangle) to play/pause the currently selected track. The last recorded track is selected by default. When a track is being played, the play button lights green. After pausing, pressing again will resume playing at the point it was paused. − − * '''bold-press PLAY''' to open the track list. After selecting a track, the audio player control view will be shown. − − * '''short-press STOP''' (solid square) to stop playing a track and rewind. Pressing play again will start playing from the beginning. − − * '''bold-press STOP''' to stop all sounds, including any audio/MIDI track and sequences. − − In some views/modes, transport buttons have specific (contextual) behaviour. When this happens, they will light orange to help you to remember their normal behavior is altered. See the sections below to have the specific details. − <br> − − '''<span style="color:#F0C000;">Navigation buttons</span>''' − [[File:v5_buttons_outlined-detail3.png|400px|right]] − Navigation buttons are used for basic navigation and operation: − − * '''UP/DOWN:''' − ** Browse lists and menus. − ** Move cursor (selected item) vertically in pattern editor, zynpad, etc. − * '''LEFT/RIGHT:''' − ** Select active chain in the mixer and chain-control views. − ** Move cursor (selected item) horizontally in pattern editor, zynpad, etc. − * '''SEL/YES:''' − ** Select items in lists and menus. − ** Enter ''select mode'' in chain-control view for browsing controller pages. − ** Add/remove notes in pattern editor. − ** Play/Stop sequences in zynpad. − ** Answer "Yes" in confirmation dialogs. − ** Bold-press may open the options menu for the selected item. − * '''BACK/NO:''' − ** Close current view, returning to previous view. − ** Answer "No" in confirmation dialogs. − − <br> − − {{NoteBox|When not in the control view, '''knob#4 acts as the ''select'' knob''' similar to the classic V1-V4 UI. Rotate to browse lists and move the cursor horizontally in grids (zynpad, pattern editor, etc.). Press to select items, same than SELECT button. Knob#3 can be used to move the cursor vertically in grids (zynpad, pattern editor, etc.).}} − <br> − − '''<span style="color:#0000D0;">Custom function buttons (F1-F4)</span>'''<br> − These buttons are considered to be customizable buttons, e.g. if you want direct access to other views, etc. you may reconfigure these buttons using the webconf's wiring layout tab. − − As explained above, while describing the ALT-mode, these buttons are assigned by default to MIDI Program Change messages: − − * '''Normal mode''': Program Change 1-4 − * '''ALT mode''': Program Change 5-8 − − This default configuration is fine for learning/recalling subsnapshots (ZS3) and you may find this really useful if you use your zynthian as a keyboard expander. − − <br clear=all> − − {{NoteBox|Although all buttons and switches are fully configurable from the webconf tool (''hardware->wiring->advanced''), this guide refers to the official V5 profile configuration, that matches printed button legends. Of course, you are very welcome to experiment with button assignment and try different configurations. In fact, if you reach a sweet point, we may be able to produce an alternative keypad with custom printings. Simply contact us at the [https://discourse.zynthian.org zynthian forum]!}} − − <br clear=all> − </div> − − <div class="show_only_v4"> − [[File:ui_action_global_v4.jpg|800px|right]] − − The zynthian's classic workflow (V1-V4) is based on the 4 knobs' switches. While short-press actions are generally contextual, bold and long-press actions are generally global. − − Along the sections below, when omitted, these are the default press actions: − − * '''layer''' − ** '''''bold-press''''' to open the ''main menu''. − ** '''''long-press''''' to open the ''admin menu''. − * '''back''' − ** '''''short-press''''' to back to the previous view. − ** '''''bold-press''''' to open the '''mixer view'''. − ** '''''long-press''''' to '''PANIC!'''. Stop all notes & sounds. − * '''learn/shot''' − ** '''''bold-press''''' to open the '''ZS3 list'''. − ** '''''long-press''''' to open the '''snapshot list'''. − * '''select''' − ** '''''short-press''''' to select/check/uncheck an item − ** '''''bold-press''''' to open contextual options. − ** '''''long-press''''' to '''power off''' the zynthian (it will ask to confirm). − − <br clear=all> − − '''The V4's extra buttons''' − − The V4's extra silicone push buttons (S1-S4) can be configured depending on the user preference. This can be done from the webconf tool, accessing the advanced options in the wiring layout section. Some predefined customization profiles are available from there: − − * '''V4 Stage:''' The 4 silicone push buttons are assigned to MIDI program change 1-4. It's specially thought to use with ZS3. − ** '''S1''' => MIDI Program 1 − ** '''S2''' => MIDI Program 2 − ** '''S3''' => MIDI Program 3 − ** '''S4''' => MIDI Program 4 − − * '''V4 Studio:''' The 4 silicone push buttons are assigned like this: − ** '''S1''' − ***'''short''' => Audio Recorder/Player − ***'''bold''' => MIDI Recorder/Player − ***'''long''' => All Sounds Off − ** '''S2''' − ***'''short''' => Zynpad − ***'''bold''' => Pattern Editor − ***'''long''' => All Sounds Off − ** '''S3''' − ***'''short/bold''' => Arrow Up − ***'''long''' => All Sounds Off − ** '''S4''' − ***'''short/bold''' => Arrow Down − ***'''long''' => All Sounds Off − − * '''V4 CC Switches:''' The 4 silicone push buttons are assigned to MIDI CC 47-50. It's specially thought to MIDI learn toggle parameters (i.e. to use with SooperLooper) − ** '''S1''' => CC 47 (value 0/127) − ** '''S2''' => CC 48 (value 0/127) − ** '''S3''' => CC 49 (value 0/127) − ** '''S4''' => CC 50 (value 0/127) − </div> − </div> − − ==The top-bar== − − At the top of the display there is usually a bar that contains information. This may not be visible for some views, such as confirmation or information pop-ups. − ===The title-bar=== − <div class="show_only_v5 show_only_v4"> − [[File:title_bar_mixer.png|400px|right|Title Bar]] − </div> − <div class="show_only_touch"> − [[File:title_bar_mixer_touch.png|400px|right|Title bar with touch back button]] − </div> − The title bar acts as a kind of breadcrumb. It normally shows the view's title or info about the current snapshot/zs3 or chain (MIDI channel, engine, bank & preset). − <div class="show_only_touch"> − It may also show a BACK button on the left which. When tapped will return to the previous view. Tapping the title's bar itself will open the options menu − </div> − − <br clear=all> − − ===The status area=== − [[File:Zynthian_Status_Bar.png|400px|right]] − − On the top-right corner, aside the title bar, is an area where some useful information is displayed in real time: − − * '''Digital Audio Peak Meter (DPM)''': horizontal bars indicating digital audio level and peaks − * '''Status icons''': indication of various zynthian states − − ====The Digital Audio Peak Meter (DPM)==== − The DPM covers the range -50dBFS to 0dBFS, i.e. maximum permissible level at full scale (far right) down to 50dB below (far left): − − * The green segment covers the range -50dBFS to -10dBFS. − * The yellow segment covers the range -10dBFS to -3dBFS. − * The red segment covers the range -3dBFS to 0dBFS. − − There are independent meters for left and right channels which monitor the system output, i.e. the mix of audio that feeds the Zynthian output. Level decays with a logarithmic rule, taking one second to decay to -200dBFS so will decay to -50dBFS (the displayed range) in about quarter of a second. Peaks are displayed instantly, i.e. the attack of the meter is immediate (*). The peak hold bar remains for two seconds or until a higher peak is reached. − − This meter is the same as the main mixbus DPM that is always visible in the mixer view and is therefore hidden when the audio mixer view is shown. − − (*) Meter is updated 5 times per second so there can be 200 ms delay in peak being displayed. − − ====The status icons==== − {| class="wikitable" style="margin:auto" − !colspan="3"|1st row: Health & Load − |- − |style="padding:10px"|<span style="color:#00FF00">{{#fas:heart}}</span> − |style="padding:10px"|'''Cpu Load''' − |style="padding:10px"|Heart, indicating CPU load. It displays as green when under 50%, yellow when load is over 50% and red over 75%. − |- − |style="padding:10px"|<span style="color:#00FF00">{{#fas:recycle}}</span> − |style="padding:10px"|'''Software update available''' − |style="padding:10px"|When a software update is available, the green recycle symbol is shown. You can update from the admin menu, webconf or terminal. − |- − |style="padding:10px"|<span style="color:#FF0000">{{#fas:exclamation-triangle}}</span> − |style="padding:10px"|'''XRun''' − |style="padding:10px"|It's shown when there are XRuns. This may be accompanied by clicks and pops on audio output. This means the CPU can't process or transfer audio fast enough and you should consider disabling some CPU-hungry option (like VNC, headphones, etc.) or reducing the complexity of your chains. − |- − |style="padding:10px"|<span style="color:#FF0000">{{#fas:bolt}}</span> − |style="padding:10px"|'''Under-voltage''' − |style="padding:10px"|Zynthian is working in a degraded state, with the CPU frequency capped to 600-800 MHz, trying to stabilize the system and avoid a system crash. You shouldn't see that icon and if you do so, you should consider looking for a better power source. − |- − |style="padding:10px"|<span style="color:#FF0000">{{#fas:temperature-high}}</span> − |style="padding:10px"|'''Over-temperature''' − |style="padding:10px"|Zynthian is working in a degraded state, with the CPU frequency capped to 600-800 MHz, trying to stabilize the system and avoid a system crash. You shouldn't see that icon and if you do so, you should improve heat dissipation (using a heat sink, etc.) − |- − !colspan="3"|2nd row: MIDI activity & Playing/Recording − |- − |style="padding:10px"|<span style="color:#8080FF">'''m'''</span> − |style="padding:10px"|'''MIDI-IN''' − |style="padding:10px"|It's shown when MIDI messages are received. Underscore indicates system message such as MIDI clock. − |- − |style="padding:10px"|<span style="color:#B00000">{{#fas:circle}}</span> − |style="padding:10px"|'''Recording Audio''' − |style="padding:10px"|Audio is being recorded. − |- − |style="padding:10px"|<span style="color:#00B000">{{#fas:play}}</span> − |style="padding:10px"|'''Playing Audio''' − |style="padding:10px"|Audio track is being played. − |- − |style="padding:10px"|<span style="color:#F000F0">{{#fas:circle}}</span> − |style="padding:10px"|'''Recording MIDI''' − |style="padding:10px"|MIDI is being recorded. − |- − |style="padding:10px"|<span style="color:#F000F0">{{#fas:play}}</span> − |style="padding:10px"|'''Playing MIDI''' − |style="padding:10px"|MIDI track is being played. − |- − |style="padding:10px"|<span style="color:#F07000">{{#fas:circle}}</span> − |style="padding:10px"|'''Recording Pattern''' − |style="padding:10px"|A sequencer's pattern is being recorded. − |- − |style="padding:10px"|<span style="color:#F07000">{{#fas:play}}</span> − |style="padding:10px"|'''Playing Sequence''' − |style="padding:10px"|A sequence or pattern is being played. − |} − Line 760:
Line 135: − − ==The Sequencer== − − Zynthian includes an advanced MIDI sequencer capable of pattern based and linear sequences. There is a [[ZynSeq_User_Guide|full user guide]] that describes the use of the sequencer in detail. This section gives a high-level overview of accessing and using the sequencer. − − ===Pattern Editor=== − The '''pattern editor''' allows editing patterns in a variety of ways: − − * using the grid to add/remove notes or modifying note parameters. − * capturing MIDI notes step-by-step. − * capturing MIDI notes while playing (live recording). − − For live recording you may want to enable the metronome and start playing the pattern before starting the capture. − − <div class="show_only_v5"> − [[File:v5_mockup_pated_01.png|800px|right]] − − * '''Knob#4''' − ** '''''rotate''''' to move cursor horizontally. − ** '''''short-press''''' to add/remove a note at cursor position. − ** '''''bold-press''''' to '''edit note parameters''': − * '''Knob#3''' − ** '''''rotate''''' to move cursor vertically. − * '''Knob#2''' − ** '''''rotate''''' to change the zoom level. − ** '''''short-press''''' to restore default zoom level. − * '''Knob#1''' − ** '''''rotate''''' to adjust tempo BPM. − − * '''REC''' to start capturing MIDI notes. − * '''STOP''' to stop playing a pattern. − * '''PLAY''' to start/stop playing a pattern. − − <br> − '''edit note parameters''' − − * '''Knob#4''' − ** '''''rotate''''' to select the parameter to edit − *** duration − *** velocity − *** offset − *** stutter count − *** stutter duration − *** play chance − ** '''''short-press knob#4''''' to end editing − ** '''''bold-press knob#4''''' again to enter '''EDIT ALL''' mode − * '''Knob#3''' − ** '''''rotate''''' to change coarse value. − * '''Knob#2''' − ** '''''rotate''''' to change fine value (when available). − − <br> − − {{NoteBox| Bold-press in an empty position to edit the default note parameters. These are the values used when adding new notes.}} − − <br> − '''ALT mode''' − − The pattern editor has a custom ALT mode that can be toggled with '''ALT''' button. When in ALT mode, the arrow buttons will change their color to orange, allowing to quickly access undo/redo functions: − − * '''LEFT''' undo the last record operation − * '''RIGHT''' redo the last record operation − * '''UP''' undo ALL record operations − * '''DOWN''' redo ALL record operations − − When adding notes step by step, each note added/removed is a record operation. When live recording, recorded notes are grouped in pattern-loops. − − <br clear=all> − </div>
Zynthian UI User's Guide Appendix - Vangelis (view source)
Revision as of 17:49, 21 September 2026
, 21 Septemberno edit summary
{{VersionBar}}
{{VersionBar}}
=== Quick Start ===
=== Quick Start ===
* Play the sound from the MIDI controller connected.
* Play the sound from the MIDI controller connected.
For audio processing, follow a similar procedure but select "Audio Input" instead of "Instrument".
For audio processing, follow a similar procedure but select "Audio Input" instead of "Instrument".
<div class="show_only_touch">
<div class="show_only_touch">
<br clear=all>
<br clear=all>
====UI Actions====
====UI Actions====
Default behaviour for touch or click of topbar are shown here. Deviations are shown in subsequent sections.
Default behaviour for touch or click of topbar are shown here. Deviations are shown in subsequent sections.
===Audio routing===
===Audio routing===
===MIDI routing===
===MIDI routing===
==Custom Control Views==
==Custom Control Views==