VoxaTrace/com.musicmuni.voxatrace.calibra.model

Package-level declarations

Types

data class ActiveSegmentState(val segmentIndex: Int, val segment: Segment, val currentPitch: Float, val currentAmplitude: Float, val elapsedSeconds: Float, val isCapturing: Boolean)

State of the currently active segment during practice.

AudioSource

sealed class AudioSource

Represents the source of audio data for evaluation.

BreathMetrics

data class BreathMetrics(val capacity: Float, val control: Float, val isValid: Boolean)

Result of breath analysis.

CompressorConfig

data class CompressorConfig(val thresholdDb: Float = -20f, val ratio: Float = 4.0f, val attackMs: Float = 10.0f, val releaseMs: Float = 100.0f, val autoMakeup: Boolean = false, val makeupDb: Float = 0.0f)

Configuration for audio compressor effect.

CompressorPreset

enum CompressorPreset : Enum<CompressorPreset>

Pre-configured compressor settings for common use cases.

ContourCleanup

data class ContourCleanup(val fixOctaveErrors: Boolean = true, val fixBoundaryOctaves: Boolean = true, val boundaryWindowMs: Float = 50.0f, val minimumNoteDurationMs: Float = 80.0f, val smoothPitch: Boolean = false)

Post-processing cleanup options for pitch contours.

DetectionStrictness

enum DetectionStrictness : Enum<DetectionStrictness>

How strict to be about pitch detection.

EffectsPreset

enum EffectsPreset : Enum<EffectsPreset>

Pre-configured effects chain combinations for common use cases.

EvaluatorConfig

data class EvaluatorConfig(val sampleRate: Int = 16000, val semitoneShift: Int = 0)

Configuration for singing evaluation.

EvaluatorPreset

enum EvaluatorPreset : Enum<EvaluatorPreset>

Pre-configured evaluator settings for common use cases.

LessonMaterial

data class LessonMaterial(val audioSource: AudioSource, val segments: List<Segment>, val keyHz: Float, val pitchContour: PitchContour? = null, val hpcpFrames: List<FloatArray>? = null)

Reference material for singing evaluation.

NoiseGateConfig

data class NoiseGateConfig(val thresholdDb: Float = -40f, val holdTimeMs: Float = 100.0f, val timeConstMs: Float = 10.0f)

Configuration for noise gate effect.

NoiseGatePreset

enum NoiseGatePreset : Enum<NoiseGatePreset>

Pre-configured noise gate settings for common scenarios.

NoteEvalConfig

data class NoteEvalConfig(val algorithm: ScoringAlgorithm = ScoringAlgorithm.SIMPLE, val boundaryToleranceMs: Int = 0)

Configuration for note evaluation scoring.

NoteEvalPreset

enum NoteEvalPreset : Enum<NoteEvalPreset>

Presets for common note evaluation use cases.

PerformanceLevel

enum PerformanceLevel : Enum<PerformanceLevel>

Performance levels for singing evaluation.

PitchAlgorithm

enum PitchAlgorithm : Enum<PitchAlgorithm>

Pitch detection algorithm backend.

PitchConfig

data class PitchConfig(val bufferSize: Int = 2048, val sampleRate: Int = 16000, val tolerance: Float = 0.15f, val minFreq: Float = 80.0f, val maxFreq: Float = 1000.0f, val refPitch: Float = 440.0f, val octaveWrap: Int = 0, val amplitudeGateThresholdDb: Float = -40f, val minConfidenceThreshold: Float = 0.75f)

Configuration for pitch detection (YIN algorithm).

PitchContour

data class PitchContour(val samples: List<PitchPoint>, val sampleRate: Int = 16000)

A sequence of pitch points representing a pitch contour over time.

PitchDetectorConfig

data class PitchDetectorConfig(val algorithm: PitchAlgorithm = PitchAlgorithm.YIN, val bufferSize: Int = 2048, val hopSize: Int = 160, val tolerance: Float = 0.15f, val minFreq: Float = 80.0f, val maxFreq: Float = 1000.0f, val amplitudeGateDb: Float = -40f, val confidenceThreshold: Float = 0.75f, val enableSmoothing: Boolean = false, val enableOctaveCorrection: Boolean = false, val smoothingWindowSize: Int = 5, val octaveThresholdCents: Float = 150.0f, val swiftF0BatchSize: Int = 2560)

