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
use crate::errors::FramerateParseError;
use crate::framerate_parse::FramerateSource;
use num::ToPrimitive;
use std::fmt;
use std::fmt::Formatter;

#[allow(unused)] // for docs links
use num::Rational64;

/// The type of NTSC standard a [Framerate] adheres to.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum Ntsc {
    /// This [Framerate] is not NTSC.
    None,
    /// This [Framerate] is non-drop NTSC (no frame numbers are dropped to sync timecode with
    /// real-world time - results in Timecode that drifts from true time).
    NonDropFrame,
    /// This [Framerate] is drop-frame NTSC (frames numbers are dropped periodically to keep
    /// timecode in sync with real-world time).
    DropFrame,
}

impl Ntsc {
    /// Returns whether this is any NTSC format (drop or non-drop).
    ///
    /// # Examples
    ///
    /// ```rust
    /// use vtc::Ntsc;
    /// assert!(!vtc::Ntsc::None.is_ntsc());
    /// assert!(vtc::Ntsc::NonDropFrame.is_ntsc());
    /// assert!(vtc::Ntsc::DropFrame.is_ntsc());
    /// ```
    pub fn is_ntsc(self) -> bool {
        self != Self::None
    }
}

impl fmt::Display for Ntsc {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        let ntsc_str = match self {
            Ntsc::None => "",
            Ntsc::NonDropFrame => "NTSC NDF",
            Ntsc::DropFrame => "NTSC DF",
        };
        write!(f, "{}", ntsc_str)
    }
}

/// The [Result] type returned by [Framerate::with_playback] and [Framerate::with_timebase].
pub type FramerateParseResult = Result<Framerate, FramerateParseError>;

/// The rate at which a video file frames are played back.
///
/// Framerate is measured in frames-per-second (24/1 = 24 frames-per-second).
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct Framerate {
    value: num::Rational64,
    ntsc: Ntsc,
}

impl Framerate {
    /// The rational representation of the real-world playback speed as a fraction in
    /// frames-per-second.
    ///
    /// # Examples
    ///
    /// ```rust
    /// use vtc::{Framerate, Ntsc};
    /// use num::Rational64;
    /// let rate = Framerate::with_timebase("24/1", Ntsc::NonDropFrame).unwrap();
    /// assert_eq!(Rational64::new(24000, 1001), rate.playback())
    /// ```
    pub fn playback(&self) -> num::Rational64 {
        self.value
    }

    /// The rational representation of the timecode timebase speed as a fraction in
    /// frames-per-second.
    ///
    ///
    /// # Examples
    ///
    /// ```rust
    /// use vtc::{Framerate, Ntsc};
    /// use num::Rational64;
    /// let rate = Framerate::with_playback("24000/1001", Ntsc::NonDropFrame).unwrap();
    /// assert_eq!(Rational64::new(24, 1), rate.timebase())
    /// ```
    pub fn timebase(&self) -> num::Rational64 {
        // If this is an NTSC timebase, we need to round it to the nearest whole number.
        if self.ntsc.is_ntsc() {
            return self.value.round();
        }
        self.value
    }

    /// Whether this is an NTSC-style time base (aka 23.98, 24000/1001, etc). Returns an enum
    /// detailing if it is not NTSC or what type of NTSC flavor it is.
    ///
    ///
    /// # Examples
    ///
    /// ```rust
    /// use vtc::{Framerate, Ntsc};
    /// let rate = Framerate::with_playback("24000/1001", Ntsc::NonDropFrame).unwrap();
    /// assert_eq!(Ntsc::NonDropFrame, rate.ntsc())
    /// ```
    pub fn ntsc(&self) -> Ntsc {
        self.ntsc
    }

    /// drop_frames returns the number o frames to skip on non-10th minutes in drop frame timecodes.
    /// This method will return None on non-dop Framerates
    ///
    /// Algorithm adapted from: https://www.davidheidelberger.com/2010/06/10/drop-frame-timecode/
    pub(crate) fn drop_frames(&self) -> Option<i64> {
        if self.ntsc != Ntsc::DropFrame {
            return None;
        }

        let drop_frames = self.timebase().to_integer() as f64 * 0.066666;
        Some(drop_frames.round() as i64)
    }

