Create NPM package

.gitattributes

@@ -0,0 +1,2 @@
+build/* binary
+build/* linguist-generated=true

.gitignore

@@ -1,6 +1,4 @@
 /.vscode/c_cpp_properties.json
-/ui/libapi.*
-!/ui/libapi.mjs.d.ts
 /node_modules
 /deps/*
 !/deps/libgphoto2

Makefile

@@ -5,7 +5,7 @@ export LDFLAGS += -L$(SYSROOT)/lib
 export ACLOCAL_PATH := $(SYSROOT)/share/aclocal:$(ACLOCAL_PATH)
 
 # Common linking flags for all targets.
-export LDFLAGS += -s DYNAMIC_EXECUTION=0 -s AUTO_JS_LIBRARIES=0 -s AUTO_NATIVE_LIBRARIES=0
+export LDFLAGS += -s DYNAMIC_EXECUTION=0 -s AUTO_JS_LIBRARIES=0 -s AUTO_NATIVE_LIBRARIES=0 -s ENVIRONMENT=web,worker
 
 # Common compilation & linking flags for all langs and targets.
 COMMON_FLAGS = -Os -flto
@@ -15,7 +15,7 @@ export LDFLAGS += $(COMMON_FLAGS)
 
 ## Main API module
 
-ui/libapi.mjs: api.o $(SYSROOT)/lib/libltdl.la $(SYSROOT)/lib/libgphoto2.la
+build/libapi.mjs: api.o $(SYSROOT)/lib/libltdl.la $(SYSROOT)/lib/libgphoto2.la
 	libtool --verbose --mode=link $(LD) $(LDFLAGS) -o $@ $+ \
 		-fexceptions --bind -s ASYNCIFY -s ALLOW_MEMORY_GROWTH \
 		-dlpreopen $(SYSROOT)/lib/libgphoto2/2.5.28.1/ptp2.la \

README.md

@@ -1,9 +1,106 @@
-This is a [demo app](https://web.dev/porting-libusb-to-webusb/) running gPhoto2 on the Web:
+# Web-gPhoto2
 
-![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)
+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
+yarn add web-gphoto2
+```
+
+## Usage
+
+A short example on how to use this package:
+
+```ts
+import Camera from "web-gphoto2";
+
+let camera = new Camera();
+
+async function connectCamera() {
+  await camera.showCameraPicker();
+  await camera.connect();
+}
+
+async function getSupportedOps() {
+  const ops = await camera.getSupportedOps();
+  console.log("Supported Ops:", ops);
+}
+
+async function getCameraConfig() {
+  const config = await camera.getConfig();
+  console.log("Config:", config);
+}
+
+async function updateConfig() {
+  await camera.setConfigValue("iso", "800");
+}
+
+async function capturePreviewAsBlob() {
+  const blob = await camera.capturePreviewAsBlob();
+  console.log("Blob:", blob);
+}
+
+async function captureImageAsFile() {
+  const file = await camera.captureImageAsFile();
+  console.log("File:", file);
+}
+```
+
+## Common Issues
+
+### 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
+```
+
+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";
+
+/** @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();
+    });
+  },
+};
+
+export default defineConfig({
+  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)
+
 For the detailed technical write-up, see [the official blog post](https://web.dev/porting-libusb-to-webusb/). To see the demo in action, visit the hosted version [here](https://web-gphoto2.rreverser.com/) (but make sure to read the [cross-platform compatibility notes](https://web.dev/porting-libusb-to-webusb/#important-cross-platform-compatibility-notes) first).
 
 If you don't have a DSLR, you can check out a recording of the demo below:
@@ -16,10 +113,10 @@ To build, you'll need Docker. Then:
 
 ```bash
 ./build.sh # runs build in Docker
-npx serve ui # starts a local server with COOP/COEP
+npx serve examples/preact # starts a local server with COOP/COEP
 ```
 
-Then, navigate to http://localhost:5000/ in Chrome.
+Then, navigate to http://localhost:3000/ in Chrome.
 
 ## See also
 

examples/preact/build

@@ -0,0 +1 @@
+../../build

ui/index.js → examples/preact/index.js

@@ -22,9 +22,9 @@ import { connect, rethrowIfCritical } from './ops.js';
 import { Preview } from './preview.js';
 import { Widget } from './widget.js';
 
-/** @typedef {import('../libapi.mjs').Context} Context */
-/** @typedef {import('../libapi.mjs').Config} Config */
-/** @typedef {import('./ops').Connection} Connection */
+/** @typedef {import('./build/libapi.mjs').Context} Context */
+/** @typedef {import('./build/libapi.mjs').Config} Config */
+/** @typedef {import('./ops.js').Connection} Connection */
 
 export const isDebug = new URLSearchParams(location.search).has('debug');
 

ui/ops.js → examples/preact/ops.js

@@ -16,7 +16,7 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  */
 
-import initModule from '../libapi.mjs';
+import initModule from './build/libapi.mjs';
 
 /** @typedef {import('../libapi.mjs').Context} Context */
 
