Skip to content

Crop

Video Single output Transform

Crop the input video.

FFmpeg filter: crop — the official reference.

Add it to a graph. The explicit form works for every filter — bind it to its input and read the result from outputs():

$node = $video->addFilter(new Crop());
$result = $node->outputs()[0];

Shorthand. Single-output filters can skip the node — apply() returns the result stream directly:

$result = $video->apply(new Crop());

TODO — when this filter shines: what it’s the right tool for, what to reach for instead when it isn’t, and how it composes with neighbouring filters.

TODO — prose: how the filter actually works and what its key parameters mean (the explanation FFmpeg’s terse option help omits).

TODO — runnable PHP, with the equivalent ffmpeg CLI alongside.

TODO

TODO

ParameterTypeDefaultRange / valuesDescription
out_wint|float|stringiwexpressionset the width crop area expression
out_hint|float|stringihexpressionset the height crop area expression
xint|float|string(in_w-out_w)/2expressionset the x crop area expression
yint|float|string(in_h-out_h)/2expressionset the y crop area expression
keep_aspectboolfalsekeep aspect ratio
exactboolfalsedo exact cropping

FFmpeg also names these options (use the parameter shown above): wout_w, hout_h.


Maps to FFmpeg’s crop filter. Verified against ffmpeg n7.1.1.

An Artisan Build project.

Built on FFmpeg — an independent binding, not affiliated with or endorsed by the FFmpeg project. Support FFmpeg.