Adsk Contrib - Add Built-in Transform and ociomakeclf app (#1006)

* Adsk Contrib - Built-in Transforms Signed-off-by: Patrick Hodoul <[email protected]> * Fix MSVC build break Signed-off-by: Patrick Hodoul <[email protected]> * Add Python bindings Signed-off-by: Patrick Hodoul <[email protected]> * Fix a computation overflow Signed-off-by: Patrick Hodoul <[email protected]> * Fix a computation overflow, part II Signed-off-by: Patrick Hodoul <[email protected]> * Revert previous changes; Impose the right overflow Signed-off-by: Patrick Hodoul <[email protected]> * Fix Python bindings Signed-off-by: Patrick Hodoul <[email protected]> * Use CI builds to print values on all machines/compilers Signed-off-by: Patrick Hodoul <[email protected]> * Use CI builds to print values on all machines/compilers, disable the prints Signed-off-by: Patrick Hodoul <[email protected]> * Use CI builds to print values on all machines/compilers, remove some prints Signed-off-by: Patrick Hodoul <[email protected]> * Use CI builds to print values on all machines/compilers, remove some prints Signed-off-by: Patrick Hodoul <[email protected]> * Use CI builds to print values on all machines/compilers, remove some prints Signed-off-by: Patrick Hodoul <[email protected]> * Use CI builds to print values on all machines/compilers, remove some prints Signed-off-by: Patrick Hodoul <[email protected]> * Use CI builds to print values on all machines/compilers, remove some prints Signed-off-by: Patrick Hodoul <[email protected]> * Try to bypass the AppleClang 11.0.3 bug Signed-off-by: Patrick Hodoul <[email protected]> * Try to bypass the AppleClang 11.0.3 bug Signed-off-by: Patrick Hodoul <[email protected]> * Try to bypass the AppleClang 11.0.3 bug Signed-off-by: Patrick Hodoul <[email protected]> * Try to bypass the AppleClang 11.0.3 bug Signed-off-by: Patrick Hodoul <[email protected]> * Try to bypass the AppleClang 11.0.3 bug Signed-off-by: Patrick Hodoul <[email protected]> * Try to bypass the AppleClang 11.0.3 bug Signed-off-by: Patrick Hodoul <[email protected]> * Try to bypass the AppleClang 11.0.3 bug Signed-off-by: Patrick Hodoul <[email protected]> * Try to bypass the AppleClang 11.0.3 bug Signed-off-by: Patrick Hodoul <[email protected]> * Try to bypass the AppleClang 11.0.3 bug Signed-off-by: Patrick Hodoul <[email protected]> * Warning when built-in camera transforms are not built Signed-off-by: Patrick Hodoul <[email protected]> * Improve the warning message Signed-off-by: Patrick Hodoul <[email protected]>
AcademySoftwareFoundation · May 12, 2020 · 406bae3 · 406bae3
1 parent 50f741f
commit 406bae3
Show file tree

Hide file tree

Showing 69 changed files with 3,696 additions and 483 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -111,6 +111,12 @@ endif()
 option(OCIO_USE_SSE "Specify whether to enable SSE CPU performance optimizations" ON)
 option(OCIO_INLINES_HIDDEN "Specify whether to build with -fvisibility-inlines-hidden" ${UNIX})
 
+###############################################################################
+# Supplemental builtins
+
+# Add supplemental built-in transformations such as camera related one.
+option(OCIO_ADD_EXTRA_BUILTINS "Specify whether to add supplemental built-in transforms" ON)
+
 ###############################################################################
 # Platform & Compiler dependent compilation flags
 

diff --git a/include/OpenColorIO/OpenColorIO.h b/include/OpenColorIO/OpenColorIO.h
@@ -1404,39 +1404,37 @@ class OCIOEXPORT Processor
  const char * getCacheID() const;
 
  //!cpp:function:: The ProcessorMetadata contains technical information
- //  such as the number of files and looks used in the processor.
+ // such as the number of files and looks used in the processor.
  ConstProcessorMetadataRcPtr getProcessorMetadata() const;
 
  //!cpp:function:: Get a FormatMetadata containing the top level metadata
- //  for the processor. For a processor from a CLF file,
- //  this corresponds to the ProcessList metadata.
+ // for the processor. For a processor from a CLF file, this corresponds to
+ // the ProcessList metadata.
  const FormatMetadata & getFormatMetadata() const;
 
  //!cpp:function:: Get the number of transforms that comprise the processor.
- //  Each transform has a (potentially empty) FormatMetadata.
+ // Each transform has a (potentially empty) FormatMetadata.
  int getNumTransforms() const;
  //!cpp:function:: Get a FormatMetadata containing the metadata for a
- // transform within the processor. For a processor from
- // a CLF file, this corresponds to the metadata associated
- // with an individual process node.
+ // transform within the processor. For a processor from a CLF file, this 
+ // corresponds to the metadata associated with an individual process node.
  const FormatMetadata & getTransformFormatMetadata(int index) const;
 
  //!cpp:function:: Return a cpp:class:`GroupTransform` that contains a
- //  copy of the transforms that comprise the processor.
- //  (Changes to it will not modify the original processor.)
+ // copy of the transforms that comprise the processor.
+ // (Changes to it will not modify the original processor.)
  GroupTransformRcPtr createGroupTransform() const;
 
  //!cpp:function:: Write the transforms comprising the processor to the stream.
- // Writing (as opposed to Baking) is a lossless process.
- // An exception is thrown if the processor cannot be
- // losslessly written to the specified file format.
+ // Writing (as opposed to Baking) is a lossless process. An exception is thrown
+ // if the processor cannot be losslessly written to the specified file format.
  void write(const char * formatName, std::ostream & os) const;
 
  //!cpp:function:: Get the number of writers.
  static int getNumWriteFormats();
 
  //!cpp:function:: Get the writer at index, return empty string if
- //  an invalid index is specified.
+ // an invalid index is specified.
  static const char * getFormatNameByIndex(int index);
  static const char * getFormatExtensionByIndex(int index);
 
@@ -2555,6 +2553,39 @@ class OCIOEXPORT Context
 
 extern OCIOEXPORT std::ostream& operator<< (std::ostream&, const Context&);
 
+
+///////////////////////////////////////////////////////////////////////////
+//!rst::
+// BuiltinTransformRegistry
+// ************************
+// The built-in transform registry contains all the existing built-in transforms which can
+// be used by a configuration (version 2 or higher only).
+
+//!cpp:class::
+class OCIOEXPORT BuiltinTransformRegistry
+{
+public:
+ //!cpp:function:: Get the current built-in transform registry.
+ static ConstBuiltinTransformRegistryRcPtr Get() noexcept;
+
+ //!cpp:function:: Get the number of built-in transforms available.
+ virtual size_t getNumBuiltins() const noexcept = 0;
+ //!cpp:function:: Get the style string for the i-th built-in transform.
+ // The style is the ID string that identifies a given transform.
+ virtual const char * getBuiltinStyle(size_t index) const = 0;
+ //!cpp:function:: Get the description string for the i-th built-in transform.
+ virtual const char * getBuiltinDescription(size_t index) const = 0;
+
+protected:
+ BuiltinTransformRegistry() = default;
+ virtual ~BuiltinTransformRegistry() = default;
+
+private:
+ BuiltinTransformRegistry(const BuiltinTransformRegistry &) = delete;
+ BuiltinTransformRegistry & operator= (const BuiltinTransformRegistry &) = delete;
+};
+
+
 } // namespace OCIO_NAMESPACE
 
 #endif // INCLUDED_OCIO_OPENCOLORIO_H
