\n \n\n"
},
{
"path": "README.md",
"content": "\n ![\"Piano\"](\"https://user-images.githubusercontent.com/7799382/30356431-dbba9920-97ed-11e7-8f2b-a5b5ba0e7682.png\")
\n
\n\n\n ![\"Platform:](\"https://user-images.githubusercontent.com/7799382/30309920-bcdb85ec-9742-11e7-96fc-af8155f4712d.png\")
\n ![\"Language:](\"https://user-images.githubusercontent.com/7799382/30309908-ace5d886-9742-11e7-85ea-8d4e5f2af2ac.png\")
\n ![\"CocoaPods](\"https://user-images.githubusercontent.com/7799382/33073452-cd78293e-ce77-11e7-8b39-8a1565616814.png\")
\n ![\"Carthage](\"https://user-images.githubusercontent.com/7799382/30309900-9fc15d2e-9742-11e7-91fd-31bb1226db90.png\")
\n ![\"License:](\"https://user-images.githubusercontent.com/7799382/30309910-adef2b38-9742-11e7-8140-d05534dd92a5.png\")
\n
\n\n\n Installation\n • Usage\n • Documentation\n • Why I Built Piano\n • License\n • Contribute\n • Questions?\n • Credits\n
\n\nPiano is a **convenient** and **easy-to-use** wrapper around the `AVFoundation` and `UIHapticFeedback` frameworks, leveraging the full capabilities of the **Taptic Engine**, while following strict Apple guidelines to **preserve battery life**. Ultimately, Piano allows you, the composer, to conduct masterful symphonies of sounds and vibrations, and create a more immersive, usable and meaningful user experience in your app or game.\n\n\n## Compatibility\n\nPiano requires **iOS 10+** and is compatible with **Swift 4.2** projects.\n\n## Installation\n\n* Installation for CocoaPods:\n\n```ruby\nplatform :ios, '10.0'\ntarget 'ProjectName' do\nuse_frameworks!\n\n pod 'Piano', '~> 1.8'\n\nend\n```\n*(if you run into problems, `pod repo update` and try again)*\n\n* Installation for Carthage:\n\n ```ruby\n github \"saoudrizwan/Piano\"\n ```\n *(make sure Xcode 10 is [set as your system's default Xcode](https://stackoverflow.com/a/28901378/3502608) before using CocoaPods or Carthage with Swift 4 frameworks)*\n\n* Or embed the Piano framework into your project\n\nAnd `import Piano` in the files you'd like to use it.\n\n## Usage\n\nUsing Piano is simple.\n```swift\nlet symphony: [Piano.Note] = [\n .sound(.asset(name: \"acapella\")),\n .hapticFeedback(.impact(.light)),\n .waitUntilFinished,\n .hapticFeedback(.impact(.heavy)),\n .wait(0.2),\n .sound(.system(.chooChoo))\n]\n\nPiano.play(symphony)\n```\n... or better yet:\n```swift\n🎹.play([\n .sound(.asset(name: \"acapella\"))\n ])\n```\nOptionally add a completion block to be called when all the notes are finished playing:\n```swift\n🎹.play([\n .sound(.asset(name: \"acapella\"))\n]) {\n // ...\n}\n```\nOr cancel the currently playing symphony:\n```swift\n🎹.cancel()\n```\n\nIn the background, each note has an internal completion block, so you can add a `.waitUntilFinished` note that tells Piano to not play the next note until the previous note is done playing. This is useful for creating patterns of custom haptic feedback, besides the ones Apple predefined. This is also great for creating complex combinations of sound effects and vibrations.\n\n### Notes\n\n#### `.sound(Audio)`\nPlays an audio file.\n\n|Audio | |\n|------------ | ------------- |\n|`.asset(name: String)` | Name of asset in any .xcassets catalogs. It's recommended to add your sound files to Asset Catalogs instead of as standalone files to your main bundle.|\n|`.file(name: String, extension: String)` | Retrieves a file from the main bundle. For example a file named `Beep.wav` would be accessed with `.file(name: \"Beep\", extension: \"wav\")`.|\n|`.url(URL)` | This only works for file URLs, not network URLs.|\n|`.system(SystemSound)` | Predefined system sounds in every iPhone. [See all available options here](https://github.com/saoudrizwan/Piano/blob/master/Sources/SystemSound.swift). |\n\n#### `.vibration(Vibration)`\nPlays standard vibrations available on all models of the iPhone.\n\n|Vibration | |\n|------------ | -------------|\n|`.default` | Basic 1-second vibration |\n|`.alert` | Two short consecutive vibrations |\n\n#### `.tapticEngine(TapticEngine)`\nPlays Taptic Engine vibrations available on the iPhone 6S and above.\n\n|TapticEngine | |\n| ------------ | ------------- |\n|`.peek` | One weak boom |\n|`.pop` | One strong boom |\n|`.cancelled` | Three sequential weak booms |\n|`.tryAgain` | One weak boom then one strong boom |\n|`.failed` | Three sequential strong booms |\n\n#### `.hapticFeedback(HapticFeedback)`\nPlays Taptic Engine Haptic Feedback available on the iPhone 7 and above.\n\n|HapticFeedback | | |\n|------------ | ------------- |------------- |\n|`.notification(Notification)` | **Notification** | Communicate that a task or action has succeeded, failed, or produced a warning of some kind. |\n| | `.success` | Indicates that a task or action has completed successfully. |\n| | `.warning` | Indicates that a task or action has produced a warning. |\n| | `.failure` | Indicates that a task or action has failed. |\n|`.impact(Impact)` | **Impact** | Indicates that an impact has occurred. For example, you might trigger impact feedback when a user interface object collides with something or snaps into place. |\n| | `.light` | Provides a physical metaphor representing a collision between small, light user interface elements.|\n| | `.medium` | Provides a physical metaphor representing a collision between moderately sized user interface elements.|\n| | `.heavy` | Provides a physical metaphor representing a collision between large, heavy user interface elements.|\n|`.selection` | | Indicates that the selection is actively changing. For example, the user feels light taps while scrolling a picker wheel.|\n\nSee: [Apple's Guidelines for using Haptic Feedback](https://developer.apple.com/ios/human-interface-guidelines/user-interaction/feedback/)\n\n#### `.waitUntilFinished`\nTells Piano to wait until the previous note is done playing before playing the next note.\n\n#### `.wait(TimeInterval)`\nTells Piano to wait a given duration before playing the next note.\n\n### Device Capabilities\n\n* The iPhone 6S and 6S Plus carry the first generation of Taptic Engine which has a few \"haptic\" vibration patterns, which you can play with Piano using the `.tapticEngine()` notes.\n\n* The iPhone 7 and above carry the latest version of the Taptic Engine which supports the iOS 10 Haptic Feedback frameworks, allowing you to select from many more vibration types. You can play these vibrations using the `.hapticFeedback()` notes.\n\n* All versions of the iPhone can play the `.vibration()` notes.\n\nPiano also includes a useful extension for `UIDevice` to check if the user's device has a Taptic Engine and if it supports Haptic Feedback. This extension is especially useful for creating symphonies for all devices:\n```swift\nif UIDevice.current.hasHapticFeedback {\n // use .hapticFeedback(HapticFeedback) notes\n} else if UIDevice.current.hasTapticEngine {\n // use .tapticEngine(TapticEngine) notes\n} else {\n // use .vibration(Vibration) notes\n}\n```\n**Note:** This extension does not work on simulators, it will always return false.\n\n### Taptic Engine Guide\n\nApple's [guide over the Haptic Feedback framework](https://developer.apple.com/documentation/uikit/uifeedbackgenerator) is very clear about using the Taptic Engine appropriately in order to prevent draining the user's device's battery life. Piano was built with this in mind, and handles most cases as efficiently as possible. But you can help preserve battery life and reduce latency further by calling these helper methods based on your specific needs.\n\n#### 1. Wake up the Taptic Engine\n```swift\nPiano.wakeTapticEngine()\n```\nThis initializes and allocates the Haptic Feedback framework and essentially \"wakes up\" the Taptic Engine, as it is normally in an idle state. A good place to put this is at the begin state of a gesture or action, in anticipation of playing a `.hapticFeedback()` note.\n\n#### 2. Prepare the Taptic Engine\n\n```swift\nPiano.prepareTapticEngine()\n```\nThis tells the Taptic Engine to prepare itself before creating any feedback to reduce latency when triggering feedback.\n\nFrom Apple's [documentation](https://developer.apple.com/documentation/uikit/uifeedbackgenerator):\n> This is particularly important when trying to match feedback to sound or visual cues. To preserve power, the Taptic Engine stays in this prepared state for only a short period of time (on the order of seconds), or until you next trigger feedback. Think about when and where you can best prepare your generators. If you call prepare and then immediately trigger feedback, the system won’t have enough time to get the Taptic Engine into the prepared state, and you may not see a reduction in latency. On the other hand, if you call prepare too early, the Taptic Engine may become idle again before you trigger feedback.\n\ntl;dr A good place to put this is right after calling `.wakeTapticEngine()`, usually at the beginning of a gesture or action, in anticipation of playing a `.hapticFeedback()` note.\n\n#### 3. Put the Taptic Engine back to Sleep\n```swift\nPiano.putTapticEngineToSleep()\n```\nOnce we know we're done using the Taptic Engine, we can deallocate the Haptic Feedback framework, returning the Taptic Engine to its idle state. A good place to put this is at the end of a finished, cancelled, or failed gesture or action.\n\n#### But you don't have to.\nPiano automatically wakes and prepares the Taptic Engine when you call `.play([ ... ])` if it includes a `.hapticFeedback()` note, and returns the Taptic Engine back to sleep when the notes are done playing.\n\n### The Example App\n\nThe [example app](https://github.com/saoudrizwan/Piano/tree/master/Example) is a great place to get started. It's designed as a playground for you to compose and test out your own symphonies of sounds and vibrations.\n\n\n![\"Piano\"](\"https://user-images.githubusercontent.com/7799382/30370416-613f985a-982c-11e7-8646-33f1efb55d90.png\")
\n
\n\nYou can even drag and drop your own sound files into the project and tweak the code a bit to see how your own sounds can work alongside the Taptic Engine. To add your own sound file, simply drag it into `Sounds.xcassets`, name it accordingly, then edit the `cellData` property in `ViewController.swift` (Scroll down to `case 7` in `cellData`, or look for \"Add your own sound assets here...\" in the Jump Bar using `Ctrl + 6`).\n\n## Documentation\nOption + click on any of Piano's methods or notes for detailed documentation.\n![\"documentation\"](\"https://user-images.githubusercontent.com/7799382/30358465-97784ee0-97f9-11e7-9f12-75fa041cf556.png\")
\n\n\n## Why I Built Piano\n\nWith the new iPhone 8 and iPhone X, we are going to see many new Augmented Reality apps, and one of the keypoints in the [Human Interface Guidelines for AR](https://developer.apple.com/ios/human-interface-guidelines/technologies/augmented-reality/) is to not clutter the AR view, allowing as much content from the augmented reality to be displayed as possible. Besides AR, Apple has spent tremendous time and manpower giving the iPhone an interface beyond our vision with the Taptic Engine and Siri. Apple even had a [session during WWDC 2017](https://developer.apple.com/videos/play/wwdc2017/803/) talking about the importance of sound design and the impact it can have on a user experience. It's obvious that the future of technology is not visual interfaces, but augmenting our connection with the real world. By using our physical, auditory, and most importantly visual senses, we can see the world in a whole new light. That's why I built Piano and [ARLogger](https://github.com/saoudrizwan/ARLogger), frameworks I hope will help developers create immersive and uncluttered interfaces, while keeping the user aware of the technology's state and purpose. If you'd like my help on an AR project, or just want to chat about the future of technology, don't hesitate to reach out to me on Twitter [@sdrzn](http://twitter.com/sdrzn).\n\n## License\n\nPiano uses the MIT license. Please file an issue if you have any questions or if you'd like to share how you're using Piano.\n\n## Contribute\n\nPlease feel free to create issues for feature requests or send pull requests of any additions you think would complement Piano and its philosophy.\n\n## Questions?\n\nContact me by email hello@saoudmr.com, or by twitter @sdrzn. Please create an issue if you come across a bug or would like a feature to be added.\n\n## Credits\n\n* Example app sound files from [Icons 8 UI Sounds](https://icons8.com/sounds)\n* Music notes in README header image from [LSE Design on the Noun Project](https://thenounproject.com/LSEdesigns/collection/music-notes/)\n"
},
{
"path": "Sources/Audio.swift",
"content": "// The MIT License (MIT)\n//\n// Copyright (c) 2018 Saoud Rizwan \n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy\n// of this software and associated documentation files (the \"Software\"), to deal\n// in the Software without restriction, including without limitation the rights\n// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n// copies of the Software, and to permit persons to whom the Software is\n// furnished to do so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in\n// all copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n// THE SOFTWARE.\n\nimport Foundation\n\n@available(iOS 10.0, *)\nextension Piano {\n /// Audio file to play\n public enum Audio {\n /// Name of asset in any .xcassets catalogs\n case asset(name: String)\n \n /// Searches main bundle for file with given name and extension\n case file(name: String, extension: String)\n \n /// URL of audio file\n case url(URL)\n \n /// Predefined system sound included in all iPhones\n case system(SystemSound)\n }\n}\n"
},
{
"path": "Sources/HapticFeedback.swift",
"content": "// The MIT License (MIT)\n//\n// Copyright (c) 2018 Saoud Rizwan \n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy\n// of this software and associated documentation files (the \"Software\"), to deal\n// in the Software without restriction, including without limitation the rights\n// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n// copies of the Software, and to permit persons to whom the Software is\n// furnished to do so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in\n// all copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n// THE SOFTWARE.\n\nimport Foundation\n\n@available(iOS 10.0, *)\nextension Piano {\n /// Second Generation Taptic Engine vibration options\n public enum HapticFeedback {\n /// Use notification feedback to communicate that a task or action has succeeded, failed, or produced a warning of some kind.\n case notification(Notification)\n public enum Notification {\n /// Indicates that a task or action, such as depositing a check or unlocking a vehicle, has completed.\n case success\n \n /// Indicates that a task or action, such as depositing a check or unlocking a vehicle, has produced a warning of some kind.\n case warning\n \n /// Indicates that a task or action, such as depositing a check or unlocking a vehicle, has failed.\n case failure\n }\n \n /// Use impact feedback generators to indicate that an impact has occurred. For example, you might trigger impact feedback when a user interface object collides with something or snaps into place.\n case impact(Impact)\n public enum Impact {\n /// Provides a physical metaphor representing a collision between small, light user interface elements. For example, the user might feel a thud when a view slides into place or two objects collide.\n case light\n \n /// Provides a physical metaphor representing a collision between moderately sized user interface elements. For example, the user might feel a thud when a view slides into place or two objects collide.\n case medium\n \n /// Provides a physical metaphor representing a collision between large, heavy user interface elements. For example, the user might feel a thud when a view slides into place or two objects collide.\n case heavy\n }\n \n /// Indicates that the selection is actively changing. For example, the user feels light taps while scrolling a picker wheel. This feedback is intended for communicating movement through a series of discrete values, not making or confirming a selection.\n case selection\n }\n}\n\n"
},
{
"path": "Sources/Info.plist",
"content": "\n\n\n\n\tCFBundleDevelopmentRegion\n\t$(DEVELOPMENT_LANGUAGE)\n\tCFBundleExecutable\n\t$(EXECUTABLE_NAME)\n\tCFBundleIdentifier\n\t$(PRODUCT_BUNDLE_IDENTIFIER)\n\tCFBundleInfoDictionaryVersion\n\t6.0\n\tCFBundleName\n\t$(PRODUCT_NAME)\n\tCFBundlePackageType\n\tFMWK\n\tCFBundleShortVersionString\n\t1.8\n\tCFBundleVersion\n\t$(CURRENT_PROJECT_VERSION)\n\tNSPrincipalClass\n\t\n\n\n"
},
{
"path": "Sources/Note.swift",
"content": "// The MIT License (MIT)\n//\n// Copyright (c) 2018 Saoud Rizwan \n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy\n// of this software and associated documentation files (the \"Software\"), to deal\n// in the Software without restriction, including without limitation the rights\n// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n// copies of the Software, and to permit persons to whom the Software is\n// furnished to do so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in\n// all copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n// THE SOFTWARE.\n\nimport Foundation\n\n@available(iOS 10.0, *)\nextension Piano {\n /// Sound, feedback, vibration, or pause for Piano to play\n public enum Note {\n /// Audio file to play\n case sound(Audio)\n \n /// Standard vibrations available on all models of the iPhone\n case vibration(Vibration)\n \n /// First generation Taptic Engine vibrations\n case tapticEngine(TapticEngine)\n \n /// Second Generation Taptic Engine vibrations\n case hapticFeedback(HapticFeedback)\n \n /// Tells Piano to wait until the previous note is done playing before playing the next note\n case waitUntilFinished\n \n /// Tells Piano to wait a given duration before playing the next note\n case wait(TimeInterval)\n }\n}\n"
},
{
"path": "Sources/Piano+Error.swift",
"content": "// The MIT License (MIT)\n//\n// Copyright (c) 2018 Saoud Rizwan \n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy\n// of this software and associated documentation files (the \"Software\"), to deal\n// in the Software without restriction, including without limitation the rights\n// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n// copies of the Software, and to permit persons to whom the Software is\n// furnished to do so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in\n// all copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n// THE SOFTWARE.\n\nimport Foundation\n\n@available(iOS 10.0, *)\nextension Piano {\n /// Possible errors when trying to play notes\n public enum PianoError: Error {\n case notFound(String)\n case couldNotPlay(String)\n }\n \n /// Currently, printing the errors in console is the most friendly way to handle them\n func handle(error: Error) {\n if let error = error as? PianoError {\n switch error {\n case .notFound(let name):\n print(\"🎹 Piano could not find \\(name)!\")\n case .couldNotPlay(let name):\n print(\"🎹 Piano could not play \\(name)!\")\n }\n } else {\n let error = error as NSError\n print(\"\"\"\n 🎹 Piano encountered an error!\n Domain: \\(error.domain)\n Code: \\(error.code)\n Description: \\(error.localizedDescription)\n Failure Reason: \\(error.localizedFailureReason ?? \"\")\n Suggestions: \\(error.localizedRecoverySuggestion ?? \"\")\n \"\"\")\n }\n }\n}\n"
},
{
"path": "Sources/Piano.h",
"content": "//\n// Piano.h\n// Piano\n//\n// Created by Saoud Rizwan on 9/11/17.\n// Copyright © 2017 Saoud Rizwan. All rights reserved.\n//\n\n#import \n\n//! Project version number for Piano.\nFOUNDATION_EXPORT double PianoVersionNumber;\n\n//! Project version string for Piano.\nFOUNDATION_EXPORT const unsigned char PianoVersionString[];\n\n// In this header, you should import all the public headers of your framework using statements like #import \n\n\n"
},
{
"path": "Sources/Piano.swift",
"content": "// The MIT License (MIT)\n//\n// Copyright (c) 2018 Saoud Rizwan \n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy\n// of this software and associated documentation files (the \"Software\"), to deal\n// in the Software without restriction, including without limitation the rights\n// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n// copies of the Software, and to permit persons to whom the Software is\n// furnished to do so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in\n// all copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n// THE SOFTWARE.\n\nimport Foundation\nimport AudioToolbox.AudioServices\nimport AVFoundation\n\n@available(iOS 10.0, *)\npublic typealias 🎹 = Piano\n\n/// Piano\n///\n/// Compose a symphony of sounds and vibrations using Taptic Engine\n@available(iOS 10.0, *)\npublic class Piano {\n \n /// Internal instance of Piano to manage shared feedback generators and symphony trackers\n private static let `default` = Piano()\n \n /// Allocatable/deallocatable tuple of UIFeedbackGenerators (Apple recommended)\n private var feedbackGenerator: (notification: UINotificationFeedbackGenerator?,\n impact: (light: UIImpactFeedbackGenerator?,\n medium: UIImpactFeedbackGenerator?,\n heavy: UIImpactFeedbackGenerator?),\n selection: UISelectionFeedbackGenerator?) = (nil, (nil, nil, nil), nil)\n \n private var player: AVAudioPlayer?\n \n /// Keeps track of multiple symphonies, preventing multiple symphonies from being played at once\n private var symphonyCounter = 0\n \n /// Holds all the scheduled Timers with music\n private var timers = [Timer]()\n \n private init() { }\n \n /// Wakes the Taptic Engine up from an idle state\n public static func wakeTapticEngine() {\n if Piano.default.feedbackGenerator.notification == nil {\n Piano.default.feedbackGenerator = (notification: UINotificationFeedbackGenerator(),\n impact: (light: UIImpactFeedbackGenerator(style: .light),\n medium: UIImpactFeedbackGenerator(style: .medium),\n heavy: UIImpactFeedbackGenerator(style: .heavy)),\n selection: UISelectionFeedbackGenerator())\n }\n }\n \n /// This tells the Taptic Engine to prepare itself before creating any feedback to reduce latency when triggering feedback. You can call this as many times as you want, preferrably right before playing a .hapticFeedback note.\n ///\n /// Apple docs:\n /// When you call this method, the generator is placed into a prepared state for a short period of time. While the generator is prepared, you can trigger feedback with lower latency.\n /// Think about when you can best prepare your generators. Call prepare() before the event that triggers feedback. The system needs time to prepare the Taptic Engine for minimal latency. Calling prepare() and then immediately triggering feedback (without any time in between) does not improve latency.\n /// To conserve power, the Taptic Engine returns to an idle state after any of the following events:\n /// - You trigger feedback on the generator.\n /// - A short period of time passes (typically seconds).\n /// - The generator is deallocated.\n ///\n /// After feedback is triggered, the Taptic Engine returns to its idle state. If you might trigger additional feedback within the next few seconds, immediately call prepare() to keep the Taptic Engine in the prepared state.\n /// You can also extend the prepared state by repeatedly calling the prepare() method. However, if you continue calling prepare() without ever triggering feedback, the system may eventually place the Taptic Engine back in an idle state and ignore any further prepare() calls until after you trigger feedback at least once.\n public static func prepareTapticEngine() {\n if Piano.default.feedbackGenerator.notification == nil {\n Piano.wakeTapticEngine()\n }\n Piano.default.feedbackGenerator.selection?.prepare()\n Piano.default.feedbackGenerator.notification?.prepare()\n Piano.default.feedbackGenerator.impact.light?.prepare()\n Piano.default.feedbackGenerator.impact.medium?.prepare()\n Piano.default.feedbackGenerator.impact.heavy?.prepare()\n }\n \n /// Returns the Taptic Engine to an idle state\n public static func putTapticEngineToSleep() {\n Piano.default.feedbackGenerator = (nil, (nil, nil, nil), nil)\n }\n \n /// Plays the audio asset with the given name\n ///\n /// - Parameters:\n /// - assetName: name of asset as per in its respective .xcassets catalog\n /// - completion: completion handler\n private func playAudio(from assetName: String, completion: (() -> Void)?) {\n guard let asset = NSDataAsset(name: assetName) else {\n handle(error: PianoError.notFound(assetName))\n completion?()\n return\n }\n do {\n try AVAudioSession.sharedInstance().setCategory(.playback, mode: .default)\n try AVAudioSession.sharedInstance().setActive(true)\n player = try AVAudioPlayer(data: asset.data, fileTypeHint: nil)\n if let player = player {\n player.play()\n DispatchQueue.main.asyncAfter(deadline: .now() + player.duration, execute: {\n completion?()\n })\n } else {\n handle(error: PianoError.couldNotPlay(assetName))\n completion?()\n }\n } catch {\n handle(error: error)\n completion?()\n }\n }\n \n /// Plays the audio file with the given name and extension\n ///\n /// - Parameters:\n /// - file: name of file (Sound.mp4 -> (\"Sound\", \"mp4\")\n /// - completion: completion handler\n private func playAudio(from file: (name: String, extension: String), completion: (() -> Void)?) {\n guard let url = Bundle.main.url(forResource: file.name, withExtension: file.extension) else {\n handle(error: PianoError.notFound(\"\\(file.name + \".\" + file.extension)\"))\n completion?()\n return\n }\n do {\n try AVAudioSession.sharedInstance().setCategory(.playback, mode: .default)\n try AVAudioSession.sharedInstance().setActive(true)\n player = try AVAudioPlayer(contentsOf: url)\n if let player = player {\n player.play()\n DispatchQueue.main.asyncAfter(deadline: .now() + player.duration, execute: {\n completion?()\n })\n } else {\n handle(error: PianoError.couldNotPlay(\"\\(file.name + \".\" + file.extension)\"))\n completion?()\n }\n } catch {\n handle(error: error)\n completion?()\n }\n }\n \n /// Plays the audio from the specified URL\n ///\n /// - Parameters:\n /// - url: file URL of audio file\n /// - completion: completion handler\n private func playAudio(from url: URL, completion: (() -> Void)?) {\n do {\n try AVAudioSession.sharedInstance().setCategory(.playback, mode: .default)\n try AVAudioSession.sharedInstance().setActive(true)\n player = try AVAudioPlayer(contentsOf: url)\n if let player = player {\n player.play()\n DispatchQueue.main.asyncAfter(deadline: .now() + player.duration, execute: {\n completion?()\n })\n } else {\n handle(error: PianoError.couldNotPlay(url.absoluteString))\n completion?()\n }\n } catch {\n handle(error: error)\n completion?()\n }\n }\n \n /// Plays system sound using Audio Services\n ///\n /// - Parameters:\n /// - soundId: System Sound ID of sound\n /// - completion: completion handler\n private func playSystemSound(with soundId: Int, completion: (() -> Void)?) {\n AudioServicesPlaySystemSoundWithCompletion(SystemSoundID(soundId)) {\n DispatchQueue.main.async {\n completion?()\n }\n }\n }\n \n /// Plays the specified haptic feedback, calling the specified completion handler after a time manually calculated from Apple's website\n ///\n /// - Parameters:\n /// - feedback: type of feedback to generate\n /// - completion: completion handler\n private func playHapticFeedback(_ feedback: HapticFeedback, completion: (() -> Void)?) {\n let duration: TimeInterval // value is calculated from https://developer.apple.com/ios/human-interface-guidelines/interaction/feedback/\n switch feedback {\n case .notification(let notification):\n switch notification {\n case .success:\n Piano.default.feedbackGenerator.notification?.notificationOccurred(.success)\n duration = 0.2\n case .warning:\n Piano.default.feedbackGenerator.notification?.notificationOccurred(.warning)\n duration = 0.25\n case .failure:\n Piano.default.feedbackGenerator.notification?.notificationOccurred(.error)\n duration = 0.5\n }\n case .impact(let impact):\n switch impact {\n case .light:\n Piano.default.feedbackGenerator.impact.light?.impactOccurred()\n case .medium:\n Piano.default.feedbackGenerator.impact.medium?.impactOccurred()\n case .heavy:\n Piano.default.feedbackGenerator.impact.heavy?.impactOccurred()\n }\n duration = 0.1\n case .selection:\n Piano.default.feedbackGenerator.selection?.selectionChanged()\n duration = 0.05\n }\n DispatchQueue.main.asyncAfter(deadline: .now() + duration, execute: {\n completion?()\n })\n }\n \n /// Cancels the currently playing symphony\n public static func cancel() {\n for timer in Piano.default.timers {\n timer.invalidate()\n }\n Piano.default.timers.removeAll()\n }\n \n /// Play a symphony of notes\n ///\n /// Note: This method automatically cancels any previously playing symphonies\n public static func play(_ notes: [Note], completion: (() -> Void)? = nil) {\n cancel()\n Piano.default.symphonyCounter += 1\n var pauseDurationBeforeNextNote: TimeInterval = 0\n let notes = Piano.default.removeUnnecessaryNotes(from: notes)\n var completion = completion\n if notes.contains(where: { (note) -> Bool in\n switch note {\n case .hapticFeedback: return true\n default: return false\n }\n }) {\n prepareTapticEngine()\n if let definedCompletion = completion {\n let newCompletion: (() -> Void) = {\n definedCompletion()\n putTapticEngineToSleep()\n }\n completion = newCompletion\n } else {\n completion = {\n putTapticEngineToSleep()\n }\n }\n }\n notesLoop: for i in 0.. Void)? = nil\n var iterationCompletion: (() -> Void)? = nil\n if (i < notes.count - 2) {\n let nextNote = notes[i + 1]\n switch nextNote {\n case .waitUntilFinished:\n let afterNextNoteIndex = i + 2\n let finalNoteIndex = notes.count - 1\n let restOfNotes = Array(notes[afterNextNoteIndex...finalNoteIndex])\n let capturedCounter = Piano.default.symphonyCounter\n iterationCompletion = {\n if Piano.default.symphonyCounter == capturedCounter {\n play(restOfNotes, completion: completion)\n }\n }\n default: break\n }\n } else if (i < notes.count - 1) {\n let nextNote = notes[i + 1]\n switch nextNote {\n case .waitUntilFinished:\n iterationCompletion = completion\n default: break\n }\n } else if i == notes.count - 1 {\n iterationCompletion = completion\n }\n switch note {\n case .sound(let audio):\n switch audio {\n case .asset(let name):\n music = { Piano.default.playAudio(from: name, completion: iterationCompletion) }\n case .file(let name, let type):\n music = { Piano.default.playAudio(from: (name, type), completion: iterationCompletion) }\n case .url(let url):\n music = { Piano.default.playAudio(from: url, completion: iterationCompletion) }\n case .system(let sound):\n music = { Piano.default.playSystemSound(with: sound.rawValue, completion: iterationCompletion) }\n }\n case .vibration(let vibration):\n music = { Piano.default.playSystemSound(with: vibration.rawValue, completion: iterationCompletion) }\n case .tapticEngine(let engine):\n music = { Piano.default.playSystemSound(with: engine.rawValue, completion: iterationCompletion) }\n case .hapticFeedback(let feedback):\n music = { Piano.default.playHapticFeedback(feedback, completion: iterationCompletion) }\n case .waitUntilFinished:\n if i != 0 {\n break notesLoop\n }\n case .wait(let interval):\n pauseDurationBeforeNextNote += interval\n if i == notes.count - 1 {\n music = { iterationCompletion?() }\n }\n }\n if let music = music {\n let timer = Timer(timeInterval: pauseDurationBeforeNextNote, repeats: false) { (_) in\n music()\n }\n RunLoop.main.add(timer, forMode: .common)\n Piano.default.timers.append(timer)\n }\n }\n if notes.count == 0 {\n completion?()\n }\n }\n \n /// Helper method for .play() to remove unnecessary .waitUntileFinisheds\n private func removeUnnecessaryNotes(from notes: [Note]) -> [Note] {\n var results = [Note]()\n for note in notes {\n if results.count == 0 {\n results.append(note)\n } else if let last = results.last {\n switch note {\n case .waitUntilFinished:\n switch last {\n case .waitUntilFinished: break\n default: results.append(note)\n }\n default: results.append(note)\n }\n }\n }\n if results.count == 1 {\n let onlyNote = results[0]\n switch onlyNote {\n case .waitUntilFinished: return []\n default: break\n }\n } else {\n var removedFirstWaits = false\n var removedLastWaits = false\n while !removedFirstWaits || !removedLastWaits {\n switch results.first! {\n case .waitUntilFinished: results.removeFirst()\n default: removedFirstWaits = true\n }\n switch results.last! {\n case .waitUntilFinished: results.removeLast()\n default: removedLastWaits = true\n }\n }\n }\n return results\n }\n}\n"
},
{
"path": "Sources/SystemSound.swift",
"content": "// The MIT License (MIT)\n//\n// Copyright (c) 2018 Saoud Rizwan \n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy\n// of this software and associated documentation files (the \"Software\"), to deal\n// in the Software without restriction, including without limitation the rights\n// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n// copies of the Software, and to permit persons to whom the Software is\n// furnished to do so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in\n// all copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n// THE SOFTWARE.\n\nimport Foundation\n\n@available(iOS 10.0, *)\nextension Piano {\n /// Default system sounds predefined and available on all iPhones\n /// Source: http://iphonedevwiki.net/index.php/AudioServices\n public enum SystemSound: Int, CaseIterable {\n case newMail = 1000\n case mailSent = 1001\n case voicemail = 1002\n case receivedMessage = 1003\n case sentMessage = 1004\n case alarm = 1005\n case lowPower = 1006\n case smsReceived1 = 1007\n case smsReceived2 = 1008\n case smsReceived3 = 1009\n case smsReceived4 = 1010\n case smsReceived7 = 1012\n case smsReceived5 = 1013\n case smsReceived6 = 1014\n case tweetSent = 1016\n case anticipate = 1020\n case bloom = 1021\n case calypso = 1022\n case chooChoo = 1023\n case descent = 1024\n case fanfare = 1025\n case ladder = 1026\n case minuet = 1027\n case newsFlash = 1028\n case noir = 1029\n case sherwhoodForest = 1030\n case spell = 1031\n case suspense = 1032\n case telegraph = 1033\n case tiptoes = 1034\n case typewriters = 1035\n case update = 1036\n case ussd = 1050\n case simToolkitCallDropped = 1051\n case simToolkitGeneralBeep = 1052\n case simToolkitNegativeAck = 1053\n case simToolkitPositiveAck = 1054\n case simToolkitSms = 1055\n case tinkQuiet = 1057\n case ctBusy = 1070\n case ctCongestion = 1071\n case ctPathAck = 1072\n case ctError = 1073\n case ctCallWaiting = 1074\n case ctKeyTone2 = 1075\n case lock = 1100\n case unlockFailed = 1102\n case tink = 1103\n case tock = 1104\n case beepBeep = 1106\n case ringerChanged = 1107\n case photoShutter = 1108\n case shake = 1109\n case jblBegin = 1110\n case jblConfirm = 1111\n case jblCancel = 1112\n case beginRecord = 1113\n case endRecord = 1114\n case jblAmbiguous = 1115\n case jblNoMatch = 1116\n case beginVideoRecord = 1117\n case endVideoRecord = 1118\n case vcInvitationAccepted = 1150\n case vcRinging = 1151\n case vcEnded = 1152\n case ctCallWaiting2 = 1153\n case vcRingingQuiet = 1154\n case touchTone0 = 1200\n case touchTone1 = 1201\n case touchTone2 = 1202\n case touchTone3 = 1203\n case touchTone4 = 1204\n case touchTone5 = 1205\n case touchTone6 = 1206\n case touchTone7 = 1207\n case touchTone8 = 1208\n case touchTone9 = 1209\n case touchToneStar = 1210\n case touchTonePound = 1211\n case headsetStartCall = 1254\n case headsetRedial = 1255\n case headsetAnswerCall = 1256\n case headsetEndCall = 1257\n case headsetWait = 1258\n case headsetTransitionEnd = 1259\n case tockQuiet = 1306\n }\n}\n"
},
{
"path": "Sources/TapticEngine.swift",
"content": "// The MIT License (MIT)\n//\n// Copyright (c) 2018 Saoud Rizwan \n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy\n// of this software and associated documentation files (the \"Software\"), to deal\n// in the Software without restriction, including without limitation the rights\n// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n// copies of the Software, and to permit persons to whom the Software is\n// furnished to do so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in\n// all copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n// THE SOFTWARE.\n\nimport Foundation\n\n@available(iOS 10.0, *)\nextension Piano {\n /// First generation Taptic Engine vibrations\n public enum TapticEngine: Int {\n /// Weak boom\n case peek = 1519\n \n /// Strong boom\n case pop = 1520\n \n /// Three sequential weak booms\n case cancelled = 1521\n \n /// Weak boom then strong boom\n case tryAgain = 1102\n \n /// Three sequential strong booms\n case failed = 1107\n }\n}\n"
},
{
"path": "Sources/UIDevice+Extension.swift",
"content": "// The MIT License (MIT)\n//\n// Copyright (c) 2018 Saoud Rizwan \n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy\n// of this software and associated documentation files (the \"Software\"), to deal\n// in the Software without restriction, including without limitation the rights\n// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n// copies of the Software, and to permit persons to whom the Software is\n// furnished to do so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in\n// all copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n// THE SOFTWARE.\n\nimport Foundation\n\n/// Device extension to check whether user's device supports Taptic Engine and/or Haptic Feedback\n/// Be sure to use with UIDevice.current\npublic extension UIDevice {\n /// In order to check if the iPhone has Taptic Engine and/or Haptic Feedback support, we need to check the device's model version. This function returns the generation and version of the current device.\n /// Note: Simulators will return a result of (0, 0), resulting in the hasTapticEngine and hasHapticFeedback BOOLs returning false\n /* Example:\n \"iPhone7,1\" on iPhone 6 Plus -> (7, 1)\n \"iPhone7,2\" on iPhone 6 -> (7, 2)\n \"iPhone8,1\" on iPhone 6S -> (8, 1)\n \"iPhone8,2\" on iPhone 6S Plus -> (8, 2)\n \"iPhone8,4\" on iPhone SE -> (8, 4)\n \"iPhone9,1\" on iPhone 7 (CDMA) -> (9, 1)\n \"iPhone9,3\" on iPhone 7 (GSM) -> (9, 3)\n \"iPhone9,2\" on iPhone 7 Plus (CDMA) -> (9, 2)\n \"iPhone9,4\" on iPhone 7 Plus (GSM) -> (9, 4)\n iPhone 8, 8S, and X will likely use a generation of 10 or greater, and will support Haptic Feedback, so this extension will work for those devices as well.\n iPhone X -> iPhone10,6\n */\n private func getDeviceGenerationVersion() -> (generation: Int, version: Int) {\n var sysinfo = utsname()\n uname(&sysinfo)\n let platform = String(bytes: Data(bytes: &sysinfo.machine, count: Int(_SYS_NAMELEN)), encoding: .ascii)!.trimmingCharacters(in: .controlCharacters)\n if platform.lowercased().prefix(\"iPhone\".count) != \"iPhone\".lowercased() { // Not an iPhone (probably simulator)\n return (0, 0)\n }\n let numbers = platform.filter { \"0123456789,\".contains($0) }\n if let commaIndex = numbers.index(of: \",\") {\n let firstNumber = numbers[numbers.startIndex.. 8 {\n return true\n } else {\n return false\n }\n }\n }\n \n // Returns a BOOL value representing whether the current device has a Taptic Engine with Haptic Feedback support\n public var hasHapticFeedback: Bool {\n get {\n let device = getDeviceGenerationVersion()\n if device.generation >= 9 {\n return true\n } else {\n return false\n }\n }\n }\n}\n"
},
{
"path": "Sources/Vibration.swift",
"content": "// The MIT License (MIT)\n//\n// Copyright (c) 2018 Saoud Rizwan \n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy\n// of this software and associated documentation files (the \"Software\"), to deal\n// in the Software without restriction, including without limitation the rights\n// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n// copies of the Software, and to permit persons to whom the Software is\n// furnished to do so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in\n// all copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n// THE SOFTWARE.\n\nimport Foundation\n\n@available(iOS 10.0, *)\nextension Piano {\n /// Standard vibrations available on all models of the iPhone\n public enum Vibration: Int {\n /// Basic 1-second vibration\n case `default` = 4095\n /// Two short consecutive vibrations\n case alert = 1011\n }\n}\n"
},
{
"path": "Tests/Info.plist",
"content": "\n\n\n\n\tCFBundleDevelopmentRegion\n\t$(DEVELOPMENT_LANGUAGE)\n\tCFBundleExecutable\n\t$(EXECUTABLE_NAME)\n\tCFBundleIdentifier\n\t$(PRODUCT_BUNDLE_IDENTIFIER)\n\tCFBundleInfoDictionaryVersion\n\t6.0\n\tCFBundleName\n\t$(PRODUCT_NAME)\n\tCFBundlePackageType\n\tBNDL\n\tCFBundleShortVersionString\n\t1.0\n\tCFBundleVersion\n\t1\n\n\n"
},
{
"path": "Tests/PianoTests.swift",
"content": "//\n// PianoTests.swift\n// PianoTests\n//\n// Created by Saoud Rizwan on 9/11/17.\n// Copyright © 2017 Saoud Rizwan. All rights reserved.\n//\n\nimport XCTest\n@testable import Piano\n\nclass PianoTests: XCTestCase {\n \n override func setUp() {\n super.setUp()\n }\n \n override func tearDown() {\n super.tearDown()\n }\n \n}\n"
}
]