File: DenoiseFrameOp.cpp

package info (click to toggle)
ospray 3.2.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 10,048 kB
  • sloc: cpp: 80,569; ansic: 951; sh: 805; makefile: 170; python: 69
file content (518 lines) | stat: -rw-r--r-- 13,869 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
// Copyright 2009 Intel Corporation
// SPDX-License-Identifier: Apache-2.0

#include "DenoiseFrameOp.h"
#include "common/DeviceRT.h"
#include "fb/FrameBufferView.h"

namespace ospray {

// error callback
void checkError(void * /*userPtr*/, oidn::Error error, const char *errorMessage)
{
  if (error != oidn::Error::None && error != oidn::Error::Cancelled) {
    throw std::runtime_error(
        "Error running OIDN: " + std::string(errorMessage));
  }
}

void checkError(oidn::DeviceRef &oidnDevice)
{
  const char *errorMessage = nullptr;
  auto error = oidnDevice.getError(errorMessage);
  checkError(nullptr, error, errorMessage);
}

struct OSPRAY_MODULE_DENOISER_EXPORT LiveDenoiseFrameOp
    : public LiveFrameOpInterface
{
  LiveDenoiseFrameOp(DenoiseFrameOp *denoiser, FrameBufferView &fbView)
      : denoiser(denoiser),
        fbView(fbView),
        filter(denoiser->oidnDevice.newFilter("RT"))
  {
    filter.set("hdr", true);
  }

 protected:
  void updateFilters();
  virtual void initFilterAlphaImages() = 0;
  virtual void initFilterAuxImages() = 0;
  virtual void updateFilterInput() = 0;
  virtual void updateAuxImages(oidn::FilterRef &) = 0;

  Ref<DenoiseFrameOp> denoiser;
  FrameBufferView fbView;
  oidn::FilterRef filter;
  oidn::FilterRef filterAlpha;
  oidn::FilterRef filterAlbedo;
  oidn::FilterRef filterNormal;
  bool prefilter{false};
};

void LiveDenoiseFrameOp::updateFilters()
{
  prefilter = denoiser->quality == OIDN_QUALITY_HIGH;

  if (prefilter) {
    if (fbView.normalBuffer && !filterNormal) {
      filterNormal = denoiser->oidnDevice.newFilter("RT");
      filterNormal.set("quality", OIDN_QUALITY_HIGH);
    }
    if (fbView.albedoBuffer && !filterAlbedo) {
      filterAlbedo = denoiser->oidnDevice.newFilter("RT");
      filterAlbedo.set("quality", OIDN_QUALITY_HIGH);
    }

    initFilterAuxImages();

    if (fbView.normalBuffer)
      filterNormal.commit();
    if (fbView.albedoBuffer)
      filterAlbedo.commit();
  }

  filter.set("quality", denoiser->quality);
  filter.set("cleanAux", prefilter);
  updateFilterInput();
  updateAuxImages(filter);

  if (denoiser->denoiseAlpha) {
    if (!filterAlpha) {
      filterAlpha = denoiser->oidnDevice.newFilter("RT");
      filterAlpha.set("hdr", false);
      initFilterAlphaImages();
    }

    filterAlpha.set("quality", denoiser->quality);
    filterAlpha.set("cleanAux", prefilter);
    updateAuxImages(filterAlpha);
  }

  filter.commit();
  if (denoiser->denoiseAlpha)
    filterAlpha.commit();
}

struct OSPRAY_MODULE_DENOISER_EXPORT LiveDenoiseFrameOpShared
    : public LiveDenoiseFrameOp
{
  LiveDenoiseFrameOpShared(DenoiseFrameOp *, FrameBufferView &);

 protected:
  // when alpha is not denoised we copy input buffer to output and then do
  // in-place denoising to preserve alpha
  oidn::BufferRef bufferOut; // shared buffer aliasing colorBufferOutput

 private:
  void initFilterAlphaImages() override;
  void initFilterAuxImages() override;
  void updateFilterInput() override;
  void updateAuxImages(oidn::FilterRef &) override;

  oidn::BufferRef bufferAux; // scratch buffer when prefiltering
  size_t byteAlbedoOffset;
};

LiveDenoiseFrameOpShared::LiveDenoiseFrameOpShared(
    DenoiseFrameOp *denoiser, FrameBufferView &fbView)
    : LiveDenoiseFrameOp(denoiser, fbView),
      bufferOut(denoiser->oidnDevice.newBuffer(fbView.colorBufferOutput,
          fbView.viewDims.long_product() * sizeof(vec4f)))
{
  filter.setImage("output",
      bufferOut,
      oidn::Format::Float3,
      fbView.viewDims.x,
      fbView.viewDims.y,
      0,
      4 * sizeof(float));

  updateFilters();
}

void LiveDenoiseFrameOpShared::initFilterAlphaImages()
{
  filterAlpha.setImage("color",
      const_cast<vec4f *>(fbView.colorBufferInput),
      oidn::Format::Float,
      fbView.viewDims.x,
      fbView.viewDims.y,
      3 * sizeof(float),
      4 * sizeof(float));
  filterAlpha.setImage("output",
      bufferOut,
      oidn::Format::Float,
      fbView.viewDims.x,
      fbView.viewDims.y,
      3 * sizeof(float),
      4 * sizeof(float));
}

void LiveDenoiseFrameOpShared::initFilterAuxImages()
{
  if (!bufferAux) {
    const size_t byteBufferSize = 3 * sizeof(float) * fbView.fbDims.product();
    size_t sz = 0;
    if (fbView.normalBuffer)
      sz += byteBufferSize;
    if (fbView.albedoBuffer) {
      byteAlbedoOffset = sz;
      sz += byteBufferSize;
    }
    bufferAux = denoiser->oidnDevice.newBuffer(sz, oidn::Storage::Device);
  }

  if (fbView.normalBuffer) {
    filterNormal.setImage("normal",
        const_cast<vec3f *>(fbView.normalBuffer),
        oidn::Format::Float3,
        fbView.fbDims.x,
        fbView.fbDims.y);
    filterNormal.setImage("output",
        bufferAux,
        oidn::Format::Float3,
        fbView.fbDims.x,
        fbView.fbDims.y);
  }
  if (fbView.albedoBuffer) {
    filterAlbedo.setImage("albedo",
        const_cast<vec3f *>(fbView.albedoBuffer),
        oidn::Format::Float3,
        fbView.fbDims.x,
        fbView.fbDims.y);
    filterAlbedo.setImage("output",
        bufferAux,
        oidn::Format::Float3,
        fbView.fbDims.x,
        fbView.fbDims.y,
        byteAlbedoOffset);
  }
}

void LiveDenoiseFrameOpShared::updateFilterInput()
{
  if (denoiser->denoiseAlpha)
    filter.setImage("color",
        const_cast<vec4f *>(fbView.colorBufferInput),
        oidn::Format::Float3,
        fbView.viewDims.x,
        fbView.viewDims.y,
        0,
        4 * sizeof(float));
  else
    filter.setImage("color",
        bufferOut, // in-place filtering of copied input
        oidn::Format::Float3,
        fbView.viewDims.x,
        fbView.viewDims.y,
        0,
        4 * sizeof(float));
}

void LiveDenoiseFrameOpShared::updateAuxImages(oidn::FilterRef &filter)
{
  if (prefilter) {
    if (fbView.normalBuffer)
      filter.setImage("normal",
          bufferAux,
          oidn::Format::Float3,
          fbView.viewDims.x,
          fbView.viewDims.y);
    if (fbView.albedoBuffer)
      filter.setImage("albedo",
          bufferAux,
          oidn::Format::Float3,
          fbView.viewDims.x,
          fbView.viewDims.y,
          byteAlbedoOffset);
  } else {
    if (fbView.normalBuffer)
      filter.setImage("normal",
          const_cast<vec3f *>(fbView.normalBuffer),
          oidn::Format::Float3,
          fbView.viewDims.x,
          fbView.viewDims.y);
    if (fbView.albedoBuffer)
      filter.setImage("albedo",
          const_cast<vec3f *>(fbView.albedoBuffer),
          oidn::Format::Float3,
          fbView.viewDims.x,
          fbView.viewDims.y);
  }
}

struct OSPRAY_MODULE_DENOISER_EXPORT LiveDenoiseFrameOpSharedSycl
    : public LiveDenoiseFrameOpShared
{
  LiveDenoiseFrameOpSharedSycl(
      DenoiseFrameOp *denoiser, FrameBufferView &fbView)
      : LiveDenoiseFrameOpShared(denoiser, fbView)
  {}

  devicert::AsyncEvent process() override;
};

devicert::AsyncEvent LiveDenoiseFrameOpSharedSycl::process()
{
  updateFilters();

  // Using SYCL calls without SYCL, that's supported in C99 API only

  if (prefilter) {
    if (filterNormal)
      oidnExecuteSYCLFilterAsync(filterNormal.getHandle(), nullptr, 0, nullptr);
    if (filterAlbedo)
      oidnExecuteSYCLFilterAsync(filterAlbedo.getHandle(), nullptr, 0, nullptr);
  }

  if (denoiser->denoiseAlpha)
    oidnExecuteSYCLFilterAsync(filterAlpha.getHandle(), nullptr, 0, nullptr);
  else
    bufferOut.writeAsync(0,
        fbView.viewDims.long_product() * sizeof(vec4f),
        fbView.colorBufferInput);

  devicert::AsyncEvent event = denoiser->drtDevice.createAsyncEvent();

  oidnExecuteSYCLFilterAsync(
      filter.getHandle(), nullptr, 0, (sycl::event *)event.getSyclEventPtr());

  return event;
}

struct OSPRAY_MODULE_DENOISER_EXPORT LiveDenoiseFrameOpSharedCpu
    : public LiveDenoiseFrameOpShared
{
  LiveDenoiseFrameOpSharedCpu(DenoiseFrameOp *denoiser, FrameBufferView &fbView)
      : LiveDenoiseFrameOpShared(denoiser, fbView)
  {}
  devicert::AsyncEvent process() override;
};

devicert::AsyncEvent LiveDenoiseFrameOpSharedCpu::process()
{
  updateFilters();

  devicert::AsyncEvent event = denoiser->drtDevice.launchHostTask([this]() {
    if (prefilter) {
      if (filterNormal)
        filterNormal.execute();
      if (filterAlbedo)
        filterAlbedo.execute();
    }
    if (denoiser->denoiseAlpha)
      filterAlpha.execute();
    else
      bufferOut.write(0,
          fbView.viewDims.long_product() * sizeof(vec4f),
          fbView.colorBufferInput);
    filter.execute();
  });
  return event;
}

struct OSPRAY_MODULE_DENOISER_EXPORT LiveDenoiseFrameOpCopy
    : public LiveDenoiseFrameOp
{
  LiveDenoiseFrameOpCopy(DenoiseFrameOp *, FrameBufferView &);

  devicert::AsyncEvent process() override;

 private:
  void initFilterAlphaImages() override;
  void initFilterAuxImages() override;
  void updateFilterInput() override;
  void updateAuxImages(oidn::FilterRef &) override;

  oidn::BufferRef buffer;
  size_t byteFloatBufferSize;
  size_t byteNormalOffset;
  size_t byteAlbedoOffset;
};

LiveDenoiseFrameOpCopy::LiveDenoiseFrameOpCopy(
    DenoiseFrameOp *denoiser, FrameBufferView &fbView)
    : LiveDenoiseFrameOp(denoiser, fbView)
{
  byteFloatBufferSize = sizeof(float) * fbView.fbDims.product();
  size_t sz = 4 * byteFloatBufferSize;

  if (fbView.normalBuffer) {
    byteNormalOffset = sz;
    sz += 3 * byteFloatBufferSize;
  }
  if (fbView.albedoBuffer) {
    byteAlbedoOffset = sz;
    sz += 3 * byteFloatBufferSize;
  }
  buffer = denoiser->oidnDevice.newBuffer(sz, oidn::Storage::Device);

  filter.setImage("output",
      buffer,
      oidn::Format::Float3,
      fbView.fbDims.x,
      fbView.fbDims.y,
      0,
      sizeof(float) * 4);

  updateFilters();
}

devicert::AsyncEvent LiveDenoiseFrameOpCopy::process()
{
  updateFilters();

  // As this path is taken when rendering on CPU and denoising on GPU,
  // the asynchronous OIDN API is used to reduce the number of CPU - GPU
  // synchronization points which would take place on every command in case
  // of using synchronous OIDN API.
  devicert::AsyncEvent event = denoiser->drtDevice.launchHostTask([this]() {
    buffer.writeAsync(0, 4 * byteFloatBufferSize, fbView.colorBufferInput);
    if (fbView.normalBuffer)
      buffer.writeAsync(
          byteNormalOffset, 3 * byteFloatBufferSize, fbView.normalBuffer);
    if (fbView.albedoBuffer)
      buffer.writeAsync(
          byteAlbedoOffset, 3 * byteFloatBufferSize, fbView.albedoBuffer);

    if (prefilter) {
      if (filterNormal)
        filterNormal.executeAsync();
      if (filterAlbedo)
        filterAlbedo.executeAsync();
    }

    filter.executeAsync();
    if (denoiser->denoiseAlpha)
      filterAlpha.executeAsync();

    buffer.readAsync(0, 4 * byteFloatBufferSize, fbView.colorBufferOutput);

    denoiser->oidnDevice.sync();
  });
  return event;
}

void LiveDenoiseFrameOpCopy::initFilterAlphaImages()
{
  filterAlpha.setImage("color",
      buffer,
      oidn::Format::Float,
      fbView.fbDims.x,
      fbView.fbDims.y,
      sizeof(float) * 3,
      sizeof(float) * 4);
  filterAlpha.setImage("output",
      buffer,
      oidn::Format::Float,
      fbView.fbDims.x,
      fbView.fbDims.y,
      sizeof(float) * 3,
      sizeof(float) * 4);
}

void LiveDenoiseFrameOpCopy::initFilterAuxImages()
{
  if (fbView.normalBuffer) {
    filterNormal.setImage("normal",
        buffer,
        oidn::Format::Float3,
        fbView.fbDims.x,
        fbView.fbDims.y,
        byteNormalOffset);
    filterNormal.setImage("output",
        buffer,
        oidn::Format::Float3,
        fbView.fbDims.x,
        fbView.fbDims.y,
        byteNormalOffset);
  }
  if (fbView.albedoBuffer) {
    filterAlbedo.setImage("albedo",
        buffer,
        oidn::Format::Float3,
        fbView.fbDims.x,
        fbView.fbDims.y,
        byteAlbedoOffset);
    filterAlbedo.setImage("output",
        buffer,
        oidn::Format::Float3,
        fbView.fbDims.x,
        fbView.fbDims.y,
        byteAlbedoOffset);
  }
}

void LiveDenoiseFrameOpCopy::updateFilterInput()
{
  filter.setImage("color",
      buffer,
      oidn::Format::Float3,
      fbView.fbDims.x,
      fbView.fbDims.y,
      0,
      sizeof(float) * 4);
}

void LiveDenoiseFrameOpCopy::updateAuxImages(oidn::FilterRef &filter)
{
  if (fbView.normalBuffer)
    filter.setImage("normal",
        buffer,
        oidn::Format::Float3,
        fbView.fbDims.x,
        fbView.fbDims.y,
        byteNormalOffset);
  if (fbView.albedoBuffer)
    filter.setImage("albedo",
        buffer,
        oidn::Format::Float3,
        fbView.fbDims.x,
        fbView.fbDims.y,
        byteAlbedoOffset);
}

DenoiseFrameOp::DenoiseFrameOp(devicert::Device &device) : drtDevice(device)
{
  // Get appropriate SYCL command queue for post-processing from device
  sycl::queue *syclQueuePtr = (sycl::queue *)drtDevice.getSyclQueuePtr();
  if (syclQueuePtr) {
    // Using SYCL call without SYCL, that's supported in C99 API only
    oidnDevice = oidnNewSYCLDevice(syclQueuePtr, 1);
  } else {
    oidnDevice = oidn::newDevice();
  }
  checkError(oidnDevice);
  oidnDevice.setErrorFunction(checkError);

  if (device.isDebug())
    oidnDevice.set("verbose", 2);

  oidnDevice.commit();
}

void DenoiseFrameOp::commit()
{
  quality = getParam<uint32_t>("quality", OSP_DENOISER_QUALITY_MEDIUM);
  denoiseAlpha = getParam<bool>("denoiseAlpha", false);
}

std::unique_ptr<LiveFrameOpInterface> DenoiseFrameOp::attach(
    FrameBufferView &fbView)
{
  if (drtDevice.getSyclQueuePtr())
    return rkcommon::make_unique<LiveDenoiseFrameOpSharedSycl>(this, fbView);

  if (oidnDevice.get<bool>("systemMemorySupported"))
    return rkcommon::make_unique<LiveDenoiseFrameOpSharedCpu>(this, fbView);

  return rkcommon::make_unique<LiveDenoiseFrameOpCopy>(this, fbView);
}

std::string DenoiseFrameOp::toString() const
{
  return "ospray::DenoiseFrameOp";
}

} // namespace ospray