ffcine-breakdown 0.3.0

ffcine breakdown: shot list of a reference video (cuts, keyframes, camera motion, beat alignment, colour, speech, on-screen text), contact sheet
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

//! `shotlist.md`: the shots as a Markdown table with an empty notes column to fill in.

use std::fmt::Write as _;

use crate::{Breakdown, clock};

/// Pipes and newlines would break the table.
fn cell(s: &str) -> String {
    s.replace('|', "\\|").replace(['\n', '\r'], " ")
}

pub fn render(b: &Breakdown) -> String {
    let name = b.source.file_name().map_or_else(
        || b.source.display().to_string(),
        |n| n.to_string_lossy().into_owned(),
    );
    let mut s = format!("# {}\n\n", cell(&name));
    let p = &b.pacing;
    let _ = write!(
        s,
        "{} · {}x{} · {:.3} fps · {} shots, mean {:.2} s, median {:.2} s, {:.1} cuts/min",
        clock(b.duration),
        b.width,
        b.height,
        b.fps,
        p.shots,
        p.mean,
        p.median,
        p.cuts_per_minute
    );
    if let Some(m) = &b.music {
        let _ = write!(
            s,
            " · {:.0} BPM, {}/{} cuts on the beat (chance {:.0} %)",
            m.tempo,
            m.on_beat,
            m.cuts,
            m.chance * 100.0
        );
    }
    s.push_str("\n\n");
    let words = b
        .shots
        .iter()
        .any(|x| !x.speech.is_empty() || !x.text.is_empty());
    s.push_str("| # | Time | Dur | Motion |");
    if words {
        s.push_str(" Speech / text |");
    }
    s.push_str(" Notes | Keyframe |\n|---|---|---|---|");
    if words {
        s.push_str("---|");
    }
    s.push_str("---|---|\n");
    for x in &b.shots {
        let beat = match x.cut_on_beat {
            Some(true) => " ♪",
            _ => "",
        };
        let _ = write!(
            s,
            "| {} | {}{beat} | {:.2} s | {} |",
            x.n,
            clock(x.start),
            x.duration,
            x.motion.label()
        );
        if words {
            let mut w = Vec::new();
            if !x.speech.is_empty() {
                w.push(format!("“{}”", x.speech));
            }
            if !x.text.is_empty() {
                w.push(format!("[{}]", x.text));
            }
            let _ = write!(s, " {} |", cell(&w.join(" ")));
        }
        let _ = writeln!(s, "  | [{0}]({0}) |", x.keyframes.key);
    }
    s
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::motion::{Motion, MotionKind};
    use crate::{Keyframes, Pacing, Shot, colour};

    #[test]
    fn table() {
        let shot = Shot {
            n: 1,
            start: 0.0,
            end: 1.5,
            duration: 1.5,
            frames: [0, 45],
            keyframes: Keyframes {
                key: "keyframes/001.jpg".into(),
                key_time: 0.7,
                first: "keyframes/001-first.jpg".into(),
                last: "keyframes/001-last.jpg".into(),
            },
            motion: Motion {
                kind: MotionKind::Pan,
                direction: Some("left".into()),
                handheld: true,
                pan: -0.3,
                tilt: 0.0,
                zoom: 1.0,
                shake: 0.4,
                speed: 0.2,
            },
            colour: colour::average(&[]),
            cut_on_beat: None,
            beat_offset: None,
            beats: None,
            speech: "a | b".into(),
            text: String::new(),
        };
        let b = Breakdown {
            version: 1,
            source: "dir/reel.mp4".into(),
            duration: 1.5,
            fps: 30.0,
            width: 1080,
            height: 1920,
            frames: 45,
            decoder: "cpu".into(),
            pacing: Pacing {
                shots: 1,
                mean: 1.5,
                median: 1.5,
                shortest: 1.5,
                longest: 1.5,
                cuts_per_minute: 0.0,
            },
            cuts: vec![],
            shots: vec![shot],
            music: None,
            transcript: None,
            contact_sheets: vec![],
            shotlist: "shotlist.md".into(),
        };
        let md = render(&b);
        assert!(md.starts_with("# reel.mp4\n"));
        assert!(md.contains(
            "| 1 | 0:00.00 | 1.50 s | pan left (handheld) | “a \\| b” |  | [keyframes/001.jpg](keyframes/001.jpg) |"
        ));
    }
}