Mathis/sharp
1
0
Fork 0
mirror of https://github.com/lovell/sharp.git synced 2025-07-11 11:30:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Changelog/doc/test updates for various new operations

Browse Source 
Dependency version bumps
This commit is contained in:
Lovell Fuller 2016-07-11 15:52:30 +01:00
parent e10aeb29eb
commit ff8c42e894
5 changed files with 117 additions and 148 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
docs/api.md
View File

@ -298,24 +298,11 @@ sharp(input)
}); });
``` ```
#### extractChannel(channel) #### trim([tolerance])
Extract a channel from the image. The following channel names are equivalent: Trim "boring" pixels from all edges that contain values within a percentage similarity of the top-left pixel.
* Red: `0, 'red'` * `tolerance`, if present, is an integral Number between 1 and 99 representing the percentage similarity, defaulting to 10.
* Green: `1, 'green'`
* Blue: `2, 'blue'`
The result will be a single-channel grayscale image.
```javascript
sharp(input)
.extractChannel('green')
.toFile('input_green.jpg',function(err, info) {
// info.channels === 1
// input_green.jpg contains the green channel of the input image
});
```
#### background(rgba) #### background(rgba)
@ -502,15 +489,30 @@ sharp('input.png')
}); });
``` ```
#### extractChannel(channel)
Extract a single channel from a multi-channel image.
* `channel` is a zero-indexed integral Number representing the band number to extract. `red`, `green` or `blue` are also accepted as an alternative to `0`, `1` or `2` respectively.
```javascript
sharp(input)
.extractChannel('green')
.toFile('input_green.jpg', function(err, info) {
// info.channels === 1
// input_green.jpg contains the green channel of the input image
});
```
#### bandbool(operation) #### bandbool(operation)
Perform a bitwise boolean operation on image color channels (bands in vips terminology). The result is a single channel grayscale image. Bandbool is performed at the end of the image processing pipeline, after gamma correction, colorspace conversion, normalization, and other operations. This makes it possible to create an image that contains the unaltered result of the boolean operation. Note that the alpha channel of the image is included in `bandbool` operations. All channels are cast to an integer type before the operation. `bandbool` takes no effect on single channel images. Perform a bitwise boolean operation on all input image channels (bands) to produce a single channel output image.
`operation` is a string containing the name of the bitwise operator to be appled to image color channels, which can be one of: `operation` is a string containing the name of the bitwise operator to be appled to image channels, which can be one of:
* `and` performs a bitwise and operation, like the c-operator `&` * `and` performs a bitwise and operation, like the c-operator `&`.
* `or` performs a bitwise or operation, like the c-operator `|` * `or` performs a bitwise or operation, like the c-operator `|`.
* `eor` performs a bitwise exclusive or operation, like the c-operator `^` * `eor` performs a bitwise exclusive or operation, like the c-operator `^`.
```javascript ```javascript
sharp('input.png') sharp('input.png')
@ -518,22 +520,22 @@ sharp('input.png')
.toFile('output.png') .toFile('output.png')
``` ```
In the above example if `input.png` is a 3 channel RGB image, `output.png` will be a 1 channel grayscale image where each pixel `P = R & G & B`. For example, if `I(1,1) = [247, 170, 14] = [0b11110111, 0b10101010, 0b00001111]` then `O(1,1) = 0b11110111 & 0b10101010 & 0b00001111 = 0b00000010 = 2`. In the above example if `input.png` is a 3 channel RGB image, `output.png` will be a 1 channel grayscale image where each pixel `P = R & G & B`.
For example, if `I(1,1) = [247, 170, 14] = [0b11110111, 0b10101010, 0b00001111]` then `O(1,1) = 0b11110111 & 0b10101010 & 0b00001111 = 0b00000010 = 2`.
#### boolean(image, operation) #### boolean(image, operation)
Perform a bitwise boolean operation with `image`. Perform a bitwise boolean operation with `image`, where `image` is one of the following:
`image` is one of the following. * Buffer containing PNG, WebP, GIF or SVG image data, or
* Buffer contianing PNG, WebP, GIF or SVG image data, or
* String containing the path to an image file * String containing the path to an image file
This operation creates an output image where each pixel is the result of the selected bitwise boolean `operation`, between the corresponding pixels of the input images. The boolean operation can be one of the following: This operation creates an output image where each pixel is the result of the selected bitwise boolean `operation` between the corresponding pixels of the input images.
The boolean operation can be one of the following:
* `and` performs a bitwise and operation, like the c-operator `&` * `and` performs a bitwise and operation, like the c-operator `&`.
* `or` performs a bitwise or operation, like the c-operator `|` * `or` performs a bitwise or operation, like the c-operator `|`.
* `eor` performs a bitwise exclusive or operation, like the c-operator `^` * `eor` performs a bitwise exclusive or operation, like the c-operator `^`.
### Output ### Output

20
docs/changelog.md
View File

