v0.6.0

Author: euwbah

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+### v0.6
+
+- Update to Python 3.12, updated dependencies.
+- Fixed Windows build batch script.
+- Add per-key velocity curve configuration.
+
 ### v0.3.0
 
 - Added config persistence with the `save` command.

README.md

@@ -19,7 +19,7 @@
   - Absolute
   - Link slide to press (channel pressure)
   - Bipolar
-- Invert sustain pedal (because I couldn't find this feature in Equator lmao)
+- Invert sustain pedal (because I couldn't find this feature in Equator)
 
 ## Quick Start
 
@@ -188,6 +188,41 @@ As such, if you're using two instances of Keyscape, it is crucial
 that you turn off the sustain pedal noise on either one of the VSTs,
 otherwise you'd get double the sustain pedal noise.
 
+### Key split data example
+
+For example, this is
+[line 92 of the default 31 edo mapping](https://github.com/euwbah/microtonal-seaboard/blob/master/mappings/default.sbmap#L92):
+
+`A4    30 -38.7097   -1  50   0.0000    0  73  38.7097    1  98   0.0000    0 128  38.7097    1`
+
+The first value of the line, `A4` is the note name of which this
+split data pertains to. The split information only applies to this
+one key. Capitalisation does not matter.
+
+After this, the values are presented in groups of threes.
+
+The value `30` represents that the following tuning data only applies
+when the Slide value (CC74) is below 30 (exclusive). This is the area
+right at the bottom of the white keys on the seaboard.
+
+The next value `-38.7097` represents the cent offset of this note
+with respect to the 12 edo equivalent on the same key.
+In 31 edo, this is the note A-down. The cent offset is used to
+calculate the amount of pitch bend to send when in MPE mode.
+
+The final value of the triple is `-1`, and this says that the
+output of this key when in MIDI mode is 1 note below A4 (that is, Ab4).
+
+Looking at the next 3 values, `50 0.0000 0`, tells us that for the
+Slide values 30-49 (inclusive), which is the middle section of the
+white key, we will apply a tuning offset of 0 cents in MPE mode,
+and an output of A4 in MIDI mode.
+In 31 edo, this is the note A-natural.
+
+The next 3 values, `73 38.7097 1` gives us the note A-up, and will
+be applied for Slide values 50-72 (inclusive), which is the part of
+the white key right below where the black keys begin.
+
 ### Microtuning on Pianoteq
 
 Pianoteq offers [multi-channel keyboard mappings](https://forum.modartt.com/viewtopic.php?id=4307)
@@ -196,15 +231,15 @@ full range.
 
 To make use of this in the seaboard mapper:
 
-1. enter `autosplit` in the console to turn auto split mode on
+1. Enter the `autosplit` command in the console to turn auto split mode on
 
 2. Under Pianoteq's microtuning screen, there's a button on the top right
   to change the **keyboard mapping**. Click on it and you will see an option
   titled '**Extended layout for up to 16*128 notes**'. Open the drop down and select **MIDI channel 5**
-  
+
 ![img.png](imgs/extended-layout-pianoteq.png)
 
-- This will cause the notes received on each subsequent MIDI channel 
+- This will cause the notes received on each subsequent MIDI channel
   to sound one octave higher than the previous MIDI channel.
 - The checked midi channel (5) denotes the MIDI channel that will not have any octave/equave transposition at all.
 - E.g. if MIDI channel 5 is selected as the main channel,
@@ -258,91 +293,11 @@ Initial Strike will yield a Slide value of 0, and sliding
 all the way to either to top or bottom will yield the max Slide value of
 127.
 
-## Seaboard Map `.sbmap` file format
-
-The mapper loads `.sbmap` files to assign a mapping to the seaboard.
-If `mappings/default.sbmap` exists, it will load that mapping on
-startup.
-
-Each line of the .sbmap file can either be a descriptive comment,
-a comment, or key split data.
-
-Mappings are meant to be generated algorithmically with a script.
-Take a look at https://github.com/euwbah/microtonal-seaboard/blob/master/mapping_generator/edo31.py
-for an example.
-
-### `/ descriptive comment`
-
-Lines that begin with `/` will be printed in the console
-when the mapping is loaded.
-
-### `# comment`
+## Invert sustain pedal
 
-Lines that begin with `#` will be ignored entirely
+The `sus` command toggle the sustain pedal polarity (so you don't have to reach for the physical switch on yours)
 
-### Key split data
-
-This line will describe how to split one key.
-
-The values of the key split data are to be separated by spaces
-or tabs, and are presented in the following format:
-
-`<note> <p1> <c1> <s1> (<p2> <c2> <s2> ... <pn> <cn> <sn>)`
-
-- `note`: 12edo note name of the key that this split applies to
-- `pn`: a cc74 (slide) value representing the exclusive upper bounds
-   of the nth vertical split point
-- `cn`: (for MPE mode) the cents offset of the output note with respect to the
-   key's original tuning in 12 edo.
-- `sn`: (for MIDI mode) the output MIDI note represented as number of
-   steps from the note A4.
-
-Take note of the following constraints:
-
-1. Key split data lines must have at least one split point.
-2. The split points must be presented in order of increasing
-   cc74 (Slide) values
-3. The final split point must always be 128 representing the
-   maxima of the cc74 value range.
-4. You can leave out notes in the mapping file. Not all
-   of them have to be mapped in order for the program to work.
-   The left-out notes will default to the standard behavior
-   and tuning.
-
-#### Key split data example
-
-For example, this is
-[line 92 of the default 31 edo mapping](https://github.com/euwbah/microtonal-seaboard/blob/master/mappings/default.sbmap#L92):
-
-`A4    30 -38.7097   -1  50   0.0000    0  73  38.7097    1  98   0.0000    0 128  38.7097    1`
-
-The first value of the line, `A4` is the note name of which this
-split data pertains to. The split information only applies to this
-one key. Capitalisation does not matter.
-
-After this, the values are presented in groups of threes.
-
-The value `30` represents that the following tuning data only applies
-when the Slide value (CC74) is below 30 (exclusive). This is the area
-right at the bottom of the white keys on the seaboard.
-
-The next value `-38.7097` represents the cent offset of this note
-with respect to the 12 edo equivalent on the same key.
-In 31 edo, this is the note A-down. The cent offset is used to
-calculate the amount of pitch bend to send when in MPE mode.
-
-The final value of the triple is `-1`, and this says that the
-output of this key when in MIDI mode is 1 note below A4 (that is, Ab4).
-
-Looking at the next 3 values, `50 0.0000 0`, tells us that for the
-Slide values 30-49 (inclusive), which is the middle section of the
-white key, we will apply a tuning offset of 0 cents in MPE mode,
-and an output of A4 in MIDI mode.
-In 31 edo, this is the note A-natural.
-
-The next 3 values, `73 38.7097 1` gives us the note A-up, and will
-be applied for Slide values 50-72 (inclusive), which is the part of
-the white key right below where the black keys begin.
+##
 
 ### Huh?
 

__pycache__/configs.cpython-312.pyc

@@ -9,4 +9,4 @@ pip install -r requirements.txt
 pyinstaller microtonal-seaboard.spec &&^
     cd dist/ &&^
     tar -a -c -f microtonal-seaboard-windows.zip ../mappings microtonal-seaboard.exe
-deactivate
+deactivate

__pycache__/handler.cpython-312.pyc

@@ -6,6 +6,7 @@
 
 from mapping import Mapping
 from split import SplitData
+from velcurve import VelocityCurves
 
 
 class SlideMode(Enum):
@@ -34,6 +35,8 @@ class CONFIGS:
     PITCH_BEND_RANGE: int = 24
     MAPPING: Mapping
     TOGGLE_SUSTAIN: bool = False
+    VELOCITY_CURVES: VelocityCurves = VelocityCurves()
+    DEBUG: bool = False
 
 
 def read_configs() -> bool:
@@ -57,6 +60,8 @@ def read_configs() -> bool:
             CONFIGS.PITCH_BEND_RANGE = c['PITCH_BEND_RANGE']
             CONFIGS.MAPPING = c['MAPPING']
             CONFIGS.TOGGLE_SUSTAIN = c['TOGGLE_SUSTAIN']
+            CONFIGS.VELOCITY_CURVES = c['VELOCITY_CURVES']
+            CONFIGS.DEBUG = c['DEBUG']
 
     except Exception:
         print('failed to load saved configurations. Delete config.dill.')
@@ -77,6 +82,8 @@ def save_configs():
             'AUTO_SPLIT': CONFIGS.AUTO_SPLIT,
             'PITCH_BEND_RANGE': CONFIGS.PITCH_BEND_RANGE,
             'MAPPING': CONFIGS.MAPPING,
-            'TOGGLE_SUSTAIN': CONFIGS.TOGGLE_SUSTAIN
+            'TOGGLE_SUSTAIN': CONFIGS.TOGGLE_SUSTAIN,
+            'VELOCITY_CURVES': CONFIGS.VELOCITY_CURVES,
+            'DEBUG': CONFIGS.DEBUG
         }
         dill.dump(c, f)

__pycache__/keytracker.cpython-312.pyc

@@ -20,6 +20,12 @@ class MidiInputHandler():
     def __init__(self, out_port: MidiOut):
         self.out_port = out_port
         self._wallclock = time.time()
+        self.octave_offset = 4
+        """
+        The lowest note on the Rise 49 is C with octave one less than this.
+
+        CC 06 (Data Entry MSB) gives the octave offset when it is updated.
+        """
 
     def __call__(self, event, data=None):
         mapping = CONFIGS.MAPPING
@@ -31,20 +37,25 @@ def __call__(self, event, data=None):
         def tune_and_send_note(note, vel, cc74):
 
             edosteps_from_a4 = mapping.calc_notes_from_a4(note, cc74)
+            scaled_vel = CONFIGS.VELOCITY_CURVES.get_velocity(note, vel, self.octave_offset, cc74, CONFIGS.DEBUG)
+
+            pitchbend = None
 
             if CONFIGS.MPE_MODE:
                 pitchbend = mapping.calc_pitchbend(note, cc74)
                 # pitch bend has to go before the note on event
                 # otherwise equator might not register it.
                 self.send_pitch_bend(channel, pitchbend)
-                self.send_note_on(channel, note, vel)
+                self.send_note_on(channel, note, scaled_vel)
 
                 if CONFIGS.SLIDE_MODE == SlideMode.FIXED:
                     self.send_cc(channel, 74, CONFIGS.SLIDE_FIXED_N)
+                # NOTE: the vel parameter is raw, before applying velocity curve
                 tracker.register_on(note, vel, channel, note, channel, edosteps_from_a4, pitchbend)
 
                 # pitch bend has to go after note on event
                 # otherwise strobe 2 complete disregards it
+                # because of this we have to send it twice
                 self.send_pitch_bend(channel, pitchbend)
             else:
                 if CONFIGS.AUTO_SPLIT is not None:
@@ -58,7 +69,7 @@ def tune_and_send_note(note, vel, cc74):
                     send_note = max(0, min(127, send_note))
                     print('Midi note out of range! Consider using mutliple vst instances in different octaves '
                           'and split ranges with pitch offsets when in MIDI mode.')
-                self.send_note_on(send_ch, send_note, vel)
+                self.send_note_on(send_ch, send_note, scaled_vel)
 
                 # if a note overrides another active note in the same input channel,
                 # stop that note. Prevents ghosts that hang around.
@@ -74,9 +85,13 @@ def do_later():
                 if CONFIGS.SLIDE_MODE == SlideMode.FIXED:
                     threading.Thread(target=do_later).start()
 
+                # NOTE: the vel parameter is raw, before applying velocity curve
                 tracker.register_on(note, vel, channel, send_note, send_ch, edosteps_from_a4)
 
-            ws_server.send_note_on(edosteps_from_a4, vel)
+            ws_server.send_note_on(edosteps_from_a4, scaled_vel)
+
+            if CONFIGS.DEBUG:
+                print(f'recv: (note {note}, vel {vel}, cc74 {cc74}), sent: (note {edosteps_from_a4}, {f"pb {pitchbend}, " if CONFIGS.MPE_MODE else ""}vel {scaled_vel})')
 
         if msg_type == midi.NOTE_ON:
             note, vel = message[1:3]
@@ -149,6 +164,9 @@ def send_preempt_defaults():
                 sustain_value = value if not CONFIGS.TOGGLE_SUSTAIN else 127 - value
                 self.send_cc(c, cc, sustain_value)
                 ws_server.send_cc(cc, sustain_value)
+            elif cc == 6: # Data Entry MSB, octave switch
+                self.octave_offset = value
+                self.send_cc(c, cc, value)
             else:
                 self.send_cc(c, cc, value)
 

__pycache__/mapping.cpython-312.pyc

@@ -17,9 +17,9 @@ def __init__(self):
         """
         Race conditions can cause a note on event to be handled before its corresponding
         cc74 message. Das not gud.
-        This flag is set to True upon note off, and will only be set to false when a 
+        This flag is set to True upon note off, and will only be set to false when a
         cc74 message has been registered.
-        
+
         If a cc74 message is registered before a note on event, no problem.
         If a cc74 message is only registered after a note on event, the cc74 message
         has to act as if the note was not yet on, and the appropriate pitch bends and
@@ -34,36 +34,38 @@ def __init__(self):
 
         self.on_velocity_received = 0
         """
-        Stores the on velocity that was received in the event that the note cannot be
+        Stores the raw on velocity that was received in the event that the note cannot be
         immediately forwarded as it is pending a cc74 message.
+
+        This is the raw value before velocity curve is applied.
         """
 
         self.midi_note_sent = 0
         """
         Represents the midi note number that was sent as a result
         of the input on this current channel.
-        
+
         In MIDI mode, this note number does not correlate to the
         input note that was received on this channel
-        
+
         This is used to turn off the appropriate midi note
         should there be a 'on' event on two notes on the same channel
         on the input when in MIDI mode.
-        
+
         This prevents hanging notes in MIDI mode when there are more than
         16 simultaneous input notes.
         """
 
         self.channel_sent = 0
         """
         Represents the channel that this note was sent to.
-        
+
         In MIDI mode, the channel of the input note does not
         correlate to the channel of the output note.
-        
+
         This keeps track of the channel the note was sent on
         so that the appropriate midi note can be turned off.
-        
+
         This prevents hanging notes in MIDI mode when there are more than
         16 simultaneous input notes.
         """