diff --git a/include/OpenColorIO/OpenColorTransforms.h b/include/OpenColorIO/OpenColorTransforms.h
@@ -173,6 +173,42 @@ class OCIOEXPORT AllocationTransform : public Transform
 extern OCIOEXPORT std::ostream& operator<< (std::ostream&, const AllocationTransform&);
 
 
+//!rst:: //////////////////////////////////////////////////////////////////
+
+//!cpp:class:: A built-in transform is similar to a FileTransform, but without the file.
+// OCIO knows how to build a set of commonly used transforms on-demand, thus avoiding the need
+// for external files and simplifying config authoring.
+class OCIOEXPORT BuiltinTransform : public Transform
+{
+public:
+ //!cpp:function::
+ static BuiltinTransformRcPtr Create();
+
+ //!cpp:function::
+ virtual const char * getStyle() const noexcept = 0;
+ //!cpp:function:: Select an existing built-in transform style from the list accessible
+ // through :cpp:class:`BuiltinTransformRegistry`. The style is the ID string that identifies
+ // which transform to apply.
+ virtual void setStyle(const char * style) = 0;
+
+ //!cpp:function::
+ virtual const char * getDescription() const noexcept = 0;
+
+ //!cpp:function:: To never use i.e. only needed for the Python bindings with pybind11. 
+ virtual ~BuiltinTransform() = default;
+
+protected:
+ BuiltinTransform() = default;
+
+private:
+ BuiltinTransform(const BuiltinTransform &) = delete;
+ BuiltinTransform & operator= (const BuiltinTransform &) = delete;
+};
+
+//!cpp:function::
+extern OCIOEXPORT std::ostream & operator<<(std::ostream &, const BuiltinTransform &) noexcept;
+
+
 //!rst:: //////////////////////////////////////////////////////////////////
 
 //!cpp:class:: An implementation of the ASC Color Decision List (CDL), based on the ASC v1.2

