June 1st, 2024 release v0.5.4

[tphakala]

[0.5.4] - 2024-06-01

🚀 Features

• (audio) Disk usage based audio clip retention policy, enabled by default with 80% disk usage treshold
• (conf) Privacy filter Confidence threshold setting
• (conf) Dog bark filter Confidence threshold setting
• (conf) Dog bark filter time to remember bark setting

🐛 Bug Fixes

• (webui) Fix Settings interface load error

🚜 Refactor

• (conf) Refactor configuration package to improve settings handling, easier access to settings in code
• (audio) Audio clip retention policy setting: none, age, usage
• (audio) Age base audio clip retention policy accepts time in days, weeks, months and years instead of hours
• (conf) Many settings renamed

⚙️ Miscellaneous Tasks

• Update go.mod with github.com/mitchellh/mapstructure v1.5.0

---

This discussion was created from the release v0.5.4.

[isZumpo]

Great work on all of these new features! I can now also verify that both arm64 and amd64 are available for this release of the docker image :)

[tphakala]

This new release adds a new disk utillization based audio clip retention policy. This new retention policy is enabled by default and it is set to keep disk utilization at 80% level, once this threshold is exceeded old clips will be deleted, database entries are left intact. Cleanup policy will delete low confidence recordings first, and by detault it keeps 10 recordings per species for each month, this is to protect rare sigthings from being deleted.

Age based cleanup policy is also reworked somewhat, instead of hours clip age is now configured as hours, weeks, months or years. If you would like to store audio clips for 6 weeks and keep no recordings for any species over that time you would configure

retention:
  policy: age
  maxage: 6w
  minclips: 0

Please recreate your config file

I have renamed few configuration settings as things evolve, and because there is not yet any automatic method for updating config file I would highly recommend you to backup your current config file by renaming it and let birdnet-go to create a new config with new structure, and copy your settings over to new file.

[tphakala]

It seems that I messed up default settings for human privacy and dog bark filters, please add confidence setting for dogbark filter with value of 0.1 or lower and fix a typo for confidence on privacyfilter.

privacyfilter: # Privacy filter prevents audio clip saving if human voice
enabled: true # is detected durin audio capture
confidence: 0.05 # threshold for human voice detection

dogbarkfilter:
enabled: true
confidence: 0.1 # confidence threshold for dog bark detection
remember: 5 # number of minutes to remember dog barks

[sclitheroe]

Hi,

Does this look correct? (see below)... Thanks so much for Birdnet-Go, I LOVE it!

privacyfilter: # Privacy filter prevents audio clip saving if human voice
        enabled: true # is detected durin audio capture
        confidence: 0.1
        threshold: 0.05 # threshold for human voice detection
    dogbarkfilter:
        enabled: true
        confidence: 0.1 # confidence threshold for dog bark detection
        remember: 5 # number of minutes to remember dog barks

[ericleslie]

I'm not super familiar with docker and the best practices for updating images. I've pulled two images, one using the latest tag and other with 0.5.4 tag. Attempting to start both of them, I get the error "exec format error" which I understand to mean I'm running the wrong architecture. Inspecting the image it says it's Arm64/linux which is the correct architecture for my rpi4b.

Advice please!

Aside, are there any plans to release this with a package manager like apt?

[isZumpo]

You might have executed docker --version rather than docker version. I would expect a larger output, this is mine for example:

docker version
Client: Docker Engine - Community
 Version:           26.1.1
 API version:       1.45
 Go version:        go1.21.9
 Git commit:        4cf5afa
 Built:             Tue Apr 30 11:47:53 2024
 OS/Arch:           linux/amd64
 Context:           default

Server: Docker Engine - Community
 Engine:
  Version:          26.1.1
  API version:      1.45 (minimum version 1.24)
  Go version:       go1.21.9
  Git commit:       ac2de55
  Built:            Tue Apr 30 11:47:53 2024
  OS/Arch:          linux/amd64
  Experimental:     false
 containerd:
  Version:          1.6.31
  GitCommit:        e377cd56a71523140ca6ae87e30244719194a521
 runc:
  Version:          1.1.12
  GitCommit:        v1.1.12-0-g51d5e946
 docker-init:
  Version:          0.19.0
  GitCommit:        de40ad0

[ericleslie]

Ah, I did use --version. Here is the desired output

Client: Docker Engine - Community
 Version:           26.1.3
 API version:       1.45
 Go version:        go1.21.10
 Git commit:        b72abbb
 Built:             Thu May 16 08:33:25 2024
 OS/Arch:           linux/arm64
 Context:           default

Server: Docker Engine - Community
 Engine:
  Version:          26.1.3
  API version:      1.45 (minimum version 1.24)
  Go version:       go1.21.10
  Git commit:       8e96db1
  Built:            Thu May 16 08:33:25 2024
  OS/Arch:          linux/arm64
  Experimental:     false
 containerd:
  Version:          1.6.32
  GitCommit:        8b3b7ca2e5ce38e8f31a34f35b2b68ceb8470d89
 runc:
  Version:          1.1.12
  GitCommit:        v1.1.12-0-g51d5e94
 docker-init:
  Version:          0.19.0
  GitCommit:        de40ad0

[isZumpo]

Ok, your setup looks all good to me. There is something very wrong with the image...

Tested it with my Raspberry Pi and had the same issue. I then went down the rabbit hole of trying to run all recent dev images, and none of them has been working for arm64 since my pull request which fixed amd64 builds.

I believe the issue might be in the makefile, more exactly this piece of code:

UNAME_M := $(shell uname -m)
ifeq ($(UNAME_M),x86_64)
    NATIVE_TARGET := linux_amd64
else ifeq ($(UNAME_M),aarch64)
    NATIVE_TARGET := linux_arm64
else
    $(error Unsupported architecture)
endif

Since my pull request, the Dockerfile builds this part of the code while running as the host platform (in the case of Github actions linux/amd64). Before the pull request, this part of the code would be emulated for the target platform (linux/arm64), since this no longer is the case it will instead only build amd64...

This means that for the arm64 builds to work again, the makefile must be updated to respect the TARGETPLATFORM env variable. Docker cross-compilation is surprisingly hard to get right at the first try 🐳

[isZumpo]

PR #191 is up which fixes the issue.

[ericleslie]

You're awesome, thank you!