    /**
    Creates a new [Framerate] with a given real-world media playback value measured in
    frames-per-second.

    # Arguments

    * `rate` - A value that represents playback frames-per-second.

    * `ntsc` - The ntsc standard this value should be parsed as.

    # Examples

    We can generate any NTSC framerates from [f32] or [f64] values easily.

    ```rust
    use vtc::{Framerate, FramerateSource, Ntsc};
    use num::Rational64;
    let rate = Framerate::with_playback(23.98, Ntsc::NonDropFrame).unwrap();
    assert_eq!(Rational64::new(24000, 1001), rate.playback());
    assert_eq!(Rational64::new(24, 1), rate.timebase());
    assert_eq!(Ntsc::NonDropFrame, rate.ntsc());
    ```

    Floats are automatically rounded to the nearest valid NTSC playback speed:

    ```rust
    # use vtc::{Framerate, FramerateSource, Ntsc};
    # use num::Rational64;
    let rate = Framerate::with_playback(23.5, Ntsc::NonDropFrame).unwrap();
    assert_eq!(Rational64::new(24000, 1001), rate.playback());
    assert_eq!(Rational64::new(24, 1), rate.timebase());
    assert_eq!(Ntsc::NonDropFrame, rate.ntsc());
    ```

    [&str] and [String] can be parsed if they are a float or rational format:

    ```rust
    # use vtc::{Framerate, FramerateSource, Ntsc};
    # use num::Rational64;
    let rate = Framerate::with_playback("23.98", Ntsc::NonDropFrame).unwrap();
    assert_eq!(Rational64::new(24000, 1001), rate.playback());
    assert_eq!(Rational64::new(24, 1), rate.timebase());
    assert_eq!(Ntsc::NonDropFrame, rate.ntsc());
    ```

    ```rust
    # use vtc::{Framerate, FramerateSource, Ntsc};
    # use num::Rational64;
    let rate = Framerate::with_playback("24000/1001", Ntsc::NonDropFrame).unwrap();
    assert_eq!(Rational64::new(24000, 1001), rate.playback());
    assert_eq!(Rational64::new(24, 1), rate.timebase());
    assert_eq!(Ntsc::NonDropFrame, rate.ntsc());
    ```

    Non-valid NTSC playback rates will result in an error if we are parsing NTSC drop or
    non-drop values:

    ```rust
    # use vtc::{Framerate, FramerateSource, Ntsc, FramerateParseError};
    let err = Framerate::with_playback("24/1", Ntsc::NonDropFrame);
    assert_eq!(FramerateParseError::Ntsc("ntsc framerates must be n/1001".to_string()), err.err().unwrap());
    ```

    This means that integers will always result in an error if ntsc != [Ntsc::None]:

    ```rust
    # use vtc::{Framerate, FramerateSource, Ntsc};
    let err = Framerate::with_playback(24, Ntsc::NonDropFrame);
    assert!(err.is_err());
    ```

    If we switch our NTSC settings to [Ntsc::None], we can parse integers and integer strings,
    as well as other arbirary playback speed values:

    ```rust
    # use vtc::{Framerate, FramerateSource, Ntsc};
    # use num::Rational64;
    let rate = Framerate::with_playback(24, Ntsc::None).unwrap();
    assert_eq!(Rational64::new(24, 1), rate.playback());
    assert_eq!(Rational64::new(24, 1), rate.timebase());
    assert_eq!(Ntsc::None, rate.ntsc());
    ```

    ```rust
    # use vtc::{Framerate, FramerateSource, Ntsc};
    # use num::Rational64;
    let rate = Framerate::with_playback("24", Ntsc::None).unwrap();
    assert_eq!(Rational64::new(24, 1), rate.playback());
    assert_eq!(Rational64::new(24, 1), rate.timebase());
    assert_eq!(Ntsc::None, rate.ntsc());
    ```

    ```rust
    # use vtc::{Framerate, FramerateSource, Ntsc};
    # use num::Rational64;
    let rate = Framerate::with_playback("3/1", Ntsc::None).unwrap();
    assert_eq!(Rational64::new(3, 1), rate.playback());
    assert_eq!(Rational64::new(3, 1), rate.timebase());
    assert_eq!(Ntsc::None, rate.ntsc());
    ```

    If we try to parse a non-drop-frame NTSC value with the wrong timbebase we will get an error:

    ```rust
    # use vtc::{Framerate, FramerateSource, Ntsc, FramerateParseError};
    let err = Framerate::with_playback(23.98, Ntsc::DropFrame);
    assert_eq!(FramerateParseError::DropFrame("dropframe must have playback divisible by 30000/1001 (multiple of 29.97)".to_string()), err.err().unwrap());
    ```

    For more information on why drop-frame timebases must be a multiple of 30000/1001, see
    [this blogpost](https://www.davidheidelberger.com/2010/06/10/drop-frame-timecode/).

    # note

    Using a float with [Ntsc::None] will result in an error. Floats are not precise, and without
    the ntsc flag, vtc cannot know exactly what framerate you want. A [Rational64] value must
    be used.
    */
    pub fn with_playback<T: FramerateSource>(rate: T, ntsc: Ntsc) -> FramerateParseResult {
        let rational = rate.to_playback(ntsc, false)?;
        let rate = Framerate {
            value: rational,
            ntsc,
        };
        Ok(rate)
    }

