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

//! Dynamic properties: values of a processor that can be changed after the
//! processor is created (exposure, contrast, gamma, grading values).
//!
//! A dynamic property is a shared handle (`Arc<RwLock<..>>`). The op holding it
//! reads the current value on each `apply`; the client mutates it through the
//! handle returned by `Processor::get_dynamic_property`.

use crate::transforms::grading::{GradingHueCurve, GradingPrimary, GradingRgbCurve, GradingTone};
use crate::types::DynamicPropertyType;
use std::sync::{Arc, RwLock};

/// A shared, mutable value.
#[derive(Debug, Default)]
pub struct SharedValue<T>(Arc<RwLock<T>>);

impl<T> Clone for SharedValue<T> {
    fn clone(&self) -> Self {
        SharedValue(self.0.clone())
    }
}

impl<T: Clone> SharedValue<T> {
    /// A new handle owning `v`.
    pub fn new(v: T) -> Self {
        SharedValue(Arc::new(RwLock::new(v)))
    }
    /// A copy of the current value.
    pub fn get(&self) -> T {
        self.0.read().unwrap().clone()
    }
    /// Replace the value (visible through every clone of the handle).
    pub fn set(&self, v: T) {
        *self.0.write().unwrap() = v;
    }
    /// True if both handles point to the same storage.
    pub fn ptr_eq(&self, other: &Self) -> bool {
        Arc::ptr_eq(&self.0, &other.0)
    }
    /// Access the value by reference under a read lock.
    pub fn with<R>(&self, f: impl FnOnce(&T) -> R) -> R {
        f(&self.0.read().unwrap())
    }
}

/// Handle to a dynamic property.
#[derive(Debug, Clone)]
pub enum DynamicProperty {
    /// Exposure (`ExposureContrastTransform`).
    Exposure(SharedValue<f64>),
    /// Contrast (`ExposureContrastTransform`).
    Contrast(SharedValue<f64>),
    /// Gamma (`ExposureContrastTransform`).
    Gamma(SharedValue<f64>),
    /// Grading primary values (`GradingPrimaryTransform`).
    GradingPrimary(SharedValue<GradingPrimary>),
    /// Grading RGB curves (`GradingRGBCurveTransform`).
    GradingRgbCurve(SharedValue<GradingRgbCurve>),
    /// Grading tone values (`GradingToneTransform`).
    GradingTone(SharedValue<GradingTone>),
    /// Grading hue curves (`GradingHueCurveTransform`).
    GradingHueCurve(SharedValue<GradingHueCurve>),
}

impl DynamicProperty {
    /// The type of the property.
    pub fn property_type(&self) -> DynamicPropertyType {
        match self {
            DynamicProperty::Exposure(_) => DynamicPropertyType::Exposure,
            DynamicProperty::Contrast(_) => DynamicPropertyType::Contrast,
            DynamicProperty::Gamma(_) => DynamicPropertyType::Gamma,
            DynamicProperty::GradingPrimary(_) => DynamicPropertyType::GradingPrimary,
            DynamicProperty::GradingRgbCurve(_) => DynamicPropertyType::GradingRgbCurve,
            DynamicProperty::GradingTone(_) => DynamicPropertyType::GradingTone,
            DynamicProperty::GradingHueCurve(_) => DynamicPropertyType::GradingHueCurve,
        }
    }

    /// Double value for exposure / contrast / gamma properties.
    pub fn as_double(&self) -> Option<&SharedValue<f64>> {
        match self {
            DynamicProperty::Exposure(v)
            | DynamicProperty::Contrast(v)
            | DynamicProperty::Gamma(v) => Some(v),
            _ => None,
        }
    }
    /// Value of a grading primary property.
    pub fn as_grading_primary(&self) -> Option<&SharedValue<GradingPrimary>> {
        match self {
            DynamicProperty::GradingPrimary(v) => Some(v),
            _ => None,
        }
    }
    /// Value of a grading RGB curve property.
    pub fn as_grading_rgb_curve(&self) -> Option<&SharedValue<GradingRgbCurve>> {
        match self {
            DynamicProperty::GradingRgbCurve(v) => Some(v),
            _ => None,
        }
    }
    /// Value of a grading tone property.
    pub fn as_grading_tone(&self) -> Option<&SharedValue<GradingTone>> {
        match self {
            DynamicProperty::GradingTone(v) => Some(v),
            _ => None,
        }
    }
    /// Value of a grading hue curve property.
    pub fn as_grading_hue_curve(&self) -> Option<&SharedValue<GradingHueCurve>> {
        match self {
            DynamicProperty::GradingHueCurve(v) => Some(v),
            _ => None,
        }
    }
}