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"
25 #include "libavutil/imgutils.h"
26 #include "libavutil/intreadwrite.h"
32 typedef struct HistogramContext {
33 const AVClass *class; ///< AVClass context for log and options purpose
34 unsigned histogram[256*256];
45 const AVPixFmtDescriptor *desc, *odesc;
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 { "level_height", "set level height", OFFSET(level_height), AV_OPT_TYPE_INT, {.i64=200}, 50, 2048, FLAGS},
58 { "scale_height", "set scale height", OFFSET(scale_height), AV_OPT_TYPE_INT, {.i64=12}, 0, 40, FLAGS},
59 { "display_mode", "set display mode", OFFSET(display_mode), AV_OPT_TYPE_INT, {.i64=2}, 0, 2, FLAGS, "display_mode"},
60 { "d", "set display mode", OFFSET(display_mode), AV_OPT_TYPE_INT, {.i64=2}, 0, 2, FLAGS, "display_mode"},
61 { "overlay", NULL, 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, FLAGS, "display_mode" },
62 { "parade", NULL, 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, FLAGS, "display_mode" },
63 { "stack", NULL, 0, AV_OPT_TYPE_CONST, {.i64=2}, 0, 0, FLAGS, "display_mode" },
64 { "levels_mode", "set levels mode", OFFSET(levels_mode), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS, "levels_mode"},
65 { "m", "set levels mode", OFFSET(levels_mode), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS, "levels_mode"},
66 { "linear", NULL, 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, FLAGS, "levels_mode" },
67 { "logarithmic", NULL, 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, FLAGS, "levels_mode" },
68 { "components", "set color components to display", OFFSET(components), AV_OPT_TYPE_INT, {.i64=7}, 1, 15, FLAGS},
69 { "c", "set color components to display", OFFSET(components), AV_OPT_TYPE_INT, {.i64=7}, 1, 15, FLAGS},
70 { "fgopacity", "set foreground opacity", OFFSET(fgopacity), AV_OPT_TYPE_FLOAT, {.dbl=0.7}, 0, 1, FLAGS},
71 { "f", "set foreground opacity", OFFSET(fgopacity), AV_OPT_TYPE_FLOAT, {.dbl=0.7}, 0, 1, FLAGS},
72 { "bgopacity", "set background opacity", OFFSET(bgopacity), AV_OPT_TYPE_FLOAT, {.dbl=0.5}, 0, 1, FLAGS},
73 { "b", "set background opacity", OFFSET(bgopacity), AV_OPT_TYPE_FLOAT, {.dbl=0.5}, 0, 1, FLAGS},
77 AVFILTER_DEFINE_CLASS(histogram);
79 static const enum AVPixelFormat levels_in_pix_fmts[] = {
80 AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUVJ420P,
81 AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVJ422P,
82 AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUVJ411P,
83 AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV410P,
84 AV_PIX_FMT_YUVA444P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUVJ444P,
85 AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9,
86 AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA444P9,
87 AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10,
88 AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA444P10,
89 AV_PIX_FMT_YUV420P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV444P12, AV_PIX_FMT_YUV440P12,
90 AV_PIX_FMT_GBRAP, AV_PIX_FMT_GBRP,
91 AV_PIX_FMT_GBRP9, AV_PIX_FMT_GBRP10, AV_PIX_FMT_GBRAP10,
92 AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRAP12,
97 static const enum AVPixelFormat levels_out_yuv8_pix_fmts[] = {
98 AV_PIX_FMT_YUVA444P, AV_PIX_FMT_YUV444P,
102 static const enum AVPixelFormat levels_out_yuv9_pix_fmts[] = {
103 AV_PIX_FMT_YUVA444P9, AV_PIX_FMT_YUV444P9,
107 static const enum AVPixelFormat levels_out_yuv10_pix_fmts[] = {
108 AV_PIX_FMT_YUVA444P10, AV_PIX_FMT_YUV444P10,
112 static const enum AVPixelFormat levels_out_yuv12_pix_fmts[] = {
113 AV_PIX_FMT_YUV444P12,
117 static const enum AVPixelFormat levels_out_rgb8_pix_fmts[] = {
118 AV_PIX_FMT_GBRAP, AV_PIX_FMT_GBRP,
122 static const enum AVPixelFormat levels_out_rgb9_pix_fmts[] = {
127 static const enum AVPixelFormat levels_out_rgb10_pix_fmts[] = {
128 AV_PIX_FMT_GBRP10, AV_PIX_FMT_GBRAP10,
132 static const enum AVPixelFormat levels_out_rgb12_pix_fmts[] = {
133 AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRAP12,
137 static int query_formats(AVFilterContext *ctx)
139 AVFilterFormats *avff;
140 const AVPixFmtDescriptor *desc;
141 const enum AVPixelFormat *out_pix_fmts;
145 if (!ctx->inputs[0]->in_formats ||
146 !ctx->inputs[0]->in_formats->nb_formats) {
147 return AVERROR(EAGAIN);
150 if (!ctx->inputs[0]->out_formats)
151 if ((ret = ff_formats_ref(ff_make_format_list(levels_in_pix_fmts), &ctx->inputs[0]->out_formats)) < 0)
153 avff = ctx->inputs[0]->in_formats;
154 desc = av_pix_fmt_desc_get(avff->formats[0]);
155 rgb = desc->flags & AV_PIX_FMT_FLAG_RGB;
156 bits = desc->comp[0].depth;
157 for (i = 1; i < avff->nb_formats; i++) {
158 desc = av_pix_fmt_desc_get(avff->formats[i]);
159 if ((rgb != (desc->flags & AV_PIX_FMT_FLAG_RGB)) ||
160 (bits != desc->comp[0].depth))
161 return AVERROR(EAGAIN);
164 if (rgb && bits == 8)
165 out_pix_fmts = levels_out_rgb8_pix_fmts;
166 else if (rgb && bits == 9)
167 out_pix_fmts = levels_out_rgb9_pix_fmts;
168 else if (rgb && bits == 10)
169 out_pix_fmts = levels_out_rgb10_pix_fmts;
170 else if (rgb && bits == 12)
171 out_pix_fmts = levels_out_rgb12_pix_fmts;
173 out_pix_fmts = levels_out_yuv8_pix_fmts;
175 out_pix_fmts = levels_out_yuv9_pix_fmts;
177 out_pix_fmts = levels_out_yuv10_pix_fmts;
179 out_pix_fmts = levels_out_yuv12_pix_fmts;
181 return AVERROR(EAGAIN);
182 if ((ret = ff_formats_ref(ff_make_format_list(out_pix_fmts), &ctx->outputs[0]->in_formats)) < 0)
188 static const uint8_t black_yuva_color[4] = { 0, 127, 127, 255 };
189 static const uint8_t black_gbrp_color[4] = { 0, 0, 0, 255 };
190 static const uint8_t white_yuva_color[4] = { 255, 127, 127, 255 };
191 static const uint8_t white_gbrp_color[4] = { 255, 255, 255, 255 };
193 static int config_input(AVFilterLink *inlink)
195 HistogramContext *h = inlink->dst->priv;
197 h->desc = av_pix_fmt_desc_get(inlink->format);
198 h->ncomp = h->desc->nb_components;
199 h->histogram_size = 1 << h->desc->comp[0].depth;
200 h->mult = h->histogram_size / 256;
202 switch (inlink->format) {
203 case AV_PIX_FMT_GBRAP12:
204 case AV_PIX_FMT_GBRP12:
205 case AV_PIX_FMT_GBRAP10:
206 case AV_PIX_FMT_GBRP10:
207 case AV_PIX_FMT_GBRP9:
208 case AV_PIX_FMT_GBRAP:
209 case AV_PIX_FMT_GBRP:
210 memcpy(h->bg_color, black_gbrp_color, 4);
211 memcpy(h->fg_color, white_gbrp_color, 4);
214 memcpy(h->bg_color, black_yuva_color, 4);
215 memcpy(h->fg_color, white_yuva_color, 4);
218 h->fg_color[3] = h->fgopacity * 255;
219 h->bg_color[3] = h->bgopacity * 255;
221 h->planeheight[1] = h->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, h->desc->log2_chroma_h);
222 h->planeheight[0] = h->planeheight[3] = inlink->h;
223 h->planewidth[1] = h->planewidth[2] = AV_CEIL_RSHIFT(inlink->w, h->desc->log2_chroma_w);
224 h->planewidth[0] = h->planewidth[3] = inlink->w;
229 static int config_output(AVFilterLink *outlink)
231 AVFilterContext *ctx = outlink->src;
232 HistogramContext *h = ctx->priv;
235 for (i = 0; i < h->ncomp; i++) {
236 if ((1 << i) & h->components)
239 outlink->w = h->histogram_size * FFMAX(ncomp * (h->display_mode == 1), 1);
240 outlink->h = (h->level_height + h->scale_height) * FFMAX(ncomp * (h->display_mode == 2), 1);
242 h->odesc = av_pix_fmt_desc_get(outlink->format);
243 h->dncomp = h->odesc->nb_components;
244 outlink->sample_aspect_ratio = (AVRational){1,1};
249 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
251 HistogramContext *h = inlink->dst->priv;
252 AVFilterContext *ctx = inlink->dst;
253 AVFilterLink *outlink = ctx->outputs[0];
257 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
260 return AVERROR(ENOMEM);
265 for (k = 0; k < 4 && out->data[k]; k++) {
266 const int is_chroma = (k == 1 || k == 2);
267 const int dst_h = AV_CEIL_RSHIFT(outlink->h, (is_chroma ? h->odesc->log2_chroma_h : 0));
268 const int dst_w = AV_CEIL_RSHIFT(outlink->w, (is_chroma ? h->odesc->log2_chroma_w : 0));
270 if (h->histogram_size <= 256) {
271 for (i = 0; i < dst_h ; i++)
272 memset(out->data[h->odesc->comp[k].plane] +
273 i * out->linesize[h->odesc->comp[k].plane],
274 h->bg_color[k], dst_w);
276 const int mult = h->mult;
278 for (i = 0; i < dst_h ; i++)
279 for (j = 0; j < dst_w; j++)
280 AV_WN16(out->data[h->odesc->comp[k].plane] +
281 i * out->linesize[h->odesc->comp[k].plane] + j * 2,
282 h->bg_color[k] * mult);
286 for (m = 0, k = 0; k < h->ncomp; k++) {
287 const int p = h->desc->comp[k].plane;
288 const int height = h->planeheight[p];
289 const int width = h->planewidth[p];
291 unsigned max_hval = 0;
294 if (!((1 << k) & h->components))
296 startx = m * h->histogram_size * (h->display_mode == 1);
297 start = m++ * (h->level_height + h->scale_height) * (h->display_mode == 2);
299 if (h->histogram_size <= 256) {
300 for (i = 0; i < height; i++) {
301 const uint8_t *src = in->data[p] + i * in->linesize[p];
302 for (j = 0; j < width; j++)
303 h->histogram[src[j]]++;
306 for (i = 0; i < height; i++) {
307 const uint16_t *src = (const uint16_t *)(in->data[p] + i * in->linesize[p]);
308 for (j = 0; j < width; j++)
309 h->histogram[src[j]]++;
313 for (i = 0; i < h->histogram_size; i++)
314 max_hval = FFMAX(max_hval, h->histogram[i]);
315 max_hval_log = log2(max_hval + 1);
317 for (i = 0; i < h->histogram_size; i++) {
321 col_height = lrint(h->level_height * (1. - (log2(h->histogram[i] + 1) / max_hval_log)));
323 col_height = h->level_height - (h->histogram[i] * (int64_t)h->level_height + max_hval - 1) / max_hval;
325 if (h->histogram_size <= 256) {
326 for (j = h->level_height - 1; j >= col_height; j--) {
327 if (h->display_mode) {
328 for (l = 0; l < h->dncomp; l++)
329 out->data[l][(j + start) * out->linesize[l] + startx + i] = h->fg_color[l];
331 out->data[p][(j + start) * out->linesize[p] + startx + i] = 255;
334 for (j = h->level_height + h->scale_height - 1; j >= h->level_height; j--)
335 out->data[p][(j + start) * out->linesize[p] + startx + i] = i;
337 const int mult = h->mult;
339 for (j = h->level_height - 1; j >= col_height; j--) {
340 if (h->display_mode) {
341 for (l = 0; l < h->dncomp; l++)
342 AV_WN16(out->data[l] + (j + start) * out->linesize[l] + startx * 2 + i * 2, h->fg_color[l] * mult);
344 AV_WN16(out->data[p] + (j + start) * out->linesize[p] + startx * 2 + i * 2, 255 * mult);
347 for (j = h->level_height + h->scale_height - 1; j >= h->level_height; j--)
348 AV_WN16(out->data[p] + (j + start) * out->linesize[p] + startx * 2 + i * 2, i);
352 memset(h->histogram, 0, h->histogram_size * sizeof(unsigned));
356 return ff_filter_frame(outlink, out);
359 static const AVFilterPad inputs[] = {
362 .type = AVMEDIA_TYPE_VIDEO,
363 .filter_frame = filter_frame,
364 .config_props = config_input,
369 static const AVFilterPad outputs[] = {
372 .type = AVMEDIA_TYPE_VIDEO,
373 .config_props = config_output,
378 AVFilter ff_vf_histogram = {
380 .description = NULL_IF_CONFIG_SMALL("Compute and draw a histogram."),
381 .priv_size = sizeof(HistogramContext),
382 .query_formats = query_formats,
385 .priv_class = &histogram_class,