Arnold Denoiser

plugins/helpers/ArnoldMenu.js

@@ -247,6 +247,7 @@ function AddPropertiesSubMenu(in_menu)
    in_menu.AddCommandItem("Texture Options", "AddTextureOptionsProperties");
    in_menu.AddCommandItem("Camera Options",  "AddCameraOptionsProperties");
    in_menu.AddCommandItem("Sidedness",       "AddSidednessProperties");
+   in_menu.AddCommandItem("Denoiser",        "AddDenoiserProperties");
 }
 
 

plugins/helpers/ArnoldProperties.js

@@ -26,6 +26,7 @@ function XSILoadPlugin(in_reg)
    in_reg.RegisterCommand("AddTextureOptionsProperties", "SITOA_AddTextureOptionsProperties");
    in_reg.RegisterCommand("AddCameraOptionsProperties",  "SITOA_AddCameraOptionsProperties");
    in_reg.RegisterCommand("AddVolumeProperties",         "SITOA_AddVolumeProperties");
+   in_reg.RegisterCommand("AddDenoiserProperties",       "SITOA_AddDenoiserProperties");
 
    in_reg.RegisterProperty("arnold_visibility");
    in_reg.RegisterProperty("arnold_matte");
@@ -92,6 +93,9 @@ function CommonAddProperties(in_collection, in_type, in_inspect)
             if (prop != null)
                volume_collection.Add(in_collection.item(i))
             break;
+         case "Denoiser":
+            prop = AddDenoiserProperty(in_collection.item(i));
+            break;
          default:
             break;
       }
@@ -224,6 +228,16 @@ function AddVolumeProperties_Execute(in_collection, in_inspect)
    return CommonAddProperties(in_collection, "Volume", in_inspect);
 }
 
+function AddDenoiserProperties_Init(in_ctxt)
+{
+   return CommonAddArguments(in_ctxt);
+}
+
+function AddDenoiserProperties_Execute(in_collection, in_inspect)
+{
+   return CommonAddProperties(in_collection, "Denoiser", in_inspect);
+}
+
 /////////////////////////////////
 // PROPERTY ADDERS
 /////////////////////////////////
@@ -414,6 +428,25 @@ function AddVolumeProperty(in_xsiObj)
    return prop;      
 }
 
+
+function AddDenoiserProperty(in_xsiObj)
+{
+   var prop = null;
+   // is in_xsiObj capable of hosting properties ?
+   var classOk = in_xsiObj.IsClassOf(siSceneItemID);
+
+   var type = in_xsiObj.type;
+   if (classOk && (type == "Pass"))
+   {
+      if (!CommonHasProperty(in_xsiObj, "arnold_denoiser"))
+         prop = in_xsiObj.AddProperty("arnold_denoiser", false, "Arnold Denoiser");
+   }
+   else
+      logmessage("[sitoa] Cannot add Denoiser property to " + in_xsiObj.FullName + ". It can only be assigned to Passes", siErrorMsg);
+
+   return prop;
+}
+
 /////////////////////////////////
 /////////////////////////////////
 /////////////////////////////////

plugins/sitoa/common/Tools.cpp

@@ -483,6 +483,33 @@ CString CStringUtilities::GetMasterBaseNodeName(CString &in_name)
    return splits[count-1];
 }
 
+
+// Return true or false if string starts with substring
+//
+// @param in_string        The input string
+// @param in_subString     The start string
+//
+// @return true or false
+//
+bool CStringUtilities::StartsWith(CString in_string, CString in_subString)
+{
+   return (in_string.FindString(in_subString) == 0);
+}
+
+
+// Return true or false if string ends with substring
+//
+// @param in_string        The input string
+// @param in_subString     The end string
+//
+// @return true or false
+//
+bool CStringUtilities::EndsWith(CString in_string, CString in_subString)
+{
+   return (in_string.ReverseFindString(in_subString) == (in_string.Length() - in_subString.Length()));
+}
+
+
 ////////////////////////////////////////////////////
 ////////////////////////////////////////////////////
 ////////////////////////////////////////////////////

plugins/sitoa/common/Tools.h

@@ -346,6 +346,10 @@ class CStringUtilities
    CString GetSoftimageNameFromSItoAName(CString &in_nane);
    // Return the name of the master node of a ginstance or a cloned light
    CString GetMasterBaseNodeName(CString &in_name);
