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
use num::{FromPrimitive, Rational64, Signed};
use std::str::FromStr;

use crate::errors::FramerateParseError;
use crate::framerate::Ntsc;
use std::convert::TryFrom;
use std::fmt::Debug;

/// The result type of [FramerateSource::to_playback].
pub type FramerateSourceResult = Result<num::Rational64, FramerateParseError>;

/// DROP_DIVISOR_PLAYBACK is the value that a playback rate needs to be cleanly divisible for
/// for it to be a valid NTSC playback rate.
const DROP_DIVISOR_PLAYBACK: num::Rational64 = num::Rational64::new_raw(30000, 1001);
/// DROP_DIVISOR_TIMEBASE is the value that a timebase rate needs to be cleanly divisible for
/// for it to be a valid NTSC playback rate.
const DROP_DIVISOR_TIMEBASE: num::Rational64 = num::Rational64::new_raw(30, 1);

/// validate_dropframe_ntsc validates that our ntsc and drop-frame settings are correct.
fn validate_ntsc_value(
    value: &num::Rational64,
    ntsc: Ntsc,
    is_base: bool,
) -> Result<(), FramerateParseError> {
    // If this value is negative, error out. We cannot have negative playback rates.
    if value.is_negative() {
        return Err(FramerateParseError::Negative(
            "framerates cannot be negative".to_string(),
        ));
    }

    // If this is not an NTSC value, return immediately.
    if !ntsc.is_ntsc() {
        return Ok(());
    }

    if is_base {
        // If this is a timebase, it needs to be a whole-number, or it is not NTSC compliant.
        if !value.is_integer() {
            return Err(FramerateParseError::Ntsc(
                "ntsc timebases must be whole numbers".to_string(),
            ));
        }
        // Otherwise if it is a playback speed, it must be divisible by 1001, or it is not compliant.
    } else if value.denom() != &1001 {
        return Err(FramerateParseError::Ntsc(
            "ntsc framerates must be n/1001".to_string(),
        ));
    }

    // If this is not a drop_frame value, we are done.
    if ntsc != Ntsc::DropFrame {
        return Ok(());
    }

    // Pick our allowed divisor based on whether this is a playback speed or timebase
    let drop_divisor = match is_base {
        true => DROP_DIVISOR_TIMEBASE,
        false => DROP_DIVISOR_PLAYBACK,
    };

    // Check that the divisor goes cleanly into the rate.
    if value % drop_divisor != num::Rational64::from_integer(0) {
        // If not get a description of the rate type for the error message.
        let rate_type = match is_base {
            true => "timebase",
            false => "playback",
        };
        let err_message = format!(
            "dropframe must have {0} divisible by {1} (multiple of 29.97)",
            rate_type, drop_divisor,
        );
        return Err(FramerateParseError::DropFrame(err_message));
    }

    // If we get to here, everything is a-ok!
    Ok(())
}

/// Implemented by any type that can be parsed into a rational playback frames-per-second value for
/// a given an NTSC standard and whether the value represents a playback speed or a timecode
/// timebase.
///
/// In most cases types that implement this trait can convert to a [num::Rational64] value, then
/// call [num::Rational64::to_playback] to complete the conversion.
pub trait FramerateSource: Debug {
    /// to_playback converts the implementing value to a Rational64 which represents the playback
    /// frames-per-second, then
    fn to_playback(&self, ntsc: Ntsc, is_timebase: bool) -> FramerateSourceResult;
}

impl<T> FramerateSource for &T
where
    T: FramerateSource,
{
    fn to_playback(&self, ntsc: Ntsc, is_timebase: bool) -> FramerateSourceResult {
        (*self).to_playback(ntsc, is_timebase)
    }
}

impl FramerateSource for &dyn FramerateSource {
    fn to_playback(&self, ntsc: Ntsc, is_timebase: bool) -> FramerateSourceResult {
        (*self).to_playback(ntsc, is_timebase)
    }
}

impl FramerateSource for Rational64 {
    fn to_playback(&self, ntsc: Ntsc, is_timebase: bool) -> FramerateSourceResult {
        validate_ntsc_value(&self, ntsc, is_timebase)?;

        let value = if is_timebase && ntsc.is_ntsc() {
            self.round() * 1000 / 1001
        } else {
            *self
        };

        Ok(value)
    }
}

