reencode-video-with-libx264 - Re-encode video (using ffmpeg and libx264)
This document describes version 0.010 of reencode-video-with-libx264 (from Perl distribution App-FfmpegUtils), released on 2022-09-20.
reencode-video-with-libx264 [--audio-sample-rate=uint|--sample-rate=uint] [--config-path=path|-c|--no-config|-C] [--config-profile=profile|-P] [--crf=int] [--debug|--log-level=level|--quiet|--trace|--verbose] [--dry-run|-n] [--ffmpeg-path=filename] [(--file=filename)+|--files-json=json] [--format=name|--json] [--frame-rate=ufloat|-r=ufloat] [--(no)naked-res] [--no-env] [--page-result[=program]|--view-result[=program]] [--preset=str|--fast|--faster|--medium|--slow|--slower|--superfast|--ultrafast|--veryfast|--veryslow] [--scale=str|--dont-scale|--no-scale] -- <file> ...
See examples in the "EXAMPLES" section.
This utility runs ffmpeg to re-encode your video files using the libx264 codec. It is a wrapper to simplify invocation of ffmpeg. It selects the appropriate ffmpeg options for you, allows you to specify multiple files, and picks appropriate output filenames. It also sports a --dry-run option to let you see ffmpeg options to be used without actually running ffmpeg.
--dry-run
This utility is usually used to reduce the file size (and optionally video width/height) of videos so they are smaller, while minimizing quality loss. Smartphone-produced videos are often high bitrate (e.g. >10-20Mbit) and not yet well compressed, so they make a good input for this utility. The default setting is roughly similar to how Google Photos encodes videos (max 1080p).
The default settings are:
-v:c libx264 -preset veryslow (to get the best compression rate, but with the slowest encoding time) -crf 28 (0-51, subjectively sane is 18-28, 18 ~ visually lossless, 28 ~ visually acceptable)
when a downsizing is requested (using the --downsize-to option), this utility first checks each input video if it is indeed larger than the requested final size. If it is, then the -vf scale option is added. This utility also calculates a valid size for ffmpeg, since using -vf scale=-1:720 sometimes results in failure due to odd number.
--downsize-to
-vf scale
-vf scale=-1:720
Audio streams are copied, not re-encoded.
Output filenames are:
ORIGINAL_NAME.crf28.mp4
or (if downsizing is done):
ORIGINAL_NAME.480p-crf28.mp4
* marks required options.
*
Set audio sample rate, in Hz.
Alias for --scale ''.
See --scale.
--scale
Shortcut for --preset=fast.
See --preset.
--preset
Shortcut for --preset=faster.
Can also be specified as the 1st command-line argument and onwards.
Can be specified multiple times.
See --file.
--file
Set frame rate, in fps.
Shortcut for --preset=medium.
Default value:
"veryslow"
Valid values:
["ultrafast","superfast","veryfast","faster","fast","medium","slow","slower","veryslow"]
"1080^>"
Scale video to specified size. See Math::Image::CalcResized or calc-image-resized-size for more details on scale specification. Some examples include:
The default is 1080^> which means to shrink to 1080p if video size is larger than 1080p.
1080^>
To disable scaling, set --scale to '' (empty string), or specify --dont-scale on the CLI.
--dont-scale
Shortcut for --preset=slow.
Shortcut for --preset=slower.
Shortcut for --preset=superfast.
Shortcut for --preset=ultrafast.
Shortcut for --preset=veryfast.
Shortcut for --preset=veryslow.
Set path to configuration file.
Can actually be specified multiple times to instruct application to read from multiple configuration files (and merge them).
Set configuration profile to use.
A single configuration file can contain profiles, i.e. alternative sets of values that can be selected. For example:
[profile=dev] username=foo pass=beaver [profile=production] username=bar pass=honey
When you specify --config-profile=dev, username will be set to foo and password to beaver. When you specify --config-profile=production, username will be set to bar and password to honey.
--config-profile=dev
username
foo
password
beaver
--config-profile=production
bar
honey
Do not use any configuration file.
If you specify --no-config, the application will not read any configuration file.
--no-config
Do not read environment for default options.
If you specify --no-env, the application wil not read any environment variable.
--no-env
Shortcut for --log-level=debug.
Set log level.
By default, these log levels are available (in order of increasing level of importance, from least important to most): trace, debug, info, warn/warning, error, fatal. By default, the level is usually set to warn, which means that log statements with level info and less important levels will not be shown. To increase verbosity, choose info, debug, or trace.
trace
debug
info
warn
warning
error
fatal
For more details on log level and logging, as well as how new logging levels can be defined or existing ones modified, see Log::ger.
Shortcut for --log-level=error.
Shortcut for --log-level=trace.
Shortcut for --log-level=info.
Choose output format, e.g. json, text.
undef
Output can be displayed in multiple formats, and a suitable default format is chosen depending on the application and/or whether output destination is interactive terminal (i.e. whether output is piped). This option specifically chooses an output format.
Set output format to json.
When outputing as JSON, strip result envelope.
0
By default, when outputing as JSON, the full enveloped result is returned, e.g.:
[200,"OK",[1,2,3],{"func.extra"=>4}]
The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use --naked-res so you just get:
--naked-res
[1,2,3]
Filter output through a pager.
This option will pipe the output to a specified pager program. If pager program is not specified, a suitable default e.g. less is chosen.
less
View output using a viewer.
This option will first save the output to a temporary file, then open a viewer program to view the temporary file. If a viewer program is not chosen, a suitable default, e.g. the browser, is chosen.
Run in simulation mode (also via DRY_RUN=1).
Display help message and exit.
Display program's version and exit.
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C reencode-video-with-libx264 reencode-video-with-libx264
in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.
To activate tcsh completion for this script, put:
complete reencode-video-with-libx264 'p/*/`reencode-video-with-libx264`/'
in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is also recommended to install shcompgen (see above).
For fish and zsh, install shcompgen as described above.
This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.
By default, these names are searched for configuration filenames (can be changed using --config-path): /home/u1/.config/reencode-video-with-libx264.conf, /home/u1/reencode-video-with-libx264.conf, or /etc/reencode-video-with-libx264.conf.
--config-path
All found files will be read and merged.
To disable searching for configuration files, pass --no-config.
You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.
[profile=SOMENAME]
[SOMESECTION profile=SOMENAME]
--config-profile SOMENAME
You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.
program=NAME
[program=NAME ...]
[SOMESECTION program=NAME]
You can also filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable equals some string: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal some string: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when the value of an environment variable includes some string: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. If you only want a section to be read when the value of an environment variable does not include some string: [env=HOSTNAME!*=server ...] or [SOMESECTION env=HOSTNAME!*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.
env=CONDITION
[env=SOMEVAR ...]
[SOMESECTION env=SOMEVAR ...]
[env=HOSTNAME=blink ...]
[SOMESECTION env=HOSTNAME=blink ...]
[env=HOSTNAME!=blink ...]
[SOMESECTION env=HOSTNAME!=blink ...]
[env=HOSTNAME*=server ...]
[SOMESECTION env=HOSTNAME*=server ...]
[env=HOSTNAME!*=server ...]
[SOMESECTION env=HOSTNAME!*=server ...]
To load and configure plugins, you can use either the -plugins parameter (e.g. -plugins=DumpArgs or -plugins=DumpArgs@before_validate_args), or use the [plugin=NAME ...] sections, for example:
-plugins
-plugins=DumpArgs
-plugins=DumpArgs@before_validate_args
[plugin=NAME ...]
[plugin=DumpArgs] -event=before_validate_args -prio=99 [plugin=Foo] -event=after_validate_args arg1=val1 arg2=val2
which is equivalent to setting -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2.
-plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2
List of available configuration parameters:
audio_sample_rate (see --audio-sample-rate) crf (see --crf) ffmpeg_path (see --ffmpeg-path) files (see --file) format (see --format) frame_rate (see --frame-rate) log_level (see --log-level) naked_res (see --naked-res) preset (see --preset) scale (see --scale)
String. Specify additional command-line options.
% reencode-video-with-libx264 *
% reencode-video-with-libx264 --dont-scale *
% reencode-video-with-libx264 --scale '480^>' --crf 18 *
Please visit the project's homepage at https://metacpan.org/release/App-FfmpegUtils.
Source repository is at https://github.com/perlancar/perl-App-FfmpegUtils.
perlancar <perlancar@cpan.org>
To contribute, you can send patches by email/via RT, or send pull requests on GitHub.
Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:
% prove -l
If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.
This software is copyright (c) 2022, 2020 by perlancar <perlancar@cpan.org>.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-FfmpegUtils
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
To install App::FfmpegUtils, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::FfmpegUtils
CPAN shell
perl -MCPAN -e shell install App::FfmpegUtils
For more information on module installation, please visit the detailed CPAN module installation guide.