+   // Checks if string starts with substring
+   bool StartsWith(CString in_string, CString in_subString);
+   // Checks if string ends with substring
+   bool EndsWith(CString in_string, CString in_subString);
 
 private:
    // Build the name for an Arnold node (overload for a CString input type)

plugins/sitoa/loader/Options.cpp

@@ -189,6 +189,20 @@ bool LoadFilters()
 
    CNodeUtilities().SetName(closestFilterNode, "sitoa_closest_filter");
 
+   // if we're outputting denoising aovs we need a variance filter
+   // https://github.com/Autodesk/sitoa/issues/34
+   if (GetRenderOptions()->m_output_denoising_aovs && !(filterType.IsEqualNoCase(L"variance") || filterType.IsEqualNoCase(L"contour")))
+   {
+      // create a variance filter
+      AtNode* varianceFilterNode = AiNode("variance_filter");
+      if (!varianceFilterNode)
+         return false;
+      CNodeUtilities().SetName(varianceFilterNode, "sitoa_variance_filter");
+      CNodeSetter::SetFloat(varianceFilterNode, "width", GetRenderOptions()->m_output_filter_width);  // width of output_filter
+      CNodeSetter::SetBoolean(varianceFilterNode, "scalar_mode", false);
+      CNodeSetter::SetString(varianceFilterNode, "filter_weights", filterType.GetAsciiString());  // type of output_filter
+   }
+
    // optix denoise filters are added in the LoadDrivers() function because they have to be unique for each AOV
 
    return true;
