Difference between revisions of "Oram TESTING Zynthian UI Users Guide"

From ZynthianWiki
Jump to navigation Jump to search
m
Line 15: Line 15:
 
https://os.zynthian.org/test/2024-03-01-zynthianos-bookworm-aarch64-oram-2403.zip
 
https://os.zynthian.org/test/2024-03-01-zynthianos-bookworm-aarch64-oram-2403.zip
  
==Changes of Note==
+
==The Zynthian UI Workflow==
 +
==Chains==
  
====Updates to Native UI====
+
==Navigation==
====Navigation====
 
 
[[File:Zynthian oram add chain.png|500px|frameless|right]]
 
[[File:Zynthian oram add chain.png|500px|frameless|right]]
 
'''''The processors are now in categories.''''' There are a few ways to navigate to make your selection:
 
'''''The processors are now in categories.''''' There are a few ways to navigate to make your selection:
Line 29: Line 29:
 
<br clear=all>
 
<br clear=all>
  
====Mixer Screen====
+
==Midi Input==
 +
There are some changes to the midi options. Currently the ACTI (Active) mode is used to accept midi input to the currently selected chain. The MULTI (Multitimbral) mode is used to select the individual chains you wish to accept midi from the given device. This can be one chain or multiple. E.g. mimi-d synth can be assigned to accept midi from both a keyboard and sequencer at once. More to come....
 +
 
 +
<blockquote>
 +
===Cloning (Layering) Explained===
 +
I would like to explain a little bit how “clone” (aka layering sounds to play unison) works in the new testing version “oram-bookworm”.
 +
 
 +
First, you may note that the “clone” option does not exist anymore. We have better mechanisms in oram because several chains can use the same MIDI channel.
 +
 
 +
1.If you are using ACTI mode for your input device
 +
 
 +
A. THE EASY WAY
 +
 
 +
    * Enable “Active MIDI chanel” in the admin menu. With this enabled, all chains in the same MIDI channel will receive the MIDI stream from the input when some of them is selected (active).
 +
    * Setup your “cloned” chains in the same MIDI channel.
 +
 
 +
B. THE COOL WAY
 +
 
 +
    * Disable “Active MIDI chanel” in the admin menu. With this disabled, only the selected (active) chain will receive MIDI from the input, not matter the MIDI channel.
 +
    *    Setup your “cloned” chains in the same MIDI channel.
 +
    *    Create a MIDI+Audio chain in the same MIDI channel. We call this chain the “GROUP” chain. You don’t need to add any processor, so you can select None from the list.
 +
    *    From the GROUP chain options, access “MIDI out” and select your “cloned” chains. This will route MIDI from the GROIUP chain to the cloned chains.
 +
    *    Finally, access “Audio Out” submenu on each cloned chain: uncheck the Main Bus and check the “GROUP chain”. With this you are routing audio from your cloned chains to the GROUP chain, so you can control de mixed audio with the GROUP’s fader.
 +
    *    Nice, true? I really love this way, but there is a little problem with it. Latency. When you route-back audio from chain’s output to the GROUP chain, you add latency. This is a general rule in digital audio processing: If you feed-back the signal, you add 1-period delay. The MIDI stream is not delayed because there is no real feed-back and it’s processed linearly.
 +
 
 +
2.If you are using MULTI mode for your input device
 +
 
 +
    * Simply setup your “cloned” chains in the same MIDI channel. That’s all.
 +
 
 +
 
 +
The cool way (B) means that you can select each chain individually and audition its sound or select the group chain to play them all simultaneously / layered. You will have full control of each chain (fader, pan, mono, etc.), be able to insert effects and see each peak meter and also have overall control of the group with the same control and monitoring (fader, pan, mono, etc. DPM, effects).
 +
 
 +
You don’t have to do both audio and MIDI grouping, each works individually and not doing the audio will reduce latency by one period net doing both audio and MIDI is super cool giving an flexible and intuitive interface.
 +
 
 +
 
 +
