Add mac native support, tests, clean up

Author: garynewby

.github/workflows/build.yml

@@ -8,9 +8,15 @@ on:
     branches: [ master ]
 
 jobs:
-  build:
+  build-ios:
     runs-on: macos-latest
     steps:
     - uses: actions/checkout@master
     - name: Start xcodebuild build
       run: xcodebuild -configuration Debug clean build test -project Example/Example.xcodeproj -scheme Example -destination "platform=iOS Simulator,name=iPhone 16"
+  build-macos:
+    runs-on: macos-latest
+    steps:
+    - uses: actions/checkout@master
+    - name: Start xcodebuild macOS build
+      run: xcodebuild -configuration Debug clean build -project Example/Example.xcodeproj -scheme Example -destination "platform=macOS"

.swiftpm/xcode/xcshareddata/xcschemes/PianoKeyboardTests.xcscheme

@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   LastUpgradeVersion = "2630"
+   version = "1.7">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES"
+      buildArchitectures = "Automatic">
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      shouldAutocreateTestPlan = "YES">
+      <Testables>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "PianoKeyboardTests"
+               BuildableName = "PianoKeyboardTests"
+               BlueprintName = "PianoKeyboardTests"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </TestableReference>
+      </Testables>
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>

Example/Example.xcodeproj/project.pbxproj

@@ -306,14 +306,18 @@
 				INFOPLIST_KEY_UILaunchScreen_Generation = YES;
 				INFOPLIST_KEY_UISupportedInterfaceOrientations_iPad = "UIInterfaceOrientationPortrait UIInterfaceOrientationPortraitUpsideDown UIInterfaceOrientationLandscapeLeft UIInterfaceOrientationLandscapeRight";
 				INFOPLIST_KEY_UISupportedInterfaceOrientations_iPhone = "UIInterfaceOrientationPortrait UIInterfaceOrientationLandscapeLeft UIInterfaceOrientationLandscapeRight";
-				IPHONEOS_DEPLOYMENT_TARGET = 15;
+				IPHONEOS_DEPLOYMENT_TARGET = 17;
 				LD_RUNPATH_SEARCH_PATHS = (
 					"$(inherited)",
 					"@executable_path/Frameworks",
 				);
-				MARKETING_VERSION = 1.0;
+				MACOSX_DEPLOYMENT_TARGET = 14.0;
+				MARKETING_VERSION = 1.1;
 				PRODUCT_BUNDLE_IDENTIFIER = com.mellowmuse.Example;
 				PRODUCT_NAME = "$(TARGET_NAME)";
+				SDKROOT = auto;
+				SUPPORTED_PLATFORMS = "iphoneos iphonesimulator macosx";
+				SUPPORTS_MAC_DESIGNED_FOR_IPHONE_IPAD = NO;
 				SWIFT_EMIT_LOC_STRINGS = YES;
 				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
@@ -336,14 +340,18 @@
 				INFOPLIST_KEY_UILaunchScreen_Generation = YES;
 				INFOPLIST_KEY_UISupportedInterfaceOrientations_iPad = "UIInterfaceOrientationPortrait UIInterfaceOrientationPortraitUpsideDown UIInterfaceOrientationLandscapeLeft UIInterfaceOrientationLandscapeRight";
 				INFOPLIST_KEY_UISupportedInterfaceOrientations_iPhone = "UIInterfaceOrientationPortrait UIInterfaceOrientationLandscapeLeft UIInterfaceOrientationLandscapeRight";
-				IPHONEOS_DEPLOYMENT_TARGET = 15;
+				IPHONEOS_DEPLOYMENT_TARGET = 17;
 				LD_RUNPATH_SEARCH_PATHS = (
 					"$(inherited)",
 					"@executable_path/Frameworks",
 				);
-				MARKETING_VERSION = 1.0;
+				MACOSX_DEPLOYMENT_TARGET = 14.0;
+				MARKETING_VERSION = 1.1;
 				PRODUCT_BUNDLE_IDENTIFIER = com.mellowmuse.Example;
 				PRODUCT_NAME = "$(TARGET_NAME)";