diff --git a/include/OpenColorIO/OpenColorTypes.h b/include/OpenColorIO/OpenColorTypes.h
@@ -121,6 +121,12 @@ typedef OCIO_SHARED_PTR<GpuShaderDesc> GpuShaderDescRcPtr;
 //!cpp:type::
 typedef OCIO_SHARED_PTR<const GpuShaderDesc> ConstGpuShaderDescRcPtr;
 
+class OCIOEXPORT BuiltinTransformRegistry;
+//!cpp:type::
+typedef OCIO_SHARED_PTR<BuiltinTransformRegistry> BuiltinTransformRegistryRcPtr;
+//!cpp:type::
+typedef OCIO_SHARED_PTR<const BuiltinTransformRegistry> ConstBuiltinTransformRegistryRcPtr;
+
 
 //!rst::
 // Transforms
@@ -138,6 +144,12 @@ typedef OCIO_SHARED_PTR<const AllocationTransform> ConstAllocationTransformRcPtr
 //!cpp:type::
 typedef OCIO_SHARED_PTR<AllocationTransform> AllocationTransformRcPtr;
 
+class OCIOEXPORT BuiltinTransform;
+//!cpp:type::
+typedef OCIO_SHARED_PTR<const BuiltinTransform> ConstBuiltinTransformRcPtr;
+//!cpp:type::
+typedef OCIO_SHARED_PTR<BuiltinTransform> BuiltinTransformRcPtr;
+
 class OCIOEXPORT CDLTransform;
 //!cpp:type::
 typedef OCIO_SHARED_PTR<const CDLTransform> ConstCDLTransformRcPtr;