Configuration for CalibraPitch detector.

PitchPoint

data class PitchPoint(val pitch: Float, val confidence: Float, val timeSeconds: Float = 0.0f)

A pitch detection result or timestamped pitch sample.

PitchPreset

enum PitchPreset : Enum<PitchPreset>

Pre-configured pitch detection presets.

PitchProcessorConfig

data class PitchProcessorConfig(val enableSmoothing: Boolean = true, val enableOctaveCorrection: Boolean = true, val smoothingWindowSize: Int = 5, val octaveThresholdCents: Float = 150.0f, val referencePitchHz: Float = 0.0f)

Configuration for pitch post-processing. Shared by both realtime and batch post-processing.

PracticePhase

enum PracticePhase : Enum<PracticePhase>

Practice phase during a CalibraLiveEval session.

QuietHandling

enum QuietHandling : Enum<QuietHandling>

How to handle quiet audio.

ResultAggregation

enum ResultAggregation : Enum<ResultAggregation>

How to aggregate multiple attempts per segment into a final score.

ReverbConfig

data class ReverbConfig(val mix: Float = 0.3f, val roomSize: Float = 0.5f)

Configuration for reverb effect.

ReverbPreset

enum ReverbPreset : Enum<ReverbPreset>

Pre-configured reverb settings for common room sizes.

ScoringAlgorithm

enum ScoringAlgorithm : Enum<ScoringAlgorithm>

Algorithm for computing note accuracy scores.

Segment

data class Segment(val index: Int, val startSeconds: Float, val endSeconds: Float, val lyrics: String = "", val studentStartSeconds: Float? = null, val studentEndSeconds: Float? = null)

A segment of a song or exercise with timing and optional lyrics.

SegmentResult

data class SegmentResult(val segment: Segment, val score: Float, val pitchAccuracy: Float = score, val level: PerformanceLevel = PerformanceLevel.fromScore(score), val attemptNumber: Int = 1, val referencePitch: PitchContour = PitchContour.EMPTY, val studentPitch: PitchContour = PitchContour.EMPTY)

Result of evaluating a single segment.

SessionConfig

data class SessionConfig(val autoAdvance: Boolean = true, val scoreThreshold: Float = 0.0f, val maxAttempts: Int = 0, val resultAggregation: ResultAggregation = ResultAggregation.LATEST, val hopSize: Int = 160, val autoPhaseTransition: Boolean = true, val autoSegmentDetection: Boolean = true)

Configuration for a CalibraLiveEval session.

SessionPhase

enum SessionPhase : Enum<SessionPhase>

Current phase of a CalibraLiveEval.

SessionState

data class SessionState(val phase: SessionPhase = SessionPhase.IDLE, val activeSegmentIndex: Int? = null, val activeSegment: Segment? = null, val currentPitch: Float = -1f, val currentAmplitude: Float = 0.0f, val segmentProgress: Float = 0.0f, val completedSegments: Set<Int> = emptySet(), val error: String? = null)

Current state of a CalibraLiveEval.

SingingResult

data class SingingResult(val overallScore: Float, val segmentResults: Map<Int, List<SegmentResult>>, val aggregation: ResultAggregation = ResultAggregation.LATEST)

Complete result of a singing evaluation session.

VADBackend

enum VADBackend : Enum<VADBackend>

Available Voice Activity Detection backend engines.

VADConfig

data class VADConfig(val backend: VADBackend = VADBackend.SPEECH, val sampleRate: Int = 16000, val threshold: Float = 0.5f, val minSpeechDuration: Float = 0.25f, val minSilenceDuration: Float = 0.25f, val windowSize: Int = 512, val numThreads: Int = 1, val modelPath: String? = null, val rmsThreshold: Float = 0.05f, val pitchProbThreshold: Float = 0.5f, val minPitch: Float = 50.0f)

Configuration for Voice Activity Detection.

VADModelProvider

sealed class VADModelProvider

Type-safe model provider for VAD backends.

VADResult

data class VADResult(val ratio: Float, val level: VoiceActivityLevel)

Result from VAD analysis containing ratio, level, and convenience properties.

VoiceActivityLevel

enum VoiceActivityLevel : Enum<VoiceActivityLevel>

Voice activity classification levels.

VoiceType

sealed class VoiceType

Voice type presets for different singing styles and voice ranges.