2 * Copyright (c) 2012-2019 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/colorspace.h"
23 #include "libavutil/opt.h"
24 #include "libavutil/parseutils.h"
25 #include "libavutil/pixdesc.h"
26 #include "libavutil/imgutils.h"
27 #include "libavutil/intreadwrite.h"
33 typedef struct HistogramContext {
34 const AVClass *class; ///< AVClass context for log and options purpose
37 unsigned histogram[256*256];
46 uint8_t envelope_rgba[4];
47 uint8_t envelope_color[4];
52 const AVPixFmtDescriptor *desc, *odesc;
62 #define OFFSET(x) offsetof(HistogramContext, x)
63 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
65 #define COMMON_OPTIONS \
66 { "display_mode", "set display mode", OFFSET(display_mode), AV_OPT_TYPE_INT, {.i64=2}, 0, 2, FLAGS, "display_mode"}, \
67 { "d", "set display mode", OFFSET(display_mode), AV_OPT_TYPE_INT, {.i64=2}, 0, 2, FLAGS, "display_mode"}, \
68 { "overlay", NULL, 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, FLAGS, "display_mode" }, \
69 { "parade", NULL, 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, FLAGS, "display_mode" }, \
70 { "stack", NULL, 0, AV_OPT_TYPE_CONST, {.i64=2}, 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 { "m", "set levels mode", OFFSET(levels_mode), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS, "levels_mode"}, \
73 { "linear", NULL, 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, FLAGS, "levels_mode" }, \
74 { "logarithmic", NULL, 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, FLAGS, "levels_mode" }, \
75 { "components", "set color components to display", OFFSET(components), AV_OPT_TYPE_INT, {.i64=7}, 1, 15, FLAGS}, \
76 { "c", "set color components to display", OFFSET(components), AV_OPT_TYPE_INT, {.i64=7}, 1, 15, FLAGS},
78 static const AVOption histogram_options[] = {
79 { "level_height", "set level height", OFFSET(level_height), AV_OPT_TYPE_INT, {.i64=200}, 50, 2048, FLAGS},
80 { "scale_height", "set scale height", OFFSET(scale_height), AV_OPT_TYPE_INT, {.i64=12}, 0, 40, FLAGS},
82 { "fgopacity", "set foreground opacity", OFFSET(fgopacity), AV_OPT_TYPE_FLOAT, {.dbl=0.7}, 0, 1, FLAGS},
83 { "f", "set foreground opacity", OFFSET(fgopacity), AV_OPT_TYPE_FLOAT, {.dbl=0.7}, 0, 1, FLAGS},
84 { "bgopacity", "set background opacity", OFFSET(bgopacity), AV_OPT_TYPE_FLOAT, {.dbl=0.5}, 0, 1, FLAGS},
85 { "b", "set background opacity", OFFSET(bgopacity), AV_OPT_TYPE_FLOAT, {.dbl=0.5}, 0, 1, FLAGS},
89 AVFILTER_DEFINE_CLASS(histogram);
91 static const enum AVPixelFormat levels_in_pix_fmts[] = {
92 AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUVJ420P,
93 AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVJ422P,
94 AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUVJ411P,
95 AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV410P,
96 AV_PIX_FMT_YUVA444P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUVJ444P,
97 AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9,
98 AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA444P9,
99 AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10,
100 AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA444P10,
101 AV_PIX_FMT_YUV420P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV444P12, AV_PIX_FMT_YUV440P12,
102 AV_PIX_FMT_YUVA422P12, AV_PIX_FMT_YUVA444P12,
103 AV_PIX_FMT_GBRAP, AV_PIX_FMT_GBRP,
104 AV_PIX_FMT_GBRP9, AV_PIX_FMT_GBRP10, AV_PIX_FMT_GBRAP10,
105 AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRAP12,
110 static const enum AVPixelFormat levels_out_yuv8_pix_fmts[] = {
111 AV_PIX_FMT_YUVA444P, AV_PIX_FMT_YUV444P,
115 static const enum AVPixelFormat levels_out_yuv9_pix_fmts[] = {
116 AV_PIX_FMT_YUVA444P9, AV_PIX_FMT_YUV444P9,
120 static const enum AVPixelFormat levels_out_yuv10_pix_fmts[] = {
121 AV_PIX_FMT_YUVA444P10, AV_PIX_FMT_YUV444P10,
125 static const enum AVPixelFormat levels_out_yuv12_pix_fmts[] = {
126 AV_PIX_FMT_YUVA444P12, AV_PIX_FMT_YUV444P12,
130 static const enum AVPixelFormat levels_out_rgb8_pix_fmts[] = {
131 AV_PIX_FMT_GBRAP, AV_PIX_FMT_GBRP,
135 static const enum AVPixelFormat levels_out_rgb9_pix_fmts[] = {
140 static const enum AVPixelFormat levels_out_rgb10_pix_fmts[] = {
141 AV_PIX_FMT_GBRP10, AV_PIX_FMT_GBRAP10,
145 static const enum AVPixelFormat levels_out_rgb12_pix_fmts[] = {
146 AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRAP12,
150 static int query_formats(AVFilterContext *ctx)
152 AVFilterFormats *avff;
153 const AVPixFmtDescriptor *desc;
154 const enum AVPixelFormat *out_pix_fmts;
158 if (!ctx->inputs[0]->incfg.formats ||
159 !ctx->inputs[0]->incfg.formats->nb_formats) {
160 return AVERROR(EAGAIN);
163 if (!ctx->inputs[0]->outcfg.formats)
164 if ((ret = ff_formats_ref(ff_make_format_list(levels_in_pix_fmts), &ctx->inputs[0]->outcfg.formats)) < 0)
166 avff = ctx->inputs[0]->incfg.formats;
167 desc = av_pix_fmt_desc_get(avff->formats[0]);
168 rgb = desc->flags & AV_PIX_FMT_FLAG_RGB;
169 bits = desc->comp[0].depth;
170 for (i = 1; i < avff->nb_formats; i++) {
171 desc = av_pix_fmt_desc_get(avff->formats[i]);
172 if ((rgb != (desc->flags & AV_PIX_FMT_FLAG_RGB)) ||
173 (bits != desc->comp[0].depth))
174 return AVERROR(EAGAIN);
177 if (rgb && bits == 8)
178 out_pix_fmts = levels_out_rgb8_pix_fmts;
179 else if (rgb && bits == 9)
180 out_pix_fmts = levels_out_rgb9_pix_fmts;
181 else if (rgb && bits == 10)
182 out_pix_fmts = levels_out_rgb10_pix_fmts;
183 else if (rgb && bits == 12)
184 out_pix_fmts = levels_out_rgb12_pix_fmts;
186 out_pix_fmts = levels_out_yuv8_pix_fmts;
188 out_pix_fmts = levels_out_yuv9_pix_fmts;
190 out_pix_fmts = levels_out_yuv10_pix_fmts;
192 out_pix_fmts = levels_out_yuv12_pix_fmts;
194 return AVERROR(EAGAIN);
195 if ((ret = ff_formats_ref(ff_make_format_list(out_pix_fmts), &ctx->outputs[0]->incfg.formats)) < 0)
201 static const uint8_t black_yuva_color[4] = { 0, 127, 127, 255 };
202 static const uint8_t black_gbrp_color[4] = { 0, 0, 0, 255 };
203 static const uint8_t white_yuva_color[4] = { 255, 127, 127, 255 };
204 static const uint8_t white_gbrp_color[4] = { 255, 255, 255, 255 };
206 static int config_input(AVFilterLink *inlink)
208 HistogramContext *s = inlink->dst->priv;
210 s->desc = av_pix_fmt_desc_get(inlink->format);
211 s->ncomp = s->desc->nb_components;
212 s->histogram_size = 1 << s->desc->comp[0].depth;
213 s->mult = s->histogram_size / 256;
215 switch (inlink->format) {
216 case AV_PIX_FMT_GBRAP12:
217 case AV_PIX_FMT_GBRP12:
218 case AV_PIX_FMT_GBRAP10:
219 case AV_PIX_FMT_GBRP10:
220 case AV_PIX_FMT_GBRP9:
221 case AV_PIX_FMT_GBRAP:
222 case AV_PIX_FMT_GBRP:
223 memcpy(s->bg_color, black_gbrp_color, 4);
224 memcpy(s->fg_color, white_gbrp_color, 4);
225 s->start[0] = s->start[1] = s->start[2] = s->start[3] = 0;
226 memcpy(s->envelope_color, s->envelope_rgba, 4);
229 memcpy(s->bg_color, black_yuva_color, 4);
230 memcpy(s->fg_color, white_yuva_color, 4);
231 s->start[0] = s->start[3] = 0;
232 s->start[1] = s->start[2] = s->histogram_size / 2;
233 s->envelope_color[0] = RGB_TO_Y_BT709(s->envelope_rgba[0], s->envelope_rgba[1], s->envelope_rgba[2]);
234 s->envelope_color[1] = RGB_TO_U_BT709(s->envelope_rgba[0], s->envelope_rgba[1], s->envelope_rgba[2], 0);
235 s->envelope_color[2] = RGB_TO_V_BT709(s->envelope_rgba[0], s->envelope_rgba[1], s->envelope_rgba[2], 0);
236 s->envelope_color[3] = s->envelope_rgba[3];
239 s->fg_color[3] = s->fgopacity * 255;
240 s->bg_color[3] = s->bgopacity * 255;
242 s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, s->desc->log2_chroma_h);
243 s->planeheight[0] = s->planeheight[3] = inlink->h;
244 s->planewidth[1] = s->planewidth[2] = AV_CEIL_RSHIFT(inlink->w, s->desc->log2_chroma_w);
245 s->planewidth[0] = s->planewidth[3] = inlink->w;
250 static int config_output(AVFilterLink *outlink)
252 AVFilterContext *ctx = outlink->src;
253 HistogramContext *s = ctx->priv;
256 if (!strcmp(ctx->filter->name, "thistogram"))
259 for (i = 0; i < s->ncomp; i++) {
260 if ((1 << i) & s->components)
266 s->width = ctx->inputs[0]->w;
267 outlink->w = s->width * FFMAX(ncomp * (s->display_mode == 1), 1);
268 outlink->h = s->histogram_size * FFMAX(ncomp * (s->display_mode == 2), 1);
270 outlink->w = s->histogram_size * FFMAX(ncomp * (s->display_mode == 1), 1);
271 outlink->h = (s->level_height + s->scale_height) * FFMAX(ncomp * (s->display_mode == 2), 1);
274 s->odesc = av_pix_fmt_desc_get(outlink->format);
275 s->dncomp = s->odesc->nb_components;
276 outlink->sample_aspect_ratio = (AVRational){1,1};
281 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
283 HistogramContext *s = inlink->dst->priv;
284 AVFilterContext *ctx = inlink->dst;
285 AVFilterLink *outlink = ctx->outputs[0];
286 AVFrame *out = s->out;
289 if (!s->thistogram || !out) {
290 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
293 return AVERROR(ENOMEM);
297 for (k = 0; k < 4 && out->data[k]; k++) {
298 const int is_chroma = (k == 1 || k == 2);
299 const int dst_h = AV_CEIL_RSHIFT(outlink->h, (is_chroma ? s->odesc->log2_chroma_h : 0));
300 const int dst_w = AV_CEIL_RSHIFT(outlink->w, (is_chroma ? s->odesc->log2_chroma_w : 0));
302 if (s->histogram_size <= 256) {
303 for (i = 0; i < dst_h ; i++)
304 memset(out->data[s->odesc->comp[k].plane] +
305 i * out->linesize[s->odesc->comp[k].plane],
306 s->bg_color[k], dst_w);
308 const int mult = s->mult;
310 for (i = 0; i < dst_h ; i++)
311 for (j = 0; j < dst_w; j++)
312 AV_WN16(out->data[s->odesc->comp[k].plane] +
313 i * out->linesize[s->odesc->comp[k].plane] + j * 2,
314 s->bg_color[k] * mult);
319 for (m = 0, k = 0; k < s->ncomp; k++) {
320 const int p = s->desc->comp[k].plane;
321 const int max_value = s->histogram_size - 1 - s->start[p];
322 const int height = s->planeheight[p];
323 const int width = s->planewidth[p];
325 unsigned max_hval = 0;
328 if (!((1 << k) & s->components))
331 starty = m * s->histogram_size * (s->display_mode == 2);
332 startx = m++ * s->width * (s->display_mode == 1);
334 startx = m * s->histogram_size * (s->display_mode == 1);
335 starty = m++ * (s->level_height + s->scale_height) * (s->display_mode == 2);
338 if (s->histogram_size <= 256) {
339 for (i = 0; i < height; i++) {
340 const uint8_t *src = in->data[p] + i * in->linesize[p];
341 for (j = 0; j < width; j++)
342 s->histogram[src[j]]++;
345 for (i = 0; i < height; i++) {
346 const uint16_t *src = (const uint16_t *)(in->data[p] + i * in->linesize[p]);
347 for (j = 0; j < width; j++)
348 s->histogram[src[j]]++;
352 for (i = 0; i < s->histogram_size; i++)
353 max_hval = FFMAX(max_hval, s->histogram[i]);
354 max_hval_log = log2(max_hval + 1);
357 int minh = s->histogram_size - 1, maxh = 0;
359 for (int i = 0; i < s->histogram_size; i++) {
360 int idx = s->histogram_size - i - 1;
361 int value = s->start[p];
363 if (s->envelope && s->histogram[idx]) {
364 minh = FFMIN(minh, i);
365 maxh = FFMAX(maxh, i);
369 value += lrint(max_value * (log2(s->histogram[idx] + 1) / max_hval_log));
371 value += lrint(max_value * s->histogram[idx] / (float)max_hval);
373 if (s->histogram_size <= 256) {
374 s->out->data[p][(i + starty) * s->out->linesize[p] + startx + s->x_pos] = value;
376 AV_WN16(s->out->data[p] + (i + starty) * s->out->linesize[p] + startx * 2 + s->x_pos * 2, value);
381 if (s->histogram_size <= 256) {
382 s->out->data[0][(minh + starty) * s->out->linesize[p] + startx + s->x_pos] = s->envelope_color[0];
383 s->out->data[0][(maxh + starty) * s->out->linesize[p] + startx + s->x_pos] = s->envelope_color[0];
384 if (s->dncomp >= 3) {
385 s->out->data[1][(minh + starty) * s->out->linesize[p] + startx + s->x_pos] = s->envelope_color[1];
386 s->out->data[2][(minh + starty) * s->out->linesize[p] + startx + s->x_pos] = s->envelope_color[2];
387 s->out->data[1][(maxh + starty) * s->out->linesize[p] + startx + s->x_pos] = s->envelope_color[1];
388 s->out->data[2][(maxh + starty) * s->out->linesize[p] + startx + s->x_pos] = s->envelope_color[2];
391 const int mult = s->mult;
393 AV_WN16(s->out->data[0] + (minh + starty) * s->out->linesize[p] + startx * 2 + s->x_pos * 2, s->envelope_color[0] * mult);
394 AV_WN16(s->out->data[0] + (maxh + starty) * s->out->linesize[p] + startx * 2 + s->x_pos * 2, s->envelope_color[0] * mult);
395 if (s->dncomp >= 3) {
396 AV_WN16(s->out->data[1] + (minh + starty) * s->out->linesize[p] + startx * 2 + s->x_pos * 2, s->envelope_color[1] * mult);
397 AV_WN16(s->out->data[2] + (minh + starty) * s->out->linesize[p] + startx * 2 + s->x_pos * 2, s->envelope_color[2] * mult);
398 AV_WN16(s->out->data[1] + (maxh + starty) * s->out->linesize[p] + startx * 2 + s->x_pos * 2, s->envelope_color[1] * mult);
399 AV_WN16(s->out->data[2] + (maxh + starty) * s->out->linesize[p] + startx * 2 + s->x_pos * 2, s->envelope_color[2] * mult);
404 for (i = 0; i < s->histogram_size; i++) {
408 col_height = lrint(s->level_height * (1. - (log2(s->histogram[i] + 1) / max_hval_log)));
410 col_height = s->level_height - (s->histogram[i] * (int64_t)s->level_height + max_hval - 1) / max_hval;
412 if (s->histogram_size <= 256) {
413 for (j = s->level_height - 1; j >= col_height; j--) {
414 if (s->display_mode) {
415 for (l = 0; l < s->dncomp; l++)
416 out->data[l][(j + starty) * out->linesize[l] + startx + i] = s->fg_color[l];
418 out->data[p][(j + starty) * out->linesize[p] + startx + i] = 255;
421 for (j = s->level_height + s->scale_height - 1; j >= s->level_height; j--)
422 out->data[p][(j + starty) * out->linesize[p] + startx + i] = i;
424 const int mult = s->mult;
426 for (j = s->level_height - 1; j >= col_height; j--) {
427 if (s->display_mode) {
428 for (l = 0; l < s->dncomp; l++)
429 AV_WN16(out->data[l] + (j + starty) * out->linesize[l] + startx * 2 + i * 2, s->fg_color[l] * mult);
431 AV_WN16(out->data[p] + (j + starty) * out->linesize[p] + startx * 2 + i * 2, 255 * mult);
434 for (j = s->level_height + s->scale_height - 1; j >= s->level_height; j--)
435 AV_WN16(out->data[p] + (j + starty) * out->linesize[p] + startx * 2 + i * 2, i);
440 memset(s->histogram, 0, s->histogram_size * sizeof(unsigned));
446 if (s->x_pos >= s->width)
450 AVFrame *clone = av_frame_clone(out);
453 return AVERROR(ENOMEM);
454 return ff_filter_frame(outlink, clone);
456 return ff_filter_frame(outlink, out);
459 static const AVFilterPad inputs[] = {
462 .type = AVMEDIA_TYPE_VIDEO,
463 .filter_frame = filter_frame,
464 .config_props = config_input,
469 static const AVFilterPad outputs[] = {
472 .type = AVMEDIA_TYPE_VIDEO,
473 .config_props = config_output,
478 #if CONFIG_HISTOGRAM_FILTER
480 AVFilter ff_vf_histogram = {
482 .description = NULL_IF_CONFIG_SMALL("Compute and draw a histogram."),
483 .priv_size = sizeof(HistogramContext),
484 .query_formats = query_formats,
487 .priv_class = &histogram_class,
490 #endif /* CONFIG_HISTOGRAM_FILTER */
492 #if CONFIG_THISTOGRAM_FILTER
494 static const AVOption thistogram_options[] = {
495 { "width", "set width", OFFSET(width), AV_OPT_TYPE_INT, {.i64=0}, 0, 8192, FLAGS},
496 { "w", "set width", OFFSET(width), AV_OPT_TYPE_INT, {.i64=0}, 0, 8192, FLAGS},
498 { "bgopacity", "set background opacity", OFFSET(bgopacity), AV_OPT_TYPE_FLOAT, {.dbl=0.9}, 0, 1, FLAGS},
499 { "b", "set background opacity", OFFSET(bgopacity), AV_OPT_TYPE_FLOAT, {.dbl=0.9}, 0, 1, FLAGS},
500 { "envelope", "display envelope", OFFSET(envelope), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS },
501 { "e", "display envelope", OFFSET(envelope), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS },
502 { "ecolor", "set envelope color", OFFSET(envelope_rgba), AV_OPT_TYPE_COLOR, {.str="gold"}, 0, 0, FLAGS },
503 { "ec", "set envelope color", OFFSET(envelope_rgba), AV_OPT_TYPE_COLOR, {.str="gold"}, 0, 0, FLAGS },
507 AVFILTER_DEFINE_CLASS(thistogram);
509 AVFilter ff_vf_thistogram = {
510 .name = "thistogram",
511 .description = NULL_IF_CONFIG_SMALL("Compute and draw a temporal histogram."),
512 .priv_size = sizeof(HistogramContext),
513 .query_formats = query_formats,
516 .priv_class = &thistogram_class,
519 #endif /* CONFIG_THISTOGRAM_FILTER */