vfxpreopenexr 0.0.4

openexr test package
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
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
use crate::{
    core::{
        channel_list::Channel,
        channel_list::CHANNEL_HALF,
        error::Error,
        refptr::{OpaquePtr, Ref, RefMut},
    },
    deep::{
        deep_frame_buffer::DeepSlice,
        deep_image_level::{DeepImageLevelRef, DeepImageLevelRefMut},
    },
};
use half::f16;
use openexr_sys as sys;

type Result<T, E = Error> = std::result::Result<T, E>;

/// Holds the pixel data for a single half-float channel in one level in a
/// [`DeepImage`](crate::deep::deep_image::DeepImage)
///
#[repr(transparent)]
pub struct DeepChannelF16(pub(crate) *mut sys::Imf_DeepHalfChannel_t);

unsafe impl OpaquePtr for DeepChannelF16 {
    type SysPointee = sys::Imf_DeepHalfChannel_t;
    type Pointee = DeepChannelF16;
}

pub type DeepChannelF16Ref<'a, P = DeepChannelF16> = Ref<'a, P>;
pub type DeepChannelF16RefMut<'a, P = DeepChannelF16> = RefMut<'a, P>;

/// Holds the pixel data for a single float channel in one level in a
/// [`DeepImage`](crate::deep::deep_image::DeepImage)
///
#[repr(transparent)]
pub struct DeepChannelF32(pub(crate) *mut sys::Imf_DeepFloatChannel_t);

unsafe impl OpaquePtr for DeepChannelF32 {
    type SysPointee = sys::Imf_DeepFloatChannel_t;
    type Pointee = DeepChannelF32;
}

pub type DeepChannelF32Ref<'a, P = DeepChannelF32> = Ref<'a, P>;
pub type DeepChannelF32RefMut<'a, P = DeepChannelF32> = RefMut<'a, P>;

/// Holds the pixel data for a single unsigned int channel in one level in a
/// [`DeepImage`](crate::deep::deep_image::DeepImage)
///
#[repr(transparent)]
pub struct DeepChannelU32(pub(crate) *mut sys::Imf_DeepUIntChannel_t);

unsafe impl OpaquePtr for DeepChannelU32 {
    type SysPointee = sys::Imf_DeepUIntChannel_t;
    type Pointee = DeepChannelU32;
}

pub type DeepChannelU32Ref<'a, P = DeepChannelU32> = Ref<'a, P>;
pub type DeepChannelU32RefMut<'a, P = DeepChannelU32> = RefMut<'a, P>;

impl DeepChannelF16 {
    /// Get the [`Channel`] description for this channel
    ///
    pub fn channel(&self) -> Channel {
        let mut c = CHANNEL_HALF;
        unsafe {
            sys::Imf_DeepHalfChannel_channel(self.0, &mut c);
        }
        c
    }

    /// Get the sampling rate in the `x` direction
    ///
    pub fn x_sampling(&self) -> i32 {
        let mut v = 0;
        unsafe {
            sys::Imf_DeepHalfChannel_xSampling(self.0, &mut v);
            v
        }
    }

    /// Get the sampling rate in the `y` direction
    ///
    pub fn y_sampling(&self) -> i32 {
        let mut v = 0;
        unsafe {
            sys::Imf_DeepHalfChannel_ySampling(self.0, &mut v);
            v
        }
    }

    /// Is this channel perceptually linear?
    ///
    pub fn p_linear(&self) -> bool {
        let mut v = false;
        unsafe {
            sys::Imf_DeepHalfChannel_pLinear(self.0, &mut v);
            v
        }
    }

    /// How many pixels are there in each row of this channel
    ///
    pub fn pixels_per_row(&self) -> i32 {
        let mut v = 0;
        unsafe {
            sys::Imf_DeepHalfChannel_pixelsPerRow(self.0, &mut v);
            v
        }
    }

    /// How many pixels are there in each column of this channel
    ///
    pub fn pixels_per_column(&self) -> i32 {
        let mut v = 0;
        unsafe {
            sys::Imf_DeepHalfChannel_pixelsPerColumn(self.0, &mut v);
            v
        }
    }

    /// How many pixels are there total in this channel
    ///
    pub fn num_pixels(&self) -> usize {
        let mut v = 0;
        unsafe {
            sys::Imf_DeepHalfChannel_numPixels(self.0, &mut v);
            v as usize
        }
    }

