User Tools

Site Tools


sunvox:manual_en

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
sunvox:manual_en [2019/12/31 10:52]
nightradio [Modes]
sunvox:manual_en [2020/01/21 09:39] (current)
nightradio [Keyboard shortcuts]
Line 26: Line 26:
   * **Sample rate** - number of samples per second.   * **Sample rate** - number of samples per second.
   * **Sustain** - suspension point (until the Note OFF) on the envelope.   * **Sustain** - suspension point (until the Note OFF) on the envelope.
-  * **Tick** - smallest time interval in SunVox pattern.+  * **Tick** - smallest time interval in SunVox pattern. 1 beat = 24 ticks.
   * **TPL** - number of Ticks Per Line.   * **TPL** - number of Ticks Per Line.
   * **Velocity** - universal parameter combining such types of expression as the velocity (how fast or hard the keys are pressed) and the aftertouch (amount of force on held-down key). It can be changed at any time in the life cycle of a single note.   * **Velocity** - universal parameter combining such types of expression as the velocity (how fast or hard the keys are pressed) and the aftertouch (amount of force on held-down key). It can be changed at any time in the life cycle of a single note.
Line 32: Line 32:
 ====== Minimum system requirements ====== ====== Minimum system requirements ======
  
-**Windows:​** +**Windows:​** ​2000 (x86/x86_64).
-  * x86 or x86_64 ​architecture;​ +
-  * Windows 2000.+
  
-**Linux:*+**Linux:** any fresh distribution ​libsdl2 ​(you can install this library using apt-get or some other package manager).
-  ​* any Linux distribution+
-  * libsdl2.+
  
-**macOS:** +**macOS:** 10.9 (x86_64).
-  * x86_64 architecture;​ +
-  * Mac OS X 10.6.+
  
-**Android:​** +**Android:​** ​4.1.
-  * Android 2.3.+
  
-**iOS:** +**iOS:** 9.
-  * iOS 9.+
  
-**Windows CE:** +**Windows CE:** 3.0 (ARM).
-  * ARM architecture.+
  
 ====== Installing ====== ====== Installing ======
