May 23rd, 2024 release

[tphakala]

[0.5.3] - 2024-05-21

🚀 Features

• (birdweather) Added location fuzzing support for BirdWeather uploads, requires support for BirdWeather.com
• (audio) Audio source device is now user configurable

🐛 Bug Fixes

• (audio) Audio clip extraction fixed for occassional non-contiguous clips

🚜 Refactor

• (conf) Move default config file from .go to .yaml and add proper default value initialization
• (conf) Update audio export settings in updateconfig.go and realtime.go

🏗️ Building

• (deps) Bump golang.org/x/text from 0.14.0 to 0.15.0
• (deps) Bump golang.org/x/crypto from 0.22.0 to 0.23.0
• (deps) Bump github.com/prometheus/client_golang

⚙️ Miscellaneous Tasks

• Update go version to 1.22.3
• Update golang version to 1.22.3
• Bump HTMX version from 1.9.11 to 1.9.12
• Bump daisyUI to 4.11.1
• Update custom.css to fix theme controller styles
• Update tailwindcss to v3.4.3
• Hide "Detections" column on smaller screens
• Update audio buffer initialization in realtime analysis
• Remove unused import and struct field in audiobuffer.go

---

This discussion was created from the release May 23rd, 2024 release.

[tphakala]

Please note that this version updates config.yaml file structure for realtime audio section quite bit, you need to manually update config.yaml file for new format for now.

# Realtime processing settings
realtime:
    interval: 15 # duplicate prediction interval in seconds
    processingtime: false # true to report processing time for each prediction
    audio:
        source: "sysdefault"
        export:
            enabled: true # true to export audio clips containing indentified bird calls
            path: clips/    # path to audio clip export directory
            type: wav       # only wav supported for now
        retention:
            enabled: true

There is a new source setting for audio , this allows user selectable audio source on Linux, by default it is set to sysdefault and it should select default capture device of your system. Valid settings for this are all sources (sysdefault, default, dsnoop, etc) that are listed with arecord -L

# arecord -L
null
    Discard all samples (playback) or generate zero samples (capture)
sysdefault
    Default Audio Device
default
    Default High-Pass Filtered Device
filtered
    High-Pass Filtered Capture Device
hw:CARD=Device,DEV=0
    USB Audio Device, USB Audio
    Direct hardware device without any conversions
plughw:CARD=Device,DEV=0
    USB Audio Device, USB Audio
    Hardware device with all software conversions
sysdefault:CARD=Device
    USB Audio Device, USB Audio
    Default Audio Device
front:CARD=Device,DEV=0
    USB Audio Device, USB Audio
    Front output / input
dsnoop:CARD=Device,DEV=0
    USB Audio Device, USB Audio
    Direct sample snooping device

Hardware device name is also a valid setting, you can see these with arecord -l

arecord -l
**** List of CAPTURE Hardware Devices ****
card 0: Device [USB Audio Device], device 0: USB Audio [USB Audio]
  Subdevices: 1/1
  Subdevice #0: subdevice #0

in this case

realtime:
    audio:
        source: "USB Audio Device"

would be a valid setting

[tomlut]

Couple of questions about this release:

1. I added/replaced the audio config.yaml section and it appears to be working. However I get this logged repeatedly:

May 26 16:10:31 raspberrypi birdnet-go[1100198]: 2024/05/26 16:10:31 Error retrieving clips for removal: invalid parameters: minHours and minClips must be greater than 0

Are there new parameters I have to add to my config.yaml fix this?

2. arecord -L reports:

$ arecord -L
null
    Discard all samples (playback) or generate zero samples (capture)
default
    Playback/recording through the PulseAudio sound server
sysdefault
    Default Audio Device
lavrate
    Rate Converter Plugin Using Libav/FFmpeg Library
samplerate
    Rate Converter Plugin Using Samplerate Library
speexrate
    Rate Converter Plugin Using Speex Resampler
jack
    JACK Audio Connection Kit
oss
    Open Sound System
pulse
    PulseAudio Sound Server
speex
    Plugin using Speex DSP (resample, agc, denoise, echo, dereverb)
upmix
    Plugin for channel upmix (4,6,8)
vdownmix
    Plugin for channel downmix (stereo) with a simple spacialization
hw:CARD=Device,DEV=0
    USB Audio Device, USB Audio
    Direct hardware device without any conversions
plughw:CARD=Device,DEV=0
    USB Audio Device, USB Audio
    Hardware device with all software conversions
sysdefault:CARD=Device
    USB Audio Device, USB Audio
    Default Audio Device
front:CARD=Device,DEV=0
    USB Audio Device, USB Audio
    Front output / input
dsnoop:CARD=Device,DEV=0
    USB Audio Device, USB Audio
    Direct sample snooping device
usbstream:CARD=Device
    USB Audio Device
    USB Stream Output

At the moment I am using sysdefault however it has quite a bit of 50Hz hum. Attempts to control this with hardware cable routing, new USB soundcard, and ferrite chokes have not really made a difference. I noticed in your example there was this source:

filtered
    High-Pass Filtered Capture Device

Is there a way I can add this as a source?

[tphakala]

"Error retrieving clips for removal: invalid parameters: minHours and minClips must be greater than 0"
This is just a cosmetic issue caused by audio file cleanup process, if retention time parameters are not set they default to 0 and this message will pop up every minute. I will fix this in upcoming releases.

On Linux high pass filter can be configured using ALSA, my ~/.asoundrc file is

pcm.!default {
    type plug
    slave.pcm "filtered"
    hint {
        show on
        description "Default High-Pass Filtered Device"
    }
}

pcm.filtered {
    type ladspa
    slave.pcm "plug:dsnoop"
    path "/usr/lib/ladspa"
    plugins [
        {
            label "hpf"
            input {
                controls [ 300 ] # Cutoff frequency for the high-pass filter
            }
        }
    ]
    hint {
        show on
        description "High-Pass Filtered Capture Device"
    }
}

This requires ladspa-sdk to be installed, on Debian / Ubuntu / Raspberry Pi OS install command should be

sudo apt install ladspa-sdk

Once this is configured you should see filtered in arecord -L listing.

[tomlut]

I installed ladspa-sdk and created ~/.asoundrc with the above contents and did see filtered in the arecord -L listing. So I changed my config to use source: "default" instead of "sysdefault" and it worked! Thank you.

if retention time parameters are not set they default to 0

If I wanted to set some retention parameters what would I add to the config file?

[tphakala]

New v0.5.4 version contains completely reworked audio clip retention code, it is set to keep disk utilization at 80% level by default. When you upgrade please backup your current config and let birdnet-go create a new config with new config file structure.