Как создать клавиатуру фортепиано с помощью ванильного 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-файлы в заголовке:

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

Мы даем ему имя id, чтобы мы могли ссылаться на него позже, когда мы создадим клавиатуру с помощью JS. Мы можем запустить наш JS-код, также вызвав его в теле:

playKeyboard()

Мы используем playKeyboard.js как одну большую функцию. Он запустится, как только браузер дойдет до этой строки кода и сгенерирует полностью рабочую клавиатуру в элементе с

id = “keyboard”.

Первые несколько строк playKeyboard.js настраивают функциональность мобильного устройства (необязательно) и создают новый AudioSynth()объект. Мы используем этот объект для вызова методов audiosynth.js, с которыми мы связывались ранее. Вначале мы используем один из этих методов, чтобы установить громкость звука.

В строке 11 мы устанавливаем положение средней C на 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 октавы ниже средней C.

Обратите внимание, что нет «плоских» ключей. Каждая нота представлена ​​диезом.

Чтобы наша фортепианная клавиатура функционировала, мы должны подготовить таблицу обратного просмотра, в которой мы переключаем key: valueпары так, чтобы играемая нота стала клавишей, а код клавиши стал значением.

Нам нужна такая таблица, потому что мы хотим перебирать музыкальные ноты, чтобы легко создать клавиатуру.

Теперь вот где все может быть сложно: нам действительно нужны две таблицы обратного просмотра.

Мы используем одну таблицу для поиска метки, которую мы хотим отобразить для компьютерной клавиши, которую мы нажимаем для воспроизведения ноты (объявленной как 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!