    /**
    Creates a new [Framerate] with a given timecode timebase playback value measured in
    frames-per-second. For NTSC framerates, the timebase will differ from the playback.

    # Arguments

    * `base` - A value that represents timebase frames-per-second.

    * `ntsc` - The ntsc standard this value should be parsed as.

    # Examples

    We can generate any NTSC framerates from any non 128-bit integer type easily:

    ```rust
    use vtc::{Framerate, FramerateSource, Ntsc};
    use num::Rational64;
    let rate = Framerate::with_timebase(24, Ntsc::NonDropFrame).unwrap();
    assert_eq!(Rational64::new(24000, 1001), rate.playback());
    assert_eq!(Rational64::new(24, 1), rate.timebase());
    assert_eq!(Ntsc::NonDropFrame, rate.ntsc());
    ```

    Floats are automatically rounded to the nearest valid NTSC timebase speed:

    ```rust
    # use vtc::{Framerate, FramerateSource, Ntsc};
    # use num::Rational64;
    let rate = Framerate::with_timebase(24.0, Ntsc::NonDropFrame).unwrap();
    assert_eq!(Rational64::new(24000, 1001), rate.playback());
    assert_eq!(Rational64::new(24, 1), rate.timebase());
    assert_eq!(Ntsc::NonDropFrame, rate.ntsc());
    ```

    [&str] and [String] can be parsed if they are an int, float or rational format:

    ```rust
    # use vtc::{Framerate, FramerateSource, Ntsc};
    # use num::Rational64;
    let rate = Framerate::with_timebase("24", Ntsc::NonDropFrame).unwrap();
    assert_eq!(Rational64::new(24000, 1001), rate.playback());
    assert_eq!(Rational64::new(24, 1), rate.timebase());
    assert_eq!(Ntsc::NonDropFrame, rate.ntsc());
    ```

    ```rust
    # use vtc::{Framerate, FramerateSource, Ntsc};
    # use num::Rational64;
    let rate = Framerate::with_timebase("24.0", Ntsc::NonDropFrame).unwrap();
    assert_eq!(Rational64::new(24000, 1001), rate.playback());
    assert_eq!(Rational64::new(24, 1), rate.timebase());
    assert_eq!(Ntsc::NonDropFrame, rate.ntsc());
    ```

    ```rust
    # use vtc::{Framerate, FramerateSource, Ntsc};
    # use num::Rational64;
    let rate = Framerate::with_timebase("24/1", Ntsc::NonDropFrame).unwrap();
    assert_eq!(Rational64::new(24000, 1001), rate.playback());
    assert_eq!(Rational64::new(24, 1), rate.timebase());
    assert_eq!(Ntsc::NonDropFrame, rate.ntsc());
    ```

    Non-valid NTSC timebase will result in an error if we are parsing NTSC drop or non-drop
    values:

    ```rust
    # use vtc::{Framerate, FramerateSource, Ntsc, FramerateParseError};
    let err = Framerate::with_timebase("24000/1001", Ntsc::NonDropFrame);
    assert_eq!(
        FramerateParseError::Ntsc("ntsc timebases must be whole numbers".to_string()),
        err.err().unwrap(),
    );
    ```

    If we switch our NTSC settings, we can parse arbirary Framerate values:

    ```rust
    # use vtc::{Framerate, FramerateSource, Ntsc};
    # use num::Rational64;
    let rate = Framerate::with_timebase("3/1", Ntsc::None).unwrap();
    assert_eq!(Rational64::new(3, 1), rate.playback());
    assert_eq!(Rational64::new(3, 1), rate.timebase());
    assert_eq!(Ntsc::None, rate.ntsc());
    ```

    If we try to parse a drop-frame value with the wrong timbebase we will get an error:

    ```rust
    # use vtc::{Framerate, FramerateSource, Ntsc, FramerateParseError};
    let err = Framerate::with_timebase("24", Ntsc::DropFrame);
    assert_eq!(
        FramerateParseError::DropFrame("dropframe must have timebase divisible by 30 (multiple of 29.97)".to_string()),
        err.err().unwrap(),
    );
    ```

    For more information on why drop-frame timebases must be a multiple of 30, see
    [this blogpost](https://www.davidheidelberger.com/2010/06/10/drop-frame-timecode/).
    */
    pub fn with_timebase<T: FramerateSource>(base: T, ntsc: Ntsc) -> FramerateParseResult {
        let rational = base.to_playback(ntsc, true)?;
        let rate = Framerate {
            value: rational,
            ntsc,
        };
        Ok(rate)
    }
}

