ffcine-cli 0.4.0

ffcine command-line interface
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

//! `ffcine breakdown`.
#![allow(clippy::doc_markdown)] // doc comments are --help text

use std::path::PathBuf;

use bpaf::Bpaf;
use ffcine::breakdown::{self, Options};
use ffcine::triage::transcribe::WhisperParams;

#[derive(Debug, Clone, Bpaf)]
#[allow(clippy::struct_excessive_bools)] // flags
pub struct BreakdownArgs {
    /// Output directory (default: NAME-breakdown next to the video).
    #[bpaf(short('o'), long("out"), argument("DIR"))]
    out: Option<PathBuf>,
    /// Cut score threshold, 0..1; lower finds softer cuts.
    #[bpaf(argument("SCORE"), fallback(0.3), display_fallback)]
    threshold: f32,
    /// Shortest shot, seconds.
    #[bpaf(argument("SEC"), fallback(0.2), display_fallback)]
    min_shot: f64,
    /// A cut this close to a beat is on it, seconds.
    #[bpaf(argument("SEC"), fallback(0.07), display_fallback)]
    beat_tolerance: f64,
    /// Long side of the keyframe JPEGs, px.
    #[bpaf(argument("PX"), fallback(960), display_fallback)]
    keyframe_size: u32,
    /// Contact sheet width, px.
    #[bpaf(argument("PX"), fallback(1800), display_fallback)]
    sheet_width: u32,
    /// Contact sheet columns (default: 8 for portrait, 6 square, 5 landscape).
    #[bpaf(argument("N"))]
    columns: Option<u32>,
    /// Skip the music tempo and beat check.
    no_beats: bool,
    /// Skip transcription.
    no_transcribe: bool,
    /// Whisper model, a faster-whisper name or CTranslate2 directory (default: large-v3-turbo).
    #[bpaf(argument("NAME"), fallback("large-v3-turbo".to_owned()))]
    model: String,
    /// Python with faster-whisper (default: $FFCINE_WHISPER_PYTHON, else python3).
    #[bpaf(argument("PATH"))]
    whisper_python: Option<PathBuf>,
    /// Transcription language, e.g. en (default: detected).
    #[bpaf(argument("LANG"))]
    language: Option<String>,
    /// Run whisper on the CPU.
    whisper_cpu: bool,
    /// Don't read on-screen text (default: read it when tesseract is on PATH).
    no_ocr: bool,
    /// Decode on the CPU instead of NVDEC.
    cpu_decode: bool,
    /// The video, a local file (a reel, TikTok, trailer).
    #[bpaf(positional("VIDEO"))]
    video: PathBuf,
}

impl BreakdownArgs {
    pub fn run(self) -> anyhow::Result<()> {
        anyhow::ensure!(
            self.beat_tolerance >= 0.0,
            "--beat-tolerance must be 0 or more"
        );
        anyhow::ensure!(
            (0.0..=1.0).contains(&self.threshold),
            "--threshold must be 0..1"
        );
        let out = self.out.clone().unwrap_or_else(|| {
            let stem = self
                .video
                .file_stem()
                .map_or_else(|| "video".into(), |s| s.to_string_lossy().into_owned());
            self.video.with_file_name(format!("{stem}-breakdown"))
        });
        let mut o = Options::new(&self.video, &out);
        o.gpu = !self.cpu_decode;
        o.scene.threshold = self.threshold;
        o.scene.min_gap = self.min_shot;
        o.beats = !self.no_beats;
        o.beat_tolerance = self.beat_tolerance;
        o.keyframe_size = self.keyframe_size;
        o.sheet_width = self.sheet_width;
        o.sheet_columns = self.columns;
        o.ocr = !self.no_ocr;
        o.whisper = (!self.no_transcribe).then(|| {
            let mut w = WhisperParams {
                model: self.model.clone(),
                language: self.language.clone().unwrap_or_default(),
                ..Default::default()
            };
            if let Some(p) = &self.whisper_python {
                w.python.clone_from(p);
            }
            if self.whisper_cpu {
                w.device = "cpu".into();
                w.compute = "int8".into();
            }
            w
        });
        let b = breakdown::run(&o)?;
        let p = &b.pacing;
        eprint!(
            "{} shots, mean {:.2} s, {:.1} cuts/min",
            p.shots, p.mean, p.cuts_per_minute
        );
        if let Some(m) = &b.music {
            eprint!(
                ", {:.0} BPM, {}/{} cuts on the beat",
                m.tempo, m.on_beat, m.cuts
            );
        }
        eprintln!();
        for f in ["breakdown.json", "shotlist.md", "contact-sheet.jpg"] {
            let path = out.join(f);
            if path.exists() {
                println!("{}", path.display());
            }
        }
        Ok(())
    }
}