Python program to render wave files into oscilloscope views, featuring advanced correlation-based triggering algorithm
Go to file
nyanpasu64 4835058ac3 Enable matplotlib global font cache, under PyInstaller 2019-01-01 13:15:27 -08:00
.appveyor
.idea
corrscope
tests
.gitattributes
.gitignore
LICENSE
README.md
appveyor.yml
build_pyinstaller.py
corrscope.spec
poetry.lock
pyproject.toml
setup.cfg

README.md

Corrscope

Python program to render wave files into oscilloscope views, featuring improved correlation-based triggering algorithm

Dependencies

  • FFmpeg

Installation

Running from Source Code (cross-platform)

Install Python 3.6 or above (3.5 will not work), and Poetry.

# Install Poetry (only do this once)
curl -sSL https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py | python
# Install corrscope
cd path/to/corrscope
poetry install --develop corrscope
poetry run corr (args)

GUI Tutorial

  1. Open GUI:
    • corrscope.exe to create new project
    • corrscope.exe file.yaml to open existing project
  2. Add audio to play back
    • On the right side of the window, click "Browse" to pick a master audio file.
  3. Add oscilloscope channels
    • On the right side of the window, click "Add" to add WAV files to be viewed.
  4. Edit settings
    • Global settings on the left side of the window
    • Per-channel on the right side
  5. Play or render to MP4/etc. video (requires ffmpeg)
    • Via toolbar or menu

Command-line Tutorial

  1. Create YAML:

    • corrscope split*.wav --audio master.wav -w
    • Specify all channels on the command line.
    • -a or --audio specifies master audio track.
    • Creates file master.yaml.
  2. Edit master.yaml to change settings.

  3. Play (requires ffmpeg):

    • corrscope master.yaml -p/--play
  4. Render and encode MP4 video (requires ffmpeg)

    • corrscope master.yaml -r/--render