rawshift-image 0.1.1

Still-image decoding, RAW processing, and encoding for rawshift
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
//! Generate synthetic test fixture files for standard image formats.
//!
//! This binary creates small test images in `test_data/standard/<format>/` and
//! corresponding ground-truth JSON in `test_fixtures/standard/<format>/`.
//!
//! Usage:
//!   cargo run --example generate_test_fixtures
//!
//! The generated fixtures are used by integration tests in
//! `tests/standard_decode_fixtures.rs`.

use std::fs;
use std::io::Cursor;
use std::path::{Path, PathBuf};

use rawshift_image::core::image::RgbImage;
use rawshift_image::core::metadata::{
    CameraInfo, DateTimeInfo, ExifInfo, GpsInfo, ImageInfo, ImageMetadata, SRational, URational,
};
use rawshift_image::formats::encode_rgb_image;
use rawshift_image::formats::export::EncodeOptions;

fn project_root() -> PathBuf {
    PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("../..")
}

fn test_data_dir() -> PathBuf {
    project_root().join("test_data").join("standard")
}

fn test_fixtures_dir() -> PathBuf {
    project_root().join("test_fixtures").join("standard")
}

// ── Reference metadata ──────────────────────────────────────────────────────

/// Known metadata values embedded into every metadata-capable fixture.
/// Tests verify these exact values survive the encode → read round-trip.
fn reference_metadata() -> ImageMetadata {
    ImageMetadata {
        camera: CameraInfo {
            make: "rawshift-test".into(),
            model: "Synthetic-v1".into(),
            lens_make: Some("rawshift-optics".into()),
            lens_model: Some("TestLens 50mm f/1.4".into()),
            ..Default::default()
        },
        exif: ExifInfo {
            iso: Some(200),
            exposure_time: Some(URational::new(1, 125)),
            f_number: Some(URational::new(56, 10)),    // f/5.6
            focal_length: Some(URational::new(50, 1)), // 50mm
            focal_length_35mm: Some(75),
            exposure_program: Some(2), // Normal
            metering_mode: Some(5),    // Pattern
            flash: Some(0),            // No flash
            exposure_compensation: Some(SRational::new(0, 1)),
            max_aperture: Some(URational::new(14, 10)), // f/1.4
            brightness_value: Some(SRational::new(7, 1)),
        },
        datetime: DateTimeInfo {
            datetime_original: Some("2025:01:15 10:30:00".into()),
            create_date: Some("2025:01:15 10:30:00".into()),
            modify_date: Some("2025:01:15 10:30:01".into()),
            offset_time: Some("-05:00".into()),
            subsec_time: Some("123".into()),
        },
        gps: GpsInfo {
            latitude: Some([
                URational::new(43, 1),
                URational::new(39, 1),
                URational::new(0, 1),
            ]),
            latitude_ref: Some('N'),
            longitude: Some([
                URational::new(79, 1),
                URational::new(23, 1),
                URational::new(0, 1),
            ]),
            longitude_ref: Some('W'),
            altitude: Some(URational::new(76, 1)),
            altitude_ref: Some(0),
            ..Default::default()
        },
        image: ImageInfo {
            orientation: Some(1),
            ..Default::default()
        },
        xmp: Some(reference_xmp_bytes()),
        ..Default::default()
    }
}

/// Minimal valid XMP packet with Dublin Core fields for round-trip testing.
fn reference_xmp_bytes() -> Vec<u8> {
    // The XMP spec requires a BOM (U+FEFF) after begin='. We build it as a
    // regular string so Rust handles the UTF-8 encoding of the BOM correctly.
    r#"<?xpacket begin='' id='W5M0MpCehiHzreSzNTczkc9d'?>
<x:xmpmeta xmlns:x="adobe:ns:meta/">
  <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
    <rdf:Description rdf:about=""
      xmlns:dc="http://purl.org/dc/elements/1.1/"
      xmlns:xmp="http://ns.adobe.com/xap/1.0/">
      <dc:description>rawshift synthetic test fixture</dc:description>
      <dc:creator><rdf:Seq><rdf:li>rawshift-test</rdf:li></rdf:Seq></dc:creator>
      <xmp:CreatorTool>rawshift generate_test_fixtures</xmp:CreatorTool>
    </rdf:Description>
  </rdf:RDF>
</x:xmpmeta>
<?xpacket end='w'?>"#
        .as_bytes()
        .to_vec()
}

