ocio 0.3.0

A pure Rust port of OpenColorIO, the color management framework for visual effects and animation.
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

//! Port of `Config_tests.cpp` test `Config/context_variables_typical_use_cases`.
//!
//! Deviation: processors are returned by value in Rust, so the C++ pointer
//! comparisons (same processor instance returned by the cache) are replaced
//! by comparing the addresses of the shared ops: a processor returned from
//! the cache shares its `Arc` ops with the cached one, while a newly built
//! processor has new ops.

mod config_common;

use config_common::*;
use ocio::*;
use std::sync::Arc;

fn same_instance(a: &Processor, b: &Processor) -> bool {
    a.ops().len() == b.ops().len()
        && !a.ops().is_empty()
        && a.ops()
            .iter()
            .zip(b.ops())
            .all(|(x, y)| std::ptr::addr_eq(Arc::as_ptr(x), Arc::as_ptr(y)))
}

fn cs(cfg: &Config, ctx: Option<&Context>, src: &str, dst: &str) -> Processor {
    match ctx {
        Some(c) => cfg.get_processor_with_context_names(c, src, dst).unwrap(),
        None => cfg.get_processor(src, dst).unwrap(),
    }
}

fn dv(cfg: &Config, ctx: Option<&Context>, view: &str) -> Processor {
    let c = ctx
        .cloned()
        .unwrap_or_else(|| cfg.current_context().clone());
    cfg.get_display_view_processor_with_context(
        &c,
        "cs1",
        "disp1",
        view,
        TransformDirection::Forward,
    )
    .unwrap()
}

fn load(s: &str) -> Config {
    let cfg = Config::create_from_str(s).unwrap().create_editable_copy();
    cfg.validate().unwrap();
    cfg
}

