tphakala / birdnet-go

Realtime BirdNET soundscape analyzer
Other
135 stars 13 forks source link

refactor: refactor analysis and capture buffers to support multiple i… #188

Closed tphakala closed 3 weeks ago

tphakala commented 3 weeks ago

…ndividual buffers for different audio sources

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The recent changes introduce a multi-source audio processing capability, replacing single audio buffer handling with a map of audio buffers. This affects various components, including the Processor, DatabaseAction, and several functions related to audio capture and processing. New fields like Source have been added to structs to track the origin of audio data. Additionally, concurrency control and logging improvements have been made to enhance robustness and traceability.

Changes

File Path Change Summary
internal/analysis/processor/actions.go Modified DatabaseAction to use AudioBuffers map, updated Execute method to call myaudio.ReadSegmentFromCaptureBuffer.
internal/analysis/processor/processor.go Updated Processor struct to use AudioBuffers map, added Source to PendingDetection, modified New function parameters.
internal/analysis/processor/speciesconfig.go Added logging for loading species config and conditional debug logging.
internal/analysis/processor/workers.go Updated getDefaultActions method to handle AudioBuffers map.
internal/analysis/queue/queue.go Added Source field to Results struct.
internal/analysis/realtime.go Initialized ring buffers for audio sources, updated buffer initialization, and adjusted audio capture routine.
internal/birdnet/analyze.go Added concurrency control to Predict method, included source and clipName in observation.New call.
internal/birdnet/birdnet.go Added sync.Mutex to BirdNET struct.
internal/datastore/model.go Commented out InputFile field, added Source field to Note struct.
internal/myaudio/audiobuffer.go Introduced audioBuffers map, mutex for concurrency, and new buffer management functions.
internal/myaudio/buffers.go Enhanced buffer management for multiple audio sources, added PCM data validation.
internal/myaudio/capture.go Updated CaptureAudio function to use new buffer management functions.
internal/myaudio/process.go Updated ProcessData function to include source parameter, added Source field to Results struct.
internal/myaudio/rstp.go Modified captureAudioRTSP to use new buffer management functions.
internal/observation/observation.go Updated New function to include source parameter, set Source field in datastore.Note struct.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant Settings
    participant Processor
    participant BirdNET
    participant AudioSource
    participant AudioBuffer
    participant DataStore

    Settings->>Processor: Initialize with settings
    Processor->>AudioSource: Capture audio data
    AudioSource->>AudioBuffer: Write data to buffer
    AudioBuffer->>Processor: Notify data available
    Processor->>BirdNET: Send audio segment for analysis
    BirdNET->>DataStore: Store analysis results with source info
    DataStore-->>Processor: Acknowledge storage

Poem

In a forest of code, where buffers reside,
The streams now flow with sources wide.
From single paths to maps we glide,
With mutex locks and logs to guide.
Each note now sings its origin's pride,
In data's dance, we now confide.
Hopping forward, side by side. 🐇🎶


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.