Emulate glReadPixels of GL_ALPHA.
[movit] / resample_effect.cpp
1 // Three-lobed Lanczos, the most common choice.
2 #define LANCZOS_RADIUS 3.0
3
4 #include <epoxy/gl.h>
5 #include <assert.h>
6 #include <limits.h>
7 #include <math.h>
8 #include <stdio.h>
9 #include <algorithm>
10
11 #include "effect_chain.h"
12 #include "effect_util.h"
13 #include "fp16.h"
14 #include "resample_effect.h"
15 #include "util.h"
16
17 using namespace std;
18
19 namespace movit {
20
21 namespace {
22
23 float sinc(float x)
24 {
25         if (fabs(x) < 1e-6) {
26                 return 1.0f - fabs(x);
27         } else {
28                 return sin(x) / x;
29         }
30 }
31
32 float lanczos_weight(float x, float a)
33 {
34         if (fabs(x) > a) {
35                 return 0.0f;
36         } else {
37                 return sinc(M_PI * x) * sinc(M_PI * x / a);
38         }
39 }
40
41 // Euclid's algorithm, from Wikipedia.
42 unsigned gcd(unsigned a, unsigned b)
43 {
44         while (b != 0) {
45                 unsigned t = b;
46                 b = a % b;
47                 a = t;
48         }
49         return a;
50 }
51
52 unsigned combine_samples(float *src, float *dst, unsigned num_src_samples, unsigned max_samples_saved)
53 {
54         unsigned num_samples_saved = 0;
55         for (unsigned i = 0, j = 0; i < num_src_samples; ++i, ++j) {
56                 // Copy the sample directly; it will be overwritten later if we can combine.
57                 if (dst != NULL) {
58                         dst[j * 2 + 0] = src[i * 2 + 0];
59                         dst[j * 2 + 1] = src[i * 2 + 1];
60                 }
61
62                 if (i == num_src_samples - 1) {
63                         // Last sample; cannot combine.
64                         continue;
65                 }
66                 assert(num_samples_saved <= max_samples_saved);
67                 if (num_samples_saved == max_samples_saved) {
68                         // We could maybe save more here, but other rows can't, so don't bother.
69                         continue;
70                 }
71
72                 float w1 = src[i * 2 + 0];
73                 float w2 = src[(i + 1) * 2 + 0];
74                 if (w1 * w2 < 0.0f) {
75                         // Differing signs; cannot combine.
76                         continue;
77                 }
78
79                 float pos1 = src[i * 2 + 1];
80                 float pos2 = src[(i + 1) * 2 + 1];
81                 assert(pos2 > pos1);
82
83                 float offset, total_weight, sum_sq_error;
84                 combine_two_samples(w1, w2, &offset, &total_weight, &sum_sq_error);
85
86                 // If the interpolation error is larger than that of about sqrt(2) of
87                 // a level at 8-bit precision, don't combine. (You'd think 1.0 was enough,
88                 // but since the artifacts are not really random, they can get quite
89                 // visible. On the other hand, going to 0.25f, I can see no change at
90                 // all with 8-bit output, so it would not seem to be worth it.)
91                 if (sum_sq_error > 0.5f / (256.0f * 256.0f)) {
92                         continue;
93                 }
94
95                 // OK, we can combine this and the next sample.
96                 if (dst != NULL) {
97                         dst[j * 2 + 0] = total_weight;
98                         dst[j * 2 + 1] = pos1 + offset * (pos2 - pos1);
99                 }
100
101                 ++i;  // Skip the next sample.
102                 ++num_samples_saved;
103         }
104         return num_samples_saved;
105 }
106
107 }  // namespace
108
109 ResampleEffect::ResampleEffect()
110         : input_width(1280),
111           input_height(720)
112 {
113         register_int("width", &output_width);
114         register_int("height", &output_height);
115
116         // The first blur pass will forward resolution information to us.
117         hpass = new SingleResamplePassEffect(this);
118         CHECK(hpass->set_int("direction", SingleResamplePassEffect::HORIZONTAL));
119         vpass = new SingleResamplePassEffect(NULL);
120         CHECK(vpass->set_int("direction", SingleResamplePassEffect::VERTICAL));
121
122         update_size();
123 }
124
125 void ResampleEffect::rewrite_graph(EffectChain *graph, Node *self)
126 {
127         Node *hpass_node = graph->add_node(hpass);
128         Node *vpass_node = graph->add_node(vpass);
129         graph->connect_nodes(hpass_node, vpass_node);
130         graph->replace_receiver(self, hpass_node);
131         graph->replace_sender(self, vpass_node);
132         self->disabled = true;
133
134
135 // We get this information forwarded from the first blur pass,
136 // since we are not part of the chain ourselves.
137 void ResampleEffect::inform_input_size(unsigned input_num, unsigned width, unsigned height)
138 {
139         assert(input_num == 0);
140         assert(width != 0);
141         assert(height != 0);
142         input_width = width;
143         input_height = height;
144         update_size();
145 }
146
147 void ResampleEffect::update_size()
148 {
149         bool ok = true;
150         ok |= hpass->set_int("input_width", input_width);
151         ok |= hpass->set_int("input_height", input_height);
152         ok |= hpass->set_int("output_width", output_width);
153         ok |= hpass->set_int("output_height", input_height);
154
155         ok |= vpass->set_int("input_width", output_width);
156         ok |= vpass->set_int("input_height", input_height);
157         ok |= vpass->set_int("output_width", output_width);
158         ok |= vpass->set_int("output_height", output_height);
159
160         assert(ok);
161 }
162
163 bool ResampleEffect::set_float(const string &key, float value) {
164         if (key == "width") {
165                 output_width = value;
166                 update_size();
167                 return true;
168         }
169         if (key == "height") {
170                 output_height = value;
171                 update_size();
172                 return true;
173         }
174         return false;
175 }
176
177 SingleResamplePassEffect::SingleResamplePassEffect(ResampleEffect *parent)
178         : parent(parent),
179           direction(HORIZONTAL),
180           input_width(1280),
181           input_height(720),
182           last_input_width(-1),
183           last_input_height(-1),
184           last_output_width(-1),
185           last_output_height(-1)
186 {
187         register_int("direction", (int *)&direction);
188         register_int("input_width", &input_width);
189         register_int("input_height", &input_height);
190         register_int("output_width", &output_width);
191         register_int("output_height", &output_height);
192
193         glGenTextures(1, &texnum);
194 }
195
196 SingleResamplePassEffect::~SingleResamplePassEffect()
197 {
198         glDeleteTextures(1, &texnum);
199 }
200
201 string SingleResamplePassEffect::output_fragment_shader()
202 {
203         char buf[256];
204         sprintf(buf, "#define DIRECTION_VERTICAL %d\n", (direction == VERTICAL));
205         return buf + read_file("resample_effect.frag");
206 }
207
208 // Using vertical scaling as an example:
209 //
210 // Generally out[y] = w0 * in[yi] + w1 * in[yi + 1] + w2 * in[yi + 2] + ...
211 //
212 // Obviously, yi will depend on y (in a not-quite-linear way), but so will
213 // the weights w0, w1, w2, etc.. The easiest way of doing this is to encode,
214 // for each sample, the weight and the yi value, e.g. <yi, w0>, <yi + 1, w1>,
215 // and so on. For each y, we encode these along the x-axis (since that is spare),
216 // so out[0] will read from parameters <x,y> = <0,0>, <1,0>, <2,0> and so on.
217 //
218 // For horizontal scaling, we fill in the exact same texture;
219 // the shader just interprets it differently.
220 void SingleResamplePassEffect::update_texture(GLuint glsl_program_num, const string &prefix, unsigned *sampler_num)
221 {
222         unsigned src_size, dst_size;
223         if (direction == SingleResamplePassEffect::HORIZONTAL) {
224                 assert(input_height == output_height);
225                 src_size = input_width;
226                 dst_size = output_width;
227         } else if (direction == SingleResamplePassEffect::VERTICAL) {
228                 assert(input_width == output_width);
229                 src_size = input_height;
230                 dst_size = output_height;
231         } else {
232                 assert(false);
233         }
234
235         // For many resamplings (e.g. 640 -> 1280), we will end up with the same
236         // set of samples over and over again in a loop. Thus, we can compute only
237         // the first such loop, and then ask the card to repeat the texture for us.
238         // This is both easier on the texture cache and lowers our CPU cost for
239         // generating the kernel somewhat.
240         num_loops = gcd(src_size, dst_size);
241         slice_height = 1.0f / num_loops;
242         unsigned dst_samples = dst_size / num_loops;
243
244         // Sample the kernel in the right place. A diagram with a triangular kernel
245         // (corresponding to linear filtering, and obviously with radius 1)
246         // for easier ASCII art drawing:
247         //
248         //                *
249         //               / \                      |
250         //              /   \                     |
251         //             /     \                    |
252         //    x---x---x   x   x---x---x---x
253         //
254         // Scaling up (in this case, 2x) means sampling more densely:
255         //
256         //                *
257         //               / \                      |
258         //              /   \                     |
259         //             /     \                    |
260         //   x-x-x-x-x-x x x x-x-x-x-x-x-x-x
261         //
262         // When scaling up, any destination pixel will only be influenced by a few
263         // (in this case, two) neighboring pixels, and more importantly, the number
264         // will not be influenced by the scaling factor. (Note, however, that the
265         // pixel centers have moved, due to OpenGL's center-pixel convention.)
266         // The only thing that changes is the weights themselves, as the sampling
267         // points are at different distances from the original pixels.
268         //
269         // Scaling down is a different story:
270         //
271         //                *
272         //               / \                      |
273         //              /   \                     |
274         //             /     \                    |
275         //    --x------ x     --x-------x--
276         //
277         // Again, the pixel centers have moved in a maybe unintuitive fashion,
278         // although when you consider that there are multiple source pixels around,
279         // it's not so bad as at first look:
280         //
281         //            *   *   *   *
282         //           / \ / \ / \ / \              |
283         //          /   X   X   X   \             |
284         //         /   / \ / \ / \   \            |
285         //    --x-------x-------x-------x--
286         //
287         // As you can see, the new pixels become averages of the two neighboring old
288         // ones (the situation for Lanczos is of course more complex).
289         //
290         // Anyhow, in this case we clearly need to look at more source pixels
291         // to compute the destination pixel, and how many depend on the scaling factor.
292         // Thus, the kernel width will vary with how much we scale.
293         float radius_scaling_factor = min(float(dst_size) / float(src_size), 1.0f);
294         int int_radius = lrintf(LANCZOS_RADIUS / radius_scaling_factor);
295         int src_samples = int_radius * 2 + 1;
296         float *weights = new float[dst_samples * src_samples * 2];
297         for (unsigned y = 0; y < dst_samples; ++y) {
298                 // Find the point around which we want to sample the source image,
299                 // compensating for differing pixel centers as the scale changes.
300                 float center_src_y = (y + 0.5f) * float(src_size) / float(dst_size) - 0.5f;
301                 int base_src_y = lrintf(center_src_y);
302
303                 // Now sample <int_radius> pixels on each side around that point.
304                 for (int i = 0; i < src_samples; ++i) {
305                         int src_y = base_src_y + i - int_radius;
306                         float weight = lanczos_weight(radius_scaling_factor * (src_y - center_src_y), LANCZOS_RADIUS);
307                         weights[(y * src_samples + i) * 2 + 0] = weight * radius_scaling_factor;
308                         weights[(y * src_samples + i) * 2 + 1] = (src_y + 0.5) / float(src_size);
309                 }
310
311         }
312
313         // Now make use of the bilinear filtering in the GPU to reduce the number of samples
314         // we need to make. This is a bit more complex than BlurEffect since we cannot combine
315         // two neighboring samples if their weights have differing signs, so we first need to
316         // figure out the maximum number of samples. Then, we downconvert all the weights to
317         // that number -- we could have gone for a variable-length system, but this is simpler,
318         // and the gains would probably be offset by the extra cost of checking when to stop.
319         //
320         // The greedy strategy for combining samples is optimal.
321         src_bilinear_samples = 0;
322         for (unsigned y = 0; y < dst_samples; ++y) {
323                 unsigned num_samples_saved = combine_samples(weights + (y * src_samples) * 2, NULL, src_samples, UINT_MAX);
324                 src_bilinear_samples = max<int>(src_bilinear_samples, src_samples - num_samples_saved);
325         }
326
327         // Now that we know the right width, actually combine the samples.
328         float *bilinear_weights = new float[dst_samples * src_bilinear_samples * 2];
329         fp16_int_t *bilinear_weights_fp16 = new fp16_int_t[dst_samples * src_bilinear_samples * 2];
330         for (unsigned y = 0; y < dst_samples; ++y) {
331                 float *bilinear_weights_ptr = bilinear_weights + (y * src_bilinear_samples) * 2;
332                 fp16_int_t *bilinear_weights_fp16_ptr = bilinear_weights_fp16 + (y * src_bilinear_samples) * 2;
333                 unsigned num_samples_saved = combine_samples(
334                         weights + (y * src_samples) * 2,
335                         bilinear_weights_ptr,
336                         src_samples,
337                         src_samples - src_bilinear_samples);
338                 assert(int(src_samples) - int(num_samples_saved) == src_bilinear_samples);
339
340                 // Convert to fp16.
341                 for (int i = 0; i < src_bilinear_samples; ++i) {
342                         bilinear_weights_fp16_ptr[i * 2 + 0] = fp64_to_fp16(bilinear_weights_ptr[i * 2 + 0]);
343                         bilinear_weights_fp16_ptr[i * 2 + 1] = fp64_to_fp16(bilinear_weights_ptr[i * 2 + 1]);
344                 }
345
346                 // Normalize so that the sum becomes one. Note that we do it twice;
347                 // this sometimes helps a tiny little bit when we have many samples.
348                 for (int normalize_pass = 0; normalize_pass < 2; ++normalize_pass) {
349                         double sum = 0.0;
350                         for (int i = 0; i < src_bilinear_samples; ++i) {
351                                 sum += fp16_to_fp64(bilinear_weights_fp16_ptr[i * 2 + 0]);
352                         }
353                         for (int i = 0; i < src_bilinear_samples; ++i) {
354                                 bilinear_weights_fp16_ptr[i * 2 + 0] = fp64_to_fp16(
355                                         fp16_to_fp64(bilinear_weights_fp16_ptr[i * 2 + 0]) / sum);
356                         }
357                 }
358         }
359
360         // Encode as a two-component texture. Note the GL_REPEAT.
361         glActiveTexture(GL_TEXTURE0 + *sampler_num);
362         check_error();
363         glBindTexture(GL_TEXTURE_2D, texnum);
364         check_error();
365         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST);
366         check_error();
367         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_REPEAT);
368         check_error();
369         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_REPEAT);
370         check_error();
371         glTexImage2D(GL_TEXTURE_2D, 0, GL_RG16F, src_bilinear_samples, dst_samples, 0, GL_RG, GL_HALF_FLOAT, bilinear_weights_fp16);
372         check_error();
373
374         delete[] weights;
375         delete[] bilinear_weights;
376         delete[] bilinear_weights_fp16;
377 }
378
379 void SingleResamplePassEffect::set_gl_state(GLuint glsl_program_num, const string &prefix, unsigned *sampler_num)
380 {
381         Effect::set_gl_state(glsl_program_num, prefix, sampler_num);
382
383         assert(input_width > 0);
384         assert(input_height > 0);
385         assert(output_width > 0);
386         assert(output_height > 0);
387
388         if (input_width != last_input_width ||
389             input_height != last_input_height ||
390             output_width != last_output_width ||
391             output_height != last_output_height) {
392                 update_texture(glsl_program_num, prefix, sampler_num);
393                 last_input_width = input_width;
394                 last_input_height = input_height;
395                 last_output_width = output_width;
396                 last_output_height = output_height;
397         }
398
399         glActiveTexture(GL_TEXTURE0 + *sampler_num);
400         check_error();
401         glBindTexture(GL_TEXTURE_2D, texnum);
402         check_error();
403
404         set_uniform_int(glsl_program_num, prefix, "sample_tex", *sampler_num);
405         ++sampler_num;
406         set_uniform_int(glsl_program_num, prefix, "num_samples", src_bilinear_samples);
407         set_uniform_float(glsl_program_num, prefix, "num_loops", num_loops);
408         set_uniform_float(glsl_program_num, prefix, "slice_height", slice_height);
409
410         // Instructions for how to convert integer sample numbers to positions in the weight texture.
411         set_uniform_float(glsl_program_num, prefix, "sample_x_scale", 1.0f / src_bilinear_samples);
412         set_uniform_float(glsl_program_num, prefix, "sample_x_offset", 0.5f / src_bilinear_samples);
413
414         // We specifically do not want mipmaps on the input texture;
415         // they break minification.
416         Node *self = chain->find_node_for_effect(this);
417         glActiveTexture(chain->get_input_sampler(self, 0));
418         check_error();
419         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR);
420         check_error();
421 }
422
423 }  // namespace movit