June 9th, 2024 release

[tphakala]

[0.5.5] - 2024-06-09

🚀 Features

• (audio) Support for multiple RTSP streams
• (birdnet) Range filter model is now selectable between latest and previous "legacy" version
• (birdnet) Added "birdnet-go range print" command which lists all species included by range filter model
• (birdnet) BirdNET overlap setting impacts now realtime process also

🐛 Bug Fixes

• (privacy) Fix defaults for privacy and dog bark filters and fix incorrect setting names in default config.yaml
• (privacy) Do not print dog bark detections if dog bark filter is not enabled
• (privacy) Fix printf declaration for human detection confidence reporting
• (audio) Yield to other goroutines in file_utils, policy_age, and policy_usage
• (build) Linux/arm64 cross-compilation in docker build

🚜 Refactor

• (audio) Refactor analysis and capture buffers to support multiple individual buffers for different audio sources
• (audio) Move RTSP code to rtsp.go
• (config) Config file format for range filter model changed due model type option
• (rtsp) Update default RTSP URLs to an empty slice
• (rtsp) Update RTSP stream URLs example in config.yaml
• (privacy) Make pricacy filter and dog bark filter source specific
• (build) Move buildDate variable to main.go

🏗️ Building

• (deps) Bump github.com/spf13/viper from 1.18.2 to 1.19.0
• (deps) Bump github.com/shirou/gopsutil/v3 from 3.24.4 to 3.24.5

---

This discussion was created from the release June 9th, 2024 release.

[tphakala]

There is a lot of changes in this release which may require you to update your config.yaml files

# BirdNET model specific settings
birdnet:
  sensitivity: 1.0      # sigmoid sensitivity, 0.1 to 1.5
  threshold: 0.8        # threshold for prediction confidence to report, 0.0 to 1.0
  overlap: 1.5          # overlap between chunks, 0.0 to 2.9
  threads: 0            # 0 to use all available CPU threads
  locale: en            # language to use for labels
  latitude: 00.000      # latitude of recording location for prediction filtering
  longitude: 00.000     # longitude of recording location for prediction filtering
  rangefilter:
      model: latest     # model to use for range filter: "latest" or "legacy" for previous model
      threshold: 0.01   # rangefilter species occurrence threshold

Overlap setting under birdnet now impacts realtime mode also, previously it affected file analysis only. Realtime mode has been using overlap value of 1.5 as fixed setting until now, if you had no issues with CPU utilization before I'd recommend that you set overlap to 1.5 in config.yaml to maintain same detection level, lower value will reduce CPU usage but can cause loss in detection accuracy.

Locationfilterthreshold was renamed to rangefilter.threshold due to new setting rangefilter.model, there has been reports of some species being excluded from detection by BirdNET_GLOBAL_6K_V2.4_MData_Model_V2_FP16.tflite range model so I included previous version to which you can fallback by setting rangefilter.model value to legacy.

Multiple RTSP streams are now supported so RTSP URL setting changed slightly

  rtsp:    
    transport: tcp        # RTSP Transport Protocol
    urls:                 # RTSP stream URLs
      # - rtsp://user:password@example.com/stream1
      # - rtsp://user:password@example.com/stream2
      # - rtsp://user:password@example.com/stream3

