2 * Copyright 2011-2017 Blender Foundation
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 #include "device/device_denoising.h"
19 #include "kernel/filter/filter_defines.h"
23 void DenoisingTask::init_from_devicetask(const DeviceTask &task)
25 radius = task.denoising_radius;
26 nlm_k_2 = powf(2.0f, lerp(-5.0f, 3.0f, task.denoising_strength));
27 if(task.denoising_relative_pca) {
28 pca_threshold = -powf(10.0f, lerp(-8.0f, 0.0f, task.denoising_feature_strength));
31 pca_threshold = powf(10.0f, lerp(-5.0f, 3.0f, task.denoising_feature_strength));
34 render_buffer.pass_stride = task.pass_stride;
35 render_buffer.denoising_data_offset = task.pass_denoising_data;
36 render_buffer.denoising_clean_offset = task.pass_denoising_clean;
38 /* Expand filter_area by radius pixels and clamp the result to the extent of the neighboring tiles */
39 rect = make_int4(max(tiles->x[0], filter_area.x - radius),
40 max(tiles->y[0], filter_area.y - radius),
41 min(tiles->x[3], filter_area.x + filter_area.z + radius),
42 min(tiles->y[3], filter_area.y + filter_area.w + radius));
45 void DenoisingTask::tiles_from_rendertiles(RenderTile *rtiles)
47 tiles = (TilesInfo*) tiles_mem.resize(sizeof(TilesInfo)/sizeof(int));
49 device_ptr buffers[9];
50 for(int i = 0; i < 9; i++) {
51 buffers[i] = rtiles[i].buffer;
52 tiles->offsets[i] = rtiles[i].offset;
53 tiles->strides[i] = rtiles[i].stride;
55 tiles->x[0] = rtiles[3].x;
56 tiles->x[1] = rtiles[4].x;
57 tiles->x[2] = rtiles[5].x;
58 tiles->x[3] = rtiles[5].x + rtiles[5].w;
59 tiles->y[0] = rtiles[1].y;
60 tiles->y[1] = rtiles[4].y;
61 tiles->y[2] = rtiles[7].y;
62 tiles->y[3] = rtiles[7].y + rtiles[7].h;
64 render_buffer.offset = rtiles[4].offset;
65 render_buffer.stride = rtiles[4].stride;
66 render_buffer.ptr = rtiles[4].buffer;
68 functions.set_tiles(buffers);
71 bool DenoisingTask::run_denoising()
73 /* Allocate denoising buffer. */
75 buffer.w = align_up(rect.z - rect.x, 4);
76 buffer.h = rect.w - rect.y;
77 buffer.pass_stride = align_up(buffer.w * buffer.h, divide_up(device->mem_address_alignment(), sizeof(float)));
78 buffer.mem.resize(buffer.pass_stride * buffer.passes);
79 device->mem_alloc("Denoising Pixel Buffer", buffer.mem, MEM_READ_WRITE);
81 device_ptr null_ptr = (device_ptr) 0;
83 /* Prefilter shadow feature. */
85 device_sub_ptr unfiltered_a (device, buffer.mem, 0, buffer.pass_stride, MEM_READ_WRITE);
86 device_sub_ptr unfiltered_b (device, buffer.mem, 1*buffer.pass_stride, buffer.pass_stride, MEM_READ_WRITE);
87 device_sub_ptr sample_var (device, buffer.mem, 2*buffer.pass_stride, buffer.pass_stride, MEM_READ_WRITE);
88 device_sub_ptr sample_var_var (device, buffer.mem, 3*buffer.pass_stride, buffer.pass_stride, MEM_READ_WRITE);
89 device_sub_ptr buffer_var (device, buffer.mem, 5*buffer.pass_stride, buffer.pass_stride, MEM_READ_WRITE);
90 device_sub_ptr filtered_var (device, buffer.mem, 6*buffer.pass_stride, buffer.pass_stride, MEM_READ_WRITE);
91 device_sub_ptr nlm_temporary_1(device, buffer.mem, 7*buffer.pass_stride, buffer.pass_stride, MEM_READ_WRITE);
92 device_sub_ptr nlm_temporary_2(device, buffer.mem, 8*buffer.pass_stride, buffer.pass_stride, MEM_READ_WRITE);
93 device_sub_ptr nlm_temporary_3(device, buffer.mem, 9*buffer.pass_stride, buffer.pass_stride, MEM_READ_WRITE);
95 nlm_state.temporary_1_ptr = *nlm_temporary_1;
96 nlm_state.temporary_2_ptr = *nlm_temporary_2;
97 nlm_state.temporary_3_ptr = *nlm_temporary_3;
99 /* Get the A/B unfiltered passes, the combined sample variance, the estimated variance of the sample variance and the buffer variance. */
100 functions.divide_shadow(*unfiltered_a, *unfiltered_b, *sample_var, *sample_var_var, *buffer_var);
102 /* Smooth the (generally pretty noisy) buffer variance using the spatial information from the sample variance. */
103 nlm_state.set_parameters(6, 3, 4.0f, 1.0f);
104 functions.non_local_means(*buffer_var, *sample_var, *sample_var_var, *filtered_var);
106 /* Reuse memory, the previous data isn't needed anymore. */
107 device_ptr filtered_a = *buffer_var,
108 filtered_b = *sample_var;
109 /* Use the smoothed variance to filter the two shadow half images using each other for weight calculation. */
110 nlm_state.set_parameters(5, 3, 1.0f, 0.25f);
111 functions.non_local_means(*unfiltered_a, *unfiltered_b, *filtered_var, filtered_a);
112 functions.non_local_means(*unfiltered_b, *unfiltered_a, *filtered_var, filtered_b);
114 device_ptr residual_var = *sample_var_var;
115 /* Estimate the residual variance between the two filtered halves. */
116 functions.combine_halves(filtered_a, filtered_b, null_ptr, residual_var, 2, rect);
118 device_ptr final_a = *unfiltered_a,
119 final_b = *unfiltered_b;
120 /* Use the residual variance for a second filter pass. */
121 nlm_state.set_parameters(4, 2, 1.0f, 0.5f);
122 functions.non_local_means(filtered_a, filtered_b, residual_var, final_a);
123 functions.non_local_means(filtered_b, filtered_a, residual_var, final_b);
125 /* Combine the two double-filtered halves to a final shadow feature. */
126 device_sub_ptr shadow_pass(device, buffer.mem, 4*buffer.pass_stride, buffer.pass_stride, MEM_READ_WRITE);
127 functions.combine_halves(final_a, final_b, *shadow_pass, null_ptr, 0, rect);
130 /* Prefilter general features. */
132 device_sub_ptr unfiltered (device, buffer.mem, 8*buffer.pass_stride, buffer.pass_stride, MEM_READ_WRITE);
133 device_sub_ptr variance (device, buffer.mem, 9*buffer.pass_stride, buffer.pass_stride, MEM_READ_WRITE);
134 device_sub_ptr nlm_temporary_1(device, buffer.mem, 10*buffer.pass_stride, buffer.pass_stride, MEM_READ_WRITE);
135 device_sub_ptr nlm_temporary_2(device, buffer.mem, 11*buffer.pass_stride, buffer.pass_stride, MEM_READ_WRITE);
136 device_sub_ptr nlm_temporary_3(device, buffer.mem, 12*buffer.pass_stride, buffer.pass_stride, MEM_READ_WRITE);
138 nlm_state.temporary_1_ptr = *nlm_temporary_1;
139 nlm_state.temporary_2_ptr = *nlm_temporary_2;
140 nlm_state.temporary_3_ptr = *nlm_temporary_3;
142 int mean_from[] = { 0, 1, 2, 6, 7, 8, 12 };
143 int variance_from[] = { 3, 4, 5, 9, 10, 11, 13 };
144 int pass_to[] = { 1, 2, 3, 0, 5, 6, 7 };
145 for(int pass = 0; pass < 7; pass++) {
146 device_sub_ptr feature_pass(device, buffer.mem, pass_to[pass]*buffer.pass_stride, buffer.pass_stride, MEM_READ_WRITE);
147 /* Get the unfiltered pass and its variance from the RenderBuffers. */
148 functions.get_feature(mean_from[pass], variance_from[pass], *unfiltered, *variance);
149 /* Smooth the pass and store the result in the denoising buffers. */
150 nlm_state.set_parameters(2, 2, 1.0f, 0.25f);
151 functions.non_local_means(*unfiltered, *unfiltered, *variance, *feature_pass);
155 /* Copy color passes. */
157 int mean_from[] = {20, 21, 22};
158 int variance_from[] = {23, 24, 25};
159 int mean_to[] = { 8, 9, 10};
160 int variance_to[] = {11, 12, 13};
161 int num_color_passes = 3;
162 for(int pass = 0; pass < num_color_passes; pass++) {
163 device_sub_ptr color_pass (device, buffer.mem, mean_to[pass]*buffer.pass_stride, buffer.pass_stride, MEM_READ_WRITE);
164 device_sub_ptr color_var_pass(device, buffer.mem, variance_to[pass]*buffer.pass_stride, buffer.pass_stride, MEM_READ_WRITE);
165 functions.get_feature(mean_from[pass], variance_from[pass], *color_pass, *color_var_pass);
169 storage.w = filter_area.z;
170 storage.h = filter_area.w;
171 storage.transform.resize(storage.w*storage.h*TRANSFORM_SIZE);
172 storage.rank.resize(storage.w*storage.h);
173 device->mem_alloc("Denoising Transform", storage.transform, MEM_READ_WRITE);
174 device->mem_alloc("Denoising Rank", storage.rank, MEM_READ_WRITE);
176 functions.construct_transform();
178 device_only_memory<float> temporary_1;
179 device_only_memory<float> temporary_2;
180 temporary_1.resize(buffer.w*buffer.h);
181 temporary_2.resize(buffer.w*buffer.h);
182 device->mem_alloc("Denoising NLM temporary 1", temporary_1, MEM_READ_WRITE);
183 device->mem_alloc("Denoising NLM temporary 2", temporary_2, MEM_READ_WRITE);
184 reconstruction_state.temporary_1_ptr = temporary_1.device_pointer;
185 reconstruction_state.temporary_2_ptr = temporary_2.device_pointer;
187 storage.XtWX.resize(storage.w*storage.h*XTWX_SIZE);
188 storage.XtWY.resize(storage.w*storage.h*XTWY_SIZE);
189 device->mem_alloc("Denoising XtWX", storage.XtWX, MEM_READ_WRITE);
190 device->mem_alloc("Denoising XtWY", storage.XtWY, MEM_READ_WRITE);
192 reconstruction_state.filter_rect = make_int4(filter_area.x-rect.x, filter_area.y-rect.y, storage.w, storage.h);
193 int tile_coordinate_offset = filter_area.y*render_buffer.stride + filter_area.x;
194 reconstruction_state.buffer_params = make_int4(render_buffer.offset + tile_coordinate_offset,
195 render_buffer.stride,
196 render_buffer.pass_stride,
197 render_buffer.denoising_clean_offset);
198 reconstruction_state.source_w = rect.z-rect.x;
199 reconstruction_state.source_h = rect.w-rect.y;
202 device_sub_ptr color_ptr (device, buffer.mem, 8*buffer.pass_stride, 3*buffer.pass_stride, MEM_READ_WRITE);
203 device_sub_ptr color_var_ptr(device, buffer.mem, 11*buffer.pass_stride, 3*buffer.pass_stride, MEM_READ_WRITE);
204 functions.reconstruct(*color_ptr, *color_var_ptr, *color_ptr, *color_var_ptr, render_buffer.ptr);
207 device->mem_free(storage.XtWX);
208 device->mem_free(storage.XtWY);
209 device->mem_free(storage.transform);
210 device->mem_free(storage.rank);
211 device->mem_free(temporary_1);
212 device->mem_free(temporary_2);
213 device->mem_free(buffer.mem);
214 device->mem_free(tiles_mem);