Load a Sofa formatted HRTFs set from either a local or distant server. Instant access to closest match HRTF IRs {left,right} as an AudioBuffer object for any given position. First published as a subclass of the binauralFIR library.
Add the library to your node project:
npm install Ircam-RnD/serveSofaHrirand check the ./examples folder for implementation details. See binauralFIR for an example use-case.
You can consult the API documentation for the complete documentation.
The public server that hosts a database of individual HRTFs is available for beta-testers only and will open to public in 2016.
The ServerDataBase retrieves a catalogue from a SOFA server. From the
catalogue, it get URLs matching optional filters: data-base, sample-rate,
and any free pattern.
You can use any HRTF data-set that follows the SOFA standard, in JSON format, using finite impulse responses (FIR). Second-order sections (SOS) are not supported, yet. See the examples HRTF directory for a few samples.
The source code is in the src directory, in ES2015 standard. npm run compile with Babel to the dist directory. Note that there is a
.babelrc file. npm run bundle runs the linters, the tests,
generates the documentation, and compiles the code.
Commit the source files to the branch develop, and update the version in
package.json if this is intended to be a release.
On the master branch, merge from the develop branch. Generate and
commit the documentation and the distribution files. Put a release tag that
corresponds to the version in package.json.
On the gh-pages branch, merge from the master branch. Commit the
examples, and the extra files (audio and HRTF set files).
npm run lint to check that the code conforms with .eslintrc and
.jscsrc files. The rules derive from AirBnB with these
major points:
- ES2015
- no
'use strict'globally (already there via babel) - enforce curly braces (
if,for, etc.) - allow spaces and new lines, with fewer requirements: use them for clarity
For any function or method, there is at least a test. The hierarchy in the test directory is the same as in the src directory.
npm run testfor all automated testsnpm run test-listenfor supervised listening tests. The test files must end with_listen.jsnpm run test-issuesfor unsolved issues. The issues may depend on the host: operating system, user-agent, sound-device, sample-rate, etc. The test files must end with_issues.js. Once an issue is solved, the corresponding tests are added to the automated test set.npm run test-browserstarts a server for running the tests in any browser.
Examples for specific testing, when developing or resolving an issue:
browserify test/geometry/test_coordinates.js -t babelify | tape-runin a headless browserbrowserify test/geometry/test_coordinates.js -t babelify | testling -ufor an URL to open in any browser
Document any public function and method with JSDoc, and generate the HTML
pages with npm run doc. At this point, neither
jsdoc nor
esdoc gives perfect
transcription. (See the jsdoc.json and esdoc.json files.)
This module is released under the BSD-3-Clause license.
This research was developed by both Acoustic And Cognitive Spaces and Analysis of Musical Practices IRCAM research teams. A previous version was part of the WAVE project, funded by ANR (French National Research Agency). The current version, supporting multiple sources and a listener, HRTFs SOFA format and the access to a HRTF server, is part of the CoSiMa project, funded by ANR.The HRTF server and efforts for standardization of the HRTF SOFA format (AES69 standard) benefited from the financial support of the Bili project (French funding program FUI).