Skip to content

Commit 617de51

Browse files
committed
Updated --help output and documentation
1 parent a6392d7 commit 617de51

File tree

3 files changed

+18
-17
lines changed

3 files changed

+18
-17
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -291,9 +291,9 @@ Disable status messages.
291291
#### `--input-filename`, `-i <filename>`
292292

293293
Input filename, which should be a MP3, WAV, FLAC, Ogg Vorbis, or Opus audio file, or a
294-
binary waveform data file. By default, audiowaveform uses the file
294+
binary or JSON format waveform data file. By default, audiowaveform uses the file
295295
extension to decide how to read the input file (either .mp3, .wav, .flac, .ogg,
296-
.oga, .opus, or .dat, as appropriate), but this can be overridden by the
296+
.oga, .opus, .dat, or .json as appropriate), but this can be overridden by the
297297
`--input-format` option. If the `--input-filename` option is `-` or
298298
is omitted, audiowaveform reads from standard input, and the
299299
`--input-format` option must be used to specify the data format.
@@ -313,7 +313,7 @@ by the `--output-format` option. If the `--output-filename` option is
313313

314314
#### `--input-format <format>`
315315

316-
Input data format, either `wav`, `mp3`, `flac`, `ogg`, `opus`, or `dat`.
316+
Input data format, either `wav`, `mp3`, `flac`, `ogg`, `opus`, `dat`, or `json`.
317317
This option must be used when reading from standard input. It may also be used to set
318318
the input file format, instead of it being determined from the file extension
319319
from the `--input-filename` option.

doc/audiowaveform.1

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH audiowaveform 1 "9 August 2023"
1+
.TH audiowaveform 1 "30 September 2023"
22

33
.SH NAME
44

@@ -56,12 +56,12 @@ Disable status messages.
5656
.TP
5757
.B --input-filename\fR, \fB-i\fR <filename>
5858
Input filename, which should be a MP3, WAV, FLAC, Ogg Vorbis, or Opus audio file,
59-
or a binary waveform data file. By default, \fBaudiowaveform\fR uses the file
60-
extension to decide how to read the input file (either .mp3, .wav, .flac, .ogg,
61-
\&.oga, .opus, or .dat, as appropriate), but this can be overridden by the
62-
\fB--input-format\fR option. If the \fB--input-filename\fR option is \fB-\fR or
63-
is omitted, \fBaudiowaveform\fR reads from standard input, and the
64-
\fB--input-format\fR option must be used to specify the data format.
59+
or a binary or JSON format waveform data file. By default, \fBaudiowaveform\fR
60+
uses the file extension to decide how to read the input file (either .mp3, .wav,
61+
\&.flac, .ogg, .oga, .opus, .dat, or .json as appropriate), but this can be
62+
overridden by the \fB--input-format\fR option. If the \fB--input-filename\fR
63+
option is \fB-\fR or is omitted, \fBaudiowaveform\fR reads from standard input,
64+
and the \fB--input-format\fR option must be used to specify the data format.
6565

6666
Note that Opus support requires libsndfile 1.0.29 or later, so may not be
6767
available on all systems.
@@ -79,9 +79,10 @@ by the \fB--output-format\fR option. If the \fB--output-filename\fR option is
7979
.TP
8080
.B --input-format\fR <format>
8181
Input data format, either \fBwav\fR, \fBmp3\fR, \fBflac\fR, \fBogg\fR,
82-
\fBopus\fR, or \fBdat\fR. This option must be used when reading from standard
83-
input. It may also be used to set the input file format, instead of it being
84-
determined from the file extension from the \fB--input-filename\fR option.
82+
\fBopus\fR, \fBdat\fR, or \fBjson\fR. This option must be used when reading
83+
from standard input. It may also be used to set the input file format, instead
84+
of it being determined from the file extension from the \fB--input-filename\fR
85+
option.
8586

8687
.TP
8788
.B --output-format\fR <format>

src/Options.cpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -126,8 +126,8 @@ bool Options::parseCommandLine(int argc, const char* const* argv)
126126
"input-filename,i",
127127
po::value<std::string>(&input_filename_),
128128
FileFormat::isSupported(FileFormat::Opus) ?
129-
"input file name (.mp3, .wav, .flac, .ogg, .oga, .opus, .dat)" :
130-
"input file name (.mp3, .wav, .flac, .ogg, .oga, .dat)"
129+
"input file name (.mp3, .wav, .flac, .ogg, .oga, .opus, .dat, .json)" :
130+
"input file name (.mp3, .wav, .flac, .ogg, .oga, .dat, .json)"
131131
)(
132132
"output-filename,o",
133133
po::value<std::string>(&output_filename_),
@@ -139,8 +139,8 @@ bool Options::parseCommandLine(int argc, const char* const* argv)
139139
"input-format",
140140
po::value<std::string>(&input_format_),
141141
FileFormat::isSupported(FileFormat::Opus) ?
142-
"input file format (mp3, wav, flac, ogg, opus, dat)" :
143-
"input file format (mp3, wav, flac, ogg, dat)"
142+
"input file format (mp3, wav, flac, ogg, opus, dat, json)" :
143+
"input file format (mp3, wav, flac, ogg, dat, json)"
144144
)(
145145
"output-format",
146146
po::value<std::string>(&output_format_),

0 commit comments

Comments
 (0)