Skip to content

flac.md: fix "-q" misinformation, and more. #818

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

H2Swine
Copy link
Contributor

@H2Swine H2Swine commented Mar 3, 2025

Hope I haven't messed up how pulls work. Wouldn't be the first time.

This intends to fix #816 , the man page wrongly states -q 16 is permitted.

I have worked on more on the man page, but I don't want to put in too much in one request.

  • Also, reworded -p for consistency with -q; -m and -M for clarity; and --lax for brevity.
  • The following 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.

* max -q value was wrong, issue xiph#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.
Reworded the wording of -j, correcting the max to the actual 64.
@H2Swine
Copy link
Contributor Author

H2Swine commented Mar 5, 2025

Looks like max thread count was wrong as well. Also reworded, clarifying that default is single-thread.


**-M**, **\--adaptive-mid-side**
: Adaptive mid-side coding for all frames (stereo only, otherwise ignored).
: Like -m, but adaptive choice (faster, slightly weaker compression).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe use the word heuristics here? I think that is more descriptive than adaptive. I know, the word adaptive was there already, but it is rather unclear what it means I think

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No objection to that. I'll look over it and - if you don't mind doing it in this thread - submit more textual suggestions. I have briefly tested picture and RG features and tried to make sense out of actual behaviour vs help text, so a question -- indeed two:

  • Could RG still leave PADDING even if --no-padding is used? I didn't get to provoke that. Looks like something similar was addressed in 1.2.1b?
  • General formatting: Should one more generally write out e.g. -w with ticks instead of -w without? I assume it would be a good thing to write flac double-asterisk-surrounded for the tool, to contrast it from the format (which likely should be FLAC in allcaps?), that is quite common manpage style?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation - incorrect range of qlp-coeff-precision parameter
2 participants