grim-rs 0.1.6

Rust implementation of grim screenshot utility for Wayland
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
use grim_rs::{Box as GrimBox, CaptureParameters, Grim};
use std::env;
use std::fs;
use std::io::{self, BufRead};
use std::path::{Path, PathBuf};

fn main() -> grim_rs::Result<()> {
    let args: Vec<String> = env::args().collect();
    let mut opts = Options::default();
    let mut output_file = None;
    let mut arg_idx = 1;

    while arg_idx < args.len() {
        match args[arg_idx].as_str() {
            "-h" | "--help" => {
                print_help();
                return Ok(());
            }
            "-s" => {
                arg_idx += 1;
                if arg_idx >= args.len() {
                    eprintln!("Error: -s requires an argument");
                    std::process::exit(1);
                }
                opts.scale = Some(args[arg_idx].parse::<f64>().map_err(|_| {
                    grim_rs::Error::Io(std::io::Error::new(
                        std::io::ErrorKind::InvalidInput,
                        "Invalid scale factor",
                    ))
                })?);
            }
            "-g" => {
                arg_idx += 1;
                if arg_idx >= args.len() {
                    eprintln!("Error: -g requires an argument");
                    std::process::exit(1);
                }
                if args[arg_idx] == "-" {
                    opts.geometry = Some(Grim::read_region_from_stdin()?);
                } else {
                    opts.geometry = Some(args[arg_idx].parse()?);
                }
            }
            "-t" => {
                arg_idx += 1;
                if arg_idx >= args.len() {
                    eprintln!("Error: -t requires an argument");
                    std::process::exit(1);
                }
                match args[arg_idx].as_str() {
                    "png" => {
                        opts.filetype = FileType::Png;
                    }
                    "ppm" => {
                        opts.filetype = FileType::Ppm;
                    }
                    "jpeg" => {
                        opts.filetype = FileType::Jpeg;
                    }
                    _ => {
                        eprintln!("Error: invalid filetype: {}", args[arg_idx]);
                        std::process::exit(1);
                    }
                }
            }
            "-q" => {
                arg_idx += 1;
                if arg_idx >= args.len() {
                    eprintln!("Error: -q requires an argument");
                    std::process::exit(1);
                }
                let quality: i32 = args[arg_idx].parse().map_err(|_| {
                    grim_rs::Error::Io(std::io::Error::new(
                        std::io::ErrorKind::InvalidInput,
                        "Invalid quality value",
                    ))
                })?;
                if !(0..=100).contains(&quality) {
                    eprintln!("Error: JPEG quality must be between 0 and 100");
                    std::process::exit(1);
                }
                opts.jpeg_quality = quality as u8;
            }
            "-l" => {
                arg_idx += 1;
                if arg_idx >= args.len() {
                    eprintln!("Error: -l requires an argument");
                    std::process::exit(1);
                }
                let level: i32 = args[arg_idx].parse().map_err(|_| {
                    grim_rs::Error::Io(std::io::Error::new(
                        std::io::ErrorKind::InvalidInput,
                        "Invalid compression level",
                    ))
                })?;
                if !(0..=9).contains(&level) {
                    eprintln!("Error: PNG compression level must be between 0 and 9");
                    std::process::exit(1);
                }
                opts.png_level = level as u8;
            }
            "-o" => {
                arg_idx += 1;
                if arg_idx >= args.len() {
                    eprintln!("Error: -o requires an argument");
                    std::process::exit(1);
                }
                opts.output_name = Some(args[arg_idx].clone());
            }
            "-c" => {
                opts.with_cursor = true;
            }
            _ => {
                if output_file.is_none() {
                    output_file = Some(args[arg_idx].clone());
                } else {
                    eprintln!("Error: too many arguments");
                    std::process::exit(1);
                }
            }
        }
        arg_idx += 1;
    }

    let output_file = if let Some(file) = output_file {
        file
    } else {
        generate_default_filename(opts.filetype)?
    };

    let mut grim = Grim::new()?;
    let effective_scale = resolve_effective_scale(&mut grim, opts.scale)?;

    let result = if let Some(ref output_name) = opts.output_name {
        if opts.with_cursor {
            let mut params =
                CaptureParameters::new(output_name.clone()).overlay_cursor(opts.with_cursor);
            if let Some(region) = opts.geometry {
                params = params.region(region);
            }
            if let Some(scale) = opts.scale {
                params = params.scale(scale);
            }
            let multi_result = grim.capture_outputs_with_scale(vec![params], effective_scale)?;
            let mut outputs = multi_result.into_outputs();
            if let Some(capture_result) = outputs.remove(output_name.as_str()) {
                capture_result
            } else {
                return Err(grim_rs::Error::OutputNotFound(output_name.clone()));
            }
        } else {
            grim.capture_output_with_scale(output_name, effective_scale)?
        }
    } else if let Some(ref geometry) = opts.geometry {
        grim.capture_region_with_scale(*geometry, effective_scale)?
    } else {
        grim.capture_all_with_scale(effective_scale)?
    };

    save_or_write_result(&grim, &result, &output_file, &opts)?;

    Ok(())
}

