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
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
use exr::prelude::*;
use crate::error::{DecodingError, EncodingError, ImageFormatHint};
use crate::image::decoder_to_vec;
use crate::{
ColorType, ExtendedColorType, ImageDecoder, ImageEncoder, ImageError, ImageFormat, ImageResult,
Progress,
};
use std::convert::TryInto;
use std::io::{Cursor, Read, Seek, Write};
#[derive(Debug)]
pub struct OpenExrDecoder<R> {
exr_reader: exr::block::reader::Reader<R>,
header_index: usize,
alpha_preference: Option<bool>,
alpha_present_in_file: bool,
}
impl<R: Read + Seek> OpenExrDecoder<R> {
pub fn new(source: R) -> ImageResult<Self> {
Self::with_alpha_preference(source, None)
}
pub fn with_alpha_preference(source: R, alpha_preference: Option<bool>) -> ImageResult<Self> {
let exr_reader = exr::block::read(source, false).map_err(to_image_err)?;
let header_index = exr_reader
.headers()
.iter()
.position(|header| {
let has_rgb = ["R", "G", "B"]
.iter()
.all(|&required| header.channels.find_index_of_channel(&Text::from(required)).is_some());
!header.deep && has_rgb
})
.ok_or_else(|| {
ImageError::Decoding(DecodingError::new(
ImageFormatHint::Exact(ImageFormat::OpenExr),
"image does not contain non-deep rgb channels",
))
})?;
let has_alpha = exr_reader.headers()[header_index]
.channels
.find_index_of_channel(&Text::from("A"))
.is_some();
Ok(Self {
alpha_preference,
exr_reader,
header_index,
alpha_present_in_file: has_alpha,
})
}
fn selected_exr_header(&self) -> &exr::meta::header::Header {
&self.exr_reader.meta_data().headers[self.header_index]
}
}
impl<'a, R: 'a + Read + Seek> ImageDecoder<'a> for OpenExrDecoder<R> {
type Reader = Cursor<Vec<u8>>;
fn dimensions(&self) -> (u32, u32) {
let size = self
.selected_exr_header()
.shared_attributes
.display_window
.size;
(size.width() as u32, size.height() as u32)
}
fn color_type(&self) -> ColorType {
let returns_alpha = self.alpha_preference.unwrap_or(self.alpha_present_in_file);
if returns_alpha {
ColorType::Rgba32F
} else {
ColorType::Rgb32F
}
}
fn original_color_type(&self) -> ExtendedColorType {
if self.alpha_present_in_file {
ExtendedColorType::Rgba32F
} else {
ExtendedColorType::Rgb32F
}
}
fn into_reader(self) -> ImageResult<Self::Reader> {
Ok(Cursor::new(decoder_to_vec(self)?))
}
fn scanline_bytes(&self) -> u64 {
self.total_bytes()
}
fn read_image_with_progress<F: Fn(Progress)>(
self,
unaligned_bytes: &mut [u8],
progress_callback: F,
) -> ImageResult<()> {
let blocks_in_header = self.selected_exr_header().chunk_count as u64;
let channel_count = self.color_type().channel_count() as usize;
let display_window = self.selected_exr_header().shared_attributes.display_window;
let data_window_offset =
self.selected_exr_header().own_attributes.layer_position - display_window.position;
{
let (width, height) = self.dimensions();
let bytes_per_pixel = self.color_type().bytes_per_pixel() as usize;
let expected_byte_count = (width as usize)
.checked_mul(height as usize)
.and_then(|size| size.checked_mul(bytes_per_pixel));
let has_invalid_size_or_overflowed = expected_byte_count
.map(|expected_byte_count| unaligned_bytes.len() != expected_byte_count)
.unwrap_or(true);
if has_invalid_size_or_overflowed {
panic!("byte buffer not large enough for the specified dimensions and f32 pixels");
}
}
let result = read()
.no_deep_data()
.largest_resolution_level()
.rgba_channels(
move |_size, _channels| vec![0_f32; display_window.size.area() * channel_count],
move |buffer, index_in_data_window, (r, g, b, a_or_1): (f32, f32, f32, f32)| {
let index_in_display_window =
index_in_data_window.to_i32() + data_window_offset;
if index_in_display_window.x() >= 0
&& index_in_display_window.y() >= 0
&& index_in_display_window.x() < display_window.size.width() as i32
&& index_in_display_window.y() < display_window.size.height() as i32
{
let index_in_display_window =
index_in_display_window.to_usize("index bug").unwrap();
let first_f32_index =
index_in_display_window.flat_index_for_size(display_window.size);
buffer[first_f32_index * channel_count
..(first_f32_index + 1) * channel_count]
.copy_from_slice(&[r, g, b, a_or_1][0..channel_count]);
}
},
)
.first_valid_layer() .all_attributes()
.on_progress(|progress| {
progress_callback(
Progress::new(
(progress * blocks_in_header as f64) as u64,
blocks_in_header,
), );
})
.from_chunks(self.exr_reader)
.map_err(to_image_err)?;
unaligned_bytes.copy_from_slice(bytemuck::cast_slice(
result.layer_data.channel_data.pixels.as_slice(),
));
Ok(())
}
}
fn write_buffer(
mut buffered_write: impl Write + Seek,
unaligned_bytes: &[u8],
width: u32,
height: u32,
color_type: ColorType,
) -> ImageResult<()> {
let width = width as usize;
let height = height as usize;
{
let expected_byte_count = width
.checked_mul(height)
.and_then(|size| size.checked_mul(color_type.bytes_per_pixel() as usize));
let has_invalid_size_or_overflowed = expected_byte_count
.map(|expected_byte_count| unaligned_bytes.len() < expected_byte_count)
.unwrap_or(true);
if has_invalid_size_or_overflowed {
return Err(ImageError::Encoding(EncodingError::new(
ImageFormatHint::Exact(ImageFormat::OpenExr),
"byte buffer not large enough for the specified dimensions and f32 pixels",
)));
}
}
let lookup_f32 = move |f32_index: usize| {
let unaligned_f32_bytes_slice = &unaligned_bytes[f32_index * 4..(f32_index + 1) * 4];
let f32_bytes_array = unaligned_f32_bytes_slice
.try_into()
.expect("indexing error");
f32::from_ne_bytes(f32_bytes_array)
};
match color_type {
ColorType::Rgb32F => {
exr::prelude::Image ::from_channels(
(width, height),
SpecificChannels::rgb(|pixel: Vec2<usize>| {
let pixel_index = 3 * pixel.flat_index_for_size(Vec2(width, height));
(
lookup_f32(pixel_index),
lookup_f32(pixel_index + 1),
lookup_f32(pixel_index + 2),
)
}),
)
.write()
.to_buffered(&mut buffered_write)
.map_err(to_image_err)?;
}
ColorType::Rgba32F => {
exr::prelude::Image ::from_channels(
(width, height),
SpecificChannels::rgba(|pixel: Vec2<usize>| {
let pixel_index = 4 * pixel.flat_index_for_size(Vec2(width, height));
(
lookup_f32(pixel_index),
lookup_f32(pixel_index + 1),
lookup_f32(pixel_index + 2),
lookup_f32(pixel_index + 3),
)
}),
)
.write()
.to_buffered(&mut buffered_write)
.map_err(to_image_err)?;
}
unsupported_color_type => {
return Err(ImageError::Encoding(EncodingError::new(
ImageFormatHint::Exact(ImageFormat::OpenExr),
format!(
"writing color type {:?} not yet supported",
unsupported_color_type
),
)))
}
}
Ok(())
}
#[derive(Debug)]
pub struct OpenExrEncoder<W>(W);
impl<W> OpenExrEncoder<W> {
pub fn new(write: W) -> Self {
Self(write)
}
}
impl<W> ImageEncoder for OpenExrEncoder<W>
where
W: Write + Seek,
{
fn write_image(
self,
buf: &[u8],
width: u32,
height: u32,
color_type: ColorType,
) -> ImageResult<()> {
write_buffer(self.0, buf, width, height, color_type)
}
}
fn to_image_err(exr_error: Error) -> ImageError {
ImageError::Decoding(DecodingError::new(
ImageFormatHint::Exact(ImageFormat::OpenExr),
exr_error.to_string(),
))
}
#[cfg(test)]
mod test {
use super::*;
use std::io::BufReader;
use std::path::{Path, PathBuf};
use crate::buffer_::{Rgb32FImage, Rgba32FImage};
use crate::error::{LimitError, LimitErrorKind};
use crate::{ImageBuffer, Rgb, Rgba};
const BASE_PATH: &[&str] = &[".", "tests", "images", "exr"];
fn write_rgb_image(write: impl Write + Seek, image: &Rgb32FImage) -> ImageResult<()> {
write_buffer(
write,
bytemuck::cast_slice(image.as_raw().as_slice()),
image.width(),
image.height(),
ColorType::Rgb32F,
)
}
fn write_rgba_image(write: impl Write + Seek, image: &Rgba32FImage) -> ImageResult<()> {
write_buffer(
write,
bytemuck::cast_slice(image.as_raw().as_slice()),
image.width(),
image.height(),
ColorType::Rgba32F,
)
}
fn read_as_rgba_image_from_file(path: impl AsRef<Path>) -> ImageResult<Rgba32FImage> {
read_as_rgba_image(BufReader::new(std::fs::File::open(path)?))
}
fn read_as_rgb_image_from_file(path: impl AsRef<Path>) -> ImageResult<Rgb32FImage> {
read_as_rgb_image(BufReader::new(std::fs::File::open(path)?))
}
fn read_as_rgb_image(read: impl Read + Seek) -> ImageResult<Rgb32FImage> {
let decoder = OpenExrDecoder::with_alpha_preference(read, Some(false))?;
let (width, height) = decoder.dimensions();
let buffer: Vec<f32> = decoder_to_vec(decoder)?;
ImageBuffer::from_raw(width, height, buffer)
.ok_or_else(|| {
ImageError::Limits(LimitError::from_kind(LimitErrorKind::InsufficientMemory))
})
}
fn read_as_rgba_image(read: impl Read + Seek) -> ImageResult<Rgba32FImage> {
let decoder = OpenExrDecoder::with_alpha_preference(read, Some(true))?;
let (width, height) = decoder.dimensions();
let buffer: Vec<f32> = decoder_to_vec(decoder)?;
ImageBuffer::from_raw(width, height, buffer)
.ok_or_else(|| {
ImageError::Limits(LimitError::from_kind(LimitErrorKind::InsufficientMemory))
})
}
#[test]
fn compare_exr_hdr() {
if cfg!(not(feature = "hdr")) {
eprintln!("warning: to run all the openexr tests, activate the hdr feature flag");
}
#[cfg(feature = "hdr")]
{
let folder = BASE_PATH.iter().collect::<PathBuf>();
let reference_path = folder.clone().join("overexposed gradient.hdr");
let exr_path = folder
.clone()
.join("overexposed gradient - data window equals display window.exr");
let hdr: Vec<Rgb<f32>> = crate::codecs::hdr::HdrDecoder::new(std::io::BufReader::new(
std::fs::File::open(&reference_path).unwrap(),
))
.unwrap()
.read_image_hdr()
.unwrap();
let exr_pixels: Rgb32FImage = read_as_rgb_image_from_file(exr_path).unwrap();
assert_eq!(
exr_pixels.dimensions().0 * exr_pixels.dimensions().1,
hdr.len() as u32
);
for (expected, found) in hdr.iter().zip(exr_pixels.pixels()) {
for (expected, found) in expected.0.iter().zip(found.0.iter()) {
assert!(
(expected - found).abs() < 0.1,
"expected {}, found {}",
expected,
found
);
}
}
}
}
#[test]
fn roundtrip_rgba() {
let mut next_random = vec![1.0, 0.0, -1.0, -3.14, 27.0, 11.0, 31.0]
.into_iter()
.cycle();
let mut next_random = move || next_random.next().unwrap();
let generated_image: Rgba32FImage = ImageBuffer::from_fn(9, 31, |_x, _y| {
Rgba([next_random(), next_random(), next_random(), next_random()])
});
let mut bytes = vec![];
write_rgba_image(Cursor::new(&mut bytes), &generated_image).unwrap();
let decoded_image = read_as_rgba_image(Cursor::new(bytes)).unwrap();
debug_assert_eq!(generated_image, decoded_image);
}
#[test]
fn roundtrip_rgb() {
let mut next_random = vec![1.0, 0.0, -1.0, -3.14, 27.0, 11.0, 31.0]
.into_iter()
.cycle();
let mut next_random = move || next_random.next().unwrap();
let generated_image: Rgb32FImage = ImageBuffer::from_fn(9, 31, |_x, _y| {
Rgb([next_random(), next_random(), next_random()])
});
let mut bytes = vec![];
write_rgb_image(Cursor::new(&mut bytes), &generated_image).unwrap();
let decoded_image = read_as_rgb_image(Cursor::new(bytes)).unwrap();
debug_assert_eq!(generated_image, decoded_image);
}
#[test]
fn compare_rgba_rgb() {
let exr_path = BASE_PATH
.iter()
.collect::<PathBuf>()
.join("overexposed gradient - data window equals display window.exr");
let rgb: Rgb32FImage = read_as_rgb_image_from_file(&exr_path).unwrap();
let rgba: Rgba32FImage = read_as_rgba_image_from_file(&exr_path).unwrap();
assert_eq!(rgba.dimensions(), rgb.dimensions());
for (Rgb(rgb), Rgba(rgba)) in rgb.pixels().zip(rgba.pixels()) {
assert_eq!(rgb, &rgba[..3]);
}
}
#[test]
fn compare_cropped() {
let exr_path = BASE_PATH.iter().collect::<PathBuf>();
let original = exr_path.clone().join("cropping - uncropped original.exr");
let cropped = exr_path
.clone()
.join("cropping - data window differs display window.exr");
{
let original_exr = read_first_flat_layer_from_file(&original).unwrap();
let cropped_exr = read_first_flat_layer_from_file(&cropped).unwrap();
assert_eq!(
original_exr.attributes.display_window,
cropped_exr.attributes.display_window
);
assert_ne!(
original_exr.layer_data.attributes.layer_position,
cropped_exr.layer_data.attributes.layer_position
);
assert_ne!(original_exr.layer_data.size, cropped_exr.layer_data.size);
}
let original: Rgba32FImage = read_as_rgba_image_from_file(&original).unwrap();
let cropped: Rgba32FImage = read_as_rgba_image_from_file(&cropped).unwrap();
assert_eq!(original.dimensions(), cropped.dimensions());
assert!(original.pixels().zip(cropped.pixels()).all(|(a, b)| a == b));
}
}