#[test]
fn config_context_variables_typical_use_cases() {
    let _lock = env_lock();
    let dir = data_file("");
    for v in [
        "FILE",
        "ENV",
        "SHOW",
        "SHOT",
        "TRANSFORM_DIR",
        "PATH_1",
        "PATH_2",
        "CCPREFIX",
        "CCNUM",
    ] {
        std::env::remove_var(v);
    }
    let _g = EnvGuard::set(OCIO_DISABLE_CACHE_FALLBACK, None);

    // Case 1 - No context variables used in the config.
    {
        let config = format!(
            "ocio_profile_version: 2\n\nsearch_path: {dir}\n\nroles:\n  default: cs1\n\ndisplays:\n  disp1:\n    - !<View> {{name: view1, colorspace: cs2}}\n    - !<View> {{name: view2, colorspace: cs3}}\n\ncolorspaces:\n  - !<ColorSpace>\n    name: cs1\n\n  - !<ColorSpace>\n    name: cs2\n    from_scene_reference: !<FileTransform> {{src: exposure_contrast_linear.ctf}}\n\n  - !<ColorSpace>\n    name: cs3\n    from_scene_reference: !<MatrixTransform> {{offset: [0.11, 0.12, 0.13, 0]}}\n"
        );
        let cfg = load(&config);
        assert!(same_instance(
            &cs(&cfg, None, "cs1", "cs2"),
            &cs(&cfg, None, "cs1", "cs2")
        ));
        assert!(same_instance(
            &cs(&cfg, None, "cs1", "cs3"),
            &cs(&cfg, None, "cs1", "cs3")
        ));
        assert!(same_instance(
            &dv(&cfg, None, "view1"),
            &dv(&cfg, None, "view1")
        ));
        assert!(same_instance(
            &dv(&cfg, None, "view2"),
            &dv(&cfg, None, "view2")
        ));

        let mut ctx = cfg.current_context().clone();
        for _ in 0..2 {
            let c = Some(&ctx);
            assert!(same_instance(
                &cs(&cfg, c, "cs1", "cs2"),
                &cs(&cfg, c, "cs1", "cs2")
            ));
            assert!(same_instance(
                &cs(&cfg, c, "cs1", "cs3"),
                &cs(&cfg, c, "cs1", "cs3")
            ));
            assert!(same_instance(
                &cs(&cfg, c, "cs1", "cs2"),
                &cs(&cfg, None, "cs1", "cs2")
            ));
            assert!(same_instance(&dv(&cfg, c, "view1"), &dv(&cfg, c, "view1")));
            assert!(same_instance(&dv(&cfg, c, "view2"), &dv(&cfg, c, "view2")));
            assert!(same_instance(
                &dv(&cfg, c, "view1"),
                &dv(&cfg, None, "view1")
            ));
            // Add an unused context variable in the context. The cache is still used.
            ctx.set_string_var("ENV", Some("xxx"));
        }
    }

    // Case 2 - Context variables used anywhere but in the search_path.
    {
        let config = format!(
            "ocio_profile_version: 2\n\nenvironment: {{FILE: exposure_contrast_linear.ctf }}\n\nsearch_path: {dir}\n\nroles:\n  default: cs1\n\ndisplays:\n  disp1:\n    - !<View> {{name: view1, colorspace: cs2}}\n\ncolorspaces:\n  - !<ColorSpace>\n    name: cs1\n\n  - !<ColorSpace>\n    name: cs2\n    from_scene_reference: !<FileTransform> {{src: $FILE}}\n"
        );
        let cfg = load(&config);
        assert!(same_instance(
            &cs(&cfg, None, "cs1", "cs2"),
            &cs(&cfg, None, "cs1", "cs2")
        ));
        assert!(same_instance(
            &dv(&cfg, None, "view1"),
            &dv(&cfg, None, "view1")
        ));

        let mut ctx = cfg.current_context().clone();
        ctx.set_string_var("ENV", Some("xxx"));
        let c = Some(&ctx);
        assert!(same_instance(
            &cs(&cfg, c, "cs1", "cs2"),
            &cs(&cfg, c, "cs1", "cs2")
        ));
        assert!(same_instance(
            &cs(&cfg, c, "cs1", "cs2"),
            &cs(&cfg, None, "cs1", "cs2")
        ));
        assert!(same_instance(&dv(&cfg, c, "view1"), &dv(&cfg, c, "view1")));
        assert!(same_instance(
            &dv(&cfg, c, "view1"),
            &dv(&cfg, None, "view1")
        ));

        // Change the value of the used context variable.
        ctx.set_string_var("FILE", Some("exposure_contrast_log.ctf"));
        let c = Some(&ctx);
        assert!(same_instance(
            &cs(&cfg, c, "cs1", "cs2"),
            &cs(&cfg, c, "cs1", "cs2")
        ));
        assert!(same_instance(
            &cs(&cfg, None, "cs1", "cs2"),
            &cs(&cfg, None, "cs1", "cs2")
        ));
        assert!(!same_instance(
            &cs(&cfg, c, "cs1", "cs2"),
            &cs(&cfg, None, "cs1", "cs2")
        ));
        assert!(same_instance(&dv(&cfg, c, "view1"), &dv(&cfg, c, "view1")));
        assert!(same_instance(
            &dv(&cfg, None, "view1"),
            &dv(&cfg, None, "view1")
        ));
        assert!(!same_instance(
            &dv(&cfg, c, "view1"),
            &dv(&cfg, None, "view1")
        ));
    }

    // Case 3 - Context variables used on the search_path, but that variable is unchanged.
    let case3 = format!(
        "ocio_profile_version: 2\n\nenvironment:\n  SHOW: {dir}\n  SHOT: exposure_contrast_linear.ctf\n\nsearch_path: $SHOW\n\nroles:\n  default: cs1\n\ndisplays:\n  disp1:\n    - !<View> {{name: view1, colorspace: cs2}}\n\ncolorspaces:\n  - !<ColorSpace>\n    name: cs1\n\n  - !<ColorSpace>\n    name: cs2\n    from_scene_reference: !<FileTransform> {{src: exposure_contrast_linear.ctf}}\n\n  - !<ColorSpace>\n    name: cs3\n    from_scene_reference: !<FileTransform> {{src: $SHOT}}\n"
    );
    {
        let cfg = load(&case3);
        let mut ctx = cfg.current_context().clone();
        ctx.set_string_var("SHOT", Some("lut1d_green.ctf"));
        assert!(same_instance(
            &cs(&cfg, None, "cs1", "cs2"),
            &cs(&cfg, Some(&ctx), "cs1", "cs2")
        ));
        assert!(same_instance(
            &cs(&cfg, None, "cs1", "cs2"),
            &cs(&cfg, None, "cs1", "cs3")
        ));
    }
    {
        let _fb = EnvGuard::set(OCIO_DISABLE_CACHE_FALLBACK, Some("1"));
        let cfg = load(&case3);
        assert!(!same_instance(
            &cs(&cfg, None, "cs1", "cs2"),
            &cs(&cfg, None, "cs1", "cs3")
        ));
        let mut ctx = cfg.current_context().clone();
        ctx.set_string_var("SHOT", Some("lut1d_green.ctf"));
        assert!(same_instance(
            &cs(&cfg, None, "cs1", "cs2"),
            &cs(&cfg, Some(&ctx), "cs1", "cs2")
        ));
    }

    // Case 4 - Context vars used in the search_path and they are changing per shot, but no
    // FileTransforms are used.
    let case4 = format!(
        "ocio_profile_version: 2\n\nenvironment:\n  SHOW: {dir}\n\nsearch_path: $SHOW\n\nroles:\n  default: cs1\n\ndisplays:\n  disp1:\n    - !<View> {{name: view1, colorspace: cs2}}\n\ncolorspaces:\n  - !<ColorSpace>\n    name: cs1\n\n  - !<ColorSpace>\n    name: cs2\n    from_scene_reference: !<MatrixTransform> {{offset: [0.11, 0.12, 0.13, 0]}}\n"
    );
    for disable in [false, true] {
        let _fb = EnvGuard::set(
            OCIO_DISABLE_CACHE_FALLBACK,
            if disable { Some("1") } else { None },
        );
        let cfg = load(&case4);
        let mut ctx = cfg.current_context().clone();
        ctx.set_string_var("SHOW", Some("/some/arbitrary/path"));
        assert_ne!(cfg.current_context().cache_id(), ctx.cache_id());
        assert!(same_instance(
            &cs(&cfg, None, "cs1", "cs2"),
            &cs(&cfg, Some(&ctx), "cs1", "cs2")
        ));
    }

    // Case 5 - Context vars in the search_path and they are changing but the changed vars are
    // not used to resolve the file transform.
    let case5 = format!(
        "ocio_profile_version: 2\n\nenvironment:\n  TRANSFORM_DIR: {dir}\n\nsearch_path:\n  - /bogus/unknown/path\n  - $TRANSFORM_DIR\n  - $SHOT\n\nroles:\n  default: cs1\n\ndisplays:\n  disp1:\n    - !<View> {{name: view1, colorspace: cs2}}\n\ncolorspaces:\n  - !<ColorSpace>\n    name: cs1\n\n  - !<ColorSpace>\n    name: cs2\n    from_scene_reference: !<FileTransform> {{src: exposure_contrast_linear.ctf}}\n"
    );
    {
        let cfg = load(&case5);
        let mut ctx1 = cfg.current_context().clone();
        ctx1.set_string_var("SHOT", Some("/unknow/path/for_path_1"));
        let mut ctx2 = cfg.current_context().clone();
        ctx2.set_string_var("SHOT", Some("/unknow/path/for_path_2"));
        assert!(same_instance(
            &cs(&cfg, Some(&ctx1), "cs1", "cs2"),
            &cs(&cfg, Some(&ctx2), "cs1", "cs2")
        ));
        {
            let _fb = EnvGuard::set(OCIO_DISABLE_CACHE_FALLBACK, Some("1"));
            let cfg = load(&case5);
            assert!(!same_instance(
                &cs(&cfg, Some(&ctx1), "cs1", "cs2"),
                &cs(&cfg, Some(&ctx2), "cs1", "cs2")
            ));
        }
    }

    // Case 6 - Context vars in the search_path, the vars on the path to the file do change, but
    // the resulting file is the same.
    let case6 = format!(
        "ocio_profile_version: 2\n\nenvironment:\n  PATH_1: {dir}\n  PATH_2: {dir}\n\nsearch_path:\n  - $PATH_1\n  - $PATH_2\n\nroles:\n  default: cs1\n\ndisplays:\n  disp1:\n    - !<View> {{name: view1, colorspace: cs2}}\n\ncolorspaces:\n  - !<ColorSpace>\n    name: cs1\n\n  - !<ColorSpace>\n    name: cs2\n    from_scene_reference: !<FileTransform> {{src: exposure_contrast_linear.ctf}}\n"
    );
    {
        let cfg = load(&case6);
        let mut ctx1 = cfg.current_context().clone();
        ctx1.set_string_var("PATH_1", Some("/unknow/path/for_path_1"));
        let mut ctx2 = cfg.current_context().clone();
        ctx2.set_string_var("PATH_2", Some("/unknow/path/for_path_2"));
        assert_ne!(ctx1.cache_id(), ctx2.cache_id());
        assert!(same_instance(
            &cs(&cfg, Some(&ctx1), "cs1", "cs2"),
            &cs(&cfg, Some(&ctx2), "cs1", "cs2")
        ));
        {
            let _fb = EnvGuard::set(OCIO_DISABLE_CACHE_FALLBACK, Some("1"));
            let cfg = load(&case6);
            assert!(!same_instance(
                &cs(&cfg, Some(&ctx1), "cs1", "cs2"),
                &cs(&cfg, Some(&ctx2), "cs1", "cs2")
            ));
        }
    }

    // Case 7 - Context variables in the FileTransform's CCCID.
    {
        let config = format!(
            "ocio_profile_version: 2\n\nenvironment:\n  CCPREFIX: cc\n\nsearch_path: {dir}\n\nroles:\n  default: cs1\n\ndisplays:\n  disp1:\n    - !<View> {{name: view1, colorspace: cs2}}\n\ncolorspaces:\n  - !<ColorSpace>\n    name: cs1\n\n  - !<ColorSpace>\n    name: cs2\n    from_scene_reference: !<FileTransform> {{src: cdl_test1.ccc, cccid: $CCPREFIX00$CCNUM}}\n"
        );
        let cfg = load(&config);
        let t = cfg
            .get_color_space("cs2")
            .unwrap()
            .transform(ColorSpaceDirection::FromReference)
            .unwrap()
            .clone();
        let mut ctx = cfg.current_context().clone();
        let mut procs = Vec::new();
        for n in ["01", "02", "03"] {
            ctx.set_string_var("CCNUM", Some(n));
            procs.push(
                cfg.get_processor_with_context(&ctx, &t, TransformDirection::Forward)
                    .unwrap(),
            );
        }
        assert!(!same_instance(&procs[0], &procs[1]));
        assert!(!same_instance(&procs[0], &procs[2]));
        assert!(!same_instance(&procs[1], &procs[2]));
    }
}