Updated "Movie Timecode" example project

Author: orchetect

Examples/Movie Timecode/Movie Timecode.xcodeproj/project.pbxproj

@@ -264,6 +264,7 @@
 ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 ASSETCATALOG_COMPILER_GLOBAL_ACCENT_COLOR_NAME = AccentColor;
 CODE_SIGN_ENTITLEMENTS = "Movie Timecode/App/MovieTimecode.entitlements";
+"CODE_SIGN_IDENTITY[sdk=macosx*]" = "-";
 CODE_SIGN_STYLE = Automatic;
 CURRENT_PROJECT_VERSION = 1;
 DEAD_CODE_STRIPPING = YES;
@@ -305,6 +306,7 @@
 ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 ASSETCATALOG_COMPILER_GLOBAL_ACCENT_COLOR_NAME = AccentColor;
 CODE_SIGN_ENTITLEMENTS = "Movie Timecode/App/MovieTimecode.entitlements";
+"CODE_SIGN_IDENTITY[sdk=macosx*]" = "-";
 CODE_SIGN_STYLE = Automatic;
 CURRENT_PROJECT_VERSION = 1;
 DEAD_CODE_STRIPPING = YES;

Examples/Movie Timecode/Movie Timecode/AddOrReplaceTimecodeTrackView.swift

@@ -30,7 +30,7 @@ struct AddOrReplaceTimecodeTrackView: View {
  }
  Picker("SubFrames Base", selection: $newStartTimecode.subFramesBase) {
  ForEach(Timecode.SubFramesBase.allCases) { subFramesBase in
- Text("\(subFramesBase)").tag(subFramesBase)
+ Text("\(subFramesBase.description)").tag(subFramesBase)
  }
  }
 
@@ -55,6 +55,23 @@ struct AddOrReplaceTimecodeTrackView: View {
  .formStyle(.grouped)
  }
  .padding()
+ 
+ #if os(macOS)
+ // note that SwiftUI's .fileImporter does not produce a security-scoped URL suitable for writing to on macOS (but seems fine on iOS).
+ // also, SwiftUI's .fileExporter insists on writing the data to disk for us with no way to write to the URL manually.
+ // hence, our workaround is to use a custom NSOpenPanel wrapper.
+ .fileOpenPanel(isPresented: $isFolderPickerShown) { openPanel in
+ openPanel.canCreateDirectories = true
+ openPanel.canChooseDirectories = true
+ openPanel.canChooseFiles = false
+ openPanel.allowsMultipleSelection = false
+ openPanel.title = "Export"
+ openPanel.directoryURL = model.defaultFolder
+ } completion: { urls in
+ guard let url = urls?.first else { return }
+ Task { await handleResult(.success(url)) }
+ }
+ #else
  .fileImporter(
  isPresented: $isFolderPickerShown,
  allowedContentTypes: [.folder]
@@ -63,23 +80,23 @@ struct AddOrReplaceTimecodeTrackView: View {
  }
  .fileDialogDefaultDirectory(model.defaultFolder)
  .fileDialogConfirmationLabel("Export")
+ #endif
  }
 
  private func handleResult(_ result: Result<URL, Error>) async {
- switch result {
- case let .success(folderURL):
+ do {
+ let folderURL = try result.get()
+ 
  isExportProgressShown = true
- guard let fileURL = model.uniqueExportURL(folder: folderURL) else { return }
- print("Exporting to \(fileURL.path)")
+ defer { isExportProgressShown = false }
 
- await model.exportReplacingTimecodeTrack(
- startTimecode: newStartTimecode,
- to: fileURL,
- revealInFinderOnCompletion: true
+ await model.export(
+ action: .replaceTimecodeTrack(startTimecode: newStartTimecode),
+ toFolder: folderURL,
+ revealInFinderOnCompletion: true // only applies to macOS
  )
- isExportProgressShown = false
- case let .failure(error):
- model.error = ModelError.exportError(error)
+ } catch {
+ model.error = .exportError(error)
  }
  }
 }

Examples/Movie Timecode/Movie Timecode/ContentView.swift

@@ -95,11 +95,15 @@ struct ContentView: View {
  }
  }
  .tabViewStyle(.tabBarOnly)
+ #if os(macOS)
  .frame(minHeight: 400)
+ #else
+ .frame(minHeight: 600)
+ #endif
  .environment(model)
  } else {
  ZStack {
- Text("Load a movie.")
+ Text("Load a movie using the panel above.")
  }
  .frame(maxWidth: .infinity, maxHeight: .infinity)
  }