// ── Pixel generation ────────────────────────────────────────────────────────

/// 8x8 RGB pixels with known colors for verification.
/// Row 0: red, green, blue, white, black, cyan, magenta, yellow
/// Rows 1-7: gradient patterns
fn reference_pixels_u8() -> (u32, u32, Vec<u8>) {
    let w = 8u32;
    let h = 8u32;
    let mut pixels = Vec::with_capacity((w * h * 3) as usize);

    // Row 0: primary + secondary colors
    let colors: [(u8, u8, u8); 8] = [
        (255, 0, 0),     // red
        (0, 255, 0),     // green
        (0, 0, 255),     // blue
        (255, 255, 255), // white
        (0, 0, 0),       // black
        (0, 255, 255),   // cyan
        (255, 0, 255),   // magenta
        (255, 255, 0),   // yellow
    ];
    for &(r, g, b) in &colors {
        pixels.extend_from_slice(&[r, g, b]);
    }

    // Rows 1-7: horizontal gradient
    for row in 1..h {
        for col in 0..w {
            let v = ((row * w + col) * 255 / (w * h - 1)) as u8;
            pixels.extend_from_slice(&[v, (255 - v), (v / 2 + 64)]);
        }
    }

    (w, h, pixels)
}

/// Convert 8-bit pixel data to 16-bit (u8 * 257 maps 0→0, 255→65535).
fn pixels_u8_to_u16(pixels_u8: &[u8]) -> Vec<u16> {
    pixels_u8.iter().map(|&v| v as u16 * 257).collect()
}

// ── Expected JSON ───────────────────────────────────────────────────────────

fn write_expected_json(
    dir: &Path,
    name: &str,
    width: u32,
    height: u32,
    format: &str,
    has_metadata: bool,
) {
    let metadata_block = if has_metadata {
        r#",
  "metadata": {
    "make": "rawshift-test",
    "model": "Synthetic-v1",
    "iso": 200,
    "focal_length_num": 50,
    "datetime_original": "2025:01:15 10:30:00",
    "has_icc": true,
    "has_xmp": true
  }"#
    } else {
        ""
    };

    let json = format!(
        r#"{{
  "format": "{}",
  "file_name": "{}",
  "width": {},
  "height": {},
  "channels": 3,
  "bit_depth_output": 16,
  "notes": "Synthetic {} fixture generated by generate_test_fixtures"{}
}}"#,
        format, name, width, height, format, metadata_block
    );
    fs::write(dir.join("expected.json"), json).expect("write expected.json");
}

// ── Format generators ───────────────────────────────────────────────────────

fn generate_jpeg(data_dir: &Path, fixture_dir: &Path) {
    let dir = data_dir.join("jpeg");
    let fdir = fixture_dir.join("jpeg");
    fs::create_dir_all(&dir).unwrap();
    fs::create_dir_all(&fdir).unwrap();

    let (w, h, pixels_u8) = reference_pixels_u8();
    let pixels_u16 = pixels_u8_to_u16(&pixels_u8);
    let img = RgbImage::new(w, h, pixels_u16);

    let name = "test_8x8.jpg";
    encode_rgb_image(
        &img,
        &reference_metadata(),
        &dir.join(name),
        &EncodeOptions::jpeg(),
    )
    .expect("JPEG encode");

    write_expected_json(&fdir, name, w, h, "JPEG", true);
    println!("  Generated {}", name);
}

