oiio-sys 0.4.1

Rust sys bindings for OpenImageIO https://github.com/AcademySoftwareFoundation/OpenImageIO
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
pub use ffi::*;

// This is the raw, signature-compatible FFI layer. Safety contracts and
// operation-oriented arguments belong on the public wrappers in `oiio`.
#[allow(clippy::missing_safety_doc, clippy::too_many_arguments)]
#[cxx::bridge(namespace = oiio)]
mod ffi {
    unsafe extern "C++" {
        include!("oiio-sys/src/ffi_imagecache.h");

        pub type ImageCache;
        pub type ImageHandle;
        pub type Perthread;
        pub type TextureOpt;
        pub type Tile;
        pub type ImageBuf = crate::imageio::ImageBuf;
        pub type ImageSpec = crate::imageio::ImageSpec;
        pub type ROI = crate::imageio::ROI;
        pub type TypeDesc = crate::typedesc::TypeDesc;

        pub fn imagecache_create(shared: bool) -> SharedPtr<ImageCache>;

        pub fn imagecache_destroy(imagecache: SharedPtr<ImageCache>, teardown: bool);

        pub unsafe fn imagecache_attribute(
            imagecache: Pin<&mut ImageCache>,
            name: &str,
            type_: TypeDesc,
            val: *const u8,
        ) -> bool;

        pub fn imagecache_attribute_int(
            imagecache: Pin<&mut ImageCache>,
            name: &str,
            val: i32,
        ) -> bool;

        pub fn imagecache_attribute_int_with_error(
            imagecache: Pin<&mut ImageCache>,
            name: &str,
            val: i32,
            error: &mut String,
        ) -> bool;

        pub fn imagecache_attribute_float(
            imagecache: Pin<&mut ImageCache>,
            name: &str,
            val: f32,
        ) -> bool;

        pub fn imagecache_attribute_float_with_error(
            imagecache: Pin<&mut ImageCache>,
            name: &str,
            val: f32,
            error: &mut String,
        ) -> bool;

        pub fn imagecache_attribute_double(
            imagecache: Pin<&mut ImageCache>,
            name: &str,
            val: f64,
        ) -> bool;

        pub fn imagecache_attribute_str(
            imagecache: Pin<&mut ImageCache>,
            name: &str,
            val: &str,
        ) -> bool;

        pub unsafe fn imagecache_getattribute(
            imagecache: Pin<&mut ImageCache>,
            name: &str,
            type_: TypeDesc,
            val: *const u8,
        ) -> bool;

        pub fn imagecache_getattribute_int(
            imagecache: Pin<&mut ImageCache>,
            name: &str,
            val: &mut i32,
        ) -> bool;

        pub fn imagecache_getattribute_float(
            imagecache: Pin<&mut ImageCache>,
            name: &str,
            val: &mut f32,
        ) -> bool;

        pub fn imagecache_getattribute_double(
            imagecache: Pin<&mut ImageCache>,
            name: &str,
            val: &mut f64,
        ) -> bool;

        pub fn imagecache_getattribute_string(
            imagecache: Pin<&mut ImageCache>,
            name: &str,
            val: Pin<&mut CxxString>,
        ) -> bool;

        pub fn imagecache_getattributetype(
            imagecache: Pin<&mut ImageCache>,
            name: &str,
        ) -> TypeDesc;

        pub unsafe fn imagecache_get_perthread_info(
            imagecache: Pin<&mut ImageCache>,
            thread_info: *mut Perthread,
        ) -> *mut Perthread;

        pub unsafe fn imagecache_create_thread_info(
            imagecache: Pin<&mut ImageCache>,
        ) -> *mut Perthread;

        pub unsafe fn imagecache_destroy_thread_info(
            imagecache: Pin<&mut ImageCache>,
            thread_info: *mut Perthread,
        );

        pub unsafe fn imagecache_get_image_handle(
            imagecache: Pin<&mut ImageCache>,
            filename: &str,
            thread_info: *mut Perthread,
            options: *const TextureOpt,
        ) -> *mut ImageHandle;

        pub unsafe fn imagecache_good(
            imagecache: Pin<&mut ImageCache>,
            file: *mut ImageHandle,
        ) -> bool;

        pub unsafe fn imagecache_filename_from_handle(
            imagecache: Pin<&mut ImageCache>,
            handle: *mut ImageHandle,
        ) -> String;

        pub unsafe fn imagecache_get_image_info(
            imagecache: Pin<&mut ImageCache>,
            filename: &str,
            subimage: i32,
            miplevel: i32,
            dataname: &str,
            datatype: TypeDesc,
            data: *mut u8,
        ) -> bool;

        pub unsafe fn imagecache_get_image_info_with_handle(
            imagecache: Pin<&mut ImageCache>,
            file: *mut ImageHandle,
            thread_info: *mut Perthread,
            subimage: i32,
            miplevel: i32,
            dataname: &str,
            datatype: TypeDesc,
            data: *mut u8,
        ) -> bool;

        #[deprecated(
            note = "OpenImageIO 3.x ignores miplevel/native here; use imagecache_get_imagespec_copy or imagecache_get_cache_dimensions_copy"
        )]
        pub fn imagecache_get_imagespec(
            imagecache: Pin<&mut ImageCache>,
            filename: &str,
            spec: Pin<&mut ImageSpec>,
            subimage: i32,
            miplevel: i32,
            native: bool,
        ) -> bool;

        pub fn imagecache_get_imagespec_copy(
            imagecache: Pin<&mut ImageCache>,
            filename: &str,
            subimage: i32,
        ) -> UniquePtr<ImageSpec>;

        pub fn imagecache_get_imagespec_copy_with_error(
            imagecache: Pin<&mut ImageCache>,
            filename: &str,
            subimage: i32,
            error: &mut String,
        ) -> UniquePtr<ImageSpec>;

        pub fn imagecache_get_cache_dimensions_copy(
            imagecache: Pin<&mut ImageCache>,
            filename: &str,
            subimage: i32,
            miplevel: i32,
        ) -> UniquePtr<ImageSpec>;

        pub fn imagecache_get_image_spec_at_copy_with_error(
            imagecache: Pin<&mut ImageCache>,
            filename: &str,
            subimage: i32,
            miplevel: i32,
            error: &mut String,
        ) -> UniquePtr<ImageSpec>;

        #[deprecated(
            note = "OpenImageIO 3.x ignores miplevel/native here; use a cache-dimensions binding"
        )]
        pub unsafe fn imagecache_get_imagespec_with_handle(
            imagecache: Pin<&mut ImageCache>,
            file: *mut ImageHandle,
            thread_info: *mut Perthread,
            spec: Pin<&mut ImageSpec>,
            subimage: i32,
            miplevel: i32,
            native: bool,
        ) -> bool;

        #[deprecated(
            note = "OpenImageIO 3.x ignores miplevel/native and the returned pointer can be invalidated"
        )]
        pub unsafe fn imagecache_imagespec(
            imagecache: Pin<&mut ImageCache>,
            filename: &str,
            subimage: i32,
            miplevel: i32,
            native: bool,
        ) -> *const ImageSpec;

        #[deprecated(
            note = "OpenImageIO 3.x ignores miplevel/native and the returned pointer can be invalidated"
        )]
        pub unsafe fn imagecache_imagespec_with_handle(
            imagecache: Pin<&mut ImageCache>,
            file: *mut ImageHandle,
            thread_info: *mut Perthread,
            subimage: i32,
            miplevel: i32,
            native: bool,
        ) -> *const ImageSpec;

        pub fn imagecache_get_thumbnail(
            imagecache: Pin<&mut ImageCache>,
            filename: &str,
            thumbnail: Pin<&mut ImageBuf>,
            subimage: i32,
        ) -> bool;

        pub unsafe fn imagecache_get_thumbnail_with_handle(
            imagecache: Pin<&mut ImageCache>,
            file: *mut ImageHandle,
            thread_info: *mut Perthread,
            thumbnail: Pin<&mut ImageBuf>,
            subimage: i32,
        ) -> bool;

        pub unsafe fn imagecache_get_pixels(
            imagecache: Pin<&mut ImageCache>,
            filename: &str,
            subimage: i32,
            miplevel: i32,
            xbegin: i32,
            xend: i32,
            ybegin: i32,
            yend: i32,
            zbegin: i32,
            zend: i32,
            chbegin: i32,
            chend: i32,
            format: TypeDesc,
            result: *const u8,
            xstride: i64,
            ystride: i64,
            zstride: i64,
            cache_chbegin: i32,
            cache_chend: i32,
        ) -> bool;

        /// The byte slice must be aligned for and contain initialized storage
        /// for `format`. Its length must exactly match `roi`.
        pub unsafe fn imagecache_get_pixels_span(
            imagecache: Pin<&mut ImageCache>,
            filename: &str,
            subimage: i32,
            miplevel: i32,
            roi: &ROI,
            format: TypeDesc,
            result: &mut [u8],
        ) -> bool;

        /// Reports success separately and captures the ImageCache error into
        /// `error` on failure. The byte-slice safety contract is the same as
        /// `imagecache_get_pixels_span`.
        pub unsafe fn imagecache_get_pixels_span_with_error(
            imagecache: Pin<&mut ImageCache>,
            filename: &str,
            subimage: i32,
            miplevel: i32,
            roi: &ROI,
            format: TypeDesc,
            result: &mut [u8],
            error: &mut String,
        ) -> bool;

        /// Safety: `file` must be a live handle from this cache, and
        /// `thread_info` null or a live per-thread record.
        pub unsafe fn imagecache_handle_is_deep(
            imagecache: Pin<&mut ImageCache>,
            file: *mut ImageHandle,
            thread_info: *mut Perthread,
            subimage: i32,
        ) -> i32;

        pub unsafe fn imagecache_get_pixels_handle_span_with_error(
            imagecache: Pin<&mut ImageCache>,
            file: *mut ImageHandle,
            thread_info: *mut Perthread,
            subimage: i32,
            miplevel: i32,
            roi: &ROI,
            format: TypeDesc,
            result: &mut [u8],
            error: &mut String,
        ) -> bool;

        pub unsafe fn imagecache_get_pixels_with_handle(
            imagecache: Pin<&mut ImageCache>,
            file: *mut ImageHandle,
            thread_info: *mut Perthread,
            subimage: i32,
            miplevel: i32,
            xbegin: i32,
            xend: i32,
            ybegin: i32,
            yend: i32,
            zbegin: i32,
            zend: i32,
            chbegin: i32,
            chend: i32,
            format: TypeDesc,
            result: *const u8,
            xstride: i64,
            ystride: i64,
            zstride: i64,
            cache_chbegin: i32,
            cache_chend: i32,
        ) -> bool;

        pub unsafe fn imagecache_get_pixels_all_channels(
            imagecache: Pin<&mut ImageCache>,
            filename: &str,
            subimage: i32,
            miplevel: i32,
            xbegin: i32,
            xend: i32,
            ybegin: i32,
            yend: i32,
            zbegin: i32,
            zend: i32,
            format: TypeDesc,
            result: *const u8,
        ) -> bool;

        pub unsafe fn imagecache_get_pixels_all_channels_with_handle(
            imagecache: Pin<&mut ImageCache>,
            file: *mut ImageHandle,
            thread_info: *mut Perthread,
            subimage: i32,
            miplevel: i32,
            xbegin: i32,
            xend: i32,
            ybegin: i32,
            yend: i32,
            zbegin: i32,
            zend: i32,
            format: TypeDesc,
            result: *const u8,
        ) -> bool;

        pub fn imagecache_invalidate(imagecache: Pin<&mut ImageCache>, filename: &str, force: bool);

        pub unsafe fn imagecache_invalidate_with_handle(
            imagecache: Pin<&mut ImageCache>,
            file: *mut ImageHandle,
            force: bool,
        );

        pub fn imagecache_invalidate_all(imagecache: Pin<&mut ImageCache>, force: bool);

        pub fn imagecache_close(imagecache: Pin<&mut ImageCache>, filename: &str);

        pub fn imagecache_close_all(imagecache: Pin<&mut ImageCache>);

        pub unsafe fn imagecache_get_tile(
            imagecache: Pin<&mut ImageCache>,
            filename: &str,
            subimage: i32,
            miplevel: i32,
            x: i32,
            y: i32,
            z: i32,
            chbegin: i32,
            chend: i32,
        ) -> *mut Tile;

        pub unsafe fn imagecache_get_tile_with_handle(
            imagecache: Pin<&mut ImageCache>,
            file: *mut ImageHandle,
            thread_info: *mut Perthread,
            subimage: i32,
            miplevel: i32,
            x: i32,
            y: i32,
            z: i32,
            chbegin: i32,
            chend: i32,
        ) -> *mut Tile;

        pub unsafe fn imagecache_release_tile(imagecache: Pin<&mut ImageCache>, tile: *mut Tile);

        pub unsafe fn imagecache_tile_format(
            imagecache: Pin<&mut ImageCache>,
            tile: *const Tile,
        ) -> TypeDesc;

        pub unsafe fn imagecache_tile_roi(
            imagecache: Pin<&mut ImageCache>,
            tile: *const Tile,
        ) -> ROI;

        pub unsafe fn imagecache_tile_pixels(
            imagecache: Pin<&mut ImageCache>,
            tile: *mut Tile,
            format: &mut TypeDesc,
        ) -> *const u8;

        // TODO: Add support for the ImageInput::Creator
        // pub unsafe fn imagecache_add_file(
        //     imagecache: Pin<&mut ImageCache>,
        //     filename: &str,
        //     creator: *const ImageInputCreator,
        //     config: *const ImageSpec,
        //     replace: bool,
        // ) -> bool;

        pub unsafe fn imagecache_add_tile_from_coordinates(
            imagecache: Pin<&mut ImageCache>,
            filename: &str,
            subimage: i32,
            miplevel: i32,
            x: i32,
            y: i32,
            z: i32,
            chbegin: i32,
            chend: i32,
            format: TypeDesc,
            buffer: *const u8,
            xstride: i64,
            ystride: i64,
            zstride: i64,
            copy: bool,
        ) -> bool;

        pub fn imagecache_has_error(imagecache: Pin<&mut ImageCache>) -> bool;

        pub fn imagecache_geterror(imagecache: Pin<&mut ImageCache>, clear: bool) -> String;

        pub fn imagecache_getstats(imagecache: Pin<&mut ImageCache>, level: i32) -> String;

        pub fn imagecache_reset_stats(imagecache: Pin<&mut ImageCache>);
    }
}