GMKeyboard

Extension

Description

GMKeyboard is a piano keyboard emulation widget, with visual feedback.

It includes two displays modes : diatonic or chromatic.

It also provides an easy way to be controlled by a HID (a computer keyboard or a MIDI device). See the example section for a detailed example of this functionality.

Class Methods

.new

Instance Methods

Interaction

.action

.sustainMode

.keyNumber

Graphics

.mode

.chromaticStartNote

.displayNames

.names

.displayHighlights

.highlights

.names

.keyColor

.keyOutlineColor

.blackKeyColor

.blackKeyOutlineColor

.blinkColor

.blinkFontColor

.fontRatio

.margins

.outlineKeys

.blackKeyRatio

HID interfacing

.playKey

.sustainKey

.releaseKey

Internal methods

.draw

.prAddBlink

.prDetectChromaKey

.prDrawChromatic

.prDrawDiatonic

.prDrawKey

.prDrawLeftKey

.prDrawMiddleKey

.prDrawRightKey

.prGetChromaticCaseSize

.prGetTimerColor

.prGetWhiteKeysNumber

.prUpdateBlinks

Examples

Simple setup example:( s.waitForBoot({ var win = Window.new( "", Rect(0, 400, 700, 300) ); var keyboard; // Using an Array to map key index // to a particular frequency var freqs = Scale.at(\chromatic).ratios * 220; freqs = freqs ++ 440; SynthDef(\GMKeyboard, { |out = 0, amp = 0.1, freq = 440| var snd = SinOsc.ar(freq, mul: amp); snd = snd * EnvGen.kr(Env.perc); Out.ar(0, snd!2); }).add; keyboard = GMKeyboard() .margins_(8) .displayHighlights_(true) .mode_(\chromatic) .keyNumber_(13) .action_({ |index| Synth(\GMKeyboard, [\freq, freqs[index]]); }); win.layout_( HLayout() .margins_(0) .add(keyboard) ); win.front; CmdPeriod.doOnce({ win.close; }); }); )

Sustain mode example:

Synths are stored inside an array so they can be accessed when they are released. Pressing a key will play the synth, releasing a key will release the synths enveloppe.( s.waitForBoot({ var win = Window.new( "", Rect(0, 400, 700, 300) ); var keyboard, freqs, synths; freqs = Scale.at(\chromatic).ratios * 220; freqs = freqs ++ 440; synths = Array.fill(freqs.size, { nil }); SynthDef(\GMKBSustain, { |out = 0, amp = 0.1, freq = 440, gate = 1| var snd = SinOsc.ar(freq, mul: amp); var env = Env( [0, 1, 0], [0.005, 0.5], \lin, 1 ); snd = snd * EnvGen.kr( env, gate, doneAction: Done.freeSelf ); Out.ar(0, snd!2); }).add; keyboard = GMKeyboard() .margins_(8) .displayHighlights_(true) .mode_(\chromatic) .keyNumber_(13) .sustainMode_(true) .action_({ |index, sustain| if(sustain) { synths[index] = Synth(\GMKBSustain, [\freq, freqs[index]]); } { synths[index].set(\gate, 0); synths[index] = nil; }; }); win.layout_( HLayout() .margins_(0) .add(keyboard) ); win.front; CmdPeriod.doOnce({ win.close; }); }); )

HID interfacing example:

playKey, sustainKey and releaseKey allow to use GMKeyboard as an interface, using a HID.

The idea is that the GMKeyboard is responsible for the action, with the HID only 'pressing' the keys, thus triggering the action.

In fact, triggering the action is optionnal and will depend on the doAction argument of those methods. This allows you to animate the GMKeyboard with the HID without evaluating the action.

This example demonstrates how to manipulate the GMKeyboard with a MIDI keyboard:( s.waitForBoot({ var win = Window.new( "", Rect(0, 400, 700, 300) ); var keyboard, freqs, synths; // Create placeholders for MIDI instructions var midiNoteOnFunc, midiNoteOffFunc; // We need to offset midi notes so the left most // key corresponds to 0. // My keyboard starts with midi note 48: var noteOffset = 48; // Connect MIDI interfaces MIDIIn.connectAll; freqs = Scale.at(\chromatic).ratios * 220; freqs = freqs ++ 440; synths = Array.fill(freqs.size, { nil }); SynthDef(\GMKBSustain, { |out = 0, amp = 0.1, freq = 440, gate = 1| var snd = SinOsc.ar(freq, mul: amp); var env = Env( [0, 1, 0], [0.005, 0.5], \lin, 1 ); snd = snd * EnvGen.kr( env, gate, doneAction: Done.freeSelf ); Out.ar(0, snd!2); }).add; keyboard = GMKeyboard() .margins_(8) .displayHighlights_(true) .mode_(\chromatic) .keyNumber_(13) .sustainMode_(true) .action_({ |index, sustain| if(sustain) { synths[index] = Synth(\GMKBSustain, [\freq, freqs[index]]); } { synths[index].set(\gate, 0); synths[index] = nil; }; }); // Assign MIDIFuncs: midiNoteOnFunc = MIDIFunc.noteOn({ |velocity, midiNote| // Converting midiNote as an index: midiNote = midiNote - noteOffset; // If midi note is in range, play it if(midiNote >= 0) { if(midiNote < keyboard.keyNumber) { // Call keyboard sustainKey, // asking it to perform the action keyboard.sustainKey(midiNote, true); // As an example, you could // only trigger the animation of the keyboard // without evaluating the action with: // keyboard.sustainNote(index, false); }; }; }); // Same with noteOff and releaseKey: midiNoteOffFunc = MIDIFunc.noteOff({ |velocity, midiNote| midiNote = midiNote - noteOffset; if(midiNote >= 0) { if(midiNote < keyboard.keyNumber) { keyboard.releaseKey(midiNote, true); }; }; }); win.layout_( HLayout() .margins_(0) .add(keyboard) ); win.front; CmdPeriod.doOnce({ // Free MIDIFuncs midiNoteOnFunc.free; midiNoteOffFunc.free; win.close; }); }); )