2 * Copyright (c) 2011 Roger Pau Monné <roger.pau@entel.upc.edu>
3 * Copyright (c) 2011 Stefano Sabatini
4 * Copyright (c) 2013 Paul B Mahol
6 * This file is part of FFmpeg.
8 * FFmpeg is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * FFmpeg is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with FFmpeg; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 * Caculate the PSNR between two input videos.
28 #include "libavutil/avstring.h"
29 #include "libavutil/opt.h"
30 #include "libavutil/pixdesc.h"
32 #include "drawutils.h"
34 #include "framesync.h"
39 typedef struct PSNRContext {
42 double mse, min_mse, max_mse, mse_comp[4];
47 int stats_header_written;
49 int max[4], average_max;
57 double planeweight[4];
62 #define OFFSET(x) offsetof(PSNRContext, x)
63 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
65 static const AVOption psnr_options[] = {
66 {"stats_file", "Set file where to store per-frame difference information", OFFSET(stats_file_str), AV_OPT_TYPE_STRING, {.str=NULL}, 0, 0, FLAGS },
67 {"f", "Set file where to store per-frame difference information", OFFSET(stats_file_str), AV_OPT_TYPE_STRING, {.str=NULL}, 0, 0, FLAGS },
68 {"stats_version", "Set the format version for the stats file.", OFFSET(stats_version), AV_OPT_TYPE_INT, {.i64=1}, 1, 2, FLAGS },
69 {"output_max", "Add raw stats (max values) to the output log.", OFFSET(stats_add_max), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, FLAGS},
73 FRAMESYNC_DEFINE_CLASS(psnr, PSNRContext, fs);
75 static inline unsigned pow_2(unsigned base)
80 static inline double get_psnr(double mse, uint64_t nb_frames, int max)
82 return 10.0 * log10(pow_2(max) / (mse / nb_frames));
85 static uint64_t sse_line_8bit(const uint8_t *main_line, const uint8_t *ref_line, int outw)
90 for (j = 0; j < outw; j++)
91 m2 += pow_2(main_line[j] - ref_line[j]);
96 static uint64_t sse_line_16bit(const uint8_t *_main_line, const uint8_t *_ref_line, int outw)
100 const uint16_t *main_line = (const uint16_t *) _main_line;
101 const uint16_t *ref_line = (const uint16_t *) _ref_line;
103 for (j = 0; j < outw; j++)
104 m2 += pow_2(main_line[j] - ref_line[j]);
109 typedef struct ThreadData {
110 const uint8_t *main_data[4];
111 const uint8_t *ref_data[4];
112 int main_linesize[4];
122 int compute_images_mse(AVFilterContext *ctx, void *arg,
123 int jobnr, int nb_jobs)
125 ThreadData *td = arg;
126 uint64_t *score = td->score[jobnr];
128 for (int c = 0; c < td->nb_components; c++) {
129 const int outw = td->planewidth[c];
130 const int outh = td->planeheight[c];
131 const int slice_start = (outh * jobnr) / nb_jobs;
132 const int slice_end = (outh * (jobnr+1)) / nb_jobs;
133 const int ref_linesize = td->ref_linesize[c];
134 const int main_linesize = td->main_linesize[c];
135 const uint8_t *main_line = td->main_data[c] + main_linesize * slice_start;
136 const uint8_t *ref_line = td->ref_data[c] + ref_linesize * slice_start;
138 for (int i = slice_start; i < slice_end; i++) {
139 m += td->dsp->sse_line(main_line, ref_line, outw);
140 ref_line += ref_linesize;
141 main_line += main_linesize;
149 static void set_meta(AVDictionary **metadata, const char *key, char comp, float d)
152 snprintf(value, sizeof(value), "%f", d);
155 snprintf(key2, sizeof(key2), "%s%c", key, comp);
156 av_dict_set(metadata, key2, value, 0);
158 av_dict_set(metadata, key, value, 0);
162 static int do_psnr(FFFrameSync *fs)
164 AVFilterContext *ctx = fs->parent;
165 PSNRContext *s = ctx->priv;
166 AVFrame *master, *ref;
167 double comp_mse[4], mse = 0.;
168 uint64_t comp_sum[4] = { 0 };
169 AVDictionary **metadata;
173 ret = ff_framesync_dualinput_get(fs, &master, &ref);
176 if (ctx->is_disabled || !ref)
177 return ff_filter_frame(ctx->outputs[0], master);
178 metadata = &master->metadata;
180 td.nb_components = s->nb_components;
183 for (int c = 0; c < s->nb_components; c++) {
184 td.main_data[c] = master->data[c];
185 td.ref_data[c] = ref->data[c];
186 td.main_linesize[c] = master->linesize[c];
187 td.ref_linesize[c] = ref->linesize[c];
188 td.planewidth[c] = s->planewidth[c];
189 td.planeheight[c] = s->planeheight[c];
192 ctx->internal->execute(ctx, compute_images_mse, &td, NULL, FFMIN(s->planeheight[1], s->nb_threads));
194 for (int j = 0; j < s->nb_threads; j++) {
195 for (int c = 0; c < s->nb_components; c++)
196 comp_sum[c] += s->score[j][c];
199 for (int c = 0; c < s->nb_components; c++)
200 comp_mse[c] = comp_sum[c] / ((double)s->planewidth[c] * s->planeheight[c]);
202 for (int c = 0; c < s->nb_components; c++)
203 mse += comp_mse[c] * s->planeweight[c];
205 s->min_mse = FFMIN(s->min_mse, mse);
206 s->max_mse = FFMAX(s->max_mse, mse);
210 for (int j = 0; j < s->nb_components; j++)
211 s->mse_comp[j] += comp_mse[j];
214 for (int j = 0; j < s->nb_components; j++) {
215 int c = s->is_rgb ? s->rgba_map[j] : j;
216 set_meta(metadata, "lavfi.psnr.mse.", s->comps[j], comp_mse[c]);
217 set_meta(metadata, "lavfi.psnr.psnr.", s->comps[j], get_psnr(comp_mse[c], 1, s->max[c]));
219 set_meta(metadata, "lavfi.psnr.mse_avg", 0, mse);
220 set_meta(metadata, "lavfi.psnr.psnr_avg", 0, get_psnr(mse, 1, s->average_max));
223 if (s->stats_version == 2 && !s->stats_header_written) {
224 fprintf(s->stats_file, "psnr_log_version:2 fields:n");
225 fprintf(s->stats_file, ",mse_avg");
226 for (int j = 0; j < s->nb_components; j++) {
227 fprintf(s->stats_file, ",mse_%c", s->comps[j]);
229 fprintf(s->stats_file, ",psnr_avg");
230 for (int j = 0; j < s->nb_components; j++) {
231 fprintf(s->stats_file, ",psnr_%c", s->comps[j]);
233 if (s->stats_add_max) {
234 fprintf(s->stats_file, ",max_avg");
235 for (int j = 0; j < s->nb_components; j++) {
236 fprintf(s->stats_file, ",max_%c", s->comps[j]);
239 fprintf(s->stats_file, "\n");
240 s->stats_header_written = 1;
242 fprintf(s->stats_file, "n:%"PRId64" mse_avg:%0.2f ", s->nb_frames, mse);
243 for (int j = 0; j < s->nb_components; j++) {
244 int c = s->is_rgb ? s->rgba_map[j] : j;
245 fprintf(s->stats_file, "mse_%c:%0.2f ", s->comps[j], comp_mse[c]);
247 fprintf(s->stats_file, "psnr_avg:%0.2f ", get_psnr(mse, 1, s->average_max));
248 for (int j = 0; j < s->nb_components; j++) {
249 int c = s->is_rgb ? s->rgba_map[j] : j;
250 fprintf(s->stats_file, "psnr_%c:%0.2f ", s->comps[j],
251 get_psnr(comp_mse[c], 1, s->max[c]));
253 if (s->stats_version == 2 && s->stats_add_max) {
254 fprintf(s->stats_file, "max_avg:%d ", s->average_max);
255 for (int j = 0; j < s->nb_components; j++) {
256 int c = s->is_rgb ? s->rgba_map[j] : j;
257 fprintf(s->stats_file, "max_%c:%d ", s->comps[j], s->max[c]);
260 fprintf(s->stats_file, "\n");
263 return ff_filter_frame(ctx->outputs[0], master);
266 static av_cold int init(AVFilterContext *ctx)
268 PSNRContext *s = ctx->priv;
270 s->min_mse = +INFINITY;
271 s->max_mse = -INFINITY;
273 if (s->stats_file_str) {
274 if (s->stats_version < 2 && s->stats_add_max) {
275 av_log(ctx, AV_LOG_ERROR,
276 "stats_add_max was specified but stats_version < 2.\n" );
277 return AVERROR(EINVAL);
279 if (!strcmp(s->stats_file_str, "-")) {
280 s->stats_file = stdout;
282 s->stats_file = fopen(s->stats_file_str, "w");
283 if (!s->stats_file) {
284 int err = AVERROR(errno);
286 av_strerror(err, buf, sizeof(buf));
287 av_log(ctx, AV_LOG_ERROR, "Could not open stats file %s: %s\n",
288 s->stats_file_str, buf);
294 s->fs.on_event = do_psnr;
298 static int query_formats(AVFilterContext *ctx)
300 static const enum AVPixelFormat pix_fmts[] = {
301 AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY9, AV_PIX_FMT_GRAY10, AV_PIX_FMT_GRAY12, AV_PIX_FMT_GRAY14, AV_PIX_FMT_GRAY16,
302 #define PF_NOALPHA(suf) AV_PIX_FMT_YUV420##suf, AV_PIX_FMT_YUV422##suf, AV_PIX_FMT_YUV444##suf
303 #define PF_ALPHA(suf) AV_PIX_FMT_YUVA420##suf, AV_PIX_FMT_YUVA422##suf, AV_PIX_FMT_YUVA444##suf
304 #define PF(suf) PF_NOALPHA(suf), PF_ALPHA(suf)
305 PF(P), PF(P9), PF(P10), PF_NOALPHA(P12), PF_NOALPHA(P14), PF(P16),
306 AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P,
307 AV_PIX_FMT_YUVJ411P, AV_PIX_FMT_YUVJ420P, AV_PIX_FMT_YUVJ422P,
308 AV_PIX_FMT_YUVJ440P, AV_PIX_FMT_YUVJ444P,
309 AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRP9, AV_PIX_FMT_GBRP10,
310 AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRP14, AV_PIX_FMT_GBRP16,
311 AV_PIX_FMT_GBRAP, AV_PIX_FMT_GBRAP10, AV_PIX_FMT_GBRAP12, AV_PIX_FMT_GBRAP16,
315 AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
317 return AVERROR(ENOMEM);
318 return ff_set_common_formats(ctx, fmts_list);
321 static int config_input_ref(AVFilterLink *inlink)
323 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
324 AVFilterContext *ctx = inlink->dst;
325 PSNRContext *s = ctx->priv;
330 s->nb_threads = ff_filter_get_nb_threads(ctx);
331 s->nb_components = desc->nb_components;
332 if (ctx->inputs[0]->w != ctx->inputs[1]->w ||
333 ctx->inputs[0]->h != ctx->inputs[1]->h) {
334 av_log(ctx, AV_LOG_ERROR, "Width and height of input videos must be same.\n");
335 return AVERROR(EINVAL);
337 if (ctx->inputs[0]->format != ctx->inputs[1]->format) {
338 av_log(ctx, AV_LOG_ERROR, "Inputs must be of same pixel format.\n");
339 return AVERROR(EINVAL);
342 s->max[0] = (1 << desc->comp[0].depth) - 1;
343 s->max[1] = (1 << desc->comp[1].depth) - 1;
344 s->max[2] = (1 << desc->comp[2].depth) - 1;
345 s->max[3] = (1 << desc->comp[3].depth) - 1;
347 s->is_rgb = ff_fill_rgba_map(s->rgba_map, inlink->format) >= 0;
348 s->comps[0] = s->is_rgb ? 'r' : 'y' ;
349 s->comps[1] = s->is_rgb ? 'g' : 'u' ;
350 s->comps[2] = s->is_rgb ? 'b' : 'v' ;
353 s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, desc->log2_chroma_h);
354 s->planeheight[0] = s->planeheight[3] = inlink->h;
355 s->planewidth[1] = s->planewidth[2] = AV_CEIL_RSHIFT(inlink->w, desc->log2_chroma_w);
356 s->planewidth[0] = s->planewidth[3] = inlink->w;
358 for (j = 0; j < s->nb_components; j++)
359 sum += s->planeheight[j] * s->planewidth[j];
361 for (j = 0; j < s->nb_components; j++) {
362 s->planeweight[j] = (double) s->planeheight[j] * s->planewidth[j] / sum;
363 average_max += s->max[j] * s->planeweight[j];
365 s->average_max = lrint(average_max);
367 s->dsp.sse_line = desc->comp[0].depth > 8 ? sse_line_16bit : sse_line_8bit;
369 ff_psnr_init_x86(&s->dsp, desc->comp[0].depth);
371 s->score = av_calloc(s->nb_threads, sizeof(*s->score));
373 return AVERROR(ENOMEM);
375 for (int t = 0; t < s->nb_threads && s->score; t++) {
376 s->score[t] = av_calloc(s->nb_components, sizeof(*s->score[0]));
378 return AVERROR(ENOMEM);
384 static int config_output(AVFilterLink *outlink)
386 AVFilterContext *ctx = outlink->src;
387 PSNRContext *s = ctx->priv;
388 AVFilterLink *mainlink = ctx->inputs[0];
391 ret = ff_framesync_init_dualinput(&s->fs, ctx);
394 outlink->w = mainlink->w;
395 outlink->h = mainlink->h;
396 outlink->time_base = mainlink->time_base;
397 outlink->sample_aspect_ratio = mainlink->sample_aspect_ratio;
398 outlink->frame_rate = mainlink->frame_rate;
399 if ((ret = ff_framesync_configure(&s->fs)) < 0)
402 outlink->time_base = s->fs.time_base;
404 if (av_cmp_q(mainlink->time_base, outlink->time_base) ||
405 av_cmp_q(ctx->inputs[1]->time_base, outlink->time_base))
406 av_log(ctx, AV_LOG_WARNING, "not matching timebases found between first input: %d/%d and second input %d/%d, results may be incorrect!\n",
407 mainlink->time_base.num, mainlink->time_base.den,
408 ctx->inputs[1]->time_base.num, ctx->inputs[1]->time_base.den);
413 static int activate(AVFilterContext *ctx)
415 PSNRContext *s = ctx->priv;
416 return ff_framesync_activate(&s->fs);
419 static av_cold void uninit(AVFilterContext *ctx)
421 PSNRContext *s = ctx->priv;
423 if (s->nb_frames > 0) {
428 for (j = 0; j < s->nb_components; j++) {
429 int c = s->is_rgb ? s->rgba_map[j] : j;
430 av_strlcatf(buf, sizeof(buf), " %c:%f", s->comps[j],
431 get_psnr(s->mse_comp[c], s->nb_frames, s->max[c]));
433 av_log(ctx, AV_LOG_INFO, "PSNR%s average:%f min:%f max:%f\n",
435 get_psnr(s->mse, s->nb_frames, s->average_max),
436 get_psnr(s->max_mse, 1, s->average_max),
437 get_psnr(s->min_mse, 1, s->average_max));
440 ff_framesync_uninit(&s->fs);
441 for (int t = 0; t < s->nb_threads && s->score; t++)
442 av_freep(&s->score[t]);
445 if (s->stats_file && s->stats_file != stdout)
446 fclose(s->stats_file);
449 static const AVFilterPad psnr_inputs[] = {
452 .type = AVMEDIA_TYPE_VIDEO,
455 .type = AVMEDIA_TYPE_VIDEO,
456 .config_props = config_input_ref,
461 static const AVFilterPad psnr_outputs[] = {
464 .type = AVMEDIA_TYPE_VIDEO,
465 .config_props = config_output,
470 AVFilter ff_vf_psnr = {
472 .description = NULL_IF_CONFIG_SMALL("Calculate the PSNR between two video streams."),
473 .preinit = psnr_framesync_preinit,
476 .query_formats = query_formats,
477 .activate = activate,
478 .priv_size = sizeof(PSNRContext),
479 .priv_class = &psnr_class,
480 .inputs = psnr_inputs,
481 .outputs = psnr_outputs,
482 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL | AVFILTER_FLAG_SLICE_THREADS,