ClangFormat: apply to source, most of intern
[blender.git] / intern / cycles / device / device_denoising.cpp
1 /*
2  * Copyright 2011-2017 Blender Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #include "device/device_denoising.h"
18
19 #include "kernel/filter/filter_defines.h"
20
21 CCL_NAMESPACE_BEGIN
22
23 DenoisingTask::DenoisingTask(Device *device, const DeviceTask &task)
24     : tile_info_mem(device, "denoising tile info mem", MEM_READ_WRITE),
25       profiler(NULL),
26       storage(device),
27       buffer(device),
28       device(device)
29 {
30   radius = task.denoising.radius;
31   nlm_k_2 = powf(2.0f, lerp(-5.0f, 3.0f, task.denoising.strength));
32   if (task.denoising.relative_pca) {
33     pca_threshold = -powf(10.0f, lerp(-8.0f, 0.0f, task.denoising.feature_strength));
34   }
35   else {
36     pca_threshold = powf(10.0f, lerp(-5.0f, 3.0f, task.denoising.feature_strength));
37   }
38
39   render_buffer.frame_stride = task.frame_stride;
40   render_buffer.pass_stride = task.pass_stride;
41   render_buffer.offset = task.pass_denoising_data;
42
43   target_buffer.pass_stride = task.target_pass_stride;
44   target_buffer.denoising_clean_offset = task.pass_denoising_clean;
45   target_buffer.offset = 0;
46
47   functions.map_neighbor_tiles = function_bind(task.map_neighbor_tiles, _1, device);
48   functions.unmap_neighbor_tiles = function_bind(task.unmap_neighbor_tiles, _1, device);
49
50   tile_info = (TileInfo *)tile_info_mem.alloc(sizeof(TileInfo) / sizeof(int));
51   tile_info->from_render = task.denoising_from_render ? 1 : 0;
52
53   tile_info->frames[0] = 0;
54   tile_info->num_frames = min(task.denoising_frames.size() + 1, DENOISE_MAX_FRAMES);
55   for (int i = 1; i < tile_info->num_frames; i++) {
56     tile_info->frames[i] = task.denoising_frames[i - 1];
57   }
58
59   write_passes = task.denoising_write_passes;
60   do_filter = task.denoising_do_filter;
61 }
62
63 DenoisingTask::~DenoisingTask()
64 {
65   storage.XtWX.free();
66   storage.XtWY.free();
67   storage.transform.free();
68   storage.rank.free();
69   buffer.mem.free();
70   buffer.temporary_mem.free();
71   tile_info_mem.free();
72 }
73
74 void DenoisingTask::set_render_buffer(RenderTile *rtiles)
75 {
76   for (int i = 0; i < 9; i++) {
77     tile_info->offsets[i] = rtiles[i].offset;
78     tile_info->strides[i] = rtiles[i].stride;
79     tile_info->buffers[i] = rtiles[i].buffer;
80   }
81   tile_info->x[0] = rtiles[3].x;
82   tile_info->x[1] = rtiles[4].x;
83   tile_info->x[2] = rtiles[5].x;
84   tile_info->x[3] = rtiles[5].x + rtiles[5].w;
85   tile_info->y[0] = rtiles[1].y;
86   tile_info->y[1] = rtiles[4].y;
87   tile_info->y[2] = rtiles[7].y;
88   tile_info->y[3] = rtiles[7].y + rtiles[7].h;
89
90   target_buffer.offset = rtiles[9].offset;
91   target_buffer.stride = rtiles[9].stride;
92   target_buffer.ptr = rtiles[9].buffer;
93
94   if (write_passes && rtiles[9].buffers) {
95     target_buffer.denoising_output_offset =
96         rtiles[9].buffers->params.get_denoising_prefiltered_offset();
97   }
98   else {
99     target_buffer.denoising_output_offset = 0;
100   }
101
102   tile_info_mem.copy_to_device();
103 }
104
105 void DenoisingTask::setup_denoising_buffer()
106 {
107   /* Expand filter_area by radius pixels and clamp the result to the extent of the neighboring tiles */
108   rect = rect_from_shape(filter_area.x, filter_area.y, filter_area.z, filter_area.w);
109   rect = rect_expand(rect, radius);
110   rect = rect_clip(rect,
111                    make_int4(tile_info->x[0], tile_info->y[0], tile_info->x[3], tile_info->y[3]));
112
113   buffer.use_intensity = write_passes || (tile_info->num_frames > 1);
114   buffer.passes = buffer.use_intensity ? 15 : 14;
115   buffer.width = rect.z - rect.x;
116   buffer.stride = align_up(buffer.width, 4);
117   buffer.h = rect.w - rect.y;
118   int alignment_floats = divide_up(device->mem_sub_ptr_alignment(), sizeof(float));
119   buffer.pass_stride = align_up(buffer.stride * buffer.h, alignment_floats);
120   buffer.frame_stride = buffer.pass_stride * buffer.passes;
121   /* Pad the total size by four floats since the SIMD kernels might go a bit over the end. */
122   int mem_size = align_up(tile_info->num_frames * buffer.frame_stride + 4, alignment_floats);
123   buffer.mem.alloc_to_device(mem_size, false);
124   buffer.use_time = (tile_info->num_frames > 1);
125
126   /* CPUs process shifts sequentially while GPUs process them in parallel. */
127   int num_layers;
128   if (buffer.gpu_temporary_mem) {
129     /* Shadowing prefiltering uses a radius of 6, so allocate at least that much. */
130     int max_radius = max(radius, 6);
131     int num_shifts = (2 * max_radius + 1) * (2 * max_radius + 1);
132     num_layers = 2 * num_shifts + 1;
133   }
134   else {
135     num_layers = 3;
136   }
137   /* Allocate two layers per shift as well as one for the weight accumulation. */
138   buffer.temporary_mem.alloc_to_device(num_layers * buffer.pass_stride);
139 }
140
141 void DenoisingTask::prefilter_shadowing()
142 {
143   device_ptr null_ptr = (device_ptr)0;
144
145   device_sub_ptr unfiltered_a(buffer.mem, 0, buffer.pass_stride);
146   device_sub_ptr unfiltered_b(buffer.mem, 1 * buffer.pass_stride, buffer.pass_stride);
147   device_sub_ptr sample_var(buffer.mem, 2 * buffer.pass_stride, buffer.pass_stride);
148   device_sub_ptr sample_var_var(buffer.mem, 3 * buffer.pass_stride, buffer.pass_stride);
149   device_sub_ptr buffer_var(buffer.mem, 5 * buffer.pass_stride, buffer.pass_stride);
150   device_sub_ptr filtered_var(buffer.mem, 6 * buffer.pass_stride, buffer.pass_stride);
151
152   /* Get the A/B unfiltered passes, the combined sample variance, the estimated variance of the sample variance and the buffer variance. */
153   functions.divide_shadow(*unfiltered_a, *unfiltered_b, *sample_var, *sample_var_var, *buffer_var);
154
155   /* Smooth the (generally pretty noisy) buffer variance using the spatial information from the sample variance. */
156   nlm_state.set_parameters(6, 3, 4.0f, 1.0f, false);
157   functions.non_local_means(*buffer_var, *sample_var, *sample_var_var, *filtered_var);
158
159   /* Reuse memory, the previous data isn't needed anymore. */
160   device_ptr filtered_a = *buffer_var, filtered_b = *sample_var;
161   /* Use the smoothed variance to filter the two shadow half images using each other for weight calculation. */
162   nlm_state.set_parameters(5, 3, 1.0f, 0.25f, false);
163   functions.non_local_means(*unfiltered_a, *unfiltered_b, *filtered_var, filtered_a);
164   functions.non_local_means(*unfiltered_b, *unfiltered_a, *filtered_var, filtered_b);
165
166   device_ptr residual_var = *sample_var_var;
167   /* Estimate the residual variance between the two filtered halves. */
168   functions.combine_halves(filtered_a, filtered_b, null_ptr, residual_var, 2, rect);
169
170   device_ptr final_a = *unfiltered_a, final_b = *unfiltered_b;
171   /* Use the residual variance for a second filter pass. */
172   nlm_state.set_parameters(4, 2, 1.0f, 0.5f, false);
173   functions.non_local_means(filtered_a, filtered_b, residual_var, final_a);
174   functions.non_local_means(filtered_b, filtered_a, residual_var, final_b);
175
176   /* Combine the two double-filtered halves to a final shadow feature. */
177   device_sub_ptr shadow_pass(buffer.mem, 4 * buffer.pass_stride, buffer.pass_stride);
178   functions.combine_halves(final_a, final_b, *shadow_pass, null_ptr, 0, rect);
179 }
180
181 void DenoisingTask::prefilter_features()
182 {
183   device_sub_ptr unfiltered(buffer.mem, 8 * buffer.pass_stride, buffer.pass_stride);
184   device_sub_ptr variance(buffer.mem, 9 * buffer.pass_stride, buffer.pass_stride);
185
186   int mean_from[] = {0, 1, 2, 12, 6, 7, 8};
187   int variance_from[] = {3, 4, 5, 13, 9, 10, 11};
188   int pass_to[] = {1, 2, 3, 0, 5, 6, 7};
189   for (int pass = 0; pass < 7; pass++) {
190     device_sub_ptr feature_pass(
191         buffer.mem, pass_to[pass] * buffer.pass_stride, buffer.pass_stride);
192     /* Get the unfiltered pass and its variance from the RenderBuffers. */
193     functions.get_feature(mean_from[pass],
194                           variance_from[pass],
195                           *unfiltered,
196                           *variance,
197                           1.0f / render_buffer.samples);
198     /* Smooth the pass and store the result in the denoising buffers. */
199     nlm_state.set_parameters(2, 2, 1.0f, 0.25f, false);
200     functions.non_local_means(*unfiltered, *unfiltered, *variance, *feature_pass);
201   }
202 }
203
204 void DenoisingTask::prefilter_color()
205 {
206   int mean_from[] = {20, 21, 22};
207   int variance_from[] = {23, 24, 25};
208   int mean_to[] = {8, 9, 10};
209   int variance_to[] = {11, 12, 13};
210   int num_color_passes = 3;
211
212   device_only_memory<float> temporary_color(device, "denoising temporary color");
213   temporary_color.alloc_to_device(3 * buffer.pass_stride, false);
214
215   for (int pass = 0; pass < num_color_passes; pass++) {
216     device_sub_ptr color_pass(temporary_color, pass * buffer.pass_stride, buffer.pass_stride);
217     device_sub_ptr color_var_pass(
218         buffer.mem, variance_to[pass] * buffer.pass_stride, buffer.pass_stride);
219     functions.get_feature(mean_from[pass],
220                           variance_from[pass],
221                           *color_pass,
222                           *color_var_pass,
223                           1.0f / render_buffer.samples);
224   }
225
226   device_sub_ptr depth_pass(buffer.mem, 0, buffer.pass_stride);
227   device_sub_ptr color_var_pass(
228       buffer.mem, variance_to[0] * buffer.pass_stride, 3 * buffer.pass_stride);
229   device_sub_ptr output_pass(buffer.mem, mean_to[0] * buffer.pass_stride, 3 * buffer.pass_stride);
230   functions.detect_outliers(
231       temporary_color.device_pointer, *color_var_pass, *depth_pass, *output_pass);
232
233   if (buffer.use_intensity) {
234     device_sub_ptr intensity_pass(buffer.mem, 14 * buffer.pass_stride, buffer.pass_stride);
235     nlm_state.set_parameters(radius, 4, 2.0f, nlm_k_2 * 4.0f, true);
236     functions.non_local_means(*output_pass, *output_pass, *color_var_pass, *intensity_pass);
237   }
238 }
239
240 void DenoisingTask::load_buffer()
241 {
242   device_ptr null_ptr = (device_ptr)0;
243
244   int original_offset = render_buffer.offset;
245
246   int num_passes = buffer.use_intensity ? 15 : 14;
247   for (int i = 0; i < tile_info->num_frames; i++) {
248     for (int pass = 0; pass < num_passes; pass++) {
249       device_sub_ptr to_pass(
250           buffer.mem, i * buffer.frame_stride + pass * buffer.pass_stride, buffer.pass_stride);
251       bool is_variance = (pass >= 11) && (pass <= 13);
252       functions.get_feature(
253           pass, -1, *to_pass, null_ptr, is_variance ? (1.0f / render_buffer.samples) : 1.0f);
254     }
255     render_buffer.offset += render_buffer.frame_stride;
256   }
257
258   render_buffer.offset = original_offset;
259 }
260
261 void DenoisingTask::write_buffer()
262 {
263   reconstruction_state.buffer_params = make_int4(target_buffer.offset,
264                                                  target_buffer.stride,
265                                                  target_buffer.pass_stride,
266                                                  target_buffer.denoising_clean_offset);
267   int num_passes = buffer.use_intensity ? 15 : 14;
268   for (int pass = 0; pass < num_passes; pass++) {
269     device_sub_ptr from_pass(buffer.mem, pass * buffer.pass_stride, buffer.pass_stride);
270     int out_offset = pass + target_buffer.denoising_output_offset;
271     functions.write_feature(out_offset, *from_pass, target_buffer.ptr);
272   }
273 }
274
275 void DenoisingTask::construct_transform()
276 {
277   storage.w = filter_area.z;
278   storage.h = filter_area.w;
279
280   storage.transform.alloc_to_device(storage.w * storage.h * TRANSFORM_SIZE, false);
281   storage.rank.alloc_to_device(storage.w * storage.h, false);
282
283   functions.construct_transform();
284 }
285
286 void DenoisingTask::reconstruct()
287 {
288   storage.XtWX.alloc_to_device(storage.w * storage.h * XTWX_SIZE, false);
289   storage.XtWY.alloc_to_device(storage.w * storage.h * XTWY_SIZE, false);
290   storage.XtWX.zero_to_device();
291   storage.XtWY.zero_to_device();
292
293   reconstruction_state.filter_window = rect_from_shape(
294       filter_area.x - rect.x, filter_area.y - rect.y, storage.w, storage.h);
295   int tile_coordinate_offset = filter_area.y * target_buffer.stride + filter_area.x;
296   reconstruction_state.buffer_params = make_int4(target_buffer.offset + tile_coordinate_offset,
297                                                  target_buffer.stride,
298                                                  target_buffer.pass_stride,
299                                                  target_buffer.denoising_clean_offset);
300   reconstruction_state.source_w = rect.z - rect.x;
301   reconstruction_state.source_h = rect.w - rect.y;
302
303   device_sub_ptr color_ptr(buffer.mem, 8 * buffer.pass_stride, 3 * buffer.pass_stride);
304   device_sub_ptr color_var_ptr(buffer.mem, 11 * buffer.pass_stride, 3 * buffer.pass_stride);
305   for (int f = 0; f < tile_info->num_frames; f++) {
306     device_ptr scale_ptr = 0;
307     device_sub_ptr *scale_sub_ptr = NULL;
308     if (tile_info->frames[f] != 0 && (tile_info->num_frames > 1)) {
309       scale_sub_ptr = new device_sub_ptr(buffer.mem, 14 * buffer.pass_stride, buffer.pass_stride);
310       scale_ptr = **scale_sub_ptr;
311     }
312
313     functions.accumulate(*color_ptr, *color_var_ptr, scale_ptr, f);
314     delete scale_sub_ptr;
315   }
316   functions.solve(target_buffer.ptr);
317 }
318
319 void DenoisingTask::run_denoising(RenderTile *tile)
320 {
321   RenderTile rtiles[10];
322   rtiles[4] = *tile;
323   functions.map_neighbor_tiles(rtiles);
324   set_render_buffer(rtiles);
325
326   setup_denoising_buffer();
327
328   if (tile_info->from_render) {
329     prefilter_shadowing();
330     prefilter_features();
331     prefilter_color();
332   }
333   else {
334     load_buffer();
335   }
336
337   if (do_filter) {
338     construct_transform();
339     reconstruct();
340   }
341
342   if (write_passes) {
343     write_buffer();
344   }
345
346   functions.unmap_neighbor_tiles(rtiles);
347 }
348
349 CCL_NAMESPACE_END