renderer.h

//
// Copyright 2018 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_PLUGIN_HD_EMBREE_RENDERER_H
#define PXR_IMAGING_PLUGIN_HD_EMBREE_RENDERER_H
 
#include "pxr/pxr.h"
 
#include "pxr/imaging/plugin/hdEmbree/context.h"
#include "pxr/imaging/plugin/hdEmbree/light.h"
 
#include "pxr/imaging/hd/aov.h"
#include "pxr/imaging/hd/renderThread.h"
 
#include "pxr/base/gf/matrix4d.h"
#include "pxr/base/gf/rect2i.h"
 
#include <embree4/rtcore.h>
#include <embree4/rtcore_device.h>
#include <embree4/rtcore_ray.h>
 
#include <random>
#include <atomic>
#include <map>
#include <mutex>
 
PXR_NAMESPACE_OPEN_SCOPE
 
enum HdEmbree_RayMask: uint32_t  {
    None = 0,
 
    Camera = 1 << 0,
    Shadow = 1 << 1,
 
    All = UINT_MAX,
};
 
class HdEmbreeRenderer final
{
public:
    using WriteMutex = std::mutex;
    using ScopedLock = std::scoped_lock<WriteMutex>;
 
    HdEmbreeRenderer();
 
    ~HdEmbreeRenderer();
 
    void SetScene(RTCScene scene);
 
    void SetDataWindow(const GfRect2i &dataWindow);
 
    void SetCamera(const GfMatrix4d& viewMatrix, const GfMatrix4d& projMatrix);
 
    void SetAovBindings(HdRenderPassAovBindingVector const &aovBindings);
 
    void AddLight(SdfPath const& lightPath, HdEmbree_Light* light);
 
    void RemoveLight(SdfPath const& lightPath, HdEmbree_Light* light);
 
    HdRenderPassAovBindingVector const& GetAovBindings() const {
        return _aovBindings;
    }
 
    void SetSamplesToConvergence(int samplesToConvergence);
 
    void SetAmbientOcclusionSamples(int ambientOcclusionSamples);
 
    void SetDomeLightCameraVisibility(bool domeLightCameraVisibility);
 
    void SetEnableSceneColors(bool enableSceneColors);
 
    void SetRandomNumberSeed(int randomNumberSeed);
 
    void SetEnableLighting(bool enableLighting);
 
    void Render(HdRenderThread *renderThread);
 
    void Clear();
 
    void MarkAovBuffersUnconverged();
 
    int GetCompletedSamples() const;
 
private:
    // Perform validation and setup immediately before starting a render
    void _PreRenderSetup();
 
    // Validate the internal consistency of aov bindings provided to
    // SetAovBindings. If the aov bindings are invalid, this will issue
    // appropriate warnings. If the function returns false, Render() will fail
    // early.
    //
    // This function thunks itself using _aovBindingsNeedValidation and
    // _aovBindingsValid.
    //   \return True if the aov bindings are valid for rendering.
    bool _ValidateAovBindings();
 
    // Return the clear color to use for the given VtValue.
    static GfVec4f _GetClearColor(VtValue const& clearValue);
 
    // Render square tiles of pixels. This function is one unit of threadpool
    // work. For each tile, iterate over pixels in the tile, generating camera
    // rays, and following them/calculating color with _TraceRay. This function
    // renders all tiles between tileStart and tileEnd.
    void _RenderTiles(HdRenderThread *renderThread, int sampleNum,
                      size_t tileStart, size_t tileEnd);
 
    // Cast a ray into the scene and if it hits an object, write to the bound
    // aov buffers.
    void _TraceRay(unsigned int x, unsigned int y,
                   GfVec3f const& origin, GfVec3f const& dir,
                   std::default_random_engine &random);
 
    // Compute the color at the given ray hit.
    GfVec4f _ComputeColor(RTCRayHit const& rayHit,
                          std::default_random_engine &random,
                          GfVec4f const& clearColor);
    // Compute the depth at the given ray hit.
    bool _ComputeDepth(RTCRayHit const& rayHit, float *depth, bool clip);
    // Compute the given ID at the given ray hit.
    bool _ComputeId(RTCRayHit const& rayHit, TfToken const& idType, int32_t *id);
    // Compute the normal at the given ray hit.
    bool _ComputeNormal(RTCRayHit const& rayHit, GfVec3f *normal, bool eye);
    // Compute a primvar at the given ray hit.
    bool _ComputePrimvar(RTCRayHit const& rayHit, TfToken const& primvar,
        GfVec3f *value);
 
    // Compute the ambient occlusion term at a given point by firing rays
    // from "position" in the hemisphere centered on "normal"; the occlusion
    // factor is the fraction of those rays that are visible.
    //
    // Modulating surface color by occlusionFactor is similar to taking
    // the light contribution of an infinitely far, pure white dome light.
    float _ComputeAmbientOcclusion(GfVec3f const& position,
                                   GfVec3f const& normal,
                                   std::default_random_engine &random);
 
    GfVec3f _ComputeLighting(
        GfVec3f const& position,
        GfVec3f const& normal,
        std::default_random_engine &random,
        HdEmbreePrototypeContext const* prototypeContext) const;
 
    // Return the visibility from `position` along `direction`
    float _Visibility(GfVec3f const& position,
                      GfVec3f const& direction,
                      float offset = 1.0e-3f) const;
 
    // Should the ray continue based on the possibly intersected prim's visibility settings?
    bool _RayShouldContinue(RTCRayHit const& rayHit) const;
 
    // The bound aovs for this renderer.
    HdRenderPassAovBindingVector _aovBindings;
    // Parsed AOV name tokens.
    HdParsedAovTokenVector _aovNames;
 
    // Do the aov bindings need to be re-validated?
    bool _aovBindingsNeedValidation;
    // Are the aov bindings valid?
    bool _aovBindingsValid;
 
    // Data window - as in CameraUtilFraming.
    GfRect2i _dataWindow;
 
    // The width of the render buffers.
    unsigned int _width;
    // The height of the render buffers.
    unsigned int _height;
 
    // View matrix: world space to camera space.
    GfMatrix4d _viewMatrix;
    // Projection matrix: camera space to NDC space.
    GfMatrix4d _projMatrix;
    // The inverse view matrix: camera space to world space.
    GfMatrix4d _inverseViewMatrix;
    // The inverse projection matrix: NDC space to camera space.
    GfMatrix4d _inverseProjMatrix;
 
    // Our handle to the embree scene.
    RTCScene _scene;
 
    // How many samples should we render to convergence?
    int _samplesToConvergence;
    // How many samples should we use for ambient occlusion?
    int _ambientOcclusionSamples;
    // Should we enable scene colors?
    bool _enableSceneColors;
    // Should we sample dome lights on ray miss?
    bool _domeLightCameraVisibility;
    // If other than -1, use this to seed the random number generator with.
    int _randomNumberSeed;
    // Should we enable direct lighting from the scene?
    bool _enableLighting;
 
    // How many samples have been completed.
    std::atomic<int> _completedSamples;
 
    // Lights
    mutable WriteMutex _lightsWriteMutex; // protects the 2 below
    std::map<SdfPath, HdEmbree_Light*> _lightMap;
    std::vector<HdEmbree_Light*> _domes;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_IMAGING_PLUGIN_HD_EMBREE_RENDERER_H