heif2jpeg 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +67 -0
  2. package/index.d.ts +11 -0
  3. package/index.js +315 -0
  4. package/package.json +44 -0
package/README.md ADDED
@@ -0,0 +1,67 @@
1
+ # heif2jpeg
2
+
3
+ Fast and simple HEIC/HEIF to JPEG converter for Node.js. Native performance, zero runtime dependencies.
4
+
5
+ Built with node-api.
6
+
7
+ ## Install
8
+
9
+ ```bash
10
+ npm install heif2jpeg
11
+ ```
12
+
13
+ Prebuilt binaries are provided for:
14
+
15
+ | Platform | Architecture |
16
+ |----------|-------------|
17
+ | macOS | x64, arm64 |
18
+ | Linux (glibc) | x64, arm64 |
19
+ | Linux (musl) | x64, arm64 |
20
+ | Windows | x64, arm64 |
21
+
22
+ Works with Node.js, Bun, and Deno.
23
+
24
+ ## Usage
25
+
26
+ ```js
27
+ const { heifToJpeg } = require("heif2jpeg");
28
+ const fs = require("fs");
29
+
30
+ const heic = fs.readFileSync("photo.heic");
31
+ const jpeg = await heifToJpeg(heic, { quality: 85 });
32
+ fs.writeFileSync("photo.jpg", jpeg);
33
+ ```
34
+
35
+ ## API
36
+
37
+ ### `heifToJpeg(input, options?)`
38
+
39
+ Convert a HEIF/HEIC buffer to JPEG.
40
+
41
+ - **input** `Buffer`: HEIF/HEIC file contents
42
+ - **options.quality** `number`: JPEG quality, 1-100 (default: 85)
43
+ - Returns `Promise<Buffer>`: JPEG file contents
44
+
45
+ ## How it works
46
+
47
+ All processing runs on the libuv thread pool — the main thread is never blocked.
48
+
49
+ 1. [libheif](https://github.com/strukturag/libheif) parses the HEIF container
50
+ 2. [libde265](https://github.com/strukturag/libde265) decodes the HEVC payload to raw RGB pixels
51
+ 3. [jpeg-encoder](https://crates.io/crates/jpeg-encoder) (pure Rust) encodes to JPEG
52
+
53
+ ## Building from source
54
+
55
+ Requires Rust, CMake, and a C/C++ compiler.
56
+
57
+ ```bash
58
+ git clone --recurse-submodules https://github.com/nicmus/heif2jpeg.git
59
+ cd heif2jpeg
60
+ npm install
61
+ npx napi build --platform --release
62
+ npm test
63
+ ```
64
+
65
+ ## License
66
+
67
+ MIT
package/index.d.ts ADDED
@@ -0,0 +1,11 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+
4
+ /* auto-generated by NAPI-RS */
5
+
6
+ export interface ConvertOptions {
7
+ /** JPEG quality (1-100, default 85) */
8
+ quality?: number
9
+ }
10
+ /** Convert a HEIF/HEIC buffer to JPEG. */
11
+ export declare function heifToJpeg(input: Buffer, options?: ConvertOptions | undefined | null): Promise<unknown>
package/index.js ADDED
@@ -0,0 +1,315 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /* prettier-ignore */
4
+
5
+ /* auto-generated by NAPI-RS */
6
+
7
+ const { existsSync, readFileSync } = require('fs')
8
+ const { join } = require('path')
9
+
10
+ const { platform, arch } = process
11
+
12
+ let nativeBinding = null
13
+ let localFileExisted = false
14
+ let loadError = null
15
+
16
+ function isMusl() {
17
+ // For Node 10
18
+ if (!process.report || typeof process.report.getReport !== 'function') {
19
+ try {
20
+ const lddPath = require('child_process').execSync('which ldd').toString().trim()
21
+ return readFileSync(lddPath, 'utf8').includes('musl')
22
+ } catch (e) {
23
+ return true
24
+ }
25
+ } else {
26
+ const { glibcVersionRuntime } = process.report.getReport().header
27
+ return !glibcVersionRuntime
28
+ }
29
+ }
30
+
31
+ switch (platform) {
32
+ case 'android':
33
+ switch (arch) {
34
+ case 'arm64':
35
+ localFileExisted = existsSync(join(__dirname, 'heif2jpeg.android-arm64.node'))
36
+ try {
37
+ if (localFileExisted) {
38
+ nativeBinding = require('./heif2jpeg.android-arm64.node')
39
+ } else {
40
+ nativeBinding = require('heif2jpeg-android-arm64')
41
+ }
42
+ } catch (e) {
43
+ loadError = e
44
+ }
45
+ break
46
+ case 'arm':
47
+ localFileExisted = existsSync(join(__dirname, 'heif2jpeg.android-arm-eabi.node'))
48
+ try {
49
+ if (localFileExisted) {
50
+ nativeBinding = require('./heif2jpeg.android-arm-eabi.node')
51
+ } else {
52
+ nativeBinding = require('heif2jpeg-android-arm-eabi')
53
+ }
54
+ } catch (e) {
55
+ loadError = e
56
+ }
57
+ break
58
+ default:
59
+ throw new Error(`Unsupported architecture on Android ${arch}`)
60
+ }
61
+ break
62
+ case 'win32':
63
+ switch (arch) {
64
+ case 'x64':
65
+ localFileExisted = existsSync(
66
+ join(__dirname, 'heif2jpeg.win32-x64-msvc.node')
67
+ )
68
+ try {
69
+ if (localFileExisted) {
70
+ nativeBinding = require('./heif2jpeg.win32-x64-msvc.node')
71
+ } else {
72
+ nativeBinding = require('heif2jpeg-win32-x64-msvc')
73
+ }
74
+ } catch (e) {
75
+ loadError = e
76
+ }
77
+ break
78
+ case 'ia32':
79
+ localFileExisted = existsSync(
80
+ join(__dirname, 'heif2jpeg.win32-ia32-msvc.node')
81
+ )
82
+ try {
83
+ if (localFileExisted) {
84
+ nativeBinding = require('./heif2jpeg.win32-ia32-msvc.node')
85
+ } else {
86
+ nativeBinding = require('heif2jpeg-win32-ia32-msvc')
87
+ }
88
+ } catch (e) {
89
+ loadError = e
90
+ }
91
+ break
92
+ case 'arm64':
93
+ localFileExisted = existsSync(
94
+ join(__dirname, 'heif2jpeg.win32-arm64-msvc.node')
95
+ )
96
+ try {
97
+ if (localFileExisted) {
98
+ nativeBinding = require('./heif2jpeg.win32-arm64-msvc.node')
99
+ } else {
100
+ nativeBinding = require('heif2jpeg-win32-arm64-msvc')
101
+ }
102
+ } catch (e) {
103
+ loadError = e
104
+ }
105
+ break
106
+ default:
107
+ throw new Error(`Unsupported architecture on Windows: ${arch}`)
108
+ }
109
+ break
110
+ case 'darwin':
111
+ localFileExisted = existsSync(join(__dirname, 'heif2jpeg.darwin-universal.node'))
112
+ try {
113
+ if (localFileExisted) {
114
+ nativeBinding = require('./heif2jpeg.darwin-universal.node')
115
+ } else {
116
+ nativeBinding = require('heif2jpeg-darwin-universal')
117
+ }
118
+ break
119
+ } catch {}
120
+ switch (arch) {
121
+ case 'x64':
122
+ localFileExisted = existsSync(join(__dirname, 'heif2jpeg.darwin-x64.node'))
123
+ try {
124
+ if (localFileExisted) {
125
+ nativeBinding = require('./heif2jpeg.darwin-x64.node')
126
+ } else {
127
+ nativeBinding = require('heif2jpeg-darwin-x64')
128
+ }
129
+ } catch (e) {
130
+ loadError = e
131
+ }
132
+ break
133
+ case 'arm64':
134
+ localFileExisted = existsSync(
135
+ join(__dirname, 'heif2jpeg.darwin-arm64.node')
136
+ )
137
+ try {
138
+ if (localFileExisted) {
139
+ nativeBinding = require('./heif2jpeg.darwin-arm64.node')
140
+ } else {
141
+ nativeBinding = require('heif2jpeg-darwin-arm64')
142
+ }
143
+ } catch (e) {
144
+ loadError = e
145
+ }
146
+ break
147
+ default:
148
+ throw new Error(`Unsupported architecture on macOS: ${arch}`)
149
+ }
150
+ break
151
+ case 'freebsd':
152
+ if (arch !== 'x64') {
153
+ throw new Error(`Unsupported architecture on FreeBSD: ${arch}`)
154
+ }
155
+ localFileExisted = existsSync(join(__dirname, 'heif2jpeg.freebsd-x64.node'))
156
+ try {
157
+ if (localFileExisted) {
158
+ nativeBinding = require('./heif2jpeg.freebsd-x64.node')
159
+ } else {
160
+ nativeBinding = require('heif2jpeg-freebsd-x64')
161
+ }
162
+ } catch (e) {
163
+ loadError = e
164
+ }
165
+ break
166
+ case 'linux':
167
+ switch (arch) {
168
+ case 'x64':
169
+ if (isMusl()) {
170
+ localFileExisted = existsSync(
171
+ join(__dirname, 'heif2jpeg.linux-x64-musl.node')
172
+ )
173
+ try {
174
+ if (localFileExisted) {
175
+ nativeBinding = require('./heif2jpeg.linux-x64-musl.node')
176
+ } else {
177
+ nativeBinding = require('heif2jpeg-linux-x64-musl')
178
+ }
179
+ } catch (e) {
180
+ loadError = e
181
+ }
182
+ } else {
183
+ localFileExisted = existsSync(
184
+ join(__dirname, 'heif2jpeg.linux-x64-gnu.node')
185
+ )
186
+ try {
187
+ if (localFileExisted) {
188
+ nativeBinding = require('./heif2jpeg.linux-x64-gnu.node')
189
+ } else {
190
+ nativeBinding = require('heif2jpeg-linux-x64-gnu')
191
+ }
192
+ } catch (e) {
193
+ loadError = e
194
+ }
195
+ }
196
+ break
197
+ case 'arm64':
198
+ if (isMusl()) {
199
+ localFileExisted = existsSync(
200
+ join(__dirname, 'heif2jpeg.linux-arm64-musl.node')
201
+ )
202
+ try {
203
+ if (localFileExisted) {
204
+ nativeBinding = require('./heif2jpeg.linux-arm64-musl.node')
205
+ } else {
206
+ nativeBinding = require('heif2jpeg-linux-arm64-musl')
207
+ }
208
+ } catch (e) {
209
+ loadError = e
210
+ }
211
+ } else {
212
+ localFileExisted = existsSync(
213
+ join(__dirname, 'heif2jpeg.linux-arm64-gnu.node')
214
+ )
215
+ try {
216
+ if (localFileExisted) {
217
+ nativeBinding = require('./heif2jpeg.linux-arm64-gnu.node')
218
+ } else {
219
+ nativeBinding = require('heif2jpeg-linux-arm64-gnu')
220
+ }
221
+ } catch (e) {
222
+ loadError = e
223
+ }
224
+ }
225
+ break
226
+ case 'arm':
227
+ if (isMusl()) {
228
+ localFileExisted = existsSync(
229
+ join(__dirname, 'heif2jpeg.linux-arm-musleabihf.node')
230
+ )
231
+ try {
232
+ if (localFileExisted) {
233
+ nativeBinding = require('./heif2jpeg.linux-arm-musleabihf.node')
234
+ } else {
235
+ nativeBinding = require('heif2jpeg-linux-arm-musleabihf')
236
+ }
237
+ } catch (e) {
238
+ loadError = e
239
+ }
240
+ } else {
241
+ localFileExisted = existsSync(
242
+ join(__dirname, 'heif2jpeg.linux-arm-gnueabihf.node')
243
+ )
244
+ try {
245
+ if (localFileExisted) {
246
+ nativeBinding = require('./heif2jpeg.linux-arm-gnueabihf.node')
247
+ } else {
248
+ nativeBinding = require('heif2jpeg-linux-arm-gnueabihf')
249
+ }
250
+ } catch (e) {
251
+ loadError = e
252
+ }
253
+ }
254
+ break
255
+ case 'riscv64':
256
+ if (isMusl()) {
257
+ localFileExisted = existsSync(
258
+ join(__dirname, 'heif2jpeg.linux-riscv64-musl.node')
259
+ )
260
+ try {
261
+ if (localFileExisted) {
262
+ nativeBinding = require('./heif2jpeg.linux-riscv64-musl.node')
263
+ } else {
264
+ nativeBinding = require('heif2jpeg-linux-riscv64-musl')
265
+ }
266
+ } catch (e) {
267
+ loadError = e
268
+ }
269
+ } else {
270
+ localFileExisted = existsSync(
271
+ join(__dirname, 'heif2jpeg.linux-riscv64-gnu.node')
272
+ )
273
+ try {
274
+ if (localFileExisted) {
275
+ nativeBinding = require('./heif2jpeg.linux-riscv64-gnu.node')
276
+ } else {
277
+ nativeBinding = require('heif2jpeg-linux-riscv64-gnu')
278
+ }
279
+ } catch (e) {
280
+ loadError = e
281
+ }
282
+ }
283
+ break
284
+ case 's390x':
285
+ localFileExisted = existsSync(
286
+ join(__dirname, 'heif2jpeg.linux-s390x-gnu.node')
287
+ )
288
+ try {
289
+ if (localFileExisted) {
290
+ nativeBinding = require('./heif2jpeg.linux-s390x-gnu.node')
291
+ } else {
292
+ nativeBinding = require('heif2jpeg-linux-s390x-gnu')
293
+ }
294
+ } catch (e) {
295
+ loadError = e
296
+ }
297
+ break
298
+ default:
299
+ throw new Error(`Unsupported architecture on Linux: ${arch}`)
300
+ }
301
+ break
302
+ default:
303
+ throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
304
+ }
305
+
306
+ if (!nativeBinding) {
307
+ if (loadError) {
308
+ throw loadError
309
+ }
310
+ throw new Error(`Failed to load native binding`)
311
+ }
312
+
313
+ const { heifToJpeg } = nativeBinding
314
+
315
+ module.exports.heifToJpeg = heifToJpeg
package/package.json ADDED
@@ -0,0 +1,44 @@
1
+ {
2
+ "name": "heif2jpeg",
3
+ "version": "0.1.1",
4
+ "description": "Fast HEIC/HEIF to JPEG converter — native, zero runtime dependencies",
5
+ "type": "commonjs",
6
+ "main": "index.js",
7
+ "types": "index.d.ts",
8
+ "files": [
9
+ "index.js",
10
+ "index.d.ts"
11
+ ],
12
+ "napi": {
13
+ "name": "heif2jpeg",
14
+ "triples": {
15
+ "defaults": true,
16
+ "additional": [
17
+ "aarch64-apple-darwin",
18
+ "aarch64-unknown-linux-gnu"
19
+ ]
20
+ }
21
+ },
22
+ "scripts": {
23
+ "artifacts": "napi artifacts",
24
+ "build": "napi build --platform --release",
25
+ "build:debug": "napi build --platform",
26
+ "prepublishOnly": "napi prepublish -t npm",
27
+ "test": "node --test test/test.mjs",
28
+ "version": "napi version"
29
+ },
30
+ "devDependencies": {
31
+ "@napi-rs/cli": "^2"
32
+ },
33
+ "license": "MIT",
34
+ "engines": {
35
+ "node": ">= 18"
36
+ },
37
+ "optionalDependencies": {
38
+ "heif2jpeg-win32-x64-msvc": "0.1.1",
39
+ "heif2jpeg-darwin-x64": "0.1.1",
40
+ "heif2jpeg-linux-x64-gnu": "0.1.1",
41
+ "heif2jpeg-darwin-arm64": "0.1.1",
42
+ "heif2jpeg-linux-arm64-gnu": "0.1.1"
43
+ }
44
+ }