diff --git a/README.md b/README.md index f55a4b8..e6fd1bf 100644 --- a/README.md +++ b/README.md @@ -19,35 +19,47 @@ Arguments: [DEVICE] Audio device to attach to Options: - -b, --buffer Size of audio buffer, and width of scope [default: 8192] - -r, --range Max value, positive and negative, on amplitude scale [default: 20000] - --scatter Use vintage looking scatter mode instead of line mode - --vectorscope Combine left and right channels into vectorscope view - --tune Tune buffer size to be in tune with given note (overrides buffer option) - --sample-rate Sample rate to use [default: 44100] - --server-buffer Pulseaudio server buffer size, in block number [default: 32] - --no-reference Don't draw reference line - --no-braille Don't use braille dots for drawing lines - -h, --help Print help information - -V, --version Print version information + -b, --buffer Size of audio buffer, and width of scope [default: 8192] + -r, --range Max value, positive and negative, on amplitude scale [default: 20000] + --scatter Use vintage looking scatter mode instead of line mode + --vectorscope Combine left and right channels into vectorscope view + --tune Tune buffer size to be in tune with given note (overrides buffer option) + --channels Number of channels to open [default: 2] + --sample-rate Sample rate to use [default: 44100] + --server-buffer Pulseaudio server buffer size, in block number [default: 32] + --triggering Start drawing at first rising edge + --threshold Threshold value for triggering [default: 0] + --no-reference Don't draw reference line + --no-ui Hide UI and only draw waveforms + --no-braille Don't use braille dots for drawing lines + -h, --help Print help information + -V, --version Print version information ``` -The audio buffer size directly impacts resource usage, latency and refresh rate and its limits are given by the audio refresh rate. Larger buffers are slower but less resource intensive. A good starting value might be `8192` +The audio buffer size directly impacts resource usage, latency and refresh rate and its limits are given by the audio refresh rate. Larger buffers are slower but less resource intensive. A good starting value might be `8192` or tuning to the 0th octave. To change audio buffer size, the PulseAudio client must be restarted. Because of this, such option is configurable only at startup. ## Controls * Use `q` or `CTRL+C` to exit * Use `` to pause and resume display -* Use `-` and `=` to decrease or increase range (`_` and `+` for smaller steps) +* Use `` and `` to decrease or increase range by 100 +* Use `` and `` to decrease or increase threshold by 100 + * Combine arrows with `` to increase or decrease by 1000 instead + * Combine arrows with `` to increase or decrease by 10 instead + * Combine arrows with `` to increase or decrease by 1 instead * Use `v` to toggle vectorscope mode * Use `s` to toggle scatter mode +* Use `b` to toggle braille characters * Use `h` to toggle interface -* Decrease/increase terminal font size to increase/decrease scope resolution. +* Use `r` to toggle reference lines +* Use `t` to toggle triggered mode # About precision -While "scatter" mode is as precise as Pulseaudio and the terminal lets us be, "line" mode simply draws a straight line across points, meaning high frequencies don't get properly represented. +While "scatter" plot mode is as precise as Pulseaudio and the terminal lets us be, "line" plot mode simply draws a straight line across points, meaning high frequencies don't get properly represented. Latency is kept to a minimum thanks to small buffer and block sizes. Sample rate can be freely specified but will ultimately be limited by source's actual sample rate. + +Decrease/increase terminal font size to increase/decrease scope resolution.