rtsp.url was renamed to rtsp.urls and URLs are now defined as shown above (# is a comment marker and should be removed for proper config).

There is a new command line option "range print" which lists all species included by current range filter settings (model, threshold, location and date). This is to help with troubleshooting range filter issues like excluded species etc.

"range print" setting accepts date and week as parameter, week number values are from 1 to 48 as BirdNET range model assumes that every month has exectly 4 weeks.

./bin/birdnet-go range print --locale en
BirdNET-Go build date: 2024-06-09T12:50:59Z, using config file: /etc/birdnet-go/config.yaml
BirdNET GLOBAL 6K V2.4 FP32 model initialized, using 4 threads of available 4 CPUs
2024/06/09 17:16:09 Using latest range filter model
Included species for 61.xxx, 25.xxx on date 2024-06-09, week 22, threshold 0.010000

Scientific Name                   Common Name                       Score
--------------------------------- --------------------------------- ------
Dog                               Dog                               1.0000
Engine                            Engine                            1.0000
Environmental                     Environmental                     1.0000
Fireworks                         Fireworks                         1.0000
Gun                               Gun                               1.0000
Human non-vocal                   Human non-vocal                   1.0000
Ciccaba huhula                    Black-banded Owl                  1.0000
Siren                             Siren                             1.0000
Power tools                       Power tools                       1.0000
Noise                             Noise                             1.0000
Human whistle                     Human whistle                     1.0000
Human vocal                       Human vocal                       1.0000
Corvus cornix                     Hooded Crow                       0.9999
Motacilla alba                    White Wagtail                     0.9905
Fringilla coelebs                 Common Chaffinch                  0.9772
Larus canus                       Common Gull                       0.9583
Hirundo rustica                   Barn Swallow                      0.9422
Phylloscopus trochilus            Willow Warbler                    0.9244
Chroicocephalus ridibundus        Black-headed Gull                 0.9016
Turdus pilaris                    Fieldfare                         0.9006
Columba palumbus                  Common Wood-Pigeon                0.8694
Parus major                       Great Tit                         0.8056
Turdus merula                     Eurasian Blackbird                0.7669
Apus apus                         Common Swift                      0.7590
Sterna hirundo                    Common Tern                       0.7107
Anas platyrhynchos                Mallard                           0.6383
Turdus iliacus                    Redwing                           0.5676
Ficedula hypoleuca                European Pied Flycatcher          0.5535
Vanellus vanellus                 Northern Lapwing                  0.5278
Cyanistes caeruleus               Eurasian Blue Tit                 0.4940
Bucephala clangula                Common Goldeneye                  0.4940
Sylvia borin                      Garden Warbler                    0.4859
Corvus monedula                   Eurasian Jackdaw                  0.4842
Cuculus canorus                   Common Cuckoo                     0.4594
Spinus spinus                     Eurasian Siskin                   0.4541
Erithacus rubecula                European Robin                    0.4402
Cygnus cygnus                     Whooper Swan                      0.4328
Turdus philomelos                 Song Thrush                       0.4087
Pica pica                         Eurasian Magpie                   0.3882
Numenius arquata                  Eurasian Curlew                   0.3818
Emberiza citrinella               Yellowhammer                      0.3776
Larus argentatus                  Herring Gull                      0.3771
Dendrocopos major                 Great Spotted Woodpecker          0.3715
Grus grus                         Common Crane                      0.3580
Carpodacus erythrinus             Common Rosefinch                  0.3515
Sturnus vulgaris                  European Starling                 0.3412
Anas crecca                       Green-winged Teal                 0.3322
Anthus trivialis                  Tree Pipit                        0.3153
Aythya fuligula                   Tufted Duck                       0.3109
Emberiza schoeniclus              Reed Bunting                      0.2971
Podiceps cristatus                Great Crested Grebe               0.2896
Phylloscopus collybita            Common Chiffchaff                 0.2772
Chloris chloris                   European Greenfinch               0.2750
Curruca communis                  Greater Whitethroat               0.2732
Acrocephalus schoenobaenus        Sedge Warbler                     0.2653
Delichon urbicum                  Common House-Martin               0.2647
Curruca curruca                   Lesser Whitethroat                0.2644
Actitis hypoleucos                Common Sandpiper                  0.2619
Sterna paradisaea                 Arctic Tern                       0.2570
Muscicapa striata                 Spotted Flycatcher                0.2519
Passer montanus                   Eurasian Tree Sparrow             0.2486
Mergus merganser                  Common Merganser                  0.2425
Alauda arvensis                   Eurasian Skylark                  0.2419
Tringa glareola                   Wood Sandpiper                    0.2321
Gallinago gallinago               Common Snipe                      0.2256
Sylvia atricapilla                Eurasian Blackcap                 0.2228
Phoenicurus phoenicurus           Common Redstart                   0.2143
Tringa nebularia                  Common Greenshank                 0.2128
Branta leucopsis                  Barnacle Goose                    0.2076
Hydrocoloeus minutus              Little Gull                       0.2036
Cygnus olor                       Mute Swan                         0.1999
Passer domesticus                 House Sparrow                     0.1987
Haematopus ostralegus             Eurasian Oystercatcher            0.1905
Luscinia luscinia                 Thrush Nightingale                0.1868
Motacilla flava                   Western Yellow Wagtail            0.1832
Gavia arctica                     Arctic Loon                       0.1814
Anser anser                       Graylag Goose                     0.1789
Mareca penelope                   Eurasian Wigeon                   0.1769
Saxicola rubetra                  Whinchat                          0.1750
Larus fuscus                      Lesser Black-backed Gull          0.1745
Phylloscopus sibilatrix           Wood Warbler                      0.1654
Tringa totanus                    Common Redshank                   0.1650
Ardea cinerea                     Gray Heron                        0.1604
Fulica atra                       Eurasian Coot                     0.1554
Oenanthe oenanthe                 Northern Wheatear                 0.1519
Carduelis carduelis               European Goldfinch                0.1500
Falco tinnunculus                 Eurasian Kestrel                  0.1496
Columba livia                     Rock Pigeon                       0.1491
Corvus corax                      Common Raven                      0.1482
Hydroprogne caspia                Caspian Tern                      0.1450
Hippolais icterina                Icterine Warbler                  0.1441
Phalacrocorax carbo               Great Cormorant                   0.1438
Scolopax rusticola                Eurasian Woodcock                 0.1428
Circus aeruginosus                Eurasian Marsh-Harrier            0.1396
Spatula clypeata                  Northern Shoveler                 0.1360
Acrocephalus dumetorum            Blyth's Reed Warbler              0.1336
Mergus serrator                   Red-breasted Merganser            0.1317
Tringa ochropus                   Green Sandpiper                   0.1302
Larus marinus                     Great Black-backed Gull           0.1296
Pandion haliaetus                 Osprey                            0.1271
Riparia riparia                   Bank Swallow                      0.1252
Branta canadensis                 Canada Goose                      0.1219
Falco subbuteo                    Eurasian Hobby                    0.1201
Regulus regulus                   Goldcrest                         0.1200
Calidris pugnax                   Ruff                              0.1184
Mareca strepera                   Gadwall                           0.1147
Troglodytes troglodytes           Eurasian Wren                     0.1146
Haliaeetus albicilla              White-tailed Eagle                0.1093
Anthus pratensis                  Meadow Pipit                      0.1087
Prunella modularis                Dunnock                           0.1071
Loxia curvirostra                 Red Crossbill                     0.1054
Turdus viscivorus                 Mistle Thrush                     0.1034
Acrocephalus palustris            Marsh Warbler                     0.1017
Podiceps grisegena                Red-necked Grebe                  0.1010
Crex crex                         Corn Crake                        0.1007
Charadrius dubius                 Little Ringed Plover              0.0988
Lanius collurio                   Red-backed Shrike                 0.0964
Linaria cannabina                 Eurasian Linnet                   0.0929
Dryocopus martius                 Black Woodpecker                  0.0891
Botaurus stellaris                Great Bittern                     0.0884
Pyrrhula pyrrhula                 Eurasian Bullfinch                0.0868
Acrocephalus scirpaceus           Eurasian Reed Warbler             0.0862
Columba oenas                     Stock Dove                        0.0859
Jynx torquilla                    Eurasian Wryneck                  0.0819
Certhia familiaris                Eurasian Treecreeper              0.0814
Charadrius hiaticula              Common Ringed Plover              0.0797
Anas acuta                        Northern Pintail                  0.0785
Lyrurus tetrix                    Black Grouse                      0.0785
Podiceps auritus                  Horned Grebe                      0.0754
Buteo buteo                       Common Buzzard                    0.0737
Melanitta fusca                   Velvet Scoter                     0.0728
Tringa erythropus                 Spotted Redshank                  0.0723
Phasianus colchicus               Ring-necked Pheasant              0.0720
Fringilla montifringilla          Brambling                         0.0711
Lullula arborea                   Wood Lark                         0.0664
Garrulus glandarius               Eurasian Jay                      0.0648
Locustella naevia                 Common Grasshopper-Warbler        0.0637
Poecile montanus                  Willow Tit                        0.0636
Rallus aquaticus                  Water Rail                        0.0635
Sitta europaea                    Eurasian Nuthatch                 0.0620
Aythya ferina                     Common Pochard                    0.0619
Accipiter nisus                   Eurasian Sparrowhawk              0.0614
Coturnix coturnix                 Common Quail                      0.0610
Lophophanes cristatus             Crested Tit                       0.0609
Caprimulgus europaeus             Eurasian Nightjar                 0.0576
Asio flammeus                     Short-eared Owl                   0.0572
Calidris alpina                   Dunlin                            0.0571
Ardea alba                        Great Egret                       0.0562
Pernis apivorus                   European Honey-buzzard            0.0560
Locustella fluviatilis            River Warbler                     0.0540
Calidris temminckii               Temminck's Stint                  0.0531
Sternula albifrons                Little Tern                       0.0530
Melanitta nigra                   Common Scoter                     0.0525
Luscinia svecica                  Bluethroat                        0.0522
Gallinula chloropus               Eurasian Moorhen                  0.0521
Tadorna tadorna                   Common Shelduck                   0.0521
Dryobates minor                   Lesser Spotted Woodpecker         0.0515
Acrocephalus arundinaceus         Great Reed Warbler                0.0511
Somateria mollissima              Common Eider                      0.0502
Pluvialis apricaria               European Golden-Plover            0.0498
Oriolus oriolus                   Eurasian Golden Oriole            0.0497
Periparus ater                    Coal Tit                          0.0494
Mergellus albellus                Smew                              0.0484
Stercorarius parasiticus          Parasitic Jaeger                  0.0475
Coccothraustes coccothraustes     Hawfinch                          0.0470
Numenius phaeopus                 Whimbrel                          0.0468
Phoenicurus ochruros              Black Redstart                    0.0463
Gavia stellata                    Red-throated Loon                 0.0448
Strix aluco                       Tawny Owl                         0.0445
Lanius excubitor                  Great Gray Shrike                 0.0444
Motacilla cinerea                 Gray Wagtail                      0.0443
Chlidonias niger                  Black Tern                        0.0442
Phylloscopus trochiloides         Greenish Warbler                  0.0438
Spatula querquedula               Garganey                          0.0434
Milvus migrans                    Black Kite                        0.0433
Porzana porzana                   Spotted Crake                     0.0427
Limosa limosa                     Black-tailed Godwit               0.0423
Picus canus                       Gray-headed Woodpecker            0.0420
Accipiter gentilis                Northern Goshawk                  0.0413
Calidris ferruginea               Curlew Sandpiper                  0.0411
Calidris canutus                  Red Knot                          0.0411
Corvus frugilegus                 Rook                              0.0411
Calidris falcinellus              Broad-billed Sandpiper            0.0409
Pluvialis squatarola              Black-bellied Plover              0.0402
Circus cyaneus                    Hen Harrier                       0.0399
Perdix perdix                     Gray Partridge                    0.0393
Asio otus                         Long-eared Owl                    0.0385
Aythya marila                     Greater Scaup                     0.0383
Emberiza hortulana                Ortolan Bunting                   0.0382
Loxia pytyopsittacus              Parrot Crossbill                  0.0380
Alca torda                        Razorbill                         0.0377
Ficedula parva                    Red-breasted Flycatcher           0.0375
Gallinago media                   Great Snipe                       0.0373
Streptopelia decaocto             Eurasian Collared-Dove            0.0372
Tetrao urogallus                  Western Capercaillie              0.0368
Bubo bubo                         Eurasian Eagle-Owl                0.0365
Tetrastes bonasia                 Hazel Grouse                      0.0352
Alcedo atthis                     Common Kingfisher                 0.0352
Acanthis flammea                  Common Redpoll                    0.0340
Arenaria interpres                Ruddy Turnstone                   0.0333
Cinclus cinclus                   White-throated Dipper             0.0333
Nucifraga caryocatactes           Eurasian Nutcracker               0.0331
Tachybaptus ruficollis            Little Grebe                      0.0327
Clangula hyemalis                 Long-tailed Duck                  0.0326
Bombycilla garrulus               Bohemian Waxwing                  0.0324
Anser fabalis                     Taiga Bean-Goose                  0.0319
Aegithalos caudatus               Long-tailed Tit                   0.0312
Falco peregrinus                  Peregrine Falcon                  0.0309
Limosa lapponica                  Bar-tailed Godwit                 0.0308
Picoides tridactylus              Eurasian Three-toed Woodpecker    0.0302
Stercorarius longicaudus          Long-tailed Jaeger                0.0301

Total number of species: 211