Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update demo images and gif in readme #12

Merged
merged 3 commits into from Mar 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 3 additions & 2 deletions Cargo.toml
Expand Up @@ -25,9 +25,10 @@ serde_yaml = "0.9.32"
spectrum-analyzer = "1.5.0"
stopwatch = "0.0.7"

# [profile.release]
[profile.release]
strip = true
opt-level = 3
# lto = true
# opt-level = 3
# codegen-units = 1
# incremental = false

56 changes: 19 additions & 37 deletions README.md
@@ -1,9 +1,10 @@
# fftviz
A lightweight, customizable FFT visualizer for audio files. Built with Rust + Bevy.

![Screenshot-2024-03-04-at-24620AM](https://github.com/gursi26/fftviz/assets/75204369/9c2d919c-c28c-4021-84dd-64e86d57ae2f)
![Presentation1](https://github.com/gursi26/fftviz/assets/75204369/590f0021-1aa3-44a1-9396-c0daf4af4080)

![demo](https://github.com/gursi26/fftviz/assets/75204369/9f78622f-705e-499f-a981-7aa110f0b2ca)

![demo](https://github.com/gursi26/fftviz/assets/75204369/93b28c8f-d989-49c0-9ec3-dc3fbf7bb2ca)

# Installation

Expand Down Expand Up @@ -42,40 +43,21 @@ Arguments:
<FILE_PATH> File path to Audio file
Options:
--fft-fps <FFT_FPS>
Temporal resolution for FFT calculation (rendering always occurs at 60 fps with interpolation) [default: 12]
--smoothness <SMOOTHNESS>
Smoothing factor for spatial interpolation between bars [default: 1]
--freq-resolution <FREQ_RESOLUTION>
Number of individual frequencies detected by the FFT [default: 90]
--min-freq <MIN_FREQ>
Maximum frequency detected by FFT [default: 0]
--max-freq <MAX_FREQ>
Minimum frequency detected by FFT [default: 5000]
--volume <VOLUME>
Volume [default: 0.7]
--width <WINDOW_WIDTH>
Window width [default: 1000]
--height <WINDOW_HEIGHT>
Window height [default: 700]
--border-size <BORDER_SIZE>
Border size for each bar [default: 1]
--border-color <BORDER_COLOR>
Border color for each bar (in hex) [default: 000000]
--bar-color <BAR_COLOR>
Color for each bar (in hex) [default: FF0000]
--track-name
Use if you want track name to be printed
--display-gui
Use if you want the gui to be open when launched
--text-color <TEXT_COLOR>
Color for currently playing text (in hex) [default: FFFFFF]
--font-size <FONT_SIZE>
Font size of currently playing label [default: 25]
--smoothness <SMOOTHNESS> Smoothing factor for spatial interpolation between bars
--freq-resolution <FREQ_RESOLUTION> Number of individual frequencies detected by the FFT
--min-freq <MIN_FREQ> Maximum frequency detected by FFT
--max-freq <MAX_FREQ> Minimum frequency detected by FFT
--volume <VOLUME> Volume
--width <WINDOW_WIDTH> Window width
--height <WINDOW_HEIGHT> Window height
--border-size <BORDER_SIZE> Border size for each bar
--border-color <BORDER_COLOR> Border color for each bar (in hex)
--bar-color <BAR_COLOR> Color for each bar (in hex)
--track-name Use if you want track name to be printed
--display-gui Use if you want the gui to be open when launched
--text-color <TEXT_COLOR> Color for currently playing text (in hex)
--font-size <FONT_SIZE> Font size of currently playing label
--background-color <BACKGROUND_COLOR>
[default: 000000]
-h, --help
Print help
-V, --version
Print version
-h, --help Print help
-V, --version Print version
```
7 changes: 3 additions & 4 deletions src/main.rs
Expand Up @@ -33,10 +33,9 @@ use std::io::BufReader;
use std::path::PathBuf;
use std::time::Duration;

// TODO : Add to other package managers
// TODO : Add yaml config file for changing default settings
// TODO : Add a button to gui to write current state to config file
// TODO : Add a button to gui to reset to default
// TODO: Add to other package managers
// TODO: Remove fft_fps and other deprecated configs from readme
// TODO: Add intensity rescaling and other options to yaml

// Constants
const RENDERING_FPS: u32 = 60;
Expand Down