Як побудувати клавіатуру для фортепіано за допомогою ванільного JavaScript

Створення гральної клавіатури на фортепіано може бути чудовим способом вивчити мову програмування (крім того, що це купа кумедних розваг). Цей підручник показує, як кодувати його за допомогою ванільного JavaScript без потреби в будь-яких зовнішніх бібліотеках або фреймворках.

Ось клавіатура для фортепіано на JavaScript, яку я зробив, якщо ви хочете спочатку перевірити кінцевий продукт.

Цей підручник передбачає, що ви добре знаєте JavaScript, як-от функції та обробку подій, а також знаєте HTML та CSS. В іншому випадку, він повністю дружній для початківців і орієнтований на тих, хто хоче вдосконалити свої навички JavaScript за допомогою проектного навчання (або просто хоче зробити класний проект!).

Клавіатура для фортепіано, яку ми робимо для цього проекту, базується на динамічно генерованій синтетичній клавіатурі, зробленій Кітом Вільямом Горвудом. Ми збільшимо кількість доступних клавіш до 4 октав та встановимо нові прив'язки клавіш.

Незважаючи на те, що його клавіатура може відтворювати звуки з інших інструментів, ми будемо робити все простими і просто дотримуватися фортепіано.

Ось кроки, які ми вживемо для вирішення цього проекту:

1. Отримайте робочі файли

2. Налаштуйте прив’язки клавіш

3. Сформувати клавіатуру

4. Обробляйте натискання клавіш

Давайте розпочнемо!

1. Отримайте робочі файли

Цей підручник використовуватиме такі файли:

· Audiosynth.js

· PlayKeyboard.js

Як вже згадувалося, ми будемо базувати клавіатуру на фортепіано на основі клавіатури Кіта. Звичайно, ми також запозичимо частину його коду, який він люб'язно дозволив audiosynth.js.

Ми включаємо audiosynth.js у playKeyboard.js (моя змінена версія деякого коду Кіта), який обробляє весь наш JavaScript. Цей підручник дає детальне пояснення в наступних розділах про основні моменти того, як код у цьому файлі створює повністю робочу клавіатуру піаніно.

Ми залишаємо файл audiosynth.js недоторканим, оскільки він несе повну відповідальність за генерацію звуку.

Код у цьому файлі відрізняє цю клавіатуру піаніно від інших, знайдених в Інтернеті, за допомогою Javascript для динамічного генерування відповідного звуку, коли користувач натискає клавішу. Таким чином, код не повинен завантажувати будь-які зовнішні аудіофайли.

Кіт уже дає пояснення того, як працює генерація звуку на своєму веб-сайті, тому ми не будемо вдаватися до деталей тут.

У двох словах, це передбачає використання Math.sin()функції в JS для створення синусоїдальних сигналів та їх трансформації, щоб вони звучали більше як справжні інструменти за допомогою якоїсь вигадливої ​​математики.

Створіть індексний HTML-файл і давайте зробимо посилання на JS-файли в заголовку:

В тілі ми можемо створити порожній елемент, який буде виконувати роль «контейнера» для клавіатури:

Ми даємо йому ідентифікатор, щоб ми могли посилатися на нього пізніше, коли створюємо клавіатуру за допомогою JS. Ми можемо запустити наш код JS, також викликавши його в тілі:

playKeyboard()

Ми використовуємо playKeyboard.js як одну велику функцію. Він запуститься, як тільки браузер дістанеться до цього рядка коду і сформує повністю робочу клавіатуру в елементі з

id = “keyboard”.

Перші кілька рядків playKeyboard.js налаштовують на функціональність мобільних пристроїв (необов’язково) і створюють новий AudioSynth()об’єкт. Ми використовуємо цей об'єкт для виклику методів audiosynth.js, до яких ми посилалися раніше. Ми використовуємо один із цих методів на початку, щоб встановити гучність звуку.

У рядку 11 ми встановлюємо положення середньої С на 4-ту октаву.

2. Налаштування прив’язок клавіш

Перш ніж генерувати клавіатуру, нам слід налаштувати прив'язки клавіш, оскільки вони визначають, скільки клавіш слід генерувати.

