Skip to content

Commit ef4491c

Browse files
authored
flac.md: fix "-q" misinformation, and more.
* max -q value was wrong, issue #816 . Fixed that. * Also, reworded -m, -M for clarity, -p for consistency with -q, --lax for brevity. * This should have been done in the previous round: the --help text has the tagging options right after --picture. Did so here too. * But, and this should either also be fixed in the help text or be rejected: --no-utf-8 is a tagging option - aren't those encoding-only? Moved and reworded, but reject as appropriate.
1 parent 4c57829 commit ef4491c

File tree

1 file changed

+32
-30
lines changed

1 file changed

+32
-30
lines changed

man/flac.md

Lines changed: 32 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -324,11 +324,6 @@ negated, see the **Negative options** section below.
324324
sign means that the \--until point is taken relative to the \--skip
325325
point. For other considerations, see \--skip.
326326

327-
**\--no-utf8-convert**
328-
: Do not convert tags from local charset to UTF-8. This is useful for
329-
scripts, and setting tags in situations where the locale is wrong.
330-
This option must appear before any tag options!
331-
332327
**-s**, **\--silent**
333328
: Silent mode (do not write runtime encode/decode statistics to stderr)
334329

@@ -426,10 +421,11 @@ Encoding will default to -5, -A "tukey(5e-1)" and one CPU thread.
426421
for subset streams with higher samplerates it must be \<= 16384.
427422

428423
**-m**, **\--mid-side**
429-
: Try mid-side coding for each frame (stereo only, otherwise ignored).
424+
: Try mid-side coding for each frame in addition to left and right, and
425+
select the best compression. (Stereo only, ignored otherwise.)
430426

431427
**-M**, **\--adaptive-mid-side**
432-
: Adaptive mid-side coding for all frames (stereo only, otherwise ignored).
428+
: Like -m, but adaptive choice (faster, slightly weaker compression).
433429

434430
**-r** \[\#,\]\#, **\--rice-partition-order**=\[\#,\]\#
435431
: Set the \[min,\]max residual partition order (0..15). For subset
@@ -445,20 +441,19 @@ Encoding will default to -5, -A "tukey(5e-1)" and one CPU thread.
445441
: Do exhaustive model search (expensive!).
446442

447443
**-q** \#, **\--qlp-coeff-precision**=\#
448-
: Precision of the quantized linear-predictor coefficients. This number
449-
must be in between 5 and 16, or 0 (the default) to let encoder decide.
450-
Does nothing if using -l 0.
444+
: Set precision (in bits) of the quantized linear-predictor
445+
coefficients, 5\<= \# \<=15 or the default 0 to let encoder decide.
446+
Does nothing if using -l 0. The encoder may reduce the actual
447+
quantization below the \# number by signal and prediction order.
451448

452449
**-p**, **\--qlp-coeff-precision-search**
453-
: Do exhaustive search of LP coefficient quantization (expensive!).
450+
: Do exhaustive search of LP coefficient precision (expensive!).
454451
Overrides -q; does nothing if using -l 0.
455452

456453
**\--lax**
457-
: Allow encoder to generate non-Subset files. The resulting FLAC file
458-
may not be streamable or might have trouble being played in all
459-
players (especially hardware devices), so you should only use this
460-
option in combination with custom encoding options meant for
461-
archival.
454+
: Allow encoding to non-*subset* FLAC files (see RFC 9639 section 7).
455+
WARNING: may cause some applications (especially legacy hardware
456+
devices) to fail streaming or playback.
462457

463458
**\--limit-min-bitrate**
464459
: Limit minimum bitrate by not allowing frames consisting of only
@@ -513,6 +508,27 @@ Encoding will default to -5, -A "tukey(5e-1)" and one CPU thread.
513508
Specifying only *FILENAME* is just shorthand for "\|\|\|\|FILENAME".
514509
See the section **Picture specification** for *SPECIFICATION* format.
515510

511+
**\--no-utf8-convert**
512+
: Upon tagging, do not convert tags from local charset to UTF-8. This
513+
is useful for scripts, and for setting tags in situations where the
514+
locale is wrong. This option must appear *before* any tag options!
515+
516+
**-T** "*FIELD=VALUE*"**, \--tag**="*FIELD=VALUE*"
517+
: Add a FLAC tag. The comment must adhere to the Vorbis comment spec;
518+
i.e. the FIELD must contain only legal characters, terminated by an
519+
'equals' sign. Make sure to quote the content if necessary. This
520+
option may appear more than once to add several Vorbis comments.
521+
NOTE: all tags will be added to all encoded files. Upon re-encoding,
522+
all existing tags will be lost, not only those set with -T / \--tag.
523+
524+
**\--tag-from-file**="*FIELD=FILENAME*"
525+
: Like \--tag, except FILENAME is a file whose contents will be read
526+
verbatim to set the tag value. The contents will be converted to
527+
UTF-8 from the local charset. This can be used to store a cuesheet
528+
in a tag (e.g. \--tag-from-file="CUESHEET=image.cue").
529+
NOTE: Do not try to store binary data in tag fields! Use PICTURE
530+
blocks for pictures and APPLICATION blocks for other binary data.
531+
516532
**-S** {\#\|X\|\#x\|\#s}, **\--seekpoint**={\#\|X\|\#x\|\#s}
517533
: Specifies point(s) to include in SEEKTABLE, to override the encoder's
518534
default choice of one per ten seconds ('-s 10s'). Using \#, a seek point
@@ -538,20 +554,6 @@ Encoding will default to -5, -A "tukey(5e-1)" and one CPU thread.
538554
of having to rewrite the entire file. Note that a block header
539555
of 4 bytes will come on top of the length specified.
540556

541-
**-T** "*FIELD=VALUE*"**, \--tag**="*FIELD=VALUE*"
542-
: Add a FLAC tag. The comment must adhere to the Vorbis comment spec;
543-
i.e. the FIELD must contain only legal characters, terminated by an
544-
'equals' sign. Make sure to quote the content if necessary. This
545-
option may appear more than once to add several Vorbis comments.
546-
NOTE: all tags will be added to all encoded files.
547-
548-
**\--tag-from-file**="*FIELD=FILENAME*"
549-
: Like \--tag, except FILENAME is a file whose contents will be read
550-
verbatim to set the tag value. The contents will be converted to
551-
UTF-8 from the local charset. This can be used to store a cuesheet
552-
in a tag (e.g. \--tag-from-file="CUESHEET=image.cue"). Do not try to
553-
store binary data in tag fields! Use APPLICATION blocks for that.
554-
555557

556558
## FORMAT OPTIONS
557559

0 commit comments

Comments
 (0)