Examples/Movie Timecode/Movie Timecode/Model/Model+Movie.swift

@@ -0,0 +1,78 @@
+//
+// Model.swift
+// TimecodeKit • https://github.com/orchetect/TimecodeKit
+// © 2020-2024 Steffan Andrews • Licensed under MIT License
+//
+
+@preconcurrency import AVFoundation
+import Observation
+import TimecodeKit
+
+extension Model {
+ struct Movie: Equatable, Hashable, Sendable {
+ let avMovie: AVMovie
+ 
+ // cached metadata
+ let frameRate: TimecodeFrameRate?
+ let timecodeStart: Timecode?
+ let containsTimecodeTrack: Bool
+ 
+ init(
+ avMovie: AVMovie,
+ frameRate: TimecodeFrameRate?,
+ timecodeStart: Timecode?,
+ containsTimecodeTrack: Bool
+ ) {
+ self.avMovie = avMovie
+ self.frameRate = frameRate
+ self.timecodeStart = timecodeStart
+ self.containsTimecodeTrack = containsTimecodeTrack
+ }
+ }
+}
+
+extension Model.Movie {
+ enum ExportAction {
+ case removeTimecodeTrack
+ case replaceTimecodeTrack(startTimecode: Timecode)
+ }
+ 
+ /// Creates a copy of the movie, performs the operation, exports to a new file,
+ /// and optionally reveals the new file in the Finder (macOS only).
+ func export(
+ action: ExportAction,
+ to url: URL,
+ revealInFinderOnCompletion: Bool
+ ) async throws(ModelError) {
+ do {
+ let mutableMovie = try getMutableMovieCopy()
+ 
+ switch action {
+ case .removeTimecodeTrack:
+ try await mutableMovie.removeTimecodeTracks()
+ case .replaceTimecodeTrack(let startTimecode):
+ try await mutableMovie.replaceTimecodeTrack(startTimecode: startTimecode, fileType: .mov)
+ }
+ 
+ try await mutableMovie.export(to: url)
+
+ #if os(macOS)
+ if revealInFinderOnCompletion {
+ try url.revealInFinder()
+ }
+ #endif
+ } catch let err as ModelError {
+ throw err
+ } catch let err {
+ throw .exportError(err)
+ }
+ }
+ 
+ /// Produces a mutable copy of the loaded movie.
+ fileprivate func getMutableMovieCopy() throws(ModelError) -> AVMutableMovie {
+ guard let mutableMovie = avMovie.mutableCopy() as? AVMutableMovie else {
+ throw .errorCreatingMutableMovieCopy
+ }
+ return mutableMovie
+ }
+}

Examples/Movie Timecode/Movie Timecode/Model/Model.swift

@@ -8,20 +8,11 @@
 import Observation
 import TimecodeKit
 
