speaker-calibration 2.0.0 → 2.1.0

package/.eslintignore

@@ -0,0 +1,72 @@
+# ignore all files starting with . or ~
+.*
+~*
+
+# ignore tests
+**/__tests__/**
+
+# ignore node/grunt dependency directories
+node_modules/
+
+# ignore dist files
+dist/
+
+# ignore composer vendor directory
+/vendor
+
+# ignore components loaded via Bower
+/bower_components
+
+# ignore jekyll build directory
+/_site
+
+# ignore OS generated files
+ehthumbs.db
+Thumbs.db
+
+# ignore Editor files
+*.sublime-project
+*.sublime-workspace
+*.komodoproject
+
+# ignore log files and databases
+*.log
+*.sql
+*.sqlite
+
+# ignore compiled files
+*.com
+*.class
+*.dll
+*.exe
+*.o
+*.so
+
+# ignore packaged files
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# ignore private/secret files
+*.der
+*.key
+*.pem
+
+# --------------------------------------------------------
+# BEGIN Explictly Allowed Files (i.e. do NOT ignore these)
+# --------------------------------------------------------
+
+# track these files, if they exist
+!.gitignore
+!.editorconfig
+!.phpcs.xml.dist
+!.env.example
+!.eslintrc.json
+!.prettierrc.json
+!.eslintignore
+!.prettierignore

package/.eslintrc.json

@@ -0,0 +1,40 @@
+{
+  "env": {
+    "browser": true,
+    "es2021": true
+  },
+  "extends": ["airbnb-base", "prettier", "plugin:compat/recommended"],
+  "plugins": ["no-floating-promise", "jsdoc"],
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "rules": {
+    "no-console": 1, //TODO: set to 1 in final submission
+    "class-methods-use-this": 1, //TODO: set to 1 in final submission
+    "require-jsdoc": [
+      "error",
+      {
+        "require": {
+          "FunctionDeclaration": true,
+          "MethodDefinition": true,
+          "ClassDeclaration": true,
+          "ArrowFunctionExpression": true,
+          "FunctionExpression": true
+        }
+      }
+    ],
+    "no-floating-promise/no-floating-promise": 2
+  },
+  "settings": {
+    "polyfills": [
+      "Promise",
+      "Array.from",
+      "Object.fromEntries",
+      "navigator.mediaDevices",
+      "AudioContext",
+      "MediaRecorder",
+      "URLSearchParams"
+    ]
+  }
+}

package/.gitignore

@@ -0,0 +1,78 @@
+# Ignore files without extentions
+*
+!/**/
+!*.*
+
+# ignore all files starting with . or ~
+.*
+~*
+
+# ignore node/grunt dependency directories
+node_modules/
+
+# ignore composer vendor directory
+/vendor
+
+# ignore components loaded via Bower
+/bower_components
+
+# ignore jekyll build directory
+/_site
+
+# ignore OS generated files
+ehthumbs.db
+Thumbs.db
+
+# ignore Editor files
+*.sublime-project
+*.sublime-workspace
+*.komodoproject
+
+# ignore log files and databases
+*.log
+*.sql
+*.sqlite
+
+# ignore compiled files
+*.com
+*.class
+*.dll
+*.exe
+*.o
+*.so
+
+# ignore packaged files
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# ignore private/secret files
+*.der
+*.key
+*.pem
+
+# ingnore CSV files
+*.csv
+
+# ignore library files
+kfr-master
+kissfft
+
+# --------------------------------------------------------
+# BEGIN Explictly Allowed Files (i.e. do NOT ignore these)
+# --------------------------------------------------------
+
+# track these files, if they exist
+!.gitignore
+!.editorconfig
+!.phpcs.xml.dist
+!.env.example
+!.eslintrc.json
+!.prettierrc
+!.eslintignore
+!.prettierignore

package/.prettierignore

