/ 
App-FfmpegUtils-0.014
River stage one • 1 direct dependent • 1 total dependent
/ vcensor

NAME

vcensor - Shorter alias for cut-duration-from-video

VERSION

This document describes version 0.014 of vcensor (from Perl distribution App-FfmpegUtils), released on 2024-09-22.

SYNOPSIS

vcensor --help (or -h, -?)

vcensor --version (or -v)

vcensor [--copy|--no-copy|--nocopy] [--debug|--log-level=level|--quiet|--trace|--verbose] [--dry-run|-n] [--duration=any|--duration-json=json|-d=any] [--end=any|--end-json=json|-e=any] [(--file=filename)+|--files-json=json] [--format=name|--json] [--(no)naked-res] [--page-result[=program]|--view-result[=program]] [--start=any|--start-json=json|-s=any] -- <file> ...

See examples in the "EXAMPLES" section.

DESCRIPTION

This utility uses ffmpeg (particularly the -t and -ss) option to cut a portion (time range) out of a video. It can be used to remove an unwanted scene from a video.

Compared to using ffmpeg directly, this wrapper offers convenience of more flexibility in specifying times and duration (e.g. '15s' as well as '00:10' as well as 'PT1M30S'), specifying only 'end' and 'duration', handling multiple files, automatically choosing output filename, and tab completion.

Alternatives:

1. If you just want to play a video and censor out certain parts, you can use create a playlist of segments called an EDL file. See for example:

https://github.com/mpv-player/mpv/blob/master/DOCS/edl-mpv.rst

OPTIONS

* marks required options.

Main options

--copy

Whether to use the "copy" codec (fast but produces inaccurate timings).

--duration-json=s, -d

See --duration.

--duration=s

(No description)

--end-json=s, -e

See --end.

--end=s

(No description)

--file=s@*

(No description)

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

Can be specified multiple times.

--files-json=s

See --file.

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

--start-json=s, -s

See --start.

--start=s

(No description)

Logging options

--debug

Shortcut for --log-level=debug.

--log-level=s

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.

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.

--quiet

Shortcut for --log-level=error.

--trace

Shortcut for --log-level=trace.

--verbose

Shortcut for --log-level=info.

Output options

--format=s

Choose output format, e.g. json, text.

Default value:

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.

--json

Set output format to json.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

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:

[1,2,3]
--page-result

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.

--view-result

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.

Other options

--dry-run, -n

Run in simulation mode (also via DRY_RUN=1).

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

complete -C vcensor vcensor

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.

tcsh

To activate tcsh completion for this script, put:

complete vcensor 'p/*/`vcensor`/'

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).

other shells

For fish and zsh, install shcompgen as described above.

EXAMPLES

Specify start & end only (using h:m:s notation), the result is 100s.cut_50_to_63.mp4

% vcensor 100s.mp4 -s 00:00:50 -e 00:01:03

Specify start & duration only (using seconds), the result is 100s.cut_50_to_63.mp4

% vcensor 100s.mp4 -s 50 -d 13

Specify end & duration only (using human & ISO 8601 notation), the result is 100s.cut_50_to_63.mp4

% vcensor 100s.mp4 -e PT63S -d 13s

HOMEPAGE

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

SOURCE

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

AUTHOR

perlancar <perlancar@cpan.org>

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

COPYRIGHT AND LICENSE

This software is copyright (c) 2024, 2023, 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.

BUGS

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.