Add readme and license

License.md

@@ -0,0 +1,7 @@
+Copyright © 2024 Sami Samhuri, https://samhuri.net <sami@samhuri.net>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Readme.md

@@ -0,0 +1,195 @@
+# Overview
+
+`SJSAssetExportSession` is an alternative to [`AVAssetExportSession`][AV] that lets you provide custom audio and video settings, without dropping down into the world of `AVAssetReader` and `AVAssetWriter`. It has similar capabilites to [SDAVAssetExportSession][SDAV] but the API is completely different, the code is written in Swift, and it's ready for the world of strict concurrency.
+
+[AV]: https://developer.apple.com/documentation/avfoundation/avassetexportsession
+[SDAV]: https://github.com/rs/SDAVAssetExportSession
+
+# Installation
+
+The only way to install this package is with Swift Package Manager (SPM). Please [file a new issue][] or submit a pull-request if you want to use something else.
+
+[file a new issue]: https://github.com/samsonjs/SJSAssetExportSession/issues/new
+
+## Supported Platforms
+
+This package is supported on iOS 17.0+, macOS Sonoma 14.0+, and visionOS 1.3+.
+
+## Xcode
+
+When you're integrating this into an app with Xcode then go to your project's Package Dependencies and enter the URL `https://github.com/samsonjs/SJSAssetExportSession` and then go through the usual flow for adding packages.
+
+## Swift Package Manager (SPM)
+
+When you're integrating this using SPM on its own then add this to your Package.swift file:
+
+```swift
+.package(url: "https://github.com/samsonjs/SJSAssetExportSession.git", .upToNextMajor(from: "1.0"))
+```
+
+# Usage
+
+There are two ways of exporting assets: one using dictionaries for audio and video settings just like with `SDAVAssetExportSession`, and the other using a builder-like API with data structures for commonly used settings.
+
+## The Nice Way
+
+This should be fairly self-explanatory:
+
+```swift
+let sourceURL = URL.documentsDirectory.appending(component: "some-video.mov")
+let sourceAsset = AVURLAsset(url: sourceURL, options: [
+    AVURLAssetPreferPreciseDurationAndTimingKey: true,
+])
+let destinationURL = URL.temporaryDirectory.appending(component: "shiny-new-video.mp4")
+let exporter = ExportSession()
+Task {
+    for await progress in exporter.progressStream {
+        print("Export progress: \(progress)")
+    }
+}
+
+try await exporter.export(
+    asset: sourceAsset,
+    video: .codec(.h264, width: 1280, height: 720),
+    to: destinationURL,
+    as: .mp4
+)
+```
+
+Most of the audio and video configuration is optional which is why there are no audio settings specified here. By default you get AAC with 2 channels at a 44.1 KHz sample rate.
+
+## All Nice Parameters
+
+Here are all of the parameters you can pass into the nice export method:
+
+```swift
+let sourceURL = URL.documentsDirectory.appending(component: "some-video.mov")
+let sourceAsset = AVURLAsset(url: sourceURL, options: [
+    AVURLAssetPreferPreciseDurationAndTimingKey: true,
+])
+let destinationURL = URL.temporaryDirectory.appending(component: "shiny-new-video.mp4")
+let exporter = ExportSession()
+Task {
+    for await progress in exporter.progressStream {
+        print("Export progress: \(progress)")
+    }
+}
+
+let locationMetadata = AVMutableMetadataItem()
+locationMetadata.key = AVMetadataKey.commonKeyLocation.rawValue as NSString
+locationMetadata.keySpace = .common
+locationMetadata.value = "+48.50176+123.34368/" as NSString
+try await exporter.export(
+    asset: sourceAsset,
+    optimizeForNetworkUse: true,
+    metadata: [locationMetadata],
+    timeRange: CMTimeRange(start: .zero, duration: .seconds(1)),
+    audio: .format(.mp3).channels(1).sampleRate(22_050),
+    video: .codec(.h264, width: 1280, height: 720)
+        .fps(24)
+        .bitrate(1_000_000)
+        .color(.sdr),
+    to: destinationURL,
+    as: .mp4
+    )
+```
+
+## The Most Flexible Way
+
+When you need all the control you can get down to the nitty gritty details. This code does the exact same thing as the code above:
+
+```swift
+let sourceURL = URL.documentsDirectory.appending(component: "some-video.mov")
+let sourceAsset = AVURLAsset(url: sourceURL, options: [
+    AVURLAssetPreferPreciseDurationAndTimingKey: true,
+])
+let destinationURL = URL.temporaryDirectory.appending(component: "shiny-new-video.mp4")
+let exporter = ExportSession()
+Task {
+    for await progress in exporter.progressStream {
+        print("Export progress: \(progress)")
+    }
+}
+
+let locationMetadata = AVMutableMetadataItem()
+locationMetadata.key = AVMetadataKey.commonKeyLocation.rawValue as NSString
+locationMetadata.keySpace = .common
+locationMetadata.value = "+48.50176+123.34368/" as NSString
+
+let videoComposition = try await AVMutableVideoComposition.videoComposition(withPropertiesOf: sourceAsset)
+videoComposition.renderSize = CGSize(width: 1280, height: 720)
+videoComposition.sourceTrackIDForFrameTiming = kCMPersistentTrackID_Invalid
+videoComposition.frameDuration = CMTime(value: 600 / 24, timescale: 600) // 24 fps
+videoComposition.colorPrimaries = AVVideoColorPrimaries_ITU_R_709_2
+videoComposition.colorTransferFunction = AVVideoTransferFunction_ITU_R_709_2
+videoComposition.colorYCbCrMatrix = AVVideoYCbCrMatrix_ITU_R_709_2
+try await exporter.export(
+    asset: sourceAsset,
+    optimizeForNetworkUse: true,
+    metadata: [locationMetadata],
+    timeRange: CMTimeRange(start: .zero, duration: .seconds(1)),
+    audioOutputSettings: [
+        AVFormatIDKey: kAudioFormatMPEGLayer3,
+        AVNumberOfChannelsKey: NSNumber(value: 1),
+        AVSampleRateKey: NSNumber(value: 22_050),
+    ],
+    videoOutputSettings: [
+        AVVideoCodecKey: AVVideoCodecType.h264.rawValue,
+        AVVideoCompressionPropertiesKey: [
+            AVVideoProfileLevelKey: AVVideoProfileLevelH264HighAutoLevel,
+            AVVideoAverageBitRateKey: NSNumber(value: 1_000_000),
+        ] as [String: (any Sendable)],
+        AVVideoColorPropertiesKey: [
+            AVVideoColorPrimariesKey: AVVideoColorPrimaries_ITU_R_709_2,
+            AVVideoTransferFunctionKey: AVVideoTransferFunction_ITU_R_709_2,
+            AVVideoYCbCrMatrixKey: AVVideoYCbCrMatrix_ITU_R_709_2,
+        ],
+    ],
+    composition: videoComposition,
+    to: destinationURL,
+    as: .mp4
+)
+```
+
+It's an effective illustration of why the nicer API exists right? You shouldn't have to read through [audio settings][] and [video settings][] just to set the bitrate, and setting the frame rate can be tricky. But when you need this flexibility then it's available for you.
+
+[audio settings]: https://developer.apple.com/documentation/avfoundation/audio_settings
+
+[video settings]: https://developer.apple.com/documentation/avfoundation/video_settings
+
+## Mix and Match
+
+`AudioOutputSettings` and `VideoOutputSettings` have a property named `settingsDictionary` and you can use that to bootstrap your own custom settings.
+
+```swift
+let sourceURL = URL.documentsDirectory.appending(component: "some-video.mov")
+let sourceAsset = AVURLAsset(url: sourceURL, options: [
+    AVURLAssetPreferPreciseDurationAndTimingKey: true,
+])
+let destinationURL = URL.temporaryDirectory.appending(component: "shiny-new-video.mp4")
+let exporter = ExportSession()
+Task {
+    for await progress in exporter.progressStream {
+        print("Export progress: \(progress)")
+    }
+}
+
+var audioSettings = AudioOutputSettings.default.settingsDictionary
+audioSettings[AVVideoAverageBitRateKey] = 65_536
+let videoSettings = VideoOutputSettings
+    .codec(.hevc, width: 1280, height: 720)
+    .settingsDictionary
+try await exporter.export(
+    asset: sourceAsset,
+    audioOutputSettings: audioSettings,
+    videoOutputSettings: videoSettings,
+    to: destinationURL,
+    as: .mp4
+)
+```
+
+# License
+
+Copyright © 2024 Sami Samhuri, https://samhuri.net <sami@samhuri.net>. Released under the terms of the [MIT License][MIT].
+
+[MIT]: https://sjs.mit-license.org

