nkscan

GitHub Actions Workflow Status

A cross-platform and performant driver for Nikon (Coolscan) film scanners.

Usage

For the command-line tool, download a binary release or build from source and run! Releases carry a binary for Linux (x86_64), Windows (x86_64) and macOS (Apple Silicon (aarch64) only).

The mac binaries are not signed, so Gatekeeper will trigger and will prevent it from running. Clear that with xattr -d com.apple.quarantine nkscan-aarch64-apple-darwin, or build from source instead.

Example

Say I'm batch scanning 6x6 color negatives on my Coolscan 9000 (the only Nikon scanner attached to my computer). I usually do 2x multisampling at the full native resolution with an IR pass. Additionally, I'll "lock" the exposure from the first frame so every frame is exposed the same off the scanner so I can perform roll analysis when I invert. To do this and scan my whole roll (with the program prompting between strips), I'd run

nkscan scan --lock-ae --samples 2 --ir --format 66

demo gif

Options

nkscan scan --help 
Perform a scan. Defaults to batch scanning with sensible defaults

Usage: nkscan scan [OPTIONS] [DEVICE]

Arguments:
  [DEVICE]
          The scanner to connect to. Optional, will default to the first found

Options:
      --basename <BASENAME>
          Where to write, as a path prefix. Each frame becomes <basename>_<n>.tiff, and its infrared mask <basename>_<n>_IR.tiff
          
          [default: scan]

      --unlock-wb
          Autoexpose per channel. Better dynamic range, but no longer "calibrated"

      --lock-ae
          Autoexpose the first frame and reuse that exposure across all frames

      --dpi <DPI>
          Resolution. Defaults to scanner maximum

      --log <LOG>
          Log verbosity: trace, debug, info, warn, error, or off
          
          [default: info]

      --samples <SAMPLES>
          Number of samples. Defaults to 1
          
          [default: 1]

      --superfine
          Singleline CCD mode. Only supported on multiline CCD scanners

      --frames <FRAMES>
          Which frame(s) to scan, comma separated. Defaults to all detected. Naming any stops after one holder rather than batching

      --ir
          Include the IR pass

      --clean
          Remove dust and scratches using the infrared channel

      --no-eject
          Don't eject at the end of the strip

      --thumbnail
          Keep the framing thumbnail as <basename>_<n>_thumbnail.tiff, on units that support this

      --format <FORMAT>
          Film format. One of: 135, half, IX240, 16, 645, 66, 67, 68, 69, or a custom frame length in mm. Defaults to what the holder reports (if any)

      --film <FILM>
          Film type, which picks the color profile the scans are tagged with

          Possible values:
          - positive:   Slide film
          - negative:   Color negative
          - kodachrome: Kodachrome, whose dyes need their own profile
          - mono:       Black and white negative
          
          [default: negative]

  -h, --help
          Print help (see a summary with '-h')

Support

Our goal is to support all the scanners supported by Nikon Scan, which are enumerated here by testing status. This library doesn't have anything scanner or adapter-specific so theoretically it should work across devices.

If you test with a ⚠️-marked scanner/adapter combo and it works, please send a PR indicating support!

  • ✅ Supported, and run against real hardware
  • ⚠️ Untested but theoretically should work

Medium Format Scanners

Scanner \ Holder 835M 835S 869S 869G 869GR 869M 816 8G1
Super Coolscan 9000 (LS-9000 ED) ⚠️ ⚠️ ✅ ⚠️ ⚠️ ⚠️ ⚠️ ⚠️
Super Coolscan 8000 (LS-8000 ED) ⚠️ ⚠️ ✅ ✅ ⚠️ ⚠️ ⚠️ ⚠️

35mm Scanners

Scanner \ Holder SA-21 IA-20/21 MA-20/21 SA-30 SF-210/200
Super Coolscan 5000 (LS-5000 ED) ⚠️ ⚠️ ✅ ⚠️ ⚠️
Super Coolscan 4000 (LS-5000 ED) ⚠️ ⚠️ ⚠️ ⚠️ ⚠️
Coolscan V (LS-50 ED) ✅ ✅ ✅ ✅ ✅
Coolscan IV (LS-40 ED) ⚠️ ⚠️ ⚠️ ⚠️ ⚠️

If you want to use a Firewire scanner on an old Mac that still has OS support for FireWire, let me know and I can scope it out. It is technically possible, but getting Rust to compile a binary for older MacOS is not something I have experience in. You could also just like, install Linux on it :)

USB Scanner Drivers

We use nusb, which is a pure-Rust alternative to libusb, but it carries the same invariants. On Windows, this means you need to associate your device with a WinUSB driver. The most popular way to do this is with Zadig.

On Linux, make sure you have the appropriate udev rules set up. Nusb has some help on this.

MacOS should just work.

FireWire Drivers

