c62e5d7351
Not sure if this is a good idea worth keeping. It may or may not fix a bug I've seen months ago. In return, it introduces complexity and brittleness into my code, and could stop working in a future ruamel.yaml update. Also `pip install` doesn't pin the exact ruamel.yaml version (accepting higher versions that could break my code), only `poetry install` pins an exact version. |
||
|---|---|---|
| .appveyor | ||
| .github | ||
| .idea | ||
| corrscope | ||
| docs | ||
| tests | ||
| .coveragerc | ||
| .gitattributes | ||
| .gitignore | ||
| .pre-commit-config.yaml | ||
| CHANGELOG.md | ||
| LICENSE | ||
| README.md | ||
| appveyor.yml | ||
| build_pyinstaller.py | ||
| corrscope.spec | ||
| poetry.lock | ||
| pyproject.toml | ||
| scripts.py | ||
| setup.cfg | ||
README.md
Corrscope
Corrscope renders oscilloscope views of WAV files recorded from chiptune (game music from retro sound chips).
Corrscope uses "waveform correlation" to track complex waves (including SNES and Sega Genesis/FM synthesis) which jump around on other oscilloscope programs.
Sample results can be found on my Youtube channel at https://www.youtube.com/nyanpasu64/videos.
Documentation is available at https://corrscope.github.io/corrscope/.
Status
Corrscope is currently in maintenance mode until further notice. The program basically works, but I may not respond to issues. For technical support, contact me at Discord (https://discord.gg/CCJZCjc), or alternatively in the issue tracker (using the "Support/feedback" template). Pull requests may be accepted if they're clean.
Dependencies
- FFmpeg
Installation
- Releases (recommended): https://github.com/corrscope/corrscope/releases
- Dev Builds: https://ci.appveyor.com/project/nyanpasu64/corrscope/history
Instructions:
- Download Windows binary releases (zip files), then double-click
corrscope.exeor runcorrscope (args)via CLI. - Download cross-platform Python packages (whl), then install Python 3.6+ and run
pip install *.whl.
Installing from PyPI via Pip (cross-platform, releases)
Install Python 3.6 or above (3.5 will not work).
# Installs into per-user Python environment.
pip3 install --user corrscope
corr (args)
Running from Source Code (cross-platform, dev master)
Install Python 3.6 or above (3.5 will not work), and Poetry.
# Installs into an isolated environment.
# Install Poetry (only do this once)
curl -sSL https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py | python
cd path/to/corrscope
poetry install corrscope # --develop is implied
poetry run corr (args)
GUI Tutorial
- Open GUI:
corrscope.exeto create new projectcorrscope.exe file.yamlto open existing project
- Add audio to play back
- On the right side of the window, click "Browse" to pick a master audio file.
- Add oscilloscope channels
- On the right side of the window, click "Add" to add WAV files to be viewed.
- Edit settings
- Global settings on the left side of the window
- Per-channel on the right side
- Play or render to MP4/etc. video (requires ffmpeg)
- Via toolbar or menu
Command-line Tutorial
-
Create YAML:
corrscope split*.wav --audio master.wav -w- Specify all channels on the command line.
-aor--audiospecifies master audio track.- Creates file
master.yaml.
-
Edit
master.yamlto change settings. -
Play (requires ffmpeg):
corrscope master.yaml -p/--play
-
Render and encode MP4 video (requires ffmpeg)
corrscope master.yaml -r/--render
Contributing
Issues, feature requests, and pull requests are accepted.
This project uses Black code formatting. Either pull request authors can reformat code before creating a PR, or maintainers can reformat code before merging.
You can install a Git pre-commit hook to apply Black formatting before each commit. Open a terminal/cmd in this repository and run:
pip install --user pre-commit
pre-commit install