Documentation:Modules/crop

Were you looking for croppadd, the current module?

Module: Crop
Type	Video filter
First VLC version	-
Last VLC version	2.0.9
Operating system(s)	all
Description	Remove borders of the video and replace them with black borders
Shortcut(s)	-

Options

• crop-geometry <string> : Set the geometry of the zone to crop. This is set as <width> × <height> + <left offset> + <top offset>
• autocrop <boolean> : Automatically detect black borders and crop them default value: disabled
• autocrop-ratio-max <integer [0 .. 15000]> : Maximum image ratio. The crop plugin will never automatically crop to a higher ratio (ie, to a more "flat" image). The value is ×1000: 1333 means 4⁄3 default value: 2405
• crop-ratio <integer [0 .. 15000]> : Force a ratio (0 for automatic). Value is ×1000: 1333 means 4⁄3 default value: 0
• autocrop-time <integer> : The number of consecutive images with the same detected ratio (different from the previously detected ratio) to consider that ratio changed and trigger recrop default value: 25
• autocrop-diff <integer> : The minimum difference in the number of detected black lines to consider that ratio changed and trigger recrop default value: 16
• autocrop-non-black-pixels <integer> : The maximum of non-black pixels in a line to consider that the line is black default value: 3
• autocrop-skip-percent <integer [0 .. 100]> : Percentage of the line to consider while checking for black lines. This allows skipping logos in black borders and crop them anyway default value: 17
• autocrop-luminance-threshold <integer [0 .. 128]> : Maximum luminance to consider a pixel as black (0-255)* default value: 40

Note

This must be a typo. Despite the claim of a range of 0-255 in the help text for the --autocrop-luminance-threshold option, the call to add_integer_with_range would have limited this to effectively 0-128.

Source code

• modules/video_filter/crop.c (vlc/vlc-2.0.git)

This page is part of official VLC media player Documentation (User Guide • Streaming HowTo • Hacker Guide • Modules)
Please read the Documentation Editing Guidelines before you edit the documentation

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.