From 8b10757e92ae4cc370804da30133a910179bb3ff Mon Sep 17 00:00:00 2001 From: ICheered Date: Fri, 4 Aug 2023 17:59:42 +0200 Subject: [PATCH] Move navigator.usb.requestDevice to package --- README.md | 68 ++++++++++++++++++++++++--------------------- src/camera.js | 15 ++++++++++ src/libapi.mjs.d.ts | 1 + 3 files changed, 53 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index f681f72..8e1a544 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,13 @@ # Web-gPhoto2 + A gPhoto2 implementation using WebAssembly to control DSLR cameras from the browser. Powered by a [custom fork](https://github.com/RReverser/libgphoto2) of [libgphoto2](https://github.com/gphoto/libgphoto2), the [WebUSB](https://github.com/WICG/webusb) backend of [libusb](https://github.com/libusb/libusb), and WebAssembly via [Emscripten](https://emscripten.org/). # NPM + ## Installation + ```bash npm install web-gphoto2 // or @@ -14,47 +17,48 @@ yarn add web-gphoto2 ## Usage A short example on how to use this package: + ```ts -import Camera from 'web-gphoto2'; +import Camera from "web-gphoto2"; let camera = new Camera(); async function connectCamera() { - // @ts-ignore - await navigator.usb.requestDevice({ - filters: [{ classCode: 6, subclassCode: 1 }] - }); - await camera.connect(); + await camera.showCameraPicker(); + await camera.connect(); } async function getSupportedOps() { - const ops = await camera.getSupportedOps(); - console.log('Supported Ops:', ops); + const ops = await camera.getSupportedOps(); + console.log("Supported Ops:", ops); } async function getCameraConfig() { - const config = await camera.getConfig(); - console.log('Config:', config); + const config = await camera.getConfig(); + console.log("Config:", config); } async function updateConfig() { - await camera.setConfigValue('iso', '800'); + await camera.setConfigValue("iso", "800"); } async function capturePreviewAsBlob() { - const blob = await camera.capturePreviewAsBlob(); - console.log('Blob:', blob); + const blob = await camera.capturePreviewAsBlob(); + console.log("Blob:", blob); } async function captureImageAsFile() { - const file = await camera.captureImageAsFile(); - console.log('File:', file); + const file = await camera.captureImageAsFile(); + console.log("File:", file); } ``` ## Common Issues -### SharedArrayBuffer can not be found + +### SharedArrayBuffer can not be found + SharedArrayBuffer has been disabled across all browsers due to the Spectre vulnerability. This package uses SharedArrayBuffer to communicate with the WebAssembly module. To work around this issue, you need to set two response headers for your document: + ``` Cross-Origin-Opener-Policy: same-origin Cross-Origin-Embedder-Policy: require-corp @@ -63,35 +67,37 @@ Cross-Origin-Embedder-Policy: require-corp Information from [Stackoverflow](https://stackoverflow.com/questions/64650119/react-error-sharedarraybuffer-is-not-defined-in-firefox) ### Error: Not found: /node_modules/.vite/deps/libapi.wasm + Vite tries to optimize the dependencies by default. This causes the WebAssembly module to be moved to a different location. To prevent this, you need to exclude the web-gphoto2 package from the optimization. In vite, both of the above mentioned issues are solved by adding the following to your vite.config.js: + ```ts -import { sveltekit } from '@sveltejs/kit/vite'; -import { defineConfig } from 'vite'; +import { sveltekit } from "@sveltejs/kit/vite"; +import { defineConfig } from "vite"; /** @type {import('vite').Plugin} */ const viteServerConfig = { - name: 'add headers', - configureServer: (server) => { - server.middlewares.use((req, res, next) => { - res.setHeader("Cross-Origin-Opener-Policy", "same-origin"); - res.setHeader("Cross-Origin-Embedder-Policy", "require-corp"); - next(); - }); - } + name: "add headers", + configureServer: (server) => { + server.middlewares.use((req, res, next) => { + res.setHeader("Cross-Origin-Opener-Policy", "same-origin"); + res.setHeader("Cross-Origin-Embedder-Policy", "require-corp"); + next(); + }); + }, }; export default defineConfig({ - plugins: [sveltekit(), viteServerConfig], - optimizeDeps: { - exclude: ['web-gphoto2'] - } + plugins: [sveltekit(), viteServerConfig], + optimizeDeps: { + exclude: ["web-gphoto2"], + }, }); ``` - # Demo + This repository also contains a [demo app](https://web.dev/porting-libusb-to-webusb/) running gPhoto2 on the Web: ![A picture of DSLR camera connected via a USB cable to a laptop. The laptop is running the Web demo mentioned in the article, which mirrors a live video feed from the camera as well as allows to tweak its settings via form controls.](https://web-dev.imgix.net/image/9oK23mr86lhFOwKaoYZ4EySNFp02/MR4YGRvl0Z9AWT6vv3sQ.jpg?auto=format&w=1600) diff --git a/src/camera.js b/src/camera.js index 066bf51..d6c7585 100644 --- a/src/camera.js +++ b/src/camera.js @@ -40,6 +40,9 @@ export function rethrowIfCritical(err) { } } +const INTERFACE_CLASS = 6; // PTP +const INTERFACE_SUBCLASS = 1; // MTP + class Camera { constructor() { /** @type {Promise} */ @@ -49,6 +52,18 @@ class Camera { this.ModulePromise = null; } + async showCameraPicker() { + // @ts-ignore + await navigator.usb.requestDevice({ + filters: [ + { + classCode: INTERFACE_CLASS, + subclassCode: INTERFACE_SUBCLASS, + }, + ], + }); + } + async connect() { if (!this.ModulePromise) { this.ModulePromise = initializeModule().then((initModule) => { diff --git a/src/libapi.mjs.d.ts b/src/libapi.mjs.d.ts index 855202d..c73dbc9 100644 --- a/src/libapi.mjs.d.ts +++ b/src/libapi.mjs.d.ts @@ -61,6 +61,7 @@ declare class Context { export declare class Camera { constructor(); + showCameraPicker(): Promise; connect(): Promise; disconnect(): Promise;