Command line usage reference

autoscrub

Welcome to autoscrub!

If you’re unsure which command you want to run, you likely want:
autoscrub autoprocess <input video path> <output video path>
To view the additional options for autoprocessing, run:
autoscrub autoprocess –help
To see command line arguments for the other autoscrub commands, run:
autoscrub COMMAND –help
where the available commands are listed below.
autoscrub [OPTIONS] COMMAND [ARGS]...

autoprocess

automatically process the input video and write to the specified output file

autoscrub autoprocess [OPTIONS] input_filepath output_filepath

Options

-d, --silence-duration <silence_duration>

The minimum duration of continuous silence (in seconds) required to trigger speed up of that segment. [default: 2.0]

-h, --hasten-audio <hasten_audio>

The method of handling audio during the speed up of silent segments. [default: tempo]

-l, --target-lufs <target_lufs>

The target LUFS for the output audio [default: -18.0]

-p, --pan-audio <pan_audio>

Copies the specified audio channel (left|right) to both audio channels.

-r, --rescale <rescale>

rescale the input video file to the resolution specified [usage: -r 1920 1080]

-s, --speed <speed>

The factor by which to speed up the video during silent segments [default: 8]

-t, --target-threshold <target_threshold>

The audio threshold for detecting silent segments in dB [default: -18.0]

-v, --silent-volume <silent_volume>

The factor to scale the audio volume during silent segments [default: 1.0]

--delay <delay>

The length of time (in seconds) to delay the start of the speed up of a silent segment. This also ends the speedup early, by the same amount, and must satisfy the condition 2*delay < silence-duration [default: 0.25]

--show-ffmpeg-output

Prints the raw FFmpeg and FFprobe output to the terminal

--debug

Retains the generated filtergraph file for inspection

Arguments

input_filepath

Required argument

output_filepath

Required argument

display-video-properties

Displays properties about the input file

autoscrub display-video-properties [OPTIONS] input_filepath

Options

--show-ffmpeg-output

Prints the raw FFmpeg and FFprobe output to the terminal

Arguments

input_filepath

Required argument

identify-silences

Displays a table of detected silent segments

autoscrub identify-silences [OPTIONS] input_filepath

Options

-d, --silence-duration <silence_duration>

The minimum duration of continuous silence (in seconds) required to trigger speed up of that segment. [default: 2.0]

-t, --target-threshold <target_threshold>

The audio threshold for detecting silent segments in dB [default: -18.0]

--show-ffmpeg-output

Prints the raw FFmpeg and FFprobe output to the terminal

Arguments

input_filepath

Required argument

loudness-adjust

Adjusts the loudness of the input file

autoscrub loudness-adjust [OPTIONS] input_filepath output_filepath

Options

-l, --target-lufs <target_lufs>

The target LUFS for the output audio [default: -18.0]

--show-ffmpeg-output

Prints the raw FFmpeg and FFprobe output to the terminal

Arguments

input_filepath

Required argument

output_filepath

Required argument

make-filtergraph

Generates a filter-graph file for use with ffmpeg.

This command is useful if you want to manually edit the filter-graph file before processing your video.
autoscrub make-filtergraph [OPTIONS] input_filepath

Options

-d, --silence-duration <silence_duration>

The minimum duration of continuous silence (in seconds) required to trigger speed up of that segment. [default: 2.0]

-h, --hasten-audio <hasten_audio>

The method of handling audio during the speed up of silent segments. [default: tempo]

-l, --target-lufs <target_lufs>

The target LUFS for the output audio [default: -18.0]

-p, --pan-audio <pan_audio>

Copies the specified audio channel (left|right) to both audio channels.

-r, --rescale <rescale>

rescale the input video file to the resolution specified [usage: -r 1920 1080]

-s, --speed <speed>

The factor by which to speed up the video during silent segments [default: 8]

-t, --target-threshold <target_threshold>

The audio threshold for detecting silent segments in dB [default: -18.0]

-v, --silent-volume <silent_volume>

The factor to scale the audio volume during silent segments [default: 1.0]

--delay <delay>

The length of time (in seconds) to delay the start of the speed up of a silent segment. This also ends the speedup early, by the same amount, and must satisfy the condition 2*delay < silence-duration [default: 0.25]

--show-ffmpeg-output

Prints the raw FFmpeg and FFprobe output to the terminal

Arguments

input_filepath

Required argument

process-filtergraph

Processes a video file using the filter-graph file created by the autoscrub make-filtergraph command

autoscrub process-filtergraph [OPTIONS] input_filepath output_filepath

Options

--show-ffmpeg-output

Prints the raw FFmpeg and FFprobe output to the terminal

Arguments

input_filepath

Required argument

output_filepath

Required argument

trim

removes unwanted content from the start and end of the input file

autoscrub trim [OPTIONS] input_filepath output_filepath

Options

--start <start>

Content before this time is removed [default: 0]

--stop <stop>

Content after this time is removed

--re-encode <re_encode>

Re-encode the file with the codec specified

--show-ffmpeg-output

Prints the raw FFmpeg and FFprobe output to the terminal

Arguments

input_filepath

Required argument

output_filepath

Required argument

version

Displays the autoscrub version

autoscrub version [OPTIONS]