Merge remote-tracking branch 'origin/main' into props-metadata

Signed-off-by: Gary Oberbrunner <[email protected]>
AcademySoftwareFoundation · Oct 1, 2024 · 54c6459 · 54c6459
2 parents 4f99557 + a8f10e1
commit 54c6459
Show file tree

Hide file tree

Showing 61 changed files with 225 additions and 48 deletions.
diff --git a/.github/workflows/release-sign.yml b/.github/workflows/release-sign.yml
@@ -0,0 +1,71 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright (c) Contributors to the OpenFX Project.
+
+#
+# Releases are signed via https://github.com/sigstore/sigstore-python.
+# See https://docs.sigstore.dev for information about sigstore.
+#
+# This action creates a .tar.gz of the complete OpenFX source tree at
+# the given release tag, signs it via sigstore, and uploads the
+# .tar.gz and the associated .tar.gz.sigstore credential bundle.
+#
+# To verify a downloaded release at a given tag:
+# 
+#   % pip install sigstore
+#   % sigstore verify github --cert-identity https://github.com/AcademySoftwareFoundation/openfx/.github/workflows/release-sign.yml@refs/tags/<tag> openfx-<tag>.tar.gz
+#
+
+name: Sign Release
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  release:
+    name: Sign & upload release artifacts
+    runs-on: ubuntu-latest
+
+    env:
+       TAG: ${{ github.ref_name == 'main' && 'OFX_Release_1.5' || github.ref_name }}
+    permissions:
+      contents: write
+      id-token: write
+      repository-projects: write
+
+    steps:
+
+      - name: Set Prefix
+        # The tag name begins with a 'v', e.g. "v3.2.4", but the prefix
+        # should omit the 'v', so the tarball "openfx-3.2.4.tar.gz"
+        # extracts files into "openfx-v3.2.4/...".  This matches
+        # the GitHub release page autogenerated artifact conventions.
+        run: |
+          echo OPENFX_PREFIX=openfx-${TAG//OFX_Release_}/ >> $GITHUB_ENV
+          echo OPENFX_TARBALL=openfx-${TAG//OFX_Release_}.tar.gz >> $GITHUB_ENV
+        shell: bash
+
+      - name: Checkout
+        uses: actions/[email protected]
+        with:
+          fetch-depth: 10         # use this if tag is older than current head
+          fetch-tags: true
+
+      - name: Create archive
+        run: git archive --format=tar.gz -o ${OPENFX_TARBALL} --prefix ${OPENFX_PREFIX} ${TAG}
+
+      - name: Sign archive with Sigstore
+        uses: sigstore/gh-action-sigstore-python@f514d46b907ebcd5bedc05145c03b69c1edd8b46 # v3.0.0
+        with:
+          inputs: ${{ env.OPENFX_TARBALL }}
+          upload-signing-artifacts: false
+          release-signing-artifacts: false
+
+      - name: Upload release archive
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: gh release upload ${TAG} ${OPENFX_TARBALL} ${OPENFX_TARBALL}.sigstore.json
diff --git a/Documentation/genPropertiesReference.py b/Documentation/genPropertiesReference.py
@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: BSD-3-Clause
+
 import os,sys, getopt,re
 
 badlyNamedProperties = ["kOfxImageEffectFrameVarying", "kOfxImageEffectPluginRenderThreadSafety"]

diff --git a/Documentation/sources/Guide/index.rst b/Documentation/sources/Guide/index.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 OpenFX Programming Guide
 ========================
 

diff --git a/Documentation/sources/Guide/ofxExample1_Basics.rst b/Documentation/sources/Guide/ofxExample1_Basics.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _basicExample:
 
 This is a guide to the basic machinery an OFX plugin uses to communicate

diff --git a/Documentation/sources/Guide/ofxExample2_Invert.rst b/Documentation/sources/Guide/ofxExample2_Invert.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _invertExample:
 
 This guide will take you through the fundamentals of processing images

diff --git a/Documentation/sources/Guide/ofxExample3_Gain.rst b/Documentation/sources/Guide/ofxExample3_Gain.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _gainExample:
 
 This guide will take you through the basics of creating and using

diff --git a/Documentation/sources/Guide/ofxExample4_Saturation.rst b/Documentation/sources/Guide/ofxExample4_Saturation.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _saturationExample:
 
 This guide will take you through the basics of creating effects that can

diff --git a/Documentation/sources/Guide/ofxExample5_Circle.rst b/Documentation/sources/Guide/ofxExample5_Circle.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _circleExample:
 
 This guide will introduce the spatial coordinate system used by OFX and

diff --git a/Documentation/sources/Guide/ofxExamples.rst b/Documentation/sources/Guide/ofxExamples.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 Foreword
 ========
 

diff --git a/Documentation/sources/Reference/DoxygenIndex.rst b/Documentation/sources/Reference/DoxygenIndex.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _doxygenIndex:
 
 ==============================

diff --git a/Documentation/sources/Reference/apiChanges_1_2_Chapter.rst b/Documentation/sources/Reference/apiChanges_1_2_Chapter.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 Changes to the API for 1.2
 ==========================
 

diff --git a/Documentation/sources/Reference/index.rst b/Documentation/sources/Reference/index.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 OpenFX reference
 ================
 

diff --git a/Documentation/sources/Reference/ofxClipPreferences.rst b/Documentation/sources/Reference/ofxClipPreferences.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _ImageEffectClipPreferences:
 
 Image Effect Clip Preferences

diff --git a/Documentation/sources/Reference/ofxCoordSystem.rst b/Documentation/sources/Reference/ofxCoordSystem.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. CoordinateSystems:
 Coordinate Systems
 ==================

diff --git a/Documentation/sources/Reference/ofxCoreAPI.rst b/Documentation/sources/Reference/ofxCoreAPI.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 The Generic Core API
 ====================
 

diff --git a/Documentation/sources/Reference/ofxHostStruct.rst b/Documentation/sources/Reference/ofxHostStruct.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxHost:
 
 The OfxHost Struct
@@ -32,4 +33,4 @@ suite, or NULL if it does not support it. Please note that a suite
 cannot be fetched until the very first action is called on the plug-in,
 which is the load action.
 
-.. doxygenstruct:: OfxHost
+.. doxygenstruct:: OfxHost
diff --git a/Documentation/sources/Reference/ofxImageClip.rst b/Documentation/sources/Reference/ofxImageClip.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _imageClip:
 Images and Clips
 ================

diff --git a/Documentation/sources/Reference/ofxImageEffectAPI.rst b/Documentation/sources/Reference/ofxImageEffectAPI.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 The Image Effect API
 ====================
 

diff --git a/Documentation/sources/Reference/ofxImageEffectActions.rst b/Documentation/sources/Reference/ofxImageEffectActions.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _ImageEffectActions:
 
 Actions Passed to An Image Effect

diff --git a/Documentation/sources/Reference/ofxImageEffectContexts.rst b/Documentation/sources/Reference/ofxImageEffectContexts.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _imageEffectContexts:
 Image Effect Contexts
 =====================

diff --git a/Documentation/sources/Reference/ofxInteractActions.rst b/Documentation/sources/Reference/ofxInteractActions.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. InteractActions:
 
 Actions Passed to an Interact

diff --git a/Documentation/sources/Reference/ofxInteracts.rst b/Documentation/sources/Reference/ofxInteracts.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 Interacts
 =========
 

diff --git a/Documentation/sources/Reference/ofxLoadingSequence.rst b/Documentation/sources/Reference/ofxLoadingSequence.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 Sequences of Operations Required to Load a Plug-in
 ---------------------------------------------------
 

diff --git a/Documentation/sources/Reference/ofxPackaging.rst b/Documentation/sources/Reference/ofxPackaging.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 Packaging OFX Plug-ins
 ======================
 

diff --git a/Documentation/sources/Reference/ofxParameter.rst b/Documentation/sources/Reference/ofxParameter.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 Effect Parameters
 =================
 

diff --git a/Documentation/sources/Reference/ofxPluginStruct.rst b/Documentation/sources/Reference/ofxPluginStruct.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxPlugin:
 
 The OfxPlugin Struct

diff --git a/Documentation/sources/Reference/ofxProcessingArch.rst b/Documentation/sources/Reference/ofxProcessingArch.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 Image Processing Architectures
 ==============================
 

diff --git a/Documentation/sources/Reference/ofxPropertiesByObject.rst b/Documentation/sources/Reference/ofxPropertiesByObject.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. warning::
 
     This section is outdated and should be properly generated automatically from source code instead

diff --git a/Documentation/sources/Reference/ofxPropertiesReference.rst b/Documentation/sources/Reference/ofxPropertiesReference.rst
@@ -49,8 +49,18 @@ Properties Reference
 
 .. doxygendefine:: kOfxImageEffectPropColourManagementAvailableConfigs
 
+.. doxygendefine:: kOfxImageEffectPropColourManagementBasic
+
 .. doxygendefine:: kOfxImageEffectPropColourManagementConfig
 
+.. doxygendefine:: kOfxImageEffectPropColourManagementCore
+
+.. doxygendefine:: kOfxImageEffectPropColourManagementFull
+
+.. doxygendefine:: kOfxImageEffectPropColourManagementNone
+
+.. doxygendefine:: kOfxImageEffectPropColourManagementOCIO
+
 .. doxygendefine:: kOfxImageEffectPropColourManagementStyle
 
 .. doxygendefine:: kOfxImageEffectPropComponents

diff --git a/Documentation/sources/Reference/ofxRendering.rst b/Documentation/sources/Reference/ofxRendering.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 Rendering
 =========
 

diff --git a/Documentation/sources/Reference/ofxStatusCodes.rst b/Documentation/sources/Reference/ofxStatusCodes.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _statusCodes:
 
 Status Codes

diff --git a/Documentation/sources/Reference/ofxStructure.rst b/Documentation/sources/Reference/ofxStructure.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 Structure of The OFX and the Image Effect API
 =============================================
 

diff --git a/Documentation/sources/Reference/ofxThreadSafety.rst b/Documentation/sources/Reference/ofxThreadSafety.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _threadRecursionSafety:
 Thread and Recursion Safety
 ===========================

diff --git a/Documentation/sources/Reference/suites/ofxDrawSuiteReference.rst b/Documentation/sources/Reference/suites/ofxDrawSuiteReference.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxDrawSuiteV1:
 OfxDrawSuiteV1: Drawing Overlays
 ================================

diff --git a/Documentation/sources/Reference/suites/ofxImageEffectSuiteReference.rst b/Documentation/sources/Reference/suites/ofxImageEffectSuiteReference.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxImageEffectSuiteV1:
 OfxImageEffectSuiteV1
 =====================

diff --git a/Documentation/sources/Reference/suites/ofxInteractSuiteReference.rst b/Documentation/sources/Reference/suites/ofxInteractSuiteReference.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxInteractSuiteV1:
 OfxInteractSuiteV1
 ==================

diff --git a/Documentation/sources/Reference/suites/ofxMemorySuiteReference.rst b/Documentation/sources/Reference/suites/ofxMemorySuiteReference.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxMemorySuiteV1:
 OfxMemorySuiteV1
 ================

diff --git a/Documentation/sources/Reference/suites/ofxMessageSuiteV1Reference.rst b/Documentation/sources/Reference/suites/ofxMessageSuiteV1Reference.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxMessageSuiteV1:
 OfxMessageSuiteV1
 =================

diff --git a/Documentation/sources/Reference/suites/ofxMessageSuiteV2Reference.rst b/Documentation/sources/Reference/suites/ofxMessageSuiteV2Reference.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxMessageSuiteV2:
 OfxMessageSuiteV2
 =================

diff --git a/Documentation/sources/Reference/suites/ofxOpenGLRenderSuiteReference.rst b/Documentation/sources/Reference/suites/ofxOpenGLRenderSuiteReference.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxImageEffectOpenGLRenderSuiteV1:
 OfxImageEffectOpenGLRenderSuiteV1
 =================================

diff --git a/Documentation/sources/Reference/suites/ofxParametersSuiteReference.rst b/Documentation/sources/Reference/suites/ofxParametersSuiteReference.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxParameterSuiteV1:
 OfxParameterSuiteV1
 ===================

diff --git a/Documentation/sources/Reference/suites/ofxParametricParamReference.rst b/Documentation/sources/Reference/suites/ofxParametricParamReference.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxParametricParameterSuiteV1:
 OfxParametricParameterSuiteV1
 =============================

diff --git a/Documentation/sources/Reference/suites/ofxProgressSuiteReference.rst b/Documentation/sources/Reference/suites/ofxProgressSuiteReference.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxProgressSuiteV1:
 OfxProgressSuiteV1
 ==================

diff --git a/Documentation/sources/Reference/suites/ofxPropertySuiteReference.rst b/Documentation/sources/Reference/suites/ofxPropertySuiteReference.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxPropertySuiteV1:
 OfxPropertySuiteV1
 ==================

diff --git a/Documentation/sources/Reference/suites/ofxSuiteReference.rst b/Documentation/sources/Reference/suites/ofxSuiteReference.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _suitesReference:
 
 OpenFX suites reference

diff --git a/Documentation/sources/Reference/suites/ofxThreadingSuiteReference.rst b/Documentation/sources/Reference/suites/ofxThreadingSuiteReference.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxMultiThreadSuiteV1:
 OfxMultiThreadSuiteV1
 =====================

diff --git a/Documentation/sources/Reference/suites/ofxTimeLineSuiteReference.rst b/Documentation/sources/Reference/suites/ofxTimeLineSuiteReference.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxTimeLineSuiteV1:
 OfxTimeLineSuiteV1
 ==================

diff --git a/Documentation/sources/ReleaseNotes/index.rst b/Documentation/sources/ReleaseNotes/index.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 OpenFX Release Notes
 ====================
 

diff --git a/Documentation/sources/ReleaseNotes/relnotes-1.4.rst b/Documentation/sources/ReleaseNotes/relnotes-1.4.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 OpenFX Release Notes for V1.4
 =============================
 
@@ -43,5 +44,5 @@ Removals
 - :c:macro:`kOfxInteractPropViewportSize`
 - :c:macro:`kOfxParamPropPluginMayWrite`
 - :c:macro:`kOfxImageEffectPropInAnalysis`
-- :c:macro:`kOfxParamDoubleTypeNormalised*` - removed in favor of :c:macro:`kOfxParamDoubleType*`
+- :c:macro:`kOfxParamDoubleTypeNormalised` - removed in favor of :c:macro:`kOfxParamDoubleType`
 
diff --git a/Documentation/sources/ReleaseNotes/relnotes-1.5.rst b/Documentation/sources/ReleaseNotes/relnotes-1.5.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 OpenFX Release Notes for V1.5
 =============================
 

diff --git a/Documentation/sources/conf.py b/Documentation/sources/conf.py
@@ -7,6 +7,8 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
+# SPDX-License-Identifier: BSD-3-Clause
+
 import subprocess, os, shutil
 project = 'OpenFX'
 copyright = '2024, Contributors to the OpenFX Project'

diff --git a/Documentation/sources/index.rst b/Documentation/sources/index.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. OpenFX documentation master file, created by
    sphinx-quickstart on Tue Mar 29 18:02:16 2016.
    You can adapt this file completely to your liking, but it should at least
@@ -15,15 +16,11 @@ The OpenFX documentation is organized as follows:
 - The :doc:`release notes<ReleaseNotes/index>` contains release notes, documenting changes in recent OpenFX releases.
 
 This documentation is also
-`available online <http://openfx.readthedocs.io/en/master/>`__
-and can be downloaded as a
-`PDF <https://readthedocs.org/projects/openfx/downloads/pdf/master/>`_ or
-`HTML zip <https://readthedocs.org/projects/openfx/downloads/htmlzip/master/>`__
-file.
+`available online <https://docs.openeffects.org>`__.
 
 This manual is maintained largely by volunteers.
 
-The `Creative Commons Attribution-ShareAlike 4.0 International License (CC-BY-SA 4.0) <https://creativecommons.org/licenses/by-sa/4.0/>`_ is used for this manual, which is a free and open license. Though there are certain restrictions that come with this license you may in general freely reproduce it and even make changes to it. However, rather than distribute your own version of this manual, we would much prefer if you would send any corrections or changes to the OpenFX association.
+The `Creative Commons Attribution 4.0 International License (CC-BY 4.0) <https://creativecommons.org/licenses/by/4.0/>`_ is used for this manual, which is a free and open license. Though there are certain restrictions that come with this license you may in general freely reproduce it and even make changes to it. However, rather than distribute your own version of this manual, we would much prefer if you would send any corrections or changes to the OpenFX maintainers.
 
 .. toctree::
     :maxdepth: 1