Спочатку я хотів спробувати зіграти початкові ноти "Für Elise", тому вибрав діапазон 4 октави для загальної кількості 48 чорно-білих клавіш. Це вимагало майже кожної клавіші на моїй (ПК) клавіатурі, і ви можете сміливо включати менше.

Примітка попередження: У мене не найкращі прив’язки клавіш, тому вони можуть відчувати себе неінтуїтивними, коли ви насправді намагаєтесь грати. Можливо, це ціна спроби створити 4-октавну клавіатуру.

Щоб налаштувати прив’язку клавіш, спочатку створіть об’єкт, який використовуватиме код ключа як ключі, а нота, що відтворюватиметься як значення ключа (початковий рядок 15):

var keyboard = { /* ~ */ 192: 'C,-2', /* 1 */ 49: 'C#,-2', /* 2 */ 50: 'D,-2', /* 3 */ 51: 'D#,-2', //...and the rest of the keys } 

Коментарі позначають клавіші, які користувач може натискати на клавіатурі комп’ютера. Якщо користувач натискає клавішу тильди, тоді відповідний код клавіші становить 192. Ви можете отримати код клавіші за допомогою інструменту, такого як keycode.info.

Ключовим значенням є нота, яку потрібно відтворити і записати у форматі "нота, модифікатор октави", де модифікатор октави представляє відносну позицію октави з октави, що містить середину C. Наприклад, "C, -2" - нота C. 2 октави нижче середньої С.

Зверніть увагу, що немає `` плоских '' клавіш. Кожна нота представлена ​​"різкою".

Щоб наша клавіатура фортепіано функціонувала, ми повинні підготувати таблицю зворотного пошуку, де ми переключаємо key: valueпари таким чином, щоб нота, що відтворюється, стала ключовою, а код клавіші - значенням.

Така таблиця нам потрібна, оскільки ми хочемо переглядати музичні ноти, щоб легко генерувати нашу клавіатуру.

Ось де речі можуть стати складними: насправді нам потрібні 2 таблиці зворотного пошуку.

Ми використовуємо одну таблицю для пошуку ярлика, який ми хочемо відобразити для клавіші комп’ютера, який ми натискаємо, щоб відтворити ноту (оголошено як reverseLookupTextу рядку 164), а другу - для пошуку фактичної натиснутої клавіші (оголошено як reverseLookupу рядку 165).

Досвідчений може зрозуміти, що в обох таблицях пошуку в якості значень є коди ключів, то яка різниця між ними?

It turns out that (for reasons unknown to me) when you get a keycode that corresponds to a key and you try to use String.fromCharCode() method on that keycode, you don’t always get back the same string representing the pressed key.

For example, pressing left open bracket yields keycode 219 but when you actually try to convert the keycode back to a string using String.fromCharCode(219) it returns "Û". To get "[", you have to use key code 91. We replace the incorrect codes starting on line 168.

Getting the right keycode initially involved a bit of trial and error, but later I realized you can just use another function (getDispStr() on line 318) to force the correct string to be displayed.

The majority of the keys do behave properly but you can choose to start with a smaller keyboard so you don’t have to deal with incorrect keycodes.

3. Generate Keyboard

We start the keyboard generation process by selecting our element keyboard container with document.getElementById(‘keyboard’) on line 209.

On the next line, we declare the selectSound object and set the value property to zero to have audioSynth.js load the sound profile for piano. You may wish to enter a different value (can be 0-3) if you want to try out other instruments. See line 233 of audioSynth.js with Synth.loadSoundProfile for more details.

On line 216 with var notes, we retrieve the available notes for one octave (C, C#, D…B) from audioSynth.js.

We generate our keyboard by looping through each octave and then each note in that octave. For each note, we create a element to represent the appropriate key using document.createElement(‘div’).

To distinguish whether we need to create a black or white key, we look at the length of the note name. Adding a sharp sign makes the length of the string greater than one (ex. ‘C#’) which indicates a black key and vice versa for white.

For each key we can set a width, height, and an offset from the left based on key position. We can also set appropriate classes for use with CSS later.

Next, we label the key with the computer key we need to press to play its note and store it in another element. This is where reverseLookupText comes in handy. Inside the same , we also display the note name. We accomplish all of this by setting the label’s innerHTML property and appending the label to the key (lines 240-242).

label.innerHTML = '' + s + '' + '

' + n.substr(0,1) + '' + (__octave + parseInt(i)) + '' + (n.substr(1,1)?n.substr(1,1):'');

Similarly, we add an event listener to the key to handle mouse clicks (line 244):

thisKey.addEventListener(evtListener[0], (function(_temp) { return function() { fnPlayKeyboard({keyCode:_temp}); } })(reverseLookup[n + ',' + i]));

The first parameter evtListener[0] is a mousedown event declared much earlier on line 7. The second parameter is a function that returns a function. We need reverseLookup to get us the correct keycode and we pass that value as a parameter _temp to the inner function. We will not need reverseLookup to handle actual keydown events.

This code is pre-ES2015 (aka ES6) and the updated, hopefully clearer equivalent is:

const keyCode = reverseLookup[n + ',' + i]; thisKey.addEventListener('mousedown', () => { fnPlayKeyboard({ keyCode }); }); 

After creating and appending all necessary keys to our keyboard, we will need to handle the actual playing of a note.

4. Handle Key Presses

We handle key presses the same way whether the user clicks the key or presses the corresponding computer key through use of the function fnPlayKeyboard on line 260. The only difference is the type of event we use in addEventListener to detect the key press.

We set up an array called keysPressed in line 206 to detect what keys are being pressed/clicked. For simplicity, we will assume that a key being pressed can include it being clicked as well.

We can divide the process of handling key presses into 3 steps: adding the keycode of the pressed key to keysPressed, playing the appropriate note, and removing the keycode from keysPressed.

The first step of adding a keycode is easy:

keysPressed.push(e.keyCode);

where e is the event detected by addEventListener.

If the added keycode is one of the key bindings we assigned, then we call fnPlayNote() on line 304 to play the note associated with that key.

In fnPlayNote(), we first create a new Audio() element container for our note using the generate() method from audiosynth.js. When the audio loads, we can then play the note.

Lines 308-313 are legacy code and seem they can just be replaced by container.play(), though I have not done any extensive testing to see what the difference is.

Removing a key press is also quite straightforward, as you can just remove the key from the keysPressed array with the splice method on line 298. For more details, see the function called fnRemoveKeyBinding().

The only thing we have to watch out for is when the user holds down a key or multiple keys. We have to make sure that the note only plays once while a key is held down (lines 262-267):

var i = keysPressed.length; while(i--) { if(keysPressed[i]==e.keyCode) { return false; } } 

Returning false prevents the rest of fnPlayKeyboard() from executing.

Summary

We have created a fully functioning piano keyboard using vanilla JavaScript!

To recap, here are the steps we took:

  1. We set up our index HTML file to load the appropriate JS files and execute

    playKeyboard() in to generate and make the keyboard functional. We have a element with id= "keyboard" where the keyboard will be displayed on the page.

  2. In our JavaScript file playKeyboard.js, we set up our key bindings with keycodes as keys and musical notes as values. We also create two reverse lookup tables in which one is responsible for looking up the appropriate key label based on the note and the other for looking up the correct keycode.

  3. We dynamically generate the keyboard by looping through every note in each octave range. Each key is created as its own element. We use the reverse lookup tables to generate the key label and correct keycode. Then an event listener on mousedown uses it to call fnPlayKeyboard() to play the note. The

    keydown event calls the same function but does not need a reverse lookup table to get the keycode.

  4. We handle key presses resulting from either mouse clicks or computer key presses in 3 steps: add keycode of the pressed key to an array, play the appropriate note, and remove keycode from that array. We must be careful not to repeatedly play a note (from the beginning) while the user continuously holds down a key.

The keyboard is now fully functional but it may look a bit dull. I will leave the CSS part to you ?

Again, here is the JavaScript piano keyboard I made for reference.

If you want to learn more about web development and check out some other neat projects, visit my blog at 1000 Mile World.

Thanks for reading and happy coding!