Skip to content

Commit 51b21f7

Browse files
H2SwineH2Swine
authored
Help text in main.c
To reflect proposed changes in flac.md (and some already implemented ones)
1 parent a555fe1 commit 51b21f7

File tree

1 file changed

+26
-20
lines changed

1 file changed

+26
-20
lines changed

‎src/flac/main.c‎

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1322,7 +1322,7 @@ void show_help(void)
13221322
usage_header();
13231323
usage_summary();
13241324
printf("\n");
1325-
printf("This help text summarizes all available options, for more explanation and\n");
1325+
printf("This help text summarizes the available options, for more explanation and\n");
13261326
printf("examples please consult the manual. This manual is often distributed\n");
13271327
printf("alongside the program as a man page or an HTML file. It can also be found\n");
13281328
printf("online at https://xiph.org/flac/documentation_tools_flac.html\n");
@@ -1345,7 +1345,6 @@ void show_help(void)
13451345
printf(" but not return an error when no such chunks are found\n");
13461346
printf(" --skip={#|mm:ss.ss} Skip the given initial samples for each input\n");
13471347
printf(" --until={#|[+|-]mm:ss.ss} Stop at the given sample for each input file\n");
1348-
printf(" --no-utf8-convert Do not convert tags from local charset to UTF-8\n");
13491348
printf(" -s, --silent Do not write runtime encode/decode statistics\n");
13501349
printf(" --totally-silent Do not print anything, including errors\n");
13511350
printf(" -w, --warnings-as-errors Treat all warnings as errors\n");
@@ -1358,8 +1357,11 @@ void show_help(void)
13581357
printf(" just the first one\n");
13591358