diff --git a/src/OpenColorIO/Baker.cpp b/src/OpenColorIO/Baker.cpp
@@ -112,15 +112,18 @@ const char * Baker::getFormatExtensionByIndex(int index)
 
 void Baker::setFormat(const char * formatName)
 {
- FileFormat* fmt = FormatRegistry::GetInstance().getFileFormatByName(formatName);
- FormatInfoVec formatInfoVec;
- fmt->getFormatInfo(formatInfoVec);
- for(unsigned int i=0; i<formatInfoVec.size(); ++i)
+ FileFormat * fmt = FormatRegistry::GetInstance().getFileFormatByName(formatName);
+ if (fmt)
  {
- if(formatInfoVec[i].capabilities & FORMAT_CAPABILITY_BAKE)
+ FormatInfoVec formatInfoVec;
+ fmt->getFormatInfo(formatInfoVec);
+ for (unsigned int i = 0; i < formatInfoVec.size(); ++i)
  {
- getImpl()->m_formatName = formatName;
- return;
+ if (formatInfoVec[i].capabilities & FORMAT_CAPABILITY_BAKE)
+ {
+ getImpl()->m_formatName = formatName;
+ return;
+ }
  }
  }
 

diff --git a/src/OpenColorIO/CMakeLists.txt b/src/OpenColorIO/CMakeLists.txt
@@ -108,6 +108,11 @@ set(SOURCES
  ScanlineHelper.cpp
  Transform.cpp
  transforms/AllocationTransform.cpp
+ transforms/builtins/ACES.cpp
+ transforms/builtins/BuiltinTransformRegistry.cpp
+ transforms/builtins/ColorMatrixHelpers.cpp
+ transforms/builtins/OpHelpers.cpp
+ transforms/BuiltinTransform.cpp
  transforms/CDLTransform.cpp
  transforms/ColorSpaceTransform.cpp
  transforms/DisplayTransform.cpp
@@ -128,6 +133,20 @@ set(SOURCES
  ViewTransform.cpp
 )
 
+if(OCIO_ADD_EXTRA_BUILTINS)
+ set(SOURCES_BUILTINS
+ transforms/builtins/ArriCameras.cpp
+ transforms/builtins/CanonCameras.cpp
+ transforms/builtins/PanasonicCameras.cpp
+ transforms/builtins/RedCameras.cpp
+ transforms/builtins/SonyCameras.cpp
+ )
+
+ list(INSERT SOURCES 0 ${SOURCES_BUILTINS})
+else()
+ message(WARNING "Disabling supplemental built-in transforms removes all built-in camera transforms, limiting OCIO configuration compatibility.")
+endif()
+
 if(WIN32 AND BUILD_SHARED_LIBS)
 
  # Impose a versioned name on Windows to avoid binary name clashes
@@ -191,6 +210,13 @@ if(OCIO_USE_SSE)
  )
 endif()
 
+if(OCIO_ADD_EXTRA_BUILTINS)
+ target_compile_definitions(OpenColorIO
+ PRIVATE
+ ADD_EXTRA_BUILTINS
+ )
+endif()
+
 if(MSVC AND BUILD_TYPE_DEBUG AND BUILD_SHARED_LIBS)
  set_target_properties(OpenColorIO PROPERTIES
  PDB_NAME ${PROJECT_NAME}_${LIBNAME_SUFFIX}

diff --git a/src/OpenColorIO/Context.cpp b/src/OpenColorIO/Context.cpp
@@ -354,7 +354,7 @@ const char * Context::resolveFileLocation(const char * filename) const
  // Loop over each path, and try to find the file
  std::ostringstream errortext;
  errortext << "The specified file reference ";
- errortext << " '" << filename << "' could not be located. ";
+ errortext << "'" << filename << "' could not be located. ";
  errortext << "The following attempts were made: ";
 
  for (unsigned int i = 0; i < searchpaths.size(); ++i)
@@ -368,8 +368,9 @@ const char * Context::resolveFileLocation(const char * filename) const
  return getImpl()->m_resultsCache[filename].c_str();
  }
  if(i!=0) errortext << " : ";
- errortext << expandedfullpath;
+ errortext << "'" << expandedfullpath << "'";
  }
+ errortext << ".";
 
  throw ExceptionMissingFile(errortext.str().c_str());
 }

diff --git a/src/OpenColorIO/MathUtils.cpp b/src/OpenColorIO/MathUtils.cpp
@@ -1,6 +1,8 @@
 // SPDX-License-Identifier: BSD-3-Clause
 // Copyright Contributors to the OpenColorIO Project.
 
+
+#include <cmath>
 #include <sstream>
 #include <string.h>
 #include <type_traits>
@@ -504,7 +506,7 @@ bool FloatsDiffer(const float expected, const float actual,
  }
  }
 