@@ -343,6 +357,7 @@ bool LoadDrivers(AtNode *in_optionsNode, Pass &in_pass, double in_frame, bool in
 {
    Framebuffer frameBuffer(in_pass.GetFramebuffers().GetItem(L"Main"));
    CString mainFormat(ParAcc_GetValue(frameBuffer, L"Format", in_frame));
+   CFrameBuffer mainFb(frameBuffer, in_frame, false);
 
    CRefArray frameBuffers = in_pass.GetFramebuffers();
    LONG nbBuffers = frameBuffers.GetCount();
@@ -365,6 +380,13 @@ bool LoadDrivers(AtNode *in_optionsNode, Pass &in_pass, double in_frame, bool in
    // vector of the drivers, each with theirs layers
    vector <CDeepExrLayersDrivers> deepExrLayersDrivers;
 
+   // vars to hold if and how to create AOVs for noice
+   // it's a string because it can be added in two ways.
+   // recognised values are "add", "add_rename" and "exist"
+   CString noiceDA = L"add";
+   CString noiceN  = L"add";
+   CString noiceZ  = L"add";
+
    unsigned int activeBuffer = 0;
    for (LONG i = 0; i<nbBuffers; i++)
    {
@@ -490,25 +512,106 @@ bool LoadDrivers(AtNode *in_optionsNode, Pass &in_pass, double in_frame, bool in
       }
 
       // if layerName ends with "_denoise", we add a denoise filter named after the layer and then add the output
-      if (thisFb.m_layerName.ReverseFindString(L"_denoise") == (thisFb.m_layerName.Length() - CString(L"_denoise").Length()))
+      if (CStringUtilities().EndsWith(thisFb.m_layerName, L"_denoise"))
       {
          // OptiX denoise needs a separete filter for each AOV, so we create them here instad of in LoadFilters()
+         CString optixFilterName = L"sitoa_" + thisFb.m_layerName + L"_optix_filter";
          AtNode* optixFilterNode = AiNode("denoise_optix_filter");
          if (!optixFilterNode)
+         {
+            GetMessageQueue()->LogMsg(L"[sitoa] Couldn't create denoise_optix_filter for layer " + thisFb.m_layerName, siErrorMsg);
             continue;
-         CNodeUtilities().SetName(optixFilterNode, CString(L"sitoa_" + thisFb.m_layerName + L"_optix_filter").GetAsciiString());
-         AiArraySetStr(outputs, activeBuffer, CString(thisFb.m_layerName + L" " + thisFb.m_layerDataType + L" sitoa_" + thisFb.m_layerName + L"_optix_filter " + masterFb.m_fullName).GetAsciiString());
+         }
+         CNodeUtilities().SetName(optixFilterNode, optixFilterName.GetAsciiString());
+         AiArraySetStr(outputs, activeBuffer, CString(thisFb.m_layerName + L" " + thisFb.m_layerDataType + L" " + optixFilterName + L" " + masterFb.m_fullName).GetAsciiString());
       }
       // Adding to outputs. masterFb differs from thisFb if they are both exr and share the same filename
       else if (thisFb.m_layerDataType.IsEqualNoCase(L"RGB") || thisFb.m_layerDataType.IsEqualNoCase(L"RGBA"))
          AiArraySetStr(outputs, activeBuffer, CString(thisFb.m_layerName + L" " + thisFb.m_layerDataType + L" " + colorFilter + " " + masterFb.m_fullName).GetAsciiString());
       else
          AiArraySetStr(outputs, activeBuffer, CString(thisFb.m_layerName + L" " + thisFb.m_layerDataType + L" " + numericFilter + " " + masterFb.m_fullName).GetAsciiString());
 
+      // Do checks if Arnold Denoising AOVs already exist and if they have the right filter if they do
+      if (masterFb.m_fullName == mainFb.m_fullName) // only check if it's a layer in the same exr as main (multilayer-exr)
+      {
+         if (thisFb.m_layerName == L"diffuse_albedo")
+            noiceDA = L"exist";
+
+         if (thisFb.m_layerName == L"N")
+         {
+            if (numericFilter == colorFilter)
+               noiceN = L"exist";
+            else
+               noiceN = L"add_rename";
+         }
+
+         if (thisFb.m_layerName == L"Z")
+         {
+            if (numericFilter == colorFilter)
+               noiceZ = L"exist";
+            else
+               noiceZ = L"add_rename";
+         }
+      }
+
       activeBuffer++;
    }
 
-   // Setting outpus array only if there is at least one active framebuffer
+   // Setup the AOVs for Arnold Denoising (noice)
+   // https://github.com/Autodesk/sitoa/issues/34
+   if (GetRenderOptions()->m_output_denoising_aovs)
+   {
+      if (mainFb.m_driverName.IsEqualNoCase(L"driver_exr"))
+      {
+         // pre-calc number of additional framebuffers to add and resize output array
+         int nbNoiceBuffers = 4;
+         if (noiceDA == L"exist")
+            nbNoiceBuffers -= 1;
+         if (noiceN == L"exist")
+            nbNoiceBuffers -= 1;
+         if (noiceZ == L"exist")
+            nbNoiceBuffers -= 1;
+         AiArrayResize(outputs, activeBuffers + nbNoiceBuffers, 1);
+
+         // Set the name and issue a warning if it's renamed
+         CString nameN = L"";
+         CString nameZ = L"";
+         if (noiceN == L"add_rename")
+         {
+            nameN = L" N_noice";
+            GetMessageQueue()->LogMsg(L"[sitoa] Arnold Denoising AOV \"N\" has been renamed to \"N_noice\" because \"N\" already exist with \"closest_filter\".", siInfoMsg);
+         }
+         if (noiceZ == L"add_rename")
+         {
+            nameZ = L" Z_noice";
+            GetMessageQueue()->LogMsg(L"[sitoa] Arnold Denoising AOV \"Z\" has been renamed to \"Z_noice\" because \"Z\" already exist with \"closest_filter\".", siInfoMsg);
+         }
+
+         // add the denoising aovs
+         int i = 0;
+         if (noiceDA != L"exist")
+         {
+            AiArraySetStr(outputs, activeBuffers+i, CString(L"diffuse_albedo RGB " + colorFilter + L" " + mainFb.m_fullName).GetAsciiString());
+            i++;
+         }
+         if (noiceN != L"exist")
+         {
+            AiArraySetStr(outputs, activeBuffers+i, CString(L"N VECTOR " + colorFilter + L" " + mainFb.m_fullName + nameN).GetAsciiString());
+            i++;
+         }
+         if (noiceZ != L"exist")
+         {
+            AiArraySetStr(outputs, activeBuffers+i, CString(L"Z FLOAT " + colorFilter + L" " + mainFb.m_fullName + nameZ).GetAsciiString());
+            i++;
+         }
+
+         AiArraySetStr(outputs, activeBuffers+i, CString(L"RGB RGB sitoa_variance_filter " + mainFb.m_fullName + L" variance").GetAsciiString());
+      }
+      else
+         GetMessageQueue()->LogMsg(L"[sitoa] Arnold Denoising AOVs can only be output to exr.", siWarningMsg);
+   }
+
+   // Setting outputs array only if there is at least one active framebuffer
    if (activeBuffer > 0)
    {
       AiNodeSetArray(in_optionsNode, "outputs", outputs);