13601359
#endif
1360+
printf(" --apply-replaygain-which-is-not-lossless\n");
1361+
printf(" Change volume of output for players that do not know\n");
1362+
printf(" ReplayGain. (Warning: irreversibly alters the signal!)\n");
13611363
printf("\n");
1362-
printf("Encoding options, defaulting to -5, -A \"tukey(5e-1)\" and one CPU thread:\n");
1364+
printf("Encoding options, defaulting to the -5 compression level and one CPU thread:\n");
13631365
printf(" -V, --verify Verify a correct encoding\n");
13641366
printf(" -0, --compression-level-0, --fast Synonymous with -l 0 -b 1152 -r 3\n");
13651367
printf(" -1, --compression-level-1 Synonymous with -l 0 -b 1152 -M -r 3\n");
@@ -1374,47 +1376,51 @@ void show_help(void)
13741376
printf(" -8, --compression-level-8, --best Synonymous with -l 12 -b 4096 -m -r 6\n");
13751377
printf(" -A \"subdivide_tukey(3)\"\n");
13761378
printf(" -l, --max-lpc-order=# Max LPC order; 0 => only fixed predictors\n");
1377-
printf(" -b, --blocksize=# Specify blocksize in samples\n");
1378-
printf(" -m, --mid-side Try mid-side coding for each frame\n");
1379-
printf(" -M, --adaptive-mid-side Adaptive choice of mid-side coding\n");
1379+
printf(" -b, --blocksize=# Set blocksize in samples (per channel)\n");
1380+
printf(" -m, --mid-side Try mid-side coding for each stereo frame\n");
1381+
printf(" -M, --adaptive-mid-side Heuristic choice of mid-side coding\n");
13801382
printf(" -r, --rice-partition-order=[#,]# Set [min,]max residual partition order\n");
13811383
printf(" -A, --apodization=\"function\" Window audio data with given function(s)\n");
13821384
printf(" -e, --exhaustive-model-search Do exhaustive model search (expensive!)\n");
1383-
printf(" -q, --qlp-coeff-precision=# Specify quantization precision in bits\n");
1384-
printf(" (default: let encoder decide)\n");
1385+
printf(" -q, --qlp-coeff-precision=# Set quantization precision in bits\n");
1386+
printf(" (-q0 (default) to let encoder decide)\n");
13851387
printf(" -p, --qlp-coeff-precision-search Exhaustively search LP coeff quantization\n");
13861388
printf(" --lax Allow encoder to generate non-Subset files\n");
1387-
printf(" --limit-min-bitrate Limit minimum bitrate (for streaming)\n");
1388-
printf(" -j, --threads=# Set number of encoding threads\n");
1389+
printf(" --limit-min-bitrate Constrain to > 1 bit/sample (for streaming)\n");
13891390
printf(" --ignore-chunk-sizes Ignore data chunk sizes in WAVE/AIFF files\n");
1390-
printf(" --replay-gain Calculate ReplayGain & store in FLAC tags\n");
1391-
printf(" --cuesheet=FILENAME Import cuesheet & store in CUESHEET block\n");
1391+
printf(" -j, --threads=# Set number of encoding threads \n");
1392+
printf(" (-j0 (default) to let encoder decide)\n");
1393+
printf(" -V, --verify Verify a correct encoding\n");
1394+
printf("\n");
13921395
printf(" --picture=SPECIFICATION Import picture & store in PICTURE block\n");
1396+
printf(" --cuesheet=FILENAME Import cuesheet & store in CUESHEET block\n");
1397+
printf(" --no-utf8-convert Do not convert tags from local charset to UTF-8\n");
13931398
printf(" -T, --tag=FIELD=VALUE Add a FLAC tag; may appear multiple times\n");
13941399
printf(" --tag-from-file=FIELD=FILENAME Like --tag but gets value from file\n");
1400+
printf(" --replay-gain Calculate ReplayGain & store in FLAC tags\n");
13951401
printf(" -S, --seekpoint={#|X|#x|#s} Add seek point(s)\n");
13961402
printf(" -P, --padding=# Write a PADDING block of length # bytes\n");
13971403
printf("\n");
13981404
printf("Format options (encoding defaults to FLAC not OGG; decoding defaults to WAVE, \n");
13991405
printf(" chunks found by --keep-foreign-metadata-if-present will override):\n");
1400-
#if FLAC__HAS_OGG
1401-
printf(" --ogg Use Ogg transport layer, output .oga\n");
1402-
printf(" --serial-number Ogg serial number to assign (encoding)\n");
1403-
printf(" or to select for decoding\n");
1404-
#endif
14051406
printf(" --force-aiff-format Decode to AIFF format\n");
14061407
printf(" --force-rf64-format Decode to RF64 format\n");
14071408
printf(" --force-wave64-format Decode to Wave64 format\n");
14081409
printf(" --force-legacy-wave-format Decode to legacy wave format\n");
14091410
printf(" --force-extensible-wave-format Decode to extensible wave format\n");
14101411
printf(" --force-aiff-c-none-format Decode to AIFF-C NONE format\n");
14111412
printf(" --force-aiff-c-sowt-format Decode to AIFF-C sowt format\n");
1413+
#if FLAC__HAS_OGG
1414+
printf(" --ogg Encode to Ogg container, output .oga\n");
1415+
printf(" --serial-number Ogg serial number to assign (encoding)\n");
1416+
printf(" or to select for decoding\n");
1417+
#endif
14121418
printf(" --force-raw-format Treat input or output as raw samples\n");
14131419
printf("raw format options:\n");
1414-
printf(" --sign={signed|unsigned} Sign of samples (input/output) \n");
1415-
printf(" --endian={big|little} Byte order for samples (input/output)\n");
1420+
printf(" --sign={signed|unsigned} Signedness of each sample. (input/output) \n");
1421+
printf(" --endian={big|little} Byte order of each sample. (input/output)\n");
14161422
printf(" --channels=# Number of channels in raw input\n");
1417-
printf(" --bps=# Number of bits per sample in raw input\n");
1423+
printf(" --bps={8|16|24|32} Bits per sample (/channel) in raw input\n");
14181424
printf(" --sample-rate=# Sample rate in Hz in raw input\n");
14191425
printf(" --input-size=# Size in bytes of raw input from stdin\n");
14201426
printf("\n");

0 commit comments

Comments
 (0)