@@ -25,7 +25,8 @@ const ModulePromise = initModule();
 export function rethrowIfCritical(err) {
   // If it's precisely Error, it's a custom error; anything else - SyntaxError,
   // WebAssembly.RuntimeError, TypeError, etc. - is treated as critical here.
-  if (err.constructor !== Error) {
+  if (err.constructor !== Error)
+  {
     throw err;
   }
 }
@@ -44,7 +45,8 @@ export async function connect() {
    * @param {(ctx: Context) => Promise<T>} op
    * @returns {Promise<T>}
    */
-  function schedule(op) {
+  function schedule(op)
+  {
     let res = queue.then(() => op(context));
     queue = res.catch(rethrowIfCritical);
     return res;

ui/widget.js → examples/preact/widget.js

@@ -18,7 +18,7 @@
 
 import { h, Component, createRef } from 'preact';
 
-/** @typedef {import('../libapi.mjs').Config} Config */
+/** @typedef {import('./build/libapi.mjs').Config} Config */
 
 /**
  * @param {Config} config

package.json

@@ -1,8 +1,47 @@
 {
+  "name": "web-gphoto2",
+  "version": "1.0.0",
+  "description": "WebAssembly implementation of gphoto2 and libusb to control DSLR cameras over USB on the Web",
+  "type": "module",
+  "main": "src/camera.js",
+  "types": "src/libapi.mjs.d.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/GoogleChromeLabs/web-gphoto2"
+  },
+  "keywords": [
+    "gphoto2",
+    "libusb",
+    "webassembly"
+  ],
+  "author": {
+    "name": "Ingvar Stepanyan",
+    "email": "[email protected]",
+    "url": "https://rreverser.com"
+  },
+  "contributors": [
+    {
+      "name": "Tjeerd Bakker",
+      "email": "[email protected]",
+      "url": "https://icheered.com"
+    }
+  ],
+  "license": "LGPL-2.1-or-later",
+  "bugs": {
+    "url": "https://github.com/GoogleChromeLabs/web-gphoto2/issues"
+  },
+  "homepage": "https://github.com/GoogleChromeLabs/web-gphoto2#readme",
+  "files": [
+    "src/*",
+    "build/*"
+  ],
   "devDependencies": {
     "@types/emscripten": "^1.39.5",
     "@types/requestidlecallback": "^0.3.4",
     "@types/stats.js": "^0.17.0",
     "preact": "^10.5.14"
   }
-}
+}

src/camera.js

@@ -0,0 +1,131 @@
+/*
+ * Copyright 2021 Google LLC
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+
+/** @typedef {import('./libapi.mjs.d.ts').Context} Context */
+
+// To avoid errors for users who use SSR or Hybrid rendering (e.g. Nuxt.js), we need to check if we're in the browser.
+let initModule;
+
+async function initializeModule() {
+  if (typeof window !== "undefined") {
+    const module = await import("../build/libapi.mjs");
+    initModule = module.default;
+    return initModule;
+  } else {
+    console.warn("web-gphoto2 is only available in the browser");
+    return null;
+  }
+}
+
+export function rethrowIfCritical(err) {
+  // If it's precisely Error, it's a custom error; anything else - SyntaxError,
+  // WebAssembly.RuntimeError, TypeError, etc. - is treated as critical here.
+  if (err.constructor !== Error) {
+    throw err;
+  }
+}
+
+const INTERFACE_CLASS = 6; // PTP
+const INTERFACE_SUBCLASS = 1; // MTP
+
+class Camera {
+  constructor() {
+    /** @type {Promise<unknown>} */
+    this.queue = Promise.resolve();
+    this.Module = null;
+    this.context = null;
+    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) => {
+        if (initModule) {
+          return initModule();
+        } else {
+          return null;
+        }
+      });
+    }
+    this.Module = await this.ModulePromise;
+    this.context = await new this.Module.Context();
+  }
+
+  /** Schedules an exclusive async operation on the global context.
+   * @template T
+   * @param {(ctx: Context) => Promise<T>} op
+   * @returns {Promise<T>}
+   */
+  async schedule(op) {
+    let res = this.queue.then(() => op(this.context));
+    this.queue = res.catch(rethrowIfCritical);
+    return res;
+  }
+
+  async disconnect() {
+    if (!this.context.isDeleted()) {
+      this.context.delete();
+    }
+  }
+
+  async getConfig() {
+    return this.schedule((context) => context.configToJS());
+  }
+
+  async getSupportedOps() {
+    if (this.context) {
+      return await this.context.supportedOps();
+    }
+    throw new Error("You need to connect to the camera first");
+  }
+
+  async setConfigValue(name, value) {
+    const uiTimeout = new Promise((resolve) => setTimeout(resolve, 800));
+    const setResult = this.schedule((context) =>
+      context.setConfigValue(name, value)
+    );
+    // wait for both the config set operation and the timeout to complete
+    return Promise.all([setResult, uiTimeout]);
+  }
+
+  async capturePreviewAsBlob() {
+    return this.schedule((context) => context.capturePreviewAsBlob());
+  }
+
+  async captureImageAsFile() {
+    return this.schedule((context) => context.captureImageAsFile());
+  }
+
+  async consumeEvents() {
+    return this.schedule((context) => context.consumeEvents());
+  }
+}
+
+export default Camera;