Things should just work on Linux (assuming you've got the SG module loaded) and Windows. MacOS dropped support for hardware FireWire a while ago and while there are efforts to bring it back, it seems a bit hacky at the moment. If you have an older mac with FireWire on it, you could just install Linux and have an OS that respects your freedom. If you have a newer mac and a cascade of dongles, maybe open an issue if you'd like support.

Design Notes

This library is written from the ground up following the official Nikon spec of the wire protocol for the LS-5000 and LS-9000 ED scanners (located in docs/). Comparing the two, we find an identical protocol. Some types are absent in one but not the other, some lists capabilities the other doesn't have, but all of the bits and bytes are in the same position across all the data. This implies we don't need any model or holder specifics, we can just read what the scanner advertises as its capabilities and work from there (for the most part). This means (hopefully) we can support every scanner and every holder with a single codebase (although please test and let me know)!

The code is broken down into several layers of independent abstractions

  • Transport: Defines what moving SCSI bytes is for the different OSes and physical layer (USB/FireWire)
  • Protocol: An implementation of the Nikon spec via serialization and deserialization of bytes as they come off the wire. This module does no IO and is just byte-oriented.
  • Session: Combines a trait object of the Transport (type erasure) with the methods from Protocol. This wraps scanner state (like global units) and provides functions that essentially perform the spec's listed actions.
  • Scan: Combine the methods from Session to perform high-level scan operations. This asks the scanner what it can do and then orders session operations to do it.

RE: LLMs

I'd rather spend money on film than on tokens. While LLMs helped with the production of some of this crate, it was largely written by hand and not vibe-coded. If you contribute, please adhere to the contribution guide.

Why Rust

I'm impatient and don't have time for runtimes, garbage collection, and dumb compilers. I like types, memory safety, correctness, and speed. Rust's model fits this better than any language, plus it has great tooling and libraries for the low-level programming in this crate. For the CLI user, you get one ~5MB binary and that's it, no messing around. I'm not super interested in a GUI right now, but that's the library part of this code base. Please go make one (hopefully also in Rust)!

TODO

  • Python bindings

License

Dual licensed under either of

at your option.

Except for the ICC profiles in profiles/, which are derived from Nikon's and are not ours to license.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Related Projects and References

Project links

Data verified by PyPI on Aug 19, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.11.0)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for activexray from gravatar.com activexray

Credits

Author: Kira Shila

GitHub Statistics

Data verified by PyPI on Aug 19, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

MIT OR Apache-2.0
View SPDX License List

Requires

Python >=3.13

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nkscan-0.7.0.tar.gz (2.8 MB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

nkscan-0.7.0-cp313-abi3-win_amd64.whl (579.0 kB view details)

Uploaded CPython 3.13+Windows x86-64

nkscan-0.7.0-cp313-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (816.8 kB view details)

Uploaded CPython 3.13+manylinux: glibc 2.17+ x86-64

nkscan-0.7.0-cp313-abi3-macosx_11_0_arm64.whl (709.1 kB view details)

Uploaded CPython 3.13+macOS 11.0+ ARM64

File details

Details for the file nkscan-0.7.0.tar.gz.

File metadata

  • Download URL: nkscan-0.7.0.tar.gz
  • Upload date:
  • Size: 2.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for nkscan-0.7.0.tar.gz
Algorithm Hash digest
SHA256 2e49d2e6f24e8262f52ca4823761d3abd287fe00b5c59e510196776364fb441f
MD5 1441929b161a5024a0b61ba2772572cc
BLAKE2b-256 5c8125bd75cab43dbf764a8221c6553ef34b5733931b527d3880124bcbcaf5de

See more details on using hashes here.

Provenance

The following attestation bundles were made for nkscan-0.7.0.tar.gz:

Publisher: release.yml on activexray/nkscan

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nkscan-0.7.0-cp313-abi3-win_amd64.whl.

File metadata

  • Download URL: nkscan-0.7.0-cp313-abi3-win_amd64.whl
  • Upload date:
  • Size: 579.0 kB
  • Tags: CPython 3.13+, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for nkscan-0.7.0-cp313-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 54c8ef7b9a0e4f67158d741da4b4d6ed8af6d6887f42c50a592acd963eac8bef
MD5 76eb33a2a5fd40c880067cf1969f45ca
BLAKE2b-256 862d23100bff6fe27cb0fb9395b04e46fd9f88a613c95f1744bcc47e3864bc4c

See more details on using hashes here.

Provenance

The following attestation bundles were made for nkscan-0.7.0-cp313-abi3-win_amd64.whl:

Publisher: release.yml on activexray/nkscan

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nkscan-0.7.0-cp313-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for nkscan-0.7.0-cp313-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 ae4187d554b372d2c2c27198fdda4522e7aa817eaffb73ee49f9e94262e9a06d
MD5 dae00b1baf2796ac1a6765246e6791af
BLAKE2b-256 5411df13d82ef519f502307cb9a35602d7518dced99c422dd09132b4e6e69afb

See more details on using hashes here.

Provenance

The following attestation bundles were made for nkscan-0.7.0-cp313-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: release.yml on activexray/nkscan

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nkscan-0.7.0-cp313-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for nkscan-0.7.0-cp313-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 22b6bc64f147be16e5ebc714e3bf930976d1d22c622f8475cc62a768377c5417
MD5 4fca25339b74d3ade58189c521b1bc38
BLAKE2b-256 0b4d0d2af94057e787b90324c4863eac5cd0e1b3ba42ce9c1387085339f217d8

See more details on using hashes here.

Provenance

The following attestation bundles were made for nkscan-0.7.0-cp313-abi3-macosx_11_0_arm64.whl:

Publisher: release.yml on activexray/nkscan

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.11.0

5 files

0.10.0

5 files

0.9.0

5 files

0.8.0

4 files

This release

0.7.0 This release

4 files

0.2.0

6 files

0.1.0

6 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page