Skip to content

Commit

Permalink
Merge pull request #27 from GoogleChrome/0.1.7-dev
Browse files Browse the repository at this point in the history
README nits
  • Loading branch information
hoch authored Oct 25, 2016
2 parents 61c03fa + 28d7532 commit 6662069
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Omnitone is a robust implementation of [FOA (first-order-ambisonic)](https://en.wikipedia.org/wiki/Ambisonics) decoder with binaural rendering written in Web Audio API. Its decoding process is based on multiple gain nodes for ambisonic gain matrix and convolutions for [HRTF](https://en.wikipedia.org/wiki/Head-related_transfer_function) binaural rendering, ensuring the optimum performance.

See Omnitone in action:
- __[Project Home](https://googlechrome.github.io/omnitone/#home)__
- __[JauntVR Gallery: Music](https://www.jauntvr.com/lobby/MusicLobby)__

The implementation of Omnitone is based on the [Google spatial media](https://github.com/google/spatial-media) specification. The input audio stream must be configured to ACN channel layout with SN3D normalization.

- [Installation](#installation)
Expand All @@ -13,6 +17,7 @@ The implementation of Omnitone is based on the [Google spatial media](https://gi
+ [FOAPhaseMatchedFilter](#foaphasematchedfilter)
+ [FORVirtualSpeaker](#forvirtualspeaker)
- [Building](#building)
- [Test](#test)
- [Audio Codec compatibility](#audio-codec-compatibility)
- [Related Resources](#related-resouces)

Expand Down Expand Up @@ -199,6 +204,11 @@ npm run build-all # build a minified library and copy static resources.
```


## Test

Currently there is no sane way of testing web applications built with Web Audio API in the automated setting (e.g. Travis CI). To run unit tests locally, fire up the web server and load the index HTML page in the the `test` directory.


## Audio Codec Compatibility

Omnitone is designed to run any browser that supports Web Audio API, however, it does not address the incompatibility issue around various media codecs in the browsers. At the time of writing, the decoding of compressed multichannel audio via `<video>` or `<audio>` elements is not fully supported by the majority of mobile browsers.
Expand Down

0 comments on commit 6662069

Please sign in to comment.