Merge pull request #3 from orchetect/main

Cleanup and Minor Refactors

Author: orchetect

Package.swift

@@ -1,24 +1,21 @@
 // swift-tools-version: 6.0
-// The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription
 
 let package = Package(
     name: "SwiftAudioFileConverter",
-    platforms: [.macOS(.v13)],
+    platforms: [.macOS(.v13), .iOS(.v14)],
     products: [
-        // Products define the executables and libraries a package produces, making them visible to other packages.
         .library(
             name: "SwiftAudioFileConverter",
-            targets: ["SwiftAudioFileConverter"]),
+            targets: ["SwiftAudioFileConverter"]
+        )
     ],
     dependencies: [
-    .package(url: "https://github.com/Phisto/swift-lame.git", .upToNextMajor(from: "3.100.0")),
-    .package(url: "https://github.com/sbooth/CFLAC.git", from: "1.3.2")
+        .package(url: "https://github.com/Phisto/swift-lame.git", .upToNextMajor(from: "3.100.0")),
+        .package(url: "https://github.com/sbooth/CFLAC.git", from: "1.3.2")
     ],
     targets: [
-        // Targets are the basic building blocks of a package, defining a module or a test suite.
-        // Targets can depend on other targets in this package and products from dependencies.
         .target(
             name: "SwiftAudioFileConverter",
             dependencies: [
@@ -31,6 +28,6 @@ let package = Package(
             name: "SwiftAudioFileConverterTests",
             dependencies: ["SwiftAudioFileConverter"],
             swiftSettings: [.interoperabilityMode(.Cxx)]
-        ),
+        )
     ]
 )

README.md

@@ -1 +1,3 @@
 # SwiftAudioFileConverter
+
+Audio file conversion utilities.

Sources/SwiftAudioFileConverter/AudioFileSettings/AudioFileSettings.swift

