TimecodeKit

The most robust, precise and complete Swift library for working with SMPTE/EBU timecode. Supports 23 industry timecode frame rates, with a suite of conversions, calculations and integrations with Apple AV frameworks.

Timecode is a broadcast and post-production standard for addressing video frames. It is used for video burn-in timecode (BITC), and display in a DAW (Digital Audio Workstation) or video playback/editing applications.

Supported Timecode Frame Rates

The following timecode rates and formats are supported.

Supported Video Frame Rates

The following video frame rates are supported. (Video rates)

Core Features

• Convert timecode between:
  • timecode display string
  • total elapsed frame count
  • real wall-clock time
  • elapsed audio samples at any audio sample rate
  • rational time notation (such as CMTime or Final Cut Pro XML and AAF encoding)
  • feet + frames
• Convert timecode and/or frame rate to a rational fraction, and vice-versa (including CMTime)
• Support for Days as a timecode component (some DAWs including Cubase support > 24 hour timecode)
• Support for Subframes
• Math operations: add, subtract, multiply, divide
• Granular timecode validation
• Form a Range or Stride between two timecode instances
• Conforms to Codable
• Formatters
  • A Formatter object that can format timecode
  • An AttributedString showing invalid timecode components using alternate attributes (such as red text color)
• SwiftUI Views
  • A timecode entry text field
  • A timecode string Text view emphasizing invalid timecode components using alternate attributes (such as red text color)
• AVAsset video file utilities to easily read/write timecode tracks and locate AVPlayer to timecode locations
• Exhaustive unit tests ensuring accuracy

Installation

Swift Package Manager (SPM)

1. Add TimecodeKit as a dependency using Swift Package Manager.
   • In an app project or framework, in Xcode: Add the package to your target using this URL: https://github.com/orchetect/TimecodeKit
   • In a Swift Package, add it to the Package.swift dependencies:

     .package(url: "https://github.com/orchetect/TimecodeKit", from: "2.3.1")

2. Import the library:

   import TimecodeKit

Documentation

See the online documentation for library usage, getting started info, and 1.x → 2.x migration guide.

Also check out the Examples folder for sample code to see TimecodeKit in action.

References

• Wikipedia: SMPTE Timecode

Author

Coded by a bunch of 🐹 hamsters in a trenchcoat that calls itself @orchetect.

License

Licensed under the MIT license. See LICENSE for details.

Sponsoring

If you enjoy using TimecodeKit and want to contribute to open-source financially, GitHub sponsorship is much appreciated. Feedback and code contributions are also welcome.

Community & Support

Please do not email maintainers for technical support. Several options are available for questions and feature ideas:

• Questions and feature ideas can be posted to Discussions.
• If an issue is a verifiable bug with reproducible steps it may be posted in Issues.

Contributions

Contributions are welcome. Feel free to post in Discussions first before submitting a PR.