Skip to main content

Easy Audio Interfaces is a Python library that provides a simple and flexible way to work with audio streams, including recording, playback, network transfer, and processing.

Project description

Easy Audio Interfaces

Easy Audio Interfaces is a Python library that provides a simple and flexible way to work with audio streams, including recording, playback, network transfer, and processing.

Features

  • Socket-based audio streaming
  • Local file reading and writing
  • Audio resampling and rechunking
  • Voice activity detection (VAD) using Silero VAD model
  • Network file transfer

Quick Start

Here's a simple example to get you started - record audio from a socket, process it, and save to a file:

from easy_audio_interfaces import SocketReceiver, LocalFileSink, RechunkingBlock, ResamplingBlock

async with SocketReceiver() as receiver, LocalFileSink("output.wav") as sink:
    rechunker = RechunkingBlock(chunk_size=512)
    resampler = ResamplingBlock(original_sample_rate=receiver.sample_rate, resample_rate=16000)

    rechunked_stream = rechunker.rechunk(receiver)
    resampled_stream = resampler.resample(rechunked_stream)
    await sink.write_from(resampled_stream)

Installation

From PyPI

uv add easy-audio-interfaces

From Source

uv add "https://github.com/AnkushMalaker/python-audio-interfaces.git"

Optional Dependencies

Based on the functionality you require, you should consider installing with the following extras:

# For speech-to-text
uv add "easy-audio-interfaces[stt]"

# For voice activity detection
uv add "easy-audio-interfaces[silero-vad]"

# For Bluetooth audio
uv add "easy-audio-interfaces[bluetooth]"

# For local audio devices
uv add "easy-audio-interfaces[local-audio]"

Usage

Main Components

Audio Sources

  • SocketReceiver: Receives audio data over a WebSocket connection
  • LocalFileStreamer: Streams audio data from a local file

Audio Sinks

  • SocketStreamer: Sends audio data over a WebSocket connection
  • LocalFileSink: Writes audio data to a local file

Processing Blocks

  • CollectorBlock: Collects audio samples for a specified duration
  • ResamplingBlock: Resamples audio to a different sample rate
  • RechunkingBlock: Rechunks audio data into fixed-size chunks

Voice Activity Detection

  • SileroVad: Uses the Silero VAD model for voice activity detection
  • VoiceGate: Applies voice activity detection to segment audio

Examples

Basic Friend Recorder

Records voice segments from a network stream using VAD:

python -m easy_audio_interfaces.examples.basic_friend_recorder

File Network Transfer

Transfer audio files over a network:

# Sender
python -m easy_audio_interfaces.examples.file_network_transfer sender input_file.wav --host localhost --port 8080

# Receiver
python -m easy_audio_interfaces.examples.file_network_transfer receiver output_file.wav --host 0.0.0.0 --port 8080

For more detailed usage and API documentation, please refer to the docstrings in the source code.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

easy_audio_interfaces-0.3.3.tar.gz (26.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

easy_audio_interfaces-0.3.3-py3-none-any.whl (32.0 kB view details)

Uploaded Python 3

File details

Details for the file easy_audio_interfaces-0.3.3.tar.gz.

File metadata

File hashes

Hashes for easy_audio_interfaces-0.3.3.tar.gz
Algorithm Hash digest
SHA256 cf0a261ac0c245af4845c0e3dce0b6422a6392b4a8065203d334b884cc00a459
MD5 36aeaf613bcd1ddc034a25f90b39a75e
BLAKE2b-256 c0015d0e2311d3a25fe103ca32f9eb752c85037558249b20214a563f2e1dd17e

See more details on using hashes here.

File details

Details for the file easy_audio_interfaces-0.3.3-py3-none-any.whl.

File metadata

File hashes

Hashes for easy_audio_interfaces-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9b877fbb7c0eaf7aa00c5c53d99183db7cb08f8b520de2179544f48b400ba974
MD5 33c43257fe048f02d4a86d9b857025d1
BLAKE2b-256 48a791c4ca212056793df970f7c75297d71ba5729b73b858a32a9c1e5146098b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page