From f2f4792f824cd64e679cdc859fb008769541257b Mon Sep 17 00:00:00 2001 From: Vasile Vilvoiu Date: Sat, 6 May 2023 20:40:52 +0300 Subject: Add support for waiting for input. Introduce -S/--sleep_for_input command line argument. Closes #17. --- man/specgram.1 | 11 ++++++++++- man/specgram.1.html | 16 ++++++++++++++-- man/specgram.1.pdf | Bin 37623 -> 37897 bytes 3 files changed, 24 insertions(+), 3 deletions(-) (limited to 'man') diff --git a/man/specgram.1 b/man/specgram.1 index 0cbf166..4d679d8 100644 --- a/man/specgram.1 +++ b/man/specgram.1 @@ -1,4 +1,4 @@ -.TH SPECGRAM 1 "2021-10-20" +.TH SPECGRAM 1 "2023-05-06" .SH NAME specgram \- create spectrograms from raw files or standard input @@ -14,6 +14,7 @@ specgram \- create spectrograms from raw files or standard input [\fB\-d, --datatype\fR=\fIDATA_TYPE\fR] [\fB\-p, --prescale\fR=\fIPRESCALE_FACTOR\fR] [\fB\-b, --block_size\fR=\fIBLOCK_SIZE\fR] +[\fB\-S, --sleep_for_input\fR=\fISLEEP_MS\fR] [\fB\-f, --fft_width\fR=\fIFFT_WIDTH\fR] [\fB\-g, --fft_stride\fR=\fIFFT_STRIDE\fR] [\fB\-n, --window_function\fR=\fIWIN_FUNC\fR] @@ -120,6 +121,14 @@ The larger this value, the larger the latency of the live spectrogram. Default is 256. +.TP +.BR \-S ", " \-\-sleep_for_input =\fISLEEP_MS\fR +Duration in milliseconds to sleep for when input is not available. +Set this to a reasonable value when input is sparse. +Leave unset when input is constant and low latency is desired. + +Default is 0 (i.e. program busywaits). + .TP \fBFFT OPTIONS\fR diff --git a/man/specgram.1.html b/man/specgram.1.html index 367fa10..5ac4677 100644 --- a/man/specgram.1.html +++ b/man/specgram.1.html @@ -1,5 +1,5 @@ - + @@ -55,7 +55,8 @@ input

--rate=RATE] [−d, --datatype=DATA_TYPE] [−p, --prescale=PRESCALE_FACTOR] [−b, ---block_size=BLOCK_SIZE] [−f, +--block_size=BLOCK_SIZE] [−S, +--sleep_for_input=SLEEP_MS] [−f, --fft_width=FFT_WIDTH] [−g, --fft_stride=FFT_STRIDE] [−n, --window_function=WIN_FUNC] [−m, @@ -227,6 +228,17 @@ spectrogram.

Default is 256.

+

−S, +−−sleep_for_input=SLEEP_MS

+ +

Duration in milliseconds to +sleep for when input is not available. Set this to a +reasonable value when input is sparse. Leave unset when +input is constant and low latency is desired.

+ +

Default is 0 +(i.e. program busywaits).

+

FFT OPTIONS
−f, −−fft_width=FFT_WIDTH

diff --git a/man/specgram.1.pdf b/man/specgram.1.pdf index d6a0be4..1d9bae6 100644 Binary files a/man/specgram.1.pdf and b/man/specgram.1.pdf differ -- cgit v1.2.3