Merge pull request #24 from frenchdog/dev

BIFROST-9549 - Public update for Bifrost 2.9.0.0 release

Author: frenchdog

CHANGELOG.md

@@ -1,4 +1,29 @@
-## [1.2.1] - 2023-11-15
+## [1.2.2] - 2024-03-27 (Bifrost 2.9)
+
+### Build
+
+ - BIFROST-9332 - Update to Bifrost 2.9 SDK
+ - BIFROST-8981 - Update to USD 0.23.11
+ - BIFROST-9147 - Make C++17 default
+
+### Feature
+
+ - BIFROST-9354 - USD File Format Option
+
+    Add parameter to set a the USD layer format to ASCII or binary. Useful to save in human readable format and still keep the .usd extension.
+
+ -  BIFROST-9334 - Add _get_edit_layer_ operator
+
+    This node returns the stage's EditTarget layer.
+
+
+### Bugfix
+
+ - BIFROST 9428 - Fix scalar attribute creation regression when _using add_to_stage_ compound
+ - BIFROST-9334 - Fix save_usd_stage compound errors when current edit target is not the root layer
+    - Update the _save_usd_stage_ compound. It is now setting the target layer to the root layer before saving and then restore the current target (using the new get_edit_layer operator).
+
+## [1.2.1] - 2023-11-15 (Bifrost 2.8)
 
 ### Build
 
@@ -79,7 +104,7 @@
    - add README.md in test folder
 
 
-## [1.2.0] - 2023-05-12
+## [1.2.0] - 2023-05-12 (Bifrost 2.7)
 
 ### Build
 
@@ -114,7 +139,7 @@
 	- removed call to changeDir() that has side effect and is not required anymore for unit tests.
 
 
-## [1.1.0] - 2023-03-29
+## [1.1.0] - 2023-03-29 (Bifrost 2.7)
 
 ### Build
 
@@ -135,6 +160,6 @@
 
 ### Bugfix
 
-## [1.0.0] - 2022-12-12
+## [1.0.0] - 2022-12-12 (Bifrost 2.6)
 
  - Initial release

CMakeLists.txt

@@ -32,6 +32,11 @@ endif()
 
 set(IS_BIFUSD_STANDALONE ON CACHE BOOL "Indicate if this is a standalone build of Bifrost USD")
 
+# C++ 17 not extensions - by default
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_EXTENSIONS OFF)
+
 include(cmake/version.info)
 
 # Enable no language yet.

README.md