fn generate_png(data_dir: &Path, fixture_dir: &Path) {
    let dir = data_dir.join("png");
    let fdir = fixture_dir.join("png");
    fs::create_dir_all(&dir).unwrap();
    fs::create_dir_all(&fdir).unwrap();

    let (w, h, pixels_u8) = reference_pixels_u8();
    let pixels_u16 = pixels_u8_to_u16(&pixels_u8);
    let img = RgbImage::new(w, h, pixels_u16);

    let name = "test_8x8.png";
    encode_rgb_image(
        &img,
        &reference_metadata(),
        &dir.join(name),
        &EncodeOptions::png(),
    )
    .expect("PNG encode");

    write_expected_json(&fdir, name, w, h, "PNG", true);
    println!("  Generated {}", name);
}

fn generate_gif(data_dir: &Path, fixture_dir: &Path) {
    use gif::{Encoder, Frame, Repeat};
    use std::borrow::Cow;

    let dir = data_dir.join("gif");
    let fdir = fixture_dir.join("gif");
    fs::create_dir_all(&dir).unwrap();
    fs::create_dir_all(&fdir).unwrap();

    // 4x4 GIF with 4-color palette
    let palette: &[u8] = &[
        255, 0, 0, // 0: red
        0, 255, 0, // 1: green
        0, 0, 255, // 2: blue
        255, 255, 255, // 3: white
        0, 0, 0, // padding
        0, 0, 0, 0, 0, 0, 0, 0, 0,
    ];

    let mut out: Vec<u8> = Vec::new();
    let mut encoder = Encoder::new(&mut out, 4, 4, palette).expect("gif encoder");
    encoder.set_repeat(Repeat::Finite(0)).unwrap();

    let frame = Frame {
        width: 4,
        height: 4,
        // 4x4 grid: alternating pattern
        buffer: Cow::Owned(vec![0, 1, 2, 3, 1, 2, 3, 0, 2, 3, 0, 1, 3, 0, 1, 2]),
        ..Frame::default()
    };
    encoder.write_frame(&frame).unwrap();
    drop(encoder);

    let name = "test_4x4.gif";
    fs::write(dir.join(name), &out).expect("write GIF");
    write_expected_json(&fdir, name, 4, 4, "GIF", false);
    println!("  Generated {}", name);
}

fn generate_tiff(data_dir: &Path, fixture_dir: &Path) {
    use tiff::encoder::{TiffEncoder, colortype::RGB8};

    let dir = data_dir.join("tiff");
    let fdir = fixture_dir.join("tiff");
    fs::create_dir_all(&dir).unwrap();
    fs::create_dir_all(&fdir).unwrap();

    let (w, h, pixels) = reference_pixels_u8();
    let mut cursor = Cursor::new(Vec::new());
    {
        let mut enc = TiffEncoder::new(&mut cursor).unwrap();
        enc.write_image::<RGB8>(w, h, &pixels).unwrap();
    }

    let name = "test_8x8.tiff";
    fs::write(dir.join(name), cursor.into_inner()).expect("write TIFF");
    write_expected_json(&fdir, name, w, h, "TIFF", false);
    println!("  Generated {}", name);
}

fn generate_webp(data_dir: &Path, fixture_dir: &Path) {
    let dir = data_dir.join("webp");
    let fdir = fixture_dir.join("webp");
    fs::create_dir_all(&dir).unwrap();
    fs::create_dir_all(&fdir).unwrap();

    let (w, h, pixels_u8) = reference_pixels_u8();
    let pixels_u16 = pixels_u8_to_u16(&pixels_u8);
    let img = RgbImage::new(w, h, pixels_u16);

    let name = "test_8x8.webp";
    encode_rgb_image(
        &img,
        &reference_metadata(),
        &dir.join(name),
        &EncodeOptions::webp_lossless(),
    )
    .expect("WebP encode");

    write_expected_json(&fdir, name, w, h, "WebP", true);
    println!("  Generated {}", name);
}

