Histogram

Video Single output Transform

Compute and draw a histogram.

FFmpeg filter: histogram — 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 Histogram(…));
$result = $node->outputs()[0];

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

$result = $video->apply(new Histogram(…));

When to use it

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.

How to use it

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

Examples

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

Gotchas

TODO

See also

TODO

Parameters

Parameter	Type	Default	Range / values	Description
level_height	int	200	50–2048	set level height
scale_height	int	12	0–40	set scale height
display_mode	HistogramDisplayMode	stack	overlay, parade, stack	set display mode
levels_mode	HistogramLevelsMode	linear	linear, logarithmic	set levels mode
components	int	7	1–15	set color components to display
fgopacity	float	0.7	0–1	set foreground opacity
bgopacity	float	0.5	0–1	set background opacity
colors_mode	HistogramColorsMode	whiteonblack	whiteonblack, blackonwhite, whiteongray, blackongray, coloronblack, coloronwhite, colorongray, blackoncolor, …	set colors mode

FFmpeg also names these options (use the parameter shown above): d → display_mode, m → levels_mode, c → components, f → fgopacity, b → bgopacity, l → colors_mode.

---

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