Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
 Cédrik Fuoco
|
e670cd98d7 | ||
|
Patrick HodoulandDoug Walker
|
d115b2534f | ||
|
Thomas Mansencal
|
e28a06c000 | ||
|
Patrick Hodoul
|
9af47cbb7a | ||
|
Patrick Hodoul
|
e5068b77dc | ||
|
|
3ba4f95742 | ||
|
Patrick HodoulandRémi Achard
|
03cb778548 | ||
|
Patrick Hodoul
|
bb28982ded | ||
|
Patrick Hodoul
|
7ffc349e66 | ||
|
Patrick Hodoulandamyspark
|
54e721268c | ||
|
Patrick Hodoul
|
2ad08a6fe8 | ||
|
Patrick Hodoul
|
32b01f64d6 | ||
|
Brendan BollesandPatrick Hodoul
|
3f2bcfb3c4 | ||
|
Patrick Hodoulanddoug-walker
|
05f5beed59 | ||
|
|
86a2aac56f | ||
|
|
ffba80b34c | ||
|
Patrick Hodoulanddoug-walker
|
0c2aacb6c9 | ||
|
Patrick Hodoulandamyspark
|
6c8cf83375 | ||
|
Patrick Hodoul
|
7a76cceb57 | ||
|
Rémi Achard
|
b37089aefb | ||
|
|
177a927ff5 | ||
|
Patrick Hodoul
|
a64e4d5d48 | ||
|
Patrick HodoulandMei Chu
|
198c888ee9 | ||
|
Patrick Hodoulanditsmattkc
|
b252372b7c | ||
|
Patrick Hodoul
|
17e52e38c6 | ||
|
Patrick HodoulandGuillaume Papin
|
7360206858 | ||
|
|
934b80829b | ||
|
Patrick HodoulandRémi Achard
|
36845c3f32 | ||
|
Patrick HodoulandHenry Schreiner
|
2d318af010 | ||
|
Patrick HodoulandBo Zhou
|
445c45b016 | ||
|
Rémi AchardandPatrick Hodoul
|
d950ab4bf7 | ||
|
Patrick Hodoulandamyspark
|
d331992d93 | ||
|
Patrick Hodoul
|
9c5a324184 | ||
|
Patrick Hodoul
|
2716337500 | ||
|
Patrick Hodoulandamyspark
|
30ac2904e3 | ||
|
Patrick Hodoulandamyspark
|
ce3042cd10 | ||
|
Patrick Hodoul
|
15ffc9a414 | ||
|
Patrick HodoulandRémi Achard
|
7ec43b7d93 | ||
|
Patrick Hodoul
|
83d3412ff2 | ||
|
Patrick Hodoul
|
156d4ffda0 |
@@ -7,21 +7,124 @@
|
||||
name: Analysis
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches-ignore:
|
||||
- RB-0.*
|
||||
- RB-1.*
|
||||
- gh-pages
|
||||
tags-ignore:
|
||||
- v0.*
|
||||
- v1.*
|
||||
paths:
|
||||
- .github/workflows/analysis_workflow.yml
|
||||
schedule:
|
||||
# Nightly build
|
||||
- cron: "0 0 * * *"
|
||||
|
||||
jobs:
|
||||
# ---------------------------------------------------------------------------
|
||||
# Latest ext packages
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
linux_latest:
|
||||
name: 'Linux CentOS 7 VFX CY${{ matrix.vfx-cy }} latest
|
||||
<${{ matrix.compiler-desc }}
|
||||
cxx=${{ matrix.cxx-standard }},
|
||||
docs=${{ matrix.build-docs }}>'
|
||||
# Don't run on OCIO forks
|
||||
if: github.repository == 'AcademySoftwareFoundation/OpenColorIO'
|
||||
# GH-hosted VM. The build runs in CentOS 7 'container' defined below.
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
# DockerHub: https://hub.docker.com/u/aswf
|
||||
# Source: https://github.com/AcademySoftwareFoundation/aswf-docker
|
||||
image: aswf/ci-base:${{ matrix.vfx-cy }}
|
||||
strategy:
|
||||
matrix:
|
||||
build: [1, 2, 3, 4]
|
||||
include:
|
||||
# -------------------------------------------------------------------
|
||||
# GCC
|
||||
# -------------------------------------------------------------------
|
||||
# VFX CY2022, C++17, docs, OpenFX
|
||||
- build: 1
|
||||
build-docs: 'ON'
|
||||
build-openfx: 'ON'
|
||||
cxx-standard: 17
|
||||
cxx-compiler: g++
|
||||
cc-compiler: gcc
|
||||
compiler-desc: GCC 9.3.1
|
||||
vfx-cy: 2022
|
||||
# VFX CY2021, C++14
|
||||
- build: 2
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'OFF'
|
||||
cxx-standard: 14
|
||||
cxx-compiler: g++
|
||||
cc-compiler: gcc
|
||||
compiler-desc: GCC 9.3.1
|
||||
vfx-cy: 2021
|
||||
# -------------------------------------------------------------------
|
||||
# Clang
|
||||
# -------------------------------------------------------------------
|
||||
# VFX CY2022, C++17
|
||||
- build: 3
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'OFF'
|
||||
cxx-standard: 17
|
||||
cxx-compiler: clang++
|
||||
cc-compiler: clang
|
||||
compiler-desc: Clang 9
|
||||
vfx-cy: 2022
|
||||
# VFX CY2021, C++14, docs, OpenFX
|
||||
- build: 4
|
||||
build-docs: 'ON'
|
||||
build-openfx: 'ON'
|
||||
cxx-standard: 14
|
||||
cxx-compiler: clang++
|
||||
cc-compiler: clang
|
||||
compiler-desc: Clang 9
|
||||
vfx-cy: 2021
|
||||
env:
|
||||
CXX: ${{ matrix.cxx-compiler }}
|
||||
CC: ${{ matrix.cc-compiler }}
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
- name: Install docs env
|
||||
run: share/ci/scripts/linux/yum/install_docs_env.sh
|
||||
if: matrix.build-docs == 'ON'
|
||||
- name: Install tests env
|
||||
run: share/ci/scripts/linux/yum/install_tests_env.sh
|
||||
- name: Install latest ext package versions
|
||||
run: |
|
||||
share/ci/scripts/linux/install_expat.sh latest
|
||||
share/ci/scripts/linux/install_lcms2.sh latest
|
||||
share/ci/scripts/linux/install_yaml-cpp.sh latest
|
||||
share/ci/scripts/linux/install_pystring.sh latest
|
||||
share/ci/scripts/linux/install_pybind11.sh latest
|
||||
share/ci/scripts/linux/install_openexr.sh latest
|
||||
share/ci/scripts/linux/install_imath.sh latest
|
||||
share/ci/scripts/linux/install_oiio.sh latest
|
||||
share/ci/scripts/linux/install_openfx.sh latest
|
||||
- name: Create build directories
|
||||
run: |
|
||||
mkdir _install
|
||||
mkdir _build
|
||||
- name: Configure
|
||||
run: |
|
||||
cmake ../. \
|
||||
-DCMAKE_INSTALL_PREFIX=../_install \
|
||||
-DCMAKE_BUILD_TYPE=Release \
|
||||
-DCMAKE_CXX_STANDARD=${{ matrix.cxx-standard }} \
|
||||
-DOCIO_BUILD_DOCS=${{ matrix.build-docs }} \
|
||||
-DOCIO_BUILD_OPENFX=${{ matrix.build-openfx }} \
|
||||
-DOCIO_BUILD_GPU_TESTS=OFF \
|
||||
-DOCIO_INSTALL_EXT_PACKAGES=NONE \
|
||||
-DOCIO_WARNING_AS_ERROR=OFF \
|
||||
-DPython_EXECUTABLE=$(which python)
|
||||
working-directory: _build
|
||||
- name: Build
|
||||
run: |
|
||||
cmake --build . \
|
||||
--target install \
|
||||
--config Release \
|
||||
-- -j$(nproc)
|
||||
working-directory: _build
|
||||
- name: Test
|
||||
run: ctest -V -C Release
|
||||
working-directory: _build
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# SonarCloud static analysis
|
||||
# ---------------------------------------------------------------------------
|
||||
@@ -41,7 +144,7 @@ jobs:
|
||||
CC: gcc
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
fetch-depth: 50
|
||||
- name: Install docs env
|
||||
|
||||
+239
-286
@@ -44,10 +44,9 @@ jobs:
|
||||
<${{ matrix.compiler-desc }}
|
||||
config=${{ matrix.build-type }},
|
||||
shared=${{ matrix.build-shared }},
|
||||
simd=${{ matrix.use-simd }},
|
||||
sse=${{ matrix.use-sse }},
|
||||
cxx=${{ matrix.cxx-standard }},
|
||||
docs=${{ matrix.build-docs }},
|
||||
oiio=${{ matrix.use-oiio }}>'
|
||||
docs=${{ matrix.build-docs }}>'
|
||||
# Avoid duplicated checks when a pull_request is opened from a local branch.
|
||||
if: |
|
||||
github.event_name == 'push' ||
|
||||
@@ -60,182 +59,198 @@ jobs:
|
||||
image: aswf/ci-ocio:${{ matrix.vfx-cy }}
|
||||
strategy:
|
||||
matrix:
|
||||
build: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]
|
||||
build: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]
|
||||
include:
|
||||
# -------------------------------------------------------------------
|
||||
# VFX CY2023 (Python 3.10)
|
||||
# VFX CY2022 (Python 3.9)
|
||||
# -------------------------------------------------------------------
|
||||
- build: 12
|
||||
# C++17, Clang, Debug, OpenFX
|
||||
- build: 13
|
||||
build-type: Debug
|
||||
build-shared: 'ON'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'ON'
|
||||
use-simd: 'ON'
|
||||
use-oiio: 'ON'
|
||||
use-sse: 'ON'
|
||||
use-openexr-half: 'OFF'
|
||||
cxx-standard: 17
|
||||
cxx-compiler: clang++
|
||||
cc-compiler: clang
|
||||
compiler-desc: Clang
|
||||
vfx-cy: 2023
|
||||
install-ext-packages: MISSING
|
||||
- build: 11
|
||||
compiler-desc: Clang 9
|
||||
vfx-cy: 2022
|
||||
# C++17, GCC, no SSE, OpenFX
|
||||
- build: 12
|
||||
build-type: Release
|
||||
build-shared: 'ON'
|
||||
build-docs: 'ON'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'ON'
|
||||
use-simd: 'OFF'
|
||||
use-oiio: 'OFF'
|
||||
use-sse: 'OFF'
|
||||
use-openexr-half: 'OFF'
|
||||
cxx-standard: 17
|
||||
cxx-compiler: g++
|
||||
cc-compiler: gcc
|
||||
compiler-desc: GCC
|
||||
vfx-cy: 2023
|
||||
install-ext-packages: ALL
|
||||
compiler-desc: GCC 9.3.1
|
||||
vfx-cy: 2022
|
||||
# C++14, GCC, static, docs
|
||||
- build: 11
|
||||
build-type: Release
|
||||
build-shared: 'OFF'
|
||||
build-docs: 'ON'
|
||||
build-openfx: 'OFF'
|
||||
use-sse: 'ON'
|
||||
use-openexr-half: 'OFF'
|
||||
cxx-standard: 14
|
||||
cxx-compiler: g++
|
||||
cc-compiler: gcc
|
||||
compiler-desc: GCC 9.3.1
|
||||
vfx-cy: 2022
|
||||
# C++11, GCC, static
|
||||
- build: 10
|
||||
build-type: Release
|
||||
build-shared: 'OFF'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'OFF'
|
||||
use-simd: 'ON'
|
||||
use-oiio: 'OFF'
|
||||
use-sse: 'ON'
|
||||
use-openexr-half: 'OFF'
|
||||
cxx-standard: 11
|
||||
cxx-compiler: g++
|
||||
cc-compiler: gcc
|
||||
compiler-desc: GCC
|
||||
vfx-cy: 2023
|
||||
install-ext-packages: ALL
|
||||
# -------------------------------------------------------------------
|
||||
# VFX CY2022 (Python 3.9)
|
||||
# -------------------------------------------------------------------
|
||||
- build: 9
|
||||
build-type: Debug
|
||||
build-shared: 'ON'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'ON'
|
||||
use-simd: 'ON'
|
||||
use-oiio: 'ON'
|
||||
cxx-standard: 17
|
||||
cxx-compiler: clang++
|
||||
cc-compiler: clang
|
||||
compiler-desc: Clang
|
||||
compiler-desc: GCC 9.3.1
|
||||
vfx-cy: 2022
|
||||
install-ext-packages: ALL
|
||||
- build: 8
|
||||
build-type: Release
|
||||
build-shared: 'ON'
|
||||
build-docs: 'ON'
|
||||
build-openfx: 'ON'
|
||||
use-simd: 'OFF'
|
||||
use-oiio: 'OFF'
|
||||
cxx-standard: 17
|
||||
cxx-compiler: g++
|
||||
cc-compiler: gcc
|
||||
compiler-desc: GCC
|
||||
vfx-cy: 2022
|
||||
install-ext-packages: MISSING
|
||||
- build: 7
|
||||
build-type: Release
|
||||
build-shared: 'OFF'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'OFF'
|
||||
use-simd: 'ON'
|
||||
use-oiio: 'OFF'
|
||||
cxx-standard: 11
|
||||
cxx-compiler: g++
|
||||
cc-compiler: gcc
|
||||
compiler-desc: GCC
|
||||
vfx-cy: 2022
|
||||
install-ext-packages: ALL
|
||||
# -------------------------------------------------------------------
|
||||
# VFX CY2021 (Python 3.7)
|
||||
# -------------------------------------------------------------------
|
||||
# C++17, Clang
|
||||
- build: 9
|
||||
build-type: Release
|
||||
build-shared: 'ON'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'OFF'
|
||||
use-sse: 'ON'
|
||||
use-openexr-half: 'ON'
|
||||
cxx-standard: 17
|
||||
cxx-compiler: clang++
|
||||
cc-compiler: clang
|
||||
compiler-desc: Clang 9
|
||||
vfx-cy: 2021
|
||||
# C++14, Clang, static, no SSE, OpenFX
|
||||
- build: 8
|
||||
build-type: Release
|
||||
build-shared: 'OFF'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'ON'
|
||||
use-sse: 'OFF'
|
||||
use-openexr-half: 'ON'
|
||||
cxx-standard: 14
|
||||
cxx-compiler: clang++
|
||||
cc-compiler: clang
|
||||
compiler-desc: Clang 9
|
||||
vfx-cy: 2021
|
||||
# C++11, GCC, Debug
|
||||
- build: 7
|
||||
build-type: Debug
|
||||
build-shared: 'ON'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'OFF'
|
||||
use-sse: 'ON'
|
||||
use-openexr-half: 'ON'
|
||||
cxx-standard: 11
|
||||
cxx-compiler: g++
|
||||
cc-compiler: gcc
|
||||
compiler-desc: GCC 9.3.1
|
||||
vfx-cy: 2021
|
||||
# -------------------------------------------------------------------
|
||||
# VFX CY2020 (Python 3.7)
|
||||
# -------------------------------------------------------------------
|
||||
# C++14, Clang, OpenFX
|
||||
- build: 6
|
||||
build-type: Release
|
||||
build-shared: 'ON'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'OFF'
|
||||
use-simd: 'ON'
|
||||
use-oiio: 'ON'
|
||||
cxx-standard: 17
|
||||
cxx-compiler: clang++
|
||||
cc-compiler: clang
|
||||
compiler-desc: Clang
|
||||
vfx-cy: 2021
|
||||
install-ext-packages: MISSING
|
||||
- build: 5
|
||||
build-type: Release
|
||||
build-shared: 'OFF'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'ON'
|
||||
use-simd: 'OFF'
|
||||
use-oiio: 'OFF'
|
||||
use-sse: 'OFF'
|
||||
use-openexr-half: 'ON'
|
||||
cxx-standard: 14
|
||||
cxx-compiler: clang++
|
||||
cc-compiler: clang
|
||||
compiler-desc: Clang
|
||||
vfx-cy: 2021
|
||||
install-ext-packages: ALL
|
||||
- build: 4
|
||||
compiler-desc: Clang 7
|
||||
vfx-cy: 2020
|
||||
# C++14, GCC, static, Debug, OpenFX
|
||||
- build: 5
|
||||
build-type: Debug
|
||||
build-shared: 'OFF'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'ON'
|
||||
use-sse: 'ON'
|
||||
use-openexr-half: 'ON'
|
||||
cxx-standard: 14
|
||||
cxx-compiler: g++
|
||||
cc-compiler: gcc
|
||||
compiler-desc: GCC 6.3.1
|
||||
vfx-cy: 2020
|
||||
# C++11, GCC, no SSE
|
||||
- build: 4
|
||||
build-type: Release
|
||||
build-shared: 'ON'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'OFF'
|
||||
use-simd: 'ON'
|
||||
use-oiio: 'OFF'
|
||||
use-sse: 'ON'
|
||||
use-openexr-half: 'ON'
|
||||
cxx-standard: 11
|
||||
cxx-compiler: g++
|
||||
cc-compiler: gcc
|
||||
compiler-desc: GCC
|
||||
vfx-cy: 2021
|
||||
install-ext-packages: ALL
|
||||
compiler-desc: GCC 6.3.1
|
||||
vfx-cy: 2020
|
||||
# -------------------------------------------------------------------
|
||||
# VFX CY2020 (Python 3.7)
|
||||
# VFX CY2019 (Python 2.7)
|
||||
# -------------------------------------------------------------------
|
||||
# C++11, Clang, static
|
||||
- build: 3
|
||||
build-type: Release
|
||||
build-shared: 'ON'
|
||||
build-shared: 'OFF'
|
||||
# Doc build requires Python 3
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'ON'
|
||||
use-simd: 'OFF'
|
||||
use-oiio: 'OFF'
|
||||
cxx-standard: 14
|
||||
build-openfx: 'OFF'
|
||||
use-sse: 'ON'
|
||||
use-openexr-half: 'ON'
|
||||
cxx-standard: 11
|
||||
cxx-compiler: clang++
|
||||
cc-compiler: clang
|
||||
compiler-desc: Clang
|
||||
vfx-cy: 2020
|
||||
install-ext-packages: MISSING
|
||||
compiler-desc: Clang 7
|
||||
vfx-cy: 2019
|
||||
# C++11, Clang, Debug, no SSE
|
||||
- build: 2
|
||||
build-type: Debug
|
||||
build-shared: 'OFF'
|
||||
build-shared: 'ON'
|
||||
# Doc build requires Python 3
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'ON'
|
||||
use-simd: 'ON'
|
||||
use-oiio: 'ON'
|
||||
cxx-standard: 14
|
||||
cxx-compiler: g++
|
||||
cc-compiler: gcc
|
||||
compiler-desc: GCC
|
||||
vfx-cy: 2020
|
||||
install-ext-packages: ALL
|
||||
build-openfx: 'OFF'
|
||||
use-sse: 'OFF'
|
||||
use-openexr-half: 'ON'
|
||||
cxx-standard: 11
|
||||
cxx-compiler: clang++
|
||||
cc-compiler: clang
|
||||
compiler-desc: Clang 7
|
||||
vfx-cy: 2019
|
||||
# C++11, GCC, OpenFX
|
||||
- build: 1
|
||||
build-type: Release
|
||||
build-shared: 'ON'
|
||||
# Doc build requires Python 3
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'OFF'
|
||||
use-simd: 'ON'
|
||||
use-oiio: 'OFF'
|
||||
build-openfx: 'ON'
|
||||
use-sse: 'ON'
|
||||
use-openexr-half: 'ON'
|
||||
cxx-standard: 11
|
||||
cxx-compiler: g++
|
||||
cc-compiler: gcc
|
||||
compiler-desc: GCC
|
||||
vfx-cy: 2020
|
||||
install-ext-packages: ALL
|
||||
compiler-desc: GCC 6.3.1
|
||||
vfx-cy: 2019
|
||||
env:
|
||||
CXX: ${{ matrix.cxx-compiler }}
|
||||
CC: ${{ matrix.cc-compiler }}
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
uses: actions/checkout@v2
|
||||
- name: Install docs env
|
||||
run: share/ci/scripts/linux/yum/install_docs_env.sh
|
||||
if: matrix.build-docs == 'ON'
|
||||
@@ -255,9 +270,9 @@ jobs:
|
||||
-DOCIO_BUILD_DOCS=${{ matrix.build-docs }} \
|
||||
-DOCIO_BUILD_OPENFX=${{ matrix.build-openfx }} \
|
||||
-DOCIO_BUILD_GPU_TESTS=OFF \
|
||||
-DOCIO_USE_SIMD=${{ matrix.use-simd }} \
|
||||
-DOCIO_USE_OIIO_FOR_APPS=${{ matrix.use-oiio }} \
|
||||
-DOCIO_INSTALL_EXT_PACKAGES=${{ matrix.install-ext-packages }} \
|
||||
-DOCIO_USE_SSE=${{ matrix.use-sse }} \
|
||||
-DOCIO_USE_OPENEXR_HALF=${{ matrix.use-openexr-half }} \
|
||||
-DOCIO_INSTALL_EXT_PACKAGES=ALL \
|
||||
-DOCIO_WARNING_AS_ERROR=ON \
|
||||
-DPython_EXECUTABLE=$(which python)
|
||||
working-directory: _build
|
||||
@@ -267,12 +282,11 @@ jobs:
|
||||
--target install \
|
||||
--config ${{ matrix.build-type }} \
|
||||
-- -j$(nproc)
|
||||
echo "ocio_build_path=$(pwd)" >> $GITHUB_ENV
|
||||
working-directory: _build
|
||||
- name: Test
|
||||
run: ctest -V -C ${{ matrix.build-type }}
|
||||
working-directory: _build
|
||||
- name: Test CMake Consumer with shared OCIO
|
||||
- name: Test CMake Consumer
|
||||
if: matrix.build-shared == 'ON'
|
||||
run: |
|
||||
cmake . \
|
||||
@@ -282,117 +296,97 @@ jobs:
|
||||
--config ${{ matrix.build-type }}
|
||||
./consumer
|
||||
working-directory: _build/tests/cmake-consumer-dist
|
||||
- name: Test CMake Consumer with static OCIO
|
||||
if: matrix.build-shared == 'OFF'
|
||||
# The yaml-cpp_VERSION is set below because Findyaml-cpp.cmake needs it but is unable to
|
||||
# extract it from the headers, like the other modules.
|
||||
#
|
||||
# Prefer the static version of each dependencies by using <pkg>_STATIC_LIBRARY.
|
||||
# Alternatively, this can be done by setting <pkg>_LIBRARY and <pkg>_INCLUDE_DIR to
|
||||
# the static version of the package.
|
||||
run: |
|
||||
cmake . \
|
||||
-DCMAKE_PREFIX_PATH=../../../_install \
|
||||
-DCMAKE_BUILD_TYPE=${{ matrix.build-type }} \
|
||||
-Dexpat_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-Dexpat_STATIC_LIBRARY=ON \
|
||||
-DImath_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-DImath_STATIC_LIBRARY=ON \
|
||||
-Dpystring_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-Dyaml-cpp_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-Dyaml-cpp_STATIC_LIBRARY=ON \
|
||||
-Dyaml-cpp_VERSION=0.7.0 \
|
||||
-DZLIB_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-DZLIB_STATIC_LIBRARY=ON \
|
||||
-Dminizip-ng_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-Dminizip-ng_STATIC_LIBRARY=ON
|
||||
cmake --build . \
|
||||
--config ${{ matrix.build-type }}
|
||||
./consumer
|
||||
working-directory: _build/tests/cmake-consumer-dist
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# macOS
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
macos:
|
||||
name: 'macOS 11
|
||||
<AppleClang
|
||||
arch=${{ matrix.arch-type }},
|
||||
name: 'macOS 10.15
|
||||
<AppleClang 11.0
|
||||
config=${{ matrix.build-type }},
|
||||
shared=${{ matrix.build-shared }},
|
||||
simd=${{ matrix.use-simd }},
|
||||
sse=${{ matrix.use-sse }},
|
||||
cxx=${{ matrix.cxx-standard }},
|
||||
python=${{ matrix.python-version }},
|
||||
docs=${{ matrix.build-docs }},
|
||||
oiio=${{ matrix.use-oiio}}>'
|
||||
docs=${{ matrix.build-docs }}>'
|
||||
# Avoid duplicated checks when a pull_request is opened from a local branch.
|
||||
if: |
|
||||
github.event_name == 'push' ||
|
||||
github.event.pull_request.head.repo.full_name != github.repository
|
||||
runs-on: macos-11
|
||||
runs-on: macos-10.15
|
||||
strategy:
|
||||
matrix:
|
||||
build: [1, 2, 3, 4]
|
||||
build: [1, 2, 3, 4, 5, 6]
|
||||
include:
|
||||
- build: 5
|
||||
arch-type: "x86_64"
|
||||
# C++17, OpenFX
|
||||
- build: 6
|
||||
build-type: Release
|
||||
build-shared: 'ON'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'ON'
|
||||
use-simd: 'ON'
|
||||
use-oiio: 'ON'
|
||||
use-sse: 'ON'
|
||||
use-openexr-half: 'OFF'
|
||||
cxx-standard: 17
|
||||
python-version: '3.11'
|
||||
# Keeping one universal build
|
||||
- build: 4
|
||||
arch-type: "x86_64;arm64"
|
||||
build-type: Release
|
||||
build-shared: 'ON'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'OFF'
|
||||
use-simd: 'ON'
|
||||
use-oiio: 'OFF'
|
||||
cxx-standard: 11
|
||||
python-version: '3.10'
|
||||
- build: 3
|
||||
arch-type: "x86_64"
|
||||
python-version: 3.9
|
||||
# C++11, Python 3.7
|
||||
- build: 5
|
||||
build-type: Release
|
||||
build-shared: 'ON'
|
||||
build-docs: 'ON'
|
||||
build-openfx: 'OFF'
|
||||
use-simd: 'OFF'
|
||||
use-oiio: 'OFF'
|
||||
use-sse: 'ON'
|
||||
use-openexr-half: 'OFF'
|
||||
cxx-standard: 11
|
||||
python-version: '3.10'
|
||||
- build: 2
|
||||
arch-type: "x86_64"
|
||||
python-version: 3.7
|
||||
# Debug, OpenFX
|
||||
- build: 4
|
||||
build-type: Debug
|
||||
build-shared: 'ON'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'ON'
|
||||
use-simd: 'ON'
|
||||
use-oiio: 'OFF'
|
||||
use-sse: 'ON'
|
||||
use-openexr-half: 'OFF'
|
||||
cxx-standard: 11
|
||||
python-version: '3.9'
|
||||
- build: 1
|
||||
arch-type: "x86_64"
|
||||
python-version: 3.7
|
||||
# C++14, OpenEXR, OpenFX
|
||||
- build: 3
|
||||
build-type: Release
|
||||
build-shared: 'ON'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'ON'
|
||||
use-sse: 'ON'
|
||||
use-openexr-half: 'ON'
|
||||
cxx-standard: 14
|
||||
python-version: 3.7
|
||||
# Static, no SSE
|
||||
- build: 2
|
||||
build-type: Release
|
||||
build-shared: 'OFF'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'ON'
|
||||
use-simd: 'ON'
|
||||
use-oiio: 'OFF'
|
||||
cxx-standard: 14
|
||||
python-version: '3.7'
|
||||
build-openfx: 'OFF'
|
||||
use-sse: 'OFF'
|
||||
use-openexr-half: 'OFF'
|
||||
cxx-standard: 11
|
||||
python-version: 3.7
|
||||
# Python 2.7
|
||||
- build: 1
|
||||
build-type: Release
|
||||
build-shared: 'ON'
|
||||
# Doc build requires Python 3
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'OFF'
|
||||
use-sse: 'ON'
|
||||
use-openexr-half: 'OFF'
|
||||
cxx-standard: 11
|
||||
python-version: 2.7
|
||||
steps:
|
||||
- name: Setup Python
|
||||
uses: actions/setup-python@v4
|
||||
uses: actions/setup-python@v1
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
uses: actions/checkout@v2
|
||||
- name: Install docs env
|
||||
run: share/ci/scripts/macos/install_docs_env.sh
|
||||
if: matrix.build-docs == 'ON'
|
||||
@@ -412,12 +406,11 @@ jobs:
|
||||
-DOCIO_BUILD_DOCS=${{ matrix.build-docs }} \
|
||||
-DOCIO_BUILD_OPENFX=${{ matrix.build-openfx }} \
|
||||
-DOCIO_BUILD_GPU_TESTS=OFF \
|
||||
-DOCIO_USE_SIMD=${{ matrix.use-simd }} \
|
||||
-DOCIO_USE_OIIO_FOR_APPS=${{ matrix.use-oiio }} \
|
||||
-DOCIO_USE_SSE=${{ matrix.use-sse }} \
|
||||
-DOCIO_USE_OPENEXR_HALF=${{ matrix.use-openexr-half }} \
|
||||
-DOCIO_INSTALL_EXT_PACKAGES=ALL \
|
||||
-DOCIO_WARNING_AS_ERROR=ON \
|
||||
-DPython_EXECUTABLE=$(which python) \
|
||||
-DCMAKE_OSX_ARCHITECTURES="${{ matrix.arch-type }}"
|
||||
-DPython_EXECUTABLE=$(which python)
|
||||
working-directory: _build
|
||||
- name: Build
|
||||
run: |
|
||||
@@ -425,12 +418,11 @@ jobs:
|
||||
--target install \
|
||||
--config ${{ matrix.build-type }} \
|
||||
-- -j$(sysctl -n hw.ncpu)
|
||||
echo "ocio_build_path=$(pwd)" >> $GITHUB_ENV
|
||||
working-directory: _build
|
||||
- name: Test
|
||||
run: ctest -V -C ${{ matrix.build-type }}
|
||||
working-directory: _build
|
||||
- name: Test CMake Consumer with shared OCIO
|
||||
- name: Test CMake Consumer
|
||||
if: matrix.build-shared == 'ON'
|
||||
run: |
|
||||
cmake . \
|
||||
@@ -440,34 +432,6 @@ jobs:
|
||||
--config ${{ matrix.build-type }}
|
||||
./consumer
|
||||
working-directory: _build/tests/cmake-consumer-dist
|
||||
- name: Test CMake Consumer with static OCIO
|
||||
if: matrix.build-shared == 'OFF'
|
||||
# The yaml-cpp_VERSION is set below because Findyaml-cpp.cmake needs it but is unable to
|
||||
# extract it from the headers, like the other modules.
|
||||
#
|
||||
# Prefer the static version of each dependencies by using <pkg>_STATIC_LIBRARY.
|
||||
# Alternatively, this can be done by setting <pkg>_LIBRARY and <pkg>_INCLUDE_DIR to
|
||||
# the static version of the package.
|
||||
run: |
|
||||
cmake . \
|
||||
-DCMAKE_PREFIX_PATH=../../../_install \
|
||||
-DCMAKE_BUILD_TYPE=${{ matrix.build-type }} \
|
||||
-Dexpat_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-Dexpat_STATIC_LIBRARY=ON \
|
||||
-DImath_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-DImath_STATIC_LIBRARY=ON \
|
||||
-Dpystring_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-Dyaml-cpp_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-Dyaml-cpp_STATIC_LIBRARY=ON \
|
||||
-Dyaml-cpp_VERSION=0.7.0 \
|
||||
-DZLIB_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-DZLIB_STATIC_LIBRARY=ON \
|
||||
-Dminizip-ng_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-Dminizip-ng_STATIC_LIBRARY=ON
|
||||
cmake --build . \
|
||||
--config ${{ matrix.build-type }}
|
||||
./consumer
|
||||
working-directory: _build/tests/cmake-consumer-dist
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Windows
|
||||
@@ -477,14 +441,13 @@ jobs:
|
||||
|
||||
windows:
|
||||
name: 'Windows 2019
|
||||
<MSVC
|
||||
<MSVC 16.4
|
||||
config=${{ matrix.build-type }},
|
||||
shared=${{ matrix.build-shared }},
|
||||
simd=${{ matrix.use-simd }},
|
||||
sse=${{ matrix.use-sse }},
|
||||
cxx=${{ matrix.cxx-standard }},
|
||||
python=${{ matrix.python-version }},
|
||||
docs=${{ matrix.build-docs }},
|
||||
oiio=${{ matrix.use-oiio }}>'
|
||||
docs=${{ matrix.build-docs }}>'
|
||||
# Avoid duplicated checks when a pull_request is opened from a local branch.
|
||||
if: |
|
||||
github.event_name == 'push' ||
|
||||
@@ -492,57 +455,78 @@ jobs:
|
||||
runs-on: windows-2019
|
||||
strategy:
|
||||
matrix:
|
||||
build: [1, 2, 3, 4]
|
||||
build: [1, 2, 3, 4, 5, 6]
|
||||
include:
|
||||
- build: 4
|
||||
# C++17, OpenFX
|
||||
- build: 6
|
||||
build-type: Release
|
||||
build-shared: 'ON'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'ON'
|
||||
use-simd: 'OFF'
|
||||
use-oiio: 'ON'
|
||||
use-sse: 'ON'
|
||||
use-openexr-half: 'OFF'
|
||||
cxx-standard: 17
|
||||
python-version: '3.11'
|
||||
- build: 3
|
||||
python-version: 3.9
|
||||
# C++11, Python 3.7
|
||||
- build: 5
|
||||
build-type: Release
|
||||
build-shared: 'OFF'
|
||||
build-shared: 'ON'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'OFF'
|
||||
use-simd: 'ON'
|
||||
use-oiio: 'OFF'
|
||||
use-sse: 'ON'
|
||||
use-openexr-half: 'OFF'
|
||||
cxx-standard: 11
|
||||
python-version: '3.9'
|
||||
- build: 2
|
||||
python-version: 3.7
|
||||
# Debug
|
||||
- build: 4
|
||||
build-type: Debug
|
||||
build-shared: 'ON'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'OFF'
|
||||
use-simd: 'ON'
|
||||
use-oiio: 'OFF'
|
||||
use-sse: 'ON'
|
||||
use-openexr-half: 'OFF'
|
||||
cxx-standard: 11
|
||||
python-version: '3.8'
|
||||
python-version: 3.7
|
||||
# C++14, OpenEXR, OpenFX
|
||||
- build: 1
|
||||
- build: 3
|
||||
build-type: Release
|
||||
build-shared: 'ON'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'ON'
|
||||
use-simd: 'ON'
|
||||
use-oiio: 'OFF'
|
||||
use-sse: 'ON'
|
||||
use-openexr-half: 'ON'
|
||||
cxx-standard: 14
|
||||
python-version: '3.7'
|
||||
python-version: 3.7
|
||||
# Static, no SSE, OpenFX
|
||||
- build: 2
|
||||
build-type: Release
|
||||
build-shared: 'OFF'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'ON'
|
||||
use-sse: 'OFF'
|
||||
use-openexr-half: 'OFF'
|
||||
cxx-standard: 11
|
||||
python-version: 3.7
|
||||
# Python 2.7
|
||||
- build: 1
|
||||
build-type: Release
|
||||
build-shared: 'ON'
|
||||
# Doc build requires Python 3
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'OFF'
|
||||
use-sse: 'ON'
|
||||
use-openexr-half: 'OFF'
|
||||
cxx-standard: 11
|
||||
python-version: 2.7
|
||||
steps:
|
||||
- name: Setup Python
|
||||
uses: actions/setup-python@v4
|
||||
uses: actions/setup-python@v1
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
uses: actions/checkout@v2
|
||||
- name: Install docs env
|
||||
run: |
|
||||
DOXYGEN_PATH=$GITHUB_WORKSPACE/doxygen
|
||||
share/ci/scripts/windows/install_docs_env.sh "$DOXYGEN_PATH"
|
||||
echo "$DOXYGEN_PATH" >> $GITHUB_PATH
|
||||
run: share/ci/scripts/windows/install_docs_env.sh
|
||||
shell: bash
|
||||
if: matrix.build-docs == 'ON'
|
||||
- name: Install tests env
|
||||
@@ -564,8 +548,8 @@ jobs:
|
||||
-DOCIO_BUILD_DOCS=${{ matrix.build-docs }} \
|
||||
-DOCIO_BUILD_OPENFX=${{ matrix.build-openfx }} \
|
||||
-DOCIO_BUILD_GPU_TESTS=OFF \
|
||||
-DOCIO_USE_SIMD=${{ matrix.use-simd }} \
|
||||
-DOCIO_USE_OIIO_FOR_APPS=${{ matrix.use-oiio }} \
|
||||
-DOCIO_USE_SSE=${{ matrix.use-sse }} \
|
||||
-DOCIO_USE_OPENEXR_HALF=${{ matrix.use-openexr-half }} \
|
||||
-DOCIO_INSTALL_EXT_PACKAGES=ALL \
|
||||
-DOCIO_WARNING_AS_ERROR=ON \
|
||||
-DPython_EXECUTABLE=$(which python)
|
||||
@@ -576,14 +560,13 @@ jobs:
|
||||
cmake --build . \
|
||||
--target install \
|
||||
--config ${{ matrix.build-type }}
|
||||
echo "ocio_build_path=$(pwd)" >> $GITHUB_ENV
|
||||
shell: bash
|
||||
working-directory: _build
|
||||
- name: Test
|
||||
run: ctest -V -C ${{ matrix.build-type }}
|
||||
shell: bash
|
||||
working-directory: _build
|
||||
- name: Test CMake Consumer with shared OCIO
|
||||
- name: Test CMake Consumer
|
||||
if: matrix.build-shared == 'ON'
|
||||
run: |
|
||||
cmake . \
|
||||
@@ -595,33 +578,3 @@ jobs:
|
||||
./${{ matrix.build-type }}/consumer
|
||||
shell: bash
|
||||
working-directory: _build/tests/cmake-consumer-dist
|
||||
- name: Test CMake Consumer with static OCIO
|
||||
if: matrix.build-shared == 'OFF'
|
||||
# The yaml-cpp_VERSION is set below because Findyaml-cpp.cmake needs it but is unable to
|
||||
# extract it from the headers, like the other modules.
|
||||
#
|
||||
# Prefer the static version of each dependencies by using <pkg>_STATIC_LIBRARY.
|
||||
# Alternatively, this can be done by setting <pkg>_LIBRARY and <pkg>_INCLUDE_DIR to
|
||||
# the static version of the package.
|
||||
run: |
|
||||
cmake . \
|
||||
-DCMAKE_PREFIX_PATH=../../../_install \
|
||||
-DCMAKE_BUILD_TYPE=${{ matrix.build-type }} \
|
||||
-Dexpat_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-Dexpat_STATIC_LIBRARY=ON \
|
||||
-DImath_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-DImath_STATIC_LIBRARY=ON \
|
||||
-Dpystring_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-Dyaml-cpp_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-Dyaml-cpp_STATIC_LIBRARY=ON \
|
||||
-Dyaml-cpp_VERSION=0.7.0 \
|
||||
-DZLIB_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-DZLIB_STATIC_LIBRARY=ON \
|
||||
-Dminizip-ng_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-Dminizip-ng_STATIC_LIBRARY=ON
|
||||
cmake --build . \
|
||||
--config ${{ matrix.build-type }}
|
||||
export PATH=../../../_install/bin:$PATH
|
||||
./${{ matrix.build-type }}/consumer
|
||||
shell: bash
|
||||
working-directory: _build/tests/cmake-consumer-dist
|
||||
|
||||
@@ -1,399 +0,0 @@
|
||||
# SPDX-License-Identifier: BSD-3-Clause
|
||||
# Copyright Contributors to the OpenColorIO Project.
|
||||
#
|
||||
# GitHub Actions workflow file
|
||||
# https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions
|
||||
|
||||
name: Dependencies latest
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches-ignore:
|
||||
- RB-0.*
|
||||
- RB-1.*
|
||||
- gh-pages
|
||||
tags-ignore:
|
||||
- v0.*
|
||||
- v1.*
|
||||
paths:
|
||||
- .github/workflows/dependencies_latest.yml
|
||||
schedule:
|
||||
# Nightly build
|
||||
- cron: "0 0 * * *"
|
||||
|
||||
jobs:
|
||||
# ---------------------------------------------------------------------------
|
||||
# Linux latest ext packages
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
linux_latest:
|
||||
name: 'Linux CentOS 7 VFX CY${{ matrix.vfx-cy }} latest
|
||||
<${{ matrix.compiler-desc }}
|
||||
cxx=${{ matrix.cxx-standard }},
|
||||
docs=${{ matrix.build-docs }}>'
|
||||
# Don't run on OCIO forks
|
||||
if: github.repository == 'AcademySoftwareFoundation/OpenColorIO'
|
||||
# GH-hosted VM. The build runs in CentOS 7 'container' defined below.
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
# DockerHub: https://hub.docker.com/u/aswf
|
||||
# Source: https://github.com/AcademySoftwareFoundation/aswf-docker
|
||||
image: aswf/ci-base:${{ matrix.vfx-cy }}
|
||||
strategy:
|
||||
matrix:
|
||||
build: [1, 2, 3, 4]
|
||||
include:
|
||||
# -------------------------------------------------------------------
|
||||
# GCC
|
||||
# -------------------------------------------------------------------
|
||||
- build: 1
|
||||
build-docs: 'ON'
|
||||
build-openfx: 'ON'
|
||||
cxx-standard: 17
|
||||
cxx-compiler: g++
|
||||
cc-compiler: gcc
|
||||
compiler-desc: GCC
|
||||
vfx-cy: 2022
|
||||
use-oiio: 'ON'
|
||||
- build: 2
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'OFF'
|
||||
cxx-standard: 14
|
||||
cxx-compiler: g++
|
||||
cc-compiler: gcc
|
||||
compiler-desc: GCC
|
||||
vfx-cy: 2021
|
||||
use-oiio: 'OFF'
|
||||
# -------------------------------------------------------------------
|
||||
# Clang
|
||||
# -------------------------------------------------------------------
|
||||
- build: 3
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'OFF'
|
||||
cxx-standard: 17
|
||||
cxx-compiler: clang++
|
||||
cc-compiler: clang
|
||||
compiler-desc: Clang
|
||||
vfx-cy: 2022
|
||||
use-oiio: 'OFF'
|
||||
- build: 4
|
||||
build-docs: 'ON'
|
||||
build-openfx: 'ON'
|
||||
cxx-standard: 14
|
||||
cxx-compiler: clang++
|
||||
cc-compiler: clang
|
||||
compiler-desc: Clang
|
||||
vfx-cy: 2021
|
||||
use-oiio: 'ON'
|
||||
env:
|
||||
CXX: ${{ matrix.cxx-compiler }}
|
||||
CC: ${{ matrix.cc-compiler }}
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
- name: Install docs env
|
||||
run: share/ci/scripts/linux/yum/install_docs_env.sh
|
||||
if: matrix.build-docs == 'ON'
|
||||
- name: Install tests env
|
||||
run: share/ci/scripts/linux/yum/install_tests_env.sh
|
||||
- name: Setup ext environment
|
||||
run: |
|
||||
EXT_PATH=/usr/local
|
||||
echo "EXT_PATH=$EXT_PATH" >> $GITHUB_ENV
|
||||
- name: Install indirect dependencies
|
||||
run: |
|
||||
share/ci/scripts/multi/install_pugixml.sh latest
|
||||
- name: Install fixed ext package versions
|
||||
# Minizip-ng depends on ZLIB. ZLIB must be installed first.
|
||||
run: |
|
||||
share/ci/scripts/multi/install_expat.sh 2.4.1 $EXT_PATH
|
||||
share/ci/scripts/multi/install_lcms2.sh 2.2 $EXT_PATH
|
||||
share/ci/scripts/multi/install_yaml-cpp.sh 0.7.0 $EXT_PATH
|
||||
share/ci/scripts/multi/install_pystring.sh 1.1.3 $EXT_PATH
|
||||
share/ci/scripts/multi/install_pybind11.sh 2.9.2 $EXT_PATH
|
||||
share/ci/scripts/multi/install_zlib.sh 1.2.12 $EXT_PATH
|
||||
share/ci/scripts/multi/install_minizip-ng.sh 3.0.6 $EXT_PATH
|
||||
- name: Install latest ext package versions
|
||||
run: |
|
||||
share/ci/scripts/multi/install_imath.sh latest $EXT_PATH
|
||||
share/ci/scripts/multi/install_openexr.sh latest $EXT_PATH
|
||||
share/ci/scripts/multi/install_oiio.sh latest $EXT_PATH
|
||||
share/ci/scripts/multi/install_osl.sh latest $EXT_PATH
|
||||
share/ci/scripts/multi/install_openfx.sh latest $EXT_PATH
|
||||
- name: Create build directories
|
||||
run: |
|
||||
mkdir _install
|
||||
mkdir _build
|
||||
- name: Configure
|
||||
run: |
|
||||
cmake ../. \
|
||||
-DCMAKE_INSTALL_PREFIX=../_install \
|
||||
-DCMAKE_BUILD_TYPE=Release \
|
||||
-DCMAKE_CXX_STANDARD=${{ matrix.cxx-standard }} \
|
||||
-DOCIO_BUILD_DOCS=${{ matrix.build-docs }} \
|
||||
-DOCIO_BUILD_OPENFX=${{ matrix.build-openfx }} \
|
||||
-DOCIO_BUILD_GPU_TESTS=OFF \
|
||||
-DOCIO_INSTALL_EXT_PACKAGES=NONE \
|
||||
-DOCIO_WARNING_AS_ERROR=OFF \
|
||||
-DPython_EXECUTABLE=$(which python) \
|
||||
-DOCIO_USE_OIIO_FOR_APPS=${{ matrix.use-oiio }}
|
||||
working-directory: _build
|
||||
- name: Build
|
||||
run: |
|
||||
cmake --build . \
|
||||
--target install \
|
||||
--config Release \
|
||||
-- -j$(nproc)
|
||||
working-directory: _build
|
||||
- name: Test
|
||||
run: ctest -V -C Release
|
||||
working-directory: _build
|
||||
- name: Test CMake Consumer
|
||||
run: |
|
||||
cmake . \
|
||||
-DCMAKE_PREFIX_PATH=../../../_install \
|
||||
-DCMAKE_BUILD_TYPE=Release
|
||||
cmake --build . \
|
||||
--config Release
|
||||
./consumer
|
||||
working-directory: _build/tests/cmake-consumer-dist
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# MacOS latest ext packages
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
macos-latest:
|
||||
name: 'macOS latest
|
||||
<AppleClang
|
||||
cxx=${{ matrix.cxx-standard }},
|
||||
docs=${{ matrix.build-docs }},
|
||||
python=${{ matrix.python-version }}>'
|
||||
# Don't run on OCIO forks
|
||||
if: github.repository == 'AcademySoftwareFoundation/OpenColorIO'
|
||||
runs-on: macos-latest
|
||||
strategy:
|
||||
matrix:
|
||||
build: [1, 2]
|
||||
include:
|
||||
- build: 1
|
||||
build-docs: 'ON'
|
||||
build-openfx: 'ON'
|
||||
cxx-standard: 17
|
||||
python-version: '3.11'
|
||||
use-oiio: 'ON'
|
||||
- build: 2
|
||||
build-docs: 'ON'
|
||||
build-openfx: 'ON'
|
||||
cxx-standard: 14
|
||||
python-version: '3.9'
|
||||
use-oiio: 'OFF'
|
||||
steps:
|
||||
- name: Setup Python
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
- name: Install docs env
|
||||
run: share/ci/scripts/macos/install_docs_env.sh
|
||||
if: matrix.build-docs == 'ON'
|
||||
- name: Install tests env
|
||||
run: share/ci/scripts/macos/install_tests_env.sh
|
||||
- name: Setup ext environment
|
||||
run: |
|
||||
EXT_PATH=/usr/local
|
||||
echo "EXT_PATH=$EXT_PATH" >> $GITHUB_ENV
|
||||
- name: Install indirect dependencies
|
||||
run: |
|
||||
share/ci/scripts/macos/install_bison.sh latest
|
||||
share/ci/scripts/macos/install_boost.sh latest
|
||||
share/ci/scripts/multi/install_pugixml.sh latest $EXT_PATH
|
||||
- name: Install fixed ext package versions
|
||||
# Minizip-ng depends on ZLIB. ZLIB must be installed first.
|
||||
run: |
|
||||
share/ci/scripts/multi/install_expat.sh 2.4.1 $EXT_PATH
|
||||
share/ci/scripts/multi/install_lcms2.sh 2.2 $EXT_PATH
|
||||
share/ci/scripts/multi/install_yaml-cpp.sh 0.7.0 $EXT_PATH
|
||||
share/ci/scripts/multi/install_pystring.sh 1.1.3 $EXT_PATH
|
||||
share/ci/scripts/multi/install_pybind11.sh 2.9.2 $EXT_PATH
|
||||
share/ci/scripts/multi/install_zlib.sh 1.2.12 $EXT_PATH
|
||||
share/ci/scripts/multi/install_minizip-ng.sh 3.0.6 $EXT_PATH
|
||||
- name: Install latest ext package versions
|
||||
run: |
|
||||
share/ci/scripts/multi/install_imath.sh latest $EXT_PATH
|
||||
share/ci/scripts/multi/install_openexr.sh latest $EXT_PATH
|
||||
share/ci/scripts/multi/install_oiio.sh latest $EXT_PATH
|
||||
share/ci/scripts/multi/install_osl.sh latest $EXT_PATH
|
||||
share/ci/scripts/multi/install_openfx.sh latest $EXT_PATH
|
||||
- name: Create build directories
|
||||
run: |
|
||||
mkdir _install
|
||||
mkdir _build
|
||||
- name: Configure
|
||||
run: |
|
||||
cmake ../. \
|
||||
-DCMAKE_INSTALL_PREFIX=../_install \
|
||||
-DCMAKE_BUILD_TYPE=Release \
|
||||
-DCMAKE_CXX_STANDARD=${{ matrix.cxx-standard }} \
|
||||
-DOCIO_BUILD_DOCS=${{ matrix.build-docs }} \
|
||||
-DOCIO_BUILD_OPENFX=${{ matrix.build-openfx }} \
|
||||
-DOCIO_BUILD_GPU_TESTS=OFF \
|
||||
-DOCIO_INSTALL_EXT_PACKAGES=NONE \
|
||||
-DOCIO_WARNING_AS_ERROR=OFF \
|
||||
-DPython_EXECUTABLE=$(which python) \
|
||||
-DOCIO_USE_OIIO_FOR_APPS=${{ matrix.use-oiio }}
|
||||
working-directory: _build
|
||||
- name: Build
|
||||
run: |
|
||||
cmake --build . \
|
||||
--target install \
|
||||
--config Release \
|
||||
-- -j$(sysctl -n hw.ncpu)
|
||||
working-directory: _build
|
||||
- name: Test
|
||||
run: ctest -V -C Release
|
||||
working-directory: _build
|
||||
- name: Test CMake Consumer
|
||||
run: |
|
||||
cmake . \
|
||||
-DCMAKE_PREFIX_PATH=../../../_install \
|
||||
-DCMAKE_BUILD_TYPE=Release
|
||||
cmake --build . \
|
||||
--config Release
|
||||
./consumer
|
||||
working-directory: _build/tests/cmake-consumer-dist
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Windows latest ext packages
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
windows-latest:
|
||||
name: 'Windows latest
|
||||
<MSVC
|
||||
cxx=${{ matrix.cxx-standard }},
|
||||
docs=${{ matrix.build-docs }},
|
||||
python=${{ matrix.python-version }}>'
|
||||
# Don't run on OCIO forks
|
||||
if: github.repository == 'AcademySoftwareFoundation/OpenColorIO'
|
||||
runs-on: windows-latest
|
||||
strategy:
|
||||
matrix:
|
||||
build: [1, 2]
|
||||
include:
|
||||
- build: 1
|
||||
build-docs: 'ON'
|
||||
build-openfx: 'ON'
|
||||
cxx-standard: 17
|
||||
python-version: '3.11'
|
||||
use-oiio: 'ON'
|
||||
- build: 2
|
||||
build-docs: 'ON'
|
||||
build-openfx: 'ON'
|
||||
cxx-standard: 14
|
||||
python-version: '3.9'
|
||||
use-oiio: 'OFF'
|
||||
steps:
|
||||
- name: Setup Python
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
- name: Install docs env
|
||||
run: |
|
||||
DOXYGEN_PATH=$GITHUB_WORKSPACE/doxygen
|
||||
share/ci/scripts/windows/install_docs_env.sh "$DOXYGEN_PATH"
|
||||
echo "$DOXYGEN_PATH" >> $GITHUB_PATH
|
||||
shell: bash
|
||||
if: matrix.build-docs == 'ON'
|
||||
- name: Install tests env
|
||||
run: share/ci/scripts/windows/install_tests_env.sh
|
||||
shell: bash
|
||||
- name: Setup ext environment
|
||||
run: |
|
||||
EXT_PATH=$GITHUB_WORKSPACE/_ext
|
||||
VCPKG_ROOT=$VCPKG_INSTALLATION_ROOT/installed/x64-windows
|
||||
echo "EXT_PATH=$EXT_PATH" >> $GITHUB_ENV
|
||||
echo "CMAKE_PREFIX_PATH=$VCPKG_ROOT;$EXT_PATH" >> $GITHUB_ENV
|
||||
echo "$VCPKG_ROOT/bin" >> $GITHUB_PATH
|
||||
echo "$EXT_PATH/bin" >> $GITHUB_PATH
|
||||
mkdir $EXT_PATH
|
||||
shell: bash
|
||||
- name: Install indirect dependencies
|
||||
run: |
|
||||
vcpkg install zlib:x64-windows
|
||||
vcpkg install tiff:x64-windows
|
||||
vcpkg install boost-asio:x64-windows
|
||||
vcpkg install boost-container:x64-windows
|
||||
vcpkg install boost-filesystem:x64-windows
|
||||
vcpkg install boost-math:x64-windows
|
||||
vcpkg install boost-stacktrace:x64-windows
|
||||
vcpkg install boost-system:x64-windows
|
||||
vcpkg install boost-thread:x64-windows
|
||||
share/ci/scripts/multi/install_pugixml.sh latest $EXT_PATH
|
||||
shell: bash
|
||||
- name: Install fixed ext package versions
|
||||
# Minizip-ng depends on ZLIB. ZLIB must be installed first.
|
||||
run: |
|
||||
share/ci/scripts/multi/install_lcms2.sh 2.2 $EXT_PATH
|
||||
share/ci/scripts/multi/install_yaml-cpp.sh 0.7.0 $EXT_PATH
|
||||
share/ci/scripts/multi/install_pystring.sh 1.1.3 $EXT_PATH
|
||||
share/ci/scripts/multi/install_pybind11.sh 2.9.2 $EXT_PATH
|
||||
share/ci/scripts/multi/install_expat.sh 2.4.1 $EXT_PATH
|
||||
share/ci/scripts/multi/install_zlib.sh 1.2.12 $EXT_PATH
|
||||
share/ci/scripts/multi/install_minizip-ng.sh 3.0.6 $EXT_PATH
|
||||
shell: bash
|
||||
# OSL not installed due to LLVM compilation time.
|
||||
- name: Install latest ext package versions
|
||||
run: |
|
||||
share/ci/scripts/multi/install_imath.sh latest $EXT_PATH
|
||||
share/ci/scripts/multi/install_openexr.sh latest $EXT_PATH
|
||||
share/ci/scripts/multi/install_oiio.sh latest $EXT_PATH
|
||||
share/ci/scripts/multi/install_openfx.sh latest $EXT_PATH
|
||||
shell: bash
|
||||
- name: Create build directories
|
||||
run: |
|
||||
mkdir _install
|
||||
mkdir _build
|
||||
shell: bash
|
||||
- name: Configure
|
||||
run: |
|
||||
cmake ../. \
|
||||
-DCMAKE_INSTALL_PREFIX=../_install \
|
||||
-DCMAKE_BUILD_TYPE=Release \
|
||||
-DCMAKE_CXX_STANDARD=${{ matrix.cxx-standard }} \
|
||||
-DCMAKE_GENERATOR_PLATFORM=x64 \
|
||||
-DOCIO_BUILD_DOCS=OFF \
|
||||
-DOCIO_BUILD_OPENFX=${{ matrix.build-openfx }} \
|
||||
-DOCIO_BUILD_GPU_TESTS=OFF \
|
||||
-DOCIO_INSTALL_EXT_PACKAGES=NONE \
|
||||
-DOCIO_WARNING_AS_ERROR=OFF \
|
||||
-DPython_EXECUTABLE=$(which python) \
|
||||
-DOCIO_BUILD_PYTHON=OFF \
|
||||
-DOCIO_USE_OIIO_FOR_APPS=${{ matrix.use-oiio }}
|
||||
shell: bash
|
||||
working-directory: _build
|
||||
- name: Build
|
||||
run: |
|
||||
cmake --build . \
|
||||
--target install \
|
||||
--config Release \
|
||||
--parallel
|
||||
shell: bash
|
||||
working-directory: _build
|
||||
- name: Test
|
||||
run: |
|
||||
ctest -V -C Release
|
||||
shell: bash
|
||||
working-directory: _build
|
||||
- name: Test CMake Consumer
|
||||
run: |
|
||||
cmake . \
|
||||
-DCMAKE_PREFIX_PATH=../../../_install \
|
||||
-DCMAKE_BUILD_TYPE=Release
|
||||
cmake --build . \
|
||||
--config Release
|
||||
export PATH=../../../_install/bin:$PATH
|
||||
./Release/consumer
|
||||
shell: bash
|
||||
working-directory: _build/tests/cmake-consumer-dist
|
||||
@@ -33,13 +33,13 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Configure AWS Credentials
|
||||
uses: aws-actions/configure-aws-credentials@v2
|
||||
uses: aws-actions/configure-aws-credentials@v1
|
||||
with:
|
||||
aws-access-key-id: ${{ secrets.CODEBUILD_ID }}
|
||||
aws-secret-access-key: ${{ secrets.CODEBUILD_SECRET }}
|
||||
aws-region: us-west-2
|
||||
- name: Run CodeBuild
|
||||
uses: aws-actions/aws-codebuild-run-build@v1
|
||||
uses: aws-actions/aws-codebuild-run-project@v1.0.0
|
||||
with:
|
||||
project-name: OpenColorIO
|
||||
buildspec-override: buildspec.yml
|
||||
|
||||
@@ -1,396 +0,0 @@
|
||||
# SPDX-License-Identifier: BSD-3-Clause
|
||||
# Copyright Contributors to the OpenColorIO Project.
|
||||
#
|
||||
# GitHub Actions workflow file
|
||||
# https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions
|
||||
|
||||
name: Platform latest
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches-ignore:
|
||||
- RB-0.*
|
||||
- RB-1.*
|
||||
- gh-pages
|
||||
tags-ignore:
|
||||
- v0.*
|
||||
- v1.*
|
||||
paths:
|
||||
- .github/workflows/platform_latest.yml
|
||||
schedule:
|
||||
# Nightly build
|
||||
- cron: "0 0 * * *"
|
||||
|
||||
jobs:
|
||||
# ---------------------------------------------------------------------------
|
||||
# Linux latest ext packages
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
linux_latest:
|
||||
name: 'Linux Ubuntu latest
|
||||
<${{ matrix.compiler-desc }}
|
||||
config=${{ matrix.build-type }},
|
||||
shared=${{ matrix.build-shared }},
|
||||
cxx=${{ matrix.cxx-standard }}>'
|
||||
# Don't run on OCIO forks
|
||||
if: github.repository == 'AcademySoftwareFoundation/OpenColorIO'
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
matrix:
|
||||
build: [1, 2, 3, 4]
|
||||
include:
|
||||
# -------------------------------------------------------------------
|
||||
# GCC
|
||||
# -------------------------------------------------------------------
|
||||
- build: 1
|
||||
build-python: ON
|
||||
build-type: Release
|
||||
build-shared: ON
|
||||
cxx-standard: 20
|
||||
cxx-compiler: g++
|
||||
cc-compiler: gcc
|
||||
compiler-desc: GCC
|
||||
enable-sanitizer: OFF
|
||||
- build: 2
|
||||
build-python: OFF
|
||||
build-type: Debug
|
||||
build-shared: ON
|
||||
cxx-standard: 20
|
||||
cxx-compiler: g++
|
||||
cc-compiler: gcc
|
||||
compiler-desc: GCC
|
||||
enable-sanitizer: ON
|
||||
# -------------------------------------------------------------------
|
||||
# Clang
|
||||
# -------------------------------------------------------------------
|
||||
- build: 3
|
||||
build-python: ON
|
||||
build-type: Release
|
||||
build-shared: ON
|
||||
cxx-standard: 20
|
||||
cxx-compiler: clang++
|
||||
cc-compiler: clang
|
||||
compiler-desc: Clang
|
||||
enable-sanitizer: OFF
|
||||
- build: 4
|
||||
build-python: OFF
|
||||
build-type: Debug
|
||||
build-shared: ON
|
||||
cxx-standard: 20
|
||||
cxx-compiler: clang++
|
||||
cc-compiler: clang
|
||||
compiler-desc: Clang
|
||||
enable-sanitizer: ON
|
||||
env:
|
||||
CXX: ${{ matrix.cxx-compiler }}
|
||||
CC: ${{ matrix.cc-compiler }}
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
- name: Install tests env
|
||||
run: share/ci/scripts/linux/yum/install_tests_env.sh
|
||||
- name: Create build directories
|
||||
run: |
|
||||
mkdir _install
|
||||
mkdir _build
|
||||
- name: Configure
|
||||
run: |
|
||||
cmake ../. \
|
||||
-DCMAKE_INSTALL_PREFIX=../_install \
|
||||
-DCMAKE_BUILD_TYPE=${{ matrix.build-type }} \
|
||||
-DCMAKE_CXX_STANDARD=${{ matrix.cxx-standard }} \
|
||||
-DBUILD_SHARED_LIBS=${{ matrix.build-shared }} \
|
||||
-DOCIO_BUILD_DOCS=OFF \
|
||||
-DOCIO_BUILD_OPENFX=ON \
|
||||
-DOCIO_BUILD_GPU_TESTS=OFF \
|
||||
-DOCIO_BUILD_PYTHON=${{ matrix.build-python}} \
|
||||
-DOCIO_USE_SIMD=ON \
|
||||
-DOCIO_USE_OIIO_FOR_APPS=OFF \
|
||||
-DOCIO_INSTALL_EXT_PACKAGES=ALL \
|
||||
-DOCIO_WARNING_AS_ERROR=ON \
|
||||
-DOCIO_ENABLE_SANITIZER=${{ matrix.enable-sanitizer }} \
|
||||
-DPython_EXECUTABLE=$(which python)
|
||||
working-directory: _build
|
||||
- name: Build
|
||||
run: |
|
||||
cmake --build . \
|
||||
--target install \
|
||||
--config ${{ matrix.build-type }} \
|
||||
-v \
|
||||
-- -j$(nproc)
|
||||
echo "ocio_build_path=$(pwd)" >> $GITHUB_ENV
|
||||
working-directory: _build
|
||||
- name: Test
|
||||
run: ctest -V -C ${{ matrix.build-type }}
|
||||
working-directory: _build
|
||||
- name: Test CMake Consumer with shared OCIO
|
||||
if: matrix.build-shared == 'ON'
|
||||
run: |
|
||||
cmake . \
|
||||
-DCMAKE_PREFIX_PATH=../../../_install \
|
||||
-DCMAKE_BUILD_TYPE=${{ matrix.build-type }} \
|
||||
-DOCIO_ENABLE_SANITIZER=${{ matrix.enable-sanitizer }}
|
||||
cmake --build . \
|
||||
--config ${{ matrix.build-type }}
|
||||
./consumer
|
||||
working-directory: _build/tests/cmake-consumer-dist
|
||||
- name: Test CMake Consumer with static OCIO
|
||||
if: matrix.build-shared == 'OFF'
|
||||
# The yaml-cpp_VERSION is set below because Findyaml-cpp.cmake needs it but is unable to
|
||||
# extract it from the headers, like the other modules.
|
||||
#
|
||||
# Prefer the static version of each dependencies by using <pkg>_STATIC_LIBRARY.
|
||||
# Alternatively, this can be done by setting <pkg>_LIBRARY and <pkg>_INCLUDE_DIR to
|
||||
# the static version of the package.
|
||||
run: |
|
||||
cmake . \
|
||||
-DCMAKE_PREFIX_PATH=../../../_install \
|
||||
-DCMAKE_BUILD_TYPE=${{ matrix.build-type }} \
|
||||
-Dexpat_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-Dexpat_STATIC_LIBRARY=ON \
|
||||
-DImath_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-DImath_STATIC_LIBRARY=ON \
|
||||
-Dpystring_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-Dyaml-cpp_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-Dyaml-cpp_STATIC_LIBRARY=ON \
|
||||
-Dyaml-cpp_VERSION=0.7.0 \
|
||||
-DZLIB_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-DZLIB_STATIC_LIBRARY=ON \
|
||||
-Dminizip-ng_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-Dminizip-ng_STATIC_LIBRARY=ON
|
||||
cmake --build . \
|
||||
--config ${{ matrix.build-type }}
|
||||
./consumer
|
||||
working-directory: _build/tests/cmake-consumer-dist
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# MacOS latest ext packages
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
macos-latest:
|
||||
name: 'macOS latest
|
||||
<AppleClang
|
||||
config=${{ matrix.build-type }},
|
||||
shared=${{ matrix.build-shared }},
|
||||
cxx=${{ matrix.cxx-standard }},
|
||||
python=${{ matrix.python-version }}>'
|
||||
# Don't run on OCIO forks
|
||||
if: github.repository == 'AcademySoftwareFoundation/OpenColorIO'
|
||||
runs-on: macos-latest
|
||||
strategy:
|
||||
matrix:
|
||||
build: [1, 2]
|
||||
include:
|
||||
- build: 1
|
||||
build-python: ON
|
||||
build-type: Release
|
||||
build-shared: ON
|
||||
cxx-standard: 20
|
||||
enable-sanitizer: OFF
|
||||
python-version: '3.11'
|
||||
- build: 2
|
||||
build-python: OFF
|
||||
build-type: Debug
|
||||
build-shared: ON
|
||||
cxx-standard: 20
|
||||
enable-sanitizer: ON
|
||||
python-version: '3.11'
|
||||
steps:
|
||||
- name: Setup Python
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
- name: Install tests env
|
||||
run: share/ci/scripts/macos/install_tests_env.sh
|
||||
- name: Create build directories
|
||||
run: |
|
||||
mkdir _install
|
||||
mkdir _build
|
||||
- name: Configure
|
||||
run: |
|
||||
cmake ../. \
|
||||
-DCMAKE_INSTALL_PREFIX=../_install \
|
||||
-DCMAKE_BUILD_TYPE=${{ matrix.build-type }} \
|
||||
-DCMAKE_CXX_STANDARD=${{ matrix.cxx-standard }} \
|
||||
-DBUILD_SHARED_LIBS=${{ matrix.build-shared }} \
|
||||
-DOCIO_BUILD_DOCS=OFF \
|
||||
-DOCIO_BUILD_OPENFX=ON \
|
||||
-DOCIO_BUILD_GPU_TESTS=OFF \
|
||||
-DOCIO_BUILD_PYTHON=${{ matrix.build-python}} \
|
||||
-DOCIO_USE_SIMD=ON \
|
||||
-DOCIO_USE_OIIO_FOR_APPS=OFF \
|
||||
-DOCIO_INSTALL_EXT_PACKAGES=ALL \
|
||||
-DOCIO_WARNING_AS_ERROR=ON \
|
||||
-DOCIO_ENABLE_SANITIZER=${{ matrix.enable-sanitizer }} \
|
||||
-DPython_EXECUTABLE=$(which python)
|
||||
working-directory: _build
|
||||
- name: Build
|
||||
run: |
|
||||
cmake --build . \
|
||||
--target install \
|
||||
--config ${{ matrix.build-type }} \
|
||||
-- -j$(sysctl -n hw.ncpu)
|
||||
echo "ocio_build_path=$(pwd)" >> $GITHUB_ENV
|
||||
working-directory: _build
|
||||
- name: Test
|
||||
run: ctest -V -C ${{ matrix.build-type }}
|
||||
working-directory: _build
|
||||
- name: Test CMake Consumer with shared OCIO
|
||||
if: matrix.build-shared == 'ON'
|
||||
run: |
|
||||
cmake . \
|
||||
-DCMAKE_PREFIX_PATH=../../../_install \
|
||||
-DCMAKE_BUILD_TYPE=${{ matrix.build-type }}
|
||||
cmake --build . \
|
||||
--config ${{ matrix.build-type }}
|
||||
./consumer
|
||||
working-directory: _build/tests/cmake-consumer-dist
|
||||
- name: Test CMake Consumer with static OCIO
|
||||
if: matrix.build-shared == 'OFF'
|
||||
# The yaml-cpp_VERSION is set below because Findyaml-cpp.cmake needs it but is unable to
|
||||
# extract it from the headers, like the other modules.
|
||||
#
|
||||
# Prefer the static version of each dependencies by using <pkg>_STATIC_LIBRARY.
|
||||
# Alternatively, this can be done by setting <pkg>_LIBRARY and <pkg>_INCLUDE_DIR to
|
||||
# the static version of the package.
|
||||
run: |
|
||||
cmake . \
|
||||
-DCMAKE_PREFIX_PATH=../../../_install \
|
||||
-DCMAKE_BUILD_TYPE=${{ matrix.build-type }} \
|
||||
-Dexpat_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-Dexpat_STATIC_LIBRARY=ON \
|
||||
-DImath_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-DImath_STATIC_LIBRARY=ON \
|
||||
-Dpystring_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-Dyaml-cpp_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-Dyaml-cpp_STATIC_LIBRARY=ON \
|
||||
-Dyaml-cpp_VERSION=0.7.0 \
|
||||
-DZLIB_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-DZLIB_STATIC_LIBRARY=ON \
|
||||
-Dminizip-ng_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-Dminizip-ng_STATIC_LIBRARY=ON
|
||||
cmake --build . \
|
||||
--config ${{ matrix.build-type }}
|
||||
./consumer
|
||||
working-directory: _build/tests/cmake-consumer-dist
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Windows latest ext packages
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
windows-latest:
|
||||
name: 'Windows latest
|
||||
<MSVC
|
||||
config=${{ matrix.build-type }},
|
||||
shared=${{ matrix.build-shared }},
|
||||
cxx=${{ matrix.cxx-standard }},
|
||||
python=${{ matrix.python-version }}>'
|
||||
# Don't run on OCIO forks
|
||||
if: github.repository == 'AcademySoftwareFoundation/OpenColorIO'
|
||||
runs-on: windows-latest
|
||||
strategy:
|
||||
matrix:
|
||||
build: [1, 2]
|
||||
include:
|
||||
- build: 1
|
||||
build-python: ON
|
||||
build-type: Release
|
||||
build-shared: ON
|
||||
cxx-standard: 20
|
||||
python-version: '3.11'
|
||||
- build: 2
|
||||
build-python: ON
|
||||
build-type: Debug
|
||||
build-shared: ON
|
||||
cxx-standard: 20
|
||||
python-version: '3.11'
|
||||
steps:
|
||||
- name: Setup Python
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
- name: Install tests env
|
||||
run: share/ci/scripts/windows/install_tests_env.sh
|
||||
shell: bash
|
||||
- name: Create build directories
|
||||
run: |
|
||||
mkdir _install
|
||||
mkdir _build
|
||||
shell: bash
|
||||
- name: Configure
|
||||
run: |
|
||||
cmake ../. \
|
||||
-DCMAKE_INSTALL_PREFIX=../_install \
|
||||
-DCMAKE_BUILD_TYPE=${{ matrix.build-type }} \
|
||||
-DCMAKE_CXX_STANDARD=${{ matrix.cxx-standard }} \
|
||||
-DCMAKE_GENERATOR_PLATFORM=x64 \
|
||||
-DBUILD_SHARED_LIBS=${{ matrix.build-shared }} \
|
||||
-DOCIO_BUILD_DOCS=OFF \
|
||||
-DOCIO_BUILD_OPENFX=ON \
|
||||
-DOCIO_BUILD_GPU_TESTS=OFF \
|
||||
-DOCIO_BUILD_PYTHON=${{ matrix.build-python}} \
|
||||
-DOCIO_USE_SIMD=ON \
|
||||
-DOCIO_USE_OIIO_FOR_APPS=OFF \
|
||||
-DOCIO_INSTALL_EXT_PACKAGES=ALL \
|
||||
-DOCIO_WARNING_AS_ERROR=ON \
|
||||
-DPython_EXECUTABLE=$(which python)
|
||||
shell: bash
|
||||
working-directory: _build
|
||||
- name: Build
|
||||
run: |
|
||||
cmake --build . \
|
||||
--target install \
|
||||
--config ${{ matrix.build-type }}
|
||||
echo "ocio_build_path=$(pwd)" >> $GITHUB_ENV
|
||||
shell: bash
|
||||
working-directory: _build
|
||||
- name: Test
|
||||
run: ctest -V -C ${{ matrix.build-type }}
|
||||
shell: bash
|
||||
working-directory: _build
|
||||
- name: Test CMake Consumer with shared OCIO
|
||||
if: matrix.build-shared == 'ON'
|
||||
run: |
|
||||
cmake . \
|
||||
-DCMAKE_PREFIX_PATH=../../../_install \
|
||||
-DCMAKE_BUILD_TYPE=${{ matrix.build-type }}
|
||||
cmake --build . \
|
||||
--config ${{ matrix.build-type }}
|
||||
export PATH=../../../_install/bin:$PATH
|
||||
./${{ matrix.build-type }}/consumer
|
||||
shell: bash
|
||||
working-directory: _build/tests/cmake-consumer-dist
|
||||
- name: Test CMake Consumer with static OCIO
|
||||
if: matrix.build-shared == 'OFF'
|
||||
# The yaml-cpp_VERSION is set below because Findyaml-cpp.cmake needs it but is unable to
|
||||
# extract it from the headers, like the other modules.
|
||||
#
|
||||
# Prefer the static version of each dependencies by using <pkg>_STATIC_LIBRARY.
|
||||
# Alternatively, this can be done by setting <pkg>_LIBRARY and <pkg>_INCLUDE_DIR to
|
||||
# the static version of the package.
|
||||
run: |
|
||||
cmake . \
|
||||
-DCMAKE_PREFIX_PATH=../../../_install \
|
||||
-DCMAKE_BUILD_TYPE=${{ matrix.build-type }} \
|
||||
-Dexpat_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-Dexpat_STATIC_LIBRARY=ON \
|
||||
-DImath_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-DImath_STATIC_LIBRARY=ON \
|
||||
-Dpystring_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-Dyaml-cpp_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-Dyaml-cpp_STATIC_LIBRARY=ON \
|
||||
-Dyaml-cpp_VERSION=0.7.0 \
|
||||
-DZLIB_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-DZLIB_STATIC_LIBRARY=ON \
|
||||
-Dminizip-ng_ROOT=${{ env.ocio_build_path }}/ext/dist \
|
||||
-Dminizip-ng_STATIC_LIBRARY=ON
|
||||
cmake --build . \
|
||||
--config ${{ matrix.build-type }}
|
||||
export PATH=../../../_install/bin:$PATH
|
||||
./${{ matrix.build-type }}/consumer
|
||||
shell: bash
|
||||
working-directory: _build/tests/cmake-consumer-dist
|
||||
@@ -20,10 +20,7 @@ on:
|
||||
- v1.*
|
||||
paths:
|
||||
- .github/workflows/wheel_workflow.yml
|
||||
- MANIFEST.in
|
||||
- pyproject.toml
|
||||
- setup.cfg
|
||||
- setup.py
|
||||
schedule:
|
||||
# Nightly build
|
||||
- cron: "0 0 * * *"
|
||||
@@ -38,33 +35,7 @@ jobs:
|
||||
# version), we build on manylinux2014 image, this requires pip >= 19.3.
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Source Distribution
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
sdist:
|
||||
name: Build SDist
|
||||
runs-on: ubuntu-latest
|
||||
# Don't run on OCIO forks
|
||||
if: |
|
||||
github.event_name != 'schedule' ||
|
||||
github.repository == 'AcademySoftwareFoundation/OpenColorIO'
|
||||
|
||||
steps:
|
||||
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Build SDist
|
||||
run: pipx run build --sdist
|
||||
|
||||
- name: Check metadata
|
||||
run: pipx run twine check dist/*
|
||||
|
||||
- uses: actions/upload-artifact@v3
|
||||
with:
|
||||
path: dist/*.tar.gz
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Linux Wheels
|
||||
# Linux
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
linux:
|
||||
@@ -78,119 +49,90 @@ jobs:
|
||||
matrix:
|
||||
include:
|
||||
# -------------------------------------------------------------------
|
||||
# CPython 64 bits manylinux_2_28
|
||||
# CPython 32 bits
|
||||
# -------------------------------------------------------------------
|
||||
- build: CPython 3.7 64 bits manylinux_2_28
|
||||
manylinux: manylinux_2_28
|
||||
- build: CPython 3.6 32 bits
|
||||
python: cp36-manylinux*
|
||||
arch: i686
|
||||
- build: CPython 3.7 32 bits
|
||||
python: cp37-manylinux*
|
||||
arch: i686
|
||||
- build: CPython 3.8 32 bits
|
||||
python: cp38-manylinux*
|
||||
arch: i686
|
||||
- build: CPython 3.9 32 bits
|
||||
python: cp39-manylinux*
|
||||
arch: i686
|
||||
- build: CPython 3.10 32 bits
|
||||
python: cp310-manylinux*
|
||||
arch: i686
|
||||
# -------------------------------------------------------------------
|
||||
# CPython 64 bits
|
||||
# -------------------------------------------------------------------
|
||||
- build: CPython 3.6 64 bits
|
||||
python: cp36-manylinux*
|
||||
arch: x86_64
|
||||
- build: CPython 3.7 64 bits
|
||||
python: cp37-manylinux*
|
||||
arch: x86_64
|
||||
- build: CPython 3.8 64 bits manylinux_2_28
|
||||
manylinux: manylinux_2_28
|
||||
- build: CPython 3.8 64 bits
|
||||
python: cp38-manylinux*
|
||||
arch: x86_64
|
||||
- build: CPython 3.9 64 bits manylinux_2_28
|
||||
manylinux: manylinux_2_28
|
||||
- build: CPython 3.9 64 bits
|
||||
python: cp39-manylinux*
|
||||
arch: x86_64
|
||||
- build: CPython 3.10 64 bits manylinux_2_28
|
||||
manylinux: manylinux_2_28
|
||||
- build: CPython 3.10 64 bits
|
||||
python: cp310-manylinux*
|
||||
arch: x86_64
|
||||
- build: CPython 3.11 64 bits manylinux_2_28
|
||||
manylinux: manylinux_2_28
|
||||
python: cp311-manylinux*
|
||||
arch: x86_64
|
||||
- build: CPython 3.12 64 bits manylinux_2_28
|
||||
manylinux: manylinux_2_28
|
||||
python: cp312-manylinux*
|
||||
arch: x86_64
|
||||
# -------------------------------------------------------------------
|
||||
# CPython 64 bits manylinux2014
|
||||
# CPython ARM 64 bits
|
||||
# -------------------------------------------------------------------
|
||||
- build: CPython 3.7 64 bits manylinux2014
|
||||
manylinux: manylinux2014
|
||||
python: cp37-manylinux*
|
||||
arch: x86_64
|
||||
- build: CPython 3.8 64 bits manylinux2014
|
||||
manylinux: manylinux2014
|
||||
python: cp38-manylinux*
|
||||
arch: x86_64
|
||||
- build: CPython 3.9 64 bits manylinux2014
|
||||
manylinux: manylinux2014
|
||||
python: cp39-manylinux*
|
||||
arch: x86_64
|
||||
- build: CPython 3.10 64 bits manylinux2014
|
||||
manylinux: manylinux2014
|
||||
python: cp310-manylinux*
|
||||
arch: x86_64
|
||||
- build: CPython 3.11 64 bits manylinux2014
|
||||
manylinux: manylinux2014
|
||||
python: cp311-manylinux*
|
||||
arch: x86_64
|
||||
- build: CPython 3.12 64 bits manylinux2014
|
||||
manylinux: manylinux2014
|
||||
python: cp312-manylinux*
|
||||
arch: x86_64
|
||||
# -------------------------------------------------------------------
|
||||
# CPython ARM 64 bits manylinux2014
|
||||
# -------------------------------------------------------------------
|
||||
- build: CPython 3.7 ARM 64 bits manylinux2014
|
||||
manylinux: manylinux2014
|
||||
- build: CPython 3.6 ARM 64 bits
|
||||
python: cp36-manylinux*
|
||||
arch: aarch64
|
||||
- build: CPython 3.7 ARM 64 bits
|
||||
python: cp37-manylinux*
|
||||
arch: aarch64
|
||||
- build: CPython 3.8 ARM 64 bits manylinux2014
|
||||
manylinux: manylinux2014
|
||||
- build: CPython 3.8 ARM 64 bits
|
||||
python: cp38-manylinux*
|
||||
arch: aarch64
|
||||
- build: CPython 3.9 ARM 64 bits manylinux2014
|
||||
manylinux: manylinux2014
|
||||
- build: CPython 3.9 ARM 64 bits
|
||||
python: cp39-manylinux*
|
||||
arch: aarch64
|
||||
- build: CPython 3.10 ARM 64 bits manylinux2014
|
||||
manylinux: manylinux2014
|
||||
- build: CPython 3.10 ARM 64 bits
|
||||
python: cp310-manylinux*
|
||||
arch: aarch64
|
||||
- build: CPython 3.11 ARM 64 bits manylinux2014
|
||||
manylinux: manylinux2014
|
||||
python: cp311-manylinux*
|
||||
arch: aarch64
|
||||
- build: CPython 3.12 ARM 64 bits manylinux2014
|
||||
manylinux: manylinux2014
|
||||
python: cp312-manylinux*
|
||||
arch: aarch64
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/checkout@v2
|
||||
|
||||
- uses: actions/setup-python@v4
|
||||
- uses: actions/setup-python@v2
|
||||
name: Install Python
|
||||
with:
|
||||
python-version: '3.8'
|
||||
|
||||
- name: Set up QEMU
|
||||
uses: docker/setup-qemu-action@v2
|
||||
uses: docker/setup-qemu-action@v1
|
||||
with:
|
||||
platforms: all
|
||||
|
||||
- name: Build wheels
|
||||
uses: pypa/cibuildwheel@v2.16.2
|
||||
uses: pypa/cibuildwheel@v2.3.1
|
||||
env:
|
||||
CIBW_BUILD: ${{ matrix.python }}
|
||||
CIBW_ARCHS: ${{ matrix.arch }}
|
||||
CIBW_MANYLINUX_X86_64_IMAGE: ${{ matrix.manylinux }}
|
||||
CIBW_MANYLINUX_AARCH64_IMAGE: ${{ matrix.manylinux }}
|
||||
|
||||
- uses: actions/upload-artifact@v3
|
||||
- uses: actions/upload-artifact@v2
|
||||
with:
|
||||
path: ./wheelhouse/*.whl
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# macOS Wheels
|
||||
# macOS
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
macos:
|
||||
name: Build wheels on macOS
|
||||
runs-on: macos-12
|
||||
runs-on: macos-10.15
|
||||
# Don't run on OCIO forks
|
||||
if: |
|
||||
github.event_name != 'schedule' ||
|
||||
@@ -201,6 +143,9 @@ jobs:
|
||||
# -------------------------------------------------------------------
|
||||
# CPython 64 bits
|
||||
# -------------------------------------------------------------------
|
||||
- build: CPython 3.6 64 bits
|
||||
python: cp36-*
|
||||
arch: x86_64
|
||||
- build: CPython 3.7 64 bits
|
||||
python: cp37-*
|
||||
arch: x86_64
|
||||
@@ -213,56 +158,44 @@ jobs:
|
||||
- build: CPython 3.10 64 bits
|
||||
python: cp310-*
|
||||
arch: x86_64
|
||||
- build: CPython 3.11 64 bits
|
||||
python: cp311-*
|
||||
arch: x86_64
|
||||
- build: CPython 3.12 64 bits
|
||||
python: cp312-*
|
||||
arch: x86_64
|
||||
# -------------------------------------------------------------------
|
||||
# CPython ARM 64 bits
|
||||
# -------------------------------------------------------------------
|
||||
- build: CPython 3.8 ARM 64 bits
|
||||
python: cp38-*
|
||||
arch: arm64
|
||||
arch: universal2
|
||||
- build: CPython 3.9 ARM 64 bits
|
||||
python: cp39-*
|
||||
arch: arm64
|
||||
arch: universal2
|
||||
- build: CPython 3.10 ARM 64 bits
|
||||
python: cp310-*
|
||||
arch: arm64
|
||||
- build: CPython 3.11 ARM 64 bits
|
||||
python: cp311-*
|
||||
arch: arm64
|
||||
- build: CPython 3.12 ARM 64 bits
|
||||
python: cp312-*
|
||||
arch: arm64
|
||||
arch: universal2
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/checkout@v2
|
||||
|
||||
- uses: actions/setup-python@v4
|
||||
- uses: actions/setup-python@v2
|
||||
name: Install Python
|
||||
with:
|
||||
python-version: '3.8'
|
||||
|
||||
- name: Build wheels
|
||||
uses: pypa/cibuildwheel@v2.16.2
|
||||
uses: pypa/cibuildwheel@v2.3.1
|
||||
env:
|
||||
CIBW_BUILD: ${{ matrix.python }}
|
||||
CIBW_ARCHS: ${{ matrix.arch }}
|
||||
|
||||
- uses: actions/upload-artifact@v3
|
||||
- uses: actions/upload-artifact@v2
|
||||
with:
|
||||
path: ./wheelhouse/*.whl
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Windows Wheels
|
||||
# Windows
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
windows:
|
||||
name: Build wheels on Windows
|
||||
runs-on: windows-2022
|
||||
runs-on: windows-2019
|
||||
# Don't run on OCIO forks
|
||||
if: |
|
||||
github.event_name != 'schedule' ||
|
||||
@@ -271,8 +204,29 @@ jobs:
|
||||
matrix:
|
||||
include:
|
||||
# -------------------------------------------------------------------
|
||||
# CPython 32 bits
|
||||
# -------------------------------------------------------------------
|
||||
- build: CPython 3.6 32 bits
|
||||
python: cp36-*
|
||||
arch: x86
|
||||
- build: CPython 3.7 32 bits
|
||||
python: cp37-*
|
||||
arch: x86
|
||||
- build: CPython 3.8 32 bits
|
||||
python: cp38-*
|
||||
arch: x86
|
||||
- build: CPython 3.9 32 bits
|
||||
python: cp39-*
|
||||
arch: x86
|
||||
- build: CPython 3.10 32 bits
|
||||
python: cp310-*
|
||||
arch: x86
|
||||
# -------------------------------------------------------------------
|
||||
# CPython 64 bits
|
||||
# -------------------------------------------------------------------
|
||||
- build: CPython 3.6 64 bits
|
||||
python: cp36-*
|
||||
arch: AMD64
|
||||
- build: CPython 3.7 64 bits
|
||||
python: cp37-*
|
||||
arch: AMD64
|
||||
@@ -285,40 +239,34 @@ jobs:
|
||||
- build: CPython 3.10 64 bits
|
||||
python: cp310-*
|
||||
arch: AMD64
|
||||
- build: CPython 3.11 64 bits
|
||||
python: cp311-*
|
||||
arch: AMD64
|
||||
- build: CPython 3.12 64 bits
|
||||
python: cp312-*
|
||||
arch: AMD64
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/checkout@v2
|
||||
|
||||
- uses: actions/setup-python@v4
|
||||
- uses: actions/setup-python@v2
|
||||
name: Install Python
|
||||
with:
|
||||
python-version: '3.8'
|
||||
|
||||
- name: Build wheels
|
||||
uses: pypa/cibuildwheel@v2.16.2
|
||||
uses: pypa/cibuildwheel@v2.1.2
|
||||
env:
|
||||
CIBW_BUILD: ${{ matrix.python }}
|
||||
CIBW_ARCHS: ${{ matrix.arch }}
|
||||
|
||||
- uses: actions/upload-artifact@v3
|
||||
- uses: actions/upload-artifact@v2
|
||||
with:
|
||||
path: ./wheelhouse/*.whl
|
||||
|
||||
|
||||
upload_pypi:
|
||||
needs: [sdist, linux, macos, windows]
|
||||
needs: [linux, macos, windows]
|
||||
runs-on: ubuntu-latest
|
||||
if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags/v')
|
||||
steps:
|
||||
- uses: actions/setup-python@v4
|
||||
- uses: actions/setup-python@v2
|
||||
|
||||
- uses: actions/download-artifact@v3
|
||||
- uses: actions/download-artifact@v2
|
||||
with:
|
||||
name: artifact
|
||||
path: dist
|
||||
|
||||
+1
-1
@@ -52,7 +52,7 @@ This charter (the "Charter") sets forth the responsibilities and proce
|
||||
7. Intellectual Property Policy
|
||||
* **a.** Participants acknowledge that the copyright in all new contributions shall be retained by the copyright holder as independent works of authorship and that no contributor or copyright holder will be required to assign copyrights to the Project.
|
||||
* **b.** Except as described in Section 7.c., all code contributions to the Project are subject to the following:
|
||||
* **i.** All new inbound code contributions to the Project must be made using the **BSD 3-Clause License (available here: [https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/main/LICENSE](https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/main/LICENSE))** (the "Project License").
|
||||
* **i.** All new inbound code contributions to the Project must be made using the **BSD 3-Clause License (available here: [https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/master/LICENSE](https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/master/LICENSE))** (the "Project License").
|
||||
* **ii.** All new inbound code contributions must:
|
||||
1. be made pursuant to a duly executed Project Contribution License Agreement (the "CLA"), available on the Project's web site; and
|
||||
2. be accompanied by a Developer Certificate of Origin ([http://developercertificate.org](http://developercertificate.org)) sign-off in the source code system that is submitted through a TSC-approved contribution process which will bind the authorized contributor and, if not self-employed, their employer to the applicable license;
|
||||
|
||||
@@ -36,7 +36,7 @@ Attendees:
|
||||
* Infrastructure
|
||||
* GitHub repo needs migrating to the ASWF organisation
|
||||
* **TODO** - John Mertic to coordinate with Steve Winslow at the LF to complete.
|
||||
* https://github.com/AcademySoftwareFoundation/tac/blob/main/process/contributing.md
|
||||
* https://github.com/AcademySoftwareFoundation/tac/blob/master/process/contributing.md
|
||||
* Require that any existing copyright notices are reviewed and amended by the current stated owners if their respective legal agrees.
|
||||
* Once migrated will enable DCO sign off checking and CLA checks.
|
||||
* Sub-discussion on the option of separate sign off for committer vs developer sign off.
|
||||
|
||||
@@ -44,9 +44,9 @@ Attendees:
|
||||
* Do a patch against 1.1 that fixes a few minor things?
|
||||
* Consensus is that we should make 1.1.1 with some important non-breaking patches and release that fix right away.
|
||||
* **TODO**: Patrick will send Slack the list of candidate commits for a 1.1.1.
|
||||
* Do we make an intermediate release from main before v2.0? People want a "developer preview" to be able to use the new GPU path.
|
||||
* Do we make an intermediate release from master before v2.0? People want a "developer preview" to be able to use the new GPU path.
|
||||
* Patrick reluctant to make a full release.
|
||||
* Proposal: just make a "developer preview" tag in main to designate a point we think is stable and has some helpful new features, but we don't promise any support or compatibility with the eventual v2.
|
||||
* Proposal: just make a "developer preview" tag in master to designate a point we think is stable and has some helpful new features, but we don't promise any support or compatibility with the eventual v2.
|
||||
* Down side: people will use it and expect us to support it.
|
||||
* No consensus that this is a good idea. Mark especially doesn't like unsupported dev preview tag.
|
||||
* But v2 will NOT be ready by SIGGRAPH 2019. In light of this, Mark thinks maybe we should have a real intermediate release.
|
||||
|
||||
@@ -26,7 +26,7 @@ Attendees:
|
||||
- Doug: As established in the initial 2.0 proposal, this is not feasible.
|
||||
- The plan remains to release a complete feature set when the full v2 roadmap is completed.
|
||||
- Community concern is that the v2 release schedule is unknown, and time between OCIO releases is long.
|
||||
- This can make planning for software vendors challenging, but preliminary implementation of the v2 interface is possible now from main for testing.
|
||||
- This can make planning for software vendors challenging, but preliminary implementation of the v2 interface is possible now from master for testing.
|
||||
- Autodesk discussing an official roadmap and insight on a potential release window. Stay tuned.
|
||||
- Long PR review cycles contribute to development slowdowns:
|
||||
- Most PRs are merged with the 2 week single reviewer clause.
|
||||
@@ -37,7 +37,7 @@ Attendees:
|
||||
- PRs are becoming smaller, more focused, which should help with review accessability
|
||||
- **TODO**: Doug/Patrick to review and report back on what project management changes could help them
|
||||
- Larry: Should we have a known commit for testing a given feature (i.e. GPU renderer) for internal testing purposes.
|
||||
- Doug: Testing off of main at any given time is stable, and ideal.
|
||||
- Doug: Testing off of master at any given time is stable, and ideal.
|
||||
|
||||
* ASWF/LF CI update from TAC meeting
|
||||
- Thanh presented comparison of Circle CI and current Jenkins infrastructure:
|
||||
|
||||
@@ -43,7 +43,7 @@ Attendees:
|
||||
- Any recommendations from LF regarding what to add to CI?
|
||||
- Thanh: Some options are Nexus IQ, WhiteSource for security, Sonar Qube for static.
|
||||
- Thanh is doing some investigation for TAC, we will follow closely for recommendations.
|
||||
- John provide the following link: https://github.com/coreinfrastructure/best-practices-badge/blob/main/doc/security.md
|
||||
- John provide the following link: https://github.com/coreinfrastructure/best-practices-badge/blob/master/doc/security.md
|
||||
- Chair asked John if we were moving too slowly, John: no.
|
||||
|
||||
* 1.1.1 Release
|
||||
|
||||
@@ -29,7 +29,7 @@ Apologies:
|
||||
- Waiting approval
|
||||
|
||||
* Azure CI Build:
|
||||
- Larry G.: Needs to build OCIO with some dependency main branch to trap coming issues?
|
||||
- Larry G.: Needs to build OCIO with some dependency master branch to trap coming issues?
|
||||
- Larry G. Only some libraries:
|
||||
As OpenEXR is an indirect dependency, perhaps not needed.
|
||||
But OIIO could be a good candidate.
|
||||
|
||||
@@ -38,7 +38,7 @@ Apologies:
|
||||
Meatballs” images with Sony.
|
||||
- Kevin: We also need to update the LICENSE on the OCIO website
|
||||
- Michael: That is pulled from GitHub, but currently from the RB-1.1
|
||||
branch. Since the license cleanup work is being done in main, is it Ok
|
||||
branch. Since the license cleanup work is being done in master, is it Ok
|
||||
to wait for a 2.0 release next year to update the site?
|
||||
- John: That should be Ok.
|
||||
- Kevin: Let’s make a note to not forget it.
|
||||
|
||||
@@ -30,8 +30,8 @@ Attendees:
|
||||
* RB-1.1
|
||||
- Michael: Following the approval for another minor release (*TSC meeting 2019-08-12*),
|
||||
Travis & AppVeyor (i.e. the former CI build) are back for the RB-1.1 branch only.
|
||||
- AppVeyor uses RB-1.1 & main branch
|
||||
- **TODO**: Sean will help to disable main.
|
||||
- AppVeyor uses RB-1.1 & master branch
|
||||
- **TODO**: Sean will help to disable master.
|
||||
- Travis triggers new warnings/errors.
|
||||
Check [PR 798](https://github.com/imageworks/OpenColorIO/pull/798) for details.
|
||||
- Agreed to fix them.
|
||||
|
||||
@@ -28,7 +28,7 @@ Apologies:
|
||||
- Doug raised that pull request #831 removes macros specific to these versions of GCC.
|
||||
- Patrick raised that as we add more C+11 features the more we will be restricted.
|
||||
- Kevin thinks we should definitely drop support for GCC 3.
|
||||
- Patrick thought dropping GCC 3 would be fine and should be done in the main branch.
|
||||
- Patrick thought dropping GCC 3 would be fine and should be done in the master branch.
|
||||
|
||||
* Azure CI build
|
||||
- Patrick raised that the communication between Azure and Github is broken.
|
||||
|
||||
@@ -26,7 +26,7 @@ Attendees:
|
||||
- To document the policy concerning repository rights vs. roles.
|
||||
|
||||
* Branch protected
|
||||
- Agreement to only protect `main`, `RB-**` and `gh-pages`.
|
||||
- Agreement to only protect `master`, `RB-**` and `gh-pages`.
|
||||
|
||||
* Stalled pull requests
|
||||
- Agreement to not have any automatic removal of stalled pull requests.
|
||||
|
||||
@@ -32,7 +32,7 @@ Attendees:
|
||||
* ASWF GSoC discussion
|
||||
- Polled Slack for project ideas for ASWF's application to Google Summer of
|
||||
Code, and submitted PR to:
|
||||
`https://github.com/AcademySoftwareFoundation/tac/blob/main/gsoc/README.md`_
|
||||
`https://github.com/AcademySoftwareFoundation/tac/blob/master/gsoc/README.md`_
|
||||
- In summary, four projects initially proposed:
|
||||
- Add Metal, Vulkan, or CUDA language support to GPU renderer
|
||||
- Restore Java bindings
|
||||
@@ -52,7 +52,7 @@ Attendees:
|
||||
|
||||
* Python bindings
|
||||
- Michael: Resumed work on pybind11 bindings. Got everything up to date with
|
||||
main.
|
||||
master.
|
||||
- Mei Chu (Imageworks) is interested in helping with this work, potentially
|
||||
designing unit tests to start.
|
||||
- Mei: Looking forward to getting more involved in OCIO
|
||||
|
||||
@@ -61,7 +61,7 @@ Apologies: Michael Dolan
|
||||
in what types of EXR images may be read (e.g. looking for a specific channel layout,
|
||||
no multi-part support).
|
||||
- Kevin: A quick scan of the EXR codec shows it only really outputs 16 bit RGB, RGBA, YCbCr.
|
||||
https://github.com/FFmpeg/FFmpeg/blob/main/libavcodec/exr.c#L1691
|
||||
https://github.com/FFmpeg/FFmpeg/blob/master/libavcodec/exr.c#L1691
|
||||
- Mark: Is that integer 16 bit?
|
||||
- Kevin: Yes, integers.
|
||||
- Mark: One approach would be to make video filters for OCIO ColorSpaceTransform and
|
||||
|
||||
@@ -70,7 +70,7 @@ Apologies:
|
||||
- Carol: A lot of it can hopefully be to work with DCC vendors to help them
|
||||
update their docs as well, and to understand coming changes. Then we can
|
||||
point our docs to theirs.
|
||||
- Michael: The [Compatible Software](https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/main/docs/CompatibleSoftware.rst)
|
||||
- Michael: The [Compatible Software](https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/master/docs/CompatibleSoftware.rst)
|
||||
page of the OCIO website was updated recently and contains many
|
||||
up-to-date documentation links.
|
||||
- Doug: Also may want to add OCIO developers to the list of consumers, to
|
||||
|
||||
@@ -87,7 +87,7 @@ Apologies:
|
||||
- Sean: Docstring header PR is in. Need another PR for pybind11 docstring
|
||||
header, and another for reorganization of doc structure. The RTD page
|
||||
points to official OCIO repo, so we're live now, but API docs and new
|
||||
style is missing. Any changes to main are getting pushed to RTD now.
|
||||
style is missing. Any changes to master are getting pushed to RTD now.
|
||||
Not as much holding back docs as it seems.
|
||||
- Simran: An event hook in GH communicates to RTD when to update the site.
|
||||
- Michael: Can we open GH issues for logical chunks of work?
|
||||
|
||||
@@ -100,10 +100,10 @@ Apologies:
|
||||
begin that?
|
||||
- Kevin: If we create them together we are saying they are the same. If
|
||||
separated, might be different.
|
||||
- Patrick: Where do we put the tag? In main or in RB-2.0?
|
||||
- Mark: Have it in both, and cherry pick main changes into RB-2.0.
|
||||
- Patrick: Only consequence is main will be tagged as RC.
|
||||
- All agree to create tag in main and branch RB-2.0 from that.
|
||||
- Patrick: Where do we put the tag? In master or in RB-2.0?
|
||||
- Mark: Have it in both, and cherry pick master changes into RB-2.0.
|
||||
- Patrick: Only consequence is master will be tagged as RC.
|
||||
- All agree to create tag in master and branch RB-2.0 from that.
|
||||
|
||||
* General discussion:
|
||||
- Kevin: If we are concerned with ABI compatibility, should we put
|
||||
|
||||
@@ -69,7 +69,7 @@ Attendees:
|
||||
- Alexa: Better to link to DCC vendors own guides.
|
||||
- Michael: There is some of that on the site now in the Compatible Software
|
||||
page, which was updated recently:
|
||||
[Compatible Software](https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/main/docs/CompatibleSoftware.rst)
|
||||
[Compatible Software](https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/master/docs/CompatibleSoftware.rst)
|
||||
- Carol: Tricky to know which vendors to include tutorials for.
|
||||
- Alexa: Could be better to explain the config, and what each part means.
|
||||
It's difficult to find everything right now.
|
||||
|
||||
@@ -30,7 +30,7 @@ Recording on Zoom cloud:
|
||||
- Mark: Is ociocheck crashing for anyone?
|
||||
- Doug: We will look into it.
|
||||
- *UPDATE:* We tested this and it is working. We found a case where illegal
|
||||
(too long) spi1d LUTs caused a crash in main. These LUTs were not flagged as
|
||||
(too long) spi1d LUTs caused a crash in master. These LUTs were not flagged as
|
||||
being illegal in OCIO v1 and would have had incorrect results.
|
||||
|
||||
**STRING UTILS**
|
||||
|
||||
@@ -218,7 +218,7 @@ discussion about the questions raised.
|
||||
|
||||
**GENERAL DISCUSSION**
|
||||
|
||||
- Mark: I was testing main and found that role names are now
|
||||
- Mark: I was testing master and found that role names are now
|
||||
case-sensitive. This is a change from OCIO v1.
|
||||
- Doug: Are we agreed we want case-insensitive behavior? Same for color
|
||||
spaces too? Group agreed.
|
||||
|
||||
@@ -3,13 +3,8 @@
|
||||
|
||||
This file documents releases up to 1.1.1. For a description of version 2.0 and later
|
||||
please refer to the Releases page on GitHub:
|
||||
|
||||
https://github.com/AcademySoftwareFoundation/OpenColorIO/releases
|
||||
|
||||
and for more details please see the release notes in latest documentation pages:
|
||||
|
||||
https://opencolorio.readthedocs.io/en/latest/releases/_index.html#releases
|
||||
|
||||
**Version 1.1.1 (April 2 2019):**
|
||||
* Added optional compatibility for building apps with OpenImageIO 1.9+
|
||||
* Added USE_SSE checks to fix Linux build failure
|
||||
|
||||
+19
-228
@@ -5,14 +5,13 @@
|
||||
###############################################################################
|
||||
# CMake definition.
|
||||
|
||||
cmake_minimum_required(VERSION 3.13)
|
||||
cmake_minimum_required(VERSION 3.12)
|
||||
|
||||
set(CMAKE_MODULE_PATH
|
||||
${CMAKE_MODULE_PATH}
|
||||
${CMAKE_CURRENT_SOURCE_DIR}/share/cmake/utils
|
||||
${CMAKE_CURRENT_SOURCE_DIR}/share/cmake/macros
|
||||
${CMAKE_CURRENT_SOURCE_DIR}/share/cmake/modules
|
||||
${CMAKE_CURRENT_SOURCE_DIR}/share/cmake/modules/install
|
||||
${CMAKE_SOURCE_DIR}/share/cmake/utils
|
||||
${CMAKE_SOURCE_DIR}/share/cmake/macros
|
||||
${CMAKE_SOURCE_DIR}/share/cmake/modules
|
||||
)
|
||||
|
||||
set(CMAKE_WARN_DEPRECATED ON)
|
||||
@@ -29,7 +28,7 @@ endif()
|
||||
# Project definition.
|
||||
|
||||
project(OpenColorIO
|
||||
VERSION 2.3.2
|
||||
VERSION 2.1.2
|
||||
DESCRIPTION "OpenColorIO (OCIO) is a complete color management solution"
|
||||
HOMEPAGE_URL https://github.com/AcademySoftwareFoundation/OpenColorIO
|
||||
LANGUAGES CXX C)
|
||||
@@ -56,7 +55,7 @@ include(GNUInstallDirs)
|
||||
###############################################################################
|
||||
# Forbid in-source build.
|
||||
|
||||
if(${PROJECT_SOURCE_DIR} STREQUAL ${PROJECT_BINARY_DIR})
|
||||
if(${CMAKE_SOURCE_DIR} STREQUAL ${CMAKE_BINARY_DIR})
|
||||
message(FATAL_ERROR
|
||||
"In-source build not allowed. Please make a new sub-directory and run cmake from there.")
|
||||
endif()
|
||||
@@ -95,26 +94,11 @@ set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" "MinSizeR
|
||||
|
||||
# Is that a valid build type?
|
||||
|
||||
set(_build_type_valid_ false)
|
||||
foreach (_build_type_ ${CMAKE_CONFIGURATION_TYPES})
|
||||
string(TOLOWER ${_build_type_} _lowercase_build_type_)
|
||||
string(TOLOWER ${CMAKE_BUILD_TYPE} _lowercase_cmake_build_type_)
|
||||
|
||||
if (_lowercase_cmake_build_type_ STREQUAL _lowercase_build_type_)
|
||||
# Build type is supported.
|
||||
set(_build_type_valid_ true)
|
||||
break()
|
||||
endif()
|
||||
endforeach()
|
||||
unset(_lowercase_build_type_)
|
||||
unset(_lowercase_cmake_build_type_)
|
||||
|
||||
if (NOT _build_type_valid_)
|
||||
if(NOT "${CMAKE_BUILD_TYPE}" IN_LIST CMAKE_CONFIGURATION_TYPES)
|
||||
string(REPLACE ";" ", " _CMAKE_CONFIGURATION_TYPES_STR "${CMAKE_CONFIGURATION_TYPES}")
|
||||
message(FATAL_ERROR
|
||||
"CMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} is unsupported. Supported values are: ${_CMAKE_CONFIGURATION_TYPES_STR}.")
|
||||
endif()
|
||||
unset(_build_type_valid_)
|
||||
|
||||
# Is that in debug mode?
|
||||
|
||||
@@ -153,196 +137,31 @@ set (OCIO_PYTHON_VERSION "" CACHE STRING
|
||||
|
||||
option(OCIO_BUILD_JAVA "Specify whether to build java bindings" OFF)
|
||||
|
||||
if (WIN32)
|
||||
option(OCIO_USE_WINDOWS_UNICODE "Compile with Windows Unicode support" ON)
|
||||
endif()
|
||||
|
||||
###############################################################################
|
||||
# Other preferences
|
||||
|
||||
option(OCIO_VERBOSE "Display more information when searching or installing dependencies" OFF)
|
||||
option(OCIO_USE_SOVERSION "Enable versioning in OCIO shared library name" ON)
|
||||
|
||||
###############################################################################
|
||||
# Warnings / debugging settings
|
||||
|
||||
option(OCIO_WARNING_AS_ERROR "Set build error level for CI testing" OFF)
|
||||
|
||||
if (NOT WIN32)
|
||||
option(OCIO_ENABLE_SANITIZER "Specify whether to enable compiler sanitizers (address)" OFF)
|
||||
endif()
|
||||
option(OCIO_USE_WINDOWS_UNICODE "On Windows only, compile with Unicode support" WIN32)
|
||||
|
||||
|
||||
###############################################################################
|
||||
# Optimization / internal linking preferences
|
||||
option(OCIO_USE_SIMD "Specify whether to enable SIMD CPU performance optimizations" ON)
|
||||
option(OCIO_USE_OIIO_FOR_APPS "Request OIIO to build apps (ociolutimage, ocioconvert and ociodisplay), the default uses OpenEXR." OFF)
|
||||
|
||||
|
||||
if (NOT APPLE)
|
||||
if ("${CMAKE_SYSTEM_PROCESSOR}" MATCHES "(AMD64|IA64|EM64T|x86_64|X86|i386|i686)")
|
||||
# Intel-based architecture (not APPLE)
|
||||
if ("${CMAKE_SYSTEM_PROCESSOR}" MATCHES "(X86|i386|i686)")
|
||||
set(OCIO_ARCH_X86_32 1)
|
||||
endif()
|
||||
set(OCIO_ARCH_X86 1)
|
||||
set(OCIO_BUILD_ENABLE_OPTIMIZATIONS_SSE ON)
|
||||
set(OCIO_BUILD_ENABLE_OPTIMIZATIONS_AVX ON)
|
||||
set(OCIO_BUILD_ENABLE_OPTIMIZATIONS_F16C ON)
|
||||
else()
|
||||
set(OCIO_ARCH_X86 0)
|
||||
set(OCIO_BUILD_ENABLE_OPTIMIZATIONS_SSE OFF)
|
||||
set(OCIO_BUILD_ENABLE_OPTIMIZATIONS_AVX OFF)
|
||||
set(OCIO_BUILD_ENABLE_OPTIMIZATIONS_F16C OFF)
|
||||
endif()
|
||||
elseif (APPLE)
|
||||
# Multiple possible scenarios:
|
||||
# A. Building on an Apple arm64 architecture for the native architecture (arm64).
|
||||
# B. Building on an Apple arm64 architecture for x86_64.
|
||||
# C. Building on an Apple arm64 architecture for universal binaries (x86_64 + arm64).
|
||||
#
|
||||
# D. Building on an Apple Intel architecture for the native architecture (x86_64).
|
||||
# E. Building on an Apple Intel architecture for arm64.
|
||||
# F. Building on an Apple Intel architecture for universal binaries (x86_64 + arm64).
|
||||
|
||||
# Check if we are NOT cross-compiling to another Apple architecture.
|
||||
if (NOT DEFINED CMAKE_OSX_ARCHITECTURES OR CMAKE_OSX_ARCHITECTURES STREQUAL "")
|
||||
# Building for the native architectures.
|
||||
if ("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "x86_64")
|
||||
# Apple Intel-based computer or Rosetta. (covers case D)
|
||||
|
||||
set(OCIO_ARCH_X86 1)
|
||||
set(OCIO_BUILD_ENABLE_OPTIMIZATIONS_SSE ON)
|
||||
# The AVX and F16C will be compiled, but it won't used at runtime by Rosetta.
|
||||
set(OCIO_BUILD_ENABLE_OPTIMIZATIONS_AVX ON)
|
||||
set(OCIO_BUILD_ENABLE_OPTIMIZATIONS_F16C ON)
|
||||
elseif ("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "arm64")
|
||||
# Apple arm64. (covers case A)
|
||||
|
||||
set(OCIO_ARCH_X86 0)
|
||||
# OCIO translates the SSE instructions into ARM Neon with the library SSE2NEON.
|
||||
set(OCIO_BUILD_ENABLE_OPTIMIZATIONS_SSE ON)
|
||||
# OCIO does not translate AVX to ARM Neon.
|
||||
set(OCIO_BUILD_ENABLE_OPTIMIZATIONS_AVX OFF)
|
||||
# Turn F16C off since they are x86_64 instructions.
|
||||
set(OCIO_BUILD_ENABLE_OPTIMIZATIONS_F16C OFF)
|
||||
endif()
|
||||
else()
|
||||
# Cross-compiling to another Apple architecture (x86_64, arm64, or both (universal))
|
||||
if ("${CMAKE_OSX_ARCHITECTURES}" STREQUAL "x86_64")
|
||||
# Compiling for x86_64 regardless of native architecture.
|
||||
# Covers case B assuming CMAKE_SYSTEM_PROCESSOR is arm64.
|
||||
# Covers case D if CMAKE_OSX_ARCHITECTURES is set to x86_64 on x86_64 architecture.
|
||||
|
||||
set(OCIO_ARCH_X86 1)
|
||||
set(OCIO_BUILD_ENABLE_OPTIMIZATIONS_SSE ON)
|
||||
# The AVX and F16C will be compiled, but they won't used at runtime by Rosetta.
|
||||
set(OCIO_BUILD_ENABLE_OPTIMIZATIONS_AVX ON)
|
||||
set(OCIO_BUILD_ENABLE_OPTIMIZATIONS_F16C ON)
|
||||
elseif ("${CMAKE_OSX_ARCHITECTURES}" STREQUAL "arm64")
|
||||
# Compiling for arm64 regardless of native architecture.
|
||||
# Covers case E assuming CMAKE_SYSTEM_PROCESSOR is x86_64.
|
||||
# Covers case A if CMAKE_OSX_ARCHITECTURES is set arm64 on arm64 architecture.
|
||||
|
||||
set(OCIO_ARCH_X86 0)
|
||||
set(OCIO_BUILD_ENABLE_OPTIMIZATIONS_SSE ON)
|
||||
set(OCIO_BUILD_ENABLE_OPTIMIZATIONS_AVX OFF)
|
||||
set(OCIO_BUILD_ENABLE_OPTIMIZATIONS_F16C OFF)
|
||||
elseif ("${CMAKE_OSX_ARCHITECTURES}" MATCHES "(arm64;x86_64|x86_64;arm64)")
|
||||
# Universal build (covers case C and F).
|
||||
|
||||
set(OCIO_ARCH_X86 1)
|
||||
set(OCIO_BUILD_ENABLE_OPTIMIZATIONS_SSE ON)
|
||||
# The AVX and F16C will be compiled, but they won't used at runtime by Rosetta.
|
||||
set(OCIO_BUILD_ENABLE_OPTIMIZATIONS_AVX ON)
|
||||
set(OCIO_BUILD_ENABLE_OPTIMIZATIONS_F16C ON)
|
||||
endif()
|
||||
endif()
|
||||
endif()
|
||||
|
||||
option(OCIO_USE_SSE2 "Specify whether to enable SSE2 CPU performance optimizations" ${OCIO_BUILD_ENABLE_OPTIMIZATIONS_SSE})
|
||||
option(OCIO_USE_SSE3 "Specify whether to enable SSE3 CPU performance optimizations" ${OCIO_BUILD_ENABLE_OPTIMIZATIONS_SSE})
|
||||
option(OCIO_USE_SSSE3 "Specify whether to enable SSSE3 CPU performance optimizations" ${OCIO_BUILD_ENABLE_OPTIMIZATIONS_SSE})
|
||||
option(OCIO_USE_SSE4 "Specify whether to enable SSE4 CPU performance optimizations" ${OCIO_BUILD_ENABLE_OPTIMIZATIONS_SSE})
|
||||
option(OCIO_USE_SSE42 "Specify whether to enable SSE4.2 CPU performance optimizations" ${OCIO_BUILD_ENABLE_OPTIMIZATIONS_SSE})
|
||||
option(OCIO_USE_AVX "Specify whether to enable AVX CPU performance optimizations" ${OCIO_BUILD_ENABLE_OPTIMIZATIONS_AVX})
|
||||
option(OCIO_USE_AVX2 "Specify whether to enable AVX2 CPU performance optimizations" ${OCIO_BUILD_ENABLE_OPTIMIZATIONS_AVX})
|
||||
option(OCIO_USE_AVX512 "Specify whether to enable AVX512 CPU performance optimizations" ${OCIO_BUILD_ENABLE_OPTIMIZATIONS_AVX})
|
||||
option(OCIO_USE_F16C "Specify whether to enable F16C CPU performance optimizations" ${OCIO_BUILD_ENABLE_OPTIMIZATIONS_F16C})
|
||||
|
||||
if (APPLE)
|
||||
# TODO: Revisit whether that option is necessary.
|
||||
option(OCIO_USE_SSE2NEON "Specify whether to enable SSE CPU performance optimizations using SSE2NEON for Apple ARM architecture" ON)
|
||||
mark_as_advanced(OCIO_USE_SSE2NEON)
|
||||
endif()
|
||||
option(OCIO_USE_SSE "Specify whether to enable SSE CPU performance optimizations" ON)
|
||||
option(OCIO_USE_OPENEXR_HALF "Specify whether to use an OpenEXR/IlmBase install of the Half library (<=v2.5) instead of the newer Imath library (>=v3.0)" OFF)
|
||||
option(OCIO_USE_OIIO_CMAKE_CONFIG "Specify whether to look for OIIO using the generated CMake Config script instead of the custom FindOpenImageIO.cmake script" OFF)
|
||||
|
||||
|
||||
###############################################################################
|
||||
# GPU configuration
|
||||
message(STATUS "")
|
||||
message(STATUS "Checking for GPU configuration...")
|
||||
|
||||
include(CheckSupportGL)
|
||||
|
||||
|
||||
###############################################################################
|
||||
# Check for ARM neon here because we need to know if ARM NEON is supported
|
||||
# quickly. Once we know that ARM NEON is supported, we can add sse2neon library
|
||||
# to the build.
|
||||
|
||||
if(OCIO_USE_SIMD)
|
||||
include(CheckSupportARMNeon)
|
||||
|
||||
if (NOT COMPILER_SUPPORTS_ARM_NEON)
|
||||
# Force it to OFF since ARM Neon is not supported.
|
||||
set(OCIO_USE_SSE2NEON OFF)
|
||||
endif()
|
||||
endif()
|
||||
|
||||
|
||||
###############################################################################
|
||||
# Add sse2neon to the build if ARM NEON intrinsics are supported.
|
||||
|
||||
if(OCIO_USE_SIMD AND OCIO_USE_SSE2NEON AND COMPILER_SUPPORTS_ARM_NEON)
|
||||
# Install sse2neon. Please note that sse2neon is downloaded during the configure step as it is
|
||||
# needed for CompilerFlags.cmake and CheckSupportSSEUsingSSE2NEON.cmake.
|
||||
|
||||
# Sse2neon is not treated like an imported target. The logic to find sse2neon is here because
|
||||
# a find module is not suitable for sse2neon's use case.
|
||||
find_path(sse2neon_INCLUDE_DIR
|
||||
NAMES
|
||||
sse2neon.h
|
||||
HINTS
|
||||
${sse2neon_ROOT}
|
||||
PATH_SUFFIXES
|
||||
sse2neon
|
||||
include
|
||||
sse2neon/include
|
||||
)
|
||||
|
||||
# As per instructions on sse2neon's GitHub page, the following compiler flags should be used:
|
||||
# "-march=armv8-a+fp+simd+crypto+crc". These flags are required for some ARM platforms that do
|
||||
# not enable floating point calculations or SIMD instructions by default. However, for ARM64
|
||||
# (Apple ARM platform) and x86_64 platforms, these features are already enabled by default.
|
||||
# Therefore, no additional compiler flags are needed.
|
||||
if (NOT sse2neon_INCLUDE_DIR)
|
||||
include(Installsse2neon)
|
||||
else()
|
||||
# Any changes to the following lines must be replicated in Installsse2neon.cmake as well.
|
||||
# Create a target for sse2neon (non-imported)
|
||||
add_library(sse2neon INTERFACE)
|
||||
# Add the include directories to the target.
|
||||
target_include_directories(sse2neon INTERFACE "${sse2neon_INCLUDE_DIR}")
|
||||
# Ignore the warnings coming from sse2neon.h as they are false positives.
|
||||
target_compile_options(sse2neon INTERFACE -Wno-unused-parameter)
|
||||
endif()
|
||||
endif()
|
||||
|
||||
|
||||
###############################################################################
|
||||
# Define compilation and link flags
|
||||
|
||||
include(CompilerFlags)
|
||||
|
||||
|
||||
###############################################################################
|
||||
# External linking options
|
||||
|
||||
@@ -386,12 +205,12 @@ endif()
|
||||
|
||||
if(NOT DEFINED OCIO_NAMESPACE)
|
||||
set(OCIO_NAMESPACE "OpenColorIO_v${OpenColorIO_VERSION_MAJOR}_${OpenColorIO_VERSION_MINOR}${OpenColorIO_VERSION_RELEASE_TYPE}" CACHE STRING
|
||||
"Specify the main OCIO C++ namespace: Options include OpenColorIO OpenColorIO_<YOURFACILITY> etc.")
|
||||
"Specify the master OCIO C++ namespace: Options include OpenColorIO OpenColorIO_<YOURFACILITY> etc.")
|
||||
elseif(OCIO_NAMESPACE STREQUAL "")
|
||||
message(FATAL_ERROR "A namespace cannot be empty.")
|
||||
else()
|
||||
set(OCIO_NAMESPACE "OpenColorIO_${OCIO_NAMESPACE}_v${OpenColorIO_VERSION_MAJOR}_${OpenColorIO_VERSION_MINOR}${OpenColorIO_VERSION_RELEASE_TYPE}" CACHE STRING
|
||||
"Specify the main OCIO C++ namespace: Options include OpenColorIO OpenColorIO_<YOURFACILITY> etc.")
|
||||
"Specify the master OCIO C++ namespace: Options include OpenColorIO OpenColorIO_<YOURFACILITY> etc.")
|
||||
message(STATUS "Setting namespace to '${OCIO_NAMESPACE}' as none was specified.")
|
||||
endif()
|
||||
|
||||
@@ -430,15 +249,6 @@ if(OCIO_BUILD_STATIC)
|
||||
endif()
|
||||
endif()
|
||||
|
||||
if (NOT BUILD_SHARED_LIBS AND NOT OCIO_INSTALL_EXT_PACKAGES STREQUAL NONE)
|
||||
message(STATUS "Note that building the static version of OpenColorIO does not embed the dependencies\
|
||||
into the library file. The needed dependencies must be linked to the consumer
|
||||
application or shared library that uses static OpenColorIO.
|
||||
|
||||
The following mandatory dependencies MUST be linked to the consumer application or shared library:
|
||||
expat, yaml-cpp, Imath, pystring, minizip-ng and ZLIB")
|
||||
endif()
|
||||
|
||||
|
||||
###############################################################################
|
||||
# Find or install external dependencies
|
||||
@@ -470,7 +280,7 @@ else()
|
||||
set(OCIO_SETUP_NAME setup_ocio.sh)
|
||||
endif()
|
||||
|
||||
configure_file(${PROJECT_SOURCE_DIR}/share/ocio/${OCIO_SETUP_NAME}.in
|
||||
configure_file(${CMAKE_SOURCE_DIR}/share/ocio/${OCIO_SETUP_NAME}.in
|
||||
${CMAKE_CURRENT_BINARY_DIR}/share/ocio/${OCIO_SETUP_NAME} @ONLY)
|
||||
|
||||
INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/share/ocio/${OCIO_SETUP_NAME} DESTINATION ${CMAKE_INSTALL_DATADIR}/ocio/)
|
||||
@@ -484,11 +294,9 @@ INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/share/ocio/${OCIO_SETUP_NAME} DESTINAT
|
||||
include(CMakePackageConfigHelpers)
|
||||
|
||||
set(OCIO_TARGETS_EXPORT_NAME "${PROJECT_NAME}Targets.cmake")
|
||||
set(OCIO_VERSION_CONFIG "${PROJECT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake")
|
||||
set(OCIO_PROJECT_CONFIG "${PROJECT_BINARY_DIR}/${PROJECT_NAME}Config.cmake")
|
||||
set(OCIO_VERSION_CONFIG "${CMAKE_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake")
|
||||
set(OCIO_PROJECT_CONFIG "${CMAKE_BINARY_DIR}/${PROJECT_NAME}Config.cmake")
|
||||
set(OCIO_CONFIG_INSTALL_DIR "${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}")
|
||||
set(OCIO_CUSTOM_FIND_MODULE_DIR "${CMAKE_INSTALL_PREFIX}/share/OpenColorIO/cmake/modules")
|
||||
set(OCIO_CUSTOM_MACROS_MODULE_DIR "${CMAKE_INSTALL_PREFIX}/share/OpenColorIO/cmake/macros")
|
||||
|
||||
# Version fetched from the top level project()
|
||||
write_basic_package_version_file(
|
||||
@@ -511,25 +319,8 @@ install(
|
||||
FILE ${OCIO_TARGETS_EXPORT_NAME}
|
||||
)
|
||||
|
||||
if (NOT BUILD_SHARED_LIBS)
|
||||
# Install custom macros used in the find modules.
|
||||
install(FILES
|
||||
${CMAKE_CURRENT_LIST_DIR}/share/cmake/macros/VersionUtils.cmake
|
||||
DESTINATION ${OCIO_CUSTOM_MACROS_MODULE_DIR}
|
||||
)
|
||||
|
||||
# Install custom Find modules.
|
||||
install(FILES
|
||||
${CMAKE_CURRENT_LIST_DIR}/share/cmake/modules/Findexpat.cmake
|
||||
${CMAKE_CURRENT_LIST_DIR}/share/cmake/modules/FindImath.cmake
|
||||
${CMAKE_CURRENT_LIST_DIR}/share/cmake/modules/Findpystring.cmake
|
||||
${CMAKE_CURRENT_LIST_DIR}/share/cmake/modules/Findminizip-ng.cmake
|
||||
${CMAKE_CURRENT_LIST_DIR}/share/cmake/modules/Findyaml-cpp.cmake
|
||||
DESTINATION ${OCIO_CUSTOM_FIND_MODULE_DIR}
|
||||
)
|
||||
endif()
|
||||
|
||||
install(
|
||||
FILES "${OCIO_PROJECT_CONFIG}" "${OCIO_VERSION_CONFIG}"
|
||||
DESTINATION "${OCIO_CONFIG_INSTALL_DIR}"
|
||||
)
|
||||
|
||||
|
||||
@@ -19,5 +19,3 @@ The current OpenColorIO Committers are:
|
||||
| Cottalango Leon | @loorthu
|
||||
| Doug Walker | @doug-walker |
|
||||
| Kevin Wheatley | @KevinJW |
|
||||
| Rémi Achard | @remia |
|
||||
| Cédrik Fuoco | @cedrik-fuoco-adsk |
|
||||
|
||||
+38
-21
@@ -19,7 +19,7 @@ explains our contribution process and procedures, so please review it first:
|
||||
For a description of the roles and responsibilities of the various
|
||||
members of the OpenColorIO community, see [GOVERNANCE](GOVERNANCE.md), and
|
||||
for further details, see the project's
|
||||
[Technical Charter](ASWF/Charter.md). Briefly, Contributors are anyone
|
||||
[Technical Charter](docs/aswf/Charter.md). Briefly, Contributors are anyone
|
||||
who submits content to the project, Committers review and approve such
|
||||
submissions, and the Technical Steering Committee provides general project
|
||||
oversight.
|
||||
@@ -91,7 +91,7 @@ can be merged.
|
||||
[Corporate Contributor Licence Agreement](https://docs.linuxfoundation.org/lfx/easycla/contributors/corporate-contributor).
|
||||
|
||||
The OCIO CLA's are the standard forms used by Linux Foundation projects and
|
||||
[recommended by the ASWF TAC](https://github.com/AcademySoftwareFoundation/tac/blob/main/process/contributing.md#contributor-license-agreement-cla).
|
||||
[recommended by the ASWF TAC](https://github.com/AcademySoftwareFoundation/tac/blob/master/process/contributing.md#contributor-license-agreement-cla).
|
||||
|
||||
### Commit Sign-Off
|
||||
|
||||
@@ -113,7 +113,7 @@ can be merged. Otherwise the EasyCLA system will provide instructions on
|
||||
signing a CLA, or request inclusion in an existing corporate CLA approved list.
|
||||
|
||||
See the
|
||||
[ASWF TAC CONTRIBUTING.md](https://github.com/AcademySoftwareFoundation/tac/blob/main/process/contributing.md#contribution-sign-off)
|
||||
[ASWF TAC CONTRIBUTING.md](https://github.com/AcademySoftwareFoundation/tac/blob/master/process/contributing.md#contribution-sign-off)
|
||||
file for more information on this requirement.
|
||||
|
||||
### Copyright Notices
|
||||
@@ -161,15 +161,15 @@ You are now ready to contribute.
|
||||
The OpenColorIO repository has a relatively straight-forward structure, and a
|
||||
simple branching and merging strategy.
|
||||
|
||||
All development work is done directly on the main branch. This represents the
|
||||
All development work is done directly on the master branch. This represents the
|
||||
bleeding-edge of the project and any contributions should be done on top of it.
|
||||
|
||||
After sufficient work is done on the main branch and OCIO leadership
|
||||
After sufficient work is done on the master branch and OCIO leadership
|
||||
determines that a release is due, we will bump the relevant internal versioning
|
||||
and tag a commit with the corresponding version number, e.g. v2.0.1. Each Minor
|
||||
version also has its own “Release Branch”, e.g. RB-1.1. This marks a branch of
|
||||
code dedicated to that Major.Minor version, which allows upstream bug fixes to
|
||||
be cherry-picked to a given version while still allowing the main branch to
|
||||
be cherry-picked to a given version while still allowing the master branch to
|
||||
continue forward onto higher versions. This basic repository structure keeps
|
||||
maintenance low, while remaining simple to understand.
|
||||
|
||||
@@ -183,7 +183,7 @@ Please review [PROCESS.md](PROCESS.md) for important procedures related to
|
||||
making changes to OpenColorIO. Small bug fixes and documentation changes can be
|
||||
more informal, but modifications to core OpenColorIO functionality MUST follow
|
||||
the
|
||||
[Core Library Changes](https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/main/PROCESS.md#Core-Library-Changes) process.
|
||||
[Core Library Changes](https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/master/PROCESS.md#Core-Library-Changes) process.
|
||||
|
||||
The development cycle for a code change should follow this protocol:
|
||||
|
||||
@@ -210,24 +210,22 @@ who may discuss, offer constructive feedback, request changes, or approve
|
||||
the work.
|
||||
|
||||
7. Upon receiving the required number of Committer approvals (as outlined in
|
||||
[Required Approvals](https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/main/PROCESS.md#Required-Approvals)),
|
||||
[Required Approvals](https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/master/PROCESS.md#Required-Approvals)),
|
||||
a Committer other than the PR contributor may squash and merge changes into the
|
||||
main branch.
|
||||
master branch.
|
||||
|
||||
For a more detailed description of the contribution process, please see the
|
||||
Contributing Guide in the main OCIO documentation:
|
||||
|
||||
* [Getting Started](https://opencolorio.readthedocs.io/en/latest/guides/contributing/contributing.html#getting-started)
|
||||
* [Submitting Changes](https://opencolorio.readthedocs.io/en/latest/guides/contributing/contributing.html#submitting-changes)
|
||||
See also (from the OCIO Developer Guide):
|
||||
* [Getting started](http://opencolorio.org/developers/getting_started.html)
|
||||
* [Submitting Changes](http://opencolorio.org/developers/submitting_changes.html)
|
||||
|
||||
## Coding Standards
|
||||
|
||||
Please see the OpenColorIO
|
||||
[Coding guidelines](https://opencolorio.readthedocs.io/en/latest/guides/contributing/contributing.html#coding-style-guide)
|
||||
[Coding guidelines](http://opencolorio.org/developers/coding_guidelines.html)
|
||||
for a reference on project code style and best practices.
|
||||
|
||||
For standards on contributing to documentation, see the
|
||||
[Documentation guidelines](https://opencolorio.readthedocs.io/en/latest/guides/contributing/contributing.html#documentation-guidelines).
|
||||
[Documentation guidelines](http://opencolorio.org/developers/documentation_guidelines.html).
|
||||
|
||||
## Test Policy
|
||||
|
||||
@@ -243,12 +241,31 @@ expected to validate the behavior of every part of OCIO:
|
||||
* Any change to existing functionality should have tests added if they
|
||||
don't already exist.
|
||||
|
||||
The test should be run, via ``ctest``, before submitting a pull request.
|
||||
The test should should be run, via ``ctest``, before submitting a pull request.
|
||||
|
||||
## Versioning Policy
|
||||
|
||||
OpenColorIO labels each version with three numbers: Major.Minor.Patch, where:
|
||||
OpenColorIO uses [semantic versioning](https://semver.org), which labels each
|
||||
version with three numbers: Major.Minor.Patch, where:
|
||||
|
||||
* **MAJOR** indicates major architectural changes
|
||||
* **MINOR** indicates an introduction of significant new features
|
||||
* **PATCH** indicates ABI-compatible bug fixes and minor enhancements
|
||||
* **MAJOR** indicates incompatible API changes
|
||||
* **MINOR** indicates functionality added in a backwards-compatible manner
|
||||
* **PATCH** indicates backwards-compatible bug fixes
|
||||
|
||||
## Creating a Release
|
||||
|
||||
To create a new release from the master branch:
|
||||
|
||||
1. Update the release notes in ``CHANGELOG.md`` with a high-level summary of
|
||||
the features and improvements. Also include the summary in the Release
|
||||
comments.
|
||||
|
||||
2. Create a new release on the GitHub Releases page.
|
||||
|
||||
3. Tag the release with name beginning with '``v``', e.g. '``v2.1.0``'.
|
||||
|
||||
4. Download and sign the release tarball, as described
|
||||
[here](https://wiki.debian.org/Creating%20signed%20GitHub%20releases),
|
||||
|
||||
5. Attach the detached ``.asc`` signature file to the GitHub release as a
|
||||
binary file.
|
||||
|
||||
+1
-4
@@ -107,20 +107,17 @@ project at all ASWF TAC meetings.
|
||||
|
||||
### TSC Leaders
|
||||
|
||||
* Chair: Carol Payne
|
||||
* Chair: Michael Dolan
|
||||
* Chief Architect: Doug Walker
|
||||
* ACES TAC Rep: Sean Cooper
|
||||
|
||||
### TSC Members
|
||||
|
||||
* Rémi Achard - DNEG
|
||||
* Mark Boorer - Industrial Light & Magic
|
||||
* Mei Chu - Sony Pictures Imageworks
|
||||
* Sean Cooper - ARRI
|
||||
* Michael Dolan - Epic Games
|
||||
* Patrick Hodoul - Autodesk
|
||||
* Zach Lewis - Method Studios
|
||||
* Thomas Mansencal - WetaFX
|
||||
* Carol Payne - Netflix
|
||||
* Carl Rand - Weta Digital
|
||||
* Mark Titchener - Foundry
|
||||
|
||||
+2
-11
@@ -1,11 +1,2 @@
|
||||
include LICENSE
|
||||
graft docs
|
||||
graft ext
|
||||
graft include
|
||||
graft share
|
||||
graft src
|
||||
graft tests
|
||||
global-include CMakeLists.txt *.cmake *.md
|
||||
global-exclude */__pycache__/*
|
||||
global-exclude *.pyc
|
||||
global-exclude .DS_Store
|
||||
graft tests/data
|
||||
exclude tests/data/CMakeLists.txt
|
||||
|
||||
+1
-1
@@ -28,7 +28,7 @@ across the project so are treated as core changes.
|
||||
[ocio-dev](https://lists.aswf.io/g/ocio-dev), but are ultimately brought to a
|
||||
TSC meeting where consensus can be reached around the proposal's relevance
|
||||
and approach. TSC meetings are public and meeting notes are posted to the
|
||||
[OCIO repo](https://github.com/AcademySoftwareFoundation/OpenColorIO/tree/main/ASWF/meetings/tsc)
|
||||
[OCIO repo](https://github.com/AcademySoftwareFoundation/OpenColorIO/tree/master/ASWF/meetings/tsc)
|
||||
within days of a meeting for a permanent record of decisions.
|
||||
2. Following acceptance of the proposal by the TSC, an issue is created in
|
||||
GitHub to present a design proposal. A period of further community
|
||||
|
||||
@@ -38,7 +38,7 @@ Houdini, Silhouette FX, and
|
||||
[others](https://opencolorio.org/#supported_apps).
|
||||
|
||||
OpenColorIO is free and open source software ([LICENSE](LICENSE)), and
|
||||
one of several projects actively sponsored by the ASWF
|
||||
one of several projects actvively sponsored by the ASWF
|
||||
([Academy Software Foundation](https://www.aswf.io/)).
|
||||
|
||||
OpenColorIO Project Mission
|
||||
@@ -50,12 +50,12 @@ content creation applications and pipelines.
|
||||
|
||||
OpenColorIO aims to:
|
||||
|
||||
* be stable, secure, and thoroughly tested on Linux, macOS, and Windows
|
||||
* be stable, secure, and thouroughly tested on Linux, macOS, and Windows
|
||||
* be performant on modern CPUs and GPUs
|
||||
* be simple, scalable, and well documented
|
||||
* be compatible with critical color and imaging standards
|
||||
* provide lossless color processing wherever possible
|
||||
* maintain config backwards compatibility across major versions
|
||||
* maintain config backwards compatability across major versions
|
||||
* have every new feature carefully reviewed by leaders from the motion picture,
|
||||
VFX, animation, and video game industries
|
||||
* have a healthy and active community
|
||||
@@ -65,14 +65,13 @@ OpenColorIO Project Governance
|
||||
------------------------------
|
||||
|
||||
OpenColorIO is governed by the Academy Software Foundation (ASWF). See
|
||||
[GOVERNANCE.md](GOVERNANCE.md) for detailed information about how the project
|
||||
[GOVERNANCE.md](GOVERNANCE.md) for detailed infomation about how the project
|
||||
operates.
|
||||
|
||||
Web Resources
|
||||
-------------
|
||||
|
||||
* Website: <http://opencolorio.org>
|
||||
* Documentation: <https://opencolorio.readthedocs.io/en/latest/>
|
||||
* Mailing lists:
|
||||
* Developer: <ocio-dev@lists.aswf.io>
|
||||
* User: <ocio-user@lists.aswf.io>
|
||||
@@ -100,11 +99,6 @@ The following reference implementations are provided:
|
||||
* Other
|
||||
* nuke-default
|
||||
|
||||
Sources for the newer builtin ACES configuration files can be found in the releases section of the
|
||||
[OpenColorIO-Config-ACES](https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES)
|
||||
repository.
|
||||
|
||||
|
||||
Acknowledgements
|
||||
----------------
|
||||
|
||||
|
||||
+26
-29
@@ -9,6 +9,32 @@ In no particular order:
|
||||
|
||||
---------------------------------------------------------------------
|
||||
|
||||
MD5, courtesy of L. Peter Deutsch, Aladdin Enterprises.
|
||||
http://sourceforge.net/projects/libmd5-rfc/files/
|
||||
|
||||
Copyright (C) 1999, 2002 Aladdin Enterprises. All rights reserved.
|
||||
|
||||
This software is provided 'as-is', without any express or implied
|
||||
warranty. In no event will the authors be held liable for any damages
|
||||
arising from the use of this software.
|
||||
|
||||
Permission is granted to anyone to use this software for any purpose,
|
||||
including commercial applications, and to alter it and redistribute it
|
||||
freely, subject to the following restrictions:
|
||||
|
||||
1. The origin of this software must not be misrepresented; you must not
|
||||
claim that you wrote the original software. If you use this software
|
||||
in a product, an acknowledgment in the product documentation would be
|
||||
appreciated but is not required.
|
||||
2. Altered source versions must be plainly marked as such, and must not be
|
||||
misrepresented as being the original software.
|
||||
3. This notice may not be removed or altered from any source distribution.
|
||||
|
||||
L. Peter Deutsch
|
||||
ghost@aladdin.com
|
||||
|
||||
---------------------------------------------------------------------
|
||||
|
||||
argparse, courtesy of OpenImageIO and Larry Gritz
|
||||
http://openimageio.org
|
||||
|
||||
@@ -203,33 +229,4 @@ England
|
||||
|
||||
---------------------------------------------------------------------
|
||||
|
||||
xxHash Library
|
||||
Copyright (c) 2012-2021 Yann Collet
|
||||
All rights reserved.
|
||||
|
||||
BSD 2-Clause License (https://www.opensource.org/licenses/bsd-license.php)
|
||||
|
||||
Redistribution and use in source and binary forms, with or without modification,
|
||||
are permitted provided that the following conditions are met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright notice, this
|
||||
list of conditions and the following disclaimer.
|
||||
|
||||
* Redistributions in binary form must reproduce the above copyright notice, this
|
||||
list of conditions and the following disclaimer in the documentation and/or
|
||||
other materials provided with the distribution.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||||
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
|
||||
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||||
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
|
||||
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
---------------------------------------------------------------------
|
||||
|
||||
If we have left anything out, it is unintentional. Please let us know.
|
||||
|
||||
@@ -41,6 +41,7 @@ phases:
|
||||
cmake ../. \
|
||||
-DCMAKE_INSTALL_PREFIX=../_install \
|
||||
-DOCIO_USE_HEADLESS=ON \
|
||||
-DOCIO_USE_OPENEXR_HALF=ON \
|
||||
-DOCIO_BUILD_APPS=ON \
|
||||
-DOCIO_BUILD_DOCS=OFF \
|
||||
-DOCIO_BUILD_TESTS=ON \
|
||||
|
||||
+20
-20
@@ -61,11 +61,11 @@ if(${Python_VERSION_MAJOR} GREATER_EQUAL 3)
|
||||
# configuration, but omits *.in to work in RTD builds.
|
||||
message(STATUS "Substitute documentation variables")
|
||||
file(GLOB_RECURSE DOC_IN_FILES
|
||||
"${PROJECT_SOURCE_DIR}/docs/**.in"
|
||||
"${PROJECT_SOURCE_DIR}/docs/conf.py"
|
||||
"${CMAKE_SOURCE_DIR}/docs/**.in"
|
||||
"${CMAKE_SOURCE_DIR}/docs/conf.py"
|
||||
)
|
||||
foreach(in_file ${DOC_IN_FILES})
|
||||
string(REPLACE "${PROJECT_SOURCE_DIR}/" "${PROJECT_BINARY_DIR}/"
|
||||
string(REPLACE "${CMAKE_SOURCE_DIR}/" "${CMAKE_BINARY_DIR}/"
|
||||
out_file ${in_file})
|
||||
string(REPLACE ".in" ""
|
||||
out_file ${out_file})
|
||||
@@ -73,15 +73,15 @@ if(${Python_VERSION_MAJOR} GREATER_EQUAL 3)
|
||||
endforeach()
|
||||
|
||||
# Copy documentation source to build location
|
||||
file(GLOB_RECURSE DOC_SOURCES "${PROJECT_SOURCE_DIR}/docs/*")
|
||||
file(GLOB_RECURSE DOC_SOURCES "${CMAKE_SOURCE_DIR}/docs/*")
|
||||
list(APPEND DOC_SOURCES
|
||||
${PROJECT_SOURCE_DIR}/README.md
|
||||
${PROJECT_SOURCE_DIR}/INSTALL.md
|
||||
${PROJECT_SOURCE_DIR}/CHANGELOG.md
|
||||
${PROJECT_SOURCE_DIR}/LICENSE
|
||||
${CMAKE_SOURCE_DIR}/README.md
|
||||
${CMAKE_SOURCE_DIR}/INSTALL.md
|
||||
${CMAKE_SOURCE_DIR}/CHANGELOG.md
|
||||
${CMAKE_SOURCE_DIR}/LICENSE
|
||||
)
|
||||
if(OCIO_BUILD_NUKE)
|
||||
list(APPEND DOC_SOURCES ${PROJECT_SOURCE_DIR}/share/nuke/ocionuke/viewer.py)
|
||||
list(APPEND DOC_SOURCES ${CMAKE_SOURCE_DIR}/share/nuke/ocionuke/viewer.py)
|
||||
endif()
|
||||
|
||||
# Don't copy configured files. In particular this prevents overwriting conf.py,
|
||||
@@ -93,15 +93,15 @@ if(${Python_VERSION_MAJOR} GREATER_EQUAL 3)
|
||||
)
|
||||
|
||||
foreach(f ${DOC_SOURCES})
|
||||
string(REGEX REPLACE "^${PROJECT_SOURCE_DIR}/" "" relpath ${f})
|
||||
string(REGEX REPLACE "^${CMAKE_SOURCE_DIR}/" "" relpath ${f})
|
||||
string(REGEX REPLACE "[/. ]" "_" tgtname ${relpath})
|
||||
string(REGEX MATCH "^docs" IN_DOCS ${relpath})
|
||||
|
||||
set(SRC_PATH ${PROJECT_SOURCE_DIR}/${relpath})
|
||||
set(DST_PATH ${PROJECT_BINARY_DIR}/${relpath})
|
||||
set(SRC_PATH ${CMAKE_SOURCE_DIR}/${relpath})
|
||||
set(DST_PATH ${CMAKE_BINARY_DIR}/${relpath})
|
||||
if(NOT IN_DOCS)
|
||||
get_filename_component(F_NAME ${relpath} NAME)
|
||||
set(DST_PATH "${PROJECT_BINARY_DIR}/docs/${F_NAME}")
|
||||
set(DST_PATH "${CMAKE_BINARY_DIR}/docs/${F_NAME}")
|
||||
endif()
|
||||
|
||||
add_custom_command(OUTPUT ${DST_PATH}
|
||||
@@ -118,16 +118,16 @@ if(${Python_VERSION_MAJOR} GREATER_EQUAL 3)
|
||||
get_target_property(DOXYGEN_EXECUTABLE Doxygen::doxygen IMPORTED_LOCATION)
|
||||
|
||||
file(GLOB_RECURSE DOXYGEN_SOURCES
|
||||
"${PROJECT_SOURCE_DIR}/include/*.h"
|
||||
"${PROJECT_BINARY_DIR}/include/*.h"
|
||||
"${CMAKE_SOURCE_DIR}/include/*.h"
|
||||
"${CMAKE_BINARY_DIR}/include/*.h"
|
||||
)
|
||||
set(DOXYGEN_INDEX_XML "${PROJECT_BINARY_DIR}/docs/_doxygen/xml/index.xml")
|
||||
set(DOXYGEN_INDEX_XML "${CMAKE_BINARY_DIR}/docs/_doxygen/xml/index.xml")
|
||||
|
||||
# Run doxygen if index.xml is behind OCIO headers or doxygen config
|
||||
add_custom_command(OUTPUT ${DOXYGEN_INDEX_XML}
|
||||
COMMAND "${DOXYGEN_EXECUTABLE}" "${PROJECT_BINARY_DIR}/docs/Doxyfile"
|
||||
COMMAND "${DOXYGEN_EXECUTABLE}" "${CMAKE_BINARY_DIR}/docs/Doxyfile"
|
||||
DEPENDS
|
||||
${PROJECT_BINARY_DIR}/docs/Doxyfile
|
||||
${CMAKE_BINARY_DIR}/docs/Doxyfile
|
||||
${DOXYGEN_SOURCES}
|
||||
COMMENT "Extracting XML files from C++ headers"
|
||||
)
|
||||
@@ -140,7 +140,7 @@ if(${Python_VERSION_MAJOR} GREATER_EQUAL 3)
|
||||
### HTML doc target ###
|
||||
|
||||
file(GLOB_RECURSE SPHINX_EXTENSIONS
|
||||
"${PROJECT_SOURCE_DIR}/share/docs/*.py"
|
||||
"${CMAKE_SOURCE_DIR}/share/docs/*.py"
|
||||
)
|
||||
|
||||
# Run Sphinx
|
||||
@@ -148,7 +148,7 @@ if(${Python_VERSION_MAJOR} GREATER_EQUAL 3)
|
||||
COMMAND
|
||||
${Python_PRE_CMD} "${Sphinx_EXECUTABLE}" -b html . "${CMAKE_CURRENT_BINARY_DIR}/build-html"
|
||||
DEPENDS
|
||||
${PROJECT_BINARY_DIR}/docs/conf.py
|
||||
${CMAKE_BINARY_DIR}/docs/conf.py
|
||||
${SPHINX_EXTENSIONS}
|
||||
${DOXYGEN_INDEX_XML}
|
||||
COMMENT "Building html docs"
|
||||
|
||||
+3
-3
@@ -792,7 +792,7 @@ WARN_LOGFILE =
|
||||
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
|
||||
# Note: If this tag is empty the current directory is searched.
|
||||
|
||||
INPUT = "@PROJECT_SOURCE_DIR@/include/@CMAKE_PROJECT_NAME@"
|
||||
INPUT = "@CMAKE_SOURCE_DIR@/include/@CMAKE_PROJECT_NAME@"
|
||||
|
||||
# This tag can be used to specify the character encoding of the source files
|
||||
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
|
||||
@@ -1301,7 +1301,7 @@ CHM_FILE =
|
||||
HHC_LOCATION =
|
||||
|
||||
# The GENERATE_CHI flag controls if a separate .chi index file is generated
|
||||
# (YES) or that it should be included in the main .chm file (NO).
|
||||
# (YES) or that it should be included in the master .chm file (NO).
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
|
||||
|
||||
@@ -2040,7 +2040,7 @@ SEARCH_INCLUDES = YES
|
||||
# preprocessor.
|
||||
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
|
||||
|
||||
INCLUDE_PATH = "@PROJECT_BINARY_DIR@/include/@CMAKE_PROJECT_NAME@"
|
||||
INCLUDE_PATH = "@CMAKE_BINARY_DIR@/include/@CMAKE_PROJECT_NAME@"
|
||||
|
||||
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
|
||||
# patterns (like *.h and *.hpp) to filter out the header-files in the
|
||||
|
||||
@@ -0,0 +1,106 @@
|
||||
# OCIO v2 Documentation Effort
|
||||
|
||||
Since the API autodoc effort is happening simultaneously it will be easier for
|
||||
a lot of contributors to do a light-weight build of the Sphinx docs, which
|
||||
doesn't require building OCIO in its entirety.
|
||||
|
||||
## How to Build HTML Docs
|
||||
|
||||
In addition to the general OCIO v2 dependencies, install Doxygen, Sphinx, and
|
||||
the Python packages listed in the `docs/requirements.txt` file.
|
||||
|
||||
Doxygen can be installed with a package manager, or by downloading a binary
|
||||
distribution from [Doxygen's website](https://www.doxygen.nl/download.html).
|
||||
Use one of the following commands to install Doxygen with a platform-specific
|
||||
package manager:
|
||||
|
||||
Linux (Debian, etc.):
|
||||
|
||||
```
|
||||
apt-get install doxygen
|
||||
```
|
||||
|
||||
Linux (Fedora, etc.):
|
||||
|
||||
```
|
||||
yum install doxygen
|
||||
```
|
||||
|
||||
macOS ([Homebrew](https://brew.sh/)):
|
||||
|
||||
```
|
||||
brew install doxygen
|
||||
```
|
||||
|
||||
Windows ([Chocolatey](https://chocolatey.org/)):
|
||||
|
||||
```
|
||||
choco install doxygen.install
|
||||
```
|
||||
|
||||
Sphinx and the other Python dependencies can be installed with a single `pip`
|
||||
command on all platforms:
|
||||
|
||||
```
|
||||
pip install -r docs/requirements.txt
|
||||
```
|
||||
|
||||
To build only the RST docs (excluding API) locally:
|
||||
|
||||
```
|
||||
cd docs
|
||||
mkdir _build
|
||||
sphinx-build -b html . _build
|
||||
<your web browser name> _build/index.html
|
||||
```
|
||||
|
||||
To build all HTML docs (including API) locally:
|
||||
|
||||
```
|
||||
mkdir _build
|
||||
cd _build
|
||||
cmake ../. -DOCIO_BUILD_DOCS=ON -DCMAKE_INSTALL_PREFIX=../_install
|
||||
make -j<your thread count> docs
|
||||
<your web browser name> docs/build-html/index.html
|
||||
```
|
||||
|
||||
Python 3 is required to build the documentation. If you have multiple Python
|
||||
installs you'll need to make sure pip and CMake find the correct version. You
|
||||
can manually inform cmake of which to use by adding this option to the above
|
||||
`cmake` command, which configures the documentation build:
|
||||
|
||||
```
|
||||
-DPython_ROOT=<Path to Python 3 root directory>
|
||||
```
|
||||
|
||||
To ease the documentation build and test on macOS one could also add these
|
||||
three lines in the ~/.zshrc file:
|
||||
|
||||
```
|
||||
alias python=/usr/local/bin/python3
|
||||
alias pip=/usr/local/bin/pip3
|
||||
alias <your web browser name>=open -a "<your web browser application name>"
|
||||
```
|
||||
|
||||
## Quirks
|
||||
|
||||
The vuepress theme that we've migrated to has some quirks to its design. For
|
||||
example it only allows two nested table of contents (TOC). So things have to be
|
||||
organized in a slightly different way than other sphinx projects.
|
||||
|
||||
The root-level `toc_redirect.rst` points to where to find the different section
|
||||
TOCs. The name and contents of each sections TOC is defined in that
|
||||
sub-directory's `_index.rst` file.
|
||||
|
||||
In this TOC the `:caption:` directive determines what the name of the section
|
||||
will be in the side-bar, and in the header of the website. The *H1* header
|
||||
determines the name of the page in the right/left arrows navigation bar. In a
|
||||
lot of cases this ends up doubling up the name on the page, but this seems
|
||||
unavoidable at the present time. If additional explanatory text is put in the
|
||||
`_index.rst` files then it shouldn't be as problematic.
|
||||
|
||||
The site will show all *H1* headers in the side panel by default, these then
|
||||
expand when selected to show all *H2* headers.
|
||||
|
||||
Due to the limited TOC and side-bar depth, we shouldn't be afraid of looong
|
||||
pages with many *H2* headings to break down the page into logical quadrants.
|
||||
@@ -31,7 +31,3 @@
|
||||
:module: PyOpenColorIO
|
||||
:value: <Allocation.ALLOCATION_UNKNOWN: 0>
|
||||
|
||||
|
||||
.. py:property:: Allocation.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -61,10 +61,6 @@
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: Baker.getDisplay(self: PyOpenColorIO.Baker) -> str
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: Baker.getFormat(self: PyOpenColorIO.Baker) -> str
|
||||
:module: PyOpenColorIO
|
||||
|
||||
@@ -98,10 +94,6 @@
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: Baker.getView(self: PyOpenColorIO.Baker) -> str
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: Baker.setConfig(self: PyOpenColorIO.Baker, config: PyOpenColorIO.Config) -> None
|
||||
:module: PyOpenColorIO
|
||||
|
||||
@@ -111,13 +103,7 @@
|
||||
.. py:method:: Baker.setCubeSize(self: PyOpenColorIO.Baker, cubeSize: int) -> None
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Override the main LUT (3d or 1d) sample size. Default value is -1, which allows each format to use its own most appropriate size.
|
||||
|
||||
|
||||
.. py:method:: Baker.setDisplayView(self: PyOpenColorIO.Baker, display: str, view: str) -> None
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Set the display and view to apply during the baking. Must not be used if setTargetSpace is used.
|
||||
Override the default cube sample size. default: <format specific>
|
||||
|
||||
|
||||
.. py:method:: Baker.setFormat(self: PyOpenColorIO.Baker, formatName: str) -> None
|
||||
@@ -147,13 +133,13 @@
|
||||
.. py:method:: Baker.setShaperSpace(self: PyOpenColorIO.Baker, shaperSpace: str) -> None
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Set an *optional* :ref:`ColorSpace` to shape the incoming values of the LUT. When baking 3DLUT, this will correspond to the 1D shaper used to normalise incoming values to the unit range. When baking 1D LUT, this will be used to determine the input range of the LUT.
|
||||
Set an *optional* :ref:`ColorSpace` to be used to shape / transfer the input colorspace. This is mostly used to allocate an HDR luminance range into an LDR one. If a shaper space is not explicitly specified, and the file format supports one, the :ref:`ColorSpace` Allocation will be used (not implemented for all formats).
|
||||
|
||||
|
||||
.. py:method:: Baker.setTargetSpace(self: PyOpenColorIO.Baker, targetSpace: str) -> None
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Set the target (i.e., output) color space for the LUT. Must not be used if setDisplayView is used.
|
||||
Set the target device colorspace for the LUT.
|
||||
|
||||
|
||||
.. py:class:: FormatIterator
|
||||
|
||||
@@ -22,7 +22,7 @@
|
||||
|
||||
BIT_DEPTH_UINT16 :
|
||||
|
||||
BIT_DEPTH_UINT32 : Here for historical reason but that's not supported.
|
||||
BIT_DEPTH_UINT32 :
|
||||
|
||||
BIT_DEPTH_F16 :
|
||||
|
||||
@@ -75,7 +75,3 @@
|
||||
:module: PyOpenColorIO
|
||||
:value: <BitDepth.BIT_DEPTH_UNKNOWN: 0>
|
||||
|
||||
|
||||
.. py:property:: BitDepth.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -31,7 +31,3 @@
|
||||
:module: PyOpenColorIO
|
||||
:value: <CDLStyle.CDL_NO_CLAMP: 1>
|
||||
|
||||
|
||||
.. py:property:: CDLStyle.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -47,7 +47,3 @@
|
||||
:module: PyOpenColorIO
|
||||
:value: <ChannelOrdering.CHANNEL_ORDERING_RGBA: 0>
|
||||
|
||||
|
||||
.. py:property:: ChannelOrdering.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -10,6 +10,8 @@
|
||||
|
||||
While a complete discussion of color spaces is beyond the scope of header documentation, traditional uses would be to have *ColorSpaces* corresponding to: physical capture devices (known cameras, scanners), and internal 'convenience' spaces (such as scene linear, logarithmic).
|
||||
|
||||
*ColorSpaces* are specific to a particular image precision (float32, uint8, etc.), and the set of ColorSpaces that provide equivalent mappings (at different precisions) are referred to as a 'family'.
|
||||
|
||||
|
||||
.. py:method:: ColorSpace.__init__(*args, **kwargs)
|
||||
:module: PyOpenColorIO
|
||||
@@ -95,7 +97,7 @@
|
||||
.. py:method:: ColorSpace.getEqualityGroup(self: PyOpenColorIO.ColorSpace) -> str
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Get the :ref:`ColorSpace` group name (used for equality comparisons) This allows no-op transforms between different colorspaces. If an equalityGroup is not defined (an empty string), it will be considered unique (i.e., it will not compare as equal to other ColorSpaces with an empty equality group).
|
||||
Get the :ref:`ColorSpace` group name (used for equality comparisons) This allows no-op transforms between different colorspaces. If an equalityGroup is not defined (an empty string), it will be considered unique (i.e., it will not compare as equal to other ColorSpaces with an empty equality group). This is often, though not always, set to the same value as 'family'.
|
||||
|
||||
|
||||
.. py:method:: ColorSpace.getFamily(self: PyOpenColorIO.ColorSpace) -> str
|
||||
|
||||
@@ -24,7 +24,3 @@
|
||||
:module: PyOpenColorIO
|
||||
:value: <ColorSpaceDirection.COLORSPACE_DIR_TO_REFERENCE: 0>
|
||||
|
||||
|
||||
.. py:property:: ColorSpaceDirection.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -31,7 +31,3 @@
|
||||
:module: PyOpenColorIO
|
||||
:value: <ColorSpaceVisibility.COLORSPACE_INACTIVE: 1>
|
||||
|
||||
|
||||
.. py:property:: ColorSpaceVisibility.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -24,47 +24,13 @@
|
||||
See developers-usageexamples
|
||||
|
||||
|
||||
.. py:method:: Config.CreateFromBuiltinConfig(arg0: str) -> PyOpenColorIO.Config
|
||||
:module: PyOpenColorIO
|
||||
:staticmethod:
|
||||
|
||||
Create a configuration using an OCIO built-in config.
|
||||
|
||||
:param configName: Built-in config name.
|
||||
|
||||
The available configNames are: "cg-config-v0.1.0_aces-v1.3_ocio-v2.1.1"-- ACES CG config, basic color spaces for computer graphics apps. More information about these configs is available at: https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES
|
||||
|
||||
Information about the available configs is available from the :ref:`BuiltinConfigRegistry`.
|
||||
|
||||
:exception :ref:`Exception`: If the configName is not recognized.
|
||||
|
||||
:return: One of the configs built into the OCIO library.
|
||||
|
||||
|
||||
.. py:method:: Config.CreateFromConfigIOProxy(arg0: OpenColorIO_v2_2dev::ConfigIOProxy) -> PyOpenColorIO.Config
|
||||
:module: PyOpenColorIO
|
||||
:staticmethod:
|
||||
|
||||
Create a config from the supplied :ref:`ConfigIOProxy` object. This allows the calling program to directly provide the config and associated LUTs rather than reading them from the standard file system.
|
||||
|
||||
See the :ref:`ConfigIOProxy` class documentation for more info.
|
||||
|
||||
:param ciop: :ref:`ConfigIOProxy` object providing access to the config's files.
|
||||
|
||||
:exception :ref:`Exception`: If the config may not be read from the proxy, or does not parse.
|
||||
|
||||
:return: The :ref:`Config` object.
|
||||
|
||||
|
||||
.. py:method:: Config.CreateFromEnv() -> PyOpenColorIO.Config
|
||||
:module: PyOpenColorIO
|
||||
:staticmethod:
|
||||
|
||||
Create a configuration using the OCIO environment variable.
|
||||
|
||||
Also supports the OCIO URI format for Built-in configs and supports archived configs. See :ref:`Config::CreateFromFile`.
|
||||
|
||||
If the variable is missing or empty, returns the same result as :ref:`Config::CreateRaw`. :return: The :ref:`Config` object.
|
||||
If the variable is missing or empty, returns the same result as :ref:`Config::CreateRaw` .
|
||||
|
||||
|
||||
.. py:method:: Config.CreateFromFile(fileName: str) -> PyOpenColorIO.Config
|
||||
@@ -73,14 +39,6 @@
|
||||
|
||||
Create a configuration using a specific config file.
|
||||
|
||||
Also supports the following OCIO URI format for Built-in configs: "ocio://default" - Default Built-in config. "ocio://<CONFIG NAME>" - A specific Built-in config. For the list of available <CONFIG NAME> strings, see :ref:`Config::CreateFromBuiltinConfig`.
|
||||
|
||||
Also supports archived configs (.ocioz files).
|
||||
|
||||
:exception :ref:`Exception`: If the file may not be read or does not parse.
|
||||
|
||||
:return: The :ref:`Config` object.
|
||||
|
||||
|
||||
.. py:method:: Config.CreateFromStream(str: str) -> PyOpenColorIO.Config
|
||||
:module: PyOpenColorIO
|
||||
@@ -88,16 +46,6 @@
|
||||
|
||||
Create a configuration using a stream.
|
||||
|
||||
Note that CreateFromStream does not set the working directory so the caller would need to set that separately in order to resolve FileTransforms. This function is typically only used for self-contained configs (no LUTs).
|
||||
|
||||
Configs created from CreateFromStream can not be archived unless the working directory is set and contains any necessary LUT files.
|
||||
|
||||
:param istream: Stream to the config.
|
||||
|
||||
:exception :ref:`Exception`: If the stream does not parse.
|
||||
|
||||
:return: The :ref:`Config` object.
|
||||
|
||||
|
||||
.. py:method:: Config.CreateRaw() -> PyOpenColorIO.Config
|
||||
:module: PyOpenColorIO
|
||||
@@ -105,15 +53,7 @@
|
||||
|
||||
Create a fall-back config.
|
||||
|
||||
This may be useful to allow client apps to launch in cases when the supplied config path is not loadable. :return: The :ref:`Config` object.
|
||||
|
||||
|
||||
.. py:class:: Config.DisplayAllIterator
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: Config.DisplayAllIterator.__init__(*args, **kwargs)
|
||||
:module: PyOpenColorIO
|
||||
This may be useful to allow client apps to launch in cases when the supplied config path is not loadable.
|
||||
|
||||
|
||||
.. py:method:: Config.GetProcessorFromConfigs(*args, **kwargs)
|
||||
@@ -137,28 +77,12 @@
|
||||
4. GetProcessorFromConfigs(srcContext: PyOpenColorIO.Context, srcConfig: PyOpenColorIO.Config, srcColorSpaceName: str, srcInterchangeName: str, dstContext: PyOpenColorIO.Context, dstConfig: PyOpenColorIO.Config, dstColorSpaceName: str, dstInterchangeName: str) -> PyOpenColorIO.Processor
|
||||
|
||||
|
||||
.. py:class:: Config.ViewForViewTypeIterator
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: Config.ViewForViewTypeIterator.__init__(*args, **kwargs)
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:class:: Config.VirtualViewIterator
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: Config.VirtualViewIterator.__init__(*args, **kwargs)
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: Config.__init__(self: PyOpenColorIO.Config) -> None
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Create an empty config of the current version.
|
||||
|
||||
Note that an empty config will not pass validation since required elements will be missing. :return: The :ref:`Config` object.
|
||||
Note that an empty config will not pass validation since required elements will be missing.
|
||||
|
||||
|
||||
.. py:method:: Config.__str__(self: PyOpenColorIO.Config) -> str
|
||||
@@ -243,30 +167,6 @@
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: Config.addVirtualDisplaySharedView(self: PyOpenColorIO.Config, sharedView: str) -> None
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: Config.addVirtualDisplayView(self: PyOpenColorIO.Config, view: str, viewTransformName: str, colorSpaceName: str, looks: str = '', ruleName: str = '', description: str = '') -> None
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: Config.archive(self: PyOpenColorIO.Config, arg0: str) -> None
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Archive the config and its LUTs into the specified output stream.
|
||||
|
||||
The config is archived by serializing the :ref:`Config` object into a file named "config.ocio" and then walking through the current working directory and any sub-directories. Any files that have an extension matching a supported LUT file format are added to the archive. Any files that do not have an extension (or have some unsupported LUT extension, including .ocio), will not be added to the archive. To reiterate, it is the in-memory :ref:`Config` object that is archived, and not any .ocio file in the current working directory. The directory structure relative to the working directory is preserved. No files outside the working directory are archived so that if it is later expanded, no files will be created outside the working dir.
|
||||
|
||||
The reason the archive is created using all supported LUT file extensions rather than by trying to resolve all the FileTransforms in the :ref:`Config` to specific files is because of the goal to allow context variables to continue to work.
|
||||
|
||||
If a :ref:`Config` is created with CreateFromStream, CreateFromFile with an OCIOZ archive, or CreateFromConfigIOProxy, it cannot be archived unless the working directory is manually set to a directory that contains any necessary LUT files.
|
||||
|
||||
The provided output stream must be closed by the caller, if necessary (e.g., an ofstream).
|
||||
|
||||
:param ostream: The output stream to write to.
|
||||
|
||||
|
||||
.. py:method:: Config.clearColorSpaces(self: PyOpenColorIO.Config) -> None
|
||||
:module: PyOpenColorIO
|
||||
|
||||
@@ -302,12 +202,6 @@
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: Config.clearVirtualDisplay(self: PyOpenColorIO.Config) -> None
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Clear the virtual display.
|
||||
|
||||
|
||||
.. py:method:: Config.filepathOnlyMatchesDefaultRule(self: PyOpenColorIO.Config, filePath: str) -> bool
|
||||
:module: PyOpenColorIO
|
||||
|
||||
@@ -362,7 +256,7 @@
|
||||
.. py:method:: Config.getColorSpaceFromFilepath(self: PyOpenColorIO.Config, filePath: str) -> tuple
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Get the color space of the first rule that matched filePath. (For v1 configs, this is equivalent to calling parseColorSpaceFromString with strictparsing set to false.)
|
||||
Get the color space of the first rule that matched filePath.
|
||||
|
||||
|
||||
.. py:method:: Config.getColorSpaceNames(*args, **kwargs)
|
||||
@@ -409,7 +303,7 @@
|
||||
Get the default coefficients for computing luma.
|
||||
|
||||
.. note::
|
||||
There is no "1 size fits all" set of luma coefficients. (The values are typically different for each colorspace, and the application of them may be nonsensical depending on the intensity coding anyways). Thus, the 'right' answer is to make these functions on the :ref:`ColorSpace` class. However, it's often useful to have a config-wide default so here it is. We will add the colorspace specific luma call if/when another client is interesting in using it.
|
||||
There is no "1 size fits all" set of luma coefficients. (The values are typically different for each colorspace, and the application of them may be nonsensical depending on the intensity coding anyways). Thus, the 'right' answer is to make these functions on the :ref:`Config` class. However, it's often useful to have a config-wide default so here it is. We will add the colorspace specific luma call if/when another client is interesting in using it.
|
||||
|
||||
|
||||
.. py:method:: Config.getDefaultSceneToDisplayViewTransform(self: PyOpenColorIO.Config) -> PyOpenColorIO.ViewTransform
|
||||
@@ -418,15 +312,9 @@
|
||||
This view transform is the one that will be used by default if a :ref:`ColorSpaceTransform` is needed between a scene-referred and display-referred color space. The config author may specify a transform to use via the default_view_transform entry in the config. If that is not present, or does not return a valid view transform from the scene-referred connection space, the fall-back is to use the first valid view transform in the config. Returns a null ConstTransformRcPtr if there isn't one.
|
||||
|
||||
|
||||
.. py:method:: Config.getDefaultView(*args, **kwargs)
|
||||
.. py:method:: Config.getDefaultView(self: PyOpenColorIO.Config, display: str) -> str
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Overloaded function.
|
||||
|
||||
1. getDefaultView(self: PyOpenColorIO.Config, display: str) -> str
|
||||
|
||||
2. getDefaultView(self: PyOpenColorIO.Config, display: str, colorSpacename: str) -> str
|
||||
|
||||
|
||||
.. py:method:: Config.getDefaultViewTransformName(self: PyOpenColorIO.Config) -> str
|
||||
:module: PyOpenColorIO
|
||||
@@ -474,10 +362,6 @@
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: Config.getDisplaysAll(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.DisplayAllIterator
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: Config.getEnvironmentMode(self: PyOpenColorIO.Config) -> PyOpenColorIO.EnvironmentMode
|
||||
:module: PyOpenColorIO
|
||||
|
||||
@@ -588,25 +472,15 @@
|
||||
|
||||
6. getProcessor(self: PyOpenColorIO.Config, context: PyOpenColorIO.Context, srcColorSpaceName: str, display: str, view: str, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor
|
||||
|
||||
7. getProcessor(self: PyOpenColorIO.Config, namedTransform: PyOpenColorIO.NamedTransform, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor
|
||||
|
||||
Get the processor to apply a :ref:`NamedTransform` in the specified direction.
|
||||
|
||||
8. getProcessor(self: PyOpenColorIO.Config, context: PyOpenColorIO.Context, namedTransform: PyOpenColorIO.NamedTransform, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor
|
||||
|
||||
9. getProcessor(self: PyOpenColorIO.Config, namedTransformName: str, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor
|
||||
|
||||
10. getProcessor(self: PyOpenColorIO.Config, context: PyOpenColorIO.Context, namedTransformName: str, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor
|
||||
|
||||
11. getProcessor(self: PyOpenColorIO.Config, transform: PyOpenColorIO.Transform) -> PyOpenColorIO.Processor
|
||||
7. getProcessor(self: PyOpenColorIO.Config, transform: PyOpenColorIO.Transform) -> PyOpenColorIO.Processor
|
||||
|
||||
Get the processor for the specified transform.
|
||||
|
||||
Not often needed, but will allow for the re-use of atomic OCIO functionality (such as to apply an individual LUT file).
|
||||
|
||||
12. getProcessor(self: PyOpenColorIO.Config, transform: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor
|
||||
8. getProcessor(self: PyOpenColorIO.Config, transform: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor
|
||||
|
||||
13. getProcessor(self: PyOpenColorIO.Config, context: PyOpenColorIO.Context, transform: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor
|
||||
9. getProcessor(self: PyOpenColorIO.Config, context: PyOpenColorIO.Context, transform: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor
|
||||
|
||||
|
||||
.. py:method:: Config.getRoleNames(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.RoleNameIterator
|
||||
@@ -654,33 +528,7 @@
|
||||
|
||||
1. getViews(self: PyOpenColorIO.Config, display: str) -> PyOpenColorIO.Config.ViewIterator
|
||||
|
||||
2. getViews(self: PyOpenColorIO.Config, type: PyOpenColorIO.ViewType, display: str) -> PyOpenColorIO.Config.ViewForViewTypeIterator
|
||||
|
||||
3. getViews(self: PyOpenColorIO.Config, display: str, colorSpaceName: str) -> PyOpenColorIO.Config.ViewForColorSpaceIterator
|
||||
|
||||
|
||||
.. py:method:: Config.getVirtualDisplayViewColorSpaceName(self: PyOpenColorIO.Config, view: str) -> str
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: Config.getVirtualDisplayViewDescription(self: PyOpenColorIO.Config, view: str) -> str
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: Config.getVirtualDisplayViewLooks(self: PyOpenColorIO.Config, view: str) -> str
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: Config.getVirtualDisplayViewRule(self: PyOpenColorIO.Config, view: str) -> str
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: Config.getVirtualDisplayViewTransformName(self: PyOpenColorIO.Config, view: str) -> str
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: Config.getVirtualDisplayViews(self: PyOpenColorIO.Config, display: PyOpenColorIO.ViewType) -> PyOpenColorIO.Config.VirtualViewIterator
|
||||
:module: PyOpenColorIO
|
||||
2. getViews(self: PyOpenColorIO.Config, display: str, colorSpaceName: str) -> PyOpenColorIO.Config.ViewForColorSpaceIterator
|
||||
|
||||
|
||||
.. py:method:: Config.getWorkingDir(self: PyOpenColorIO.Config) -> str
|
||||
@@ -693,69 +541,6 @@
|
||||
Return true if the role has been defined.
|
||||
|
||||
|
||||
.. py:method:: Config.instantiateDisplayFromICCProfile(self: PyOpenColorIO.Config, ICCProfileFilepath: str) -> int
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Instantiate a new display from a virtual display, using an ICC profile.
|
||||
|
||||
On platforms such as Linux, where the :ref:`SystemMonitors` class is not able to obtain a list of ICC profiles from the OS, this method may be used to manually specify a path to an ICC profile.
|
||||
|
||||
Will throw if the virtual display definition is missing from the config.
|
||||
|
||||
Returns the index of the display.
|
||||
|
||||
|
||||
.. py:method:: Config.instantiateDisplayFromMonitorName(self: PyOpenColorIO.Config, monitorName: str) -> int
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Instantiate a new display from a virtual display, using the monitor name.
|
||||
|
||||
This method uses the virtual display to create an actual display for the given monitorName. The new display will receive the views from the virtual display.
|
||||
|
||||
After the ICC profile is read, a display name will be created by combining the description text from the profile with the monitorName obtained from the OS. Use the :ref:`SystemMonitors` class to obtain the list of monitorName strings for the displays connected to the computer.
|
||||
|
||||
A new display color space will also be created using the display name. It will have a from_display_reference transform that is a :ref:`FileTransform` pointing to the ICC profile.
|
||||
|
||||
Any instantiated display color spaces for a virtual display are intended to be temporary (i.e. last as long as the current session). By default, they are not saved when writing a config file. If there is a need to make it a permanent color space, it may be desirable to copy the ICC profile somewhere under the config search_path.
|
||||
|
||||
Will throw if the config does not have a virtual display or if the monitorName does not exist.
|
||||
|
||||
If there is already a display or a display color space with the name monitorName, it will be replaced/updated.
|
||||
|
||||
Returns the index of the display.
|
||||
|
||||
|
||||
.. py:method:: Config.isArchivable(self: PyOpenColorIO.Config) -> bool
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Verify if the config is archivable.
|
||||
|
||||
A config is not archivable if any of the following are true: -- The working directory is not set -- It contains FileTransforms with a src outside the working directory -- The search path contains paths outside the working directory -- The search path contains paths that start with a context variable
|
||||
|
||||
:ref:`Context` variables are allowed but the intent is that they may only resolve to paths that are within or below the working directory. This is because the archiving function will only archive files that are within the working directory in order to ensure that if it is later expanded, that it will not create any files outside this directory.
|
||||
|
||||
For example, a context variable on the search path intended to contain the name of a sub-directory under the working directory must have the form "./$DIR_NAME" rather than just "$DIR_NAME" to be considered archivable. This is imperfect since there is no way to prevent the context variable from creating a path outside the working dir, but it should at least draw attention to the fact that the archive would fail if used with context vars that try to abuse the intended functionality.
|
||||
|
||||
:return: bool Archivable if true.
|
||||
|
||||
|
||||
.. py:method:: Config.isColorSpaceLinear(self: PyOpenColorIO.Config, colorSpace: str, referenceSpaceType: PyOpenColorIO.ReferenceSpaceType) -> bool
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Return true if the specified color space is linear.
|
||||
|
||||
The determination of linearity is made with respect to one of the two reference spaces (i.e., either the scene-referred one or the display-referred one). If the reference space type of the color space is the opposite of the requested reference space type, false is returned immediately rather than trying to invoke the default view transform to convert between the reference spaces.
|
||||
|
||||
Note: This function relies on heuristics that may sometimes give an incorrect result. For example, if the encoding attribute is not set appropriately or the sampled values fail to detect non-linearity.
|
||||
|
||||
The algorithm proceeds as follows: -- If the color space isdata attribute is true, return false. -- If the reference space type of the color space differs from the requested reference space type, return false. -- If the color space's encoding attribute is present, return true if it matches the expected reference space type (i.e., "scene-linear" for REFERENCE_SPACE_SCENE or "display-linear" for REFERENCE_SPACE_DISPLAY) and false otherwise. -- If the color space has no to_reference or from_reference transform, return true. -- Evaluate several points through the color space's transform and check if the output only differs by a scale factor (which may be different per channel, e.g. allowing an arbitrary matrix transform, with no offset).
|
||||
|
||||
Note that the encoding test happens before the sampled value test to give config authors ultimate control over the linearity determination. For example, they could set the encoding attribute to indicate linearity if they want to ignore some areas of non-linearity (e.g., at extreme values). Or they could set it to indicate that a color space should not be considered linear, even if it is, in a mathematical sense.
|
||||
|
||||
:param colorSpace: Color space to evaluate.
|
||||
:param referenceSpaceType: Evaluate linearity with respect to the specified reference space (either scene-referred or display-referred).
|
||||
|
||||
|
||||
.. py:method:: Config.isColorSpaceUsed(self: PyOpenColorIO.Config, name: str) -> bool
|
||||
:module: PyOpenColorIO
|
||||
|
||||
@@ -765,10 +550,6 @@
|
||||
Name must be the canonical name.
|
||||
|
||||
|
||||
.. py:method:: Config.isDisplayTemporary(self: PyOpenColorIO.Config, display: str) -> bool
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: Config.isStrictParsingEnabled(self: PyOpenColorIO.Config) -> bool
|
||||
:module: PyOpenColorIO
|
||||
|
||||
@@ -780,7 +561,7 @@
|
||||
.. py:method:: Config.parseColorSpaceFromString(self: PyOpenColorIO.Config, str: str) -> str
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Given the specified string, get the longest, right-most, colorspace substring that appears.
|
||||
Given the specified string, get the longest, right-most, colorspace substring that appears. This is now deprecated, please use getColorSpaceFromFilepath.
|
||||
|
||||
- If strict parsing is enabled, and no color space is found, return an empty string.
|
||||
- If strict parsing is disabled, return ROLE_DEFAULT (if defined).
|
||||
@@ -815,12 +596,6 @@
|
||||
Remove a shared view. Will throw if the view does not exist.
|
||||
|
||||
|
||||
.. py:method:: Config.removeVirtualDisplayView(self: PyOpenColorIO.Config, view: str) -> None
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Remove the view from the virtual display.
|
||||
|
||||
|
||||
.. py:method:: Config.serialize(*args, **kwargs)
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -10,6 +10,8 @@
|
||||
.. py:method:: CPUProcessor.__init__(*args, **kwargs)
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Initialize self. See help(type(self)) for accurate signature.
|
||||
|
||||
|
||||
.. py:method:: CPUProcessor.apply(*args, **kwargs)
|
||||
:module: PyOpenColorIO
|
||||
|
||||
@@ -51,6 +51,8 @@
|
||||
.. py:method:: DynamicProperty.__init__(*args, **kwargs)
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Initialize self. See help(type(self)) for accurate signature.
|
||||
|
||||
|
||||
.. py:method:: DynamicProperty.getDouble(self: PyOpenColorIO.DynamicProperty) -> float
|
||||
:module: PyOpenColorIO
|
||||
|
||||
@@ -54,7 +54,3 @@
|
||||
:module: PyOpenColorIO
|
||||
:value: <DynamicPropertyType.DYNAMIC_PROPERTY_GRADING_TONE: 5>
|
||||
|
||||
|
||||
.. py:property:: DynamicPropertyType.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -31,7 +31,3 @@
|
||||
:module: PyOpenColorIO
|
||||
:value: <EnvironmentMode.ENV_ENVIRONMENT_UNKNOWN: 0>
|
||||
|
||||
|
||||
.. py:property:: EnvironmentMode.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -33,7 +33,3 @@
|
||||
:module: PyOpenColorIO
|
||||
:value: <ExposureContrastStyle.EXPOSURE_CONTRAST_VIDEO: 1>
|
||||
|
||||
|
||||
.. py:property:: ExposureContrastStyle.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -30,8 +30,6 @@
|
||||
|
||||
Getters and setters are using the rule position, they will throw if the position is not valid. If the rule at the specified position does not implement the requested property getter will return NULL and setter will throw.
|
||||
|
||||
When loading a v1 config, a set of :ref:`FileRules` are created with ColorSpaceNamePathSearch followed by the Default rule pointing to the default role. This allows getColorSpaceFromFilepath to emulate OCIO v1 code that used parseColorSpaceFromString with strictparsing set to false.
|
||||
|
||||
|
||||
.. py:method:: FileRules.__init__(self: PyOpenColorIO.FileRules) -> None
|
||||
:module: PyOpenColorIO
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
FIXED_FUNCTION_ACES_GAMUTMAP_07 : ACES 0.7 Gamut clamping algorithm -- NOT IMPLEMENTED YET.
|
||||
|
||||
FIXED_FUNCTION_ACES_GAMUT_COMP_13 : ACES 1.3 Parametric Gamut Compression (expects ACEScg values)
|
||||
FIXED_FUNCTION_ACES_GAMUTMAP_13 : ACES 1.3 Gamut mapping algorithm.
|
||||
|
||||
.. py:method:: name() -> str
|
||||
:property:
|
||||
@@ -54,9 +54,9 @@
|
||||
:value: <FixedFunctionStyle.FIXED_FUNCTION_ACES_GAMUTMAP_07: 11>
|
||||
|
||||
|
||||
.. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_ACES_GAMUT_COMP_13
|
||||
.. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_ACES_GAMUTMAP_13
|
||||
:module: PyOpenColorIO
|
||||
:value: <FixedFunctionStyle.FIXED_FUNCTION_ACES_GAMUT_COMP_13: 12>
|
||||
:value: <FixedFunctionStyle.FIXED_FUNCTION_ACES_GAMUTMAP_13: 12>
|
||||
|
||||
|
||||
.. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_ACES_GLOW_03
|
||||
@@ -103,7 +103,3 @@
|
||||
:module: PyOpenColorIO
|
||||
:value: <FixedFunctionStyle.FIXED_FUNCTION_XYZ_TO_xyY: 7>
|
||||
|
||||
|
||||
.. py:property:: FixedFunctionStyle.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -28,6 +28,8 @@
|
||||
.. py:method:: FormatMetadata.__init__(*args, **kwargs)
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Initialize self. See help(type(self)) for accurate signature.
|
||||
|
||||
|
||||
.. py:method:: FormatMetadata.__iter__(self: PyOpenColorIO.FormatMetadata) -> PyOpenColorIO.FormatMetadata.AttributeNameIterator
|
||||
:module: PyOpenColorIO
|
||||
|
||||
@@ -18,14 +18,8 @@
|
||||
|
||||
GPU_LANGUAGE_GLSL_4_0 : OpenGL Shading Language.
|
||||
|
||||
GPU_LANGUAGE_GLSL_ES_1_0 : OpenGL ES Shading Language.
|
||||
|
||||
GPU_LANGUAGE_GLSL_ES_3_0 : OpenGL ES Shading Language.
|
||||
|
||||
GPU_LANGUAGE_HLSL_DX11 : DirectX Shading Language.
|
||||
|
||||
GPU_LANGUAGE_MSL_2_0 : Metal Shading Language.
|
||||
|
||||
.. py:method:: name() -> str
|
||||
:property:
|
||||
|
||||
@@ -49,26 +43,7 @@
|
||||
:value: <GpuLanguage.GPU_LANGUAGE_GLSL_4_0: 3>
|
||||
|
||||
|
||||
.. py:attribute:: GpuLanguage.GPU_LANGUAGE_GLSL_ES_1_0
|
||||
:module: PyOpenColorIO
|
||||
:value: <GpuLanguage.GPU_LANGUAGE_GLSL_ES_1_0: 6>
|
||||
|
||||
|
||||
.. py:attribute:: GpuLanguage.GPU_LANGUAGE_GLSL_ES_3_0
|
||||
:module: PyOpenColorIO
|
||||
:value: <GpuLanguage.GPU_LANGUAGE_GLSL_ES_3_0: 7>
|
||||
|
||||
|
||||
.. py:attribute:: GpuLanguage.GPU_LANGUAGE_HLSL_DX11
|
||||
:module: PyOpenColorIO
|
||||
:value: <GpuLanguage.GPU_LANGUAGE_HLSL_DX11: 4>
|
||||
|
||||
|
||||
.. py:attribute:: GpuLanguage.GPU_LANGUAGE_MSL_2_0
|
||||
:module: PyOpenColorIO
|
||||
:value: <GpuLanguage.GPU_LANGUAGE_MSL_2_0: 8>
|
||||
|
||||
|
||||
.. py:property:: GpuLanguage.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -10,6 +10,8 @@
|
||||
.. py:method:: GPUProcessor.__init__(*args, **kwargs)
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Initialize self. See help(type(self)) for accurate signature.
|
||||
|
||||
|
||||
.. py:method:: GPUProcessor.extractGpuShaderInfo(self: PyOpenColorIO.GPUProcessor, shaderDesc: PyOpenColorIO.GpuShaderDesc) -> None
|
||||
:module: PyOpenColorIO
|
||||
|
||||
@@ -8,10 +8,9 @@
|
||||
|
||||
Inherit from the class to fully customize the implementation of a GPU shader program from a color transformation.
|
||||
|
||||
When no customizations are needed and the intermediate in-memory step is acceptable then the :ref:`GpuShaderDesc` is a better choice.
|
||||
When no customizations are needed then the :ref:`GpuShaderDesc` is a better choice.
|
||||
|
||||
.. note::
|
||||
To better decouple the DynamicProperties from their GPU implementation, the code provides several addUniform() methods i.e. one per access function types. For example, an :ref:`ExposureContrastTransform` instance owns three DynamicProperties and they are all implemented by a double. When creating the GPU fragment shader program, the addUniform() with :ref:`GpuShaderCreator::DoubleGetter` is called when property is dynamic, up to three times.
|
||||
To better decouple the DynamicProperties from their GPU implementation, the code provides several addUniform() methods i.e. one per access function types. For example, an :ref:`ExposureContrastTransform` instance owns three DynamicProperties and they are all implemented by a double. When creating the GPU fragment shader program, the addUniform() with :ref:`GpuShaderCreator::DoubleGetter` is called when property is dynamic, up to three times.
|
||||
|
||||
**An OCIO shader program could contain:**
|
||||
|
||||
@@ -50,47 +49,6 @@
|
||||
} //
|
||||
|
||||
|
||||
.. py:attribute:: GpuShaderCreator.TEXTURE_1D
|
||||
:module: PyOpenColorIO
|
||||
:value: <TextureDimensions.TEXTURE_1D: 1>
|
||||
|
||||
|
||||
.. py:attribute:: GpuShaderCreator.TEXTURE_2D
|
||||
:module: PyOpenColorIO
|
||||
:value: <TextureDimensions.TEXTURE_2D: 2>
|
||||
|
||||
|
||||
.. py:class:: GpuShaderCreator.TextureDimensions
|
||||
:module: PyOpenColorIO
|
||||
:canonical: PyOpenColorIO.GpuShaderCreator.TextureDimensions
|
||||
|
||||
Dimension enum used to differentiate between 1D and 2D object/resource types.
|
||||
|
||||
Members:
|
||||
|
||||
TEXTURE_1D
|
||||
|
||||
TEXTURE_2D
|
||||
|
||||
|
||||
.. py:attribute:: GpuShaderCreator.TextureDimensions.TEXTURE_1D
|
||||
:module: PyOpenColorIO
|
||||
:value: <TextureDimensions.TEXTURE_1D: 1>
|
||||
|
||||
|
||||
.. py:attribute:: GpuShaderCreator.TextureDimensions.TEXTURE_2D
|
||||
:module: PyOpenColorIO
|
||||
:value: <TextureDimensions.TEXTURE_2D: 2>
|
||||
|
||||
|
||||
.. py:property:: GpuShaderCreator.TextureDimensions.name
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:property:: GpuShaderCreator.TextureDimensions.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: GpuShaderCreator.addToDeclareShaderCode(self: PyOpenColorIO.GpuShaderCreator, shaderCode: str) -> None
|
||||
:module: PyOpenColorIO
|
||||
|
||||
@@ -140,10 +98,6 @@
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: GpuShaderCreator.getAllowTexture1D(self: PyOpenColorIO.GpuShaderCreator) -> bool
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: GpuShaderCreator.getCacheID(self: PyOpenColorIO.GpuShaderCreator) -> str
|
||||
:module: PyOpenColorIO
|
||||
|
||||
@@ -167,7 +121,7 @@
|
||||
.. py:method:: GpuShaderCreator.getNextResourceIndex(self: PyOpenColorIO.GpuShaderCreator) -> int
|
||||
:module: PyOpenColorIO
|
||||
|
||||
To avoid global texture sampler and uniform name clashes always append an increasing index to the resource name.
|
||||
To avoid texture/unform name clashes always append an increasing number to the resource name.
|
||||
|
||||
|
||||
.. py:method:: GpuShaderCreator.getPixelName(self: PyOpenColorIO.GpuShaderCreator) -> str
|
||||
@@ -193,12 +147,6 @@
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: GpuShaderCreator.setAllowTexture1D(self: PyOpenColorIO.GpuShaderCreator, allowed: bool) -> None
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Allow 1D GPU resource type, otherwise always using 2D resources for 1D LUTs.
|
||||
|
||||
|
||||
.. py:method:: GpuShaderCreator.setFunctionName(self: PyOpenColorIO.GpuShaderCreator, name: str) -> None
|
||||
:module: PyOpenColorIO
|
||||
|
||||
@@ -253,10 +201,6 @@
|
||||
:value: <TextureType.TEXTURE_RGB_CHANNEL: 1>
|
||||
|
||||
|
||||
.. py:property:: TextureType.value
|
||||
:module: PyOpenColorIO.GpuShaderCreator
|
||||
|
||||
|
||||
.. py:class:: DynamicPropertyIterator
|
||||
:module: PyOpenColorIO.GpuShaderCreator
|
||||
|
||||
|
||||
@@ -87,9 +87,18 @@
|
||||
|
||||
// Step 1: Create a GPU shader description
|
||||
//
|
||||
// The two potential scenarios are:
|
||||
// The three potential scenarios are:
|
||||
//
|
||||
// 1. Instantiate the generic shader description. The color processor
|
||||
// 1. Instantiate the legacy shader description. The color processor
|
||||
// is baked down to contain at most one 3D LUT and no 1D LUTs.
|
||||
//
|
||||
// This is the v1 behavior and will remain part of OCIO v2
|
||||
// for backward compatibility.
|
||||
//
|
||||
OCIO::GpuShaderDescRcPtr shaderDesc
|
||||
= OCIO::GpuShaderDesc::CreateLegacyShaderDesc(LUT3D_EDGE_SIZE);
|
||||
//
|
||||
// 2. Instantiate the generic shader description. The color processor
|
||||
// is used as-is (i.e. without any baking step) and could contain
|
||||
// any number of 1D & 3D luts.
|
||||
//
|
||||
@@ -98,7 +107,7 @@
|
||||
//
|
||||
OCIO::GpuShaderDescRcPtr shaderDesc = OCIO::GpuShaderDesc::Create();
|
||||
//
|
||||
// 2. Instantiate a custom shader description.
|
||||
// 3. Instantiate a custom shader description.
|
||||
//
|
||||
// Writing a custom shader description is a way to tailor the shaders
|
||||
// to the needs of a given client program. This involves writing a
|
||||
@@ -146,72 +155,19 @@
|
||||
Create the default shader description.
|
||||
|
||||
|
||||
.. py:attribute:: GpuShaderDesc.TEXTURE_1D
|
||||
:module: PyOpenColorIO
|
||||
:value: <TextureDimensions.TEXTURE_1D: 1>
|
||||
|
||||
|
||||
.. py:attribute:: GpuShaderDesc.TEXTURE_2D
|
||||
:module: PyOpenColorIO
|
||||
:value: <TextureDimensions.TEXTURE_2D: 2>
|
||||
|
||||
|
||||
.. py:class:: GpuShaderDesc.TextureDimensions
|
||||
:module: PyOpenColorIO
|
||||
:canonical: PyOpenColorIO.GpuShaderCreator.TextureDimensions
|
||||
|
||||
Dimension enum used to differentiate between 1D and 2D object/resource types.
|
||||
|
||||
Members:
|
||||
|
||||
TEXTURE_1D
|
||||
|
||||
TEXTURE_2D
|
||||
|
||||
|
||||
.. py:attribute:: GpuShaderDesc.TextureDimensions.TEXTURE_1D
|
||||
:module: PyOpenColorIO
|
||||
:value: <TextureDimensions.TEXTURE_1D: 1>
|
||||
|
||||
|
||||
.. py:attribute:: GpuShaderDesc.TextureDimensions.TEXTURE_2D
|
||||
:module: PyOpenColorIO
|
||||
:value: <TextureDimensions.TEXTURE_2D: 2>
|
||||
|
||||
|
||||
.. py:method:: GpuShaderDesc.TextureDimensions.__init__(self: PyOpenColorIO.GpuShaderCreator.TextureDimensions, value: int) -> None
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:property:: GpuShaderDesc.TextureDimensions.name
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:property:: GpuShaderDesc.TextureDimensions.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: GpuShaderDesc.__init__(*args, **kwargs)
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Initialize self. See help(type(self)) for accurate signature.
|
||||
|
||||
|
||||
.. py:method:: GpuShaderDesc.add3DTexture(self: PyOpenColorIO.GpuShaderDesc, textureName: str, samplerName: str, edgeLen: int, interpolation: PyOpenColorIO.Interpolation, values: buffer) -> None
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Add a 3D texture with RGB channel type.
|
||||
|
||||
.. note::
|
||||
The 'values' parameter contains the 3D LUT data which must be used as-is as the dimension and origin are hard-coded in the fragment shader program. So, it means one GPU 3D texture per entry.
|
||||
|
||||
|
||||
.. py:method:: GpuShaderDesc.addTexture(self: PyOpenColorIO.GpuShaderDesc, textureName: str, samplerName: str, width: int, height: int, channel: PyOpenColorIO.GpuShaderCreator.TextureType, dimensions: PyOpenColorIO.GpuShaderCreator.TextureDimensions, interpolation: PyOpenColorIO.Interpolation, values: buffer) -> None
|
||||
.. py:method:: GpuShaderDesc.addTexture(self: PyOpenColorIO.GpuShaderDesc, textureName: str, samplerName: str, width: int, height: int, channel: PyOpenColorIO.GpuShaderCreator.TextureType, interpolation: PyOpenColorIO.Interpolation, values: buffer) -> None
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Add a 1D or 2D texture
|
||||
|
||||
.. note::
|
||||
The 'values' parameter contains the LUT data which must be used as-is as the dimensions and origin are hard-coded in the fragment shader program. So, it means one GPU texture per entry.
|
||||
|
||||
|
||||
.. py:method:: GpuShaderDesc.addToDeclareShaderCode(self: PyOpenColorIO.GpuShaderCreator, shaderCode: str) -> None
|
||||
:module: PyOpenColorIO
|
||||
@@ -266,10 +222,6 @@
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: GpuShaderDesc.getAllowTexture1D(self: PyOpenColorIO.GpuShaderCreator) -> bool
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: GpuShaderDesc.getCacheID(self: PyOpenColorIO.GpuShaderCreator) -> str
|
||||
:module: PyOpenColorIO
|
||||
|
||||
@@ -293,7 +245,7 @@
|
||||
.. py:method:: GpuShaderDesc.getNextResourceIndex(self: PyOpenColorIO.GpuShaderCreator) -> int
|
||||
:module: PyOpenColorIO
|
||||
|
||||
To avoid global texture sampler and uniform name clashes always append an increasing index to the resource name.
|
||||
To avoid texture/unform name clashes always append an increasing number to the resource name.
|
||||
|
||||
|
||||
.. py:method:: GpuShaderDesc.getPixelName(self: PyOpenColorIO.GpuShaderCreator) -> str
|
||||
@@ -333,12 +285,6 @@
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: GpuShaderDesc.setAllowTexture1D(self: PyOpenColorIO.GpuShaderCreator, allowed: bool) -> None
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Allow 1D GPU resource type, otherwise always using 2D resources for 1D LUTs.
|
||||
|
||||
|
||||
.. py:method:: GpuShaderDesc.setFunctionName(self: PyOpenColorIO.GpuShaderCreator, name: str) -> None
|
||||
:module: PyOpenColorIO
|
||||
|
||||
@@ -373,7 +319,6 @@
|
||||
|
||||
.. py:class:: TextureType
|
||||
:module: PyOpenColorIO.GpuShaderDesc
|
||||
:canonical: PyOpenColorIO.GpuShaderCreator.TextureType
|
||||
|
||||
Members:
|
||||
|
||||
@@ -394,10 +339,6 @@
|
||||
:value: <TextureType.TEXTURE_RGB_CHANNEL: 1>
|
||||
|
||||
|
||||
.. py:property:: TextureType.value
|
||||
:module: PyOpenColorIO.GpuShaderDesc
|
||||
|
||||
|
||||
.. py:class:: UniformData
|
||||
:module: PyOpenColorIO.GpuShaderDesc
|
||||
|
||||
@@ -422,68 +363,75 @@
|
||||
:module: PyOpenColorIO.GpuShaderDesc
|
||||
|
||||
|
||||
.. py:property:: UniformData.type
|
||||
.. py:method:: UniformData.type
|
||||
:module: PyOpenColorIO.GpuShaderDesc
|
||||
:property:
|
||||
|
||||
|
||||
.. py:class:: Texture
|
||||
:module: PyOpenColorIO.GpuShaderDesc
|
||||
|
||||
|
||||
.. py:property:: Texture.channel
|
||||
:module: PyOpenColorIO.GpuShaderDesc
|
||||
|
||||
|
||||
.. py:property:: Texture.dimensions
|
||||
.. py:method:: Texture.channel
|
||||
:module: PyOpenColorIO.GpuShaderDesc
|
||||
:property:
|
||||
|
||||
|
||||
.. py:method:: Texture.getValues(self: PyOpenColorIO.GpuShaderDesc.Texture) -> numpy.ndarray
|
||||
:module: PyOpenColorIO.GpuShaderDesc
|
||||
|
||||
|
||||
.. py:property:: Texture.height
|
||||
.. py:method:: Texture.height
|
||||
:module: PyOpenColorIO.GpuShaderDesc
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: Texture.interpolation
|
||||
.. py:method:: Texture.interpolation
|
||||
:module: PyOpenColorIO.GpuShaderDesc
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: Texture.samplerName
|
||||
.. py:method:: Texture.samplerName
|
||||
:module: PyOpenColorIO.GpuShaderDesc
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: Texture.textureName
|
||||
.. py:method:: Texture.textureName
|
||||
:module: PyOpenColorIO.GpuShaderDesc
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: Texture.width
|
||||
.. py:method:: Texture.width
|
||||
:module: PyOpenColorIO.GpuShaderDesc
|
||||
:property:
|
||||
|
||||
|
||||
.. py:class:: Texture3D
|
||||
:module: PyOpenColorIO.GpuShaderDesc
|
||||
|
||||
|
||||
.. py:property:: Texture3D.edgeLen
|
||||
.. py:method:: Texture3D.edgeLen
|
||||
:module: PyOpenColorIO.GpuShaderDesc
|
||||
:property:
|
||||
|
||||
|
||||
.. py:method:: Texture3D.getValues(self: PyOpenColorIO.GpuShaderDesc.Texture3D) -> numpy.ndarray
|
||||
:module: PyOpenColorIO.GpuShaderDesc
|
||||
|
||||
|
||||
.. py:property:: Texture3D.interpolation
|
||||
.. py:method:: Texture3D.interpolation
|
||||
:module: PyOpenColorIO.GpuShaderDesc
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: Texture3D.samplerName
|
||||
.. py:method:: Texture3D.samplerName
|
||||
:module: PyOpenColorIO.GpuShaderDesc
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: Texture3D.textureName
|
||||
.. py:method:: Texture3D.textureName
|
||||
:module: PyOpenColorIO.GpuShaderDesc
|
||||
:property:
|
||||
|
||||
|
||||
.. py:class:: UniformIterator
|
||||
@@ -548,7 +496,6 @@
|
||||
|
||||
.. py:class:: DynamicPropertyIterator
|
||||
:module: PyOpenColorIO.GpuShaderDesc
|
||||
:canonical: PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator
|
||||
|
||||
|
||||
.. py:method:: DynamicPropertyIterator.__getitem__(self: PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator, arg0: int) -> PyOpenColorIO.DynamicProperty
|
||||
|
||||
@@ -19,10 +19,12 @@
|
||||
2. __init__(self: PyOpenColorIO.GradingControlPoint, x: float = 0.0, y: float = 0.0) -> None
|
||||
|
||||
|
||||
.. py:property:: GradingControlPoint.x
|
||||
.. py:method:: GradingControlPoint.x
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: GradingControlPoint.y
|
||||
.. py:method:: GradingControlPoint.y
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
@@ -23,56 +23,69 @@
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:property:: GradingPrimary.brightness
|
||||
.. py:method:: GradingPrimary.brightness
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: GradingPrimary.clampBlack
|
||||
.. py:method:: GradingPrimary.clampBlack
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: GradingPrimary.clampWhite
|
||||
.. py:method:: GradingPrimary.clampWhite
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: GradingPrimary.contrast
|
||||
.. py:method:: GradingPrimary.contrast
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: GradingPrimary.exposure
|
||||
.. py:method:: GradingPrimary.exposure
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: GradingPrimary.gain
|
||||
.. py:method:: GradingPrimary.gain
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: GradingPrimary.gamma
|
||||
.. py:method:: GradingPrimary.gamma
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: GradingPrimary.lift
|
||||
.. py:method:: GradingPrimary.lift
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: GradingPrimary.offset
|
||||
.. py:method:: GradingPrimary.offset
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: GradingPrimary.pivot
|
||||
.. py:method:: GradingPrimary.pivot
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: GradingPrimary.pivotBlack
|
||||
.. py:method:: GradingPrimary.pivotBlack
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: GradingPrimary.pivotWhite
|
||||
.. py:method:: GradingPrimary.pivotWhite
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: GradingPrimary.saturation
|
||||
.. py:method:: GradingPrimary.saturation
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:method:: GradingPrimary.validate(self: PyOpenColorIO.GradingPrimary, arg0: PyOpenColorIO.GradingStyle) -> None
|
||||
|
||||
@@ -21,18 +21,22 @@
|
||||
2. __init__(self: PyOpenColorIO.GradingRGBCurve, red: PyOpenColorIO.GradingBSplineCurve = <control_points=[<x=0, y=0><x=0.5, y=0.5><x=1, y=1>]>, green: PyOpenColorIO.GradingBSplineCurve = <control_points=[<x=0, y=0><x=0.5, y=0.5><x=1, y=1>]>, blue: PyOpenColorIO.GradingBSplineCurve = <control_points=[<x=0, y=0><x=0.5, y=0.5><x=1, y=1>]>, master: PyOpenColorIO.GradingBSplineCurve = <control_points=[<x=0, y=0><x=0.5, y=0.5><x=1, y=1>]>) -> None
|
||||
|
||||
|
||||
.. py:property:: GradingRGBCurve.blue
|
||||
.. py:method:: GradingRGBCurve.blue
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: GradingRGBCurve.green
|
||||
.. py:method:: GradingRGBCurve.green
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: GradingRGBCurve.master
|
||||
.. py:method:: GradingRGBCurve.master
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: GradingRGBCurve.red
|
||||
.. py:method:: GradingRGBCurve.red
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
@@ -19,18 +19,22 @@
|
||||
2. __init__(self: PyOpenColorIO.GradingRGBM, red: float, green: float, blue: float, master: float) -> None
|
||||
|
||||
|
||||
.. py:property:: GradingRGBM.blue
|
||||
.. py:method:: GradingRGBM.blue
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: GradingRGBM.green
|
||||
.. py:method:: GradingRGBM.green
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: GradingRGBM.master
|
||||
.. py:method:: GradingRGBM.master
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: GradingRGBM.red
|
||||
.. py:method:: GradingRGBM.red
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
@@ -21,26 +21,32 @@
|
||||
3. __init__(self: PyOpenColorIO.GradingRGBMSW, start: float, width: float) -> None
|
||||
|
||||
|
||||
.. py:property:: GradingRGBMSW.blue
|
||||
.. py:method:: GradingRGBMSW.blue
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: GradingRGBMSW.green
|
||||
.. py:method:: GradingRGBMSW.green
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: GradingRGBMSW.master
|
||||
.. py:method:: GradingRGBMSW.master
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: GradingRGBMSW.red
|
||||
.. py:method:: GradingRGBMSW.red
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: GradingRGBMSW.start
|
||||
.. py:method:: GradingRGBMSW.start
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: GradingRGBMSW.width
|
||||
.. py:method:: GradingRGBMSW.width
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
@@ -33,7 +33,3 @@
|
||||
:module: PyOpenColorIO
|
||||
:value: <GradingStyle.GRADING_VIDEO: 2>
|
||||
|
||||
|
||||
.. py:property:: GradingStyle.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -13,24 +13,29 @@
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:property:: GradingTone.blacks
|
||||
.. py:method:: GradingTone.blacks
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: GradingTone.highlights
|
||||
.. py:method:: GradingTone.highlights
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: GradingTone.midtones
|
||||
.. py:method:: GradingTone.midtones
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: GradingTone.scontrast
|
||||
.. py:method:: GradingTone.scontrast
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:property:: GradingTone.shadows
|
||||
.. py:method:: GradingTone.shadows
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
.. py:method:: GradingTone.validate(self: PyOpenColorIO.GradingTone) -> None
|
||||
@@ -39,6 +44,7 @@
|
||||
The valid range for each parameter varies. The client is expected to enforce these bounds in the UI.
|
||||
|
||||
|
||||
.. py:property:: GradingTone.whites
|
||||
.. py:method:: GradingTone.whites
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
@@ -71,7 +71,3 @@
|
||||
:module: PyOpenColorIO
|
||||
:value: <Interpolation.INTERP_UNKNOWN: 0>
|
||||
|
||||
|
||||
.. py:property:: Interpolation.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -45,7 +45,3 @@
|
||||
:module: PyOpenColorIO
|
||||
:value: <LoggingLevel.LOGGING_LEVEL_WARNING: 1>
|
||||
|
||||
|
||||
.. py:property:: LoggingLevel.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -33,7 +33,3 @@
|
||||
:module: PyOpenColorIO
|
||||
:value: <Lut1DHueAdjust.HUE_WYPN: 2>
|
||||
|
||||
|
||||
.. py:property:: Lut1DHueAdjust.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -20,6 +20,8 @@
|
||||
.. py:method:: MixingSlider.__init__(*args, **kwargs)
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Initialize self. See help(type(self)) for accurate signature.
|
||||
|
||||
|
||||
.. py:method:: MixingSlider.getSliderMaxEdge(self: PyOpenColorIO.MixingSlider) -> float
|
||||
:module: PyOpenColorIO
|
||||
|
||||
@@ -12,13 +12,6 @@
|
||||
curve" transform where there is no need to convert to or from a reference space.
|
||||
|
||||
|
||||
.. py:method:: NamedTransform.GetTransform(transform: PyOpenColorIO.NamedTransform, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Transform
|
||||
:module: PyOpenColorIO
|
||||
:staticmethod:
|
||||
|
||||
Get the requested transform, creating the transform from the inverse direction if the transform for the requested direction is missing.
|
||||
|
||||
|
||||
.. py:class:: NamedTransform.NamedTransformAliasIterator
|
||||
:module: PyOpenColorIO
|
||||
|
||||
@@ -26,6 +19,8 @@
|
||||
.. py:method:: NamedTransform.NamedTransformAliasIterator.__init__(*args, **kwargs)
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Initialize self. See help(type(self)) for accurate signature.
|
||||
|
||||
|
||||
.. py:method:: NamedTransform.__init__(*args, **kwargs)
|
||||
:module: PyOpenColorIO
|
||||
@@ -118,7 +113,7 @@
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: NamedTransform.setEncoding(self: PyOpenColorIO.NamedTransform, encoding: str) -> None
|
||||
.. py:method:: NamedTransform.setEncoding(self: PyOpenColorIO.NamedTransform, encodig: str) -> None
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
|
||||
@@ -31,7 +31,3 @@
|
||||
:module: PyOpenColorIO
|
||||
:value: <NamedTransformVisibility.NAMEDTRANSFORM_INACTIVE: 1>
|
||||
|
||||
|
||||
.. py:property:: NamedTransformVisibility.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -40,7 +40,3 @@
|
||||
:module: PyOpenColorIO
|
||||
:value: <NegativeStyle.NEGATIVE_PASS_THRU: 2>
|
||||
|
||||
|
||||
.. py:property:: NegativeStyle.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -208,7 +208,3 @@
|
||||
:module: PyOpenColorIO
|
||||
:value: <OptimizationFlags.OPTIMIZATION_VERY_GOOD: 263995331>
|
||||
|
||||
|
||||
.. py:property:: OptimizationFlags.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -12,6 +12,8 @@
|
||||
.. py:method:: Processor.__init__(*args, **kwargs)
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Initialize self. See help(type(self)) for accurate signature.
|
||||
|
||||
|
||||
.. py:method:: Processor.createGroupTransform(self: PyOpenColorIO.Processor) -> PyOpenColorIO.GroupTransform
|
||||
:module: PyOpenColorIO
|
||||
@@ -29,7 +31,7 @@
|
||||
Get an optimized :ref:`CPUProcessor` instance.
|
||||
|
||||
.. note::
|
||||
This may provide higher fidelity than anticipated due to internal optimizations. For example, if the inputColorSpace and the outputColorSpace are members of the same equalitygroup, no conversion will be applied, even though strictly speaking quantization should be added.
|
||||
This may provide higher fidelity than anticipated due to internal optimizations. For example, if the inputColorSpace and the outputColorSpace are members of the same family, no conversion will be applied, even though strictly speaking quantization should be added.
|
||||
|
||||
.. note::
|
||||
The typical use case to apply color processing to an image is:
|
||||
|
||||
@@ -40,7 +40,3 @@
|
||||
:module: PyOpenColorIO
|
||||
:value: <ProcessorCacheFlags.PROCESSOR_CACHE_SHARE_DYN_PROPERTIES: 2>
|
||||
|
||||
|
||||
.. py:property:: ProcessorCacheFlags.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -26,7 +26,3 @@
|
||||
:module: PyOpenColorIO
|
||||
:value: <RangeStyle.RANGE_NO_CLAMP: 0>
|
||||
|
||||
|
||||
.. py:property:: RangeStyle.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -26,7 +26,3 @@
|
||||
:module: PyOpenColorIO
|
||||
:value: <ReferenceSpaceType.REFERENCE_SPACE_SCENE: 0>
|
||||
|
||||
|
||||
.. py:property:: ReferenceSpaceType.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -47,7 +47,3 @@
|
||||
:module: PyOpenColorIO
|
||||
:value: <RGBCurveType.RGB_RED: 0>
|
||||
|
||||
|
||||
.. py:property:: RGBCurveType.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -31,7 +31,3 @@
|
||||
:module: PyOpenColorIO
|
||||
:value: <SearchReferenceSpaceType.SEARCH_REFERENCE_SPACE_SCENE: 0>
|
||||
|
||||
|
||||
.. py:property:: SearchReferenceSpaceType.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -8,7 +8,5 @@
|
||||
|
||||
Set the Compute Hash Function to use; otherwise, use the default.
|
||||
|
||||
This is not used when using CreateFromFile with an OCIOZ archive or CreateFromConfigIOProxy.
|
||||
|
||||
:param ComputeHashFunction:
|
||||
|
||||
|
||||
@@ -12,6 +12,8 @@
|
||||
.. py:method:: Transform.__init__(*args, **kwargs)
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Initialize self. See help(type(self)) for accurate signature.
|
||||
|
||||
|
||||
.. py:method:: Transform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection
|
||||
:module: PyOpenColorIO
|
||||
|
||||
@@ -24,7 +24,3 @@
|
||||
:module: PyOpenColorIO
|
||||
:value: <TransformDirection.TRANSFORM_DIR_INVERSE: 1>
|
||||
|
||||
|
||||
.. py:property:: TransformDirection.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -164,7 +164,3 @@
|
||||
:module: PyOpenColorIO
|
||||
:value: <TransformType.TRANSFORM_TYPE_RANGE: 21>
|
||||
|
||||
|
||||
.. py:property:: TransformType.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -54,7 +54,3 @@
|
||||
:module: PyOpenColorIO
|
||||
:value: <UniformDataType.UNIFORM_VECTOR_INT: 4>
|
||||
|
||||
|
||||
.. py:property:: UniformDataType.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -24,7 +24,3 @@
|
||||
:module: PyOpenColorIO
|
||||
:value: <ViewTransformDirection.VIEWTRANSFORM_DIR_TO_REFERENCE: 0>
|
||||
|
||||
|
||||
.. py:property:: ViewTransformDirection.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -24,7 +24,3 @@
|
||||
:module: PyOpenColorIO
|
||||
:value: <ViewType.VIEW_SHARED: 0>
|
||||
|
||||
|
||||
.. py:property:: ViewType.value
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ Charter
|
||||
=======
|
||||
|
||||
See `Charter.md
|
||||
<https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/main/ASWF/Charter.md>`__
|
||||
<https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/master/ASWF/Charter.md>`__
|
||||
on GitHub.
|
||||
|
||||
Technical Charter (the “Charter”) for OpenColorIO a Series of LF Projects, LLC
|
||||
@@ -193,7 +193,7 @@ Project must comply with the terms of this Charter.
|
||||
|
||||
- **i.** All new inbound code contributions to the Project must be
|
||||
made using the **BSD 3-Clause License (available
|
||||
here: **\ https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/main/LICENSE\ **)**
|
||||
here: **\ https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/master/LICENSE\ **)**
|
||||
(the “Project License”).
|
||||
- **ii.** All new inbound code contributions must:
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ follows the open source software best practice policies of the ASWF TAC with
|
||||
the guidance from the Linux Foundation.
|
||||
|
||||
See `CONTRIBUTING.md
|
||||
<https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/main/CONTRIBUTING.md>`__
|
||||
<https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/master/CONTRIBUTING.md>`__
|
||||
for more information.
|
||||
|
||||
CLA
|
||||
@@ -35,7 +35,7 @@ then you should use the :ref:`Corporate Contributor Licence Agreement <ccla>`.
|
||||
|
||||
The OCIO CLA's are the standard forms used by Linux Foundation projects and
|
||||
`recommended by the ASWF TAC
|
||||
<https://github.com/AcademySoftwareFoundation/tac/blob/main/process/contributing.md#contributor-license-agreement-cla>`__.
|
||||
<https://github.com/AcademySoftwareFoundation/tac/blob/master/process/contributing.md#contributor-license-agreement-cla>`__.
|
||||
|
||||
.. _ccla:
|
||||
|
||||
@@ -43,7 +43,7 @@ CLA-corporate
|
||||
+++++++++++++
|
||||
|
||||
See `CLA-corporate.md
|
||||
<https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/main/ASWF/CLA-corporate.md>`__
|
||||
<https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/master/ASWF/CLA-corporate.md>`__
|
||||
on GitHub.
|
||||
|
||||
----
|
||||
@@ -108,7 +108,7 @@ CLA-individual
|
||||
++++++++++++++
|
||||
|
||||
See `CLA-individual.md
|
||||
<https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/main/ASWF/CLA-individual.md>`__
|
||||
<https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/master/ASWF/CLA-individual.md>`__
|
||||
on GitHub.
|
||||
|
||||
----
|
||||
|
||||
@@ -12,7 +12,7 @@ library should abide by that license unless otherwised approved by the OCIO
|
||||
TSC and ASWF Governing Board.
|
||||
|
||||
See `LICENSE
|
||||
<https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/main/LICENSE>`__
|
||||
<https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/master/LICENSE>`__
|
||||
on GitHub.
|
||||
|
||||
----
|
||||
|
||||
@@ -222,7 +222,7 @@ are loaded, etc.
|
||||
CPU CODE PATH
|
||||
+++++++++++++
|
||||
|
||||
The main list of ops is then optimized, and stored internally in the processor.
|
||||
The master list of ops is then optimized, and stored internally in the processor.
|
||||
|
||||
.. code-block:: cpp
|
||||
|
||||
@@ -260,7 +260,7 @@ After all ops have been applied, the results are copied back to the source
|
||||
GPU CODE PATH
|
||||
+++++++++++++
|
||||
|
||||
#. The main list of ops is partitioned into 3 ordered lists:
|
||||
#. The master list of ops is partitioned into 3 ordered lists:
|
||||
|
||||
- As many ops as possible from the BEGINNING of the op-list that can be done
|
||||
analytically in shader text. (called gpu-preops)
|
||||
@@ -276,7 +276,7 @@ analyze the op-stream metadata and determine the appropriate allocation to use.
|
||||
interserting a forward allocation to the end of the pre-ops, and the inverse
|
||||
allocation to the start of the lattice ops.
|
||||
|
||||
See https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/main/src/core/NoOps.cpp#L183
|
||||
See https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/master/src/core/NoOps.cpp#L183
|
||||
|
||||
#. The 3 lists of ops are then optimized individually, and stored on the processor.
|
||||
The Lut3d is computed by applying the gpu-lattice ops, on the CPU, to a lut3d
|
||||
|
||||
@@ -4,30 +4,11 @@
|
||||
|
||||
.. _publications:
|
||||
|
||||
Presentations & Publications
|
||||
============================
|
||||
Publications
|
||||
============
|
||||
|
||||
* ASWF Open Source Days 2023 `video <https://www.youtube.com/watch?v=y-oq693Wl8g>`_
|
||||
DigiPro 2020 **paper** `"The ASWF takes OpenColorIO to the Next Level" <https://drive.google.com/file/d/1y_0ZEftivHH0zoKwvKZx3gH_u_cDm1bD/view?usp=sharing>`_
|
||||
|
||||
* OCIO wins the Pipeline Tool award at DigiPro 2022! `video <https://vimeo.com/742052701>`_
|
||||
DigiPro 2020 **video** `"The ASWF takes OpenColorIO to the Next Level" <https://vimeo.com/458011669>`_
|
||||
|
||||
* ASWF Open Source Days 2022 `video <https://www.youtube.com/watch?v=WzFlz1HeNdI>`_
|
||||
|
||||
* HPA Tech Retreat 2022 "Color Processing with OCIO v2 and the Academy/ASC Common LUT Format"
|
||||
`Slides & Tutorial <https://drive.google.com/drive/folders/1ZRTIYE6kFb-7sTUtYIYFNJndhY6tmJee?usp=share_link>`_
|
||||
|
||||
* OCIO v2 wins an Engineering Excellence award from the Hollywood Post Alliance!
|
||||
`article <https://www.hollywoodreporter.com/movies/movie-news/hpa-engineering-excellence-award-recipients-announced-1234995410/>`_
|
||||
|
||||
* SIGGRAPH 2021 course "Color management with OpenColorIO V2"
|
||||
`video <https://vimeo.com/689093714>`__ `PDF <https://drive.google.com/file/d/1v37Bz7s1wbJNg-ULsBqnGPA9h7pWNfhU/view?usp=share_link>`__ `ACM <https://dl.acm.org/doi/10.1145/3450508.3464600>`_
|
||||
|
||||
* ASWF Open Source Days 2021 `video <https://youtu.be/FSzLwSTJjWo>`_
|
||||
|
||||
* DigiPro 2020 "The ASWF takes OpenColorIO to the Next Level" `video <https://vimeo.com/458011669>`__ `PDF <https://drive.google.com/file/d/1y_0ZEftivHH0zoKwvKZx3gH_u_cDm1bD/view?usp=sharing>`__ `ACM <https://dl.acm.org/doi/abs/10.1145/3403736.3403942>`_
|
||||
|
||||
* ASWF Open Source Days 2020 `video <https://www.youtube.com/watch?v=7e0SSka8Ar8>`_
|
||||
|
||||
* ASWF Open Source Days 2019 `video <https://youtu.be/L5dpFtgZuhQ>`_
|
||||
|
||||
* `Cinematic Color <http://cinematiccolor.org/>`_
|
||||
`Cinematic Color <http://cinematiccolor.org/>`_
|
||||
|
||||
@@ -10,10 +10,8 @@ Configurations
|
||||
.. toctree::
|
||||
:caption: Configurations
|
||||
|
||||
aces_studio
|
||||
aces_cg
|
||||
ocio_v2_demo
|
||||
aces_1.0.3
|
||||
nuke_default
|
||||
spi_anim
|
||||
spi_vfx
|
||||
nuke_default
|
||||
ocio_v2_demo
|
||||
|
||||
@@ -2,21 +2,17 @@
|
||||
SPDX-License-Identifier: CC-BY-4.0
|
||||
Copyright Contributors to the OpenColorIO Project.
|
||||
|
||||
.. _aces_1.0.3:
|
||||
|
||||
aces_1.0.3
|
||||
==========
|
||||
|
||||
This section describes the ACES 1.0.3 OpenColorIO configuration.
|
||||
|
||||
.. note::
|
||||
There is a more recent version of the ACES 1.0.3 config for ACES 1.2 available here:
|
||||
There is a more recent version of the ACES config for ACES 1.2 available here:
|
||||
|
||||
- https://github.com/colour-science/OpenColorIO-Configs/tree/feature/aces-1.2-config
|
||||
|
||||
.. note::
|
||||
Please note that both of these configurations have been supplanted by the new
|
||||
:ref:`aces_studio` for OCIO v2.
|
||||
An ACES config that takes advantage of the new OCIO v2 features is under development.
|
||||
|
||||
|
||||
Information about ACES
|
||||
@@ -315,7 +311,7 @@ Features exposed for customization by the user include:
|
||||
- Selection of shaper function: Log2 or Dolby PQ
|
||||
|
||||
**CTL Source**
|
||||
The configuration depends on the **ACES 1.0.3** release. The release contains a number of file renames and the new ACEScct color space and a number of minor bug fixes and small additions, but is otherwise very similar as the main **ACES 1.0.2** release.
|
||||
The configuration depends on the **ACES 1.0.3** release. The release contains a number of file renames and the new ACEScct color space and a number of minor bug fixes and small additions, but is otherwise very similar as the master **ACES 1.0.2** release.
|
||||
|
||||
The CTL is available here:
|
||||
|
||||
|
||||
@@ -1,59 +0,0 @@
|
||||
..
|
||||
SPDX-License-Identifier: CC-BY-4.0
|
||||
Copyright Contributors to the OpenColorIO Project.
|
||||
|
||||
.. _aces_cg:
|
||||
|
||||
OCIO CG Config for ACES
|
||||
=======================
|
||||
|
||||
The OCIO Computer Graphics (CG) config for ACES is a simple, lightweight config intended for use
|
||||
in typical digital content creation (DCC) apps that need robust choices for texture and
|
||||
rendering spaces and a basic selection of display and view transforms.
|
||||
|
||||
Users who need a more extensive set of color spaces, including digital cinema camera
|
||||
color spaces and a wider set of displays and view should look at the :ref:`aces_studio`.
|
||||
|
||||
Please note that some of the color spaces (e.g. for texturing) are not officially part of the
|
||||
ACES specifications but are included because they are widely used in VFX, animation, and games.
|
||||
|
||||
The latest version of this config may be downloaded from the Releases page of its GitHub
|
||||
`repo. <https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES/releases>`_
|
||||
|
||||
The CG Config leverages the high quality ACES implementation built into OCIO itself
|
||||
and so requires no external LUT files. In fact, even the config file is built into OCIO
|
||||
and users may access it from any application that uses OCIO 2.2 or higher by using one of the
|
||||
following strings in place of the config path:
|
||||
|
||||
``ocio://studio-config-v2.1.0_aces-v1.3_ocio-v2.3`` (for OCIO 2.3 or higher)
|
||||
|
||||
``ocio://studio-config-v1.0.0_aces-v1.3_ocio-v2.1`` (for OCIO 2.2 or higher)
|
||||
|
||||
These new configs adopt an advanced naming convention so that they can be uniquely identified:
|
||||
|
||||
``studio-config-v1.0.0_aces-v1.3_ocio-v2.1.ocio``
|
||||
|
||||
``|-----|-------------|---------|---------|---|``
|
||||
|
||||
``|Type | Colorspaces | ACES | Profile | |``
|
||||
|
||||
Where:
|
||||
|
||||
* Type: The type of the config, e.g., CG or Studio
|
||||
* Colorspaces: The version for the color spaces and other config features
|
||||
* ACES: The aces-dev version being used
|
||||
* Profile: Minimum required OCIO version
|
||||
|
||||
The OCIO Configs Working Group collected input from the community and simplified the
|
||||
naming scheme relative to the earlier OCIO v1 ACES configs. However, aliases have been
|
||||
added so that the original color space names continue to work (if there is an equivalent
|
||||
space in the new config).
|
||||
|
||||
Please note that with OCIO v2 we are trying to be more rigorous about what constitutes a
|
||||
"color space". For this reason, the new configs do not bake view transforms or looks into
|
||||
the display color spaces. Therefore, it is necessary to use a DisplayViewTransform rather
|
||||
than a ColorSpaceTransform if you want to bake in an ACES Output Transform. This is not
|
||||
only more rigorous from a color management point of view, it also helps clarify to end-users
|
||||
the important role of a view transform in the process. Baking in a view transform is a
|
||||
fundamentally different process than just converting between color space encodings, and it
|
||||
should be perceived as such by users.
|
||||
@@ -1,59 +0,0 @@
|
||||
..
|
||||
SPDX-License-Identifier: CC-BY-4.0
|
||||
Copyright Contributors to the OpenColorIO Project.
|
||||
|
||||
.. _aces_studio:
|
||||
|
||||
OCIO Studio Config for ACES
|
||||
===========================
|
||||
|
||||
The OCIO Studio Config for ACES is the successor to the widely used :ref:`ACES config <aces_1.0.3>`
|
||||
for OCIO v1.
|
||||
|
||||
It contains the complete set of ACES color spaces, displays, and views. In addition, it
|
||||
contains some extra color spaces that are not officially part of ACES but that are widely
|
||||
used in the VFX, animation, games, and post-production industries.
|
||||
|
||||
Users who need a simpler config that contains just the basics needed to use ACES color
|
||||
management in common DCC tools are encouraged to check out the :ref:`aces_cg`.
|
||||
|
||||
The latest version of this config may be downloaded from the Releases page of its GitHub
|
||||
`repo. <https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES/releases>`_
|
||||
|
||||
The Studio Config leverages the high quality ACES implementation built into OCIO itself
|
||||
and so requires no external LUT files. In fact, even the config file is built into OCIO
|
||||
and users may access it from any application that uses OCIO 2.2 or higher by using one of the
|
||||
following strings in place of the config path:
|
||||
|
||||
``ocio://studio-config-v2.1.0_aces-v1.3_ocio-v2.3`` (for OCIO 2.3 or higher)
|
||||
|
||||
``ocio://studio-config-v1.0.0_aces-v1.3_ocio-v2.1`` (for OCIO 2.2 or higher)
|
||||
|
||||
These new configs adopt an advanced naming convention so that they can be uniquely identified:
|
||||
|
||||
``studio-config-v1.0.0_aces-v1.3_ocio-v2.1.ocio``
|
||||
|
||||
``|-----|-------------|---------|---------|---|``
|
||||
|
||||
``|Type | Colorspaces | ACES | Profile | |``
|
||||
|
||||
Where:
|
||||
|
||||
* Type: The type of the config, e.g., CG or Studio
|
||||
* Colorspaces: The version for the color spaces and other config features
|
||||
* ACES: The aces-dev version being used
|
||||
* Profile: Minimum required OCIO version
|
||||
|
||||
The OCIO Configs Working Group collected input from the community and simplified the
|
||||
naming scheme relative to the earlier OCIO v1 ACES configs. However, aliases have been
|
||||
added so that the original color space names continue to work (if there is an equivalent
|
||||
space in the new config).
|
||||
|
||||
Please note that with OCIO v2 we are trying to be more rigorous about what constitutes a
|
||||
"color space". For this reason, the new configs do not bake view transforms or looks into
|
||||
the display color spaces. Therefore, it is necessary to use a DisplayViewTransform rather
|
||||
than a ColorSpaceTransform if you want to bake in an ACES Output Transform. This is not
|
||||
only more rigorous from a color management point of view, it also helps clarify to end-users
|
||||
the important role of a view transform in the process. Baking in a view transform is a
|
||||
fundamentally different process than just converting between color space encodings, and it
|
||||
should be perceived as such by users.
|
||||
@@ -10,10 +10,6 @@ ocio-v2_demo
|
||||
Note: this is not intended to be a complete production-ready config, its purpose
|
||||
is to introduce many of the new features in OCIO v2.
|
||||
|
||||
Due to the limitations of the web template, it may be easier for you to read this
|
||||
config in a text editor. The config file is located
|
||||
`here. <https://github.com/AcademySoftwareFoundation/OpenColorIO/tree/main/docs/configurations/ocio-v2_demo.ocio>`_
|
||||
|
||||
|
||||
.. literalinclude:: ocio-v2_demo.ocio
|
||||
:language: yaml
|
||||
|
||||
@@ -15,19 +15,19 @@ Colorspaces
|
||||
|
||||
Required.
|
||||
|
||||
This section is a list of the scene-referred colorspaces in the config.
|
||||
A colorspace may be referred to elsewhere within the config (including
|
||||
This section is a list of all the colorspaces known to OCIO. A
|
||||
colorspace can be referred to elsewhere within the config (including
|
||||
other colorspace definitions), and are used within OCIO-supporting
|
||||
applications.
|
||||
|
||||
A colorspace may use the following keys:
|
||||
A color space may use the following keys:
|
||||
|
||||
|
||||
``to_scene_reference`` and ``from_scene_reference``
|
||||
---------------------------------------------------
|
||||
|
||||
These keys specify the transforms that define the relationship between
|
||||
the colorspace and the scene-referred reference space.
|
||||
the color space and the scene-referred reference space.
|
||||
|
||||
Note: In OCIO v1, the keys ``to_reference`` and ``from_reference`` were
|
||||
used (since there was only one reference space). These are still supported
|
||||
@@ -404,10 +404,10 @@ compatibility.
|
||||
|
||||
Optional.
|
||||
|
||||
These two options were used in OCIO v1 when transforms were applied on the
|
||||
GPU. However, the new GPU renderer in OCIO v2 does not need these.
|
||||
These two options are used when OCIO transforms are applied on the
|
||||
GPU.
|
||||
|
||||
However, they may still be used to automatically generate a "shaper LUT" when
|
||||
It is also used to automatically generate a "shaper LUT" when
|
||||
:ref:`baking LUT's <userguide-bakelut>` unless one is explicitly
|
||||
specified (not all output formats utilise this)
|
||||
|
||||
@@ -469,8 +469,6 @@ It's common to use literal ``|`` block syntax to preserve all newlines:
|
||||
This is the second.
|
||||
|
||||
|
||||
.. _config-display-colorspaces:
|
||||
|
||||
Display Colorspaces
|
||||
*******************
|
||||
|
||||
@@ -479,7 +477,7 @@ Display Colorspaces
|
||||
|
||||
Optional.
|
||||
|
||||
This section is a list of all the display-referred colorspaces in the config.
|
||||
This section is a list of all the display colorspaces known to OCIO.
|
||||
A display colorspace is very similar to a colorspace except its transforms
|
||||
go from or to the display-referred reference space rather than the
|
||||
scene-referred reference space.
|
||||
|
||||
@@ -142,7 +142,7 @@ Example:
|
||||
|
||||
|
||||
Note that if the per-shot lut is not found, you can control whether a
|
||||
fallback LUT succeeds based on if it's in the main location. You can
|
||||
fallback LUT succeeds based on if it's in the master location. You can
|
||||
also use this for multiple levels (show, shot, etc).
|
||||
|
||||
Advanced option: If some shots use .cc files, and some use 3d-luts
|
||||
|
||||
@@ -18,12 +18,6 @@ This page alone will not help you to write a useful config file! See
|
||||
the :ref:`configurations` section for examples of complete, practical
|
||||
configs, and discussion of how they fit within a facilities workflow.
|
||||
|
||||
Please note that you should use the OCIO Python or C++ API to generate
|
||||
the config.ocio file rather than writing the YAML by hand in a text editor.
|
||||
However, if you do ever modify YAML by hand rather than via the API, you
|
||||
should run :ref:`overview-ociocheck` on it to ensure that the syntax is
|
||||
correct.
|
||||
|
||||
YAML basics
|
||||
***********
|
||||
|
||||
@@ -35,7 +29,7 @@ has a good overview.
|
||||
|
||||
OCIO configs typically use a small subset of YAML, so looking at
|
||||
existing configs is probably the quickest way to familiarise yourself
|
||||
(just remember the indentation is important!).
|
||||
(just remember the indentation is important!)
|
||||
|
||||
Checking for errors
|
||||
*******************
|
||||
@@ -65,12 +59,8 @@ An OCIO config has the following sections:
|
||||
* :ref:`config-displays-views` -- This section defines how color spaces should be viewed.
|
||||
* :ref:`config-looks` -- Looks are transforms used to adjust colors, such as to apply a
|
||||
creative effect.
|
||||
* :ref:`config-colorspaces` -- This section defines the scene-referred color space encodings
|
||||
* :ref:`config-colorspaces` -- This section defines the universe of color space encodings
|
||||
available within the config.
|
||||
* :ref:`config-display-colorspaces` -- This section defines the display-referred color space
|
||||
encodings available within the config.
|
||||
* :ref:`config-named-transforms` -- Named Transforms are a way to provide transforms that
|
||||
do not have a fixed relationship to a specific reference space, such as a utility curve.
|
||||
|
||||
A collection of :ref:`config-transforms` is provided for use in the various sections
|
||||
of the config file.
|
||||
@@ -109,12 +99,11 @@ Optional. A brief description of the configuration.
|
||||
``name``
|
||||
^^^^^^^^
|
||||
|
||||
Optional. A unique name for the config. Future versions of OCIO might use this as a
|
||||
sort of "namespace" for the color spaces defined in the rest of the config.
|
||||
Optional. A unique name for the config.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
name: studio-config-v1.0.0_aces-v1.3_ocio-v2.1
|
||||
name: foo_2021-02-01
|
||||
|
||||
|
||||
``search_path``
|
||||
|
||||
@@ -16,9 +16,7 @@ File & Viewing rules
|
||||
``file_rules``
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
.. warning::
|
||||
Either the file_rules section or the default role are Required for configs of
|
||||
version 2 or higher.
|
||||
Either file_rules or the default role are Required.
|
||||
|
||||
Use the File Rules to assign a default color space to files based on their path.
|
||||
|
||||
@@ -26,10 +24,10 @@ Here is example showing the various types of rules that may be defined:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
file_rules:
|
||||
files_rules:
|
||||
- !<Rule> {name: LogC, extension: "*", pattern: "*LogC*", colorspace: ARRI LogC}
|
||||
- !<Rule> {name: OpenEXR, extension: "exr", pattern: "*", colorspace: ACEScg}
|
||||
- !<Rule> {name: TIFF, regex: ".*\\.TIF?F", colorspace: sRGB}
|
||||
- !<Rule> {name: TIFF, regex: ".*\.TIF?F$", colorspace: sRGB}
|
||||
- !<Rule> {name: ColorSpaceNamePathSearch}
|
||||
- !<Rule> {name: Default, colorspace: default}
|
||||
|
||||
@@ -44,41 +42,36 @@ other keys depend on the rule type.
|
||||
This is the basic rule type that uses Unix glob style pattern matching and is
|
||||
thus very easy to use. It contains the keys:
|
||||
|
||||
* ``name``: Name of the rule.
|
||||
* ``name``: Name of the rule
|
||||
* ``pattern``: Glob pattern to be used for the main part of the name/path.
|
||||
This is case-sensitive. It must be in double-quotes. Set it to "*" if you only
|
||||
want the rule to consider the extension.
|
||||
This is case-sensitive.
|
||||
* ``extension``: Glob pattern or string to be used for the file extension. Note that
|
||||
if glob tokens are not used, the extension will be used in a non-case-sensitive
|
||||
way by default. For example the simple string "exr" would match "exr" and "EXR".
|
||||
If you only want to match "exr", use the glob pattern "[e][x][r]". It must be
|
||||
in double-quotes. Set it to "*" if you only want the rule to consider the pattern.
|
||||
If you only want to match "exr", use the glob pattern "[e][x][r]".
|
||||
* ``colorspace``: ColorSpace name to be returned.
|
||||
|
||||
2. RegEx Rules --
|
||||
2. Regex Rules --
|
||||
This is similar to the basic rule but allows additional capabilities for
|
||||
power-users. It contains the keys:
|
||||
|
||||
* ``name``: Name of the rule.
|
||||
* ``regex``: Regular expression to be evaluated. It must be in double-quotes.
|
||||
* ``name``: Name of the rule
|
||||
* ``regex``: Regular expression to be evaluated.
|
||||
* ``colorspace``: ColorSpace name to be returned.
|
||||
|
||||
Note that a backslash character in a RegEx expression needs to be doubled up as ``\\``
|
||||
(as shown in the example above for the TIFF rule) to make it through the Yaml parsing.
|
||||
|
||||
3. OCIO v1 style Rule --
|
||||
This rule allows the use of the OCIO v1 style, where the string is searched for
|
||||
ColorSpace names from the config. This rule may occur 0 or 1 times in the list.
|
||||
The position in the list prioritizes it with respect to the other rules. It has
|
||||
the key:
|
||||
|
||||
* ``name``: Must be ``ColorSpaceNamePathSearch``.
|
||||
* ``name``: Must be "ColorSpaceNamePathSearch".
|
||||
|
||||
4. Default Rule --
|
||||
The file_rules section must always end with this rule. If no prior rules match, this
|
||||
The file_rules must always end with this rule. If no prior rules match, this
|
||||
rule specifies the ColorSpace applications will use. It has the keys:
|
||||
|
||||
* ``name``: must be ``Default``.
|
||||
* ``name``: must be "Default".
|
||||
* ``colorspace``: ColorSpace name to be returned.
|
||||
|
||||
Note: OCIO v1 defined a ``default`` role intended to specify a default color space
|
||||
@@ -91,24 +84,19 @@ missing, an exception will be thrown when loading the config.
|
||||
|
||||
Note that the strictparsing token does not affect the behavior of the File Rules
|
||||
API. In other words, evaluating the rules will always result in a ColorSpace being
|
||||
available to an application. However, the API also allows the application to know
|
||||
available to an application. However, the API alsos allow the application to know
|
||||
which rule was the matching one. So apps that want to work in "strict" mode should
|
||||
first check if strictparsing is true and if so check to see if the matching rule
|
||||
was the Default Rule. If so, it could then notify the user and take whatever action
|
||||
is appropriate. (As an alternative to checking which rule number was matched, the
|
||||
API call ``filepathOnlyMatchesDefaultRule`` may be used instead.)
|
||||
is appropriate.
|
||||
|
||||
Roles may be used rather than ColorSpace names in the rules.
|
||||
|
||||
It is also legal for rules to have additional key:value pairs where the value
|
||||
It is also legal for rules to have additional key:value pairs where the value
|
||||
may be an arbitrary string. The API provides access to getting/setting these
|
||||
additional pairs and will preserve them on a Config read/write. These may be
|
||||
used to define application-specific behavior.
|
||||
|
||||
Note to developers: The older ``parseColorSpaceFromString`` API call is now deprecated
|
||||
and should be replaced with ``getColorSpaceFromFilepath``.
|
||||
|
||||
|
||||
``strictparsing``
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
@@ -119,21 +107,12 @@ Optional. Valid values are ``true`` and ``false``. Default is ``true``
|
||||
|
||||
strictparsing: true
|
||||
|
||||
.. warning::
|
||||
This attribute is from OCIO v1. In OCIO v2, the FileRules system was
|
||||
introduced and so the ``strictparsing`` attribute is less relevant now.
|
||||
The ``parseColorSpaceFromString`` API call is now deprecated and the
|
||||
proper way to obtain this information is ``getColorSpaceFromFilepath``.
|
||||
The FileRules always return a default color space but the API
|
||||
``filepathOnlyMatchesDefaultRule`` may be used by applications that
|
||||
want to take some special action if ``strictparsing`` is true.
|
||||
|
||||
OCIO v1 provided a mechanism for applications to extract the colorspace
|
||||
from a filename (the ``parseColorSpaceFromString`` API method).
|
||||
OCIO provides a mechanism for applications to extract the colorspace
|
||||
from a filename (the ``parseColorSpaceFromString`` API method)
|
||||
|
||||
So for a file like ``example_render_v001_lnf.0001.exr`` it will
|
||||
determine the colorspace ``lnf`` (it being the right-most substring
|
||||
containing a colorspace name).
|
||||
containing a colorspace name)
|
||||
|
||||
However, if the colorspace cannot be determined and ``strictparsing:
|
||||
true``, it will return an empty string.
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user