@@ -25,6 +25,8 @@ You must provide the following variables to the cmake command:
 * BIFUSD_OSX_MIN_OS : (optional) Can be set to choose the minimum macOS deployement target. If not set, macOS 11.0 will be used.
 * BIFUSD_OSX_BINARY_ARCH : (optional) Can be set to choose the target architecture to build on macOS. Acceptable values are `x64` (Intel CPU), `arm64` (Apple M1 CPU), `ub2` (Universal Binary 2 - both x64 and arm64) and empty (default) (host system's processor).
 
+__C++17 is the minimal required version going forward.__
+
 __Python 3 version is assumed.__
 
 __If your build uses MAYA_RUNTIME_LOCATION, you will need to use the same USD version than MayaUSD plugin.__

bifrost_hydra/src/BifrostHdEngine/CMakeLists.txt

@@ -19,11 +19,13 @@
 set(hd_Engine_headers
     Container.h
     Engine.h
+    Export.h
     JobTranslationData.h
     Parameters.h
     Requirement.h
     Runtime.h
     ValueTranslationData.h
+    Workspace.h
 )
 
 bifusd_install_headers(
@@ -54,17 +56,18 @@ set(src_files
     Requirement.cpp
     Runtime.cpp
     ValueTranslationData.cpp
+    Workspace.cpp
 )
 
 bifusd_set_extra_rpaths(extra_rpaths)
 
 bifusd_create_shared_lib(
-    BifrostHdEngine "BIFROST_HD_ENGINE_BUILD_DLL" # TODO: add export file
+    BifrostHdEngine        "BIFROST_HD_ENGINE_BUILD_DLL" # TODO: add export file
     PUBLIC_INSTALL
-    PUBLIC_DEFINITIONS     $<${BIFUSD_IS_MSC}: BOOST_LIB_TOOLSET="vc141">
+    PUBLIC_DEFINITIONS     $<${BIFUSD_IS_MSC}: BOOST_LIB_TOOLSET="vc142">
     PRIVATE_DEFINITIONS    $<${BIFUSD_IS_DEBUG}: TBB_USE_DEBUG BOOST_DEBUG_PYTHON BOOST_LINKING_PYTHON>
 
-    PRIVATE_OPTIONS        $<${BIFUSD_IS_MSC}:/wd4251 /wd4273>
+    PRIVATE_OPTIONS        $<${BIFUSD_IS_MSC}:/wd4251 /wd4273 /wd4003>
                            $<${BIFUSD_IS_GCC}: -Wno-deprecated -Wno-unused-macros>
                            $<${BIFUSD_IS_CLANG}: -Wno-deprecated -Wno-unused-macros>
 

bifrost_hydra/src/BifrostHdEngine/Container.cpp

@@ -16,26 +16,33 @@
 
 #include <BifrostHydra/Engine/Container.h>
 
+#include <BifrostHydra/Engine/JobTranslationData.h>
+#include <BifrostHydra/Engine/Requirement.h>
+#include <BifrostHydra/Engine/Runtime.h>
+
+#include <BifrostGraph/Executor/PreviewUtility.h>
+
 #include <iostream>
 
 namespace BifrostHd {
 
-Container::Container() : BifrostBoardContainer(&Runtime::Get()), m_job(this) {}
+Container::Container(Runtime& runtime) : BifrostGraph::Executor::GraphContainerPreview(&runtime), m_job(this) {}
 
 Container::~Container() = default;
 
-/* static */
-Runtime& Container::GetRuntime() { return Runtime::Get(); }
-
-BifrostBoardJob::Requirement* Container::createEvaluationRequirement(
-    const Amino::String&                               name,
-    Amino::PortDescription::PortDirection              direction,
-    const Amino::Type&                                 type,
-    BifrostGraph::Executor::TypeTranslation::PortClass portClass) const {
-    Amino::Value           defaultVal;
+BifrostGraph::Executor::JobPreview::Requirement*
+Container::createEvaluationRequirement(
+    const Amino::String&                  name,
+    BifrostGraph::Executor::PortDirection direction,
+    const Amino::Type&                    type,
+    BifrostGraph::Executor::PortClass     portClass) const {
+    Amino::Any             defaultVal;
     Amino::PortDescription portDesc;
     if (getGraph().getPorts().findByName(name, portDesc)) {
-        defaultVal = portDesc.value();
+        BifrostGraph::Executor::Utility::convertValueToAny(
+            getRuntime()->getAmLibrary(),
+            portDesc.value(),
+            defaultVal);
     }
 
     return new Requirement(name, direction, type, portClass, defaultVal);
@@ -47,8 +54,8 @@ bool Container::initialize() {
     // Job Ports are global state ports, such as for time information.
     // For now TypeTranslation::portAdded() does nothing, so the
     // pointer can be nullptr.
-    auto status =
-        m_job.update(nullptr, BifrostBoardJob::CompileSwitch::kCompile);
+    auto status = m_job.update(
+        nullptr, BifrostGraph::Executor::JobPreview::CompileSwitch::kCompile);
 
     // See BIFROST-3651.
     if (status == Amino::SetGraphStatus::Value::kFailure) {
@@ -99,13 +106,16 @@ bool Container::initialize() {
 }
 
 bool Container::updateJob() {
-    return m_job.update(nullptr, BifrostBoardJob::CompileSwitch::kCompile) !=
-           BifrostBoardJob::EvaluationStatus::kFailure;
+    return m_job.update(
+               nullptr,
+               BifrostGraph::Executor::JobPreview::CompileSwitch::kCompile) !=
+           BifrostGraph::Executor::JobPreview::EvaluationStatus::kFailure;
 }
 
 Amino::Job::State Container::executeJob(JobTranslationData& translationData) {
-    return m_job.execute(&translationData,
-                         BifrostBoardJob::ExecuteFlags::kDefault);
+    return m_job.execute(
+        &translationData,
+        BifrostGraph::Executor::JobPreview::ExecuteFlags::kDefault);
 }
 
 } // namespace BifrostHd

bifrost_hydra/src/BifrostHdEngine/Container.h

@@ -17,27 +17,26 @@
 #ifndef BIFROST_USD_ENGINE_CONTAINER_H_
 #define BIFROST_USD_ENGINE_CONTAINER_H_
 
-#include <BifrostHydra/Engine/JobTranslationData.h>
-#include <BifrostHydra/Engine/Requirement.h>
-#include <BifrostHydra/Engine/Runtime.h>
+#include <BifrostHydra/Engine/Export.h>
 
-#include <BifrostGraph/Executor/BifrostBoardJob.h>
+#include <BifrostGraph/Executor/GraphContainerPreview.h>
+#include <BifrostGraph/Executor/JobPreview.h>
 
 namespace BifrostHd {
+class Runtime;
+class JobTranslationData;
 
-class Container final : public BifrostBoardContainer {
+class BIFROST_HD_ENGINE_SHARED_DECL Container final : public BifrostGraph::Executor::GraphContainerPreview {
 public:
-    explicit Container();
+    explicit Container(Runtime& runtime);
     ~Container() override;
 
-    static Runtime& GetRuntime();
-
-    BifrostBoardJob::Requirement* createEvaluationRequirement(
-        const Amino::String&                               name,
-        Amino::PortDescription::PortDirection              direction,
-        const Amino::Type&                                 type,
-        BifrostGraph::Executor::TypeTranslation::PortClass portClass)
-        const override;
+    BifrostGraph::Executor::JobPreview::Requirement*
+    createEvaluationRequirement(
+        const Amino::String&                  name,
+        BifrostGraph::Executor::PortDirection direction,
+        const Amino::Type&                    type,
+        BifrostGraph::Executor::PortClass     portClass) const override;
 
     bool initialize();
 
@@ -57,7 +56,7 @@ class Container final : public BifrostBoardContainer {
     /// \}
 
 private:
-    BifrostBoardJob m_job;
+    BifrostGraph::Executor::JobPreview m_job;
 };
 
 } // namespace BifrostHd

bifrost_hydra/src/BifrostHdEngine/Engine.cpp

@@ -17,6 +17,9 @@
 #include <BifrostHydra/Engine/Engine.h>
 
 #include <BifrostHydra/Engine/Container.h>
+#include <BifrostHydra/Engine/Runtime.h>
+#include <BifrostHydra/Engine/Workspace.h>
+
 #include <BifrostHydra/Engine/JobTranslationData.h>
 #include <BifrostHydra/Engine/Parameters.h>
 
@@ -36,15 +39,14 @@ class Engine::Impl {
         if (m_container.graphExecutionCounter() == 0) {
             if (!m_container.loadGraph(
                     qualifiedName,
-                    BifrostBoardContainer::GraphMode::kLoadAsReference)) {
+                    BifrostGraph::Executor::GraphContainerPreview::GraphMode::kLoadAsReference)) {
                 return Amino::Job::State::kErrors;
             }
             if (!m_container.updateJob()) {
                 return Amino::Job::State::kErrors;
             }
         }
 
-
         const double currentTime = frame / m_fps;
         const double frameLength = 1.0 / m_fps;
 
@@ -68,7 +70,7 @@ class Engine::Impl {
 private:
     double               m_fps{24.0};
     Parameters           m_parameters;
-    BifrostHd::Container m_container;
+    BifrostHd::Container m_container{BifrostHd::Runtime::getInstance()};
 };
 
 Engine::Engine() : m_impl(std::make_unique<Impl>()) {}

bifrost_hydra/src/BifrostHdEngine/Engine.h

@@ -17,14 +17,17 @@
 #ifndef BIFROST_HD_ENGINE_H
 #define BIFROST_HD_ENGINE_H
 
-#include <AminoJob.h>
+#include <BifrostHydra/Engine/Export.h>
+
+#include <Amino/AminoJob.h>
 #include <Bifrost/Object/Object.h>
 
 #include <pxr/imaging/hd/sceneIndex.h>
 
 #include <memory>
 
 namespace BifrostHd {
+class Workspace;
 
 /// \class Engine
 ///
@@ -35,7 +38,7 @@ namespace BifrostHd {
 using Output =
     std::pair<std::string, Amino::Array<Amino::Ptr<Bifrost::Object>>>;
 
-class Engine {
+class BIFROST_HD_ENGINE_SHARED_DECL Engine {
 public:
     Engine();
 

bifrost_hydra/src/BifrostHdEngine/Export.h

@@ -0,0 +1,36 @@
+//-
+// Copyright 2023 Autodesk, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//+
+
+#ifndef BIFROST_HD_ENGINE_EXPORT
+#define BIFROST_HD_ENGINE_EXPORT
+
+#if defined(_WIN32) || defined(__CYGWIN__)
+#if defined(BIFROST_HD_ENGINE_BUILD_DLL)
+#define BIFROST_HD_ENGINE_SHARED_DECL __declspec(dllexport)
+#else
+#define BIFROST_HD_ENGINE_SHARED_DECL __declspec(dllimport)
+#endif
+
+#elif defined(__GNUC__)
+#if defined(BIFROST_HD_ENGINE_BUILD_DLL)
+#define BIFROST_HD_ENGINE_SHARED_DECL __attribute__((visibility("default")))
+#else
+#define BIFROST_HD_ENGINE_SHARED_DECL
+#endif
+
+#endif
+
+#endif // BIFROST_HD_ENGINE_EXPORT

bifrost_hydra/src/BifrostHdEngine/JobTranslationData.cpp

@@ -39,7 +39,7 @@ class JobTranslationData::Impl {
 JobTranslationData::JobTranslationData(Parameters& params,
                                        bool        logVerbose,
                                        Time const& time)
-    : BifrostBoardJob::JobTranslationData(),
+    : BifrostGraph::Executor::JobPreview::JobTranslationData(),
       m_impl(std::make_unique<Impl>(logVerbose, time, params)) {}
 
 JobTranslationData::~JobTranslationData() = default;