Add CHANGELOG.md and changelog section to README for v1.0.0 release

This commit is contained in:
Bastian Bührig
2025-07-11 09:10:40 +02:00
parent 0668469fb1
commit ac678f2aa8
6 changed files with 39 additions and 15 deletions

14
CHANGELOG.md Normal file
View File

@@ -0,0 +1,14 @@
# Changelog
## [v1.0.0] - 2024-06-09
### Added
- Initial public release: Valhallir Deconvolver
- Fast FFT-based deconvolution for IR extraction
- Automatic input conversion: accepts any WAV sample rate, bit depth, or channel count
- Output IR in user-selectable sample rate and bit depth (WAV only)
- Optional minimum phase transform (MPT) output
- Silence trimming and normalization
- Optional output IR length control (`--length-ms`)
- Mono output (stereo/multichannel inputs are averaged)
- CLI with urfave/cli, version flag, and detailed logging
- Full documentation and usage examples in README

View File

@@ -234,4 +234,8 @@ Generate IRs in different sample rates and bit depths:
## Contributing
[Add contribution guidelines here]
[Add contribution guidelines here]
## Changelog
See [CHANGELOG.md](./CHANGELOG.md) for version history and details. Current version: v1.0.0

21
go.mod
View File

@@ -3,13 +3,16 @@ module valhallir-deconvolver
go 1.24.1
require (
github.com/cpuguy83/go-md2man/v2 v2.0.7 // indirect
github.com/go-audio/audio v1.0.0 // indirect
github.com/go-audio/riff v1.0.0 // indirect
github.com/go-audio/wav v1.1.0 // indirect
github.com/mjibson/go-dsp v0.0.0-20180508042940-11479a337f12 // indirect
github.com/russross/blackfriday/v2 v2.1.0 // indirect
github.com/urfave/cli/v2 v2.27.7 // indirect
github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1 // indirect
gonum.org/v1/gonum v0.13.0 // indirect
github.com/go-audio/audio v1.0.0
github.com/go-audio/wav v1.1.0
github.com/mjibson/go-dsp v0.0.0-20180508042940-11479a337f12
github.com/urfave/cli/v2 v2.27.7
gonum.org/v1/gonum v0.13.0
)
require (
github.com/cpuguy83/go-md2man/v2 v2.0.7 // indirect
github.com/go-audio/riff v1.0.0 // indirect
github.com/russross/blackfriday/v2 v2.1.0 // indirect
github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1 // indirect
)

2
go.sum
View File

@@ -14,5 +14,7 @@ github.com/urfave/cli/v2 v2.27.7 h1:bH59vdhbjLv3LAvIu6gd0usJHgoTTPhCFib8qqOwXYU=
github.com/urfave/cli/v2 v2.27.7/go.mod h1:CyNAG/xg+iAOg0N4MPGZqVmv2rCoP267496AOXUZjA4=
github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1 h1:gEOO8jv9F4OT7lGCjxCBTO/36wtF6j2nSip77qHd4x4=
github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1/go.mod h1:Ohn+xnUBiLI6FVj/9LpzZWtj1/D6lUovWYBkxHVV3aM=
golang.org/x/exp v0.0.0-20230321023759-10a507213a29 h1:ooxPy7fPvB4kwsA2h+iBNHkAbp/4JxTSwCmvdjEYmug=
golang.org/x/exp v0.0.0-20230321023759-10a507213a29/go.mod h1:CxIveKay+FTh1D0yPZemJVgC/95VzuuOLq5Qi4xnoYc=
gonum.org/v1/gonum v0.13.0 h1:a0T3bh+7fhRyqeNbiC3qVHYmkiQgit3wnNan/2c0HMM=
gonum.org/v1/gonum v0.13.0/go.mod h1:/WPYRckkfWrhWefxyYTfrTtQR0KH4iyHNuzxqXAKyAU=

View File

@@ -5,16 +5,17 @@ import (
"log"
"os"
"valhallir-convoluter/pkg/convolve"
"valhallir-convoluter/pkg/wav"
"valhallir-deconvolver/pkg/convolve"
"valhallir-deconvolver/pkg/wav"
"github.com/urfave/cli/v2"
)
func main() {
app := &cli.App{
Name: "valhallir-deconvolver",
Usage: "Deconvolve sweep and recorded WAV files to create impulse responses",
Name: "valhallir-deconvolver",
Usage: "Deconvolve sweep and recorded WAV files to create impulse responses",
Version: "v1.0.0",
Flags: []cli.Flag{
&cli.StringFlag{
Name: "sweep",

View File

@@ -4,7 +4,7 @@ import (
"fmt"
"os"
"valhallir-convoluter/pkg/convolve"
"valhallir-deconvolver/pkg/convolve"
"github.com/go-audio/audio"
"github.com/go-audio/wav"