diff --git a/.gitignore b/.gitignore index b44b649..9bb4492 100644 --- a/.gitignore +++ b/.gitignore @@ -33,3 +33,4 @@ # *.swp +.vscode diff --git a/doc/manuals/Build-Manual.pdf b/doc/manuals/Build-Manual.pdf new file mode 100644 index 0000000..41b00ab Binary files /dev/null and b/doc/manuals/Build-Manual.pdf differ diff --git a/doc/manuals/MicroDexed-Build_Manual/MicroDexed-Build_Manual.md b/doc/manuals/MicroDexed-Build_Manual/MicroDexed-Build_Manual.md deleted file mode 100644 index 7cacc57..0000000 --- a/doc/manuals/MicroDexed-Build_Manual/MicroDexed-Build_Manual.md +++ /dev/null @@ -1,57 +0,0 @@ -![](../../images/MicroDexed.png) - -# MicroDexed Build Manual - -## Requirements - -Making a TeensyMIDIAudio board is not very difficult, but you should consider the following: - -* You should've soldered something before. Preferably a small kit. Without some practice you will get problems with bad soldering points and such errors are always very difficult to find if you have not worked properly. Instructions on how to solder and which tools are necessary for it, you will surely find on the Internet. -* You need time! Someone with a lot of experience and practice can finish the whole kit in 2 hours. But if you don't take enough time, there is a high risk to fill something wrong or to create bad soldering spots. -* You need good tools. Good doesn't always mean expensive. But don't try to work with unsuitable tools - this leads to problems. - -## Tools - -* Soldering iron: It is best to use a temperature-controlled soldering iron or a station with a power of about 40 watts or less. Never use soldering tips that are too large or a soldering iron with a large capacity. -* (Small) Side cutter -* "Helping hand" or fastening material (which is heat resistant) - -## Build - -The printed circuit board has numerous optional components that only need to be mounted in certain cases. In this manual only those steps are shown which are absolutely necessary. - -**Note: The photos show a mounted SMD component (type PT8211). This is not necessary and is not pre-assembled.** - -### Kit Completeness check - -For the assembly of printed circuit boards you should always start with the flattest components and mount the higher components step by step. - -
-##### Diode and Resistors - -You need: - -* Diode D1 (1N4148) -* Resistors - * R1 (470 Ohm / 470) - * R2 (10 Ohm / 10) - * R3 (220 Ohm / 220) - * R4 (220 Ohm / 220) - * R5 (220 Ohm / 220) - * R6 (4.7 kOhm / 4K7) - * R7 (4.7 kOhm / 4K7) - * R9 (220 Ohm / 220) - * R10 (220 Ohm / 220) - -![](images/10.jpg) - -
-##### Capacitors (Part 1) - -You need: - -* Capacitor C1 (100 nF) -* Capacitor C2 (100 nF) - -![](images/20.jpg) - diff --git a/doc/manuals/MicroDexed-Build_Manual/MicroDexed-Build_Manual.pdf b/doc/manuals/MicroDexed-Build_Manual/MicroDexed-Build_Manual.pdf deleted file mode 100644 index 9538c0b..0000000 Binary files a/doc/manuals/MicroDexed-Build_Manual/MicroDexed-Build_Manual.pdf and /dev/null differ diff --git a/doc/manuals/MicroDexed-Build_Manual/build.sh b/doc/manuals/MicroDexed-Build_Manual/build.sh deleted file mode 100755 index 2568654..0000000 --- a/doc/manuals/MicroDexed-Build_Manual/build.sh +++ /dev/null @@ -1,16 +0,0 @@ -#!/bin/bash -# -# sudo apt install wkhtmltopdf pandoc - -LCDIMG="../../bin/gen_lcd_screen.sh ../../images" - -${LCDIMG} " MicroDexed" " Build Manual" images/00_MD_Build_Manual.jpg - -pandoc MicroDexed-Build_Manual.md \ - -V 'geometry:a4paper' \ - -V 'geometry:margin=2cm' \ - -V 'fontfamily:dejavu' \ - -V 'fontsize:16pt' \ - -V 'lang=de-DE' \ ---number-sections \ --t html5 -o MicroDexed-Build_Manual.pdf diff --git a/doc/manuals/MicroDexed-Build_Manual/images/00_MD_Build_Manual.jpg b/doc/manuals/MicroDexed-Build_Manual/images/00_MD_Build_Manual.jpg deleted file mode 100644 index a7b95ad..0000000 Binary files a/doc/manuals/MicroDexed-Build_Manual/images/00_MD_Build_Manual.jpg and /dev/null differ diff --git a/doc/manuals/MicroDexed-Build_Manual/images/10.jpg b/doc/manuals/MicroDexed-Build_Manual/images/10.jpg deleted file mode 100644 index 8855b86..0000000 Binary files a/doc/manuals/MicroDexed-Build_Manual/images/10.jpg and /dev/null differ diff --git a/doc/manuals/MicroDexed-Build_Manual/images/10.png b/doc/manuals/MicroDexed-Build_Manual/images/10.png deleted file mode 100644 index 8b563fe..0000000 Binary files a/doc/manuals/MicroDexed-Build_Manual/images/10.png and /dev/null differ diff --git a/doc/manuals/MicroDexed-Build_Manual/images/20.jpg b/doc/manuals/MicroDexed-Build_Manual/images/20.jpg deleted file mode 100644 index 6e3abdc..0000000 Binary files a/doc/manuals/MicroDexed-Build_Manual/images/20.jpg and /dev/null differ diff --git a/doc/manuals/MicroDexed-User_Manual/MicroDexed-User_Manual.md b/doc/manuals/MicroDexed-User_Manual/MicroDexed-User_Manual.md index c345ce1..073a78c 100644 --- a/doc/manuals/MicroDexed-User_Manual/MicroDexed-User_Manual.md +++ b/doc/manuals/MicroDexed-User_Manual/MicroDexed-User_Manual.md @@ -1,4 +1,81 @@ -![](../../images/MicroDexed.png) +--- +fontfamily: dejavu +fontsize: 16pt +geometry: a4paper,margin=2cm +--- # MicroDexed User Manual +![](../../images/MicroDexed.png) + +Version 1.0 (June 2020) + +## encoder functions +### Left encoder +**push**: open menu / go up one level in menu hierarchy + +**turn**: change master volume +### Right encoder +**push**: +* in menu: open submenu +* in preset selection: go to next option + +**turn**: +* in menu: pick menu entry / change value +* in preset selection: change preset or bank + +## preset selection +This is the main MicroDexed screen you will use during operation. You can change the currently active preset by turning the right encoder. The preset's name appears in the bottom LCD row.
+Presets are organised in banks. Each bank holds 32 presets. If you arrive at the last preset in the current bank and turn the right encoder even further, the first preset of the next bank will become active.
+You can switch between preset and bank selection by pushing the right encoder. The active selection is marked by square brackets.
+If you compiled MicroDexed to use two Dexed instances, each instance will use its own preset. Which instance you are selecting presets for can be seen in the LCD's top right corner. The active instance's number is displayed white-on-black.
+A small lock in the place of instance number 2 means that MicroDexed was compiled to use a single Dexed instance.
+A mirrored number in either place means that this instance is currently disabled (polyphony set to 0) and will not use CPU time. + +## configuration menu + +A note on instances:
+When setting parameters in this menu, pushing the right encoder switches between instance 1 or 2 if both are active.
+ +### 1. Voice +#### 1.1 Select +Selecting this entry opens the preset selection screen. +#### 1.2 Audio +##### 1.2.1 Voice Level +##### 1.2.2 Panorama +##### 1.2.3 Effects + +**Chorus**

