Merge 26ab43f63a into b78390c2ab

Bumps [jquery](https://github.com/jquery/jquery) from 3.4.1 to 3.6.2.
- [Release notes](https://github.com/jquery/jquery/releases)
- [Commits](https://github.com/jquery/jquery/compare/3.4.1...3.6.2)

---
updated-dependencies:
- dependency-name: jquery
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.github/workflows/tests.yml

@@ -8,7 +8,7 @@ jobs:
     - name: Setup node
       uses: actions/setup-node@v2
       with:
-        node-version: '12'
+        node-version: '14'
         check-latest: true
     - name: Cache node modules
       uses: actions/cache@v2
@@ -33,7 +33,7 @@ jobs:
     - name: Setup node
       uses: actions/setup-node@v2
       with:
-        node-version: '12'
+        node-version: '14'
         check-latest: true
     - name: Cache node modules
       uses: actions/cache@v2
@@ -58,7 +58,7 @@ jobs:
     - name: Setup node
       uses: actions/setup-node@v2
       with:
-        node-version: '12'
+        node-version: '14'
         check-latest: true
     - name: Cache node modules
       uses: actions/cache@v2
@@ -83,7 +83,7 @@ jobs:
     - name: Setup node
       uses: actions/setup-node@v2
       with:
-        node-version: '12'
+        node-version: '14'
         check-latest: true
     - name: Cache node modules
       uses: actions/cache@v2
@@ -109,7 +109,7 @@ jobs:
     - name: Setup node
       uses: actions/setup-node@v2
       with:
-        node-version: '12'
+        node-version: '14'
         check-latest: true
     - name: Cache node modules
       uses: actions/cache@v2
@@ -134,7 +134,7 @@ jobs:
     - name: Setup node
       uses: actions/setup-node@v2
       with:
-        node-version: '12'
+        node-version: '14'
         check-latest: true
     - name: Cache node modules
       uses: actions/cache@v2
@@ -159,7 +159,7 @@ jobs:
     - name: Setup node
       uses: actions/setup-node@v2
       with:
-        node-version: '12'
+        node-version: '14'
         check-latest: true
     - name: Cache node modules
       uses: actions/cache@v2
@@ -184,7 +184,7 @@ jobs:
     - name: Setup node
       uses: actions/setup-node@v2
       with:
-        node-version: '12'
+        node-version: '14'
         check-latest: true
     - name: Cache node modules
       uses: actions/cache@v2

CONTRIBUTING.md

@@ -118,9 +118,9 @@ function ModuleName(options,UI) {
       ];
 ```
 ### Running a browser-only module in node
-If your module has browser specific code or you are consuming a dependency which does the `gl-context` api. We designed this api especially for webl based modules but since it runs the module in a headless browser, ti supports all browser specific APIs.
+If your module has browser specific code or you are consuming a dependency which does the `gl-context` API. We designed this api especially for web-based modules but since it runs the module in a headless browser, it supports all browser specific APIs.
 
-The api must be used in the following format
+The API must be used in the following format
 ```js
 var step = this;
 
@@ -197,7 +197,7 @@ There are four events in all:
 * `UI.onComplete(options.step)` must be emitted whenever the output of a draw call
 is ready. An argument, that is the DataURL of the output image must be passed in.
 * `UI.onRemove(options.step)` is emitted automatically and the module should not emit it.
-* `UI.notify(msg,id)` must be emmited when a notification has to be produced.
+* `UI.notify(msg,id)` must be emitted when a notification has to be produced.
 
 ### Name and description
 
@@ -244,7 +244,7 @@ Also, A module may have output values. These must be defined as shown above.
 
 ### Progress reporting
 
-The default "loading spinner" can be optionally overriden with a custom progress object to draw progress on the CLI, following is a basic module format for the same:
+The default "loading spinner" can be optionally overridden with a custom progress object to draw progress on the CLI, following is a basic module format for the same:
 
 ```js
 module.exports = function ModuleName(options,UI) {
@@ -279,7 +279,7 @@ module.exports = function ModuleName(options,UI) {
 }
 ```
 
-The `progressObj` parameter of `draw()` is not consumed unless a custom progress bar needs to be drawn, for which this default spinner should be stopped with `progressObj.stop()` and image-sequencer is informed about the custom progress bar with `progressObj.overrideFlag = true;` following which this object can be overriden with custom progress object.
+The `progressObj` parameter of `draw()` is not consumed unless a custom progress bar needs to be drawn, for which this default spinner should be stopped with `progressObj.stop()` and image-sequencer is informed about the custom progress bar with `progressObj.overrideFlag = true;` following which this object can be overridden with custom progress object.
 
 
 ### Module example
@@ -292,7 +292,7 @@ For help integrating, please open an issue.
 
 ## Meta Module
 
-IMAGE SEQUENCER supports "meta modules" -- modules made of other modules. The syntax and structure of these meta modules is very similar to standard modules. Sequencer can also genarate meta modules dynamically with the function `createMetaModule` which can be called in the following ways
+IMAGE SEQUENCER supports "meta modules" -- modules made of other modules. The syntax and structure of these meta modules is very similar to standard modules. Sequencer can also generate meta modules dynamically with the function `createMetaModule` which can be called in the following ways
 
 ```js
 
@@ -387,7 +387,7 @@ npx eslint <file path> --fix
 ```
 Be sure to not include the angular brackets(<>).
 
-Husky ensures automation of the above steps with git-hooks(eg. git add,git commit..). However we don't want to check and fix changes of the entire codebase with each commit and that the fixes made by eslint appear unstaged and require us to commit them  again and that is where lint-staged helps.
+Husky ensures automation of the above steps with git-hooks(eg. git add, git commit..). However we don't want to check and fix changes of the entire codebase with each commit and that the fixes made by eslint appear unstaged and require us to commit them  again and that is where lint-staged helps.
 
 If we want `husky` to not verify the commit and push it anyway, use `git commit -m "message" --no-verify.`
 
@@ -479,3 +479,13 @@ The following shell scripts are present in the `scripts/` directory.
  This script is safe to use directly because it separately clones the repo in a temporary directory.
 
   Arguments: None since it is a an *interactive* script, ie it asks the user for input.
+
+****
+
+# Comments
+
+1. Methods must be described using [JSDoc comments](https://devdocs.io/jsdoc/)
+2. Misc code comments should be inline unless it is a long sentence.
+3. No use of continuous tenses, no pronouns.
+4. No redundant comments.
+5. Each comment should start with an uppercase letter and end with a full stop.

examples/index.html

@@ -221,7 +221,6 @@
 
     <footer>
       <hr style="margin:20px;">
-      <center><button class="btn btn-default btn-sm" id="clear-cache">Clear offline cache</button></center>
       <div class="row">
         <div class="col-md-6">
           <h2>Need Help?</h2>
@@ -242,6 +241,7 @@
       </div>
       <div class="row">
         <p id="version-number-text">Loading Version Number</p>
+        <center><button class="btn btn-primary btn-sm" id="clear-cache">Clear offline cache</button></center>
       </div>
     </footer>
 

package.json

@@ -49,7 +49,6 @@
     "expr-eval": "^2.0.2",
     "fisheyegl": "^0.1.2",
     "font-awesome": "~4.7.0",
-    "geotiff": "^1.0.0-beta.6",
     "get-pixels": "~3.3.0",
     "gifshot": "^0.4.5",
     "glfx": "0.0.4",
@@ -62,9 +61,9 @@
     "imagemin-pngquant": "^9.0.1",
     "istanbul": "^0.4.5",
     "jasmine": "^4.0.2",
-    "jpegtran-bin": "^6.0.1",
+    "jpegtran-bin": "^7.0.0",
     "jquery": "^3.3.1",
-    "jsdom": "^19.0.0",
+    "jsdom": "^20.0.0",
     "jspdf": "^2.1.1",
     "jsqr": "^1.1.1",
     "lodash": "^4.17.11",
@@ -97,21 +96,21 @@
     "grunt-contrib-uglify-es": "^3.3.0",
     "grunt-contrib-watch": "^1.1.0",
     "grunt-text-replace": "^0.4.0",
-    "husky": "^7.0.0",
+    "husky": "^8.0.1",
     "image-filter-core": "~2.0.2",
     "image-filter-threshold": "~2.0.1",
     "jasmine-core": "^4.0.0",
     "jasmine-jquery": "^2.1.1",
     "jasmine-spec-reporter": "^7.0.0",
-    "jest": "^27.0.1",
+    "jest": "^29.0.0",
     "jest-puppeteer": "^6.0.0",
-    "lint-staged": "^12.1.3",
+    "lint-staged": "^13.0.0",
     "looks-same": "^7.0.0",
     "matchdep": "^2.0.0",
     "resemblejs": "^4.0.1",
     "tap-spec": "^5.0.0",
     "tape": "^5.2.0",
-    "tape-run": "^9.0.0",
+    "tape-run": "^10.0.0",
     "uglify-es": "^3.3.7"
   },
   "husky": {

src/modules/FisheyeGl/Module.js

@@ -1,63 +1,72 @@
 /*
 * Resolves Fisheye Effect
 */
+const _ = require('lodash');
 module.exports = function DoNothing(options, UI) {
 
   var output;
+  getPixels = require('get-pixels');
+  gl = require('fisheyegl');
+  
 
-  var gl = require('fisheyegl');
+  function draw(input, callback, progressObj) {
 
-  function draw(input, callback) {
+    progressObj.stop(true);
+    progressObj.overrideFlag = true;
 
     var step = this;
-
-    if (!options.inBrowser) {
-      require('../_nomodule/gl-context')(input, callback, step, options);
+    var curr = 0;
+    var isGif = input.src.includes('image/gif');
+    function changePixel(r, g, b, a) {
+      return [r, g, b, a];
     }
-    else {
-      // Create a canvas, if it doesn't already exist.
-      if (!document.querySelector('#image-sequencer-canvas')) {
+
+    
+    function extraManipulation(pixels, setRenderState, generateOutput) {
+      curr++;
+      const oldPixels = _.cloneDeep(pixels);
+      const getDataUri = require('../../util/getDataUri');
+      setRenderState(false); // Prevent rendering of final output image until extraManipulation completes.
+      
+      if (!options.inBrowser) {
+        require('../_nomodule/gl-context')(input, callback, step, options);
+      }
+      else {
+      
         var canvas = document.createElement('canvas');
         canvas.style.display = 'none';
-        canvas.setAttribute('id', 'image-sequencer-canvas');
+        canvas.setAttribute('id', 'image-sequencer-canvas' + curr.toString());
         document.body.append(canvas);
+        
+        var distorter = new FisheyeGl({
+          selector: '#image-sequencer-canvas' + curr.toString()
+        });
       }
-      else var canvas = document.querySelector('#image-sequencer-canvas');
-
-      distorter = FisheyeGl({
-        selector: '#image-sequencer-canvas'
+      getDataUri(pixels, input.format).then(dataUrl => {
+        require('./fisheye')(options, pixels, oldPixels, dataUrl, distorter, () => {
+          
+          setRenderState(true); // Allow rendering in the callback.
+          generateOutput();
+          
+        });
       });
-
-      // Parse the inputs
-      options.a = parseFloat(options.a) || distorter.lens.a;
-      options.b = parseFloat(options.b) || distorter.lens.b;
-      options.Fx = parseFloat(options.Fx) || distorter.lens.Fx;
-      options.Fy = parseFloat(options.Fy) || distorter.lens.Fy;
-      options.scale = parseFloat(options.scale) || distorter.lens.scale;
-      options.x = parseFloat(options.x) || distorter.fov.x;
-      options.y = parseFloat(options.y) || distorter.fov.y;
-
-      // Set fisheyegl inputs
-      distorter.lens.a = options.a;
-      distorter.lens.b = options.b;
-      distorter.lens.Fx = options.Fx;
-      distorter.lens.Fy = options.Fy;
-      distorter.lens.scale = options.scale;
-      distorter.fov.x = options.x;
-      distorter.fov.y = options.y;
-
-      // generate fisheyegl output
-      distorter.setImage(input.src, function() {
-
-        // this output is accessible to Image Sequencer
-        step.output = { src: canvas.toDataURL(), format: input.format };
-
-        // Tell Image Sequencer and UI that step has been drawn
-        callback();
-
-      });
-
     }
+
+    function output(image, datauri, mimetype, wasmSuccess) {
+      step.output = { src: datauri, format: mimetype, wasmSuccess, useWasm: options.useWasm };
+    }
+
+    return require('../_nomodule/PixelManipulation.js')(input, {
+      output: output,
+      ui: options.step.ui,
+      changePixel: changePixel,
+      extraManipulation: extraManipulation,
+      format: input.format,
+      image: options.image,
+      inBrowser: options.inBrowser,
+      callback: callback,
+      useWasm:options.useWasm
+    });
   }
 
   return {

src/modules/FisheyeGl/fisheye.js

@@ -0,0 +1,48 @@
+const pixelSetter = require('../../util/pixelSetter.js'),
+  getPixels = require('get-pixels');
+  
+module.exports = exports = function (options, pixels, oldPixels, url1, distorter, cb) {
+  // Parse the inputs
+  options.a = parseFloat(options.a) || distorter.lens.a;
+  options.b = parseFloat(options.b) || distorter.lens.b;
+  options.Fx = parseFloat(options.Fx) || distorter.lens.Fx;
+  options.Fy = parseFloat(options.Fy) || distorter.lens.Fy;
+  options.scale = parseFloat(options.scale) || distorter.lens.scale;
+  options.x = parseFloat(options.x) || distorter.fov.x;
+  options.y = parseFloat(options.y) || distorter.fov.y;
+
+  // Set fisheyegl inputs
+  distorter.lens.a = options.a;
+  distorter.lens.b = options.b;
+  distorter.lens.Fx = options.Fx;
+  distorter.lens.Fy = options.Fy;
+  distorter.lens.scale = options.scale;
+  distorter.fov.x = options.x;
+  distorter.fov.y = options.y;
+
+  distorter.setImage(url1, function() {
+    getPixels(distorter.getImage().src, function (err, distorted) {
+                
+      for (let x = 0; x < oldPixels.shape[0]; x++) {
+        for (let y = 0; y < oldPixels.shape[1]; y++) {
+                    
+                    
+          pixelSetter(
+            x,
+            y,
+            [
+              distorted.get(x, y, 0),
+              distorted.get(x, y, 1),
+              distorted.get(x, y, 2),
+              distorted.get(x, y, 3)
+            ],
+            pixels
+          );
+                    
+        }
+      }
+
+      if(cb) cb();
+    });
+  });
+};