nkscan 0.8.0

A platform-agnostic, performant driver for Nikon film scanners
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

//! Taking one scan pass over the film
//!
//! Every kind of pass, thumbnail, prescan and scan alike, is the same four
//! commands. The I/O lives on [`Session`](crate::session::Session); this module holds the pure types
//! and the decoder builder.

use crate::{
    error::Error,
    protocol::{
        caps::set_window::ColorInterleaving, curves::Curves, data::CooperativeAction, image::Layout,
    },
};

/// A finished scan pass
///
/// The samples are the caller's buffer, so this struct carries only what describes them
#[derive(Debug, Clone)]
pub struct Pass {
    /// The stream's shape, as far as 2-10's formula describes it
    pub layout: Layout,
    /// What the unit asked the host to do with the data, if anything
    pub cooperation: Vec<CooperativeAction>,
    /// Whether every block the layout promised arrived
    pub complete: bool,
    /// Image rows and columns: the sensor (the layout's pixels) and the feed
    /// (its lines)
    pub rows: usize,
    pub cols: usize,
}

/// How far along a pass is, reported once per chunk
///
/// `total` is the layout's own arithmetic and the cooperative modes can make it
/// wrong, so a pass can finish short of it or run past. [`Pass::complete`] is
/// what answers whether everything arrived
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Progress {
    /// Bytes taken off the unit so far
    pub bytes: u64,
    /// Bytes the layout says the pass holds
    pub total: u64,
    /// Blocks the decoder has unscrambled
    pub blocks: usize,
}

/// Build a decoder for a scan pass, applying CCD correction only for multi-line
pub fn decoder<'a>(
    layout: &Layout,
    curves: Option<&'a Curves>,
) -> Result<crate::protocol::decode::Decoder<'a>, Error> {
    let decoder = crate::protocol::decode::Decoder::new(layout)?;
    match curves.filter(|_| {
        layout
            .interleaving
            .contains(ColorInterleaving::MULTILINE_SIMULTANEOUS)
    }) {
        Some(curves) => Ok(decoder.correcting(curves)),
        None => Ok(decoder),
    }
}