1use crate::transform::ConstTransform;
2use crate::{
3 Config, Look, NamedTransform, Result, TransformDirection, ViewTransform, ViewTransformDirection,
4};
5use std::ffi::{c_void, CStr};
6use std::ptr::NonNull;
7
8pub(crate) fn serialize_named_item(
9 handle: NonNull<c_void>,
10 kind: i32,
11 is_const: bool,
12) -> Result<String> {
13 crate::clear_last_error();
14 let text = unsafe {
15 crate::cstr_to_opt_string(ocio_sys::ocio_named_item_serialize_text(
16 handle.as_ptr(),
17 kind,
18 is_const,
19 ))
20 };
21 crate::ocio_call_status()?;
22 text.ok_or_else(|| {
23 crate::OcioError::Ocio("OCIO returned a null named item representation".into())
24 })
25}
26
27struct Item {
28 handle: NonNull<c_void>,
29 kind: i32,
30}
31impl Item {
32 fn text(&self, field: i32, index: usize, argument: Option<&CStr>) -> Result<Option<&CStr>> {
33 crate::clear_last_error();
34 let ptr = unsafe {
35 ocio_sys::ocio_const_named_item_text(
36 self.handle.as_ptr(),
37 self.kind,
38 field,
39 index,
40 argument.map_or(std::ptr::null(), CStr::as_ptr),
41 )
42 };
43 crate::ocio_call_status()?;
44 Ok(if ptr.is_null() {
45 None
46 } else {
47 Some(unsafe { CStr::from_ptr(ptr) })
48 })
49 }
50 fn number(&self, field: i32) -> Result<usize> {
51 crate::clear_last_error();
52 let value = unsafe {
53 ocio_sys::ocio_const_named_item_number(self.handle.as_ptr(), self.kind, field)
54 };
55 crate::ocio_call_status()?;
56 Ok(value)
57 }
58 fn contains(&self, field: i32, value: &CStr) -> Result<bool> {
59 crate::clear_last_error();
60 let found = unsafe {
61 ocio_sys::ocio_const_named_item_contains(
62 self.handle.as_ptr(),
63 self.kind,
64 field,
65 value.as_ptr(),
66 )
67 };
68 crate::ocio_call_status()?;
69 Ok(found)
70 }
71 fn name(&self) -> Result<Option<String>> {
72 crate::clear_last_error();
73 let ptr = unsafe { ocio_sys::ocio_const_named_item_name(self.handle.as_ptr(), self.kind) };
74 let name = unsafe { crate::cstr_to_opt_string(ptr) };
75 crate::ocio_call_status()?;
76 Ok(name)
77 }
78 fn copy(&self) -> Result<NonNull<c_void>> {
79 crate::clear_last_error();
80 let handle = unsafe {
81 ocio_sys::ocio_const_named_item_editable_copy(self.handle.as_ptr(), self.kind)
82 };
83 crate::handle_result(handle)
84 }
85 fn transform(&self, kind: i32, direction: i32) -> Result<Option<ConstTransform>> {
86 ConstTransform::from_parent(self.handle.as_ptr(), kind, direction)
87 }
88}
89impl Drop for Item {
90 fn drop(&mut self) {
91 unsafe { ocio_sys::ocio_const_named_item_destroy(self.handle.as_ptr(), self.kind) }
92 }
93}
94
95pub struct ConstLook(Item);
98pub struct ConstNamedTransform(Item);
101pub struct ConstViewTransform(Item);
104
105macro_rules! accessors {
106 ($ty:ident, $editable:ident) => {
107 impl $ty {
108 pub fn name(&self) -> Result<Option<String>> {
110 self.0.name()
111 }
112 pub fn serialize(&self) -> Result<String> {
115 serialize_named_item(self.0.handle, self.0.kind, true)
116 }
117 pub fn name_ref(&self) -> Result<Option<&CStr>> {
119 self.0.text(0, 0, None)
120 }
121 pub fn description(&self) -> Result<Option<&CStr>> {
123 self.0.text(1, 0, None)
124 }
125 pub fn create_editable_copy(&self) -> Result<$editable> {
128 Ok($editable {
129 handle: self.0.copy()?,
130 })
131 }
132 }
133 };
134}
135accessors!(ConstLook, Look);
136accessors!(ConstNamedTransform, NamedTransform);
137accessors!(ConstViewTransform, ViewTransform);
138
139impl ConstLook {
140 #[cfg(feature = "v2_5")]
142 pub fn try_interchange_attributes(&self) -> Result<std::collections::BTreeMap<String, String>> {
143 crate::colorspace::interchange_attributes_snapshot(self.0.handle.as_ptr(), true, Some(0))
144 }
145 pub fn process_space(&self) -> Result<Option<&CStr>> {
147 self.0.text(2, 0, None)
148 }
149 #[cfg(feature = "v2_5")]
151 pub fn interchange_attribute(&self, name: &CStr) -> Result<Option<&CStr>> {
152 self.0.text(7, 0, Some(name))
153 }
154 pub fn try_const_transform(&self) -> Result<Option<ConstTransform>> {
156 self.0.transform(6, 0)
157 }
158 pub fn try_const_inverse_transform(&self) -> Result<Option<ConstTransform>> {
160 self.0.transform(7, 0)
161 }
162}
163impl ConstNamedTransform {
164 pub fn family(&self) -> Result<Option<&CStr>> {
166 self.0.text(3, 0, None)
167 }
168 pub fn encoding(&self) -> Result<Option<&CStr>> {
170 self.0.text(4, 0, None)
171 }
172 pub fn num_aliases(&self) -> Result<usize> {
174 self.0.number(0)
175 }
176 pub fn alias(&self, index: usize) -> Result<Option<&CStr>> {
178 self.0.text(5, index, None)
179 }
180 pub fn has_alias(&self, value: &CStr) -> Result<bool> {
182 self.0.contains(0, value)
183 }
184 pub fn num_categories(&self) -> Result<usize> {
186 self.0.number(1)
187 }
188 pub fn category(&self, index: usize) -> Result<Option<&CStr>> {
190 self.0.text(6, index, None)
191 }
192 pub fn has_category(&self, value: &CStr) -> Result<bool> {
194 self.0.contains(1, value)
195 }
196 pub fn resolve_const_transform(
199 &self,
200 direction: TransformDirection,
201 ) -> Result<Option<ConstTransform>> {
202 self.0.transform(10, direction as i32)
203 }
204 pub(crate) fn raw(&self) -> *mut c_void {
205 self.0.handle.as_ptr()
206 }
207 pub fn try_const_transform(
209 &self,
210 direction: TransformDirection,
211 ) -> Result<Option<ConstTransform>> {
212 self.0.transform(8, direction as i32)
213 }
214}
215impl ConstViewTransform {
216 #[cfg(feature = "v2_5")]
218 pub fn try_interchange_attributes(&self) -> Result<std::collections::BTreeMap<String, String>> {
219 crate::colorspace::interchange_attributes_snapshot(self.0.handle.as_ptr(), true, Some(2))
220 }
221 pub fn family(&self) -> Result<Option<&CStr>> {
223 self.0.text(3, 0, None)
224 }
225 pub fn num_categories(&self) -> Result<usize> {
227 self.0.number(1)
228 }
229 pub fn category(&self, index: usize) -> Result<Option<&CStr>> {
231 self.0.text(6, index, None)
232 }
233 pub fn has_category(&self, value: &CStr) -> Result<bool> {
235 self.0.contains(1, value)
236 }
237 pub fn reference_space_type(&self) -> Result<crate::ReferenceSpaceType> {
239 match self.0.number(2)? {
240 0 => Ok(crate::ReferenceSpaceType::Scene),
241 1 => Ok(crate::ReferenceSpaceType::Display),
242 _ => Err(crate::OcioError::Ocio(
243 "unknown reference space type".into(),
244 )),
245 }
246 }
247 #[cfg(feature = "v2_5")]
249 pub fn interchange_attribute(&self, name: &CStr) -> Result<Option<&CStr>> {
250 self.0.text(7, 0, Some(name))
251 }
252 pub fn try_const_transform(
254 &self,
255 direction: ViewTransformDirection,
256 ) -> Result<Option<ConstTransform>> {
257 self.0.transform(9, direction as i32)
258 }
259}
260
261fn lookup(config: *mut c_void, name: Option<&CStr>, kind: i32) -> Result<Option<Item>> {
262 crate::clear_last_error();
263 let handle = unsafe {
264 ocio_sys::ocio_config_get_const_named_item(
265 config,
266 name.map_or(std::ptr::null(), CStr::as_ptr),
267 kind,
268 )
269 };
270 crate::ocio_call_status()?;
271 Ok(NonNull::new(handle).map(|handle| Item {
272 handle,
273 kind: if kind == 3 { 2 } else { kind },
274 }))
275}
276
277fn lookup_const(config: *mut c_void, name: Option<&CStr>, kind: i32) -> Result<Option<Item>> {
278 crate::clear_last_error();
279 let handle = unsafe {
280 ocio_sys::ocio_const_config_get_named_item(
281 config,
282 name.map_or(std::ptr::null(), CStr::as_ptr),
283 kind,
284 )
285 };
286 crate::ocio_call_status()?;
287 Ok(NonNull::new(handle).map(|handle| Item {
288 handle,
289 kind: if kind == 3 { 2 } else { kind },
290 }))
291}
292
293impl crate::ConstConfig {
294 pub fn try_const_look(&self, name: &CStr) -> Result<Option<ConstLook>> {
296 Ok(lookup_const(self.handle.as_ptr(), Some(name), 0)?.map(ConstLook))
297 }
298 pub fn try_const_named_transform(&self, name: &CStr) -> Result<Option<ConstNamedTransform>> {
300 Ok(lookup_const(self.handle.as_ptr(), Some(name), 1)?.map(ConstNamedTransform))
301 }
302 pub fn try_const_view_transform(&self, name: &CStr) -> Result<Option<ConstViewTransform>> {
304 Ok(lookup_const(self.handle.as_ptr(), Some(name), 2)?.map(ConstViewTransform))
305 }
306 pub fn try_const_default_scene_to_display_view_transform(
308 &self,
309 ) -> Result<Option<ConstViewTransform>> {
310 Ok(lookup_const(self.handle.as_ptr(), None, 3)?.map(ConstViewTransform))
311 }
312}
313
314impl Config {
315 pub fn try_const_look(&self, name: &CStr) -> Result<Option<ConstLook>> {
317 Ok(lookup(self.handle.as_ptr(), Some(name), 0)?.map(ConstLook))
318 }
319 pub fn try_const_named_transform(&self, name: &CStr) -> Result<Option<ConstNamedTransform>> {
321 Ok(lookup(self.handle.as_ptr(), Some(name), 1)?.map(ConstNamedTransform))
322 }
323 pub fn try_const_view_transform(&self, name: &CStr) -> Result<Option<ConstViewTransform>> {
325 Ok(lookup(self.handle.as_ptr(), Some(name), 2)?.map(ConstViewTransform))
326 }
327 pub fn try_const_default_scene_to_display_view_transform(
329 &self,
330 ) -> Result<Option<ConstViewTransform>> {
331 Ok(lookup(self.handle.as_ptr(), None, 3)?.map(ConstViewTransform))
332 }
333}