Using wasm to accelerate PixelManipulation.js

README.md

@@ -578,3 +578,22 @@ sequencer2.run();
 This method returns an object which defines the name and inputs of the modules. If a module name (hyphenated) is passed in the method, then only the details of that module are returned.
 
 The `notify` function takes two parameters `msg` and `id`, former being the message to be displayed on console (in case of CLI and node ) and a HTML component(in browser). The id is optional and is useful for HTML interface to give appropriate IDs.
+
+## Using WebAssembly for heavy pixel processing
+
+As of now, any of the modules, which uses changePixel function uses wasm as well. Both node and browser code use WebAssembly and the only region of fallback to the initial code is the one under browserified unit tests.
+
+The main advantage we get using wasm is blazing fast speed attained in processing pixels for many modules that is very clear from the benchmarks itself.
+
+The only limitation encountered was that the browser and node code for implementing wasm had to be written separately. This is because in browser we use ```fetch``` and in node we use ```fs``` module which both can't be used in other environment.
+
+Also, one can toggle between the two modes, the wasm one and the non-wasm in the following way:
+
+```js
+let sequencer = ImageSequencer({useWasm:true}) // for wasm mode or
+
+let sequencer = ImageSequencer({useWasm:false}) //for non-wasm mode or simply
+
+let sequencer = ImageSequencer() // also for non-wasm mode
+
+```

examples/demo.js

@@ -6,7 +6,7 @@ var defaultHtmlSequencerUi = require('./lib/defaultHtmlSequencerUi.js'),
   insertPreview = require('./lib/insertPreview.js');
 
 window.onload = function() {
-  sequencer = ImageSequencer();
+  sequencer = ImageSequencer({useWasm:true});
 
   function refreshOptions() {
     // Load information of all modules (Name, Inputs, Outputs)

examples/lib/insertPreview.js

@@ -1,6 +1,6 @@
 function generatePreview(previewStepName, customValues, path, selector) {
 
-  var previewSequencer = ImageSequencer();
+  var previewSequencer = ImageSequencer({useWasm:true});
   function insertPreview(src) {
     var img = document.createElement('img');
     img.classList.add('img-thumbnail');

examples/replace.html

@@ -52,7 +52,7 @@ <h4>sequencer.replaceImage('#pencils','invert');</h4>
 
     <script>
 
-      var sequencer = ImageSequencer();
+      var sequencer = ImageSequencer({useWasm:true});
       document.querySelector('#pencils').onclick = function() {
         sequencer.replaceImage('#pencils','invert');
       }

index.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 require('./src/ImageSequencer');
-sequencer = ImageSequencer({ ui: false });
+sequencer = ImageSequencer({ ui: false,useWasm:true });
 var fs = require('fs');
 var program = require('commander');
 var utils = require('./src/CliUtils');