avfilter/vf_histogram: fix segfault in parade waveform mode for subsampled formats
[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     int            ncomp;
43     const uint8_t  *bg_color;
44     const uint8_t  *fg_color;
45     int            level_height;
46     int            scale_height;
47     int            step;
48     int            waveform_mode;
49     int            display_mode;
50     int            levels_mode;
51     const AVPixFmtDescriptor *desc;
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 const enum AVPixelFormat waveform_pix_fmts[] = {
91      AV_PIX_FMT_GBRP,     AV_PIX_FMT_GBRAP,
92      AV_PIX_FMT_YUV422P,  AV_PIX_FMT_YUV420P,
93      AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV440P,
94      AV_PIX_FMT_YUV411P,  AV_PIX_FMT_YUV410P,
95      AV_PIX_FMT_YUVJ440P, AV_PIX_FMT_YUVJ411P, AV_PIX_FMT_YUVJ420P,
96      AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ444P,
97      AV_PIX_FMT_YUVA444P, AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUVA420P,
98      AV_PIX_FMT_GRAY8,
99      AV_PIX_FMT_NONE
100 };
101
102 static int query_formats(AVFilterContext *ctx)
103 {
104     HistogramContext *h = ctx->priv;
105     const enum AVPixelFormat *pix_fmts;
106
107     switch (h->mode) {
108     case MODE_WAVEFORM:
109         pix_fmts = waveform_pix_fmts;
110         break;
111     case MODE_LEVELS:
112         pix_fmts = levels_pix_fmts;
113         break;
114     case MODE_COLOR:
115     case MODE_COLOR2:
116         pix_fmts = color_pix_fmts;
117         break;
118     default:
119         av_assert0(0);
120     }
121
122     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
123
124     return 0;
125 }
126
127 static const uint8_t black_yuva_color[4] = { 0, 127, 127, 255 };
128 static const uint8_t black_gbrp_color[4] = { 0, 0, 0, 255 };
129 static const uint8_t white_yuva_color[4] = { 255, 127, 127, 255 };
130 static const uint8_t white_gbrp_color[4] = { 255, 255, 255, 255 };
131
132 static int config_input(AVFilterLink *inlink)
133 {
134     HistogramContext *h = inlink->dst->priv;
135
136     h->desc  = av_pix_fmt_desc_get(inlink->format);
137     h->ncomp = h->desc->nb_components;
138
139     switch (inlink->format) {
140     case AV_PIX_FMT_GBRAP:
141     case AV_PIX_FMT_GBRP:
142         h->bg_color = black_gbrp_color;
143         h->fg_color = white_gbrp_color;
144         break;
145     default:
146         h->bg_color = black_yuva_color;
147         h->fg_color = white_yuva_color;
148     }
149
150     return 0;
151 }
152
153 static int config_output(AVFilterLink *outlink)
154 {
155     AVFilterContext *ctx = outlink->src;
156     HistogramContext *h = ctx->priv;
157
158     switch (h->mode) {
159     case MODE_LEVELS:
160         outlink->w = 256;
161         outlink->h = (h->level_height + h->scale_height) * FFMAX(h->ncomp * h->display_mode, 1);
162         break;
163     case MODE_WAVEFORM:
164         if (h->waveform_mode)
165             outlink->h = 256 * FFMAX(h->ncomp * h->display_mode, 1);
166         else
167             outlink->w = 256 * FFMAX(h->ncomp * h->display_mode, 1);
168         break;
169     case MODE_COLOR:
170     case MODE_COLOR2:
171         outlink->h = outlink->w = 256;
172         break;
173     default:
174         av_assert0(0);
175     }
176
177     outlink->sample_aspect_ratio = (AVRational){1,1};
178
179     return 0;
180 }
181
182 static void gen_waveform(HistogramContext *h, AVFrame *inpicref, AVFrame *outpicref,
183                          int component, int intensity, int offset, int col_mode)
184 {
185     const int plane = h->desc->comp[component].plane;
186     const int is_chroma = (component == 1 || component == 2);
187     const int shift_w = (is_chroma ? h->desc->log2_chroma_w : 0);
188     const int shift_h = (is_chroma ? h->desc->log2_chroma_h : 0);
189     const int src_linesize = inpicref->linesize[plane];
190     const int dst_linesize = outpicref->linesize[plane];
191     uint8_t *src_data = inpicref->data[plane];
192     uint8_t *dst_data = outpicref->data[plane] + (col_mode ? (offset >> shift_h) * dst_linesize : offset >> shift_w);
193     uint8_t * const dst_line = dst_data;
194     const uint8_t max = 255 - intensity;
195     const int src_h = FF_CEIL_RSHIFT(inpicref->height, shift_h);
196     const int src_w = FF_CEIL_RSHIFT(inpicref->width, shift_w);
197     uint8_t *dst, *p;
198     int y;
199
200     for (y = 0; y < src_h; y++) {
201         const uint8_t *src_data_end = src_data + src_w;
202         dst = dst_line;
203         for (p = src_data; p < src_data_end; p++) {
204             uint8_t *target;
205             if (col_mode)
206                 target = dst++ + dst_linesize * (*p >> shift_h);
207             else
208                 target = dst_data + (*p >> shift_w);
209             if (*target <= max)
210                 *target += intensity;
211             else
212                 *target = 255;
213         }
214         src_data += src_linesize;
215         dst_data += dst_linesize;
216     }
217 }
218
219
220 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
221 {
222     HistogramContext *h   = inlink->dst->priv;
223     AVFilterContext *ctx  = inlink->dst;
224     AVFilterLink *outlink = ctx->outputs[0];
225     AVFrame *out;
226     const uint8_t *src;
227     uint8_t *dst;
228     int i, j, k, l;
229
230     out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
231     if (!out) {
232         av_frame_free(&in);
233         return AVERROR(ENOMEM);
234     }
235
236     out->pts = in->pts;
237
238     for (k = 0; k < h->ncomp; k++) {
239         int is_chroma = (k == 1 || k == 2);
240         int dst_h = FF_CEIL_RSHIFT(outlink->h, (is_chroma ? h->desc->log2_chroma_h : 0));
241         int dst_w = FF_CEIL_RSHIFT(outlink->w, (is_chroma ? h->desc->log2_chroma_w : 0));
242         for (i = 0; i < dst_h ; i++)
243             memset(out->data[h->desc->comp[k].plane] +
244                    i * out->linesize[h->desc->comp[k].plane],
245                    h->bg_color[k], dst_w);
246     }
247
248     switch (h->mode) {
249     case MODE_LEVELS:
250         for (k = 0; k < h->ncomp; k++) {
251             const int p = h->desc->comp[k].plane;
252             int start = k * (h->level_height + h->scale_height) * h->display_mode;
253             double max_hval_log;
254             unsigned max_hval = 0;
255
256             for (i = 0; i < in->height; i++) {
257                 src = in->data[p] + i * in->linesize[p];
258                 for (j = 0; j < in->width; j++)
259                     h->histogram[src[j]]++;
260             }
261
262             for (i = 0; i < 256; i++)
263                 max_hval = FFMAX(max_hval, h->histogram[i]);
264             max_hval_log = log2(max_hval + 1);
265
266             for (i = 0; i < outlink->w; i++) {
267                 int col_height;
268
269                 if (h->levels_mode)
270                     col_height = round(h->level_height * (1. - (log2(h->histogram[i] + 1) / max_hval_log)));
271                 else
272                     col_height = h->level_height - (h->histogram[i] * (int64_t)h->level_height + max_hval - 1) / max_hval;
273
274                 for (j = h->level_height - 1; j >= col_height; j--) {
275                     if (h->display_mode) {
276                         for (l = 0; l < h->ncomp; l++)
277                             out->data[l][(j + start) * out->linesize[l] + i] = h->fg_color[l];
278                     } else {
279                         out->data[p][(j + start) * out->linesize[p] + i] = 255;
280                     }
281                 }
282                 for (j = h->level_height + h->scale_height - 1; j >= h->level_height; j--)
283                     out->data[p][(j + start) * out->linesize[p] + i] = i;
284             }
285
286             memset(h->histogram, 0, 256 * sizeof(unsigned));
287         }
288         break;
289     case MODE_WAVEFORM:
290         for (k = 0; k < h->ncomp; k++) {
291             int offset = k * 256 * h->display_mode;
292             gen_waveform(h, in, out, k, h->step, offset, h->waveform_mode);
293         }
294         break;
295     case MODE_COLOR:
296         for (i = 0; i < inlink->h; i++) {
297             int iw1 = i * in->linesize[1];
298             int iw2 = i * in->linesize[2];
299             for (j = 0; j < inlink->w; j++) {
300                 int pos = in->data[1][iw1 + j] * out->linesize[0] + in->data[2][iw2 + j];
301                 if (out->data[0][pos] < 255)
302                     out->data[0][pos]++;
303             }
304         }
305         for (i = 0; i < 256; i++) {
306             dst = out->data[0] + i * out->linesize[0];
307             for (j = 0; j < 256; j++) {
308                 if (!dst[j]) {
309                     out->data[1][i * out->linesize[0] + j] = i;
310                     out->data[2][i * out->linesize[0] + j] = j;
311                 }
312             }
313         }
314         break;
315     case MODE_COLOR2:
316         for (i = 0; i < inlink->h; i++) {
317             int iw1 = i * in->linesize[1];
318             int iw2 = i * in->linesize[2];
319             for (j = 0; j < inlink->w; j++) {
320                 int u = in->data[1][iw1 + j];
321                 int v = in->data[2][iw2 + j];
322                 int pos = u * out->linesize[0] + v;
323                 if (!out->data[0][pos])
324                     out->data[0][pos] = FFABS(128 - u) + FFABS(128 - v);
325                 out->data[1][pos] = u;
326                 out->data[2][pos] = v;
327             }
328         }
329         break;
330     default:
331         av_assert0(0);
332     }
333
334     av_frame_free(&in);
335     return ff_filter_frame(outlink, out);
336 }
337
338 static const AVFilterPad inputs[] = {
339     {
340         .name         = "default",
341         .type         = AVMEDIA_TYPE_VIDEO,
342         .filter_frame = filter_frame,
343         .config_props = config_input,
344     },
345     { NULL }
346 };
347
348 static const AVFilterPad outputs[] = {
349     {
350         .name         = "default",
351         .type         = AVMEDIA_TYPE_VIDEO,
352         .config_props = config_output,
353     },
354     { NULL }
355 };
356
357 AVFilter avfilter_vf_histogram = {
358     .name          = "histogram",
359     .description   = NULL_IF_CONFIG_SMALL("Compute and draw a histogram."),
360     .priv_size     = sizeof(HistogramContext),
361     .query_formats = query_formats,
362     .inputs        = inputs,
363     .outputs       = outputs,
364     .priv_class    = &histogram_class,
365 };