@ -50,6 +50,26 @@ Requires libvips v8.3.1
[#490](https://github.com/lovell/sharp/issues/490) [#490](https://github.com/lovell/sharp/issues/490)
[@jwagner](https://github.com/jwagner) [@jwagner](https://github.com/jwagner)
* Add trim operation to remove "boring" edges.
[#492](https://github.com/lovell/sharp/pull/492)
[@kleisauke](https://github.com/kleisauke)
* Add bandbool feature for channel-wise boolean operations.
[#496](https://github.com/lovell/sharp/pull/496)
[@mhirsch](https://github.com/mhirsch)
* Add extractChannel operation to extract a channel from an image.
[#497](https://github.com/lovell/sharp/pull/497)
[@mhirsch](https://github.com/mhirsch)
* Add ability to read and write native libvips .v files.
[#500](https://github.com/lovell/sharp/pull/500)
[@mhirsch](https://github.com/mhirsch)
* Add boolean feature for bitwise image operations.
[#501](https://github.com/lovell/sharp/pull/501)
[@mhirsch](https://github.com/mhirsch)
#### v0.15.0 - 21<sup>st</sup> May 2016 #### v0.15.0 - 21<sup>st</sup> May 2016
* Use libvips' new Lanczos 3 kernel as default for image reduction. * Use libvips' new Lanczos 3 kernel as default for image reduction.

14
package.json
View File

@ -58,11 +58,11 @@
"vips" "vips"
], ],
"dependencies": { "dependencies": {
"bluebird": "^3.3.5", "bluebird": "^3.4.1",
"color": "^0.11.1", "color": "^0.11.3",
"nan": "^2.2.1", "nan": "^2.4.0",
"semver": "^5.1.0", "semver": "^5.2.0",
"request": "^2.71.0", "request": "^2.73.0",
"tar": "^2.2.1" "tar": "^2.2.1"
}, },
"devDependencies": { "devDependencies": {
@ -71,11 +71,11 @@
"coveralls": "^2.11.9", "coveralls": "^2.11.9",
"exif-reader": "^1.0.0", "exif-reader": "^1.0.0",
"icc": "^0.0.2", "icc": "^0.0.2",
"istanbul": "^0.4.3", "istanbul": "^0.4.4",
"mocha": "^2.5.3", "mocha": "^2.5.3",
"mocha-jshint": "^2.3.1", "mocha-jshint": "^2.3.1",
"node-cpplint": "^0.4.0", "node-cpplint": "^0.4.0",
"rimraf": "^2.5.2", "rimraf": "^2.5.3",
"unzip": "^0.1.11" "unzip": "^0.1.11"
}, },
"license": "Apache-2.0", "license": "Apache-2.0",

60
test/unit/bandbool.js
View File

@ -6,46 +6,34 @@ var sharp = require('../../index');
describe('Bandbool per-channel boolean operations', function() { describe('Bandbool per-channel boolean operations', function() {
it('\'and\' Operation', function(done) { [
sharp(fixtures.inputPngBooleanNoAlpha) sharp.bool.and,
.bandbool('and') sharp.bool.or,
.toBuffer(function(err, data, info) { sharp.bool.eor
if (err) throw err; ]
assert.strictEqual(200, info.width); .forEach(function(op) {
assert.strictEqual(200, info.height); it(op + ' operation', function(done) {
assert.strictEqual(1, info.channels); sharp(fixtures.inputPngBooleanNoAlpha)
fixtures.assertSimilar(fixtures.expected('bandbool_and_result.png'), data, done); .bandbool(op)
}); .toBuffer(function(err, data, info) {
}); if (err) throw err;
assert.strictEqual(200, info.width);
it('\'or\' Operation', function(done) { assert.strictEqual(200, info.height);
sharp(fixtures.inputPngBooleanNoAlpha) assert.strictEqual(1, info.channels);
.bandbool(sharp.bool.or) fixtures.assertSimilar(fixtures.expected('bandbool_' + op + '_result.png'), data, done);
.toBuffer(function(err, data, info) { });
if (err) throw err; });
assert.strictEqual(200, info.width);
assert.strictEqual(200, info.height);
assert.strictEqual(1, info.channels);
fixtures.assertSimilar(fixtures.expected('bandbool_or_result.png'), data, done);
});
});
it('\'eor\' Operation', function(done) {
sharp(fixtures.inputPngBooleanNoAlpha)
.bandbool('eor')
.toBuffer(function(err, data, info) {
if (err) throw err;
assert.strictEqual(200, info.width);
assert.strictEqual(200, info.height);
assert.strictEqual(1, info.channels);
fixtures.assertSimilar(fixtures.expected('bandbool_eor_result.png'), data, done);
});
}); });
it('Invalid operation', function() { it('Invalid operation', function() {
assert.throws(function() { assert.throws(function() {
sharp(fixtures.inputPngBooleanNoAlpha) sharp().bandbool('fail');
.bandbool('fail'); });
});
it('Missing operation', function() {
assert.throws(function() {
sharp().bandbool();
}); });
}); });
}); });

107
test/unit/boolean.js
View File

@ -7,97 +7,56 @@ var sharp = require('../../index');
describe('Boolean operation between two images', function() { describe('Boolean operation between two images', function() {
it('\'and\' Operation, file', function(done) { var inputJpgBooleanTestBuffer = fs.readFileSync(fixtures.inputJpgBooleanTest);
sharp(fixtures.inputJpg) //fixtures.inputJpg
.resize(320,240)
.boolean(fixtures.inputJpgBooleanTest, 'and')
.toBuffer(function(err, data, info) {
if (err) throw err;
assert.strictEqual(320, info.width);
assert.strictEqual(240, info.height);
fixtures.assertSimilar(fixtures.expected('boolean_and_result.jpg'), data, done);
});
});
it('\'and\' Operation, buffer', function(done) { [
sharp(fixtures.inputJpg) //fixtures.inputJpg sharp.bool.and,
.resize(320,240) sharp.bool.or,
.boolean(fs.readFileSync(fixtures.inputJpgBooleanTest), sharp.bool.and) sharp.bool.eor
.toBuffer(function(err, data, info) { ]
if (err) throw err; .forEach(function(op) {
assert.strictEqual(320, info.width);
assert.strictEqual(240, info.height);
fixtures.assertSimilar(fixtures.expected('boolean_and_result.jpg'), data, done);
});
});
it('\'or\' Operation, file', function(done) { it(op + ' operation, file', function(done) {
sharp(fixtures.inputJpg) sharp(fixtures.inputJpg)
.resize(320,240) .resize(320, 240)
.boolean(fixtures.inputJpgBooleanTest, sharp.bool.or) .boolean(fixtures.inputJpgBooleanTest, op)
.toBuffer(function(err, data, info) { .toBuffer(function(err, data, info) {
if (err) throw err; if (err) throw err;
assert.strictEqual(320, info.width); assert.strictEqual(320, info.width);
assert.strictEqual(240, info.height); assert.strictEqual(240, info.height);
fixtures.assertSimilar(fixtures.expected('boolean_or_result.jpg'), data, done); fixtures.assertSimilar(fixtures.expected('boolean_' + op + '_result.jpg'), data, done);
}); });
}); });
it('\'or\' Operation, buffer', function(done) { it(op + ' operation, buffer', function(done) {
sharp(fixtures.inputJpg) sharp(fixtures.inputJpg)
.resize(320,240) .resize(320, 240)
.boolean(fs.readFileSync(fixtures.inputJpgBooleanTest), 'or') .boolean(inputJpgBooleanTestBuffer, op)
.toBuffer(function(err, data, info) { .toBuffer(function(err, data, info) {
if (err) throw err; if (err) throw err;
assert.strictEqual(320, info.width); assert.strictEqual(320, info.width);
assert.strictEqual(240, info.height); assert.strictEqual(240, info.height);
fixtures.assertSimilar(fixtures.expected('boolean_or_result.jpg'), data, done); fixtures.assertSimilar(fixtures.expected('boolean_' + op + '_result.jpg'), data, done);
}); });
}); });
it('\'eor\' Operation, file', function(done) {
sharp(fixtures.inputJpg)
.resize(320,240)
.boolean(fixtures.inputJpgBooleanTest, 'eor')
.toBuffer(function(err, data, info) {
if (err) throw err;
assert.strictEqual(320, info.width);
assert.strictEqual(240, info.height);
fixtures.assertSimilar(fixtures.expected('boolean_eor_result.jpg'), data, done);
});
});
it('\'eor\' Operation, buffer', function(done) {
sharp(fixtures.inputJpg)
.resize(320,240)
.boolean(fs.readFileSync(fixtures.inputJpgBooleanTest), sharp.bool.eor)
.toBuffer(function(err, data, info) {
if (err) throw err;
assert.strictEqual(320, info.width);
assert.strictEqual(240, info.height);
fixtures.assertSimilar(fixtures.expected('boolean_eor_result.jpg'), data, done);
});
}); });
it('Invalid operation', function() { it('Invalid operation', function() {
assert.throws(function() { assert.throws(function() {
sharp(fixtures.inputJpg) sharp().boolean(fixtures.inputJpgBooleanTest, 'fail');
.boolean(fs.readFileSync(fixtures.inputJpgBooleanTest), 'fail');
}); });
}); });
it('Invalid operation, non-string', function() { it('Invalid operation, non-string', function() {
assert.throws(function() { assert.throws(function() {
sharp(fixtures.inputJpg) sharp().boolean(fixtures.inputJpgBooleanTest, null);
.boolean(fs.readFileSync(fixtures.inputJpgBooleanTest), null);
}); });
}); });
if('Invalid buffer input', function() { if('Invalid input', function() {
assert.throws(function() { assert.throws(function() {
sharp(fixtures.inputJpg) sharp().boolean([], 'eor');
.resize(320,240)
.boolean([],'eor');
}); });
}); });
}); });