Pitch Detector Dart

https://pub.dev/packages/pitch_detector_dart
Admin
A dart library for pitch detection. It implements the yin algorithm ported from the tarsosDSP...
Tokens:1,914
Snippets:32
Trust Score:9.9
Update:4 months ago
Show doc for...
Tokens:
Raw
### Example pubspec.yaml Dependency

Source: https://pub.dev/packages/pitch_detector_dart/install

This is how the dependency will appear in your pubspec.yaml file after adding the package.

```yaml
dependencies:
  pitch_detector_dart: ^0.0.7
```

--------------------------------

### Get Tuning Status Description

Source: https://pub.dev/packages/pitch_detector_dart/example

Provides a human-readable description for different tuning statuses.

```dart
String getDescription() => switch(this) {
  TuningStatus.tuned => "Tuned",
  TuningStatus.toolow => "Too low. Tighten the string",
  TuningStatus.toohigh => "Too hig. Give it some slack",
  TuningStatus.waytoolow => "Way too low. Tighten the string",
  TuningStatus.waytoohigh => "Way to high. Give it some slack",
  TuningStatus.undefined => "Note is not in the valid interval.",
};
```

--------------------------------

### Get Pitch from Float Buffer

Source: https://pub.dev/packages/pitch_detector_dart

Use this method to detect pitch from an audio sample represented as a List<double>, typically from PCM float encoding.

```dart
//The first acccepts a List<double> - This should be a sample from the PCM float enconding type.

final result = pitchDetectorDart.getPitchFromFloatBuffer(PCM32FloataudioSample);

```

--------------------------------

### Get Pitch from Int Buffer

Source: https://pub.dev/packages/pitch_detector_dart

Use this method to detect pitch from an audio sample represented as a UInt8List, commonly used for PCM16 encoding. This facilitates integration with many recording libraries.

```dart
//The second acccepts a UInt8List - This should be an audio sample from the PCM16 enconding type. Most recording libraties use a UInt8List to hold the samples. So I decided to follow that to facilitate using the library.

final result = pitchDetectorDart.getPitchFromIntBuffer(PCM16Int8AudioSample);

```

--------------------------------

### Initialize Pitch Detector

Source: https://pub.dev/packages/pitch_detector_dart

Create a new instance of PitchDetector, specifying the sample rate and buffer size. This is the first step before processing audio.

```dart
//Create a new pitch detector and set the sample rate and buffer size  
final pitchDetectorDart = PitchDetector(44100, 2000);

```

--------------------------------

### Import pitch_detector_dart Modules

Source: https://pub.dev/packages/pitch_detector_dart/install

Import the necessary modules from the pitch_detector_dart library into your Dart code.

```dart
import 'package:pitch_detector_dart/algorithm/pitch_algorithm.dart';
import 'package:pitch_detector_dart/algorithm/yin.dart';
import 'package:pitch_detector_dart/exceptions/invalid_audio_buffer_exception.dart';
import 'package:pitch_detector_dart/pitch_detector.dart';
import 'package:pitch_detector_dart/pitch_detector_result.dart';
import 'package:pitch_detector_dart/util/pcm_util_extensions.dart';
```

--------------------------------

### Initialize Pitch Detection Stream

Source: https://pub.dev/packages/pitch_detector_dart/example

Initializes the audio recorder and pitch detector to stream audio samples and detect pitch. Handles audio configuration and buffering.

```dart
final recordStream = await _audioRecorder.startStream(
  const RecordConfig(
    encoder: AudioEncoder.pcm16bits,
    numChannels: 1,
    bitRate: 128000,
    sampleRate: PitchDetector.DEFAULT_SAMPLE_RATE,
  )
);

var audioSampleBufferedStream = bufferedListStream(
  recordStream.map((event) {
    return event.toList();
  }),
  //The library converts a PCM16 to 8bits internally. So we need twice as many bytes
  PitchDetector.DEFAULT_BUFFER_SIZE * 2,
) ;

await for (var audioSample in audioSampleBufferedStream) {
  final intBuffer = Uint8List.fromList(audioSample);

  _pitchDetectorDart.getPitchFromIntBuffer(intBuffer).then((detectedPitch) {
    if (detectedPitch.pitched) {
       _pitchupDart.handlePitch(detectedPitch.pitch).then((pitchResult) => {
        
        emit(TunningState(
          note: pitchResult.note,
          status: pitchResult.tuningStatus.getDescription(),
        ))
      });
    }
  });
}
```

--------------------------------

### Add pitch_detector_dart to Dart Project

Source: https://pub.dev/packages/pitch_detector_dart/install

Use this command to add the package as a dependency in your Dart project.

```bash
$ dart pub add pitch_detector_dart
```

--------------------------------

### Add pitch_detector_dart Dependency

Source: https://pub.dev/packages/pitch_detector_dart

Add this dependency to your project's pubspec.yaml file to include the pitch_detector_dart library.

```yaml
dependencies:
  pitch_detector_dart: ^0.0.7

```

--------------------------------

### Add pitch_detector_dart to Flutter Project

Source: https://pub.dev/packages/pitch_detector_dart/install

Use this command to add the package as a dependency in your Flutter project.

```bash
$ flutter pub add pitch_detector_dart
```
Tokens:
Raw