</blockquote>
 +
 
 +
==The UI Screens==
 +
==Mixer Screen==
 
[[File:Zynthian oram ui mixer icons.png|right|200px|New icons for chains]]
 
[[File:Zynthian oram ui mixer icons.png|right|200px|New icons for chains]]
 
Some subtle changes to the mixer screen include icons at the bottom of the chain's volume to show the midi channel used and new icons: notes for a midi device and a microphone for audio based chains
 
Some subtle changes to the mixer screen include icons at the bottom of the chain's volume to show the midi channel used and new icons: notes for a midi device and a microphone for audio based chains
 
<br clear=all>
 
<br clear=all>
  
====Midi Options====
+
==Main Menu==
There are some changes to the midi options. Currently the ACTI (Active) mode is used to accept midi input to the currently selected chain. The MULTI (Multitimbral) mode is used to select the individual chains you wish to accept midi from the given device. This can be one chain or multiple. E.g. mimi-d synth can be assigned to accept midi from both a keyboard and sequencer at once. More to come....
+
===Improvements to VNC===
 
 
====Improvements to VNC====
 
 
Good news for those with headless/barebones setups, there are noticeable improvements to the speed and quality of the VNC connection to Zynthian.
 
Good news for those with headless/barebones setups, there are noticeable improvements to the speed and quality of the VNC connection to Zynthian.
  
 
Riban: The fixes were in later versions of VNC libraries that we benefit from by moving to Debian 12 Bookworm. The previous versions were horrible with screen tearing, etc.
 
Riban: The fixes were in later versions of VNC libraries that we benefit from by moving to Debian 12 Bookworm. The previous versions were horrible with screen tearing, etc.
  
====Wifi Setup & Accessing Webconf====
+
===Wifi Setup & Accessing Webconf===
  
 
As of writing, it is not possible to set wifi directly in Webconf. It must be set from within the ADMIN > Wi-Fi Config menu.
 
As of writing, it is not possible to set wifi directly in Webconf. It must be set from within the ADMIN > Wi-Fi Config menu.

Revision as of 09:37, 22 April 2024

1 Introduction

This is a guide to the x64 Oram testing image version of Zynthian. Based on 64-bit Debian 12 (Bookworm), it will eventually become the new stable version. There are numerous changes to the UI and lots of refactoring under the hood according to the devs. This guide will aim to summarise the important changes or things to note about the testing version from forum discussions. As ever, this guide will be wrong in places or fall out of date so check the [discourse.zynthian.org | forum] if the guidance here isn't working for you. Feel free to contribute if you've found something relevant to add here, if you don't have an account, ask in the forum.

2 Getting started

2.1 Compatibility

So far, Raspberry Pi3, Pi4 and Pi5 are compatible. Pi5 have some issues to solve, but it's mostly working OK.

2.2 Installing Oram

The link for the image follows. If you need a guide you can follow along at No Hardware Build Guide and come back to this page to fill in the gaps where there are changes. https://os.zynthian.org/test/2024-03-01-zynthianos-bookworm-aarch64-oram-2403.zip

3 The Zynthian UI Workflow

4 Chains

5 Navigation

Zynthian oram add chain.png

The processors are now in categories. There are a few ways to navigate to make your selection:

  • Use the second encoder to switch between categories
  • Swipe left or right to shift categories for touchscreen users
  • On a USB keyboard you can use the arrow keys
  • Or you could try a midi device and assign the UI navigation to buttons you have available See the CUIA page of the user guide for more on this.

Note also a circular green arrow in the top right corner of the screen to indicate that an update is available to download.

6 Midi Input

There are some changes to the midi options. Currently the ACTI (Active) mode is used to accept midi input to the currently selected chain. The MULTI (Multitimbral) mode is used to select the individual chains you wish to accept midi from the given device. This can be one chain or multiple. E.g. mimi-d synth can be assigned to accept midi from both a keyboard and sequencer at once. More to come....