- // TODO: Revisit the ULP comparison to use unsigned integers. 
+ // TODO: Revisit the ULP comparison to only use unsigned integers. 
 
  // Comparing regular floats.
  unsigned expectedBitsComp, actualBitsComp;

diff --git a/src/OpenColorIO/OCIOYaml.cpp b/src/OpenColorIO/OCIOYaml.cpp
@@ -476,6 +476,55 @@ inline void save(YAML::Emitter& out, ConstAllocationTransformRcPtr t)
  out << YAML::EndMap;
 }
 
+// BuiltinTransform
+
+inline void load(const YAML::Node & node, BuiltinTransformRcPtr & t)
+{
+ t = BuiltinTransform::Create();
+
+ std::string key;
+
+ for (const auto & iter : node)
+ {
+ const YAML::Node & first = iter.first;
+ const YAML::Node & second = iter.second;
+
+ load(first, key);
+
+ if (second.IsNull() || !second.IsDefined()) continue;
+
+ if (key == "style")
+ {
+ std::string transformStyle;
+ load(second, transformStyle);
+ t->setStyle(transformStyle.c_str());
+ }
+ else if (key == "direction")
+ {
+ TransformDirection dir = TRANSFORM_DIR_UNKNOWN;
+ load(second, dir);
+ t->setDirection(dir);
+ }
+ else
+ {
+ LogUnknownKeyWarning(node, first);
+ }
+ }
+}
+
+inline void save(YAML::Emitter & out, const ConstBuiltinTransformRcPtr & t)
+{
+ out << YAML::VerbatimTag("BuiltinTransform");
+ out << YAML::Flow << YAML::BeginMap;
+
+ out << YAML::Key << "style";
+ out << YAML::Value << YAML::Flow << t->getStyle();
+
+ EmitBaseTransformKeyValues(out, t);
+
+ out << YAML::EndMap;
+}
+
 // CDLTransform
 
 inline void load(const YAML::Node& node, CDLTransformRcPtr& t)
@@ -1922,6 +1971,12 @@ void load(const YAML::Node& node, TransformRcPtr& t)
  load(node, temp);
  t = temp;
  }
+ else if(type == "BuiltinTransform")
+ {
+ BuiltinTransformRcPtr temp;
+ load(node, temp);
+ t = temp;
+ }
  else if(type == "CDLTransform")
  {
  CDLTransformRcPtr temp;
@@ -2030,6 +2085,9 @@ void save(YAML::Emitter& out, ConstTransformRcPtr t)
  if(ConstAllocationTransformRcPtr Allocation_tran = \
  DynamicPtrCast<const AllocationTransform>(t))
  save(out, Allocation_tran);
+ else if (ConstBuiltinTransformRcPtr builtin_tran = \
+ DynamicPtrCast<const BuiltinTransform>(t))
+ save(out, builtin_tran);
  else if(ConstCDLTransformRcPtr CDL_tran = \
  DynamicPtrCast<const CDLTransform>(t))
  save(out, CDL_tran);

diff --git a/src/OpenColorIO/OpBuilders.h b/src/OpenColorIO/OpBuilders.h
@@ -26,6 +26,11 @@ void BuildAllocationOp(OpRcPtrVec & ops,
  const AllocationTransform & transform,
  TransformDirection dir);
 
+void BuildBuiltinOps(OpRcPtrVec & ops,
+ const Config & config,
+ const BuiltinTransform & transform,
+ TransformDirection dir);
+
 void BuildCDLOp(OpRcPtrVec & ops,
  const Config & config,
  const CDLTransform & transform,

diff --git a/src/OpenColorIO/Processor.cpp b/src/OpenColorIO/Processor.cpp
@@ -316,7 +316,7 @@ void Processor::Impl::write(const char * formatName, std::ostream & os) const
  catch (std::exception & e)
  {
  std::ostringstream err;
- err << "Error writing " << formatName << ":";
+ err << "Error writing format '" << formatName << "': ";
  err << e.what();
  throw Exception(err.str().c_str());
  }