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