buttercap 0.1.0

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.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Eduardo
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,40 @@
1
+ # buttercap
2
+
3
+ Discord-quality screen capture for Node.js. Native Rust addon via napi-rs.
4
+
5
+ - Windows.Graphics.Capture for window capture
6
+ - DXGI Desktop Duplication for display capture
7
+ - WASAPI process loopback for per-app audio
8
+ - Media Foundation hardware H.264 encoding (NVENC/AMF/QSV)
9
+ - Zero-copy GPU pipeline
10
+
11
+ ## Install
12
+
13
+ ```bash
14
+ npm install buttercap
15
+ ```
16
+
17
+ ## Usage
18
+
19
+ ```typescript
20
+ import { createSession, listDisplays } from 'buttercap';
21
+
22
+ const displays = listDisplays();
23
+ const primary = displays.find(d => d.primary);
24
+
25
+ const session = createSession({
26
+ target: { type: 'display', id: primary.id },
27
+ video: { fps: 60, codec: 'h264', bitrate: 8_000_000 },
28
+ cursor: true,
29
+ });
30
+
31
+ session.on('video-packet', (packet) => {
32
+ // H.264 NAL units ready for WebRTC or muxing
33
+ });
34
+
35
+ await session.start();
36
+ ```
37
+
38
+ ## License
39
+
40
+ MIT
package/index.d.ts ADDED
@@ -0,0 +1,102 @@
1
+ /* auto-generated by NAPI-RS */
2
+ /* eslint-disable */
3
+ export declare class AudioCaptureHandle {
4
+ stop(): void
5
+ }
6
+
7
+ export declare class CaptureSession {
8
+ constructor(config: SessionConfig)
9
+ onVideoPacket(callback: (err: null, packet: VideoPacket) => void): void
10
+ onAudioPacket(callback: (err: null, packet: AudioPacket) => void): void
11
+ onError(callback: (err: null, message: string) => void): void
12
+ onStopped(callback: (err: null) => void): void
13
+ start(): void
14
+ stop(): void
15
+ pause(): void
16
+ resume(): void
17
+ }
18
+
19
+ export declare class RawCaptureHandle {
20
+ stop(): void
21
+ }
22
+
23
+ export interface AudioPacket {
24
+ data: Buffer
25
+ timestampUs: number
26
+ samples: number
27
+ }
28
+
29
+ export interface AudioPacketJs {
30
+ data: Buffer
31
+ samples: number
32
+ }
33
+
34
+ export interface DisplayInfo {
35
+ id: number
36
+ name: string
37
+ width: number
38
+ height: number
39
+ primary: boolean
40
+ }
41
+
42
+ export interface EncoderConfig {
43
+ width: number
44
+ height: number
45
+ fps: number
46
+ bitrate: number
47
+ codec: string
48
+ preferHardware: boolean
49
+ }
50
+
51
+ export interface EncoderInfoJs {
52
+ name: string
53
+ hardware: boolean
54
+ }
55
+
56
+ export interface FrameData {
57
+ width: number
58
+ height: number
59
+ buffer: Buffer
60
+ timestampMs: number
61
+ }
62
+
63
+ export declare function getEncoderInfo(): Array<EncoderInfoJs>
64
+
65
+ export declare function listDisplays(): Array<DisplayInfo>
66
+
67
+ export declare function listWindows(): Array<WindowInfo>
68
+
69
+ export interface SessionConfig {
70
+ /** "window" or "display" */
71
+ targetType: string
72
+ /** hwnd for window, monitor index for display */
73
+ targetId: number
74
+ fps?: number
75
+ codec?: string
76
+ preferHardware?: boolean
77
+ bitrate?: number
78
+ captureCursor?: boolean
79
+ /** "none", "system", or "process" */
80
+ audioMode?: string
81
+ /** PID for process audio capture */
82
+ audioProcessId?: number
83
+ }
84
+
85
+ export declare function startRawCapture(hwnd: number, onFrame: (err: null, frame: FrameData) => void): RawCaptureHandle
86
+
87
+ export declare function startSystemAudioCapture(onAudio: (err: null, packet: AudioPacketJs) => void): AudioCaptureHandle
88
+
89
+ export declare function version(): string
90
+
91
+ export interface VideoPacket {
92
+ data: Buffer
93
+ timestampUs: number
94
+ keyframe: boolean
95
+ }
96
+
97
+ export interface WindowInfo {
98
+ hwnd: number
99
+ title: string
100
+ pid: number
101
+ exe: string
102
+ }
package/index.js ADDED
@@ -0,0 +1,587 @@
1
+ // prettier-ignore
2
+ /* eslint-disable */
3
+ // @ts-nocheck
4
+ /* auto-generated by NAPI-RS */
5
+
6
+ const { readFileSync } = require('node:fs')
7
+ let nativeBinding = null
8
+ const loadErrors = []
9
+
10
+ const isMusl = () => {
11
+ let musl = false
12
+ if (process.platform === 'linux') {
13
+ musl = isMuslFromFilesystem()
14
+ if (musl === null) {
15
+ musl = isMuslFromReport()
16
+ }
17
+ if (musl === null) {
18
+ musl = isMuslFromChildProcess()
19
+ }
20
+ }
21
+ return musl
22
+ }
23
+
24
+ const isFileMusl = (f) => f.includes('libc.musl-') || f.includes('ld-musl-')
25
+
26
+ const isMuslFromFilesystem = () => {
27
+ try {
28
+ return readFileSync('/usr/bin/ldd', 'utf-8').includes('musl')
29
+ } catch {
30
+ return null
31
+ }
32
+ }
33
+
34
+ const isMuslFromReport = () => {
35
+ let report = null
36
+ if (typeof process.report?.getReport === 'function') {
37
+ process.report.excludeNetwork = true
38
+ report = process.report.getReport()
39
+ }
40
+ if (!report) {
41
+ return null
42
+ }
43
+ if (report.header && report.header.glibcVersionRuntime) {
44
+ return false
45
+ }
46
+ if (Array.isArray(report.sharedObjects)) {
47
+ if (report.sharedObjects.some(isFileMusl)) {
48
+ return true
49
+ }
50
+ }
51
+ return false
52
+ }
53
+
54
+ const isMuslFromChildProcess = () => {
55
+ try {
56
+ return require('child_process').execSync('ldd --version', { encoding: 'utf8' }).includes('musl')
57
+ } catch (e) {
58
+ // If we reach this case, we don't know if the system is musl or not, so is better to just fallback to false
59
+ return false
60
+ }
61
+ }
62
+
63
+ function requireNative() {
64
+ if (process.env.NAPI_RS_NATIVE_LIBRARY_PATH) {
65
+ try {
66
+ return require(process.env.NAPI_RS_NATIVE_LIBRARY_PATH);
67
+ } catch (err) {
68
+ loadErrors.push(err)
69
+ }
70
+ } else if (process.platform === 'android') {
71
+ if (process.arch === 'arm64') {
72
+ try {
73
+ return require('./buttercap.android-arm64.node')
74
+ } catch (e) {
75
+ loadErrors.push(e)
76
+ }
77
+ try {
78
+ const binding = require('buttercap-android-arm64')
79
+ const bindingPackageVersion = require('buttercap-android-arm64/package.json').version
80
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
81
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
82
+ }
83
+ return binding
84
+ } catch (e) {
85
+ loadErrors.push(e)
86
+ }
87
+ } else if (process.arch === 'arm') {
88
+ try {
89
+ return require('./buttercap.android-arm-eabi.node')
90
+ } catch (e) {
91
+ loadErrors.push(e)
92
+ }
93
+ try {
94
+ const binding = require('buttercap-android-arm-eabi')
95
+ const bindingPackageVersion = require('buttercap-android-arm-eabi/package.json').version
96
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
97
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
98
+ }
99
+ return binding
100
+ } catch (e) {
101
+ loadErrors.push(e)
102
+ }
103
+ } else {
104
+ loadErrors.push(new Error(`Unsupported architecture on Android ${process.arch}`))
105
+ }
106
+ } else if (process.platform === 'win32') {
107
+ if (process.arch === 'x64') {
108
+ if (process.config?.variables?.shlib_suffix === 'dll.a' || process.config?.variables?.node_target_type === 'shared_library') {
109
+ try {
110
+ return require('./buttercap.win32-x64-gnu.node')
111
+ } catch (e) {
112
+ loadErrors.push(e)
113
+ }
114
+ try {
115
+ const binding = require('buttercap-win32-x64-gnu')
116
+ const bindingPackageVersion = require('buttercap-win32-x64-gnu/package.json').version
117
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
118
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
119
+ }
120
+ return binding
121
+ } catch (e) {
122
+ loadErrors.push(e)
123
+ }
124
+ } else {
125
+ try {
126
+ return require('./buttercap.win32-x64-msvc.node')
127
+ } catch (e) {
128
+ loadErrors.push(e)
129
+ }
130
+ try {
131
+ const binding = require('buttercap-win32-x64-msvc')
132
+ const bindingPackageVersion = require('buttercap-win32-x64-msvc/package.json').version
133
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
134
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
135
+ }
136
+ return binding
137
+ } catch (e) {
138
+ loadErrors.push(e)
139
+ }
140
+ }
141
+ } else if (process.arch === 'ia32') {
142
+ try {
143
+ return require('./buttercap.win32-ia32-msvc.node')
144
+ } catch (e) {
145
+ loadErrors.push(e)
146
+ }
147
+ try {
148
+ const binding = require('buttercap-win32-ia32-msvc')
149
+ const bindingPackageVersion = require('buttercap-win32-ia32-msvc/package.json').version
150
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
151
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
152
+ }
153
+ return binding
154
+ } catch (e) {
155
+ loadErrors.push(e)
156
+ }
157
+ } else if (process.arch === 'arm64') {
158
+ try {
159
+ return require('./buttercap.win32-arm64-msvc.node')
160
+ } catch (e) {
161
+ loadErrors.push(e)
162
+ }
163
+ try {
164
+ const binding = require('buttercap-win32-arm64-msvc')
165
+ const bindingPackageVersion = require('buttercap-win32-arm64-msvc/package.json').version
166
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
167
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
168
+ }
169
+ return binding
170
+ } catch (e) {
171
+ loadErrors.push(e)
172
+ }
173
+ } else {
174
+ loadErrors.push(new Error(`Unsupported architecture on Windows: ${process.arch}`))
175
+ }
176
+ } else if (process.platform === 'darwin') {
177
+ try {
178
+ return require('./buttercap.darwin-universal.node')
179
+ } catch (e) {
180
+ loadErrors.push(e)
181
+ }
182
+ try {
183
+ const binding = require('buttercap-darwin-universal')
184
+ const bindingPackageVersion = require('buttercap-darwin-universal/package.json').version
185
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
186
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
187
+ }
188
+ return binding
189
+ } catch (e) {
190
+ loadErrors.push(e)
191
+ }
192
+ if (process.arch === 'x64') {
193
+ try {
194
+ return require('./buttercap.darwin-x64.node')
195
+ } catch (e) {
196
+ loadErrors.push(e)
197
+ }
198
+ try {
199
+ const binding = require('buttercap-darwin-x64')
200
+ const bindingPackageVersion = require('buttercap-darwin-x64/package.json').version
201
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
202
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
203
+ }
204
+ return binding
205
+ } catch (e) {
206
+ loadErrors.push(e)
207
+ }
208
+ } else if (process.arch === 'arm64') {
209
+ try {
210
+ return require('./buttercap.darwin-arm64.node')
211
+ } catch (e) {
212
+ loadErrors.push(e)
213
+ }
214
+ try {
215
+ const binding = require('buttercap-darwin-arm64')
216
+ const bindingPackageVersion = require('buttercap-darwin-arm64/package.json').version
217
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
218
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
219
+ }
220
+ return binding
221
+ } catch (e) {
222
+ loadErrors.push(e)
223
+ }
224
+ } else {
225
+ loadErrors.push(new Error(`Unsupported architecture on macOS: ${process.arch}`))
226
+ }
227
+ } else if (process.platform === 'freebsd') {
228
+ if (process.arch === 'x64') {
229
+ try {
230
+ return require('./buttercap.freebsd-x64.node')
231
+ } catch (e) {
232
+ loadErrors.push(e)
233
+ }
234
+ try {
235
+ const binding = require('buttercap-freebsd-x64')
236
+ const bindingPackageVersion = require('buttercap-freebsd-x64/package.json').version
237
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
238
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
239
+ }
240
+ return binding
241
+ } catch (e) {
242
+ loadErrors.push(e)
243
+ }
244
+ } else if (process.arch === 'arm64') {
245
+ try {
246
+ return require('./buttercap.freebsd-arm64.node')
247
+ } catch (e) {
248
+ loadErrors.push(e)
249
+ }
250
+ try {
251
+ const binding = require('buttercap-freebsd-arm64')
252
+ const bindingPackageVersion = require('buttercap-freebsd-arm64/package.json').version
253
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
254
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
255
+ }
256
+ return binding
257
+ } catch (e) {
258
+ loadErrors.push(e)
259
+ }
260
+ } else {
261
+ loadErrors.push(new Error(`Unsupported architecture on FreeBSD: ${process.arch}`))
262
+ }
263
+ } else if (process.platform === 'linux') {
264
+ if (process.arch === 'x64') {
265
+ if (isMusl()) {
266
+ try {
267
+ return require('./buttercap.linux-x64-musl.node')
268
+ } catch (e) {
269
+ loadErrors.push(e)
270
+ }
271
+ try {
272
+ const binding = require('buttercap-linux-x64-musl')
273
+ const bindingPackageVersion = require('buttercap-linux-x64-musl/package.json').version
274
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
275
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
276
+ }
277
+ return binding
278
+ } catch (e) {
279
+ loadErrors.push(e)
280
+ }
281
+ } else {
282
+ try {
283
+ return require('./buttercap.linux-x64-gnu.node')
284
+ } catch (e) {
285
+ loadErrors.push(e)
286
+ }
287
+ try {
288
+ const binding = require('buttercap-linux-x64-gnu')
289
+ const bindingPackageVersion = require('buttercap-linux-x64-gnu/package.json').version
290
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
291
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
292
+ }
293
+ return binding
294
+ } catch (e) {
295
+ loadErrors.push(e)
296
+ }
297
+ }
298
+ } else if (process.arch === 'arm64') {
299
+ if (isMusl()) {
300
+ try {
301
+ return require('./buttercap.linux-arm64-musl.node')
302
+ } catch (e) {
303
+ loadErrors.push(e)
304
+ }
305
+ try {
306
+ const binding = require('buttercap-linux-arm64-musl')
307
+ const bindingPackageVersion = require('buttercap-linux-arm64-musl/package.json').version
308
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
309
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
310
+ }
311
+ return binding
312
+ } catch (e) {
313
+ loadErrors.push(e)
314
+ }
315
+ } else {
316
+ try {
317
+ return require('./buttercap.linux-arm64-gnu.node')
318
+ } catch (e) {
319
+ loadErrors.push(e)
320
+ }
321
+ try {
322
+ const binding = require('buttercap-linux-arm64-gnu')
323
+ const bindingPackageVersion = require('buttercap-linux-arm64-gnu/package.json').version
324
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
325
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
326
+ }
327
+ return binding
328
+ } catch (e) {
329
+ loadErrors.push(e)
330
+ }
331
+ }
332
+ } else if (process.arch === 'arm') {
333
+ if (isMusl()) {
334
+ try {
335
+ return require('./buttercap.linux-arm-musleabihf.node')
336
+ } catch (e) {
337
+ loadErrors.push(e)
338
+ }
339
+ try {
340
+ const binding = require('buttercap-linux-arm-musleabihf')
341
+ const bindingPackageVersion = require('buttercap-linux-arm-musleabihf/package.json').version
342
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
343
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
344
+ }
345
+ return binding
346
+ } catch (e) {
347
+ loadErrors.push(e)
348
+ }
349
+ } else {
350
+ try {
351
+ return require('./buttercap.linux-arm-gnueabihf.node')
352
+ } catch (e) {
353
+ loadErrors.push(e)
354
+ }
355
+ try {
356
+ const binding = require('buttercap-linux-arm-gnueabihf')
357
+ const bindingPackageVersion = require('buttercap-linux-arm-gnueabihf/package.json').version
358
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
359
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
360
+ }
361
+ return binding
362
+ } catch (e) {
363
+ loadErrors.push(e)
364
+ }
365
+ }
366
+ } else if (process.arch === 'loong64') {
367
+ if (isMusl()) {
368
+ try {
369
+ return require('./buttercap.linux-loong64-musl.node')
370
+ } catch (e) {
371
+ loadErrors.push(e)
372
+ }
373
+ try {
374
+ const binding = require('buttercap-linux-loong64-musl')
375
+ const bindingPackageVersion = require('buttercap-linux-loong64-musl/package.json').version
376
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
377
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
378
+ }
379
+ return binding
380
+ } catch (e) {
381
+ loadErrors.push(e)
382
+ }
383
+ } else {
384
+ try {
385
+ return require('./buttercap.linux-loong64-gnu.node')
386
+ } catch (e) {
387
+ loadErrors.push(e)
388
+ }
389
+ try {
390
+ const binding = require('buttercap-linux-loong64-gnu')
391
+ const bindingPackageVersion = require('buttercap-linux-loong64-gnu/package.json').version
392
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
393
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
394
+ }
395
+ return binding
396
+ } catch (e) {
397
+ loadErrors.push(e)
398
+ }
399
+ }
400
+ } else if (process.arch === 'riscv64') {
401
+ if (isMusl()) {
402
+ try {
403
+ return require('./buttercap.linux-riscv64-musl.node')
404
+ } catch (e) {
405
+ loadErrors.push(e)
406
+ }
407
+ try {
408
+ const binding = require('buttercap-linux-riscv64-musl')
409
+ const bindingPackageVersion = require('buttercap-linux-riscv64-musl/package.json').version
410
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
411
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
412
+ }
413
+ return binding
414
+ } catch (e) {
415
+ loadErrors.push(e)
416
+ }
417
+ } else {
418
+ try {
419
+ return require('./buttercap.linux-riscv64-gnu.node')
420
+ } catch (e) {
421
+ loadErrors.push(e)
422
+ }
423
+ try {
424
+ const binding = require('buttercap-linux-riscv64-gnu')
425
+ const bindingPackageVersion = require('buttercap-linux-riscv64-gnu/package.json').version
426
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
427
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
428
+ }
429
+ return binding
430
+ } catch (e) {
431
+ loadErrors.push(e)
432
+ }
433
+ }
434
+ } else if (process.arch === 'ppc64') {
435
+ try {
436
+ return require('./buttercap.linux-ppc64-gnu.node')
437
+ } catch (e) {
438
+ loadErrors.push(e)
439
+ }
440
+ try {
441
+ const binding = require('buttercap-linux-ppc64-gnu')
442
+ const bindingPackageVersion = require('buttercap-linux-ppc64-gnu/package.json').version
443
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
444
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
445
+ }
446
+ return binding
447
+ } catch (e) {
448
+ loadErrors.push(e)
449
+ }
450
+ } else if (process.arch === 's390x') {
451
+ try {
452
+ return require('./buttercap.linux-s390x-gnu.node')
453
+ } catch (e) {
454
+ loadErrors.push(e)
455
+ }
456
+ try {
457
+ const binding = require('buttercap-linux-s390x-gnu')
458
+ const bindingPackageVersion = require('buttercap-linux-s390x-gnu/package.json').version
459
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
460
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
461
+ }
462
+ return binding
463
+ } catch (e) {
464
+ loadErrors.push(e)
465
+ }
466
+ } else {
467
+ loadErrors.push(new Error(`Unsupported architecture on Linux: ${process.arch}`))
468
+ }
469
+ } else if (process.platform === 'openharmony') {
470
+ if (process.arch === 'arm64') {
471
+ try {
472
+ return require('./buttercap.openharmony-arm64.node')
473
+ } catch (e) {
474
+ loadErrors.push(e)
475
+ }
476
+ try {
477
+ const binding = require('buttercap-openharmony-arm64')
478
+ const bindingPackageVersion = require('buttercap-openharmony-arm64/package.json').version
479
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
480
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
481
+ }
482
+ return binding
483
+ } catch (e) {
484
+ loadErrors.push(e)
485
+ }
486
+ } else if (process.arch === 'x64') {
487
+ try {
488
+ return require('./buttercap.openharmony-x64.node')
489
+ } catch (e) {
490
+ loadErrors.push(e)
491
+ }
492
+ try {
493
+ const binding = require('buttercap-openharmony-x64')
494
+ const bindingPackageVersion = require('buttercap-openharmony-x64/package.json').version
495
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
496
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
497
+ }
498
+ return binding
499
+ } catch (e) {
500
+ loadErrors.push(e)
501
+ }
502
+ } else if (process.arch === 'arm') {
503
+ try {
504
+ return require('./buttercap.openharmony-arm.node')
505
+ } catch (e) {
506
+ loadErrors.push(e)
507
+ }
508
+ try {
509
+ const binding = require('buttercap-openharmony-arm')
510
+ const bindingPackageVersion = require('buttercap-openharmony-arm/package.json').version
511
+ if (bindingPackageVersion !== '0.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
512
+ throw new Error(`Native binding package version mismatch, expected 0.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
513
+ }
514
+ return binding
515
+ } catch (e) {
516
+ loadErrors.push(e)
517
+ }
518
+ } else {
519
+ loadErrors.push(new Error(`Unsupported architecture on OpenHarmony: ${process.arch}`))
520
+ }
521
+ } else {
522
+ loadErrors.push(new Error(`Unsupported OS: ${process.platform}, architecture: ${process.arch}`))
523
+ }
524
+ }
525
+
526
+ nativeBinding = requireNative()
527
+
528
+ if (!nativeBinding || process.env.NAPI_RS_FORCE_WASI) {
529
+ let wasiBinding = null
530
+ let wasiBindingError = null
531
+ try {
532
+ wasiBinding = require('./buttercap.wasi.cjs')
533
+ nativeBinding = wasiBinding
534
+ } catch (err) {
535
+ if (process.env.NAPI_RS_FORCE_WASI) {
536
+ wasiBindingError = err
537
+ }
538
+ }
539
+ if (!nativeBinding || process.env.NAPI_RS_FORCE_WASI) {
540
+ try {
541
+ wasiBinding = require('buttercap-wasm32-wasi')
542
+ nativeBinding = wasiBinding
543
+ } catch (err) {
544
+ if (process.env.NAPI_RS_FORCE_WASI) {
545
+ if (!wasiBindingError) {
546
+ wasiBindingError = err
547
+ } else {
548
+ wasiBindingError.cause = err
549
+ }
550
+ loadErrors.push(err)
551
+ }
552
+ }
553
+ }
554
+ if (process.env.NAPI_RS_FORCE_WASI === 'error' && !wasiBinding) {
555
+ const error = new Error('WASI binding not found and NAPI_RS_FORCE_WASI is set to error')
556
+ error.cause = wasiBindingError
557
+ throw error
558
+ }
559
+ }
560
+
561
+ if (!nativeBinding) {
562
+ if (loadErrors.length > 0) {
563
+ throw new Error(
564
+ `Cannot find native binding. ` +
565
+ `npm has a bug related to optional dependencies (https://github.com/npm/cli/issues/4828). ` +
566
+ 'Please try `npm i` again after removing both package-lock.json and node_modules directory.',
567
+ {
568
+ cause: loadErrors.reduce((err, cur) => {
569
+ cur.cause = err
570
+ return cur
571
+ }),
572
+ },
573
+ )
574
+ }
575
+ throw new Error(`Failed to load native binding`)
576
+ }
577
+
578
+ module.exports = nativeBinding
579
+ module.exports.AudioCaptureHandle = nativeBinding.AudioCaptureHandle
580
+ module.exports.CaptureSession = nativeBinding.CaptureSession
581
+ module.exports.RawCaptureHandle = nativeBinding.RawCaptureHandle
582
+ module.exports.getEncoderInfo = nativeBinding.getEncoderInfo
583
+ module.exports.listDisplays = nativeBinding.listDisplays
584
+ module.exports.listWindows = nativeBinding.listWindows
585
+ module.exports.startRawCapture = nativeBinding.startRawCapture
586
+ module.exports.startSystemAudioCapture = nativeBinding.startSystemAudioCapture
587
+ module.exports.version = nativeBinding.version
package/package.json ADDED
@@ -0,0 +1,53 @@
1
+ {
2
+ "name": "buttercap",
3
+ "version": "0.1.0",
4
+ "description": "Discord-quality screen capture for Node.js — WGC + GPU H.264 encoding + WASAPI audio",
5
+ "main": "wrapper.js",
6
+ "types": "wrapper.d.ts",
7
+ "license": "MIT",
8
+ "repository": {
9
+ "type": "git",
10
+ "url": "https://github.com/eduardoalba00/buttercap"
11
+ },
12
+ "keywords": [
13
+ "screen-capture",
14
+ "h264",
15
+ "windows",
16
+ "napi",
17
+ "electron",
18
+ "wgc",
19
+ "wasapi"
20
+ ],
21
+ "files": [
22
+ "index.js",
23
+ "index.d.ts",
24
+ "wrapper.js",
25
+ "wrapper.d.ts"
26
+ ],
27
+ "napi": {
28
+ "name": "buttercap",
29
+ "triples": {
30
+ "defaults": false,
31
+ "additional": [
32
+ "x86_64-pc-windows-msvc"
33
+ ]
34
+ }
35
+ },
36
+ "scripts": {
37
+ "artifacts": "napi artifacts",
38
+ "build": "napi build --platform --release",
39
+ "build:debug": "napi build --platform",
40
+ "prepublishOnly": "napi prepublish -t npm",
41
+ "test": "vitest run",
42
+ "universal": "napi universal"
43
+ },
44
+ "devDependencies": {
45
+ "@napi-rs/cli": "^3.0.0",
46
+ "electron": "^35.0.0",
47
+ "vitest": "^3.0.0",
48
+ "typescript": "^5.7.0"
49
+ },
50
+ "optionalDependencies": {
51
+ "buttercap-win32-x64-msvc": "0.1.0"
52
+ }
53
+ }
package/wrapper.d.ts ADDED
@@ -0,0 +1,80 @@
1
+ import { EventEmitter } from 'events';
2
+
3
+ export interface WindowInfo {
4
+ hwnd: number;
5
+ title: string;
6
+ pid: number;
7
+ exe: string;
8
+ }
9
+
10
+ export interface DisplayInfo {
11
+ id: number;
12
+ name: string;
13
+ width: number;
14
+ height: number;
15
+ primary: boolean;
16
+ }
17
+
18
+ export interface EncoderInfo {
19
+ name: string;
20
+ hardware: boolean;
21
+ }
22
+
23
+ export interface VideoPacket {
24
+ data: Buffer;
25
+ timestampUs: number;
26
+ keyframe: boolean;
27
+ }
28
+
29
+ export interface AudioPacket {
30
+ data: Buffer;
31
+ timestampUs: number;
32
+ samples: number;
33
+ }
34
+
35
+ export interface SessionTarget {
36
+ type: 'window' | 'display';
37
+ id: number;
38
+ }
39
+
40
+ export interface SessionVideoConfig {
41
+ fps?: number;
42
+ codec?: 'h264';
43
+ preferHardware?: boolean;
44
+ bitrate?: number;
45
+ }
46
+
47
+ export interface SessionAudioConfig {
48
+ mode: 'none' | 'system' | 'process';
49
+ processId?: number;
50
+ }
51
+
52
+ export interface SessionOptions {
53
+ target: SessionTarget;
54
+ video?: SessionVideoConfig;
55
+ cursor?: boolean;
56
+ audio?: SessionAudioConfig;
57
+ }
58
+
59
+ export interface CaptureSession extends EventEmitter {
60
+ start(): this;
61
+ stop(): this;
62
+ pause(): this;
63
+ resume(): this;
64
+
65
+ on(event: 'video-packet', listener: (packet: VideoPacket) => void): this;
66
+ on(event: 'audio-packet', listener: (packet: AudioPacket) => void): this;
67
+ on(event: 'error', listener: (error: Error) => void): this;
68
+ on(event: 'stopped', listener: () => void): this;
69
+
70
+ once(event: 'video-packet', listener: (packet: VideoPacket) => void): this;
71
+ once(event: 'audio-packet', listener: (packet: AudioPacket) => void): this;
72
+ once(event: 'error', listener: (error: Error) => void): this;
73
+ once(event: 'stopped', listener: () => void): this;
74
+ }
75
+
76
+ export function createSession(options: SessionOptions): CaptureSession;
77
+ export function listWindows(): WindowInfo[];
78
+ export function listDisplays(): DisplayInfo[];
79
+ export function getEncoderInfo(): EncoderInfo[];
80
+ export function version(): string;
package/wrapper.js ADDED
@@ -0,0 +1,77 @@
1
+ const { EventEmitter } = require('events');
2
+ const native = require('./index.js');
3
+
4
+ class CaptureSessionWrapper extends EventEmitter {
5
+ #session;
6
+
7
+ constructor(options) {
8
+ super();
9
+
10
+ const config = {
11
+ targetType: options.target.type,
12
+ targetId:
13
+ typeof options.target.id === 'number'
14
+ ? options.target.id
15
+ : Number(options.target.id),
16
+ fps: options.video?.fps,
17
+ codec: options.video?.codec,
18
+ preferHardware: options.video?.preferHardware,
19
+ bitrate: options.video?.bitrate,
20
+ captureCursor: options.cursor,
21
+ audioMode: options.audio?.mode ?? 'none',
22
+ audioProcessId: options.audio?.processId,
23
+ };
24
+
25
+ this.#session = new native.CaptureSession(config);
26
+
27
+ this.#session.onVideoPacket((_err, packet) => {
28
+ this.emit('video-packet', packet);
29
+ });
30
+
31
+ this.#session.onAudioPacket((_err, packet) => {
32
+ this.emit('audio-packet', packet);
33
+ });
34
+
35
+ this.#session.onError((_err, message) => {
36
+ this.emit('error', new Error(message));
37
+ });
38
+
39
+ this.#session.onStopped((_err) => {
40
+ this.emit('stopped');
41
+ });
42
+ }
43
+
44
+ start() {
45
+ this.#session.start();
46
+ return this;
47
+ }
48
+
49
+ stop() {
50
+ this.#session.stop();
51
+ return this;
52
+ }
53
+
54
+ pause() {
55
+ this.#session.pause();
56
+ return this;
57
+ }
58
+
59
+ resume() {
60
+ this.#session.resume();
61
+ return this;
62
+ }
63
+ }
64
+
65
+ function createSession(options) {
66
+ return new CaptureSessionWrapper(options);
67
+ }
68
+
69
+ module.exports = {
70
+ createSession,
71
+ listWindows: native.listWindows,
72
+ listDisplays: native.listDisplays,
73
+ getEncoderInfo: native.getEncoderInfo,
74
+ startRawCapture: native.startRawCapture,
75
+ startSystemAudioCapture: native.startSystemAudioCapture,
76
+ version: native.version,
77
+ };