diff --git a/audiowaveform/README.md b/audiowaveform/README.md new file mode 100644 index 0000000..4694b37 --- /dev/null +++ b/audiowaveform/README.md @@ -0,0 +1,41 @@ +audiowaveform +============= + +![](https://badge.imagelayers.io/vimagick/audiowaveform:latest.svg) + +**audiowaveform** is a C++ command-line application that generates waveform data +from either MP3, WAV, or FLAC format audio files. Waveform data can be used to +produce a visual rendering of the audio, similar in appearance to audio editing +applications. + +### Run + + $ docker pull vimagick/audiowaveform + $ alias awf='docker run --rm -v `pwd`:/work -w /work vimagick/audiowaveform' + $ awf -i input.mp3 -o output.png + +## Command line options + +**audiowaveform** accepts the following command-line options: + +| Short | Long | Description | +| --------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------- | +| | `--help` | Show help message | +| `-v` | `--version` | Show version information | +| `-i ` | `--input-filename ` | Input mono or stereo audio (.wav or .mp3) or waveform data (.dat) file name | +| `-o ` | `--output-filename ` | Output waveform data (.dat or .json), audio (.wav), or PNG image (.png) file name | +| `-z ` | `--zoom ` | Zoom level (samples per pixel), default: 256. Not valid if `--end` or `--pixels-per-second` is also specified | +| | `--pixels-per-second ` | Zoom level (pixels per second), default: 100. Not valid if `--end` or `--zoom` is also specified | +| `-b ` | `--bits ` | Number of bits resolution when creating a waveform data file (either 8 or 16), default: 16 | +| `-s ` | `--start ` | Start time (seconds), default: 0 | +| `-e ` | `--end ` | End time (seconds). Not valid if `--zoom` is also specified | +| `-w ` | `--width ` | Width of output image (pixels), default: 800 | +| `-h ` | `--height ` | Height of output image (pixels), default: 250 | +| `-c ` | `--colors ` | Color scheme of output image (either 'audition' or 'audacity'), default: audacity | +| | `--border-color ` | Border color (in rrggbb\[aa\] hex format), default: set by `--colors` option | +| | `--background-color ` | Background color (in rrggbb\[aa\] hex format), default: set by `--colors` option | +| | `--waveform-color ` | Waveform color (in rrggbb\[aa\] hex format), default: set by `--colors` option | +| | `--axis-label-color ` | Axis label color (in rrggbb\[aa\] hex format), default: set by `--colors` option | +| | `--no-axis-labels` | Render PNG images without axis labels | +| | `--with-axis-labels` | Render PNG images with axis labels (default) | +