Use this page to move from your first RAW decode to lower-level LibRaw control and SDK development. The package root exports the stable v1 API; documents marked as historical describe the deprecated beta surface.
- Project README — What the SDK does, supported platforms, and the shortest working example.
- Getting started — Install, verify, and decode from files or buffers with ESM and CommonJS.
- Formats and cameras — Representative RAW families and the formats exercised by the release fixtures.
- Platform support — Node versions, operating systems, architectures, prebuilds, and exclusions.
- Lifecycle, events, and cancellation — Processor state, worker ownership, FIFO execution, cancellation, recycle, and close.
- Examples — Additional workflows. Check the compatibility note at the top before copying an example written for the beta API.
- API mapping — Safe LibRaw 0.22.2 parity, camelCase names, explicit exclusions, output parameters, and 16-bit behavior.
- Stable v1 design — Public contract and architectural decisions.
- Stable v1 implementation audit — Requirement-by-requirement verification.
- Migration to v1 — Stable result and error shapes,
lifecycle changes, and the
lightdrift-libraw/legacycompatibility entry. - The legacy entry point remains available throughout v1, emits one deprecation warning per process, and will be removed in v2.
- Source builds — Compiler prerequisites and the vendored LibRaw/zlib build fallback.
- Contributing — Local development and pull requests.
- Testing reference — Historical suites plus the current test
commands listed in
package.json. - 1.0.1 release notes — AWS Lambda prebuild compatibility and Electron support.
- 1.0.0 release notes — Stable installation, supported platforms, verification gates, provenance, and compatibility.
- 1.0.0-rc.2 release notes — Documentation changes, compatibility, known limits, and historical promotion gates.
- Stable v1 implementation plan
- RC.2 documentation design
- RC.2 implementation plan
- Third-party notices
The following documents are retained for applications using
lightdrift-libraw/legacy. Their result shapes, examples, performance claims,
and setup instructions do not define the stable package-root contract:
- Beta API reference
- Beta buffer API
- Beta examples
- Beta worker-thread guide
- Beta worker quick reference
Use the migration guide before adapting these examples to the stable API.
- Project README — Installation and first workflow.
- Getting started — Expanded beginner guide.
- Migration to v1 — Beta compatibility policy.