Merge pull request #10 from orchetect/dev

Performance improvements; 100fps stringValue bugfix; added FrameRate.CompatibleGroup

Author: orchetect

.gitignore

@@ -1,5 +1,7 @@
+# Custom
+[Dd]ev/
+
 # Xcode
-/dev/
 
 # macOS
 .DS_Store

Package.swift

@@ -18,10 +18,10 @@ let package = Package(
     dependencies: [
 
 		// utility/support code:
-		.package(url: "https://github.com/orchetect/OTCore", from: "1.0.0"),
+		.package(url: "https://github.com/orchetect/OTCore", from: "1.1.0"),
 
 		// console progress module for dev tests:
-		.package(url: "https://github.com/orchetect/SegmentedProgress", from: "1.0.0")
+		.package(url: "https://github.com/orchetect/SegmentedProgress", from: "1.0.1")
 
     ],
 

README.md

@@ -17,7 +17,7 @@
 <img src="http://img.shields.io/badge/license-MIT-blue.svg?style=flat"
      alt="License: MIT" /></a>
 </p>
-A robust multiplatform Swift library for working with SMPTE timecode supporting 20 industry frame rates, and including methods to convert to/from timecode strings and perform calculations.
+A robust multi-platform Swift library for working with SMPTE timecode supporting 20 industry frame rates, and including methods to convert to/from timecode strings and perform calculations.
 
 ## Supported Frame Rates
 
@@ -50,7 +50,7 @@ A robust multiplatform Swift library for working with SMPTE timecode supporting
 
 To add TimecodeKit to your Xcode project:
 
-1. Select File → Swift Packages → Add Package Depedancy
+1. Select File → Swift Packages → Add Package Dependency
 2. Add package using  `https://github.com/orchetect/TimecodeKit` as the URL.
 
 ## Documentation

Sources/TimecodeKit/Components/Component.swift

@@ -6,8 +6,6 @@
 //  Copyright © 2020 Steffan Andrews. All rights reserved.
 //
 
-import Foundation
-
 extension Timecode {
 
 	/// Enum naming an individual timecode component

Sources/TimecodeKit/Components/Components.swift

@@ -6,8 +6,6 @@
 //  Copyright © 2018 Steffan Andrews. All rights reserved.
 //
 
-import Foundation
-
 /// Convenience typealias for cleaner code.
 public typealias TCC = Timecode.Components
 
@@ -41,12 +39,12 @@ extension Timecode {
 
 		// MARK: init
 
-		public init(d: Int = 0,
-					h: Int = 0,
-					m: Int = 0,
-					s: Int = 0,
-					f: Int = 0,
-					sf: Int = 0)
+		@inlinable public init(d: Int = 0,
+							   h: Int = 0,
+							   m: Int = 0,
+							   s: Int = 0,
+							   f: Int = 0,
+							   sf: Int = 0)
 		{
 
 			self.d = d
@@ -64,7 +62,7 @@ extension Timecode {
 
 extension Timecode.Components: Equatable {
 
-	public static func ==(lhs: Self, rhs: Self) -> Bool {
+	@inlinable public static func ==(lhs: Self, rhs: Self) -> Bool {
 
 		lhs.d == rhs.d &&
 			lhs.h == rhs.h &&
@@ -80,9 +78,9 @@ extension Timecode.Components: Equatable {
 extension Timecode.Components {
 
 	/// Returns an instance of `Timecode(exactly:)`.
-	public func toTimecode(at frameRate: Timecode.FrameRate,
-						   limit: Timecode.UpperLimit = ._24hours,
-						   subFramesDivisor: Int? = nil) -> Timecode?
+	@inlinable public func toTimecode(at frameRate: Timecode.FrameRate,
+									  limit: Timecode.UpperLimit = ._24hours,
+									  subFramesDivisor: Int? = nil) -> Timecode?
 	{
 
 		if let sfd = subFramesDivisor {
@@ -102,9 +100,9 @@ extension Timecode.Components {
 	}
 
 	/// Returns an instance of `Timecode(rawValues:)`.
-	public func toTimecode(rawValuesAt frameRate: Timecode.FrameRate,
-						   limit: Timecode.UpperLimit = ._24hours,
-						   subFramesDivisor: Int? = nil) -> Timecode
+	@inlinable public func toTimecode(rawValuesAt frameRate: Timecode.FrameRate,
+									  limit: Timecode.UpperLimit = ._24hours,
+									  subFramesDivisor: Int? = nil) -> Timecode
 	{
 
 		if let sfd = subFramesDivisor {

Sources/TimecodeKit/Data Interchange/Timecode Components.swift

@@ -6,36 +6,38 @@
 //  Copyright © 2020 Steffan Andrews. All rights reserved.
 //
 
-import Foundation
-
 extension Timecode {
 
 	/// Timecode components.
 	/// When setting, invalid values will cause the setter to fail silently. (Validation is based on the frame rate and `upperLimit` property.)
-	public var components: Components {
+	@inlinable public var components: Components {
+		
 		get {
-			return Components(d: days,
-							  h: hours,
-							  m: minutes,
-							  s: seconds,
-							  f: frames,
-							  sf: subFrames)
+			Components(d: days,
+					   h: hours,
+					   m: minutes,
+					   s: seconds,
+					   f: frames,
+					   sf: subFrames)
 		}
 		set {
 			_ = setTimecode(exactly: newValue)
 		}
+		
 	}
 
 	/** Set timecode from tuple values.
 	Returns true/false depending on whether the string values are valid or not.
 	Values which are out-of-bounds will return false. (Validation is based on the frame rate and `upperLimit` property.)
 	*/
 	@discardableResult
-	public mutating func setTimecode(exactly values: Components) -> Bool {
+	@inlinable public mutating func setTimecode(exactly values: Components) -> Bool {
 
-		guard values.invalidComponents(at: frameRate,
-									   limit: upperLimit,
-									   subFramesDivisor: subFramesDivisor).count == 0
+		guard values
+				.invalidComponents(at: frameRate,
+								   limit: upperLimit,
+								   subFramesDivisor: subFramesDivisor)
+				.count == 0
 			else { return false }
 
 		days = values.d
@@ -46,12 +48,14 @@ extension Timecode {
 		subFrames = values.sf
 
 		return true
+		
 	}
 
 	/** Set timecode from tuple values.
 	(Validation is based on the frame rate and `upperLimit` property.)
 	*/
-	public mutating func setTimecode(clamping values: Components) {
+	@inlinable public mutating func setTimecode(clamping values: Components) {
+		
 		days = values.d
 		hours = values.h
 		minutes = values.m
@@ -60,27 +64,33 @@ extension Timecode {
 		subFrames = values.sf
 
 		clampComponents()
+		
 	}
 
 	/** Set timecode from tuple values.
 	Timecode will wrap if out-of-bounds. Will handle negative values and wrap accordingly. (Wrapping is based on the frame rate and `upperLimit` property.)
 	*/
-	public mutating func setTimecode(wrapping values: Components) {
+	@inlinable public mutating func setTimecode(wrapping values: Components) {
+		
 		// guaranteed to work so we can ignore the value returned
 
-		_ = setTimecode(exactly: __add(wrapping: values, to: Components(f: 0)))
+		_ = setTimecode(exactly: __add(wrapping: values,
+									   to: Components(f: 0)))
+		
 	}
 
 	/** Set timecode from tuple values.
 	Timecode values will not be validated or rejected if they overflow.
 	*/
-	public mutating func setTimecode(rawValues values: Components) {
+	@inlinable public mutating func setTimecode(rawValues values: Components) {
+		
 		days = values.d
 		hours = values.h
 		minutes = values.m
 		seconds = values.s
 		frames = values.f
 		subFrames = values.sf
+		
 	}
 
 }

Sources/TimecodeKit/Data Interchange/Timecode Real Time.swift

@@ -6,8 +6,6 @@
 //  Copyright © 2018 Steffan Andrews. All rights reserved.
 //
 
-import Foundation
-
 extension Timecode {
 
 	/// (Lossy) Returns the current timecode converted to a duration in real-time milliseconds (wall-clock time), based on the frame rate. Value is returned as a Double so a high level of precision can be maintained.
@@ -67,20 +65,20 @@ extension TimeValue {
 	/// Convenience method to create an `Timecode` struct using the default `(_ exactly:)` initializer.
 	public func toTimecode(at frameRate: Timecode.FrameRate,
 						   limit: Timecode.UpperLimit = ._24hours,
-						   subFramesDivisor: Int? = nil) -> Timecode?
-	{
+						   subFramesDivisor: Int? = nil) -> Timecode? {
+		
 		if let sfd = subFramesDivisor {
 
 			return Timecode(self,
-							  at: frameRate,
-							  limit: limit,
-							  subFramesDivisor: sfd)
+							at: frameRate,
+							limit: limit,
+							subFramesDivisor: sfd)
 
 		} else {
 
 			return Timecode(self,
-							  at: frameRate,
-							  limit: limit)
+							at: frameRate,
+							limit: limit)
 
 		}
 

Sources/TimecodeKit/Data Interchange/Timecode Samples.swift

@@ -6,25 +6,25 @@
 //  Copyright © 2020 Steffan Andrews. All rights reserved.
 //
 
-import Foundation
-
 extension Timecode {
 
 	/// (Lossy)
 	/// Returns the current timecode converted to a duration in real-time audio samples at the given sample rate, rounded to the nearest sample.
 	/// Sample rate must be expressed as an Integer in Hz (ie: 48KHz would be passed as 48000)
-	public func samplesValue(atSampleRate: Int) -> Double {
+	@inlinable public func samplesValue(atSampleRate: Int) -> Double {
 
 		// prepare coefficients
 
 		var fRate = frameRate.frameRateForElapsedFramesCalculation
 
-		if frameRate.isDrop
-		&& frameRate != ._30_drop
-		&& frameRate != ._60_drop
-		&& frameRate != ._120_drop {
+		if frameRate.isDrop,
+		   frameRate != ._30_drop,
+		   frameRate != ._60_drop,
+		   frameRate != ._120_drop {
+			
 			// all dropframe rates require this except 30 DF and its multiples
 			fRate = Double(frameRate.maxFrames) / 1.001
+			
 		}
 
 		var offset = 1.0
@@ -35,7 +35,9 @@ extension Timecode {
 			 ._47_952,
 			 ._59_94,
 			 ._119_88:
-			offset = 1.001	// not sure why this works, but it makes for an accurate calculation
+			
+			// not sure why this works, but it makes for an accurate calculation
+			offset = 1.001
 
 		case ._24,
 			 ._25,
@@ -48,11 +50,13 @@ extension Timecode {
 			 ._100,
 			 ._119_88_drop,
 			 ._120:
+			
 			break
 
 		case ._30_drop,
 			 ._60_drop,
 			 ._120_drop:
+			
 			offset = 0.999
 
 		}
@@ -76,8 +80,8 @@ extension Timecode {
 	/// Returns false if it underflows or overflows valid timecode range.
 	/// Sample rate must be expressed as an Integer of Hz (ie: 48KHz would be passed as 48000)
 	@discardableResult
-	public mutating func setTimecode(fromSamplesValue: Double,
-									 atSampleRate: Int) -> Bool {
+	@inlinable public mutating func setTimecode(fromSamplesValue: Double,
+												atSampleRate: Int) -> Bool {
 
 		// prepare coefficients