+				SDKROOT = auto;
+				SUPPORTED_PLATFORMS = "iphoneos iphonesimulator macosx";
+				SUPPORTS_MAC_DESIGNED_FOR_IPHONE_IPAD = NO;
 				SWIFT_EMIT_LOC_STRINGS = YES;
 				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = "1,2";

Example/Example/AudioEngine.swift

@@ -33,19 +33,15 @@ class AudioEngine {
         delay.feedback = 75.0
         delay.lowPassCutoff = 16000.0
 
+#if os(iOS)
         let audioSession = AVAudioSession.sharedInstance()
-
-        do {
-            try AVAudioSession.sharedInstance().setCategory(.playback)
-        } catch {
-            print("Error: AudioSession couldn't set category")
-        }
-
         do {
+            try audioSession.setCategory(.playback)
             try audioSession.setActive(true)
         } catch {
-            print("Error: AudioSession couldn't set category active")
+            print("Error: AudioSession configuration failed")
         }
+#endif
 
         if engine.isRunning {
             print("Audio engine already running")

Example/Example/ContentView.swift

@@ -9,8 +9,9 @@ import SwiftUI
 import PianoKeyboard
 
 struct ContentView: View {
-    @ObservedObject private var viewModel: PianoKeyboardViewModel
-    @State var styleIndex: Int
+
+    @Bindable private var viewModel: PianoKeyboardViewModel
+    @State private var styleIndex: Int
 
     private let audioEngine: AudioEngine
 
@@ -25,91 +26,73 @@ struct ContentView: View {
     }
 
     var body: some View {
-        VStack(spacing: 0) {
-            ZStack(alignment: .bottom) {
-                Rectangle()
-                    .fill(
-                        LinearGradient(gradient: Gradient(stops: [
-                            Gradient.Stop(color: Color(white: 0.2), location: 0),
-                                Gradient.Stop(color: Color(white: 0.3), location: 0.96),
-                                Gradient.Stop(color: .black, location: 1),
-                            ]), startPoint: .top, endPoint: .bottom)
-                    )
-                    .shadow(radius: 8)
+        GeometryReader { geometry in
+            VStack(spacing: 0) {
+                ZStack(alignment: .bottom) {
+                    Rectangle()
+                        .fill(
+                            LinearGradient(gradient: Gradient(stops: [
+                                Gradient.Stop(color: Color(white: 0.2), location: 0),
+                                    Gradient.Stop(color: Color(white: 0.3), location: 0.96),
+                                    Gradient.Stop(color: .black, location: 1),
+                                ]), startPoint: .top, endPoint: .bottom)
+                        )
+                        .shadow(radius: 8)
 
-                HStack(alignment: .top) {
-                    VStack(alignment: .leading, spacing: 10) {
-                        Stepper("Keys: \(viewModel.numberOfKeys)") {
-                            viewModel.numberOfKeys += 1
-                        } onDecrement: {
-                            viewModel.numberOfKeys -= 1
-                        }
-                        .font(.subheadline.bold())
-                        .foregroundColor(.white)
+                    VStack(alignment: .trailing) {
+                        HStack(spacing: 30) {
+                            Stepper("Keys") {
+                                viewModel.numberOfKeys += 1
+                            } onDecrement: {
+                                viewModel.numberOfKeys -= 1
+                            }
 
-                        Stepper("Style:", value: $styleIndex, in: 0...2)
-                            .font(.subheadline.bold())
-                            .foregroundColor(.white)
-                            .tint(.blue)
+                            Stepper("Style", value: $styleIndex, in: 0...2)
 
-                    }
-                    .padding(EdgeInsets(top: 0, leading: 20, bottom: 30, trailing: 0))
-                    .frame(width: 200)
+                            Toggle("Latch", isOn: $viewModel.latch)
+                                .toggleStyle(.switch)
+                                .tint(.blue)
 
+                            HStack {
+                                Text("Notes:")
+                                Text("\(viewModel.keysPressed.joined(separator: ", "))")
+                            }
 
-                    VStack {
-                        Toggle("Latch:", isOn: $viewModel.latch)
-                            .font(.subheadline.bold())
-                            .foregroundColor(.white)
-
-                        HStack {
-                            Text("Notes:")
-                                .font(.subheadline.bold())
-                                .foregroundStyle(.white)
                             Spacer()
-                            Text("\(viewModel.keysPressed.joined(separator: ", "))")
-                                .font(.subheadline.bold())
-                                .foregroundStyle(.white)
                         }
-                    }
-                    .padding(EdgeInsets(top: 0, leading: 20, bottom: 30, trailing: 0))
-                    .frame(width: 200)
+                        .foregroundStyle(.white)
+                        .padding(20)
 
-                    Spacer()
+                        Spacer()
 
-                    Text("PianoKeyboard")
-                        .font(.title2.bold())
-                        .foregroundColor(.white)
-                        .padding(30)
+                        Text("PianoKeyboard")
+                            .font(.title.bold())
+                            .foregroundColor(.white)
+                            .padding(20)
+                    }
                 }
-            }
-            .frame(height: UIScreen.main.bounds.height * 0.45)
+                .frame(height: geometry.size.height * 0.45)
 
-            if styleIndex == 0 {
-                PianoKeyboardView(viewModel: viewModel, style: ClassicStyle(sfKeyWidthMultiplier: 0.55))
-                    .frame(height: UIScreen.main.bounds.height * 0.55)
-            } else if styleIndex == 1 {
-                PianoKeyboardView(viewModel: viewModel, style: ModernStyle())
-                    .frame(height: UIScreen.main.bounds.height * 0.55)
-            } else if styleIndex == 2{
-                PianoKeyboardView(viewModel: viewModel, style: CustomStyle(showLabels: true))
-                    .frame(height: UIScreen.main.bounds.height * 0.55)
+                if styleIndex == 0 {
+                    PianoKeyboardView(viewModel: viewModel, style: ClassicStyle(sfKeyWidthMultiplier: 0.55))
+                        .frame(height: geometry.size.height * 0.55)
+                } else if styleIndex == 1 {
+                    PianoKeyboardView(viewModel: viewModel, style: ModernStyle())
+                        .frame(height: geometry.size.height * 0.55)
+                } else if styleIndex == 2{
+                    PianoKeyboardView(viewModel: viewModel, style: CustomStyle(showLabels: true))
+                        .frame(height: geometry.size.height * 0.55)
+                }
             }
+            .background(.black)
         }
-        .background(.black)
         .onAppear() {
             viewModel.delegate = audioEngine
             audioEngine.start()
         }
     }
 }
 
-struct ContentView_Previews: PreviewProvider {
-    static var previews: some View {
-        NavigationView {
-            ContentView()
-        }
-        .navigationViewStyle(.stack)
-        .previewInterfaceOrientation(.landscapeLeft)
-    }
+#Preview(traits: .landscapeRight) {
+    ContentView()
 }

Package.swift

@@ -4,7 +4,8 @@ import PackageDescription
 let package = Package(
     name: "PianoKeyboard",
     platforms: [
-        .iOS("15.0")
+        .iOS("17.0"),
+        .macOS("14.0")
     ],
     products: [
         .library(

README.md

@@ -3,7 +3,7 @@ PianoKeyboard
 
 [![Build and test](https://github.com/garynewby/PianoKeyboard/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/garynewby/PianoKeyboard/actions/workflows/build.yml)
 
-A SwiftUI piano keyboard view for iPhone and iPad. 
+A SwiftUI piano keyboard view for iPhone, iPad, and macOS.
 
 Easily customisable styles, configurable
 - Number of keys
@@ -43,6 +43,13 @@ func pianoKeyUp(_ keyNumber: Int) {
 ### Requirements
 
 - Swift 5, SwiftUI
+- iOS 15.0+
+- macOS 12.0+
+
+### Platform notes
+
+- iOS and iPadOS use native multi-touch input.
+- macOS uses native AppKit pointer/trackpad input.
 
 ## Author
 

Source/PianoKeyViewModel.swift

@@ -10,6 +10,7 @@ import Foundation
 public struct PianoKeyViewModel {
     let keyIndex: Int
     let noteOffset: Int
+    
     public var touchDown = false
     public var latched = false
 

Source/PianoKeyboardView.swift

@@ -8,7 +8,7 @@
 import SwiftUI
 
 public struct PianoKeyboardView<T: KeyboardStyle>: View {
-    @ObservedObject private var viewModel: PianoKeyboardViewModel
+    private var viewModel: PianoKeyboardViewModel
     var style: T
 
     public init(