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

chore: renamed metavars

Browse source
This commit is contained in:
əlemi 2022-12-26 03:32:52 +01:00
parent d5742f746b
commit a337852dac
No known key found for this signature in database
GPG key ID: BBCBFE5D7244634E
2 changed files with 17 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -19,17 +19,17 @@ Arguments:
[DEVICE] Audio device to attach to [DEVICE] Audio device to attach to
Options: Options:
-b, --buffer <BUFFER> 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 <RANGE> 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 <TUNE> 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 <SAMPLE_RATE> Sample rate to use [default: 44100] --sample-rate <HZ> Sample rate to use [default: 44100]
--server-buffer <SERVER_BUFFER> Pulseaudio server buffer size, in block number [default: 32] --server-buffer <N> Pulseaudio server buffer size, in block number [default: 32]
--no-reference Don't draw reference line --no-reference Don't draw reference line
--no-braille Don't use braille dots for drawing lines --no-braille Don't use braille dots for drawing lines
-h, --help Print help information -h, --help Print help information
-V, --version Print version 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`

12
src/main.rs
View file

@ -34,12 +34,12 @@ struct Args {
device: Option<String>, device: Option<String>,
/// Size of audio buffer, and width of scope /// Size of audio buffer, and width of scope
#[arg(short, long, default_value_t = 8192)] #[arg(short, long, value_name = "SIZE", default_value_t = 8192)]
buffer: u32, buffer: u32,
/// Max value, positive and negative, on amplitude scale /// Max value, positive and negative, on amplitude scale
#[arg(short, long, default_value_t = 20000)] #[arg(short, long, value_name = "SIZE", default_value_t = 20000)]
range: u32, range: u32, // TODO counterintuitive, improve this
/// Use vintage looking scatter mode instead of line mode /// Use vintage looking scatter mode instead of line mode
#[arg(long, default_value_t = false)] #[arg(long, default_value_t = false)]
@ -50,15 +50,15 @@ struct Args {
vectorscope: bool, vectorscope: bool,
/// Tune buffer size to be in tune with given note (overrides buffer option) /// Tune buffer size to be in tune with given note (overrides buffer option)
#[arg(long)] #[arg(long, value_name = "NOTE")]
tune: Option<Note>, tune: Option<Note>,
/// Sample rate to use /// Sample rate to use
#[arg(long, default_value_t = 44100)] #[arg(long, value_name = "HZ", default_value_t = 44100)]
sample_rate: u32, sample_rate: u32,
/// Pulseaudio server buffer size, in block number /// Pulseaudio server buffer size, in block number
#[arg(long, default_value_t = 32)] #[arg(long, value_name = "N", default_value_t = 32)]
server_buffer: u32, server_buffer: u32,
/// Don't draw reference line /// Don't draw reference line