Skip to content

Commit

Permalink
update docs and completions
Browse files Browse the repository at this point in the history
  • Loading branch information
slhck committed Dec 15, 2024
1 parent c0923e8 commit 5b27bee
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 3 deletions.
6 changes: 5 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ If you want to contribute a new feature or fix, please:
- Provide a commit for the change you want to make (one feature per commit, please)
- Create a pull request

## For CLI specifically

- Make sure to add an entry in the README.md file, and update the `completions/` directory with the new completion options.

## Issues and Questions

If you simply have a question or want to raise an issue, head to the issue tracker. There's a template there that you're kindly asked to fill out. It helps me understand what the problem might be.
If you simply have a question or want to raise an issue, head to the issue tracker. There's a template there that you're kindly asked to fill out. It helps me understand what the problem might be.
3 changes: 2 additions & 1 deletion completions/ffmpeg-normalize-shtab.bash
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@



_shtab_ffmpeg_normalize_option_strings=('-h' '--help' '-o' '--output' '-of' '--output-folder' '-f' '--force' '-d' '--debug' '-v' '--verbose' '-q' '--quiet' '-n' '--dry-run' '-pr' '--progress' '--version' '-nt' '--normalization-type' '-t' '--target-level' '-p' '--print-stats' '-lrt' '--loudness-range-target' '--keep-loudness-range-target' '--keep-lra-above-loudness-range-target' '-tp' '--true-peak' '--offset' '--lower-only' '--dual-mono' '--dynamic' '-c:a' '--audio-codec' '-b:a' '--audio-bitrate' '-ar' '--sample-rate' '-ac' '--audio-channels' '-koa' '--keep-original-audio' '-prf' '--pre-filter' '-pof' '--post-filter' '-vn' '--video-disable' '-c:v' '--video-codec' '-sn' '--subtitle-disable' '-mn' '--metadata-disable' '-cn' '--chapters-disable' '-ei' '--extra-input-options' '-e' '--extra-output-options' '-ofmt' '--output-format' '-ext' '--extension')
_shtab_ffmpeg_normalize_option_strings=('-h' '--help' '-o' '--output' '-of' '--output-folder' '-f' '--force' '-d' '--debug' '-v' '--verbose' '-q' '--quiet' '-n' '--dry-run' '-pr' '--progress' '--version' '-nt' '--normalization-type' '-t' '--target-level' '-p' '--print-stats' '-lrt' '--loudness-range-target' '--keep-loudness-range-target' '--keep-lra-above-loudness-range-target' '-tp' '--true-peak' '--offset' '--lower-only' '--auto-lower-loudness-target' '--dual-mono' '--dynamic' '-c:a' '--audio-codec' '-b:a' '--audio-bitrate' '-ar' '--sample-rate' '-ac' '--audio-channels' '-koa' '--keep-original-audio' '-prf' '--pre-filter' '-pof' '--post-filter' '-vn' '--video-disable' '-c:v' '--video-codec' '-sn' '--subtitle-disable' '-mn' '--metadata-disable' '-cn' '--chapters-disable' '-ei' '--extra-input-options' '-e' '--extra-output-options' '-ofmt' '--output-format' '-ext' '--extension')



Expand Down Expand Up @@ -32,6 +32,7 @@ _shtab_ffmpeg_normalize___print_stats_nargs=0
_shtab_ffmpeg_normalize___keep_loudness_range_target_nargs=0
_shtab_ffmpeg_normalize___keep_lra_above_loudness_range_target_nargs=0
_shtab_ffmpeg_normalize___lower_only_nargs=0
_shtab_ffmpeg_normalize___auto_lower_loudness_target_nargs=0
_shtab_ffmpeg_normalize___dual_mono_nargs=0
_shtab_ffmpeg_normalize___dynamic_nargs=0
_shtab_ffmpeg_normalize__koa_nargs=0
Expand Down
6 changes: 6 additions & 0 deletions completions/ffmpeg-normalize-shtab.zsh
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,12 @@ Range is -99.0 - \+99.0.
If the measured loudness from the first pass is lower than the target
loudness then normalization pass will be skipped for the measured audio
source.
]"
"--auto-lower-loudness-target[Automatically lower EBU Integrated Loudness Target to prevent falling
back to dynamic filtering.
Makes sure target loudness is lower than measured loudness minus peak
loudness (input_i - input_tp) by a small amount.
]"
"--dual-mono[Treat mono input files as \"dual-mono\".
Expand Down
1 change: 1 addition & 0 deletions completions/ffmpeg-normalize.bash
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ _ffmpeg_normalize()
-lrt --loudness-range-target \
--keep-loudness-range-target \
--keep-lra-above-loudness-range-target \
--auto-lower-loudness-target \
-tp --true-peak \
--offset \
--lower-only \
Expand Down
1 change: 1 addition & 0 deletions completions/ffmpeg-normalize.zsh
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ _ffmpeg_normalize() {
'(-lrt --loudness-range-target)'{-lrt,--loudness-range-target}'[EBU Loudness Range Target in LUFS]:range:'
'--keep-loudness-range-target[Keep input loudness range target]'
'--keep-lra-above-loudness-range-target[Keep input loudness range above target]'
'--auto-lower-loudness-target[Automatically lower EBU Integrated Loudness Target]'
'(-tp --true-peak)'{-tp,--true-peak}'[EBU Maximum True Peak in dBTP]:peak:'
'--offset[EBU Offset Gain]:offset:'
'--lower-only[Do not increase loudness]'
Expand Down
2 changes: 1 addition & 1 deletion ffmpeg_normalize/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ def create_parser() -> argparse.ArgumentParser:
back to dynamic filtering.
Makes sure target loudness is lower than measured loudness minus peak
loudness (input_i - input_tp) by a small amount.
loudness (input_i - input_tp) by a small amount (0.1 LUFS).
"""
),
)
Expand Down

0 comments on commit 5b27bee

Please sign in to comment.