Merge branch 'main' into fix/host-prop-type

Signed-off-by: Gary Oberbrunner <[email protected]>

Author: garyo

.github/workflows/build.yml

@@ -41,7 +41,8 @@ jobs:
             need_node20_vol: true
             has_cmake_presets: false
             buildtype: Release
-            conan_version: 2.1.0
+            # use old conan version for CentOS 7
+            conan_version: 2.10.3
             cxx-standard: 17
             cxx-compiler: clang++
             cc-compiler: clang
@@ -58,7 +59,8 @@ jobs:
             need_node20_vol: true
             has_cmake_presets: false
             buildtype: Release
-            conan_version: 2.1.0
+            # use old conan version for CentOS 7
+            conan_version: 2.10.3
             cxx-standard: 17
             cxx-compiler: clang++
             cc-compiler: clang
@@ -74,7 +76,7 @@ jobs:
             vfx-cy: 2023
             has_cmake_presets: false
             buildtype: Release
-            conan_version: 2.1.0
+            conan_version: 2.20.1
             cxx-standard: 17
             cxx-compiler: clang++
             cc-compiler: clang
@@ -90,7 +92,7 @@ jobs:
             vfx-cy: 2023
             has_cmake_presets: false
             buildtype: Release
-            conan_version: 2.1.0
+            conan_version: 2.20.1
             cxx-standard: 17
             cxx-compiler: clang++
             cc-compiler: clang
@@ -103,7 +105,7 @@ jobs:
             os: ubuntu-latest
             has_cmake_presets: true
             buildtype: Release
-            conan_version: 2.1.0
+            conan_version: 2.20.1
             cxx-standard: 17
             cxx-compiler: clang++
             cc-compiler: clang
@@ -116,7 +118,7 @@ jobs:
             os: macos-latest
             has_cmake_presets: true
             buildtype: Release
-            conan_version: 2.1.0
+            conan_version: 2.20.1
             cxx-standard: 17
             cxx-compiler: clang++
             cc-compiler: clang
@@ -129,7 +131,7 @@ jobs:
             os: windows-latest
             has_cmake_presets: true
             buildtype: Release
-            conan_version: 2.1.0
+            conan_version: 2.20.1
             cxx-standard: 17
             cxx-compiler: clang++
             cc-compiler: clang
@@ -142,7 +144,7 @@ jobs:
             os: windows-latest
             has_cmake_presets: true
             buildtype: Release
-            conan_version: 2.0.16
+            conan_version: 2.20.1
             cxx-standard: 17
             cxx-compiler: clang++
             cc-compiler: clang

CONTRIBUTING.md

