BirdNET powered soundscape analysis for bird song identification
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Samuel ORTION d6763f6e54 Merge pull request 'dev' (#1) from dev into main 3 months ago
.github/ISSUE_TEMPLATE Update issue templates 4 months ago
.ideas db: Add mysql support for birdnet_observation database 3 months ago
analyzer@cb3707813f Switch submodule git address to http 3 months ago
config db: Add mysql support for birdnet_observation database 3 months ago
daemon db: Add mysql support for birdnet_observation database 3 months ago
docker docker: Symfony seems to be running (still mysql issues) 3 months ago
docs db: Add mysql support for birdnet_observation database 3 months ago
media Generate favicon 4 months ago
utils Update install.sh 3 months ago
www daemon: Remove birdnet_miner and call birdnet_output_to_sql at each new model execution 3 months ago
.dockerignore docker: Working on mysql database and symfony dependencies 3 months ago
.env.example docker: Working on mysql database and symfony dependencies 3 months ago
.gitignore Remove instance specific .env file 3 months ago
.gitmodules Switch submodule git address to http 3 months ago
CHANGELOG.md daemon: Remove birdnet_miner and call birdnet_output_to_sql at each new model execution 3 months ago
CONTRIBUTING.md Trying to port BirdNET-stream to Docker 3 months ago
INSTALL.md daemon: Remove birdnet_miner and call birdnet_output_to_sql at each new model execution 3 months ago
LICENSE Initial commit 4 months ago
README.md docs: Updated CHANGELOG and README for better installation méthod 3 months ago
TODO docker: Working database creation 3 months ago
docker-compose.yml docker: Symfony seems to be running (still mysql issues) 3 months ago
install.sh daemon: Remove birdnet_miner and call birdnet_output_to_sql at each new model execution 3 months ago
requirements.txt Add plotter and fix miner 4 months ago
uninstall.sh daemon: Remove birdnet_miner and call birdnet_output_to_sql at each new model execution 3 months ago

README.md

BirdNET-stream

Realtime BirdNET powered soundscape analysis for bird song identification.

BirdNET-stream logo image IA generated

Introduction

BirdNET-stream records sound 24/7 on any Linux computer with a microphone and analyze it using BirdNET algorithm by @kahst.

Bird contacts are stored in a database and are made accessible in a webapp.

Features

  • 24/7 recording and BirdNET-Analyzer analysis of sound
  • Live audio streaming and live spectrogram visualization from web browser
  • Bird contacts saved into a SQL database
  • Web Interface for system monitoring, data analysis and visualization

Requirements

BirdNET-stream aims to be able to run on any 64-bit Linux computer. It has been tested on Fedora and Debian.

It should work on a Raspberry Pi (or other Single Board Computer) with a USB microphone or Sound Card (not tested yet).

Installation

Warning BirdNET-stream is in early development, and may not work properly...

On debian based systems (tested on Debian Bullseye), the following command should allow you to install the base components without too much trouble:

# Change to your installation directory here, /home/$USER/Documents/BirdNET-stream for instance, or /opt/birdnet-stream, or whatever
cd /path/to/installation/directory
# Download installation script 
curl -0 https://raw.githubusercontent.com/UncleSamulus/BirdNET-stream/main/install.sh
# Run installation script:
chmod +x ./install.sh
./install.sh

I recommend to add DEBUG=1 before this command to see the installation steps:

DEBUG=1 ./install.sh

To install from a specific git branch, add BRANCH=<branch> before the command, for instance:

BRANCH=dev DEBUG=1 ./install.sh

For finer control, or to adapt to your system, you can follow the instructions in the INSTALL.md file (it may unfortunatly not be accurate for your system).

Usage

  • BirdNET-stream web application can be accessed on any web browser at https://birdnet.home, from your local network, or at any other hostname you set in nginx configuration, if your public IP is accessible from the internet.

  • See the species detected

Acknoledgments

  • BirdNET on which this project relies
  • BirdNET-Pi the great inspiration of this project

License

BirdNET-stream is licensed under the GNU General Public License v3.0, see ./LICENSE for more details.