Skip to content

Commit 11e732e

Browse files
H2Swinektmf01
authored andcommitted
flac.md: fix "-q" misinformation, and more. (xiph#818)
* max -q value was wrong, issue xiph#816 . Fixed that. * Also, reworded -m, -M for clarity, -p for consistency with -q, --lax for brevity. * move the tagging options right after --picture. * moved and reworded --no-utf-8 is a tagging option * Correct -j description Co-authored-by: Martijn van Beurden <mvanb1@gmail.com>
1 parent 68b053b commit 11e732e

File tree

1 file changed

+43
-37
lines changed

1 file changed

+43
-37
lines changed

man/flac.md

Lines changed: 43 additions & 37 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,12 @@ 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 choose with a heuristic (faster, slightly weaker
429+
compression).
433430

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

447444
**-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.
445+
: Set precision (in bits) of the quantized linear-predictor
446+
coefficients, 5\<= \# \<=15 or the default 0 to let encoder decide.
447+
Does nothing if using -l 0. The encoder may reduce the actual
448+
quantization below the \# number by signal and prediction order.
451449

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

456454
**\--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.
455+
: Allow encoding to non-*subset* FLAC files (see RFC 9639 section 7).
456+
WARNING: may cause some applications (especially legacy hardware
457+
devices) to fail streaming or playback.
462458

463459
**\--limit-min-bitrate**
464460
: Limit minimum bitrate by not allowing frames consisting of only
@@ -467,13 +463,14 @@ Encoding will default to -5, -A "tukey(5e-1)" and one CPU thread.
467463
internet streaming.
468464

469465
**-j** \#, **\--threads**=\#
470-
: Try to set a maximum number of threads to use for encoding. If
471-
multithreading was not enabled on compilation or when setting a
472-
number of threads that is too high, this fails with a warning. The
473-
value of 0 means a default set by the encoder; currently that is 1
474-
thread (i.e. no multithreading), but that could change in the
475-
future. Currently, up to 128 threads are supported. Using a value
476-
higher than the number of available CPU threads harms performance.
466+
: By default, **flac** will encode with one thread. This option enables
467+
multithreading with max \# number of threads, although "0" to let the
468+
encoder decide. Currently, -j 0 is synonymous with -j 1 (i.e. no
469+
multithreading), and the max supported number is 64; both could change
470+
in the future. If \# exceeds the supported maximum (64), **flac** will
471+
encode with a single thread (and throw a warning). The same happens
472+
(for any \#) if **flac** was compiled with multithreading disabled.
473+
NOTE: Exceeding the *actual* available CPU threads, harms speed.
477474

478475
**\--ignore-chunk-sizes**
479476
: When encoding to flac, ignore the file size headers in WAV and AIFF
@@ -513,6 +510,29 @@ Encoding will default to -5, -A "tukey(5e-1)" and one CPU thread.
513510
Specifying only *FILENAME* is just shorthand for "\|\|\|\|FILENAME".
514511
See the section **Picture specification** for *SPECIFICATION* format.
515512

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

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-
555561

556562
## FORMAT OPTIONS
557563

0 commit comments

Comments
 (0)