From f3afd2eca09ed704cbac8e92d3f4c5f3a9f17efa Mon Sep 17 00:00:00 2001
From: WeebDataHoarder <57538841+WeebDataHoarder@users.noreply.github.com>
Date: Wed, 26 Jan 2022 09:38:13 +0100
Subject: [PATCH] Cleanup of names / values

---
 goborator.go | 16 ++++++++++------
 1 file changed, 10 insertions(+), 6 deletions(-)

diff --git a/goborator.go b/goborator.go
index 0634d02..2269715 100644
--- a/goborator.go
+++ b/goborator.go
@@ -28,7 +28,7 @@ type Gaborator struct {
 
 func NewGaborator(blockSize int, sampleRate float64, bandsPerOctave int, minimumFrequency, maximumFrequency, referenceFrequency float64, stepSize int) *Gaborator {
 	g := &Gaborator{
-		pointer:                   unsafe.Pointer(C.gaborator_initialize(C.double(sampleRate), C.int(bandsPerOctave), C.double(minimumFrequency), C.double(maximumFrequency), C.double(referenceFrequency))),
+		pointer:                   unsafe.Pointer(C.gaborator_initialize(C.double(sampleRate), C.int(bandsPerOctave), C.double(minimumFrequency), C.double(referenceFrequency), C.double(maximumFrequency))),
 		sampleRate:                sampleRate,
 		audioBlockSize:            blockSize,
 		audioDataToTransform:      make([]float32, blockSize),
@@ -93,12 +93,16 @@ func float32Max(a, b float32) float32 {
 
 func (g *Gaborator) gaborTransform(audioData []float32) {
 
-	analysysResult := g.analyze(audioData)
+	analysisResult := g.analyze(audioData)
 
-	for i := 0; i < len(analysysResult); i += 3 {
-		band := int(analysysResult[i])
-		audioSample := int(analysysResult[i+1])
-		coefficient := analysysResult[i+2]
+	//The analysis result consists of a float array with three values:
+	// a frequency band index [i] (always an integer)
+	// an audio sample index [i+1] (expressed in audio samples)
+	// a magnitude value [i+2] (the magnitude value)
+	for i := 0; i < len(analysisResult); i += 3 {
+		band := int(analysisResult[i])
+		audioSample := int(analysisResult[i+1])
+		coefficient := analysisResult[i+2]
 
 		coefficientIndex := audioSample/g.frequencyBinTimeStepSize - g.coefficientIndexOffset
 		bandIndex := band - g.firstBandCache