fn generate_svg(data_dir: &Path, fixture_dir: &Path) {
    let dir = data_dir.join("svg");
    let fdir = fixture_dir.join("svg");
    fs::create_dir_all(&dir).unwrap();
    fs::create_dir_all(&fdir).unwrap();

    let svg = r#"<svg xmlns="http://www.w3.org/2000/svg" width="8" height="8">
  <rect x="0" y="0" width="4" height="4" fill="red"/>
  <rect x="4" y="0" width="4" height="4" fill="green"/>
  <rect x="0" y="4" width="4" height="4" fill="blue"/>
  <rect x="4" y="4" width="4" height="4" fill="white"/>
</svg>"#;

    let name = "test_8x8.svg";
    fs::write(dir.join(name), svg).expect("write SVG");
    write_expected_json(&fdir, name, 8, 8, "SVG", false);
    println!("  Generated {}", name);
}

#[cfg(feature = "avif-encode")]
fn generate_avif(data_dir: &Path, fixture_dir: &Path) {
    let dir = data_dir.join("avif");
    let fdir = fixture_dir.join("avif");
    fs::create_dir_all(&dir).unwrap();
    fs::create_dir_all(&fdir).unwrap();

    let (w, h, pixels_u8) = reference_pixels_u8();
    let pixels_u16 = pixels_u8_to_u16(&pixels_u8);
    let img = RgbImage::new(w, h, pixels_u16);

    let name = "test_8x8.avif";
    encode_rgb_image(
        &img,
        &reference_metadata(),
        &dir.join(name),
        &EncodeOptions::avif(),
    )
    .expect("AVIF encode");

    write_expected_json(&fdir, name, w, h, "AVIF", true);
    println!("  Generated {}", name);
}

#[cfg(feature = "jxl-encode")]
fn generate_jxl(data_dir: &Path, fixture_dir: &Path) {
    let dir = data_dir.join("jxl");
    let fdir = fixture_dir.join("jxl");
    fs::create_dir_all(&dir).unwrap();
    fs::create_dir_all(&fdir).unwrap();

    let (w, h, pixels_u8) = reference_pixels_u8();
    let pixels_u16 = pixels_u8_to_u16(&pixels_u8);
    let img = RgbImage::new(w, h, pixels_u16);

    let name = "test_8x8.jxl";
    encode_rgb_image(
        &img,
        &reference_metadata(),
        &dir.join(name),
        &EncodeOptions::jxl(),
    )
    .expect("JXL encode");

    // JXL metadata reading is not yet implemented, so no metadata in ground truth
    write_expected_json(&fdir, name, w, h, "JXL", false);
    println!("  Generated {}", name);
}

fn main() {
    let data_dir = test_data_dir();
    let fixture_dir = test_fixtures_dir();

    println!("Generating standard format test fixtures...");
    println!("  Data dir:    {}", data_dir.display());
    println!("  Fixture dir: {}", fixture_dir.display());
    println!();

    generate_jpeg(&data_dir, &fixture_dir);
    generate_png(&data_dir, &fixture_dir);
    generate_gif(&data_dir, &fixture_dir);
    generate_tiff(&data_dir, &fixture_dir);
    generate_webp(&data_dir, &fixture_dir);
    generate_svg(&data_dir, &fixture_dir);
    #[cfg(feature = "avif-encode")]
    generate_avif(&data_dir, &fixture_dir);
    #[cfg(feature = "jxl-encode")]
    generate_jxl(&data_dir, &fixture_dir);

    println!();
    println!("Done. Run integration tests with:");
    println!("  cargo test --test standard_decode_fixtures");
    #[cfg(feature = "avif-encode")]
    println!("  cargo test --features avif --test standard_decode_fixtures");
    #[cfg(feature = "jxl-encode")]
    println!("  cargo test --features jxl --test standard_decode_fixtures");
}