@@ -18,7 +18,7 @@ Committee provides general project oversight.
 There are several ways to connect with the OpenFX project:
 
 * The [openfx-discussion](https://lists.aswf.io/g/openfx-discussion)
-  mail list: This is our primary mailing list, intended for techical
+  mail list: This is our primary mailing list, intended for technical
   discussion and help implementing and using OpenFX.
 
 * [GitHub Issues](https://github.com/ofxa/openfx/issues): GitHub
@@ -273,9 +273,19 @@ All new source files should begin with a copyright and license stating:
 
     //
     // SPDX-License-Identifier: BSD-3-Clause
-    // Copyright (c) Contributors to the OpenFX Project.
+    // Copyright (c) OpenFX and contributors to the OpenFX Project.
     //
 
+Prior to becoming an ASWF project, OpenFX was controlled by The Open Effects
+Association, a legal entity which had been assigned copyright in the original
+contributions by a variety of companies and individuals. When the project
+transferred to ASWF, these copyrights were assigned to a new legal entity, 
+OpenFX a Series of LF Projects, LLC (abbreviated to "OpenFX" in the notice).
+In line with ASWF principles, new contributions do not require a copyright
+assignment, but our copyright notice reflects this mixed history, and is 
+applied consistently across the project to avoid confusion when code is moved
+between old and new files.
+
 #### Third-party libraries
 
 The standard itself should not depend on any third-party library or

Documentation/build.sh

@@ -22,37 +22,44 @@ if [ ! -f genPropertiesReference.py ] ; then
     exit 1
 fi
 
-if ! command -v sphinx-build > /dev/null 2>&1 ; then
-    echo "Python can't import required modules; did you set up the prereqs?"
-    echo "Check the README.md."
-    exit 1
+if command -v uvx > /dev/null 2>&1; then
+    USE_UV=1
+    SPHINX_BUILD="uv run --with-requirements pipreq.txt sphinx-build"
+    UV_RUN="uv run"
+else
+    USE_UV=
+    SPHINX_BUILD="sphinx-build"
+    UV_RUN=""
 fi
 
 rm -rf build
 
 # Generate references
 EXPECTED_ERRS="unable to resolve reference|explicit link request|found in multiple"
-python genPropertiesReference.py \
+$UV_RUN python genPropertiesReference.py \
        -i ../include -o sources/Reference/ofxPropertiesReference.rst -r \
        > /tmp/ofx-doc-build.out 2>&1
-egrep -v "$EXPECTED_ERRS" /tmp/ofx-doc-build.out || true
+grep -v -E "$EXPECTED_ERRS" /tmp/ofx-doc-build.out || true
 
 # Build the Doxygen docs
 EXPECTED_ERRS="malformed hyperlink target|Duplicate explicit|Definition list ends|unable to resolve|could not be resolved"
 cd ../include
 doxygen ofx.doxy > /tmp/ofx-doc-build.out 2>&1
-egrep -v "$EXPECTED_ERRS" /tmp/ofx-doc-build.out || true
+grep -v -E "$EXPECTED_ERRS" /tmp/ofx-doc-build.out || true
 cd -
 
 # Use breathe.apidoc to collect the Doxygen API docs
 rm -rf sources/Reference/api
-python -m breathe.apidoc -p 'ofx_reference' -m --force -g class,interface,struct,union,file,namespace,group -o sources/Reference/api doxygen_build/xml
-
+if [[ $USE_UV ]]; then
+    $UV_RUN --with breathe python -m breathe.apidoc -p 'ofx_reference' -m --force -g class,interface,struct,union,file,namespace,group -o sources/Reference/api doxygen_build/xml
+else
+    python -m breathe.apidoc -p 'ofx_reference' -m --force -g class,interface,struct,union,file,namespace,group -o sources/Reference/api doxygen_build/xml
+fi
 
 # Build the Sphinx docs
 EXPECTED_ERRS='Explicit markup ends without|Duplicate C.*declaration|Declaration is|cpp:func targets a member|undefined label'
-sphinx-build -b html sources build > /tmp/ofx-doc-build.out 2>&1
-egrep -v "$EXPECTED_ERRS" /tmp/ofx-doc-build.out || true
+$SPHINX_BUILD -b html sources build > /tmp/ofx-doc-build.out 2>&1
+grep -v -E "$EXPECTED_ERRS" /tmp/ofx-doc-build.out || true
 
 echo "Documentation build complete."
 echo "Open file:///$PWD/build/index.html in your browser"

Documentation/genPropertiesReference.py

@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: BSD-3-Clause
 
-import os,sys, getopt,re
+import os,sys,getopt
 
 badlyNamedProperties = ["kOfxImageEffectFrameVarying", "kOfxImageEffectPluginRenderThreadSafety"]
 

Documentation/sourceforge/index.html

@@ -33,7 +33,7 @@ <h3>Programming Reference </h3>
 
 <h3>Doxygen Documentation </h3>
 <para>
-The doxygen documentation extracted from the header files is a useful adjunct to the programmming reference. It is available in two forms...
+The doxygen documentation extracted from the header files is a useful adjunct to the programming reference. It is available in two forms...
 <ul>
 <li><a href="Doxygen/index.html">A set of HTML files, one per section,</a></li>
 <li><a href="ofxDoxygenDocs_1.3.tgz">A tarball of the set of HTML files (229K).</a></li>

Documentation/sources/Guide/Code/Example1/basics.cpp

@@ -86,7 +86,7 @@ namespace {
   int  gNumInstancesLiving = 0;
 
   ////////////////////////////////////////////////////////////////////////////////
-  // The first _action_ called after the binary is loaded (three boot strapper functions will be howeever)
+  // The first _action_ called after the binary is loaded (three boot strapper functions will be however)
   OfxStatus LoadAction(void)
   {
     ERROR_ABORT_IF(gHost == NULL, "The OfxHost pointer has not been set, it should have been set in 'setHostFunc' before any action is called.");
@@ -152,7 +152,7 @@ namespace {
     char *context;
     gPropertySuite->propGetString(inArgs, kOfxImageEffectPropContext, 0, &context);
 
-    ERROR_IF(strcmp(context, kOfxImageEffectContextFilter) != 0, "DescribeInContextAction called on unsupported contex %s", context);
+    ERROR_IF(strcmp(context, kOfxImageEffectContextFilter) != 0, "DescribeInContextAction called on unsupported context %s", context);
 
     OfxPropertySetHandle props;
     // define the mandated single output clip
@@ -300,7 +300,7 @@ namespace {
 static OfxPlugin effectPluginStruct =
 {
   kOfxImageEffectPluginApi,                // The API this plugin satisfies.
-  1,                                       // The version of the API it satisifes.
+  1,                                       // The version of the API it satisfies.
   "org.openeffects:BasicsExamplePlugin",   // The unique ID of this plugin.
   1,                                       // The major version number of this plugin.
   0,                                       // The minor version number of this plugin.

Documentation/sources/Guide/Code/Example2/invert.cpp

@@ -73,7 +73,7 @@ namespace {
   OfxImageEffectSuiteV1 *gImageEffectSuite = 0;
 
   ////////////////////////////////////////////////////////////////////////////////
-  // The first _action_ called after the binary is loaded (three boot strapper functions will be howeever)
+  // The first _action_ called after the binary is loaded (three boot strapper functions will be however)
   OfxStatus LoadAction(void)
   {
     /// now fetch a suite out of the host via it's fetch suite function.
@@ -426,7 +426,7 @@ namespace {
 static OfxPlugin effectPluginStruct =
 {
   kOfxImageEffectPluginApi,                // The API this plugin satisfies.
-  1,                                       // The version of the API it satisifes.
+  1,                                       // The version of the API it satisfies.
   "org.openeffects:InvertExamplePlugin",   // The unique ID of this plugin.
   1,                                       // The major version number of this plugin.
   0,                                       // The minor version number of this plugin.

Documentation/sources/Guide/Code/Example3/gain.cpp

@@ -131,7 +131,7 @@ namespace {
   }
 
   ////////////////////////////////////////////////////////////////////////////////
-  // The first _action_ called after the binary is loaded (three boot strapper functions will be howeever)
+  // The first _action_ called after the binary is loaded (three boot strapper functions will be however)
   OfxStatus LoadAction(void)
   {
     // fetch our three suites
@@ -648,7 +648,7 @@ namespace {
 static OfxPlugin effectPluginStruct =
 {
   kOfxImageEffectPluginApi,                // The API this plugin satisfies.
-  1,                                       // The version of the API it satisifes.
+  1,                                       // The version of the API it satisfies.
   "org.openeffects:GainExamplePlugin",     // The unique ID of this plugin.
   1,                                       // The major version number of this plugin.
   0,                                       // The minor version number of this plugin.

Documentation/sources/Guide/Code/Example4/saturation.cpp

@@ -287,7 +287,7 @@ namespace {
   }
 
   ////////////////////////////////////////////////////////////////////////////////
-  // The first _action_ called after the binary is loaded (three boot strapper functions will be howeever)
+  // The first _action_ called after the binary is loaded (three boot strapper functions will be however)
   OfxStatus LoadAction(void)
   {
     // fetch our three suites
@@ -779,7 +779,7 @@ namespace {
 static OfxPlugin effectPluginStruct =
 {
   kOfxImageEffectPluginApi,                  // The API this plugin satisfies.
-  1,                                         // The version of the API it satisifes.
+  1,                                         // The version of the API it satisfies.
   "org.openeffects:SaturationExamplePlugin", // The unique ID of this plugin.
   1,                                         // The major version number of this plugin.
   0,                                         // The minor version number of this plugin.

Documentation/sources/Guide/Code/Example5/circle.cpp

@@ -318,7 +318,7 @@ namespace {
   }
 
   ////////////////////////////////////////////////////////////////////////////////
-  // The first _action_ called after the binary is loaded (three boot strapper functions will be howeever)
+  // The first _action_ called after the binary is loaded (three boot strapper functions will be however)
   OfxStatus LoadAction(void)
   {
     // fetch our three suites
@@ -978,7 +978,7 @@ namespace {
 static OfxPlugin effectPluginStruct =
 {
   kOfxImageEffectPluginApi,                  // The API this plugin satisfies.
-  1,                                         // The version of the API it satisifes.
+  1,                                         // The version of the API it satisfies.
   "org.openeffects:CircleExamplePlugin",     // The unique ID of this plugin.
   1,                                         // The major version number of this plugin.
   0,                                         // The minor version number of this plugin.