Skip to content

Latest commit

 

History

History
130 lines (100 loc) · 6.21 KB

README.md

File metadata and controls

130 lines (100 loc) · 6.21 KB
Raw

node-vibrant

Known Vulnerabilities

Extract prominent colors from an image.

node-vibrant is a node.js port of Vibrant.js, which is a javascript port of the awesome Palette class in the Android support library.

Features

  • Identical (asynchronous) API for both node.js and browser environment
  • Support browserify
  • Consistent results (*)

* The results is consistent within each user's browser instance regardelss of visible region or display size of the image, unlike the original vibrant.js implementation.

However, due to the very nature of HTML5 canvas element, image rendering is platform/machine-dependent. Thus the resulting swatches in browser environment varies and may not be the same as in node.js nor in another machine. See Canvas Fingerprinting.

Install

$ npm install node-vibrant

Usage

node.js / browserify

# Use in node.js or bunddle with browserify
Vibrant = require('node-vibrant')

v = new Vibrant('path/to/image', opts)
v.getSwatches (err, swatches) ->
  console.log(swatches)

Browser

<!-- Debug version -->
<script src="/path/to/dist/vibrant.js"></script>
<!-- Uglified version -->
<script src="/path/to/dist/vibrant.min.js"></script>

<script>
  // Use `Vibrant` in script
  // Vibrant is exported to global. window.Vibrant === Vibrant
  var v = new Vibrant('/path/to/image', opts);
  // ... same as in node.js
</script>

References

Vibrant.constructor(imagePath, opts)

Name Type Description
imagePath string Path to image file
opts object Options (optional)

opts

Field Default Description
colorCount 64 amount of colors in initial palette from which the swatches will be generated
quality 5 1 is highest, but takes way more processing
targetDarkLuma 0.26 target luma value for generating the dark swatches, values should be in the range [0 1]
maxDarkLuma 0.45 maximal luma threshold for generating the dark swatches, values should be in the range [0 1]
minLightLuma 0.55 minimal luma threshold for generating the light swatches, values should be in the range [0 1]
targetLightLuma 0.74 target luma value for generating the light swatches, values should be in the range [0 1]
minNormalLuma 0.3 minimal luma threshold for generating the Vibrant and Muted swatches, values should be in the range [0 1]
targetNormalLuma 0.5 target luma value for generating the Vibrant and Muted swatches, values should be in the range [0 1]
maxNormalLuma 0.7 maximal luma threshold for generating the Vibrant and Muted swatches, values should be in the range [0 1]
targetMutedSaturation 0.3 target saturation for generating the Muted swatch, values should be in the range [0 1]
maxMutesSaturation 0.4 maximal saturation threshold for generating the Muted swatches, values should be in the range [0 1]
targetVibrantSaturation 1.0 target saturation value for generating the Vibrant swatches, values should be in the range [0 1]
minVibrantSaturation 0.35 minimal saturation threshold for generating the Vibrant swatches, values should be in the range [0 1]
weightSaturation 3 saturation weight coefficient for determining each swatch, actual impact depends on other weights
weightLuma 6 luma weight coefficient for determining each swatch, actual impact depends on other weights
weightPopulation 1 population weight coefficient for determining each swatch, actual impact depends on other weights

Vibrant.getSwatches(cb)

Name Type Description
cb function callback function

cb(err, swatches)

Name Type Description
err object Error (if thrown)
swatches object Resulting swatches

Intentional Deviation From vibrant.js

  • node-vibrant takes image path, not the image object as parameter for the obvious reason that node.js environment has no access to HTML DOM object.
  • node-vibrant provides asynchronous API since most node.js image processing library is asynchronous. And the original vibrant.js workflow is asynchronous any way (though you will have to handle the image loading yourself, while node-vibrant does it for you).
  • node-vibrant uses one single opts object to hold all options for future expansions. And it feels more node.js-like.
  • node-vibrant uses method call to initiate image processing instead of constructor so that developers can use it with Promise.

Benchmark

Run gulp benchmark to see how opts value affects performance.

[12:53:52] Running suite node-vibrant colorCount benchmark (quality = 5)
[12:53:58]    Color count: 2 x 9.83 ops/sec ±2.67% (52 runs sampled)
[12:54:04]    Color count: 4 x 9.52 ops/sec ±1.02% (50 runs sampled)
[12:54:10]    Color count: 8 x 9.01 ops/sec ±1.39% (47 runs sampled)
[12:54:16]    Color count: 16 x 8.29 ops/sec ±0.95% (44 runs sampled)
[12:54:22]    Color count: 32 x 7.95 ops/sec ±0.85% (43 runs sampled)
[12:54:28]    Color count: 64 x 7.23 ops/sec ±2.17% (39 runs sampled)
[12:54:33]    Color count: 128 x 7.42 ops/sec ±1.00% (40 runs sampled)
[12:54:39]    Color count: 256 x 6.36 ops/sec ±2.54% (35 runs sampled)
[12:54:39] Fastest test is Color count: 2 at 1.03x faster than Color count: 4
[12:54:39] Running suite node-vibrant quality benchmark (colorCount = 64)
[12:54:46]    Quality: 1 x 3.11 ops/sec ±5.63% (20 runs sampled)
[12:54:53]    Quality: 2 x 3.53 ops/sec ±3.11% (22 runs sampled)
[12:54:59]    Quality: 3 x 3.95 ops/sec ±1.98% (24 runs sampled)
[12:55:05]    Quality: 4 x 4.29 ops/sec ±1.24% (26 runs sampled)
[12:55:12]    Quality: 5 x 4.44 ops/sec ±0.97% (26 runs sampled)
[12:55:18]    Quality: 6 x 4.55 ops/sec ±1.14% (27 runs sampled)
[12:55:24]    Quality: 7 x 4.60 ops/sec ±0.77% (27 runs sampled)
[12:55:30]    Quality: 8 x 4.59 ops/sec ±1.41% (27 runs sampled)
[12:55:30] Fastest tests are Quality: 7,Quality: 8 at 1.00x faster than Quality: 8
[12:55:30] Finished 'benchmark' after 1.63 min