lavfi/histogram: logarithmic mode for levels
[ffmpeg.git] / libavfilter / vf_histogram.c
1 /*
2  * Copyright (c) 2012-2013 Paul B Mahol
3  *
4  * This file is part of FFmpeg.
5  *
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.
10  *
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.
15  *
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
19  */
20
21 #include "libavutil/avassert.h"
22 #include "libavutil/opt.h"
23 #include "libavutil/parseutils.h"
24 #include "libavutil/pixdesc.h"
25 #include "avfilter.h"
26 #include "formats.h"
27 #include "internal.h"
28 #include "video.h"
29
30 enum HistogramMode {
31     MODE_LEVELS,
32     MODE_WAVEFORM,
33     MODE_COLOR,
34     MODE_COLOR2,
35     MODE_NB
36 };
37
38 typedef struct HistogramContext {
39     const AVClass *class;               ///< AVClass context for log and options purpose
40     enum HistogramMode mode;
41     unsigned       histogram[256];
42     unsigned       max_hval;
43     int            ncomp;
44     const uint8_t  *bg_color;
45     const uint8_t  *fg_color;
46     int            level_height;
47     int            scale_height;
48     int            step;
49     int            waveform_mode;
50     int            display_mode;
51     int            levels_mode;
52 } HistogramContext;
53
54 #define OFFSET(x) offsetof(HistogramContext, x)
55 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
56
57 static const AVOption histogram_options[] = {
58     { "mode", "set histogram mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64=MODE_LEVELS}, 0, MODE_NB-1, FLAGS, "mode"},
59     { "levels", "standard histogram", 0, AV_OPT_TYPE_CONST, {.i64=MODE_LEVELS}, 0, 0, FLAGS, "mode" },
60     { "waveform", "per row/column luminance graph", 0, AV_OPT_TYPE_CONST, {.i64=MODE_WAVEFORM}, 0, 0, FLAGS, "mode" },
61     { "color", "chroma values in vectorscope", 0, AV_OPT_TYPE_CONST, {.i64=MODE_COLOR}, 0, 0, FLAGS, "mode" },
62     { "color2", "chroma values in vectorscope", 0, AV_OPT_TYPE_CONST, {.i64=MODE_COLOR2}, 0, 0, FLAGS, "mode" },
63     { "level_height", "set level height", OFFSET(level_height), AV_OPT_TYPE_INT, {.i64=200}, 50, 2048, FLAGS},
64     { "scale_height", "set scale height", OFFSET(scale_height), AV_OPT_TYPE_INT, {.i64=12}, 0, 40, FLAGS},
65     { "step", "set waveform step value", OFFSET(step), AV_OPT_TYPE_INT, {.i64=10}, 1, 255, FLAGS},
66     { "waveform_mode", "set waveform mode", OFFSET(waveform_mode), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS, "waveform_mode"},
67     { "row",   NULL, 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, FLAGS, "waveform_mode" },
68     { "column", NULL, 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, FLAGS, "waveform_mode" },
69     { "display_mode", "set display mode", OFFSET(display_mode), AV_OPT_TYPE_INT, {.i64=1}, 0, 1, FLAGS, "display_mode"},
70     { "parade",  NULL, 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, FLAGS, "display_mode" },
71     { "overlay", NULL, 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, FLAGS, "display_mode" },
72     { "levels_mode", "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     { NULL },
76 };
77
78 AVFILTER_DEFINE_CLASS(histogram);
79
80 static const enum AVPixelFormat color_pix_fmts[] = {
81     AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUVA444P, AV_PIX_FMT_YUVJ444P,
82     AV_PIX_FMT_NONE
83 };
84
85 static const enum AVPixelFormat levels_pix_fmts[] = {
86     AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUVA444P, AV_PIX_FMT_YUVJ444P,
87     AV_PIX_FMT_GRAY8, AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRAP, AV_PIX_FMT_NONE
88 };
89
90 static int query_formats(AVFilterContext *ctx)
91 {
92     HistogramContext *h = ctx->priv;
93     const enum AVPixelFormat *pix_fmts;
94
95     switch (h->mode) {
96     case MODE_WAVEFORM:
97     case MODE_LEVELS:
98         pix_fmts = levels_pix_fmts;
99         break;
100     case MODE_COLOR:
101     case MODE_COLOR2:
102         pix_fmts = color_pix_fmts;
103         break;
104     default:
105         av_assert0(0);
106     }
107
108     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
109
110     return 0;
111 }
112
113 static const uint8_t black_yuva_color[4] = { 0, 127, 127, 255 };
114 static const uint8_t black_gbrp_color[4] = { 0, 0, 0, 255 };
115 static const uint8_t white_yuva_color[4] = { 255, 127, 127, 255 };
116 static const uint8_t white_gbrp_color[4] = { 255, 255, 255, 255 };
117
118 static int config_input(AVFilterLink *inlink)
119 {
120     HistogramContext *h = inlink->dst->priv;
121     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
122
123     h->ncomp = desc->nb_components;
124
125     switch (inlink->format) {
126     case AV_PIX_FMT_GBRAP:
127     case AV_PIX_FMT_GBRP:
128         h->bg_color = black_gbrp_color;
129         h->fg_color = white_gbrp_color;
130         break;
131     default:
132         h->bg_color = black_yuva_color;
133         h->fg_color = white_yuva_color;
134     }
135
136     return 0;
137 }
138
139 static int config_output(AVFilterLink *outlink)
140 {
141     AVFilterContext *ctx = outlink->src;
142     HistogramContext *h = ctx->priv;
143
144     switch (h->mode) {
145     case MODE_LEVELS:
146         outlink->w = 256;
147         outlink->h = (h->level_height + h->scale_height) * FFMAX(h->ncomp * h->display_mode, 1);
148         break;
149     case MODE_WAVEFORM:
150         if (h->waveform_mode)
151             outlink->h = 256 * FFMAX(h->ncomp * h->display_mode, 1);
152         else
153             outlink->w = 256 * FFMAX(h->ncomp * h->display_mode, 1);
154         break;
155     case MODE_COLOR:
156     case MODE_COLOR2:
157         outlink->h = outlink->w = 256;
158         break;
159     default:
160         av_assert0(0);
161     }
162
163     outlink->sample_aspect_ratio = (AVRational){1,1};
164
165     return 0;
166 }
167
168 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
169 {
170     HistogramContext *h   = inlink->dst->priv;
171     AVFilterContext *ctx  = inlink->dst;
172     AVFilterLink *outlink = ctx->outputs[0];
173     AVFrame *out;
174     const uint8_t *src;
175     uint8_t *dst;
176     int i, j, k, l;
177
178     out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
179     if (!out) {
180         av_frame_free(&in);
181         return AVERROR(ENOMEM);
182     }
183
184     out->pts = in->pts;
185
186     for (k = 0; k < h->ncomp; k++)
187         for (i = 0; i < outlink->h; i++)
188             memset(out->data[k] + i * out->linesize[k], h->bg_color[k], outlink->w);
189
190     switch (h->mode) {
191     case MODE_LEVELS:
192         for (k = 0; k < h->ncomp; k++) {
193             int start = k * (h->level_height + h->scale_height) * h->display_mode;
194
195             for (i = 0; i < in->height; i++) {
196                 src = in->data[k] + i * in->linesize[k];
197                 for (j = 0; j < in->width; j++)
198                     h->histogram[src[j]]++;
199             }
200
201             for (i = 0; i < 256; i++)
202                 h->max_hval = FFMAX(h->max_hval, h->histogram[i]);
203
204             for (i = 0; i < outlink->w; i++) {
205                 int col_height;
206
207                 if (h->levels_mode)
208                     col_height = round(h->level_height * (1. - (log2(h->histogram[i] + 1) / log2(h->max_hval + 1))));
209                 else
210                     col_height = h->level_height - (h->histogram[i] * (int64_t)h->level_height + h->max_hval - 1) / h->max_hval;
211
212                 for (j = h->level_height - 1; j >= col_height; j--) {
213                     if (h->display_mode) {
214                         for (l = 0; l < h->ncomp; l++)
215                             out->data[l][(j + start) * out->linesize[l] + i] = h->fg_color[l];
216                     } else {
217                         out->data[k][(j + start) * out->linesize[k] + i] = 255;
218                     }
219                 }
220                 for (j = h->level_height + h->scale_height - 1; j >= h->level_height; j--)
221                     out->data[k][(j + start) * out->linesize[k] + i] = i;
222             }
223
224             memset(h->histogram, 0, 256 * sizeof(unsigned));
225             h->max_hval = 0;
226         }
227         break;
228     case MODE_WAVEFORM:
229         if (h->waveform_mode) {
230             for (k = 0; k < h->ncomp; k++) {
231                 int offset = k * 256 * h->display_mode;
232                 for (i = 0; i < inlink->w; i++) {
233                     for (j = 0; j < inlink->h; j++) {
234                         int pos = (offset +
235                                    in->data[k][j * in->linesize[k] + i]) *
236                                   out->linesize[k] + i;
237                         unsigned value = out->data[k][pos];
238                         value = FFMIN(value + h->step, 255);
239                         out->data[k][pos] = value;
240                     }
241                 }
242             }
243         } else {
244             for (k = 0; k < h->ncomp; k++) {
245                 int offset = k * 256 * h->display_mode;
246                 for (i = 0; i < inlink->h; i++) {
247                     src = in ->data[k] + i * in ->linesize[k];
248                     dst = out->data[k] + i * out->linesize[k];
249                     for (j = 0; j < inlink->w; j++) {
250                         int pos = src[j] + offset;
251                         unsigned value = dst[pos];
252                         value = FFMIN(value + h->step, 255);
253                         dst[pos] = value;
254                     }
255                 }
256             }
257         }
258         break;
259     case MODE_COLOR:
260         for (i = 0; i < inlink->h; i++) {
261             int iw1 = i * in->linesize[1];
262             int iw2 = i * in->linesize[2];
263             for (j = 0; j < inlink->w; j++) {
264                 int pos = in->data[1][iw1 + j] * out->linesize[0] + in->data[2][iw2 + j];
265                 if (out->data[0][pos] < 255)
266                     out->data[0][pos]++;
267             }
268         }
269         for (i = 0; i < 256; i++) {
270             dst = out->data[0] + i * out->linesize[0];
271             for (j = 0; j < 256; j++) {
272                 if (!dst[j]) {
273                     out->data[1][i * out->linesize[0] + j] = i;
274                     out->data[2][i * out->linesize[0] + j] = j;
275                 }
276             }
277         }
278         break;
279     case MODE_COLOR2:
280         for (i = 0; i < inlink->h; i++) {
281             int iw1 = i * in->linesize[1];
282             int iw2 = i * in->linesize[2];
283             for (j = 0; j < inlink->w; j++) {
284                 int u = in->data[1][iw1 + j];
285                 int v = in->data[2][iw2 + j];
286                 int pos = u * out->linesize[0] + v;
287                 if (!out->data[0][pos])
288                     out->data[0][pos] = FFABS(128 - u) + FFABS(128 - v);
289                 out->data[1][pos] = u;
290                 out->data[2][pos] = v;
291             }
292         }
293         break;
294     default:
295         av_assert0(0);
296     }
297
298     av_frame_free(&in);
299     return ff_filter_frame(outlink, out);
300 }
301
302 static const AVFilterPad inputs[] = {
303     {
304         .name         = "default",
305         .type         = AVMEDIA_TYPE_VIDEO,
306         .filter_frame = filter_frame,
307         .config_props = config_input,
308     },
309     { NULL }
310 };
311
312 static const AVFilterPad outputs[] = {
313     {
314         .name         = "default",
315         .type         = AVMEDIA_TYPE_VIDEO,
316         .config_props = config_output,
317     },
318     { NULL }
319 };
320
321 AVFilter avfilter_vf_histogram = {
322     .name          = "histogram",
323     .description   = NULL_IF_CONFIG_SMALL("Compute and draw a histogram."),
324     .priv_size     = sizeof(HistogramContext),
325     .query_formats = query_formats,
326     .inputs        = inputs,
327     .outputs       = outputs,
328     .priv_class    = &histogram_class,
329 };