@@ -0,0 +1,70 @@
+# ignore all files starting with . or ~
+.*
+~*
+
+# ignore dist files
+dist/*
+!dist/example/
+
+# ignore node/grunt dependency directories
+node_modules/
+
+# ignore composer vendor directory
+/vendor
+
+# ignore components loaded via Bower
+/bower_components
+
+# ignore jekyll build directory
+/_site
+
+# ignore OS generated files
+ehthumbs.db
+Thumbs.db
+
+# ignore Editor files
+*.sublime-project
+*.sublime-workspace
+*.komodoproject
+
+# ignore log files and databases
+*.log
+*.sql
+*.sqlite
+
+# ignore compiled files
+*.com
+*.class
+*.dll
+*.exe
+*.o
+*.so
+
+# ignore packaged files
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# ignore private/secret files
+*.der
+*.key
+*.pem
+
+# --------------------------------------------------------
+# BEGIN Explictly Allowed Files (i.e. do NOT ignore these)
+# --------------------------------------------------------
+
+# track these files, if they exist
+!.gitignore
+!.editorconfig
+!.phpcs.xml.dist
+!.env.example
+!.eslintrc.json
+!.prettierrc.json
+!.eslintignore
+!.prettierignore

package/.prettierrc

@@ -0,0 +1,15 @@
+{
+    "$schema": "http://json.schemastore.org/prettierrc",
+    "arrowParens": "avoid",
+    "bracketSpacing": false,
+    "jsxBracketSameLine": false,
+    "jsxSingleQuote": false,
+    "printWidth": 100,
+    "proseWrap": "always",
+    "quoteProps": "as-needed",
+    "semi": true,
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false
+}

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 EasyEyes
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) 2022 EasyEyes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/README.md

@@ -1,133 +1,133 @@
-# Speaker-Calibration
-
-Speaker-Calibration provides a simple API for performing speaker calibration in Javascript. The
-Library has minimal dependencies and is designed to be used in the browser.
-
-[![Netlify Status](https://api.netlify.com/api/v1/badges/4662ab8c-dd4f-43ce-8e2d-add7a406300a/deploy-status)](https://app.netlify.com/sites/focused-hodgkin-0a6531/deploys)
-
-## Usage
-
-```html
-<!-- index.html --->
-...
-<body>
-  ...
-  <script src="https://unpkg.com/speaker-calibration@1.4.1/dist/main.js"></script>
-</body>
-```
-
-```javascript
-// speaker.js
-
-// initialize the chosen calibrator with the paramters, or pass no paramters to use default settings
-const calibrator = new ImpulseResponseCalibration({
-  numCaptures: 3,
-  numMLSPerCapture: 3,
-  download: false,
-});
-
-// pass the calibrator and speaker paramters to the startCalibration method (async)
-const invertedIR = await Speaker.startCalibration(
-  {
-    siteUrl: window.location.href.substring(0, location.href.lastIndexOf('/')),
-    targetElementId: 'display',
-  },
-  calibrator
-);
-```
-
-```javascript
-// listener.js
-
-window.listener = new speakerCalibrator.Listener({
-  targetElementId: 'display',
-});
-```
-
-## UML Design
-
-![UML Diagram of the Speaker Calibration Library](doc/Speaker-Calibration-UML-Diagram.png)
-
-## Impulse Response Calibration Logic
-
-![Logic Diagram of the Speaker Calibration Library](doc/sc-activity-diagram.png)
-
----
-
-## Contribution Guidelines
-
-_As of 07/29/2022_
-
-### Initial Setup
-
-1. `git clone https://github.com/EasyEyes/speaker-calibration.git`
-2. `cd speaker-calibration`
-3. `npm i`
-
-All outputs from the scripts/recipies below should be automatically placed in the `/dist` directory.
-This is what will be served once the library is published.
-
-#### Example
-
-In `/dist/example` you will find a small example app that uses the `speaker-calibration` library.
-
-#### Javascript
-
-In `package.json` you will see some key scripts:
-
-1.  `build:prod` tells webpack to build the library in production mode, outputing to `/dist`
-2.  `build:dev` tells webpack to build the library in development watch mode, outputing to `/dist`
-3.  `build:dev:analyze` tells webpack to build the library in development mode and open up a bundle
-    analysis page. Helpful for viewing the size of the library, broken down by individual modules
-    and/or dependencies.
-4.  `serve:dev` spins up an `express.js` server on port `3000` using `nodemon`. It serves the
-    `/dist` & `/dist/example` folders.
-5.  `build:wasm` calls the makefile recipe to clean, and rebuild the web assembly code (requires
-    emscripten installed, more details below)
-6.  `lint` runs `eslint` on all js files in the project
-7.  `lint:fix` lints and automatically fixes all js files in the project.
-8.  `build:doc` builds the documentation using `jsdoc`. Outputs to `/doc`
-
-Run `(2)` & `(3)` in seperate shell windows, with this setup you will be able to modify both the
-library and front end examples with hot reload built in. Run `(7)` precommit to keep you code
-standardized.
-
-#### CPP/WASM
-
-We are using [Emscripten](https://emscripten.org/) to compile the C++ code into a wasm file. Usage
-requires the installation of the Emscriten compiler. Instructions can be found on their website. In
-`makefile` you will see a few recipies:
-
-- `mlsGen_bind` compiles the cpp files to wasm, generating a modularized javascript "glue" file,
-  using embind. This is the current build target
-- `mlsGen_module` compiles the cpp files to wasm, generating a modularized javascript "glue" file.
-- `mlsGen_wasm` compiles the cpp file to a stand-alone wasm without a javascript "clue" file.
-- `clean` cleans up and generated code
-- `rebuild` cleans and rebuilds the output. Run this after making changes to the cpp files.
-
-#### Documentation
-
-We use [jsdoc](https://jsdoc.app/) standards to document our library.
-
-#### Linting
-
-We use [ESLint](https://eslint.org/) to lint our code and enforce best practices. We are currently
-using [AirBnB's JavaScript Style Guide](https://airbnb.io/javascript/)
-
-#### Styling
-
-We use [Prettier](https://prettier.io/) to format our code.
-
----
-
-### Deployment
-
-- Changes publshed to `main` will automatically trigger a deploy on the `netlify` project. This
-  deployment is only relevant to the `example` app, it will not make any changes to any others using
-  the library.
-- `speaker-calibration` is library that is published to [npm](https://www.npmjs.com/). This means
-  that in order to make your changes 'live' a new version of the library needs to be published.
-  Conveniently, there exists an npm package [np](https://www.npmjs.com/package/np) which provides a
-  lot of helpful abstractions and UI elements when dealing with npm.
-- Once a new version of the library is published, it is then live for anyone to use by bumping the
-  version they're using up to the newest release.
+# Speaker-Calibration
+
+Speaker-Calibration provides a simple API for performing speaker calibration in Javascript. The
+Library has minimal dependencies and is designed to be used in the browser.
+
+[![Netlify Status](https://api.netlify.com/api/v1/badges/4662ab8c-dd4f-43ce-8e2d-add7a406300a/deploy-status)](https://app.netlify.com/sites/focused-hodgkin-0a6531/deploys)
+
+## Usage
+
+```html
+<!-- index.html --->
+...
+<body>
+  ...
+  <script src="https://unpkg.com/speaker-calibration@1.4.1/dist/main.js"></script>
+</body>
+```
+
+```javascript
+// speaker.js
+
+// initialize the chosen calibrator with the paramters, or pass no paramters to use default settings
+const calibrator = new ImpulseResponseCalibration({
+  numCaptures: 3,
+  numMLSPerCapture: 3,
+  download: false,
+});
+
+// pass the calibrator and speaker paramters to the startCalibration method (async)
+const invertedIR = await Speaker.startCalibration(
+  {
+    siteUrl: window.location.href.substring(0, location.href.lastIndexOf('/')),
+    targetElementId: 'display',
+  },
+  calibrator
+);
+```
+
+```javascript
+// listener.js
+
+window.listener = new speakerCalibrator.Listener({
+  targetElementId: 'display',
+});
+```
+
+## UML Design
+
+![UML Diagram of the Speaker Calibration Library](doc/Speaker-Calibration-UML-Diagram.png)
+
+## Impulse Response Calibration Logic
+
+![Logic Diagram of the Speaker Calibration Library](doc/sc-activity-diagram.png)
+
+---
+
+## Contribution Guidelines
+
+_As of 07/29/2022_
+
+### Initial Setup
+
+1. `git clone https://github.com/EasyEyes/speaker-calibration.git`
+2. `cd speaker-calibration`
+3. `npm i`
+
+All outputs from the scripts/recipies below should be automatically placed in the `/dist` directory.
+This is what will be served once the library is published.
+
+#### Example
+
+In `/dist/example` you will find a small example app that uses the `speaker-calibration` library.
+
+#### Javascript
+
+In `package.json` you will see some key scripts:
+
+1.  `build:prod` tells webpack to build the library in production mode, outputing to `/dist`
+2.  `build:dev` tells webpack to build the library in development watch mode, outputing to `/dist`
+3.  `build:dev:analyze` tells webpack to build the library in development mode and open up a bundle
+    analysis page. Helpful for viewing the size of the library, broken down by individual modules
+    and/or dependencies.
+4.  `serve:dev` spins up an `express.js` server on port `3000` using `nodemon`. It serves the
+    `/dist` & `/dist/example` folders.
+5.  `build:wasm` calls the makefile recipe to clean, and rebuild the web assembly code (requires
+    emscripten installed, more details below)
+6.  `lint` runs `eslint` on all js files in the project
+7.  `lint:fix` lints and automatically fixes all js files in the project.
+8.  `build:doc` builds the documentation using `jsdoc`. Outputs to `/doc`
+
+Run `(2)` & `(3)` in seperate shell windows, with this setup you will be able to modify both the
+library and front end examples with hot reload built in. Run `(7)` precommit to keep you code
+standardized.
+
+#### CPP/WASM
+
+We are using [Emscripten](https://emscripten.org/) to compile the C++ code into a wasm file. Usage
+requires the installation of the Emscriten compiler. Instructions can be found on their website. In
+`makefile` you will see a few recipies:
+
+- `mlsGen_bind` compiles the cpp files to wasm, generating a modularized javascript "glue" file,
+  using embind. This is the current build target
+- `mlsGen_module` compiles the cpp files to wasm, generating a modularized javascript "glue" file.
+- `mlsGen_wasm` compiles the cpp file to a stand-alone wasm without a javascript "clue" file.
+- `clean` cleans up and generated code
+- `rebuild` cleans and rebuilds the output. Run this after making changes to the cpp files.
+
+#### Documentation
+
+We use [jsdoc](https://jsdoc.app/) standards to document our library.
+
+#### Linting
+
+We use [ESLint](https://eslint.org/) to lint our code and enforce best practices. We are currently
+using [AirBnB's JavaScript Style Guide](https://airbnb.io/javascript/)
+
+#### Styling
+
+We use [Prettier](https://prettier.io/) to format our code.
+
+---
+
+### Deployment
+
+- Changes publshed to `main` will automatically trigger a deploy on the `netlify` project. This
+  deployment is only relevant to the `example` app, it will not make any changes to any others using
+  the library.
+- `speaker-calibration` is library that is published to [npm](https://www.npmjs.com/). This means
+  that in order to make your changes 'live' a new version of the library needs to be published.
+  Conveniently, there exists an npm package [np](https://www.npmjs.com/package/np) which provides a
+  lot of helpful abstractions and UI elements when dealing with npm.
+- Once a new version of the library is published, it is then live for anyone to use by bumping the
+  version they're using up to the newest release.

package/__mocks__/fileMock.js

@@ -0,0 +1 @@
+module.exports = 'test-file-stub';

package/__mocks__/styleMock.js

@@ -0,0 +1 @@
+module.exports = {};

package/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [['@babel/preset-env', {targets: {node: 'current'}}]],
+};

package/coverage/clover.xml

@@ -0,0 +1,71 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<coverage generated="1650991329939" clover="3.2.0">
+  <project timestamp="1650991329939" name="All files">
+    <metrics statements="62" coveredstatements="45" conditionals="8" coveredconditionals="7" methods="6" coveredmethods="6" elements="76" coveredelements="58" complexity="0" loc="62" ncloc="62" packages="1" files="1" classes="1"/>
+    <file name="PythonServerInterface.js" path="/Users/hugo/Desktop/dev/easyeyes/speaker-calibration/src/server/PythonServerInterface.js">
+      <metrics statements="62" coveredstatements="45" conditionals="8" coveredconditionals="7" methods="6" coveredmethods="6"/>
+      <line num="1" count="1" type="stmt"/>
+      <line num="2" count="1" type="stmt"/>
+      <line num="3" count="1" type="stmt"/>
+      <line num="4" count="1" type="stmt"/>
+      <line num="5" count="1" type="stmt"/>
+      <line num="6" count="1" type="stmt"/>
+      <line num="7" count="1" type="cond" truecount="1" falsecount="0"/>
+      <line num="8" count="1" type="stmt"/>
+      <line num="9" count="1" type="stmt"/>
+      <line num="10" count="1" type="stmt"/>
+      <line num="11" count="1" type="stmt"/>
+      <line num="12" count="1" type="stmt"/>
+      <line num="13" count="1" type="cond" truecount="1" falsecount="0"/>
+      <line num="14" count="2" type="stmt"/>
+      <line num="15" count="2" type="stmt"/>
+      <line num="16" count="2" type="stmt"/>
+      <line num="17" count="2" type="stmt"/>
+      <line num="18" count="2" type="stmt"/>
+      <line num="19" count="2" type="stmt"/>
+      <line num="20" count="2" type="stmt"/>
+      <line num="21" count="2" type="stmt"/>
+      <line num="22" count="1" type="stmt"/>
+      <line num="23" count="1" type="cond" truecount="2" falsecount="0"/>
+      <line num="24" count="1" type="stmt"/>
+      <line num="25" count="1" type="stmt"/>
+      <line num="26" count="1" type="stmt"/>
+      <line num="27" count="1" type="stmt"/>
+      <line num="28" count="1" type="stmt"/>
+      <line num="29" count="2" type="stmt"/>
+      <line num="30" count="2" type="cond" truecount="1" falsecount="0"/>
+      <line num="31" count="1" type="stmt"/>
+      <line num="32" count="1" type="stmt"/>
+      <line num="33" count="1" type="stmt"/>
+      <line num="34" count="1" type="cond" truecount="0" falsecount="1"/>
+      <line num="35" count="0" type="stmt"/>
+      <line num="36" count="0" type="stmt"/>
+      <line num="37" count="0" type="stmt"/>
+      <line num="38" count="0" type="stmt"/>
+      <line num="39" count="0" type="stmt"/>
+      <line num="40" count="0" type="stmt"/>
+      <line num="41" count="0" type="stmt"/>
+      <line num="42" count="0" type="stmt"/>
+      <line num="43" count="0" type="stmt"/>
+      <line num="44" count="0" type="stmt"/>
+      <line num="45" count="0" type="stmt"/>
+      <line num="46" count="0" type="stmt"/>
+      <line num="47" count="0" type="stmt"/>
+      <line num="48" count="2" type="stmt"/>
+      <line num="49" count="2" type="cond" truecount="1" falsecount="0"/>
+      <line num="50" count="2" type="cond" truecount="1" falsecount="0"/>
+      <line num="51" count="2" type="stmt"/>
+      <line num="52" count="2" type="stmt"/>
+      <line num="53" count="0" type="stmt"/>
+      <line num="54" count="0" type="stmt"/>
+      <line num="55" count="2" type="stmt"/>
+      <line num="56" count="0" type="stmt"/>
+      <line num="57" count="0" type="stmt"/>
+      <line num="58" count="2" type="stmt"/>
+      <line num="59" count="2" type="stmt"/>
+      <line num="60" count="1" type="stmt"/>
+      <line num="61" count="1" type="stmt"/>
+      <line num="62" count="1" type="stmt"/>
+    </file>
+  </project>
+</coverage>