Python program to render wave files into oscilloscope views, featuring advanced correlation-based triggering algorithm
Go to file
nyanpasu64 ad300eb364 Remove unused Config fields (player/encoder args) 2019-01-03 12:09:59 -08:00
.appveyor Add appveyor.yml (poetry, pytest, pyinstaller) 2018-12-23 15:57:31 -08:00
.idea Rename ovgenpy to corrscope 2018-12-22 18:39:03 -08:00
corrscope Remove unused Config fields (player/encoder args) 2019-01-03 12:09:59 -08:00
tests Add test to accept .wav with header metadata larger than filesize 2019-01-03 00:39:25 -08:00
.gitattributes .gitattributes: Force eol=LF on Windows 2018-11-20 18:05:28 -08:00
.gitignore Datestamp --profile filenames, add GUI --profile (#104) 2019-01-01 00:26:36 -08:00
LICENSE
README.md Update README.md (#97) 2018-12-29 21:21:09 -05:00
appveyor.yml [appveyor] Fix skipping pyinstaller on x64 2018-12-23 19:43:49 -08:00
build_pyinstaller.py [pyinstaller] After pyinstaller, run resulting program 2018-12-23 00:33:12 -08:00
corrscope.spec [pyinstaller] Add PyInstaller and launcher script 2018-12-23 00:33:12 -08:00
poetry.lock [poetry] Remove scipy dependency 2018-12-23 00:33:12 -08:00
pyproject.toml Show app version, bump version number to 0.1.1-pre (#98) 2018-12-29 22:58:48 -05:00
setup.cfg Rename ovgenpy to corrscope 2018-12-22 18:39:03 -08:00

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