Skip to content

Commit

Permalink
Good to go.
Browse files Browse the repository at this point in the history
  • Loading branch information
AdityaSeth777 committed Mar 28, 2024
1 parent f581af5 commit 9e041a4
Show file tree
Hide file tree
Showing 7 changed files with 22 additions and 141 deletions.
114 changes: 0 additions & 114 deletions Audio_SpectraCLI.egg-info/PKG-INFO

This file was deleted.

10 changes: 0 additions & 10 deletions Audio_SpectraCLI.egg-info/SOURCES.txt

This file was deleted.

1 change: 0 additions & 1 deletion Audio_SpectraCLI.egg-info/dependency_links.txt

This file was deleted.

8 changes: 0 additions & 8 deletions Audio_SpectraCLI.egg-info/requires.txt

This file was deleted.

1 change: 0 additions & 1 deletion Audio_SpectraCLI.egg-info/top_level.txt

This file was deleted.

27 changes: 21 additions & 6 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,13 @@

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.

## Features
## Current Features (with respect to 2.2)

- Real-time audio spectrum visualization.
- Interactive CLI menu for easy navigation.
- Cross-platform compatibility (works on Windows, macOS, and Linux).
- 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

Expand Down Expand Up @@ -50,15 +52,28 @@ pip install Audio-SpectraCLI

2. Import and use modules

- Create a Python file.
- You can use [Example.py](./tests/main.py) as a reference or use the following code :

```
from Audio_SpectraCLI import audio_visualizer
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
- 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.

Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name = Audio-SpectraCLI
version = 2.2
author = Aditya Seth
author_email = [email protected]
author_email = [email protected]
description = 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.
license = MIT
home-page = https://github.com/AdityaSeth777/Audio-SpectraCLI

0 comments on commit 9e041a4

Please sign in to comment.