audio/mp3, audio/vorbis, audio/wav: add comments about cache

hajimehoshi · May 4, 2024 · 322ad99 · 322ad99
1 parent c3b9afe
commit 322ad99
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/audio/mp3/decode.go b/audio/mp3/decode.go
@@ -87,6 +87,9 @@ func DecodeWithoutResampling(src io.Reader) (*Stream, error) {
 //
 // A Stream doesn't close src even if src implements io.Closer.
 // Closing the source is src owner's responsibility.
+//
+// Resampling can be a very heavy task. Stream has a cache for resampling, but the size is limited.
+// Do not expect that Stream has a resampling cache even after whole data is played.
 func DecodeWithSampleRate(sampleRate int, src io.Reader) (*Stream, error) {
 	d, err := mp3.NewDecoder(src)
 	if err != nil {

diff --git a/audio/vorbis/vorbis.go b/audio/vorbis/vorbis.go
@@ -182,6 +182,9 @@ func DecodeWithoutResampling(src io.Reader) (*Stream, error) {
 //
 // A Stream doesn't close src even if src implements io.Closer.
 // Closing the source is src owner's responsibility.
+//
+// Resampling can be a very heavy task. Stream has a cache for resampling, but the size is limited.
+// Do not expect that Stream has a resampling cache even after whole data is played.
 func DecodeWithSampleRate(sampleRate int, src io.Reader) (*Stream, error) {
 	decoded, channelCount, origSampleRate, err := decode(src)
 	if err != nil {

diff --git a/audio/wav/decode.go b/audio/wav/decode.go
@@ -134,6 +134,9 @@ func DecodeWithoutResampling(src io.Reader) (*Stream, error) {
 //
 // A Stream doesn't close src even if src implements io.Closer.
 // Closing the source is src owner's responsibility.
+//
+// Resampling can be a very heavy task. Stream has a cache for resampling, but the size is limited.
+// Do not expect that Stream has a resampling cache even after whole data is played.
 func DecodeWithSampleRate(sampleRate int, src io.Reader) (*Stream, error) {
 	s, origSampleRate, err := decode(src)
 	if err != nil {