Processing node which spatializes an incoming audio stream in three-dimensional space for binaural audio.
The binauralModeled node provides binaural listening to the user with three simple steps. The novelty of this library is that it permits to use your own modeled HRTF dataset. This node implements the minimum-phase and pure delay synthesis technique. This library can be used as a regular node - AudioNode - inside the Web Audio API. You can connect the native nodes to the binauralModeled node by using the connect method to binauralModeled.input:
nativeNode.connect(binauralModeled.input);
binauralModeled.connect(audioContext.destination);We provide a modeled HRTF dataset example provided by IRCAM in the /examples/snd/complete_hrtf_modeled.js file.
Load binauralModeled.js, for instance in your html file by using:
<script src="binuralmodeled.min.js"></script>
<!-- https://github.com/Ircam-RnD/buffer-loader We need a way to load and decode the HRTF files, so we use this lib -->
<script src="buffer-loader.min.js"></script>
<!-- https://github.com/Ircam-RnD/player - We use this player to play a sound -->
<script src="player.min.js"></script>
<!-- You can find the file with the HRTF dataset in /examples/snd/complete_hrtfs_modeled.js folder.-->
<script src ="complete_hrtfs_modeled.js"></script> // We need an audio context
var audioContext = new AudioContext();
var targetNode = audioContext.destination;
//Create Audio Nodes
var player = createPlayer();
var binauralModeledNode = createBinauralModeled();
// Set HRTF dataset (it is possible to find a dataset example in the /examples/snd/complete_hrtf_modeled.js folder)
binauralModeledNode.HRTFDataset = hrtfs;
// Connect Audio Nodes
player.connect(binauralModeledNode.input);
binauralModeledNode.connect(targetNode);
// Set the position of the virtual source to -45° azimuth - 45° on your left -, distance of 1 meter and elevation of 10º
binauralModeledNode.setPosition(-45, 10, 1);
// Load player file
bufferLoader.load('/examples/snd/breakbeat.wav').then(function(buffer){
player.setBuffer(buffer);
player.enableLoop(true);
player.start();
})
As this library allow you to use your own modeled HRTF Dataset, if you want to use your dataset in the library you have to follow the following format:
| Data | Description |
|---|---|
azimuth |
Azimuth in degrees: from 0 to -180 for source on your left, and from 0 to 180 for source on your right |
distance |
Distance in meters |
elevation |
Elevation in degrees: from 0 to 90 for source above your head, 0 for source in front of your head, and from 0 to -90 for source below your head) |
itd |
Delay value in ms. The left delay and right delay are calculated as: "left delay = offset + ITD / 2" and "right delay = offset - ITD / 2" where offset is an offset to guarantee that the delays are positive (casual). |
iir_coeffs_left |
Array of biquad coefficients for the left ear. |
iir_coeffs_right |
Array of biquad coefficients for the right ear. |
This data must be provided inside an Array of Objects, like this example:
[
{
'azimuth': 0,
'distance': 1,
'elevation': -40,
'itd': 0,
'iir_coeffs_left': [
0.65549,
-1.7477,
0.88655,
-1.7006,
0.83541,
-1.2725,
0.85948,
-1.3682,
0.71943,
-1.9479,
0.95212,
-1.9484,
0.95334,
-1.9382,
0.96228,
-1.9422,
0.96604,
-0.53165,
0.8805,
-0.7819,
0.78236,
-0.14235,
0.43518,
0.10004,
0.78684,
],
'iir_coeffs_right': [
0.65549,
-1.7477,
0.88655,
-1.7006,
0.83541,
-1.2725,
0.85948,
-1.3682,
0.71943,
-1.9479,
0.95212,
-1.9484,
0.95334,
-1.9382,
0.96228,
-1.9422,
0.96604,
-0.53165,
0.8805,
-0.7819,
0.78236,
-0.14235,
0.43518,
0.10004,
0.78684,
]
}
]The binauralModeled object exposes the following API:
| Method | Description |
|---|---|
binauralModeled.connect() |
Connects the binauralModeledNode to the Web Audio graph |
binauralModeled.disconnect() |
Disconnect the binauralModeledNode from the Web Audio graph |
binauralModeled.HRTFDataset |
Set the modeled HRTF Dataset to be used with the virtual source. |
binauralModeled.setPosition(azimuth, elevation, distance) |
Set the position of the virtual source. |
binauralModeled.getPosition() |
Get the current position of the virtual source. |
binauralModeled.setCrossfadeDuration(duration) |
Set the duration of crossfading in miliseconds. |
binauralModeled.getCrossfadeDuration() |
Get the duration of crossfading in miliseconds. |
If grunt is not installed
$ npm install -g grunt-cliInstall all depencies in the module folder
$ npm installRun the server on 9001 port (you can change the port in the Grunfile.js)
$ grunt testRun the test via the web browser on https://localhost:9001/tests
This module is released under the BSD-3-Clause license.
This code has been developed from both Acoustic And Cognitive Spaces and Analysis of Musical Practices IRCAM research teams. It is also part of the WAVE project (https://wave.ircam.fr), funded by ANR (The French National Research Agency), ContInt program, 2012-2015.