@@ -8,25 +8,39 @@
 import Foundation
 
 public struct AudioFileSettings {
-    let sampleRate: SampleRate
-    let bitDepth: BitDepth
-    let fileFormat: FileFormat
-    let channelFormat: ChannelFormat
-    
-    var isPCM: Bool {
-        return fileFormat == .aiff || fileFormat == .wav
-    }
+    public let sampleRate: SampleRate
+    public let bitDepth: BitDepth
+    public let fileFormat: FileFormat
+    public let channelFormat: ChannelFormat
 
     public init(sampleRate: SampleRate, bitDepth: BitDepth, fileFormat: FileFormat, channelFormat: ChannelFormat) throws {
         self.sampleRate = sampleRate
         self.bitDepth = bitDepth
         self.fileFormat = fileFormat
         self.channelFormat = channelFormat
 
-        if !isPCM && bitDepth != .float32 {
+        if !isPCM, bitDepth != .float32 {
             throw SwiftAudioFileConverterError.invalidAudioFileSettings(self)
         }
     }
 }
 
-extension AudioFileSettings: Sendable {}
+extension AudioFileSettings: Equatable { }
+
+extension AudioFileSettings: Hashable { }
+
+extension AudioFileSettings: Sendable { }
+
+extension AudioFileSettings: CustomStringConvertible {
+    public var description: String {
+        "\(fileFormat) \(channelFormat) @ \(sampleRate)/\(bitDepth)"
+    }
+}
+
+// MARK: - Properties
+
+extension AudioFileSettings {
+    public var isPCM: Bool {
+        fileFormat == .aiff || fileFormat == .wav
+    }
+}

Sources/SwiftAudioFileConverter/AudioFileSettings/BitDepth.swift

@@ -4,13 +4,32 @@
 //
 //  Created by Devin Roth on 2025-04-03.
 //
-import Foundation
 
+import Foundation
 
 public enum BitDepth {
     case int16
     case int24
     case float32
 }
-extension BitDepth: Sendable {}
-extension BitDepth: CaseIterable {}
+
+extension BitDepth: Equatable { }
+
+extension BitDepth: Hashable { }
+
+extension BitDepth: Sendable { }
+
+extension BitDepth: CaseIterable { }
+
+extension BitDepth: CustomStringConvertible {
+    public var description: String {
+        switch self {
+        case .int16:
+            "16-bit Int"
+        case .int24:
+            "24-bit Int"
+        case .float32:
+            "32-bit Float"
+        }
+    }
+}

Sources/SwiftAudioFileConverter/AudioFileSettings/ChannelFormat.swift

@@ -5,10 +5,28 @@
 //  Created by Devin Roth on 2025-04-03.
 //
 
+import Foundation
 
 public enum ChannelFormat {
     case mono
     case stereo
 }
-extension ChannelFormat: Sendable {}
-extension ChannelFormat: CaseIterable {}
+
+extension ChannelFormat: Equatable { }
+
+extension ChannelFormat: Hashable { }
+
+extension ChannelFormat: CaseIterable { }
+
+extension ChannelFormat: Sendable { }
+
+extension ChannelFormat: CustomStringConvertible {
+    public var description: String {
+        switch self {
+        case .mono:
+            "Mono"
+        case .stereo:
+            "Stereo"
+        }
+    }
+}

Sources/SwiftAudioFileConverter/AudioFileSettings/FileFormat.swift

@@ -4,8 +4,8 @@
 //
 //  Created by Devin Roth on 2025-04-03.
 //
-import Foundation
 
+import Foundation
 
 public enum FileFormat: String {
     case aac
@@ -15,5 +15,11 @@ public enum FileFormat: String {
     case flac
     case alac = "m4a"
 }
-extension FileFormat: Sendable {}
-extension FileFormat: CaseIterable {}
+
+extension FileFormat: Equatable { }
+
+extension FileFormat: Hashable { }
+
+extension FileFormat: Sendable { }
+
+extension FileFormat: CaseIterable { }

Sources/SwiftAudioFileConverter/AudioFileSettings/SampleRate.swift

@@ -4,8 +4,8 @@
 //
 //  Created by Devin Roth on 2025-04-03.
 //
-import Foundation
 
+import Foundation
 
 public enum SampleRate: Double {
     case kHz8 = 8000
@@ -14,5 +14,17 @@ public enum SampleRate: Double {
     case kHz44 = 44100
     case kHz48 = 48000
 }
-extension SampleRate: Sendable {}
-extension SampleRate: CaseIterable {}
+
+extension SampleRate: Equatable { }
+
+extension SampleRate: Hashable { }
+
+extension SampleRate: Sendable { }
+
+extension SampleRate: CaseIterable { }
+
+extension SampleRate: CustomStringConvertible {
+    public var description: String {
+        "\(rawValue)Hz"
+    }
+}

Sources/SwiftAudioFileConverter/Errors/CoreAudioError.swift

@@ -4,10 +4,11 @@
 //
 //  Created by Devin Roth on 2025-04-03.
 //
+
 import Foundation
 import AudioToolbox
 
-public enum CoreAudioError {
+public enum CoreAudioError: LocalizedError {
     case formatNotSupported
     case unspecified
     case unsupportedProperty
@@ -16,8 +17,7 @@ public enum CoreAudioError {
     case unknownFormat
     case unknownError(OSStatus)
 
-    init(status: OSStatus) {
-        
+    public init(status: OSStatus) {
         switch status {
         case kAudioFormatUnsupportedDataFormatError:
             self = .formatNotSupported
@@ -34,9 +34,32 @@ public enum CoreAudioError {
         default:
             self = .unknownError(status)
         }
-        
-        
     }
 }
 
-extension CoreAudioError: Sendable {}
+extension CoreAudioError: Equatable { }
+
+extension CoreAudioError: Hashable { }
+
+extension CoreAudioError: Sendable { }
+
+extension CoreAudioError {
+    public var errorDescription: String? {
+        switch self {
+        case .formatNotSupported:
+            "Format not supported."
+        case .unspecified:
+            "Unspecified error."
+        case .unsupportedProperty:
+            "Unsupported property."
+        case .badPropertySize:
+            "Bad property size."
+        case .badSpecifierSize:
+            "Bad specifier size."
+        case .unknownFormat:
+            "Unknown format."
+        case let .unknownError(osStatus):
+            "Unknown error (OSStatus \(osStatus))"
+        }
+    }
+}

Sources/SwiftAudioFileConverter/Errors/SwiftAudioFileConverterError.swift

@@ -4,9 +4,10 @@
 //
 //  Created by Devin Roth on 2025-04-03.
 //
+
 import Foundation
 
-public enum SwiftAudioFileConverterError: Error {
+public enum SwiftAudioFileConverterError: LocalizedError {
     case invalidAudioFileSettings(AudioFileSettings)
     case unsupportedAudioFileExtension(URL)
     case audioFileExtensionSettingsMismatch(URL, AudioFileSettings)
@@ -18,3 +19,36 @@ public enum SwiftAudioFileConverterError: Error {
     case coreAudioError(CoreAudioError)
     case flacConversionUnknownError
 }
+
+extension SwiftAudioFileConverterError: Equatable { }
+
+extension SwiftAudioFileConverterError: Hashable { }
+
+extension SwiftAudioFileConverterError: Sendable { }
+
+extension SwiftAudioFileConverterError {
+    public var errorDescription: String? {
+        switch self {
+        case let .invalidAudioFileSettings(audioFileSettings):
+            "Invalid audio file settings. \(audioFileSettings)"
+        case let .unsupportedAudioFileExtension(url):
+            "Unsupported audio file extension (\(url.path))"
+        case let .audioFileExtensionSettingsMismatch(url, audioFileSettings):
+            "Audio file extension settings mismatch. (\(url.path)) \(audioFileSettings)"
+        case let .fileDoesNotExist(url):
+            "File does not exist. (\(url.path))"
+        case let .fileIsNotReadable(url):
+            "File is not readable. (\(url.path))"
+        case let .unableToOpenFile(url):
+            "Unable to open file. (\(url.path))"
+        case let .fileIsNotWritable(url):
+            "File is not writable. (\(url.path))"
+        case let .unsupportedConversion(fileFormat):
+            "Unsupported conversion: \(fileFormat)"
+        case let .coreAudioError(coreAudioError):
+            "Core Audio error: \(coreAudioError)"
+        case .flacConversionUnknownError:
+            "Unknown FLAC conversion error."
+        }
+    }
+}