    /// Construct a [`DeepSlice`] for this Channel
    ///
    pub fn slice(&self) -> DeepSlice {
        let mut s = sys::Imf_DeepSlice_t::default();
        unsafe {
            sys::Imf_DeepHalfChannel_slice(self.0, &mut s);
        }
        DeepSlice(s)
    }

    /// Get the level which this channel is a part of
    ///
    pub fn deep_level(&self) -> DeepImageLevelRef {
        let mut ptr = std::ptr::null();
        unsafe {
            sys::Imf_DeepHalfChannel_deepLevel_const(self.0, &mut ptr);
        }
        DeepImageLevelRef::new(ptr)
    }

    /// Get the level which this channel is a part of
    ///
    pub fn deep_level_mut(&mut self) -> DeepImageLevelRefMut {
        let mut ptr = std::ptr::null_mut();
        unsafe {
            sys::Imf_DeepHalfChannel_deepLevel(self.0, &mut ptr);
        }
        DeepImageLevelRefMut::new(ptr)
    }

    /// Get a reference to the pixel at `[x, y]`
    ///
    pub fn get(&self, x: i32, y: i32) -> Option<&f16> {
        let mut ptr = std::ptr::null();
        unsafe {
            sys::Imf_DeepHalfChannel_at_const(self.0, &mut ptr, x, y)
                .into_result()
                .ok()
                .map(|_| &*(ptr as *const f16))
        }
    }

    /// Get a mutable reference to the pixel at `[x, y]`
    ///
    pub fn get_mut(&self, x: i32, y: i32) -> Option<&mut f16> {
        let mut ptr = std::ptr::null_mut();
        unsafe {
            sys::Imf_DeepHalfChannel_at(self.0, &mut ptr, x, y)
                .into_result()
                .ok()
                .map(|_| &mut *(ptr as *mut f16))
        }
    }

    /*
    // FIXME: need to figure out how we can handle rows - if we can?
    /// Get row `r` of the channel as a slice
    ///
    pub fn row(&self, r: i32) -> Option<&[f16]> {
        if r >= self.pixels_per_column() {
            None
        } else {
            let mut ptr = std::ptr::null();
            unsafe {
                sys::Imf_DeepHalfChannel_row_const(self.0, &mut ptr, r);
                if ptr.is_null() {
                    None
                } else {
                    Some(std::slice::from_raw_parts(
                        ptr as *const f16,
                        self.pixels_per_row() as usize,
                    ))
                }
            }
        }
    }

    /// Get row `r` of the channel as a mutable slice
    ///
    pub fn row_mut(&mut self, r: i32) -> Option<&mut [f16]> {
        if r >= self.pixels_per_column() {
            None
        } else {
            let mut ptr = std::ptr::null_mut();
            unsafe {
                sys::Imf_DeepHalfChannel_row(self.0, &mut ptr, r);
                if ptr.is_null() {
                    None
                } else {
                    Some(std::slice::from_raw_parts_mut(
                        ptr as *mut f16,
                        self.pixels_per_row() as usize,
                    ))
                }
            }
        }
    }
    */
}

impl DeepChannelF32 {
    /// Get the [`Channel`] description for this channel
    ///
    pub fn channel(&self) -> Channel {
        let mut c = CHANNEL_HALF;
        unsafe {
            sys::Imf_DeepFloatChannel_channel(self.0, &mut c);
        }
        c
    }

    /// Get the sampling rate in the `x` direction
    ///
    pub fn x_sampling(&self) -> i32 {
        let mut v = 0;
        unsafe {
            sys::Imf_DeepFloatChannel_xSampling(self.0, &mut v);
            v
        }
    }

    /// Get the sampling rate in the `y` direction
    ///
    pub fn y_sampling(&self) -> i32 {
        let mut v = 0;
        unsafe {
            sys::Imf_DeepFloatChannel_ySampling(self.0, &mut v);
            v
        }
    }

    /// Is this channel perceptually linear?
    ///
    pub fn p_linear(&self) -> bool {
        let mut v = false;
        unsafe {
            sys::Imf_DeepFloatChannel_pLinear(self.0, &mut v);
            v
        }
    }

