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
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

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 square-gradient-stroke.png in all four modes to showcase
/// how different approaches produce different outputs that all perfectly reconstruct

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

    // Run bgone in non-strict mode without any foreground colors
    // This should optimize for maximum transparency
    Command::new(cargo::cargo_bin!("bgone"))
        .args([
            "tests/inputs/square-gradient-stroke.png",
            output_path.to_str().unwrap(),
            "--bg",
            "14191e", // dark background (20, 25, 30)
        ])
        .assert()
        .success();

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

    // Reconstruct by overlaying on background
    let background_color = [0x14, 0x19, 0x1e]; // (20, 25, 30)
    let reconstructed = overlay_on_background(&processed, background_color);

    // Save outputs for inspection
    save_test_images(
        "square_gradient_stroke",
        "non_strict_no_fg",
        &processed,
        &reconstructed,
    );

    // Verify perfect reconstruction
    let similarity = calculate_similarity_percentage(&original, &reconstructed);
    let psnr = calculate_psnr(&original, &reconstructed);

    println!(
        "Non-strict (no fg) - Similarity: {:.2}%, PSNR: {:.2} dB",
        similarity, psnr
    );
    assert!(
        similarity > 99.0,
        "Similarity {:.2}% is too low",
        similarity
    );
}

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

    // Run bgone in non-strict mode with three known foreground colors
    // Colors close to these will use high opacity, others will be flexible
    Command::new(cargo::cargo_bin!("bgone"))
        .args([
            "tests/inputs/square-gradient-stroke.png",
            output_path.to_str().unwrap(),
            "--fg",
            "00ffff", // cyan
            "--fg",
            "ff00ff", // magenta
            "--fg",
            "a7b511", // actual stroke color
            "--bg",
            "14191e", // dark background (20, 25, 30)
        ])
        .assert()
        .success();

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

    // Reconstruct by overlaying on background
    let background_color = [0x14, 0x19, 0x1e]; // (20, 25, 30)
    let reconstructed = overlay_on_background(&processed, background_color);

    // Save outputs for inspection
    save_test_images(
        "square_gradient_stroke",
        "non_strict_with_fg",
        &processed,
        &reconstructed,
    );

    // Verify perfect reconstruction
    let similarity = calculate_similarity_percentage(&original, &reconstructed);
    let psnr = calculate_psnr(&original, &reconstructed);

    println!(
        "Non-strict (with fg) - Similarity: {:.2}%, PSNR: {:.2} dB",
        similarity, psnr
    );
    assert!(
        similarity > 99.0,
        "Similarity {:.2}% is too low",
        similarity
    );
}

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

    // Run bgone in strict mode with three known foreground colors
    // This restricts the unmixing to only these specific colors
    Command::new(cargo::cargo_bin!("bgone"))
        .args([
            "tests/inputs/square-gradient-stroke.png",
            output_path.to_str().unwrap(),
            "--strict",
            "--fg",
            "00ffff", // cyan
            "--fg",
            "ff00ff", // magenta
            "--fg",
            "a7b511", // actual stroke color
            "--bg",
            "14191e", // dark background (20, 25, 30)
        ])
        .assert()
        .success();

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

    // Reconstruct by overlaying on background
    let background_color = [0x14, 0x19, 0x1e]; // (20, 25, 30)
    let reconstructed = overlay_on_background(&processed, background_color);

    // Save outputs for inspection
    save_test_images(
        "square_gradient_stroke",
        "strict_known",
        &processed,
        &reconstructed,
    );

    // Verify perfect reconstruction
    let similarity = calculate_similarity_percentage(&original, &reconstructed);
    let psnr = calculate_psnr(&original, &reconstructed);

    println!(
        "Strict (known colors) - Similarity: {:.2}%, PSNR: {:.2} dB",
        similarity, psnr
    );
    assert!(
        similarity > 99.0,
        "Similarity {:.2}% is too low",
        similarity
    );
}

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

    // Run bgone in strict mode with automatic color deduction
    // This will find the optimal 3 colors automatically
    Command::new(cargo::cargo_bin!("bgone"))
        .args([
            "tests/inputs/square-gradient-stroke.png",
            output_path.to_str().unwrap(),
            "--strict",
            "--fg",
            "auto",
            "--fg",
            "auto",
            "--fg",
            "auto",
            "--bg",
            "14191e", // dark background (20, 25, 30)
        ])
        .assert()
        .success();

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

    // Reconstruct by overlaying on background
    let background_color = [0x14, 0x19, 0x1e]; // (20, 25, 30)
    let reconstructed = overlay_on_background(&processed, background_color);

    // Save outputs for inspection
    save_test_images(
        "square_gradient_stroke",
        "strict_auto",
        &processed,
        &reconstructed,
    );

    // Verify perfect reconstruction
    let similarity = calculate_similarity_percentage(&original, &reconstructed);
    let psnr = calculate_psnr(&original, &reconstructed);

    println!(
        "Strict (auto colors) - Similarity: {:.2}%, PSNR: {:.2} dB",
        similarity, psnr
    );
    assert!(
        similarity > 99.0,
        "Similarity {:.2}% is too low",
        similarity
    );
}

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

    // Run bgone in non-strict mode with three known foreground colors and higher threshold
    // This should make more pixels be considered "close enough" to use the known colors
    Command::new(cargo::cargo_bin!("bgone"))
        .args([
            "tests/inputs/square-gradient-stroke.png",
            output_path.to_str().unwrap(),
            "--fg",
            "00ffff", // cyan
            "--fg",
            "ff00ff", // magenta
            "--fg",
            "a7b511", // actual stroke color
            "--bg",
            "14191e", // dark background (20, 25, 30)
            "--fg-threshold",
            "0.5", // 50% threshold instead of default 5%
        ])
        .assert()
        .success();

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

    // Reconstruct by overlaying on background
    let background_color = [0x14, 0x19, 0x1e]; // (20, 25, 30)
    let reconstructed = overlay_on_background(&processed, background_color);

    // Save outputs for inspection
    save_test_images(
        "square_gradient_stroke",
        "non_strict_with_fg_high_threshold",
        &processed,
        &reconstructed,
    );

    // Verify perfect reconstruction
    let similarity = calculate_similarity_percentage(&original, &reconstructed);
    let psnr = calculate_psnr(&original, &reconstructed);

    println!(
        "Non-strict (high threshold) - Similarity: {:.2}%, PSNR: {:.2} dB",
        similarity, psnr
    );
    assert!(
        similarity > 99.0,
        "Similarity {:.2}% is too low",
        similarity
    );
}