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
use openexr_sys as sys;
use crate::{
core::{
error::Error,
frame_buffer::{FrameBuffer, FrameBufferRef},
header::HeaderRef,
},
multi_part::multi_part_input_file::MultiPartInputFile,
};
type Result<T, E = Error> = std::result::Result<T, E>;
use std::marker::PhantomData;
#[repr(transparent)]
pub struct InputPart<'a> {
pub(crate) inner: sys::Imf_InputPart_t,
phantom: std::marker::PhantomData<&'a MultiPartInputFile>,
}
impl<'a> InputPart<'a> {
/// Get an interface to the part `part_number` of the [`MultiPartInputFile`]
/// `multi_part_file`.
///
pub fn new(
multi_part_file: &MultiPartInputFile,
part_number: i32,
) -> Result<InputPart> {
let mut part = sys::Imf_InputPart_t::default();
unsafe {
sys::Imf_InputPart_ctor(&mut part, multi_part_file.0, part_number)
.into_result()?;
}
Ok(InputPart {
inner: part,
phantom: PhantomData,
})
}
/// Access to the file [`Header`](crate::core::header::Header)
///
pub fn header(&self) -> HeaderRef {
unsafe {
let mut ptr = std::ptr::null();
sys::Imf_InputPart_header(&self.inner, &mut ptr);
if ptr.is_null() {
panic!("Received null ptr from sys::Imf_InputPart_header");
}
HeaderRef::new(ptr)
}
}
/// Access to the file format version
///
pub fn version(&self) -> i32 {
let mut v = 0;
unsafe {
sys::Imf_InputPart_version(&self.inner, &mut v);
}
v
}
/// Set the current frame buffer -- copies the FrameBuffer
/// object into the InputPart object.
///
/// The current frame buffer is the destination for the pixel
/// data read from the file. The current frame buffer must be
/// set at least once before `read_pixels()` is called.
/// The current frame buffer can be changed after each call
/// to `read_pixels()`.
///
/// # Errors
/// * [`Error::InvalidArgument`] - if the sampling factors do not match or
/// if the frame buffer does not have a sample count slice.
///
pub fn set_frame_buffer(
&mut self,
frame_buffer: &FrameBuffer,
) -> Result<()> {
unsafe {
sys::Imf_InputPart_setFrameBuffer(
&mut self.inner,
frame_buffer.ptr,
)
.into_result()?;
}
Ok(())
}
/// Access to the current frame buffer
///
pub fn frame_buffer(&self) -> FrameBufferRef {
let mut ptr = std::ptr::null();
unsafe {
sys::Imf_InputPart_frameBuffer(&self.inner, &mut ptr);
}
FrameBufferRef::new(ptr)
}
/// Check if all pixels in the data window are present in the input file
///
pub fn is_complete(&self) -> bool {
let mut v = false;
unsafe {
sys::Imf_InputPart_isComplete(&self.inner, &mut v);
}
v
}
/// Check if SSE optimization is enabled
///
/// Call after `set_frame_buffer()` to query whether optimized file decoding
/// is available - decode times will be faster if returns true
///
/// Optimization depends on:
/// the file type (only scanline data is supported),
/// the framebuffer channels (RGB/RGBA mono or stereo)
/// the framebuffer channel types (all channels half-float format only)
/// the file channels (RGB/RGBA mono or stereo)
/// the file channel types (all channel half-float format only)
/// whether SSE2 instruction support was detected at compile time
///
/// # Errors
/// * [`Error::InvalidArgument`] - if no frame buffer has been set
///
pub fn is_optimization_enabled(&self) -> bool {
let mut v = false;
unsafe {
sys::Imf_InputPart_isOptimizationEnabled(&self.inner, &mut v);
}
v
}
/// Read all scanlines in the range [s1, s2] and put them in the current
/// frame buffer.
///
/// `read_pixel_sample_counts()` must be called before calling this method.
///
/// # Safety
/// You must ensure the the [`FrameBuffer`] attached to this part by
/// [`set_frame_buffer()`](InputPart::set_frame_buffer) has valid slices
/// for the channels to be read.
///
/// # Errors
/// * [`Error::InvalidArgument`] - if no frame buffer has been set, if `s1`
/// or `s2` are outside the data window, or if the sample counts have not been
/// read yet
/// * [`Error::Base`] - if any other error occurs
///
pub unsafe fn read_pixels(&mut self, s1: i32, s2: i32) -> Result<()> {
sys::Imf_InputPart_readPixels(&mut self.inner, s1, s2).into_result()?;
Ok(())
}
}