new plugin: audio-stream

[dnecra]

Audio Stream Plugin

Description

This plugin enables streaming of raw PCM (Pulse Code Modulation) audio data from Pear Desktop over HTTP. It allows external applications, recording software, or other devices on your local network to receive real-time audio streams for processing, recording, or playback.

How It Works

The plugin consists of three main components:

1. Renderer Process: Captures audio from the Web Audio API using a ScriptProcessorNode, converts the audio samples to PCM format (16-bit or 32-bit), and sends the data to the backend via IPC.

2. Backend Process: Runs an HTTP server that listens for client connections. When clients connect to the /stream endpoint, the server streams PCM audio data in real-time. The server maintains a small buffer of recent audio chunks so new clients can catch up.

3. Configuration: Users can configure the streaming port, hostname, and audio quality settings (sample rate, bit depth, channels, buffer size) through the plugin menu.

Key Features

• Real-time PCM streaming over HTTP
• Configurable audio quality: Sample rates (44.1kHz, 48kHz, 96kHz), bit depths (16-bit, 32-bit), mono/stereo
• Low latency: Configurable buffer sizes (1024-8192 samples) for balancing latency vs. stability
• Multiple client support: Multiple applications can connect simultaneously
• Dynamic configuration: Audio settings can be changed without restarting the app
• CORS enabled: Allows connections from web-based applications

Use Cases

• Recording audio from Pear Desktop to external software
• Real-time audio processing and analysis
• Streaming to external audio devices or applications
• Integration with home automation or audio routing systems
• Audio visualization or analysis tools

Technical Details

• Default port: 8765
• Default hostname: 0.0.0.0 (listens on all interfaces)
• Default audio settings: 48kHz, 16-bit, stereo, 2048 sample buffer
• Protocol: HTTP streaming with binary PCM data
• Format: Each chunk includes metadata (sample rate, bit depth, channels, timestamp) followed by raw PCM samples

Configuration

The plugin can be configured through the Pear Desktop menu:

• Port: Set the HTTP server port (default: 8765)
• Quality & Latency: Adjust sample rate, bit depth, channels, and buffer size

Stream URL format: http://localhost:{port}/stream

[ArjixWasTaken]

If we are going to add audio streaming, we should do what internet radio stations do, so existing radio apps will be supported.

I see you designed your own interface for streaming data+metadata, requiring a custom client to receive the stream.
I believe we should instead follow the Icecast Protocol.

Also, using node:http is discouraged, if you look at the api-server plugin you'll see that we use a lightweight library named hono, which is really similar to express.js

Therefore I will be marking this PR as a draft, and will help make the necessary changes.