Mark isValidTimecodeRate deprecated in favor of isSmpteTimecodeRate

Signed-off-by: Joshua Minor <jminor@users.noreply.github.com>

Author: jminor

Sources/objc/include/opentime.h

@@ -60,14 +60,15 @@ extern "C" {
 #endif
 
 
-    
+
 double rational_time_value_rescaled_to(CxxRationalTime const*, double new_rate);
 double rational_time_value_rescaled_to_copy(CxxRationalTime, double new_rate);
 CxxRationalTime rational_time_rescaled_to(CxxRationalTime const* rt, double new_rate);
 bool rational_time_almost_equal(CxxRationalTime, CxxRationalTime, double);
 
 CxxRationalTime rational_time_duration_from_start_end_time(CxxRationalTime, CxxRationalTime);
 bool rational_time_is_valid_timecode_rate(double);
+bool rational_time_is_smpte_timecode_rate(double);
 
 CxxRationalTime rational_time_from_timecode(NSString* timecode, double rate, CxxErrorStruct* err);
 CxxRationalTime rational_time_from_timestring(NSString* timestring, double rate, CxxErrorStruct* err);

Sources/objc/opentime.mm

@@ -41,10 +41,15 @@ CxxRationalTime rational_time_duration_from_start_end_time(CxxRationalTime s, Cx
                                                                             otioRationalTime(e)));
 }
 
+// deprecated
 bool rational_time_is_valid_timecode_rate(double rate) {
     return otio::RationalTime::is_valid_timecode_rate(rate);
 }
 
+bool rational_time_is_smpte_timecode_rate(double rate) {
+    return otio::RationalTime::is_smpte_timecode_rate(rate);
+}
+
 static inline void deal_with_error(opentime::ErrorStatus const& error_status, CxxErrorStruct* err) {
     if (error_status.outcome != error_status.OK) {
         err->statusCode = error_status.outcome;

Sources/swift/RationalTime.swift

@@ -10,19 +10,19 @@ import OpenTimelineIO_objc
 public struct RationalTime: CustomStringConvertible, Equatable {
     public var value: Double { return cxxRationalTime.value }
     public var rate: Double { return cxxRationalTime.rate }
-    
+
     public var description: String {
         return "RationalTime(\(value), \(rate))"
     }
-    
+
     public init(value: Double = 0, rate: Double = 1) {
         cxxRationalTime = CxxRationalTime(value: value, rate: rate)
     }
-    
+
     public func isInvalidTime() -> Bool {
         return rate <= 0
     }
-    
+
     public func rescaled(to newRate: Double) -> RationalTime {
         return withUnsafePointer(to: self.cxxRationalTime) {
             RationalTime(rational_time_rescaled_to($0, newRate));
@@ -55,11 +55,16 @@ public struct RationalTime: CustomStringConvertible, Equatable {
         return RationalTime(rational_time_duration_from_start_end_time(startTime.cxxRationalTime,
                                                                        endTime.cxxRationalTime))
     }
-    
+
+    @available(*, deprecated, renamed: "isSmpteTimecodeRate")
     static public func isValidTimecodeRate(_ inRate: Double) -> Bool {
         return rational_time_is_valid_timecode_rate(inRate)
     }
-    
+
+    static public func isSmpteTimecodeRate(_ inRate: Double) -> Bool {
+        return rational_time_is_smpte_timecode_rate(inRate)
+    }
+
     static public func from(frame: Double, rate inRate: Double) -> RationalTime {
         return RationalTime(value: floor(frame), rate: inRate)
     }
@@ -71,27 +76,27 @@ public struct RationalTime: CustomStringConvertible, Equatable {
     static public func from(seconds: Double) -> RationalTime {
         return RationalTime(value: seconds, rate: 1)
     }
-    
+
     static public func from(timecode: String, rate inRate: Double) throws -> RationalTime {
         return try OpentimeError.returnOrThrow { RationalTime(rational_time_from_timecode(timecode, inRate, &$0)) }
     }
-    
+
     static public func from(timestring: String, rate inRate: Double) throws -> RationalTime {
         return try OpentimeError.returnOrThrow { RationalTime(rational_time_from_timestring(timestring, inRate, &$0)) }
     }
-    
+
     public func toFrames() -> Int {
         return Int(value)
     }
-    
+
     public func toFrames(rate inRate: Double) -> Int {
         return Int(valueRescaled(to: inRate))
     }
-    
+
     public func toSeconds() -> Double {
         return valueRescaled(to: 1)
     }
-    
+
     public func toTimecode(rate inRate: Double) throws -> String {
         return try OpentimeError.returnOrThrow { rational_time_to_timecode(cxxRationalTime, inRate, &$0) }
     }
@@ -115,7 +120,7 @@ public struct RationalTime: CustomStringConvertible, Equatable {
     static public prefix func - (lhs: RationalTime) -> RationalTime {
         return RationalTime(value: -lhs.value, rate: -lhs.rate)
     }
-    
+
     static public func + (lhs: RationalTime, rhs: RationalTime) -> RationalTime {
         return RationalTime(rational_time_add(lhs.cxxRationalTime, rhs.cxxRationalTime))
     }
@@ -151,7 +156,6 @@ public struct RationalTime: CustomStringConvertible, Equatable {
     internal init(_ cxxRationalTime: CxxRationalTime) {
         self.cxxRationalTime = cxxRationalTime
     }
-    
+
     internal let cxxRationalTime: CxxRationalTime
 }
-

Tests/OpenTimelineIOTests/testRationalTime.swift

@@ -211,6 +211,15 @@ class testRationalTime: XCTestCase {
         try XCTAssertThrowsError(t.toTimecode())
     }
 
+    func testSmpteRates() {
+      XCTAssertFalse(RationalTime.isSmpteTimecodeRate(29.98))
+      XCTAssertFalse(RationalTime.isSmpteTimecodeRate(23.98))
+      XCTAssertTrue(RationalTime.isSmpteTimecodeRate(30000.0 / 1001.0))
+      XCTAssertTrue(RationalTime.isSmpteTimecodeRate(24000.0 / 1001.0))
+      XCTAssertTrue(RationalTime.isSmpteTimecodeRate(30))
+      XCTAssertTrue(RationalTime.isSmpteTimecodeRate(24))
+    }
+
     func testTimeString24() {
         var time_string = "00:00:00.041667"
         var t = RationalTime(value: 1.0, rate: 24)