-@Observable @MainActor class Model {
+@Observable @MainActor final class Model {
  private(set) var movie: Movie?
  var error: ModelError?
 }
 
-extension Model {
- @MainActor struct Movie {
- private(set) var avMovie: AVMovie
- private(set) var frameRate: TimecodeFrameRate?
- private(set) var timecodeStart: Timecode?
- private(set) var containsTimecodeTrack: Bool = false
- }
-}
-
 // MARK: - Handlers
 
 extension Model {
@@ -161,63 +152,41 @@ extension Model {
 // MARK: - Movie Mutation and Export
 
 extension Model {
- func exportReplacingTimecodeTrack(
- startTimecode: Timecode,
- to url: URL,
+ func export(
+ action: Movie.ExportAction,
+ toFolder folderURL: URL,
  revealInFinderOnCompletion: Bool
  ) async {
+ guard let fileURL = uniqueExportURL(folder: folderURL) else { return }
+ print("Exporting to \(fileURL.path)")
+ 
  await export(
- to: url,
+ action: action,
+ to: fileURL,
  revealInFinderOnCompletion: revealInFinderOnCompletion
- ) { mutableMovie in
- try await mutableMovie.replaceTimecodeTrack(startTimecode: startTimecode, fileType: .mov)
- }
+ )
  }
 
- func exportRemovingTimecodeTrack(
+ func export(
+ action: Movie.ExportAction,
  to url: URL,
  revealInFinderOnCompletion: Bool
- ) async {
- await export(
- to: url,
- revealInFinderOnCompletion: revealInFinderOnCompletion
- ) { mutableMovie in
- try await mutableMovie.removeTimecodeTracks()
- }
- }
- 
- /// Creates a copy of the movie, performs the operation, exports to a new file,
- /// and optionally reveals the new file in the Finder (macOS only).
- private func export(
- to url: URL,
- revealInFinderOnCompletion: Bool,
- _ mutation: @Sendable (_ mutableMovie: AVMutableMovie) async throws -> Void
  ) async {
  do {
- let mutableMovie = try getMutableCopy()
- try await mutation(mutableMovie)
- try await mutableMovie.export(to: url)
- 
- #if os(macOS)
- if revealInFinderOnCompletion {
- try url.revealInFinder()
+ guard let movie else {
+ throw ModelError.noMovieLoaded
  }
- #endif
+ 
+ try await movie.export(
+ action: action,
+ to: url,
+ revealInFinderOnCompletion: revealInFinderOnCompletion
+ )
+ 
  } catch let err as ModelError {
  error = err
  } catch let err {
  error = .exportError(err)
  }
  }
- 
- /// Produces a mutable copy of the loaded movie.
- private func getMutableCopy() throws -> AVMutableMovie {
- guard let movie else {
- throw ModelError.noMovieLoaded
- }
- guard let mutableMovie = movie.avMovie.mutableCopy() as? AVMutableMovie else {
- throw ModelError.errorCreatingMutableMovieCopy
- }
- return mutableMovie
- }
 }

Examples/Movie Timecode/Movie Timecode/Model/ModelError.swift

@@ -19,21 +19,21 @@ extension ModelError {
  var errorDescription: String? {
  switch self {
  case .errorCreatingMutableMovieCopy:
- "Error creating mutable movie copy in memory."
+ "Error creating mutable movie copy in memory"
  case let .fileImportError(error):
- "File import error: \(error.localizedDescription)."
+ "File import error: \(error.localizedDescription)"
  case .noMovieLoaded:
- "No movie loaded."
+ "No movie loaded"
  case let .exportError(details):
  if let details {
- "Export error: \(details.localizedDescription)."
+ "Export error: \(details.localizedDescription)"
  } else {
- "Export error."
+ "Export error"
  }
  case .pathDoesNotExist:
- "Path does not exist."
+ "Path does not exist"
  case .pathIsNotFolder:
- "Path is not a folder."
+ "Path is not a folder"
  }
  }
 }

Examples/Movie Timecode/Movie Timecode/RemoveTimecodeTrackView.swift

@@ -30,6 +30,23 @@ struct RemoveTimecodeTrackView: View {
  .formStyle(.grouped)
  }
  .padding()
+ 
+ #if os(macOS)
+ // note that SwiftUI's .fileImporter does not produce a security-scoped URL suitable for writing to on macOS (but seems fine on iOS).
+ // also, SwiftUI's .fileExporter insists on writing the data to disk for us with no way to write to the URL manually.
+ // hence, our workaround is to use a custom NSOpenPanel wrapper.
+ .fileOpenPanel(isPresented: $isFolderPickerShown) { openPanel in
+ openPanel.canCreateDirectories = true
+ openPanel.canChooseDirectories = true
+ openPanel.canChooseFiles = false
+ openPanel.allowsMultipleSelection = false
+ openPanel.title = "Export"
+ openPanel.directoryURL = model.defaultFolder
+ } completion: { urls in
+ guard let url = urls?.first else { return }
+ Task { await handleResult(.success(url)) }
+ }
+ #else
  .fileImporter(
  isPresented: $isFolderPickerShown,
  allowedContentTypes: [.folder]
@@ -38,23 +55,23 @@ struct RemoveTimecodeTrackView: View {
  }
  .fileDialogDefaultDirectory(model.defaultFolder)
  .fileDialogConfirmationLabel("Export")
+ #endif
  }
 
  private func handleResult(_ result: Result<URL, Error>) async {
  do {
  let folderURL = try result.get()
 
  isExportProgressShown = true
- guard let fileURL = model.uniqueExportURL(folder: folderURL) else { return }
- print("Exporting to \(fileURL.path)")
+ defer { isExportProgressShown = false }
 
- await model.exportRemovingTimecodeTrack(
- to: fileURL,
- revealInFinderOnCompletion: true
+ await model.export(
+ action: .removeTimecodeTrack,
+ toFolder: folderURL,
+ revealInFinderOnCompletion: true // only applies to macOS
  )
- isExportProgressShown = false
  } catch {
- model.error = ModelError.exportError(error)
+ model.error = .exportError(error)
  }
  }
 }