Merge pull request #7 from dlepaux/dev

fix due to the example
dlepaux · Mar 18, 2018 · d5bc177 · d5bc177
2 parents b7bd67c + b821d96
commit d5bc177
Show file tree

Hide file tree

Showing 20 changed files with 93 additions and 393 deletions.
diff --git a/.npmignore b/.npmignore
@@ -2,7 +2,6 @@ test
 node_modules
 .nyc_output
 coverage
-example
 doc
 .coveralls.yml
 .editorconfig

diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
 [![Coverage Status](https://coveralls.io/repos/github/dlepaux/realtime-bpm-analyzer/badge.svg?branch=master)](https://coveralls.io/github/dlepaux/realtime-bpm-analyzer?branch=master)
 [![npm](https://img.shields.io/npm/l/express.svg)]()
 
-This tool allow to compute the BPM (Beats Per minutes) in real time, of a song on an <audio></audio> or <video></video> node thanks to the [WebAudioAPI](https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API).
+This tool allow to compute the BPM (Beats Per minutes) in real time, of a song on an `<audio></audio>` or `<video></video>` node thanks to the [WebAudioAPI](https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API).
 
 Please, note that the main use case for this tool, is to get the BPM **during** the video / audio **play**. In fact, it pre-compute datas instead to store the entire AudioBuffer in memory. So it can quickly return BPM.
 
@@ -49,12 +49,17 @@ Please, note that the main use case for this tool, is to get the BPM **during**
             console.log('bpm', bpm);
         }
     });
-    // Attach realTime function to audioprocess event
+    // Attach realTime function to audioprocess event.inputBuffer (AudioBuffer)
     scriptProcessorNode.onaudioprocess = function (e) {
-        onAudioProcess.analyze(e);
+        onAudioProcess.analyze(e.inputBuffer);
     };
     ```
 
+## Example
+
+You can find here [a functionnal example](https://github.com/dlepaux/realtime-bpm-analyzer-example) of this tool.
+
+
 ## Technical approch
 
 This tool has been largely inspired by the [Tornqvist project](https://github.com/tornqvist/bpm-detective).
@@ -79,3 +84,5 @@ This tool is designed to detect BPM by detecting all peaks for all thresolds, be
 
 This library was been inspired from [Tornqvist project](https://github.com/tornqvist/bpm-detective) which also based on [Joe Sullivan's algorithm](http://joesul.li/van/beat-detection-using-web-audio/). Thank you to both of them
 
+## Todo
+- Add controls
diff --git a/example/app/app.js b/example/app/app.js
diff --git a/example/app/assets/index.html b/example/app/assets/index.html
diff --git a/example/app/assets/media/new_order-blue_monday.mp3 b/example/app/assets/media/new_order-blue_monday.mp3
diff --git a/example/app/scss/app.scss b/example/app/scss/app.scss
diff --git a/example/brunch-config.coffee b/example/brunch-config.coffee
diff --git a/example/package.json b/example/package.json
diff --git a/example/public/.gitkeep b/example/public/.gitkeep
diff --git a/example/public/css/master.css b/example/public/css/master.css
diff --git a/example/public/css/master.css.map b/example/public/css/master.css.map
diff --git a/example/public/index.html b/example/public/index.html