impl FramerateSource for num::Rational32 {
    fn to_playback(&self, ntsc: Ntsc, is_timebase: bool) -> FramerateSourceResult {
        let numerator: i32 = *self.numer();
        let denominator: i32 = *self.denom();

        let rat64 = num::Rational64::new(numerator.into(), denominator.into());
        rat64.to_playback(ntsc, is_timebase)
    }
}

impl FramerateSource for i64 {
    fn to_playback(&self, ntsc: Ntsc, is_timebase: bool) -> FramerateSourceResult {
        let rational = num::Rational64::from_integer(*self);
        rational.to_playback(ntsc, is_timebase)
    }
}

impl FramerateSource for u64 {
    fn to_playback(&self, ntsc: Ntsc, is_timebase: bool) -> FramerateSourceResult {
        let i64_val = match i64::try_from(*self) {
            Ok(converted) => converted,
            Err(err) => {
                return Err(FramerateParseError::Conversion(format!(
                    "error converting u64 to i64 : {}",
                    err.to_string()
                )))
            }
        };

        i64_val.to_playback(ntsc, is_timebase)
    }
}

impl FramerateSource for i32 {
    fn to_playback(&self, ntsc: Ntsc, is_timebase: bool) -> FramerateSourceResult {
        i64::from(*self).to_playback(ntsc, is_timebase)
    }
}

impl FramerateSource for u32 {
    fn to_playback(&self, ntsc: Ntsc, is_timebase: bool) -> FramerateSourceResult {
        i64::from(*self).to_playback(ntsc, is_timebase)
    }
}

impl FramerateSource for i16 {
    fn to_playback(&self, ntsc: Ntsc, is_timebase: bool) -> FramerateSourceResult {
        i64::from(*self).to_playback(ntsc, is_timebase)
    }
}

impl FramerateSource for u16 {
    fn to_playback(&self, ntsc: Ntsc, is_timebase: bool) -> FramerateSourceResult {
        i64::from(*self).to_playback(ntsc, is_timebase)
    }
}

impl FramerateSource for i8 {
    fn to_playback(&self, ntsc: Ntsc, is_timebase: bool) -> FramerateSourceResult {
        i64::from(*self).to_playback(ntsc, is_timebase)
    }
}

impl FramerateSource for u8 {
    fn to_playback(&self, ntsc: Ntsc, is_timebase: bool) -> FramerateSourceResult {
        i64::from(*self).to_playback(ntsc, is_timebase)
    }
}

impl FramerateSource for f64 {
    fn to_playback(&self, ntsc: Ntsc, is_timebase: bool) -> FramerateSourceResult {
        if !ntsc.is_ntsc() {
            return Err(FramerateParseError::Imprecise(
                "float values cannot be parsed for non-NTSC Framerates due to imprecision"
                    .to_string(),
            ));
        }
        let mut rational = match num::Rational64::from_f64(*self) {
            None => {
                return Err(FramerateParseError::Conversion(
                    "could not parse rational from f64".to_string(),
                ))
            }
            Some(rational) => rational,
        };

        // If this is an NTSC playback speed, coerce it to the nearest correct ntsc value.
        if !is_timebase && ntsc.is_ntsc() {
            rational = rational.round() * 1000 / 1001;
        }
        rational.to_playback(ntsc, is_timebase)
    }
}

impl FramerateSource for f32 {
    fn to_playback(&self, ntsc: Ntsc, is_timebase: bool) -> FramerateSourceResult {
        f64::from(*self).to_playback(ntsc, is_timebase)
    }
}

impl FramerateSource for &str {
    fn to_playback(&self, ntsc: Ntsc, is_timebase: bool) -> FramerateSourceResult {
        if let Ok(parsed) = num::Rational64::from_str(self) {
            return parsed.to_playback(ntsc, is_timebase);
        }

        if let Ok(parsed) = i64::from_str(self) {
            return parsed.to_playback(ntsc, is_timebase);
        }

        if let Ok(parsed) = f64::from_str(self) {
            return parsed.to_playback(ntsc, is_timebase);
        }

        Err(FramerateParseError::Conversion(format!(
            "could not parse '{0}' as rational, int, or float for framerate",
            self
        )))
    }
}

impl FramerateSource for String {
    fn to_playback(&self, ntsc: Ntsc, is_timebase: bool) -> FramerateSourceResult {
        let str: &str = self.as_str();
        str.to_playback(ntsc, is_timebase)
    }
}