6.1 Cloning (Layering) Explained

I would like to explain a little bit how “clone” (aka layering sounds to play unison) works in the new testing version “oram-bookworm”.

First, you may note that the “clone” option does not exist anymore. We have better mechanisms in oram because several chains can use the same MIDI channel.

1.If you are using ACTI mode for your input device

A. THE EASY WAY

* Enable “Active MIDI chanel” in the admin menu. With this enabled, all chains in the same MIDI channel will receive the MIDI stream from the input when some of them is selected (active). * Setup your “cloned” chains in the same MIDI channel.

B. THE COOL WAY

* Disable “Active MIDI chanel” in the admin menu. With this disabled, only the selected (active) chain will receive MIDI from the input, not matter the MIDI channel. * Setup your “cloned” chains in the same MIDI channel. * Create a MIDI+Audio chain in the same MIDI channel. We call this chain the “GROUP” chain. You don’t need to add any processor, so you can select None from the list. * From the GROUP chain options, access “MIDI out” and select your “cloned” chains. This will route MIDI from the GROIUP chain to the cloned chains. * Finally, access “Audio Out” submenu on each cloned chain: uncheck the Main Bus and check the “GROUP chain”. With this you are routing audio from your cloned chains to the GROUP chain, so you can control de mixed audio with the GROUP’s fader. * Nice, true? I really love this way, but there is a little problem with it. Latency. When you route-back audio from chain’s output to the GROUP chain, you add latency. This is a general rule in digital audio processing: If you feed-back the signal, you add 1-period delay. The MIDI stream is not delayed because there is no real feed-back and it’s processed linearly.

2.If you are using MULTI mode for your input device

* Simply setup your “cloned” chains in the same MIDI channel. That’s all.


The cool way (B) means that you can select each chain individually and audition its sound or select the group chain to play them all simultaneously / layered. You will have full control of each chain (fader, pan, mono, etc.), be able to insert effects and see each peak meter and also have overall control of the group with the same control and monitoring (fader, pan, mono, etc. DPM, effects).

You don’t have to do both audio and MIDI grouping, each works individually and not doing the audio will reduce latency by one period net doing both audio and MIDI is super cool giving an flexible and intuitive interface.


7 The UI Screens

8 Mixer Screen

New icons for chains

Some subtle changes to the mixer screen include icons at the bottom of the chain's volume to show the midi channel used and new icons: notes for a midi device and a microphone for audio based chains

9 Main Menu

9.1 Improvements to VNC

Good news for those with headless/barebones setups, there are noticeable improvements to the speed and quality of the VNC connection to Zynthian.

Riban: The fixes were in later versions of VNC libraries that we benefit from by moving to Debian 12 Bookworm. The previous versions were horrible with screen tearing, etc.

9.2 Wifi Setup & Accessing Webconf

As of writing, it is not possible to set wifi directly in Webconf. It must be set from within the ADMIN > Wi-Fi Config menu.

The password for access (Webconf, VNC UI & Engines) is now: opensynth

10 Webconf Changes

10.1 Library

10.1.1 Snapshots

Zynthian oram webconf snapshots.png

Snapshots page now shows the names of individual chains (and effects) saved within the snapshot along with a list of configurations used. Clicking on the 'i' for each chain in the snapshot will show information about the settings of the patch.

10.2 Hardware

10.3 Software

10.3.1 Engines page improved information

Zynthian oram webconf engines.png
  • The engines page now shows descriptions and ratings for quality/complexity for Synth + Effects + Midi Tools + Audio Generator + Special Category. Start editing your own ratings by clicking on the line to expand and use the drop-down menus to set as desired.
  • Adding and removing engines requires only checking the box, no need to save. Engines added in addition to the default set will show as 'toggled'

10.4 Interface

10.5 System