Navigation
API > API/Plugins > API/Plugins/AudioSynesthesiaCore
Pitch detector based on autocorrelation. Note that autocorrelation pitch detectors give more accurate frequency results for low frequencies, but have issues with octave errors. Generally, it will produce erroneous frequency observations in octaves below the true pitch frequency.
| Name | FAutoCorrelationPitchDetector |
| Type | class |
| Header File | /Engine/Plugins/Runtime/AudioSynesthesia/Source/AudioSynesthesiaCore/Public/AutoCorrelationPitchDetector.h |
| Include Path | #include "AutoCorrelationPitchDetector.h" |
Syntax
class FAutoCorrelationPitchDetector : public Audio::IPitchDetector
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FAutoCorrelationPitchDetector
(
const FAutoCorrelationPitchDetectorSettings& InSettings, |
Create an auto correlation pitch detector with settings and a sample rate. | AutoCorrelationPitchDetector.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FAutoCorrelationPitchDetector() |
AutoCorrelationPitchDetector.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AutoCorrBuffer | FAlignedFloatBuffer | AutoCorrelationPitchDetector.h | ||
| Correlator | TUniquePtr< FBlockCorrelator > | AutoCorrelationPitchDetector.h | ||
| MaxAutoCorrBin | int32 | AutoCorrelationPitchDetector.h | ||
| MinAutoCorrBin | int32 | AutoCorrelationPitchDetector.h | ||
| PeakIndices | TArray< int32 > | AutoCorrelationPitchDetector.h | ||
| PeakPicker | TUniquePtr< FPeakPicker > | AutoCorrelationPitchDetector.h | ||
| SampleRate | float | AutoCorrelationPitchDetector.h | ||
| Settings | FAutoCorrelationPitchDetectorSettings | AutoCorrelationPitchDetector.h | ||
| SlidingBuffer | TSlidingBuffer< float > | AutoCorrelationPitchDetector.h | ||
| WindowBuffer | FAlignedFloatBuffer | AutoCorrelationPitchDetector.h | ||
| WindowCounter | int32 | AutoCorrelationPitchDetector.h |
Functions
Public
Overridden from IPitchDetector
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void DetectPitches
(
const FAlignedFloatBuffer& InMonoAudio, |
Detect pitches in the audio. This can be called repeatedly with new audio. | AutoCorrelationPitchDetector.h | |
virtual void Finalize
(
TArray< FPitchInfo >& OutPitches |
Resets internal audio buffers. This pitch detector does not produce any more pitches on Finalize. | AutoCorrelationPitchDetector.h |