2 * Copyright (c) 2012-2013 Paul B Mahol
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #include "libavutil/avassert.h"
22 #include "libavutil/opt.h"
23 #include "libavutil/parseutils.h"
24 #include "libavutil/pixdesc.h"
38 typedef struct HistogramContext {
39 const AVClass *class; ///< AVClass context for log and options purpose
40 enum HistogramMode mode;
41 unsigned histogram[256];
43 const uint8_t *bg_color;
44 const uint8_t *fg_color;
53 #define OFFSET(x) offsetof(HistogramContext, x)
54 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
56 static const AVOption histogram_options[] = {
57 { "mode", "set histogram mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64=MODE_LEVELS}, 0, MODE_NB-1, FLAGS, "mode"},
58 { "levels", "standard histogram", 0, AV_OPT_TYPE_CONST, {.i64=MODE_LEVELS}, 0, 0, FLAGS, "mode" },
59 { "waveform", "per row/column luminance graph", 0, AV_OPT_TYPE_CONST, {.i64=MODE_WAVEFORM}, 0, 0, FLAGS, "mode" },
60 { "color", "chroma values in vectorscope", 0, AV_OPT_TYPE_CONST, {.i64=MODE_COLOR}, 0, 0, FLAGS, "mode" },
61 { "color2", "chroma values in vectorscope", 0, AV_OPT_TYPE_CONST, {.i64=MODE_COLOR2}, 0, 0, FLAGS, "mode" },
62 { "level_height", "set level height", OFFSET(level_height), AV_OPT_TYPE_INT, {.i64=200}, 50, 2048, FLAGS},
63 { "scale_height", "set scale height", OFFSET(scale_height), AV_OPT_TYPE_INT, {.i64=12}, 0, 40, FLAGS},
64 { "step", "set waveform step value", OFFSET(step), AV_OPT_TYPE_INT, {.i64=10}, 1, 255, FLAGS},
65 { "waveform_mode", "set waveform mode", OFFSET(waveform_mode), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS, "waveform_mode"},
66 { "row", NULL, 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, FLAGS, "waveform_mode" },
67 { "column", NULL, 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, FLAGS, "waveform_mode" },
68 { "display_mode", "set display mode", OFFSET(display_mode), AV_OPT_TYPE_INT, {.i64=1}, 0, 1, FLAGS, "display_mode"},
69 { "parade", NULL, 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, FLAGS, "display_mode" },
70 { "overlay", NULL, 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, FLAGS, "display_mode" },
71 { "levels_mode", "set levels mode", OFFSET(levels_mode), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS, "levels_mode"},
72 { "linear", NULL, 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, FLAGS, "levels_mode" },
73 { "logarithmic", NULL, 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, FLAGS, "levels_mode" },
77 AVFILTER_DEFINE_CLASS(histogram);
79 static const enum AVPixelFormat color_pix_fmts[] = {
80 AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUVA444P, AV_PIX_FMT_YUVJ444P,
84 static const enum AVPixelFormat levels_pix_fmts[] = {
85 AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUVA444P, AV_PIX_FMT_YUVJ444P,
86 AV_PIX_FMT_GRAY8, AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP, AV_PIX_FMT_NONE
89 static int query_formats(AVFilterContext *ctx)
91 HistogramContext *h = ctx->priv;
92 const enum AVPixelFormat *pix_fmts;
97 pix_fmts = levels_pix_fmts;
101 pix_fmts = color_pix_fmts;
107 ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
112 static const uint8_t black_yuva_color[4] = { 0, 127, 127, 255 };
113 static const uint8_t black_gbrp_color[4] = { 0, 0, 0, 255 };
114 static const uint8_t white_yuva_color[4] = { 255, 127, 127, 255 };
115 static const uint8_t white_gbrp_color[4] = { 255, 255, 255, 255 };
117 static int config_input(AVFilterLink *inlink)
119 HistogramContext *h = inlink->dst->priv;
120 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
122 h->ncomp = desc->nb_components;
124 switch (inlink->format) {
125 case AV_PIX_FMT_GBRAP:
126 case AV_PIX_FMT_GBRP:
127 h->bg_color = black_gbrp_color;
128 h->fg_color = white_gbrp_color;
131 h->bg_color = black_yuva_color;
132 h->fg_color = white_yuva_color;
138 static int config_output(AVFilterLink *outlink)
140 AVFilterContext *ctx = outlink->src;
141 HistogramContext *h = ctx->priv;
146 outlink->h = (h->level_height + h->scale_height) * FFMAX(h->ncomp * h->display_mode, 1);
149 if (h->waveform_mode)
150 outlink->h = 256 * FFMAX(h->ncomp * h->display_mode, 1);
152 outlink->w = 256 * FFMAX(h->ncomp * h->display_mode, 1);
156 outlink->h = outlink->w = 256;
162 outlink->sample_aspect_ratio = (AVRational){1,1};
167 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
169 HistogramContext *h = inlink->dst->priv;
170 AVFilterContext *ctx = inlink->dst;
171 AVFilterLink *outlink = ctx->outputs[0];
177 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
180 return AVERROR(ENOMEM);
185 for (k = 0; k < h->ncomp; k++)
186 for (i = 0; i < outlink->h; i++)
187 memset(out->data[k] + i * out->linesize[k], h->bg_color[k], outlink->w);
191 for (k = 0; k < h->ncomp; k++) {
192 int start = k * (h->level_height + h->scale_height) * h->display_mode;
194 unsigned max_hval = 0;
196 for (i = 0; i < in->height; i++) {
197 src = in->data[k] + i * in->linesize[k];
198 for (j = 0; j < in->width; j++)
199 h->histogram[src[j]]++;
202 for (i = 0; i < 256; i++)
203 max_hval = FFMAX(max_hval, h->histogram[i]);
204 max_hval_log = log2(max_hval + 1);
206 for (i = 0; i < outlink->w; i++) {
210 col_height = round(h->level_height * (1. - (log2(h->histogram[i] + 1) / max_hval_log)));
212 col_height = h->level_height - (h->histogram[i] * (int64_t)h->level_height + max_hval - 1) / max_hval;
214 for (j = h->level_height - 1; j >= col_height; j--) {
215 if (h->display_mode) {
216 for (l = 0; l < h->ncomp; l++)
217 out->data[l][(j + start) * out->linesize[l] + i] = h->fg_color[l];
219 out->data[k][(j + start) * out->linesize[k] + i] = 255;
222 for (j = h->level_height + h->scale_height - 1; j >= h->level_height; j--)
223 out->data[k][(j + start) * out->linesize[k] + i] = i;
226 memset(h->histogram, 0, 256 * sizeof(unsigned));
230 if (h->waveform_mode) {
231 for (k = 0; k < h->ncomp; k++) {
232 int offset = k * 256 * h->display_mode;
233 for (i = 0; i < inlink->w; i++) {
234 for (j = 0; j < inlink->h; j++) {
236 in->data[k][j * in->linesize[k] + i]) *
237 out->linesize[k] + i;
238 unsigned value = out->data[k][pos];
239 value = FFMIN(value + h->step, 255);
240 out->data[k][pos] = value;
245 for (k = 0; k < h->ncomp; k++) {
246 int offset = k * 256 * h->display_mode;
247 for (i = 0; i < inlink->h; i++) {
248 src = in ->data[k] + i * in ->linesize[k];
249 dst = out->data[k] + i * out->linesize[k];
250 for (j = 0; j < inlink->w; j++) {
251 int pos = src[j] + offset;
252 unsigned value = dst[pos];
253 value = FFMIN(value + h->step, 255);
261 for (i = 0; i < inlink->h; i++) {
262 int iw1 = i * in->linesize[1];
263 int iw2 = i * in->linesize[2];
264 for (j = 0; j < inlink->w; j++) {
265 int pos = in->data[1][iw1 + j] * out->linesize[0] + in->data[2][iw2 + j];
266 if (out->data[0][pos] < 255)
270 for (i = 0; i < 256; i++) {
271 dst = out->data[0] + i * out->linesize[0];
272 for (j = 0; j < 256; j++) {
274 out->data[1][i * out->linesize[0] + j] = i;
275 out->data[2][i * out->linesize[0] + j] = j;
281 for (i = 0; i < inlink->h; i++) {
282 int iw1 = i * in->linesize[1];
283 int iw2 = i * in->linesize[2];
284 for (j = 0; j < inlink->w; j++) {
285 int u = in->data[1][iw1 + j];
286 int v = in->data[2][iw2 + j];
287 int pos = u * out->linesize[0] + v;
288 if (!out->data[0][pos])
289 out->data[0][pos] = FFABS(128 - u) + FFABS(128 - v);
290 out->data[1][pos] = u;
291 out->data[2][pos] = v;
300 return ff_filter_frame(outlink, out);
303 static const AVFilterPad inputs[] = {
306 .type = AVMEDIA_TYPE_VIDEO,
307 .filter_frame = filter_frame,
308 .config_props = config_input,
313 static const AVFilterPad outputs[] = {
316 .type = AVMEDIA_TYPE_VIDEO,
317 .config_props = config_output,
322 AVFilter avfilter_vf_histogram = {
324 .description = NULL_IF_CONFIG_SMALL("Compute and draw a histogram."),
325 .priv_size = sizeof(HistogramContext),
326 .query_formats = query_formats,
329 .priv_class = &histogram_class,