+**Chorus Frequency** This value controls the LFO frequency that modulates the Chorus. It is given in Hz.
+**Chorus Waveform** This sets the LFO modulator waveform for the Chorus. You can choose between sine and triangle wave.
+**Chorus Depth** This value sets the Chorus LFO modulator's amplitude.
+**Chorus Level** This value controls how much of the Chorus' output is added to the mix.
+ +**Delay**

+**Delay Time** The time between reflections (milliseconds).
+**Delay Feedback** The amount of signal that is fed back to the Delay (percent).
+**Delay Level** This value controls how much of the Delay's output is added to the mix.
+ +**Filter** Lowpass? Freq is 0-100? + +**Reverb**
+Hint: Start by setting Roomsize to 30, Reverb Send to its maximum and Reverb Level to 50%. This should give you the smallest amount of noise. If the reverb sounds distorted when you play a loud preset, decrease Reverb Send until the distortion is gone, then adjust Reverb Level to your liking.
+**Reverb Roomsize** This influences how long the reverb will sound.
+**Reverb Damping** This controls how fast higher frequencies are filtered from the reverb sound.
+**Reverb Level** This value controls how much of the Reverb's output is added to the mix.
+**Reverb Send** This value controls how much of the Dexed's signal is fed to the reverb.
+ +#### 1.3 Controller +#### 1.4 MIDI +#### 1.5 Setup +#### 1.6 Internal +#### 1.7 Operator +#### 1.8 Save Voice +### 2 Load/Save +### 3 System +### 4 Info +#### 4.1 Tips and tricks +https://www.thisdx7cartdoesnotexist.com/ +https://dx7.vstforx.de/ +https://synthmata.com/volca-fm/ + diff --git a/doc/manuals/MicroDexed-User_Manual/MicroDexed-User_Manual.pdf b/doc/manuals/MicroDexed-User_Manual/MicroDexed-User_Manual.pdf new file mode 100644 index 0000000..ccba604 Binary files /dev/null and b/doc/manuals/MicroDexed-User_Manual/MicroDexed-User_Manual.pdf differ diff --git a/doc/manuals/MicroDexed-User_Manual/build.sh b/doc/manuals/MicroDexed-User_Manual/build.sh index 1595a17..564f70e 100755 --- a/doc/manuals/MicroDexed-User_Manual/build.sh +++ b/doc/manuals/MicroDexed-User_Manual/build.sh @@ -4,7 +4,7 @@ LCDIMG="../../bin/gen_lcd_screen.sh ../../images" -${LCDIMG} " MicroDexed" " User Manual" images/00_MD_User_Manual.jpg +${LCDIMG} " MicroDexed" " User Manual" 00_MD_User_Manual.jpg pandoc MicroDexed-User_Manual.md \ -V 'geometry:a4paper' \ diff --git a/doc/manuals/MicroDexed/.gitignore b/doc/manuals/MicroDexed/.gitignore index 686ce3d..b627dba 100644 --- a/doc/manuals/MicroDexed/.gitignore +++ b/doc/manuals/MicroDexed/.gitignore @@ -1,2 +1 @@ -*.pdf images/* diff --git a/doc/manuals/MicroDexed/MicroDexed.md b/doc/manuals/MicroDexed/MicroDexed.md index c607a74..5d3d5ae 100644 --- a/doc/manuals/MicroDexed/MicroDexed.md +++ b/doc/manuals/MicroDexed/MicroDexed.md @@ -1,5 +1,15 @@ +--- +fontfamily: dejavu +fontsize: 16pt +geometry: a4paper,margin=2cm +--- + +# MicroDexed + ![](../../images/MicroDexed.png) +Version 1.0 (June 2020) + # What is MicroDexed? MicroDexed is a FM-Software-Synthesizer with six operators and much additional features. @@ -7,12 +17,12 @@ It is written in C/C++ for the microcontroller Teensy-3.6/4.x. The sound generat from the free VST-plugin Dexed was used and a user interface was created using two encoders and an LCD display. -For the original Dexed/msfa software take a look at https://github.com/asb2m10/dexed and -https://github.com/google/music-synthesizer-for-android. +For the original Dexed/msfa software take a look at [Dexed on Github](https://github.com/asb2m10/dexed) and +[Music Synthesizer for Android on Github](https://github.com/google/music-synthesizer-for-android). ## Features -* Compatible to a legendary FM synth with six operators of a famous japanese manufacturer +* Compatible to a legendary FM synth with six operators from a famous Japanese manufacturer * MIDI interface: * DIN IN/OUT with software THRU (can be disabled, optional hardware THRU possible) * USB-Slave (for connecting to a PC) @@ -25,21 +35,21 @@ https://github.com/google/music-synthesizer-for-android. * Low-pass filter with resonance * Reverb (stereo) * Mono sound engine with panorama controller before reverb -* Up to 16 voices of polyphony -* Up to 100 banks of 32 voices can be used on a SD card. +* Up to 20 voices of polyphony +* Up to 100 banks of 32 voices can be stored on an SD card * MIDI SYSEX compatible - * Sounds can be edited with a external editor like... - * EdiSyn (https://github.com/eclab/edisyn) - * Dexed-VST (https://asb2m10.github.io/dexed/) - * https://dx7.vstforx.de/ - * https://synthmata.com/volca-fm/ - * https://www.thisdx7cartdoesnotexist.com/ + * Sounds can be edited with external editors like... + * [EdiSyn](https://github.com/eclab/edisyn) + * [Dexed-VST](https://asb2m10.github.io/dexed/) + * [DX7 by Vstforx](https://dx7.vstforx.de/) + * [Synthmata](https://synthmata.com/volca-fm/) + * [KI generated DX banks](https://www.thisdx7cartdoesnotexist.com/) * Sending of Voice/Bank MIDI-SYSEX dumps * Receiving of Voice/Bank MIDI-SYSEX dumps * Voice-Parameter change via MIDI-SYSEX -* Flexible MIDI controller settings with additional features + * Flexible MIDI controller settings with additional features * Modwheel, Pitchbend, Portamento, Breath-Controller, Aftertouch, Foot-Controller - * Additional modes for the most Controllers (linear, inverse, direct) + * Additional modes for most controllers (linear, inverse, direct) * Controller parameter change via MIDI-SYSEX * Additional MIDI-CCs * Bank select @@ -51,26 +61,26 @@ https://github.com/google/music-synthesizer-for-android. * Delay time * Delay feedback * Delay volume -* Storing of voice, effect presets and combinationsof both as performance +* Storage of voice presets, effect presets and combinations of both as "performance" on SD card * Transpose, fine-tune, mono-mode * Note refresh options: normal or retriggered * Velocity level adaption * Three sound engines: * Modern : this is the original 24-bit music-synthesizer-for-android implementation. * Mark I : Based on the OPL Series but at a higher resolution (LUT are 10-bits). The target of this engine is to be closest to the real DX7. - * OPL Series : this is an experimental implementation of the reversed engineered OPL family chips. 8-bit. Keep in mind that the envelopes stills needs tuning. + * OPL Series : this is an experimental implementation of the reverse-engineered OPL family chips, 8-bit. Keep in mind that the envelopes still need tuning. * Open-Source (https://codeberg.org/dcoredump/MicroDexed)
## Manuals -A manual how you can build your own MicroDexed can be found here: TBD +A manual how you can build your own MicroDexed can be found here: [https://codeberg.org/dcoredump/MicroDexed/src/branch/master/doc/manuals/Build-Manual.pdf](https://codeberg.org/dcoredump/MicroDexed/src/branch/master/doc/manuals/Build-Manual.pdf) -A user manual can be found at: TBD +A user manual can be found at: [https://codeberg.org/dcoredump/MicroDexed/src/branch/master/doc/manuals/MicroDexed-User_Manual/MicroDexed-User_Manual.pdf](https://codeberg.org/dcoredump/MicroDexed/src/branch/master/doc/manuals/MicroDexed-User_Manual/MicroDexed-User_Manual.pdf) ## License -MicroDexed is licensed on the GPL v3. The msfa component (acronym for music synthesizer for android, see https://github.com/google/music-synthesizer-for-android) stays on the Apache 2.0 license to able to collaborate between projects. +MicroDexed is licensed under the GPL v3. The msfa component (acronym for music synthesizer for android, see https://github.com/google/music-synthesizer-for-android) stays under the Apache 2.0 license to be able to collaborate between projects. ## Credits & thanks diff --git a/doc/manuals/MicroDexed/MicroDexed.pdf b/doc/manuals/MicroDexed/MicroDexed.pdf new file mode 100644 index 0000000..0528943 Binary files /dev/null and b/doc/manuals/MicroDexed/MicroDexed.pdf differ diff --git a/doc/manuals/MicroDexed/build.sh b/doc/manuals/MicroDexed/build.sh index b7b6424..8aa122e 100755 --- a/doc/manuals/MicroDexed/build.sh +++ b/doc/manuals/MicroDexed/build.sh @@ -2,16 +2,7 @@ # # sudo apt install wkhtmltopdf pandoc -LCDIMG="../../bin/gen_lcd_screen.sh ../../images" +LCDIMG="../../bin/gen_lcd_screen.sh ../../images/" #${LCDIMG} " MicroDexed" "%round-brace-open%c%round-brace-close%parasiTstudio" images/00_MD_boot.jpg ${LCDIMG} " Let there be" "music and peace%note%" images/01_MD_Peace.jpg - -pandoc MicroDexed.md \ - -V 'geometry:a4paper' \ - -V 'geometry:margin=2cm' \ - -V 'fontfamily:dejavu' \ - -V 'fontsize:16pt' \ - -V 'lang=de-DE' \ ---number-sections \ --t html5 -o MicroDexed.pdf