Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

multimath

Package Overview
Dependencies
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

multimath

Core to create fast image math in WebAssembly and JS.

  • 2.0.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
76K
decreased by-6.5%
Maintainers
1
Weekly downloads
 
Created
Source

multimath

Build Status NPM version

Core to create fast image math in WebAssembly and JS.

multimath simplifies creation of small CPU-intensive webassembly modules with fallback to JavaScript implementations.

  • It cares about modules init, memory management and other things.
  • Has built-in helpers to write webassembly code without additional runtimes.
  • Use shared memory to chain webassembly calls without memory copy.

Built-in functions (curently - unsharp mask) are available as examples for your extensions.

Install

npm install multimath

Use

const mm = require('multimath')()
             .use(require('multimath/lib/unsharp_mask'))
             .use(require('your_custom_module'))

// Simple sync call. Will use sync wasm compile. Ok for webworkers.
// Can freeze interface at first call if wasm source is too big.
mm.unsharp_mask(rgba_buffer, width, height);

// Async init, compile all modules at once in async way.
mm.init().then(() => {
  mm.unsharp_mask(rgba_buffer, width, height);
});

API

new multimath(options)

Create library instance. Sugar - multimath() (without new).

const mm = require('multimath')({
  // Options are not mandatory, but you can disable js or ww
  // implementations for testing
  js:   true,
  wasm: true
});

.use(module)

Register new module, format is:

{
  name:     String,    // default wasm module & function name to expose
  fn:       Function,  // JS implementation
  wasm_fn:  Function,  // WebAssembly glue
  wasm_src: String     // Base64 encoded WebAssembly module
}

See example implementation in lib/ folder.

.init() -> Promise

Optional. Compile all wasm modules in async way. May be useful in this cases:

  1. If you have wasm module > 4K AND run multimath in the main thread (not in webworker). Some browsers prohibit sync wasm creation in this case.
  2. If you have a lot of small modules and wish to init everything before run in the main thread, withoutinterface freeze.

Probably, you will never need to use this method. Note, 3K was file is initialized in ~ 3ms.

.<your_method>

All modules, loaded via .use(), pin their methods to current Multimath instance. The best implementation will be selected automatically (depends on browser features and constructor options);

Development

Ways to go with your own modules:

  • Use ./support/llvmasm_install.sh to install llvm/binaryen tools. Or use it as base for your own.
  • See Makefile
  • See ./lib/unsharp_mask as example and... of cause ./index.js.

Also, see how pica use this library.

Licence

MIT

Keywords

FAQs

Package last updated on 15 Jul 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc