voicing modes: below, under, above

packages/core/controls.mjs

@@ -579,7 +579,7 @@ const generic_params = [
   ['dictionary', 'dict'], // which dictionary to use for the voicings
   ['anchor'], // the top note to align the voicing to, defaults to c5
   ['offset'], // how the voicing is offset from the anchored position
-  ['mode'], // below = anchor note will be removed from the voicing, useful for melody harmonization
+  [['mode', 'anchor']], // below = anchor note will be removed from the voicing, useful for melody harmonization
 
   /**
    * Sets the level of reverb.

packages/tonal/test/tonleiter.test.mjs

@@ -15,7 +15,6 @@ import {
   tokenizeChord,
   note2pc,
   note2oct,
-  note2midi,
   midi2note,
   renderVoicing,
   scaleStep,
@@ -92,13 +91,6 @@ describe('tonleiter', () => {
     expect(note2oct('C7')).toBe(7);
     //expect(note2oct('C10')).toBe(10); // <- 2 digits fail
   });
-  test('note2midi', () => {
-    expect(note2midi('C4')).toBe(60);
-    expect(note2midi('C#4')).toBe(61);
-    expect(note2midi('Cb4')).toBe(59);
-    expect(note2midi('Bb3')).toBe(58);
-    // expect(note2midi('C10')).toBe(58); // <- 2 digits fail
-  });
   test('midi2note', () => {
     expect(midi2note(60)).toBe('C4');
     expect(midi2note(61)).toBe('Db4');
@@ -122,14 +114,39 @@ describe('tonleiter', () => {
         '10 14 15 19', // b7 9 b3 5
       ],
     };
-    expect(renderVoicing({ chord: 'Em7', anchor: 'Bb4', dictionary })).toEqual(['G3', 'B3', 'D4', 'Gb4']);
+    expect(renderVoicing({ chord: 'Em7', anchor: 'Bb4', dictionary, mode: 'below' })).toEqual([
-    expect(renderVoicing({ chord: 'Cm7', anchor: 'D5', dictionary })).toEqual(['Eb4', 'G4', 'Bb4', 'D5']);
+      'G3',
-    expect(renderVoicing({ chord: 'Cm7', anchor: 'G5', dictionary })).toEqual(['Bb4', 'D5', 'Eb5', 'G5']);
+      'B3',
-    expect(renderVoicing({ chord: 'Cm7', anchor: 'g5', dictionary })).toEqual(['Bb4', 'D5', 'Eb5', 'G5']);
+      'D4',
-    expect(renderVoicing({ chord: 'Cm7', anchor: 'g5', dictionary, n: 0 })).toEqual([70]); // Bb4
+      'Gb4',
-    expect(renderVoicing({ chord: 'Cm7', anchor: 'g5', dictionary, n: 1 })).toEqual([74]); // D5
+    ]);
-    expect(renderVoicing({ chord: 'Cm7', anchor: 'g5', dictionary, n: 4 })).toEqual([82]); // Bb5
+    expect(renderVoicing({ chord: 'Cm7', anchor: 'D5', dictionary, mode: 'below' })).toEqual([
-    expect(renderVoicing({ chord: 'Cm7', anchor: 'g5', dictionary, offset: 1 })).toEqual(['Eb5', 'G5', 'Bb5', 'D6']);
+      'Eb4',
+      'G4',
+      'Bb4',
+      'D5',
+    ]);
+    expect(renderVoicing({ chord: 'Cm7', anchor: 'G5', dictionary, mode: 'below' })).toEqual([
+      'Bb4',
+      'D5',
+      'Eb5',
+      'G5',
+    ]);
+    expect(renderVoicing({ chord: 'Cm7', anchor: 'g5', dictionary, mode: 'below' })).toEqual([
+      'Bb4',
+      'D5',
+      'Eb5',
+      'G5',
+    ]);
+    expect(renderVoicing({ chord: 'Cm7', anchor: 'g5', dictionary, mode: 'below', n: 0 })).toEqual([70]); // Bb4
+    expect(renderVoicing({ chord: 'Cm7', anchor: 'g5', dictionary, mode: 'below', n: 1 })).toEqual([74]); // D5
+    expect(renderVoicing({ chord: 'Cm7', anchor: 'g5', dictionary, mode: 'below', n: 4 })).toEqual([82]); // Bb5
+    expect(renderVoicing({ chord: 'Cm7', anchor: 'g5', dictionary, mode: 'below', offset: 1 })).toEqual([
+      'Eb5',
+      'G5',
+      'Bb5',
+      'D6',
+    ]);
     // expect(voiceBelow('G4', 'Cm7', voicingDictionary)).toEqual(['Bb3', 'D4', 'Eb4', 'G4']);
     // TODO: test with offset
   });

packages/tonal/tonleiter.mjs

@@ -1,4 +1,4 @@
-import { isNote, isNoteWithOctave, _mod } from '@strudel.cycles/core';
+import { isNote, isNoteWithOctave, _mod, noteToMidi } from '@strudel.cycles/core';
 import { Interval } from '@tonaljs/tonal';
 
 // https://codesandbox.io/s/stateless-voicings-g2tmz0?file=/src/lib.js:0-2515
@@ -30,10 +30,6 @@ export function tokenizeChord(chord) {
 export const note2pc = (note) => note.slice(0, -1);
 export const note2oct = (note) => Number(note.slice(-1));
 
-export const note2midi = (note) => {
-  const [pc, oct] = [note2pc(note), note2oct(note)];
-  return pc2chroma(pc) + oct * 12 + 12;
-};
 export const note2chroma = (note) => {
   return pc2chroma(note2pc(note));
 };
@@ -42,13 +38,13 @@ export const note2chroma = (note) => {
 export const midi2chroma = (midi) => midi % 12;
 
 // TODO: test and use in voicing function
-export const pitch2chroma = (x) => {
+export const pitch2chroma = (x, defaultOctave) => {
   if (isNoteWithOctave(x)) {
     return note2chroma(x);
   }
   if (isNote(x)) {
     //pc
-    return pc2chroma(x);
+    return pc2chroma(x, defaultOctave);
   }
   if (typeof x === 'number') {
     // expect midi
@@ -69,7 +65,7 @@ export const x2midi = (x) => {
     return x;
   }
   if (typeof x === 'string') {
-    return note2midi(x);
+    return noteToMidi(x);
   }
 };
 
@@ -81,17 +77,24 @@ export const midi2note = (midi, sharp = false) => {
 };
 
 export function scaleStep(notes, offset) {
-  notes = notes.map((note) => (typeof note === 'string' ? note2midi(note) : note));
+  notes = notes.map((note) => (typeof note === 'string' ? noteToMidi(note) : note));
   const octOffset = Math.floor(offset / notes.length) * 12;
   offset = _mod(offset, 12);
   return notes[offset % notes.length] + octOffset;
 }
 
-export function renderVoicing({ chord, anchor, dictionary, offset = 0, n, mode }) {
+// different ways to resolve the note to compare the anchor to (see renderVoicing)
-  anchor = anchor?.note || anchor || 'c5';
+let modeTarget = {
+  below: (v) => v.slice(-1)[0],
+  under: (v) => v.slice(-1)[0],
+  above: (v) => v[0],
+};
+
+export function renderVoicing({ chord, dictionary, offset = 0, n, mode = 'above', anchor = 'c4' }) {
   const [root, symbol] = tokenizeChord(chord);
-  const anchorChroma = pitch2chroma(anchor);
   const rootChroma = pc2chroma(root);
+  anchor = anchor?.note || anchor;
+  const anchorChroma = pitch2chroma(anchor);
   const voicings = dictionary[symbol].map((voicing) =>
     (typeof voicing === 'string' ? voicing.split(' ') : voicing).map(step2semitones),
   );
@@ -99,7 +102,8 @@ export function renderVoicing({ chord, anchor, dictionary, offset = 0, n, mode }
   let minDistance, bestIndex;
   // calculate distances up from voicing top notes
   let chromaDiffs = voicings.map((v, i) => {
-    const diff = _mod(anchorChroma - v.slice(-1)[0] - rootChroma, 12);
+    const targetStep = modeTarget[mode](v);
+    const diff = _mod(anchorChroma - targetStep - rootChroma, 12);
     if (minDistance === undefined || diff < minDistance) {
       minDistance = diff;
       bestIndex = i;
@@ -110,16 +114,16 @@ export function renderVoicing({ chord, anchor, dictionary, offset = 0, n, mode }
   const octDiff = Math.ceil(offset / voicings.length) * 12;
   const indexWithOffset = _mod(bestIndex + offset, voicings.length);
   const voicing = voicings[indexWithOffset];
-  const maxMidi = note2midi(anchor);
+  const targetStep = modeTarget[mode](voicing);
-  const topMidi = maxMidi - chromaDiffs[indexWithOffset] + octDiff;
+  const anchorMidi = noteToMidi(anchor, 4) - chromaDiffs[indexWithOffset] + octDiff;
 
-  const voicingMidi = voicing.map((v) => topMidi - voicing[voicing.length - 1] + v);
+  const voicingMidi = voicing.map((v) => anchorMidi - targetStep + v);
   let notes = voicingMidi.map((n) => midi2note(n));
   if (n !== undefined) {
     return [scaleStep(notes, n)];
   }
-  if (mode === 'below') {
+  if (mode === 'under') {
-    notes = notes.filter((n) => x2midi(n) !== note2midi(anchor));
+    notes = notes.filter((n) => x2midi(n) !== noteToMidi(anchor));
   }
   return notes;
 }