SJSAssetExportSession.xcodeproj/project.pbxproj

@@ -7,6 +7,7 @@
 	objects = {
 
 /* Begin PBXBuildFile section */
+		7B4C031A2C7256760091C5DB /* ReadmeExamples.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7B4C03192C7256760091C5DB /* ReadmeExamples.swift */; };
 		7B7AE3092C36615700DB7391 /* SampleWriter.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7B7AE3082C36615700DB7391 /* SampleWriter.swift */; };
 		7B9867982C6AF57C001353BC /* AVAsset+sending.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7BC5FC8B2C3BB0180090B757 /* AVAsset+sending.swift */; };
 		7B9BC00E2C305D2C00C160C2 /* SJSAssetExportSession.docc in Sources */ = {isa = PBXBuildFile; fileRef = 7B9BC00D2C305D2C00C160C2 /* SJSAssetExportSession.docc */; };
@@ -33,6 +34,9 @@
 /* End PBXContainerItemProxy section */
 
 /* Begin PBXFileReference section */
+		7B4C03172C723EA40091C5DB /* License.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = License.md; sourceTree = "<group>"; };
+		7B4C03182C723F3B0091C5DB /* Readme.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = Readme.md; sourceTree = "<group>"; };
+		7B4C03192C7256760091C5DB /* ReadmeExamples.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ReadmeExamples.swift; sourceTree = "<group>"; };
 		7B7AE3082C36615700DB7391 /* SampleWriter.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SampleWriter.swift; sourceTree = "<group>"; };
 		7B9BC0092C305D2C00C160C2 /* SJSAssetExportSession.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = SJSAssetExportSession.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		7B9BC00C2C305D2C00C160C2 /* SJSAssetExportSession.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = SJSAssetExportSession.h; sourceTree = "<group>"; };
@@ -75,6 +79,8 @@
 		7B9BBFFF2C305D2C00C160C2 = {
 			isa = PBXGroup;
 			children = (
+				7B4C03172C723EA40091C5DB /* License.md */,
+				7B4C03182C723F3B0091C5DB /* Readme.md */,
 				7B9BC00B2C305D2C00C160C2 /* SJSAssetExportSession */,
 				7B9BC0172C305D2C00C160C2 /* SJSAssetExportSessionTests */,
 				7B9BC00A2C305D2C00C160C2 /* Products */,