impl fmt::Display for Framerate {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        let value_str = format!("{:.2}", self.value.to_f64().unwrap());
        let mut value_str = value_str.trim_end_matches('0');
        value_str = value_str.trim_end_matches('.');

        write!(f, "[{}", value_str)?;
        if self.ntsc.is_ntsc() {
            write!(f, " ")?;
        }
        write!(f, "{}]", self.ntsc)
    }
}

/**
A collection of common framerates seen in the wild as constants.

# Examples

```rust
use vtc::{rates, Framerate, Ntsc};
assert_eq!(rates::F23_98, Framerate::with_playback(23.98, Ntsc::NonDropFrame).unwrap());
assert_eq!(rates::F24, Framerate::with_playback(24, Ntsc::None).unwrap());
assert_eq!(rates::F29_97_NDF, Framerate::with_playback(29.97, Ntsc::NonDropFrame).unwrap());
assert_eq!(rates::F29_97_DF, Framerate::with_playback(29.97, Ntsc::DropFrame).unwrap());
```
*/
pub mod rates {
    use crate::Framerate;
    use crate::Ntsc;

    /// 23.98 NTSC Non-drop-frame.
    pub const F23_98: Framerate = Framerate {
        value: num::Rational64::new_raw(24000, 1001),
        ntsc: Ntsc::NonDropFrame,
    };

    /// 24 fps.
    pub const F24: Framerate = Framerate {
        value: num::Rational64::new_raw(24, 1),
        ntsc: Ntsc::None,
    };

    /// 29.97 NTSC Non-drop-frame.
    pub const F29_97_NDF: Framerate = Framerate {
        value: num::Rational64::new_raw(30000, 1001),
        ntsc: Ntsc::NonDropFrame,
    };

    /// 29.97 NTSC Drop-frame.
    pub const F29_97_DF: Framerate = Framerate {
        value: num::Rational64::new_raw(30000, 1001),
        ntsc: Ntsc::DropFrame,
    };

    /// 30 fps.
    pub const F30: Framerate = Framerate {
        value: num::Rational64::new_raw(30, 1),
        ntsc: Ntsc::None,
    };

    /// 47.95 NTSC.
    pub const F47_95: Framerate = Framerate {
        value: num::Rational64::new_raw(48000, 1001),
        ntsc: Ntsc::NonDropFrame,
    };

    /// 48 fps.
    pub const F48: Framerate = Framerate {
        value: num::Rational64::new_raw(48, 1),
        ntsc: Ntsc::None,
    };

    /// 59.94 NTSC Non-drop-frame.
    pub const F59_94_NDF: Framerate = Framerate {
        value: num::Rational64::new_raw(60000, 1001),
        ntsc: Ntsc::NonDropFrame,
    };

    /// 59.94 NTSC Drop-frame.
    pub const F59_94_DF: Framerate = Framerate {
        value: num::Rational64::new_raw(60000, 1001),
        ntsc: Ntsc::DropFrame,
    };

    /// 60 fps.
    pub const F60: Framerate = Framerate {
        value: num::Rational64::new_raw(60, 1),
        ntsc: Ntsc::None,
    };
}