feat: added split notes function

This commit is contained in:
Xiaohan-Tian
2026-05-18 19:00:21 -07:00
parent d10965066f
commit 4cf474be7e
9 changed files with 645 additions and 6 deletions
+1
View File
@@ -41,6 +41,7 @@ export { DeleteNotesCommand, DeleteNoteCommand } from './note/DeleteNotesCommand
export { ResizeNotesCommand } from './note/ResizeNotesCommand';
export { MoveNotesCommand } from './note/MoveNotesCommand';
export { PasteNotesCommand } from './note/PasteNotesCommand';
export { SplitSelectedNotesCommand } from './note/SplitSelectedNotesCommand';
export { UpdateNotePropertiesCommand } from './note/UpdateNotePropertiesCommand';
export { UpdatePitchBendPropertiesCommand } from './note/UpdatePitchBendPropertiesCommand';
export { UpdateControllerEventPropertiesCommand } from './note/UpdateControllerEventPropertiesCommand';
@@ -0,0 +1,131 @@
import { beforeEach, describe, expect, it, vi } from 'vitest';
import type { Selectable } from '../../../components/interfaces';
import { KGCore } from '../../KGCore';
import { KGMidiNote } from '../../midi/KGMidiNote';
import { SplitSelectedNotesCommand } from './SplitSelectedNotesCommand';
import { createMockMidiNote, createMockMidiRegion, createMockMidiTrack, createMockProject } from '../../../test/utils/mock-data';
vi.mock('../../KGCore', () => ({
KGCore: {
instance: vi.fn(),
}
}));
interface MockCore {
getCurrentProject: ReturnType<typeof vi.fn>;
getSelectedItems: ReturnType<typeof vi.fn>;
clearSelectedItems: ReturnType<typeof vi.fn>;
addSelectedItems: ReturnType<typeof vi.fn>;
}
describe('SplitSelectedNotesCommand', () => {
let mockCore: MockCore;
beforeEach(() => {
vi.clearAllMocks();
mockCore = {
getCurrentProject: vi.fn(),
getSelectedItems: vi.fn(),
clearSelectedItems: vi.fn(),
addSelectedItems: vi.fn(),
};
vi.mocked(KGCore.instance).mockReturnValue(mockCore as unknown as KGCore);
});
it('splits one selected note into two halves and selects both results', () => {
const splitNote = createMockMidiNote({ id: 'note-a', startBeat: 1, endBeat: 5, pitch: 64, velocity: 90 });
splitNote.select();
const region = createMockMidiRegion({
id: 'region-1',
trackId: '1',
trackIndex: 0,
notes: [splitNote],
});
const track = createMockMidiTrack({ id: 1, regions: [region] });
mockCore.getCurrentProject.mockReturnValue(createMockProject({ tracks: [track] }));
mockCore.getSelectedItems.mockReturnValue([splitNote]);
const command = new SplitSelectedNotesCommand(region.getId(), [splitNote.getId()], 3);
command.execute();
const notes = region.getNotes();
expect(notes).toHaveLength(2);
expect(notes.map(note => [note.getStartBeat(), note.getEndBeat(), note.getPitch(), note.getVelocity()])).toEqual([
[1, 3, 64, 90],
[3, 5, 64, 90],
]);
expect(notes.every(note => note.isSelected())).toBe(true);
expect(command.getSplitCount()).toBe(1);
expect(mockCore.clearSelectedItems).toHaveBeenCalledTimes(1);
expect(mockCore.addSelectedItems).toHaveBeenCalledTimes(1);
expect((mockCore.addSelectedItems.mock.calls[0][0] as Selectable[])).toHaveLength(2);
});
it('splits multiple selected notes in one undoable operation and leaves uncrossed selected notes unchanged', () => {
const noteA = createMockMidiNote({ id: 'note-a', startBeat: 0, endBeat: 4, pitch: 60, velocity: 70 });
const noteB = createMockMidiNote({ id: 'note-b', startBeat: 1, endBeat: 2, pitch: 62, velocity: 75 });
const noteC = createMockMidiNote({ id: 'note-c', startBeat: 2, endBeat: 5, pitch: 65, velocity: 80 });
[noteA, noteB, noteC].forEach(note => note.select());
const region = createMockMidiRegion({
id: 'region-1',
trackId: '1',
trackIndex: 0,
notes: [noteA, noteB, noteC],
});
const track = createMockMidiTrack({ id: 1, regions: [region] });
mockCore.getCurrentProject.mockReturnValue(createMockProject({ tracks: [track] }));
mockCore.getSelectedItems.mockReturnValue([noteA, noteB, noteC]);
const command = new SplitSelectedNotesCommand(region.getId(), [noteA.getId(), noteB.getId(), noteC.getId()], 3);
command.execute();
const notes = region.getNotes();
expect(notes).toHaveLength(5);
expect(notes.map(note => [note.getStartBeat(), note.getEndBeat(), note.getPitch()])).toEqual([
[0, 3, 60],
[3, 4, 60],
[1, 2, 62],
[2, 3, 65],
[3, 5, 65],
]);
expect(command.getSplitCount()).toBe(2);
expect(command.getUnchangedSelectedNoteIds()).toEqual(['note-b']);
command.undo();
expect(region.getNotes()).toEqual([noteA, noteB, noteC]);
expect(mockCore.clearSelectedItems).toHaveBeenCalledTimes(2);
expect(mockCore.addSelectedItems).toHaveBeenLastCalledWith([noteA, noteB, noteC]);
command.execute();
expect(region.getNotes().map(note => [note.getStartBeat(), note.getEndBeat(), note.getPitch()])).toEqual([
[0, 3, 60],
[3, 4, 60],
[1, 2, 62],
[2, 3, 65],
[3, 5, 65],
]);
});
it('throws when no selected note crosses the playhead', () => {
const noteA = new KGMidiNote('note-a', 0, 1, 60, 100);
const noteB = new KGMidiNote('note-b', 4, 5, 62, 100);
const region = createMockMidiRegion({
id: 'region-1',
trackId: '1',
trackIndex: 0,
notes: [noteA, noteB],
});
const track = createMockMidiTrack({ id: 1, regions: [region] });
mockCore.getCurrentProject.mockReturnValue(createMockProject({ tracks: [track] }));
mockCore.getSelectedItems.mockReturnValue([noteA, noteB]);
const command = new SplitSelectedNotesCommand(region.getId(), [noteA.getId(), noteB.getId()], 3);
expect(() => command.execute()).toThrow(
'The playhead is not inside any selected note. Move the playhead inside a selected note before splitting.'
);
});
});
@@ -0,0 +1,164 @@
import type { Selectable } from '../../../components/interfaces';
import { generateUniqueId } from '../../../util/miscUtil';
import { KGCore } from '../../KGCore';
import { KGMidiNote } from '../../midi/KGMidiNote';
import { KGMidiRegion } from '../../region/KGMidiRegion';
import { KGCommand } from '../KGCommand';
interface SplitNoteRecord {
originalNoteId: string;
leftNoteId: string;
rightNoteId: string;
startBeat: number;
endBeat: number;
pitch: number;
velocity: number;
}
export class SplitSelectedNotesCommand extends KGCommand {
private readonly regionId: string;
private readonly selectedNoteIds: string[];
private readonly splitAtBeat: number;
private targetRegion: KGMidiRegion | null = null;
private originalNotes: KGMidiNote[] = [];
private originalSelectedItems: Selectable[] = [];
private splitNoteRecords: SplitNoteRecord[] = [];
private unchangedSelectedNoteIds: string[] = [];
constructor(regionId: string, selectedNoteIds: string[], splitAtBeat: number) {
super();
this.regionId = regionId;
this.selectedNoteIds = [...selectedNoteIds];
this.splitAtBeat = splitAtBeat;
}
execute(): void {
const core = KGCore.instance();
const targetRegion = this.resolveTargetRegion();
const noteIdSet = new Set(this.selectedNoteIds);
const currentNotes = targetRegion.getNotes();
const selectedNotes = currentNotes.filter(note => noteIdSet.has(note.getId()));
if (selectedNotes.length === 0) {
throw new Error('No selected notes were found in the active MIDI region.');
}
if (this.originalSelectedItems.length === 0) {
this.originalSelectedItems = [...core.getSelectedItems()];
}
if (this.originalNotes.length === 0) {
this.originalNotes = [...currentNotes];
}
if (this.splitNoteRecords.length === 0) {
this.splitNoteRecords = selectedNotes
.filter(note => note.getStartBeat() < this.splitAtBeat && this.splitAtBeat < note.getEndBeat())
.map(note => ({
originalNoteId: note.getId(),
leftNoteId: generateUniqueId('KGMidiNote'),
rightNoteId: generateUniqueId('KGMidiNote'),
startBeat: note.getStartBeat(),
endBeat: note.getEndBeat(),
pitch: note.getPitch(),
velocity: note.getVelocity(),
}));
}
if (this.splitNoteRecords.length === 0) {
throw new Error('The playhead is not inside any selected note. Move the playhead inside a selected note before splitting.');
}
const splitRecordByOriginalId = new Map(
this.splitNoteRecords.map(record => [record.originalNoteId, record])
);
this.unchangedSelectedNoteIds = selectedNotes
.filter(note => !splitRecordByOriginalId.has(note.getId()))
.map(note => note.getId());
const nextNotes: KGMidiNote[] = [];
const nextSelectedNotes: KGMidiNote[] = [];
for (const note of currentNotes) {
const splitRecord = splitRecordByOriginalId.get(note.getId());
if (!splitRecord) {
note.deselect();
nextNotes.push(note);
if (noteIdSet.has(note.getId())) {
note.select();
nextSelectedNotes.push(note);
}
continue;
}
const leftNote = new KGMidiNote(
splitRecord.leftNoteId,
splitRecord.startBeat,
this.splitAtBeat,
splitRecord.pitch,
splitRecord.velocity
);
const rightNote = new KGMidiNote(
splitRecord.rightNoteId,
this.splitAtBeat,
splitRecord.endBeat,
splitRecord.pitch,
splitRecord.velocity
);
leftNote.select();
rightNote.select();
nextNotes.push(leftNote, rightNote);
nextSelectedNotes.push(leftNote, rightNote);
}
targetRegion.setNotes(nextNotes);
core.clearSelectedItems();
core.addSelectedItems(nextSelectedNotes);
}
undo(): void {
if (!this.targetRegion) {
throw new Error('Cannot undo: split was never executed');
}
const core = KGCore.instance();
this.targetRegion.setNotes([...this.originalNotes]);
this.originalNotes.forEach(note => note.deselect());
this.originalSelectedItems.forEach(item => item.select());
core.clearSelectedItems();
core.addSelectedItems(this.originalSelectedItems);
}
getDescription(): string {
const splitCount = this.splitNoteRecords.length || this.selectedNoteIds.length;
return splitCount === 1 ? 'Split note' : `Split ${splitCount} notes`;
}
public getSplitCount(): number {
return this.splitNoteRecords.length;
}
public getUnchangedSelectedNoteIds(): string[] {
return [...this.unchangedSelectedNoteIds];
}
private resolveTargetRegion(): KGMidiRegion {
if (this.targetRegion) {
return this.targetRegion;
}
const tracks = KGCore.instance().getCurrentProject().getTracks();
for (const track of tracks) {
const region = track.getRegions().find(candidate => candidate.getId() === this.regionId);
if (region instanceof KGMidiRegion) {
this.targetRegion = region;
return region;
}
}
throw new Error(`MIDI region with ID ${this.regionId} not found`);
}
}
+4 -1
View File
@@ -231,13 +231,16 @@ export class ConfigManager {
hold_to_create_region: 'ctrl',
play: 'space',
loop: 'c',
record: 'r',
undo: 'ctrl+z',
redo: 'ctrl+shift+z',
select_all: 'ctrl+a',
copy: 'ctrl+c',
cut: 'ctrl+x',
paste: 'ctrl+v',
save: 'ctrl+s'
save: 'ctrl+s',
split_region: 'ctrl+t',
merge_regions: 'ctrl+j'
},
piano_roll: {
switch: 'tab',