soundcheck 0.0.36

A terminal-based audio monitoring application that displays real-time audio levels and exits when sound exceeds a specified threshold.
soundcheck-0.0.36 is not a library.

Soundcheck

A terminal-based audio monitoring application that displays real-time audio levels and exits when sound exceeds a specified threshold.

Installation 🚀

From Crates.io

cargo install soundcheck

From Homebrew

brew tap isfopo/homebrew-tap

brew install soundcheck

From Chocolatey (Windows)

choco install soundcheck

From Source

git clone <repository-url>
cd soundcheck
cargo build --release
# Binary will be at target/release/soundcheck

Contributing & Development 🤝

Release Process

For detailed information about creating and publishing releases, see RELEASE.md.

Usage 📖

Basic Usage

# Monitor with default settings (0 dB threshold)
soundcheck

# Set custom threshold
soundcheck --threshold=-10

# Specify audio device
soundcheck --device="MacBook Pro Microphone"

# Combine options
soundcheck --threshold=-25 --device="External USB Audio"

Command Line Options

Option Description Default Example
--threshold Audio threshold in dB (-60 to 0) 0 --threshold -30
--device Audio input device name Default device --device "USB Microphone"

Command Chaining Examples

# Continue to next command only if threshold reached
soundcheck && echo "Audio detected!"

# Run fallback command if user exits
soundcheck || echo "Monitoring cancelled by user"

# Error handling
soundcheck || echo "Failed to start monitoring"

Requirements 📋

System Requirements

  • macOS: 10.15 or later
  • Linux: Kernel 3.16+ with ALSA
  • Windows: Windows 10+ with WASAPI

Dependencies

  • Rust: 1.70+ (for edition 2021)
  • Audio Libraries: System audio frameworks
    • macOS: CoreAudio
    • Linux: ALSA
    • Windows: WASAPI

Development 🛠️

Building

# Debug build
cargo build

# Release build
cargo build --release

# Run tests
cargo test

# Check code quality
cargo clippy
cargo fmt

Troubleshooting 🔍

Common Issues

"No default input device"

  • Ensure your microphone/audio input is connected and enabled
  • Check system audio settings

"Device not found"

  • Use soundcheck --help to see available options
  • Verify the device name spelling

Blank screen on startup

  • Ensure terminal supports Unicode characters
  • Try a different terminal emulator

Audio levels not updating

  • Check that the correct audio device is selected
  • Verify audio input permissions
  • Test with different threshold values

Debug Mode

# Run with verbose output
RUST_LOG=debug cargo run -- --threshold -20

License 📄

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments 🙏

  • CPAL - Cross-platform audio library
  • Ratatui - Terminal UI framework
  • Tokio - Async runtime
  • Clap - Command line parsing