Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
huang0h authored Jun 5, 2022
1 parent e6f9999 commit ea69ffc
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# constellatia
Constellatia is a simple audio visualizer built in Python.

You'll need to install
<a href="https://www.pygame.org/wiki/GettingStarted">pygame</a> and
<a href="http://pydub.com/">pydub</a>
in order for the visualizer to run.

## How to use
Simply run ``` python main.py ``` in the constellatia directory to start the visualizer.
You can determine what audio is played/visualized by setting ```FILENAME``` to the path to an audio file.
Currently, it runs immediately after processing, and will automatically stop after playing through the song.

This repo comes with three songs in the ```audio``` folder:
- <a href="https://www.youtube.com/watch?v=b6D6iGeEl1o">Deep Blue by The Midnight</a>
- <a href="https://www.youtube.com/watch?v=cnpqLWBrNw0">Missing by Orax</a>
- <a href="https://www.youtube.com/watch?v=9wCJPm19XYQ">Reckoner by Radiohead</a>

as well as two test files, one of a sine wave and one of a square wave.

You can configure the visualizer before running by editing the config variables at the top of the file.

**note**: ```WINDOW_SIZE``` refers to the number of samples that are processed at a time (in other words, how many dots make up the wavy stuff),
NOT the size of the visualizer - ```SCREEN_WIDTH``` and ```SCREEN_HEIGHT``` determine that.
Controls:
- p: pause/unpause the visualizer and music
- q: prematurely end the visualizer
- r: start/stop recording

I **HIGHLY** discourage recording right now, since the current setup is super janky and I'm still working on it.
It will absolutely destroy your memory if you record for more than ~40 seconds.
However, if you do want to record, make sure the ```imgs``` folder is empty; otherwise, frames from previous recordings might get mixed in.
You can start recording right away by setting ```RECORDING = True```, or press r to toggle recordings as you like.

0 comments on commit ea69ffc

Please sign in to comment.