feat(ChordDisplay): detectOnRelease option

Author: ArTiSTiX

src/main/store/defaults.ts

@@ -38,6 +38,7 @@ export const defaultChordDisplaySettings: ChordDisplaySettings = {
   chordNotation: 'short',
   allowOmissions: true,
   useSustain: true,
+  detectOnRelease: true,
   highlightAlterations: false,
   displayKeyboard: true,
   displayChord: true,

src/main/types/Settings.schema.json

@@ -15,6 +15,9 @@
                         ],
                         "type": "string"
                     },
+                    "detectOnRelease": {
+                        "type": "boolean"
+                    },
                     "displayAltChords": {
                         "type": "boolean"
                     },

src/main/types/Settings.ts

@@ -29,6 +29,7 @@ export type ChordDisplaySettings = {
   chordNotation: 'long' | 'short' | 'symbol';
   allowOmissions: boolean;
   useSustain: boolean;
+  detectOnRelease: boolean;
   highlightAlterations: boolean;
   displayKeyboard: boolean;
   displayChord: boolean;

src/renderer/hooks/useNotes.ts

@@ -51,6 +51,7 @@ interface Parameters {
   midiChannel: number;
   allowOmissions: boolean;
   useSustain: boolean;
+  detectOnRelease: boolean;
 }
 
 enum MidiActionTypes {
@@ -69,6 +70,7 @@ enum ParametersActionTypes {
   KEY_SIGNATURE_CHANGED = 'KEY_SIGNATURE_CHANGED',
   ALLOW_OMISSIONS_CHANGED = 'ALLOW_OMISSIONS_CHANGED',
   USE_SUSTAIN_CHANGED = 'USE_SUSTAIN_CHANGED',
+  DETECT_ON_RELEASE_CHANGED = 'DETECT_ON_RELEASE_CHANGED',
 }
 
 interface ParametersAction {
@@ -83,6 +85,7 @@ interface State {
     keySignature: KeySignatureConfig;
     allowOmissions: boolean;
     useSustain: boolean;
+    detectOnRelease: boolean;
   };
   sustainedMidiNotes: number[];
   playedMidiNotes: number[];
@@ -196,7 +199,9 @@ function reducer(state: State, action: Action): State {
       midiNotes.sort(midiSortCompareFn);
       const notes = midiNotes.map(fromMidi);
       const pitchClasses = notes.map(Note.pitchClass);
-      const chords = getChords(notes, keySignatureNotes, state.params.allowOmissions);
+      const chords = state.params.detectOnRelease
+        ? getChords(notes, keySignatureNotes, state.params.allowOmissions)
+        : state.chords;
 
       return {
         ...state,
@@ -230,7 +235,9 @@ function reducer(state: State, action: Action): State {
       midiNotes.sort(midiSortCompareFn);
       const notes = midiNotes.map(fromMidi);
       const pitchClasses = notes.map(Note.pitchClass);
-      const chords = getChords(notes, keySignatureNotes, state.params.allowOmissions);
+      const chords = state.params.detectOnRelease
+        ? getChords(notes, keySignatureNotes, state.params.allowOmissions)
+        : state.chords;
 
       return {
         ...state,
@@ -253,6 +260,7 @@ const defaultState: State = {
     keySignature: getKeySignature('C'),
     allowOmissions: false,
     useSustain: true,
+    detectOnRelease: true,
   },
   sustainedMidiNotes: [],
   playedMidiNotes: [],
@@ -269,13 +277,15 @@ export default function useNotes({
   midiChannel = MIDI_CHANNEL_ALL,
   allowOmissions = false,
   useSustain = true,
+  detectOnRelease = true,
 }: Partial<Parameters> = {}) {
   const [state, dispatch] = useReducer(reducer, {
     ...defaultState,
     params: {
       keySignature: getKeySignature(key, accidentals === 'sharp'),
       allowOmissions,
       useSustain,
+      detectOnRelease,
     },
   });
 
@@ -300,6 +310,13 @@ export default function useNotes({
     });
   }, [useSustain]);
 
+  useEffect(() => {
+    dispatch({
+      type: ParametersActionTypes.DETECT_ON_RELEASE_CHANGED,
+      value: detectOnRelease,
+    });
+  }, [detectOnRelease]);
+
   const onMidiMessage = useCallback(
     (message: MidiMessage) => {
       const cmd = getMidiCommand(message);

src/renderer/views/ChordDisplay/ChordDisplayModule.tsx

@@ -31,6 +31,7 @@ const ChordDisplayModule: React.FC<Props> = ({ moduleId }) => {
     midiChannel: 0,
     allowOmissions: moduleSettings.allowOmissions,
     useSustain: moduleSettings.useSustain,
+    detectOnRelease: moduleSettings.detectOnRelease,
   });
 
   if (!settings || !moduleSettings) return null;

src/renderer/views/Settings/ChordDisplaySettings/ChordDisplayModuleSettings.tsx

@@ -117,6 +117,17 @@ const ChordDisplayModuleSettings: React.FC<Props> = ({ parentPath }) => {
                 checked={moduleSettings.useSustain}
               />
             </FormControlLabel>
+
+            <FormControlLabel
+              label="Detect on release"
+              hint="Refresh chord detection when releasing notes"
+              reverse
+            >
+              <Switch
+                onChange={(value) => updateModuleSetting('detectOnRelease', value)}
+                checked={moduleSettings.detectOnRelease}
+              />
+            </FormControlLabel>
           </FormFieldset>
 
           <FormFieldset label="Additional Info">