alemi/scope-tui
1
0
Fork 0
mirror of https://github.com/alemidev/scope-tui.git synced 2024-11-14 02:39:20 +01:00
Code Issues Activity

docs: update readme

Browse source
This commit is contained in:
əlemi 2023-01-05 01:00:00 +01:00
parent d72e471dbd
commit 865a3e406b
No known key found for this signature in database
GPG key ID: BBCBFE5D7244634E
1 changed files with 27 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -19,35 +19,47 @@ Arguments:
[DEVICE] Audio device to attach to [DEVICE] Audio device to attach to
Options: Options:
-b, --buffer <SIZE> Size of audio buffer, and width of scope [default: 8192] -b, --buffer <SIZE> Size of audio buffer, and width of scope [default: 8192]
-r, --range <SIZE> Max value, positive and negative, on amplitude scale [default: 20000] -r, --range <SIZE> Max value, positive and negative, on amplitude scale [default: 20000]
--scatter Use vintage looking scatter mode instead of line mode --scatter Use vintage looking scatter mode instead of line mode
--vectorscope Combine left and right channels into vectorscope view --vectorscope Combine left and right channels into vectorscope view
--tune <NOTE> Tune buffer size to be in tune with given note (overrides buffer option) --tune <NOTE> Tune buffer size to be in tune with given note (overrides buffer option)
--sample-rate <HZ> Sample rate to use [default: 44100] --channels <N> Number of channels to open [default: 2]
--server-buffer <N> Pulseaudio server buffer size, in block number [default: 32] --sample-rate <HZ> Sample rate to use [default: 44100]
--no-reference Don't draw reference line --server-buffer <N> Pulseaudio server buffer size, in block number [default: 32]
--no-braille Don't use braille dots for drawing lines --triggering Start drawing at first rising edge
-h, --help Print help information --threshold <THRESHOLD> Threshold value for triggering [default: 0]
-V, --version Print version information --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. To change audio buffer size, the PulseAudio client must be restarted. Because of this, such option is configurable only at startup.
## Controls ## Controls
* Use `q` or `CTRL+C` to exit * Use `q` or `CTRL+C` to exit
* Use `<SPACE>` to pause and resume display * Use `<SPACE>` to pause and resume display
* Use `-` and `=` to decrease or increase range (`_` and `+` for smaller steps) * Use `<LEFT>` and `<RIGHT>` to decrease or increase range by 100
* Use `<UP>` and `<DOWN>` to decrease or increase threshold by 100
* Combine arrows with `<SHIFT>` to increase or decrease by 1000 instead
* Combine arrows with `<CTRL>` to increase or decrease by 10 instead
* Combine arrows with `<ALT>` to increase or decrease by 1 instead
* Use `v` to toggle vectorscope mode * Use `v` to toggle vectorscope mode
* Use `s` to toggle scatter mode * Use `s` to toggle scatter mode
* Use `b` to toggle braille characters
* Use `h` to toggle interface * 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 # 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. 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. 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.