Split out some private utilities into effect_util.cpp, so we do not need to include...
[movit] / deconvolution_sharpen_effect.cpp
1 // NOTE: Throughout, we use the symbol ⊙ for convolution.
2 // Since all of our signals are symmetrical, discrete correlation and convolution
3 // is the same operation, and so we won't make a difference in notation.
4
5 #include <Eigen/Dense>
6 #include <Eigen/Cholesky>
7 #include <GL/glew.h>
8 #include <assert.h>
9 #include <math.h>
10 #include <stdio.h>
11 #include <stdlib.h>
12 #include <algorithm>
13 #include <new>
14
15 #include "deconvolution_sharpen_effect.h"
16 #include "effect_util.h"
17 #include "util.h"
18
19 using namespace Eigen;
20
21 DeconvolutionSharpenEffect::DeconvolutionSharpenEffect()
22         : R(5),
23           circle_radius(2.0f),
24           gaussian_radius(0.0f),
25           correlation(0.95f),
26           noise(0.01f),
27           last_R(-1),
28           last_circle_radius(-1.0f),
29           last_gaussian_radius(-1.0f),
30           last_correlation(-1.0f),
31           last_noise(-1.0f)
32 {
33         register_int("matrix_size", &R);
34         register_float("circle_radius", &circle_radius);
35         register_float("gaussian_radius", &gaussian_radius);
36         register_float("correlation", &correlation);
37         register_float("noise", &noise);
38 }
39
40 std::string DeconvolutionSharpenEffect::output_fragment_shader()
41 {
42         char buf[256];
43         sprintf(buf, "#define R %u\n", R);
44
45         assert(R >= 1);
46         assert(R <= 25);  // Same limit as Refocus.
47
48         last_R = R;
49         return buf + read_file("deconvolution_sharpen_effect.frag");
50 }
51
52 namespace {
53
54 // Integral of sqrt(r² - x²) dx over x=0..a.
55 float circle_integral(float a, float r)
56 {
57         assert(a >= 0.0f);
58         if (a <= 0.0f) {
59                 return 0.0f;
60         }
61         if (a >= r) {
62                 return 0.25f * M_PI * r * r;
63         }
64         return 0.5f * (a * sqrt(r*r - a*a) + r*r * asin(a / r));
65 }
66
67 // Yields the impulse response of a circular blur with radius r.
68 // We basically look at each element as a square centered around (x,y),
69 // and figure out how much of its area is covered by the circle.
70 float circle_impulse_response(int x, int y, float r)
71 {
72         if (r < 1e-3) {
73                 // Degenerate case: radius = 0 yields the impulse response.
74                 return (x == 0 && y == 0) ? 1.0f : 0.0f;
75         }
76
77         // Find the extents of this cell. Due to symmetry, we can cheat a bit
78         // and pretend we're always in the upper-right quadrant, except when
79         // we're right at an axis crossing (x = 0 or y = 0), in which case we
80         // simply use the evenness of the function; shrink the cell, make
81         // the calculation, and down below we'll normalize by the cell's area.
82         float min_x, max_x, min_y, max_y;
83         if (x == 0) {
84                 min_x = 0.0f;
85                 max_x = 0.5f;
86         } else {
87                 min_x = abs(x) - 0.5f;
88                 max_x = abs(x) + 0.5f;
89         }
90         if (y == 0) {
91                 min_y = 0.0f;
92                 max_y = 0.5f;
93         } else {
94                 min_y = abs(y) - 0.5f;
95                 max_y = abs(y) + 0.5f;
96         }
97         assert(min_x >= 0.0f && max_x >= 0.0f);
98         assert(min_y >= 0.0f && max_y >= 0.0f);
99
100         float cell_height = max_y - min_y;
101         float cell_width = max_x - min_x;
102
103         if (min_x * min_x + min_y * min_y > r * r) {
104                 // Lower-left corner is outside the circle, so the entire cell is.
105                 return 0.0f;
106         }
107         if (max_x * max_x + max_y * max_y < r * r) {
108                 // Upper-right corner is inside the circle, so the entire cell is.
109                 return 1.0f;
110         }
111
112         // OK, so now we know the cell is partially covered by the circle:
113         //
114         //      \           .
115         //  -------------
116         // |####|#\      |
117         // |####|##|     |
118         //  -------------
119         //   A   ###|
120         //       ###|
121         //
122         // The edge of the circle is defined by x² + y² = r², 
123         // or x = sqrt(r² - y²) (since x is nonnegative).
124         // Find out where the curve crosses our given y values.
125         float mid_x1 = (max_y >= r) ? min_x : sqrt(r * r - max_y * max_y);
126         float mid_x2 = sqrt(r * r - min_y * min_y);
127         if (mid_x1 < min_x) {
128                 mid_x1 = min_x;
129         }
130         if (mid_x2 > max_x) {
131                 mid_x2 = max_x;
132         }
133         assert(mid_x1 >= min_x);
134         assert(mid_x2 >= mid_x1);
135         assert(max_x >= mid_x2);
136
137         // The area marked A in the figure above.
138         float covered_area = cell_height * (mid_x1 - min_x);
139
140         // The area marked B in the figure above. Note that the integral gives the entire
141         // shaded space down to zero, so we need to subtract the rectangle that does not
142         // belong to our cell.
143         covered_area += circle_integral(mid_x2, r) - circle_integral(mid_x1, r);
144         covered_area -= min_y * (mid_x2 - mid_x1);
145
146         assert(covered_area <= cell_width * cell_height);
147         return covered_area / (cell_width * cell_height);
148 }
149
150 // Compute a ⊙ b. Note that we compute the “full” convolution,
151 // ie., our matrix will be big enough to hold every nonzero element of the result.
152 MatrixXf convolve(const MatrixXf &a, const MatrixXf &b)
153 {
154         MatrixXf result(a.rows() + b.rows() - 1, a.cols() + b.cols() - 1);
155         for (int yr = 0; yr < result.rows(); ++yr) {
156                 for (int xr = 0; xr < result.cols(); ++xr) {
157                         float sum = 0.0f;
158
159                         // Given that x_b = x_r - x_a, find the values of x_a where
160                         // x_a is in [0, a_cols> and x_b is in [0, b_cols>. (y is similar.)
161                         //
162                         // The second demand gives:
163                         //
164                         //   0 <= x_r - x_a < b_cols
165                         //   0 >= x_a - x_r > -b_cols
166                         //   x_r >= x_a > x_r - b_cols
167                         int ya_min = yr - b.rows() + 1;
168                         int ya_max = yr;
169                         int xa_min = xr - b.rows() + 1;
170                         int xa_max = xr;
171
172                         // Now fit to the first demand.
173                         ya_min = std::max<int>(ya_min, 0);
174                         ya_max = std::min<int>(ya_max, a.rows() - 1);
175                         xa_min = std::max<int>(xa_min, 0);
176                         xa_max = std::min<int>(xa_max, a.cols() - 1);
177
178                         assert(ya_max >= ya_min);
179                         assert(xa_max >= xa_min);
180
181                         for (int ya = ya_min; ya <= ya_max; ++ya) {
182                                 for (int xa = xa_min; xa <= xa_max; ++xa) {
183                                         sum += a(ya, xa) * b(yr - ya, xr - xa);
184                                 }
185                         }
186
187                         result(yr, xr) = sum;
188                 }
189         }
190         return result;
191 }
192
193 // Similar to convolve(), but instead of assuming every element outside
194 // of b is zero, we make no such assumption and instead return only the
195 // elements where we know the right answer. (This is the only difference
196 // between the two.)
197 // This is the same as conv2(a, b, 'valid') in Octave.
198 //
199 // a must be the larger matrix of the two.
200 MatrixXf central_convolve(const MatrixXf &a, const MatrixXf &b)
201 {
202         assert(a.rows() >= b.rows());
203         assert(a.cols() >= b.cols());
204         MatrixXf result(a.rows() - b.rows() + 1, a.cols() - b.cols() + 1);
205         for (int yr = b.rows() - 1; yr < result.rows() + b.rows() - 1; ++yr) {
206                 for (int xr = b.cols() - 1; xr < result.cols() + b.cols() - 1; ++xr) {
207                         float sum = 0.0f;
208
209                         // Given that x_b = x_r - x_a, find the values of x_a where
210                         // x_a is in [0, a_cols> and x_b is in [0, b_cols>. (y is similar.)
211                         //
212                         // The second demand gives:
213                         //
214                         //   0 <= x_r - x_a < b_cols
215                         //   0 >= x_a - x_r > -b_cols
216                         //   x_r >= x_a > x_r - b_cols
217                         int ya_min = yr - b.rows() + 1;
218                         int ya_max = yr;
219                         int xa_min = xr - b.rows() + 1;
220                         int xa_max = xr;
221
222                         // Now fit to the first demand.
223                         ya_min = std::max<int>(ya_min, 0);
224                         ya_max = std::min<int>(ya_max, a.rows() - 1);
225                         xa_min = std::max<int>(xa_min, 0);
226                         xa_max = std::min<int>(xa_max, a.cols() - 1);
227
228                         assert(ya_max >= ya_min);
229                         assert(xa_max >= xa_min);
230
231                         for (int ya = ya_min; ya <= ya_max; ++ya) {
232                                 for (int xa = xa_min; xa <= xa_max; ++xa) {
233                                         sum += a(ya, xa) * b(yr - ya, xr - xa);
234                                 }
235                         }
236
237                         result(yr - b.rows() + 1, xr - b.cols() + 1) = sum;
238                 }
239         }
240         return result;
241 }
242
243 void print_matrix(const MatrixXf &m)
244 {
245         for (int y = 0; y < m.rows(); ++y) {
246                 for (int x = 0; x < m.cols(); ++x) {
247                         printf("%7.4f ", m(x, y));
248                 }
249                 printf("\n");
250         }
251 }
252
253 }  // namespace
254
255 void DeconvolutionSharpenEffect::update_deconvolution_kernel()
256 {
257         // Figure out the impulse response for the circular part of the blur.
258         MatrixXf circ_h(2 * R + 1, 2 * R + 1);
259         for (int y = -R; y <= R; ++y) { 
260                 for (int x = -R; x <= R; ++x) {
261                         circ_h(y + R, x + R) = circle_impulse_response(x, y, circle_radius);
262                 }
263         }
264
265         // Same, for the Gaussian part of the blur. We make this a lot larger
266         // since we're going to convolve with it soon, and it has infinite support
267         // (see comments for central_convolve()).
268         MatrixXf gaussian_h(4 * R + 1, 4 * R + 1);
269         for (int y = -2 * R; y <= 2 * R; ++y) { 
270                 for (int x = -2 * R; x <= 2 * R; ++x) {
271                         float val;
272                         if (gaussian_radius < 1e-3) {
273                                 val = (x == 0 && y == 0) ? 1.0f : 0.0f;
274                         } else {
275                                 val = exp(-(x*x + y*y) / (2.0 * gaussian_radius * gaussian_radius));
276                         }
277                         gaussian_h(y + 2 * R, x + 2 * R) = val;
278                 }
279         }
280
281         // h, the (assumed) impulse response that we're trying to invert.
282         MatrixXf h = central_convolve(gaussian_h, circ_h);
283         assert(h.rows() == 2 * R + 1);
284         assert(h.cols() == 2 * R + 1);
285
286         // Normalize the impulse response.
287         float sum = 0.0f;
288         for (int y = 0; y < 2 * R + 1; ++y) {
289                 for (int x = 0; x < 2 * R + 1; ++x) {
290                         sum += h(y, x);
291                 }
292         }
293         for (int y = 0; y < 2 * R + 1; ++y) {
294                 for (int x = 0; x < 2 * R + 1; ++x) {
295                         h(y, x) /= sum;
296                 }
297         }
298
299         // r_uu, the (estimated/assumed) autocorrelation of the input signal (u).
300         // The signal is modelled a standard autoregressive process with the
301         // given correlation coefficient.
302         //
303         // We have to take a bit of care with the size of this matrix.
304         // The pow() function naturally has an infinite support (except for the
305         // degenerate case of correlation=0), but we have to chop it off
306         // somewhere. Since we convolve it with a 4*R+1 large matrix below,
307         // we need to make it twice as big as that, so that we have enough
308         // data to make r_vv valid. (central_convolve() effectively enforces
309         // that we get at least the right size.)
310         MatrixXf r_uu(8 * R + 1, 8 * R + 1);
311         for (int y = -4 * R; y <= 4 * R; ++y) { 
312                 for (int x = -4 * R; x <= 4 * R; ++x) {
313                         r_uu(x + 4 * R, y + 4 * R) = pow(correlation, hypot(x, y));
314                 }
315         }
316
317         // Estimate r_vv, the autocorrelation of the output signal v.
318         // Since we know that v = h ⊙ u and both are symmetrical,
319         // convolution and correlation are the same, and
320         // r_vv = v ⊙ v = (h ⊙ u) ⊙ (h ⊙ u) = (h ⊙ h) ⊙ r_uu.
321         MatrixXf r_vv = central_convolve(r_uu, convolve(h, h));
322         assert(r_vv.rows() == 4 * R + 1);
323         assert(r_vv.cols() == 4 * R + 1);
324
325         // Similarly, r_uv = u ⊙ v = u ⊙ (h ⊙ u) = h ⊙ r_uu.
326         MatrixXf r_uu_center = r_uu.block(2 * R, 2 * R, 4 * R + 1, 4 * R + 1);
327         MatrixXf r_uv = central_convolve(r_uu_center, h);
328         assert(r_uv.rows() == 2 * R + 1);
329         assert(r_uv.cols() == 2 * R + 1);
330         
331         // Add the noise term (we assume the noise is uncorrelated,
332         // so it only affects the central element).
333         r_vv(2 * R, 2 * R) += noise;
334
335         // Now solve the Wiener-Hopf equations to find the deconvolution kernel g.
336         // Most texts show this only for the simpler 1D case:
337         //
338         // [ r_vv(0)  r_vv(1) r_vv(2) ... ] [ g(0) ]   [ r_uv(0) ]
339         // [ r_vv(-1) r_vv(0) ...         ] [ g(1) ] = [ r_uv(1) ]
340         // [ r_vv(-2) ...                 ] [ g(2) ]   [ r_uv(2) ]
341         // [ ...                          ] [ g(3) ]   [ r_uv(3) ]
342         //
343         // (Since r_vv is symmetrical, we can drop the minus signs.)
344         //
345         // Generally, row i of the matrix contains (dropping _vv for brevity):
346         //
347         // [ r(0-i) r(1-i) r(2-i) ... ]
348         //
349         // However, we have the 2D case. We flatten the vectors out to
350         // 1D quantities; this means we must think of the row number
351         // as a pair instead of as a scalar. Row (i,j) then contains:
352         //
353         // [ r(0-i,0-j) r(1-i,0-j) r(2-i,0-j) ... r(0-i,1-j) r_(1-i,1-j) r(2-i,1-j) ... ]
354         //
355         // g and r_uv are flattened in the same fashion.
356         //
357         // Note that even though this matrix is block Toeplitz, it is _not_ Toeplitz,
358         // and thus can not be inverted through the standard Levinson-Durbin method.
359         // There exists a block Levinson-Durbin method, which we may or may not
360         // want to use later. (Eigen's solvers are fast enough that for big matrices,
361         // the convolution operation and not the matrix solving is the bottleneck.)
362         //
363         // One thing we definitely want to use, though, is the symmetry properties.
364         // Since we know that g(i, j) = g(|i|, |j|), we can reduce the amount of
365         // unknowns to about 1/4th of the total size. The method is quite simple,
366         // as can be seen from the following toy equation system:
367         //
368         //   A x0 + B x1 + C x2 = y0
369         //   D x0 + E x1 + F x2 = y1
370         //   G x0 + H x1 + I x2 = y2
371         //
372         // If we now know that e.g. x0=x1 and y0=y1, we can rewrite this to
373         //
374         //   (A+B+D+E) x0 + (C+F) x2 = 2 y0
375         //   (G+H)     x0 + I x2     = y2
376         //
377         // This both increases accuracy and provides us with a very nice speed
378         // boost.
379         MatrixXf M(MatrixXf::Zero((R + 1) * (R + 1), (R + 1) * (R + 1)));
380         MatrixXf r_uv_flattened(MatrixXf::Zero((R + 1) * (R + 1), 1));
381         for (int outer_i = 0; outer_i < 2 * R + 1; ++outer_i) {
382                 int folded_outer_i = abs(outer_i - R);
383                 for (int outer_j = 0; outer_j < 2 * R + 1; ++outer_j) {
384                         int folded_outer_j = abs(outer_j - R);
385                         int row = folded_outer_i * (R + 1) + folded_outer_j;
386                         for (int inner_i = 0; inner_i < 2 * R + 1; ++inner_i) {
387                                 int folded_inner_i = abs(inner_i - R);
388                                 for (int inner_j = 0; inner_j < 2 * R + 1; ++inner_j) {
389                                         int folded_inner_j = abs(inner_j - R);
390                                         int col = folded_inner_i * (R + 1) + folded_inner_j;
391                                         M(row, col) += r_vv((inner_i - R) - (outer_i - R) + 2 * R,
392                                                             (inner_j - R) - (outer_j - R) + 2 * R);
393                                 }
394                         }
395                         r_uv_flattened(row) += r_uv(outer_i, outer_j);
396                 }
397         }
398
399         LLT<MatrixXf> llt(M);
400         MatrixXf g_flattened = llt.solve(r_uv_flattened);
401         assert(g_flattened.rows() == (R + 1) * (R + 1)),
402         assert(g_flattened.cols() == 1);
403
404         // Normalize and de-flatten the deconvolution matrix.
405         g = MatrixXf(R + 1, R + 1);
406         sum = 0.0f;
407         for (int i = 0; i < g_flattened.rows(); ++i) {
408                 int y = i / (R + 1);
409                 int x = i % (R + 1);
410                 if (y == 0 && x == 0) {
411                         sum += g_flattened(i);
412                 } else if (y == 0 || x == 0) {
413                         sum += 2.0f * g_flattened(i);
414                 } else {
415                         sum += 4.0f * g_flattened(i);
416                 }
417         }
418         for (int i = 0; i < g_flattened.rows(); ++i) {
419                 int y = i / (R + 1);
420                 int x = i % (R + 1);
421                 g(y, x) = g_flattened(i) / sum;
422         }
423
424         last_circle_radius = circle_radius;
425         last_gaussian_radius = gaussian_radius;
426         last_correlation = correlation;
427         last_noise = noise;
428 }
429
430 void DeconvolutionSharpenEffect::set_gl_state(GLuint glsl_program_num, const std::string &prefix, unsigned *sampler_num)
431 {
432         Effect::set_gl_state(glsl_program_num, prefix, sampler_num);
433
434         assert(R == last_R);
435
436         if (fabs(circle_radius - last_circle_radius) > 1e-3 ||
437             fabs(gaussian_radius - last_gaussian_radius) > 1e-3 ||
438             fabs(correlation - last_correlation) > 1e-3 ||
439             fabs(noise - last_noise) > 1e-3) {
440                 update_deconvolution_kernel();
441         }
442         // Now encode it as uniforms, and pass it on to the shader.
443         float samples[4 * (R + 1) * (R + 1)];
444         for (int y = 0; y <= R; ++y) {
445                 for (int x = 0; x <= R; ++x) {
446                         int i = y * (R + 1) + x;
447                         samples[i * 4 + 0] = x / float(width);
448                         samples[i * 4 + 1] = y / float(height);
449                         samples[i * 4 + 2] = g(y, x);
450                         samples[i * 4 + 3] = 0.0f;
451                 }
452         }
453
454         set_uniform_vec4_array(glsl_program_num, prefix, "samples", samples, (R + 1) * (R + 1));
455 }