bgone 0.6.0

Ultra-fast CLI tool for removing solid background colors from images
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

mod common;

use assert_cmd::cargo;
use assert_cmd::prelude::*;
use common::{
    calculate_psnr, calculate_similarity_percentage, ensure_output_dir, overlay_on_background,
    save_test_images,
};
use std::process::Command;
use tempfile::TempDir;

#[test]
fn test_square_removal() {
    ensure_output_dir();
    let temp_dir = TempDir::new().unwrap();
    let output_path = temp_dir.path().join("output.png");

    // Run bgone
    let mut cmd = Command::new(cargo::cargo_bin!("bgone"));
    cmd.args([
        "tests/inputs/square.png",
        output_path.to_str().unwrap(),
        "--strict",
        "--fg",
        "#ff0000",
        "--bg",
        "#000000",
    ]);

    cmd.assert().success();

    // Load images
    let original = image::open("tests/inputs/square.png").unwrap();
    let processed = image::open(&output_path).unwrap();

    // Overlay processed image back on black background
    let reconstructed = overlay_on_background(&processed, [0, 0, 0]);

    // Save for inspection
    save_test_images("strict", "square", &processed, &reconstructed);

    // Compare with original
    let similarity = calculate_similarity_percentage(&original, &reconstructed);
    let psnr = calculate_psnr(&original, &reconstructed);

    println!(
        "Red on black - Similarity: {:.2}%, PSNR: {:.2} dB",
        similarity, psnr
    );

    // Should be nearly identical
    assert!(
        similarity > 99.0,
        "Similarity {:.4}% is too low",
        similarity
    );
    assert!(psnr > 50.0, "PSNR {:.2} dB is too low", psnr);
}

#[test]
fn test_circle_gradient_removal() {
    ensure_output_dir();
    let temp_dir = TempDir::new().unwrap();
    let output_path = temp_dir.path().join("output.png");

    // Run bgone
    let mut cmd = Command::new(cargo::cargo_bin!("bgone"));
    cmd.args([
        "tests/inputs/circle-gradient.png",
        output_path.to_str().unwrap(),
        "--strict",
        "--fg",
        "#ff0000",
        "--bg",
        "#ffffff",
    ]);

    cmd.assert().success();

    // Load images
    let original = image::open("tests/inputs/circle-gradient.png").unwrap();
    let processed = image::open(&output_path).unwrap();

    // Overlay processed image back on white background
    let reconstructed = overlay_on_background(&processed, [255, 255, 255]);

    // Save for inspection
    save_test_images("strict", "circle_gradient", &processed, &reconstructed);

    // Compare with original
    let similarity = calculate_similarity_percentage(&original, &reconstructed);
    let psnr = calculate_psnr(&original, &reconstructed);

    println!(
        "Red gradient on white - Similarity: {:.2}%, PSNR: {:.2} dB",
        similarity, psnr
    );

    // Should be nearly identical
    assert!(
        similarity > 99.0,
        "Similarity {:.4}% is too low",
        similarity
    );
    assert!(psnr > 50.0, "PSNR {:.2} dB is too low", psnr);
}

#[test]
fn test_rectangles_removal() {
    ensure_output_dir();
    let temp_dir = TempDir::new().unwrap();
    let output_path = temp_dir.path().join("output.png");

    // Run bgone
    let mut cmd = Command::new(cargo::cargo_bin!("bgone"));
    cmd.args([
        "tests/inputs/rectangles.png",
        output_path.to_str().unwrap(),
        "--strict",
        "--fg",
        "#ff0000", // red
        "#00ff00", // green
        "#ffff00", // yellow
        "--bg",
        "#0000ff",
    ]);

    cmd.assert().success();

    // Load images
    let original = image::open("tests/inputs/rectangles.png").unwrap();
    let processed = image::open(&output_path).unwrap();

    // Overlay processed image back on blue background
    let reconstructed = overlay_on_background(&processed, [0, 0, 255]);

    // Save for inspection
    save_test_images("strict", "rectangles", &processed, &reconstructed);

    // Compare with original
    let similarity = calculate_similarity_percentage(&original, &reconstructed);
    let psnr = calculate_psnr(&original, &reconstructed);

    println!(
        "Multicolor on blue - Similarity: {:.2}%, PSNR: {:.2} dB",
        similarity, psnr
    );

    // Multiple colors with blending is the hardest case
    assert!(
        similarity > 99.0,
        "Similarity {:.2}% is too low",
        similarity
    );
    assert!(psnr > 50.0, "PSNR {:.2} dB is too low", psnr);
}

#[test]
fn test_auto_background_detection() {
    ensure_output_dir();
    let temp_dir = TempDir::new().unwrap();
    let output_path = temp_dir.path().join("output.png");

    // Run bgone without specifying background (should auto-detect black)
    let mut cmd = Command::new(cargo::cargo_bin!("bgone"));
    cmd.args([
        "tests/inputs/square.png",
        output_path.to_str().unwrap(),
        "--strict",
        "--fg",
        "#ff0000",
    ]);

    cmd.assert().success();

    // Should detect black background automatically
    let original = image::open("tests/inputs/square.png").unwrap();
    let processed = image::open(&output_path).unwrap();
    let reconstructed = overlay_on_background(&processed, [0, 0, 0]);

    // Save for inspection
    save_test_images("strict", "auto_detect_black", &processed, &reconstructed);

    let similarity = calculate_similarity_percentage(&original, &reconstructed);
    assert!(
        similarity > 99.0,
        "Auto-detection failed: similarity {:.4}%",
        similarity
    );
}

#[test]
fn test_square_gradient_with_known_colors() {
    ensure_output_dir();
    let temp_dir = TempDir::new().unwrap();
    let output_path = temp_dir.path().join("output.png");

    // Test with known cyan and magenta - should preserve transparency
    let mut cmd = Command::new(cargo::cargo_bin!("bgone"));
    cmd.args([
        "tests/inputs/square-gradient.png",
        output_path.to_str().unwrap(),
        "--strict",
        "--fg",
        "#00ffff",
        "#ff00ff",
        "--bg",
        "#14191e",
    ]);

    cmd.assert().success();

    // Load and save images for inspection
    let original = image::open("tests/inputs/square-gradient.png").unwrap();
    let processed = image::open(&output_path).unwrap();
    let reconstructed = overlay_on_background(&processed, [20, 25, 30]);

    save_test_images(
        "strict",
        "square_gradient_known",
        &processed,
        &reconstructed,
    );

    // Check reconstruction quality
    let similarity = calculate_similarity_percentage(&original, &reconstructed);
    let psnr = calculate_psnr(&original, &reconstructed);
    println!(
        "Square gradient (known colors) - Similarity: {:.2}%, PSNR: {:.2} dB",
        similarity, psnr
    );

    assert!(
        similarity > 99.0,
        "Reconstruction quality too low: {:.4}%",
        similarity
    );
}

#[test]
fn test_strict_mode_requires_fg() {
    let temp_dir = TempDir::new().unwrap();
    let output_path = temp_dir.path().join("output.png");

    // Test: No foreground colors specified in strict mode - should fail
    let mut cmd = Command::new(cargo::cargo_bin!("bgone"));
    cmd.args([
        "tests/inputs/square.png",
        output_path.to_str().unwrap(),
        "--strict",
    ]);

    cmd.assert()
        .failure()
        .stderr(predicates::str::contains("strict mode"));
}