Skip to content

Commit

Permalink
Add usage comment
Browse files Browse the repository at this point in the history
  • Loading branch information
mistydemeo committed Apr 4, 2013
1 parent 7139dad commit b47f528
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions hotline
Original file line number Diff line number Diff line change
@@ -1,4 +1,24 @@
#!/usr/bin/env ruby
#
# hotline is a curses-based audio visualization tool. It takes an audio
# file and a video file and creates a composite, colour
# ASCII visualization.
#
# Currently, hotline requires sox (if audio is not in raw format),
# ffmpeg (if video is not already in ASCII), and aview (ditto). Right
# now only a custom version of aview works. Homebrew formula:
# https://gist.github.com/mistydemeo/043274d4440b7017f593/raw/4e313e2e8f63da934e1c44c22009e3a415c3d9a7/aview.rb
# Patch:
# https://gist.github.com/mistydemeo/982ef8adf468c1e57457/raw/76a8ef7fe1624286152c81ddaa0eb7256bcc3429/aview.diff
#
# Usage:
#
# hotline source_audio source_video [--cache-video]
#
# When --cache-video is specified, hotline will output a marshalled
# copy of the ASCII video to standard out and won't play back the
# visualization. You can use this to prerender video and avoid the
# excruciatingly long startup time when ffmpeg is converting video.

require 'curses'
require 'fileutils'
Expand Down

0 comments on commit b47f528

Please sign in to comment.