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
//! A library for manipulating SMPTE timecodes. #![feature(step_trait)] use std::fmt; use std::iter; use std::marker; use std::ops; use std::str; mod frame_rate; pub use frame_rate::{ FrameRate, FrameRate2398, FrameRate24, FrameRate25, FrameRate2997, FrameRate30, FrameRate50, FrameRate5994, FrameRate60, }; #[derive(Debug)] /// All [Result](https://doc.rust-lang.org/std/result/enum.Result.html) values /// returned by this library will use this for error values. pub struct TimecodeError { pub kind: TimecodeErrorKind, } #[derive(Debug)] /// Error values for this library. pub enum TimecodeErrorKind { /// Timecode parsing failed due to input having an invalid format. InvalidFormat, /// Timecode had an invalid value. For instance the frame field might have /// a value higher than the frame rate allows. InvalidTimecode, } /// Representation of a timecode as a struct, generic over types implementing /// the trait [FrameRate](trait.FrameRate.html). /// /// **Note**: Currently the user-facing values are open properties. These may /// be replaced by getters to facilitate lazy evaluation. /// /// ``` /// use video_timecode::*; /// use std::str::FromStr; /// /// let tc1 = Timecode::<FrameRate24>::new(0, 0, 0, 10).unwrap(); /// assert_eq!(tc1.frame_number, 10); /// /// let tc2 = Timecode::<FrameRate24>::from_str("00:00:10:00").unwrap(); /// assert_eq!(tc2.frame_number, 240); /// /// let mut tc3 = Timecode::<FrameRate24>::from(240); /// assert_eq!(tc3.hour, 0); /// assert_eq!(tc3.minute, 0); /// assert_eq!(tc3.second, 10); /// assert_eq!(tc3.frame, 0); /// assert_eq!(tc3.frame_number, 240); /// /// tc3 += tc1; /// assert_eq!(tc3.hour, 0); /// assert_eq!(tc3.minute, 0); /// assert_eq!(tc3.second, 10); /// assert_eq!(tc3.frame, 10); /// assert_eq!(tc3.frame_number, 250); /// ``` #[derive(Clone, PartialEq, PartialOrd)] pub struct Timecode<T: FrameRate> { /// Frame number. The count of frames after `00:00:00:00` pub frame_number: u32, pub hour: u8, pub minute: u8, pub second: u8, pub frame: u8, frame_rate: marker::PhantomData<T>, } impl<T: FrameRate> Timecode<T> { /// Returns a timecode with the given hour/minute/second/frame fields. /// /// ``` /// use video_timecode::*; /// /// let timecode = Timecode::<FrameRate24>::new(10, 0, 0, 0).unwrap(); /// assert_eq!(timecode.frame_number, 864000); /// ``` pub fn new(hour: u8, minute: u8, second: u8, frame: u8) -> Result<Timecode<T>, TimecodeError> { use self::TimecodeErrorKind::*; let result = T::calculate_frame_number( u32::from(hour), u32::from(minute), u32::from(second), u32::from(frame), ); match result { Some(frame_number) => Ok(Timecode { frame_number, hour, minute, second, frame, frame_rate: marker::PhantomData, }), None => Err(TimecodeError { kind: InvalidTimecode, }), } } } /// Parse a string into a timecode. /// /// Colon separator is alright for all types. /// /// ``` /// use video_timecode::*; /// use std::str::FromStr; /// /// let tc1 = Timecode::<FrameRate24>::from_str("00:00:10:00").unwrap(); /// assert_eq!(tc1.frame_number, 240); /// /// let tc2 = Timecode::<FrameRate2997>::from_str("00:00:10:00").unwrap(); /// assert_eq!(tc2.frame_number, 300); /// ``` /// /// For frame rates with drop frame, the following formats are also allowed: /// /// * `00:00:00;00` /// * `00;00;00;00` /// * `00.00.00.00` /// * `00:00:00.00` /// /// ``` /// use video_timecode::*; /// use std::str::FromStr; /// /// let tc1 = Timecode::<FrameRate2997>::from_str("00:00:10;00").unwrap(); /// assert_eq!(tc1.frame_number, 300); /// /// let tc2 = Timecode::<FrameRate2997>::from_str("00;00;10;00").unwrap(); /// assert_eq!(tc2.frame_number, 300); /// /// let tc3 = Timecode::<FrameRate2997>::from_str("00:00:10.00").unwrap(); /// assert_eq!(tc3.frame_number, 300); /// /// let tc4 = Timecode::<FrameRate2997>::from_str("00.00.10.00").unwrap(); /// assert_eq!(tc4.frame_number, 300); /// ``` impl<T: FrameRate> str::FromStr for Timecode<T> { /// If parsing fails, a timecode error is returned. /// /// If the input format is invalid in some way, the `TimecodeErrorKind` field /// of the [TimecodeError](struct.TimecodeError.html) will be /// [InvalidFormat](enum.TimecodeErrorKind.html#variant.InvalidFormat). /// /// ``` /// use video_timecode::*; /// use video_timecode::TimecodeErrorKind::*; /// use std::str::FromStr; /// /// // Semicolon notation only allowed for drop frame frame rates. /// match Timecode::<FrameRate24>::from_str("00:00:10;00") { /// Err(TimecodeError { kind: InvalidFormat }) => {} /// _ => panic!() /// } /// ``` /// /// If the timecode is not valid for the given frame rate, it will be /// [InvalidTimecode](enum.TimecodeErrorKind.html#variant.Timecode). /// /// ``` /// use video_timecode::*; /// use video_timecode::TimecodeErrorKind::*; /// use std::str::FromStr; /// /// // This is a dropped frame. /// match Timecode::<FrameRate2997>::from_str("00:01:00;00") { /// Err(TimecodeError { kind: InvalidTimecode }) => {} /// _ => panic!() /// } /// ``` type Err = TimecodeError; fn from_str(s: &str) -> Result<Self, Self::Err> { use self::TimecodeErrorKind::*; let mut colon_notation = false; let mut semi_colon_notation = false; let mut dot_notation = false; let mut it = s.chars(); let hour_string = it.by_ref().take(2).collect::<String>(); let hour: u8 = match hour_string.parse() { Ok(n) if n < 60 => n, _ => { return Err(TimecodeError { kind: InvalidFormat, }); } }; let minute_sep_char = it.next(); match minute_sep_char { Some(':') => colon_notation = true, Some(';') => semi_colon_notation = true, Some('.') => dot_notation = true, _ => { return Err(TimecodeError { kind: InvalidFormat, }); } }; let minute_string = it.by_ref().take(2).collect::<String>(); let minute: u8 = match minute_string.parse() { Ok(n) if n < 60 => n, _ => { return Err(TimecodeError { kind: InvalidFormat, }); } }; let second_sep_char = it.next(); match second_sep_char { Some(':') if colon_notation => {} Some(';') if semi_colon_notation => {} Some('.') if dot_notation => {} _ => { return Err(TimecodeError { kind: InvalidFormat, }); } } let second_string = it.by_ref().take(2).collect::<String>(); let second: u8 = match second_string.parse() { Ok(n) if n < 60 => n, _ => { return Err(TimecodeError { kind: InvalidFormat, }); } }; let frame_sep_char = it.next(); let drop_frame = match frame_sep_char { Some(':') if colon_notation => false, Some(';') if semi_colon_notation || colon_notation => true, Some('.') if dot_notation || colon_notation => true, _ => { return Err(TimecodeError { kind: InvalidFormat, }); } }; let frame_string = it.by_ref().take(2).collect::<String>(); let frame: u8 = match frame_string.parse() { Ok(n) => n, _ => { return Err(TimecodeError { kind: InvalidFormat, }); } }; if it.next() != None { return Err(TimecodeError { kind: InvalidFormat, }); } if drop_frame && !T::DROP_FRAME { return Err(TimecodeError { kind: InvalidFormat, }); } match Timecode::<T>::new(hour, minute, second, frame) { Ok(timecode) => Ok(timecode), Err(_) => Err(TimecodeError { kind: InvalidTimecode, }), } } } impl<T: FrameRate> fmt::Display for Timecode<T> { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { let separator = if T::DROP_FRAME { ';' } else { ':' }; write!( f, "{:02}:{:02}:{:02}{}{:02}", self.hour, self.minute, self.second, separator, self.frame ) } } impl<T: FrameRate> fmt::Debug for Timecode<T> { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { let separator = if T::DROP_FRAME { ';' } else { ':' }; write!( f, "Timecode {{ timecode: {:02}:{:02}:{:02}{}{:02}, frame_number: {}, frame_rate: {} }}", self.hour, self.minute, self.second, separator, self.frame, self.frame_number, T::DISPLAY, ) } } /// Create a timecode with the the given frame number. impl<T: FrameRate> From<u32> for Timecode<T> { fn from(frame_number: u32) -> Self { let new_frame_number = frame_number % T::MAX_FRAMES; let (hour, minute, second, frame) = T::calculate_time_code(new_frame_number); Timecode { frame_number: new_frame_number, hour, minute, second, frame, frame_rate: marker::PhantomData, } } } /// Make a new timecode by adding a number of frames to a timecode. impl<T: FrameRate> ops::Add<u32> for Timecode<T> { type Output = Self; fn add(self, other: u32) -> Self { Timecode::<T>::from(self.frame_number + other) } } /// Add a number of frames to a timecode. impl<T: FrameRate> ops::AddAssign<u32> for Timecode<T> { fn add_assign(&mut self, other: u32) { let new_frame_number = (self.frame_number + other) % T::MAX_FRAMES; let (hour, minute, second, frame) = T::calculate_time_code(new_frame_number); self.hour = hour; self.minute = minute; self.second = second; self.frame = frame; self.frame_number = new_frame_number; } } /// Make a new timecode by removing a number of frames to a timecode. impl<T: FrameRate> ops::Sub<u32> for Timecode<T> { type Output = Self; fn sub(self, other: u32) -> Self { Timecode::<T>::from(self.frame_number - other) } } /// Remove a number of frames from a timecode. impl<T: FrameRate> ops::SubAssign<u32> for Timecode<T> { fn sub_assign(&mut self, other: u32) { let new_frame_number = (self.frame_number - other) % T::MAX_FRAMES; let (hour, minute, second, frame) = T::calculate_time_code(new_frame_number); self.hour = hour; self.minute = minute; self.second = second; self.frame = frame; self.frame_number = new_frame_number; } } /// Make a new timecode by adding two timecodes together. The result is a /// timecode where the field `frame_number` is the sum of the frame numbers /// of the two added timecodes. /// /// ``` /// use video_timecode::*; /// /// let tc1 = Timecode::<FrameRate24>::new(0, 0, 20, 0).unwrap(); /// let tc2 = Timecode::<FrameRate24>::new(0, 0, 10, 0).unwrap(); /// let tc3 = tc1 + tc2; /// assert_eq!(tc3, Timecode::<FrameRate24>::new(0, 0, 30, 0).unwrap()); /// ``` /// /// # Adding Timecodes of different frame rates /// /// Adding timecodes of different framerates together is not supported. /// /// Since adding Timecodes of different frame rates together normally does not make /// any sense, it is better that the programmer has to mark this, by explicitly /// adding the number of frames. /// /// ```compile_fail /// use video_timecode::*; /// /// let tc1 = Timecode::<FrameRate2997>::new(0, 0, 0, 0).unwrap(); /// let tc2 = Timecode::<FrameRate24>::new(0, 0, 10, 0).unwrap(); /// let tc3 = tc1 + tc2; /// ``` /// /// # Timecode roll-over /// /// The timecode (including the `frame_number` field) will roll over when the /// timecode reaches 24 hours. /// /// ``` /// use video_timecode::*; /// /// let tc1 = Timecode::<FrameRate24>::new(23, 59, 30, 0).unwrap(); /// let tc2 = Timecode::<FrameRate24>::new(0, 1, 0, 0).unwrap(); /// let tc3 = tc1 + tc2; /// assert_eq!(tc3, Timecode::<FrameRate24>::new(0, 0, 30, 0).unwrap()); /// ``` impl<T: FrameRate> ops::Add for Timecode<T> { type Output = Timecode<T>; fn add(self, other: Self) -> Self { self + other.frame_number } } /// Add one timecode to another, of the same frame rate. The first timecode /// will have a `frame_number` that's the sum of the frame numbers of the /// two timecodes. /// /// ``` /// use video_timecode::*; /// /// let mut tc1 = Timecode::<FrameRate24>::new(0, 0, 10, 0).unwrap(); /// let tc2 = Timecode::<FrameRate24>::new(0, 0, 10, 0).unwrap(); /// tc1 += tc2; /// /// assert_eq!(tc1, Timecode::<FrameRate24>::new(0, 0, 20, 0).unwrap()); /// ``` impl<T: FrameRate> ops::AddAssign for Timecode<T> { fn add_assign(&mut self, other: Self) { *self += other.frame_number; } } /// Iterate over timecodes in steps. /// /// ``` /// use video_timecode::*; /// /// assert_eq!( /// (Timecode::<FrameRate24>::new(00, 0, 59, 22).unwrap() /// ..Timecode::<FrameRate24>::new(00, 1, 0, 2).unwrap()) /// .collect::<Vec<Timecode<FrameRate24>>>(), /// vec![ /// Timecode::<FrameRate24>::new(00, 0, 59, 22).unwrap(), /// Timecode::<FrameRate24>::new(00, 0, 59, 23).unwrap(), /// Timecode::<FrameRate24>::new(00, 1, 0, 0).unwrap(), /// Timecode::<FrameRate24>::new(00, 1, 0, 1).unwrap(), /// ] /// ); /// ``` impl<T: FrameRate + Clone + PartialOrd> iter::Step for Timecode<T> { fn steps_between(start: &Self, end: &Self) -> Option<usize> { if start.frame_number <= end.frame_number { Some((end.frame_number - start.frame_number) as usize) } else { None } } fn replace_one(&mut self) -> Self { std::mem::replace( self, Timecode { frame_number: 1, hour: 0, minute: 0, second: 0, frame: 1, frame_rate: marker::PhantomData, }, ) } fn replace_zero(&mut self) -> Self { std::mem::replace( self, Timecode { frame_number: 0, hour: 0, minute: 0, second: 0, frame: 0, frame_rate: marker::PhantomData, }, ) } fn add_one(&self) -> Self { if u32::from(self.frame) < (T::FPS - 1) { Timecode { frame_number: self.frame_number + 1, hour: self.hour, minute: self.minute, second: self.second, frame: self.frame + 1, frame_rate: marker::PhantomData, } } else if self.second < 59 { Timecode { frame_number: self.frame_number + 1, hour: self.hour, minute: self.minute, second: self.second + 1, frame: 0, frame_rate: marker::PhantomData, } } else if self.minute < 59 { let new_minute = self.minute + 1; let new_frame = if T::DROP_FRAME && (new_minute % 10 != 0) { T::DROP_FRAME_COUNT as u8 } else { 0 }; Timecode { frame_number: self.frame_number + 1, hour: self.hour, minute: new_minute, second: 0, frame: new_frame, frame_rate: marker::PhantomData, } } else { Timecode { frame_number: self.frame_number + 1, hour: self.hour + 1, minute: 0, second: 0, frame: 0, frame_rate: marker::PhantomData, } } } fn sub_one(&self) -> Self { if u32::from(self.frame) > 0 { Timecode { frame_number: self.frame_number - 1, hour: self.hour, minute: self.minute, second: self.second, frame: self.frame - 1, frame_rate: marker::PhantomData, } } else if self.second > 0 { Timecode { frame_number: self.frame_number - 1, hour: self.hour, minute: self.minute, second: self.second - 1, frame: T::FPS as u8 - 1, frame_rate: marker::PhantomData, } } else if self.minute > 0 { Timecode { frame_number: self.frame_number - 1, hour: self.hour, minute: self.minute - 1, second: 59, frame: T::FPS as u8 - 1, frame_rate: marker::PhantomData, } } else { Timecode { frame_number: self.frame_number - 1, hour: self.hour - 1, minute: 59, second: 59, frame: T::FPS as u8 - 1, frame_rate: marker::PhantomData, } } } fn add_usize(&self, n: usize) -> Option<Self> { if n == 1 { Some(self.add_one()) } else { Some(self.clone() + (n as u32)) } } }