    /// How many pixels are there in each row of this channel
    ///
    pub fn pixels_per_row(&self) -> i32 {
        let mut v = 0;
        unsafe {
            sys::Imf_DeepFloatChannel_pixelsPerRow(self.0, &mut v);
            v
        }
    }

    /// How many pixels are there in each column of this channel
    ///
    pub fn pixels_per_column(&self) -> i32 {
        let mut v = 0;
        unsafe {
            sys::Imf_DeepFloatChannel_pixelsPerColumn(self.0, &mut v);
            v
        }
    }

    /// How many pixels are there total in this channel
    ///
    pub fn num_pixels(&self) -> usize {
        let mut v = 0;
        unsafe {
            sys::Imf_DeepFloatChannel_numPixels(self.0, &mut v);
            v as usize
        }
    }

    /// Construct a [`DeepSlice`] for this Channel
    ///
    pub fn slice(&self) -> DeepSlice {
        let mut s = sys::Imf_DeepSlice_t::default();
        unsafe {
            sys::Imf_DeepFloatChannel_slice(self.0, &mut s);
        }
        DeepSlice(s)
    }

    /// Get the level which this channel is a part of
    ///
    pub fn deep_level(&self) -> DeepImageLevelRef {
        let mut ptr = std::ptr::null();
        unsafe {
            sys::Imf_DeepFloatChannel_deepLevel_const(self.0, &mut ptr);
        }
        DeepImageLevelRef::new(ptr)
    }

    /// Get the level which this channel is a part of
    ///
    pub fn deep_level_mut(&mut self) -> DeepImageLevelRefMut {
        let mut ptr = std::ptr::null_mut();
        unsafe {
            sys::Imf_DeepFloatChannel_deepLevel(self.0, &mut ptr);
        }
        DeepImageLevelRefMut::new(ptr)
    }

    /// Get a reference to the pixel at `[x, y]`
    ///
    pub fn get(&self, x: i32, y: i32) -> Option<&f32> {
        let mut ptr = std::ptr::null();
        unsafe {
            sys::Imf_DeepFloatChannel_at_const(self.0, &mut ptr, x, y)
                .into_result()
                .ok()
                .map(|_| &*(ptr as *const f32))
        }
    }

    /// Get a mutable reference to the pixel at `[x, y]`
    ///
    pub fn get_mut(&self, x: i32, y: i32) -> Option<&mut f32> {
        let mut ptr = std::ptr::null_mut();
        unsafe {
            sys::Imf_DeepFloatChannel_at(self.0, &mut ptr, x, y)
                .into_result()
                .ok()
                .map(|_| &mut *(ptr as *mut f32))
        }
    }

    /*
    /// Get row `r` of the channel as a slice
    ///
    pub fn row(&self, r: i32) -> Option<&[f32]> {
        if r >= self.pixels_per_column() {
            None
        } else {
            let mut ptr = std::ptr::null();
            unsafe {
                sys::Imf_DeepFloatChannel_row_const(self.0, &mut ptr, r);
                if ptr.is_null() {
                    None
                } else {
                    Some(std::slice::from_raw_parts(
                        ptr as *const f32,
                        self.pixels_per_row() as usize,
                    ))
                }
            }
        }
    }

    /// Get row `r` of the channel as a mutable slice
    ///
    pub fn row_mut(&mut self, r: i32) -> Option<&mut [f32]> {
        if r >= self.pixels_per_column() {
            None
        } else {
            let mut ptr = std::ptr::null_mut();
            unsafe {
                sys::Imf_DeepFloatChannel_row(self.0, &mut ptr, r);
                if ptr.is_null() {
                    None
                } else {
                    Some(std::slice::from_raw_parts_mut(
                        ptr as *mut f32,
                        self.pixels_per_row() as usize,
                    ))
                }
            }
        }
    }
    */
}

impl DeepChannelU32 {
    /// Get the [`Channel`] description for this channel
    ///
    pub fn channel(&self) -> Channel {
        let mut c = CHANNEL_HALF;
        unsafe {
            sys::Imf_DeepUIntChannel_channel(self.0, &mut c);
        }
        c
    }

    /// Get the sampling rate in the `x` direction
    ///
    pub fn x_sampling(&self) -> i32 {
        let mut v = 0;
        unsafe {
            sys::Imf_DeepUIntChannel_xSampling(self.0, &mut v);
            v
        }
    }