#[derive(Debug)]
struct Options {
    scale: Option<f64>,
    geometry: Option<GrimBox>,
    filetype: FileType,
    jpeg_quality: u8,
    png_level: u8,
    output_name: Option<String>,
    with_cursor: bool,
}

impl Default for Options {
    fn default() -> Self {
        Self {
            scale: None,
            geometry: None,
            filetype: FileType::Png,
            jpeg_quality: 80,
            png_level: 6,
            output_name: None,
            with_cursor: false,
        }
    }
}

#[derive(Debug, Clone, Copy)]
enum FileType {
    Png,
    Ppm,
    Jpeg,
}

fn save_or_write_result(
    grim: &grim_rs::Grim,
    result: &grim_rs::CaptureResult,
    output_file: &str,
    opts: &Options,
) -> grim_rs::Result<()> {
    if output_file == "-" {
        write_to_stdout(grim, result, opts)
    } else {
        save_to_file(grim, result, output_file, opts)
    }
}

fn write_to_stdout(
    grim: &grim_rs::Grim,
    result: &grim_rs::CaptureResult,
    opts: &Options,
) -> grim_rs::Result<()> {
    match opts.filetype {
        FileType::Png => write_png_to_stdout(grim, result, opts.png_level),
        FileType::Ppm => grim.write_ppm_to_stdout(result.data(), result.width(), result.height()),
        FileType::Jpeg => write_jpeg_to_stdout(grim, result, opts.jpeg_quality),
    }
}

fn save_to_file(
    grim: &grim_rs::Grim,
    result: &grim_rs::CaptureResult,
    output_file: &str,
    opts: &Options,
) -> grim_rs::Result<()> {
    let path = Path::new(output_file);
    match opts.filetype {
        FileType::Png => save_png_to_file(grim, result, path, opts.png_level),
        FileType::Ppm => grim.save_ppm(result.data(), result.width(), result.height(), path),
        FileType::Jpeg => save_jpeg_to_file(grim, result, path, opts.jpeg_quality),
    }
}

fn write_png_to_stdout(
    grim: &grim_rs::Grim,
    result: &grim_rs::CaptureResult,
    compression_level: u8,
) -> grim_rs::Result<()> {
    if compression_level == 6 {
        grim.write_png_to_stdout(result.data(), result.width(), result.height())
    } else {
        grim.write_png_to_stdout_with_compression(
            result.data(),
            result.width(),
            result.height(),
            compression_level,
        )
    }
}

fn save_png_to_file(
    grim: &grim_rs::Grim,
    result: &grim_rs::CaptureResult,
    path: &Path,
    compression_level: u8,
) -> grim_rs::Result<()> {
    if compression_level == 6 {
        grim.save_png(result.data(), result.width(), result.height(), path)
    } else {
        grim.save_png_with_compression(
            result.data(),
            result.width(),
            result.height(),
            path,
            compression_level,
        )
    }
}

fn write_jpeg_to_stdout(
    grim: &grim_rs::Grim,
    result: &grim_rs::CaptureResult,
    quality: u8,
) -> grim_rs::Result<()> {
    #[cfg(feature = "jpeg")]
    {
        if quality == 80 {
            grim.write_jpeg_to_stdout(result.data(), result.width(), result.height())
        } else {
            grim.write_jpeg_to_stdout_with_quality(
                result.data(),
                result.width(),
                result.height(),
                quality,
            )
        }
    }
    #[cfg(not(feature = "jpeg"))]
    {
        let _ = (grim, result, quality);
        Err(create_jpeg_not_supported_error())
    }
}

fn save_jpeg_to_file(
    grim: &grim_rs::Grim,
    result: &grim_rs::CaptureResult,
    path: &Path,
    quality: u8,
) -> grim_rs::Result<()> {
    #[cfg(feature = "jpeg")]
    {
        if quality == 80 {
            grim.save_jpeg(result.data(), result.width(), result.height(), path)
        } else {
            grim.save_jpeg_with_quality(
                result.data(),
                result.width(),
                result.height(),
                path,
                quality,
            )
        }
    }
    #[cfg(not(feature = "jpeg"))]
    {
        let _ = (grim, result, path, quality);
        Err(create_jpeg_not_supported_error())
    }
}

#[cfg(not(feature = "jpeg"))]
fn create_jpeg_not_supported_error() -> grim_rs::Error {
    grim_rs::Error::ImageProcessing(image::ImageError::Unsupported(
        image::error::UnsupportedError::from_format_and_kind(
            image::error::ImageFormatHint::Name("JPEG".to_string()),
            image::error::UnsupportedErrorKind::Format(image::ImageFormat::Jpeg.into()),
        ),
    ))
}