Line 58: Line 49:
   - Download [[https://​warmplace.ru/​soft/​sunvox|SunVox for Windows]] (ZIP archive).   - Download [[https://​warmplace.ru/​soft/​sunvox|SunVox for Windows]] (ZIP archive).
   - Unpack this archive to the user folder (with read and write permissions;​ for example, your own folder on the external flash drive).   - Unpack this archive to the user folder (with read and write permissions;​ for example, your own folder on the external flash drive).
-  - You will see the new directory **sunvox** after unpacking - open it, and go to the **sunvox/​windows_x86** or **sunvox/​windows_x86_64** directory. +  - You will see the new directory **sunvox** after unpacking - open it, and go to the **sunvox/​windows_x86** ​(for 32-bit system) ​or **sunvox/​windows_x86_64** ​(for 64-bit system) ​directory. 
-  - You will find several files in the last folder: sunvox.exe (full 32bit version) and sunvox_lofi_console.exe (version with 16bit audio engine for slow devices)just lauch one of these versions.+  - You will find several ​executable ​files in the last folder: 
 +    * sunvox ​version ​with 32-bit audio engine; 
 +    * sunvox_lofi_console ​version with 16-bit ​audio engine for slow devices; 
 +    * sunvox_for_old_cpu - version for CPUs without SSSE3.
  
 **Linux:** **Linux:**
   - Download [[https://​warmplace.ru/​soft/​sunvox|SunVox for Linux]] (ZIP archive).   - Download [[https://​warmplace.ru/​soft/​sunvox|SunVox for Linux]] (ZIP archive).
   - Unpack this archive to the home user directory (/​home/​username).   - Unpack this archive to the home user directory (/​home/​username).
-  - You will see the new directory **sunvox** after unpacking - open it, and go to the **sunvox/​linux_**xxx  ​directory,​ where the xxx is the name of the architecture of your device. +  - You will see the new directory **sunvox** after unpacking - open it, and go to the **sunvox/​linux_**xx  ​directory,​ where the xx is the name of the architecture of your device. 
-  - You will find several files in the **linux_**xxx ​folder: sunvoxsunvox_lofi, sunvox_no_simd,​ etc.just use the most appropriate ​for your system.+  - You will find several ​executable ​files in the last folder: 
 +    * sunvox ​- version with 32-bit audio engine; 
 +    * sunvox_lofi ​- version with 16-bit audio engine for slow devices; 
 +    * sunvox_for_old_cpu - version ​for CPUs without SSSE3.
   - In case of some errors: open Terminal, go to the sunvox directory (use **cd** command), enter **chmod a+x sunvox** and then **./​sunvox** ; if still not working - copy all error messages from the Terminal and send it to nightradio@gmail.com.   - In case of some errors: open Terminal, go to the sunvox directory (use **cd** command), enter **chmod a+x sunvox** and then **./​sunvox** ; if still not working - copy all error messages from the Terminal and send it to nightradio@gmail.com.
 [[https://​warmplace.ru/​forum/​viewtopic.php?​f=16&​t=4454|Here is the instruction for Raspberry Pi users]] [[https://​warmplace.ru/​forum/​viewtopic.php?​f=16&​t=4454|Here is the instruction for Raspberry Pi users]]
Line 73: Line 70:
   - You will see the new directory **sunvox** after unpacking; move it to some another user-created directory; don't use the Applications folder.   - You will see the new directory **sunvox** after unpacking; move it to some another user-created directory; don't use the Applications folder.
   - Go to the **sunvox/​sunvox/​macos** directory.   - Go to the **sunvox/​sunvox/​macos** directory.
 +  - [[https://​warmplace.ru/​forum/​viewtopic.php?​f=3&​t=4399|Read this important information for the macOS 10.12+ users]]
   - Launch SunVox.   - Launch SunVox.
-[[https://​warmplace.ru/​forum/​viewtopic.php?​f=3&​t=4399|Important information for the macOS 10.12+ users]]. 
  
 **Android:​** **Android:​**
Line 91: Line 88:
 ====== Comparison of different versions ====== ====== Comparison of different versions ======
  
-^ System ^ Supported architectures ^ Sound engine format ^ Multi-touch ​^ MIDI ^ GPIO ^ +^ System ^ Supported architectures ^ Sound engine format ^ Multi-touch ^ GPIO ^ 
-^ Linux | x86, x86_64, ARM (Maemo-based devices, Raspberry Pi, PocketCHIP, etc.), ARM64 (PINE64 etc.) | 32-bit floating-point / 4,12 fixed-point | YES | Full support ​| YES | +^ Linux | x86, x86_64, ARM (Maemo-based devices, Raspberry Pi, PocketCHIP, etc.), ARM64 (PINE64 etc.) | 32-bit floating-point / 4,12 fixed-point | YES | YES | 
-^ Windows | x86, x86_64 | 32-bit floating-point / 4,12 fixed-point | YES | Full support ​| | +^ Windows | x86, x86_64 | 32-bit floating-point / 4,12 fixed-point | YES | | 
-^ Windows CE | ARM | 4,12 fixed-point | | Export and Import only | | +^ Windows CE | ARM | 4,12 fixed-point | | | 
-^ macOS | x86_64 | 32-bit floating-point | | Full support ​| | +^ macOS | x86_64 | 32-bit floating-point | | | 
-^ Android | ARM, x86 | 32-bit floating-point / 4,12 fixed-point (on devices without FPU) | YES | Export and Import ​ only | YES | +^ Android | ARM, x86 | 32-bit floating-point / 4,12 fixed-point (on devices without FPU) | YES | YES | 
-^ iOS | ARM | 32-bit floating-point (iOS 7 and higher) / 4,12 fixed-point | YES | Full support ​| |+^ iOS | ARM | 32-bit floating-point (iOS 7 and higher) / 4,12 fixed-point | YES | |
  
 As you can see, there are two sound engine formats in SunVox. Let's look at them in detail. As you can see, there are two sound engine formats in SunVox. Let's look at them in detail.
Line 179: Line 176:
 ^ SHIFT + '​['​ | transpose octave down (-12 semitones) | ^ SHIFT + '​['​ | transpose octave down (-12 semitones) |
 ^ CTRL + P | place selected events evenly | ^ CTRL + P | place selected events evenly |
 +^ SHIFT + 7 | cyclic shift up |
 +^ SHIFT + 8 | cyclic shift down |
 ^ //not assigned// | remap | ^ //not assigned// | remap |
  
Line 310: Line 309:
     * 13 - set Bypass/​Solo/​Mute (BSM = XYY) flags; example of mute: 13 0001; example of solo: 13 0010;     * 13 - set Bypass/​Solo/​Mute (BSM = XYY) flags; example of mute: 13 0001; example of solo: 13 0010;
     * 14 - reset Bypass/​Solo/​Mute (BSM = XYY) flags; example of bypass reset: 14 0100;     * 14 - reset Bypass/​Solo/​Mute (BSM = XYY) flags; example of bypass reset: 14 0100;
 +    * 15 - change the relative note and finetune of the module; XX - relative note (00 - ignore; 01 = -127<​sub>​dec</​sub>;​ 80 = 0; FF = 127<​sub>​dec</​sub>​);​ YY - finetune (00 - ignore; 01 = one semitone lower; 80 = 0; FF = one semitone higher);
     * 19 - retrigger note after XXYY ticks during the line;     * 19 - retrigger note after XXYY ticks during the line;
     * 1C - cut note after XXYY ticks in the current line;     * 1C - cut note after XXYY ticks in the current line;
Line 325: Line 325:
     * 29 - take a random note from the range of lines XX..YY (inclusive) on track 0;     * 29 - take a random note from the range of lines XX..YY (inclusive) on track 0;
     * 30 - stop playing the song;     * 30 - stop playing the song;
 +    * 31 - jump to line XXYY (address) right after the end of the current line;
 +    * 32 - set jump address mode YY: 0 - absolute address, relative to the start of the timeline (default); 1 - ( pattern beginning + address ); 2 - ( pattern beginning - address ); 3 - ( next line + address ); 4 - ( next line - address );
 +    * destructive effects (irreversibly change the contents of the pattern):
 +      * 38 - delete an event on track XX with a probability of YY (00..FF(100%));​ see simple_examples/​pat effect 38 self destructive.sunvox
 +      * 39 - cyclic shift of track XX down by YY lines;
 +      * 3A - generate a new iteration of YY-line polyrhythm on track XX; see simple_examples/​pat effect 3A polyrhythm.sunvox;​
 +      * 3B - copy track XX to a pattern named YY;
     * 40...5F - delay an event for selected fraction of the line (from 40 (0%) to 5F (96.875%));     * 40...5F - delay an event for selected fraction of the line (from 40 (0%) to 5F (96.875%));
   * XXYY - parameter of a selected effect/​controller (0000 - min; 8000 - max).   * XXYY - parameter of a selected effect/​controller (0000 - min; 8000 - max).
Line 407: Line 414:
  
 **14 - Reset Bypass/​Solo/​Mute flags.** BSM = XYY. Example of bypass reset: 14 0100. **14 - Reset Bypass/​Solo/​Mute flags.** BSM = XYY. Example of bypass reset: 14 0100.
 +
 +**15 - Сhange the relative note XX and finetune YY of the module.** \\
 +
 +Relative note XX:
 +  * 00: ignore;
 +  * 01: -127<​sub>​dec</​sub>;​
 +  * 02: -126<​sub>​dec</​sub>;​
 +  * ...
 +  * 80: 0 (no note offset);
 +  * 81: +1;
 +  * 82: +2;
 +  * ...
 +  * FF: +127<​sub>​dec</​sub>​.
 +
 +Finetune YY:
 +  * 00: ignore;
 +  * 01: one semitone lower;
 +  * ...
 +  * 80: 0 (no finetune offset);
 +  * ...
 +  * FF: one semitone higher.
  
 **19 - Retrigger.** Effect 19 allows you to retrigger a note after XXYY ticks during the line. For example, let's specify note C3 and set XXYY = 2 when the speed (TPL) is currently 6. This starts the specified note at the beginning of the line, and after two ticks it is restarted. This continues until the beginning of the next line. **19 - Retrigger.** Effect 19 allows you to retrigger a note after XXYY ticks during the line. For example, let's specify note C3 and set XXYY = 2 when the speed (TPL) is currently 6. This starts the specified note at the beginning of the line, and after two ticks it is restarted. This continues until the beginning of the next line.
Line 440: Line 468:
  
 **30 - Stop playing the song.** **30 - Stop playing the song.**
 +
 +**31 - Jump to line XXYY (address) right after the end of the current line.**
 +
 +**32 - Set jump address mode YY:**
 +  * 0: jump to absolute address, relative to the start of the timeline (default);
 +  * 1: jump to ( pattern beginning + address );
 +  * 2: jump to ( pattern beginning - address );
 +  * 3: jump to ( next line + address );
 +  * 4: jump to ( next line - address ).
 +
 +**38 - Delete an event on track XX with a probability of YY (00..FF(100%)).**
 +See simple_examples/​pat effect 38 self destructive.sunvox.
 +
 +**39 - Cyclic shift of track XX down by YY lines.**
 +
 +**3A - Generate a new iteration of YY-line polyrhythm on track XX.**
 +See simple_examples/​pat effect 3A polyrhythm.sunvox.
 +
 +**3B - Copy track XX to a pattern named YY.**
  
 **40...5F - delay an event for selected fraction of the line** (from 0% (40) to 96.875% (5F)). **40...5F - delay an event for selected fraction of the line** (from 0% (40) to 96.875% (5F)).
Line 844: Line 891:
 ==== Delay ==== ==== Delay ====
  
-Maximal length of the delay is 1/64 second.+This module delays ​the sound and the incoming events (note, pitch, phase, velocity). 
 +Max delay length = 4 seconds.
  
 Controllers:​ Controllers:​
   * Dry - amount of original signal;   * Dry - amount of original signal;
   * Wet - amount of processed signal;   * Wet - amount of processed signal;
-  * Delay L - delay length on the left channel; maximum ​delay - 1/64 second+  * Delay L - left channel delay length, or event delay length
-  * Delay R - delay length on the right channel; maximum ​delay - 1/64 second;+  * Delay R - right channel delay length;
   * Volume L - left channel volume;   * Volume L - left channel volume;
   * Volume R - right channel volume;   * Volume R - right channel volume;
-  * Mono: 0 - stereo ​delay; 1 - mono delay+  * Mono: 0 - stereo; 1 - mono (use left channel only)
-  * Inverse amplitude: 0 - OFF1 - ON.+  * Inverse amplitude ​(off/on); 
 +  * Delay unit for "Delay L" and "Delay R".
  
 ==== Distortion ==== ==== Distortion ====
Line 862: Line 911:
 Controllers:​ Controllers:​
   * Volume;   * Volume;
-  * Distortion type: <​html><​br><​img src="​https://​warmplace.ru/​docs/​sunvox/​disttypes.gif"></​html>​+  * Distortion type: <​html><​br><​img src="​https://​warmplace.ru/​docs/​sunvox/​disttypes.gif?v=2"></​html>​
   * Power - amount of distortion of the type selected above;   * Power - amount of distortion of the type selected above;
   * Bit depth - change it to reduce the resolution of the incoming sound; default value 16 means that the bit depth remains unchanged;   * Bit depth - change it to reduce the resolution of the incoming sound; default value 16 means that the bit depth remains unchanged;
Line 999: Line 1048:
 ==== Loop ==== ==== Loop ====
  
-This effect is for repeating small pieces ​of input sound.+This module repeats a fragment ​of the incoming ​sound a specified number of times. 
 +To reset the loop: either change the "​Repeats"​ controller, or send some note to this module.
  
 Controllers:​ Controllers:​
   * Volume;   * Volume;
-  * Delay;+  * Delay - repeat length;
   * Stereo: 0 - mono; 1 - stereo;   * Stereo: 0 - mono; 1 - stereo;
-  * Repeats - number of repeats in the loop;+  * Repeats - how many times to repeat a fragment before proceeding to capture ​the next;
   * Mode: 0 - normal; 1 - ping-pong loop playback.   * Mode: 0 - normal; 1 - ping-pong loop playback.
  
Line 1163: Line 1213:
   * Ignore notes with zero velocity;   * Ignore notes with zero velocity;
   * Trigger: Note OFF commands will be ignored; the new note turns off the old note with the same pitch;   * Trigger: Note OFF commands will be ignored; the new note turns off the old note with the same pitch;
 +  * Generate missed Note OFF cmds: if two notes follow each other on the same track - there are no Note OFF commands between them (one note simply replaces another); sometimes we need to insert these missing сommands, to avoid notes hanging; [[https://​warmplace.ru/​forum/​viewtopic.php?​f=16&​t=5143|read more]];
   * Curve1 - show curve1: //output velocity = curve1(input note)//;   * Curve1 - show curve1: //output velocity = curve1(input note)//;
   * Curve2 - show curve2: //output velocity = curve2(input velocity)//​.   * Curve2 - show curve2: //output velocity = curve2(input velocity)//​.
sunvox/manual_en.1577778756.txt.gz · Last modified: 2019/12/31 10:52 by nightradio