@@ -108,6 +114,7 @@
 		7B9BC0172C305D2C00C160C2 /* SJSAssetExportSessionTests */ = {
 			isa = PBXGroup;
 			children = (
+				7B4C03192C7256760091C5DB /* ReadmeExamples.swift */,
 				7BC5FC782C3B90F70090B757 /* AutoDestructingURL.swift */,
 				7BC5FC8B2C3BB0180090B757 /* AVAsset+sending.swift */,
 				7BC5FC812C3B9E3D0090B757 /* Resources */,
@@ -246,6 +253,7 @@
 				7B9BC0192C305D2C00C160C2 /* SJSAssetExportSessionTests.swift in Sources */,
 				7BC5FC792C3B90F70090B757 /* AutoDestructingURL.swift in Sources */,
 				7B9867982C6AF57C001353BC /* AVAsset+sending.swift in Sources */,
+				7B4C031A2C7256760091C5DB /* ReadmeExamples.swift in Sources */,
 				7BC5FC772C3B8C5A0090B757 /* SendableWrapper.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;

SJSAssetExportSessionTests/ReadmeExamples.swift

@@ -0,0 +1,142 @@
+//
+//  ReadmeExamples.swift
+//  SJSAssetExportSessionTests
+//
+//  Created by Sami Samhuri on 2024-08-18.
+//
+
+internal import AVFoundation
+@testable import SJSAssetExportSession
+
+private func readmeNiceExample() async throws {
+    let sourceURL = URL.documentsDirectory.appending(component: "some-video.mov")
+    let sourceAsset = AVURLAsset(url: sourceURL, options: [
+        AVURLAssetPreferPreciseDurationAndTimingKey: true,
+    ])
+    let destinationURL = URL.temporaryDirectory.appending(component: "shiny-new-video.mp4")
+    let exporter = ExportSession()
+    Task {
+        for await progress in exporter.progressStream {
+            print("Export progress: \(progress)")
+        }
+    }
+
+    try await exporter.export(
+        asset: sourceAsset,
+        video: .codec(.h264, width: 1280, height: 720),
+        to: destinationURL,
+        as: .mp4
+    )
+}
+
+private func readmeCompleteNiceExample() async throws {
+    let sourceURL = URL.documentsDirectory.appending(component: "some-video.mov")
+    let sourceAsset = AVURLAsset(url: sourceURL, options: [
+        AVURLAssetPreferPreciseDurationAndTimingKey: true,
+    ])
+    let destinationURL = URL.temporaryDirectory.appending(component: "shiny-new-video.mp4")
+    let exporter = ExportSession()
+    Task {
+        for await progress in exporter.progressStream {
+            print("Export progress: \(progress)")
+        }
+    }
+
+    let locationMetadata = AVMutableMetadataItem()
+    locationMetadata.key = AVMetadataKey.commonKeyLocation.rawValue as NSString
+    locationMetadata.keySpace = .common
+    locationMetadata.value = "+48.50176+123.34368/" as NSString
+    try await exporter.export(
+        asset: sourceAsset,
+        optimizeForNetworkUse: true,
+        metadata: [locationMetadata],
+        timeRange: CMTimeRange(start: .zero, duration: .seconds(1)),
+        audio: .format(.mp3).channels(1).sampleRate(22_050),
+        video: .codec(.h264, width: 1280, height: 720)
+            .fps(24)
+            .bitrate(1_000_000)
+            .color(.sdr),
+        to: destinationURL,
+        as: .mp4
+    )
+}
+
+private func readmeFlexibleExample() async throws {
+    let sourceURL = URL.documentsDirectory.appending(component: "some-video.mov")
+    let sourceAsset = AVURLAsset(url: sourceURL, options: [
+        AVURLAssetPreferPreciseDurationAndTimingKey: true,
+    ])
+    let destinationURL = URL.temporaryDirectory.appending(component: "shiny-new-video.mp4")
+    let exporter = ExportSession()
+    Task {
+        for await progress in exporter.progressStream {
+            print("Export progress: \(progress)")
+        }
+    }
+
+    let locationMetadata = AVMutableMetadataItem()
+    locationMetadata.key = AVMetadataKey.commonKeyLocation.rawValue as NSString
+    locationMetadata.keySpace = .common
+    locationMetadata.value = "+48.50176+123.34368/" as NSString
+
+    let videoComposition = try await AVMutableVideoComposition.videoComposition(withPropertiesOf: sourceAsset)
+    videoComposition.renderSize = CGSize(width: 1280, height: 720)
+    videoComposition.sourceTrackIDForFrameTiming = kCMPersistentTrackID_Invalid
+    videoComposition.frameDuration = CMTime(value: 600 / 24, timescale: 600) // 24 fps
+    videoComposition.colorPrimaries = AVVideoColorPrimaries_ITU_R_709_2
+    videoComposition.colorTransferFunction = AVVideoTransferFunction_ITU_R_709_2
+    videoComposition.colorYCbCrMatrix = AVVideoYCbCrMatrix_ITU_R_709_2
+    try await exporter.export(
+        asset: sourceAsset,
+        optimizeForNetworkUse: true,
+        metadata: [locationMetadata],
+        timeRange: CMTimeRange(start: .zero, duration: .seconds(1)),
+        audioOutputSettings: [
+            AVFormatIDKey: kAudioFormatMPEGLayer3,
+            AVNumberOfChannelsKey: NSNumber(value: 1),
+            AVSampleRateKey: NSNumber(value: 22_050),
+        ],
+        videoOutputSettings: [
+            AVVideoCodecKey: AVVideoCodecType.h264.rawValue,
+            AVVideoCompressionPropertiesKey: [
+                AVVideoProfileLevelKey: AVVideoProfileLevelH264HighAutoLevel,
+                AVVideoAverageBitRateKey: NSNumber(value: 1_000_000),
+            ] as [String: (any Sendable)],
+            AVVideoColorPropertiesKey: [
+                AVVideoColorPrimariesKey: AVVideoColorPrimaries_ITU_R_709_2,
+                AVVideoTransferFunctionKey: AVVideoTransferFunction_ITU_R_709_2,
+                AVVideoYCbCrMatrixKey: AVVideoYCbCrMatrix_ITU_R_709_2,
+            ],
+        ],
+        composition: videoComposition,
+        to: destinationURL,
+        as: .mp4
+    )
+}
+
+private func readmeMixAndMatchExample() async throws {
+    let sourceURL = URL.documentsDirectory.appending(component: "some-video.mov")
+    let sourceAsset = AVURLAsset(url: sourceURL, options: [
+        AVURLAssetPreferPreciseDurationAndTimingKey: true,
+    ])
+    let destinationURL = URL.temporaryDirectory.appending(component: "shiny-new-video.mp4")
+    let exporter = ExportSession()
+    Task {
+        for await progress in exporter.progressStream {
+            print("Export progress: \(progress)")
+        }
+    }
+
+    var audioSettings = AudioOutputSettings.default.settingsDictionary
+    audioSettings[AVVideoAverageBitRateKey] = 65_536
+    let videoSettings = VideoOutputSettings
+        .codec(.hevc, width: 1280, height: 720)
+        .settingsDictionary
+    try await exporter.export(
+        asset: sourceAsset,
+        audioOutputSettings: audioSettings,
+        videoOutputSettings: videoSettings,
+        to: destinationURL,
+        as: .mp4
+    )
+}