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 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950
use num::integer::div_mod_floor; use num::rational::Ratio; use num::{abs, FromPrimitive, Rational64, Signed, ToPrimitive, Zero}; use crate::{ consts::{FRAMES_PER_FOOT, PREMIERE_TICKS_PER_SECOND, SECONDS_PER_HOUR, SECONDS_PER_MINUTE}, source_ppro_ticks::PremiereTicksSource, timecode_parse::round_seconds_to_frame, Framerate, FramesSource, Ntsc, SecondsSource, TimecodeParseError, }; use std::ops::{Add, Div, DivAssign, Mul, MulAssign, Neg, Rem, RemAssign, Sub}; use std::{cmp::Ordering, ops::AddAssign}; use std::{ fmt::{Display, Formatter}, ops::SubAssign, }; /** Holds the individual sections of a timecode for formatting / manipulation. */ #[derive(Clone, Debug, Eq, PartialEq)] pub struct TimecodeSections { /// Whether the timecode is a negative value. pub negative: bool, /// Hours place value. pub hours: i64, /// Minutes place value. pub minutes: i64, /// Seconds place value. pub seconds: i64, /// Frames value. pub frames: i64, } /// The [Result] type returned by [Timecode::with_seconds], [Timecode::with_frames], and /// [Timecode::with_premiere_ticks]. pub type TimecodeParseResult = Result<Timecode, TimecodeParseError>; /** [Timecode] represents the frame at a particular time in a video. New [Timecode] values are created with the [Timecode::with_seconds], [Timecode::with_frames], and [Timecode::with_premiere_ticks] methods. [Timecode] is a [Copy] value. # Examples For timecode attribute examples, see the individual methods of the [Timecode] type, such as [Timecode::timecode]. For examples of how to construct a new timecode, see the examples on the contructor methods like [Timecode::with_frames]. There are a number of opeations we can apply to [Timecode] values. ## Compare Timecodes ```rust use vtc::{Timecode, rates}; let tc1 = Timecode::with_frames("01:00:00:00", rates::F23_98).unwrap(); let tc2 = Timecode::with_frames("01:00:00:00", rates::F23_98).unwrap(); let tc3 = Timecode::with_frames("00:30:00:00", rates::F23_98).unwrap(); let tc4 = Timecode::with_frames("01:30:00:00", rates::F23_98).unwrap(); assert!(tc1 == tc2); assert!(tc1 > tc3); assert!(tc1 < tc4); ``` ## Sort_Timecodes ```rust # use vtc::{Timecode, rates}; let tc1 = Timecode::with_frames("01:00:00:00", rates::F23_98).unwrap(); let tc2 = Timecode::with_frames("01:30:00:00", rates::F23_98).unwrap(); let tc3 = Timecode::with_frames("00:30:00:00", rates::F23_98).unwrap(); let mut timecodes = vec![tc1, tc2, tc3]; timecodes.sort(); assert_eq!(timecodes[0], tc3); assert_eq!(timecodes[1], tc1); assert_eq!(timecodes[2], tc2); ``` ## Add Timecodes ```rust # use vtc::{Timecode, rates}; let tc1 = Timecode::with_frames("01:00:00:00", rates::F23_98).unwrap(); let tc2 = Timecode::with_frames("00:30:00:00", rates::F23_98).unwrap(); let mut result = tc1 + tc2; assert_eq!("01:30:00:00", result.timecode()); result += tc1; assert_eq!("02:30:00:00", result.timecode()); ``` ## Subtract Timecodes ```rust # use vtc::{Timecode, rates}; let tc1 = Timecode::with_frames("01:00:00:00", rates::F23_98).unwrap(); let tc2 = Timecode::with_frames("00:30:00:00", rates::F23_98).unwrap(); let mut result = tc1 - tc2; assert_eq!("00:30:00:00", result.timecode()); result -= tc1; assert_eq!("-00:30:00:00", result.timecode()); ``` ## Multiply Timecodes ```rust # use vtc::{Timecode, rates}; let tc1 = Timecode::with_frames("01:00:00:00", rates::F23_98).unwrap(); let mut result = tc1 * 1.5; assert_eq!("01:30:00:00", result.timecode()); result *= 2; assert_eq!("03:00:00:00", result.timecode()); ``` ## Divide Timecodes Dividing always acts as if floor devision had been done on the frame count of the [Timecode]. ```rust # use vtc::{Timecode, rates}; let tc1 = Timecode::with_frames("01:00:00:01", rates::F23_98).unwrap(); let result = tc1 / 1.5; assert_eq!("00:40:00:00", result.timecode()); ``` This allows divisions and remainders to give correct, complementary values: ```rust # use vtc::{Timecode, rates}; # let tc1 = Timecode::with_frames("01:00:00:01", rates::F23_98).unwrap(); let result = tc1 % 1.5; assert_eq!("00:00:00:01", result.timecode()); ``` [DivAssign] and [RemAssign] are also implemented for [Timecode]: ```rust # use vtc::{Timecode, rates}; let mut tc = Timecode::with_frames("01:00:00:00", rates::F23_98).unwrap(); tc /= 2; assert_eq!("00:30:00:00", tc.timecode()); tc %= 1.65; assert_eq!("00:00:00:01", tc.timecode()) ``` */ #[derive(Clone, Copy, Debug)] pub struct Timecode { seconds: Rational64, rate: Framerate, } impl Timecode { /// Returns the Framerate of the timecode. /// /// # Examples /// /// ```rust /// # use vtc::{Timecode, rates}; /// let tc = Timecode::with_frames("01:00:00:00", rates::F23_98).unwrap(); /// assert_eq!(rates::F23_98, tc.rate()) /// ``` pub fn rate(&self) -> Framerate { self.rate } /** Returns the rational representation of the real-world seconds that would have elapsed between 00:00:00:00 and this timecode. # What it is The number of real-world seconds that have elapsed between 00:00:00:00 and the timecode value. With NTSC timecode, the timecode drifts from the real-world elapsed time. # Where you see it - Anywhere real-world time needs to be calculated. - In code that needs to do lossless calculations of playback time and not rely on frame count, like adding two timecodes together with different framerates. # Examples ```rust # use vtc::{Timecode, rates}; use num::Rational64; let tc = Timecode::with_seconds(3600.0, rates::F24).unwrap(); assert_eq!(Rational64::new(3600, 1), tc.seconds()) ``` */ pub fn seconds(&self) -> Rational64 { self.seconds } /// The individual sections of a timecode string as i64 values. /// /// # Examples /// /// ```rust /// # use vtc::{Timecode, rates, TimecodeSections}; /// let tc = Timecode::with_frames("01:00:00:00", rates::F23_98).unwrap(); /// let expected = TimecodeSections{ /// negative: false, /// hours: 1, /// minutes: 0, /// seconds: 0, /// frames: 0, /// }; /// assert_eq!(expected, tc.sections()) /// ``` pub fn sections(&self) -> TimecodeSections { // We use the absolute frame count here so floor behaves as expected regardless of whether // this value is negative. let mut frames = Rational64::from(abs(self.frames())); let timebase = self.rate.timebase(); if self.rate.ntsc() == Ntsc::DropFrame { // Convert the frame number to an adjusted one for drop-frame display values. let frames_int = frame_num_to_drop_num(frames.to_integer(), self.rate); frames = Rational64::from_integer(frames_int) } let frames_per_minute = timebase * SECONDS_PER_MINUTE; let frames_per_hour = timebase * SECONDS_PER_HOUR; let hours = (frames / frames_per_hour).floor(); frames %= frames_per_hour; let minutes = (frames / frames_per_minute).floor(); frames %= frames_per_minute; let seconds = (frames / timebase).floor(); frames = (frames % timebase).round(); TimecodeSections { negative: self.seconds.is_negative(), hours: hours.to_integer(), minutes: minutes.to_integer(), seconds: seconds.to_integer(), frames: frames.to_integer(), } } /** Returns the the formatted SMPTE timecode: (ex: 01:00:00:00). # What it is Timecode is used as a human-readable way to represent the id of a given frame. It is formatted to give a rough sense of where to find a frame: {HOURS}:{MINUTES}:{SECONDS}:{FRAME}. For more on timecode, see Frame.io's [excellent post](https://blog.frame.io/2017/07/17/timecode-and-frame-rates/) on the subject. # Where you see it Timecode is ubiquitous in video editing, a small sample of places you might see timecode: - Source and Playback monitors in your favorite NLE. - Burned into the footage for dailies. - Cut lists like an EDL. # Examples ```rust # use vtc::{Timecode, rates}; let tc = Timecode::with_frames("01:00:00:00", rates::F23_98).unwrap(); assert_eq!("01:00:00:00", tc.timecode()) ``` */ pub fn timecode(&self) -> String { let sections = self.sections(); let sign = if self.seconds.is_negative() { "-" } else { "" }; let frame_sep = if self.rate.ntsc() == Ntsc::DropFrame { ";" } else { ":" }; format!( "{}{:02}:{:02}:{:02}{}{:02}", sign, sections.hours, sections.minutes, sections.seconds, frame_sep, sections.frames, ) } /** Returns the number of frames that would have elapsed between 00:00:00:00 and this timecode. # What it is Frame number / frames count is the number of a frame if the timecode started at 00:00:00:00 and had been running until the current value. A timecode of '00:00:00:10' has a frame number of 10. A timecode of '01:00:00:00' has a frame number of 86400. # Where you see it - Frame-sequence files: 'my_vfx_shot.0086400.exr' - FCP7XML cut lists: ```xml <timecode> <rate> <timebase>24</timebase> <ntsc>TRUE</ntsc> </rate> <string>01:00:00:00</string> <frame>86400</frame> <!-- <====THIS LINE--> <displayformat>NDF</displayformat> </timecode> ``` # Examples ```rust # use vtc::{Timecode, rates}; let tc = Timecode::with_frames("01:00:00:00", rates::F23_98).unwrap(); assert_eq!(86400, tc.frames()) ``` */ pub fn frames(&self) -> i64 { let rational_frames = self.seconds * self.rate.playback(); if rational_frames.denom() == &1 { return *rational_frames.numer(); }; rational_frames.round().to_integer() } /** Returns the true, real-world runtime of the timecode in HH:MM:SS.FFFFFFFFF format. # Arguments * `precision` - How many places to print after the decimal. Tailing 0's will be truncated regardless of setting. # What it is The formatted version of seconds. It looks like timecode, but with a decimal seconds value instead of a frame number place. # Where you see it - Anywhere real-world time is used. - FFMPEG commands: ```shell ffmpeg -ss 00:00:30.5 -i input.mov -t 00:00:10.25 output.mp4 ``` # Examples ```rust # use vtc::{Timecode, rates}; let tc = Timecode::with_frames("01:00:00:00", rates::F23_98).unwrap(); assert_eq!("01:00:03.6", tc.runtime(9)) ``` ## note: Runtime and timecode will differ with NTSC framerates. NTSC reports timecode *as-if* it were running at a whole-frame rate (so 23.98 is reported as if it were running at 24.) [Timecode::runtime] reports the true, real-world time elapsed since 00:00:00:00. */ pub fn runtime(&self, precision: usize) -> String { // We use the absolute seconds here so floor behaves as expected regardless of whether // this value is negative. let mut seconds = abs(self.seconds); let hours = (seconds / SECONDS_PER_HOUR).floor().to_integer(); seconds %= SECONDS_PER_HOUR; let minutes = (seconds / SECONDS_PER_MINUTE).floor().to_integer(); seconds %= SECONDS_PER_MINUTE; let fract = seconds.fract(); let seconds_int = seconds.floor().to_integer(); let fract_str = if fract == Rational64::zero() { ".0".to_string() } else { let formatted = format!("{:.1$}", fract.to_f64().unwrap_or(0.0), precision); let mut formatted = formatted.trim_start_matches('0'); formatted = formatted.trim_end_matches('0'); formatted.to_string() }; let sign = if self.seconds.is_negative() { "-" } else { "" }; format!( "{}{:02}:{:02}:{:02}{}", sign, hours, minutes, seconds_int, fract_str, ) } /** Returns the number of elapsed ticks this timecode represents in Adobe Premiere Pro. # What it is Internally, Adobe Premiere Pro uses ticks to divide up a second, and keep track of how far into that second we are. There are 254016000000 ticks in a second, regardless of framerate in Premiere. # Where you see it - Premiere Pro Panel functions and scripts - FCP7XML cutlists generated from Premiere: ```xml <clipitem id="clipitem-1"> ... <in>158</in> <out>1102</out> <pproTicksIn>1673944272000</pproTicksIn> <pproTicksOut>11675231568000</pproTicksOut> ... </clipitem> ``` # Examples ```rust # use vtc::{Timecode, rates}; use num::Rational64; let tc = Timecode::with_seconds(1.0, rates::F24).unwrap(); assert_eq!(254016000000, tc.premiere_ticks()) ``` ```rust # use vtc::{Timecode, rates}; let tc = Timecode::with_frames("01:00:00:00", rates::F23_98).unwrap(); assert_eq!(915372057600000, tc.premiere_ticks()) ``` */ pub fn premiere_ticks(&self) -> i64 { // We need to jump up to a i128-based rat for a second to avoid an overflow // here. let seconds128 = Ratio::<i128>::new(*self.seconds.numer() as i128, *self.seconds.denom() as i128); let seconds_int = (seconds128 * PREMIERE_TICKS_PER_SECOND) .round() .to_integer(); seconds_int as i64 } /** Returns the number of feet and frames this timecode represents if it were shot on 35mm 4-perf film (16 frames per foot). ex: '5400+13'. # What it is On physical film, each foot contains a certain number of frames. For 35mm, 4-perf film (the most common type on Hollywood movies), this number is 16 frames per foot. Feet-And-Frames was often used in place of Keycode to quickly reference a frame in the edit. # Where you see it For the most part, feet + frames has died out as a reference, because digital media is not measured in feet. The most common place it is still used is Studio Sound Departments. Many Sound Mixers and Designers intuitively think in feet + frames, and it is often burned into the reference picture for them. - Telecine. - Sound turnover reference picture. - Sound turnover change lists. # Examples ```rust # use vtc::{Timecode, rates}; let tc = Timecode::with_frames("01:00:00:00", rates::F23_98).unwrap(); assert_eq!("5400+00", tc.feet_and_frames()) ``` */ pub fn feet_and_frames(&self) -> String { let result = div_mod_floor(abs(self.frames()), FRAMES_PER_FOOT); let feet = result.0; let frames = result.1; let sign = if self.seconds.is_negative() { "-" } else { "" }; return format!("{}{}+{:02}", sign, feet, frames); } /// Returns a [Timecode] with the same number of frames running at a different /// [Framerate]. /// /// # Arguments /// /// * `rate` - The new framerate to apply to the frrame count.. /// /// ```rust /// # use vtc::{Timecode, rates}; /// let tc = Timecode::with_frames("01:00:00:00", rates::F24).unwrap(); /// let rebased = tc.rebase(rates::F48); /// assert_eq!("00:30:00:00", rebased.timecode()) /// ``` pub fn rebase(&self, rate: Framerate) -> Self { Timecode::with_i64_frames(self.frames(), rate) } /// Returns the absolute value of the [Timecode] value. /// /// # Examples /// /// ```rust /// # use vtc::{Timecode, rates}; /// use num::Rational64; /// let tc = Timecode::with_frames("-01:00:00:00", rates::F23_98).unwrap(); /// assert_eq!("01:00:00:00", tc.abs().timecode()) /// ``` /// /// ```rust /// # use vtc::{Timecode, rates}; /// let tc = Timecode::with_frames("01:00:00:00", rates::F23_98).unwrap(); /// assert_eq!("01:00:00:00", tc.abs().timecode()) /// ``` pub fn abs(&self) -> Self { Timecode::with_rational_seconds(abs(self.seconds), self.rate) } /// Returns a new [Timecode] with a [Timecode::frames] return value equal to the frames arg. /// /// [Timecode::with_frames] takes many different formats (more than just numeric types) that /// represent the frame count of the timecode. /// /// # Arguments /// /// * `frames` - A value which can be represented as a frame number / frame count. /// /// * `rate` - The Framerate at which the frames are being played back. /// /// # Examples /// /// Create a [Timecode] from a timecode string: /// /// ```rust /// # use vtc::{Timecode, rates}; /// let tc = Timecode::with_frames("01:00:00:00", rates::F23_98).unwrap(); /// assert_eq!("01:00:00:00", tc.timecode()) /// ``` /// /// From am integer frame count: /// /// ```rust /// # use vtc::{Timecode, rates}; /// let tc = Timecode::with_frames(86400, rates::F23_98).unwrap(); /// assert_eq!("01:00:00:00", tc.timecode()) /// ``` /// /// From a feet+frames string: /// /// ```rust /// # use vtc::{Timecode, rates}; /// use num::Rational64; /// let tc = Timecode::with_frames("5400+00", rates::F23_98).unwrap(); /// assert_eq!("01:00:00:00", tc.timecode()) /// ``` pub fn with_frames<T: FramesSource>(frames: T, rate: Framerate) -> TimecodeParseResult { let frame_count = frames.to_frames(rate)?; Ok(Self::with_i64_frames(frame_count, rate)) } /// Returns a new [Timecode] with a [Timecode::seconds] return value equal to the seconds arg /// (rounded to the nearest frame). /// /// [Timecode::with_seconds] takes many different formats (more than just numeric types) that /// represent the frame count of the timecode. /// /// # Arguments /// /// * `seconds` - A value which can be represented as a number of seconds. /// /// * `rate` - The Framerate which seconds will be rounded to match the nearest frame with. /// /// # Examples /// /// From a float value: /// /// ```rust /// # use vtc::{Timecode, rates}; /// let tc = Timecode::with_seconds(3600.0, rates::F24).unwrap(); /// assert_eq!("01:00:00:00", tc.timecode()) /// ``` /// /// From a Rational64 value: /// /// ```rust /// # use vtc::{Timecode, rates}; /// use num::Rational64; /// let tc = Timecode::with_seconds(Rational64::new(3600, 1), rates::F24).unwrap(); /// assert_eq!("01:00:00:00", tc.timecode()) /// ``` /// /// From a Rational64 runtime: /// /// ```rust /// # use vtc::{Timecode, rates}; /// let tc = Timecode::with_seconds("01:00:00.0", rates::F24).unwrap(); /// assert_eq!("01:00:00:00", tc.timecode()) /// ``` /// /// ## Note: /// /// Remember that seconds are rounded to the nearest whole frame, so what you get back may not /// exactly match what you put in: /// /// ```rust /// # use vtc::{Timecode, rates}; /// use num::Rational64; /// let tc = Timecode::with_seconds(Rational64::new(3600, 1), rates::F23_98).unwrap(); /// assert_eq!(Rational64::new(43200157, 12000), tc.seconds()) /// ``` pub fn with_seconds<T: SecondsSource>(seconds: T, rate: Framerate) -> TimecodeParseResult { let seconds_rat = seconds.to_seconds(rate)?; Ok(Self::with_rational_seconds(seconds_rat, rate)) } /// Returns a new [Timecode] with a [Timecode::premiere_ticks] return value equal to the ticks /// arg. /// /// # Arguments /// /// * `ticks` - A value which can be represented as a number Adobe Premiere Pro ticks. /// /// * `rate` - The Framerate which seconds will be rounded to match the nearest frame with. /// /// # Examples /// /// ```rust /// # use vtc::{Timecode, rates}; /// use num::Rational64; /// let tc = Timecode::with_premiere_ticks(915372057600000i64, rates::F23_98).unwrap(); /// assert_eq!("01:00:00:00", tc.timecode()) /// ``` pub fn with_premiere_ticks<T: PremiereTicksSource>( ticks: T, rate: Framerate, ) -> TimecodeParseResult { let tick_count = ticks.to_ticks(rate)?; // We need to do this calculation in a 128-bit Ratio because otherwise // PREMIERE_TICKS_PER_SECOND could easily cause an integer overflow for a reasonably i64 // seconds value. let seconds128 = Ratio::<i128>::from_integer(tick_count as i128) / PREMIERE_TICKS_PER_SECOND; let seconds = Rational64::new(*seconds128.numer() as i64, *seconds128.denom() as i64); Self::with_seconds(seconds, rate) } /// Used internally for creating new timecodes from i64 frame count values without /// an error return. fn with_i64_frames(frame_count: i64, rate: Framerate) -> Timecode { let seconds = Rational64::from_integer(frame_count) / rate.playback(); Self::with_rational_seconds(seconds, rate) } /// Used internally for creating new timecodes from Rational64 seconds values /// without an error return. fn with_rational_seconds(seconds: Rational64, rate: Framerate) -> Timecode { let seconds = round_seconds_to_frame(seconds, rate); Timecode { seconds, rate } } } impl Display for Timecode { fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { write!(f, "[{} @ {}]", self.timecode(), self.rate) } } impl PartialEq for Timecode { fn eq(&self, other: &Self) -> bool { self.seconds == other.seconds } } impl Eq for Timecode {} impl PartialOrd for Timecode { fn partial_cmp(&self, other: &Self) -> Option<Ordering> { self.seconds.partial_cmp(&other.seconds) } } impl Ord for Timecode { fn cmp(&self, other: &Self) -> Ordering { self.seconds.cmp(&other.seconds) } } impl Add for Timecode { type Output = Timecode; fn add(self, rhs: Self) -> Self::Output { let new_seconds = self.seconds + rhs.seconds; Timecode::with_rational_seconds(new_seconds, self.rate()) } } impl<T> AddAssign<T> for Timecode where Timecode: Add<T, Output = Timecode>, { fn add_assign(&mut self, rhs: T) { *self = *self + rhs } } impl Sub for Timecode { type Output = Timecode; fn sub(self, rhs: Self) -> Self::Output { let new_seconds = self.seconds - rhs.seconds; Timecode::with_rational_seconds(new_seconds, self.rate) } } impl<T> SubAssign<T> for Timecode where Timecode: Sub<T, Output = Timecode>, { fn sub_assign(&mut self, rhs: T) { *self = *self - rhs } } impl Mul<Rational64> for Timecode { type Output = Timecode; fn mul(self, rhs: Rational64) -> Self::Output { let new_seconds = self.seconds * rhs; Timecode::with_rational_seconds(new_seconds, self.rate) } } impl Mul<f64> for Timecode { type Output = Timecode; fn mul(self, rhs: f64) -> Self::Output { let rhs_rat = Rational64::from_f64(rhs).unwrap(); let new_seconds = self.seconds * rhs_rat; Timecode::with_rational_seconds(new_seconds, self.rate) } } impl Mul<Timecode> for f64 { type Output = Timecode; fn mul(self, rhs: Timecode) -> Self::Output { rhs * self } } impl Mul<i64> for Timecode { type Output = Timecode; fn mul(self, rhs: i64) -> Self::Output { let rhs_rat = Rational64::from_integer(rhs); let new_seconds = self.seconds * rhs_rat; Timecode::with_rational_seconds(new_seconds, self.rate) } } impl Mul<Timecode> for i64 { type Output = Timecode; fn mul(self, rhs: Timecode) -> Self::Output { rhs * self } } impl<T> MulAssign<T> for Timecode where Timecode: Mul<T, Output = Timecode>, { fn mul_assign(&mut self, rhs: T) { *self = *self * rhs } } impl Div<Rational64> for Timecode { type Output = Timecode; fn div(self, rhs: Rational64) -> Self::Output { let mut frames_rat = Rational64::from_integer(self.frames()); frames_rat /= rhs; frames_rat = frames_rat.floor(); Timecode::with_i64_frames(frames_rat.to_integer(), self.rate) } } impl Rem<Rational64> for Timecode { type Output = Timecode; fn rem(self, rhs: Rational64) -> Self::Output { let mut frames_rat = Rational64::from_integer(self.frames()); frames_rat %= rhs; frames_rat = frames_rat.round(); Timecode::with_i64_frames(frames_rat.to_integer(), self.rate) } } impl Div<f64> for Timecode { type Output = Timecode; fn div(self, rhs: f64) -> Self::Output { // We're going to do the actual operation with rationals. let rhs_rat = Rational64::from_f64(rhs).unwrap(); self / rhs_rat } } impl Rem<f64> for Timecode { type Output = Timecode; fn rem(self, rhs: f64) -> Self::Output { let rhs_rat = Rational64::from_f64(rhs).unwrap(); self % rhs_rat } } impl Div<i64> for Timecode { type Output = Timecode; fn div(self, rhs: i64) -> Self::Output { let frames_divided = self.frames() / rhs; Timecode::with_i64_frames(frames_divided, self.rate) } } impl Rem<i64> for Timecode { type Output = Timecode; fn rem(self, rhs: i64) -> Self::Output { let frames_remainder = self.frames() % rhs; Timecode::with_i64_frames(frames_remainder, self.rate) } } impl<T> DivAssign<T> for Timecode where Timecode: Div<T, Output = Timecode>, { fn div_assign(&mut self, rhs: T) { *self = *self / rhs } } impl<T> RemAssign<T> for Timecode where Timecode: Rem<T, Output = Timecode>, { fn rem_assign(&mut self, rhs: T) { *self = *self % rhs } } impl Neg for Timecode { type Output = Self; fn neg(self) -> Self::Output { Timecode::with_rational_seconds(-self.seconds, self.rate) } } /// Converts a frame-number to an adjusted frame number for creating drop-frame tc. /// /// Algorithm adapted from: https://www.davidheidelberger.com/2010/06/10/drop-frame-timecode/ /// /// * `frame_number` - The frame number to convert to a drop-frame number. /// /// * `rate` - the framerate of the timecode. /// /// returns The frame number adjusted to produce the correct drop-frame timecode when /// used in the normal timecode calculation. /// /// ***WARNING:*** This method will panic if passed a non-drop-frame framerate. fn frame_num_to_drop_num(frame_number: i64, rate: Framerate) -> i64 { // Get the timebase as an i64. NTSC timebases are always whole-frame. let timebase = rate.timebase().to_integer(); // Get the number frames-per-minute at the whole-frame rate. let frames_per_minute = timebase * 60; // Get the number of frames we need to drop each time we drop frames (ex: 2 f or 29.97). let drop_frames = rate.drop_frames().unwrap(); // Get the number of frames are in a minute where we have dropped frames at the // beginning. let frames_per_minute_drop = (timebase * 60) - drop_frames; // Get the number of actual frames in a 10-minute span for drop frame timecode. Since // we drop 9 times in 10 minute, it will be 9 drop-minute frame counts + 1 whole-minute // frame count. let frames_per_10minutes_drop = frames_per_minute_drop * 9 + frames_per_minute; // Get the number of 10s of minutes in this count, and the remaining frames. let result = div_mod_floor(frame_number, frames_per_10minutes_drop); let tens_of_minutes = result.0; let mut frames = result.1; // Create an adjustment for the number of 10s of minutes. It will be 9 times the // drop value (we drop for the first 9 minutes, then leave the 10th alone). let mut adjustment = 9 * drop_frames * tens_of_minutes; // If our remaining frames are less than a whole minute, we aren't going to drop // again. Add the adjustment and return. if frames < frames_per_minute { return frame_number + adjustment; }; // Remove the first full minute (we don't drop until the next minute) and add the // drop-rate to the adjustment. frames -= timebase; adjustment += drop_frames; // Get the number of remaining drop-minutes present, and add a drop adjustment for // each. let minutes_drop = frames / frames_per_minute_drop; adjustment += minutes_drop * drop_frames; // Return our original frame number adjusted by our calculated adjustment. frame_number + adjustment }