newly compiled dist files

Bumps [lint-staged](https://github.com/okonet/lint-staged) from 12.3.5 to 12.3.7.
- [Release notes](https://github.com/okonet/lint-staged/releases)
- [Commits](https://github.com/okonet/lint-staged/compare/v12.3.5...v12.3.7)

---
updated-dependencies:
- dependency-name: lint-staged
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

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

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Jeffrey Warren <jeff@unterbahn.com>

.codecov.yml

@@ -0,0 +1,11 @@
+comment:
+  layout: "reach, diff, flags, files"
+  behavior: default
+  require_changes: false  # if true: only post the comment if coverage changes
+  require_base: no        # [yes :: must have a base report to post]
+  require_head: yes       # [yes :: must have a head report to post]
+  branches: null          # branch names that can post comment
+coverage:
+  status:
+    project: off
+    patch: off

.eslintignore

@@ -0,0 +1 @@
+dist/*

.eslintrc.js

@@ -0,0 +1,36 @@
+module.exports = {
+    'env': {
+        'browser': true,
+        'commonjs': true,
+        'es6': true,
+        'node': true
+    },
+    'extends': 'eslint:recommended',
+    'globals': {
+        'Atomics': 'readonly',
+        'SharedArrayBuffer': 'readonly'
+    },
+    'parserOptions': {
+        'ecmaVersion': 2018
+    },
+    'rules': {
+        'indent': ['error',2],
+        'linebreak-style': ['error','unix'],
+        'quotes': ['error','single'],
+        'semi': ['error','always'], //
+        'no-undef': 0,
+        'no-console': 'off',
+        'no-unused-vars': 'off',
+        'no-redeclare': 'off',
+        'no-inner-declarations':'off',
+        'no-empty':'off',
+        'no-mixed-spaces-and-tabs':'off',
+        'no-self-assign':'off',
+        'no-constant-condition':'off',
+        'no-dupe-keys':'off',
+        'space-infix-ops': ['error', {'int32Hint': false}], // Enforce spaces around operators 
+        'comma-spacing': ['error', { "before": false, "after": true }], // require spacing after a comma
+        'comma-style': ['error', 'last'], // requires comma after and on the same line
+        'no-trailing-spaces': ['error', { 'skipBlankLines': true }], // Disallows trailing whitespace on end of lines and empty lines
+    }
+};

.github/CODEOWNERS

@@ -0,0 +1,75 @@
+# <-- DOCS FOR THIS FILE -->
+# This is a comment.
+# Each line is a file pattern followed by one or more owners.
+
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence,
+# @global-owner1 and @global-owner2 will be requested for
+# review when someone opens a pull request.
+# *       @global-owner1 @global-owner2
+
+# Order is important; the last matching pattern takes the most
+# precedence. When someone opens a pull request that only
+# modifies JS files, only @js-owner and not the global
+# owner(s) will be requested for a review.
+# *.js    @js-owner
+
+# You can also use email addresses if you prefer. They'll be
+# used to look up users just like we do for commit author
+# emails.
+# *.go docs@example.com
+
+# In this example, @doctocat owns any files in the build/logs
+# directory at the root of the repository and any of its
+# subdirectories.
+# /build/logs/ @doctocat
+
+# The `docs/*` pattern will match files like
+# `docs/getting-started.md` but not further nested files like
+# `docs/build-app/troubleshooting.md`.
+# docs/*  docs@example.com
+
+# In this example, @octocat owns any file in an apps directory
+# anywhere in your repository.
+# apps/ @octocat
+
+# In this example, @doctocat owns any file in the `/docs`
+# directory in the root of your repository.
+# /docs/ @doctocat
+# <-- /DOCS FOR THIS FILE -->
+
+# <-- COMMON TO ALL MAINTAINERS -->
+/*.json @publiclab/is-maintainers
+/*.md @publiclab/is-maintainers
+/*.lock @ubliclab/is-maintainers
+/Gruntfile.js @publiclab/is-maintainers
+/.github/ @publiclab/is-maintainers
+/scripts/ @publiclab/is-maintainers
+# <-- /COMMON TO ALL MAINTAINERS -->
+
+# <-- SPECIFIC MAINTAINERS -->
+/index.js @publiclab/is-cli-maintainers
+/src/cli/ @publiclab/is-cli-maintainers
+/src/CliUtils.js @publiclab/is-cli-maintainers
+
+/src/*.js @publiclab/is-core-maintainers
+/src/*.json @publiclab/is-core-maintainers
+/src/util/ @publiclab/is-core-maintainers
+/test/core/* @publiclab/is-core-maintainers
+
+/src/modules/ @publiclab/is-module-maintainers
+/docs/ @publiclab/is-module-maintainers
+
+/test/ @publiclab/is-tests-maintainers
+/jest* @publiclab/is-tests-maintainers
+/eslint* @publiclab/is-tests-maintainers
+/travis* @publiclab/is-tests-maintainers
+.travis.yml @publiclab/is-tests-maintainers
+.gitpod* @publiclab/is-tests-maintainers
+/gitpod* @publiclab/is-tests-maintainers
+
+/examples/ @publiclab/is-ui-maintainers
+/icons/ @publiclab/is-ui-maintainers
+/test/ui-2/test/* @publiclab/is-ui-maintainers
+/test/ui/spec/* @publiclab/is-ui-maintainers
+# <-- /SPECIFIC MAINTAINERS -->

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,42 @@
+---
+name: Bug report 🐞
+about: Help us identify and fix a bug!
+title: ''
+labels: bug
+---
+
+### Please describe the problem (or idea)
+
+> What happened just before the problem occurred? Or what problem could this idea solve?
+
+
+
+> What did you expect to see that you didn't?
+
+
+
+### Please show us where to look
+
+Paste in a full URL, starting with:
+
+> https://beta.sequencer.publiclab.org/
+
+If you can share a screenshot or a GIF that is EXTRA helpful! 💖
+
+If you can see a version number in the upper right, please note that!
+
+
+### Browser, version, and operating system
+
+> Many bugs are related to these -- please help us track it down and reproduce what you're seeing!
+
+
+****
+
+## Thank you!
+
+Your help makes Public Lab better! We *deeply* appreciate your helping refine and improve this site.
+
+To learn how to write really great issues, which increases the chances they'll be resolved, see:
+
+https://publiclab.org/wiki/developers#Contributing+for+non-coders

.github/ISSUE_TEMPLATE/enhancement template.md

@@ -0,0 +1,25 @@
+# New Enhancement Request
+
+Describe your enhancement
+
+
+
+
+
+
+ What does your enhancement do?
+
+ Upload Screenshot of your enhancement
+ 
+ ### Please show us where to look
+ Paste in a full URL, starting with:
+ ### Problem it can solve
+ 
+   what problem could this enhancement solve?
+   
+   Your help makes Public Lab better! We *deeply* appreciate your helping refine and improve this site.
+
+To learn how to write really great issues, which increases the chances they'll be resolved, see:
+
+https://publiclab.org/wiki/developers#Contributing+for+non-coders
+### Thank you :)

.github/ISSUE_TEMPLATE/feature request.md

@@ -0,0 +1,22 @@
+# New Feature Request
+
+Describe your feature
+
+
+
+
+
+
+ What does your feature do?
+
+ Upload Screenshot of your implementation/feature
+ 
+ ### Please show us where to look
+ Paste in a full URL, starting with:
+ ### Problem it can solve
+ Your help makes Public Lab better! We *deeply* appreciate your helping refine and improve this site.
+
+To learn how to write really great issues, which increases the chances they'll be resolved, see:
+
+https://publiclab.org/wiki/developers#Contributing+for+non-coders
+### Thank you :)

.github/ISSUE_TEMPLATE/release_workflow.md

@@ -0,0 +1,51 @@
+---
+name: New release checklist ✅
+about: Coordinate steps to publish a new release
+title: 'Checklist and coordination for v0.0.0 major/minor/patch release'
+labels: release
+assignees: '@publiclab/is-maintainers'
+---
+
+This template guides us through the steps of creating a new release, based on conversation and testing in [#1692](https://github.com/publiclab/image-sequencer/issues/1692).
+
+Discuss with @publiclab/is-maintainers if anything is ambiguous!
+
+<!-- NOTE: Change v0.0.0 to the appropriate release version -->
+
+* [x] open an issue using the "release" template with this checklist with title `Checklist and coordination for v0.0.0 major/minor/patch release` (see [semantic versioning](https://docs.npmjs.com/about-semantic-versioning/))
+* [ ] create a release draft in https://github.com/publiclab/image-sequencer/releases
+* [ ] auto-compile release notes and copy below from corresponding release draft
+* [ ] open a pull request with updated version numbers
+    * [ ] update version number in `package.json` (ex #1695)
+    * [ ] update version number in `examples/sw.js` (ex #1734)
+    * [ ] run `npm install` to update `package-lock.json` (from recent node version - 16 at time of writing, in GitPod should work)
+    * [ ] check in `package-lock.json`
+* [ ] finalize and merge to `main` branch (freeze merges to `main` branch until next step)
+
+Now, move to `stable` branch:
+
+* [ ] force push from `main` to `stable`
+* [ ] then in `stable` branch, compile `dist/` files with `grunt build`
+* [ ] add `dist/` files with `git add -f dist/*` and commit them to `stable` branch
+* [ ] publish `stable` branch to `npm` with `npm publish` (logging in first as necessary)
+
+Draft a release:
+
+* [ ] [create a release on GitHub](https://github.com/publiclab/image-sequencer/releases) and reconcile with features description + release notes from below
+* [ ] tag version number branch (i.e. `v0.0.0`) based on `stable` or choose `stable`
+* [ ] publish to live Github pages [demo](https://sequencer.publiclab.org) (with [bash script](https://github.com/publiclab/image-sequencer/pull/1703) from `/scripts/update-demo`) (from within GitPod works well)
+* [ ] move anything necessary to next release project, i.e. <!-- Update this link -->https://github.com/publiclab/image-sequencer/projects/[insert project number]
+* [ ] close this issue!
+
+Noting we're now in this process in https://github.com/publiclab/image-sequencer/issues/1751 for `v3.7.0`.
+
+****
+
+### Release notes
+Compile and edit release notes below, to be copied into the release description.
+
+#### Added
+
+#### Fixed
+
+#### Changed

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,19 @@
+<!--- (Replace `0000` with the Issue Number below) --->
+Fixes #0000  
+
+
+<!---Make sure these boxes are checked before your pull request (PR) is ready to be reviewed and merged. Thanks!--->
+
+* [ ] tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR -- or run tests locally with `npm run test-all`
+* [ ] code is in uniquely-named feature branch and has no merge conflicts
+* [ ] PR is descriptively titled
+* [ ] ask `@publiclab/is-reviewers` for help, in a comment below 
+* [ ] at least 2 reviews required for getting pull request merged
+* [ ] Insert-step functionality is working correct as expected.
+<!--- We're happy to help you get this ready -- don't be afraid to ask for help, and **don't be discouraged** if your tests fail at first!--->
+
+<!---If tests do fail, click on the red `X` to learn why by reading the logs.--->
+
+<!---Please be sure you've reviewed our contribution guidelines at https://publiclab.org/contributing-to-public-lab-software--->
+<!---Please make sure to get at least two reviews before asking for merging the PR as that would make the PR more reliable on our part
+Thanks!--->

.github/config.yml

@@ -0,0 +1,30 @@
+# Configuration for welcome - https://github.com/behaviorbot/welcome
+
+# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
+
+# Comment to be posted to on first time issues
+newIssueWelcomeComment: |
+ Thanks for opening your first issue here! This space is [protected by our Code of Conduct](https://publiclab.org/conduct) - and we're here to help.
+ Please follow the issue template to help us help you 👍🎉😄
+ If you have screenshots to share demonstrating the issue, that's really helpful! 📸 You can [make a gif](https://www.cockos.com/licecap/) too!
+ Don't forget to join our [PublicLab Gitter channel](https://gitter.im/publiclab/publiclab) and our [ImageSequencer Gitter Channel](https://gitter.im/publiclab/image-sequencer) for some brainstorming discussions. 
+# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
+
+# Comment to be posted to on PRs from first time contributors in your repository
+newPRWelcomeComment: |
+ Thanks for opening this pull request! This space is [protected by our Code of Conduct](https://publiclab.org/conduct).
+ There may be some errors, **but don't worry!** We're here to help! 👍🎉😄
+ Also please refer (https://github.com/publiclab/image-sequencer/blob/main/README.md) for installation help.
+# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
+
+# Comment to be posted to on pull requests merged by a first time user
+firstPRMergeComment: |
+ Congrats on merging your first pull request! 🙌🎉⚡️ 
+ Your code will be published to https://beta.sequencer.publiclab.org in a day or two. Please test out your work on this testing server and report back with a comment that all has gone well!
+ In the meantime, can you tell us your Twitter handle so we can thank you properly also do join our weekly check-in to share your this week goal and the awesome work you did 😃. 
+ Please find the link **pinned in the issue section**
+ Now that you've completed this, you can help someone else take their first step! Try looking at this list of `first-timers-only` issues, and see if someone else is waiting for feedback, or even stuck! 😕
+ People often get stuck at the same steps, so you might be able to help someone get unstuck, or help lead them to some documentation that'd help. Reach out and be encouraging and friendly! 😄 🎉  
+ See: [Public Lab's coding community!](https://code.publiclab.org)
+
+# It is recommended to include as many gifs and emojis as possible

.github/dependabot.yml

@@ -0,0 +1,25 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: jest-puppeteer
+    versions:
+    - 5.0.1
+    - 5.0.2
+  - dependency-name: geotiff
+    versions:
+    - 1.0.2
+  - dependency-name: "@babel/core"
+    versions:
+    - 7.13.13
+  - dependency-name: puppeteer
+    versions:
+    - 5.2.1
+    - 7.1.0
+  - dependency-name: tape
+    versions:
+    - 5.1.1

.github/first-timers.yml

@@ -0,0 +1,12 @@
+# You can change the labels to suit your needs if "first-timers-only" is not what you are looking for.
+# These are some examples.
+labels:
+  - first-timers-only
+  - help wanted
+  
+#If you would like to add your own template for the issue, add an .md file to your .github folder
+template: .github/fto-template.md
+  
+# You can create the issue in a different repo than where the problem is. Just make sure you installed the bot on the configured repository.
+# The issue will link back to the original repository where the contribution will be made.
+#repository: repo-name 

.github/fto-template.md

@@ -0,0 +1,51 @@
+Hi, this is a [first-timers-only issue](https://code.publiclab.org/#r=all). This means we've worked to make it more legible to folks who either **haven't contributed to our codebase before, or even folks who haven't contributed to open source before**. 
+
+If that's you, we're interested in helping you take the first step and can answer questions and help you out as you do. Note that we're especially interested in contributions from people from groups underrepresented in free and open source software!
+
+We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you 💝
+
+If you have contributed before, **consider leaving this one for someone new**, and looking through our general [help wanted](https://github.com/publiclab/image-sequencer/labels/help-wanted) issues. Thanks!
+
+### 🤔 What you will need to know.
+
+Nothing. This issue is meant to welcome you to Open Source :) We are happy to walk you through the process.
+
+### 📋 Step by Step
+
+- [ ] 🙋 **Claim this issue**: Comment below. If someone else has claimed it, ask if they've opened a pull request already and if they're stuck -- maybe you can help them solve a problem or move it along!
+
+- [ ] 📝 **Update** the file [$FILENAME]($BRANCH_URL) in the `$REPO` repository (press the little pen Icon) and edit the line as shown below. 
+
+[See this page](https://code.publiclab.org/#r=all) for some help in taking your first steps!
+
+Below is a "diff" showing in red (and a `-`) which lines to remove, and in green (and a `+`) which lines to add:
+
+```diff
+
+$DIFF
+
+```
+- [ ] 💾 **Commit** your changes
+
+- [ ] 🔀 **Start a Pull Request**. There are two ways how you can start a pull request:
+
+1. If you are familiar with the terminal or would like to learn it, [here is a great tutorial](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) on how to send a pull request using the terminal.
+
+2. You can also [edit files directly in your browser](https://help.github.com/articles/editing-files-in-your-repository/) and open a pull request from there. 
+
+- [ ] 🏁 **Done** Ask in comments for a review :)
+
+### Please keep us updated
+
+💬⏰ - We encourage contributors to be respectful to the community and provide an update **within a week** of claiming a first-timers-only issue. We're happy to keep it assigned to you as long as you need if you update us with a request for more time or help, but if we don't see any activity a week after you claim it we may reassign it to give someone else a chance. Thank you in advance! 
+
+If this happens to you, don't sweat it! Grab another open issue.
+
+### Is someone else already working on this?
+
+🔗- We encourage contributors to link to the original issue in their pull request so all users can easily see if someone's already started on it. 
+
+👥- **If someone seems stuck, offer them some help!** Otherwise, [take a look at some other issues you can help with](https://code.publiclab.org/#r=all). Thanks!
+
+### 🤔❓ Questions?
+Leave a comment below!

.github/workflows/rebase.yml

@@ -0,0 +1,21 @@
+name: Automatic Rebase
+# https://github.com/marketplace/actions/automatic-rebase
+
+on:
+  issue_comment:
+    types: [created]
+jobs:
+  rebase:
+    name: Rebase
+    if: github.event.issue.pull_request != '' && contains(github.event.comment.body, '/rebase')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the latest code
+        uses: actions/checkout@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          fetch-depth: 0 # otherwise, you will fail to push refs to dest repo
+      - name: Automatic Rebase
+        uses: cirrus-actions/rebase@1.4
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/tests.yml

@@ -0,0 +1,209 @@
+name: tests
+on: [pull_request]
+jobs:
+  base-tests:
+    runs-on: ubuntu-18.04
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup node
+      uses: actions/setup-node@v2
+      with:
+        node-version: '12'
+        check-latest: true
+    - name: Cache node modules
+      uses: actions/cache@v2
+      env:
+        cache-name: cache-node-modules
+      with:
+        path: ~/.npm
+        key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+        restore-keys: |
+          ${{ runner.os }}-build-${{ env.cache-name }}-
+          ${{ runner.os }}-build-
+          ${{ runner.os }}-
+    - name: Install Dependencies
+      run: npm install
+    - name: "Base istanbul/tape node tests"
+      run: npm test
+
+  benchmark-tests:
+    runs-on: ubuntu-18.04
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup node
+      uses: actions/setup-node@v2
+      with:
+        node-version: '12'
+        check-latest: true
+    - name: Cache node modules
+      uses: actions/cache@v2
+      env:
+        cache-name: cache-node-modules
+      with:
+        path: ~/.npm
+        key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+        restore-keys: |
+          ${{ runner.os }}-build-${{ env.cache-name }}-
+          ${{ runner.os }}-build-
+          ${{ runner.os }}-
+    - name: Install Dependencies
+      run: npm install
+    - name: "Benchmark tests"
+      run: npm run benchmark
+
+  gif-tests:
+    runs-on: ubuntu-18.04
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup node
+      uses: actions/setup-node@v2
+      with:
+        node-version: '12'
+        check-latest: true
+    - name: Cache node modules
+      uses: actions/cache@v2
+      env:
+        cache-name: cache-node-modules
+      with:
+        path: ~/.npm
+        key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+        restore-keys: |
+          ${{ runner.os }}-build-${{ env.cache-name }}-
+          ${{ runner.os }}-build-
+          ${{ runner.os }}-
+    - name: Install Dependencies
+      run: npm install
+    - name: "Gif tests"
+      run: npm run gif-test
+
+  browserify-core-tests:
+    runs-on: ubuntu-18.04
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup node
+      uses: actions/setup-node@v2
+      with:
+        node-version: '12'
+        check-latest: true
+    - name: Cache node modules
+      uses: actions/cache@v2
+      env:
+        cache-name: cache-node-modules
+      with:
+        path: ~/.npm
+        key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+        restore-keys: |
+          ${{ runner.os }}-build-${{ env.cache-name }}-
+          ${{ runner.os }}-build-
+          ${{ runner.os }}-
+    - name: Install Dependencies
+      run: npm install
+    - run: sudo apt-get install xvfb
+    - name: "Browserify core tests and run"
+      run: grunt tests && xvfb-run --auto-servernum npm run core-tests
+
+  jsmine-ui-tests:
+    runs-on: ubuntu-18.04
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup node
+      uses: actions/setup-node@v2
+      with:
+        node-version: '12'
+        check-latest: true
+    - name: Cache node modules
+      uses: actions/cache@v2
+      env:
+        cache-name: cache-node-modules
+      with:
+        path: ~/.npm
+        key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+        restore-keys: |
+          ${{ runner.os }}-build-${{ env.cache-name }}-
+          ${{ runner.os }}-build-
+          ${{ runner.os }}-
+    - name: Install Dependencies
+      run: npm install
+    - name: "Jasmine UI tests (mocked browser env)"
+      run: npm run test-ui
+
+  jest-ui-tests:
+    runs-on: ubuntu-18.04
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup node
+      uses: actions/setup-node@v2
+      with:
+        node-version: '12'
+        check-latest: true
+    - name: Cache node modules
+      uses: actions/cache@v2
+      env:
+        cache-name: cache-node-modules
+      with:
+        path: ~/.npm
+        key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+        restore-keys: |
+          ${{ runner.os }}-build-${{ env.cache-name }}-
+          ${{ runner.os }}-build-
+          ${{ runner.os }}-
+    - name: Install Dependencies
+      run: npm install
+    - name: "jest-puppeteer UI tests (full browser env)"
+      run: npm run test-ui-2    
+
+  cli-tests:
+    runs-on: ubuntu-18.04
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup node
+      uses: actions/setup-node@v2
+      with:
+        node-version: '12'
+        check-latest: true
+    - name: Cache node modules
+      uses: actions/cache@v2
+      env:
+        cache-name: cache-node-modules
+      with:
+        path: ~/.npm
+        key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+        restore-keys: |
+          ${{ runner.os }}-build-${{ env.cache-name }}-
+          ${{ runner.os }}-build-
+          ${{ runner.os }}-
+    - name: Install Dependencies
+      run: npm install
+    - name: "CLI tests"
+      run: npm run test-cli
+
+  grunt-build-test:
+    runs-on: ubuntu-18.04
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup node
+      uses: actions/setup-node@v2
+      with:
+        node-version: '12'
+        check-latest: true
+    - name: Cache node modules
+      uses: actions/cache@v2
+      env:
+        cache-name: cache-node-modules
+      with:
+        path: ~/.npm
+        key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+        restore-keys: |
+          ${{ runner.os }}-build-${{ env.cache-name }}-
+          ${{ runner.os }}-build-
+          ${{ runner.os }}-
+    - name: Install Dependencies
+      run: npm install
+    - name: "Grunt build test of dev environment"
+      run: grunt build
+
+## Cache NPM folder
+# cache:
+#   directories:
+#     - ~/.npm
+#     - ~/.cache

.gitignore

@@ -27,16 +27,26 @@ build/Release
 node_modules
 node_modules/*
 
+# Dist Files
+dist/*
+dist
+
 # Optional npm cache directory
 .npm
 
 # Optional REPL history
 .node_repl_history
 
+.DS_Store
+
 *.swp
 todo.txt
 test.js
 output.txt
 output/
+test/core/modules/test_outputs
+test/core/modules/test_outputs/*
 node_modules/
 node_modules/*
+test_outputs
+/test_outputs

.gitpod.dockerfile

@@ -0,0 +1,68 @@
+FROM gitpod/workspace-full
+
+USER root
+RUN sudo apt-get update && apt-get install -y apt-transport-https \
+ && sudo apt-get install -y \
+    xserver-xorg-dev \
+    libxext-dev \
+    build-essential \
+    libxi-dev \
+    libglew-dev \
+    pkg-config \
+    libglu1-mesa-dev \
+    freeglut3-dev \
+    mesa-common-dev \
+    x11-apps \
+    libice6 \
+    libsm6 \
+    libxaw7 \
+    libxft2 \
+    libxmu6 \
+    libxpm4 \
+    libxt6 \
+    x11-apps \
+    xbitmaps \
+    ca-certificates \
+    fonts-liberation \
+    libappindicator3-1 \
+    libasound2 \
+    libatk-bridge2.0-0 \
+    libatk1.0-0 \
+    libc6 \
+    libcairo2 \
+    libcairo2-dev \
+    libcups2 \
+    libdbus-1-3 \
+    libexpat1 \
+    libfontconfig1 \
+    libgbm1 \
+    libgcc1 \
+    libgif-dev \
+    libglib2.0-0 \
+    libgtk-3-0 \
+    libjpeg-dev \
+    libnspr4 \
+    libnss3 \
+    libpango-1.0-0 \
+    libpango1.0-dev \
+    libpangocairo-1.0-0 \
+    libstdc++6 \
+    librsvg2-dev \
+    libx11-6 \
+    libx11-xcb1 \
+    libxcb1 \
+    libxcomposite1 \
+    libxcursor1 \
+    libxdamage1 \
+    libxext6 \
+    libxfixes3 \
+    libxi6 \
+    libxrandr2 \
+    libxrender1 \
+    libxss1 \
+    libxtst6 \
+    lsb-release \
+    wget \
+    xdg-utils \
+    xvfb \
+ && apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/*

.gitpod.yml

@@ -0,0 +1,18 @@
+image:
+  file: .gitpod.dockerfile
+tasks:
+  - init: npm run setup
+    command: npm start
+ports:
+  - port: 3000
+    onOpen: open-preview
+
+github:
+  prebuilds:
+    branches: true
+    pullRequests: true
+    pullRequestsFromForks: true
+    addCheck: true
+    addComment: true
+    addBadge: false
+    addLabel: false

.npmignore

@@ -0,0 +1,47 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Optional npm cache directory
+.npm
+
+# Optional REPL history
+.node_repl_history
+
+.DS_Store
+
+*.swp
+todo.txt
+test.js
+output.txt
+output/
+
+
+
+examples/
+icons/
+
+.travis.yml
+Gruntfile.js
+yarn.lock

.travis.yml

@@ -1,16 +1,37 @@
+sudo: required
 language: node_js
 node_js:
-  - '4'
-  - '5'
-  - '6'
-  - '7' # Node.js 7 is most stable version
+  - '10'
+  - '12'
 env:
   - CXX=g++-4.8
 before_script:
   - npm install grunt-cli -g # for "grunt build"
-script:
-  - npm test
-  - grunt build
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+jobs:
+  include:
+    - name: "Base istanbul/tape node tests"
+      script: npm test
+    - name: "Benchmark tests"
+      script: npm run benchmark
+    - name: "Gif tests"
+      script: npm run gif-test
+    - name: "Browserify core tests and run"
+      script: grunt tests && npm run core-tests
+    - name: "Jasmine UI tests (mocked browser env)"
+      script: npm run test-ui
+    - name: "jest-puppeteer UI tests (full browser env)"
+      script: npm run test-ui-2    
+    - name: "CLI tests"
+      script: npm run test-cli
+    - name: "Grunt build test of dev environment"
+      script: grunt build
+after_success:
+  - bash <(curl -s https://codecov.io/bash)
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
 addons:
   apt:
     sources:
@@ -18,6 +39,10 @@ addons:
     packages:
       - g++-4.8
       - xvfb # for tape-run
+before_install:
+  - sudo apt-get update
+  - sudo apt-get install xserver-xorg-dev libxext-dev libxi-dev
+  - sudo apt-get install -y build-essential libxi-dev libglu1-mesa-dev libglew-dev pkg-config libglu1-mesa-dev freeglut3-dev mesa-common-dev
 install:
   - export DISPLAY=':99.0' # for tape-run
   - Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 & # for tape-run

CODE_OF_CONDUCT.md

@@ -0,0 +1,11 @@
+# Public Lab Code of Conduct 
+
+_Public Lab, 55 Cromwell Street, 1C, Providence, RI 02907_
+
+We are coming together with an intent to care for ourselves and one another as we produce knowledge in pursuit of environmental justice. For this to work for everybody, individual decisions will not be allowed to run counter to the welfare of other people. We—visitors, community members, community moderators, staff, organizers, sponsors, and all others—hold ourselves accountable to the same values regardless of position or experience. This community aspires to be a respectful place both during online and in-person interactions so that all people are able to fully participate with their dignity intact. This document is a piece of the culture we're creating.
+
+This code of conduct applies to all spaces managed by the Public Lab community and non-profit, both online and in person. It provides a clear set of practical guidelines for events led by organizers and community members, multi-day events such as Barnraisings, and online venues such as the website, comment threads on software platforms, chatrooms, our mailing lists, the issue tracker, and any other forums created by Public Lab which the community uses for communication. For interactions with additional groups, see our Partnership Guidelines at https://publiclab.org/partners.
+
+To read the full Code of Conduct and learn how to contact the Conduct Committee or the Moderators group, see:
+
+https://publiclab.org/conduct

CONTRIBUTING.md

@@ -3,6 +3,10 @@ Contributing to Image Sequencer
 
 Happily accepting pull requests; to edit the core library, modify files in `./src/`. To build, run `npm install` followed by `grunt build`.
 
+On ARM based devices, the `gl` module may require some libraries to be re-installed:
+
+`sudo apt-get install -y build-essential xserver-xorg-dev libxext-dev libxi-dev libglu1-mesa-dev libglew-dev pkg-config` -- see https://github.com/stackgl/headless-gl#ubuntudebian for more.
+
 Most contribution (we imagine) would be in the form of API-compatible modules, which need not be directly included.
 
 ## Jump To
@@ -10,12 +14,16 @@ Most contribution (we imagine) would be in the form of API-compatible modules, w
 * [README.md](https://github.com/publiclab/image-sequencer)
 * [Contributing Modules](#contributing-modules)
 * [Info File](#info-file)
-* [Ideas](#ideas)
+* [Ideas](#Contribution-ideas)
+* [Grunt Tasks](#grunt-tasks)
+* [UI Helper Methods](#ui-helper-methods)
+* [Scripts](#scripts)
 
+****
 
-## Contribution ideas
+## Contribution-ideas
 
-See [this issue](https://github.com/publiclab/image-sequencer/issues/118) for a range of ideas for new contributions, and links to possibly helpful libraries. Also see the [new features issues list](https://github.com/publiclab/image-sequencer/labels/new-feature).
+See [this issue](https://github.com/publiclab/image-sequencer/issues/118) for a range of ideas for new contributions and links to possibly helpful libraries, or you can solve an [existing issue](https://github.com/publiclab/image-sequencer/labels/module). Also see the [new features issues list](https://github.com/publiclab/image-sequencer/labels/new-feature).
 
 ### Bugs
 
@@ -25,26 +33,27 @@ If you find a bug please list it here, and help us develop Image Sequencer by [o
 
 ## Contributing modules
 
-Most contributions can happen in modules, rather than to core library code. Modules and their [corresponding info files](#info-file) are included into the library in this file: https://github.com/publiclab/image-sequencer/blob/master/src/Modules.js#L5-L7
+Most contributions can happen in modules, rather than to core library code. Modules and their [corresponding info files](#info-file) are included into the library in this file: https://github.com/publiclab/image-sequencer/blob/main/src/Modules.js#L5-L7
+
+Module names, descriptions, and parameters are set in the `info.json` file -- [see below](#info-file).
 
 Any module must follow this basic format:
 
 ```js
 module.exports = function ModuleName(options,UI) {
-  options = options || {};
-  options.title = "Title of the Module";
-  UI.onSetup(options.step);
+
   var output;
+  // Module requirements have been simplified in version 3, see https://github.com/publiclab/image-sequencer/blob/master/CONTRIBUTING.md#contributing-modules
 
   function draw(input,callback) {
-    UI.onDraw(options.step);
 
-    var output = /*do something with the input*/ ;
+    var output = function(input){
+      /* do something with the input */
+      return input;
+    }
 
-    this.output = output;
-    options.step.output = output.src;
+    this.output = output(input); // run the output and assign it to this.output
     callback();
-    UI.onComplete(options.step);
   }
 
   return {
@@ -56,6 +65,73 @@ module.exports = function ModuleName(options,UI) {
 }
 ```
 
+Image Sequencer modules are designed to be run either in the browser or in a Node.js environment. For dynamically loaded modules, that means that any uses of `require()` to include an external library must be compiled using a system like `browserify` or `webpack` to ensure browser compatibility. An example of this can be found here:
+
+https://github.com/tech4gt/image-sequencer
+
+### Browser/node compatibility
+
+If you wish to offer a module without browser-compatibility, please indicate this in the returned `info` object as:
+
+module.exports = [
+  ModuleName,
+  { only: ['node'] }
+];
+
+If you believe that full cross-compatibility is possible, but need help, please open an issue on your module's issue tracker requesting assistance (and potentially link to it from an inline comment or the module description).
+
+Any Independent Module Must follow this basic format
+```js
+function ModuleName(options,UI) {
+
+  var output;
+
+  function draw(input,callback) {
+
+    var output = function(input){
+      /* do something with the input */
+      return input;
+    }
+
+    this.output = output(input); // run the output and assign it to this.output
+    callback();
+  }
+
+  return {
+    options: options,
+    draw: draw,
+    output: output,
+    UI: UI
+  };
+}
+
+  module.exports = [ModuleName,{
+      "name": "ModuleName",
+      "description": "",
+      "inputs": {
+        // inputs here
+      }
+      /* Info can be defined here or imported from a json file */
+      // require('./info.json') This only works in node
+      // In a module compiled with browserify or webpack, a require() can be used to
+      // load a standard info.json file.
+      ];
+```
+### 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.
+
+The api must be used in the following format
+```js
+var step = this;
+
+    if (!options.inBrowser) {
+      require('../_nomodule/gl-context')(input, callback, step, options);
+    }
+    else {
+      /* Browser specific code */
+    }
+```
+
 ### options
 
 The object `options` stores some important information. This is how you can accept
@@ -67,6 +143,28 @@ whether your module is being run on a browser.
 
 ### draw()
 
+To add a module to Image Sequencer, it must have a `draw` method; you can wrap an existing module to add them:
+
+* `module.draw(input, callback)`
+
+The `draw` method should accept an `input` parameter, which will be an object of the form:
+
+```js
+input = {
+  src: "datauri of an image here",
+  format: "jpeg/png/etc",
+  // utility functions
+  getPixels: "function to get Image pixels. Wrapper around https://npmjs.com/get-pixels",
+  savePixels: "function to save Image pixels. Wrapper around https://npmjs.com/save-pixels",
+  lodash: "wrapper around lodash library, https://github.com/lodash",
+  dataUriToBuffer: "wrapper around https://www.npmjs.com/package/data-uri-to-buffer",
+  pixelManipulation: "general purpose pixel manipulation API, see https://github.com/publiclab/image-sequencer/blob/master/src/modules/_nomodule/PixelManipulation.js"
+}
+```
+For example usage of pixelManipulation see https://github.com/publiclab/image-sequencer/blob/main/src/modules/Invert/Module.js
+
+**The module is included in the browser inside a script tag and since the code runs directly in the browser if any other module is required apart from the apis available on the input object, it should be either bundled with the module code and imported in es6 format or the module code must be browserified before distribution for browser**
+
 The draw method is run every time the step is `run` using `sequencer.run()`.
 So any calculations must go **into** the `draw()` method's definition.
 
@@ -82,44 +180,33 @@ constant definitions must be done **outside** the `draw()` method's definition.
       format: "<png|jpeg|gif>"
     }
     ```
-* `callback` is a function which is responsible to tell the sequencer that the
-step has been "drawn".
+* `callback` is a function which is responsible to tell the sequencer that the step has been "drawn".
 
-When you have done your calculations and produced an image output, you are required
-to set `this.output` to an object similar to what the input object was, call
-`callback()`, and set `options.step.output` equal to the output DataURL
+When you have done your calculations and produced an image output, you are required to set `this.output` to an object similar to what the input object was, call `callback()`, and set `options.step.output` equal to the output DataURL
+
+* `progressObj` is an optional additional Object that can be passed in the format `draw(input, callback, progressObj)`, which handles the progress output; see [Progress reporting](#progress-reporting) below.
 
 ### UI Methods
 
-The module is responsible for emitting various events for the UI to capture. There are
-four events in all:
+The module is responsible for emitting various events for the UI to capture.
+
+There are four events in all:
 
 * `UI.onSetup(options.step)` must be emitted when the module is added. So it must be emitted outside the draw method's definition as shown above.
 * `UI.onDraw(options.step)` must be emitted whenever the `draw()` method is called. So it should ideally be the first line of the definition of the `draw` method.
 * `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.
 
-To add a module to Image Sequencer, it must have the following method; you can wrap an existing module to add them:
+### Name and description
 
-* `module.draw()`
-
-The `draw(input,callback)` method should accept an `input` parameter, which will be an object of the form:
-
-```js
-input = {
-  src: "datauri here",
-  format: "jpeg/png/etc"
-}
-```
-
-### options.title
-
-For display in the web-based UI, each module may also have a title `options.title`.
+For display in the web-based demo UI, set the `name` and `description` fields in the `info.json` file for the module.
 
 ## Info file
 
 All module folders must have an `info.json` file which looks like the following:
+
 ```json
 {
   "name": "Name of Module to be displayed",
@@ -155,10 +242,240 @@ Similarly, "Select" type inputs should have a `values` array.
 
 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:
+
+```js
+module.exports = function ModuleName(options,UI) {
+
+  var output;
+
+  function draw(input,callback,progressObj) {
+
+    /* If you wish to supply your own progress bar you need to override progressObj */
+    progressObj.stop() // Stop the current progress spinner
+
+    progressObj.overrideFlag = true; // Tell image sequencer that you will supply your own progressBar
+
+    /* Override the object and give your own progress Bar */
+    progressObj = /* Your own progress Object */
+
+    var output = function(input){
+      /* do something with the input */
+      return input;
+    };
+
+    this.output = output();
+    callback();
+  }
+
+  return {
+    options: options,
+    draw: draw,
+    output: output,
+    UI: 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.
+
+
 ### Module example
 
-See existing module `green-channel` for an example: https://github.com/publiclab/image-sequencer/tree/master/src/modules/GreenChannel/Module.js
+See existing module `channel` for an example: https://github.com/publiclab/image-sequencer/blob/main/src/modules/Channel/Module.js
 
-The `green-channel` module is included into the core modules here: https://github.com/publiclab/image-sequencer/blob/master/src/Modules.js#L5-L7
+The `channel` module is included into the core modules here: https://github.com/publiclab/image-sequencer/blob/main/src/Modules.js#L5-L7
 
 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
+
+```js
+
+/* Mapping function is a function which gets the inputs of the module as argument
+*  and returns an array with steps mapped to their options
+*  See https://github.com/publiclab/image-sequencer/blob/main/src/modules/Colorbar/Module.js for example
+*/
+
+/* Module options is an object with the following keys
+*  infoJson: the info.json object for the module
+*/
+sequencer.createMetaModule(mappingFunction,moduleOptions)
+
+/* createMetaModule returns an array of module function and info just like normal
+*  modules. These can also be loaded into sequencer dynamically like other modules
+*/
+```
+
+A Meta module can also be contributed like a normal module with an info and a Module.js. A basic Meta module shall follow the following format
+
+
+```js
+// Module.js
+  module.exports = require('../../util/createMetaModule.js')(
+    function mapFunction(options) {
+
+        return [
+            { 'name': 'module-name', 'options': {} },
+            { 'name': 'module-name', 'options': {} },
+        ];
+    }, {
+        infoJson: require('./info.json')
+    }
+)[0];
+```
+
+```json
+// Info
+{
+  "name": "meta-moduleName",
+  "description": "",
+  "inputs": {
+  }
+}
+```
+
+```js
+//index.js
+module.exports = [
+  require('./Module.js'),
+  require('./info.json')
+]
+```
+
+All of the above can also be combined together to form a single file module.
+
+```js
+
+// MetaModule.js
+module.exports =
+  sequencer.createMetaModule(
+    function mapFunction(options) {
+
+        return [
+            { 'name': 'module-name', 'options': {} },
+            { 'name': 'module-name', 'options': {} },
+        ];
+    }, {
+        infoJson: {
+            "name": "meta-moduleName",
+            "description": "",
+            "inputs": {
+            }
+        }
+    });
+```
+
+## Linting
+
+We are now using `eslint` and `husky` to help lint and format our code each time we commit. Eslint defines coding standards and helps in cleaning up the code. To run eslint for checking errors globally or within a specific file run:
+
+```
+npx eslint .
+
+npx eslint <file path>
+```
+And to fix those errors globally or in a file, run these in your terminal:
+```
+npx eslint . --fix
+
+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.
+
+If we want `husky` to not verify the commit and push it anyway, use `git commit -m "message" --no-verify.`
+
+## Grunt Tasks
+
+This repository has different grunt tasks for different uses. The source code is in the [Gruntfile](https://github.com/publiclab/image-sequencer/blob/main/Gruntfile.js).
+
+The following command is used for running the tasks: `grunt [task-name]`. Here `[task-name]` should be replaced by the name of the task to be run. To run the default task run `grunt` without any options.
+
+#### Tasks
+1. **compile**: Compiles/Browserifies the dist files in `/dist/image-sequencer.js` and `/dist/image-sequencer-ui.js`.
+2. **build**: Compiles the files as in the **compile** task and minifies/uglifies dist files in `/dist/image-sequencer.min.js` and `/dist/image-sequencer-ui.min.js`.
+3. **watch**: Checks for any changes in the source code and runs the **compile** task if any changes are found.
+4. **serve**: Compiles the dist files as in the **compile** task and starts a local server on `localhost:3000` to host the demo site in `/examples/` directory. Also runs the **watch** task.
+5. **production**: Compiles and minifies dist files in `/dist/image-sequencer.js` and `/dist/image-sequencer-ui.js` without the `.min.js` extension to include minified files in the demo site. This script should only be used in production mode while deploying.
+6. **default**: Runs the **watch** task as default.
+
+## UI Helper Methods
+
+### scopeQuery
+
+###### Path: `/examples/lib/scopeQuery.js`
+
+The method returns a scoped `jQuery` object which only searches for elements inside a given scope (a DOM element).
+
+To use the method,
+* import the `scopeSelector` and `scopeSelectorAll` methods from `lib/scopeQuery.js`
+* call the methods with scope as a parameter
+
+```js
+var scopeQuery = require('./scopeQuery');
+
+var $step = scopeQuery.scopeSelector(scope),
+    $stepAll = scopeQuery.scopeSelectorAll(scope);
+```
+This will return an object with a constructor which returns a `jQuery` object (from inside the scope) but with new `elem` and `elemAll` methods.
+
+#### Methods of the Returned Object
+* `elem()`: Selects an element inside the scope.
+* `elemAll()`: Selects all the instances of a given element inside the scope.
+* `getScope()`: Returns the scope as a DOM element.
+* `getDomElem()`: Returns the scoped element as a DOM element instead of a jquery object.
+
+#### Example
+
+```js
+//The scope is a div element with id=“container“ and there are three divs in it
+//with ids „1“, „2“, and „3“, and all of them have a „child“ class attribute
+
+var $step = require('./scopeQuery').scopeSelector(document.getElementById('container'));
+
+$step('#1'); // returns the div element with id=“1“
+$step('#1').hide().elemAll('.child').fadeOut(); // abruptly hides the div element with id=“1“ and fades out all other div elements
+```
+
+These two methods are chainable and will always return elements from inside the scope.
+
+#### Usage
+
+Instead of using
+
+```js
+$(step.ui.querySelector('query')).show().hide();
+$(step.ui.querySelectorAll('q2')).show().hide();
+```
+The following code can be used
+
+```js
+$step('query').show().hide();
+$stepAll('q2').show().hide();
+```
+
+## Scripts
+The following shell scripts are present in the `scripts/` directory.
+
+- `update-gh-pages`: This script can be used to update the `gh-pages` branch of this repo or a fork.
+ This script is not meant to be used directly as it runs in the current working directory.
+ If you run it on your primary local clone, it can **delete** the local changes. This script is made to be used in a github action
+ or in a temporary directory via another script, such as `update-demo`.
+
+  Arguments:
+  1. Repo(to use as upstream) url in the form username/repo (default: publiclab/image-sequencer) NOTE: Github only
+  2. Branch to pull from eg: main or stable (default: stable)
+  3. CNAME URL (default: none)
+  4. Set the fourth argument to anything to bypass the warning. You will have to set this argument if you want to run this script in another script without needing
+  user interaction, such as in a github action.
+
+- `update-demo`: A safe, interactive script that can be used to update the `gh-pages` branch of any image-sequencer fork.
+ 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.

Gruntfile.js

@@ -1,50 +1,106 @@
 module.exports = function(grunt) {
+  grunt.loadNpmTasks('grunt-browserify');
+  grunt.loadNpmTasks('grunt-contrib-uglify-es');
+  grunt.loadNpmTasks('grunt-browser-sync');
+  grunt.loadNpmTasks('grunt-text-replace');
 
-    grunt.loadNpmTasks('grunt-browserify');
-    grunt.loadNpmTasks('grunt-contrib-uglify');
+  require('matchdep')
+    .filterDev('grunt-*')
+    .forEach(grunt.loadNpmTasks);
 
-    require('matchdep').filterDev('grunt-*').forEach(grunt.loadNpmTasks);
+  grunt.initConfig({
+    pkg: grunt.file.readJSON('package.json'),
 
-    grunt.initConfig({
-
-      pkg: grunt.file.readJSON('package.json'),
-
-      watch: {
-          options : {
-              livereload: true
-          },
-          source: {
-              files: [
-                  'src/*.js',
-                  'src/*/*.js',
-                  'Gruntfile.js'
-              ],
-              tasks: [ 'build:js' ]
-          }
+    watch: {
+      options: {
+        livereload: true
       },
+      source: {
+        files: ['src/**/*', 'Gruntfile.js', 'examples/lib/*', 'examples/demo.js'],
+        tasks: ['compile']
+      }
+    },
 
-      browserify: {
-          dist: {
-            src: ['src/ImageSequencer.js'],
-            dest: 'dist/image-sequencer.js'
-          }
+    browserify: {
+      options: {
+        alias: {
+          'gpu.js': './node_modules/gpu.js/src/index.js'
+        }
       },
+      core: {
+        src: ['src/ImageSequencer.js'],
+        dest: 'dist/image-sequencer.js'
+      },
+      ui: {
+        src: ['examples/demo.js'],
+        dest: 'dist/image-sequencer-ui.js'
+      },
+      prodcore: {
+        src: ['src/ImageSequencer.js'],
+        dest: 'dist/image-sequencer.brow.js'
+      },
+      produi: {
+        src: ['examples/demo.js'],
+        dest: 'dist/image-sequencer-ui.brow.js'
+      },
+      tests: {
+        src: ['test/core/sequencer/meta-modules.js',
+              'test/core/sequencer/image-sequencer.js',
+              'test/core/sequencer/chain.js',
+              'test/core/sequencer/replace.js',
+              'test/core/sequencer/import-export.js',
+              'test/core/sequencer/run.js',
+              'test/core/sequencer/dynamic-imports.js',
+              'test/core/util/*.js'],
+        dest: './output/core-tests.js'
+      }
+    },
 
-      uglify: {
-        dist: {
-          src: ['./dist/image-sequencer.js'],
-          dest: './dist/image-sequencer.min.js'
+    replace: {
+      version: {
+        src: ['examples/sw.js'],
+        overwrite: true,
+        replacements: [{
+          from: /image-sequencer-static-v.*/g,
+          to: "image-sequencer-static-v<%= pkg.version %>';"
+        }]
+      }
+    },
+
+    uglify: {
+      core: {
+        src: ['./dist/image-sequencer.js'],
+        dest: './dist/image-sequencer.min.js'
+      },
+      ui: {
+        src: ['dist/image-sequencer-ui.js'],
+        dest: 'dist/image-sequencer-ui.min.js'
+      },
+      prodcore: {
+        src: ['dist/image-sequencer.brow.js'],
+        dest: 'dist/image-sequencer.js'
+      },
+      produi: {
+        src: ['dist/image-sequencer-ui.brow.js'],
+        dest: 'dist/image-sequencer-ui.js'
+      }
+    },
+    browserSync: {
+      dev: {
+        options: {
+          watchTask: true,
+          server: './'
         }
       }
+    }
+  });
 
-    });
-
-    /* Default (development): Watch files and build on change. */
-    grunt.registerTask('default', ['watch']);
-
-    grunt.registerTask('build', [
-        'browserify:dist',
-        'uglify:dist'
-    ]);
+  /* Default (development): Watch files and build on change. */
+  grunt.registerTask('default', ['watch']);
+  grunt.registerTask('build', ['browserify:core', 'browserify:ui', 'replace:version', 'uglify:core', 'uglify:ui']);
+  grunt.registerTask('serve', ['browserify:core', 'browserify:ui', 'replace:version', 'browserSync', 'watch']);
+  grunt.registerTask('compile', ['browserify:core', 'browserify:ui']);
+  grunt.registerTask('production', ['browserify:prodcore', 'browserify:produi', 'replace:version', 'uglify:prodcore', 'uglify:produi']);
 
+  grunt.registerTask('tests', ['browserify:tests']);
 };

README.md

@@ -1,34 +1,51 @@
 Image Sequencer
 ====
 
-[![Build Status](https://travis-ci.org/publiclab/image-sequencer.svg?branch=master)](https://travis-ci.org/publiclab/image-sequencer)
+[![Code of Conduct](https://img.shields.io/badge/code-of%20conduct-green.svg)](https://publiclab.org/conduct)
+[![npm version](https://badge.fury.io/js/image-sequencer.svg)](https://badge.fury.io/js/image-sequencer)
+[![Build Status](https://travis-ci.org/publiclab/image-sequencer.svg?branch=master)](https://travis-ci.org/publiclab/image-sequencer) [![Maintainability](https://api.codeclimate.com/v1/badges/5906996dd2e90aca6398/maintainability)](https://codeclimate.com/github/publiclab/image-sequencer/maintainability) [![Codecov](https://img.shields.io/codecov/c/github/publiclab/image-sequencer.svg?logo=codecov)](https://codecov.io/gh/publiclab/image-sequencer)
+[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/publiclab/image-sequencer/)
+
+- **Latest Stable Demo**: https://sequencer.publiclab.org
+- **Latest Beta Demo**: https://beta.sequencer.publiclab.org
+- **Stable Branch**: https://github.com/publiclab/image-sequencer/tree/stable/
+
+Begin running (and contributing to) this codebase immediately with [GitPod](https://gitpod.io) (this also opens the latest `main` branch code):
+
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/publiclab/image-sequencer)
 
 ## Why
 
-Image Sequencer is different from other image processing systems in that it's _non-destructive_: instead of modifying the original image, it **creates a new image at each step in a sequence**. This is because it:
+Image Sequencer is different from other image processing systems because it's _non-destructive_: instead of modifying the original image, it **creates a new image at each step in a sequence**. This is because it:
 
 * produces a legible trail of operations, to "show your work" for evidential, educational, or reproducibility reasons
 * makes the creation of new tools or "modules" simpler -- each must accept an input image, and produce an output image
-* allows many images to be run through the same sequence of steps
-* works identically in the browser, on Node.js, and on the commandline
+* allows many images to run through the same sequence of steps
+* works identically in the browser, on Node.js, and on the command line
 
-![workflow diagram](https://raw.githubusercontent.com/publiclab/image-sequencer/master/examples/images/diagram-workflows.png)
+The following diagrams attempt to explain how the applications various components interconnect:
 
-It is also for prototyping some other related ideas:
+![general diagram](https://publiclab.org/i/30547.png?s=o)
 
-* filter-like image processing -- applying a transform to any image from a given source, like a proxy. I.e. every image tile of a satellite imagery web map
-* test-based image processing -- the ability to create a sequence of steps that do the same task as some other image processing tool, provable with example before/after images to compare with
-* logging of each step to produce an evidentiary record of modifications to an original image
+![workflow diagram](https://raw.githubusercontent.com/publiclab/image-sequencer/main/examples/images/diagram-workflows.png)
+
+It also for prototypes other related ideas:
+
+* filter-like image processing -- apply a transform to an image from a given source, like a proxy. I.e. [every image tile of a satellite imagery web map](https://publiclab.org/notes/warren/05-10-2018/prototype-filter-map-tiles-in-real-time-in-a-browser-with-imagesequencer-ndvi-landsat)
+* test-based image processing -- the ability to create a sequence of steps that do the same task as other image processing tools, provable with example before/after images to compare with
+* logging each step -- to produce an evidentiary record of modifications to an original image
 * cascading changes -- change an earlier step's settings, and see those changes affect later steps
-* "small modules"-based extensibility: see [Contributing](https://github.com/publiclab/image-sequencer/blob/master/CONTRIBUTING.md)
+* "small modules" -- based extensibility: see [Contributing](https://github.com/publiclab/image-sequencer/blob/main/CONTRIBUTING.md)
+
 
 ## Examples
 
-* [Simple Demo](https://publiclab.github.io/image-sequencer/)
+* [Simple Demo](https://sequencer.publiclab.org)
+* [Latest Beta Demo](https://beta.sequencer.publiclab.org)
 
 A diagram of this running 5 steps on a single sample image may help explain how it works:
 
-![example workflow](https://raw.githubusercontent.com/publiclab/image-sequencer/master/examples/images/diagram-6-steps.png)
+![example workflow](https://raw.githubusercontent.com/publiclab/image-sequencer/main/examples/images/diagram-6-steps.png)
 
 ## Jump to:
 
@@ -39,21 +56,41 @@ A diagram of this running 5 steps on a single sample image may help explain how
 * [Method Chaining](#method-chaining)
 * [Multiple Images](#multiple-images)
 * [Creating a User Interface](#creating-a-user-interface)
-* [Contributing](https://github.com/publiclab/image-sequencer/blob/master/CONTRIBUTING.md)
-* [Submit a Module](https://github.com/publiclab/image-sequencer/blob/master/CONTRIBUTING.md#contributing-modules)
+* [Contributing](https://github.com/publiclab/image-sequencer/blob/main/CONTRIBUTING.md)
+* [Submit a Module](https://github.com/publiclab/image-sequencer/blob/main/CONTRIBUTING.md#contributing-modules)
+* [Get Demo Bookmarklet](https://publiclab.org/w/imagesequencerbookmarklet)
 
 ## Installation
 
-This library works in the browser, in Node, and on the commandline (CLI), which we think is great. 
+This library conveniently works in the browser, in Node, and on the command line (CLI).
+
+### Unix based platforms
+You can set up a local environment to test the UI with `sudo npm run setup` followed by `npm start`.
+
+### Windows
+Our npm scripts do not support windows shells, please run the following snippet in PowerShell.
+```powershell
+npm i ; npm i -g grunt grunt-cli ; grunt build; grunt serve
+```
+In case of a port conflict please run the following
+```powershell
+npm i -g http-server ; http-server -p 3000
+```
+
+### Online one-click setup for contributing
+
+Contribute to ImageSequencer using a fully featured online development environment that will automatically: clone the repo, install the dependencies and start the webserver.
+
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/)
 
 ### Browser
 
-Just include [image-sequencer.js](https://publiclab.github.io/image-sequencer/dist/image-sequencer.js) in the Head section of your web page. See the [demo here](https://publiclab.github.io/image-sequencer/)!
+Just include [image-sequencer.min.js](https://github.com/publiclab/image-sequencer/blob/stable/dist/image-sequencer.min.js) in the Head section of your web page. See the [demo here](https://sequencer.publiclab.org)!
 
 ### Node (via NPM)
 
 (You must have NPM for this)
-Add `image-sequencer` to your list of dependancies and run `$ npm install`
+Add `image-sequencer` to your list of dependencies and run `npm install`
 
 ### CLI
 
@@ -65,43 +102,67 @@ $ npm install image-sequencer -g
 
 (You should have Node.JS and NPM for this.)
 
+### To run the debug script
+
+```
+$ npm run debug invert
+```
 
 ## Quick Usage
 
+### Initializing the Sequencer
+
+The Image Sequencer Library exports a function ImageSequencer which initializes a sequencer.
+
+```js
+var sequencer = ImageSequencer();
+```
+
 Image Sequencer can be used to run modules on an HTML Image Element using the
-`replaceImage` method. The method accepts two parameters - `selector` and `steps`.
+`replaceImage` method, which accepts two parameters - `selector` and `steps`.
 `selector` is a CSS selector. If it matches multiple images, all images will be
 modified. `steps` may be the name of a module or array of names of modules.
 
 Note: Browser CORS Restrictions apply. Some browsers may not allow local images
-form other folders, and throw a Security Error instead.
+from other folders, and throw a Security Error instead.
 
 ```js
-  sequencer.replaceImage(selector,steps,optional_options);
+sequencer.replaceImage(selector,steps,optional_options);
 ```
 
-`optional_options` allows to pass additional arguments to the module itself.
+`optional_options` allows passing additional arguments to the module itself.
 
 For example:
 
 ```js
-  sequencer.replaceImage('#photo','invert');
-  sequencer.replaceImage('#photo',['invert','ndvi-red']);
+sequencer.replaceImage('#photo','invert');
+sequencer.replaceImage('#photo',['invert','ndvi-red']);
 ```
 
+### Data URL usage
+
+Since Image Sequencer uses data-urls, you can initiate a new sequence by providing an image in the [data URL format](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs), which will import into the demo and run:
+
+[Try this example link with a very small Data URL](http://sequencer.publiclab.org/examples/#src=data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/2wBDAQcHBwoIChMKChMoGhYaKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCj/wAARCAAQABADASIAAhEBAxEB/8QAFQABAQAAAAAAAAAAAAAAAAAAAAf/xAAUEAEAAAAAAAAAAAAAAAAAAAAA/8QAFQEBAQAAAAAAAAAAAAAAAAAABgj/xAAUEQEAAAAAAAAAAAAAAAAAAAAA/9oADAMBAAIRAxEAPwCdABykX//Z&steps=invert{})
+
+To produce a data URL from an HTML image, see [this nice blog post with example code](https://davidwalsh.name/convert-image-data-uri-javascript).
+
 ## CLI Usage
 
 Image Sequencer also provides a CLI for applying operations to local files. The CLI takes the following arguments:
 
     -i  | --image [PATH/URL] | Input image URL. (required)
     -s  | --step [step-name] | Name of the step to be added. (required)
+    -b  | --basic            | Basic mode only outputs the final image
     -o  | --output [PATH]    | Directory where output will be stored. (optional)
-    -op | --opions {object}  | Options for the step. (optional)
+    -c  | --config {object} | Options for the step. (optional)
+    --save-sequence [string] | Name space separated with Stringified sequence to save
+    --install-module [string] | Module name space seaprated npm package name
 
-The basic format for using the CLI is as follows: 
+The basic format for using the CLI is as follows:
 
 ```
-    $ ./index.js -i [PATH] -s step-name
+$ ./index.js -i [PATH] -s step-name
 ```
 
 *NOTE:* On Windows you'll have to use `node index.js` instead of `./index.js`.
@@ -109,11 +170,36 @@ The basic format for using the CLI is as follows:
 The CLI also can take multiple steps at once, like so:
 
 ```
-    $ ./index.js -i [PATH] -s "step-name-1 step-name-2 ..."
+$ ./index.js -i [PATH] -s "step-name-1 step-name-2 ..."
 ```
 
 But for this, double quotes must wrap the space-separated steps.
 
+Options for the steps can be passed in one line as JSON in the details option like
+```
+$ ./index.js -i [PATH] -s "brightness" -c '{"brightness":50}'
+
+```
+Or the values can be given through the terminal prompt like
+
+<img width="1436" alt="screen shot 2018-02-14 at 5 18 50 pm" src="https://user-images.githubusercontent.com/25617855/36202790-3c6e8204-11ab-11e8-9e17-7f3387ab0158.png">
+
+`save-sequence` option can be used to save a sequence and the associated options for later usage. You should provide a string which contains a name of the sequence space separated from the sequence of steps which constitute it.
+```shell
+sequencer --save-sequence "invert-colormap invert(),colormap()"
+```
+
+`install-module` option can be used to install new modules from npm. You can register this module in your sequencer with a custom namespace separated with the npm package name. Below is an example of the `image-sequencer-invert` module.
+```shell
+sequencer --install-module "invert image-sequencer-invert"
+```
+
+The CLI is also chainable with other commands using `&&`
+
+```
+sequencer -i <Image Path> -s <steps> && mv <Output Image Path> <New path>
+```
+
 ## Classic Usage
 
 ### Initializing the Sequencer
@@ -127,25 +213,27 @@ var sequencer = ImageSequencer();
 ### Loading an Image into the Sequencer
 
 The `loadImage` method is used to load an image into the sequencer. It accepts
-a name and an image. The method also accepts an optional callback.
+an image `src`, either a URL or a data-url. The method also accepts an optional callback.
 
 ```js
-sequencer.loadImage(image_src,optional_callback);
+sequencer.loadImage(image_src, optional_callback);
 ```
+
 On `Node.js` the `image_src` may be a DataURI or a local path or a URL.
 
 On browsers, it may be a DatURI, a local image or a URL (Unless this violates
 CORS Restrictions). To sum up, these are accepted:
+
 * Images in the same domain (or directory - for a local implementation)
 * CORS-Proof images in another domain.
 * DataURLs
 
 return value: **none** (A callback should be used to ensure the image gets loaded)
-The callback is called within the scope of a the sequencer. For example:
+The callback is called within the scope of a sequencer. For example:
 (addSteps is defined later)
 
 ```js
-sequencer.loadImage('SRC',function(){
+sequencer.loadImage('SRC', function(){
   this.addSteps('module-name');
 });
 ```
@@ -155,7 +243,7 @@ In this case, only `'SRC'`.
 
 ### Adding steps to the image
 
-The `addSteps` method is used to add steps on the image. One or more steps can
+The `addSteps` method is used to add steps to the image. One or more steps can
 be added at a time. Each step is called a module.
 
 ```js
@@ -163,11 +251,43 @@ sequencer.addSteps(modules, optional_options);
 ```
 
 If only one module is to be added, `modules` is simply the name of the module.
-If multiple images are to be added, `modules` is an array of the names of modules
-which are to be added, in that particular order.
+If multiple images are to be added, `modules` is an array, which holds the names of modules
+to be added, in that particular order.
 
-optional_otions is just additional parameters, in object form, which you might
-want to provide to the modules. It's an optional parameter.
+optional_options is just an optional parameter, in object form, which you might
+want to provide to the modules.
+
+A variety of syntaxes are supported by Image Sequencer to add multiple steps and configurations quickly for module chaining. The project supports the string syntax, designed to be compact and URL friendly, and JSON, for handling more complex sequences. This can be achieved by passing strings to `sequencer.addStep()`:
+
+
+```js
+sequencer.addSteps('invert,channel');
+sequencer.addSteps(['invert','channel']);
+```
+
+For passing default configurations ({} is optional):
+
+```js
+sequencer.addSteps('brightness{}');
+```
+
+For passing custom configurations:
+
+```js
+sequencer.addSteps('brightness{brightness:80}');
+```
+
+For passing multiple custom configurations:
+
+```js
+sequencer.addSteps('crop{x:120|y:90}')
+```
+
+For passing multiple custom configurable modules:
+
+```js
+sequencer.addSteps('crop{x:130|y:80},brightness{brightness:80}')
+```
 
 return value: **`sequencer`** (To allow method chaining)
 
@@ -181,13 +301,35 @@ modules.
 sequencer.run();
 ```
 
-Additionally, an optional callback can be passed to this method.
+Sequencer can be run with a custom config object
 
 ```js
-sequencer.run(function(out){
+// The config object enables custom progress bars in a node environment and
+// ability to run the sequencer from a particular index(of the steps array)
+
+sequencer.run(config);
+
+```
+
+The config object can have the following keys
+
+```js
+config: {
+  progressObj: , //A custom object to handle progress bar
+  index: //Index to run the sequencer from (defaults to 0)
+}
+```
+
+Additionally, an optional callback function can be passed to this method.
+
+```js
+sequencer.run(function callback(out){
   // this gets called back.
   // "out" is the DataURL of the final image.
 });
+sequencer.run(config,function callback(out){
+  // the callback is supported by all types of invocations
+});
 ```
 
 return value: **`sequencer`** (To allow method chaining)
@@ -196,7 +338,7 @@ return value: **`sequencer`** (To allow method chaining)
 ### Removing a step from the sequencer
 
 The `removeSteps` method is used to remove unwanted steps from the sequencer.
-It accepts the index of the step as an input, or an array of the unwanted indices
+It accepts the index of the step as an input or an array of the unwanted indices,
 if there are more than one.
 
 For example, if the modules ['ndvi-red','crop','invert'] were added in this order,
@@ -216,14 +358,14 @@ return value: **`sequencer`** (To allow method chaining)
 ### Inserting a step in between the sequencer
 
 The `insertSteps` method can be used to insert one or more steps at a given index
-in the sequencer. It accepts the index where the module is to be inserted, name of
+in the sequencer. It accepts the index where the module is to be inserted, the name of
 the module, and an optional options parameter. `index` is the index of the inserted
 step. Only one step can be inserted at a time. `optional_options` plays the same
 role it played in `addSteps`.
 
 Indexes can be negative. Negative sign with an index means that counting will be
 done in reverse order. If the index is out of bounds, the counting will wrap in
-the original direction of counting. So, an `index` of -1 means that the module is
+the original direction of counting. So, an `index` of -1 means the module is
 inserted at the end.
 
 ```js
@@ -232,19 +374,28 @@ sequencer.insertSteps(index,module_name,optional_options);
 
 return value: **`sequencer`** (To allow method chaining)
 
+### Importing an independent module
+
+The `loadNewModule` method can be used to import a new module inside the sequencer. Modules can be downloaded via npm, yarn or CDN and are imported with a custom name. If you wish to load a new module at runtime, it will need to avoid using `require()` -- unless it is compiled with a system like browserify or webpack.
+
+```js
+const module = require('sequencer-moduleName')
+sequencer.loadNewModule('moduleName',module);
+```
+
 
 ## Method Chaining
+
 Methods can be chained on the Image Sequencer:
 * loadImage()/loadImages() can only terminate a chain.
 * run() can not be in the middle of the chain.
 * If the chain starts with loadImage() or loadImages(), the following methods are
 applied only to the newly loaded images.
-* If no name is provided to the image, a name will be generated for it. The name will
-be of the form "image<number>". For ex: "image1", "image2", "image3", etc.
+
 
 Valid Chains:
 ```js
-sequencer.loadImage('red',function(){
+sequencer.loadImage(function(){
   this.addSteps('invert').run(function(out){
     //do something with ouptut.
   });
@@ -259,152 +410,80 @@ sequencer.addSteps('invert').run().addSteps('ndvi-red');
 ```
 
 
-## Multiple Images
-Image Sequencer is capable of handling multiple images at once.
 
-### Initializing a sequencer with multiple images.
-This is just like before.
-```js
-var sequencer = ImageSequencer();
-```
+## Fetching current steps
 
-### Loading Multiple Images into the Sequencer
-
-Multiple images can be loaded by the method `loadImages`. Everything is the same,
-except that now, a unique identification called `image_name` has to be provided
-with each image. This is a string literal.
-
-* 3/2 parameters :
-    ```js
-    sequencer.loadImages(image_name,
-      image_src,optional_callback);
-    ```
-* 1/2 parameters (JSON) :
-    ```js
-    sequencer.loadImages({
-      images: {
-        image1_name: image_src,
-        image2_name: image_src,
-        ...
-      },
-      callback: optional_callback
-    });
-    ```
-
-return value: **none**
-
-
-### Adding Steps on Multiple Images
-
-The same method `addSteps` is used for this. There's just a slight obvious change
-in the syntax that the image name has to be supplied too. `image_name` as well as
-`module_name` in the following examples can be either strings or arrays of strings.
+The `getSteps` method can be used to get the array of current steps in `this` instance of sequencer.For example
 
 ```js
-sequencer.addSteps(image_name,module_name,optional_options);
+sequencer.getSteps()
 ```
 
-If no Image Name is specified, the module is added to **all** images.
+returns an array of steps associated with the current sequencer.
+
+## Saving Sequences
+
+IMAGE SEQUENCER supports saving a sequence of modules and their associated settings in a simple string syntax. These sequences can be saved in the local storage of the browser and inside a JSON file in node.js. sequences can be saved in node context using the CLI option
+
+```shell
+--save-sequence "name stringified-sequence"
+```
+
+In Node and the browser the following function can be used
+```js
+sequencer.saveSequence(name,sequenceString)
+```
+
+The function `sequencer.loadModules()` reloads the modules and the saved sequences into `sequencer.modules` and `sequencer.sequences`
+
+
+## String syntax
+
+Image sequencer supports stringifying a sequence which is appended to the url and hence can then be shared. An example below shows the string syntax for `channel` and `invert` module
+```
+channel{channel:green},invert{}
+```
+
+The use of `()` in place of `{}` for backward compatibility with older links is now **deprecated**. (There is no longer support for the following syntax, and should be avoided)
+```
+channel(channel:green),invert()
+```
+
+Following are the core API functions that can be used to stringify and jsonify steps.
+```js
+sequencer.toString() //returns the stringified sequence of current steps
+sequencer.toJSON(str) // returns the JSON for the current sequence
+sequencer.stringToJSON(str) // returns the JSON for given stringified sequence
+sequencer.importString(str) //Imports the sequence of steps into sequencer
+sequencer.importJSON(obj) //Imports the given sequence of JSON steps into sequencer
+```
+
+Image Sequencer can also generate a string for usage in the CLI for the current sequence of steps:
+```js
+sequencer.toCliString()
+```
+
+
+## Importing steps using JSON array
+
+Image sequencer provides the following core API function to import the given sequence of JSON steps into sequencer.
 
 ```js
-sequencer.addSteps(module_name,optional_options);
+sequencer.importJSON(obj)
 ```
-
-All this can be passed in as JSON:
+It can be implemented the following way for example:
 
 ```js
-sequencer.addSteps({
-  image1_name: {name: module_name, o: optional_options},
-  image2_name: {name: module_name, o: optional_options},
-  ...
-});
-```
+sequencer.importJSON([
+    { name: 'blur', options: {} }
+  ]);
+  ```
+  where name is the name of step to be added, options object can be the one used to provide various params to the sequencer which can customise the default ones.
 
-return value: **`sequencer`** (To allow method chaining)
+To see this in action, please refer to line # 51 of the following:
 
+[test/core/modules/import-export.js](https://github.com/publiclab/image-sequencer/blob/main/test/core/modules/import-export.js)
 
-### Running a Sequencer with multiple images
-
-The same `run` method can be used with a slight change in syntax.
-The `run` method accepts parameters `image` and `from`. `from` is the index from
-where the function starts generating output. By default, it will run across all
-the steps. (from = 1) If no image is specified, the sequencer will be run over **all
-the images**. `image_name` may be an array of image names.
-
-```js
-sequencer.run(); //All images from first step
-```
-
-```js
-sequencer.run(image_name,from); //Image 'image' from 'from'
-```
-
-The `run` method also accepts an optional callback just like before:
-
-```js
-  sequencer.run(image_name,from,function(out){
-    // This gets called back.
-    // "out" is the DataURL of final image.
-  });
-```
-
-JSON Input is also acceptable.
-
-```js
-sequencer.run({
-  image1_name: from,
-  image2_name: from,
-  ...
-});
-```
-
-return value: **`sequencer`** (To allow method chaining)
-
-
-### Removing Steps from an Image
-
-Similarly, `removeSteps` can also accept an `image_name` parameter. Either, both,
-or none of `image_name` and `steps` them may be an array. JSON input is also acceptable.
-
-```js
-sequencer.removeSteps("image_name",[steps]);
-```
-
-```js
-sequencer.removeSteps("image_name",step);
-```
-
-```js
-sequencer.removeSteps({
-  image1_name: [steps],
-  image2_name: [steps],
-  ...
-});
-```
-return value: **`sequencer`** (To allow method chaining)
-
-
-### Inserting steps on an image
-
-The `insertSteps` method can also accept an `image_name` parameter. `image_name`
-may be an array. Everything else remains the same. JSON Inout is acceptable too.
-
-```js
-sequencer.insertSteps("image",index,"module_name",o);
-```
-```js
-sequencer.insertSteps([image],index,"module_name",o);
-```
-```js
-sequencer.insertSteps({
-  image1: [
-    {index:index1, name: module_name1, o:optional_options1},
-    {index:index2, name: module_name2, o:optional_options2},
-    ...
-  ]
-});
-```
-return value: **`sequencer`** (To allow method chaining)
 
 
 ## Creating a User Interface
@@ -421,6 +500,10 @@ for a module. This can be used, for instance, to update the DIV with the new ima
 and remove the loading GIF generated above.
 * `onRemove` : This event is triggered when a module is removed. This can be used,
 for instance, to remove the DIV generated above.
+* `notify` : This event is triggered whenever we need to shoot a notification to the
+user-interface.For example when the step is not available, we can shoot a notification,
+by sending appropriate message.For HTML UI it adds a DOM node to the browser, for CLI
+and node , it logs the notification output to the respective console.
 
 How to define these functions:
 
@@ -429,7 +512,8 @@ sequencer.setUI({
   onSetup: function(step) {},
   onDraw: function(step) {},
   onComplete: function(step) {},
-  onRemove: function(step) {}
+  onRemove: function(step) {},
+  notify: function(msg,id) {}
 });
 ```
 
@@ -472,10 +556,71 @@ sequencer.setUI({
 });
 ```
 
-Note: `identity.imageName` is the "name" of that particular image. This name can
-be specified while loading the image via `sequencer.loadImage("name","SRC")`. If
-not specified, the name of a loaded image defaults to a name like "image1",
-"image2", et cetra.
+## Using multiple images on same sequencer:
 
-Details of all modules can be sought using `sequencer.modulesInfo()`.
+Image Sequencer object supports one imageURL at a time.
+
+Adding a seccond image to same sequencer will result to adding same set of steps added to prior image and flushing out the previous one.
+
+```js
+s1 = new ImageSequencer(...);
+s1.loadImage(url1);
+s1.addSteps('blur');
+s1.run();
+s1.addImage(url2);
+s1.run();
+```
+However if we want to use more than one image, we can either initialize a sequencer for each image like:
+
+```js
+sequencer1 = new ImageSequencer(...);
+sequencer1.loadImage(...);
+sequencer1.addSteps(steps);
+sequencer1.run();
+
+sequencer2 = new ImageSequencer(...);
+sequencer2.loadImage(...);
+sequencer2.addSteps(steps);
+sequencer2.run();
+```
+
+
+
+**Note**: Details of all modules can be sought using `sequencer.modulesInfo()`.
 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
+
+Any module which uses the `changePixel` function gets WebAssembly acceleration (`wasm`). Both node and browser code use WebAssembly and the only code which falls back to non-`wasm` code is the [browserified unit tests](https://github.com/publiclab/image-sequencer/blob/main/test/core/sequencer/benchmark.js).
+
+The main advantage we get using `wasm` is blazing fast speed attained in processing pixels for many modules that is very clear from [checking module benchmarks](https://travis-ci.org/publiclab/image-sequencer/jobs/544415673#L1931).
+
+
+The only limitation is that browser and node code for `wasm` had to be written separately, and switched between. This is because in browser we use `fetch` to retrieve the compiled `wasm` program while in node we use the `fs` module, each of which cannot be used in the other's environment.
+
+
+`wasm` mode is enabled by default. If you need to force this mode to be on or off, you can use the `useWasm` option when initializing ImageSequencer:
+
+```js
+let sequencer = ImageSequencer({useWasm:true}) // for wasm mode or simply
+
+let sequencer = ImageSequencer() // also for wasm mode i.e. default mode
+
+let sequencer = ImageSequencer({useWasm:false}) //for non-wasm mode 
+
+```
+
+## Experimental GIF processing support
+
+ImageSequencer currently can process GIFs but only for most of the modules. Every frame of the GIF is manipulated sequentially (parallel processing would be preferable in the future).
+The final frames are then converted back to a GIF but in the process, the time duration of each frame is lost and defaults to `0.1s`.
+
+Modules that do not work:
+1. ColorBar (Will get fixed upon fixing overlay as this is a meta module which uses overlay)
+2. FisheyeGL
+3. Overlay
+4. Blend
+5. Histogram
+6. WebGL Distort

docs/MODULES.md

@@ -1,10 +1,260 @@
 Documentation of various Modules
 ===
 
-## Crop Module (crop)
+List of Module Documentations
+
+1.  [Add QR](#Add-QR-module)
+2.  [Average](#average-module)
+3.  [Blend](#blend-module)
+4.  [Blur](#blur-module)
+5.  [Brightness](#brightness-module)
+6.  [Canvas-Resize](#canvas-resize-module)
+7.  [Channel](#channel-module)
+8.  [Colorbar](#colorbar-module)
+9.  [Colormap](#colormap-module)
+10. [ColorTemperature](#color-temperature)
+11. [Contrast](#contrast-module)
+12. [Convolution](#convolution-module)
+13. [Crop](#crop-module)
+14. [DecodeQr](#decodeQr-module)
+15. [Dither](#dither-module)
+16. [DrawRectangle](#draw-rectangle-module)
+17. [Dynamic](#dynamic-module)
+18. [Edge-Detect](#edge-detect-module)
+19. [Exposure](#exposure-module)
+20. [FisheyeGl](#fisheyeGl-module)
+21. [FlipImage](#flipimage-module)
+22. [Gamma-Correction](#gamma-correction-module)
+23. [Gradient](#gradient-module)
+24. [Grid-Overlay](#grid-overlay)
+25. [Histogram](#histogram-module)
+26. [Import-image](#import-image-module)
+27. [Invert](#invert-module)
+28. [MinifyImage](#minify-image)
+29. [Ndvi](#ndvi-module)
+30. [Ndvi-Colormap](#ndvi-colormap-module)
+31. [NoiseReduction](#noise-reduction)
+32. [Overlay](#overlay-module)
+33. [PaintBucket](#paint-bucket-module)
+34. [ReplaceColor](#replacecolor-module)
+35. [Resize](#resize-module)
+36. [Rotate](#rotate-module)
+37. [Saturation](#saturation-module)
+38. [Segmented-Colormap](#segmented-colormap-module)
+39. [Sharpen](#sharpening-module)
+40. [Text-Overlay](#text-overlay)
+41. [Threshold](#threshold)
+42. [Tint](#tint)
+43. [WebGL-Distort](#webgl-distort-module)
+44. [White-Balance](#white-balance-module)
+
+
+## add-qr-module
+
+This module Adds QR corresponding to the given string.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('add-qr',options)
+           .run()
+```
+
+where `options` is an object with the following properties:
+* size : size of QR code in pixels (default 200)
+* qrCodeString : input string to generate QR code
+
+
+## average-module
+
+This module is used for averaging all the pixels of the image.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('average',options)
+           .run()
+```
+
+
+## blend-module
+
+This module is used for blending two images. For More info read:  _[wiki](https://en.wikipedia.org/wiki/Blend_modes)_
+
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('blend',options)
+           .run()
+```
+
+where `options` is an object with the following properties:
+* offset: step of image with which current image is to be blended(Two steps back is -2, three steps back is -3 etc; default -2) 
+* blendMode: Blending mode to use for blending two images by default it uses the given function
+* func: function used to blend two images (default : function(r1, g1, b1, a1, r2, g2, b2, a2) { return [ r1, g2, b2, a2 ] })
+
+[More info for different blend modes can be found here](http://docs.gimp.org/en/gimp-concepts-layer-modes.html)
+
+
+## Blob Analysis
+
+This module uses Opencv.js for detecting and marking blob/region in microscopic images. It requires an opencv.js file to 
+be loaded before using the functionalities which is currently being loaded to the webpage via script.It supports both environments, Node.js and browser for processing. 
+
+As the size of opencv.js file is quite large, the future versions will focus on loading it asynchronously, on demand of the the module to optimise performance.
+
+#### Usage
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('blob-analysis')
+           .run()
+```
+
+## blur-module
+
+This module is used for applying a Gaussian blur effect.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('blur',options)
+           .run()
+```
+
+where `options` is an object with the following property:
+* blur : Intensity of Gaussian blur (0 to 5; default 2)
+
+
+## brightness-module
+
+This module is used for changing the brightness of the image.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('brightness',options)
+           .run()
+```
+
+where `options` is an object with the following property:
+* brightness : brightness of the image in percentage (0 to 100; default 100)
+
+
+## canvas-resize-module
+
+This module is used for resizing the canvas of the image.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('canvas-resize',options)
+           .run()
+```
+
+where `options` is an object with the following property:
+* width: final width of the canvas (default 1000)
+* height: final height of the canvas (default 1000)
+* x: x-coordinate of the top left of the image on the canvas (default 500)
+* y: y-coordinate of the top left of the image on the canvas (default 500)
+
+
+## channel-module
+
+This module is used for forming a grayscale image by applying one of the three primary colors.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('channel',options)
+           .run()
+```
+
+where `options` is an object with the following property:
+* channel : color of the channel (red, green, blue; default green)
+
+
+## colorbar-module
+
+This module is used for displaying an image with a colorbar.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('colorbar',options)
+           .run()
+```
+
+where `options` is an object with the following properties:
+* colormap : Name of the Colormap(default, greyscale, stretched, fastie, brntogrn, blutoredjet,                 colors16; default: default)
+* x : X-position of the image on which the new image is overlayed (default 0)
+* y : Y-position of the image on which the new image is overlayed (default 0)
+* h : height of resulting cropped image (default : 50% of input image width )
+
+
+## colormap-module
+
+This module is used for mapping brightness values (average of red, green & blue) to a given color  lookup table, made up of a set of one more color gradients.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('colormap',options)
+           .run()
+```
+
+where `options` is an object with the following property:
+* colormap : Name of the Colormap ( greyscale, stretched, fastie, brntogrn, blutoredjet,                        colors16)
+
+
+## Color Temperature
+
+This changes the color temperature of the image.
+## Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('color-temperature',options)
+           .run()
+```
+where `options` is an object with the following property:
+* temperature : temperature between 0 - 40,000 kelvin (default 6000)
+
+
+## contrast-module
+
+This module is used for changing the contrast of the image.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('contrast',options)
+           .run()
+```
+
+where `options` is an object with the following property:
+* contrast : contrast for the given image (-100 to 100; default : 70)
+
+
+## convolution-module
+
+This module is used for performing image-convolution.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('convolution',options)
+           .run()
+```
+
+where `options` is an object with the following properties:
+* constantFactor : a constant factor, multiplies all the kernel values by that factor (default :                     1/9)
+* kernelValues : nine space separated numbers representing the kernel values in left to right and                   top to bottom format(default : 1 1 1 1 1 1 1 1 1)
+
+
+## crop-module
 
 This module is used to crop an image.
-
 #### Usage
 
 ```js
@@ -24,10 +274,379 @@ Where `options` is an object having the properties `x`, `y`, `w`, `h`. This diag
 * `options.h` : half of image height
 
 
-## Segmented Colormap Module (segmented-colormap)
+## decodeQr-module
+
+This module is used for decoding a QR in image (if present).
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('decode-qr',options)
+           .run()
+```
+
+## dither-module
+
+This module approximates a color from a mixture of other colors when the required color is not available, creating illusions of the color that is not present actually.
+
+[more info on wikipedia](https://en.wikipedia.org/wiki/Dither)
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('dither',options)
+           .run()
+```
+where `options` is an object with the following property:
+* dither : Can select the name of the Dithering Algorithm(default none)
+ 
+
+## draw-rectangle-module
+
+This module helps to draw a rectangle on the image with a starting and ending corner with the specified thickness and color of the border.
+## Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('draw-rectangle',options)
+           .run()
+```
+where `options` is an object with the following properties:
+* startingX : starting x position of the rectangle (default 0)
+* startingY : starting y position of the rectangle (default 0)
+* endX      : last x position of the rectangle (default "width")
+* endY      : last y position of the rectangle (default "height")
+* thickness : thickness of the border (default 1)
+* color     : RGBA values separated by a space (default "0 0 0 255") 
+
+
+## dynamic-module
+
+This module is used for producing each color channel based on the original image's color.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('dynamic',options)
+           .run()
+```
+
+where `options` is an object with the following properties:
+* red : expression for red channel (R, G, B and A as inputs; default r)
+* green : expression for green channel (R, G, B and A as inputs; default g)
+* blue : expression for blue channel (R, G, B and A as inputs; default b)
+* monochrome: fallback for other channels if none provided (default : r+g+b/3)
+
+
+## edge-detect-module
+
+This module is used for detecting images.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('edge-detect',options)
+           .run()
+```
+
+where `options` is an object with the following properties:
+* blur :  Intensity of Gaussian blur (0 to 5; default 2)
+* highThresholdRatio : Upper Threshold Ratio ( default : 0.2)
+* lowThresholdratio : Lower Threshold Ratio ( default : 0.2)
+
+
+## exposure-module
+
+This module is used for changing the exposure of the image.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('exposure',options)
+           .run()
+```
+
+where `options` is an object with the following property:
+* exposure: exposure value for the new image (-3 to 4; default 1)
+
+
+## fisheyeGl-module
+
+This module is used for correcting Fisheye or Lens Distortion
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('fisheye-gl',options)
+           .run()
+```
+
+where `options` is an object with the following properties:
+* a : a correction (0 to 4; default 1)
+* b : b correction (0 to 4; default 1)
+* Fx : x correction (0 to 4; default 1)
+* Fy : y correction (0 to 4; default 1)
+* scale : The ratio to which the original image is to be scaled (0 to 20; default 1.5)
+* x : Field of View x (0 to 2; default 1)
+* y : Field of View y (0 to 2; default 1)
+
+
+## flipimage-module 
+
+This module is used for flipping the image on the selected axis.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('flip-image',options)
+           .run()
+```
+
+where `options` is an object with the following properties:
+* Axis : select the required axis (default : vertical)
+
+
+## gamma-correction-module
+
+This module is used for applying gamma correction.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('gamma-correction',options)
+           .run()
+```
+
+where `options` is an object with the following property:
+* adjustment : Inverse of actual gamma factor (default 0.2)
+
+
+## gradient-module
+
+This module is used for finding gradient of the image.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('gradient',options)
+           .run()
+```
+
+
+## Grid Overlay
+
+This adds the grid over an image.
+## Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('grid-overlay',options)
+           .run()
+```
+where `options` is an object with the following property:
+* options.x : The value at which the grid line should start in x-axis.
+* options.y : The value at which the grid line should start in y-axis.
+* color : Color for the grid on the image.
+
+
+## histogram-module
+
+This module is used for calculating histogram of the image.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('histogram',options)
+           .run()
+```
+
+where `options` is an object with the following property:
+* gradient : boolean value used to toggle gradient along x-axis (true or false; default true)
+
+
+## import-image-module
+
+This module is used for importing a new image and replacing the original with it.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('import-image',options)
+           .run()
+```
+
+where `options` is an object with the following property:
+* url : url of the  new image (local image url or data url;default : "./images/monarch.png")
+
+
+## invert-module
+
+This module is used for inverting the image.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('invert',options)
+           .run()
+```
+
+
+## Minify Image
+
+This module minifies the image using lossy compression that is the image-dimensions are not lost but the size is reduced.
+
+The module supports jpg/jpeg/webp images in browser; but the node version supports all of the types.
+#### Usage
+
+```js
+sequencer.loadImage('PATH')
+           .addSteps('minify-image')
+           .run()
+```
+
+
+## ndvi-module  
+
+This module is used for applying ndvi technique to the image.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('ndvi',options)
+           .run()
+```
+
+where `options` is an object with the following property:
+* filter : filter for NDVI (blue or red; default red)
+
+
+## ndvi-colormap-module
+
+This module is used for demonstrating ndvi and colormap properties consecutively.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('ndvi-colormap',options)
+           .run()
+```
+
+
+## Noise-Reduction
+
+Noise in an image are atypical pixels that are not representing the color or the exposure of the scene correctly. This Noise Reduction module reduces the noise in the image by using either median filtering or mean filtering techniques to change the RGB value of the pixels to create a smoother and fuller image.
+
+#### Usage
+```js
+    sequencer.loadImage('PATH')
+             .addSteps('noise-reduction',options)
+             .run()
+```
+where `options` is an object with the property `method`. `options.method` can be:
+* Median Filtering: Set the RGB value of the pixel to the median RGB pixel value of all adjacent pixels (maximum 8 adjacent pixels and itself)
+* Mean Filtering: Set the RGB value of the pixel to the mean RGB pixel value of all adjacent pixels (maximum 8 adjacent pixels and itself)
+
+
+## overlay-module
+
+This module is used for overlaying an Image over another .
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('overlay',options)
+           .run()
+```
+
+where `options` is an object with the following properties:
+* x : X-position of the image on which the new image is overlayed (default 0)
+* y : Y-position of the image on which the new image is overlayed (default 0)
+* offset : offset to the step on which the output of the last step is overlayed (default -2)
+
+
+## paint-bucket-module
+
+This module fills any polygonal shape with the specified color in pixels.
+## Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('paint-bucket',options)
+           .run()
+```
+
+where `options` is an object with the following property:
+* startingX : it is the value of the starting x-cordinate (default 10)
+* startingY : it is the value of the starting y-cordinate (default 10)
+* fillColor : they are four spaced seperated numbers representing the RGBA values of fill-color (default "100 100 100 255")
+* tolerance : it is the % tolerance (default 10)
+
+
+## replacecolor-module
+
+This module is used in replacing the color with grey or any desired color.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('replace-color',options)
+           .run()
+```
+where `options` is an object with the following properties:
+* replaceMethod : replaces with the desired color (default greyscale)
+* replaceColor : three space separated numbers representing the RGB values of color to be filled (default "0 0 255")
+* color : three space separated numbers representing the RGB values of color to be replaced (default "228 86 81")
+* tolerance : it is the % tolerance (default 50)
+
+
+## resize-module
+
+This module is used for resizing an image.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('resize',options)
+           .run()
+```
+
+where `options` is an object with the following property:
+* resize : Percentage value of resize (default 125%)
+
+
+## rotate-module
+
+This module is used for rotating an image.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('rotate',options)
+           .run()
+```
+
+where `options` is an object with the following property:
+* rotate : angular value for rotation in degrees (between 0 and 360; default 0)
+
+
+## saturation-module
+
+This module is used for changing the saturation of the image.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('saturation',options)
+           .run()
+```
+
+where `options` is an object with the following property:
+* saturation : saturation for the new image (between 0 and 2; default 0)
+
+
+## segmented-colormap-module
 
 This module is used to map the pixels of the image to a segmented colormap.
-
 #### Usage
 
 ```js
@@ -48,23 +667,95 @@ where `options` is an object with the property `colormap`. `options.colormap` ca
 
 * A custom array.
 
-## FisheyeGl (fisheye-gl)
 
-This module is used for correcting Fisheye or Lens Distortion
+## sharpen-module
 
+This module is used to sharpen the pixels of the image using a 3x3 convolution filter.
 #### Usage
 
 ```js
   sequencer.loadImage('PATH')
-           .addSteps('fisheye-gl',options)
+           .addSteps('sharpen',options)
            .run()
 ```
 
-where `options` is an object with the following properties:
-* a : a correction (0 to 4; default 1)
-* b : b correction (0 to 4; default 1)
-* Fx : x correction (0 to 4; default 1)
-* Fy : y correction (0 to 4; default 1)
-* scale : The ratio to which the original image is to be scaled (0 to 20; default 1.5)
-* x : Field of View x (0 to 2; default 1)
-* y : Field of View y (0 to 2; default 1)
+where `options` is an object with the property `sharpenStrength`, which can be set to achieve the desired level of sharpening on the image.
+
+
+## Text Overlay
+
+The modules allows to add text to image in both browser and node environment. We have the options to modify the font-size and also support few font-styles. The text color can also be modified.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('grid-overlay',options)
+           .run()
+```
+The options can take various attributes like,
+var options = { text : 'Hello World', size : '12'};
+
+
+## Threshold 
+
+Thresholding is used to create binary images.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('threshold',options)
+           .run()
+```
+where `options` is an object with the following property:
+* threshold : it allows to select the types of thresholding (default "manual thresholding")
+* input : it allows to select the range of thresholding value (default 120)
+
+
+## Tint 
+
+It adds color tint to an image
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('tint',options)
+           .run()
+```
+where `options` is an object with the following property:
+* color : RGB values seperated by a space (default "0 0 255")
+* factor : amount of tint (default 0.5)
+
+
+## webgl-distort-module
+
+This module is used for transforming the perspective of images based on corner coordinates.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('webgl-distort',options)
+           .run()
+```
+
+where `options` is an object with the following property:
+* nw: top-left corner x and y coordinates separated by a comma (default "0,100")
+* ne: top-right corner x and y coordinates separated by a comma (default "1023,-50")
+* se: bottom-right corner x and y coordinates separated by a comma (default "1223,867")
+* sw: bottom-left corner x and y coordinates separated by a comma (default "100,767")
+
+
+## white-balance-module
+
+This module is used for rendering neutral colors of an image correctly based on the whitest pixel in the image.
+#### Usage
+
+```js
+  sequencer.loadImage('PATH')
+           .addSteps('white-balance',options)
+           .run()
+```
+
+where `options` is an object with the following property:
+* red: red component of the whitest pixel (default 255)
+* green: green component of the whitest pixel (default 255)
+* blue: blue component of the whitest pixel (default 255)

examples/demo.css

@@ -1,14 +1,10 @@
 /* https://github.com/theleagueof/league-spartan */
 @font-face {
-    font-family: 'League Spartan';
-    src: url('https://raw.githubusercontent.com/theleagueof/league-spartan/master/_webfonts/leaguespartan-bold.eot');
-    src: url('https://raw.githubusercontent.com/theleagueof/league-spartan/master/_webfonts/leaguespartan-bold.eot?#iefix') format('embedded-opentype'),
-         url('https://raw.githubusercontent.com/theleagueof/league-spartan/master/_webfonts/leaguespartan-bold.woff2') format('woff2'),
-         url('https://raw.githubusercontent.com/theleagueof/league-spartan/master/_webfonts/leaguespartan-bold.woff') format('woff'),
-         url('https://raw.githubusercontent.com/theleagueof/league-spartan/master/_webfonts/leaguespartan-bold.ttf') format('truetype'),
-         url('https://raw.githubusercontent.com/theleagueof/league-spartan/master/_webfonts/leaguespartan-bold.svg#league_spartanbold') format('svg');
-    font-weight: bold;
-    font-style: normal;
+  font-family: 'League Spartan';
+  src: url('https://cdn.jsdelivr.net/npm/fontsource-league-spartan@3/files/league-spartan-latin-600-normal.woff2') format('woff2'),
+       url('https://cdn.jsdelivr.net/npm/fontsource-league-spartan@3/files/league-spartan-latin-600-normal.woff') format('woff');
+  font-weight: bold;
+  font-style: normal;
 }
 
 body {
@@ -18,20 +14,47 @@ body {
   background: #f8f8fa;
 }
 
+footer {
+  margin-top: 40px;
+}
+
 h1 {
   font-family: 'League Spartan';
   color: #445;
 }
 
+body > .container,
+body > .container-fluid {
+}
+
+.center-align {
+  display: flex;
+  justify-content: left;
+  text-align:center;
+}
+
 .header {
   text-align: center;
 }
 
+.panel {
+  margin-left: 20px;
+  margin-right: 20px;
+}
+
+.mouse {
+  cursor: pointer !important;
+}
+
 .nomargin {
   margin: 0 !important;
 }
 
-#dropzone {
+.form-control[type="range"] {
+  padding: 0px 0px;
+}
+
+.dropzone {
   padding: 30px;
   margin: 0 20% 30px;
   border: 4px dashed #ccc;
@@ -40,12 +63,23 @@ h1 {
   color: #444;
 }
 
-.hover {
-  background: #eee;
+.dropzone input {
+  max-width: 100%;
 }
 
-#dropzone input {
-  max-width: 100%;  
+.import-image-zone {
+  margin: 10px auto 30px auto;
+  max-width: 250px;
+  min-width: 230px;
+}
+
+.import-image-zone input {
+  max-width: 100%;
+}
+
+.hover {
+  border: 4px dashed #888888;
+  background: #F0F0F0;
 }
 
 .step {
@@ -56,17 +90,6 @@ h1 {
   margin-bottom: 20px;
 }
 
-.details {
-  border-top: 3px solid #444;
-  padding-left: 6px;
-}
-
-.details h3 {
-  font-family: monospace;
-  margin-top: 12px;
-  font-size: 1.3em;
-}
-
 .det {
   padding: 10px 16px;
   text-decoration: italic;
@@ -76,11 +99,27 @@ h1 {
   margin: 10px 0;
 }
 
+.load {
+  padding: 30px;
+  background: #eee;
+  border-radius: 8px;
+  text-align: center;
+  font-size: 2em;
+  color: #444;
+}
+
 #addStep {
   max-width: 500px;
   margin: 20px auto;
 }
 
+#add-step-btn{
+  width: 100%
+}
+.selectize-input {
+  width: 100%;
+}
+
 #addStep .labels {
   text-align: right;
   padding: 6px;
@@ -98,3 +137,267 @@ h1 {
   text-align: center;
   margin: 10px;
 }
+#save-seq {
+  display: block;
+  margin: 0px 10px 0px 0px;
+  width: 250px;
+}
+.info {
+  padding: 8px;
+  text-align: center;
+}
+#gif {
+  display: block;
+  margin: 0px 0px 0px 10px;
+  width: 250px;
+}
+
+@media(max-width: 768px) {
+    #dropzone {
+      margin: 0 0% 30px;
+    }
+}
+
+#dwnld {
+  max-width: 500px;
+  margin: 20px auto;
+}
+
+#gif_element {
+  display: block;
+  margin: 0 auto;
+  width: 100%;
+  height: auto;
+}
+
+#move-up {
+  position: fixed;
+  bottom: 30px;
+  right: 20px;
+  z-index: 550;
+  display: none;
+  background:transparent;
+  border:none;
+}
+
+#move-up i {
+  font-size:50px;
+  opacity:0.7;
+  color:#BABABA;
+}
+
+@media (max-width: 768px), (max-height 700px) {
+  #move-up {
+    display: none !important; /* !important is used to override the jQuery style */
+  }
+}
+
+.btn-circle{
+  min-width: 80px;
+  min-height: 80px;
+  text-align: center;
+  display: flex !important;
+  flex-direction: column;
+  padding: 6px 0;
+  font-size: 12px;
+  line-height: 1.42;
+  border-radius: 10px;
+  margin-left: 5px;
+  margin-right: 5px;
+}
+.radio{
+  cursor:pointer;
+  overflow: hidden;
+  height: 80px;
+  width: 80px;
+  margin-left: 5px;
+  margin-right: 5px;
+}
+
+.radio-group {
+  margin-bottom: 20px;
+  overflow: auto;
+}
+
+.no-border {
+  border: 0px;
+}
+
+.savesequencemsg{
+  display: none;
+  text-align: center;
+}
+
+.notification {
+  background-color: #808b96;
+  padding:4px;
+  color:white;
+  border-radius:3px;
+  font-size:2rem;
+  position:fixed;
+  bottom:2px;
+  left:50%;
+  min-width:14rem;
+  text-align:center;
+  display:none;
+  transform: translate(-50%, -50%);
+}
+
+#resetButton {
+  margin-top: 20px;
+}
+
+.i-over {
+  position: absolute;
+  left: 15px;
+  top: 15px;
+  z-index: 2;
+  color: white;
+}
+
+.i-small {
+  left: 25px;
+}
+
+@media all and (max-width: 767px) {
+  .center-align {
+    justify-content: space-between;
+  }
+}
+a.name-header{
+  text-decoration: none;
+  color: #445;
+}
+
+.step-column{
+  display:flex;
+  align-content: center;
+  justify-content: center;
+}
+
+.trash-container button.btn-xs {
+  position: relative;
+  bottom: 7px;
+}
+
+.toggleIcon {
+  transition: transform 0.2s;
+}
+
+.rotated {
+  transform: rotate(180deg);
+}
+
+#gif{
+  margin-left:0px;
+  margin-top:5px;
+  width:100%;
+}
+.save-button{
+  margin-top:20px;
+  margin-bottom:0px;
+  align:center;
+  width:100%;
+}
+
+.toggle {
+  cursor: default;
+}
+
+.general-tooltip:hover{
+  text-decoration: none;
+}
+
+.general-tooltip:focus{
+  outline: none;
+}
+
+.general-tooltip:focus-within{
+  outline: none;
+}
+
+.general-tooltip{
+  position: relative;
+  bottom: 7px;
+  font-size: 16px;
+  color: #444;
+}
+
+#version-number-text {
+  text-align: center;
+  padding-top: 100px;
+  color: gray;
+}
+#version-number-top-right {
+  position: fixed;
+  right: 2%;
+  top: 5%;
+  color: gray;
+}
+/* Non float rightward alignment*/
+.right {
+  margin-left: auto;
+  display: block;
+}
+
+#update-prompt-modal,.notify-box {
+ visibility: hidden;
+ min-width: 250px;
+ margin-left: -125px;
+ background-color: #333;
+ color: #fff;
+ text-align: center;
+ border-radius: 8px;
+ padding: 16px;
+ position: fixed;
+ z-index: 1000;
+ left: 10%;
+ top: 30px;
+}
+
+#update-prompt-modal {
+  width: 30vw;
+  margin: 0.2rem;
+}
+
+.notify-box {
+  width:34vw;
+  padding:18px;
+  border-radius:8px;
+  margin-left:0.8rem;
+  text-align:left;
+  color:#333;
+  background:#c3c3c3;
+}
+
+/* Bootstrap class for display none remove it after updating to version v4 */
+.d-none {
+  display:none;
+}
+
+/* Bootstrap class for display block remove it after updating to version v4 */
+.d-block {
+  display:block;
+}
+
+#update-prompt-modal.show,.notify-box {
+ visibility: visible;
+ -webkit-animation: fadein 0.5s;
+ animation: fadein 0.5s;
+}
+@-webkit-keyframes fadein {
+ from {
+   opacity: 0;
+ }
+ to {
+   opacity: 1;
+ }
+}
+@keyframes fadein {
+ from {
+   opacity: 0;
+ }
+ to {
+   opacity: 1;
+ }
+}

examples/demo.js

@@ -1,179 +1,354 @@
-window.onload = function() {
+var defaultHtmlSequencerUi = require('./lib/defaultHtmlSequencerUi.js'),
+  setupCache = require('./lib/cache.js'),
+  intermediateHtmlStepUi = require('./lib/intermediateHtmlStepUi.js'),
+  DefaultHtmlStepUi = require('./lib/defaultHtmlStepUi.js'),
+  urlHash = require('./lib/urlHash.js'),
+  insertPreview = require('./lib/insertPreview.js'),
+  versionManagement = require('./lib/versionManagement.js'),
+  isGIF = require('../src/util/isGif');
 
-  sequencer = ImageSequencer();
 
-  // Load information of all modules (Name, Inputs, Outputs)
-  var modulesInfo = sequencer.modulesInfo();
-
-  // Add modules to the addStep dropdown
-  for(var m in modulesInfo) {
-    $('#addStep select').append(
-      '<option value="'+m+'">'+modulesInfo[m].name+'</option>'
-    );
-  }
-
-  // Initial definitions
-  var steps = document.querySelector('#steps');
-  var parser = new DOMParser();
-  var reader = new FileReader();
-
-  // Set the UI in sequencer. This Will generate HTML based on
-  // Image Sequencer events :
-  // onSetup : Called every time a step is added
-  // onDraw : Called every time a step starts draw
-  // onComplete : Called every time a step finishes drawing
-  // onRemove : Called everytime a step is removed
-  // The variable 'step' stores useful data like input and
-  // output values, step information.
-  // See documetation for more details.
-  sequencer.setUI({
-
-    onSetup: function(step) {
-
-      if (step.options && step.options.description) step.description = step.options.description
-
-      step.ui = '\
-      <div class="row step">\
-        <div class="col-md-4 details">\
-          <h3>'+step.name+'</h3>\
-          <p><i>'+(step.description || '')+'</i></p>\
-        </div>\
-        <div class="col-md-8">\
-          <img alt="" class="img-thumbnail"/>\
-        </div>\
-      </div>\
-      ';
-
-      var tools =
-      '<div class="tools btn-group">\
-         <button confirm="Are you sure?" class="remove btn btn-xs btn-default">\
-           <i class="fa fa-trash"></i>\
-         </button>\
-      </div>';
-
-      step.ui = parser.parseFromString(step.ui,'text/html');
-      step.ui = step.ui.querySelector('div.row');
-      step.imgElement = step.ui.querySelector('img');
-
-      if(sequencer.modulesInfo().hasOwnProperty(step.name)) {
-        var inputs = sequencer.modulesInfo(step.name).inputs;
-        var outputs = sequencer.modulesInfo(step.name).outputs;
-        var io = Object.assign(inputs, outputs);
-        for (var i in io) {
-          var div = document.createElement('div');
-          div.className = "row";
-          div.setAttribute('name', i);
-          div.innerHTML = "<div class='det'>\
-                             <label for='" + i + "'>" + i + "</label>\
-                             <input name=" + i + " class='form-control' style='width:50%' type='text' />\
-                           </div>";
-          step.ui.querySelector('div.details').appendChild(div);
-        }
-        $(step.ui.querySelector('div.details')).append("<p><button class='btn btn-default btn-save'>Save</button></p>");
-
-        // on clicking Save in the details pane of the step
-        $(step.ui.querySelector('div.details .btn-save')).click(function saveOptions() {
-          $(step.ui.querySelector('div.details')).find('input').each(function(i, input) {
-            step.options[$(input).attr('name')] = input.value;
-          });
-          sequencer.run();
-        });
+window.onload = function () {
+  sequencer = ImageSequencer(); // Set the global sequencer variable
+  
+  options = {
+    sortField: 'text',
+    openOnFocus: false,
+    onInitialize: function () {
+      this.$control.on('click', () => {
+        this.ignoreFocusOpen = true;
+        setTimeout(() => {
+          // Trigger onFocus and open dropdown.
+          this.ignoreFocusOpen = false;
+        }, 50);
+      });
+    },
+    // Open dropdown after timeout of onClick.
+    onFocus: function () {
+      if (!this.ignoreFocusOpen) {
+        this.open();
       }
+    }
+  };
 
-      if(step.name != "load-image")
-        step.ui.querySelector('div.details').appendChild(
-          parser.parseFromString(tools,'text/html')
-                .querySelector('div')
+  versionManagement.getLatestVersionNumber(function(versionNumber) {
+    console.log('The latest NPM version number for Image Sequencer (from GitHub) is v' + versionNumber);
+  });
+  console.log('The local version number for Image Sequencer is v' + versionManagement.getLocalVersionNumber());
+
+  function displayVersionNumber() {
+    $('#version-number-text').text('Image Sequencer v' + versionManagement.getLocalVersionNumber());
+    $('#version-number-top-right').text('v' + versionManagement.getLocalVersionNumber());
+  }
+  displayVersionNumber();
+
+  function refreshOptions(options) {
+    // Default options if parameter is empty.
+    if (options == undefined) options = { sortField: 'text' };
+    // Load information of all modules (Name, Inputs, Outputs)
+    var modulesInfo = sequencer.modulesInfo();
+
+    var addStepSelect = $('#addStep select');
+    addStepSelect.html('');
+
+    // Add modules to the addStep dropdown
+    for (var m in modulesInfo) {
+      if (modulesInfo[m] && modulesInfo[m].name)
+        addStepSelect.append(
+          '<option value="' + m + '">' + modulesInfo[m].name + '</option>'
         );
+    }
+    // Null option
+    addStepSelect.append('<option value="" disabled selected>Select a Module</option>');
+    addStepSelect.selectize(options);
+  }
+  refreshOptions(options);
 
-      steps.appendChild(step.ui);
-    },
+  $(window).on('scroll', scrollFunction);
 
-    onComplete: function(step) {
-      step.imgElement.src = step.output;
-      if(sequencer.modulesInfo().hasOwnProperty(step.name)) {
-        var inputs = sequencer.modulesInfo(step.name).inputs;
-        var outputs = sequencer.modulesInfo(step.name).outputs;
-        for (var i in inputs) {
-          if (step.options[i] !== undefined) step.ui.querySelector('div[name="'+i+'"] input')
-                                                 .value = step.options[i];
-        }
-        for (var i in outputs) {
-          if (step[i] !== undefined) step.ui.querySelector('div[name="'+i+'"] input')
-                                         .value = step[i];
+  /**
+   * @description Method to toggle the scroll-up arrow.
+   */
+  function scrollFunction(A, B) {
+    var shouldDisplay = $('body').scrollTop() > 20 || $(':root').scrollTop() > 20;
+
+    $('#move-up').css({
+      display: shouldDisplay ? 'block' : 'none'
+    });
+  }
+
+  /**
+   * @description Method to scroll to the top of the page.
+   */
+  function topFunction() {
+    $('body').animate({scrollTop: 0});
+    $(':root').animate({scrollTop: 0});
+  }
+
+  $('#move-up').on('click', topFunction);
+
+
+  // UI for each step:
+  sequencer.setUI(DefaultHtmlStepUi(sequencer));
+
+  // UI for the overall demo:
+  var ui = defaultHtmlSequencerUi(sequencer);
+
+  // Load image data from URL `src` parameter.
+  if (urlHash.getUrlHashParameter('src')) {
+    sequencer.loadImage(urlHash.getUrlHashParameter('src'), ui.onLoad);
+  } else {
+    sequencer.loadImage('images/tulips.png', ui.onLoad);
+  }
+
+  var resetSequence = function () {
+    var r = confirm('Do you want to reset the sequence?');
+    if (r)
+    {
+      window.location.hash = '';
+      location.reload();
+    }
+  };
+
+  $('#addStep select').on('change', ui.selectNewStepUi);
+  $('#addStep #add-step-btn').on('click', ui.addStepUi);
+  $('#resetButton').on('click', resetSequence);
+
+  // Module Selector quick buttons click handler.
+  $('.radio-group .radio').on('click', function () {
+    $(this).parent().find('.radio').removeClass('selected');
+    $(this).addClass('selected');
+    newStep = $(this).attr('data-value');
+
+    $('#addStep select').val(newStep);
+    ui.selectNewStepUi(newStep);
+    ui.addStepUi(newStep);
+    $(this).removeClass('selected');
+  });
+
+  /**
+   * @method displayMessageOnSaveSequence
+   * @description When a sequence is saved to a browser, notification is displayed.
+   * @returns {Null}
+   */
+  function displayMessageOnSaveSequence() {
+    $('.savesequencemsg').fadeIn();
+    setTimeout(function () {
+      $('.savesequencemsg').fadeOut();
+    }, 3000);
+  }
+
+  $('body').on('click', 'button.remove', ui.removeStepUi);
+  function saveSequence() { // 1. save seq
+    var result = window.prompt('Please give a name to your sequence... (Saved sequence will only be available in this browser).');
+    if (result) {
+      result = result + ' (local)';
+      sequencer.saveSequence(result, sequencer.toString()); // 1.a study saveSequence
+      sequencer.loadModules();
+      displayMessageOnSaveSequence();
+      refreshOptions();
+    }
+  }
+  $('#saveButton').on('click', function () {
+    // Different handlers triggered for different dropdown options.
+
+    let dropDownValue = $('#selectSaveOption option:selected').val();
+
+    if (dropDownValue == 'save-image') {
+      $('.download-btn:last()').trigger('click');
+    }
+    else if (dropDownValue == 'save-gif') {
+      handleSavePNG();
+    }
+    else if (dropDownValue == 'save-seq') {
+      saveSequence();
+    } else if(dropDownValue == 'save-pdf') {
+      savePDF(getLastImage());
+    }
+    else if (dropDownValue == 'save-to-publiclab.org' ){
+      SaveToPubliclab();
+    }
+  });
+
+  let isWorkingOnGifGeneration = false;
+
+  $('.js-view-as-gif').on('click', function (event) { // GIF generation and display
+    if (isWorkingOnGifGeneration) return; // Prevent multiple button clicks
+
+    isWorkingOnGifGeneration = true;
+
+    var button = event.target;
+    button.disabled = true;
+    button.innerHTML = '<i class="fa fa-circle-o-notch fa-spin"></i>';
+
+    try {
+      // Get GIF resources from previous steps
+      let options = getGifResources();
+
+      gifshot.createGIF(options, function (obj) { // GIF generation
+        if (!obj.error) {
+          // Final GIF encoded with base64 format
+          var image = obj.image;
+          var animatedImage = document.createElement('img');
+
+          animatedImage.id = 'gif_element';
+          animatedImage.src = image;
+
+          let modal = $('#js-download-gif-modal');
+
+          $('#js-download-as-gif-button').one('click', function () {
+            downloadGif(image); // Trigger GIF download
+            modal.modal('hide');
+          });
+
+          var gifContainer = document.getElementById('js-download-modal-gif-container');
+
+          // Clear previous results
+          gifContainer.innerHTML = '';
+
+          // Insert image
+          gifContainer.appendChild(animatedImage);
+
+          // Open modal
+          modal.modal();
+
+          button.disabled = false;
+          button.innerHTML = 'View GIF';
+          isWorkingOnGifGeneration = false;
         }
+      });
+    }
+    catch (e) {
+      console.error(e);
+      button.disabled = false;
+      button.innerHTML = 'View GIF';
+      isWorkingOnGifGeneration = false;
+    }
+  });
+
+  function getGifResources() {
+    // Returns an object with specific gif options
+    let imgs = document.getElementsByClassName('step-thumbnail');
+    var imgSrcs = [];
+
+    // Pushes image sources of all the modules in the DOM
+    for (var i = 0; i < imgs.length; i++) {
+      imgSrcs.push(imgs[i].src);
+    }
+
+    var options = { // GIF frame options
+      'gifWidth': imgs[0].width,
+      'gifHeight': imgs[0].height,
+      'images': imgSrcs,
+      'frameDuration': 7,
+    };
+
+    return options;
+  }
+
+  function handleSavePNG() {
+    let options = getGifResources();
+    gifshot.createGIF(options, function(obj){
+
+      downloadGif(obj.image);
+
+    });
+  }
+
+  /**
+  * Get the data URL for the last image in the sequence.
+  * @return {string} The data URL for the last image in the sequence.
+  */
+  function getLastImage() {
+    // Get the image from the last step.
+    let imgs = document.getElementsByClassName('step-thumbnail');
+    let lastStepImage = imgs[imgs.length - 1];
+    return lastStepImage.getAttribute('src');
+  }
+
+  /**
+  * Download the given image URL as a PDF file.
+  * @param {string} imageDataURL - The data URL for the image.
+  */
+  function savePDF(imageDataURL) {
+    sequencer.getImageDimensions(imageDataURL, function(dimensions) {
+      if (isGIF(imageDataURL)) {
+        // Get the dimensions of the image.
+        let pageWidth = dimensions.width;
+        let pageHeight = dimensions.height;
+
+        // Create a new pdf with the same dimensions as the image.
+        const pdf = new jsPDF({
+          orientation: pageHeight > pageWidth ? 'portrait' : 'landscape',
+          unit: 'px',
+          format: [pageHeight, pageWidth]
+        });
+
+        // Add the image to the pdf with dimensions equal to the internal dimensions of the page.
+        pdf.addImage(imageDataURL, 0, 0, pdf.internal.pageSize.getWidth(), pdf.internal.pageSize.getHeight());
+
+        // Save the pdf with the filename specified here:
+        pdf.save('index.pdf');
       }
+      else console.log('GIFs cannot be converted to PDF');
+    });
+  }
+
+
+
+  function downloadGif(image) {
+    download(image, 'index.gif', 'image/gif'); // Downloadjs library function
+  }
+
+  function SaveToPubliclab() {
+    function postToPL(imgSrc) {
+      var uniq = Date.now();
+      $('body').append('<form method="post" id="postToPL' + uniq + '" action="https://publiclab.org/post" target="postToPLWindow"><input type="hidden" name="datauri_main_image" /></form>');
+      f = $('#postToPL' + uniq)[0];
+      f.datauri_main_image.value = imgSrc;
+      window.open('', 'postToPLWindow');
+      f.submit();
+    }
+    postToPL($('img')[sequencer.steps.length - 1].src);
+  }
+
+  // Image selection and drag/drop handling from examples/lib/imageSelection.js
+  sequencer.setInputStep({
+    dropZoneSelector: '#dropzone',
+    fileInputSelector: '#fileInput',
+    takePhotoSelector: '#take-photo',
+    onLoad: function onFileReaderLoad(progress) {
+      var reader = progress.target;
+      var step = sequencer.steps[0];
+      var util = intermediateHtmlStepUi(sequencer);
+      step.output.src = reader.result;
+      sequencer.run({ index: 0 });
+      if (typeof step.options !== 'undefined')
+        step.options.step.imgElement.src = reader.result;
+      else
+        step.imgElement.src = reader.result;
+
+      insertPreview.updatePreviews(reader.result, document.querySelector('#addStep'));
+      DefaultHtmlStepUi(sequencer).updateDimensions(step);
     },
-
-    onRemove: function(step) {
-      step.ui.remove();
+    onTakePhoto: function (url) {
+      var step = sequencer.steps[0];
+      step.output.src = url;
+      sequencer.run({ index: 0 });
+      if (typeof step.options !== 'undefined')
+        step.options.step.imgElement.src = url;
+      else
+        step.imgElement.src = url;
+      insertPreview.updatePreviews(url, document.querySelector('#addStep'));
+      DefaultHtmlStepUi(sequencer).updateDimensions(step);
     }
-
   });
 
-  sequencer.loadImage('images/tulips.png', function loadImageUI(){
+  setupCache();
 
-    // look up needed steps from Url Hash:
-    var stepsFromHash = getUrlHashParameter('steps').split(',')
-    stepsFromHash.forEach(function eachStep(step) {
-      sequencer.addSteps(step)
-    });
-    sequencer.run();
-
-  });
-
-
-  // File handling
-
-  $('#addStep select').on('change', selectNewStepUI);
-
-  function selectNewStepUI() {
-    $('#options').html('');
-    var m = $('#addStep select').val();
-    for(var input in modulesInfo[m].inputs) {
-      $('#options').append(
-        '<div class="row">\
-           <div class="col-md-5 labels">\
-             '+input+':\
-           </div>\
-           <div class="col-md-5">\
-             <input class="form-control" type="text" name="'+input+'" value="" placeholder="'+
-             modulesInfo[m].inputs[input].default+'"/>\
-           </div>\
-         </div>'
-      );
-    }
+  if (urlHash.getUrlHashParameter('src')) {  // Gets the sequence from the URL
+    insertPreview.updatePreviews(urlHash.getUrlHashParameter('src'), document.querySelector('#addStep'));
+  } else {
+    insertPreview.updatePreviews('images/tulips.png', document.querySelector('#addStep'));
   }
-
-
-  function addStepUI() {
-    var options = {};
-    var inputs = $('#options input');
-    $.each(inputs, function() {
-      options[this.name] = $(this).val();
-    });
-    if($('#addStep select').val()=="none") return;
-    // add to URL hash too
-    setUrlHashParameter('steps', getUrlHashParameter('steps') + ',' + $('#addStep select').val())
-    sequencer.addSteps($('#addStep select').val(),options).run();
-  }
-
-  $('#addStep button').on('click', addStepUI);
-
-
-  function removeStepUI(){
-    var index = $('button.remove').index(this) + 1;
-    sequencer.removeSteps(index).run();
-    // remove from URL hash too
-    var urlHash = getUrlHashParameter('steps').split(',');
-    urlHash.splice(index - 1, 1);
-    setUrlHashParameter("steps", urlHash.join(','));
-  }
-
-  $('body').on('click','button.remove', removeStepUI);
-
-
-  // image selection and drag/drop handling from examples/lib/imageSelection.js
-  setupFileHandling(sequencer);
-
-}
+};

examples/fisheye.html

@@ -29,6 +29,7 @@
       }
     </style>
 
+    <script src="../node_modules/jquery/dist/jquery.min.js"></script>
     <script src="../dist/image-sequencer.js"></script>
   </head>
 

examples/index.html

@@ -2,69 +2,258 @@
 
 <html>
 
+<head>
 
-  <head>
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <meta http-equiv="content-type" content="text/html; charset=UTF8">
+  <meta name="theme-color" content="#428bca">
+  <link rel="icon" sizes="192x192" href="../icons/ic_192.png">
+  <link rel="manifest" href="manifest.json">
 
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <meta http-equiv="content-type" content="text/html; charset=UTF8">
+  <!--Adding meta Tag for search engine optimisation-->
+  <meta property="og:description"
+    content="A pure JavaScript sequential image processing system, inspired by storyboards. Instead of modifying the original image, it creates a new image at each step in a sequence.">
+  <meta property="og:site_name" content="sequencer.publiclab.org">
+  <meta property="og:url" content="https://sequencer.publiclab.org">
+  <meta property="og:title" content="Image Sequencer">
+  <meta name="Description"
+    content="Image Sequencer is an image editing tool that creates a new downloadble image at each step.It works in browser and supports both node and CLI.">
+  <meta name="Keywords" content="image editing downloadable browser node CLI">
 
-    <title>Image Sequencer</title>
+  <title>Image Sequencer</title>
 
-    <script src="../node_modules/jquery/dist/jquery.min.js"></script>
-    <script src="../node_modules/bootstrap/dist/js/bootstrap.min.js"></script>
-    <script src="../dist/image-sequencer.js" charset="utf-8"></script>
-    <script src="lib/urlHash.js" charset="utf-8"></script>
-    <script src="lib/imageSelection.js" charset="utf-8"></script>
-    <script src="demo.js" charset="utf-8"></script>
+  <script src="../node_modules/jquery/dist/jquery.min.js"></script>
+  <script src="../node_modules/bootstrap/dist/js/bootstrap.min.js"></script>
+  <script src="../src/ui/prepareDynamic.js"></script>
+  <script src="../dist/image-sequencer.js" charset="utf-8"></script>
+  <script src="../dist/image-sequencer-ui.js" charset="utf-8"></script>
+  <script src="../node_modules/bootstrap-colorpicker/dist/js/bootstrap-colorpicker.js"></script>
+  <!-- for crop module: -->
+  <script src="../node_modules/imgareaselect/jquery.imgareaselect.dev.js"></script>
+  <script src="../node_modules/gifshot/dist/gifshot.min.js" type="text/javascript"></script>
 
-  </head>
+  <!-- Download.js for large files -->
+  <script src="../node_modules/downloadjs/download.min.js" type="text/javascript" ></script>
 
+  <!-- jspdf to enable save image as pdf -->
+  <script src="../node_modules/jspdf/dist/jspdf.min.js" type="text/javascript" ></script>
 
-  <body>
+  <!-- <script src="lib/scrollToTop.js"></script> -->
+  <script src="../node_modules/selectize/dist/js/standalone/selectize.min.js"></script>
+</head>
 
-    <link href="../node_modules/bootstrap/dist/css/bootstrap.min.css" rel="stylesheet">
-    <link href="../node_modules/font-awesome/css/font-awesome.min.css" rel="stylesheet">
-    <link rel="stylesheet" href="demo.css">
+<body>
 
-    <div class="container-fluid">
+  <link href="../node_modules/bootstrap/dist/css/bootstrap.min.css" rel="stylesheet">
+  <link href="../node_modules/bootstrap-colorpicker/dist/css/bootstrap-colorpicker.css" rel="stylesheet">
 
-      <header class="text-center">
-        <h1>Image Sequencer</h1>
-        <p>
-          Open Source <a href="https://github.com/publiclab/image-sequencer"><i class="fa fa-github"></i></a> by <a href="https://publiclab.org">Public Lab</a>
-        </p>
-      </header>
+  <link rel="stylesheet" href="demo.css">
+  <link href="../node_modules/font-awesome/css/font-awesome.min.css" rel="stylesheet">
+  <link href="../node_modules/selectize/dist/css/selectize.default.css" rel="stylesheet">
+  <!-- for crop module: -->
+  <!-- for crop module: -->
+  <link href="../node_modules/imgareaselect/distfiles/css/imgareaselect-default.css" rel="stylesheet">
+  <link href="./selectize.default.css" rel="stylesheet">
+  <link rel="stylesheet" href="demo.css">
 
-      <div id="dropzone">
-        <p><i>Select or drag in an image to start!</i></p>
-        <center><input type="file" id="fileInput" value=""></center>
-      </div>
+  <div id="update-prompt-modal">A new version of image sequencer is available. Click <a href="#" id="reload">here</a> to update.</div>
 
-      <section id="steps" class="row"></section>
+  <div class="notify-box d-none">
+    <strong>Failed To Load Image</strong>
+    <button type="button" class="ml-2 mb-1 close" id="close-popup"><span>&times;</span></button>
+    <div class="notify-msg">
+      Can not Load Image Due to CORS Error Learn more about this 
+      <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS/Errors" target="_blank">here</a>
+    </div>
+  </div>
 
-      <section id="addStep">
-        <div class="row">
-          <select class="form-control">
-            <option value="none" disabled selected>Select a new step...</option>
-          </select>
-        </div>
-        <hr />
-        <div class="row">
-          <div id="options"></div>
-        </div>
-        <div class="row add">
-          <button class="btn btn-success btn-lg" name="add">Add Step</button>
-        </div>
-      </section>
+  <div class="container-fluid">
 
+    <header class="text-center">
+      <h1><a href="/" target='_blank' class="name-header">Image Sequencer</a></h1>
+      <p>
+        A pure JavaScript sequential image processing system, inspired by storyboards. Instead of modifying the original
+        image, it
+        creates a new image at each step in a sequence.
+        <a href="https://publiclab.org/image-sequencer">Learn more</a>
+      </p>
+      <p>
+        Open Source
+        <a href="https://github.com/publiclab/image-sequencer">
+          <i class="fa fa-github"></i>
+        </a>
+        by <a href="https://publiclab.org" title="Publiclab Website"><i class="fa fa-globe"></i> Publiclab</a>
+      </p>
+      <span id="version-number-top-right"></span>
+    </header>
+
+    <div id="dropzone" class="dropzone">
+      <p id="dropzone-text">
+        <i>Select or drag in an image to start!</i>
+      </p>
+      <center>
+        <input type="file" id="fileInput" value="" accept="image/*"><br />
+        <button type="button" id="take-photo" class="btn btn-primary btn-block btn-lg ">Take a Photo</button>
+        <video id="video" width="100%" height="100%" style="display:none"></video>
+        <a href="#" id="capture" style="display:none" class="btn btn-primary btn-md">Click Picture</a>
+        <a href="#" id="close" style="display:none" class="btn btn-default btn-md">Close</a>
+        <canvas id="canvas" width="400" height="300" style="display:none"></canvas>
+      </center>
     </div>
 
+    <section id="steps" class="row">
+      <div id="load-image"></div>
+    </section>
+
+    <hr />
+    <p class="alert alert-success savesequencemsg">Saved Sequence Success. Sequence can be found among other modules in browser's localStorage.
+    </p>
+    <div class="row">
+      <div class="col-sm-8">
+        <section id="addStep" class="panel panel-primary">
+          <div class="form-inline">
+            <div class="panel-body">
+              <div style="display:flex; justify-content:center;">
+              </div>
+              <p class="info">Select a new module to add to your sequence.</p>
+              <div class="row center-align radio-group">
+                <div>
+                  <div class="radio" data-value="resize">
+                    <i class="fa fa-arrows-alt fa-4x i-over"></i>
+                  </div>
+                  <p>Resize</p>
+                </div>
+                <div>
+                  <div class="radio" data-value="brightness">
+                    <i class="fa fa-sun-o fa-4x i-over"></i>
+                  </div>
+                  <p>Brightness</p>
+                </div>
+                <div>
+                  <div class="radio" data-value="contrast">
+                    <i class="fa fa-adjust fa-4x i-over"></i>
+                  </div>
+                  <p>Contrast</p>
+                </div>
+                <div>
+                  <div class="radio" data-value="saturation">
+                    <i class="fa fa-tint fa-4x i-over i-small"></i>
+                  </div>
+                  <p>Saturation</p>
+                </div>
+                <div>
+                  <div class="radio" data-value="rotate">
+                    <i class="fa fa-rotate-right fa-4x i-over"></i>
+                  </div>
+                  <p>Rotate</p>
+                </div>
+                <div>
+                  <div class="radio" data-value="crop">
+                    <i class="fa fa-crop fa-4x i-over"></i>
+                  </div>
+                  <p>Crop</p>
+                </div>
+              </div>
+              <div class="row justify-content-center">
+                <div class="col-lg-8">
+
+                  <select id="selectStep" class="text-center">
+                    <!-- The default null selection has been appended manually in demo.js
+              This is because the options in select are overritten when options are appended.-->
+                  </select>
+                </div>
+                <div class="col-lg-4">
+                  <button class="btn btn-primary btn-lg" name="add" id="add-step-btn">Add Step</button></div>
+              </div>
+              <div class="row center-align">
+                <button id="resetButton" class="btn btn-default btn-lg"
+                  style=" margin: 20px 35px 0px 35px; width:100%;">Clear All Steps</button>
+              </div>
+            </div>
+          </div>
+        </section>
+
+        <div class="modal fade" id="js-download-gif-modal" tabindex="-1" role="dialog">
+          <div class="modal-dialog" role="document">
+            <div class="modal-content">
+              <div class="modal-header">
+                <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span
+                    aria-hidden="true">&times;</span></button>
+                <h4 class="modal-title">Your gif is ready</h4>
+              </div>
+              <div class="modal-body">
+                <div id="js-download-modal-gif-container">
+                  <!-- Gif should appear here -->
+                </div>
+              </div>
+              <div class="modal-footer">
+                <button type="button" class="btn btn-default" data-dismiss="modal">Done</button>
+
+                <button id="js-download-as-gif-button" class="btn btn-primary">Download</button>
+              </div>
+            </div>
+          </div>
+        </div>
+
+      </div>
+      <div class="col-sm-4">
+        <section id="dwnld" class="panel panel-primary">
+          <div class="form-inline">
+            <div class="panel-body">
+              <div style="text-align:center;">
+                <h2 style="margin-top:20px">Save</h2>
+                <select class="form-control input-md mouse" id="selectSaveOption" style="margin-top:20px">
+                  <option value="save-image">Save as PNG</option>
+                  <option value="save-gif">Save as GIF (all steps)</option>
+                  <option value="save-pdf">Save as PDF</option>
+                  <option value="save-seq">Save sequence</option>
+                  <option value="save-seq-string">Save sequence string</option>
+                  <option value="save-to-publiclab.org">Save to PublicLab.org</option>>
+                </select>
+                <p><button id="saveButton" class="btn btn-primary btn-lg save-button">Save</button></p>
+                <p><button class="btn btn-default btn-lg js-view-as-gif" id="gif">Preview GIF</button></p>
+              </div>
+            </div>
+          </div>
+        </section>
+      </div>
+    </div>
+
+    <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>
+          <p>
+            <a class="btn btn-default" href="https://github.com/publiclab/image-sequencer/issues">Ask a question</a>
+            <a class="btn btn-default" href="https://gitter.im/publiclab/image-sequencer"  target="_blank">Ask in our chatroom </a>
+          </p>
+        </div>
+        <div class="col-md-6">
+          <h2>Improve this tool</h2>
+          <p>
+            This is an open source toolkit which you can help improve on Github
+          </p>
+          <p>
+            <a class="btn btn-default" href="https://github.com/publiclab/image-sequencer">View the code &raquo;</a>
+          </p>
+        </div>
+      </div>
+      <div class="row">
+        <p id="version-number-text">Loading Version Number</p>
+      </div>
+    </footer>
+
+    <button id="move-up"><i class="fa fa-arrow-circle-o-up"></i></button>
+
     <script type="text/javascript">
-
-      var sequencer;
-
+      $(function () {
+        var sequencer;
+      })
     </script>
+    <script async src="../node_modules/opencv.js/opencv.js" type="text/javascript"></script>
 
-  </body>
+</body>
 
 </html>

examples/lib/cache.js

@@ -0,0 +1,98 @@
+var setupCache = function() {
+  let newWorker; // When sw.js is changed, this is the new service worker generated.
+  
+  // Toggle a CSS class to display a popup prompting the user to fetch a new version.
+  function showUpdateModal() {
+    $('#update-prompt-modal').addClass('show');
+  }
+
+  /**
+  * When a new service worker has been loaded, the button in the update prompt
+  * modal should trigger the skipWaiting event to replace the current
+  * service worker with the new one.
+  */
+  $('#reload').on('click', function() {
+    newWorker.postMessage({ action: 'skipWaiting' });
+  });
+
+  if ('serviceWorker' in navigator) {
+    // Register the service worker.
+    navigator.serviceWorker.register('sw.js', { scope: '/examples/' })
+      .then(function(registration) {
+
+          return new Promise(function(resolve,reject){
+
+            registration.addEventListener('updatefound', () => {
+              // When sw.js has been changed, get a reference to the new service worker.
+              newWorker = registration.installing;
+
+              if(!newWorker){
+                return reject(new Error('error in installing service worker'));
+              }
+
+            newWorker.addEventListener('statechange', () => {
+              // Check if service worker state has changed.
+              switch(newWorker.state) {
+                case 'installed':
+                  if(navigator.serviceWorker.controller) {
+                    // New service worker available; prompt the user to update.
+                    showUpdateModal();
+                    $('#reload').on('click',(e) => {
+                      e.preventDefault();
+                      console.log('New Service Worker Installed Successfully');
+                      location.reload();
+                      return resolve();
+                    })
+                  }
+                  // No updates available; do nothing.
+                  break;
+
+                case 'redundant':
+                  return reject(new Error('installing new service worker now became redundant'));
+              }
+            })
+          })
+        })
+      }).catch(err => {
+        console.log('Failed In Registering Service Worker: ',err);
+      });
+
+      /**
+      * This is the event listener for when the service worker updates.
+      * When the service worker updates, reload the page.
+      */
+      let refreshing;
+      navigator.serviceWorker.addEventListener('controllerchange', function() {
+        if(refreshing) return;
+        window.location.reload();
+        refreshing = true;
+      });
+  }
+
+  if ('serviceWorker' in navigator) {
+    caches.keys().then(function(cacheNames) {
+      cacheNames.forEach(function(cacheName) {
+        $('#clear-cache').append(' ' + cacheName);
+      });
+    });
+  }
+
+  const clearCache = () => {
+    if ('serviceWorker' in navigator) {
+      return caches.keys()
+        .then(function(cache) {
+          return Promise.all(cache.map(function(cacheItem) {
+            return caches.delete(cacheItem);
+        }));
+      });
+    }
+  }
+
+  $('#clear-cache').click(function() {
+    clearCache();
+    location.reload();
+  });
+
+};
+
+module.exports = setupCache;

examples/lib/defaultHtmlSequencerUi.js

@@ -0,0 +1,102 @@
+var urlHash = require('./urlHash.js');
+   insertPreview = require('./insertPreview.js');
+function DefaultHtmlSequencerUi(_sequencer, options) {
+
+  options = options || {};
+  var addStepSel = options.addStepSel = options.addStepSel || '#addStep';
+  var removeStepSel = options.removeStepSel = options.removeStepSel || 'button.remove';
+  var selectStepSel = options.selectStepSel = options.selectStepSel || '#selectStep';
+
+  function onLoad() {
+    importStepsFromUrlHash();
+    if ($('#selectStep').val() === 'none')
+      $(addStepSel + ' #add-step-btn').prop('disabled', true);
+    handleSaveSequence();
+  }
+
+  // look up needed steps from Url Hash:
+  function importStepsFromUrlHash() {
+    var hash = urlHash.getUrlHashParameter('steps');
+    if (hash) {
+      _sequencer.importString(hash);
+      _sequencer.run({ index: 0 });
+    }
+    urlHash.setUrlHashParameter('steps', sequencer.toString());
+  }
+
+  function selectNewStepUi() {
+    var m = $(addStepSel + ' select').val();
+    if(m) $(addStepSel + ' .info').html(_sequencer.modulesInfo(m).description);
+    $(addStepSel + ' #add-step-btn').prop('disabled', false);
+  }
+
+  function removeStepUi() {
+    var index = $(removeStepSel).index(this) + 1;
+    // If last step is removed.
+    if(sequencer.steps.length==index+1){
+      console.log("inside")
+      insertPreview.updatePreviews(sequencer.steps[index-1].output.src, document.querySelector('#addStep'));
+    }
+    sequencer.removeSteps(index).run({ index: index - 1 });
+    // remove from URL hash too
+    urlHash.setUrlHashParameter('steps', sequencer.toString());
+    //disable save-sequence button if all steps are removed
+    handleSaveSequence();
+  }
+
+  function addStepUi() {
+    
+    if ($(addStepSel + ' select').val() == ''){
+      alert('Please Select a Step to Proceed');
+      return;
+    }
+
+    var newStepName;
+    if(typeof arguments[0] !== 'string')
+      newStepName = $(addStepSel + ' select option').html().toLowerCase().split(' ').join('-');
+    else newStepName = arguments[0];
+
+    
+    /*
+    * after adding the step we run the sequencer from defined step
+    * and since loadImage is not a part of the drawarray the step lies at current
+    * length - 2 of the drawarray
+    */
+    var sequenceLength = 1;
+    if (sequencer.sequences[newStepName]) {
+      sequenceLength = sequencer.sequences[newStepName].length;
+    } else if (sequencer.modules[newStepName][1]['length']) {
+      sequenceLength = sequencer.modules[newStepName][1]['length'];
+    }
+    _sequencer
+      .addSteps(newStepName, options)
+      .run({ index: _sequencer.steps.length - sequenceLength - 1 });
+    $(addStepSel + ' .info').html('Select a new module to add to your sequence.');
+    $(addStepSel + ' select').val('none');
+
+    //enable save-sequence button if disabled initially
+    handleSaveSequence();
+
+    // add to URL hash too
+    urlHash.setUrlHashParameter('steps', _sequencer.toString());
+  }
+
+  function handleSaveSequence(){
+    var stepCount = sequencer.steps.length;
+    if(stepCount < 2)
+      $(' #save-seq').prop('disabled', true);
+    else
+      $(' #save-seq').prop('disabled', false);
+  }
+
+  return {
+    onLoad: onLoad,
+    importStepsFromUrlHash: importStepsFromUrlHash,
+    selectNewStepUi: selectNewStepUi,
+    removeStepUi: removeStepUi,
+    addStepUi: addStepUi
+  };
+}
+
+module.exports = DefaultHtmlSequencerUi;
+

examples/lib/defaultHtmlStepUi.js

@@ -0,0 +1,509 @@
+// Set the UI in sequencer. This Will generate HTML based on
+// Image Sequencer events :
+// onSetup : Called every time a step is added
+// onDraw : Called every time a step starts draw
+// onComplete : Called every time a step finishes drawing
+// onRemove : Called everytime a step is removed
+// The variable 'step' stores useful data like input and
+// output values, step information.
+// See documetation for more details.
+
+const intermediateHtmlStepUi = require('./intermediateHtmlStepUi.js'),
+  urlHash = require('./urlHash.js'),
+  _ = require('lodash'),
+  insertPreview = require('./insertPreview.js');
+  mapHtmlTypes = require('./mapHtmltypes'),
+  scopeQuery = require('./scopeQuery'),
+  isGIF = require('../../src/util/isGif');
+
+function DefaultHtmlStepUi(_sequencer, options) {
+  options = options || {};
+  var stepsEl = options.stepsEl || document.querySelector('#steps');
+  var selectStepSel = options.selectStepSel = options.selectStepSel || '#selectStep';
+
+  function onSetup(step, stepOptions) {
+    if (step.options && step.options.description)
+      step.description = step.options.description;
+    
+    let stepDocsLink = '';
+    if (step.moduleInfo) stepDocsLink = step.moduleInfo['docs-link'] || '';
+
+    step.ui = // Basic UI markup for the step
+      '\
+      <div class="container-fluid step-container">\
+          <div class="panel panel-default">\
+            <div class="panel-heading">\
+              <div class="trash-container pull-right">\
+                <a type="button" target="_blank" href="https://developer.mozilla.org/en-US/docs/WebAssembly" style="display: none;" class="btn btn-link general-tooltip wasm-tooltip" data-toggle="tooltip" data-html="true" data-original-title="<div style=\'text-align: center\'><p>This step is Web Assembly accelerated. Click to Read More</div>">\
+                  <i class="fa fa-bolt"></i>\
+                </a>\
+                <button type="button" class="btn btn-link ' + step.name + ' general-tooltip dimension-tooltip" data-toggle="tooltip" data-html="true" data-original-title="">\
+                  <i class="fa fa-info-circle"></i>\
+                </button>\
+              </div>\
+              <h3 class="panel-title">' +
+                '<span class="toggle mouse">' + step.name + ' <span class="caret toggleIcon rotated"></span>\
+                 <span class="load-spin pull-right" style="display:none;padding:1px 8px;"><i class="fa fa-circle-o-notch fa-spin"></i></span>\
+              </h3>\
+            </div>\
+            <form class="input-form">\
+            <div class="panel-body cal collapse in">\
+              <div class="row step">\
+                <div class="col-md-4 details container-fluid">\
+                  <div class="cal collapse in"><p>' +
+                    '<a href="' + stepDocsLink + '">' + (step.description || '') + '</a>' +
+                 '</p></div>\
+                </div>\
+                <div class="col-md-8 cal collapse in step-column">\
+                  <div class="load load-spin" style="display:none;"><i class="fa fa-circle-o-notch fa-spin"></i></div>\
+                  <div class="step-image">\
+                    <a class="cal collapse in"><img class="img-thumbnail step-thumbnail"/></a>\
+                  </div>\
+                </div>\
+              </div>\
+            </div>\
+            <div class="panel-footer cal collapse in"></div>\
+            </form>\
+          </div>\
+      </div>';
+
+    var tools =
+    '<div class="trash" style="display: inline-block">\
+      <button confirm="Are you sure?" class="remove btn btn-default btn-xs">\
+        <i class="fa fa-trash"></i>\
+      </button>\
+    </div>';
+
+    var util = intermediateHtmlStepUi(_sequencer, step);
+
+    var parser = new DOMParser();
+    step.ui = parser.parseFromString(step.ui, 'text/html'); // Convert the markup string to a DOM node.
+    step.ui = step.ui.querySelector('div.container-fluid');
+
+    step.$step = scopeQuery.scopeSelector(step.ui); // Shorthand methods for scoped DOM queries. Read the docs [CONTRIBUTING.md](https://github.com/publiclab/image-sequencer/blob/main/CONTRIBUTING.md) for more info.
+    step.$stepAll = scopeQuery.scopeSelectorAll(step.ui);
+    let {$step, $stepAll} = step;
+
+    step.linkElements = step.ui.querySelectorAll('a'); // All the anchor tags in the step UI
+    step.imgElement = $step('a img.img-thumbnail')[0]; // The output image
+
+    if (_sequencer.modulesInfo().hasOwnProperty(step.name)) {
+      var inputs = _sequencer.modulesInfo(step.name).inputs;
+      var outputs = _sequencer.modulesInfo(step.name).outputs;
+      var merged = Object.assign(inputs, outputs); // Combine outputs with inputs
+
+      for (var paramName in merged) {
+        var isInput = inputs.hasOwnProperty(paramName);
+        var html = '';
+        var inputDesc = isInput ? mapHtmlTypes(inputs[paramName]) : {};
+        if (!isInput) {
+          html += '<span class="output"></span>';
+        }
+        else if (inputDesc.type.toLowerCase() == 'select') {
+
+          html += '<select class="form-control target" name="' + paramName + '">';
+          for (var option in inputDesc.values) {
+            html += '<option>' + inputDesc.values[option] + '</option>';
+          }
+          html += '</select>';
+        }
+        else {
+          let paramVal = step.options[paramName] || inputDesc.default;
+
+          if (inputDesc.id == 'color-picker') { // Separate input field for color-picker
+            html +=
+              '<div id="color-picker" class="input-group colorpicker-component">' +
+              '<input class="form-control color-picker-target" type="' +
+              inputDesc.type +
+              '" name="' +
+              paramName +
+              '" value="' +
+              paramVal + '">' + '<span class="input-group-addon"><i></i></span>' +
+              '</div>';
+          }
+          else if(inputDesc.type === 'button'){
+            html = '<div><button name="' + paramName + '" type="' + inputDesc.type + '" >\
+            <i class="fa fa-crosshairs"></i></button>\
+            <span>click to select coordinates</span>\
+            </div>';
+          }
+          else { // Non color-picker input types and other than a button
+
+            html =
+              '<input class="form-control target" type="' +
+              inputDesc.type +
+              '" name="' +
+              paramName +
+              '" value="' +
+              paramVal +
+              '" placeholder ="' +
+              (inputDesc.placeholder || '');
+
+            if (inputDesc.type.toLowerCase() == 'range') {
+              html +=
+                '"min="' +
+                inputDesc.min +
+                '"max="' +
+                inputDesc.max +
+                '"step="' +
+                inputDesc.step + '">' + '<span>' + paramVal + '</span>';
+
+            }
+            else html += '">';
+          }
+        }
+
+        var div = document.createElement('div');
+        div.className = 'row';
+        div.setAttribute('name', paramName);
+        var description = inputs[paramName].desc || paramName;
+        div.innerHTML =
+          '<div class=\'det cal collapse in\'>\
+                           <label for=\'' +
+          paramName +
+          '\'>' +
+          description +
+          '</label>\
+                           ' +
+          html +
+          '\
+                         </div>';
+        $step('div.details').append(div);
+      }
+      $step('div.panel-footer').append( // Save button
+        '<div class="cal collapse in"><button type="submit" class="btn btn-sm btn-default btn-save" disabled = "true" >Apply</button> <small style="padding-top:2px;">Press apply to see changes</small></div>'
+      );
+      $step('div.panel-footer').prepend( // Markup for tools: download and insert step buttons
+        '<button class="pull-right btn btn-default btn-sm insert-step" >\
+        <span class="insert-text"><i class="fa fa-plus"></i> Insert Step</span><span class="no-insert-text" style="display:none">Close</span></button>\
+        <button class="pull-right btn btn-default btn-sm download-btn" style="margin-right:2px" >\
+        <i class="fa fa-download"></i>\
+        </button>'
+      );
+    }
+
+    if (step.name != 'load-image') {
+      $step('div.trash-container')
+        .prepend(
+          parser.parseFromString(tools, 'text/html').querySelector('div')
+        );
+
+      $stepAll('.remove').on('click', function() {notify('Step Removed', 'remove-notification');}); // Notification on removal of a step
+      $step('.insert-step').on('click', function() { util.insertStep(step.ID); }); // Insert a step in between the sequence
+      // Insert the step's UI in the right place
+
+      if (stepOptions.index == _sequencer.steps.length) {
+        stepsEl.appendChild(step.ui);
+        $('#steps .step-container:nth-last-child(1) .insert-step').prop('disabled', true);
+        if($('#steps .step-container:nth-last-child(2)'))
+          $('#steps .step-container:nth-last-child(2) .insert-step').prop('disabled', false);
+      }
+      else {
+        stepsEl.insertBefore(step.ui, $(stepsEl).children()[stepOptions.index]);
+      }
+
+      // Enable the load-image insert-step button when there are steps after load-image
+      // The logical operator is `> 0` because the number of steps is found before adding the step, actual logic is `steps.length + 1 > 1` which is later simplified.
+      if (_sequencer.steps.length > 0) $('#load-image .insert-step').prop('disabled', false);
+      else $('#load-image .insert-step').prop('disabled', true);
+    }
+    else {
+      $('#load-image').append(step.ui); // Default UI without extra tools for the first step(load image)
+
+      $step('div.panel-footer').prepend( `
+          <button class="right btn btn-default btn-sm insert-step" disabled="true">
+            <span class="insert-text"><i class="fa fa-plus"></i> Insert Step</span>
+            <span class="no-insert-text" style="display:none">Close</span>
+          </button>`
+      );
+
+      $step('.insert-step').on('click', function() { util.insertStep(step.ID); });
+    }
+    $step('.toggle').on('click', () => { // Step container dropdown
+      $step('.toggleIcon').toggleClass('rotated');
+      $stepAll('.cal').collapse('toggle');
+    });
+
+    $(step.imgElement).on('mousemove', _.debounce(() => imageHover(step), 150)); // Shows the pixel coordinates on hover
+    $(step.imgElement).on('click', (e) => {e.preventDefault(); });
+    $stepAll('#color-picker').colorpicker();
+
+    function saveOptions(e) { // 1. SAVE OPTIONS
+      e.preventDefault();
+      if (optionsChanged){
+        $step('div.details')
+          .find('input,select')
+          .each(function(i, input) {
+            $(input)
+              .data('initValue', $(input).val())
+              .data('hasChangedBefore', false);
+            step.options[$(input).attr('name')] = $(input).val();
+          });
+        _sequencer.run({ index: step.index - 1 });
+
+        // Modify the URL hash
+        urlHash.setUrlHashParameter('steps', _sequencer.toString());
+        // Disable the save button
+        $step('.btn-save').prop('disabled', true);
+        optionsChanged = false;
+        changedInputs = 0;
+      }
+    }
+
+    /**
+     * @method handleInputValueChange
+     * @description Enables the save button on input change
+     * @param {*} currentValue The current value of the input
+     * @param {*} initValue The initial/old value of the input
+     * @param {Boolean} hasChangedBefore Whether the input was changed before
+     * @returns {Boolean} True if the value has changed
+     */
+    function handleInputValueChange(currentValue, initValue, hasChangedBefore) {
+      var inputChanged = !(isNaN(initValue) || isNaN(currentValue) ? currentValue === initValue : currentValue - initValue === 0);
+      changedInputs += hasChangedBefore ? inputChanged ? 0 : -1 : inputChanged ? 1 : 0;
+      optionsChanged = changedInputs > 0;
+
+      $step('.btn-save').prop('disabled', !optionsChanged);
+      return inputChanged;
+    }
+
+    var
+      changedInputs = 0,
+      optionsChanged = false;
+    $step('.input-form').on('submit', saveOptions);
+    $stepAll('.target').each(function(i, input) {
+      $(input)
+        .data('initValue', $(input).val())
+        .data('hasChangedBefore', false)
+        .on('input change', function() {
+          $(this)
+            .focus()
+            .data('hasChangedBefore',
+              handleInputValueChange(
+                $(this).val(),
+                $(this).data('initValue'),
+                $(this).data('hasChangedBefore')
+              )
+            );
+        });
+    });
+
+    $stepAll('.color-picker-target').each(function(i, input) {
+      $(input)
+        .data('initValue', $(input).val())
+        .data('hasChangedBefore', false)
+        .on('input change', function() {
+          $(this)
+            .data('hasChangedBefore',
+              handleInputValueChange(
+                $(this).val(),
+                $(this).data('initValue'),
+                $(this).data('hasChangedBefore')
+              )
+            );
+        });
+    });
+
+
+    $('input[type="range"]').on('input', function() {
+      $(this).next().html($(this).val());
+    });
+  }
+
+
+  function onDraw({$step, $stepAll}) {
+    $step('.load').show();
+    $step('img').hide();
+    $stepAll('.load-spin').show();
+  }
+
+  function onComplete(step) {
+    let {$step, $stepAll} = step;
+    $step('img').show();
+    $stepAll('.load-spin').hide();
+    $step('.load').hide();
+
+    $stepAll('.download-btn').off('click');
+    
+    step.imgElement.src = (step.name == 'load-image') ? step.output.src : step.output;
+    var imgthumbnail = $step('.img-thumbnail').getDomElem();
+    for (let index = 0; index < step.linkElements.length; index++) {
+      if (step.linkElements[index].contains(imgthumbnail))
+        step.linkElements[index].href = step.imgElement.src;
+    }
+
+    // TODO: use a generalized version of this.
+    function fileExtension(output) {
+      return output.split('/')[1].split(';')[0];
+    }
+
+    $stepAll('.download-btn').on('click', () => {
+
+      function dataURLtoBlob(dataurl) {
+        let arr = dataurl.split(','), mime = arr[0].match(/:(.*?);/)[1],
+          bstr = atob(arr[1]), n = bstr.length, u8arr = new Uint8Array(n);
+        while(n--){
+          u8arr[n] = bstr.charCodeAt(n);
+        }
+        return new Blob([u8arr], {type:mime});
+      }
+      
+      var element = document.createElement('a');
+      
+      element.setAttribute('download', step.name + '.' + fileExtension(step.imgElement.src));
+      element.style.display = 'none';
+      document.body.appendChild(element);
+      var blob = dataURLtoBlob(step.output);
+      var objurl = URL.createObjectURL(blob);
+      element.setAttribute('href', objurl);
+      
+      element.click();
+    });
+
+    // Fill inputs with stored step options
+    if (_sequencer.modulesInfo().hasOwnProperty(step.name)) {
+      var inputs = _sequencer.modulesInfo(step.name).inputs;
+      var outputs = _sequencer.modulesInfo(step.name).outputs;
+      for (var i in inputs) {
+        if (step.options[i] !== undefined) {
+          if (inputs[i].type.toLowerCase() === 'input')
+            $step('div[name="' + i + '"] input')
+              .val(step.options[i])
+              .data('initValue', step.options[i]);
+          if (inputs[i].type.toLowerCase() === 'select')
+            $step('div[name="' + i + '"] select')
+              .val(String(step.options[i]))
+              .data('initValue', step.options[i]);
+        }
+      }
+      for (var i in outputs) {
+        if (step[i] !== undefined)
+          $step('div[name="' + i + '"] input')
+            .val(step[i]);
+      }
+    }
+
+    $(function () {
+      $('[data-toggle="tooltip"]').tooltip();
+      updateDimensions(step);
+    });
+
+    if (step.name === 'load-image') insertPreview.updatePreviews(step.output.src, document.querySelector('#addStep'));
+    else insertPreview.updatePreviews(step.output, document.querySelector('#addStep'));  
+
+    // Handle the wasm bolt display
+
+    if (step.useWasm) {
+      if (step.wasmSuccess) $step('.wasm-tooltip').fadeIn();
+      else $step('.wasm-tooltip').fadeOut();
+    }
+    else $step('.wasm-tooltip').fadeOut();
+  }
+  /**
+   * @description Updates Dimension of the image
+   * @param {Object} step  - Current Step
+   * @returns {void}
+   *
+   */
+  function updateDimensions(step){
+    _sequencer.getImageDimensions(step.imgElement.src, function (dim) {
+      step.ui.querySelector('.' + step.name).attributes['data-original-title'].value = `<div style="text-align: center"><p>Image Width: ${dim.width} px<br>Image Height: ${dim.height} px</br>${isGIF(step.output) ? `Frames: ${dim.frames}` : ''}</div>`;
+    });
+  }
+
+  /**
+   * @method imageHover
+   * @description Handler to display image coordinates on hover.
+   * @param {Object} step Current step variable
+   * @returns {Null}
+   */
+  function imageHover(step){
+
+    var img = $(step.imgElement);
+
+    let customXCoord = '20'; //default x coordinate
+    let customYCoord = '20'; //default y coordinate
+
+    const customButton = $('button[name="Custom-Coordinates"]');
+      img.click(function(e) {
+          customXCoord = e.offsetX;
+          customYCoord = e.offsetY;
+          customButton.click(function() {
+            $('input[name="x"]').val(customXCoord);
+            $('input[name="y"]').val(customYCoord);
+          })
+      });
+
+    img.mousemove(function(e) {
+      var canvas = document.createElement('canvas');
+      canvas.width = img.width();
+      canvas.height = img.height();
+      var context = canvas.getContext('2d');
+      context.drawImage(this, 0, 0);
+
+      var offset = $(this).offset();
+      var xPos = e.pageX - offset.left;
+      var yPos = e.pageY - offset.top;
+      var myData = context.getImageData(xPos, yPos, 1, 1);
+      img[0].title = 'rgb: ' + myData.data[0] + ',' + myData.data[1] + ',' + myData.data[2];//+ rgbdata;
+    });
+  }
+
+  function onRemove(step) {
+    step.ui.remove();
+    $('#steps .step-container:nth-last-child(1) .insert-step').prop('disabled', true);
+
+    // Enable the load-image insert-step button when there are steps after load-image
+    // The logical operator is `> 2` because the number of steps is found before removing the step, actual logic is `steps.length - 1 > 1` which is later simplified.
+    if (_sequencer.steps.length - 1 > 1) $('#load-image .insert-step').prop('disabled', false);
+    else $('#load-image .insert-step').prop('disabled', true);
+
+    $(step.imgElement).imgAreaSelect({
+      remove: true
+    });
+  }
+
+  function getPreview() {
+    return step.imgElement;
+  }
+
+  /**
+   * @method notify
+   * @description General purpose DOM toast notification
+   * @param {String} msg Message to be displayed
+   * @param {String} id A unique identifier for the notification
+   * @returns {Null}
+   */
+  function notify(msg, id){
+    if ($('#' + id).length == 0) {
+      var notification = document.createElement('span');
+      notification.innerHTML = ' <i class="fa fa-info-circle" aria-hidden="true"></i> ' + msg ;
+      notification.id = id;
+      notification.classList.add('notification');
+
+      $('body').append(notification);
+    }
+
+    $('#' + id).fadeIn(500).delay(200).fadeOut(500);
+  }
+
+
+  return {
+    getPreview: getPreview,
+    onSetup: onSetup,
+    onComplete: onComplete,
+    onRemove: onRemove,
+    onDraw: onDraw,
+    notify: notify,
+    imageHover: imageHover,
+    updateDimensions: updateDimensions
+  };
+}
+
+if(typeof window === 'undefined'){
+  module.exports = {
+    DefaultHtmlStepUi: DefaultHtmlStepUi
+  };
+}
+
+module.exports = DefaultHtmlStepUi;

examples/lib/imageSelection.js

@@ -1,46 +0,0 @@
-function setupFileHandling(_sequencer, dropzoneId, fileInputId) {
-
-  dropzoneId = dropzoneId || "dropzone";
-  var dropzone = $('#' + dropzoneId);
-
-  fileInputId = fileInputId || "fileInput";
-  var fileInput = $('#' + fileInputId);
-
-  function handleFile(e) {
-
-    e.preventDefault();
-    e.stopPropagation(); // stops the browser from redirecting.
-
-    if (e.target && e.target.files) var file = e.target.files[0];
-    else var file = e.dataTransfer.files[0];
-    if(!file) return;
-
-    reader.onload = function onFileReaderLoad() {
-      var loadStep = _sequencer.images.image1.steps[0];
-      loadStep.output.src = reader.result;
-      _sequencer.run(0);
-      loadStep.options.step.imgElement.src = reader.result;
-    }
-
-    reader.readAsDataURL(file);
-  }
-
-  fileInput.on('change', handleFile);
-
-  dropzone[0].addEventListener('drop', handleFile, false);
-
-  dropzone.on('dragover', function onDragover(e) {
-    e.stopPropagation();
-    e.preventDefault();
-    e.dataTransfer.dropEffect = 'copy'; // Explicitly show this is a copy.
-  }, false);
-
-  dropzone.on('dragenter', function onDragEnter(e) {
-    dropzone.addClass('hover');
-  });
-
-  dropzone.on('dragleave', function onDragLeave(e) {
-    dropzone.removeClass('hover');
-  });
-
-}

examples/lib/insertPreview.js

@@ -0,0 +1,79 @@
+// Generate downscaled preview images for quick buttons.
+function generatePreview(previewStepName, customValues, path, DomNode) {
+  var previewSequencer = ImageSequencer();
+  function insertPreview(src) {
+    var img = document.createElement('img');
+    img.classList.add('img-thumbnail');
+    img.classList.add('no-border');
+    img.src = src;
+    $(img).css('max-width', '200%');
+    $(img).css('transform', 'translateX(-20%)');
+    $(DomNode.querySelector('.radio-group')).find('.radio').each(function() {
+      if ($(this).attr('data-value') === previewStepName) {
+        $(this).find('img').remove();
+        $(this).append(img);
+      }
+    });
+  }
+
+  function loadPreview() {
+    if (previewStepName === 'crop') {
+      previewSequencer.addSteps(previewStepName, customValues).run(insertPreview);
+    }
+    else {
+      previewSequencer.addSteps(previewStepName, { [previewStepName]: customValues }).run(insertPreview);
+    }
+  }
+  if(previewStepName === 'resize')
+    insertPreview(path);
+  else
+    previewSequencer.loadImage(path, loadPreview);
+}
+
+function updatePreviews(src, DomNode) {
+  $(DomNode).find('img').remove();
+
+  var previewSequencerSteps = {
+    'resize': '125%',
+    'brightness': '175',
+    'saturation': '0.5',
+    'rotate': 90,
+    'contrast': 90,
+    'crop': {
+      'x': 0,
+      'y': 0,
+      'w': '50%',
+      'h': '50%',
+      'noUI': true
+    }
+  };
+
+  var img = new Image();
+
+  img.onload = function(){
+    var height = img.height;
+    var width = img.width;
+
+    let percentage = (80 / height) * 100; // Take the min resize value that fits the preview area => (new-width/orig_ht) - '80 as the preview area has 80*80 dimension.
+    percentage = Math.max((80 / width) * 100, percentage); // Make sure that one dimension doesn't resize greater, leading distorting preview-area fitting.
+    percentage = Math.ceil(percentage);
+
+    var sequencer = ImageSequencer();
+
+    sequencer.loadImage(src, function(){
+      this.addSteps('resize', {['resize']: percentage + '%'});
+      this.run((src)=>{
+        Object.keys(previewSequencerSteps).forEach(function (step, index) {
+          generatePreview(step, Object.values(previewSequencerSteps)[index], src, DomNode);
+        });
+      });
+    });
+  };
+  img.src = src;
+}
+
+
+module.exports = {
+  generatePreview : generatePreview,
+  updatePreviews : updatePreviews
+};

examples/lib/intermediateHtmlStepUi.js

@@ -0,0 +1,172 @@
+var urlHash = require('./urlHash.js'),
+  insertPreview = require('./insertPreview.js');
+
+/**
+ * @method IntermediateHtmlStepUi
+ * @description Inserts a module selector in between the current sequence
+ * @param {Object} _sequencer Sequencer instance
+ * @param {Object} step Current step variable
+ * @param {Object} options Optional options Object
+ * @returns {Object} Object containing the insertStep function
+ */
+function IntermediateHtmlStepUi(_sequencer, step, options) {
+  function stepUI() {
+    // Basic markup for the selector
+    return '<div class="row insertDiv collapse">\
+          <section class="panel panel-primary .insert-step">\
+            <button class="btn btn-default close-insert-box"><i class="fa fa-times" aria-hidden="true"></i> Close</button>\
+            <div class="form-inline">\
+              <div class="panel-body">\
+                <p class="info">Select a new module to add to your sequence.</p>\
+                <div class="row center-align radio-group">\
+                  <div>\
+                    <div class="radio" data-value="resize">\
+                      <i class="fa fa-arrows-alt fa-4x i-over"></i>\
+                    </div>\
+                    <p>Resize</p>\
+                  </div>\
+                  <div>\
+                    <div class="radio" data-value="brightness">\
+                      <i class="fa fa-sun-o fa-4x i-over"></i>\
+                    </div>\
+                    <p>Brightness</p>\
+                  </div>\
+                  <div>\
+                    <div class="radio" data-value="contrast">\
+                      <i class="fa fa-adjust fa-4x i-over"></i>\
+                    </div>\
+                    <p>Contrast</p>\
+                  </div>\
+                  <div>\
+                    <div class="radio" data-value="saturation">\
+                      <i class="fa fa-tint fa-4x i-over i-small"></i>\
+                    </div>\
+                    <p>Saturation</p>\
+                  </div>\
+                  <div>\
+                    <div class="radio" data-value="rotate">\
+                      <i class="fa fa-rotate-right fa-4x i-over"></i>\
+                    </div>\
+                    <p>Rotate</p>\
+                  </div>\
+                  <div>\
+                    <div class="radio" data-value="crop">\
+                      <i class="fa fa-crop fa-4x i-over"></i>\
+                    </div>\
+                    <p>Crop</p>\
+                  </div>\
+                </div>\
+                <div class="row center-align">\
+                  <div class="col-md-8">\
+                    <select class="insert-step-select">\
+                      <!-- The default null selection has been appended manually in demo.js\
+                      This is because the options in select are overritten when options are appended.-->\
+                    </select>\
+                  <div>\
+                  <div class="col-md-4">\
+                    <button class="btn btn-primary btn-lg insert-save-btn add-step-btn" name="add">Add Step</button>\
+                  <div>\
+                </div>\
+              </div>\
+            </div>\
+          </section>\
+        </div>';
+  }
+
+  /**
+   * @method toggleDiv
+   * @description Toggles the module selector dropdown.
+   * @param {Object} $step $step util function
+   * @param {Fucntion} callback Optional callback function
+   * @returns {Null}
+   */
+  var toggleDiv = function($step, callback = function(){}){
+    $step('.insertDiv').collapse('toggle');
+    if ($step('.insert-text').css('display') != 'none'){
+      $step('.insert-text').fadeToggle(200, function(){$step('.no-insert-text').fadeToggle(200, callback);});
+    }
+    else {
+      $step('.no-insert-text').fadeToggle(200, function(){$step('.insert-text').fadeToggle(200, callback);});
+    }
+  };
+
+  /**
+   * @method insertStep
+   * @description Handler to insert selected module in the sequence
+   * @returns {Null}
+   */
+  insertStep = function (id) {
+    const $step = step.$step,
+      $stepAll = step.$stepAll;
+    var modulesInfo = _sequencer.modulesInfo();
+    var parser = new DOMParser();
+    var addStepUI = stepUI();
+    addStepUI = parser.parseFromString(addStepUI, 'text/html').querySelector('div');
+
+    if ($step('.insertDiv').length > 0){
+      toggleDiv($step);
+    }
+    else {
+      step.ui
+        .querySelector('div.step')
+        .insertAdjacentElement('afterend',
+          addStepUI
+        );
+      toggleDiv($step, function(){
+        if (step.name === 'load-image') insertPreview.updatePreviews(step.output.src, $step('.insertDiv').getDomElem());
+        else insertPreview.updatePreviews(step.output, $step('.insertDiv').getDomElem());
+      });
+    }
+
+
+    $step('.insertDiv .close-insert-box').off('click').on('click', function(){
+      toggleDiv($step);
+      $step('.insertDiv').removeClass('insertDiv');
+    });
+
+    var insertStepSelect = $step('.insert-step-select');
+    insertStepSelect.html('');
+
+    // Add modules to the insertStep dropdown
+    for (var m in modulesInfo) {
+      if (modulesInfo[m] && modulesInfo[m].name)
+        insertStepSelect.append(
+          '<option value="' + m + '">' + modulesInfo[m].name + '</option>'
+        );
+    }
+
+    insertStepSelect.selectize({
+      sortField: 'text'
+    });
+
+    $('.insertDiv .radio-group .radio').on('click', function () {
+      var newStepName = $(this).attr('data-value'); // Get the name of the module to be inserted
+      id = $($step('.insertDiv').parents()[3]).prevAll().length;
+      insert(id, $step, newStepName); // Insert the selected module
+    });
+
+    $step('.insertDiv .add-step-btn').on('click', function () {
+      var newStepName = insertStepSelect.val();
+      id = $($step('.insertDiv').parents()[3]).prevAll().length;
+      insert(id, $step, newStepName); });
+  };
+
+  /**
+   * @method insert
+   * @description Inserts the specified step at the specified index in the sequence
+   * @param {Number} id Index of the step
+   * @param {Function} $step $step util function
+   * @param {String} newStepName Name of the new step
+   */
+  function insert(id, $step, newStepName) {
+    toggleDiv($step);
+    $step('.insertDiv').removeClass('insertDiv');
+    _sequencer.insertSteps(id + 1, newStepName).run({ index: id });
+    urlHash.setUrlHashParameter('steps', _sequencer.toString());
+  }
+
+  return {
+    insertStep
+  };
+}
+module.exports = IntermediateHtmlStepUi;

examples/lib/mapHtmltypes.js

@@ -0,0 +1,37 @@
+/**
+ * @description Maps module input types to their respective html <input> tag types.
+ * @param {Object} inputInfo Object containing the type and optionally min/max for range type inputs.
+ */
+function mapHtmlTypes(inputInfo){
+  var htmlType;
+  switch(inputInfo.type.toLowerCase()){
+  case 'integer':
+    htmlType = inputInfo.min != undefined ? 'range' : 'number';
+    if (htmlType === 'range') inputInfo.step = inputInfo.step || 1; // default range step size for integer
+    break;
+  case 'string':
+    htmlType = 'text';
+    break;
+  case 'select':
+    htmlType = 'select';
+    break;
+  case 'percentage':
+    htmlType = 'number';
+    break;
+  case 'float':
+    htmlType = inputInfo.min != undefined ? 'range' : 'text';
+    if (htmlType === 'range') inputInfo.step = inputInfo.step || 0.1; // default range step size for float
+    break;
+  case 'coordinate-input':
+    htmlType = 'button';
+    break;
+  default:
+    htmlType = 'text';
+    break;
+  }
+  var response = Object.assign({}, inputInfo);
+  response.type = htmlType;
+  return response;
+}
+
+module.exports = mapHtmlTypes;

examples/lib/scopeQuery.js

@@ -0,0 +1,72 @@
+/**
+ * @method $scope
+ * @param {"DOMNode"} scope A DOM Node as the scope
+ * @returns {Function} Constructor for the scopeSelector Object.
+ */
+function $scope(scope) {
+  return function(queryString){
+    var element = $(scope.querySelector(queryString));
+
+    element.elem = function(queryString){
+      return new $scope(scope)(queryString);
+    };
+    element.elemAll = function(queryString){
+      return new $scopeAll(scope)(queryString);
+    };
+    element.getDomElem = function(i = 0){
+      return element[i];
+    };
+    element.getScope = () => scope;
+
+    return element;
+  };
+}
+
+/**
+ * @method $scopeAll
+ * @param {"DOMNode"} scope A DOM Node as the scope
+ * @returns {Function} Constructor for the scopeSelectorAll Object.
+ */
+function $scopeAll(scope){
+  return function(queryString){
+    var element = $(scope.querySelectorAll(queryString));
+
+    element.elem = function(queryString){
+      return new $scope(scope)(queryString);
+    };
+    element.elemAll = function(queryString){
+      return new $scopeAll(scope)(queryString);
+    };
+    element.getDomElem = function(i = 0){
+      return element[i];
+    };
+    element.getScope = () => scope;
+
+    return element;
+  };
+}
+
+/**
+ * @method scopeSelector
+ * @description A scoped jQuery selector
+ * @param {"DOMNode"} scope A DOM Node as the scope
+ * @returns {Function}
+ */
+function scopeSelector(scope){
+  return $scope(scope);
+}
+
+/**
+ * @method scopeSelectorAll
+ * @description A scoped jQuery multiple selector
+ * @param {"DOMNode} scope A DOM Node as the scope
+ * @returns {Function}
+ */
+function scopeSelectorAll(scope){
+  return $scopeAll(scope);
+}
+
+module.exports = {
+  scopeSelector,
+  scopeSelectorAll
+};

examples/lib/urlHash.js

@@ -40,3 +40,10 @@ function setUrlHashParameter(param, value) {
   setUrlHashParameters(params);
 
 }
+
+module.exports =  {
+  getUrlHashParameter: getUrlHashParameter,
+  setUrlHashParameter: setUrlHashParameter,
+  getUrlHashParameters: getUrlHashParameters,
+  setUrlHashParameters: setUrlHashParameters
+};

examples/lib/versionManagement.js

@@ -0,0 +1,43 @@
+/**
+ * Functions for getting version information.
+ * Note: these functions are not used by the service worker to check for updates;
+ * the service worker updates whenever sw.js has changed.
+ * sw.js is changed when grunt replace:version is run. This task is run during
+ * grunt build, serve, and productions tasks.
+ */
+
+const package = require('../../package.json');
+
+/**
+ * Get the current version number from package.json on the homepage.
+ * @param {function} callback The function that uses the version number.
+ */
+function getLatestVersionNumber(callback) {
+  // Get the homepage reference from the local package.json.
+  var homepage = package.homepage;
+  var request = new XMLHttpRequest();
+  request.onreadystatechange = function() {
+    if (request.readyState == 4 && request.status == 200) {
+      var response = JSON.parse(this.responseText);
+      var latestVersionNumber = response.version;
+
+      // Do something with the version number using a callback function.
+      if (callback)
+        callback(latestVersionNumber);
+    }
+  }
+
+  // Get the package.json file from online using a GET request.
+  request.open("GET", homepage + "/package.json", true);
+  request.send();
+}
+
+// Get the version number from the local package.json file.
+function getLocalVersionNumber() {
+  return package.version;
+}
+
+module.exports = {
+  getLatestVersionNumber,
+  getLocalVersionNumber
+}

examples/manifest.json

@@ -0,0 +1,21 @@
+{
+  "short_name": "IS",
+  "name": "Image Sequencer",
+  "icons": [
+    {
+      "src": "../icons/ic_192.png",
+      "type": "image/png",
+      "sizes": "192x192"
+    },
+    {
+      "src": "../icons/ic_512.png",
+      "type": "image/png",
+      "sizes": "512x512"
+    }
+  ],
+  "start_url": "/examples/#steps=",
+  "background_color": "#428bca",
+  "display": "standalone",
+  "scope": "/examples/",
+  "theme_color": "#428bca"
+}

examples/offline.html

@@ -0,0 +1,34 @@
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Error 502 | Bad Gateway</title>
+    <style>
+        body{
+            background-color:#d3d3d3;
+        }
+        p {
+            font-size:20px;
+        }
+        main {
+            display: flex;
+            flex-direction:column;
+            text-align: center;
+            justify-content: center;
+        }
+        a {
+            text-decoration: none;
+            color:blue;
+        }
+        
+    </style>
+</head>
+<body>
+    <main> 
+        <p>Error 502: something went wrong.</p>
+        <p>It seems that you are not connected to internet.<br>Please try after some time.</p>
+        <a href="/">Go To Home Page</a>
+    </main>
+</body>
+</html>

examples/selectize.default.css

@@ -0,0 +1,403 @@
+/**
+ * selectize.default.css (v0.12.6) - Default Theme
+ * Copyright (c) 2013–2015 Brian Reavis & contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this
+ * file except in compliance with the License. You may obtain a copy of the License at:
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+ * ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ *
+ * @author Brian Reavis <brian@thirdroute.com>
+ */
+.selectize-control.plugin-drag_drop.multi > .selectize-input > div.ui-sortable-placeholder {
+  visibility: visible !important;
+  background: #f2f2f2 !important;
+  background: rgba(0, 0, 0, 0.06) !important;
+  border: 0 none !important;
+  -webkit-box-shadow: inset 0 0 12px 4px #fff;
+  box-shadow: inset 0 0 12px 4px #fff;
+}
+.selectize-control.plugin-drag_drop .ui-sortable-placeholder::after {
+  content: '!';
+  visibility: hidden;
+}
+.selectize-control.plugin-drag_drop .ui-sortable-helper {
+  -webkit-box-shadow: 0 2px 5px rgba(0, 0, 0, 0.2);
+  box-shadow: 0 2px 5px rgba(0, 0, 0, 0.2);
+}
+.selectize-dropdown-header {
+  position: relative;
+  padding: 5px 8px;
+  border-bottom: 1px solid #d0d0d0;
+  background: #f8f8f8;
+  -webkit-border-radius: 3px 3px 0 0;
+  -moz-border-radius: 3px 3px 0 0;
+  border-radius: 3px 3px 0 0;
+}
+.selectize-dropdown-header-close {
+  position: absolute;
+  right: 8px;
+  top: 50%;
+  color: #303030;
+  opacity: 0.4;
+  margin-top: -12px;
+  line-height: 20px;
+  font-size: 20px !important;
+}
+.selectize-dropdown-header-close:hover {
+  color: #000000;
+}
+.selectize-dropdown.plugin-optgroup_columns .optgroup {
+  border-right: 1px solid #f2f2f2;
+  border-top: 0 none;
+  float: left;
+  -webkit-box-sizing: border-box;
+  -moz-box-sizing: border-box;
+  box-sizing: border-box;
+}
+.selectize-dropdown.plugin-optgroup_columns .optgroup:last-child {
+  border-right: 0 none;
+}
+.selectize-dropdown.plugin-optgroup_columns .optgroup:before {
+  display: none;
+}
+.selectize-dropdown.plugin-optgroup_columns .optgroup-header {
+  border-top: 0 none;
+}
+.selectize-control.plugin-remove_button [data-value] {
+  position: relative;
+  padding-right: 24px !important;
+}
+.selectize-control.plugin-remove_button [data-value] .remove {
+  z-index: 1;
+  /* fixes ie bug (see #392) */
+  position: absolute;
+  top: 0;
+  right: 0;
+  bottom: 0;
+  width: 17px;
+  text-align: center;
+  font-weight: bold;
+  font-size: 12px;
+  color: inherit;
+  text-decoration: none;
+  vertical-align: middle;
+  display: inline-block;
+  padding: 2px 0 0 0;
+  border-left: 1px solid #0073bb;
+  -webkit-border-radius: 0 2px 2px 0;
+  -moz-border-radius: 0 2px 2px 0;
+  border-radius: 0 2px 2px 0;
+  -webkit-box-sizing: border-box;
+  -moz-box-sizing: border-box;
+  box-sizing: border-box;
+}
+.selectize-control.plugin-remove_button [data-value] .remove:hover {
+  background: rgba(0, 0, 0, 0.05);
+}
+.selectize-control.plugin-remove_button [data-value].active .remove {
+  border-left-color: #00578d;
+}
+.selectize-control.plugin-remove_button .disabled [data-value] .remove:hover {
+  background: none;
+}
+.selectize-control.plugin-remove_button .disabled [data-value] .remove {
+  border-left-color: #aaaaaa;
+}
+.selectize-control.plugin-remove_button .remove-single {
+  position: absolute;
+  right: 0;
+  top: 0;
+  font-size: 23px;
+}
+.selectize-control {
+  position: relative;
+}
+.selectize-dropdown,
+.selectize-input,
+.selectize-input input {
+  color: #303030;
+  font-family: inherit;
+  font-size: 18px;
+  line-height: 18px;
+  -webkit-font-smoothing: inherit;
+}
+.selectize-input,
+.selectize-control.single .selectize-input.input-active {
+  background: #fff;
+  cursor: text;
+  display: inline-block;
+}
+.selectize-input {
+  border: 1px solid #d0d0d0;
+  padding: 10px 0px;
+  display: inline-block;
+  width: 24vw;
+  overflow: hidden;
+  position: relative;
+  z-index: 1;
+  -webkit-box-sizing: border-box;
+  -moz-box-sizing: border-box;
+  box-sizing: border-box;
+  -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.1);
+  box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.1);
+  -webkit-border-radius: 3px;
+  -moz-border-radius: 3px;
+  border-radius: 3px;
+}
+.selectize-control.multi .selectize-input.has-items {
+  padding: 5px 8px 2px;
+}
+.selectize-input.full {
+  background-color: #fff;
+}
+.selectize-input.disabled,
+.selectize-input.disabled * {
+  cursor: default !important;
+}
+.selectize-input.focus {
+  -webkit-box-shadow: inset 0 1px 2px rgba(0, 0, 0, 0.15);
+  box-shadow: inset 0 1px 2px rgba(0, 0, 0, 0.15);
+}
+.selectize-input.dropdown-active {
+  -webkit-border-radius: 3px 3px 0 0;
+  -moz-border-radius: 3px 3px 0 0;
+  border-radius: 3px 3px 0 0;
+}
+.selectize-input > * {
+  vertical-align: baseline;
+  display: -moz-inline-stack;
+  display: inline-block;
+  zoom: 1;
+  *display: inline;
+}
+.selectize-control.multi .selectize-input > div {
+  cursor: pointer;
+  margin: 0 3px 3px 0;
+  padding: 2px 6px;
+  background: #1da7ee;
+  color: #fff;
+  border: 1px solid #0073bb;
+}
+.selectize-control.multi .selectize-input > div.active {
+  background: #92c836;
+  color: #fff;
+  border: 1px solid #00578d;
+}
+.selectize-control.multi .selectize-input.disabled > div,
+.selectize-control.multi .selectize-input.disabled > div.active {
+  color: #ffffff;
+  background: #d2d2d2;
+  border: 1px solid #aaaaaa;
+}
+.selectize-input > input {
+  display: inline-block !important;
+  padding: 0 !important;
+  min-height: 0 !important;
+  max-height: none !important;
+  max-width: 100% !important;
+  margin: 0 1px !important;
+  text-indent: 0 !important;
+  border: 0 none !important;
+  background: none !important;
+  line-height: inherit !important;
+  -webkit-user-select: auto !important;
+  -webkit-box-shadow: none !important;
+  box-shadow: none !important;
+}
+.selectize-input > input::-ms-clear {
+  display: none;
+}
+.selectize-input > input:focus {
+  outline: none !important;
+}
+.selectize-input::after {
+  content: ' ';
+  display: block;
+  clear: left;
+}
+.selectize-input.dropdown-active::before {
+  content: ' ';
+  display: block;
+  position: absolute;
+  background: #f0f0f0;
+  height: 1px;
+  bottom: 0;
+  left: 0;
+  right: 0;
+}
+.selectize-dropdown {
+  position: absolute;
+  z-index: 10;
+  border: 1px solid #d0d0d0;
+  background: #fff;
+  margin: -1px 0 0 0;
+  border-top: 0 none;
+  -webkit-box-sizing: border-box;
+  -moz-box-sizing: border-box;
+  box-sizing: border-box;
+  -webkit-box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
+  box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
+  -webkit-border-radius: 0 0 3px 3px;
+  -moz-border-radius: 0 0 3px 3px;
+  border-radius: 0 0 3px 3px;
+}
+.selectize-dropdown [data-selectable] {
+  cursor: pointer;
+  overflow: hidden;
+}
+.selectize-dropdown [data-selectable] .highlight {
+  background: rgba(125, 168, 208, 0.2);
+  -webkit-border-radius: 1px;
+  -moz-border-radius: 1px;
+  border-radius: 1px;
+}
+.selectize-dropdown .option,
+.selectize-dropdown .optgroup-header {
+  padding: 5px 8px;
+}
+.selectize-dropdown .option,
+.selectize-dropdown [data-disabled],
+.selectize-dropdown [data-disabled] [data-selectable].option {
+  cursor: inherit;
+  opacity: 0.5;
+}
+.selectize-dropdown [data-selectable].option {
+  opacity: 1;
+}
+.selectize-dropdown .optgroup:first-child .optgroup-header {
+  border-top: 0 none;
+}
+.selectize-dropdown .optgroup-header {
+  color: #303030;
+  background: #fff;
+  cursor: default;
+}
+.selectize-dropdown .active {
+  background-color: #f5fafd;
+  color: #495c68;
+}
+.selectize-dropdown .active.create {
+  color: #495c68;
+}
+.selectize-dropdown .create {
+  color: rgba(48, 48, 48, 0.5);
+}
+.selectize-dropdown-content {
+  overflow-y: auto;
+  overflow-x: hidden;
+  max-height: 200px;
+  -webkit-overflow-scrolling: touch;
+}
+.selectize-control.single .selectize-input,
+.selectize-control.single .selectize-input input {
+  cursor: pointer;
+}
+.selectize-control.single .selectize-input.input-active,
+.selectize-control.single .selectize-input.input-active input {
+  cursor: text;
+}
+.selectize-control.single .selectize-input:after {
+  content: ' ';
+  display: block;
+  position: absolute;
+  top: 50%;
+  right: 15px;
+  margin-top: -3px;
+  width: 0;
+  height: 0;
+  border-style: solid;
+  border-width: 5px 5px 0 5px;
+  border-color: #808080 transparent transparent transparent;
+}
+.selectize-control.single .selectize-input.dropdown-active:after {
+  margin-top: -4px;
+  border-width: 0 5px 5px 5px;
+  border-color: transparent transparent #808080 transparent;
+}
+.selectize-control.rtl.single .selectize-input:after {
+  left: 15px;
+  right: auto;
+}
+.selectize-control.rtl .selectize-input > input {
+  margin: 0 4px 0 -2px !important;
+}
+.selectize-control .selectize-input.disabled {
+  opacity: 0.5;
+  background-color: #fafafa;
+}
+.selectize-control.multi .selectize-input.has-items {
+  padding-left: 5px;
+  padding-right: 5px;
+}
+.selectize-control.multi .selectize-input.disabled [data-value] {
+  color: #999;
+  text-shadow: none;
+  background: none;
+  -webkit-box-shadow: none;
+  box-shadow: none;
+}
+.selectize-control.multi .selectize-input.disabled [data-value],
+.selectize-control.multi .selectize-input.disabled [data-value] .remove {
+  border-color: #e6e6e6;
+}
+.selectize-control.multi .selectize-input.disabled [data-value] .remove {
+  background: none;
+}
+.selectize-control.multi .selectize-input [data-value] {
+  text-shadow: 0 1px 0 rgba(0, 51, 83, 0.3);
+  -webkit-border-radius: 3px;
+  -moz-border-radius: 3px;
+  border-radius: 3px;
+  background-color: #1b9dec;
+  background-image: -moz-linear-gradient(top, #1da7ee, #178ee9);
+  background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#1da7ee), to(#178ee9));
+  background-image: -webkit-linear-gradient(top, #1da7ee, #178ee9);
+  background-image: -o-linear-gradient(top, #1da7ee, #178ee9);
+  background-image: linear-gradient(to bottom, #1da7ee, #178ee9);
+  background-repeat: repeat-x;
+  filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff1da7ee', endColorstr='#ff178ee9', GradientType=0);
+  -webkit-box-shadow: 0 1px 0 rgba(0,0,0,0.2),inset 0 1px rgba(255,255,255,0.03);
+  box-shadow: 0 1px 0 rgba(0,0,0,0.2),inset 0 1px rgba(255,255,255,0.03);
+}
+.selectize-control.multi .selectize-input [data-value].active {
+  background-color: #0085d4;
+  background-image: -moz-linear-gradient(top, #008fd8, #0075cf);
+  background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#008fd8), to(#0075cf));
+  background-image: -webkit-linear-gradient(top, #008fd8, #0075cf);
+  background-image: -o-linear-gradient(top, #008fd8, #0075cf);
+  background-image: linear-gradient(to bottom, #008fd8, #0075cf);
+  background-repeat: repeat-x;
+  filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff008fd8', endColorstr='#ff0075cf', GradientType=0);
+}
+.selectize-control.single .selectize-input {
+  -webkit-box-shadow: 0 1px 0 rgba(0,0,0,0.05), inset 0 1px 0 rgba(255,255,255,0.8);
+  box-shadow: 0 1px 0 rgba(0,0,0,0.05), inset 0 1px 0 rgba(255,255,255,0.8);
+  background-color: #f9f9f9;
+  background-image: -moz-linear-gradient(top, #fefefe, #f2f2f2);
+  background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#fefefe), to(#f2f2f2));
+  background-image: -webkit-linear-gradient(top, #fefefe, #f2f2f2);
+  background-image: -o-linear-gradient(top, #fefefe, #f2f2f2);
+  background-image: linear-gradient(to bottom, #fefefe, #f2f2f2);
+  background-repeat: repeat-x;
+  filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#fffefefe', endColorstr='#fff2f2f2', GradientType=0);
+}
+/* .selectize-control.single .selectize-input,
+.selectize-dropdown.single {
+  border-color: #b8b8b8;
+} */
+.selectize-dropdown .optgroup-header {
+  padding-top: 7px;
+  font-weight: bold;
+  font-size: 0.85em;
+}
+.selectize-dropdown .optgroup {
+  border-top: 1px solid #f0f0f0;
+}
+.selectize-dropdown .optgroup:first-child {
+  border-top: 0 none;
+}

examples/sw.js

@@ -0,0 +1,61 @@
+const staticCacheName = 'image-sequencer-static-v3.7.3';
+self.addEventListener('install', function(e) {
+  e.waitUntil(
+    caches.open(staticCacheName).then(function(cache) {
+      console.log('Attempting to install service worker');
+      return cache.addAll([
+        '/',
+        '/examples/offline.html'
+      ]);
+    })
+  );
+});
+
+self.addEventListener('activate', function(e) {
+  console.log('[ServiceWorker] Activate');
+  e.waitUntil(
+    caches.keys().then(function(cacheNames) {
+      return Promise.all(
+        cacheNames.filter(function(cacheName){
+          return cacheName.startsWith('image-sequencer-') &&
+                 cacheName != staticCacheName;
+        }).map(function(cacheName){
+          return caches.delete(cacheName);
+        })
+      );
+    })
+  );
+});
+
+self.addEventListener('fetch', function(event) {
+  event.respondWith(
+    // Try to fetch the latest data first.
+    fetch(event.request)
+      .then(function(response) {
+        return caches.open(staticCacheName)
+          .then(function(cache) {
+            if(event.request.method == 'GET'){
+              cache.put(event.request.url, response.clone());
+            }
+            return response;
+          });
+      })
+      .catch(function(err) {
+      // Now the request has been failed so show cached data.
+        return caches.match(event.request).then(function(res){
+          if (res === undefined) {
+            // Display offline page
+            return caches.match('offline.html');
+          }
+          return res;
+        });
+      })
+  );
+});
+
+// When the update modal sends a 'skipWaiting' message, call the skipWaiting method.
+self.addEventListener('message', function(event) {
+  if(event.data.action === 'skipWaiting') {
+    self.skipWaiting();
+  }
+});

index.js

@@ -1,111 +1,5 @@
 #!/usr/bin/env node
 
-require('./src/ImageSequencer');
-sequencer = ImageSequencer({ui: false});
+var cli = require('./src/cli');
 
-var program = require('commander');
-var readlineSync = require('readline-sync');
-
-function exit(message) {
-  console.error(message);
-  process.exit(1);
-}
-
-program
-  .version('0.1.0')
-  .option('-i, --image [PATH/URL]', 'Input image URL')
-  .option('-s, --step [step-name]', 'Name of the step to be added.')
-  .option('-o, --output [PATH]', 'Directory where output will be stored.')
-  .option('-op, --opions {object}', 'Options for the step')
-  .parse(process.argv);
-
-// Parse step into an array to allow for multiple steps.
-program.step = program.step.split(" ");
-
-// User must input an image.
-if(!program.image) exit("Can't read file.")
-
-// User must input an image.
-require('fs').access(program.image, function(err){
-  if(err) exit("Can't read file.")
-});
-
-// User must input a step. If steps exist, check that every step is a valid step.
-if(!program.step || !validateSteps(program.step))
-  exit("Please ensure all steps are valid.");
-
-// If there's no user defined output directory, select a default directory.
-program.output = program.output || "./output/";
-
-// Set sequencer to log module outputs, if any.
-sequencer.setUI({
-
-  onComplete: function(step) {
-
-    // Get information of outputs.
-    step.info = sequencer.modulesInfo(step.name);
-
-    for (var output in step.info.outputs) {
-      console.log("["+program.step+"]: "+output+" = "+step[output]);
-    }
-
-  }
-
-});
-
-// Finally, if everything is alright, load the image, add the steps and run the sequencer.
-sequencer.loadImages(program.image,function(){
-
-  // Iterate through the steps and retrieve their inputs.
-  program.step.forEach(function(step){
-    var options = Object.assign({}, sequencer.modulesInfo(step).inputs);
-
-    // If inputs exists, print to console.
-    if (Object.keys(options).length) {
-      console.log("[" + step + "]: Inputs");
-    }
-
-    // If inputs exists, print them out with descriptions.
-    Object.keys(options).forEach(function(input) {
-        // The array below creates a variable number of spaces. This is done with (length + 1). 
-        // The extra 4 that makes it (length + 5) is to account for the []: characters
-        console.log(new Array(step.length + 5).join(' ') + input + ": " + options[input].desc);
-    });
-
-    // If inputs exist, iterate through them and prompt for values.
-    Object.keys(options).forEach(function(input) {
-        var value = readlineSync.question("[" + step + "]: Enter a value for " + input + " (" + options[input].type + ", default: " + options[input].default + "): ");
-        options[input] = value;
-    });
-
-    // Add the step and its inputs to the sequencer.
-    sequencer.addSteps(step, options);
-  });
-
-  // Run the sequencer.
-  sequencer.run(function(){
-
-    // Export all images as binary files.
-    sequencer.exportBin(program.output);
-
-    console.log("Files will be exported to \""+program.output+"\"");
-
-  });
-
-});
-
-// Takes an array of steps and checks if they are valid steps for the sequencer.
-function validateSteps(steps) {
-
-  // Assume all are valid in the beginning. 
-  var valid = true;
-  steps.forEach(function(step) {
-    // If any step in the array is not valid (not a property of modulesInfo), set valid to false.
-    if (!sequencer.modulesInfo().hasOwnProperty(step)) {
-      valid = false;
-    }
-  });
-
-  // Return valid. (If all of the steps are valid properties, valid will have remained true).
-  return valid;
-}
+cli(process.argv);

jest-puppeteer.config.js

@@ -0,0 +1,12 @@
+module.exports = {
+  launch: {
+    args: ['--no-sandbox', '--disable-setuid-sandbox'], // https://github.com/puppeteer/puppeteer/blob/main/docs/troubleshooting.md#setting-up-chrome-linux-sandbox
+    headless: process.env.HEADLESS !== 'false',
+  },
+  server: {
+    command: 'grunt serve',
+    port:3000,
+    launchTimeout: 5000000,
+  },
+  
+};

jest.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  preset: 'jest-puppeteer',
+  testRegex: './*\\.test\\.js$',
+  verbose: true,
+};
+

package.json

@@ -1,10 +1,26 @@
 {
   "name": "image-sequencer",
-  "version": "0.1.1",
+  "version": "3.7.3",
   "description": "A modular JavaScript image manipulation library modeled on a storyboard.",
   "main": "src/ImageSequencer.js",
   "scripts": {
-    "test": "tape test/*.js | tap-spec; browserify test/image-sequencer.js test/chain.js | tape-run --render=\"tap-spec\""
+    "debug": "TEST=true node ./index.js -i ./examples/images/monarch.png -s invert",
+    "test": "TEST=true istanbul cover tape test/core/*.js test/core/ui/user-interface.js test/core/modules/*.js | tap-spec;",
+    "benchmark": "node test/core/sequencer/benchmark.js | tap-spec;",
+    "gif-test": "node test/core/gifs/gif-test.js | tap-spec;",
+    "core-tests": "cat ./output/core-tests.js | tape-run --render=\"tap-spec\"",
+    "test-all": "npm run test && npm run benchmark && npm run gif-test && grunt tests && npm run core-tests",
+    "test-ui": "node node_modules/jasmine/bin/jasmine test/ui/spec/*.js",
+    "test-ui-2": "node ./node_modules/.bin/jest",
+    "test-cli": "node test/cli/*.js | tap-spec",
+    "setup": "npm i && npm i -g grunt grunt-cli && npm rebuild --build-from-source && grunt build",
+    "start": "grunt serve"
+  },
+  "lint-staged": {
+    "*.js": [
+      "./node_modules/.bin/eslint --fix",
+      "git add"
+    ]
   },
   "repository": {
     "type": "git",
@@ -20,36 +36,90 @@
     "url": "https://github.com/publiclab/image-sequencer/issues"
   },
   "dependencies": {
-    "bootstrap": "~3.2.0",
-    "buffer": "~5.0.2",
-    "commander": "^2.11.0",
-    "data-uri-to-buffer": "^2.0.0",
+    "atob": "^2.1.2",
+    "base64-img": "^1.0.4",
+    "bootstrap": "^3.4.1",
+    "bootstrap-colorpicker": "^2.5.3",
+    "buffer": "~6.0.2",
+    "commander": "^9.0.0",
+    "compressorjs": "^1.0.5",
+    "data-uri-to-buffer": "^3.0.0",
+    "downloadjs": "^1.4.7",
+    "eslint": "^8.0.0",
+    "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",
-    "font-awesome": "~4.5.0",
-    "jquery": "~2",
-    "jsqr": "^0.2.2",
+    "gifshot": "^0.4.5",
+    "glfx": "0.0.4",
+    "gpu.js": "^2.3.1",
+    "imgareaselect": "git+https://git@github.com/jywarren/imgareaselect.git#v1.0.0-rc.2",
+    "image-sequencer-invert": "^1.0.0",
+    "imagejs": "git+https://git@github.com/glennjones/imagejs.git#1119a31e6eabc87563bc573cd62c11bd487ce8a9",
+    "imagemin": "^7.0.1",
+    "imagemin-jpegtran": "^7.0.0",
+    "imagemin-pngquant": "^9.0.1",
+    "istanbul": "^0.4.5",
+    "jasmine": "^4.0.2",
+    "jpegtran-bin": "^6.0.1",
+    "jquery": "^3.3.1",
+    "jsdom": "^19.0.0",
+    "jspdf": "^2.1.1",
+    "jsqr": "^1.1.1",
+    "lodash": "^4.17.11",
+    "ndarray": "^1.0.18",
+    "opencv.js": "^1.2.1",
+    "ora": "^5.1.0",
+    "pace": "0.0.4",
+    "pngquant-bin": "^6.0.0",
+    "puppeteer": "^1.14.0",
+    "qrcode": "^1.3.3",
     "readline-sync": "^1.4.7",
     "save-pixels": "~2.3.4",
-    "urify": "^2.1.0"
+    "selectize": "^0.12.6",
+    "spawn-sync": "^2.0.0",
+    "urify": "^2.1.1",
+    "webgl-distort": "0.0.2"
   },
   "devDependencies": {
-    "browserify": "13.0.0",
-    "data-uri-to-buffer": "^2.0.0",
-    "grunt": "^0.4.5",
+    "@babel/core": "^7.4.3",
+    "@babel/plugin-proposal-object-rest-spread": "^7.4.3",
+    "@babel/plugin-syntax-object-rest-spread": "^7.2.0",
+    "babelify": "^10.0.0",
+    "browserify": "17.0.0",
+    "canvas": "^2.8.0",
+    "eslint": "^8.0.0",
+    "grunt": "^1.0.3",
+    "grunt-browser-sync": "^2.2.0",
     "grunt-browserify": "^5.0.0",
-    "grunt-contrib-concat": "^0.5.0",
-    "grunt-contrib-uglify": "git://github.com/gruntjs/grunt-contrib-uglify.git#harmony",
-    "grunt-contrib-watch": "^0.6.1",
-    "image-filter-core": "~1.0.0",
-    "image-filter-threshold": "~1.0.0",
-    "looks-same": "^3.2.1",
-    "matchdep": "^0.3.0",
-    "tap-spec": "^4.1.1",
-    "tape": ">=4.7.0",
-    "tape-run": "^3.0.0"
+    "grunt-contrib-concat": "^2.0.0",
+    "grunt-contrib-uglify-es": "^3.3.0",
+    "grunt-contrib-watch": "^1.1.0",
+    "grunt-text-replace": "^0.4.0",
+    "husky": "^7.0.0",
+    "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-puppeteer": "^6.0.0",
+    "lint-staged": "^12.1.3",
+    "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",
+    "uglify-es": "^3.3.7"
   },
-  "homepage": "https://github.com/publiclab/image-sequencer",
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "homepage": "https://sequencer.publiclab.org",
   "bin": {
     "sequencer": "./index.js"
   }

scripts/update-demo

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+scriptsDir=$(realpath $(dirname $0))
+
+echo -ne "Enter the repo to push to in the form username/repo (required): "
+read -e pushRepo
+
+echo -ne "Enter repo URL to pull from (upstream) in the form username/repo (default: publiclab/image-sequencer): "
+read -e repoInput
+
+echo -ne "Enter branch name (default: stable): "
+read -e branchInput
+
+echo -ne "Enter CNAME URL(default: none): "
+read -e cnameUrlInput
+
+tempDir=$(mktemp -d)
+pushd $tempDir > /dev/null
+
+git clone https://github.com/$pushRepo
+pushd image-sequencer > /dev/null
+
+$scriptsDir/update-gh-pages "$repoInput" "$branchInput" "$cnameUrlInput" "no warn"
+
+popd > /dev/null
+popd > /dev/null

scripts/update-gh-pages

@@ -0,0 +1,117 @@
+#!/bin/bash
+set -e # So that nothing wrong is published
+
+warn() {
+  echo -e "\033[1;31m
+------IMPORTANT------
+  THIS SCRIPT IS NOT MEANT TO BE USED DIRECTLY, PLEASE NEWLY CLONE THE REPO IN A SEPARATE DIRECTORY AND USE THE SCRIPT THERE.
+  USING THIS SCRIPT IN YOUR MAIN CLONE MAY DELETE YOUR LOCAL CHANGES.
+  This script is made to be reusable: If you want to manually update the demo, \
+  use the interactive script \`update-demo\`. This script can also be used in a github action.
+
+  You can set the 4th argument to anything to bypass this warning. \
+  Setting the 4th argument means that the first 3 arguments are also set which means that you know what you are doing (I assume).
+------IMPORTANT------
+\033[0m"
+
+  echo -ne "Do you still want to continue? [Y/n]: "
+  read -e yN
+
+  case $yN in
+    [yY][eE][sS] | [yY])
+    ;;
+    *)
+      exit 0
+    ;;
+  esac
+}
+
+# --- Constants ---
+deps="jquery bootstrap imgareaselect gifshot downloadjs selectize font-awesome bootstrap-colorpicker jspdf opencv.js/opencv.js" # A list of node_module dependencies to force commit
+# --- Constants ---
+
+# --- Arguments ---
+# $1: Repo(to use as upstream) url in the form username/repo (default: publiclab/image-sequencer) NOTE: Github only
+# $2: Branch to pull from eg: main or stable (default: stable)
+# $3: CNAME URL (default: none)
+# $4: Set the fourth argument to anything to bypass the warning.
+
+if [[ "$1" != "" ]];
+then
+  repo=$1
+else
+  repo="publiclab/image-sequencer"
+fi
+
+if [[ "$2" != "" ]];
+then
+  branch=$2
+else
+  branch="stable"
+fi
+
+if [[ "$3" != "" ]];
+then
+  CNAMEURL=$3
+else
+  CNAMEURL=""
+fi
+# --- Arguments ---
+
+# --- Main Script ---
+if [[ "$4" == "" ]]; # Set a 4th argument to anything to bypass this warning.
+then
+  warn
+fi
+
+git checkout gh-pages
+git remote add upstream https://github.com/$repo
+git fetch upstream
+
+git reset --hard upstream/$branch
+
+echo -e "Running setup script."
+npm run setup
+
+echo -e "Building dist files."
+grunt production
+
+if [ ! -f CNAME ];
+then
+  echo -e "Creating CNAME"
+  touch CNAME
+fi
+
+echo $CNAMEURL > CNAME
+
+echo -e "Removing unnecessary files."
+rm -R docs/
+rm -R test/
+rm CONTRIBUTING.md
+rm index.js
+
+echo -e "Copying important files from src/"
+cp src/ui/prepareDynamic.js prepareDynamic.js
+
+echo "Removing src/"
+rm -R src/
+mkdir -p src/ui/
+mv prepareDynamic.js src/ui/prepareDynamic.js
+
+echo -e "git add dist and node_modules dependencies."
+git add .
+
+for dep in $deps; # Force add node_modules dependencies
+do
+  git add -f node_modules/$dep
+done
+
+git add -f dist/image-sequencer.js
+git add -f dist/image-sequencer-ui.js
+
+echo -e "committing and pusing."
+git commit --no-verify -m "update"
+git push -f
+
+exit 0
+# --- Main Script ---

src/AddStep.js

@@ -1,29 +1,5 @@
-function AddStep(ref, image, name, o) {
-
-  function addStep(image, name, o_) {
-    var o = ref.copy(o_);
-    o.number = ref.options.sequencerCounter++; //Gives a Unique ID to each step
-    o.name = o_.name || name;
-    o.selector = o_.selector || 'ismod-' + name;
-    o.container = o_.container || ref.options.selector;
-    o.image = image;
-    o.inBrowser = ref.options.inBrowser;
-
-    o.step = {
-      name: o.name,
-      ID: o.number,
-      imageName: o.image,
-      inBrowser: ref.options.inBrowser,
-      ui: ref.options.ui,
-      options: o
-    };
-    var UI = ref.events;
-    var module = ref.modules[name][0](o,UI);
-    ref.images[image].steps.push(module);
-
-    return true;
-  }
-
-  addStep(image, name, o);
+// add steps to the sequencer
+function AddStep(_sequencer, name, o) {
+  return require('./InsertStep')(_sequencer, -1, name, o);
 }
 module.exports = AddStep;

src/CliUtils.js

@@ -0,0 +1,58 @@
+var fs = require('fs');
+
+/*
+* This function checks if the directory exists, if not it creates one on the given path
+* Callback is called with argument error if an error is encountered
+*/
+function makedir(path, callback){
+  fs.access(path, function(err){
+    if(err) fs.mkdir(path, function(err){
+      if(err) callback(err);
+      callback();
+    });
+    else callback();
+  });
+}
+
+// Takes an array of steps and checks if they are valid steps for the sequencer.
+function validateSteps(steps, sequencer) {
+  // Assume all are valid in the beginning.
+  var valid = true;
+  steps.forEach(function(step) {
+    // If any step in the array is not valid (not a property of modulesInfo), set valid to false.
+    if (!sequencer.modulesInfo().hasOwnProperty(step)) {
+      valid = false;
+    }
+  });
+
+  // Return valid. (If all of the steps are valid properties, valid will have remained true).
+  return valid;
+}
+
+//Takes config and options object and checks if all the keys exist in config
+function validateConfig(config_, options_) {
+  options_ = Object.keys(options_);
+  if (
+    (function() {
+      for (var input in options_) {
+        if (!config_[options_[input]]) {
+          console.error(
+            '\x1b[31m%s\x1b[0m',
+            `Options Object does not have the required details "${
+              options_[input]
+            }" not specified. Fallback case activated`
+          );
+          return false;
+        }
+      }
+    })() == false
+  )
+    return false;
+  else return true;
+}
+
+module.exports = exports = {
+  makedir: makedir,
+  validateSteps: validateSteps,
+  validateConfig: validateConfig
+};

src/ExportBin.js

@@ -1,54 +1,69 @@
 var fs = require('fs');
 var getDirectories = function(rootDir, cb) {
   fs.readdir(rootDir, function(err, files) {
-      var dirs = [];
-      if(typeof(files)=="undefined") {
-        cb(dirs);
-        return [];
-      }
-      for (var index = 0; index < files.length; ++index) {
-          var file = files[index];
-          if (file[0] !== '.') {
-              var filePath = rootDir + '/' + file;
-              fs.stat(filePath, function(err, stat) {
-                  if (stat.isDirectory()) {
-                      dirs.push(this.file);
-                  }
-                  if (files.length === (this.index + 1)) {
-                      return cb(dirs);
-                  }
-              }.bind({index: index, file: file}));
-          }
-      }
-  });
-}
-
-module.exports = function ExportBin(dir = "./output/",ref) {
-  dir = (dir[dir.length-1]=="/") ? dir : dir + "/";
-  if(ref.options.inBrowser) return false;
-  fs.access(dir, function(err){
-    if(err) fs.mkdir(dir, function() {});
-  });
-  getDirectories(dir,function(dirs){
-    var num = 1;
-    for(var d in dirs){
-      if(dirs[d].match(/^sequencer(.*)$/)==null) continue;
-      var n = parseInt(dirs[d].match(/^sequencer(.*)$/)[1]);
-      num = (n>=num)?(n+1):num;
+    var dirs = [];
+    if (typeof (files) == 'undefined' || files.length == 0) {
+      cb(dirs);
+      return [];
     }
-    fs.mkdir(dir+'sequencer'+num,function(){
-      var root = dir+'sequencer'+num+'/';
-      for(var image in ref.images) {
-        var steps = ref.images[image].steps;
-        for(var i in steps) {
-          var datauri = steps[i].output.src;
-          var ext = steps[i].output.format;
-          var buffer = require('data-uri-to-buffer')(datauri);
-          fs.writeFile(root+image+"_"+i+"."+ext,buffer,function(){
-
-          });
-        }
+    for (var index = 0; index < files.length; ++index) {
+      var file = files[index];
+      if (file[0] !== '.') {
+        var filePath = rootDir + '/' + file;
+        fs.stat(filePath, function(err, stat) {
+          if (stat.isDirectory()) {
+            dirs.push(this.file);
+          }
+          if (files.length === (this.index + 1)) {
+            return cb(dirs);
+          }
+        }.bind({ index: index, file: file }));
       }
-    })
+    }
   });
-}
+};
+
+module.exports = function ExportBin(dir = './output/', ref, basic, filename) {
+
+  // If user did not give an output filename so we can continue without doing anything
+  dir = (dir[dir.length - 1] == '/') ? dir : dir + '/';
+  if (ref.options.inBrowser) return false;
+  fs.access(dir, function(err) {
+    if (err) console.error(err);
+  });
+  if (filename && basic) {
+    var steps = ref.steps;
+    var datauri = steps.slice(-1)[0].output.src;
+    var ext = steps.slice(-1)[0].output.format;
+    var buffer = require('data-uri-to-buffer')(datauri);
+    fs.writeFile(dir + filename, buffer, function() { });
+  }
+  else {
+    getDirectories(dir, function(dirs) {
+      var num = 1;
+      for (var d in dirs) {
+        if (dirs[d].match(/^sequencer(.*)$/) == null) continue;
+        var n = parseInt(dirs[d].match(/^sequencer(.*)$/)[1]);
+        num = (n >= num) ? (n + 1) : num;
+      }
+      fs.mkdir(dir + 'sequencer' + num, function() {
+        var root = dir + 'sequencer' + num + '/';
+        var steps = ref.steps;
+        if (basic) {
+          var datauri = steps.slice(-1)[0].output.src;
+          var ext = steps.slice(-1)[0].output.format;
+          var buffer = require('data-uri-to-buffer')(datauri);
+          fs.writeFile(root + 'image' + '_' + (steps.length - 1) + '.' + ext, buffer, function() { });
+        }
+        else {
+          for (var i in steps) {
+            var datauri = steps[i].output.src;
+            var ext = steps[i].output.format;
+            var buffer = require('data-uri-to-buffer')(datauri);
+            fs.writeFile(root + 'image' + '_' + i + '.' + ext, buffer, function() { });
+          }
+        }
+      });
+    });
+  }
+};

src/FormatInput.js

@@ -1,19 +1,19 @@
 function objTypeOf(object){
-  return Object.prototype.toString.call(object).split(" ")[1].slice(0,-1)
+  return Object.prototype.toString.call(object).split(' ')[1].slice(0, -1);
 }
 
 function getPrimitive(object){
-  return (objTypeOf(object)=='Array')?object[0]:object;
+  return (objTypeOf(object) == 'Array') ? object[0] : object;
 }
 
 function makeArray(input) {
-  return (objTypeOf(input)=="Array")?input:[input];
+  return (objTypeOf(input) == 'Array') ? input : [input];
 }
 
 function copy(a) {
-  if (!typeof(a) == "object") return a;
-  if (objTypeOf(a) == "Array") return a.slice();
-  if (objTypeOf(a) == "Object") {
+  if (!typeof(a) == 'object') return a;
+  if (objTypeOf(a) == 'Array') return a.slice();
+  if (objTypeOf(a) == 'Object') {
     var b = {};
     for (var v in a) {
       b[v] = copy(a[v]);
@@ -23,141 +23,84 @@ function copy(a) {
   return a;
 }
 
-function formatInput(args,format,images) {
-  images = [];
-  for (var image in this.images) {
-    images.push(image);
-  }
+function formatInput(args, format, images) {
   var json_q = {};
   var format_i = format;
-  if (format == "+")
-    format = ['o_string_a', 'string_a', 'o_object'];
-  else if (format == "-")
-    format = ['o_string_a', 'number_a'];
-  else if (format == "^")
-    format = ['o_string_a', 'number', 'string', 'o_object'];
-  else if (format == "r")
-    format = ['o_string_a', 'o_number'];
-  else if (format == "l")
-    format = ['o_string','string','o_function'];
+  if (format == '+')
+    format = ['string_a', 'o_object'];
+  else if (format == '-')
+    format = ['number_a'];
+  else if (format == '^')
+    format = ['number', 'string', 'o_object'];
+  else if (format == 'r')
+    format = ['o_number'];
+  else if (format == 'l')
+    format = ['string', 'o_function'];
+    
 
-  /*
-    formats:
-      addSteps :: o_image_a, name_a, o_o
-        o_string_a, string_a, o_object => { image: [{name,o}] }
-      removeSteps :: o_image_a, index_a
-        o_string_a, number_a => { image: [index] }
-      insertSteps :: o_image_a, index, name, o_o
-        o_string_a, number, string, o_object => { image: [{index,name,o}] }
-      run :: o_image_a, o_from
-        o_string_a, o_number => { image: index }
-      loadImages :: image, src, o_function
-        string, string, o_function => { images: [{image:src}], callback }
-
-    optionals:
-      image: o_string_a
-      options: o_object
-      from: o_number
-      callback: o_function
-  */
-
-  if(format[format.length-1] == "o_object") {
-    if(objTypeOf(args[args.length-1]) != "Object")
+  if(format[format.length - 1] == 'o_object') {
+    if(objTypeOf(args[args.length - 1]) != 'Object')
       args.push({});
   }
-  else if (format[format.length-1] == "o_number") {
-    if(typeof(args[args.length-1]) != "number" && objTypeOf(args[0])!="Object")
+  else if (format[format.length - 1] == 'o_number') {
+    if(typeof(args[args.length - 1]) != 'number' && objTypeOf(args[0]) != 'Object')
       args.push(1);
   }
-  else if (format[format.length-1] == "o_function") {
-    if(objTypeOf(args[args.length-1]) != "Function" && objTypeOf(args[0])!="Object")
+  else if (format[format.length - 1] == 'o_function') {
+    if(objTypeOf(args[args.length - 1]) != 'Function' && objTypeOf(args[0]) != 'Object')
       args.push(function(){});
   }
 
-  if(format[0] == "o_string_a") {
-    if(args.length == format.length - 1) {
-      var insert = false;
-      for (var i in args) {
-        if (format[parseInt(i)+1].includes( typeof(getPrimitive(args[i])) )){
-          insert = true;
-        }
-        else {insert = false; break;}
-      }
-      if(insert)
-        args.splice(0,0,copy(images));
-    }
-  }
-  else if (format[0] == "o_string" && format_i == "l" && args.length == 2) {
-    if (typeof(args[0]) == "string") {
-      var identifier = "image";
-      var number = 1;
-      while (this.images.hasOwnProperty(identifier+number)) number++;
-      args.splice(0,0,identifier+number);
-    }
-  }
 
-  if(args.length == format.length) {
+  if(args.length == format.length) {//making of arrays
     for (var i in format) {
-      if (format[i].substr(format[i].length-2,2)=="_a")
+      if (format[i].substr(format[i].length - 2, 2) == '_a')
         args[i] = makeArray(args[i]);
     }
   }
 
-  if (args.length == 1) {
-    json_q = copy(args[0]);
-    if(!(format_i == "r" || format_i == "l")) {
-      for (var img in json_q)
-        json_q[img] = makeArray(json_q[img]);
+  if (args.length == 1 ) {
+    if(format_i == 'r') json_q = {0:copy(args[0])};
+    else if(format_i == '-') {
+      json_q = [];
+      json_q = copy(args[0]);
     }
   }
-  else if (format_i == "r") {
-    for (var img in args[0]) json_q[args[0][img]] = args[1];
+  else if (format_i == 'r' ) {
+    for (var img in args[0]) json_q = {0:args[0]};
   }
-  else if (format_i == "l") {
+  else if (format_i == 'l') {
     json_q = {
-      images: {},
-      callback: args[2]
-    }
-    json_q.images[args[0]] = args[1];
+      image: args[0],
+      callback: args[1]
+    };
   }
   else {
-    for (var img in args[0]) {
-      var image = args[0][img];
-      json_q[image] = [];
-
-      if(format_i == "+") {
-        for(var s in args[1]) {
-          json_q[image].push({
-            name: args[1][s],
-            o: args[2]
-          });
-        }
-      }
-
-      if(format_i == "-") {
-        json_q[image] = args[1];
-      }
-
-      if(format_i == "^") {
-        var size = this.images[image].steps.length;
-        var index = args[1];
-        index = (index==size)?index:index%size;
-        if (index<0) index += size+1;
-        json_q[image].push({
-          index: index,
-          name: args[2],
-          o: args[3]
+    json_q = [];
+    if(format_i == '+') {
+      for(var s in args[0]) {
+        json_q.push({
+          name: args[0][s],
+          o: args[1]
         });
       }
+    }
+
+
+    if(format_i == '^') {
+      var size = this.steps.length;
+      var index = args[0];
+      index = (index == size) ? index : index % size;
+      if (index < 0) index += size + 1;
+      json_q.push({
+        index: index,
+        name: args[1],
+        o: args[2]
+      });
 
     }
   }
 
-  if(format_i == "l") {
-    json_q.loadedimages = [];
-    for (var i in json_q.images) json_q.loadedimages.push(i);
-  }
-
   return json_q;
 
 }

src/ImageSequencer.js

@@ -1,28 +1,47 @@
-if (typeof window !== 'undefined') {window.$ = window.jQuery = require('jquery'); isBrowser = true}
-else {var isBrowser = false}
+if (typeof window !== 'undefined') { isBrowser = true; }
+else { var isBrowser = false; }
+require('./util/getStep.js');
 
+/**
+ * @method ImageSequencer
+ * @param {Object|Float32Array} options Optional options
+ * @returns {Object}
+ */
 ImageSequencer = function ImageSequencer(options) {
 
-  options = options || {};
-  options.inBrowser = options.inBrowser || isBrowser;
-  // if (options.inBrowser) options.ui = options.ui || require('./UserInterface');
-  options.sequencerCounter = 0;
+  var str = require('./Strings.js')(this.steps, modulesInfo, addSteps, copy);
 
-  function objTypeOf(object){
-    return Object.prototype.toString.call(object).split(" ")[1].slice(0,-1)
+  var sequencer = (this.name == 'ImageSequencer') ? this : this.sequencer;
+  options = options || {};
+  options.inBrowser = options.inBrowser === undefined ? isBrowser : options.inBrowser;
+  options.sequencerCounter = 0;
+  function objTypeOf(object) {
+    return Object.prototype.toString.call(object).split(' ')[1].slice(0, -1);
   }
 
-  function log(color,msg) {
-    if(options.ui!="none") {
-      if(arguments.length==1) console.log(arguments[0]);
-      else if(arguments.length==2) console.log(color,msg);
+  /**
+   * @method log
+   * @description Logs colored messages to the console using ASCII color codes
+   * @param {String} color ASCII color code
+   * @param {String} msg Message to be logged to the console
+   */
+  function log(color, msg) {
+    if (options.ui != 'none') {
+      if (arguments.length == 1) console.log(arguments[0]);
+      else if (arguments.length == 2) console.log(color, msg);
     }
   }
 
+  /**
+   * @method copy
+   * @description Returns a clone of the input object.
+   * @param {Object|Float32Array} a The Object/Array to be cloned
+   * @returns {Object|Float32Array}
+   */
   function copy(a) {
-    if (!typeof(a) == "object") return a;
-    if (objTypeOf(a) == "Array") return a.slice();
-    if (objTypeOf(a) == "Object") {
+    if (!typeof (a) == 'object') return a;
+    if (objTypeOf(a) == 'Array') return a.slice();
+    if (objTypeOf(a) == 'Object') {
       var b = {};
       for (var v in a) {
         b[v] = copy(a[v]);
@@ -33,174 +52,342 @@ ImageSequencer = function ImageSequencer(options) {
   }
 
   function makeArray(input) {
-    return (objTypeOf(input)=="Array")?input:[input];
+    return (objTypeOf(input) == 'Array') ? input : [input];
   }
 
   var image,
-      steps = [],
-      modules = require('./Modules'),
-      formatInput = require('./FormatInput'),
-      images = {},
-      inputlog = [],
-      events = require('./UserInterface')(),
-      fs = require('fs');
+    steps = [],
+    modules = require('./Modules'),
+    sequences = require('./SavedSequences.json'),
+    formatInput = require('./FormatInput'),
+    inputlog = [],
+    events = require('./ui/UserInterface')(),
+    fs = require('fs');
+
+
+
+  if (options.inBrowser) {
+    for (o in sequencer) {
+      modules[o] = sequencer[o];
+    }
+    sequences = JSON.parse(window.localStorage.getItem('sequences')); // Get saved sequences from localStorage
+    if (!sequences) {
+      sequences = {};
+      window.localStorage.setItem('sequences', JSON.stringify(sequences)); // Set the localStorage entry as an empty Object by default
+    }
+  }
 
   // if in browser, prompt for an image
   // if (options.imageSelect || options.inBrowser) addStep('image-select');
   // else if (options.imageUrl) loadImage(imageUrl);
 
-  function addSteps(){
-    var this_ = (this.name == "ImageSequencer")?this:this.sequencer;
-    var args = (this.name == "ImageSequencer")?[]:[this.images];
+  /**
+   * @method addSteps
+   * @description Adds one of more steps to the sequence.
+   * @return {Object}
+   */
+  function addSteps() {
+    var this_ = (this.name == 'ImageSequencer') ? this : this.sequencer;
+    var args = [];
     var json_q = {};
-    for(var arg in arguments){args.push(copy(arguments[arg]));}
-    json_q = formatInput.call(this_,args,"+");
-
-    inputlog.push({method:"addSteps", json_q:copy(json_q)});
-
-    for (var i in json_q)
-      for (var j in json_q[i])
-        require("./AddStep")(this_,i,json_q[i][j].name,json_q[i][j].o);
+    for (var arg in arguments) { args.push(copy(arguments[arg])); } // Get all the module names from the arguments
+    json_q = formatInput.call(this_, args, '+');
 
+    inputlog.push({ method: 'addSteps', json_q: copy(json_q) });
+    for (var j in json_q)
+      require('./AddStep')(this_, json_q[j].name, json_q[j].o);
     return this;
   }
 
-  function removeStep(image,index) {
-    //remove the step from images[image].steps and redraw remaining images
-    if(index>0) {
-      thisStep = images[image].steps[index];
+  /**
+   * @method removeStep
+   * @description Removes the step at the specified index from the sequence.
+   * @param {Object} ref ImageSequencer instance
+   * @param {Number} index Index of the step to be removed
+   * @returns {Null}
+   */
+  function removeStep(ref, index) {
+    // Remove the step from images[image].steps and redraw remaining images
+    if (index > 0) {
+      // var this_ = (this.name == "ImageSequencer") ? this : this.sequencer;
+      thisStep = ref.steps[index];
       thisStep.UI.onRemove(thisStep.options.step);
-      images[image].steps.splice(index,1);
+      ref.steps.splice(index, 1);
     }
-    //tell the UI a step has been removed
   }
 
-  function removeSteps(image,index) {
-    var run = {}, indices;
-    var this_ = (this.name == "ImageSequencer")?this:this.sequencer;
-    var args = (this.name == "ImageSequencer")?[]:[this.images];
-    for(var arg in arguments) args.push(copy(arguments[arg]));
-
-    var json_q = formatInput.call(this_,args,"-");
-    inputlog.push({method:"removeSteps", json_q:copy(json_q)});
-
-    for (var img in json_q) {
-      indices = json_q[img].sort(function(a,b){return b-a});
-      run[img] = indices[indices.length-1];
-      for (var i in indices)
-        removeStep(img,indices[i]);
-    }
-    // this.run(run); // This is creating problems
-    return this;
-  }
-
-  function insertSteps(image, index, name, o) {
-    var run = {};
-    var this_ = (this.name == "ImageSequencer")?this:this.sequencer;
-    var args = (this.name == "ImageSequencer")?[]:[this.images];
-    for (var arg in arguments) args.push(arguments[arg]);
-
-    var json_q = formatInput.call(this_,args,"^");
-    inputlog.push({method:"insertSteps", json_q:copy(json_q)});
-
-    for (var img in json_q) {
-      var details = json_q[img];
-      details = details.sort(function(a,b){return b.index-a.index});
-      for (var i in details)
-        require("./InsertStep")(this_,img,details[i].index,details[i].name,details[i].o);
-      run[img] = details[details.length-1].index;
-    }
-    // this.run(run); // This is Creating issues
-    return this;
-  }
-
-  function run(t_image,t_from) {
-    var this_ = (this.name == "ImageSequencer")?this:this.sequencer;
-    var args = (this.name == "ImageSequencer")?[]:[this.images];
+  /**
+   * @method removeSteps
+   * @description Removes one or more steps from the sequence
+   * @returns {Object}
+   */
+  function removeSteps() {
+    var   indices;
+    var this_ = (this.name == 'ImageSequencer') ? this : this.sequencer;
+    var args = [];
     for (var arg in arguments) args.push(copy(arguments[arg]));
 
-    var callback = function() {};
+    var json_q = formatInput.call(this_, args, '-');
+    inputlog.push({ method: 'removeSteps', json_q: copy(json_q) });
+
+    indices = json_q.sort(function(a, b) { return b - a; });
+    for (var i in indices)
+      removeStep(this_, indices[i]);
+    return this;
+  }
+
+  /**
+   * @method insertSteps
+   * @description Inserts steps at the specified index
+   * @returns {Object}
+   */
+  function insertSteps() {
+    var this_ = (this.name == 'ImageSequencer') ? this : this.sequencer;
+    var args = [];
+    for (var arg in arguments) args.push(arguments[arg]);
+
+    var json_q = formatInput.call(this_, args, '^');
+    inputlog.push({ method: 'insertSteps', json_q: copy(json_q) });
+
+    var details = json_q;
+    details = details.sort(function(a, b) { return b.index - a.index; });
+    for (var i in details)
+      require('./InsertStep')(this_, details[i].index, details[i].name, details[i].o);
+    return this;
+  }
+
+  /**
+   * @method run
+   * @param {Object} config Object which contains the runtime configuration like progress bar information and index from which the sequencer should run.
+   * @returns {Boolean}
+   */
+  function run(config) {
+    var progressObj, index = 0;
+    config = config || { mode: 'no-arg' };
+    if (config.index) index = config.index;
+
+    if (config.mode != 'no-arg' && typeof config != 'function') {
+      if (config.progressObj) progressObj = config.progressObj;
+      delete arguments['0'];
+    }
+
+    var this_ = (this.name == 'ImageSequencer') ? this : this.sequencer;
+    var args = [];
+    for (var arg in arguments) args.push(copy(arguments[arg]));
+
+    var callback = function() { };
     for (var arg in args)
-      if(objTypeOf(args[arg]) == "Function")
-        callback = args.splice(arg,1)[0];
+      if (objTypeOf(args[arg]) == 'Function')
+        callback = args.splice(arg, 1)[0]; // Callback is formed
 
-    var json_q = formatInput.call(this_,args,"r");
+    var json_q = formatInput.call(this_, args, 'r');
 
-    require('./Run')(this_, json_q, callback);
+    require('./Run')(this_, json_q, callback, index, progressObj);
 
     return true;
   }
 
+  /**
+   * @method loadImages
+   * @description Loads an image via dataURL or normal URL. Read the docs(https://github.com/publiclab/image-sequencer/blob/main/README.md) for more info.
+   * @returns {Null}
+   */
   function loadImages() {
     var args = [];
+    var prevSteps = this.getSteps().slice(1).map(step=>step.options.name);
     var sequencer = this;
+    sequencer.image = arguments[0];
     for (var arg in arguments) args.push(copy(arguments[arg]));
-    var json_q = formatInput.call(this,args,"l");
-
-    inputlog.push({method:"loadImages", json_q:copy(json_q)});
-    var loadedimages = this.copy(json_q.loadedimages);
-// require('./LoadImage')(this,i,json_q.images[i]);
-
+    var json_q = formatInput.call(this, args, 'l');
+    if(this.getSteps().length != 0){
+      this.options.sequencerCounter = 0;
+      inputlog = [];
+      this.steps = [];
+    }
+    inputlog.push({ method: 'loadImages', json_q: copy(json_q) });
     var ret = {
-      name: "ImageSequencer Wrapper",
+      name: 'ImageSequencer Wrapper',
       sequencer: this,
       addSteps: this.addSteps,
       removeSteps: this.removeSteps,
       insertSteps: this.insertSteps,
       run: this.run,
       UI: this.UI,
-      setUI: this.setUI,
-      images: loadedimages
+      setUI: this.setUI
     };
-
-    function load(i) {
-      if(i==loadedimages.length) {
-        json_q.callback.call(ret);
-        return;
+    function loadPrevSteps(ref){
+      if(prevSteps.length != 0){
+        ref.addSteps(prevSteps);
+        prevSteps = [];
       }
-      var img = loadedimages[i];
-      require('./LoadImage')(sequencer,img,json_q.images[img],function(){
-        load(++i);
-      });
     }
+    require('./ui/LoadImage')(sequencer, 'image', json_q.image, function() {
+      loadPrevSteps(sequencer);
+      json_q.callback.call(ret);
+    });
 
-    load(0);
   }
 
-  function replaceImage(selector,steps,options) {
+  /**
+   * @method replaceImage
+   * @description Replaces the current image in the sequencer
+   * @param {String} selector DOM selector string for the image input
+   * @param {*} steps Current steps Object
+   * @param {Object} options
+   * @returns {*}
+   */
+  function replaceImage(selector, steps, options) {
     options = options || {};
-    return require('./ReplaceImage')(this,selector,steps);
+    options.callback = options.callback || function() { };
+    return require('./ReplaceImage')(this, selector, steps, options);
   }
 
+  /**
+   * @method getSteps
+   * @description Returns the current sequence of steps
+   * @returns {Object}
+   */
+  function getSteps(){
+    return this.steps;
+  }
+
+  /**
+   * @method setUI
+   * @description To set up a UI for ImageSequencer via different callback methods. Read the docs(https://github.com/publiclab/image-sequencer/blob/main/README.md) for more info.
+   * @param {Object} UI Object containing UI callback methods. Read the docs(https://github.com/publiclab/image-sequencer/blob/main/README.md) for more info.
+   * @returns {Null}
+   */
   function setUI(UI) {
-    this.events = require('./UserInterface')(UI);
+    this.events = require('./ui/UserInterface')(UI);
   }
 
-  var exportBin = function(dir) {
-    return require('./ExportBin')(dir,this);
-  }
+  var exportBin = function(dir, basic, filename) {
+    return require('./ExportBin')(dir, this, basic, filename);
+  };
 
+  /**
+   * @method modulesInfo
+   * @description Returns information about the given module or all the available modules
+   * @param {String} name Module name
+   * @returns {Object}
+   */
   function modulesInfo(name) {
-    var modulesdata = {}
-    if(name == "load-image") return {};
-    if(arguments.length==0)
-      for (var modulename in modules) {
+    var modulesdata = {};
+    if (name == 'load-image') return {};
+    if (arguments.length == 0) {
+      for (var modulename in this.modules) {
         modulesdata[modulename] = modules[modulename][1];
       }
-    else modulesdata = modules[name][1];
+      for (var sequencename in this.sequences) {
+        modulesdata[sequencename] = { name: sequencename, steps: this.sequences[sequencename] };
+      }
+    }
+    else {
+      if (modules[name]){
+        modulesdata = modules[name][1];
+      }
+      else
+        modulesdata = { 'inputs': sequences[name]['options'] };
+    }
     return modulesdata;
   }
 
+  /**
+   * @method loadNewModule
+   * @description Adds a new local module to sequencer. Read the docs(https://github.com/publiclab/image-sequencer/blob/main/README.md) for mode info.
+   * @param {String} name Name of the new module
+   * @param {Object} options An Object containing path and info about the new module.
+   * @returns {Object}
+   */
+  function loadNewModule(name, options) {
+
+    if (!options) {
+      return this;
+
+    } else if (Array.isArray(options)) {
+      // Contains the array of module and info
+      this.modules[name] = options;
+
+    } else if (options.func && options.info) {
+      // Passed in options object
+      this.modules[name] = [
+        options.func, options.info
+      ];
+
+    } else if (options.path && !this.inBrowser) {
+      // Load from path(only in node)
+      const module = [
+        require(`${options.path}/Module.js`),
+        require(`${options.path}/info.json`)
+      ];
+      this.modules[name] = module;
+    }
+    return this;
+  }
+
+  /**
+   * @method saveNewModule
+   * @description Saves a new local module to ImageSequencer
+   * @param {String} name Name of the new module
+   * @param {String} path Path to the new module
+   * @returns {Null}
+   */
+  function saveNewModule(name, path) {
+    if (options.inBrowser) {
+      // Not for browser context
+      return;
+    }
+    var mods = fs.readFileSync('./src/Modules.js').toString();
+    mods = mods.substr(0, mods.length - 1) + '  \'' + name + '\': require(\'' + path + '\'),\n}';
+    fs.writeFileSync('./src/Modules.js', mods);
+  }
+
+  /**
+   * @method saveSequence
+   * @description Saves a sequence on the browser localStorage.
+   * @param {String} name Name for the sequence
+   * @param {String} sequenceString Sequence data as a string
+   * @returns {Null}
+   */
+  function saveSequence(name, sequenceString) { // 4. save sequence
+    const sequence = str.stringToJSON(sequenceString);
+    // Save the given sequence string as a module
+    if (options.inBrowser) {
+      // Inside the browser we save the meta-modules using the Web Storage API
+      var sequences = JSON.parse(window.localStorage.getItem('sequences'));
+      sequences[name] = sequence;
+      window.localStorage.setItem('sequences', JSON.stringify(sequences));
+    }
+    else {
+      // In node we save the sequences in the json file SavedSequences.json
+      var sequences = require('./SavedSequences.json');
+      sequences[name] = sequence;
+      fs.writeFileSync('./src/SavedSequences.json', JSON.stringify(sequences));
+    }
+  }
+
+  function loadModules() {
+    // loadModules function loads the modules and saved sequences.
+    this.modules = require('./Modules');
+    if (options.inBrowser)
+      this.sequences = JSON.parse(window.localStorage.getItem('sequences'));
+    else
+      this.sequences = require('./SavedSequences.json');
+  }
+
+
   return {
-    //literals and objects
-    name: "ImageSequencer",
+    // Literals and objects
+    name: 'ImageSequencer',
     options: options,
     inputlog: inputlog,
     modules: modules,
-    images: images,
+    sequences: sequences,
     events: events,
+    steps: steps,
+    image: image,
 
-    //user functions
+    // User functions
     loadImages: loadImages,
     loadImage: loadImages,
     addSteps: addSteps,
@@ -211,12 +398,32 @@ ImageSequencer = function ImageSequencer(options) {
     setUI: setUI,
     exportBin: exportBin,
     modulesInfo: modulesInfo,
+    toCliString: str.toCliString,
+    detectStringSyntax: str.detectStringSyntax,
+    parseStringSyntax: str.parseStringSyntax,
+    stringToSteps: str.stringToSteps,
+    toString: str.toString,
+    stepToString: str.stepToString,
+    toJSON: str.toJSON,
+    stringToJSON: str.stringToJSON,
+    stringToJSONstep: str.stringToJSONstep,
+    importString: str.importString,
+    importJSON: str.importJSON,
+    loadNewModule: loadNewModule,
+    saveNewModule: saveNewModule,
+    createMetaModule: require('./util/createMetaModule'),
+    saveSequence: saveSequence,
+    loadModules: loadModules,
+    getSteps:getSteps,
 
-    //other functions
+    // Other functions
     log: log,
     objTypeOf: objTypeOf,
-    copy: copy
-  }
+    copy: copy,
+    getImageDimensions: require('./util/getImageDimensions'),
 
-}
+    setInputStep: require('./ui/SetInputStep')(sequencer)
+  };
+
+};
 module.exports = ImageSequencer;

src/InsertStep.js

@@ -1,32 +1,67 @@
-function InsertStep(ref, image, index, name, o) {
+const getStepUtils = require('./util/getStep.js');
+
+// insert one or more steps at a given index in the sequencer
+function InsertStep(ref, index, name, o) {
+  if (ref.sequences[name]) {
+    return ref.importJSON(ref.sequences[name]);
+  }
+
+  if (ref.detectStringSyntax(name)) {
+    return ref.stringToSteps(name);
+  }
+
+  function insertStep(index, name, o_) {
+    if (ref.modules[name]) var moduleInfo = ref.modules[name][1];
+    else {
+      console.log('Module ' + name + ' not found.');
+    }
 
-  function insertStep(image, index, name, o_) {
     var o = ref.copy(o_);
+
     o.number = ref.options.sequencerCounter++; //Gives a Unique ID to each step
-    o.name = o_.name || name;
+    o.name = o_.name || name || moduleInfo.name;
+    o.description = o_.description || moduleInfo.description;
+    o.moduleInfo = o_.moduleInfo || moduleInfo;
     o.selector = o_.selector || 'ismod-' + name;
     o.container = o_.container || ref.options.selector;
-    o.image = image;
-
-    if(index==-1) index = ref.images[image].steps.length;
+    o.inBrowser = ref.options.inBrowser;
+    o.useWasm = (ref.options.useWasm === false) ? false : true;
+    if (index == -1) index = ref.steps.length;
 
     o.step = {
       name: o.name,
       description: o.description,
-      url: o.url,
+      moduleInfo: o.moduleInfo,
       ID: o.number,
-      imageName: o.image,
       inBrowser: ref.options.inBrowser,
       ui: ref.options.ui,
       options: o
     };
     var UI = ref.events;
-    var module = ref.modules[name][0](o,UI);
-    ref.images[image].steps.splice(index,0,module);
+
+    // define the expandSteps function for sequencer
+    ref.modules[name].expandSteps = function expandSteps(stepsArray) {
+      for (var i in stepsArray) {
+        let step = stepsArray[i];
+        ref.insertSteps(index + Number.parseInt(i), step['name'], step['options']);
+      }
+    };
+
+    // Tell UI that a step has been set up.
+    o = o || {};
+
+    if (!ref.modules[name][1].length) {
+      UI.onSetup(o.step, { index: index });
+      ref.steps.splice(index, 0, ref.modules[name][0](o, UI));
+    } else {
+      ref.modules[name][0](o, UI);
+    }
 
     return true;
   }
 
-  insertStep(image, index, name, o);
+  insertStep(index, name, o);
+  ref.steps = ref.steps;
+
 }
 module.exports = InsertStep;

src/LoadImage.js

@@ -1,105 +0,0 @@
-// special module to load an image into the start of the sequence; used in the HTML UI
-function LoadImage(ref, name, src, main_callback) {
-  function makeImage(datauri) {
-    var image = {
-      src: datauri,
-      format: datauri.split(':')[1].split(';')[0].split('/')[1]
-    }
-    return image;
-  }
-  function CImage(src, callback) {
-    var datauri;
-    if (!!src.match(/^data:/i)) {
-      datauri = src;
-      callback(datauri);
-    }
-    else if (!ref.options.inBrowser && !!src.match(/^https?:\/\//i)) {
-      require( src.match(/^(https?):\/\//i)[1] ).get(src,function(res){
-        var data = '';
-        var contentType = res.headers['content-type'];
-        res.setEncoding('base64');
-        res.on('data',function(chunk) {data += chunk;});
-        res.on('end',function() {
-          callback("data:"+contentType+";base64,"+data);
-        });
-      });
-    }
-    else if (ref.options.inBrowser) {
-      var ext = src.split('.').pop();
-      var image = document.createElement('img');
-      var canvas = document.createElement('canvas');
-      var context = canvas.getContext('2d');
-      image.onload = function() {
-        canvas.width = image.naturalWidth;
-        canvas.height = image.naturalHeight;
-        context.drawImage(image,0,0);
-        datauri = canvas.toDataURL(ext);
-        callback(datauri);
-      }
-      image.src = src;
-    }
-    else {
-      datauri = require('urify')(src);
-      callback(datauri);
-    }
-  }
-
-  function loadImage(name, src) {
-    var step = {
-      name: "load-image",
-      description: "This initial step loads and displays the original image without any modifications.",
-      ID: ref.options.sequencerCounter++,
-      imageName: name,
-      inBrowser: ref.options.inBrowser,
-      ui: ref.options.ui
-    };
-
-    var image = {
-      src: src,
-      steps: [{
-        options: {
-          id: step.ID,
-          name: "load-image",
-          description: "This initial step loads and displays the original image without any modifications.",
-          title: "Load Image",
-          step: step
-        },
-        UI: ref.events,
-        draw: function() {
-          UI.onDraw(options.step);
-          if(arguments.length==1){
-            this.output = CImage(arguments[0]);
-            options.step.output = this.output;
-            UI.onComplete(options.step);
-            return true;
-          }
-          else if(arguments.length==2) {
-            this.output = CImage(arguments[0]);
-            options.step.output = this.output;
-            arguments[1]();
-            UI.onComplete(options.step);
-            return true;
-          }
-          return false;
-        },
-      }]
-    };
-    CImage(src, function(datauri) {
-      var output = makeImage(datauri);
-      ref.images[name] = image;
-      var loadImageStep = ref.images[name].steps[0];
-      loadImageStep.output = output;
-      loadImageStep.options.step.output = loadImageStep.output.src;
-      loadImageStep.UI.onSetup(loadImageStep.options.step);
-      loadImageStep.UI.onDraw(loadImageStep.options.step);
-      loadImageStep.UI.onComplete(loadImageStep.options.step);
-
-      main_callback();
-      return true;
-    });
-  }
-
-  return loadImage(name,src);
-}
-
-module.exports = LoadImage;

src/Modules.js

@@ -1,29 +1,55 @@
 /*
- * Core modules and their info files
- */
+* Core modules and their info files
+*/
 module.exports = {
-  'green-channel': [
-    require('./modules/GreenChannel/Module'),require('./modules/GreenChannel/info')
-  ],
-  'ndvi-red': [
-    require('./modules/NdviRed/Module'),require('./modules/NdviRed/info')
-  ],
-  'invert': [
-    require('./modules/Invert/Module'),require('./modules/Invert/info')
-  ],
-  'crop': [
-    require('./modules/Crop/Module'),require('./modules/Crop/info')
-  ],
-  'segmented-colormap': [
-    require('./modules/SegmentedColormap/Module'),require('./modules/SegmentedColormap/info')
-  ],
-  'decode-qr': [
-    require('./modules/DecodeQr/Module'),require('./modules/DecodeQr/info')
-  ],
-  'fisheye-gl': [
-    require('./modules/FisheyeGl/Module'),require('./modules/FisheyeGl/info')
-  ],
-  'dynamic': [
-    require('./modules/Dynamic/Module'),require('./modules/Dynamic/info')
-  ]
-}
+  'add-qr': require('./modules/AddQR'),
+  'average': require('./modules/Average'),
+  'blend': require('./modules/Blend'),
+  'blob-analysis': require('./modules/BlobAnalysis'),
+  'blur': require('./modules/Blur'),
+  'brightness': require('./modules/Brightness'),
+  'canvas-resize': require('./modules/CanvasResize'),
+  'channel': require('./modules/Channel'),
+  'colorbar': require('./modules/Colorbar'),
+  'color-halftone': require('./modules/ColorHalftone'),
+  'color-temperature': require('./modules/ColorTemperature'),
+  'colormap': require('./modules/Colormap'),
+  'constrained-crop': require('./modules/ConstrainedCrop'),
+  'contrast': require('./modules/Contrast'),
+  'convolution': require('./modules/Convolution'),
+  'crop': require('./modules/Crop'),
+  'decode-qr': require('./modules/DecodeQr'),
+  'dither': require('./modules/Dither'),
+  'draw-rectangle': require('./modules/DrawRectangle'),
+  'dynamic': require('./modules/Dynamic'),
+  'edge-detect': require('./modules/EdgeDetect'),
+  'exposure': require('./modules/Exposure'),
+  'flip-image': require('./modules/FlipImage'),
+  'fisheye-gl': require('./modules/FisheyeGl'),
+  'histogram': require('./modules/Histogram'),
+  'gamma-correction': require('./modules/GammaCorrection'),
+  'gradient': require('./modules/Gradient'),
+  'grid-overlay': require('./modules/GridOverlay'),
+  'import-image': require('./modules/ImportImage'),
+  'mask': require('./modules/Mask'),
+  'minify-image': require('./modules/MinifyImage'),
+  // 'invert': require('image-sequencer-invert'), this code imports the invert module from a different repository altogether (using a require statement)
+  // Which is a powerful feature of ImageSequencer, the modules are independent of the rest of the library's source.
+  'invert': require('./modules/Invert'),
+  'ndvi': require('./modules/Ndvi'),
+  'ndvi-colormap': require('./modules/NdviColormap'),
+  'noise-reduction': require('./modules/NoiseReduction'),
+  'overlay': require('./modules/Overlay'),
+  'paint-bucket': require('./modules/PaintBucket'),
+  'replace-color': require('./modules/ReplaceColor'),
+  'resize': require('./modules/Resize'),
+  'rotate': require('./modules/Rotate'),
+  'saturation': require('./modules/Saturation'),
+  'shadow': require('./modules/Shadow'),
+  'sharpen': require('./modules/Sharpen'),
+  'text-overlay': require('./modules/TextOverlay'),
+  'threshold': require('./modules/Threshold'),
+  'tint': require('./modules/Tint'),
+  'webgl-distort': require('./modules/WebglDistort'),
+  'white-balance': require('./modules/WhiteBalance')
+};

src/ReplaceImage.js

@@ -1,35 +1,63 @@
-function ReplaceImage(ref,selector,steps,options) {
+// Uses a given image as input and replaces it with the output.
+// Works only in the browser.
+function ReplaceImage(ref, selector, steps, options) {
   if(!ref.options.inBrowser) return false; // This isn't for Node.js
+  var tempSequencer = ImageSequencer({ui: false});
   var this_ = ref;
-  var input = document.querySelectorAll(selector);
+  if (window.hasOwnProperty('$')) var input = $(selector);
+  else var input = document.querySelectorAll(selector);
   var images = [];
-  for (var i = 0; i < input.length; i++)
+  for (var i = 0; i < input.length; i++) {
     if (input[i] instanceof HTMLImageElement) images.push(input[i]);
-  for (var i in images) {
-    var the_image = images[i];
-    var url = images[i].src;
-    var ext = url.split('.').pop();
+  }
+
+  function replaceImage (img, steps) {
+    var url = img.src;
+    // refactor to filetypeFromUrl()
+    var ext = url.split('?')[0].split('.').pop();
 
     var xmlHTTP = new XMLHttpRequest();
     xmlHTTP.open('GET', url, true);
     xmlHTTP.responseType = 'arraybuffer';
     xmlHTTP.onload = function(e) {
       var arr = new Uint8Array(this.response);
-      var raw = String.fromCharCode.apply(null,arr);
+
+      // in chunks to avoid "RangeError: Maximum call stack exceeded"
+      // https://github.com/publiclab/image-sequencer/issues/241
+      // https://stackoverflow.com/a/20048852/1116657
+      var raw = '';
+      var i, j, subArray, chunk = 5000;
+      for (i = 0, j = arr.length; i < j; i += chunk) {
+        subArray = arr.subarray(i, i + chunk);
+        raw += String.fromCharCode.apply(null, subArray);
+      }
+
       var base64 = btoa(raw);
-      var dataURL="data:image/"+ext+";base64," + base64;
+      var dataURL = 'data:image/' + ext + ';base64,' + base64;
       make(dataURL);
     };
 
-    if(url.substr(0,11).toLowerCase()!="data:image/") xmlHTTP.send();
+    if(url.substr(0, 11).toLowerCase() != 'data:image/') xmlHTTP.send();
     else make(url);
 
     function make(url) {
-      this_.loadImage('default',url).addSteps('default',steps).run(function(out){
-        the_image.src = out;
+      tempSequencer.loadImage(url, function(){
+        // this.addSteps(steps).run({stop:function(){}},function(out){
+        var sequence = this.addSteps(steps);
+        if (ref.detectStringSyntax(steps))
+          sequence = this.stringToSteps(steps);
+        sequence.run({stop:function(){}}, function(out){
+          img.src = out;
+        });
       });
     }
   }
+
+  for (var i = 0; i < images.length; i++) {
+    replaceImage(images[i], steps);
+    if (i == images.length - 1)
+      options.callback();
+  }
 }
 
 module.exports = ReplaceImage;

src/Run.js

@@ -1,55 +1,91 @@
-function Run(ref, json_q, callback) {
+const getStepUtils = require('./util/getStep.js');
+
+function Run(ref, json_q, callback, ind, progressObj) {
+  if (!progressObj) progressObj = { stop: function() { } };
 
   function drawStep(drawarray, pos) {
     if (pos == drawarray.length && drawarray[pos - 1] !== undefined) {
-      var image = drawarray[pos-1].image;
-      if(ref.objTypeOf(callback) == 'Function') {
-        var steps = ref.images[image].steps;
-        var out = steps[steps.length-1].output.src;
+      if (ref.objTypeOf(callback) == 'Function' && ref.steps.slice(-1)[0].output) {
+        var steps = ref.steps;
+        var out = steps[steps.length - 1].output.src;
         callback(out);
         return true;
       }
     }
+
     // so we don't run on the loadImage module:
     if (drawarray[pos] !== undefined) {
-      var image = drawarray[pos].image;
       var i = drawarray[pos].i;
-      var input = ref.images[image].steps[i - 1].output;
-      ref.images[image].steps[i].draw(ref.copy(input), function onEachStep() {
-        drawStep(drawarray, ++pos);
-      });
+      var input = ref.steps[i - 1].output;
+      var step = ref.steps[i];
+
+      step.getStep = function getStep(offset) {
+        if (i + offset >= ref.steps.length) return { options: { name: undefined } };
+        else return ref.steps.slice(i + offset)[0];
+      };
+      step.getIndex = function getIndex() {
+        return i;
+      };
+
+      for (var util in getStepUtils) {
+        if (getStepUtils.hasOwnProperty(util)) {
+          step[util] = getStepUtils[util];
+        }
+      }
+
+      // Tell UI that a step is being drawn.
+      step.UI.onDraw(step.options.step);
+
+      // provides a set of standard tools for each step
+      var inputForNextStep = require('./RunToolkit')(ref.copy(input));
+
+      step.draw(
+        inputForNextStep,
+        function onEachStep() {
+
+          // This output is accessible by UI
+          ref.steps[i].options.step.output = ref.steps[i].output.src;
+          ref.steps[i].options.step.wasmSuccess = ref.steps[i].output.wasmSuccess || false;
+          ref.steps[i].options.step.useWasm = ref.steps[i].output.useWasm || false;
+
+          // Tell UI that step has been drawn.
+          ref.steps[i].UI.onComplete(ref.steps[i].options.step);
+
+          drawStep(drawarray, ++pos);
+        },
+        progressObj
+      );
     }
   }
 
   function drawSteps(json_q) {
-    var drawarray = [];
-    for (var image in json_q) {
-      var no_steps = ref.images[image].steps.length;
-      var init = json_q[image];
-      for(var i = 0; i < no_steps - init; i++) {
-        drawarray.push({ image: image, i: init + i });
-      }
+    var drawarray = [],
+      no_steps = ref.steps.length,
+      init = json_q[0];
+    for (var i = 0; i < no_steps - init; i++) {
+      drawarray.push({i: init + i });
     }
-    drawStep(drawarray,0);
+    drawStep(drawarray, ind);
   }
 
-  function filter(json_q){
-    for (var image in json_q) {
-      if (json_q[image] == 0 && ref.images[image].steps.length == 1)
-        delete json_q[image];
-      else if (json_q[image] == 0) json_q[image]++;
-    }
-    for (var image in json_q) {
-      var prevstep = ref.images[image].steps[json_q[image] - 1];
-      while (typeof(prevstep) == "undefined" || typeof(prevstep.output) == "undefined") {
-        prevstep = ref.images[image].steps[(--json_q[image]) - 1];
-      }
+  function filter(json_q) {
+ 
+    if (json_q[0] == 0 && ref.steps.length == 1)
+      delete json_q[0];
+    else if (json_q[0] == 0) json_q[0]++;
+    var prevstep = ref.steps[json_q[0] - 1];
+    while (
+      typeof prevstep == 'undefined' ||
+        typeof prevstep.output == 'undefined'
+    ) {
+      prevstep = ref.steps[--json_q[0] - 1];
     }
+    
     return json_q;
   }
-
+  
   var json_q = filter(json_q);
+  
   return drawSteps(json_q);
-
 }
 module.exports = Run;

src/RunToolkit.js

@@ -0,0 +1,14 @@
+const getPixels = require('get-pixels');
+const pixelManipulation = require('./modules/_nomodule/PixelManipulation');
+const lodash = require('lodash');
+const dataUriToBuffer = require('data-uri-to-buffer');
+const savePixels = require('save-pixels');
+
+module.exports = function(input) {
+  input.getPixels = getPixels;
+  input.pixelManipulation = pixelManipulation;
+  input.lodash = lodash;
+  input.dataUriToBuffer = dataUriToBuffer;
+  input.savePixels = savePixels;
+  return input;
+};

src/SavedSequences.json

@@ -0,0 +1 @@
+{"sample":[{"name":"invert","options":{}},{"name":"channel","options":{"channel":"red"}},{"name":"blur","options":{"blur":"5"}}]}

src/Strings.js

@@ -0,0 +1,159 @@
+module.exports = function(steps, modulesInfo, addSteps, copy) {
+  // Genates a CLI string for the current sequence
+  function toCliString() {
+    var cliStringSteps = '"', cliOptions = {};
+    for (var step in this.steps) {
+      var name = (typeof this.steps[step].options !== 'undefined') ? this.steps[step].options.name : this.steps[step].name;
+      if (name !== 'load-image'){
+        cliStringSteps += `${name} `;
+      }
+      for (var inp in modulesInfo(name).inputs) {
+        cliOptions[inp] = this.steps[step].options[inp];
+      }
+    }
+    cliStringSteps = cliStringSteps.substr(0, cliStringSteps.length - 1) + '"';
+    return `sequencer -i [PATH] -s ${cliStringSteps} -d '${JSON.stringify(cliOptions)}'`;
+  }
+
+  // Checks if input is a string of comma separated module names
+  function detectStringSyntax(str) {
+    let result = (str.includes(',') || str.includes('{')) ? true : false;
+    return result;
+  }
+
+  // Parses input string and returns array of module names
+  function parseStringSyntax(str) {
+    let stringifiedNames = str.replace(/\s/g, '');
+    let moduleNames = stringifiedNames.split(',');
+    return moduleNames;
+  }
+
+  // imports string of comma separated module names to sequencer steps
+  function stringToSteps(str) {
+    let sequencer = this;
+    let names = [];
+    if (this.name != 'ImageSequencer')
+      sequencer = this.sequencer;
+    if (detectStringSyntax(str))
+      names = stringToJSON(str);
+    names.forEach(function eachStep(stepObj) {
+      sequencer.addSteps(stepObj.name, stepObj.options);
+    });
+  }
+
+  // Strigifies the current sequence
+  function toString(step) {
+    if (step) {
+      return stepToString(step);
+    } else {
+      return copy(this.steps.map(stepToString).slice(1).join(','));
+    }
+  }
+
+  // Stringifies one step of the sequence
+  function stepToString(step) {
+    var arg = (step.name) ? step.name : step.options.name;
+    let inputs = modulesInfo(arg).inputs || {}, op = {};
+
+    for (let input in inputs) {
+
+      if (!!step.options[input] && step.options[input] != inputs[input].default) {
+        op[input] = step.options[input];
+        op[input] = encodeURIComponent(op[input]);
+      }
+
+    }
+
+    var configurations = Object.keys(op).map(key => key + ':' + op[key]).join('|');
+    return `${arg}{${configurations}}`;
+  }
+
+  // exports the current sequence as an array of JSON steps
+  function toJSON() {
+    return this.stringToJSON(this.toString());
+  }
+
+  // Coverts stringified sequence into an array of JSON steps
+  function stringToJSON(str) {
+    let steps;
+    if (detectStringSyntax(str))
+      steps = parseStringSyntax(str);
+    else
+      steps = [str];
+    return steps.map(stringToJSONstep);
+  }
+
+  // Converts one stringified step into JSON
+  function stringToJSONstep(str) {
+    var bracesStrings;
+    if (str.includes('{'))
+      if (str.includes('(') && str.indexOf('(') < str.indexOf('{'))
+        bracesStrings = ['(', ')'];
+      else
+        bracesStrings = ['{', '}'];
+    else
+      bracesStrings = ['(', ')'];
+
+    if (str.indexOf(bracesStrings[0]) === -1) { // if there are no settings specified
+      var moduleName = str.substr(0);
+      stepSettings = '';
+    } else {
+      var moduleName = str.substr(0, str.indexOf(bracesStrings[0]));
+      stepSettings = str.slice(str.indexOf(bracesStrings[0]) + 1, -1);
+    }
+
+    stepSettings = stepSettings.split('|').reduce(function formatSettings(accumulator, current, i) {
+      var settingName = current.substr(0, current.indexOf(':')),
+        settingValue = current.substr(current.indexOf(':') + 1);
+      settingValue = settingValue.replace(/^\(/, ''); // strip () at start/end
+      settingValue = settingValue.replace(/^\{/, '').replace(/\}$/, ''); // strip {} at start/end
+      settingValue = decodeURIComponent(settingValue);
+      current = [
+        settingName,
+        settingValue
+      ];
+      if (settingName) accumulator[settingName] = settingValue;
+      return accumulator;
+    }, {});
+
+    return {
+      name: moduleName,
+      options: stepSettings
+    };
+  }
+
+  // imports a string into the sequencer steps
+  function importString(str) {
+    let sequencer = this;
+    if (this.name != 'ImageSequencer')
+      sequencer = this.sequencer;
+    var stepsFromString = stringToJSON(str);
+    stepsFromString.forEach(function eachStep(stepObj) {
+      sequencer.addSteps(stepObj.name, stepObj.options);
+    });
+  }
+
+  // imports a array of JSON steps into the sequencer steps
+  function importJSON(obj) {
+    let sequencer = this;
+    if (this.name != 'ImageSequencer')
+      sequencer = this.sequencer;
+    obj.forEach(function eachStep(stepObj) {
+      sequencer.addSteps(stepObj.name, stepObj.options);
+    });
+  }
+
+  return {
+    toCliString: toCliString,
+    detectStringSyntax: detectStringSyntax,
+    parseStringSyntax: parseStringSyntax,
+    stringToSteps: stringToSteps,
+    toString: toString,
+    stepToString: stepToString,
+    toJSON: toJSON,
+    stringToJSON: stringToJSON,
+    stringToJSONstep: stringToJSONstep,
+    importString: importString,
+    importJSON: importJSON
+  };
+};

src/UserInterface.js

@@ -1,66 +0,0 @@
-/*
- * User Interface Handling Module
- */
-
-module.exports = function UserInterface(events = {}) {
-
-  events.onSetup = events.onSetup || function(step) {
-    if(step.ui == false) {
-        // No UI
-    }
-    else if(step.inBrowser) {
-      // Create and append an HTML Element
-      console.log("Added Step \""+step.name+"\" to \""+step.imageName+"\".");
-    }
-    else {
-      // Create a NodeJS Object
-      console.log('\x1b[36m%s\x1b[0m',"Added Step \""+step.name+"\" to \""+step.imageName+"\".");
-    }
-  }
-
-  events.onDraw = events.onDraw || function(step) {
-    if (step.ui == false) {
-      // No UI
-    }
-    else if(step.inBrowser) {
-      // Overlay a loading spinner
-      console.log("Drawing Step \""+step.name+"\" on \""+step.imageName+"\".");
-    }
-    else {
-      // Don't do anything
-      console.log('\x1b[33m%s\x1b[0m',"Drawing Step \""+step.name+"\" on \""+step.imageName+"\".");
-    }
-  }
-
-  events.onComplete = events.onComplete || function(step) {
-    if (step.ui == false) {
-      // No UI
-    }
-    else if(step.inBrowser) {
-      // Update the DIV Element
-      // Hide the laoding spinner
-      console.log("Drawn Step \""+step.name+"\" on \""+step.imageName+"\".");
-    }
-    else {
-      // Update the NodeJS Object
-      console.log('\x1b[32m%s\x1b[0m',"Drawn Step \""+step.name+"\" on \""+step.imageName+"\".");
-    }
-  }
-
-  events.onRemove = events.onRemove || function(step) {
-    if(step.ui == false){
-      // No UI
-    }
-    else if(step.inBrowser) {
-      // Remove the DIV Element
-      console.log("Removing Step \""+step.name+"\" of \""+step.imageName+"\".");
-    }
-    else {
-      // Delete the NodeJS Object
-      console.log('\x1b[31m%s\x1b[0m',"Removing Step \""+step.name+"\" of \""+step.imageName+"\".");
-    }
-  }
-
-  return events;
-
-}

src/cli/index.js

@@ -0,0 +1,102 @@
+require('../ImageSequencer');
+sequencer = ImageSequencer({ ui: true });
+var fs = require('fs');
+var { Command } = require('commander');
+var utils = require('../CliUtils');
+
+var saveSequence = require('./saveSequence.js');
+var installModule = require('./installModule.js');
+var sequencerSteps = require('./sequencerSteps.js');
+
+function exit(message) {
+  console.error(message);
+  process.exit(1);
+}
+
+function executeSteps(program) {
+  // Set sequencer to log module outputs, if any.
+  sequencer.setUI({
+    onComplete: function (step) {
+      // Get information of outputs.
+      step.info = sequencer.modulesInfo(step.name);
+
+      for (var output in step.info.outputs) {
+        console.log('[' + program.step + ']: ' + output + ' = ' + step[output]);
+      }
+    },
+    notify: function (msg) {
+      console.log('\x1b[36m%s\x1b[0m', '🌟  ' + msg);
+    },
+  });
+
+  // Finally, if everything is alright, load the image, add the steps and run the sequencer.
+  sequencer.loadImages(program.image, function () {
+    console.warn(
+      '\x1b[33m%s\x1b[0m',
+      'Please wait \n output directory generated will be empty until the execution is complete'
+    );
+
+    //Generate the Output Directory
+    var outputFilename = program.output.split('/').slice(-1)[0];
+    if (outputFilename.includes('.')) {
+      // user did give an output filename we have to remove it from dir
+      program.output = program.output.split('/').slice(0, -1).join('/');
+    } else {
+      outputFilename = null;
+    }
+
+    sequencerSteps(program, sequencer, outputFilename);
+  });
+}
+
+function parseSteps(program) {
+  // Parse step into an array to allow for multiple steps.
+  if (!program.step) exit('No steps passed');
+  program.step = program.step.split(' ');
+
+  // User must input an image.
+  if (!program.image) exit('Can\'t read file.');
+
+  // User must input an image.
+  fs.access(program.image, function (err) {
+    if (err) exit('Can\'t read file.');
+  });
+
+  // User must input a step. If steps exist, check that every step is a valid step.
+  if (!program.step || !utils.validateSteps(program.step, sequencer))
+    exit('Please ensure all steps are valid.');
+
+  // If there's no user defined output directory, select a default directory.
+  program.output = program.output || './output/';
+
+  executeSteps(program);
+}
+
+function cli(args) {
+
+  let program = new Command();
+
+  program
+    .version('0.1.0')
+    .option('-i, --image [PATH/URL]', 'Input image URL')
+    .option('-s, --step [step-name]', 'Name of the step to be added.')
+    .option('-o, --output [PATH]', 'Directory where output will be stored.')
+    .option('-b, --basic', 'Basic mode outputs only final image')
+    .option('-c, --config [Object]', 'Options for the step')
+    .option(
+      '--save-sequence [string]',
+      'Name space separated with Stringified sequence'
+    )
+    .option(
+      '--install-module [string]',
+      'Module name space seaprated npm package name'
+    )
+    .parse(args);
+
+  const options = program.opts();
+  if (options.saveSequence) saveSequence(options, sequencer);
+  else if (options.installModule) installModule(options, sequencer);
+  else parseSteps(options);
+}
+
+module.exports = cli;

src/cli/installModule.js

@@ -0,0 +1,17 @@
+var childProcess = require('child_process');
+var Spinner = require('ora');
+
+module.exports = function (program, sequencer) {
+  console.log(
+    '\x1b[33m%s\x1b[0m',
+    'Please wait while your Module is being Installed...\nThis may take a while!'
+  );
+
+  var params = program.installModule.split(' ');
+  var spinner = Spinner('Now Installing...').start();
+  childProcess.execSync(`npm i ${params[1]}`);
+  sequencer.saveNewModule(params[0], params[1]);
+  sequencer.loadNewModule(params[0], require(params[1]));
+  spinner.stop();
+  console.log('\x1b[32m%s\x1b[0m', 'Your module was installed successfully!!');
+};

src/cli/saveSequence.js

@@ -0,0 +1,7 @@
+module.exports = function (program, sequencer) {
+
+  var params = program.saveSequence.split(' ');
+  sequencer.saveSequence(params[0], params[1]);
+  console.log('\x1b[32m', 'Your sequence was saved successfully!!');
+
+};

src/cli/sequencerSteps.js

@@ -0,0 +1,88 @@
+var Spinner = require('ora');
+var readlineSync = require('readline-sync');
+var utils  = require('../CliUtils');
+
+module.exports = function (program, sequencer, outputFilename) {
+  utils.makedir(program.output, () => {
+    console.log('Files will be exported to "' + program.output + '"');
+
+    if (program.basic)
+      console.log('Basic mode is enabled, outputting only final image');
+
+    // Iterate through the steps and retrieve their inputs.
+    program.step.forEach(function(step) {
+      var options = Object.assign({}, sequencer.modulesInfo(step).inputs);
+
+      // If inputs exists, print to console.
+      if (Object.keys(options).length) {
+        console.log('[' + step + ']: Inputs');
+      }
+
+      // If inputs exists, print them out with descriptions.
+      Object.keys(options).forEach(function(input) {
+        // The array below creates a variable number of spaces. This is done with (length + 1).
+        // The extra 4 that makes it (length + 5) is to account for the []: characters
+        console.log(
+          new Array(step.length + 5).join(' ') +
+          input +
+          ': ' +
+          options[input].desc
+        );
+      });
+
+      if (program.config) {
+        try {
+          var config = JSON.parse(program.config);
+          console.log('The parsed options object: ', config);
+        } catch (e) {
+          console.error(
+            '\x1b[31m%s\x1b[0m',
+            'Options(Config) is not a not valid JSON Fallback activate'
+          );
+          program.config = false;
+          console.log(e);
+        }
+      }
+      if (program.config && utils.validateConfig(config, options)) {
+        console.log('Now using Options object');
+        Object.keys(options).forEach(function(input) {
+          options[input] = config[input];
+        });
+      } else {
+        // If inputs exist, iterate through them and prompt for values.
+        Object.keys(options).forEach(function(input) {
+          var value = readlineSync.question(
+            '[' +
+            step +
+            ']: Enter a value for ' +
+            input +
+            ' (' +
+            options[input].type +
+            ', default: ' +
+            options[input].default +
+            '): '
+          );
+          options[input] = value;
+        });
+      }
+      // Add the step and its inputs to the sequencer.
+      sequencer.addSteps(step, options);
+    });
+
+    var spinnerObj = { succeed: () => { }, stop: () => { } };
+    if (!process.env.TEST)
+      spinnerObj = Spinner('Your Image is being processed..').start();
+
+    // Run the sequencer.
+    sequencer.run({ progressObj: spinnerObj }, function() {
+      // Export all images or final image as binary files.
+      sequencer.exportBin(program.output, program.basic, outputFilename);
+
+      //check if spinner was not overriden stop it
+      if (!spinnerObj.overrideFlag) {
+        spinnerObj.succeed();
+        console.log('\nDone!!');
+      }
+    });
+  });
+};

src/modules/AddQR/Module.js

@@ -0,0 +1,64 @@
+const _ = require('lodash'),
+  parseCornerCoordinateInputs = require('../../util/ParseInputCoordinates');
+module.exports = function AddQR(options, UI) {
+
+  var defaults = require('./../../util/getDefaults.js')(require('./info.json'));
+  var output;
+  getPixels = require('get-pixels');
+
+  function draw(input, callback, progressObj) {
+
+    options.size = Number(options.size || defaults.size);
+    options.qrCodeString = options.qrCodeString || defaults.qrCodeString;
+    options.startingX = options.startingX || defaults.startingX;
+    options.startingY = options.startingY || defaults.startingY;
+    progressObj.stop(true);
+    progressObj.overrideFlag = true;
+
+    var step = this;
+
+    function extraManipulation(pixels, setRenderState, generateOutput) {
+      let iw = pixels.shape[0], // Width of Original Image
+        ih = pixels.shape[1]; // Height of Original Image
+      const oldPixels = _.cloneDeep(pixels);
+      setRenderState(false); // Prevent rendering of final output image until extraManipulation completes.
+
+      // Parse the inputs.
+      parseCornerCoordinateInputs({iw, ih},
+        {
+          startingX: { valInp: options.startingX, type: 'horizontal'},
+          startingY: { valInp: options.startingY, type: 'vertical' },
+        }, function(opt, cord){
+          options.startingX = Math.floor(cord.startingX.valInp);
+          options.startingY = Math.floor(cord.startingY.valInp);
+        });
+
+      require('./QR')(options, pixels, oldPixels, () => {
+        setRenderState(true); // Allow rendering in the callback.
+        generateOutput();
+      });
+    }
+
+    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,
+      extraManipulation: extraManipulation,
+      format: input.format,
+      image: options.image,
+      inBrowser: options.inBrowser,
+      callback: callback,
+      useWasm:options.useWasm
+    });
+  }
+
+  return {
+    options: options,
+    draw: draw,
+    output: output,
+    UI: UI
+  };
+};

src/modules/AddQR/QR.js

@@ -0,0 +1,37 @@
+const pixelSetter = require('../../util/pixelSetter.js'),
+  getPixels = require('get-pixels'),
+  QRCode = require('qrcode');
+module.exports = exports = function (options, pixels, oldPixels, cb) {
+
+  QRCode.toDataURL(options.qrCodeString, {width: options.size, scale: 1}, function (error, url) {
+    getPixels(url, function (err, qrPixels) {
+      if (err) {
+        console.log('get-pixels error: ', err);
+      }
+
+      const width = oldPixels.shape[0],
+        height = oldPixels.shape[1];
+
+      const xe = Math.min(options.startingX, width - options.size), // Starting pixel coordinates
+        ye = Math.min(options.startingY, height - options.size);
+
+      for (let x = xe; x < Math.min(xe + options.size, width); x++) {
+        for (let y = ye; y < Math.min(ye + options.size, height); y++) {
+          pixelSetter(
+            x,
+            y,
+            [
+              qrPixels.get(x - xe, y - ye, 0),
+              qrPixels.get(x - xe, y - ye, 1),
+              qrPixels.get(x - xe, y - ye, 2),
+              qrPixels.get(x - xe, y - ye, 3)
+            ],
+            pixels
+          );
+        }
+      }
+
+      if(cb) cb();
+    });
+  });
+};

src/modules/AddQR/index.js

@@ -0,0 +1,4 @@
+module.exports = [
+  require('./Module'),
+  require('./info.json')
+];

src/modules/AddQR/info.json

@@ -0,0 +1,29 @@
+{
+    "name": "add-qr",
+    "description": "Adds QR corresponding to the given string",
+    "url": "https://github.com/publiclab/image-sequencer/tree/master/MODULES.md",
+    "inputs": {
+      "size": {
+        "type": "integer",
+        "desc": "size of QR code in pixels",
+        "default": 200
+      },
+      "qrCodeString":{
+        "type": "string",
+        "desc": "input string to generate QR code",
+        "default": "https://github.com/publiclab/image-sequencer"
+      },
+      "startingX": {
+        "type": "string",
+        "desc": "X-position (measured from left) from where QR starts",
+        "default": "0"
+      },
+      "startingY": {
+        "type": "string",
+        "desc": "Y-position (measured from top) from where QR starts",
+        "default": "0"
+      }
+    },
+    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#add-qr-module"
+  }
+  

src/modules/Average/Module.js

@@ -0,0 +1,72 @@
+/*
+* Average all pixel colors
+*/
+module.exports = function Average(options, UI) {
+
+  var output;
+
+  options.step.metadata = options.step.metadata || {};
+
+  function draw(input, callback, progressObj) {
+
+    progressObj.stop(true);
+    progressObj.overrideFlag = true;
+
+    var step = this;
+
+    // do the averaging
+    function extraManipulation(pixels) {
+      var i = 0, sum = [0, 0, 0, 0];
+      while (i < pixels.data.length) {
+        sum[0] += pixels.data[i++];
+        sum[1] += pixels.data[i++];
+        sum[2] += pixels.data[i++];
+        sum[3] += pixels.data[i++];
+      }
+
+      let divisor = pixels.data.length / 4;
+
+      sum[0] = Math.floor(sum[0] / divisor);
+      sum[1] = Math.floor(sum[1] / divisor);
+      sum[2] = Math.floor(sum[2] / divisor);
+      sum[3] = Math.floor(sum[3] / divisor);
+
+      i = 0;
+      while (i < pixels.data.length) {
+        pixels.data[i++] = sum[0];
+        pixels.data[i++] = sum[1];
+        pixels.data[i++] = sum[2];
+        pixels.data[i++] = sum[3];
+      }
+
+      // report back and store average in metadata:
+      options.step.metadata.averages = sum;
+
+      if (options.step.average === undefined) options.step.average = '';
+      options.step.average += 'rgba(' + sum.join(', ') + ')';
+      return pixels;
+    }
+
+    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,
+      inBrowser: options.inBrowser,
+      extraManipulation: extraManipulation,
+      format: input.format,
+      image: options.image,
+      callback: callback,
+      useWasm:options.useWasm
+    });
+
+  }
+  return {
+    options: options,
+    draw: draw,
+    output: output,
+    UI: UI
+  };
+};

src/modules/Average/index.js

@@ -0,0 +1,4 @@
+module.exports = [
+  require('./Module'),
+  require('./info.json')
+];

src/modules/Average/info.json

@@ -0,0 +1,13 @@
+{
+    "name": "average",
+    "description": "Average all pixel color",
+    "inputs": {
+    },
+    "outputs": {
+        "average": {
+            "type": "string",
+            "desc": "The average value of all the pixels."
+        }
+    },
+    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#average-module"
+}

src/modules/Blend/Module.js

@@ -0,0 +1,132 @@
+module.exports = function Blend(options, UI, util) {
+
+  var defaults = require('./../../util/getDefaults.js')(require('./info.json'));
+
+  options.func = options.blend || defaults.blend;
+  options.offset = options.offset || defaults.offset;
+  options.blendMode = options.blendMode || defaults.blendMode;
+
+  var output;
+
+  // This function is called on every draw.
+  function draw(input, callback, progressObj) {
+
+    progressObj.stop(true);
+    progressObj.overrideFlag = true;
+
+    var step = this;
+
+    var getPixels = require('get-pixels');
+
+    // convert offset as string to int
+    if (typeof options.offset === 'string') options.offset = parseInt(options.offset);
+
+    // save first image's pixels
+    var priorStep = this.getStep(options.offset);
+
+    if (priorStep.output === undefined) {
+      this.output = input;
+      UI.notify('Offset Unavailable', 'offset-notification');
+      callback();
+    }
+
+    // see http://docs.gimp.org/en/gimp-concepts-layer-modes.html for other blend modes
+
+    const multiply_mode = function (i, m) {
+      return ~~( (i * m) / 255 );
+    };
+    const divide_mode = function (i, m) {
+      return ~~( (256 * i) / (m + 1) );
+    };
+
+    const overlay_mode = function (i, m) {
+      return ~~( (i / 255) * (i + ((2 * m) / 255) * (255 - i)) );
+    };
+    
+    const screen_mode = function (i, m) {
+      return ~~( 255 - ((255 - m) * (255 - i)) / 255 );
+    };
+    
+    const sof_light_mode = function (i, m) {
+      var Rs = screen_mode(i, m);
+      return ~~( ((((255 - i) * m) + Rs) * i) / 255 );
+    };
+    
+    const color_dodge = function (i, m) {
+      return ~~( (256 * i) / (255 - m + 1) );
+    };
+
+    const burn_mode = function (i, m) {
+      return ~~( 255 - (256 * (255 - i)) / (m + 1));
+    };
+
+    const grain_extract_mode = function (i, m) {
+      return ~~( i - m + 128 );
+    };
+
+    const grain_merge_mode = function (i, m) {
+      return ~~( i + m - 128 );
+    };
+
+    
+    getPixels(priorStep.output.src, function(err, pixels) {
+      options.firstImagePixels = pixels;
+
+      // Convert to runnable code.
+      if (typeof options.func === 'string') eval('options.func = ' + options.func);
+      
+      function changePixel(r2, g2, b2, a2, x, y) {
+        // blend!
+        let p = options.firstImagePixels;
+        let r1 = p.get(x, y, 0),
+          g1 = p.get(x, y, 1),
+          b1 = p.get(x, y, 2),
+          a1 = p.get(x, y, 3);
+
+        const blends = {
+          'Color Dodge': () => [color_dodge(r2, r1), color_dodge(g2, g1), color_dodge(b2, b1), 255],
+          'Multiply': () => [multiply_mode(r2, r1), multiply_mode(g2, g1), multiply_mode(b2, b1), multiply_mode(a2, a1)],
+          'Divide': () => [divide_mode(r2, r1), divide_mode(g2, g1), divide_mode(b2, b1), 255],
+          'Overlay': () => [overlay_mode(r2, r1), overlay_mode(g2, g1), overlay_mode(b2, b1), 255],
+          'Screen': () => [screen_mode(r2, r1), screen_mode(g2, g1), screen_mode(b2, b1), 255],
+          'Soft Light': () => [sof_light_mode(r2, r1), sof_light_mode(g2, g1), sof_light_mode(b2, b1), 255],
+          'Color Burn': () => [burn_mode(r2, r1), burn_mode(g2, g1), burn_mode(b2, b1), 255],
+          'Grain Extract': () => [grain_extract_mode(r2, r1), grain_extract_mode(g2, g1), grain_extract_mode(b2, b1), 255],
+          'Grain Merge': () => [grain_merge_mode(r2, r1), grain_merge_mode(g2, g1), grain_merge_mode(b2, b1), 255]
+        };
+        
+        if(options.blendMode == 'custom')
+          return options.func(
+            r2, g2, b2, a2, r1, g1, b1, a1
+          );
+        else {
+          return blends[options.blendMode]();
+        }
+
+      }
+
+      function output(image, datauri, mimetype, wasmSuccess) {
+        step.output = { src: datauri, format: mimetype, wasmSuccess, useWasm: options.useWasm };
+      }
+
+      // run PixelManipulatin on second image's pixels
+      return require('../_nomodule/PixelManipulation.js')(input, {
+        output: output,
+        ui: options.step.ui,
+        changePixel: changePixel,
+        format: input.format,
+        image: options.image,
+        inBrowser: options.inBrowser,
+        callback: callback,
+        useWasm:options.useWasm
+      });
+    });
+  }
+
+  return {
+    options: options,
+    draw: draw,
+    output: output,
+    UI: UI
+  };
+};

src/modules/Blend/index.js

@@ -0,0 +1,4 @@
+module.exports = [
+  require('./Module'),
+  require('./info.json')
+];

src/modules/Blend/info.json

@@ -0,0 +1,34 @@
+{
+  "name": "blend",
+  "description": "Blend two chosen image steps with the given function. Defaults to using the red channel from image 1 and the green and blue and alpha channels of image 2.",
+  "inputs": {
+    "offset": {
+      "type": "integer",
+      "desc": "Choose which image to blend the current image with. Two steps back is -2, three steps back is -3 etc.",
+      "default": -2
+    },
+    "blendMode": {
+      "type": "select",
+      "desc": "Name of the Blend Mode to use",
+      "default": "custom",
+      "values": [
+        "custom",
+        "Multiply",
+        "Divide",
+        "Overlay",
+        "Screen",
+        "Soft Light",
+        "Color Burn",
+        "Color Dodge",
+        "Grain Extract",
+        "Grain Merge"
+      ]
+    },
+    "blend": {
+      "type": "string",
+      "desc": "Function to use to blend the two images.",
+      "default": "function(r1, g1, b1, a1, r2, g2, b2, a2, x, y) { return [ r2, g2, b2, a2 ] }"
+    }
+  },
+  "docs-link": "https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#blend-module"
+}

src/modules/BlobAnalysis/BlobAnalysis.js

@@ -0,0 +1,74 @@
+module.exports = function(pixels){
+  var canvas = document.createElement('canvas');
+  canvas.width = pixels.shape[0];
+  canvas.height = pixels.shape[1];
+  var ctx = canvas.getContext('2d');
+  ctx.putImageData(new ImageData(new Uint8ClampedArray(pixels.data), pixels.shape[0], pixels.shape[1]), 0, 0);
+  
+  let imgData = ctx.getImageData(0, 0, canvas.width, canvas.height);
+
+
+  let src = cv.matFromImageData(imgData);
+  let dst = new cv.Mat();
+  let gray = new cv.Mat();
+  let opening = new cv.Mat();
+  let imageBg = new cv.Mat();
+  let imageFg = new cv.Mat();
+  let distTrans = new cv.Mat();
+  let unknown = new cv.Mat();
+  let markers = new cv.Mat();
+ 
+  // Gray and Threshold the image
+  cv.cvtColor(src, gray, cv.COLOR_RGBA2GRAY, 0);
+  cv.threshold(gray, gray, 0, 255, cv.THRESH_BINARY_INV + cv.THRESH_OTSU);
+ 
+  // Get background
+  let M = cv.Mat.ones(3, 3, cv.CV_8U);
+  cv.erode(gray, gray, M);
+  cv.dilate(gray, opening, M);
+  cv.dilate(opening, imageBg, M, new cv.Point(-1, -1), 3);
+ 
+  // Distance transform
+  cv.distanceTransform(opening, distTrans, cv.DIST_L2, 5);
+  cv.normalize(distTrans, distTrans, 1, 0, cv.NORM_INF);
+ 
+  // Get foreground
+  cv.threshold(distTrans, imageFg, 0.7 * 1, 255, cv.THRESH_BINARY);
+  imageFg.convertTo(imageFg, cv.CV_8U, 1, 0);
+  cv.subtract(imageBg, imageFg, unknown);
+ 
+  // Get connected components markers
+  cv.connectedComponents(imageFg, markers);
+  for (let i = 0; i < markers.rows; i++) {
+    for (let j = 0; j < markers.cols; j++) {
+      markers.intPtr(i, j)[0] = markers.ucharPtr(i, j)[0] + 1;
+      if (unknown.ucharPtr(i, j)[0] == 255) {
+        markers.intPtr(i, j)[0] = 0;
+      }
+    }
+  }
+ 
+  cv.cvtColor(src, src, cv.COLOR_RGBA2RGB, 0);
+  cv.watershed(src, markers);
+ 
+  // Grow barriers
+  for (let i = 0; i < markers.rows; i++) {
+    for (let j = 0; j < markers.cols; j++) {
+      if (markers.intPtr(i, j)[0] == -1) {
+        src.ucharPtr(i, j)[0] = 255; // Red
+        src.ucharPtr(i, j)[1] = 0; // Green
+        src.ucharPtr(i, j)[2] = 0; // Blue
+      }
+    }
+  }
+
+  cv.imshow(canvas, src);
+
+  src.delete(); dst.delete(); gray.delete(); opening.delete(); imageBg.delete();
+  imageFg.delete(); distTrans.delete(); unknown.delete(); markers.delete(); M.delete();
+  
+  var myImageData = ctx.getImageData(0, 0, canvas.width, canvas.height);
+  pixels.data = myImageData.data;
+ 
+  return pixels;
+};

src/modules/BlobAnalysis/Module.js

@@ -0,0 +1,46 @@
+
+module.exports = function BlobAnalysis(options, UI){
+
+  var output;
+  
+  function draw(input, callback, progressObj) {
+  
+    progressObj.stop(true);
+    progressObj.overrideFlag = true;
+  
+    var step = this;
+
+    function extraManipulation(pixels, setRenderState, generateOutput){
+      setRenderState(false);
+      if (!options.inBrowser) {
+        require('../_nomodule/gl-context')(input, callback, step, options);
+      } else{
+        pixels = require('./BlobAnalysis')(pixels);
+        setRenderState(true);
+        generateOutput();
+      }
+      return pixels;
+    }
+  
+    function output(image, datauri, mimetype, wasmSuccess) {
+      step.output = { src: datauri, format: mimetype, wasmSuccess, useWasm: options.useWasm };
+    }
+  
+    return require('../_nomodule/PixelManipulation.js')(input, {
+      output: output,
+      extraManipulation: extraManipulation,
+      format: input.format,
+      image: options.image,
+      inBrowser: options.inBrowser,
+      callback: callback
+    });
+  
+  }
+  
+  return {
+    options: options,
+    draw: draw,
+    output: output,
+    UI: UI
+  };
+};

src/modules/BlobAnalysis/index.js

@@ -0,0 +1,4 @@
+module.exports = [
+  require('./Module'),
+  require('./info.json')
+];

src/modules/BlobAnalysis/info.json

@@ -0,0 +1,7 @@
+{
+    "name": "Blob Analysis",
+    "description": "Blob/Region identification for microscopic images.",
+    "inputs": {},
+    "requires": ["webgl", "browser"],
+    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#blob-analysis"
+}

src/modules/Blur/Blur.js

@@ -0,0 +1,65 @@
+// Generates a 5x5 Gaussian kernel
+function kernelGenerator(sigma = 1) {
+
+  let kernel = [],
+    sum = 0;
+
+  if (sigma == 0) sigma += 0.05;
+
+  const s = 2 * Math.pow(sigma, 2);
+
+  for (let y = -2; y <= 2; y++) {
+    kernel.push([]);
+    for (let x = -2; x <= 2; x++) {
+      let r = Math.sqrt(Math.pow(x, 2) + Math.pow(y, 2));
+      kernel[y + 2].push(Math.exp(-(r / s)));
+      sum += kernel[y + 2][x + 2];
+    }
+  }
+
+  for (let x = 0; x < 5; x++){
+    for (let y = 0; y < 5; y++){
+      kernel[y][x] = (kernel[y][x] / sum);
+    }
+  }
+
+  return kernel;
+}
+
+module.exports = exports = function(pixels, blur) {
+  const pixelSetter = require('../../util/pixelSetter.js');
+
+  let kernel = kernelGenerator(blur), // Generate the Gaussian kernel based on the sigma input.
+    pixs = { // Separates the rgb channel pixels to convolve on the GPU.
+      r: [],
+      g: [],
+      b: [],
+    };
+
+  for (let y = 0; y < pixels.shape[1]; y++){
+    pixs.r.push([]);
+    pixs.g.push([]);
+    pixs.b.push([]);
+
+    for (let x = 0; x < pixels.shape[0]; x++){
+      pixs.r[y].push(pixels.get(x, y, 0));
+      pixs.g[y].push(pixels.get(x, y, 1));
+      pixs.b[y].push(pixels.get(x, y, 2));
+    }
+  }
+
+  const convolve = require('../_nomodule/gpuUtils').convolve; // GPU convolution function.
+
+  const conPix = convolve([pixs.r, pixs.g, pixs.b], kernel); // Convolves the pixels (all channels separately) on the GPU.
+
+  for (let y = 0; y < pixels.shape[1]; y++){
+    for (let x = 0; x < pixels.shape[0]; x++){
+      var pixelvalue = [Math.max(0, Math.min(conPix[0][y][x], 255)),
+        Math.max(0, Math.min(conPix[1][y][x], 255)),
+        Math.max(0, Math.min(conPix[2][y][x], 255))];
+      pixelSetter(x, y, pixelvalue, pixels); // Sets the image pixels according to the blurred values.
+    }
+  }
+
+  return pixels;
+};

src/modules/Blur/Module.js

@@ -0,0 +1,45 @@
+/*
+* Blur an Image
+*/
+module.exports = function Blur(options, UI) {
+
+  var defaults = require('./../../util/getDefaults.js')(require('./info.json'));
+  options.blur = options.blur || defaults.blur;
+  options.blur = parseFloat(options.blur);
+  var output;
+
+  function draw(input, callback, progressObj) {
+
+    progressObj.stop(true);
+    progressObj.overrideFlag = true;
+
+    var step = this;
+
+    function extraManipulation(pixels) {
+      pixels = require('./Blur')(pixels, options.blur);
+      return pixels;
+    }
+
+    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,
+      inBrowser: options.inBrowser,
+      extraManipulation: extraManipulation,
+      format: input.format,
+      image: options.image,
+      callback: callback,
+      useWasm:options.useWasm
+    });
+
+  }
+  return {
+    options: options,
+    draw: draw,
+    output: output,
+    UI: UI
+  };
+};

src/modules/Blur/index.js

@@ -0,0 +1,4 @@
+module.exports = [
+  require('./Module'),
+  require('./info.json')
+];

src/modules/Blur/info.json

@@ -0,0 +1,15 @@
+{
+    "name": "blur",
+    "description": "Applies a Gaussian blur given by the intensity value",
+    "inputs": {
+        "blur": {
+            "type": "float",
+            "desc": "Amount of gaussian blur(Less blur gives more detail, typically 0-5)",
+            "default": 2,
+            "min": 0,
+            "max": 5,
+            "step": 0.05
+        }
+    },
+    "docs-link":"https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#blur-module"
+}