Exposed the html report file in the render settings reader / render delegate (#2253)

Author: TomMinor

libs/common/constant_strings.h

@@ -84,6 +84,7 @@ ASTR2(primvars_arnold_light, "primvars:arnold:light");
 ASTR2(log_file, "log:file");
 ASTR2(log_verbosity, "log:verbosity");
 ASTR2(profile_file, "profile:file");
+ASTR2(report_file, "report:file");
 ASTR2(stats_file, "stats:file");
 ASTR2(stats_mode, "stats:mode");
 ASTR2(outputs_color, "outputs:color");

libs/common/rendersettings_utils.cpp

@@ -48,6 +48,7 @@ TF_DEFINE_PRIVATE_TOKENS(_tokens,
     ((colorManagerEntry, "arnold:color_manager:node_entry"))
     ((logFile, "arnold:global:log:file"))
     ((logVerbosity, "arnold:global:log:verbosity"))
+    ((reportFile, "arnold:global:report:file"))
     ((statsFile, "arnold:global:stats:file"))
     ((statsMode, "arnold:global:stats:mode"))
     ((profileFile, "arnold:global:profile:file"))
@@ -873,6 +874,15 @@ AtNode* ReadRenderSettings(const UsdPrim &renderSettingsPrim, ArnoldAPIAdapter &
         }
     }
 
+    // html report file
+    if (UsdAttribute reportFileAttr = renderSettingsPrim.GetAttribute(_tokens->reportFile)) {
+        VtValue reportFileValue;
+        if (reportFileAttr.Get(&reportFileValue, time.frame)) {
+            const std::string reportFile = VtValueGetString(reportFileValue);
+            AiReportSetFileName(reportFile.c_str());
+        }
+    }
+
     // stats file
     if (UsdAttribute statsFileAttr = renderSettingsPrim.GetAttribute(_tokens->statsFile)) {
         VtValue statsFileValue;

libs/render_delegate/config.cpp

@@ -98,6 +98,8 @@ TF_DEFINE_ENV_SETTING(HDARNOLD_interactive_fps_min, "5.0", "Minimum fps for prog
 
 TF_DEFINE_ENV_SETTING(HDARNOLD_profile_file, "", "Output file for profiling information.");
 
+TF_DEFINE_ENV_SETTING(HDARNOLD_report_file, "", "Output file for the Arnold HTML report file");
+
 TF_DEFINE_ENV_SETTING(HDARNOLD_stats_file, "", "Output file for stats information.");
 
 TF_DEFINE_ENV_SETTING(HDARNOLD_texture_searchpath, "", "Texture search path.");
@@ -118,6 +120,7 @@ HdArnoldConfig::HdArnoldConfig()
     log_file = TfGetEnvSetting(HDARNOLD_log_file);
     log_flags_console = TfGetEnvSetting(HDARNOLD_log_flags_console);
     log_flags_file = TfGetEnvSetting(HDARNOLD_log_flags_file);
+    report_file = TfGetEnvSetting(HDARNOLD_report_file);
     stats_file = TfGetEnvSetting(HDARNOLD_stats_file);
     threads = TfGetEnvSetting(HDARNOLD_threads);
     AA_samples = TfGetEnvSetting(HDARNOLD_AA_samples);

libs/render_delegate/config.h

@@ -163,6 +163,10 @@ struct HdArnoldConfig {
     ///
     std::string profile_file; ///< Output file for profiling data.
 
+    /// Use HDARNOLD_report_file to set the value.
+    ///
+    std::string report_file; ///< Output file for html report data.
+
     /// Use HDARNOLD_stats_file to set the value.
     ///
     std::string stats_file; ///< Output file for stats data.

libs/render_delegate/render_delegate.cpp

@@ -335,6 +335,8 @@ const SupportedRenderSettings& _GetSupportedRenderSettings()
         {str::t_ignore_smoothing, {"Ignore Smoothing"}},
         {str::t_ignore_sss, {"Ignore SubSurface Scattering"}},
         {str::t_ignore_operators, {"Ignore Operators"}},
+        // HTML Report Settings
+        {str::t_report_file, {"HTML Report Path", config.report_file}},
         // Log Settings
         {str::t_log_verbosity, {"Log Verbosity (0-5)", config.log_verbosity}},
         {str::t_log_file, {"Log File Path", config.log_file}},
@@ -691,6 +693,11 @@ void HdArnoldRenderDelegate::_SetRenderSetting(const TfToken& _key, const VtValu
             _logFile = value.UncheckedGet<std::string>();
             AiMsgSetLogFileName(_logFile.c_str());
         }
+    } else if (key == str::t_report_file) {
+        if (value.IsHolding<std::string>()) {
+            _reportFile = value.UncheckedGet<std::string>();
+            AiReportSetFileName(_reportFile.c_str());
+        }
     } else if (key == str::t_stats_file) {
         if (value.IsHolding<std::string>()) {
             _statsFile = value.UncheckedGet<std::string>();
@@ -983,6 +990,8 @@ VtValue HdArnoldRenderDelegate::GetRenderSetting(const TfToken& _key) const
         return VtValue(ArnoldUsdGetLogVerbosityFromFlags(_verbosityLogFlags));
     } else if (key == str::t_log_file) {
         return VtValue(_logFile);
+    } else if (key == str::t_report_file) {
+        return VtValue(_reportFile);
     } else if (key == str::t_stats_file) {
         return VtValue(_statsFile);
     } else if (key == str::t_stats_mode) {

libs/render_delegate/render_delegate.h

@@ -766,6 +766,7 @@ class HdArnoldRenderDelegate final : public HdRenderDelegate {
     AtNode* _procParent = nullptr;
     AtSessionMode _renderSessionType = AI_SESSION_INTERACTIVE;
     std::string _logFile;
+    std::string _reportFile;
     std::string _statsFile;
     AtStatsMode _statsMode;
     std::string _profileFile;