node-libcamera 0.1.0 → 0.1.1

package/README.md

@@ -1,103 +1,55 @@
-# TSDX User Guide
+# node-libcamera 📷
 
-Congrats! You just saved yourself hours of work by bootstrapping this project with TSDX. Let’s get you oriented with what’s here and how to use it.
+A set of wrapper functions for the native [Raspberry Pi `libcamera` API](https://www.raspberrypi.com/documentation/accessories/camera.html).
 
-> This TSDX setup is meant for developing libraries (not apps!) that can be published to NPM. If you’re looking to build a Node app, you could use `ts-node-dev`, plain `ts-node`, or simple `tsc`.
+_Open to any and all contributions!_
 
-> If you’re new to TypeScript, checkout [this handy cheatsheet](https://devhints.io/typescript)
-
-## Commands
-
-TSDX scaffolds your new library inside `/src`.
-
-To run TSDX, use:
+## Installation
 
 ```bash
-npm start # or yarn start
+npm install node-libcamera
 ```
 
-This builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`.
-
-To do a one-off build, use `npm run build` or `yarn build`.
-
-To run tests, use `npm test` or `yarn test`.
-
-## Configuration
-
-Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly.
-
-### Jest
+## Usage
 
-Jest tests are set up to run with `npm test` or `yarn test`.
+### [`libcamera-still`](https://www.raspberrypi.com/documentation/accessories/camera.html#libcamera-still)
 
-### Bundle Analysis
+Capture an image!
 
-[`size-limit`](https://github.com/ai/size-limit) is set up to calculate the real cost of your library with `npm run size` and visualize the bundle with `npm run analyze`.
-
-#### Setup Files
-
-This is the folder structure we set up for you:
-
-```txt
-/src
-  index.tsx       # EDIT THIS
-/test
-  blah.test.tsx   # EDIT THIS
-.gitignore
-package.json
-README.md         # EDIT THIS
-tsconfig.json
+```js
+const { still } = require('node-libcamera')
+
+// basic example
+still({ output: 'test.jpg' })
+  .then((result) => /* 📸 */ )
+  .catch((error) => /* 🐛 */ )
+
+// example with options
+still({
+  output: 'images/test.jpg', // output file path
+  timeout: 2000, // timeout before taking the picture
+  width: 640, // image width
+  height: 480, // image height
+})
+  .then((result) => /* 📸 */ )
+  .catch((error) => /* 🐛 */ )
 ```
 
-### Rollup
-
-TSDX uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details.
-
-### TypeScript
-
-`tsconfig.json` is set up to interpret `dom` and `esnext` types, as well as `react` for `jsx`. Adjust according to your needs.
-
-## Continuous Integration
+### [`libcamera-vid`](https://www.raspberrypi.com/documentation/accessories/camera.html#libcamera-vid)
 
-### GitHub Actions
-
-Two actions are added by default:
-
-- `main` which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
-- `size` which comments cost comparison of your library on every pull request using [`size-limit`](https://github.com/ai/size-limit)
-
-## Optimizations
-
-Please see the main `tsdx` [optimizations docs](https://github.com/palmerhq/tsdx#optimizations). In particular, know that you can take advantage of development-only optimizations:
+Record a video!
 
 ```js
-// ./types/index.d.ts
-declare var __DEV__: boolean;
+const { vid } = require('node-libcamera')
 
-// inside your code...
-if (__DEV__) {
-  console.log('foo');
-}
+// record a 10s video
+vid({ output: 'test.h264', timeout: 10000, 'save-pts': 'timestamps.txt' })
+  .then((result) => /* 🎥 */ )
+  .catch((error) => /* 🐛 */ )
 ```
 
-You can also choose to install and use [invariant](https://github.com/palmerhq/tsdx#invariant) and [warning](https://github.com/palmerhq/tsdx#warning) functions.
-
-## Module Formats
-
-CJS, ESModules, and UMD module formats are supported.
-
-The appropriate paths are configured in `package.json` and `dist/index.js` accordingly. Please report if any issues are found.
-
-## Named Exports
+Note: this will result in an unpackaged video bistream, it is not wrapped in any kind of container format (such as an mp4 file). The `save-pts` option can be used to output frame timestamps so that the bitstream can subsequently be converted into an appropriate format using a tool like `mkvmerge`.
 
-Per Palmer Group guidelines, [always use named exports.](https://github.com/palmerhq/typescript#exports) Code split inside your React app instead of your React library.
-
-## Including Styles
-
-There are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this, configure how you like.
-
-For vanilla CSS, you can include it at the root directory and add it to the `files` section in your `package.json`, so that it can be imported separately by your users and run through their bundler's loader.
-
-## Publishing to NPM
-
-We recommend using [np](https://github.com/sindresorhus/np).
+```bash
+mkvmerge -o test.mkv --timecodes 0:timestamps.txt test.h264
+```

package/dist/index.d.ts

@@ -1,2 +1,4 @@
 import { LibCamera } from './options';
-export declare function snap(options: LibCamera.OptionsObject): Promise<unknown>;
+export declare function jpeg(options: Partial<LibCamera.OptionsObject>): string | Promise<unknown>;
+export declare function still(options: Partial<LibCamera.OptionsObject>): string | Promise<unknown>;
+export declare function vid(options: Partial<LibCamera.OptionsObject>): string | Promise<unknown>;

package/dist/node-libcamera.cjs.development.js

@@ -2,96 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var child_process = require('child_process');
+require('child_process');
 
-var OPTIONS = {
-  help: {
-    "short": 'h',
-    desc: 'Print help information for the application'
-  },
-  version: {
-    desc: 'Print help information for the application'
-  },
-  timeout: {
-    "short": 't',
-    desc: 'Delay before application stops automatically <milliseconds>',
-    validator: function validator(val) {
-      return typeof val === 'number';
-    },
-    convert: function convert(val) {
-      return val.toString();
-    }
-  },
-  preview: {
-    "short": 'p',
-    desc: 'Preview window settings <x,y,w,h>',
-    validator: function validator(val) {
-      return typeof val === 'object' && Boolean((val == null ? void 0 : val.x) && (val == null ? void 0 : val.y) && (val == null ? void 0 : val.width) && (val == null ? void 0 : val.height));
-    },
-    convert: function convert(val) {
-      return val.x + "," + val.y + "," + val.width + "," + val.height;
-    }
-  },
-  fullscreen: {
-    "short": 'f',
-    desc: 'Fullscreen preview mode'
-  },
-  'qt-preview': {
-    desc: 'Use Qt-based preview window'
-  },
-  nopreview: {
-    "short": 'n',
-    desc: 'Do not display a preview window'
-  },
-  'info-text': {
-    desc: 'Set window title bar text <string>',
-    validator: function validator(val) {
-      return typeof val === 'string';
-    }
-  },
-  width: {
-    desc: 'Capture image width <width>',
-    validator: function validator(val) {
-      return typeof val === 'number';
-    },
-    convert: function convert(val) {
-      return val.toString();
-    }
-  },
-  height: {
-    desc: 'Capture image height <height>',
-    validator: function validator(val) {
-      return typeof val === 'number';
-    },
-    convert: function convert(val) {
-      return val.toString();
-    }
-  },
-  'viewfinder-width': {
-    desc: 'Capture image width <width>',
-    validator: function validator(val) {
-      return typeof val === 'number';
-    },
-    convert: function convert(val) {
-      return val.toString();
-    }
-  },
-  'viewfinder-height': {
-    desc: 'Capture image height <height>',
-    validator: function validator(val) {
-      return typeof val === 'number';
-    },
-    convert: function convert(val) {
-      return val.toString();
-    }
-  },
-  // ...
-  output: {
-    "short": 'o',
-    desc: 'Output file name <string>',
-    validator: function validator(val) {
-      return typeof val === 'string';
-    }
+var optionConverterMap = {
+  preview: function preview(val) {
+    return val.x + "," + val.y + "," + val.width + "," + val.height;
   }
 };
 
@@ -99,37 +14,44 @@ function cmd(base, args) {
   if (base && !args) return base;
   return base + " " + (args == null ? void 0 : args.join(' '));
 }
-function run(command, options) {
-  return new Promise(function (resolve, reject) {
-    child_process.exec(command, options, function (error, stdout, stderr) {
-      if (stderr || error) reject(stderr || error);
-      resolve(stdout);
-    });
-  });
-}
 function convertOptionsToCmdArgs(options) {
   var args = [];
   Object.entries(options).forEach(function (_ref) {
     var key = _ref[0],
         val = _ref[1];
-    var opt = OPTIONS[key];
-
-    if (typeof opt.validator === 'function' && !opt.validator(val)) {
-      throw new Error("Invalid value for option \"" + key + "\"");
-    }
-
-    var value = typeof opt.convert === 'function' ? opt.convert(val) : val;
+    var converter = optionConverterMap[key];
+    var value = typeof converter === 'function' ? converter(val) : val;
     if (value) args.push("--" + key);
-    if (value !== true) args.push(value);
+    if (value !== true && value != null && value.toString()) args.push(value == null ? void 0 : value.toString());
   }, true);
   return args;
 }
 
-function snap(options) {
+function runLibCamera(bin, options) {
+  if (bin === void 0) {
+    bin = 'libcamera-still';
+  }
+
   var args = convertOptionsToCmdArgs(options);
-  var command = cmd('libcamera-still', args);
-  return run(command);
+  var command = cmd(bin, args);
+
+  {
+    console.log(command);
+    return command;
+  }
+}
+
+function jpeg(options) {
+  return runLibCamera('libcamera-jpeg', options);
+}
+function still(options) {
+  return runLibCamera('libcamera-still', options);
+}
+function vid(options) {
+  return runLibCamera('libcamera-vid', options);
 }
 
-exports.snap = snap;
+exports.jpeg = jpeg;
+exports.still = still;
+exports.vid = vid;
 //# sourceMappingURL=node-libcamera.cjs.development.js.map

package/dist/node-libcamera.cjs.development.js.map

@@ -1 +1 @@
-{"version":3,"file":"node-libcamera.cjs.development.js","sources":["../src/options.ts","../src/utils.ts","../src/index.ts"],"sourcesContent":["export namespace LibCamera {\n  export type OptionKeys = typeof OPTION_KEYS[number]\n\n  export interface OptionDefinition {\n    short?: string\n    desc?: string\n    validator?: (val: any) => boolean\n    convert?: (val: any) => string\n  }\n\n  export type OptionsObject = {\n    [key in OptionKeys]?: any\n  }\n\n  export interface PreviewOption {\n    x: number\n    y: number\n    width: number\n    height: number\n  }\n}\n\nexport const OPTION_KEYS = [\n  'help',\n  'version',\n  'timeout',\n  'preview',\n  'fullscreen',\n  'qt-preview',\n  'nopreview',\n  'info-text',\n  'width',\n  'height',\n  'viewfinder-width',\n  'viewfinder-height',\n  // ...\n  'output',\n] as const\n\nexport const OPTIONS: Record<\n  LibCamera.OptionKeys,\n  LibCamera.OptionDefinition\n> = {\n  help: {\n    short: 'h',\n    desc: 'Print help information for the application',\n  },\n  version: {\n    desc: 'Print help information for the application',\n  },\n  timeout: {\n    short: 't',\n    desc: 'Delay before application stops automatically <milliseconds>',\n    validator: (val: number) => typeof val === 'number',\n    convert: (val: number) => val.toString(),\n  },\n  preview: {\n    short: 'p',\n    desc: 'Preview window settings <x,y,w,h>',\n    validator(val: LibCamera.PreviewOption) {\n      return (\n        typeof val === 'object' &&\n        Boolean(val?.x && val?.y && val?.width && val?.height)\n      )\n    },\n    convert(val: LibCamera.PreviewOption) {\n      return `${val.x},${val.y},${val.width},${val.height}`\n    },\n  },\n  fullscreen: {\n    short: 'f',\n    desc: 'Fullscreen preview mode',\n  },\n  'qt-preview': {\n    desc: 'Use Qt-based preview window',\n  },\n  nopreview: {\n    short: 'n',\n    desc: 'Do not display a preview window',\n  },\n  'info-text': {\n    desc: 'Set window title bar text <string>',\n    validator: (val: string) => typeof val === 'string',\n  },\n  width: {\n    desc: 'Capture image width <width>',\n    validator: (val: number) => typeof val === 'number',\n    convert: (val: number) => val.toString(),\n  },\n  height: {\n    desc: 'Capture image height <height>',\n    validator: (val: number) => typeof val === 'number',\n    convert: (val: number) => val.toString(),\n  },\n  'viewfinder-width': {\n    desc: 'Capture image width <width>',\n    validator: (val: number) => typeof val === 'number',\n    convert: (val: number) => val.toString(),\n  },\n  'viewfinder-height': {\n    desc: 'Capture image height <height>',\n    validator: (val: number) => typeof val === 'number',\n    convert: (val: number) => val.toString(),\n  },\n\n  // ...\n\n  output: {\n    short: 'o',\n    desc: 'Output file name <string>',\n    validator: (val: string) => typeof val === 'string',\n  },\n} as const\n","import { exec, ExecOptionsWithBufferEncoding } from 'child_process'\nimport { OPTIONS, LibCamera } from './options'\n\nexport function cmd(base: string, args?: string[]): string {\n  if (base && !args) return base\n  return `${base} ${args?.join(' ')}`\n}\n\nexport function run(command: string, options?: ExecOptionsWithBufferEncoding) {\n  return new Promise((resolve, reject) => {\n    exec(command, options, (error, stdout, stderr) => {\n      if (stderr || error) reject(stderr || error)\n      resolve(stdout)\n    })\n  })\n}\n\nexport function convertOptionsToCmdArgs(\n  options: LibCamera.OptionsObject\n): string[] {\n  const args: string[] = []\n  Object.entries(options).forEach(([key, val]) => {\n    const opt = OPTIONS[key as LibCamera.OptionKeys]\n    if (typeof opt.validator === 'function' && !opt.validator(val)) {\n      throw new Error(`Invalid value for option \"${key}\"`)\n    }\n    const value = typeof opt.convert === 'function' ? opt.convert(val) : val\n    if (value) args.push(`--${key}`)\n    if (value !== true) args.push(value)\n  }, true)\n  return args\n}\n","import { LibCamera } from './options'\nimport { run, cmd, convertOptionsToCmdArgs } from './utils'\n\nexport function snap(options: LibCamera.OptionsObject) {\n  const args = convertOptionsToCmdArgs(options)\n  const command = cmd('libcamera-still', args)\n  return run(command)\n}\n"],"names":["OPTIONS","help","desc","version","timeout","validator","val","convert","toString","preview","Boolean","x","y","width","height","fullscreen","nopreview","output","cmd","base","args","join","run","command","options","Promise","resolve","reject","exec","error","stdout","stderr","convertOptionsToCmdArgs","Object","entries","forEach","key","opt","Error","value","push","snap"],"mappings":";;;;;;AAuCO,IAAMA,OAAO,GAGhB;AACFC,EAAAA,IAAI,EAAE;AACJ,aAAO,GADH;AAEJC,IAAAA,IAAI,EAAE;AAFF,GADJ;AAKFC,EAAAA,OAAO,EAAE;AACPD,IAAAA,IAAI,EAAE;AADC,GALP;AAQFE,EAAAA,OAAO,EAAE;AACP,aAAO,GADA;AAEPF,IAAAA,IAAI,EAAE,6DAFC;AAGPG,IAAAA,SAAS,EAAE,mBAACC,GAAD;AAAA,aAAiB,OAAOA,GAAP,KAAe,QAAhC;AAAA,KAHJ;AAIPC,IAAAA,OAAO,EAAE,iBAACD,GAAD;AAAA,aAAiBA,GAAG,CAACE,QAAJ,EAAjB;AAAA;AAJF,GARP;AAcFC,EAAAA,OAAO,EAAE;AACP,aAAO,GADA;AAEPP,IAAAA,IAAI,EAAE,mCAFC;AAGPG,IAAAA,SAHO,qBAGGC,GAHH;AAIL,aACE,OAAOA,GAAP,KAAe,QAAf,IACAI,OAAO,CAAC,CAAAJ,GAAG,QAAH,YAAAA,GAAG,CAAEK,CAAL,MAAUL,GAAV,oBAAUA,GAAG,CAAEM,CAAf,MAAoBN,GAApB,oBAAoBA,GAAG,CAAEO,KAAzB,MAAkCP,GAAlC,oBAAkCA,GAAG,CAAEQ,MAAvC,CAAD,CAFT;AAID,KARM;AASPP,IAAAA,OATO,mBASCD,GATD;AAUL,aAAUA,GAAG,CAACK,CAAd,SAAmBL,GAAG,CAACM,CAAvB,SAA4BN,GAAG,CAACO,KAAhC,SAAyCP,GAAG,CAACQ,MAA7C;AACD;AAXM,GAdP;AA2BFC,EAAAA,UAAU,EAAE;AACV,aAAO,GADG;AAEVb,IAAAA,IAAI,EAAE;AAFI,GA3BV;AA+BF,gBAAc;AACZA,IAAAA,IAAI,EAAE;AADM,GA/BZ;AAkCFc,EAAAA,SAAS,EAAE;AACT,aAAO,GADE;AAETd,IAAAA,IAAI,EAAE;AAFG,GAlCT;AAsCF,eAAa;AACXA,IAAAA,IAAI,EAAE,oCADK;AAEXG,IAAAA,SAAS,EAAE,mBAACC,GAAD;AAAA,aAAiB,OAAOA,GAAP,KAAe,QAAhC;AAAA;AAFA,GAtCX;AA0CFO,EAAAA,KAAK,EAAE;AACLX,IAAAA,IAAI,EAAE,6BADD;AAELG,IAAAA,SAAS,EAAE,mBAACC,GAAD;AAAA,aAAiB,OAAOA,GAAP,KAAe,QAAhC;AAAA,KAFN;AAGLC,IAAAA,OAAO,EAAE,iBAACD,GAAD;AAAA,aAAiBA,GAAG,CAACE,QAAJ,EAAjB;AAAA;AAHJ,GA1CL;AA+CFM,EAAAA,MAAM,EAAE;AACNZ,IAAAA,IAAI,EAAE,+BADA;AAENG,IAAAA,SAAS,EAAE,mBAACC,GAAD;AAAA,aAAiB,OAAOA,GAAP,KAAe,QAAhC;AAAA,KAFL;AAGNC,IAAAA,OAAO,EAAE,iBAACD,GAAD;AAAA,aAAiBA,GAAG,CAACE,QAAJ,EAAjB;AAAA;AAHH,GA/CN;AAoDF,sBAAoB;AAClBN,IAAAA,IAAI,EAAE,6BADY;AAElBG,IAAAA,SAAS,EAAE,mBAACC,GAAD;AAAA,aAAiB,OAAOA,GAAP,KAAe,QAAhC;AAAA,KAFO;AAGlBC,IAAAA,OAAO,EAAE,iBAACD,GAAD;AAAA,aAAiBA,GAAG,CAACE,QAAJ,EAAjB;AAAA;AAHS,GApDlB;AAyDF,uBAAqB;AACnBN,IAAAA,IAAI,EAAE,+BADa;AAEnBG,IAAAA,SAAS,EAAE,mBAACC,GAAD;AAAA,aAAiB,OAAOA,GAAP,KAAe,QAAhC;AAAA,KAFQ;AAGnBC,IAAAA,OAAO,EAAE,iBAACD,GAAD;AAAA,aAAiBA,GAAG,CAACE,QAAJ,EAAjB;AAAA;AAHU,GAzDnB;AA+DF;AAEAS,EAAAA,MAAM,EAAE;AACN,aAAO,GADD;AAENf,IAAAA,IAAI,EAAE,2BAFA;AAGNG,IAAAA,SAAS,EAAE,mBAACC,GAAD;AAAA,aAAiB,OAAOA,GAAP,KAAe,QAAhC;AAAA;AAHL;AAjEN,CAHG;;SCpCSY,IAAIC,MAAcC;AAChC,MAAID,IAAI,IAAI,CAACC,IAAb,EAAmB,OAAOD,IAAP;AACnB,SAAUA,IAAV,UAAkBC,IAAlB,oBAAkBA,IAAI,CAAEC,IAAN,CAAW,GAAX,CAAlB;AACD;AAED,SAAgBC,IAAIC,SAAiBC;AACnC,SAAO,IAAIC,OAAJ,CAAY,UAACC,OAAD,EAAUC,MAAV;AACjBC,IAAAA,kBAAI,CAACL,OAAD,EAAUC,OAAV,EAAmB,UAACK,KAAD,EAAQC,MAAR,EAAgBC,MAAhB;AACrB,UAAIA,MAAM,IAAIF,KAAd,EAAqBF,MAAM,CAACI,MAAM,IAAIF,KAAX,CAAN;AACrBH,MAAAA,OAAO,CAACI,MAAD,CAAP;AACD,KAHG,CAAJ;AAID,GALM,CAAP;AAMD;AAED,SAAgBE,wBACdR;AAEA,MAAMJ,IAAI,GAAa,EAAvB;AACAa,EAAAA,MAAM,CAACC,OAAP,CAAeV,OAAf,EAAwBW,OAAxB,CAAgC;QAAEC;QAAK9B;AACrC,QAAM+B,GAAG,GAAGrC,OAAO,CAACoC,GAAD,CAAnB;;AACA,QAAI,OAAOC,GAAG,CAAChC,SAAX,KAAyB,UAAzB,IAAuC,CAACgC,GAAG,CAAChC,SAAJ,CAAcC,GAAd,CAA5C,EAAgE;AAC9D,YAAM,IAAIgC,KAAJ,iCAAuCF,GAAvC,QAAN;AACD;;AACD,QAAMG,KAAK,GAAG,OAAOF,GAAG,CAAC9B,OAAX,KAAuB,UAAvB,GAAoC8B,GAAG,CAAC9B,OAAJ,CAAYD,GAAZ,CAApC,GAAuDA,GAArE;AACA,QAAIiC,KAAJ,EAAWnB,IAAI,CAACoB,IAAL,QAAeJ,GAAf;AACX,QAAIG,KAAK,KAAK,IAAd,EAAoBnB,IAAI,CAACoB,IAAL,CAAUD,KAAV;AACrB,GARD,EAQG,IARH;AASA,SAAOnB,IAAP;AACD;;SC5BeqB,KAAKjB;AACnB,MAAMJ,IAAI,GAAGY,uBAAuB,CAACR,OAAD,CAApC;AACA,MAAMD,OAAO,GAAGL,GAAG,CAAC,iBAAD,EAAoBE,IAApB,CAAnB;AACA,SAAOE,GAAG,CAACC,OAAD,CAAV;AACD;;;;"}
+{"version":3,"file":"node-libcamera.cjs.development.js","sources":["../src/options.ts","../src/utils.ts","../src/index.ts"],"sourcesContent":["export namespace LibCamera {\n  export interface CommandLineOptions {\n    /**\n     * Print help information for the application\n     *\n     * The `--help` option causes every application to print its full set of command line options with a brief synopsis of each, and then quit.\n     **/\n    help: boolean\n    /**\n     * Print out a software version number\n     *\n     * All `libcamera-apps` will, when they see the `--version` option, print out a version string both for `libcamera` and `libcamera-apps` and then quit.\n     */\n    version: boolean\n    /**\n     * Delay before application stops automatically <milliseconds>\n     *\n     * The `--timeout` option specifies how long the application runs before it stops, whether it is recording a video or showing a preview. In the case of still image capture, the application will show the preview window for this long before capturing the output image.\n     *\n     * If unspecified, the default value is 5000 (5 seconds). The value zero causes the application to run indefinitely.\n     */\n    timeout: number\n  }\n\n  export interface PreviewWindowOptions {\n    /**\n     * Preview window settings\n     *\n     * Sets the size and location of the preview window (both X Windows and DRM versions). It does not affect the resolution or aspect ratio of images being requested from the camera. The camera images will be scaled to the size of the preview window for display, and will be pillar/letter-boxed to fit.\n     *\n     * Example:\n     * ```json\n     * { \"x\": 100, \"y\": 100, \"width\": 500, \"height\": 500 }\n     * ```\n     */\n    preview: PreviewOption\n    /**\n     * Fullscreen preview mode\n     *\n     * Forces the preview window to use the whole screen, and the window will have no border or title bar. Again the image may be pillar/letter-boxed.\n     */\n    fullscreen: boolean\n    /**\n     * Use Qt-based preview window\n     *\n     * The preview window is switched to use the Qt-based implementation. This option is not normally recommended because it no longer uses zero-copy buffer sharing nor GPU acceleration and is therefore very expensive, however, it does support X forwarding (which the other preview implementations do not).\n     *\n     * The Qt preview window does not support the `--fullscreen` option. Generally it is advised to try and keep the preview window small.\n     */\n    'qt-preview': boolean\n    /**\n     * Do not display a preview window\n     *\n     * The preview window is suppressed entirely.\n     */\n    nopreview: boolean\n    /**\n     * Set window title bar text <string>\n     *\n     * The supplied string is set as the title of the preview window (when running under X Windows). Additionally the string may contain a number of `%` directives which are substituted with information from the image metadata. The permitted directives are:\n     *\n     * | Directive        | Substitution        |\n     * | :--------------- | :------------------ |\n     * | `%frame`         | The sequence number of the frame |\n     * | `%fps`           | The instantaneous frame rate |\n     * | `%exp`           | The shutter speed used to capture the image, in microseconds |\n     * | `%ag`            | The analogue gain applied to the image in the sensor |\n     * | `%dg`            | The digital gain applied to the image by the ISP |\n     * | `%rg`            | The gain applied to the red component of each pixel |\n     * | `%bg`            | The gain applied to the blue component of each pixel |\n     * | `%focus`         | The focus metric for the image, where a larger value implies a sharper image |\n     *\n     * When not provided, the `--info-text` string defaults to `\"#%frame (%fps fps) exp %exp ag %ag dg %dg\"`.\n     */\n    'info-text': string\n  }\n\n  export interface CameraResolutionOptions {\n    /**\n     * Capture image width <width>\n     *\n     * This number specifies the output resolution of the camera images captured by libcamera-still, libcamera-jpeg and libcamera-vid.\n     *\n     * For libcamera-raw, it affects the size of the raw frames captured. Where a camera has a 2x2 binned readout mode, specifying a resolution not larger than this binned mode will result in the capture of 2x2 binned raw frames.\n     *\n     * For libcamera-hello these parameters have no effect.\n     */\n    width: number\n    /**\n     * Capture image height <height>\n     *\n     * This number specifies the output resolution of the camera images captured by libcamera-still, libcamera-jpeg and libcamera-vid.\n     *\n     * For libcamera-raw, it affects the size of the raw frames captured. Where a camera has a 2x2 binned readout mode, specifying a resolution not larger than this binned mode will result in the capture of 2x2 binned raw frames.\n     *\n     * For libcamera-hello these parameters have no effect.\n     */\n    height: number\n  }\n\n  export interface OutputFileOptions {\n    /**\n     * Output file name <string>\n     *\n     * `--output` sets the name of the output file to which the output image or video is written. Besides regular file names, this may take the following special values:\n     *\n     * `-` - write to stdout\n     *\n     * `udp://` - a string starting with this is taken as a network address for streaming\n     *\n     * `tcp://` - a string starting with this is taken as a network address for streaming\n     *\n     * a string containing a `%d` directive is taken as a file name where the format directive is replaced with a count that increments for each file that is opened. Standard C format directive modifiers are permitted.\n     */\n    output: string\n  }\n\n  export interface VideoOptions {\n    /**\n     * Saves timestamp information to the specified file. Useful as an input file to `mkvmerge`.\n     */\n    'save-pts': string\n  }\n\n  export type OptionsObject = CommandLineOptions &\n    PreviewWindowOptions &\n    CameraResolutionOptions &\n    OutputFileOptions &\n    VideoOptions\n\n  export type OptionKeys = keyof OptionsObject\n  export type OptionConverter = (val: any) => string\n\n  export interface PreviewOption {\n    x: number\n    y: number\n    width: number\n    height: number\n  }\n}\n\nexport const optionConverterMap: Partial<Record<\n  LibCamera.OptionKeys,\n  LibCamera.OptionConverter\n>> = {\n  preview(val: LibCamera.PreviewOption) {\n    return `${val.x},${val.y},${val.width},${val.height}`\n  },\n} as const\n","import { exec, ExecOptionsWithBufferEncoding } from 'child_process'\nimport { optionConverterMap, LibCamera } from './options'\n\nexport function cmd(base: string, args?: string[]): string {\n  if (base && !args) return base\n  return `${base} ${args?.join(' ')}`\n}\n\nexport function run(command: string, options?: ExecOptionsWithBufferEncoding) {\n  return new Promise((resolve, reject) => {\n    exec(command, options, (error, stdout, stderr) => {\n      if (stderr || error) reject(stderr || error)\n      resolve(stdout)\n    })\n  })\n}\n\nexport function convertOptionsToCmdArgs(\n  options: Partial<LibCamera.OptionsObject>\n): string[] {\n  const args: string[] = []\n  Object.entries(options).forEach(([key, val]) => {\n    const converter = optionConverterMap[key as LibCamera.OptionKeys]\n    const value = typeof converter === 'function' ? converter(val) : val\n    if (value) args.push(`--${key}`)\n    if (value !== true && value?.toString()) args.push(value?.toString())\n  }, true)\n  return args\n}\n","import { LibCamera } from './options'\nimport { run, cmd, convertOptionsToCmdArgs } from './utils'\n\nfunction runLibCamera(\n  bin: string = 'libcamera-still',\n  options: Partial<LibCamera.OptionsObject>\n) {\n  const args = convertOptionsToCmdArgs(options)\n  const command = cmd(bin, args)\n  if (__DEV__) {\n    console.log(command)\n    return command\n  }\n  return run(command)\n}\n\nexport function jpeg(options: Partial<LibCamera.OptionsObject>) {\n  return runLibCamera('libcamera-jpeg', options)\n}\n\nexport function still(options: Partial<LibCamera.OptionsObject>) {\n  return runLibCamera('libcamera-still', options)\n}\n\nexport function vid(options: Partial<LibCamera.OptionsObject>) {\n  return runLibCamera('libcamera-vid', options)\n}\n"],"names":["optionConverterMap","preview","val","x","y","width","height","cmd","base","args","join","convertOptionsToCmdArgs","options","Object","entries","forEach","key","converter","value","push","toString","runLibCamera","bin","command","console","log","jpeg","still","vid"],"mappings":";;;;;;AA6IO,IAAMA,kBAAkB,GAG1B;AACHC,EAAAA,OADG,mBACKC,GADL;AAED,WAAUA,GAAG,CAACC,CAAd,SAAmBD,GAAG,CAACE,CAAvB,SAA4BF,GAAG,CAACG,KAAhC,SAAyCH,GAAG,CAACI,MAA7C;AACD;AAHE,CAHE;;SC1ISC,IAAIC,MAAcC;AAChC,MAAID,IAAI,IAAI,CAACC,IAAb,EAAmB,OAAOD,IAAP;AACnB,SAAUA,IAAV,UAAkBC,IAAlB,oBAAkBA,IAAI,CAAEC,IAAN,CAAW,GAAX,CAAlB;AACD;AAED,SASgBC,wBACdC;AAEA,MAAMH,IAAI,GAAa,EAAvB;AACAI,EAAAA,MAAM,CAACC,OAAP,CAAeF,OAAf,EAAwBG,OAAxB,CAAgC;QAAEC;QAAKd;AACrC,QAAMe,SAAS,GAAGjB,kBAAkB,CAACgB,GAAD,CAApC;AACA,QAAME,KAAK,GAAG,OAAOD,SAAP,KAAqB,UAArB,GAAkCA,SAAS,CAACf,GAAD,CAA3C,GAAmDA,GAAjE;AACA,QAAIgB,KAAJ,EAAWT,IAAI,CAACU,IAAL,QAAeH,GAAf;AACX,QAAIE,KAAK,KAAK,IAAV,IAAkBA,KAAlB,YAAkBA,KAAK,CAAEE,QAAP,EAAtB,EAAyCX,IAAI,CAACU,IAAL,CAAUD,KAAV,oBAAUA,KAAK,CAAEE,QAAP,EAAV;AAC1C,GALD,EAKG,IALH;AAMA,SAAOX,IAAP;AACD;;ACzBD,SAASY,YAAT,CACEC,GADF,EAEEV,OAFF;MACEU;AAAAA,IAAAA,MAAc;;;AAGd,MAAMb,IAAI,GAAGE,uBAAuB,CAACC,OAAD,CAApC;AACA,MAAMW,OAAO,GAAGhB,GAAG,CAACe,GAAD,EAAMb,IAAN,CAAnB;;AACA,EAAa;AACXe,IAAAA,OAAO,CAACC,GAAR,CAAYF,OAAZ;AACA,WAAOA,OAAP;AACD;AAEF;;AAED,SAAgBG,KAAKd;AACnB,SAAOS,YAAY,CAAC,gBAAD,EAAmBT,OAAnB,CAAnB;AACD;AAED,SAAgBe,MAAMf;AACpB,SAAOS,YAAY,CAAC,iBAAD,EAAoBT,OAApB,CAAnB;AACD;AAED,SAAgBgB,IAAIhB;AAClB,SAAOS,YAAY,CAAC,eAAD,EAAkBT,OAAlB,CAAnB;AACD;;;;;;"}

package/dist/node-libcamera.cjs.production.min.js

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var t=require("child_process"),e={help:{short:"h",desc:"Print help information for the application"},version:{desc:"Print help information for the application"},timeout:{short:"t",desc:"Delay before application stops automatically <milliseconds>",validator:function(t){return"number"==typeof t},convert:function(t){return t.toString()}},preview:{short:"p",desc:"Preview window settings <x,y,w,h>",validator:function(t){return"object"==typeof t&&Boolean((null==t?void 0:t.x)&&(null==t?void 0:t.y)&&(null==t?void 0:t.width)&&(null==t?void 0:t.height))},convert:function(t){return t.x+","+t.y+","+t.width+","+t.height}},fullscreen:{short:"f",desc:"Fullscreen preview mode"},"qt-preview":{desc:"Use Qt-based preview window"},nopreview:{short:"n",desc:"Do not display a preview window"},"info-text":{desc:"Set window title bar text <string>",validator:function(t){return"string"==typeof t}},width:{desc:"Capture image width <width>",validator:function(t){return"number"==typeof t},convert:function(t){return t.toString()}},height:{desc:"Capture image height <height>",validator:function(t){return"number"==typeof t},convert:function(t){return t.toString()}},"viewfinder-width":{desc:"Capture image width <width>",validator:function(t){return"number"==typeof t},convert:function(t){return t.toString()}},"viewfinder-height":{desc:"Capture image height <height>",validator:function(t){return"number"==typeof t},convert:function(t){return t.toString()}},output:{short:"o",desc:"Output file name <string>",validator:function(t){return"string"==typeof t}}};exports.snap=function(n){return r=function(t,e){return e?t+" "+(null==e?void 0:e.join(" ")):t}("libcamera-still",function(t){var n=[];return Object.entries(t).forEach((function(t){var r=t[0],i=t[1],o=e[r];if("function"==typeof o.validator&&!o.validator(i))throw new Error('Invalid value for option "'+r+'"');var u="function"==typeof o.convert?o.convert(i):i;u&&n.push("--"+r),!0!==u&&n.push(u)}),!0),n}(n)),new Promise((function(e,n){t.exec(r,void 0,(function(t,r,i){(i||t)&&n(i||t),e(r)}))}));var r};
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("child_process"),n={preview:function(e){return e.x+","+e.y+","+e.width+","+e.height}};function r(r,t){return void 0===r&&(r="libcamera-still"),i=function(e,n){return e&&!n?e:e+" "+(null==n?void 0:n.join(" "))}(r,function(e){var r=[];return Object.entries(e).forEach((function(e){var t=e[0],i=e[1],o=n[t],u="function"==typeof o?o(i):i;u&&r.push("--"+t),!0!==u&&null!=u&&u.toString()&&r.push(null==u?void 0:u.toString())}),!0),r}(t)),new Promise((function(n,r){e.exec(i,void 0,(function(e,t,i){(i||e)&&r(i||e),n(t)}))}));var i}exports.jpeg=function(e){return r("libcamera-jpeg",e)},exports.still=function(e){return r("libcamera-still",e)},exports.vid=function(e){return r("libcamera-vid",e)};
 //# sourceMappingURL=node-libcamera.cjs.production.min.js.map

package/dist/node-libcamera.cjs.production.min.js.map

@@ -1 +1 @@
-{"version":3,"file":"node-libcamera.cjs.production.min.js","sources":["../src/options.ts","../src/index.ts","../src/utils.ts"],"sourcesContent":["export namespace LibCamera {\n  export type OptionKeys = typeof OPTION_KEYS[number]\n\n  export interface OptionDefinition {\n    short?: string\n    desc?: string\n    validator?: (val: any) => boolean\n    convert?: (val: any) => string\n  }\n\n  export type OptionsObject = {\n    [key in OptionKeys]?: any\n  }\n\n  export interface PreviewOption {\n    x: number\n    y: number\n    width: number\n    height: number\n  }\n}\n\nexport const OPTION_KEYS = [\n  'help',\n  'version',\n  'timeout',\n  'preview',\n  'fullscreen',\n  'qt-preview',\n  'nopreview',\n  'info-text',\n  'width',\n  'height',\n  'viewfinder-width',\n  'viewfinder-height',\n  // ...\n  'output',\n] as const\n\nexport const OPTIONS: Record<\n  LibCamera.OptionKeys,\n  LibCamera.OptionDefinition\n> = {\n  help: {\n    short: 'h',\n    desc: 'Print help information for the application',\n  },\n  version: {\n    desc: 'Print help information for the application',\n  },\n  timeout: {\n    short: 't',\n    desc: 'Delay before application stops automatically <milliseconds>',\n    validator: (val: number) => typeof val === 'number',\n    convert: (val: number) => val.toString(),\n  },\n  preview: {\n    short: 'p',\n    desc: 'Preview window settings <x,y,w,h>',\n    validator(val: LibCamera.PreviewOption) {\n      return (\n        typeof val === 'object' &&\n        Boolean(val?.x && val?.y && val?.width && val?.height)\n      )\n    },\n    convert(val: LibCamera.PreviewOption) {\n      return `${val.x},${val.y},${val.width},${val.height}`\n    },\n  },\n  fullscreen: {\n    short: 'f',\n    desc: 'Fullscreen preview mode',\n  },\n  'qt-preview': {\n    desc: 'Use Qt-based preview window',\n  },\n  nopreview: {\n    short: 'n',\n    desc: 'Do not display a preview window',\n  },\n  'info-text': {\n    desc: 'Set window title bar text <string>',\n    validator: (val: string) => typeof val === 'string',\n  },\n  width: {\n    desc: 'Capture image width <width>',\n    validator: (val: number) => typeof val === 'number',\n    convert: (val: number) => val.toString(),\n  },\n  height: {\n    desc: 'Capture image height <height>',\n    validator: (val: number) => typeof val === 'number',\n    convert: (val: number) => val.toString(),\n  },\n  'viewfinder-width': {\n    desc: 'Capture image width <width>',\n    validator: (val: number) => typeof val === 'number',\n    convert: (val: number) => val.toString(),\n  },\n  'viewfinder-height': {\n    desc: 'Capture image height <height>',\n    validator: (val: number) => typeof val === 'number',\n    convert: (val: number) => val.toString(),\n  },\n\n  // ...\n\n  output: {\n    short: 'o',\n    desc: 'Output file name <string>',\n    validator: (val: string) => typeof val === 'string',\n  },\n} as const\n","import { LibCamera } from './options'\nimport { run, cmd, convertOptionsToCmdArgs } from './utils'\n\nexport function snap(options: LibCamera.OptionsObject) {\n  const args = convertOptionsToCmdArgs(options)\n  const command = cmd('libcamera-still', args)\n  return run(command)\n}\n","import { exec, ExecOptionsWithBufferEncoding } from 'child_process'\nimport { OPTIONS, LibCamera } from './options'\n\nexport function cmd(base: string, args?: string[]): string {\n  if (base && !args) return base\n  return `${base} ${args?.join(' ')}`\n}\n\nexport function run(command: string, options?: ExecOptionsWithBufferEncoding) {\n  return new Promise((resolve, reject) => {\n    exec(command, options, (error, stdout, stderr) => {\n      if (stderr || error) reject(stderr || error)\n      resolve(stdout)\n    })\n  })\n}\n\nexport function convertOptionsToCmdArgs(\n  options: LibCamera.OptionsObject\n): string[] {\n  const args: string[] = []\n  Object.entries(options).forEach(([key, val]) => {\n    const opt = OPTIONS[key as LibCamera.OptionKeys]\n    if (typeof opt.validator === 'function' && !opt.validator(val)) {\n      throw new Error(`Invalid value for option \"${key}\"`)\n    }\n    const value = typeof opt.convert === 'function' ? opt.convert(val) : val\n    if (value) args.push(`--${key}`)\n    if (value !== true) args.push(value)\n  }, true)\n  return args\n}\n"],"names":["OPTIONS","help","desc","version","timeout","validator","val","convert","toString","preview","Boolean","x","y","width","height","fullscreen","nopreview","output","options","command","base","args","join","cmd","Object","entries","forEach","key","opt","Error","value","push","convertOptionsToCmdArgs","Promise","resolve","reject","exec","run","error","stdout","stderr"],"mappings":"mGAuCaA,EAGT,CACFC,KAAM,OACG,IACPC,KAAM,8CAERC,QAAS,CACPD,KAAM,8CAERE,QAAS,OACA,IACPF,KAAM,8DACNG,UAAW,SAACC,SAA+B,iBAARA,GACnCC,QAAS,SAACD,UAAgBA,EAAIE,aAEhCC,QAAS,OACA,IACPP,KAAM,oCACNG,mBAAUC,SAES,iBAARA,GACPI,eAAQJ,SAAAA,EAAKK,WAAKL,SAAAA,EAAKM,WAAKN,SAAAA,EAAKO,eAASP,SAAAA,EAAKQ,UAGnDP,iBAAQD,UACIA,EAAIK,MAAKL,EAAIM,MAAKN,EAAIO,UAASP,EAAIQ,SAGjDC,WAAY,OACH,IACPb,KAAM,wCAEM,CACZA,KAAM,+BAERc,UAAW,OACF,IACPd,KAAM,+CAEK,CACXA,KAAM,qCACNG,UAAW,SAACC,SAA+B,iBAARA,IAErCO,MAAO,CACLX,KAAM,8BACNG,UAAW,SAACC,SAA+B,iBAARA,GACnCC,QAAS,SAACD,UAAgBA,EAAIE,aAEhCM,OAAQ,CACNZ,KAAM,gCACNG,UAAW,SAACC,SAA+B,iBAARA,GACnCC,QAAS,SAACD,UAAgBA,EAAIE,gCAEZ,CAClBN,KAAM,8BACNG,UAAW,SAACC,SAA+B,iBAARA,GACnCC,QAAS,SAACD,UAAgBA,EAAIE,iCAEX,CACnBN,KAAM,gCACNG,UAAW,SAACC,SAA+B,iBAARA,GACnCC,QAAS,SAACD,UAAgBA,EAAIE,aAKhCS,OAAQ,OACC,IACPf,KAAM,4BACNG,UAAW,SAACC,SAA+B,iBAARA,2BC3GlBY,UCKDC,WALAC,EAAcC,UACnBA,EACHD,aAAQC,SAAAA,EAAMC,KAAK,MADHF,EDCVG,CAAI,2BCapBL,OAEMG,EAAiB,UACvBG,OAAOC,QAAQP,GAASQ,SAAQ,gBAAEC,OAAKrB,OAC/BsB,EAAM5B,EAAQ2B,MACS,mBAAlBC,EAAIvB,YAA6BuB,EAAIvB,UAAUC,SAClD,IAAIuB,mCAAmCF,WAEzCG,EAA+B,mBAAhBF,EAAIrB,QAAyBqB,EAAIrB,QAAQD,GAAOA,EACjEwB,GAAOT,EAAKU,UAAUJ,IACZ,IAAVG,GAAgBT,EAAKU,KAAKD,MAC7B,GACIT,ED1BMW,CAAwBd,ICK9B,IAAIe,SAAQ,SAACC,EAASC,GAC3BC,OAAKjB,ODJAkB,GCIkB,SAACC,EAAOC,EAAQC,IACjCA,GAAUF,IAAOH,EAAOK,GAAUF,GACtCJ,EAAQK,aAJMpB"}
+{"version":3,"file":"node-libcamera.cjs.production.min.js","sources":["../src/options.ts","../src/index.ts","../src/utils.ts"],"sourcesContent":["export namespace LibCamera {\n  export interface CommandLineOptions {\n    /**\n     * Print help information for the application\n     *\n     * The `--help` option causes every application to print its full set of command line options with a brief synopsis of each, and then quit.\n     **/\n    help: boolean\n    /**\n     * Print out a software version number\n     *\n     * All `libcamera-apps` will, when they see the `--version` option, print out a version string both for `libcamera` and `libcamera-apps` and then quit.\n     */\n    version: boolean\n    /**\n     * Delay before application stops automatically <milliseconds>\n     *\n     * The `--timeout` option specifies how long the application runs before it stops, whether it is recording a video or showing a preview. In the case of still image capture, the application will show the preview window for this long before capturing the output image.\n     *\n     * If unspecified, the default value is 5000 (5 seconds). The value zero causes the application to run indefinitely.\n     */\n    timeout: number\n  }\n\n  export interface PreviewWindowOptions {\n    /**\n     * Preview window settings\n     *\n     * Sets the size and location of the preview window (both X Windows and DRM versions). It does not affect the resolution or aspect ratio of images being requested from the camera. The camera images will be scaled to the size of the preview window for display, and will be pillar/letter-boxed to fit.\n     *\n     * Example:\n     * ```json\n     * { \"x\": 100, \"y\": 100, \"width\": 500, \"height\": 500 }\n     * ```\n     */\n    preview: PreviewOption\n    /**\n     * Fullscreen preview mode\n     *\n     * Forces the preview window to use the whole screen, and the window will have no border or title bar. Again the image may be pillar/letter-boxed.\n     */\n    fullscreen: boolean\n    /**\n     * Use Qt-based preview window\n     *\n     * The preview window is switched to use the Qt-based implementation. This option is not normally recommended because it no longer uses zero-copy buffer sharing nor GPU acceleration and is therefore very expensive, however, it does support X forwarding (which the other preview implementations do not).\n     *\n     * The Qt preview window does not support the `--fullscreen` option. Generally it is advised to try and keep the preview window small.\n     */\n    'qt-preview': boolean\n    /**\n     * Do not display a preview window\n     *\n     * The preview window is suppressed entirely.\n     */\n    nopreview: boolean\n    /**\n     * Set window title bar text <string>\n     *\n     * The supplied string is set as the title of the preview window (when running under X Windows). Additionally the string may contain a number of `%` directives which are substituted with information from the image metadata. The permitted directives are:\n     *\n     * | Directive        | Substitution        |\n     * | :--------------- | :------------------ |\n     * | `%frame`         | The sequence number of the frame |\n     * | `%fps`           | The instantaneous frame rate |\n     * | `%exp`           | The shutter speed used to capture the image, in microseconds |\n     * | `%ag`            | The analogue gain applied to the image in the sensor |\n     * | `%dg`            | The digital gain applied to the image by the ISP |\n     * | `%rg`            | The gain applied to the red component of each pixel |\n     * | `%bg`            | The gain applied to the blue component of each pixel |\n     * | `%focus`         | The focus metric for the image, where a larger value implies a sharper image |\n     *\n     * When not provided, the `--info-text` string defaults to `\"#%frame (%fps fps) exp %exp ag %ag dg %dg\"`.\n     */\n    'info-text': string\n  }\n\n  export interface CameraResolutionOptions {\n    /**\n     * Capture image width <width>\n     *\n     * This number specifies the output resolution of the camera images captured by libcamera-still, libcamera-jpeg and libcamera-vid.\n     *\n     * For libcamera-raw, it affects the size of the raw frames captured. Where a camera has a 2x2 binned readout mode, specifying a resolution not larger than this binned mode will result in the capture of 2x2 binned raw frames.\n     *\n     * For libcamera-hello these parameters have no effect.\n     */\n    width: number\n    /**\n     * Capture image height <height>\n     *\n     * This number specifies the output resolution of the camera images captured by libcamera-still, libcamera-jpeg and libcamera-vid.\n     *\n     * For libcamera-raw, it affects the size of the raw frames captured. Where a camera has a 2x2 binned readout mode, specifying a resolution not larger than this binned mode will result in the capture of 2x2 binned raw frames.\n     *\n     * For libcamera-hello these parameters have no effect.\n     */\n    height: number\n  }\n\n  export interface OutputFileOptions {\n    /**\n     * Output file name <string>\n     *\n     * `--output` sets the name of the output file to which the output image or video is written. Besides regular file names, this may take the following special values:\n     *\n     * `-` - write to stdout\n     *\n     * `udp://` - a string starting with this is taken as a network address for streaming\n     *\n     * `tcp://` - a string starting with this is taken as a network address for streaming\n     *\n     * a string containing a `%d` directive is taken as a file name where the format directive is replaced with a count that increments for each file that is opened. Standard C format directive modifiers are permitted.\n     */\n    output: string\n  }\n\n  export interface VideoOptions {\n    /**\n     * Saves timestamp information to the specified file. Useful as an input file to `mkvmerge`.\n     */\n    'save-pts': string\n  }\n\n  export type OptionsObject = CommandLineOptions &\n    PreviewWindowOptions &\n    CameraResolutionOptions &\n    OutputFileOptions &\n    VideoOptions\n\n  export type OptionKeys = keyof OptionsObject\n  export type OptionConverter = (val: any) => string\n\n  export interface PreviewOption {\n    x: number\n    y: number\n    width: number\n    height: number\n  }\n}\n\nexport const optionConverterMap: Partial<Record<\n  LibCamera.OptionKeys,\n  LibCamera.OptionConverter\n>> = {\n  preview(val: LibCamera.PreviewOption) {\n    return `${val.x},${val.y},${val.width},${val.height}`\n  },\n} as const\n","import { LibCamera } from './options'\nimport { run, cmd, convertOptionsToCmdArgs } from './utils'\n\nfunction runLibCamera(\n  bin: string = 'libcamera-still',\n  options: Partial<LibCamera.OptionsObject>\n) {\n  const args = convertOptionsToCmdArgs(options)\n  const command = cmd(bin, args)\n  if (__DEV__) {\n    console.log(command)\n    return command\n  }\n  return run(command)\n}\n\nexport function jpeg(options: Partial<LibCamera.OptionsObject>) {\n  return runLibCamera('libcamera-jpeg', options)\n}\n\nexport function still(options: Partial<LibCamera.OptionsObject>) {\n  return runLibCamera('libcamera-still', options)\n}\n\nexport function vid(options: Partial<LibCamera.OptionsObject>) {\n  return runLibCamera('libcamera-vid', options)\n}\n","import { exec, ExecOptionsWithBufferEncoding } from 'child_process'\nimport { optionConverterMap, LibCamera } from './options'\n\nexport function cmd(base: string, args?: string[]): string {\n  if (base && !args) return base\n  return `${base} ${args?.join(' ')}`\n}\n\nexport function run(command: string, options?: ExecOptionsWithBufferEncoding) {\n  return new Promise((resolve, reject) => {\n    exec(command, options, (error, stdout, stderr) => {\n      if (stderr || error) reject(stderr || error)\n      resolve(stdout)\n    })\n  })\n}\n\nexport function convertOptionsToCmdArgs(\n  options: Partial<LibCamera.OptionsObject>\n): string[] {\n  const args: string[] = []\n  Object.entries(options).forEach(([key, val]) => {\n    const converter = optionConverterMap[key as LibCamera.OptionKeys]\n    const value = typeof converter === 'function' ? converter(val) : val\n    if (value) args.push(`--${key}`)\n    if (value !== true && value?.toString()) args.push(value?.toString())\n  }, true)\n  return args\n}\n"],"names":["optionConverterMap","preview","val","x","y","width","height","runLibCamera","bin","options","command","base","args","join","cmd","Object","entries","forEach","key","converter","value","push","toString","convertOptionsToCmdArgs","Promise","resolve","reject","exec","run","error","stdout","stderr"],"mappings":"mGA6IaA,EAGR,CACHC,iBAAQC,UACIA,EAAIC,MAAKD,EAAIE,MAAKF,EAAIG,UAASH,EAAII,SC/IjD,SAASC,EACPC,EACAC,mBADAD,IAAAA,EAAc,mBCIIE,WALAC,EAAcC,UAC5BD,IAASC,EAAaD,EAChBA,aAAQC,SAAAA,EAAMC,KAAK,MDGbC,CAAIN,WCUpBC,OAEMG,EAAiB,UACvBG,OAAOC,QAAQP,GAASQ,SAAQ,gBAAEC,OAAKhB,OAC/BiB,EAAYnB,EAAmBkB,GAC/BE,EAA6B,mBAAdD,EAA2BA,EAAUjB,GAAOA,EAC7DkB,GAAOR,EAAKS,UAAUH,IACZ,IAAVE,SAAkBA,GAAAA,EAAOE,YAAYV,EAAKS,WAAKD,SAAAA,EAAOE,eACzD,GACIV,EDpBMW,CAAwBd,ICE9B,IAAIe,SAAQ,SAACC,EAASC,GAC3BC,OAAKjB,ODGAkB,GCHkB,SAACC,EAAOC,EAAQC,IACjCA,GAAUF,IAAOH,EAAOK,GAAUF,GACtCJ,EAAQK,aAJMpB,wBDQCD,UACZF,EAAa,iBAAkBE,2BAGlBA,UACbF,EAAa,kBAAmBE,yBAGrBA,UACXF,EAAa,gBAAiBE"}

package/dist/node-libcamera.esm.js

@@ -1,93 +1,8 @@
 import { exec } from 'child_process';
 
-var OPTIONS = {
-  help: {
-    "short": 'h',
-    desc: 'Print help information for the application'
-  },
-  version: {
-    desc: 'Print help information for the application'
-  },
-  timeout: {
-    "short": 't',
-    desc: 'Delay before application stops automatically <milliseconds>',
-    validator: function validator(val) {
-      return typeof val === 'number';
-    },
-    convert: function convert(val) {
-      return val.toString();
-    }
-  },
-  preview: {
-    "short": 'p',
-    desc: 'Preview window settings <x,y,w,h>',
-    validator: function validator(val) {
-      return typeof val === 'object' && Boolean((val == null ? void 0 : val.x) && (val == null ? void 0 : val.y) && (val == null ? void 0 : val.width) && (val == null ? void 0 : val.height));
-    },
-    convert: function convert(val) {
-      return val.x + "," + val.y + "," + val.width + "," + val.height;
-    }
-  },
-  fullscreen: {
-    "short": 'f',
-    desc: 'Fullscreen preview mode'
-  },
-  'qt-preview': {
-    desc: 'Use Qt-based preview window'
-  },
-  nopreview: {
-    "short": 'n',
-    desc: 'Do not display a preview window'
-  },
-  'info-text': {
-    desc: 'Set window title bar text <string>',
-    validator: function validator(val) {
-      return typeof val === 'string';
-    }
-  },
-  width: {
-    desc: 'Capture image width <width>',
-    validator: function validator(val) {
-      return typeof val === 'number';
-    },
-    convert: function convert(val) {
-      return val.toString();
-    }
-  },
-  height: {
-    desc: 'Capture image height <height>',
-    validator: function validator(val) {
-      return typeof val === 'number';
-    },
-    convert: function convert(val) {
-      return val.toString();
-    }
-  },
-  'viewfinder-width': {
-    desc: 'Capture image width <width>',
-    validator: function validator(val) {
-      return typeof val === 'number';
-    },
-    convert: function convert(val) {
-      return val.toString();
-    }
-  },
-  'viewfinder-height': {
-    desc: 'Capture image height <height>',
-    validator: function validator(val) {
-      return typeof val === 'number';
-    },
-    convert: function convert(val) {
-      return val.toString();
-    }
-  },
-  // ...
-  output: {
-    "short": 'o',
-    desc: 'Output file name <string>',
-    validator: function validator(val) {
-      return typeof val === 'string';
-    }
+var optionConverterMap = {
+  preview: function preview(val) {
+    return val.x + "," + val.y + "," + val.width + "," + val.height;
   }
 };
 
@@ -108,24 +23,39 @@ function convertOptionsToCmdArgs(options) {
   Object.entries(options).forEach(function (_ref) {
     var key = _ref[0],
         val = _ref[1];
-    var opt = OPTIONS[key];
-
-    if (typeof opt.validator === 'function' && !opt.validator(val)) {
-      throw new Error("Invalid value for option \"" + key + "\"");
-    }
-
-    var value = typeof opt.convert === 'function' ? opt.convert(val) : val;
+    var converter = optionConverterMap[key];
+    var value = typeof converter === 'function' ? converter(val) : val;
     if (value) args.push("--" + key);
-    if (value !== true) args.push(value);
+    if (value !== true && value != null && value.toString()) args.push(value == null ? void 0 : value.toString());
   }, true);
   return args;
 }
 
-function snap(options) {
+function runLibCamera(bin, options) {
+  if (bin === void 0) {
+    bin = 'libcamera-still';
+  }
+
   var args = convertOptionsToCmdArgs(options);
-  var command = cmd('libcamera-still', args);
+  var command = cmd(bin, args);
+
+  if (process.env.NODE_ENV !== "production") {
+    console.log(command);
+    return command;
+  }
+
   return run(command);
 }
 
-export { snap };
+function jpeg(options) {
+  return runLibCamera('libcamera-jpeg', options);
+}
+function still(options) {
+  return runLibCamera('libcamera-still', options);
+}
+function vid(options) {
+  return runLibCamera('libcamera-vid', options);
+}
+
+export { jpeg, still, vid };
 //# sourceMappingURL=node-libcamera.esm.js.map

package/dist/node-libcamera.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"node-libcamera.esm.js","sources":["../src/options.ts","../src/utils.ts","../src/index.ts"],"sourcesContent":["export namespace LibCamera {\n  export type OptionKeys = typeof OPTION_KEYS[number]\n\n  export interface OptionDefinition {\n    short?: string\n    desc?: string\n    validator?: (val: any) => boolean\n    convert?: (val: any) => string\n  }\n\n  export type OptionsObject = {\n    [key in OptionKeys]?: any\n  }\n\n  export interface PreviewOption {\n    x: number\n    y: number\n    width: number\n    height: number\n  }\n}\n\nexport const OPTION_KEYS = [\n  'help',\n  'version',\n  'timeout',\n  'preview',\n  'fullscreen',\n  'qt-preview',\n  'nopreview',\n  'info-text',\n  'width',\n  'height',\n  'viewfinder-width',\n  'viewfinder-height',\n  // ...\n  'output',\n] as const\n\nexport const OPTIONS: Record<\n  LibCamera.OptionKeys,\n  LibCamera.OptionDefinition\n> = {\n  help: {\n    short: 'h',\n    desc: 'Print help information for the application',\n  },\n  version: {\n    desc: 'Print help information for the application',\n  },\n  timeout: {\n    short: 't',\n    desc: 'Delay before application stops automatically <milliseconds>',\n    validator: (val: number) => typeof val === 'number',\n    convert: (val: number) => val.toString(),\n  },\n  preview: {\n    short: 'p',\n    desc: 'Preview window settings <x,y,w,h>',\n    validator(val: LibCamera.PreviewOption) {\n      return (\n        typeof val === 'object' &&\n        Boolean(val?.x && val?.y && val?.width && val?.height)\n      )\n    },\n    convert(val: LibCamera.PreviewOption) {\n      return `${val.x},${val.y},${val.width},${val.height}`\n    },\n  },\n  fullscreen: {\n    short: 'f',\n    desc: 'Fullscreen preview mode',\n  },\n  'qt-preview': {\n    desc: 'Use Qt-based preview window',\n  },\n  nopreview: {\n    short: 'n',\n    desc: 'Do not display a preview window',\n  },\n  'info-text': {\n    desc: 'Set window title bar text <string>',\n    validator: (val: string) => typeof val === 'string',\n  },\n  width: {\n    desc: 'Capture image width <width>',\n    validator: (val: number) => typeof val === 'number',\n    convert: (val: number) => val.toString(),\n  },\n  height: {\n    desc: 'Capture image height <height>',\n    validator: (val: number) => typeof val === 'number',\n    convert: (val: number) => val.toString(),\n  },\n  'viewfinder-width': {\n    desc: 'Capture image width <width>',\n    validator: (val: number) => typeof val === 'number',\n    convert: (val: number) => val.toString(),\n  },\n  'viewfinder-height': {\n    desc: 'Capture image height <height>',\n    validator: (val: number) => typeof val === 'number',\n    convert: (val: number) => val.toString(),\n  },\n\n  // ...\n\n  output: {\n    short: 'o',\n    desc: 'Output file name <string>',\n    validator: (val: string) => typeof val === 'string',\n  },\n} as const\n","import { exec, ExecOptionsWithBufferEncoding } from 'child_process'\nimport { OPTIONS, LibCamera } from './options'\n\nexport function cmd(base: string, args?: string[]): string {\n  if (base && !args) return base\n  return `${base} ${args?.join(' ')}`\n}\n\nexport function run(command: string, options?: ExecOptionsWithBufferEncoding) {\n  return new Promise((resolve, reject) => {\n    exec(command, options, (error, stdout, stderr) => {\n      if (stderr || error) reject(stderr || error)\n      resolve(stdout)\n    })\n  })\n}\n\nexport function convertOptionsToCmdArgs(\n  options: LibCamera.OptionsObject\n): string[] {\n  const args: string[] = []\n  Object.entries(options).forEach(([key, val]) => {\n    const opt = OPTIONS[key as LibCamera.OptionKeys]\n    if (typeof opt.validator === 'function' && !opt.validator(val)) {\n      throw new Error(`Invalid value for option \"${key}\"`)\n    }\n    const value = typeof opt.convert === 'function' ? opt.convert(val) : val\n    if (value) args.push(`--${key}`)\n    if (value !== true) args.push(value)\n  }, true)\n  return args\n}\n","import { LibCamera } from './options'\nimport { run, cmd, convertOptionsToCmdArgs } from './utils'\n\nexport function snap(options: LibCamera.OptionsObject) {\n  const args = convertOptionsToCmdArgs(options)\n  const command = cmd('libcamera-still', args)\n  return run(command)\n}\n"],"names":["OPTIONS","help","desc","version","timeout","validator","val","convert","toString","preview","Boolean","x","y","width","height","fullscreen","nopreview","output","cmd","base","args","join","run","command","options","Promise","resolve","reject","exec","error","stdout","stderr","convertOptionsToCmdArgs","Object","entries","forEach","key","opt","Error","value","push","snap"],"mappings":";;AAuCO,IAAMA,OAAO,GAGhB;AACFC,EAAAA,IAAI,EAAE;AACJ,aAAO,GADH;AAEJC,IAAAA,IAAI,EAAE;AAFF,GADJ;AAKFC,EAAAA,OAAO,EAAE;AACPD,IAAAA,IAAI,EAAE;AADC,GALP;AAQFE,EAAAA,OAAO,EAAE;AACP,aAAO,GADA;AAEPF,IAAAA,IAAI,EAAE,6DAFC;AAGPG,IAAAA,SAAS,EAAE,mBAACC,GAAD;AAAA,aAAiB,OAAOA,GAAP,KAAe,QAAhC;AAAA,KAHJ;AAIPC,IAAAA,OAAO,EAAE,iBAACD,GAAD;AAAA,aAAiBA,GAAG,CAACE,QAAJ,EAAjB;AAAA;AAJF,GARP;AAcFC,EAAAA,OAAO,EAAE;AACP,aAAO,GADA;AAEPP,IAAAA,IAAI,EAAE,mCAFC;AAGPG,IAAAA,SAHO,qBAGGC,GAHH;AAIL,aACE,OAAOA,GAAP,KAAe,QAAf,IACAI,OAAO,CAAC,CAAAJ,GAAG,QAAH,YAAAA,GAAG,CAAEK,CAAL,MAAUL,GAAV,oBAAUA,GAAG,CAAEM,CAAf,MAAoBN,GAApB,oBAAoBA,GAAG,CAAEO,KAAzB,MAAkCP,GAAlC,oBAAkCA,GAAG,CAAEQ,MAAvC,CAAD,CAFT;AAID,KARM;AASPP,IAAAA,OATO,mBASCD,GATD;AAUL,aAAUA,GAAG,CAACK,CAAd,SAAmBL,GAAG,CAACM,CAAvB,SAA4BN,GAAG,CAACO,KAAhC,SAAyCP,GAAG,CAACQ,MAA7C;AACD;AAXM,GAdP;AA2BFC,EAAAA,UAAU,EAAE;AACV,aAAO,GADG;AAEVb,IAAAA,IAAI,EAAE;AAFI,GA3BV;AA+BF,gBAAc;AACZA,IAAAA,IAAI,EAAE;AADM,GA/BZ;AAkCFc,EAAAA,SAAS,EAAE;AACT,aAAO,GADE;AAETd,IAAAA,IAAI,EAAE;AAFG,GAlCT;AAsCF,eAAa;AACXA,IAAAA,IAAI,EAAE,oCADK;AAEXG,IAAAA,SAAS,EAAE,mBAACC,GAAD;AAAA,aAAiB,OAAOA,GAAP,KAAe,QAAhC;AAAA;AAFA,GAtCX;AA0CFO,EAAAA,KAAK,EAAE;AACLX,IAAAA,IAAI,EAAE,6BADD;AAELG,IAAAA,SAAS,EAAE,mBAACC,GAAD;AAAA,aAAiB,OAAOA,GAAP,KAAe,QAAhC;AAAA,KAFN;AAGLC,IAAAA,OAAO,EAAE,iBAACD,GAAD;AAAA,aAAiBA,GAAG,CAACE,QAAJ,EAAjB;AAAA;AAHJ,GA1CL;AA+CFM,EAAAA,MAAM,EAAE;AACNZ,IAAAA,IAAI,EAAE,+BADA;AAENG,IAAAA,SAAS,EAAE,mBAACC,GAAD;AAAA,aAAiB,OAAOA,GAAP,KAAe,QAAhC;AAAA,KAFL;AAGNC,IAAAA,OAAO,EAAE,iBAACD,GAAD;AAAA,aAAiBA,GAAG,CAACE,QAAJ,EAAjB;AAAA;AAHH,GA/CN;AAoDF,sBAAoB;AAClBN,IAAAA,IAAI,EAAE,6BADY;AAElBG,IAAAA,SAAS,EAAE,mBAACC,GAAD;AAAA,aAAiB,OAAOA,GAAP,KAAe,QAAhC;AAAA,KAFO;AAGlBC,IAAAA,OAAO,EAAE,iBAACD,GAAD;AAAA,aAAiBA,GAAG,CAACE,QAAJ,EAAjB;AAAA;AAHS,GApDlB;AAyDF,uBAAqB;AACnBN,IAAAA,IAAI,EAAE,+BADa;AAEnBG,IAAAA,SAAS,EAAE,mBAACC,GAAD;AAAA,aAAiB,OAAOA,GAAP,KAAe,QAAhC;AAAA,KAFQ;AAGnBC,IAAAA,OAAO,EAAE,iBAACD,GAAD;AAAA,aAAiBA,GAAG,CAACE,QAAJ,EAAjB;AAAA;AAHU,GAzDnB;AA+DF;AAEAS,EAAAA,MAAM,EAAE;AACN,aAAO,GADD;AAENf,IAAAA,IAAI,EAAE,2BAFA;AAGNG,IAAAA,SAAS,EAAE,mBAACC,GAAD;AAAA,aAAiB,OAAOA,GAAP,KAAe,QAAhC;AAAA;AAHL;AAjEN,CAHG;;SCpCSY,IAAIC,MAAcC;AAChC,MAAID,IAAI,IAAI,CAACC,IAAb,EAAmB,OAAOD,IAAP;AACnB,SAAUA,IAAV,UAAkBC,IAAlB,oBAAkBA,IAAI,CAAEC,IAAN,CAAW,GAAX,CAAlB;AACD;AAED,SAAgBC,IAAIC,SAAiBC;AACnC,SAAO,IAAIC,OAAJ,CAAY,UAACC,OAAD,EAAUC,MAAV;AACjBC,IAAAA,IAAI,CAACL,OAAD,EAAUC,OAAV,EAAmB,UAACK,KAAD,EAAQC,MAAR,EAAgBC,MAAhB;AACrB,UAAIA,MAAM,IAAIF,KAAd,EAAqBF,MAAM,CAACI,MAAM,IAAIF,KAAX,CAAN;AACrBH,MAAAA,OAAO,CAACI,MAAD,CAAP;AACD,KAHG,CAAJ;AAID,GALM,CAAP;AAMD;AAED,SAAgBE,wBACdR;AAEA,MAAMJ,IAAI,GAAa,EAAvB;AACAa,EAAAA,MAAM,CAACC,OAAP,CAAeV,OAAf,EAAwBW,OAAxB,CAAgC;QAAEC;QAAK9B;AACrC,QAAM+B,GAAG,GAAGrC,OAAO,CAACoC,GAAD,CAAnB;;AACA,QAAI,OAAOC,GAAG,CAAChC,SAAX,KAAyB,UAAzB,IAAuC,CAACgC,GAAG,CAAChC,SAAJ,CAAcC,GAAd,CAA5C,EAAgE;AAC9D,YAAM,IAAIgC,KAAJ,iCAAuCF,GAAvC,QAAN;AACD;;AACD,QAAMG,KAAK,GAAG,OAAOF,GAAG,CAAC9B,OAAX,KAAuB,UAAvB,GAAoC8B,GAAG,CAAC9B,OAAJ,CAAYD,GAAZ,CAApC,GAAuDA,GAArE;AACA,QAAIiC,KAAJ,EAAWnB,IAAI,CAACoB,IAAL,QAAeJ,GAAf;AACX,QAAIG,KAAK,KAAK,IAAd,EAAoBnB,IAAI,CAACoB,IAAL,CAAUD,KAAV;AACrB,GARD,EAQG,IARH;AASA,SAAOnB,IAAP;AACD;;SC5BeqB,KAAKjB;AACnB,MAAMJ,IAAI,GAAGY,uBAAuB,CAACR,OAAD,CAApC;AACA,MAAMD,OAAO,GAAGL,GAAG,CAAC,iBAAD,EAAoBE,IAApB,CAAnB;AACA,SAAOE,GAAG,CAACC,OAAD,CAAV;AACD;;;;"}
+{"version":3,"file":"node-libcamera.esm.js","sources":["../src/options.ts","../src/utils.ts","../src/index.ts"],"sourcesContent":["export namespace LibCamera {\n  export interface CommandLineOptions {\n    /**\n     * Print help information for the application\n     *\n     * The `--help` option causes every application to print its full set of command line options with a brief synopsis of each, and then quit.\n     **/\n    help: boolean\n    /**\n     * Print out a software version number\n     *\n     * All `libcamera-apps` will, when they see the `--version` option, print out a version string both for `libcamera` and `libcamera-apps` and then quit.\n     */\n    version: boolean\n    /**\n     * Delay before application stops automatically <milliseconds>\n     *\n     * The `--timeout` option specifies how long the application runs before it stops, whether it is recording a video or showing a preview. In the case of still image capture, the application will show the preview window for this long before capturing the output image.\n     *\n     * If unspecified, the default value is 5000 (5 seconds). The value zero causes the application to run indefinitely.\n     */\n    timeout: number\n  }\n\n  export interface PreviewWindowOptions {\n    /**\n     * Preview window settings\n     *\n     * Sets the size and location of the preview window (both X Windows and DRM versions). It does not affect the resolution or aspect ratio of images being requested from the camera. The camera images will be scaled to the size of the preview window for display, and will be pillar/letter-boxed to fit.\n     *\n     * Example:\n     * ```json\n     * { \"x\": 100, \"y\": 100, \"width\": 500, \"height\": 500 }\n     * ```\n     */\n    preview: PreviewOption\n    /**\n     * Fullscreen preview mode\n     *\n     * Forces the preview window to use the whole screen, and the window will have no border or title bar. Again the image may be pillar/letter-boxed.\n     */\n    fullscreen: boolean\n    /**\n     * Use Qt-based preview window\n     *\n     * The preview window is switched to use the Qt-based implementation. This option is not normally recommended because it no longer uses zero-copy buffer sharing nor GPU acceleration and is therefore very expensive, however, it does support X forwarding (which the other preview implementations do not).\n     *\n     * The Qt preview window does not support the `--fullscreen` option. Generally it is advised to try and keep the preview window small.\n     */\n    'qt-preview': boolean\n    /**\n     * Do not display a preview window\n     *\n     * The preview window is suppressed entirely.\n     */\n    nopreview: boolean\n    /**\n     * Set window title bar text <string>\n     *\n     * The supplied string is set as the title of the preview window (when running under X Windows). Additionally the string may contain a number of `%` directives which are substituted with information from the image metadata. The permitted directives are:\n     *\n     * | Directive        | Substitution        |\n     * | :--------------- | :------------------ |\n     * | `%frame`         | The sequence number of the frame |\n     * | `%fps`           | The instantaneous frame rate |\n     * | `%exp`           | The shutter speed used to capture the image, in microseconds |\n     * | `%ag`            | The analogue gain applied to the image in the sensor |\n     * | `%dg`            | The digital gain applied to the image by the ISP |\n     * | `%rg`            | The gain applied to the red component of each pixel |\n     * | `%bg`            | The gain applied to the blue component of each pixel |\n     * | `%focus`         | The focus metric for the image, where a larger value implies a sharper image |\n     *\n     * When not provided, the `--info-text` string defaults to `\"#%frame (%fps fps) exp %exp ag %ag dg %dg\"`.\n     */\n    'info-text': string\n  }\n\n  export interface CameraResolutionOptions {\n    /**\n     * Capture image width <width>\n     *\n     * This number specifies the output resolution of the camera images captured by libcamera-still, libcamera-jpeg and libcamera-vid.\n     *\n     * For libcamera-raw, it affects the size of the raw frames captured. Where a camera has a 2x2 binned readout mode, specifying a resolution not larger than this binned mode will result in the capture of 2x2 binned raw frames.\n     *\n     * For libcamera-hello these parameters have no effect.\n     */\n    width: number\n    /**\n     * Capture image height <height>\n     *\n     * This number specifies the output resolution of the camera images captured by libcamera-still, libcamera-jpeg and libcamera-vid.\n     *\n     * For libcamera-raw, it affects the size of the raw frames captured. Where a camera has a 2x2 binned readout mode, specifying a resolution not larger than this binned mode will result in the capture of 2x2 binned raw frames.\n     *\n     * For libcamera-hello these parameters have no effect.\n     */\n    height: number\n  }\n\n  export interface OutputFileOptions {\n    /**\n     * Output file name <string>\n     *\n     * `--output` sets the name of the output file to which the output image or video is written. Besides regular file names, this may take the following special values:\n     *\n     * `-` - write to stdout\n     *\n     * `udp://` - a string starting with this is taken as a network address for streaming\n     *\n     * `tcp://` - a string starting with this is taken as a network address for streaming\n     *\n     * a string containing a `%d` directive is taken as a file name where the format directive is replaced with a count that increments for each file that is opened. Standard C format directive modifiers are permitted.\n     */\n    output: string\n  }\n\n  export interface VideoOptions {\n    /**\n     * Saves timestamp information to the specified file. Useful as an input file to `mkvmerge`.\n     */\n    'save-pts': string\n  }\n\n  export type OptionsObject = CommandLineOptions &\n    PreviewWindowOptions &\n    CameraResolutionOptions &\n    OutputFileOptions &\n    VideoOptions\n\n  export type OptionKeys = keyof OptionsObject\n  export type OptionConverter = (val: any) => string\n\n  export interface PreviewOption {\n    x: number\n    y: number\n    width: number\n    height: number\n  }\n}\n\nexport const optionConverterMap: Partial<Record<\n  LibCamera.OptionKeys,\n  LibCamera.OptionConverter\n>> = {\n  preview(val: LibCamera.PreviewOption) {\n    return `${val.x},${val.y},${val.width},${val.height}`\n  },\n} as const\n","import { exec, ExecOptionsWithBufferEncoding } from 'child_process'\nimport { optionConverterMap, LibCamera } from './options'\n\nexport function cmd(base: string, args?: string[]): string {\n  if (base && !args) return base\n  return `${base} ${args?.join(' ')}`\n}\n\nexport function run(command: string, options?: ExecOptionsWithBufferEncoding) {\n  return new Promise((resolve, reject) => {\n    exec(command, options, (error, stdout, stderr) => {\n      if (stderr || error) reject(stderr || error)\n      resolve(stdout)\n    })\n  })\n}\n\nexport function convertOptionsToCmdArgs(\n  options: Partial<LibCamera.OptionsObject>\n): string[] {\n  const args: string[] = []\n  Object.entries(options).forEach(([key, val]) => {\n    const converter = optionConverterMap[key as LibCamera.OptionKeys]\n    const value = typeof converter === 'function' ? converter(val) : val\n    if (value) args.push(`--${key}`)\n    if (value !== true && value?.toString()) args.push(value?.toString())\n  }, true)\n  return args\n}\n","import { LibCamera } from './options'\nimport { run, cmd, convertOptionsToCmdArgs } from './utils'\n\nfunction runLibCamera(\n  bin: string = 'libcamera-still',\n  options: Partial<LibCamera.OptionsObject>\n) {\n  const args = convertOptionsToCmdArgs(options)\n  const command = cmd(bin, args)\n  if (__DEV__) {\n    console.log(command)\n    return command\n  }\n  return run(command)\n}\n\nexport function jpeg(options: Partial<LibCamera.OptionsObject>) {\n  return runLibCamera('libcamera-jpeg', options)\n}\n\nexport function still(options: Partial<LibCamera.OptionsObject>) {\n  return runLibCamera('libcamera-still', options)\n}\n\nexport function vid(options: Partial<LibCamera.OptionsObject>) {\n  return runLibCamera('libcamera-vid', options)\n}\n"],"names":["optionConverterMap","preview","val","x","y","width","height","cmd","base","args","join","run","command","options","Promise","resolve","reject","exec","error","stdout","stderr","convertOptionsToCmdArgs","Object","entries","forEach","key","converter","value","push","toString","runLibCamera","bin","console","log","jpeg","still","vid"],"mappings":";;AA6IO,IAAMA,kBAAkB,GAG1B;AACHC,EAAAA,OADG,mBACKC,GADL;AAED,WAAUA,GAAG,CAACC,CAAd,SAAmBD,GAAG,CAACE,CAAvB,SAA4BF,GAAG,CAACG,KAAhC,SAAyCH,GAAG,CAACI,MAA7C;AACD;AAHE,CAHE;;SC1ISC,IAAIC,MAAcC;AAChC,MAAID,IAAI,IAAI,CAACC,IAAb,EAAmB,OAAOD,IAAP;AACnB,SAAUA,IAAV,UAAkBC,IAAlB,oBAAkBA,IAAI,CAAEC,IAAN,CAAW,GAAX,CAAlB;AACD;AAED,SAAgBC,IAAIC,SAAiBC;AACnC,SAAO,IAAIC,OAAJ,CAAY,UAACC,OAAD,EAAUC,MAAV;AACjBC,IAAAA,IAAI,CAACL,OAAD,EAAUC,OAAV,EAAmB,UAACK,KAAD,EAAQC,MAAR,EAAgBC,MAAhB;AACrB,UAAIA,MAAM,IAAIF,KAAd,EAAqBF,MAAM,CAACI,MAAM,IAAIF,KAAX,CAAN;AACrBH,MAAAA,OAAO,CAACI,MAAD,CAAP;AACD,KAHG,CAAJ;AAID,GALM,CAAP;AAMD;AAED,SAAgBE,wBACdR;AAEA,MAAMJ,IAAI,GAAa,EAAvB;AACAa,EAAAA,MAAM,CAACC,OAAP,CAAeV,OAAf,EAAwBW,OAAxB,CAAgC;QAAEC;QAAKvB;AACrC,QAAMwB,SAAS,GAAG1B,kBAAkB,CAACyB,GAAD,CAApC;AACA,QAAME,KAAK,GAAG,OAAOD,SAAP,KAAqB,UAArB,GAAkCA,SAAS,CAACxB,GAAD,CAA3C,GAAmDA,GAAjE;AACA,QAAIyB,KAAJ,EAAWlB,IAAI,CAACmB,IAAL,QAAeH,GAAf;AACX,QAAIE,KAAK,KAAK,IAAV,IAAkBA,KAAlB,YAAkBA,KAAK,CAAEE,QAAP,EAAtB,EAAyCpB,IAAI,CAACmB,IAAL,CAAUD,KAAV,oBAAUA,KAAK,CAAEE,QAAP,EAAV;AAC1C,GALD,EAKG,IALH;AAMA,SAAOpB,IAAP;AACD;;ACzBD,SAASqB,YAAT,CACEC,GADF,EAEElB,OAFF;MACEkB;AAAAA,IAAAA,MAAc;;;AAGd,MAAMtB,IAAI,GAAGY,uBAAuB,CAACR,OAAD,CAApC;AACA,MAAMD,OAAO,GAAGL,GAAG,CAACwB,GAAD,EAAMtB,IAAN,CAAnB;;AACA,6CAAa;AACXuB,IAAAA,OAAO,CAACC,GAAR,CAAYrB,OAAZ;AACA,WAAOA,OAAP;AACD;;AACD,SAAOD,GAAG,CAACC,OAAD,CAAV;AACD;;AAED,SAAgBsB,KAAKrB;AACnB,SAAOiB,YAAY,CAAC,gBAAD,EAAmBjB,OAAnB,CAAnB;AACD;AAED,SAAgBsB,MAAMtB;AACpB,SAAOiB,YAAY,CAAC,iBAAD,EAAoBjB,OAApB,CAAnB;AACD;AAED,SAAgBuB,IAAIvB;AAClB,SAAOiB,YAAY,CAAC,eAAD,EAAkBjB,OAAlB,CAAnB;AACD;;;;"}

package/dist/options.d.ts

@@ -1,14 +1,125 @@
 export declare namespace LibCamera {
-    type OptionKeys = typeof OPTION_KEYS[number];
-    interface OptionDefinition {
-        short?: string;
-        desc?: string;
-        validator?: (val: any) => boolean;
-        convert?: (val: any) => string;
+    interface CommandLineOptions {
+        /**
+         * Print help information for the application
+         *
+         * The `--help` option causes every application to print its full set of command line options with a brief synopsis of each, and then quit.
+         **/
+        help: boolean;
+        /**
+         * Print out a software version number
+         *
+         * All `libcamera-apps` will, when they see the `--version` option, print out a version string both for `libcamera` and `libcamera-apps` and then quit.
+         */
+        version: boolean;
+        /**
+         * Delay before application stops automatically <milliseconds>
+         *
+         * The `--timeout` option specifies how long the application runs before it stops, whether it is recording a video or showing a preview. In the case of still image capture, the application will show the preview window for this long before capturing the output image.
+         *
+         * If unspecified, the default value is 5000 (5 seconds). The value zero causes the application to run indefinitely.
+         */
+        timeout: number;
     }
-    type OptionsObject = {
-        [key in OptionKeys]?: any;
-    };
+    interface PreviewWindowOptions {
+        /**
+         * Preview window settings
+         *
+         * Sets the size and location of the preview window (both X Windows and DRM versions). It does not affect the resolution or aspect ratio of images being requested from the camera. The camera images will be scaled to the size of the preview window for display, and will be pillar/letter-boxed to fit.
+         *
+         * Example:
+         * ```json
+         * { "x": 100, "y": 100, "width": 500, "height": 500 }
+         * ```
+         */
+        preview: PreviewOption;
+        /**
+         * Fullscreen preview mode
+         *
+         * Forces the preview window to use the whole screen, and the window will have no border or title bar. Again the image may be pillar/letter-boxed.
+         */
+        fullscreen: boolean;
+        /**
+         * Use Qt-based preview window
+         *
+         * The preview window is switched to use the Qt-based implementation. This option is not normally recommended because it no longer uses zero-copy buffer sharing nor GPU acceleration and is therefore very expensive, however, it does support X forwarding (which the other preview implementations do not).
+         *
+         * The Qt preview window does not support the `--fullscreen` option. Generally it is advised to try and keep the preview window small.
+         */
+        'qt-preview': boolean;
+        /**
+         * Do not display a preview window
+         *
+         * The preview window is suppressed entirely.
+         */
+        nopreview: boolean;
+        /**
+         * Set window title bar text <string>
+         *
+         * The supplied string is set as the title of the preview window (when running under X Windows). Additionally the string may contain a number of `%` directives which are substituted with information from the image metadata. The permitted directives are:
+         *
+         * | Directive        | Substitution        |
+         * | :--------------- | :------------------ |
+         * | `%frame`         | The sequence number of the frame |
+         * | `%fps`           | The instantaneous frame rate |
+         * | `%exp`           | The shutter speed used to capture the image, in microseconds |
+         * | `%ag`            | The analogue gain applied to the image in the sensor |
+         * | `%dg`            | The digital gain applied to the image by the ISP |
+         * | `%rg`            | The gain applied to the red component of each pixel |
+         * | `%bg`            | The gain applied to the blue component of each pixel |
+         * | `%focus`         | The focus metric for the image, where a larger value implies a sharper image |
+         *
+         * When not provided, the `--info-text` string defaults to `"#%frame (%fps fps) exp %exp ag %ag dg %dg"`.
+         */
+        'info-text': string;
+    }
+    interface CameraResolutionOptions {
+        /**
+         * Capture image width <width>
+         *
+         * This number specifies the output resolution of the camera images captured by libcamera-still, libcamera-jpeg and libcamera-vid.
+         *
+         * For libcamera-raw, it affects the size of the raw frames captured. Where a camera has a 2x2 binned readout mode, specifying a resolution not larger than this binned mode will result in the capture of 2x2 binned raw frames.
+         *
+         * For libcamera-hello these parameters have no effect.
+         */
+        width: number;
+        /**
+         * Capture image height <height>
+         *
+         * This number specifies the output resolution of the camera images captured by libcamera-still, libcamera-jpeg and libcamera-vid.
+         *
+         * For libcamera-raw, it affects the size of the raw frames captured. Where a camera has a 2x2 binned readout mode, specifying a resolution not larger than this binned mode will result in the capture of 2x2 binned raw frames.
+         *
+         * For libcamera-hello these parameters have no effect.
+         */
+        height: number;
+    }
+    interface OutputFileOptions {
+        /**
+         * Output file name <string>
+         *
+         * `--output` sets the name of the output file to which the output image or video is written. Besides regular file names, this may take the following special values:
+         *
+         * `-` - write to stdout
+         *
+         * `udp://` - a string starting with this is taken as a network address for streaming
+         *
+         * `tcp://` - a string starting with this is taken as a network address for streaming
+         *
+         * a string containing a `%d` directive is taken as a file name where the format directive is replaced with a count that increments for each file that is opened. Standard C format directive modifiers are permitted.
+         */
+        output: string;
+    }
+    interface VideoOptions {
+        /**
+         * Saves timestamp information to the specified file. Useful as an input file to `mkvmerge`.
+         */
+        'save-pts': string;
+    }
+    type OptionsObject = CommandLineOptions & PreviewWindowOptions & CameraResolutionOptions & OutputFileOptions & VideoOptions;
+    type OptionKeys = keyof OptionsObject;
+    type OptionConverter = (val: any) => string;
     interface PreviewOption {
         x: number;
         y: number;
@@ -16,5 +127,4 @@ export declare namespace LibCamera {
         height: number;
     }
 }
-export declare const OPTION_KEYS: readonly ["help", "version", "timeout", "preview", "fullscreen", "qt-preview", "nopreview", "info-text", "width", "height", "viewfinder-width", "viewfinder-height", "output"];
-export declare const OPTIONS: Record<LibCamera.OptionKeys, LibCamera.OptionDefinition>;
+export declare const optionConverterMap: Partial<Record<LibCamera.OptionKeys, LibCamera.OptionConverter>>;

package/dist/utils.d.ts

@@ -3,4 +3,4 @@ import { ExecOptionsWithBufferEncoding } from 'child_process';
 import { LibCamera } from './options';
 export declare function cmd(base: string, args?: string[]): string;
 export declare function run(command: string, options?: ExecOptionsWithBufferEncoding): Promise<unknown>;
-export declare function convertOptionsToCmdArgs(options: LibCamera.OptionsObject): string[];
+export declare function convertOptionsToCmdArgs(options: Partial<LibCamera.OptionsObject>): string[];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "node-libcamera",
   "author": "Hussain Abbas",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -16,7 +16,7 @@
   "scripts": {
     "start": "tsdx watch",
     "build": "tsdx build",
-    "test": "tsdx test",
+    "test": "tsdx test --no-cache",
     "lint": "tsdx lint",
     "prepare": "tsdx build",
     "size": "size-limit",
@@ -51,5 +51,10 @@
       "path": "dist/node-libcamera.esm.js",
       "limit": "10 KB"
     }
-  ]
+  ],
+  "jest": {
+    "globals": {
+      "__DEV__": true
+    }
+  }
 }

package/src/index.ts

@@ -1,8 +1,27 @@
 import { LibCamera } from './options'
 import { run, cmd, convertOptionsToCmdArgs } from './utils'
 
-export function snap(options: LibCamera.OptionsObject) {
+function runLibCamera(
+  bin: string = 'libcamera-still',
+  options: Partial<LibCamera.OptionsObject>
+) {
   const args = convertOptionsToCmdArgs(options)
-  const command = cmd('libcamera-still', args)
+  const command = cmd(bin, args)
+  if (__DEV__) {
+    console.log(command)
+    return command
+  }
   return run(command)
 }
+
+export function jpeg(options: Partial<LibCamera.OptionsObject>) {
+  return runLibCamera('libcamera-jpeg', options)
+}
+
+export function still(options: Partial<LibCamera.OptionsObject>) {
+  return runLibCamera('libcamera-still', options)
+}
+
+export function vid(options: Partial<LibCamera.OptionsObject>) {
+  return runLibCamera('libcamera-vid', options)
+}

package/src/options.ts

@@ -1,17 +1,136 @@
 export namespace LibCamera {
-  export type OptionKeys = typeof OPTION_KEYS[number]
+  export interface CommandLineOptions {
+    /**
+     * Print help information for the application
+     *
+     * The `--help` option causes every application to print its full set of command line options with a brief synopsis of each, and then quit.
+     **/
+    help: boolean
+    /**
+     * Print out a software version number
+     *
+     * All `libcamera-apps` will, when they see the `--version` option, print out a version string both for `libcamera` and `libcamera-apps` and then quit.
+     */
+    version: boolean
+    /**
+     * Delay before application stops automatically <milliseconds>
+     *
+     * The `--timeout` option specifies how long the application runs before it stops, whether it is recording a video or showing a preview. In the case of still image capture, the application will show the preview window for this long before capturing the output image.
+     *
+     * If unspecified, the default value is 5000 (5 seconds). The value zero causes the application to run indefinitely.
+     */
+    timeout: number
+  }
+
+  export interface PreviewWindowOptions {
+    /**
+     * Preview window settings
+     *
+     * Sets the size and location of the preview window (both X Windows and DRM versions). It does not affect the resolution or aspect ratio of images being requested from the camera. The camera images will be scaled to the size of the preview window for display, and will be pillar/letter-boxed to fit.
+     *
+     * Example:
+     * ```json
+     * { "x": 100, "y": 100, "width": 500, "height": 500 }
+     * ```
+     */
+    preview: PreviewOption
+    /**
+     * Fullscreen preview mode
+     *
+     * Forces the preview window to use the whole screen, and the window will have no border or title bar. Again the image may be pillar/letter-boxed.
+     */
+    fullscreen: boolean
+    /**
+     * Use Qt-based preview window
+     *
+     * The preview window is switched to use the Qt-based implementation. This option is not normally recommended because it no longer uses zero-copy buffer sharing nor GPU acceleration and is therefore very expensive, however, it does support X forwarding (which the other preview implementations do not).
+     *
+     * The Qt preview window does not support the `--fullscreen` option. Generally it is advised to try and keep the preview window small.
+     */
+    'qt-preview': boolean
+    /**
+     * Do not display a preview window
+     *
+     * The preview window is suppressed entirely.
+     */
+    nopreview: boolean
+    /**
+     * Set window title bar text <string>
+     *
+     * The supplied string is set as the title of the preview window (when running under X Windows). Additionally the string may contain a number of `%` directives which are substituted with information from the image metadata. The permitted directives are:
+     *
+     * | Directive        | Substitution        |
+     * | :--------------- | :------------------ |
+     * | `%frame`         | The sequence number of the frame |
+     * | `%fps`           | The instantaneous frame rate |
+     * | `%exp`           | The shutter speed used to capture the image, in microseconds |
+     * | `%ag`            | The analogue gain applied to the image in the sensor |
+     * | `%dg`            | The digital gain applied to the image by the ISP |
+     * | `%rg`            | The gain applied to the red component of each pixel |
+     * | `%bg`            | The gain applied to the blue component of each pixel |
+     * | `%focus`         | The focus metric for the image, where a larger value implies a sharper image |
+     *
+     * When not provided, the `--info-text` string defaults to `"#%frame (%fps fps) exp %exp ag %ag dg %dg"`.
+     */
+    'info-text': string
+  }
+
+  export interface CameraResolutionOptions {
+    /**
+     * Capture image width <width>
+     *
+     * This number specifies the output resolution of the camera images captured by libcamera-still, libcamera-jpeg and libcamera-vid.
+     *
+     * For libcamera-raw, it affects the size of the raw frames captured. Where a camera has a 2x2 binned readout mode, specifying a resolution not larger than this binned mode will result in the capture of 2x2 binned raw frames.
+     *
+     * For libcamera-hello these parameters have no effect.
+     */
+    width: number
+    /**
+     * Capture image height <height>
+     *
+     * This number specifies the output resolution of the camera images captured by libcamera-still, libcamera-jpeg and libcamera-vid.
+     *
+     * For libcamera-raw, it affects the size of the raw frames captured. Where a camera has a 2x2 binned readout mode, specifying a resolution not larger than this binned mode will result in the capture of 2x2 binned raw frames.
+     *
+     * For libcamera-hello these parameters have no effect.
+     */
+    height: number
+  }
 
-  export interface OptionDefinition {
-    short?: string
-    desc?: string
-    validator?: (val: any) => boolean
-    convert?: (val: any) => string
+  export interface OutputFileOptions {
+    /**
+     * Output file name <string>
+     *
+     * `--output` sets the name of the output file to which the output image or video is written. Besides regular file names, this may take the following special values:
+     *
+     * `-` - write to stdout
+     *
+     * `udp://` - a string starting with this is taken as a network address for streaming
+     *
+     * `tcp://` - a string starting with this is taken as a network address for streaming
+     *
+     * a string containing a `%d` directive is taken as a file name where the format directive is replaced with a count that increments for each file that is opened. Standard C format directive modifiers are permitted.
+     */
+    output: string
   }
 
-  export type OptionsObject = {
-    [key in OptionKeys]?: any
+  export interface VideoOptions {
+    /**
+     * Saves timestamp information to the specified file. Useful as an input file to `mkvmerge`.
+     */
+    'save-pts': string
   }
 
+  export type OptionsObject = CommandLineOptions &
+    PreviewWindowOptions &
+    CameraResolutionOptions &
+    OutputFileOptions &
+    VideoOptions
+
+  export type OptionKeys = keyof OptionsObject
+  export type OptionConverter = (val: any) => string
+
   export interface PreviewOption {
     x: number
     y: number
@@ -20,94 +139,11 @@ export namespace LibCamera {
   }
 }
 
-export const OPTION_KEYS = [
-  'help',
-  'version',
-  'timeout',
-  'preview',
-  'fullscreen',
-  'qt-preview',
-  'nopreview',
-  'info-text',
-  'width',
-  'height',
-  'viewfinder-width',
-  'viewfinder-height',
-  // ...
-  'output',
-] as const
-
-export const OPTIONS: Record<
+export const optionConverterMap: Partial<Record<
   LibCamera.OptionKeys,
-  LibCamera.OptionDefinition
-> = {
-  help: {
-    short: 'h',
-    desc: 'Print help information for the application',
-  },
-  version: {
-    desc: 'Print help information for the application',
-  },
-  timeout: {
-    short: 't',
-    desc: 'Delay before application stops automatically <milliseconds>',
-    validator: (val: number) => typeof val === 'number',
-    convert: (val: number) => val.toString(),
-  },
-  preview: {
-    short: 'p',
-    desc: 'Preview window settings <x,y,w,h>',
-    validator(val: LibCamera.PreviewOption) {
-      return (
-        typeof val === 'object' &&
-        Boolean(val?.x && val?.y && val?.width && val?.height)
-      )
-    },
-    convert(val: LibCamera.PreviewOption) {
-      return `${val.x},${val.y},${val.width},${val.height}`
-    },
-  },
-  fullscreen: {
-    short: 'f',
-    desc: 'Fullscreen preview mode',
-  },
-  'qt-preview': {
-    desc: 'Use Qt-based preview window',
-  },
-  nopreview: {
-    short: 'n',
-    desc: 'Do not display a preview window',
-  },
-  'info-text': {
-    desc: 'Set window title bar text <string>',
-    validator: (val: string) => typeof val === 'string',
-  },
-  width: {
-    desc: 'Capture image width <width>',
-    validator: (val: number) => typeof val === 'number',
-    convert: (val: number) => val.toString(),
-  },
-  height: {
-    desc: 'Capture image height <height>',
-    validator: (val: number) => typeof val === 'number',
-    convert: (val: number) => val.toString(),
-  },
-  'viewfinder-width': {
-    desc: 'Capture image width <width>',
-    validator: (val: number) => typeof val === 'number',
-    convert: (val: number) => val.toString(),
-  },
-  'viewfinder-height': {
-    desc: 'Capture image height <height>',
-    validator: (val: number) => typeof val === 'number',
-    convert: (val: number) => val.toString(),
-  },
-
-  // ...
-
-  output: {
-    short: 'o',
-    desc: 'Output file name <string>',
-    validator: (val: string) => typeof val === 'string',
+  LibCamera.OptionConverter
+>> = {
+  preview(val: LibCamera.PreviewOption) {
+    return `${val.x},${val.y},${val.width},${val.height}`
   },
 } as const

package/src/utils.ts

@@ -1,5 +1,5 @@
 import { exec, ExecOptionsWithBufferEncoding } from 'child_process'
-import { OPTIONS, LibCamera } from './options'
+import { optionConverterMap, LibCamera } from './options'
 
 export function cmd(base: string, args?: string[]): string {
   if (base && !args) return base
@@ -16,17 +16,14 @@ export function run(command: string, options?: ExecOptionsWithBufferEncoding) {
 }
 
 export function convertOptionsToCmdArgs(
-  options: LibCamera.OptionsObject
+  options: Partial<LibCamera.OptionsObject>
 ): string[] {
   const args: string[] = []
   Object.entries(options).forEach(([key, val]) => {
-    const opt = OPTIONS[key as LibCamera.OptionKeys]
-    if (typeof opt.validator === 'function' && !opt.validator(val)) {
-      throw new Error(`Invalid value for option "${key}"`)
-    }
-    const value = typeof opt.convert === 'function' ? opt.convert(val) : val
+    const converter = optionConverterMap[key as LibCamera.OptionKeys]
+    const value = typeof converter === 'function' ? converter(val) : val
     if (value) args.push(`--${key}`)
-    if (value !== true) args.push(value)
+    if (value !== true && value?.toString()) args.push(value?.toString())
   }, true)
   return args
 }