keydetector

Documentation

Overview

/home/megalith/megasound/keydetector/keydetector.go

/home/megalith/megasound/keydetector/krumhansl.go

/home/megalith/megasound/keydetector/pcp.go

Index

• func ComputePCP(streamer megasound.Streamer, sampleRate int) ([]float64, error)
• func KrumhanslKeyProfiles() map[string][]float64
• func PCPKeyProfiles() map[string][]float64
• type KeyDetector
  • func NewKeyDetector(s megasound.Streamer, sampleRate int) *KeyDetector
  • func (kd *KeyDetector) DetectKey() (KeyResult, error)
• type KeyProfile
• type KeyResult
  • func KrumhanslSchmuckler(pcp []float64) KeyResult

Functions

func ComputePCP

func ComputePCP(streamer megasound.Streamer, sampleRate int) ([]float64, error)

ComputePCP analyzes an audio stream and returns the detected key with Camelot Wheel notation.

func KrumhanslKeyProfiles

func KrumhanslKeyProfiles() map[string][]float64

func PCPKeyProfiles

func PCPKeyProfiles() map[string][]float64

PCPKeyProfiles returns predefined key profiles for all major and minor keys based on music theory principles. These profiles correspond to the harmonic relationships between the 12 notes in the chromatic scale for each key.

Types

type KeyDetector

type KeyDetector struct {
	Streamer   megasound.Streamer
	SampleRate int
}

func NewKeyDetector

func NewKeyDetector(s megasound.Streamer, sampleRate int) *KeyDetector

func (*KeyDetector) DetectKey

func (kd *KeyDetector) DetectKey() (KeyResult, error)

type KeyProfile

type KeyProfile struct {
	Profile []float64
	Norm    float64
}

KeyProfile represents a key profile with its precomputed norm.

type KeyResult

type KeyResult struct {
	Key             string
	CamelotNotation string
	Confidence      float64
}

KeyResult represents the detected key with additional information like Camelot Wheel notation.

func KrumhanslSchmuckler

func KrumhanslSchmuckler(pcp []float64) KeyResult

KrumhanslSchmuckler computes the most likely key based on PCP and includes Camelot Wheel notation.