https://github.com/matt54/swifttuner

Open Source Musical Instrument Tuner
https://github.com/matt54/swifttuner

music musical-instruments pitch pitch-detection tuning

Last synced: 3 months ago
JSON representation

Open Source Musical Instrument Tuner

• Host: GitHub
• URL: https://github.com/matt54/swifttuner
• Owner: Matt54
• License: mit
• Created: 2024-03-02T16:40:32.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-04-22T21:14:54.000Z (9 months ago)
• Last Synced: 2024-10-14T19:51:01.069Z (3 months ago)
• Topics: music, musical-instruments, pitch, pitch-detection, tuning
• Language: Swift
• Homepage: https://apps.apple.com/us/app/spatial-tuner-pitch-tuning/id6478814592
• Size: 16.9 MB
• Stars: 25
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SwiftTuner - [App Store Link](https://apps.apple.com/us/app/spatial-tuner-pitch-tuning/id6478814592)





    





This open source Swift Package aims to create a great Tuner experience on visionOS. It uses the AudioKit library to provide real-time tuning information for pitch and deviation.

## Features

- **Real-time Tuning:** SwiftTuner provides real-time tuning information for pitch and deviation.

- **Customizable Settings:** Users can customize settings such as buffer size and amplitude threshold.

## Installation

### Swift Package Manager (SPM)

You can use Swift Package Manager to install SwiftTuner in your project. Follow these steps:

1. In Xcode, select your project in the project navigator.

2. Select the "Swift Packages" tab.

3. Click the "+" button and select "Add Package Dependency..."

4. Enter the URL of the SwiftTuner repository: `https://github.com/Matt54/SwiftTuner.git`

5. Click "Next" and follow the prompts to complete the installation.

## Usage

1. Import SwiftTuner into your Swift file: `import SwiftTuner`

2. Create an instance of `TunerConductor`: `let tuner = TunerConductor()`

3. Start the tuner: `tuner.start()`

4. Use the tuning information provided by the `TunerConductor` instance to adjust your instrument.

## Just Tuner Example

```swift

import SwiftTuner

let tuner = TunerConductor()

tuner.start()

// Use tuner.data.pitch, tuner.data.noteName, tuner.data.octaveNumber, tuner.data.deviation as needed

```

## Tuner View Example

``` swift

import SwiftTuner

import SwiftUI

@main

struct SpatialTunerApp: App {

    var body: some Scene {

        WindowGroup {

            TunerRootView(tuner: TunerConductor())

        }

        .windowResizability(.contentSize)

    }

}

```





    





## Credits

SwiftTuner is developed and maintained by Matt Pfeiffer and owes much thanks to the AudioKit community.

## License

SwiftTuner is released under the MIT License. See LICENSE for details.

## Contributing

You are welcome to contribute! Feel free to open an issue or pull request.