Remove an unused parameter in EffectChainTester.
[movit] / test_util.cpp
1 #include <assert.h>
2 #include <math.h>
3 #include <stdio.h>
4 #include <algorithm>
5 #include <epoxy/gl.h>
6 #include <gtest/gtest.h>
7 #include <gtest/gtest-message.h>
8
9 #include "flat_input.h"
10 #include "init.h"
11 #include "resource_pool.h"
12 #include "test_util.h"
13 #include "util.h"
14
15 using namespace std;
16
17 namespace movit {
18
19 class Input;
20
21 namespace {
22
23 // Not thread-safe, but this isn't a big problem for testing.
24 ResourcePool *get_static_pool()
25 {
26         static ResourcePool *resource_pool = nullptr;
27         if (!resource_pool) {
28                 resource_pool = new ResourcePool();
29         }
30         return resource_pool;
31 }
32
33 // Flip upside-down to compensate for different origin.
34 template<class T>
35 void vertical_flip(T *data, unsigned width, unsigned height)
36 {
37         for (unsigned y = 0; y < height / 2; ++y) {
38                 unsigned flip_y = height - y - 1;
39                 for (unsigned x = 0; x < width; ++x) {
40                         swap(data[y * width + x], data[flip_y * width + x]);
41                 }
42         }
43 }
44
45 void init_movit_for_test()
46 {
47        CHECK(init_movit(".", MOVIT_DEBUG_OFF));
48 }
49
50 }  // namespace
51
52 EffectChainTester::EffectChainTester(const float *data, unsigned width, unsigned height,
53                                      MovitPixelFormat pixel_format, Colorspace color_space, GammaCurve gamma_curve,
54                                      GLenum framebuffer_format)
55         : chain(width, height, get_static_pool()),
56           width(width),
57           height(height),
58           framebuffer_format(framebuffer_format),
59           output_added(false),
60           finalized(false)
61 {
62         init_movit_for_test();
63
64         if (data != nullptr) {
65                 add_input(data, pixel_format, color_space, gamma_curve);
66         }
67 }
68
69 EffectChainTester::~EffectChainTester()
70 {
71 }
72
73 Input *EffectChainTester::add_input(const float *data, MovitPixelFormat pixel_format, Colorspace color_space, GammaCurve gamma_curve, int input_width, int input_height)
74 {
75         ImageFormat format;
76         format.color_space = color_space;
77         format.gamma_curve = gamma_curve;
78
79         if (input_width == -1) {
80                 input_width = width;
81         }
82         if (input_height == -1) {
83                 input_height = height;
84         }
85
86         FlatInput *input = new FlatInput(format, pixel_format, GL_FLOAT, input_width, input_height);
87         input->set_pixel_data(data);
88         chain.add_input(input);
89         return input;
90 }
91
92 Input *EffectChainTester::add_input(const unsigned char *data, MovitPixelFormat pixel_format, Colorspace color_space, GammaCurve gamma_curve, int input_width, int input_height)
93 {
94         ImageFormat format;
95         format.color_space = color_space;
96         format.gamma_curve = gamma_curve;
97
98         if (input_width == -1) {
99                 input_width = width;
100         }
101         if (input_height == -1) {
102                 input_height = height;
103         }
104
105         FlatInput *input = new FlatInput(format, pixel_format, GL_UNSIGNED_BYTE, input_width, input_height);
106         input->set_pixel_data(data);
107         chain.add_input(input);
108         return input;
109 }
110
111 void EffectChainTester::run(float *out_data, GLenum format, Colorspace color_space, GammaCurve gamma_curve, OutputAlphaFormat alpha_format)
112 {
113         internal_run<float>(out_data, nullptr, nullptr, nullptr, format, color_space, gamma_curve, alpha_format);
114 }
115
116 void EffectChainTester::run(float *out_data, float *out_data2, GLenum format, Colorspace color_space, GammaCurve gamma_curve, OutputAlphaFormat alpha_format)
117 {
118         internal_run<float>(out_data, out_data2, nullptr, nullptr, format, color_space, gamma_curve, alpha_format);
119 }
120
121 void EffectChainTester::run(float *out_data, float *out_data2, float *out_data3, GLenum format, Colorspace color_space, GammaCurve gamma_curve, OutputAlphaFormat alpha_format)
122 {
123         internal_run<float>(out_data, out_data2, out_data3, nullptr, format, color_space, gamma_curve, alpha_format);
124 }
125
126 void EffectChainTester::run(float *out_data, float *out_data2, float *out_data3, float *out_data4, GLenum format, Colorspace color_space, GammaCurve gamma_curve, OutputAlphaFormat alpha_format)
127 {
128         internal_run(out_data, out_data2, out_data3, out_data4, format, color_space, gamma_curve, alpha_format);
129 }
130
131 void EffectChainTester::run(unsigned char *out_data, GLenum format, Colorspace color_space, GammaCurve gamma_curve, OutputAlphaFormat alpha_format)
132 {
133         internal_run<unsigned char>(out_data, nullptr, nullptr, nullptr, format, color_space, gamma_curve, alpha_format);
134 }
135
136 void EffectChainTester::run(unsigned char *out_data, unsigned char *out_data2, GLenum format, Colorspace color_space, GammaCurve gamma_curve, OutputAlphaFormat alpha_format)
137 {
138         internal_run<unsigned char>(out_data, out_data2, nullptr, nullptr, format, color_space, gamma_curve, alpha_format);
139 }
140
141 void EffectChainTester::run(unsigned char *out_data, unsigned char *out_data2, unsigned char *out_data3, GLenum format, Colorspace color_space, GammaCurve gamma_curve, OutputAlphaFormat alpha_format)
142 {
143         internal_run<unsigned char>(out_data, out_data2, out_data3, nullptr, format, color_space, gamma_curve, alpha_format);
144 }
145
146 void EffectChainTester::run(unsigned char *out_data, unsigned char *out_data2, unsigned char *out_data3, unsigned char *out_data4, GLenum format, Colorspace color_space, GammaCurve gamma_curve, OutputAlphaFormat alpha_format)
147 {
148         internal_run(out_data, out_data2, out_data3, out_data4, format, color_space, gamma_curve, alpha_format);
149 }
150
151 void EffectChainTester::run(uint16_t *out_data, GLenum format, Colorspace color_space, GammaCurve gamma_curve, OutputAlphaFormat alpha_format)
152 {
153         internal_run<uint16_t>(out_data, nullptr, nullptr, nullptr, format, color_space, gamma_curve, alpha_format);
154 }
155
156 void EffectChainTester::run_10_10_10_2(uint32_t *out_data, GLenum format, Colorspace color_space, GammaCurve gamma_curve, OutputAlphaFormat alpha_format)
157 {
158         internal_run<uint32_t>(out_data, nullptr, nullptr, nullptr, format, color_space, gamma_curve, alpha_format);
159 }
160
161 #ifdef HAVE_BENCHMARK
162
163 void EffectChainTester::benchmark(benchmark::State &state, float *out_data, GLenum format, Colorspace color_space, GammaCurve gamma_curve, OutputAlphaFormat alpha_format)
164 {
165         internal_run<float>(out_data, nullptr, nullptr, nullptr, format, color_space, gamma_curve, alpha_format, &state);
166 }
167
168 void EffectChainTester::benchmark(benchmark::State &state, float *out_data, float *out_data2, GLenum format, Colorspace color_space, GammaCurve gamma_curve, OutputAlphaFormat alpha_format)
169 {
170         internal_run<float>(out_data, out_data2, nullptr, nullptr, format, color_space, gamma_curve, alpha_format, &state);
171 }
172
173 void EffectChainTester::benchmark(benchmark::State &state, float *out_data, float *out_data2, float *out_data3, GLenum format, Colorspace color_space, GammaCurve gamma_curve, OutputAlphaFormat alpha_format)
174 {
175         internal_run<float>(out_data, out_data2, out_data3, nullptr, format, color_space, gamma_curve, alpha_format, &state);
176 }
177
178 void EffectChainTester::benchmark(benchmark::State &state, float *out_data, float *out_data2, float *out_data3, float *out_data4, GLenum format, Colorspace color_space, GammaCurve gamma_curve, OutputAlphaFormat alpha_format)
179 {
180         internal_run(out_data, out_data2, out_data3, out_data4, format, color_space, gamma_curve, alpha_format, &state);
181 }
182
183 void EffectChainTester::benchmark(benchmark::State &state, unsigned char *out_data, GLenum format, Colorspace color_space, GammaCurve gamma_curve, OutputAlphaFormat alpha_format)
184 {
185         internal_run<unsigned char>(out_data, nullptr, nullptr, nullptr, format, color_space, gamma_curve, alpha_format, &state);
186 }
187
188 void EffectChainTester::benchmark(benchmark::State &state, unsigned char *out_data, unsigned char *out_data2, GLenum format, Colorspace color_space, GammaCurve gamma_curve, OutputAlphaFormat alpha_format)
189 {
190         internal_run<unsigned char>(out_data, out_data2, nullptr, nullptr, format, color_space, gamma_curve, alpha_format, &state);
191 }
192
193 void EffectChainTester::benchmark(benchmark::State &state, unsigned char *out_data, unsigned char *out_data2, unsigned char *out_data3, GLenum format, Colorspace color_space, GammaCurve gamma_curve, OutputAlphaFormat alpha_format)
194 {
195         internal_run<unsigned char>(out_data, out_data2, out_data3, nullptr, format, color_space, gamma_curve, alpha_format, &state);
196 }
197
198 void EffectChainTester::benchmark(benchmark::State &state, unsigned char *out_data, unsigned char *out_data2, unsigned char *out_data3, unsigned char *out_data4, GLenum format, Colorspace color_space, GammaCurve gamma_curve, OutputAlphaFormat alpha_format)
199 {
200         internal_run(out_data, out_data2, out_data3, out_data4, format, color_space, gamma_curve, alpha_format, &state);
201 }
202
203 void EffectChainTester::benchmark(benchmark::State &state, uint16_t *out_data, GLenum format, Colorspace color_space, GammaCurve gamma_curve, OutputAlphaFormat alpha_format)
204 {
205         internal_run<uint16_t>(out_data, nullptr, nullptr, nullptr, format, color_space, gamma_curve, alpha_format, &state);
206 }
207
208 void EffectChainTester::benchmark_10_10_10_2(benchmark::State &state, uint32_t *out_data, GLenum format, Colorspace color_space, GammaCurve gamma_curve, OutputAlphaFormat alpha_format)
209 {
210         internal_run<uint32_t>(out_data, nullptr, nullptr, nullptr, format, color_space, gamma_curve, alpha_format, &state);
211 }
212
213 #endif
214
215 template<class T>
216 void EffectChainTester::internal_run(T *out_data, T *out_data2, T *out_data3, T *out_data4, GLenum format, Colorspace color_space, GammaCurve gamma_curve, OutputAlphaFormat alpha_format
217 #ifdef HAVE_BENCHMARK
218 , benchmark::State *benchmark_state
219 #endif
220 )
221 {
222         if (!finalized) {
223                 finalize_chain(color_space, gamma_curve, alpha_format);
224         }
225
226         GLuint type;
227         if (framebuffer_format == GL_RGBA8) {
228                 type = GL_UNSIGNED_BYTE;
229         } else if (framebuffer_format == GL_RGBA16) {
230                 type = GL_UNSIGNED_SHORT;
231         } else if (framebuffer_format == GL_RGBA16F || framebuffer_format == GL_RGBA32F) {
232                 type = GL_FLOAT;
233         } else if (framebuffer_format == GL_RGB10_A2) {
234                 type = GL_UNSIGNED_INT_2_10_10_10_REV;
235         } else {
236                 // Add more here as needed.
237                 assert(false);
238         }
239
240         unsigned num_outputs;
241         if (out_data4 != nullptr) {
242                 num_outputs = 4;
243         } else if (out_data3 != nullptr) {
244                 num_outputs = 3;
245         } else if (out_data2 != nullptr) {
246                 num_outputs = 2;
247         } else {
248                 num_outputs = 1;
249         }
250
251         glActiveTexture(GL_TEXTURE0);
252         check_error();
253
254         vector<EffectChain::DestinationTexture> textures;
255         for (unsigned i = 0; i < num_outputs; ++i) {
256                 GLuint texnum = chain.get_resource_pool()->create_2d_texture(framebuffer_format, width, height);
257                 textures.push_back(EffectChain::DestinationTexture{texnum, framebuffer_format});
258
259                 // The output texture needs to have valid state to be written to by a compute shader.
260                 glBindTexture(GL_TEXTURE_2D, texnum);
261                 check_error();
262                 glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR);
263                 check_error();
264         }
265
266         chain.render_to_texture(textures, width, height);
267
268 #ifdef HAVE_BENCHMARK
269         // If running benchmarks: Now we've warmed up everything, so let's run the
270         // actual benchmark loop.
271         if (benchmark_state != nullptr) {
272                 glFinish();
273                 size_t iters = benchmark_state->max_iterations;
274                 for (auto _ : *benchmark_state) {
275                         chain.render_to_texture(textures, width, height);
276                         if (--iters == 0) {
277                                 glFinish();
278                         }
279                 }
280                 benchmark_state->SetItemsProcessed(benchmark_state->iterations() * width * height);
281         }
282 #endif
283
284         T *data[4] = { out_data, out_data2, out_data3, out_data4 };
285
286         for (unsigned i = 0; i < num_outputs; ++i) {
287                 T *ptr = data[i];
288                 glBindTexture(GL_TEXTURE_2D, textures[i].texnum);
289                 check_error();
290                 if (!epoxy_is_desktop_gl() && (format == GL_RED || format == GL_BLUE || format == GL_ALPHA)) {
291                         // GLES will only read GL_RGBA.
292                         T *temp = new T[width * height * 4];
293                         glGetTexImage(GL_TEXTURE_2D, 0, GL_RGBA, type, temp);
294                         check_error();
295                         if (format == GL_ALPHA) {
296                                 for (unsigned i = 0; i < width * height; ++i) {
297                                         ptr[i] = temp[i * 4 + 3];
298                                 }
299                         } else if (format == GL_BLUE) {
300                                 for (unsigned i = 0; i < width * height; ++i) {
301                                         ptr[i] = temp[i * 4 + 2];
302                                 }
303                         } else {
304                                 for (unsigned i = 0; i < width * height; ++i) {
305                                         ptr[i] = temp[i * 4];
306                                 }
307                         }
308                         delete[] temp;
309                 } else {
310                         glGetTexImage(GL_TEXTURE_2D, 0, format, type, ptr);
311                         check_error();
312                 }
313
314                 if (format == GL_RGBA && (type == GL_UNSIGNED_BYTE || type == GL_UNSIGNED_SHORT || type == GL_FLOAT)) {
315                         vertical_flip(ptr, width * 4, height);
316                 } else {
317                         vertical_flip(ptr, width, height);
318                 }
319         }
320
321         for (unsigned i = 0; i < num_outputs; ++i) {
322                 chain.get_resource_pool()->release_2d_texture(textures[i].texnum);
323         }
324 }
325
326 void EffectChainTester::add_output(const ImageFormat &format, OutputAlphaFormat alpha_format)
327 {
328         chain.add_output(format, alpha_format);
329         output_added = true;
330 }
331
332 void EffectChainTester::add_ycbcr_output(const ImageFormat &format, OutputAlphaFormat alpha_format, const YCbCrFormat &ycbcr_format, YCbCrOutputSplitting output_splitting, GLenum type)
333 {
334         chain.add_ycbcr_output(format, alpha_format, ycbcr_format, output_splitting, type);
335         output_added = true;
336 }
337
338 void EffectChainTester::finalize_chain(Colorspace color_space, GammaCurve gamma_curve, OutputAlphaFormat alpha_format)
339 {
340         assert(!finalized);
341         if (!output_added) {
342                 ImageFormat image_format;
343                 image_format.color_space = color_space;
344                 image_format.gamma_curve = gamma_curve;
345                 chain.add_output(image_format, alpha_format);
346                 output_added = true;
347         }
348         chain.finalize();
349         finalized = true;
350 }
351
352 void expect_equal(const float *ref, const float *result, unsigned width, unsigned height, float largest_difference_limit, float rms_limit)
353 {
354         float largest_difference = -1.0f;
355         float squared_difference = 0.0f;
356         int largest_diff_x = -1, largest_diff_y = -1;
357
358         for (unsigned y = 0; y < height; ++y) {
359                 for (unsigned x = 0; x < width; ++x) {
360                         float diff = ref[y * width + x] - result[y * width + x];
361                         if (fabs(diff) > largest_difference) {
362                                 largest_difference = fabs(diff);
363                                 largest_diff_x = x;
364                                 largest_diff_y = y;
365                         }
366                         squared_difference += diff * diff;
367                 }
368         }
369
370         EXPECT_LT(largest_difference, largest_difference_limit)
371                 << "Largest difference is in x=" << largest_diff_x << ", y=" << largest_diff_y << ":\n"
372                 << "Reference: " << ref[largest_diff_y * width + largest_diff_x] << "\n"
373                 << "Result:    " << result[largest_diff_y * width + largest_diff_x];
374
375         float rms = sqrt(squared_difference) / (width * height);
376         EXPECT_LT(rms, rms_limit);
377
378         if (largest_difference >= largest_difference_limit || isnan(rms) || rms >= rms_limit) {
379                 fprintf(stderr, "Dumping matrices for easier debugging, since at least one test failed.\n");
380
381                 fprintf(stderr, "Reference:\n");
382                 for (unsigned y = 0; y < height; ++y) {
383                         for (unsigned x = 0; x < width; ++x) {
384                                 fprintf(stderr, "%7.4f ", ref[y * width + x]);
385                         }
386                         fprintf(stderr, "\n");
387                 }
388
389                 fprintf(stderr, "\nResult:\n");
390                 for (unsigned y = 0; y < height; ++y) {
391                         for (unsigned x = 0; x < width; ++x) {
392                                 fprintf(stderr, "%7.4f ", result[y * width + x]);
393                         }
394                         fprintf(stderr, "\n");
395                 }
396         }
397 }
398
399 void expect_equal(const unsigned char *ref, const unsigned char *result, unsigned width, unsigned height, unsigned largest_difference_limit, float rms_limit)
400 {
401         assert(width > 0);
402         assert(height > 0);
403
404         float *ref_float = new float[width * height];
405         float *result_float = new float[width * height];
406
407         for (unsigned y = 0; y < height; ++y) {
408                 for (unsigned x = 0; x < width; ++x) {
409                         ref_float[y * width + x] = ref[y * width + x];
410                         result_float[y * width + x] = result[y * width + x];
411                 }
412         }
413
414         expect_equal(ref_float, result_float, width, height, largest_difference_limit, rms_limit);
415
416         delete[] ref_float;
417         delete[] result_float;
418 }
419
420 void expect_equal(const uint16_t *ref, const uint16_t *result, unsigned width, unsigned height, unsigned largest_difference_limit, float rms_limit)
421 {
422         assert(width > 0);
423         assert(height > 0);
424
425         float *ref_float = new float[width * height];
426         float *result_float = new float[width * height];
427
428         for (unsigned y = 0; y < height; ++y) {
429                 for (unsigned x = 0; x < width; ++x) {
430                         ref_float[y * width + x] = ref[y * width + x];
431                         result_float[y * width + x] = result[y * width + x];
432                 }
433         }
434
435         expect_equal(ref_float, result_float, width, height, largest_difference_limit, rms_limit);
436
437         delete[] ref_float;
438         delete[] result_float;
439 }
440
441 void expect_equal(const int *ref, const int *result, unsigned width, unsigned height, unsigned largest_difference_limit, float rms_limit)
442 {
443         assert(width > 0);
444         assert(height > 0);
445
446         float *ref_float = new float[width * height];
447         float *result_float = new float[width * height];
448
449         for (unsigned y = 0; y < height; ++y) {
450                 for (unsigned x = 0; x < width; ++x) {
451                         ref_float[y * width + x] = ref[y * width + x];
452                         result_float[y * width + x] = result[y * width + x];
453                 }
454         }
455
456         expect_equal(ref_float, result_float, width, height, largest_difference_limit, rms_limit);
457
458         delete[] ref_float;
459         delete[] result_float;
460 }
461
462 void test_accuracy(const float *expected, const float *result, unsigned num_values, double absolute_error_limit, double relative_error_limit, double local_relative_error_limit, double rms_limit)
463 {
464         double squared_difference = 0.0;
465         for (unsigned i = 0; i < num_values; ++i) {
466                 double absolute_error = fabs(expected[i] - result[i]);
467                 squared_difference += absolute_error * absolute_error;
468                 EXPECT_LT(absolute_error, absolute_error_limit);
469
470                 if (expected[i] > 0.0) {
471                         double relative_error = fabs(absolute_error / expected[i]);
472
473                         EXPECT_LT(relative_error, relative_error_limit);
474                 }
475                 if (i < num_values - 1) {
476                         double delta = expected[i + 1] - expected[i];
477                         double local_relative_error = fabs(absolute_error / delta);
478                         EXPECT_LT(local_relative_error, local_relative_error_limit);
479                 }
480         }
481         double rms = sqrt(squared_difference) / num_values;
482         EXPECT_LT(rms, rms_limit);
483 }
484
485 double srgb_to_linear(double x)
486 {
487         // From the Wikipedia article on sRGB.
488         if (x < 0.04045) {
489                 return x / 12.92;
490         } else {
491                 return pow((x + 0.055) / 1.055, 2.4);
492         }
493 }
494
495 double linear_to_srgb(double x)
496 {
497         // From the Wikipedia article on sRGB.
498         if (x < 0.0031308) {
499                 return 12.92 * x;
500         } else {
501                 return 1.055 * pow(x, 1.0 / 2.4) - 0.055;
502         }
503 }
504
505 DisableComputeShadersTemporarily::DisableComputeShadersTemporarily(bool disable_compute_shaders)
506         : disable_compute_shaders(disable_compute_shaders)
507 {
508         init_movit_for_test();
509         saved_compute_shaders_supported = movit_compute_shaders_supported;
510         if (disable_compute_shaders) {
511                 movit_compute_shaders_supported = false;
512         }
513 }
514
515 DisableComputeShadersTemporarily::~DisableComputeShadersTemporarily()
516 {
517         movit_compute_shaders_supported = saved_compute_shaders_supported;
518 }
519
520 bool DisableComputeShadersTemporarily::should_skip()
521 {
522         if (disable_compute_shaders) {
523                 return false;
524         }
525
526         if (!movit_compute_shaders_supported) {
527                 fprintf(stderr, "Compute shaders not supported; skipping.\n");
528                 return true;
529         }
530         return false;
531 }
532
533 #ifdef HAVE_BENCHMARK
534 bool DisableComputeShadersTemporarily::should_skip(benchmark::State *benchmark_state)
535 {
536         if (disable_compute_shaders) {
537                 return false;
538         }
539
540         if (!movit_compute_shaders_supported) {
541                 benchmark_state->SkipWithError("Compute shaders not supported");
542                 return true;
543         }
544         return false;
545 }
546 #endif
547
548 }  // namespace movit