view release on metacpan or  search on metacpan

script/reencode-video-with-libx264  view on Meta::CPAN

#!perl

# Note: This script is a CLI for Riap function /App/FfmpegUtils/reencode_video_with_libx264
# and generated automatically using Perinci::CmdLine::Gen version 0.502

use 5.010001;
use strict;
use warnings;
use Log::ger;

use Perinci::CmdLine::Any;

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2025-10-29'; # DATE
our $DIST = 'App-FfmpegUtils'; # DIST
our $VERSION = '0.015'; # VERSION

my $cmdline = Perinci::CmdLine::Any->new(
    url => "/App/FfmpegUtils/reencode_video_with_libx264",
    program_name => "reencode-video-with-libx264",
    log => 1,
    log_level => "info",
);

$cmdline->run;

# ABSTRACT: Re-encode video (using ffmpeg and libx264)
# PODNAME: reencode-video-with-libx264

__END__

=pod

=encoding UTF-8

=head1 NAME

reencode-video-with-libx264 - Re-encode video (using ffmpeg and libx264)

=head1 VERSION

This document describes version 0.015 of reencode-video-with-libx264 (from Perl distribution App-FfmpegUtils), released on 2025-10-29.

=head1 SYNOPSIS

B<reencode-video-with-libx264> B<L<--help|/"--help">>

B<reencode-video-with-libx264> B<L<--version|/"--version">>

B<reencode-video-with-libx264> [B<L<--audio-sample-rate|/"--audio-sample-rate=s, --sample-rate">>=I<L<uint|Sah::Schema::uint>>|B<L<--sample-rate|/"--audio-sample-rate=s, --sample-rate">>=I<L<uint|Sah::Schema::uint>>] [B<L<--config-path|/"--config-pat...



See examples in the L</EXAMPLES> section.

=head1 DESCRIPTION

This utility runs I<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 C<--dry-run> option to let
you see ffmpeg options to be used without actually running ffmpeg.

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 C<--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 C<-vf scale> option is added. This utility also
calculates a valid size for ffmpeg, since using C<-vf scale=-1:720> sometimes
results in failure due to odd number.

Audio streams are copied, not re-encoded.

Output filenames are:

 ORIGINAL_NAME.crf28.mp4

or (if downsizing is done):

 ORIGINAL_NAME.480p-crf28.mp4

=head1 OPTIONS

C<*> marks required options.

=head2 Main options

=over

=item B<--audio-sample-rate>=I<s>, B<--sample-rate>

Set audio sample rate, in Hz.

=item B<--crf>=I<s>

(No description)


=item B<--dont-scale>

Alias for --scale ''.

See C<--scale>.

=item B<--fast>

Shortcut for --preset=fast.

See C<--preset>.

=item B<--faster>

Shortcut for --preset=faster.

See C<--preset>.

=item B<--ffmpeg-path>=I<s>

(No description)


=item B<--file>=I<s@>*

(No description)


Can also be specified as the 1st command-line argument and onwards.

Can be specified multiple times.

=item B<--files-json>=I<s>

See C<--file>.

Can also be specified as the 1st command-line argument and onwards.

=item B<--frame-rate>=I<s>, B<-r>

Set frame rate, in fps.

=item B<--medium>

Shortcut for --preset=medium.

See C<--preset>.

=item B<--no-scale>

Alias for --scale ''.

See C<--scale>.

=item B<--overwrite>, B<-O>

(No description)


=item B<--preset>=I<s>

Default value:

 "veryslow"

Valid values:

 ["ultrafast","superfast","veryfast","faster","fast","medium","slow","slower","veryslow"]

=item B<--scale>=I<s>

Default value:

 "1080^>"

Scale video to specified size. See L<Math::Image::CalcResized> or
L<calc-image-resized-size> for more details on scale specification. Some
examples include:

The default is C<< 1080^E<gt> >> which means to shrink to 1080p if video size is larger
than 1080p.

To disable scaling, set C<--scale> to '' (empty string), or specify
C<--dont-scale> on the CLI.


=item B<--slow>

Shortcut for --preset=slow.

See C<--preset>.

=item B<--slower>

Shortcut for --preset=slower.

See C<--preset>.

=item B<--superfast>

Shortcut for --preset=superfast.

script/reencode-video-with-libx264  view on Meta::CPAN

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 L<cpanm-shcompgen>
which can activate shell completion for scripts immediately.

=head2 tcsh

To activate tcsh completion for this script, put:

 complete reencode-video-with-libx264 'p/*/`reencode-video-with-libx264`/'

in your tcsh startup (e.g. F<~/.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 L<shcompgen> (see above).

=head2 other shells

For fish and zsh, install L<shcompgen> as described above.

=head1 CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of L<IOD>, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using C<--config-path>): F</home/u1/.config/reencode-video-with-libx264.conf>, F</home/u1/reencode-video-with-libx264.conf>, or F</etc/reencode-video-with-libx264.conf>.

All found files will be read and merged.

To disable searching for configuration files, pass C<--no-config>.

You can put multiple profiles in a single file by using section names like C<[profile=SOMENAME]> or C<[SOMESECTION profile=SOMENAME]>. Those sections will only be read if you specify the matching C<--config-profile SOMENAME>.

You can also put configuration for multiple programs inside a single file, and use filter C<program=NAME> in section names, e.g. C<[program=NAME ...]> or C<[SOMESECTION program=NAME]>. The section will then only be used when the reading program match...

You can also filter a section by environment variable using the filter C<env=CONDITION> in section names. For example if you only want a section to be read if a certain environment variable is true: C<[env=SOMEVAR ...]> or C<[SOMESECTION env=SOMEVAR ...

To load and configure plugins, you can use either the C<-plugins> parameter (e.g. C<< -plugins=DumpArgs >> or C<< -plugins=DumpArgs@before_validate_args >>), or use the C<[plugin=NAME ...]> sections, for example:

 [plugin=DumpArgs]
 -event=before_validate_args
 -prio=99
 
 [plugin=Foo]
 -event=after_validate_args
 arg1=val1
 arg2=val2

 

which is equivalent to setting C<< -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)
 overwrite (see --overwrite)
 preset (see --preset)
 scale (see --scale)

=head1 ENVIRONMENT

=head2 REENCODE_VIDEO_WITH_LIBX264_OPT

String. Specify additional command-line options.

=head1 FILES

=head2 /home/u1/.config/reencode-video-with-libx264.conf

=head2 /home/u1/reencode-video-with-libx264.conf

=head2 /etc/reencode-video-with-libx264.conf

=head1 EXAMPLES

=head2 The default setting is to shrink to 1080p if video is larger than 1080p

 % reencode-video-with-libx264 *

=head2 Do not scale/shrink

 % reencode-video-with-libx264 --dont-scale *

=head2 Shrink to 480p if video is larger than 480p, but make the reencoding "visually lossless"

 % reencode-video-with-libx264 --scale '480^>' --crf 18 *

=head1 HOMEPAGE

Please visit the project's homepage at L<https://metacpan.org/release/App-FfmpegUtils>.

=head1 SOURCE

Source repository is at L<https://github.com/perlancar/perl-App-FfmpegUtils>.

=head1 AUTHOR

perlancar <perlancar@cpan.org>

=head1 CONTRIBUTING


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 L<Dist::Zilla>,
L<Dist::Zilla::PluginBundle::Author::PERLANCAR>,