@revizly/sharp 0.33.2-revizly3
Sign up to get free protection for your applications and to get access to all the features.
- package/LICENSE +191 -0
- package/README.md +118 -0
- package/install/check.js +41 -0
- package/lib/channel.js +174 -0
- package/lib/colour.js +182 -0
- package/lib/composite.js +210 -0
- package/lib/constructor.js +444 -0
- package/lib/index.d.ts +1723 -0
- package/lib/index.js +16 -0
- package/lib/input.js +657 -0
- package/lib/is.js +169 -0
- package/lib/libvips.js +195 -0
- package/lib/operation.js +921 -0
- package/lib/output.js +1572 -0
- package/lib/resize.js +582 -0
- package/lib/sharp.js +115 -0
- package/lib/utility.js +286 -0
- package/package.json +218 -0
- package/src/binding.gyp +280 -0
- package/src/common.cc +1090 -0
- package/src/common.h +393 -0
- package/src/metadata.cc +287 -0
- package/src/metadata.h +82 -0
- package/src/operations.cc +471 -0
- package/src/operations.h +125 -0
- package/src/pipeline.cc +1741 -0
- package/src/pipeline.h +385 -0
- package/src/sharp.cc +40 -0
- package/src/stats.cc +183 -0
- package/src/stats.h +59 -0
- package/src/utilities.cc +269 -0
- package/src/utilities.h +19 -0
package/LICENSE
ADDED
@@ -0,0 +1,191 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction, and
|
10
|
+
distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by the copyright
|
13
|
+
owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all other entities
|
16
|
+
that control, are controlled by, or are under common control with that entity.
|
17
|
+
For the purposes of this definition, "control" means (i) the power, direct or
|
18
|
+
indirect, to cause the direction or management of such entity, whether by
|
19
|
+
contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
20
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
21
|
+
|
22
|
+
"You" (or "Your") shall mean an individual or Legal Entity exercising
|
23
|
+
permissions granted by this License.
|
24
|
+
|
25
|
+
"Source" form shall mean the preferred form for making modifications, including
|
26
|
+
but not limited to software source code, documentation source, and configuration
|
27
|
+
files.
|
28
|
+
|
29
|
+
"Object" form shall mean any form resulting from mechanical transformation or
|
30
|
+
translation of a Source form, including but not limited to compiled object code,
|
31
|
+
generated documentation, and conversions to other media types.
|
32
|
+
|
33
|
+
"Work" shall mean the work of authorship, whether in Source or Object form, made
|
34
|
+
available under the License, as indicated by a copyright notice that is included
|
35
|
+
in or attached to the work (an example is provided in the Appendix below).
|
36
|
+
|
37
|
+
"Derivative Works" shall mean any work, whether in Source or Object form, that
|
38
|
+
is based on (or derived from) the Work and for which the editorial revisions,
|
39
|
+
annotations, elaborations, or other modifications represent, as a whole, an
|
40
|
+
original work of authorship. For the purposes of this License, Derivative Works
|
41
|
+
shall not include works that remain separable from, or merely link (or bind by
|
42
|
+
name) to the interfaces of, the Work and Derivative Works thereof.
|
43
|
+
|
44
|
+
"Contribution" shall mean any work of authorship, including the original version
|
45
|
+
of the Work and any modifications or additions to that Work or Derivative Works
|
46
|
+
thereof, that is intentionally submitted to Licensor for inclusion in the Work
|
47
|
+
by the copyright owner or by an individual or Legal Entity authorized to submit
|
48
|
+
on behalf of the copyright owner. For the purposes of this definition,
|
49
|
+
"submitted" means any form of electronic, verbal, or written communication sent
|
50
|
+
to the Licensor or its representatives, including but not limited to
|
51
|
+
communication on electronic mailing lists, source code control systems, and
|
52
|
+
issue tracking systems that are managed by, or on behalf of, the Licensor for
|
53
|
+
the purpose of discussing and improving the Work, but excluding communication
|
54
|
+
that is conspicuously marked or otherwise designated in writing by the copyright
|
55
|
+
owner as "Not a Contribution."
|
56
|
+
|
57
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
|
58
|
+
of whom a Contribution has been received by Licensor and subsequently
|
59
|
+
incorporated within the Work.
|
60
|
+
|
61
|
+
2. Grant of Copyright License.
|
62
|
+
|
63
|
+
Subject to the terms and conditions of this License, each Contributor hereby
|
64
|
+
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
|
65
|
+
irrevocable copyright license to reproduce, prepare Derivative Works of,
|
66
|
+
publicly display, publicly perform, sublicense, and distribute the Work and such
|
67
|
+
Derivative Works in Source or Object form.
|
68
|
+
|
69
|
+
3. Grant of Patent License.
|
70
|
+
|
71
|
+
Subject to the terms and conditions of this License, each Contributor hereby
|
72
|
+
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
|
73
|
+
irrevocable (except as stated in this section) patent license to make, have
|
74
|
+
made, use, offer to sell, sell, import, and otherwise transfer the Work, where
|
75
|
+
such license applies only to those patent claims licensable by such Contributor
|
76
|
+
that are necessarily infringed by their Contribution(s) alone or by combination
|
77
|
+
of their Contribution(s) with the Work to which such Contribution(s) was
|
78
|
+
submitted. If You institute patent litigation against any entity (including a
|
79
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work or a
|
80
|
+
Contribution incorporated within the Work constitutes direct or contributory
|
81
|
+
patent infringement, then any patent licenses granted to You under this License
|
82
|
+
for that Work shall terminate as of the date such litigation is filed.
|
83
|
+
|
84
|
+
4. Redistribution.
|
85
|
+
|
86
|
+
You may reproduce and distribute copies of the Work or Derivative Works thereof
|
87
|
+
in any medium, with or without modifications, and in Source or Object form,
|
88
|
+
provided that You meet the following conditions:
|
89
|
+
|
90
|
+
You must give any other recipients of the Work or Derivative Works a copy of
|
91
|
+
this License; and
|
92
|
+
You must cause any modified files to carry prominent notices stating that You
|
93
|
+
changed the files; and
|
94
|
+
You must retain, in the Source form of any Derivative Works that You distribute,
|
95
|
+
all copyright, patent, trademark, and attribution notices from the Source form
|
96
|
+
of the Work, excluding those notices that do not pertain to any part of the
|
97
|
+
Derivative Works; and
|
98
|
+
If the Work includes a "NOTICE" text file as part of its distribution, then any
|
99
|
+
Derivative Works that You distribute must include a readable copy of the
|
100
|
+
attribution notices contained within such NOTICE file, excluding those notices
|
101
|
+
that do not pertain to any part of the Derivative Works, in at least one of the
|
102
|
+
following places: within a NOTICE text file distributed as part of the
|
103
|
+
Derivative Works; within the Source form or documentation, if provided along
|
104
|
+
with the Derivative Works; or, within a display generated by the Derivative
|
105
|
+
Works, if and wherever such third-party notices normally appear. The contents of
|
106
|
+
the NOTICE file are for informational purposes only and do not modify the
|
107
|
+
License. You may add Your own attribution notices within Derivative Works that
|
108
|
+
You distribute, alongside or as an addendum to the NOTICE text from the Work,
|
109
|
+
provided that such additional attribution notices cannot be construed as
|
110
|
+
modifying the License.
|
111
|
+
You may add Your own copyright statement to Your modifications and may provide
|
112
|
+
additional or different license terms and conditions for use, reproduction, or
|
113
|
+
distribution of Your modifications, or for any such Derivative Works as a whole,
|
114
|
+
provided Your use, reproduction, and distribution of the Work otherwise complies
|
115
|
+
with the conditions stated in this License.
|
116
|
+
|
117
|
+
5. Submission of Contributions.
|
118
|
+
|
119
|
+
Unless You explicitly state otherwise, any Contribution intentionally submitted
|
120
|
+
for inclusion in the Work by You to the Licensor shall be under the terms and
|
121
|
+
conditions of this License, without any additional terms or conditions.
|
122
|
+
Notwithstanding the above, nothing herein shall supersede or modify the terms of
|
123
|
+
any separate license agreement you may have executed with Licensor regarding
|
124
|
+
such Contributions.
|
125
|
+
|
126
|
+
6. Trademarks.
|
127
|
+
|
128
|
+
This License does not grant permission to use the trade names, trademarks,
|
129
|
+
service marks, or product names of the Licensor, except as required for
|
130
|
+
reasonable and customary use in describing the origin of the Work and
|
131
|
+
reproducing the content of the NOTICE file.
|
132
|
+
|
133
|
+
7. Disclaimer of Warranty.
|
134
|
+
|
135
|
+
Unless required by applicable law or agreed to in writing, Licensor provides the
|
136
|
+
Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
|
137
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
|
138
|
+
including, without limitation, any warranties or conditions of TITLE,
|
139
|
+
NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
|
140
|
+
solely responsible for determining the appropriateness of using or
|
141
|
+
redistributing the Work and assume any risks associated with Your exercise of
|
142
|
+
permissions under this License.
|
143
|
+
|
144
|
+
8. Limitation of Liability.
|
145
|
+
|
146
|
+
In no event and under no legal theory, whether in tort (including negligence),
|
147
|
+
contract, or otherwise, unless required by applicable law (such as deliberate
|
148
|
+
and grossly negligent acts) or agreed to in writing, shall any Contributor be
|
149
|
+
liable to You for damages, including any direct, indirect, special, incidental,
|
150
|
+
or consequential damages of any character arising as a result of this License or
|
151
|
+
out of the use or inability to use the Work (including but not limited to
|
152
|
+
damages for loss of goodwill, work stoppage, computer failure or malfunction, or
|
153
|
+
any and all other commercial damages or losses), even if such Contributor has
|
154
|
+
been advised of the possibility of such damages.
|
155
|
+
|
156
|
+
9. Accepting Warranty or Additional Liability.
|
157
|
+
|
158
|
+
While redistributing the Work or Derivative Works thereof, You may choose to
|
159
|
+
offer, and charge a fee for, acceptance of support, warranty, indemnity, or
|
160
|
+
other liability obligations and/or rights consistent with this License. However,
|
161
|
+
in accepting such obligations, You may act only on Your own behalf and on Your
|
162
|
+
sole responsibility, not on behalf of any other Contributor, and only if You
|
163
|
+
agree to indemnify, defend, and hold each Contributor harmless for any liability
|
164
|
+
incurred by, or claims asserted against, such Contributor by reason of your
|
165
|
+
accepting any such warranty or additional liability.
|
166
|
+
|
167
|
+
END OF TERMS AND CONDITIONS
|
168
|
+
|
169
|
+
APPENDIX: How to apply the Apache License to your work
|
170
|
+
|
171
|
+
To apply the Apache License to your work, attach the following boilerplate
|
172
|
+
notice, with the fields enclosed by brackets "[]" replaced with your own
|
173
|
+
identifying information. (Don't include the brackets!) The text should be
|
174
|
+
enclosed in the appropriate comment syntax for the file format. We also
|
175
|
+
recommend that a file or class name and description of purpose be included on
|
176
|
+
the same "printed page" as the copyright notice for easier identification within
|
177
|
+
third-party archives.
|
178
|
+
|
179
|
+
Copyright [yyyy] [name of copyright owner]
|
180
|
+
|
181
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
182
|
+
you may not use this file except in compliance with the License.
|
183
|
+
You may obtain a copy of the License at
|
184
|
+
|
185
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
186
|
+
|
187
|
+
Unless required by applicable law or agreed to in writing, software
|
188
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
189
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
190
|
+
See the License for the specific language governing permissions and
|
191
|
+
limitations under the License.
|
package/README.md
ADDED
@@ -0,0 +1,118 @@
|
|
1
|
+
# sharp
|
2
|
+
|
3
|
+
<img src="https://cdn.jsdelivr.net/gh/lovell/sharp@main/docs/image/sharp-logo.svg" width="160" height="160" alt="sharp logo" align="right">
|
4
|
+
|
5
|
+
The typical use case for this high speed Node-API module
|
6
|
+
is to convert large images in common formats to
|
7
|
+
smaller, web-friendly JPEG, PNG, WebP, GIF and AVIF images of varying dimensions.
|
8
|
+
|
9
|
+
It can be used with all JavaScript runtimes
|
10
|
+
that provide support for Node-API v9, including
|
11
|
+
Node.js (^18.17.0 or >= 20.3.0), Deno and Bun.
|
12
|
+
|
13
|
+
Resizing an image is typically 4x-5x faster than using the
|
14
|
+
quickest ImageMagick and GraphicsMagick settings
|
15
|
+
due to its use of [libvips](https://github.com/libvips/libvips).
|
16
|
+
|
17
|
+
Colour spaces, embedded ICC profiles and alpha transparency channels are all handled correctly.
|
18
|
+
Lanczos resampling ensures quality is not sacrificed for speed.
|
19
|
+
|
20
|
+
As well as image resizing, operations such as
|
21
|
+
rotation, extraction, compositing and gamma correction are available.
|
22
|
+
|
23
|
+
Most modern macOS, Windows and Linux systems
|
24
|
+
do not require any additional install or runtime dependencies.
|
25
|
+
|
26
|
+
## Documentation
|
27
|
+
|
28
|
+
Visit [sharp.pixelplumbing.com](https://sharp.pixelplumbing.com/) for complete
|
29
|
+
[installation instructions](https://sharp.pixelplumbing.com/install),
|
30
|
+
[API documentation](https://sharp.pixelplumbing.com/api-constructor),
|
31
|
+
[benchmark tests](https://sharp.pixelplumbing.com/performance) and
|
32
|
+
[changelog](https://sharp.pixelplumbing.com/changelog).
|
33
|
+
|
34
|
+
## Examples
|
35
|
+
|
36
|
+
```sh
|
37
|
+
npm install sharp
|
38
|
+
```
|
39
|
+
|
40
|
+
```javascript
|
41
|
+
const sharp = require('sharp');
|
42
|
+
```
|
43
|
+
|
44
|
+
### Callback
|
45
|
+
|
46
|
+
```javascript
|
47
|
+
sharp(inputBuffer)
|
48
|
+
.resize(320, 240)
|
49
|
+
.toFile('output.webp', (err, info) => { ... });
|
50
|
+
```
|
51
|
+
|
52
|
+
### Promise
|
53
|
+
|
54
|
+
```javascript
|
55
|
+
sharp('input.jpg')
|
56
|
+
.rotate()
|
57
|
+
.resize(200)
|
58
|
+
.jpeg({ mozjpeg: true })
|
59
|
+
.toBuffer()
|
60
|
+
.then( data => { ... })
|
61
|
+
.catch( err => { ... });
|
62
|
+
```
|
63
|
+
|
64
|
+
### Async/await
|
65
|
+
|
66
|
+
```javascript
|
67
|
+
const semiTransparentRedPng = await sharp({
|
68
|
+
create: {
|
69
|
+
width: 48,
|
70
|
+
height: 48,
|
71
|
+
channels: 4,
|
72
|
+
background: { r: 255, g: 0, b: 0, alpha: 0.5 }
|
73
|
+
}
|
74
|
+
})
|
75
|
+
.png()
|
76
|
+
.toBuffer();
|
77
|
+
```
|
78
|
+
|
79
|
+
### Stream
|
80
|
+
|
81
|
+
```javascript
|
82
|
+
const roundedCorners = Buffer.from(
|
83
|
+
'<svg><rect x="0" y="0" width="200" height="200" rx="50" ry="50"/></svg>'
|
84
|
+
);
|
85
|
+
|
86
|
+
const roundedCornerResizer =
|
87
|
+
sharp()
|
88
|
+
.resize(200, 200)
|
89
|
+
.composite([{
|
90
|
+
input: roundedCorners,
|
91
|
+
blend: 'dest-in'
|
92
|
+
}])
|
93
|
+
.png();
|
94
|
+
|
95
|
+
readableStream
|
96
|
+
.pipe(roundedCornerResizer)
|
97
|
+
.pipe(writableStream);
|
98
|
+
```
|
99
|
+
|
100
|
+
## Contributing
|
101
|
+
|
102
|
+
A [guide for contributors](https://github.com/lovell/sharp/blob/main/.github/CONTRIBUTING.md)
|
103
|
+
covers reporting bugs, requesting features and submitting code changes.
|
104
|
+
|
105
|
+
## Licensing
|
106
|
+
|
107
|
+
Copyright 2013 Lovell Fuller and others.
|
108
|
+
|
109
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
110
|
+
you may not use this file except in compliance with the License.
|
111
|
+
You may obtain a copy of the License at
|
112
|
+
[https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)
|
113
|
+
|
114
|
+
Unless required by applicable law or agreed to in writing, software
|
115
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
116
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
117
|
+
See the License for the specific language governing permissions and
|
118
|
+
limitations under the License.
|
package/install/check.js
ADDED
@@ -0,0 +1,41 @@
|
|
1
|
+
// Copyright 2013 Lovell Fuller and others.
|
2
|
+
// SPDX-License-Identifier: Apache-2.0
|
3
|
+
|
4
|
+
'use strict';
|
5
|
+
|
6
|
+
try {
|
7
|
+
const { useGlobalLibvips, globalLibvipsVersion, log, spawnRebuild } = require('../lib/libvips');
|
8
|
+
|
9
|
+
const buildFromSource = (msg) => {
|
10
|
+
log(msg);
|
11
|
+
log('Attempting to build from source via node-gyp');
|
12
|
+
try {
|
13
|
+
require('node-addon-api');
|
14
|
+
log('Found node-addon-api');
|
15
|
+
} catch (err) {
|
16
|
+
log('Please add node-addon-api to your dependencies');
|
17
|
+
return;
|
18
|
+
}
|
19
|
+
try {
|
20
|
+
const gyp = require('node-gyp');
|
21
|
+
log(`Found node-gyp version ${gyp().version}`);
|
22
|
+
} catch (err) {
|
23
|
+
log('Please add node-gyp to your dependencies');
|
24
|
+
return;
|
25
|
+
}
|
26
|
+
log('See https://sharp.pixelplumbing.com/install#building-from-source');
|
27
|
+
const status = spawnRebuild();
|
28
|
+
if (status !== 0) {
|
29
|
+
process.exit(status);
|
30
|
+
}
|
31
|
+
};
|
32
|
+
|
33
|
+
if (useGlobalLibvips()) {
|
34
|
+
buildFromSource(`Detected globally-installed libvips v${globalLibvipsVersion()}`);
|
35
|
+
} else if (process.env.npm_config_build_from_source) {
|
36
|
+
buildFromSource('Detected --build-from-source flag');
|
37
|
+
}
|
38
|
+
} catch (err) {
|
39
|
+
const summary = err.message.split(/\n/).slice(0, 1);
|
40
|
+
console.log(`sharp: skipping install check: ${summary}`);
|
41
|
+
}
|
package/lib/channel.js
ADDED
@@ -0,0 +1,174 @@
|
|
1
|
+
// Copyright 2013 Lovell Fuller and others.
|
2
|
+
// SPDX-License-Identifier: Apache-2.0
|
3
|
+
|
4
|
+
'use strict';
|
5
|
+
|
6
|
+
const is = require('./is');
|
7
|
+
|
8
|
+
/**
|
9
|
+
* Boolean operations for bandbool.
|
10
|
+
* @private
|
11
|
+
*/
|
12
|
+
const bool = {
|
13
|
+
and: 'and',
|
14
|
+
or: 'or',
|
15
|
+
eor: 'eor'
|
16
|
+
};
|
17
|
+
|
18
|
+
/**
|
19
|
+
* Remove alpha channel, if any. This is a no-op if the image does not have an alpha channel.
|
20
|
+
*
|
21
|
+
* See also {@link /api-operation#flatten|flatten}.
|
22
|
+
*
|
23
|
+
* @example
|
24
|
+
* sharp('rgba.png')
|
25
|
+
* .removeAlpha()
|
26
|
+
* .toFile('rgb.png', function(err, info) {
|
27
|
+
* // rgb.png is a 3 channel image without an alpha channel
|
28
|
+
* });
|
29
|
+
*
|
30
|
+
* @returns {Sharp}
|
31
|
+
*/
|
32
|
+
function removeAlpha () {
|
33
|
+
this.options.removeAlpha = true;
|
34
|
+
return this;
|
35
|
+
}
|
36
|
+
|
37
|
+
/**
|
38
|
+
* Ensure the output image has an alpha transparency channel.
|
39
|
+
* If missing, the added alpha channel will have the specified
|
40
|
+
* transparency level, defaulting to fully-opaque (1).
|
41
|
+
* This is a no-op if the image already has an alpha channel.
|
42
|
+
*
|
43
|
+
* @since 0.21.2
|
44
|
+
*
|
45
|
+
* @example
|
46
|
+
* // rgba.png will be a 4 channel image with a fully-opaque alpha channel
|
47
|
+
* await sharp('rgb.jpg')
|
48
|
+
* .ensureAlpha()
|
49
|
+
* .toFile('rgba.png')
|
50
|
+
*
|
51
|
+
* @example
|
52
|
+
* // rgba is a 4 channel image with a fully-transparent alpha channel
|
53
|
+
* const rgba = await sharp(rgb)
|
54
|
+
* .ensureAlpha(0)
|
55
|
+
* .toBuffer();
|
56
|
+
*
|
57
|
+
* @param {number} [alpha=1] - alpha transparency level (0=fully-transparent, 1=fully-opaque)
|
58
|
+
* @returns {Sharp}
|
59
|
+
* @throws {Error} Invalid alpha transparency level
|
60
|
+
*/
|
61
|
+
function ensureAlpha (alpha) {
|
62
|
+
if (is.defined(alpha)) {
|
63
|
+
if (is.number(alpha) && is.inRange(alpha, 0, 1)) {
|
64
|
+
this.options.ensureAlpha = alpha;
|
65
|
+
} else {
|
66
|
+
throw is.invalidParameterError('alpha', 'number between 0 and 1', alpha);
|
67
|
+
}
|
68
|
+
} else {
|
69
|
+
this.options.ensureAlpha = 1;
|
70
|
+
}
|
71
|
+
return this;
|
72
|
+
}
|
73
|
+
|
74
|
+
/**
|
75
|
+
* Extract a single channel from a multi-channel image.
|
76
|
+
*
|
77
|
+
* @example
|
78
|
+
* // green.jpg is a greyscale image containing the green channel of the input
|
79
|
+
* await sharp(input)
|
80
|
+
* .extractChannel('green')
|
81
|
+
* .toFile('green.jpg');
|
82
|
+
*
|
83
|
+
* @example
|
84
|
+
* // red1 is the red value of the first pixel, red2 the second pixel etc.
|
85
|
+
* const [red1, red2, ...] = await sharp(input)
|
86
|
+
* .extractChannel(0)
|
87
|
+
* .raw()
|
88
|
+
* .toBuffer();
|
89
|
+
*
|
90
|
+
* @param {number|string} channel - zero-indexed channel/band number to extract, or `red`, `green`, `blue` or `alpha`.
|
91
|
+
* @returns {Sharp}
|
92
|
+
* @throws {Error} Invalid channel
|
93
|
+
*/
|
94
|
+
function extractChannel (channel) {
|
95
|
+
const channelMap = { red: 0, green: 1, blue: 2, alpha: 3 };
|
96
|
+
if (Object.keys(channelMap).includes(channel)) {
|
97
|
+
channel = channelMap[channel];
|
98
|
+
}
|
99
|
+
if (is.integer(channel) && is.inRange(channel, 0, 4)) {
|
100
|
+
this.options.extractChannel = channel;
|
101
|
+
} else {
|
102
|
+
throw is.invalidParameterError('channel', 'integer or one of: red, green, blue, alpha', channel);
|
103
|
+
}
|
104
|
+
return this;
|
105
|
+
}
|
106
|
+
|
107
|
+
/**
|
108
|
+
* Join one or more channels to the image.
|
109
|
+
* The meaning of the added channels depends on the output colourspace, set with `toColourspace()`.
|
110
|
+
* By default the output image will be web-friendly sRGB, with additional channels interpreted as alpha channels.
|
111
|
+
* Channel ordering follows vips convention:
|
112
|
+
* - sRGB: 0: Red, 1: Green, 2: Blue, 3: Alpha.
|
113
|
+
* - CMYK: 0: Magenta, 1: Cyan, 2: Yellow, 3: Black, 4: Alpha.
|
114
|
+
*
|
115
|
+
* Buffers may be any of the image formats supported by sharp.
|
116
|
+
* For raw pixel input, the `options` object should contain a `raw` attribute, which follows the format of the attribute of the same name in the `sharp()` constructor.
|
117
|
+
*
|
118
|
+
* @param {Array<string|Buffer>|string|Buffer} images - one or more images (file paths, Buffers).
|
119
|
+
* @param {Object} options - image options, see `sharp()` constructor.
|
120
|
+
* @returns {Sharp}
|
121
|
+
* @throws {Error} Invalid parameters
|
122
|
+
*/
|
123
|
+
function joinChannel (images, options) {
|
124
|
+
if (Array.isArray(images)) {
|
125
|
+
images.forEach(function (image) {
|
126
|
+
this.options.joinChannelIn.push(this._createInputDescriptor(image, options));
|
127
|
+
}, this);
|
128
|
+
} else {
|
129
|
+
this.options.joinChannelIn.push(this._createInputDescriptor(images, options));
|
130
|
+
}
|
131
|
+
return this;
|
132
|
+
}
|
133
|
+
|
134
|
+
/**
|
135
|
+
* Perform a bitwise boolean operation on all input image channels (bands) to produce a single channel output image.
|
136
|
+
*
|
137
|
+
* @example
|
138
|
+
* sharp('3-channel-rgb-input.png')
|
139
|
+
* .bandbool(sharp.bool.and)
|
140
|
+
* .toFile('1-channel-output.png', function (err, info) {
|
141
|
+
* // The output will be a single channel image where each pixel `P = R & G & B`.
|
142
|
+
* // If `I(1,1) = [247, 170, 14] = [0b11110111, 0b10101010, 0b00001111]`
|
143
|
+
* // then `O(1,1) = 0b11110111 & 0b10101010 & 0b00001111 = 0b00000010 = 2`.
|
144
|
+
* });
|
145
|
+
*
|
146
|
+
* @param {string} boolOp - one of `and`, `or` or `eor` to perform that bitwise operation, like the C logic operators `&`, `|` and `^` respectively.
|
147
|
+
* @returns {Sharp}
|
148
|
+
* @throws {Error} Invalid parameters
|
149
|
+
*/
|
150
|
+
function bandbool (boolOp) {
|
151
|
+
if (is.string(boolOp) && is.inArray(boolOp, ['and', 'or', 'eor'])) {
|
152
|
+
this.options.bandBoolOp = boolOp;
|
153
|
+
} else {
|
154
|
+
throw is.invalidParameterError('boolOp', 'one of: and, or, eor', boolOp);
|
155
|
+
}
|
156
|
+
return this;
|
157
|
+
}
|
158
|
+
|
159
|
+
/**
|
160
|
+
* Decorate the Sharp prototype with channel-related functions.
|
161
|
+
* @private
|
162
|
+
*/
|
163
|
+
module.exports = function (Sharp) {
|
164
|
+
Object.assign(Sharp.prototype, {
|
165
|
+
// Public instance functions
|
166
|
+
removeAlpha,
|
167
|
+
ensureAlpha,
|
168
|
+
extractChannel,
|
169
|
+
joinChannel,
|
170
|
+
bandbool
|
171
|
+
});
|
172
|
+
// Class attributes
|
173
|
+
Sharp.bool = bool;
|
174
|
+
};
|