Metadata-Version: 2.1
Name: Audio_SpectraCLI
Version: 3.1
Summary: AudioSpectraCLI is a command-line tool that provides real-time FFT visualization of audio spectra. It captures audio input from the microphone and displays the corresponding frequency spectrum directly in the terminal window, allowing users to monitor and analyze audio signals without the need for graphical interfaces.
Home-page: https://github.com/AdityaSeth777/Audio-SpectraCLI
Author: Aditya Seth
Author-email: contact@adityaseth.in
License: MIT
Description-Content-Type: text/markdown
License-File: LICENSE

```
    _             _ _            ____                  _              ____ _     ___
   / \  _   _  __| (_) ___      / ___| _ __   ___  ___| |_ _ __ __ _ / ___| |   |_ _|
  / _ \| | | |/ _` | |/ _ \ ____\___ \| '_ \ / _ \/ __| __| '__/ _` | |   | |    | |
 / ___ \ |_| | (_| | | (_) |_____|__) | |_) |  __/ (__| |_| | | (_| | |___| |___ | |
/_/   \_\__,_|\__,_|_|\___/     |____/| .__/ \___|\___|\__|_|  \__,_|\____|_____|___|
                                      |_|
```

Audio Spectrum Visualization is a Python project that visualizes real-time audio input as a spectrum using Fast Fourier Transform (FFT). It provides an interactive CLI interface for users to start the visualization and exit the program.

## Current Features (with respect to 3.1)

- Real-time visualization of Fast Fourier Transform (FFT) spectrum of audio input.
- Support for adjusting parameters such as duration, sampling rate, and block size.
- Seamless integration with SoundDevice for audio input capture.
- Customizable Frequency Range: Allow users to specify the frequency range to display in the spectrum.
- Color Customization: Provide options for users to customize the colors used in the spectrum visualization.

## Packaging

```
Audio-SpectraCLI/

│   CODE_OF_CONDUCT.md
│   Contributing.md
│   LICENSE
│   Readme.md
│   requirements.txt
│   setup.cfg
│   setup.py
│
├───.github
│   └───workflows
│           python-publish.yml
│
├───Audio_SpectraCLI
│       main.py
│       __init__.py
│
└───tests
        main.py
```

## Installation & Usage

1. Install using pip

```
pip install Audio-SpectraCLI
```

2. Import and use modules

- Create a Python file.
- You can use [Example.py](https://github.com/AdityaSeth777/Audio-SpectraCLI/blob/3.1/tests/main.py) as a reference or use the following code :

```
from Audio_SpectraCLI import AudioSpectrumVisualizer

# Creating an instance of AudioSpectrumVisualizer with custom parameters.
audio_visualizer = AudioSpectrumVisualizer(
    duration=5, frequency_range=(50, 5000), color='red')

# Starting the audio spectrum visualization
audio_visualizer.start_visualization()
```

- Once you have activated the audio_visualizer instance, feel free to use it wherever in the program. It consists of several parameters (which gives more control to the user), so make sure to configure and add those before using it in your code.

---

## Upcoming Features

- CLI endpoints.
- Option to choose between CLI/GUI.
- Save and Export: Implement functionality to save the generated spectrum as an image file or export data for further analysis.
- Additional Audio Effects: Integrate additional audio effects or processing options to enhance the visualization.

---

## For contributing

Check the [Contributing page.](https://github.com/AdityaSeth777/Audio-SpectraCLI/blob/main/Contributing.md)
Make sure to PR your changes in the development branch.

## .env file

This file contains various environment variables that you can configure.

## License

[MIT © Aditya Seth](https://github.com/AdityaSeth777/Audio-SpectraCLI/blob/main/LICENSE)

## What next?

I will be improving this project.

## Where to contact ?

Contact: [contact@adityaseth.in]

## 🙋‍♂️ Support

💙 If you like this project, give it a ⭐ and share it with friends!<br><br>
[☕ Buy me a coffee](https://www.buymeacoffee.com/adityaseth)

---

Made with ❤️
