From febc8fdd331106885a9f679b3a446957f3f34e4d Mon Sep 17 00:00:00 2001
From: Mark Kremer <mail@markkremer.nl>
Date: Sun, 11 Aug 2024 19:14:00 +0200
Subject: [PATCH] Implement temporary fix for mewkiz/flac frame.Position() bug

See https://github.com/mewkiz/flac/pull/73
---
 flac/decode.go      | 44 +++++++++++++++++++++++++++++++++++++++++++-
 flac/decode_test.go | 26 ++++++++++++++++++++++++++
 2 files changed, 69 insertions(+), 1 deletion(-)

diff --git a/flac/decode.go b/flac/decode.go
index 5bdc5ca..8e86433 100644
--- a/flac/decode.go
+++ b/flac/decode.go
@@ -41,6 +41,7 @@ func Decode(r io.Reader) (s beep.StreamSeekCloser, format beep.Format, err error
 	if err != nil {
 		return nil, beep.Format{}, errors.Wrap(err, "flac")
 	}
+	d.hasFixedBlockSize = d.frame.HasFixedBlockSize
 
 	format = beep.Format{
 		SampleRate:  beep.SampleRate(d.stream.Info.SampleRate),
@@ -57,6 +58,8 @@ type decoder struct {
 	posInFrame  int
 	err         error
 	seekEnabled bool
+
+	hasFixedBlockSize bool
 }
 
 func (d *decoder) Stream(samples [][2]float64) (n int, ok bool) {
@@ -126,6 +129,15 @@ func (d *decoder) Len() int {
 }
 
 func (d *decoder) Position() int {
+	if d.frame == nil {
+		return d.Len()
+	}
+
+	// Temporary workaround until https://github.com/mewkiz/flac/pull/73 is resolved.
+	if d.hasFixedBlockSize {
+		return int(d.frame.Num)*int(d.stream.Info.BlockSizeMax) + d.posInFrame
+	}
+
 	return int(d.frame.SampleNumber()) + d.posInFrame
 }
 
@@ -134,6 +146,36 @@ func (d *decoder) Seek(p int) error {
 		return errors.New("flac.decoder.Seek: not enabled")
 	}
 
+	// Temporary workaround until https://github.com/mewkiz/flac/pull/73 is resolved.
+	// frame.SampleNumber() doesn't work for the last frame of a fixed block size stream
+	// with the result that seeking to that frame doesn't work either. Therefore, if such
+	// a seek is requested, we seek to one of the frames before it and consume until the
+	// desired position is reached.
+	if d.hasFixedBlockSize {
+		lastFrameStartLowerBound := d.Len() - int(d.stream.Info.BlockSizeMax)
+		if p >= lastFrameStartLowerBound {
+			// Seek to & consume an earlier frame.
+			_, err := d.stream.Seek(uint64(lastFrameStartLowerBound - 1))
+			if err != nil {
+				return errors.Wrap(err, "flac")
+			}
+			for {
+				d.frame, err = d.stream.ParseNext()
+				if err != nil {
+					return errors.Wrap(err, "flac")
+				}
+				// Calculate the frame start position manually, because this doesn't
+				// work for the last frame.
+				frameStart := d.frame.Num * uint64(d.stream.Info.BlockSizeMax)
+				if frameStart+uint64(d.frame.BlockSize) >= d.stream.Info.NSamples {
+					// Found the desired frame.
+					d.posInFrame = p - int(frameStart)
+					return nil
+				}
+			}
+		}
+	}
+
 	// d.stream.Seek() doesn't seek to the exact position p, instead
 	// it seeks to the start of the frame p is in. The frame position
 	// is returned and stored in pos.
@@ -148,7 +190,7 @@ func (d *decoder) Seek(p int) error {
 		return errors.Wrap(err, "flac")
 	}
 
-	return err
+	return nil
 }
 
 func (d *decoder) Close() error {
diff --git a/flac/decode_test.go b/flac/decode_test.go
index c98c16f..b447d4c 100644
--- a/flac/decode_test.go
+++ b/flac/decode_test.go
@@ -118,6 +118,32 @@ func TestDecoder_Seek(t *testing.T) {
 	wavSamples = testtools.CollectNum(100, wavStream)
 	flacSamples = testtools.CollectNum(100, flacStream)
 	testtools.AssertSamplesEqual(t, wavSamples, flacSamples)
+
+	// Test end of stream.
+	seekPos = wavStream.Len() - 1
+	err = wavStream.Seek(seekPos)
+	assert.NoError(t, err)
+	assert.Equal(t, seekPos, wavStream.Position())
+	err = flacStream.Seek(seekPos)
+	assert.NoError(t, err)
+	assert.Equal(t, seekPos, flacStream.Position())
+
+	wavSamples = testtools.CollectNum(100, wavStream)
+	flacSamples = testtools.CollectNum(100, flacStream)
+	testtools.AssertSamplesEqual(t, wavSamples, flacSamples)
+
+	// Test after end of stream.
+	seekPos = wavStream.Len()
+	err = wavStream.Seek(seekPos)
+	assert.NoError(t, err)
+	assert.Equal(t, seekPos, wavStream.Position())
+	err = flacStream.Seek(seekPos)
+	assert.NoError(t, err)
+	assert.Equal(t, seekPos, flacStream.Position())
+
+	wavSamples = testtools.CollectNum(100, wavStream)
+	flacSamples = testtools.CollectNum(100, flacStream)
+	testtools.AssertSamplesEqual(t, wavSamples, flacSamples)
 }
 
 func getFlacFrameStartPositions(r io.Reader) ([]uint64, error) {