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 <cstddef>
15 #include <string>
16 #include <vector>
17
18 #include "absl/flags/flag.h"
19 #include "absl/flags/parse.h"
20 #include "absl/strings/match.h"
21 #include "api/scoped_refptr.h"
22 #include "rtc_base/strings/string_builder.h"
23 #include "rtc_tools/frame_analyzer/video_color_aligner.h"
24 #include "rtc_tools/frame_analyzer/video_geometry_aligner.h"
25 #include "rtc_tools/frame_analyzer/video_quality_analysis.h"
26 #include "rtc_tools/frame_analyzer/video_temporal_aligner.h"
27 #include "rtc_tools/video_file_reader.h"
28 #include "rtc_tools/video_file_writer.h"
29 #include "test/testsupport/perf_test.h"
30
31 ABSL_FLAG(int32_t, width, -1, "The width of the reference and test files");
32 ABSL_FLAG(int32_t, height, -1, "The height of the reference and test files");
33 ABSL_FLAG(std::string,
34 label,
35 "MY_TEST",
36 "The label to use for the perf output");
37 ABSL_FLAG(std::string,
38 reference_file,
39 "ref.yuv",
40 "The reference YUV file to run the analysis against");
41 ABSL_FLAG(std::string,
42 test_file,
43 "test.yuv",
44 "The test YUV file to run the analysis for");
45 ABSL_FLAG(std::string,
46 aligned_output_file,
47 "",
48 "Where to write aligned YUV/Y4M output file, f not present, no files "
49 "will be written");
50 ABSL_FLAG(std::string,
51 yuv_directory,
52 "",
53 "Where to write aligned YUV ref+test output files, if not present, "
54 "no files will be written");
55 ABSL_FLAG(std::string,
56 chartjson_result_file,
57 "",
58 "Where to store perf result in chartjson format, if not present, no "
59 "perf result will be stored");
60
61 namespace {
62
63 #ifdef WIN32
64 const char* const kPathDelimiter = "\\";
65 #else
66 const char* const kPathDelimiter = "/";
67 #endif
68
JoinFilename(std::string directory,std::string filename)69 std::string JoinFilename(std::string directory, std::string filename) {
70 return directory + kPathDelimiter + filename;
71 }
72
73 } // namespace
74
75 /*
76 * A command line tool running PSNR and SSIM on a reference video and a test
77 * video. The test video is a record of the reference video which can start at
78 * an arbitrary point. It is possible that there will be repeated frames or
79 * skipped frames as well. The video files should be I420 .y4m or .yuv videos.
80 * If both files are .y4m, it's not needed to specify width/height. The tool
81 * prints the result to standard output in the Chromium perf format:
82 * RESULT <metric>:<label>= <values>
83 *
84 * The max value for PSNR is 48.0 (between equal frames), as for SSIM it is 1.0.
85 *
86 * Usage:
87 * frame_analyzer --label=<test_label> --reference_file=<name_of_file>
88 * --test_file_ref=<name_of_file> --width=<frame_width> --height=<frame_height>
89 */
main(int argc,char * argv[])90 int main(int argc, char* argv[]) {
91 absl::ParseCommandLine(argc, argv);
92
93 int width = absl::GetFlag(FLAGS_width);
94 int height = absl::GetFlag(FLAGS_height);
95 const std::string reference_file_name = absl::GetFlag(FLAGS_reference_file);
96 const std::string test_file_name = absl::GetFlag(FLAGS_test_file);
97
98 // .yuv files require explicit resolution.
99 if ((absl::EndsWith(reference_file_name, ".yuv") ||
100 absl::EndsWith(test_file_name, ".yuv")) &&
101 (width <= 0 || height <= 0)) {
102 fprintf(stderr,
103 "Error: You need to specify width and height when using .yuv "
104 "files\n");
105 return -1;
106 }
107
108 webrtc::test::ResultsContainer results;
109
110 rtc::scoped_refptr<webrtc::test::Video> reference_video =
111 webrtc::test::OpenYuvOrY4mFile(reference_file_name, width, height);
112 rtc::scoped_refptr<webrtc::test::Video> test_video =
113 webrtc::test::OpenYuvOrY4mFile(test_file_name, width, height);
114
115 if (!reference_video || !test_video) {
116 fprintf(stderr, "Error opening video files\n");
117 return 1;
118 }
119
120 const std::vector<size_t> matching_indices =
121 webrtc::test::FindMatchingFrameIndices(reference_video, test_video);
122
123 // Align the reference video both temporally and geometrically. I.e. align the
124 // frames to match up in order to the test video, and align a crop region of
125 // the reference video to match up to the test video.
126 const rtc::scoped_refptr<webrtc::test::Video> aligned_reference_video =
127 AdjustCropping(ReorderVideo(reference_video, matching_indices),
128 test_video);
129
130 // Calculate if there is any systematic color difference between the reference
131 // and test video.
132 const webrtc::test::ColorTransformationMatrix color_transformation =
133 CalculateColorTransformationMatrix(aligned_reference_video, test_video);
134
135 char buf[256];
136 rtc::SimpleStringBuilder string_builder(buf);
137 for (int i = 0; i < 3; ++i) {
138 string_builder << "\n";
139 for (int j = 0; j < 4; ++j)
140 string_builder.AppendFormat("%6.2f ", color_transformation[i][j]);
141 }
142 printf("Adjusting test video with color transformation: %s\n",
143 string_builder.str());
144
145 // Adjust all frames in the test video with the calculated color
146 // transformation.
147 const rtc::scoped_refptr<webrtc::test::Video> color_adjusted_test_video =
148 AdjustColors(color_transformation, test_video);
149
150 results.frames = webrtc::test::RunAnalysis(
151 aligned_reference_video, color_adjusted_test_video, matching_indices);
152
153 const std::vector<webrtc::test::Cluster> clusters =
154 webrtc::test::CalculateFrameClusters(matching_indices);
155 results.max_repeated_frames = webrtc::test::GetMaxRepeatedFrames(clusters);
156 results.max_skipped_frames = webrtc::test::GetMaxSkippedFrames(clusters);
157 results.total_skipped_frames =
158 webrtc::test::GetTotalNumberOfSkippedFrames(clusters);
159 results.decode_errors_ref = 0;
160 results.decode_errors_test = 0;
161
162 webrtc::test::PrintAnalysisResults(absl::GetFlag(FLAGS_label), &results);
163
164 std::string chartjson_result_file =
165 absl::GetFlag(FLAGS_chartjson_result_file);
166 if (!chartjson_result_file.empty()) {
167 if (!webrtc::test::WritePerfResults(chartjson_result_file)) {
168 return 1;
169 }
170 }
171 std::string aligned_output_file = absl::GetFlag(FLAGS_aligned_output_file);
172 if (!aligned_output_file.empty()) {
173 webrtc::test::WriteVideoToFile(aligned_reference_video, aligned_output_file,
174 /*fps=*/30);
175 }
176 std::string yuv_directory = absl::GetFlag(FLAGS_yuv_directory);
177 if (!yuv_directory.empty()) {
178 webrtc::test::WriteVideoToFile(aligned_reference_video,
179 JoinFilename(yuv_directory, "ref.yuv"),
180 /*fps=*/30);
181 webrtc::test::WriteVideoToFile(color_adjusted_test_video,
182 JoinFilename(yuv_directory, "test.yuv"),
183 /*fps=*/30);
184 }
185
186 return 0;
187 }
188