fn print_help() {
    println!(
        "Usage: grim [options...] [output-file]\n\
         \n\
         Options:\n\
         -h              Show help message and quit.\n\
         -s <factor>     Set the output image's scale factor (default: greatest output scale).\n\
         -g <geometry>   Set the region to capture.\n\
         -t png|ppm|jpeg Set the output filetype.\n\
         -q <quality>    Set the JPEG filetype compression rate (0-100).\n\
         -l <level>      Set the PNG filetype compression level (0-9).\n\
         -o <output>     Set the output name to capture.\n\
         -c              Include cursors in the screenshot.\n\
         \n\
         If output-file is '-', output to standard output.\n\
         If no output-file is specified, use a default timestamped filename."
    );
}

fn resolve_effective_scale(grim: &mut Grim, requested_scale: Option<f64>) -> grim_rs::Result<f64> {
    if let Some(scale) = requested_scale {
        return Ok(scale);
    }

    let outputs = grim.get_outputs()?;
    Ok(default_scale_from_output_scales(
        outputs.iter().map(|output| output.scale()),
    ))
}

fn default_scale_from_output_scales<I>(scales: I) -> f64
where
    I: IntoIterator<Item = i32>,
{
    let max_scale = scales
        .into_iter()
        .filter(|&scale| scale > 0)
        .max()
        .unwrap_or(1);
    f64::from(max_scale)
}

fn generate_default_filename(filetype: FileType) -> grim_rs::Result<String> {
    use chrono::Local;

    // Format: YYYYMMDD_HHhMMmSSs_grim.ext (e.g., 20241004_10h30m45s_grim.png)
    let now = Local::now();
    let timestamp = now.format("%Y%m%d_%Hh%Mm%Ss");

    let ext = match filetype {
        FileType::Png => "png",
        FileType::Ppm => "ppm",
        FileType::Jpeg => "jpeg",
    };

    let output_dir = get_output_dir();
    let filename = format!("{}_grim.{}", timestamp, ext);

    Ok(output_dir.join(filename).to_string_lossy().to_string())
}

/// ~/.config/user-dirs.dirs
fn get_xdg_pictures_dir() -> Option<PathBuf> {
    // XDG_PICTURES_DIR
    if let Ok(pictures_dir) = env::var("XDG_PICTURES_DIR") {
        let expanded = expand_home_dir(&pictures_dir);
        return Some(PathBuf::from(expanded));
    }

    // Parse ~/.config/user-dirs.dirs
    let config_home = env::var("XDG_CONFIG_HOME").ok().or_else(|| {
        env::var("HOME")
            .ok()
            .map(|home| format!("{}/.config", home))
    })?;

    let user_dirs_file = PathBuf::from(config_home).join("user-dirs.dirs");

    if !user_dirs_file.exists() {
        return None;
    }

    let file = fs::File::open(user_dirs_file).ok()?;
    let reader = io::BufReader::new(file);

    for line in reader.lines().map_while(Result::ok) {
        let line = line.trim();
        if line.is_empty() || line.starts_with('#') {
            continue;
        }

        // Look for XDG_PICTURES_DIR="..."
        if line.starts_with("XDG_PICTURES_DIR=") {
            if let Some(value) = line.strip_prefix("XDG_PICTURES_DIR=") {
                // Remove quotes
                let value = value.trim_matches('"').trim_matches('\'');
                let expanded = expand_home_dir(value);
                return Some(PathBuf::from(expanded));
            }
        }
    }

    None
}

/// Expand $HOME in paths
fn expand_home_dir(path: &str) -> String {
    if path.starts_with("$HOME") {
        if let Ok(home) = env::var("HOME") {
            return path.replace("$HOME", &home);
        }
    }
    path.to_string()
}

/// GRIM_DEFAULT_DIR > XDG_PICTURES_DIR > "."
fn get_output_dir() -> PathBuf {
    // GRIM_DEFAULT_DIR
    if let Ok(default_dir) = env::var("GRIM_DEFAULT_DIR") {
        let path = PathBuf::from(default_dir);
        if path.exists() || path.parent().map(|p| p.exists()).unwrap_or(false) {
            return path;
        }
    }

    // XDG_PICTURES_DIR
    if let Some(pictures_dir) = get_xdg_pictures_dir() {
        if pictures_dir.exists() {
            return pictures_dir;
        }
    }

    PathBuf::from(".")
}

#[cfg(test)]
mod tests {
    use super::default_scale_from_output_scales;

    #[test]
    fn default_scale_uses_max_positive_scale() {
        assert_eq!(default_scale_from_output_scales([1, 2, 1]), 2.0);
    }

    #[test]
    fn default_scale_falls_back_to_one() {
        assert_eq!(default_scale_from_output_scales([]), 1.0);
        assert_eq!(default_scale_from_output_scales([0, -1]), 1.0);
    }
}