1/*
2 *  Copyright (c) 2012 The WebRTC project authors. All Rights Reserved.
3 *
4 *  Use of this source code is governed by a BSD-style license
5 *  that can be found in the LICENSE file in the root of the source
6 *  tree. An additional intellectual property rights grant can be found
7 *  in the file PATENTS.  All contributing project authors may
8 *  be found in the AUTHORS file in the root of the source tree.
9 */
10
11#include <stdio.h>
12#include <stdlib.h>
13
14#include <map>
15#include <string>
16#include <vector>
17
18#include "webrtc/tools/frame_analyzer/video_quality_analysis.h"
19#include "webrtc/tools/simple_command_line_parser.h"
20
21/*
22 * A command line tool running PSNR and SSIM on a reference video and a test
23 * video. The test video is a record of the reference video which can start at
24 * an arbitrary point. It is possible that there will be repeated frames or
25 * skipped frames as well. In order to have a way to compare corresponding
26 * frames from the two videos, a stats file should be provided. The stats file
27 * is a text file assumed to be in the format:
28 * frame_xxxx yyyy
29 * where xxxx is the frame number in the test video and yyyy is the
30 * corresponding frame number in the original video.
31 * The video files should be 1420 YUV videos.
32 * The tool prints the result to standard output in the Chromium perf format:
33 * RESULT <metric>:<label>= <values>
34 *
35 * The max value for PSNR is 48.0 (between equal frames), as for SSIM it is 1.0.
36 *
37 * Usage:
38 * frame_analyzer --label=<test_label> --reference_file=<name_of_file>
39 * --test_file=<name_of_file> --stats_file=<name_of_file> --width=<frame_width>
40 * --height=<frame_height>
41 */
42int main(int argc, char** argv) {
43  std::string program_name = argv[0];
44  std::string usage = "Compares the output video with the initially sent video."
45      "\nExample usage:\n" + program_name + " --stats_file=stats.txt "
46      "--reference_file=ref.yuv --test_file=test.yuv --width=320 --height=240\n"
47      "Command line flags:\n"
48      "  - width(int): The width of the reference and test files. Default: -1\n"
49      "  - height(int): The height of the reference and test files. "
50      " Default: -1\n"
51      "  - label(string): The label to use for the perf output."
52      " Default: MY_TEST\n"
53      "  - stats_file(string): The full name of the file containing the stats"
54      " after decoding of the received YUV video. Default: stats.txt\n"
55      "  - reference_file(string): The reference YUV file to compare against."
56      " Default: ref.yuv\n"
57      "  - test_file(string): The test YUV file to run the analysis for."
58      " Default: test_file.yuv\n";
59
60  webrtc::test::CommandLineParser parser;
61
62  // Init the parser and set the usage message
63  parser.Init(argc, argv);
64  parser.SetUsageMessage(usage);
65
66  parser.SetFlag("width", "-1");
67  parser.SetFlag("height", "-1");
68  parser.SetFlag("label", "MY_TEST");
69  parser.SetFlag("stats_file", "stats.txt");
70  parser.SetFlag("reference_file", "ref.yuv");
71  parser.SetFlag("test_file", "test.yuv");
72  parser.SetFlag("help", "false");
73
74  parser.ProcessFlags();
75  if (parser.GetFlag("help") == "true") {
76    parser.PrintUsageMessage();
77  }
78  parser.PrintEnteredFlags();
79
80  int width = strtol((parser.GetFlag("width")).c_str(), NULL, 10);
81  int height = strtol((parser.GetFlag("height")).c_str(), NULL, 10);
82
83  if (width <= 0 || height <= 0) {
84    fprintf(stderr, "Error: width or height cannot be <= 0!\n");
85    return -1;
86  }
87
88  webrtc::test::ResultsContainer results;
89
90  webrtc::test::RunAnalysis(parser.GetFlag("reference_file").c_str(),
91                            parser.GetFlag("test_file").c_str(),
92                            parser.GetFlag("stats_file").c_str(), width, height,
93                            &results);
94
95  std::string label = parser.GetFlag("label");
96  webrtc::test::PrintAnalysisResults(label, &results);
97  webrtc::test::PrintMaxRepeatedAndSkippedFrames(label,
98                                                 parser.GetFlag("stats_file"));
99}
100