    /// Get the sampling rate in the `y` direction
    ///
    pub fn y_sampling(&self) -> i32 {
        let mut v = 0;
        unsafe {
            sys::Imf_DeepUIntChannel_ySampling(self.0, &mut v);
            v
        }
    }

    /// Is this channel perceptually linear?
    ///
    pub fn p_linear(&self) -> bool {
        let mut v = false;
        unsafe {
            sys::Imf_DeepUIntChannel_pLinear(self.0, &mut v);
            v
        }
    }

    /// How many pixels are there in each row of this channel
    ///
    pub fn pixels_per_row(&self) -> i32 {
        let mut v = 0;
        unsafe {
            sys::Imf_DeepUIntChannel_pixelsPerRow(self.0, &mut v);
            v
        }
    }

    /// How many pixels are there in each column of this channel
    ///
    pub fn pixels_per_column(&self) -> i32 {
        let mut v = 0;
        unsafe {
            sys::Imf_DeepUIntChannel_pixelsPerColumn(self.0, &mut v);
            v
        }
    }

    /// How many pixels are there total in this channel
    ///
    pub fn num_pixels(&self) -> usize {
        let mut v = 0;
        unsafe {
            sys::Imf_DeepUIntChannel_numPixels(self.0, &mut v);
            v as usize
        }
    }

    /// Construct a [`DeepSlice`] for this Channel
    ///
    pub fn slice(&self) -> DeepSlice {
        let mut s = sys::Imf_DeepSlice_t::default();
        unsafe {
            sys::Imf_DeepUIntChannel_slice(self.0, &mut s);
        }
        DeepSlice(s)
    }

    /// Get the level which this channel is a part of
    ///
    pub fn deep_level(&self) -> DeepImageLevelRef {
        let mut ptr = std::ptr::null();
        unsafe {
            sys::Imf_DeepUIntChannel_deepLevel_const(self.0, &mut ptr);
        }
        DeepImageLevelRef::new(ptr)
    }

    /// Get the level which this channel is a part of
    ///
    pub fn deep_level_mut(&mut self) -> DeepImageLevelRefMut {
        let mut ptr = std::ptr::null_mut();
        unsafe {
            sys::Imf_DeepUIntChannel_deepLevel(self.0, &mut ptr);
        }
        DeepImageLevelRefMut::new(ptr)
    }

    /// Get a reference to the pixel at `[x, y]`
    ///
    pub fn get(&self, x: i32, y: i32) -> Option<&u32> {
        let mut ptr = std::ptr::null();
        unsafe {
            sys::Imf_DeepUIntChannel_at_const(self.0, &mut ptr, x, y)
                .into_result()
                .ok()
                .map(|_| &*(ptr as *const u32))
        }
    }

    /// Get a mutable reference to the pixel at `[x, y]`
    ///
    pub fn get_mut(&self, x: i32, y: i32) -> Option<&mut u32> {
        let mut ptr = std::ptr::null_mut();
        unsafe {
            sys::Imf_DeepUIntChannel_at(self.0, &mut ptr, x, y)
                .into_result()
                .ok()
                .map(|_| &mut *(ptr as *mut u32))
        }
    }

    /*
    /// Get row `r` of the channel as a slice
    ///
    pub fn row(&self, r: i32) -> Option<&[u32]> {
        if r >= self.pixels_per_column() {
            None
        } else {
            let mut ptr = std::ptr::null();
            unsafe {
                sys::Imf_DeepUIntChannel_row_const(self.0, &mut ptr, r);
                if ptr.is_null() {
                    None
                } else {
                    Some(std::slice::from_raw_parts(
                        ptr as *const *const u32,
                        self.pixels_per_row() as usize,
                    ))
                }
            }
        }
    }

    /// Get row `r` of the channel as a mutable slice
    ///
    pub fn row_mut(&mut self, r: i32) -> Option<&mut [u32]> {
        if r >= self.pixels_per_column() {
            None
        } else {
            let mut ptr = std::ptr::null_mut();
            unsafe {
                sys::Imf_DeepUIntChannel_row(self.0, &mut ptr, r);
                if ptr.is_null() {
                    None
                } else {
                    Some(std::slice::from_raw_parts_mut(
                        ptr as *mut *mut u32,
                        self.pixels_per_row() as usize,
                    ))
                }
            }
        }
    }
    */
}