Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
d2b672f7e7 | ||
|
Cédrik Fuoco
|
7de13fc20a | ||
|
Cédrik Fuoco
|
d4435d33e7 | ||
|
Patrick HodoulandDoug Walker
|
73229d885d | ||
|
Patrick HodoulandRémi Achard
|
2983316028 | ||
|
Patrick HodoulandMichael Dolan
|
f74c1b88a9 | ||
|
Patrick Hodoul
|
14f13c8b4e | ||
|
Patrick Hodoul
|
8fed1b3bc6 | ||
|
|
52faf7449c | ||
|
Patrick Hodoul
|
e1b3ffecdd | ||
|
Patrick HodoulandBo Zhou
|
a8626f8b45 | ||
|
Patrick Hodoul
|
df74525ef9 | ||
|
Patrick Hodoul
|
9b619d837a | ||
|
Patrick Hodoul
|
056b7b0cb0 | ||
|
|
5ef7fe09eb | ||
|
|
9b9819f7d7 | ||
|
Patrick Hodoul
|
ecdc10c458 | ||
|
Patrick Hodoul
|
8dc5f6e52b | ||
|
Patrick Hodoulanddoug-walker
|
eb8e338598 | ||
|
|
d7b41f6c82 | ||
|
Patrick Hodoulanddoug-walker
|
9eb736bd84 | ||
|
Patrick HodoulandRémi Achard
|
0472317713 | ||
|
Patrick HodoulandMichael Dolan
|
7ffd61d5e7 | ||
|
Patrick HodoulandMichael Dolan
|
37349220e7 | ||
|
|
0064973150 | ||
|
Patrick Hodoulanddoug-walker
|
c0a02f3f97 | ||
|
|
267b5d0eaf | ||
|
Patrick Hodoul
|
86d7fb56ab | ||
|
Patrick Hodoul
|
54e5512ca1 | ||
|
Larry GritzandPatrick Hodoul
|
12ee9db34f | ||
|
Larry Gritz
|
67729901c5 | ||
|
Patrick Hodoul
|
0645fdd6b5 | ||
|
Patrick Hodoul
|
33185815e4 | ||
|
Brendan Bolles
|
7067004759 | ||
|
Patrick Hodoul
|
9d964541c1 | ||
|
Patrick Hodoul
|
d46e367f4b | ||
|
Patrick Hodoul
|
5346a5c08b | ||
|
Patrick Hodoul
|
467f90d4ed | ||
|
Patrick Hodoulanddoug-walker
|
f44dc562ed | ||
|
Patrick Hodoul
|
a984c22cb2 | ||
|
Patrick Hodoul
|
229ec9cb3a | ||
|
Patrick Hodoul
|
3ae974a03b | ||
|
Patrick Hodoul
|
066a9ee845 | ||
|
Patrick Hodoulanddoug-walker
|
4508967c09 | ||
|
Patrick HodoulandMichael Dolan
|
544c833115 | ||
|
Patrick HodoulandBrendan Bolles
|
f51291111c | ||
|
Bernard Lefebvre
|
cb5e319d0f |
@@ -7,27 +7,20 @@
|
||||
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:
|
||||
# ---------------------------------------------------------------------------
|
||||
# SonarCloud static analysis
|
||||
# Latest ext packages
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
linux_sonarcloud:
|
||||
name: 'Linux CentOS 7 VFX CY2022 SonarCloud <GCC 9.3.1>'
|
||||
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.
|
||||
@@ -35,13 +28,140 @@ jobs:
|
||||
container:
|
||||
# DockerHub: https://hub.docker.com/u/aswf
|
||||
# Source: https://github.com/AcademySoftwareFoundation/aswf-docker
|
||||
image: aswf/ci-ocio:2022
|
||||
image: aswf/ci-base:${{ matrix.vfx-cy }}
|
||||
strategy:
|
||||
matrix:
|
||||
build: [1, 2, 3, 4, 5, 6]
|
||||
include:
|
||||
# -------------------------------------------------------------------
|
||||
# GCC, VFX CY2020
|
||||
# -------------------------------------------------------------------
|
||||
# C++11, Python 3.7
|
||||
- build: 1
|
||||
build-docs: 'ON'
|
||||
cxx-standard: 11
|
||||
cxx-compiler: g++
|
||||
cc-compiler: gcc
|
||||
compiler-desc: GCC 6.3.1
|
||||
vfx-cy: 2020
|
||||
# C++14
|
||||
- build: 2
|
||||
build-docs: 'OFF'
|
||||
cxx-standard: 14
|
||||
cxx-compiler: g++
|
||||
cc-compiler: gcc
|
||||
compiler-desc: GCC 6.3.1
|
||||
vfx-cy: 2020
|
||||
# -------------------------------------------------------------------
|
||||
# GCC, VFX CY2019
|
||||
# -------------------------------------------------------------------
|
||||
# Python 2.7
|
||||
- build: 3
|
||||
# Doc build requires Python 3
|
||||
build-docs: 'OFF'
|
||||
cxx-standard: 11
|
||||
cxx-compiler: g++
|
||||
cc-compiler: gcc
|
||||
compiler-desc: GCC 6.3.1
|
||||
vfx-cy: 2019
|
||||
# -------------------------------------------------------------------
|
||||
# Clang, VFX CY2020
|
||||
# -------------------------------------------------------------------
|
||||
# C++11, Python 3.7
|
||||
- build: 4
|
||||
build-docs: 'OFF'
|
||||
cxx-standard: 11
|
||||
cxx-compiler: clang++
|
||||
cc-compiler: clang
|
||||
compiler-desc: Clang 7
|
||||
vfx-cy: 2020
|
||||
# C++14
|
||||
- build: 5
|
||||
build-docs: 'OFF'
|
||||
cxx-standard: 14
|
||||
cxx-compiler: clang++
|
||||
cc-compiler: clang
|
||||
compiler-desc: Clang 7
|
||||
vfx-cy: 2020
|
||||
# -------------------------------------------------------------------
|
||||
# Clang, VFX CY2019
|
||||
# -------------------------------------------------------------------
|
||||
# Python 2.7
|
||||
- build: 6
|
||||
# Doc build requires Python 3
|
||||
build-docs: 'OFF'
|
||||
cxx-standard: 11
|
||||
cxx-compiler: clang++
|
||||
cc-compiler: clang
|
||||
compiler-desc: Clang 7
|
||||
vfx-cy: 2019
|
||||
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_oiio.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_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
|
||||
working-directory: _build
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# SonarCloud static analysis
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
linux_sonarcloud:
|
||||
name: 'Linux CentOS 7 VFX CY2020 SonarCloud <GCC 6.3.1>'
|
||||
# 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-ocio:2020
|
||||
env:
|
||||
CXX: g++
|
||||
CC: gcc
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
fetch-depth: 50
|
||||
- name: Install docs env
|
||||
@@ -57,7 +177,7 @@ jobs:
|
||||
cmake ../. \
|
||||
-DCMAKE_INSTALL_PREFIX=../_install \
|
||||
-DCMAKE_BUILD_TYPE=Release \
|
||||
-DCMAKE_CXX_STANDARD=14 \
|
||||
-DCMAKE_CXX_STANDARD=11 \
|
||||
-DCMAKE_CXX_FLAGS="-g -O0 -fprofile-arcs -ftest-coverage" \
|
||||
-DCMAKE_CXX_OUTPUT_EXTENSION_REPLACE=ON \
|
||||
-DCMAKE_EXE_LINKER_FLAGS="-lgcov" \
|
||||
@@ -71,7 +191,7 @@ jobs:
|
||||
run: build-wrapper-linux-x86-64 --out-dir bw_output make clean all
|
||||
working-directory: _build
|
||||
- name: Test
|
||||
run: ctest -V -C Release
|
||||
run: ctest -V
|
||||
working-directory: _build
|
||||
- name: Generate code coverage report
|
||||
run: share/ci/scripts/linux/run_gcov.sh
|
||||
|
||||
+229
-336
@@ -44,14 +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 }}>'
|
||||
# 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
|
||||
docs=${{ matrix.build-docs }}>'
|
||||
# GH-hosted VM. The build runs in CentOS 7 'container' defined below.
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
@@ -63,179 +58,182 @@ jobs:
|
||||
build: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]
|
||||
include:
|
||||
# -------------------------------------------------------------------
|
||||
# VFX CY2023 (Python 3.10)
|
||||
# VFX CY2021
|
||||
# -------------------------------------------------------------------
|
||||
- build: 12
|
||||
build-type: Debug
|
||||
build-shared: 'ON'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'ON'
|
||||
use-simd: 'ON'
|
||||
use-oiio: 'ON'
|
||||
build-gpu: 'OFF'
|
||||
use-headless: 'OFF'
|
||||
use-sse: 'OFF'
|
||||
cxx-standard: 17
|
||||
cxx-compiler: clang++
|
||||
cc-compiler: clang
|
||||
compiler-desc: Clang
|
||||
vfx-cy: 2023
|
||||
install-ext-packages: MISSING
|
||||
compiler-desc: Clang 9
|
||||
vfx-cy: 2021
|
||||
- build: 11
|
||||
build-type: Release
|
||||
build-shared: 'ON'
|
||||
build-docs: 'ON'
|
||||
build-openfx: 'ON'
|
||||
use-simd: 'OFF'
|
||||
use-oiio: 'OFF'
|
||||
build-docs: 'OFF'
|
||||
build-gpu: 'OFF'
|
||||
use-headless: 'OFF'
|
||||
use-sse: 'ON'
|
||||
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: 2021
|
||||
# -------------------------------------------------------------------
|
||||
# GCC, VFX CY2020
|
||||
# -------------------------------------------------------------------
|
||||
# C++11, Python 3.7
|
||||
- build: 10
|
||||
build-type: Release
|
||||
build-shared: 'OFF'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'OFF'
|
||||
use-simd: 'ON'
|
||||
use-oiio: 'OFF'
|
||||
build-shared: 'ON'
|
||||
build-docs: 'ON'
|
||||
build-gpu: 'OFF'
|
||||
use-headless: 'OFF'
|
||||
use-sse: 'ON'
|
||||
cxx-standard: 11
|
||||
cxx-compiler: g++
|
||||
cc-compiler: gcc
|
||||
compiler-desc: GCC
|
||||
vfx-cy: 2023
|
||||
install-ext-packages: ALL
|
||||
# -------------------------------------------------------------------
|
||||
# VFX CY2022 (Python 3.9)
|
||||
# -------------------------------------------------------------------
|
||||
compiler-desc: GCC 6.3.1
|
||||
vfx-cy: 2020
|
||||
# Debug
|
||||
- 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
|
||||
vfx-cy: 2022
|
||||
install-ext-packages: ALL
|
||||
build-gpu: 'OFF'
|
||||
use-headless: 'OFF'
|
||||
use-sse: 'ON'
|
||||
cxx-standard: 11
|
||||
cxx-compiler: g++
|
||||
cc-compiler: gcc
|
||||
compiler-desc: GCC 6.3.1
|
||||
vfx-cy: 2020
|
||||
# C++14
|
||||
- build: 8
|
||||
build-type: Release
|
||||
build-shared: 'ON'
|
||||
build-docs: 'ON'
|
||||
build-openfx: 'ON'
|
||||
use-simd: 'OFF'
|
||||
use-oiio: 'OFF'
|
||||
cxx-standard: 17
|
||||
build-docs: 'OFF'
|
||||
build-gpu: 'OFF'
|
||||
use-headless: 'OFF'
|
||||
use-sse: 'ON'
|
||||
cxx-standard: 14
|
||||
cxx-compiler: g++
|
||||
cc-compiler: gcc
|
||||
compiler-desc: GCC
|
||||
vfx-cy: 2022
|
||||
install-ext-packages: MISSING
|
||||
compiler-desc: GCC 6.3.1
|
||||
vfx-cy: 2020
|
||||
# Static, no SSE
|
||||
- build: 7
|
||||
build-type: Release
|
||||
build-shared: 'OFF'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'OFF'
|
||||
use-simd: 'ON'
|
||||
use-oiio: 'OFF'
|
||||
build-gpu: 'OFF'
|
||||
use-headless: 'OFF'
|
||||
use-sse: 'OFF'
|
||||
cxx-standard: 11
|
||||
cxx-compiler: g++
|
||||
cc-compiler: gcc
|
||||
compiler-desc: GCC
|
||||
vfx-cy: 2022
|
||||
install-ext-packages: ALL
|
||||
compiler-desc: GCC 6.3.1
|
||||
vfx-cy: 2020
|
||||
# -------------------------------------------------------------------
|
||||
# VFX CY2021 (Python 3.7)
|
||||
# GCC, VFX CY2019
|
||||
# -------------------------------------------------------------------
|
||||
# Python 2.7
|
||||
- build: 6
|
||||
build-type: Release
|
||||
build-shared: 'ON'
|
||||
# Doc build requires Python 3
|
||||
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-gpu: 'OFF'
|
||||
use-headless: 'OFF'
|
||||
use-sse: 'ON'
|
||||
cxx-standard: 11
|
||||
cxx-compiler: g++
|
||||
cc-compiler: gcc
|
||||
compiler-desc: GCC 6.3.1
|
||||
vfx-cy: 2019
|
||||
# -------------------------------------------------------------------
|
||||
# Clang, VFX CY2020
|
||||
# -------------------------------------------------------------------
|
||||
# C++11, Python 3.7
|
||||
- build: 5
|
||||
build-type: Release
|
||||
build-shared: 'OFF'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'ON'
|
||||
use-simd: 'OFF'
|
||||
use-oiio: 'OFF'
|
||||
cxx-standard: 14
|
||||
build-shared: 'ON'
|
||||
build-docs: 'ON'
|
||||
build-gpu: 'OFF'
|
||||
use-headless: 'OFF'
|
||||
use-sse: 'ON'
|
||||
cxx-standard: 11
|
||||
cxx-compiler: clang++
|
||||
cc-compiler: clang
|
||||
compiler-desc: Clang
|
||||
vfx-cy: 2021
|
||||
install-ext-packages: ALL
|
||||
compiler-desc: Clang 7
|
||||
vfx-cy: 2020
|
||||
# Debug
|
||||
- build: 4
|
||||
build-type: Debug
|
||||
build-shared: 'ON'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'OFF'
|
||||
use-simd: 'ON'
|
||||
use-oiio: 'OFF'
|
||||
build-gpu: 'OFF'
|
||||
build-headless: 'OFF'
|
||||
use-sse: 'ON'
|
||||
cxx-standard: 11
|
||||
cxx-compiler: g++
|
||||
cc-compiler: gcc
|
||||
compiler-desc: GCC
|
||||
vfx-cy: 2021
|
||||
install-ext-packages: ALL
|
||||
# -------------------------------------------------------------------
|
||||
# VFX CY2020 (Python 3.7)
|
||||
# -------------------------------------------------------------------
|
||||
cxx-compiler: clang++
|
||||
cc-compiler: clang
|
||||
compiler-desc: Clang 7
|
||||
vfx-cy: 2020
|
||||
# C++14
|
||||
- build: 3
|
||||
build-type: Release
|
||||
build-shared: 'ON'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'ON'
|
||||
use-simd: 'OFF'
|
||||
use-oiio: 'OFF'
|
||||
build-gpu: 'OFF'
|
||||
use-headless: 'OFF'
|
||||
use-sse: 'ON'
|
||||
cxx-standard: 14
|
||||
cxx-compiler: clang++
|
||||
cc-compiler: clang
|
||||
compiler-desc: Clang
|
||||
compiler-desc: Clang 7
|
||||
vfx-cy: 2020
|
||||
install-ext-packages: MISSING
|
||||
# Static, no SSE
|
||||
- build: 2
|
||||
build-type: Debug
|
||||
build-type: Release
|
||||
build-shared: 'OFF'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'ON'
|
||||
use-simd: 'ON'
|
||||
use-oiio: 'ON'
|
||||
cxx-standard: 14
|
||||
cxx-compiler: g++
|
||||
cc-compiler: gcc
|
||||
compiler-desc: GCC
|
||||
build-gpu: 'OFF'
|
||||
use-headless: 'OFF'
|
||||
use-sse: 'OFF'
|
||||
cxx-standard: 11
|
||||
cxx-compiler: clang++
|
||||
cc-compiler: clang
|
||||
compiler-desc: Clang 7
|
||||
vfx-cy: 2020
|
||||
install-ext-packages: ALL
|
||||
# -------------------------------------------------------------------
|
||||
# Clang, VFX CY2019
|
||||
# -------------------------------------------------------------------
|
||||
# Python 2.7
|
||||
- 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-gpu: 'OFF'
|
||||
use-headless: 'OFF'
|
||||
use-sse: 'ON'
|
||||
cxx-standard: 11
|
||||
cxx-compiler: g++
|
||||
cc-compiler: gcc
|
||||
compiler-desc: GCC
|
||||
vfx-cy: 2020
|
||||
install-ext-packages: ALL
|
||||
cxx-compiler: clang++
|
||||
cc-compiler: clang
|
||||
compiler-desc: Clang 7
|
||||
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'
|
||||
@@ -253,11 +251,10 @@ jobs:
|
||||
-DCMAKE_CXX_STANDARD=${{ matrix.cxx-standard }} \
|
||||
-DBUILD_SHARED_LIBS=${{ matrix.build-shared }} \
|
||||
-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_BUILD_GPU_TESTS=${{ matrix.build-gpu }} \
|
||||
-DOCIO_USE_HEADLESS=${{ matrix.use-headless }} \
|
||||
-DOCIO_USE_SSE=${{ matrix.use-sse }} \
|
||||
-DOCIO_INSTALL_EXT_PACKAGES=ALL \
|
||||
-DOCIO_WARNING_AS_ERROR=ON \
|
||||
-DPython_EXECUTABLE=$(which python)
|
||||
working-directory: _build
|
||||
@@ -267,132 +264,98 @@ 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 }}
|
||||
run: ctest -V
|
||||
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
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 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}}>'
|
||||
# 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
|
||||
docs=${{ matrix.build-docs }}>'
|
||||
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
|
||||
- build: 6
|
||||
build-type: Release
|
||||
build-shared: 'ON'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'ON'
|
||||
use-simd: 'ON'
|
||||
use-oiio: 'ON'
|
||||
build-gpu: 'OFF'
|
||||
use-headless: 'OFF'
|
||||
use-sse: 'ON'
|
||||
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.7
|
||||
# Static, no SSE
|
||||
# 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'
|
||||
build-gpu: 'OFF'
|
||||
use-headless: 'OFF'
|
||||
use-sse: 'ON'
|
||||
cxx-standard: 11
|
||||
python-version: '3.10'
|
||||
- build: 2
|
||||
arch-type: "x86_64"
|
||||
python-version: 3.7
|
||||
# Debug
|
||||
- build: 4
|
||||
build-type: Debug
|
||||
build-shared: 'ON'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'ON'
|
||||
use-simd: 'ON'
|
||||
use-oiio: 'OFF'
|
||||
build-gpu: 'OFF'
|
||||
use-headless: 'OFF'
|
||||
use-sse: 'ON'
|
||||
cxx-standard: 11
|
||||
python-version: '3.9'
|
||||
- build: 1
|
||||
arch-type: "x86_64"
|
||||
python-version: 3.7
|
||||
# C++14
|
||||
- build: 3
|
||||
build-type: Release
|
||||
build-shared: 'ON'
|
||||
build-docs: 'OFF'
|
||||
build-gpu: 'OFF'
|
||||
use-headless: 'OFF'
|
||||
use-sse: '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-gpu: 'OFF'
|
||||
use-headless: 'OFF'
|
||||
use-sse: '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-gpu: 'OFF'
|
||||
use-headless: 'OFF'
|
||||
use-sse: 'ON'
|
||||
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'
|
||||
@@ -410,14 +373,12 @@ jobs:
|
||||
-DCMAKE_CXX_STANDARD=${{ matrix.cxx-standard }} \
|
||||
-DBUILD_SHARED_LIBS=${{ matrix.build-shared }} \
|
||||
-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_BUILD_GPU_TESTS=${{ matrix.build-gpu }} \
|
||||
-DOCIO_USE_HEADLESS=${{ matrix.use-headless }} \
|
||||
-DOCIO_USE_SSE=${{ matrix.use-sse }} \
|
||||
-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,49 +386,10 @@ 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 }}
|
||||
run: ctest -V
|
||||
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
|
||||
@@ -477,77 +399,92 @@ 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 }}>'
|
||||
# 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
|
||||
docs=${{ matrix.build-docs }}>'
|
||||
runs-on: windows-2019
|
||||
strategy:
|
||||
matrix:
|
||||
build: [1, 2, 3, 4]
|
||||
build: [1, 2, 3, 4, 5, 6]
|
||||
include:
|
||||
- build: 4
|
||||
# C++17
|
||||
- build: 6
|
||||
build-type: Release
|
||||
build-shared: 'ON'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'ON'
|
||||
use-simd: 'OFF'
|
||||
use-oiio: 'ON'
|
||||
build-gpu: 'OFF'
|
||||
use-headless: 'OFF'
|
||||
use-sse: 'ON'
|
||||
cxx-standard: 17
|
||||
python-version: '3.11'
|
||||
- build: 3
|
||||
python-version: 3.7
|
||||
# C++11, Python 3.7
|
||||
- build: 5
|
||||
build-type: Release
|
||||
build-shared: 'OFF'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'OFF'
|
||||
use-simd: 'ON'
|
||||
use-oiio: 'OFF'
|
||||
build-shared: 'ON'
|
||||
build-docs: 'ON'
|
||||
build-gpu: 'OFF'
|
||||
use-headless: 'OFF'
|
||||
use-sse: 'ON'
|
||||
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'
|
||||
build-gpu: 'OFF'
|
||||
use-headless: 'OFF'
|
||||
use-sse: 'ON'
|
||||
cxx-standard: 11
|
||||
python-version: '3.8'
|
||||
# C++14, OpenEXR, OpenFX
|
||||
- build: 1
|
||||
python-version: 3.7
|
||||
# C++14
|
||||
- build: 3
|
||||
build-type: Release
|
||||
build-shared: 'ON'
|
||||
build-docs: 'OFF'
|
||||
build-openfx: 'ON'
|
||||
use-simd: 'ON'
|
||||
use-oiio: 'OFF'
|
||||
build-gpu: 'OFF'
|
||||
use-headless: 'OFF'
|
||||
use-sse: 'ON'
|
||||
cxx-standard: 14
|
||||
python-version: '3.7'
|
||||
python-version: 3.7
|
||||
# Static, no SSE
|
||||
- build: 2
|
||||
build-type: Release
|
||||
build-shared: 'OFF'
|
||||
build-docs: 'OFF'
|
||||
build-gpu: 'OFF'
|
||||
use-headless: 'OFF'
|
||||
use-sse: '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-gpu: 'OFF'
|
||||
use-headless: 'OFF'
|
||||
use-sse: 'ON'
|
||||
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
|
||||
run: share/ci/scripts/windows/install_tests_env.sh
|
||||
shell: bash
|
||||
- name: Create build directories
|
||||
run: |
|
||||
mkdir _install
|
||||
@@ -562,10 +499,9 @@ jobs:
|
||||
-DCMAKE_GENERATOR_PLATFORM=x64 \
|
||||
-DBUILD_SHARED_LIBS=${{ matrix.build-shared }} \
|
||||
-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_BUILD_GPU_TESTS=${{ matrix.build-gpu }} \
|
||||
-DOCIO_USE_HEADLESS=${{ matrix.use-headless }} \
|
||||
-DOCIO_USE_SSE=${{ matrix.use-sse }} \
|
||||
-DOCIO_INSTALL_EXT_PACKAGES=ALL \
|
||||
-DOCIO_WARNING_AS_ERROR=ON \
|
||||
-DPython_EXECUTABLE=$(which python)
|
||||
@@ -576,52 +512,9 @@ 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 }}
|
||||
run: ctest -V
|
||||
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
|
||||
|
||||
@@ -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
|
||||
@@ -25,7 +25,7 @@ jobs:
|
||||
linux_gpu:
|
||||
name: 'Linux CentOS 7 VFX CY2020 GPU <GCC 6.3.1>'
|
||||
# Don't run on OCIO forks
|
||||
if: github.repository == 'AcademySoftwareFoundation/OpenColorIO'
|
||||
if: github.event.push.repository.full_name == 'AcademySoftwareFoundation/OpenColorIO'
|
||||
# GH-hosted VM. The build runs in CentOS 7 'container' hard-coded in
|
||||
# AWS CodeBuild project.
|
||||
# TODO: Add support for dynamic GH Action defined CodeBuild
|
||||
@@ -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
|
||||
@@ -1,329 +0,0 @@
|
||||
# SPDX-License-Identifier: BSD-3-Clause
|
||||
# Copyright Contributors to the OpenColorIO Project.
|
||||
#
|
||||
|
||||
name: Wheel
|
||||
|
||||
on:
|
||||
push:
|
||||
# Workflow run on tags for v2 only.
|
||||
tags:
|
||||
- v2.*
|
||||
pull_request:
|
||||
# Workflow run on pull_request only when related files change.
|
||||
branches-ignore:
|
||||
- RB-0.*
|
||||
- RB-1.*
|
||||
- gh-pages
|
||||
tags-ignore:
|
||||
- v0.*
|
||||
- v1.*
|
||||
paths:
|
||||
- .github/workflows/wheel_workflow.yml
|
||||
- MANIFEST.in
|
||||
- pyproject.toml
|
||||
- setup.cfg
|
||||
- setup.py
|
||||
schedule:
|
||||
# Nightly build
|
||||
- cron: "0 0 * * *"
|
||||
|
||||
jobs:
|
||||
# Linux jobs run in Docker containers (manylinux), so the latest OS version
|
||||
# is OK. macOS and Windows jobs need to be locked to specific virtual
|
||||
# environment versions to mitigate issues from OS updates, and will require
|
||||
# maintenance as OS versions are retired.
|
||||
#
|
||||
# Due to documentation build failing on manylinux2010 (maybe too old doxygen
|
||||
# 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:
|
||||
name: Build wheels on Linux
|
||||
runs-on: ubuntu-latest
|
||||
# Don't run on OCIO forks
|
||||
if: |
|
||||
github.event_name != 'schedule' ||
|
||||
github.repository == 'AcademySoftwareFoundation/OpenColorIO'
|
||||
strategy:
|
||||
matrix:
|
||||
include:
|
||||
# -------------------------------------------------------------------
|
||||
# CPython 64 bits manylinux_2_28
|
||||
# -------------------------------------------------------------------
|
||||
- build: CPython 3.7 64 bits manylinux_2_28
|
||||
manylinux: manylinux_2_28
|
||||
python: cp37-manylinux*
|
||||
arch: x86_64
|
||||
- build: CPython 3.8 64 bits manylinux_2_28
|
||||
manylinux: manylinux_2_28
|
||||
python: cp38-manylinux*
|
||||
arch: x86_64
|
||||
- build: CPython 3.9 64 bits manylinux_2_28
|
||||
manylinux: manylinux_2_28
|
||||
python: cp39-manylinux*
|
||||
arch: x86_64
|
||||
- build: CPython 3.10 64 bits manylinux_2_28
|
||||
manylinux: manylinux_2_28
|
||||
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
|
||||
# -------------------------------------------------------------------
|
||||
- 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
|
||||
python: cp37-manylinux*
|
||||
arch: aarch64
|
||||
- build: CPython 3.8 ARM 64 bits manylinux2014
|
||||
manylinux: manylinux2014
|
||||
python: cp38-manylinux*
|
||||
arch: aarch64
|
||||
- build: CPython 3.9 ARM 64 bits manylinux2014
|
||||
manylinux: manylinux2014
|
||||
python: cp39-manylinux*
|
||||
arch: aarch64
|
||||
- build: CPython 3.10 ARM 64 bits manylinux2014
|
||||
manylinux: manylinux2014
|
||||
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/setup-python@v4
|
||||
name: Install Python
|
||||
with:
|
||||
python-version: '3.8'
|
||||
|
||||
- name: Set up QEMU
|
||||
uses: docker/setup-qemu-action@v2
|
||||
with:
|
||||
platforms: all
|
||||
|
||||
- name: Build wheels
|
||||
uses: pypa/cibuildwheel@v2.16.2
|
||||
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
|
||||
with:
|
||||
path: ./wheelhouse/*.whl
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# macOS Wheels
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
macos:
|
||||
name: Build wheels on macOS
|
||||
runs-on: macos-12
|
||||
# Don't run on OCIO forks
|
||||
if: |
|
||||
github.event_name != 'schedule' ||
|
||||
github.repository == 'AcademySoftwareFoundation/OpenColorIO'
|
||||
strategy:
|
||||
matrix:
|
||||
include:
|
||||
# -------------------------------------------------------------------
|
||||
# CPython 64 bits
|
||||
# -------------------------------------------------------------------
|
||||
- build: CPython 3.7 64 bits
|
||||
python: cp37-*
|
||||
arch: x86_64
|
||||
- build: CPython 3.8 64 bits
|
||||
python: cp38-*
|
||||
arch: x86_64
|
||||
- build: CPython 3.9 64 bits
|
||||
python: cp39-*
|
||||
arch: x86_64
|
||||
- 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
|
||||
- build: CPython 3.9 ARM 64 bits
|
||||
python: cp39-*
|
||||
arch: arm64
|
||||
- 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
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- uses: actions/setup-python@v4
|
||||
name: Install Python
|
||||
with:
|
||||
python-version: '3.8'
|
||||
|
||||
- name: Build wheels
|
||||
uses: pypa/cibuildwheel@v2.16.2
|
||||
env:
|
||||
CIBW_BUILD: ${{ matrix.python }}
|
||||
CIBW_ARCHS: ${{ matrix.arch }}
|
||||
|
||||
- uses: actions/upload-artifact@v3
|
||||
with:
|
||||
path: ./wheelhouse/*.whl
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Windows Wheels
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
windows:
|
||||
name: Build wheels on Windows
|
||||
runs-on: windows-2022
|
||||
# Don't run on OCIO forks
|
||||
if: |
|
||||
github.event_name != 'schedule' ||
|
||||
github.repository == 'AcademySoftwareFoundation/OpenColorIO'
|
||||
strategy:
|
||||
matrix:
|
||||
include:
|
||||
# -------------------------------------------------------------------
|
||||
# CPython 64 bits
|
||||
# -------------------------------------------------------------------
|
||||
- build: CPython 3.7 64 bits
|
||||
python: cp37-*
|
||||
arch: AMD64
|
||||
- build: CPython 3.8 64 bits
|
||||
python: cp38-*
|
||||
arch: AMD64
|
||||
- build: CPython 3.9 64 bits
|
||||
python: cp39-*
|
||||
arch: AMD64
|
||||
- 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/setup-python@v4
|
||||
name: Install Python
|
||||
with:
|
||||
python-version: '3.8'
|
||||
|
||||
- name: Build wheels
|
||||
uses: pypa/cibuildwheel@v2.16.2
|
||||
env:
|
||||
CIBW_BUILD: ${{ matrix.python }}
|
||||
CIBW_ARCHS: ${{ matrix.arch }}
|
||||
|
||||
- uses: actions/upload-artifact@v3
|
||||
with:
|
||||
path: ./wheelhouse/*.whl
|
||||
|
||||
|
||||
upload_pypi:
|
||||
needs: [sdist, 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/download-artifact@v3
|
||||
with:
|
||||
name: artifact
|
||||
path: dist
|
||||
|
||||
- uses: pypa/gh-action-pypi-publish@release/v1
|
||||
with:
|
||||
user: __token__
|
||||
password: ${{ secrets.PYPI_API_TOKEN }}
|
||||
+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;
|
||||
|
||||
@@ -1,124 +0,0 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
<!-- Copyright Contributors to the OpenColorIO Project. -->
|
||||
|
||||
# OpenColorIO Google Summer of Code 2021
|
||||
|
||||
OpenColorIO (OCIO) is a complete color management solution geared towards
|
||||
motion picture production with an emphasis on visual effects and computer
|
||||
animation. OCIO provides a straightforward and consistent user experience
|
||||
across all supporting applications while allowing for sophisticated back-end
|
||||
configuration options suitable for high-end production usage. OCIO is compatible
|
||||
with the Academy Color Encoding Specification (ACES) and is LUT-format agnostic,
|
||||
supporting many popular formats.
|
||||
|
||||
OpenColorIO version 1.0 was released in 2011, having been in development since
|
||||
2003. OCIO v1 represented the culmination of years of production experience
|
||||
earned on such films as SpiderMan 2 (2004), Surf’s Up (2007), Cloudy with a
|
||||
Chance of Meatballs (2009), Alice in Wonderland (2010), and many more.
|
||||
OpenColorIO v2 has been in development since 2017 and was feature complete as of
|
||||
SIGGRAPH 2020. After a stabilization and bug-fixing period, an official 2.0.0
|
||||
release was made in January 2021!
|
||||
|
||||
While OCIO is a color management library (written in C++ with a Python API),
|
||||
its only knowledge of color science comes from its execution of the transforms
|
||||
defined in the OCIO configuration file, written in YAML. These transforms are
|
||||
either defined by the end user in a custom OCIO config or inherited from the
|
||||
publicly available configs. By specifying your desired config file in the local
|
||||
environment all OCIO compatible applications and software libraries will be able
|
||||
to see your defined color transform “universe”. You can then direct the
|
||||
transformation of image data from one defined OCIO Color Space to another, in
|
||||
addition to the other transforms documented elsewhere - the options are endless!
|
||||
|
||||
## About the Academy Software Foundation
|
||||
|
||||
The Academy Software Foundation (ASWF) is collaboration between the Linux
|
||||
Foundation and the Academy of Motion Picture Arts and Sciences, serving as
|
||||
an umbrella organization that is the home to several key open source
|
||||
software projects used by the film industry (primarily visual effects and
|
||||
animation production). The projects we manage are some of the most
|
||||
high-profile and widely used open source projects originating and used in
|
||||
film production studios. It's a great opportunity for students to get
|
||||
involved with projects that will be used professionally on films!
|
||||
|
||||
The mission of the ASWF is to increase the quality and quantity of
|
||||
contributions to the content creation industry's open source software base;
|
||||
to provide a neutral forum to coordinate cross-project efforts; to provide a
|
||||
common build and test infrastructure; and to provide individuals and
|
||||
organizations a clear path to participation in advancing our open source
|
||||
ecosystem.
|
||||
|
||||
In 2020, the ASWF projects OpenEXR, OpenTimelineIO, and OpenCue mentored
|
||||
GSoC students. This year, OpenColorIO is the ASWF project that looks forward
|
||||
to welcoming and mentoring GSoC students.
|
||||
|
||||
## Application Instructions for Students
|
||||
|
||||
Please review the CONTRIBUTING guidelines thoroughly before applying. OCIO
|
||||
maintains a contributor license agreement (CLA) which must be signed to
|
||||
accept contributions.
|
||||
|
||||
**Successfully submitting a Pull Request to the OCIO project is a strict**
|
||||
**requirement prior to submitting an application.**
|
||||
This is not negotiable. We will not even read applications from students who
|
||||
have not submitted an acceptable PR to the project. It can be a truly minimal
|
||||
change -- for example, fixing a typo in an error message. You will find issues
|
||||
tagged "good first issue" on our GitHub repo, which are ideal candidates for
|
||||
your small trial PR to qualify for application.
|
||||
|
||||
## Application template
|
||||
|
||||
Please use this application template. Feel free to expand or tell us any other
|
||||
relevant details, but this is a good place to start. The applications will be
|
||||
judged by representatives of the OCIO technical steering comittee.
|
||||
|
||||
* Student name:
|
||||
* School / year / area of study:
|
||||
* Relevant courses, materials studied, jobs, programming projects, skills, other
|
||||
open source projects you've contributed to. Go ahead and tell us anything about
|
||||
your background that you think we will find interesting for our projects.
|
||||
* Project proposal - please explain in detail and give specifics on acceptance
|
||||
criteria -- how we can measure your success, how we can test your code. Provide
|
||||
a weekly timeline for expected progress.
|
||||
* Please tell us which test PR you had merged into the OCIO repo:
|
||||
|
||||
## Project information and suggested ideas list
|
||||
|
||||
Home page: https://opencolorio.org/ <br>
|
||||
GitHub: https://github.com/AcademySoftwareFoundation/OpenColorIO <br>
|
||||
Skills/knowledge relevant to the project: C++11, CMake, color science
|
||||
|
||||
Mentor suggestions: Patrick Hodoul, Doug Walker, Michael Dolan
|
||||
|
||||
## Project Ideas:
|
||||
|
||||
**Add OCIO support to FFmpeg or another FOSS project**
|
||||
An important effort for OCIO is expanding the libraries and applications where
|
||||
OCIO is implemented. Users have specifically called out FFmpeg as a library and
|
||||
command-line tool where they would like to see OCIO support, but any other FOSS
|
||||
project leveraged by digital artists or production pipelines could be considered.
|
||||
This could also include upgrading an existing implementation to support the OCIO
|
||||
v2 API and leverage new functionality.
|
||||
Special skills: Familiarity with prospective host library or tool, and knowledge
|
||||
of working with image buffers and authoring plugins.
|
||||
|
||||
**OpenFX Plugin Development**
|
||||
OCIO currently has a number of plug-ins in the GitHub repo for proprietary
|
||||
application interfaces. (And in several cases, these have become out of sync
|
||||
with the actual plug-ins shipped by vendors.) It would be great to have OpenFX
|
||||
plug-ins in the repo. These would have the benefit of bringing OCIO support to
|
||||
a wider range of applications. Furthermore, the existing plug-ins are all based
|
||||
on OCIO v1, the new OpenFX plug-ins would be the perfect place to showcase the
|
||||
new OCIO v2 features.
|
||||
Special skills: Access to a host application that supports OpenFX plug-ins and
|
||||
ability to build the basic demo plug-ins in the OpenFX SDK.
|
||||
|
||||
**Add support for more ICC profile structures**
|
||||
OCIO currently supports basic ICC monitor profiles. These are the type that
|
||||
are most often set as monitor profiles on Mac and Windows. But it would be nice
|
||||
for OCIO to be able to read and convert some of the more advanced ICC profile
|
||||
structures such as the A2B* and B2A* tags. There are some monitor profiles that
|
||||
use these tags to implement gamut mapping. OCIO already has operators to support
|
||||
the most common usage of these tags, so the project is simply about importing a
|
||||
profile into existing OCIO operators. It would not be a goal of this project to
|
||||
import structures that don’t already have an OCIO equivalent, such as
|
||||
4-dimensional tables.
|
||||
@@ -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
|
||||
|
||||
@@ -1,159 +0,0 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
<!-- Copyright Contributors to the OpenColorIO Project. -->
|
||||
|
||||
January 18, 2021
|
||||
|
||||
Host: Michael Dolan
|
||||
|
||||
Attendees:
|
||||
* [X] Mark Boorer (_TSC_) - Industrial Light & Magic
|
||||
* [ ] Mei Chu (_TSC_) - Sony Pictures Imageworks
|
||||
* [X] Sean Cooper (_TSC ACES TAC Rep_) - ARRI
|
||||
* [X] Michael Dolan (_TSC Chair_) - Epic Games
|
||||
* [X] Patrick Hodoul (_TSC_) - Autodesk
|
||||
* [ ] John Mertic - Academy Software Foundation / Linux Foundation
|
||||
* [X] Carol Payne (_TSC_) - Netflix
|
||||
* [X] Mark Titchener (_TSC_) - Foundry
|
||||
* [X] Carl Rand (_TSC_) - Weta Digital
|
||||
* [X] Doug Walker (_TSC Chief Architect_) - Autodesk
|
||||
* [X] Kevin Wheatley (_TSC_) - Framestore
|
||||
* [X] Bernard Lefebvre - Autodesk
|
||||
|
||||
Apologies:
|
||||
* Mei Chu
|
||||
|
||||
# **OCIO TSC Meeting Notes**
|
||||
|
||||
* Doug to summarize in-progress work:
|
||||
- Doug: Number of PRs landing this week. Bug fixes in Python bindings, etc.
|
||||
No new features. Small but appreciate quick turn around.
|
||||
|
||||
* Any volunteers to help get the OpenFX plug-ins compiling (PR #1232)?
|
||||
- Doug: Contributor needs help with compilation and loading in OFX
|
||||
compliant app. Doesn't need help writing plugins, just initial step of
|
||||
getting it built.
|
||||
- Michael: Currently is swapping code into a Resolve plugin example I
|
||||
believe.
|
||||
- Carol: Is there more we can do to help people get up and running with
|
||||
OCIO? Many new developers are struggling to get up and running. Not sure
|
||||
what the issue is.
|
||||
- Doug: Valid point. Heard similar feedback from ACES community too. Not
|
||||
all those trying to build OCIO are necessarily developers.
|
||||
- Sean: Might be lack of familiarity with C++ build env.
|
||||
- Carol: Could link to some CMake help for getting started, etc.
|
||||
- Sean: After release, when we get into other package envs, those
|
||||
complaints will go away.
|
||||
- Michael: I brought this up in the last CI working group. Pushed for
|
||||
making one of the goals this year to work on standardized package manager
|
||||
support across ASWF projects.
|
||||
- Mark T: He had example plugins building. I talked to him about some of
|
||||
that. Is able to build examples now, but not able to build his plugin.
|
||||
- Michael: We can do zoom to help support if needed.
|
||||
|
||||
* VFX Reference Platform 2.0.x -> 2.x:
|
||||
- Michael: I reached out to the platform working group and the TAC about
|
||||
the change and got good feedback. OpenVDB has always had a variable minor
|
||||
version, but has to be handled carefully. Stance from VFX ref platform is
|
||||
that a CY version range must be ABI compatible.
|
||||
- Doug: Challenge is we may want to do 2.x release that breaks ABI
|
||||
compatibility. Lots of things could break it.
|
||||
- Michael: Can do minor version ranges in platform, if we could commit to
|
||||
certain minor versions being ABI compatible.
|
||||
- Doug: Anyone rememberer when tetrahedral interpolation was added to
|
||||
OCIO v1? Did that break ABI compatibility?
|
||||
- Kevin: It didn't quite. Was able to put binary from Nuke into Mari and
|
||||
it worked.
|
||||
- Patrick: Can add enum, but add at end.
|
||||
- Doug: Risk is committing to all 2.x not breaking ABI.
|
||||
- Patrick: Need to say that for next 9 months, no change will break ABI
|
||||
compatibility. Since v2 is first being used, challenge to say that.
|
||||
- Carol: Have not done enough testing to be confident.
|
||||
- Michael: Semver doesn't explicitly say ABI compatibility, but sort of
|
||||
implies it in minor version changes being backwards compatible. That
|
||||
would impact the decision too.
|
||||
- Patrick: We will have to change API.
|
||||
- Carol: Might be 6 months before we see v2 release with Nuke.
|
||||
- Mark T: Yes, taking longer than we hoped. also delay getting into
|
||||
production once it's in DCCs.
|
||||
- Michael: Suggest we back out changes if we're not confident in adhering
|
||||
to the rule.
|
||||
- Doug: Will need to be 2.0.1 as bug fix, and then eventually 2.1.
|
||||
- Carol: Can push bigger changes to CY2022.
|
||||
- Mark B: Don't forsee needing to use these new features at facility scale
|
||||
in 2021. Not a huge deal if VFX ref misses some of those minor features.
|
||||
- Michael: We're currently missing builtin transforms needed for the ACES
|
||||
config. Would we need to resort to LUTs to get that out?
|
||||
- Doug: Can do like was pasted in Slack a while back, building the output
|
||||
transforms in the config.
|
||||
- Michael: Any performance cost? Or since builtin transform just builds ops
|
||||
directly, is it about the same?
|
||||
- Doug: Shouldn't be. Have not tested yet.
|
||||
- Michael: Complicates config build script a bit. ACES 1.3 can wait, but we
|
||||
will need output transforms.
|
||||
- Kevin: How many releases could we have this year? How many versions on
|
||||
active support? Committing to support VFX ref platform. Minor versions
|
||||
could be more to support. Tradeoff of not locking ref platform down.
|
||||
- Mark B: Could add broken endpoints for features we're planning to add.
|
||||
Then API won't change.
|
||||
- Michael: Good idea. I have seen other libraries do that. Let's continue
|
||||
this discussion in the config wg meeting tomorrow. I will followup with
|
||||
platform working group after that.
|
||||
|
||||
* Release plan discussion for 2.0.0:
|
||||
- Doug: Would like to do 2.0.0 release next week, Monday or Tuesday. Minor
|
||||
PRs in this week to merge quickly.
|
||||
|
||||
* Issues, Built-in Transform, Documentation, or other “must haves” for 2.0.0:
|
||||
- Doug: If there are things people feel are must haves, want to get them on
|
||||
table. Bernard working on issues. Not currently working on reported
|
||||
OpenEXR 2.5 CMake issue.
|
||||
- **TODO**: Michael will roll back OIIO find module to resolve that
|
||||
issue for now.
|
||||
|
||||
* Ociocheck behavior for missing roles:
|
||||
- Doug: ociocheck looks for known set of roles. If they are missing it
|
||||
prints error message. Added new roles to OCIO v2, so was going to add
|
||||
them to OCIO check, but they aren't mandatory. some of the roles it is
|
||||
currently complaining about don't seem mandatory. Propose changing
|
||||
message to warning instead of error.
|
||||
- Kevin: Difference in behavior with new roles. They are required in
|
||||
certain circumstances. Without matte_paint role config will work. Would
|
||||
like a strict check that validates as an error. Agree on some other roles
|
||||
being warnings though.
|
||||
- Sean: Core roles could be hard coded in DCCs and know that those exist.
|
||||
More for DCC/API compatibility. With newer v2.0 features, can question
|
||||
whether they are necessary.
|
||||
|
||||
* Should inactive color spaces be included by parseColorSpaceFromString?
|
||||
- Doug: Inactive spaces won't be in menus. Should we parse inactive color
|
||||
spaces from strings?
|
||||
- Kevin: I think so. Useful for loading historical color spaces. Like to be
|
||||
able to load file on disk.
|
||||
- Mark, Sean: Agree. Good to load them still if it's defined.
|
||||
|
||||
* Scope of image IO support for app refactor (to remove OpenImageIO dependency):
|
||||
- Michael: I've been building simple image interface to load EXRs for apps.
|
||||
OpenEXR is a broad interface though, with many types of files. Should we
|
||||
support them all? Or limit it since the apps only operate on RGBA?
|
||||
- Mark B: Think we can keep the OIIO dependency. If needed can change how
|
||||
they are built, with apps in another repo, or a separate CMake build.
|
||||
- Kevin: Package managers would prefer library and tools separate.
|
||||
- Mark B: That's what debian and brew do.
|
||||
- Patrick: Agree not a huge problem, but falls in problem category. Two
|
||||
types of commandline tools. Helpers and apps like ociodisplay, which are
|
||||
useful for development. Moving tools for external users outside could be
|
||||
good. But ocioperf less convinced. ocioperf would be ok only having
|
||||
OpenEXR format. Tool we really need OIIO for is ociodisplay.
|
||||
- Group agrees to continue discussion next week and in GH issue. Leaning
|
||||
toward keeping OIIO dependency and implementing one of Mark's
|
||||
suggestions.
|
||||
|
||||
* ASWF 2020 CCLA 2.1 transition:
|
||||
- Sean: What would the timeline by for this change? 6 months?
|
||||
- Michael: I talked to John and it sounds like we can get the new CCLA
|
||||
signed before we switch and then switch it over once we know there will
|
||||
be no disruption to contributions. Will follow up more on this next week.
|
||||
|
||||
* Items for next TSC meeting agenda:
|
||||
- Removing apps from repo or main build.
|
||||
- ASWF 2020 CCLA 2.1 transition plan.
|
||||
@@ -1,87 +0,0 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
<!-- Copyright Contributors to the OpenColorIO Project. -->
|
||||
|
||||
February 8, 2021
|
||||
|
||||
Host: Michael Dolan
|
||||
|
||||
Attendees:
|
||||
* [X] Mark Boorer (_TSC_) - Industrial Light & Magic
|
||||
* [X] Mei Chu (_TSC_) - Sony Pictures Imageworks
|
||||
* [ ] Sean Cooper (_TSC ACES TAC Rep_) - ARRI
|
||||
* [X] Michael Dolan (_TSC Chair_) - Epic Games
|
||||
* [X] Patrick Hodoul (_TSC_) - Autodesk
|
||||
* [ ] John Mertic - Academy Software Foundation / Linux Foundation
|
||||
* [X] Carol Payne (_TSC_) - Netflix
|
||||
* [X] Mark Titchener (_TSC_) - Foundry
|
||||
* [ ] Carl Rand (_TSC_) - Weta Digital
|
||||
* [X] Doug Walker (_TSC Chief Architect_) - Autodesk
|
||||
* [X] Kevin Wheatley (_TSC_) - Framestore
|
||||
* [X] Rémi Achard - DNEG
|
||||
* [X] Thomas Mansencal - Weta Digital
|
||||
* [X] Matthias Scharfenberg - Industrial Light & Magic
|
||||
* [X] J Schulte - Industrial Light & Magic
|
||||
|
||||
# **OCIO TSC Meeting Notes**
|
||||
|
||||
* Several pending pull requests: some are Python reviews, but most of them are
|
||||
meeting minute reviews.
|
||||
- Patrick: Few PRs awaiting review. Not C++ changes - meeting minutes,
|
||||
Python, etc.
|
||||
- Carol: There's a website PR ready for review too. I will take a look at
|
||||
that.
|
||||
- Michael: Noting some issues reported related to v2, which means it's
|
||||
being used and tested. I've been testing it and love the new config
|
||||
features. Being able to build configs without external files is great.
|
||||
- Patrick: Doug and I are investigating the issues. Big thanks to Doug for
|
||||
the config improvements. *clap*
|
||||
- Kevin: Using pre-release of v2 and encountered a bug while baking to
|
||||
Resolve cube with ociobakelut. Known issue? Asking to bake 3D cube, but
|
||||
resulted in 1d cube. I will investigate further.
|
||||
|
||||
* GSoC/D&I internships:
|
||||
- Carol: Put doc in TSC channel. Two projects - ffmpeg support, and OFX
|
||||
plugins:
|
||||
https://docs.google.com/document/d/1sa68Cjq0TzSYFg2xhf2w2FFAQ1In7G391iINWKXfDo8/edit?usp=sharing
|
||||
- Carol: Going to ask community for more ideas, and for more mentor
|
||||
volunteers this week. End of this week needs to go to Larry. Think we're
|
||||
the only ones submitting to GSoC this year.
|
||||
- Michael: Quick mention that there's a new ASWF working group forming
|
||||
around topic of Rust bindings for VFX OSS libs. Sounds like a group of
|
||||
developers interested in working on this for several projects. First need
|
||||
to make C bindings.
|
||||
- Mark B: Talked about OCIO C bindings a while ago. Complex due to use
|
||||
of shared pointers everywhere.
|
||||
- Patrick: Earlier we discussed the idea of going back and making OCIO a C
|
||||
lib with header only C++ bindings. Too late now, but interesting topic.
|
||||
|
||||
* Static builds - cmake export:
|
||||
- Mark B: Problems with static builds when deploying on Windows. Looking at
|
||||
fixing a number of CMake issues and improving 3rd party lib builds.
|
||||
Improving debug and release builds too. PR will have a lot of changes,
|
||||
but only to CMake. Hoping to open PR this week. Also noting some issues
|
||||
with the way unit tests are linked which could be improved later. Tests
|
||||
don't use same targets as lib, so must rebuild code.
|
||||
- Patrick: Unit tests need private part of some files, so needed in some
|
||||
places. Even if CMake is platform agnostic, have to deal with Windows
|
||||
specific stuff. Often seems slightly broken on Windows platform.
|
||||
- Mark: Big one for me was debug. CMake build type variable doesn't work on
|
||||
all platforms. Default setup on Windows uses VS solutions, which support
|
||||
multiple targets. Since on Windows release and debug libs can't be mixed,
|
||||
current setup can be problematic.
|
||||
|
||||
* Locale issue:
|
||||
- Patrick: Working on OCIO v2 integration in Maya. Facing locale issue -
|
||||
numeric separator handling. We discussed this earlier, but will need to
|
||||
resume conversation.
|
||||
- Mark B: Parsing LUT files with locale wrong can cause read issues.
|
||||
Probably want correct locale when reading yaml files, but one consistent
|
||||
locale when reading LUTs.
|
||||
- Patrick: Previous Turkish locale bug was related to upper to lower case
|
||||
conversion (PR #984). I agree that numeric parsing should be locked to
|
||||
decimal points.
|
||||
- Doug: Lib is quite dependent on lowercase conversions. Could argue not
|
||||
needed, but for backward compatibility might have to keep it.
|
||||
|
||||
* Items for next TSC meeting agenda:
|
||||
- Absent next week: Patrick, Michael. Doug will be present and host.
|
||||
@@ -5,12 +5,12 @@ DATE
|
||||
|
||||
Host: NAME (Michael Dolan?)
|
||||
|
||||
Secretary: NAME
|
||||
Rotating Secretary: NAME
|
||||
|
||||
Attendees:
|
||||
* [ ] Mark Boorer (_TSC_) - Industrial Light & Magic
|
||||
* [ ] Mei Chu (_TSC_) - Sony Pictures Imageworks
|
||||
* [ ] Sean Cooper (_TSC ACES TAC Rep_) - ARRI
|
||||
* [ ] Sean Cooper (_TSC ACES TAC Rep_) - DNEG
|
||||
* [ ] Michael Dolan (_TSC Chair_) - Epic Games
|
||||
* [ ] Patrick Hodoul (_TSC_) - Autodesk
|
||||
* [ ] John Mertic - Academy Software Foundation / Linux Foundation
|
||||
@@ -36,3 +36,5 @@ Apologies:
|
||||
|
||||
* Items for next TSC meeting agenda:
|
||||
- xxx
|
||||
|
||||
|
||||
|
||||
@@ -1,107 +0,0 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
<!-- Copyright Contributors to the OpenColorIO Project. -->
|
||||
|
||||
January 19, 2021
|
||||
|
||||
Host: Michael Dolan
|
||||
|
||||
Attendees:
|
||||
* [X] Mark Boorer (_TSC_) - Industrial Light & Magic
|
||||
* [X] Michael Dolan (_TSC Chair_) - Epic Games
|
||||
* [X] Carol Payne (_TSC_) - Netflix
|
||||
* [X] Doug Walker (_TSC Chief Architect_) - Autodesk
|
||||
* [X] Dennis Adams - Sony
|
||||
* [X] Christophe Brejon
|
||||
* [X] Zach Lewis - Method
|
||||
* [X] Scott Dyer - A.M.P.A.S.
|
||||
* [X] Sean Cooper (_TSC_) - ARRI
|
||||
* [X] Kevin Wheatley (_TSC_) - Framestore
|
||||
|
||||
Apologies:
|
||||
* Thomas Mansencal
|
||||
|
||||
# **OCIO Configs Working Group Meeting Notes**
|
||||
|
||||
* Include skeleton API for missing building transforms in v2.0.0? Need to make
|
||||
call on CY2021 ABI compatibility for VFX ref platform. If not may need to
|
||||
expose transform internals in config:
|
||||
- Michael: Following up from TSC meeting discussion. Options put on the
|
||||
table: Add stubs for missing transforms? Switch to a minor version range
|
||||
in CY2021?
|
||||
- Decision: Back out of requested VFX ref platform change. Stick with 2.0.x
|
||||
for CY2021 and move forward with any needed minor version updates
|
||||
throughout the year. ACES 1.3 support won't arrive until CY2022, and the
|
||||
ACES config will use verbose color space definitions instead of Builtin
|
||||
transforms in some places, but in performance and functionality will be
|
||||
equivalent. We will attempt to maintain ABI compatibility for initial
|
||||
minor version releases for users who want to drop newer versions into
|
||||
CY2021 DCCs. There are some algorithms (e.g. PQ) that need to be added to
|
||||
core lib to support LUT-free ACES config. AD will submit PR with these
|
||||
additions this week for the v2.0.0 release next week.
|
||||
- Other proposed plans would have worked, but the group determined it
|
||||
would be better to strictly follow semver and not make a rash
|
||||
decision based solely on getting the changes into VFX ref platform.
|
||||
As Sean put it: "Feels like the cart driving the horse". The agreed
|
||||
upon resolution permits completion of the ACES reference
|
||||
(and studio) configs and gives us a year to polish the v2 features
|
||||
for CY2022. DCCs likely won't have v2 support until near mid year
|
||||
anyway, and studios will likely delay further beyond that.
|
||||
|
||||
* Make decision on config generation code direction:
|
||||
- Michael: Propose we stick with current code in repo. Refinements can be
|
||||
contributed via PR if needed.
|
||||
- Mark and group: Go for it.
|
||||
- Sean: Will there be artifacts via CI? Biggest buffer to people not caring
|
||||
about code.
|
||||
- Mark: Discussed artifacts and versioning earlier. Still plan to provide
|
||||
artifacts.
|
||||
- Michael: Yes, Thomas add CI setup which can be extended to support that.
|
||||
|
||||
* Spreadsheet questions ACES feedback:
|
||||
- Michael: Open questions are related to inclusion of ACESproxy and the
|
||||
DCDM output transforms. Scott suggested they not be included by email,
|
||||
but we can discuss here to confirm a decision.
|
||||
- Carol: Get rid of them if ACES doesn't want them.
|
||||
- Scott: Better way to do DCDM than the transforms. Leave them out.
|
||||
- Michael: Same about ACESproxy?
|
||||
- Doug: Clipped integer version of ACEScc. Not sure why needed in OCIO.
|
||||
- Scott: Not sure of many using ACESproxy at all.
|
||||
- Group agrees to exclude these. Set to "excluded" in spreadsheet.
|
||||
- Carol: In first version, get people to speak up if they miss it.
|
||||
- Michael: Anything else?
|
||||
- Sean: Why only Sony Venice included?
|
||||
- Doug: Other Sony transforms in CSC section further up.
|
||||
- Carol: There isn't CSC of new Sony Venice IDTs yet.
|
||||
|
||||
* Un-tonemapped view naming:
|
||||
- Doug: Discussion about needing another view (un-tone-mapped) in config.
|
||||
Trying to come up with name: Source colors, scene referred colors,
|
||||
textures, colorimetry, colorimetric view, un-ton-mapped, no tone-map,
|
||||
identity tone-map, identity view, 1:1, flat...
|
||||
- Decision: Group agrees on "un-tone-mapped" since it is explicit and
|
||||
clear. It may be confusing to users not familiar with color science, but
|
||||
it is better to have something clear to config authors, and a good
|
||||
learning opportunity for others. Also the term used by ACES.
|
||||
|
||||
* Review of ACES Output Transform prototype:
|
||||
- Doug demos how to implement output transform with current OCIO v2 state.
|
||||
Breaking down transforms needed to create ODT, which in the future will
|
||||
be defined in a builtin transform via C++.
|
||||
- Doug: Clamps around ACES primary change prevent negative values from
|
||||
becoming large positives due to matrix. In testing that, noticed that
|
||||
some ACES output transforms generate black in unexpected places. Tested
|
||||
synthetic chart with camera log space. Values going through power
|
||||
function to infinity. Builtin functions for CSC log transforms will send
|
||||
large input values (outside 0-1) to infinity on output. Is that ok? Or
|
||||
should we clamp to large positive value? Often implemented with LUTs
|
||||
where infinity won't occur. Implemented here with LogCameraTransform, so
|
||||
exact math. Value greater than one could give infinity.
|
||||
- Mark: Think infinity fine in that context. Doing the right thing.
|
||||
- Doug: Downside is for synthetic chart image, with RGB inf,inf,inf one
|
||||
channel will become negative and get mapped to NaN (Inf - Inf) when going
|
||||
through a matrix. Since NaN typically maps to zero, it's possible that
|
||||
extremely bright values map to black on display.
|
||||
- Mark: Don't think would be problem. The formula should do what it does.
|
||||
We understand floating point limitations and are used to hitting them,
|
||||
so not crazy to expect same behavior here. Would be weird to do something
|
||||
different.
|
||||
@@ -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.
|
||||
|
||||
+2
-8
@@ -1,14 +1,8 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
<!-- Copyright Contributors to the OpenColorIO Project. -->
|
||||
|
||||
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 2.0.0 (unreleased):**
|
||||
* Renamed sanityCheck() method to validate()
|
||||
|
||||
**Version 1.1.1 (April 2 2019):**
|
||||
* Added optional compatibility for building apps with OpenImageIO 1.9+
|
||||
|
||||
+18
-245
@@ -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.0.5
|
||||
DESCRIPTION "OpenColorIO (OCIO) is a complete color management solution"
|
||||
HOMEPAGE_URL https://github.com/AcademySoftwareFoundation/OpenColorIO
|
||||
LANGUAGES CXX C)
|
||||
@@ -37,26 +36,13 @@ project(OpenColorIO
|
||||
# "dev", "beta1", rc1", etc or "" for an official release.
|
||||
set(OpenColorIO_VERSION_RELEASE_TYPE "")
|
||||
|
||||
|
||||
###############################################################################
|
||||
# ctest
|
||||
|
||||
# To correctly generate the DartConfiguration.tcl, include the CTest CMake file.
|
||||
# By doing so 'ctest -F memcheck' works.
|
||||
include (CTest)
|
||||
|
||||
enable_testing()
|
||||
|
||||
|
||||
###############################################################################
|
||||
# Provides install directory variables as defined by the GNU Coding Standards.
|
||||
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 +81,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?
|
||||
|
||||
@@ -138,7 +109,6 @@ include(CppVersion)
|
||||
|
||||
option(BUILD_SHARED_LIBS "Set to OFF to build static libraries" ON)
|
||||
option(OCIO_BUILD_APPS "Set to OFF to disable command-line apps" ON)
|
||||
option(OCIO_BUILD_OPENFX "Specify whether to build OpenFX plugins" OFF)
|
||||
option(OCIO_BUILD_NUKE "Specify whether to build nuke plugins" OFF)
|
||||
option(OCIO_BUILD_TESTS "Specify whether to build unittests" ON)
|
||||
option(OCIO_BUILD_GPU_TESTS "Specify whether to build gpu unittests" ON)
|
||||
@@ -153,196 +123,27 @@ 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()
|
||||
|
||||
|
||||
###############################################################################
|
||||
# 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)
|
||||
|
||||
|
||||
###############################################################################
|
||||
# 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 +187,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 +231,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
|
||||
@@ -454,10 +246,11 @@ include(FindExtPackages)
|
||||
|
||||
add_subdirectory(vendor)
|
||||
if(OCIO_BUILD_DOCS)
|
||||
add_subdirectory(docs)
|
||||
add_subdirectory(docs)
|
||||
endif()
|
||||
add_subdirectory(tests)
|
||||
add_subdirectory(src)
|
||||
add_subdirectory(include)
|
||||
add_subdirectory(ext)
|
||||
|
||||
|
||||
@@ -470,10 +263,10 @@ 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/)
|
||||
INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/share/ocio/${OCIO_SETUP_NAME} DESTINATION share/ocio/)
|
||||
|
||||
|
||||
###############################################################################
|
||||
@@ -484,11 +277,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,24 +302,6 @@ 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.
|
||||
|
||||
+2
-5
@@ -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
|
||||
* Sean Cooper - DNEG
|
||||
* Michael Dolan - Epic Games
|
||||
* Patrick Hodoul - Autodesk
|
||||
* Zach Lewis - Method Studios
|
||||
* Thomas Mansencal - WetaFX
|
||||
* Carol Payne - Netflix
|
||||
* Carl Rand - Weta Digital
|
||||
* Mark Titchener - Foundry
|
||||
|
||||
-11
@@ -1,11 +0,0 @@
|
||||
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
|
||||
+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
|
||||
|
||||
@@ -10,7 +10,6 @@ OpenColorIO
|
||||
[](https://github.com/AcademySoftwareFoundation/OpenColorIO/actions?query=workflow%3AAnalysis)
|
||||
[](https://sonarcloud.io/dashboard?id=AcademySoftwareFoundation_OpenColorIO)
|
||||
[](https://bestpractices.coreinfrastructure.org/projects/2612)
|
||||
[](https://github.com/AcademySoftwareFoundation/OpenColorIO/actions?query=workflow%3AWheel)
|
||||
|
||||
Introduction
|
||||
------------
|
||||
@@ -29,16 +28,16 @@ configuration options suitable for high-end production usage. OCIO is
|
||||
compatible with the Academy Color Encoding Specification (ACES) and is
|
||||
LUT-format agnostic, supporting many popular formats.
|
||||
|
||||
OpenColorIO is released as version 2.0 and has been in development since 2003.
|
||||
OpenColorIO is released as version 1.0 and has been in development since 2003.
|
||||
OCIO represents the culmination of years of production experience earned on
|
||||
such films as SpiderMan 2 (2004), Surf's Up (2007), Cloudy with a Chance of
|
||||
Meatballs (2009), Alice in Wonderland (2010), and many more. OpenColorIO is
|
||||
natively supported in commercial applications like Katana, Mari, Nuke, Maya,
|
||||
Houdini, Silhouette FX, and
|
||||
[others](https://opencolorio.org/#supported_apps).
|
||||
[others](https://opencolorio.org/CompatibleSoftware.html).
|
||||
|
||||
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 +49,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 +64,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 +98,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
-66
@@ -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
|
||||
|
||||
@@ -166,70 +192,4 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
---------------------------------------------------------------------
|
||||
|
||||
OpenFX Support Library, courtesy of The Open Effects Association Ltd.
|
||||
http://openeffects.org/
|
||||
|
||||
Software License :
|
||||
|
||||
Copyright (c) 2004-2007, The Open Effects Association Ltd. All rights reserved.
|
||||
|
||||
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.
|
||||
* Neither the name The Open Effects Association Ltd, nor the names of its
|
||||
contributors may be used to endorse or promote products derived from this
|
||||
software without specific prior written permission.
|
||||
|
||||
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 OWNER 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.
|
||||
|
||||
The Open Effects Association Ltd
|
||||
1 Wardour St
|
||||
London W1D 6PA
|
||||
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.
|
||||
|
||||
+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.
|
||||
@@ -32,6 +32,7 @@
|
||||
:value: <Allocation.ALLOCATION_UNKNOWN: 0>
|
||||
|
||||
|
||||
.. py:property:: Allocation.value
|
||||
.. py:method:: Allocation.value
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
@@ -19,6 +19,12 @@
|
||||
2. __init__(self: PyOpenColorIO.AllocationTransform, allocation: PyOpenColorIO.Allocation = <Allocation.ALLOCATION_UNIFORM: 1>, vars: List[float] = [], direction: PyOpenColorIO.TransformDirection = <TransformDirection.TRANSFORM_DIR_FORWARD: 0>) -> None
|
||||
|
||||
|
||||
.. py:method:: AllocationTransform.__str__()
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Return str(self).
|
||||
|
||||
|
||||
.. py:method:: AllocationTransform.getAllocation(self: PyOpenColorIO.AllocationTransform) -> PyOpenColorIO.Allocation
|
||||
: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 :
|
||||
|
||||
@@ -76,6 +76,7 @@
|
||||
:value: <BitDepth.BIT_DEPTH_UNKNOWN: 0>
|
||||
|
||||
|
||||
.. py:property:: BitDepth.value
|
||||
.. py:method:: BitDepth.value
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
@@ -19,6 +19,12 @@
|
||||
2. __init__(self: PyOpenColorIO.BuiltinTransform, style: str = 'IDENTITY', direction: PyOpenColorIO.TransformDirection = <TransformDirection.TRANSFORM_DIR_FORWARD: 0>) -> None
|
||||
|
||||
|
||||
.. py:method:: BuiltinTransform.__str__()
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Return str(self).
|
||||
|
||||
|
||||
.. py:method:: BuiltinTransform.getDescription(self: PyOpenColorIO.BuiltinTransform) -> str
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -32,6 +32,7 @@
|
||||
:value: <CDLStyle.CDL_NO_CLAMP: 1>
|
||||
|
||||
|
||||
.. py:property:: CDLStyle.value
|
||||
.. py:method:: CDLStyle.value
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
@@ -8,10 +8,6 @@
|
||||
|
||||
An implementation of the ASC Color Decision List (CDL), based on the ASC v1.2 specification.
|
||||
|
||||
**ASC_SOP**
|
||||
|
||||
Slope, offset, power:: out = clamp( (in * slope) + offset ) ^ power
|
||||
|
||||
.. note::
|
||||
If the config version is 1, negative values are clamped if the power is not 1.0. For config version 2 and higher, the negative handling is controlled by the CDL style.
|
||||
|
||||
@@ -22,6 +18,7 @@
|
||||
|
||||
Load the CDL from the src .cdl, .cc, or .ccc file.
|
||||
|
||||
|
||||
.. note::
|
||||
The cccid can be the ID of a CDL or the index of the CDL (as string). If cccid is NULL or empty the first CDL is returned. The cccid is case-sensitive. The src must be an absolute path reference, no relative directory or envvar resolution is performed. Throws if file does not contain any CDL or if the specified cccid is not found.
|
||||
|
||||
@@ -32,6 +29,7 @@
|
||||
|
||||
Load all of the CDLs in a .cdl or .ccc file into a single :ref:`GroupTransform`.
|
||||
|
||||
|
||||
.. note::
|
||||
This may be useful as a quicker way for applications to check the contents of each of the CDLs. The src must be an absolute path reference, no relative directory or envvar resolution is performed.
|
||||
|
||||
@@ -48,6 +46,12 @@
|
||||
3. __init__(self: PyOpenColorIO.CDLTransform, slope: List[float[3]] = [1.0, 1.0, 1.0], offset: List[float[3]] = [0.0, 0.0, 0.0], power: List[float[3]] = [1.0, 1.0, 1.0], sat: float = 1.0, id: str = '', description: str = '', direction: PyOpenColorIO.TransformDirection = <TransformDirection.TRANSFORM_DIR_FORWARD: 0>) -> None
|
||||
|
||||
|
||||
.. py:method:: CDLTransform.__str__()
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Return str(self).
|
||||
|
||||
|
||||
.. py:method:: CDLTransform.equals(self: PyOpenColorIO.CDLTransform, other: PyOpenColorIO.CDLTransform) -> bool
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -48,6 +48,7 @@
|
||||
:value: <ChannelOrdering.CHANNEL_ORDERING_RGBA: 0>
|
||||
|
||||
|
||||
.. py:property:: ChannelOrdering.value
|
||||
.. py:method:: ChannelOrdering.value
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
@@ -6,10 +6,6 @@
|
||||
.. py:class:: ColorSpace
|
||||
:module: PyOpenColorIO
|
||||
|
||||
The *:ref:`ColorSpace`* is the state of an image with respect to colorimetry and color encoding. Transforming images between different *ColorSpaces* is the primary motivation for this library.
|
||||
|
||||
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).
|
||||
|
||||
|
||||
.. py:method:: ColorSpace.__init__(*args, **kwargs)
|
||||
:module: PyOpenColorIO
|
||||
@@ -34,6 +30,7 @@
|
||||
|
||||
Add a single category.
|
||||
|
||||
|
||||
.. note::
|
||||
Will do nothing if the category already exists.
|
||||
|
||||
@@ -55,10 +52,6 @@
|
||||
.. py:method:: ColorSpace.getAllocation(self: PyOpenColorIO.ColorSpace) -> PyOpenColorIO.Allocation
|
||||
:module: PyOpenColorIO
|
||||
|
||||
*Allocation*
|
||||
|
||||
If this colorspace needs to be transferred to a limited dynamic range coding space (such as during display with a GPU path), use this allocation to maximize bit efficiency.
|
||||
|
||||
|
||||
.. py:method:: ColorSpace.getAllocationVars(self: PyOpenColorIO.ColorSpace) -> List[float]
|
||||
:module: PyOpenColorIO
|
||||
@@ -79,23 +72,11 @@
|
||||
.. py:method:: ColorSpace.getEncoding(self: PyOpenColorIO.ColorSpace) -> str
|
||||
:module: PyOpenColorIO
|
||||
|
||||
*Encodings*
|
||||
|
||||
It is sometimes useful for applications to group color spaces based on how the color values are digitally encoded. For example, images in scene-linear, logarithmic, video, and data color spaces could have different default views. Unlike the Family and EqualityGroup attributes of a color space, the list of Encodings is predefined in the OCIO documentation (rather than being config-specific) to make it easier for applications to utilize.
|
||||
|
||||
Here is an example config entry that could appear under a :ref:`ColorSpace`:
|
||||
|
||||
.. code-block:: cpp
|
||||
|
||||
encoding: scene-linear
|
||||
|
||||
Encoding strings are not case-sensitive. Although users may add their own encodings, the strings will typically come from a fixed set listed in the documentation (similar to roles).
|
||||
|
||||
|
||||
.. 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
|
||||
@@ -117,8 +98,6 @@
|
||||
.. py:method:: ColorSpace.getTransform(self: PyOpenColorIO.ColorSpace, direction: PyOpenColorIO.ColorSpaceDirection) -> PyOpenColorIO.Transform
|
||||
:module: PyOpenColorIO
|
||||
|
||||
*:ref:`Transform`*
|
||||
|
||||
If a transform in the specified direction has been specified, return it. Otherwise return a null ConstTransformRcPtr
|
||||
|
||||
|
||||
@@ -127,31 +106,10 @@
|
||||
|
||||
Return true if the category is present.
|
||||
|
||||
A category is used to allow applications to filter the list of color spaces they display in menus based on what that color space is used for.
|
||||
|
||||
Here is an example config entry that could appear under a :ref:`ColorSpace`:
|
||||
|
||||
.. code-block:: cpp
|
||||
|
||||
categories: [ file-io, working-space, basic-3d ]
|
||||
|
||||
The example contains three categories: 'file-io', 'working-space' and 'basic-3d'.
|
||||
|
||||
.. note::
|
||||
Category strings are not case-sensitive and the order is not significant.
|
||||
|
||||
There is no limit imposed on length or number. Although users may add their own categories, the strings will typically come from a fixed set listed in the documentation (similar to roles).
|
||||
|
||||
|
||||
.. py:method:: ColorSpace.isData(self: PyOpenColorIO.ColorSpace) -> bool
|
||||
:module: PyOpenColorIO
|
||||
|
||||
*Data*
|
||||
|
||||
ColorSpaces that are data are treated a bit special. Basically, any colorspace transforms you try to apply to them are ignored. (Think of applying a gamut mapping transform to an ID pass). However, the setDataBypass method on :ref:`ColorSpaceTransform` and :ref:`DisplayViewTransform` allow applications to process data when necessary. (Think of sending mattes to an HDR monitor.)
|
||||
|
||||
This is traditionally used for pixel data that represents non-color pixel data, such as normals, point positions, ID information, etc.
|
||||
|
||||
|
||||
.. py:method:: ColorSpace.removeAlias(self: PyOpenColorIO.ColorSpace, alias: str) -> None
|
||||
:module: PyOpenColorIO
|
||||
@@ -164,6 +122,7 @@
|
||||
|
||||
Remove a category.
|
||||
|
||||
|
||||
.. note::
|
||||
Will do nothing if the category is missing.
|
||||
|
||||
|
||||
@@ -25,6 +25,7 @@
|
||||
:value: <ColorSpaceDirection.COLORSPACE_DIR_TO_REFERENCE: 0>
|
||||
|
||||
|
||||
.. py:property:: ColorSpaceDirection.value
|
||||
.. py:method:: ColorSpaceDirection.value
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
@@ -6,10 +6,10 @@
|
||||
.. py:class:: ColorSpaceSet
|
||||
:module: PyOpenColorIO
|
||||
|
||||
The *:ref:`ColorSpaceSet`* is a set of color spaces (i.e. no color space duplication) which could be the result of :ref:`Config::getColorSpaces` or built from scratch.
|
||||
The *:ref:`ColorSpaceSet`* is a set of color spaces (i.e. no color space duplication) which could be the result of :cpp:func:`:ref:`Config::getColorSpaces`` or built from scratch.
|
||||
|
||||
.. note::
|
||||
The color spaces are decoupled from the config ones, i.e., any changes to the set itself or to its color spaces do not affect the original color spaces from the configuration. If needed, use :ref:`Config::addColorSpace` to update the configuration.
|
||||
The color spaces are decoupled from the config ones, i.e., any changes to the set itself or to its color spaces do not affect the original color spaces from the configuration. If needed, use :cpp:func:`:ref:`Config::addColorSpace`` to update the configuration.
|
||||
|
||||
|
||||
.. py:method:: ColorSpaceSet.__and__(self: PyOpenColorIO.ColorSpaceSet, arg0: PyOpenColorIO.ColorSpaceSet) -> PyOpenColorIO.ColorSpaceSet
|
||||
@@ -17,6 +17,7 @@
|
||||
|
||||
Perform the intersection of two sets.
|
||||
|
||||
|
||||
.. note::
|
||||
This function provides operations on two color space sets where the result contains copied color spaces and no duplicates.
|
||||
|
||||
@@ -29,6 +30,7 @@
|
||||
|
||||
Return true if the two sets are equal.
|
||||
|
||||
|
||||
.. note::
|
||||
The comparison is done on the color space names (not a deep comparison).
|
||||
|
||||
@@ -50,6 +52,7 @@
|
||||
|
||||
Perform the union of two sets.
|
||||
|
||||
|
||||
.. note::
|
||||
This function provides operations on two color space sets where the result contains copied color spaces and no duplicates.
|
||||
|
||||
@@ -62,6 +65,7 @@
|
||||
|
||||
Perform the difference of two sets.
|
||||
|
||||
|
||||
.. note::
|
||||
This function provides operations on two color space sets where the result contains copied color spaces and no duplicates.
|
||||
|
||||
@@ -74,6 +78,7 @@
|
||||
|
||||
Add color space(s).
|
||||
|
||||
|
||||
.. note::
|
||||
If another color space is already registered with the same name, this will overwrite it. This stores a copy of the specified color space(s). Throws if one of the aliases is already assigned as a name or alias to an existing color space.
|
||||
|
||||
@@ -110,6 +115,7 @@
|
||||
|
||||
Remove color space(s) using color space names (i.e. no role name).
|
||||
|
||||
|
||||
.. note::
|
||||
The removal of a missing color space does nothing.
|
||||
|
||||
|
||||
@@ -17,6 +17,12 @@
|
||||
2. __init__(self: PyOpenColorIO.ColorSpaceTransform, src: str = '', dst: str = '', direction: PyOpenColorIO.TransformDirection = <TransformDirection.TRANSFORM_DIR_FORWARD: 0>, dataBypass: bool = True) -> None
|
||||
|
||||
|
||||
.. py:method:: ColorSpaceTransform.__str__()
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Return str(self).
|
||||
|
||||
|
||||
.. py:method:: ColorSpaceTransform.getDataBypass(self: PyOpenColorIO.ColorSpaceTransform) -> bool
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -32,6 +32,7 @@
|
||||
:value: <ColorSpaceVisibility.COLORSPACE_INACTIVE: 1>
|
||||
|
||||
|
||||
.. py:property:: ColorSpaceVisibility.value
|
||||
.. py:method:: ColorSpaceVisibility.value
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
@@ -6,55 +6,6 @@
|
||||
.. py:class:: Config
|
||||
:module: PyOpenColorIO
|
||||
|
||||
A config defines all the color spaces to be available at runtime.
|
||||
|
||||
The color configuration (:ref:`Config`) is the main object for interacting with this library. It encapsulates all of the information necessary to use customized :ref:`ColorSpaceTransform` and :ref:`DisplayViewTransform` operations.
|
||||
|
||||
See the user-guide for more information on selecting, creating, and working with custom color configurations.
|
||||
|
||||
For applications interested in using only one color config at a time (this is the vast majority of apps), their API would traditionally get the global configuration and use that, as opposed to creating a new one. This simplifies the use case for plugins and bindings, as it alleviates the need to pass around configuration handles.
|
||||
|
||||
An example of an application where this would not be sufficient would be a multi-threaded image proxy server (daemon), which wished to handle multiple show configurations in a single process concurrently. This app would need to keep multiple configurations alive, and to manage them appropriately.
|
||||
|
||||
Roughly speaking, a novice user should select a default configuration that most closely approximates the use case (animation, visual effects, etc.), and set the :envvar:`OCIO` environment variable to point at the root of that configuration.
|
||||
|
||||
.. note::
|
||||
Initialization using environment variables is typically preferable in a multi-app ecosystem, as it allows all applications to be consistently configured.
|
||||
|
||||
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
|
||||
@@ -62,9 +13,8 @@
|
||||
|
||||
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 +23,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 +30,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 +37,8 @@
|
||||
|
||||
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)
|
||||
@@ -126,6 +51,7 @@
|
||||
|
||||
Get a processor to convert between color spaces in two separate configs.
|
||||
|
||||
|
||||
This relies on both configs having the aces_interchange role (when srcName is scene-referred) or the role cie_xyz_d65_interchange (when srcName is display-referred) defined. An exception is thrown if that is not the case.
|
||||
|
||||
2. GetProcessorFromConfigs(srcContext: PyOpenColorIO.Context, srcConfig: PyOpenColorIO.Config, srcColorSpaceName: str, dstContext: PyOpenColorIO.Context, dstConfig: PyOpenColorIO.Config, dstColorSpaceName: str) -> PyOpenColorIO.Processor
|
||||
@@ -137,28 +63,13 @@
|
||||
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
|
||||
@@ -170,6 +81,7 @@
|
||||
|
||||
Add a color space to the configuration.
|
||||
|
||||
|
||||
.. note::
|
||||
If another color space is already present with the same name, this will overwrite it. This stores a copy of the specified color space.
|
||||
|
||||
@@ -182,6 +94,7 @@
|
||||
|
||||
Add a (reference to a) shared view to a display.
|
||||
|
||||
|
||||
The shared view must be part of the config. See :ref:`Config::addSharedView`
|
||||
|
||||
This will throw if:
|
||||
@@ -222,6 +135,7 @@
|
||||
|
||||
Add a single search path to the end of the list.
|
||||
|
||||
|
||||
Paths may be either absolute or relative. Relative paths are relative to the working directory. Forward slashes will be normalized to reverse for Windows. Environment (context) variables may be used in paths.
|
||||
|
||||
|
||||
@@ -230,48 +144,17 @@
|
||||
|
||||
Will throw if view or colorSpaceName are null or empty.
|
||||
|
||||
The following methods only manipulate active displays and views. Active displays and views are defined from an env. variable or from the config file.
|
||||
|
||||
Looks is a potentially comma (or colon) delimited list of lookNames, Where +/- prefixes are optionally allowed to denote forward/inverse look specification. (And forward is assumed in the absence of either)
|
||||
|
||||
Add shared view (or replace existing one with same name). Shared views are defined at config level and can be referenced by several displays. Either provide a view transform and a display color space or just a color space (and a null view transform). Looks, rule and description are optional, they can be null or empty.
|
||||
|
||||
Shared views using a view transform may use the token <USE_DISPLAY_NAME> for the color space (see :c:var:`OCIO_VIEW_USE_DISPLAY_NAME`). In that case, when the view is referenced in a display, the display color space that is used will be the one matching the display name. In other words, the view will be customized based on the display it is used in. :ref:`Config::validate` will throw if the config does not contain the matching display color space.
|
||||
|
||||
|
||||
.. py:method:: Config.addViewTransform(self: PyOpenColorIO.Config, viewTransform: PyOpenColorIO.ViewTransform) -> None
|
||||
: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
|
||||
|
||||
Remove all the color spaces from the configuration.
|
||||
|
||||
|
||||
.. note::
|
||||
Removing color spaces from a :ref:`Config` does not affect any :ref:`ColorSpaceSet` sets that have already been created.
|
||||
|
||||
@@ -302,12 +185,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
|
||||
|
||||
@@ -329,19 +206,11 @@
|
||||
|
||||
1. getCacheID(self: PyOpenColorIO.Config) -> str
|
||||
|
||||
This will produce a hash of the all colorspace definitions, etc. All external references, such as files used in FileTransforms, etc., will be incorporated into the cacheID. While the contents of the files are not read, the file system is queried for relevant information (mtime, inode) so that the config's cacheID will change when the underlying luts are updated.
|
||||
|
||||
If a context is not provided, the current :ref:`Context` will be used.
|
||||
|
||||
If a null context is provided, file references will not be taken into account (this is essentially a hash of :ref:`Config::serialize`).
|
||||
This will produce a hash of the all colorspace definitions, etc. All external references, such as files used in FileTransforms, etc., will be incorporated into the cacheID. While the contents of the files are not read, the file system is queried for relevant information (mtime, inode) so that the config's cacheID will change when the underlying luts are updated. If a context is not provided, the current :ref:`Context` will be used. If a null context is provided, file references will not be taken into account (this is essentially a hash of :ref:`Config::serialize`).
|
||||
|
||||
2. getCacheID(self: PyOpenColorIO.Config, context: PyOpenColorIO.Context) -> str
|
||||
|
||||
This will produce a hash of the all colorspace definitions, etc. All external references, such as files used in FileTransforms, etc., will be incorporated into the cacheID. While the contents of the files are not read, the file system is queried for relevant information (mtime, inode) so that the config's cacheID will change when the underlying luts are updated.
|
||||
|
||||
If a context is not provided, the current :ref:`Context` will be used.
|
||||
|
||||
If a null context is provided, file references will not be taken into account (this is essentially a hash of :ref:`Config::serialize`).
|
||||
This will produce a hash of the all colorspace definitions, etc. All external references, such as files used in FileTransforms, etc., will be incorporated into the cacheID. While the contents of the files are not read, the file system is queried for relevant information (mtime, inode) so that the config's cacheID will change when the underlying luts are updated. If a context is not provided, the current :ref:`Context` will be used. If a null context is provided, file references will not be taken into account (this is essentially a hash of :ref:`Config::serialize`).
|
||||
|
||||
|
||||
.. py:method:: Config.getCanonicalName(self: PyOpenColorIO.Config, name: str) -> str
|
||||
@@ -355,6 +224,7 @@
|
||||
|
||||
Get the color space from all the color spaces (i.e. active and inactive) and return null if the name is not found.
|
||||
|
||||
|
||||
.. note::
|
||||
The fcn accepts either a color space name, role name, or alias. (Color space names take precedence over roles.)
|
||||
|
||||
@@ -362,7 +232,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)
|
||||
@@ -384,8 +254,9 @@
|
||||
|
||||
Get all active color spaces having a specific category in the order they appear in the config file.
|
||||
|
||||
|
||||
.. note::
|
||||
If the category is null or empty, the method returns all the active color spaces like :ref:`Config::getNumColorSpaces` and :ref:`Config::getColorSpaceNameByIndex` do.
|
||||
If the category is null or empty, the method returns all the active color spaces like :cpp:func:`:ref:`Config::getNumColorSpaces`` and :cpp:func:`:ref:`Config::getColorSpaceNameByIndex`` do.
|
||||
|
||||
.. note::
|
||||
It's worth noticing that the method returns a copy of the selected color spaces decoupling the result from the config. Hence, any changes on the config do not affect the existing color space sets, and vice-versa.
|
||||
@@ -408,8 +279,9 @@
|
||||
|
||||
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 :cpp:class:`: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 +290,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 +340,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
|
||||
|
||||
@@ -495,6 +357,7 @@
|
||||
|
||||
Get the family separator.
|
||||
|
||||
|
||||
A single character used to separate the family string into tokens for use in hierarchical menus. Defaults to '/'.
|
||||
|
||||
|
||||
@@ -571,8 +434,6 @@
|
||||
|
||||
1. getProcessor(self: PyOpenColorIO.Config, srcColorSpace: PyOpenColorIO.ColorSpace, dstColorSpace: PyOpenColorIO.ColorSpace) -> PyOpenColorIO.Processor
|
||||
|
||||
Get the processor to apply a :ref:`ColorSpaceTransform` from a source to a destination color space.
|
||||
|
||||
2. getProcessor(self: PyOpenColorIO.Config, context: PyOpenColorIO.Context, srcColorSpace: PyOpenColorIO.ColorSpace, dstColorSpace: PyOpenColorIO.ColorSpace) -> PyOpenColorIO.Processor
|
||||
|
||||
3. getProcessor(self: PyOpenColorIO.Config, srcColorSpaceName: str, dstColorSpaceName: str) -> PyOpenColorIO.Processor
|
||||
@@ -584,29 +445,20 @@
|
||||
|
||||
5. getProcessor(self: PyOpenColorIO.Config, srcColorSpaceName: str, display: str, view: str, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor
|
||||
|
||||
Get the processor to apply a :ref:`DisplayViewTransform` for a display and view. Refer to the Display/View Registration section above for more info on the display and view arguments.
|
||||
|
||||
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
|
||||
cpp:function::
|
||||
|
||||
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 +506,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 +519,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 +528,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 +539,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).
|
||||
@@ -792,6 +551,7 @@
|
||||
|
||||
Remove a color space from the configuration.
|
||||
|
||||
|
||||
.. note::
|
||||
It does not throw an exception. Name must be the canonical name. If a role name or alias is provided or if the name is not in the config, nothing is done.
|
||||
|
||||
@@ -804,6 +564,7 @@
|
||||
|
||||
Remove the view and the display if no more views.
|
||||
|
||||
|
||||
It does not remove the associated color space. If the view name is a shared view, it only removes the reference to the view from the display but the shared view, remains in the config.
|
||||
|
||||
Will throw if the view does not exist.
|
||||
@@ -815,12 +576,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
|
||||
|
||||
@@ -832,6 +587,7 @@
|
||||
|
||||
Returns the string representation of the :ref:`Config` in YAML text form.
|
||||
|
||||
|
||||
This is typically stored on disk in a file with the extension .ocio. NB: This does not validate the config. Applications should validate before serializing.
|
||||
|
||||
|
||||
@@ -840,6 +596,7 @@
|
||||
|
||||
$OCIO_ACTIVE_DISPLAYS envvar can, at runtime, optionally override the allowed displays. It is a comma or colon delimited list. Active displays that are not in the specified profile will be ignored, and the left-most defined display will be the default.
|
||||
|
||||
|
||||
Comma-delimited list of names to filter and order the active displays.
|
||||
|
||||
.. note::
|
||||
@@ -851,6 +608,7 @@
|
||||
|
||||
$OCIO_ACTIVE_VIEWS envvar can, at runtime, optionally override the allowed views. It is a comma or colon delimited list. Active views that are not in the specified profile will be ignored, and the left-most defined view will be the default.
|
||||
|
||||
|
||||
Comma-delimited list of names to filter and order the active views.
|
||||
|
||||
.. note::
|
||||
@@ -880,6 +638,7 @@
|
||||
|
||||
Set the family separator.
|
||||
|
||||
|
||||
Succeeds if the characters is null or a valid character from the ASCII table i.e. from value 32 (i.e. space) to 126 (i.e. '~'); otherwise, it throws an exception.
|
||||
|
||||
|
||||
@@ -888,6 +647,7 @@
|
||||
|
||||
Set file rules.
|
||||
|
||||
|
||||
.. note::
|
||||
The argument is cloned.
|
||||
|
||||
@@ -897,10 +657,11 @@
|
||||
|
||||
Set/get a list of inactive color space or named transform names.
|
||||
|
||||
|
||||
Notes:
|
||||
- List can contain color space and/or named transform names.
|
||||
- The inactive spaces are color spaces that should not appear in application menus.
|
||||
- These color spaces will still work in :ref:`Config::getProcessor` calls.
|
||||
- These color spaces will still work in Config::getProcessor calls.
|
||||
- The argument is a comma-delimited string. A null or empty string empties the list.
|
||||
- The environment variable OCIO_INACTIVE_COLORSPACES may also be used to set the inactive color space list.
|
||||
- The env. var. takes precedence over the inactive_colorspaces list in the config file.
|
||||
@@ -928,8 +689,7 @@
|
||||
.. py:method:: Config.setProcessorCacheFlags(self: PyOpenColorIO.Config, flags: PyOpenColorIO.ProcessorCacheFlags) -> None
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Control the caching of processors in the config instance. By default, caching is on.
|
||||
The flags allow turning caching off entirely or only turning it off if dynamic properties are being used by the processor.
|
||||
cpp:function:: Control the caching of processors in the config instance. By default, caching
|
||||
|
||||
|
||||
.. py:method:: Config.setRole(self: PyOpenColorIO.Config, role: str, colorSpaceName: str) -> None
|
||||
@@ -944,6 +704,7 @@
|
||||
|
||||
Set all search paths as a concatenated string, ':' to separate the paths.
|
||||
|
||||
|
||||
See :ref:`addSearchPath` for a more robust and platform-agnostic method of setting the search paths.
|
||||
|
||||
|
||||
@@ -962,6 +723,7 @@
|
||||
|
||||
Set viewing rules.
|
||||
|
||||
|
||||
.. note::
|
||||
The argument is cloned.
|
||||
|
||||
@@ -983,6 +745,7 @@
|
||||
|
||||
Performs a thorough validation for the most common user errors.
|
||||
|
||||
|
||||
This will throw an exception if the config is malformed. The most common error occurs when references are made to colorspaces that do not exist.
|
||||
|
||||
|
||||
|
||||
@@ -6,31 +6,6 @@
|
||||
.. py:class:: Context
|
||||
:module: PyOpenColorIO
|
||||
|
||||
:ref:`Context`
|
||||
|
||||
A context defines some overrides to a :ref:`Config`. For example, it can override the search path or change the value of a context variable.
|
||||
|
||||
.. note::
|
||||
Only some :ref:`Config::getProcessor` methods accept a custom context; otherwise, the default context instance is used (see Config::getCurrentContext).
|
||||
|
||||
:ref:`Context` Variables
|
||||
|
||||
The context variables allow changes at runtime using environment variables. For example, a color space name (such as src & dst for the :ref:`ColorSpaceTransform`) or a file name (such as LUT file name for the :ref:`FileTransform`) could be defined by context variables. The color transformation is then customized based on some environment variables.
|
||||
|
||||
In a config the context variables support three syntaxes (i.e. ${VAR}, $VAR and VAR%) and the parsing starts from longest to shortest. So, the resolve works like '$TEST_$TESTING_$TE' expands in this order '2 1 3'.
|
||||
|
||||
:ref:`Config` authors are recommended to include the "environment" section in their configs. This improves performance as well as making the config more readable. When present, this section must declare all context variables used in the config. It may also provide a default value, in case the variable is not present in the user's environment.
|
||||
|
||||
A context variable may only be used in the following places:
|
||||
- the `:ref:`ColorSpaceTransform`` to define the source and the destination color space names,
|
||||
- the `:ref:`FileTransform`` to define the source file name (e.g. a LUT file name),
|
||||
- the search_path,
|
||||
- the cccid of the `:ref:`FileTransform`` to only extract one specific transform from the CDL & CCC files.
|
||||
|
||||
Some specific restrictions are worth calling out:
|
||||
- they cannot be used as either the name or value of a role,
|
||||
- the context variable characters $ and % are prohibited in a color space name.
|
||||
|
||||
|
||||
.. py:method:: Context.__init__(*args, **kwargs)
|
||||
:module: PyOpenColorIO
|
||||
@@ -61,6 +36,8 @@
|
||||
.. py:method:: Context.getEnvironmentMode(self: PyOpenColorIO.Context) -> PyOpenColorIO.EnvironmentMode
|
||||
:module: PyOpenColorIO
|
||||
|
||||
cpp:function::
|
||||
|
||||
|
||||
.. py:method:: Context.getSearchPath(self: PyOpenColorIO.Context) -> str
|
||||
:module: PyOpenColorIO
|
||||
@@ -111,16 +88,18 @@
|
||||
|
||||
1. resolveStringVar(self: PyOpenColorIO.Context, string: str) -> str
|
||||
|
||||
Resolve all the context variables from the string. It could be color space names or file names. Note that it recursively applies the context variable resolution. Returns the string unchanged if it does not contain any context variable.
|
||||
cpp:function:: Resolve all the context variables from the string. It could be color space
|
||||
|
||||
2. resolveStringVar(self: PyOpenColorIO.Context, string: str, usedContextVars: PyOpenColorIO.Context) -> str
|
||||
|
||||
Resolve all the context variables from the string and return all the context variables used to resolve the string (empty if no context variables were used).
|
||||
cpp:function:: Resolve all the context variables from the string and return all the context
|
||||
|
||||
|
||||
.. py:method:: Context.setEnvironmentMode(self: PyOpenColorIO.Context, mode: PyOpenColorIO.EnvironmentMode) -> None
|
||||
:module: PyOpenColorIO
|
||||
|
||||
cpp:function::
|
||||
|
||||
|
||||
.. py:method:: Context.setSearchPath(self: PyOpenColorIO.Context, path: str) -> None
|
||||
: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
|
||||
@@ -147,11 +149,6 @@
|
||||
.. py:method:: CPUProcessor.getDynamicProperty(self: PyOpenColorIO.CPUProcessor, type: PyOpenColorIO.DynamicPropertyType) -> PyOpenColorIO.DynamicProperty
|
||||
:module: PyOpenColorIO
|
||||
|
||||
The returned pointer may be used to set the value of any dynamic properties of the requested type. Throws if the requested property is not found. Note that if the processor contains several ops that support the requested property, only one can be dynamic.
|
||||
|
||||
.. note::
|
||||
The dynamic properties in this object are decoupled from the ones in the :ref:`Processor` it was generated from. For each dynamic property in the :ref:`Processor`, there is one in the CPU processor.
|
||||
|
||||
|
||||
.. py:method:: CPUProcessor.getInputBitDepth(self: PyOpenColorIO.CPUProcessor) -> PyOpenColorIO.BitDepth
|
||||
:module: PyOpenColorIO
|
||||
|
||||
@@ -17,6 +17,12 @@
|
||||
2. __init__(self: PyOpenColorIO.DisplayViewTransform, src: str = '', display: str = '', view: str = '', looksBypass: bool = False, dataBypass: bool = True, direction: PyOpenColorIO.TransformDirection = <TransformDirection.TRANSFORM_DIR_FORWARD: 0>) -> None
|
||||
|
||||
|
||||
.. py:method:: DisplayViewTransform.__str__()
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Return str(self).
|
||||
|
||||
|
||||
.. py:method:: DisplayViewTransform.getDataBypass(self: PyOpenColorIO.DisplayViewTransform) -> bool
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -6,51 +6,20 @@
|
||||
.. py:class:: DynamicProperty
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Allows transform parameter values to be set on-the-fly (after finalization). For example, to modify the exposure in a viewport. Dynamic properties can be accessed from the `:ref:`CPUProcessor`` or `:ref:`GpuShaderCreator`` to change values between processing.
|
||||
Allows transform parameter values to be set on-the-fly (after finalization). For example, to modify the exposure in a viewport. Dynamic properties can be accessed from the :cpp:class:`:ref:`CPUProcessor`` or :cpp:class:`:ref:`GpuShaderCreator`` to change values between processing.
|
||||
|
||||
.. code-block:: cpp
|
||||
|
||||
OCIO::ConstConfigRcPtr config = OCIO::GetCurrentConfig();
|
||||
OCIO::ConstProcessorRcPtr processor = config->getProcessor(colorSpace1, colorSpace2);
|
||||
OCIO::ConstCPUProcessorRcPtr cpuProcessor = processor->getDefaultCPUProcessor();
|
||||
OCIO::ConstConfigRcPtr config = OCIO::GetCurrentConfig(); OCIO::ConstProcessorRcPtr processor = config->getProcessor(colorSpace1, colorSpace2); OCIO::ConstCPUProcessorRcPtr cpuProcessor = processor->getDefaultCPUProcessor();
|
||||
|
||||
if (cpuProcessor->hasDynamicProperty(OCIO::DYNAMIC_PROPERTY_EXPOSURE))
|
||||
{
|
||||
// Get the in-memory implementation of the dynamic property.
|
||||
OCIO::DynamicPropertyRcPtr dynProp =
|
||||
cpuProcessor->getDynamicProperty(OCIO::DYNAMIC_PROPERTY_EXPOSURE);
|
||||
// Get the interface used to change the double value.
|
||||
OCIO::DynamicPropertyDoubleRcPtr exposure =
|
||||
OCIO::DynamicPropertyValue::AsDouble(dynProp);
|
||||
// Update of the dynamic property instance with the new value.
|
||||
exposure->setValue(1.1f);
|
||||
}
|
||||
if (cpuProcessor->hasDynamicProperty(OCIO::DYNAMIC_PROPERTY_GRADING_PRIMARY))
|
||||
{
|
||||
OCIO::DynamicPropertyRcPtr dynProp =
|
||||
cpuProcessor->getDynamicProperty(OCIO::DYNAMIC_PROPERTY_GRADING_PRIMARY);
|
||||
OCIO::DynamicPropertyGradingPrimaryRcPtr primaryProp =
|
||||
OCIO::DynamicPropertyValue::AsGradingPrimary(dynProp);
|
||||
OCIO::GradingPrimary primary = primaryProp->getValue();
|
||||
primary.m_saturation += 0.1f;
|
||||
rgbCurveProp->setValue(primary);
|
||||
}
|
||||
if (cpuProcessor->hasDynamicProperty(OCIO::DYNAMIC_PROPERTY_GRADING_RGBCURVE))
|
||||
{
|
||||
OCIO::DynamicPropertyRcPtr dynProp =
|
||||
cpuProcessor->getDynamicProperty(OCIO::DYNAMIC_PROPERTY_GRADING_RGBCURVE);
|
||||
OCIO::DynamicPropertyGradingRGBCurveRcPtr rgbCurveProp =
|
||||
OCIO::DynamicPropertyValue::AsGradingRGBCurve(dynProp);
|
||||
OCIO::ConstGradingRGBCurveRcPtr rgbCurve = rgbCurveProp->getValue()->createEditableCopy();
|
||||
OCIO::GradingBSplineCurveRcPtr rCurve = rgbCurve->getCurve(OCIO::RGB_RED);
|
||||
rCurve->getControlPoint(1).m_y += 0.1f;
|
||||
rgbCurveProp->setValue(rgbCurve);
|
||||
}
|
||||
if (cpuProcessor->hasDynamicProperty(OCIO::DYNAMIC_PROPERTY_EXPOSURE)) { // Get the in-memory implementation of the dynamic property. OCIO::DynamicPropertyRcPtr dynProp = cpuProcessor->getDynamicProperty(OCIO::DYNAMIC_PROPERTY_EXPOSURE); // Get the interface used to change the double value. OCIO::DynamicPropertyDoubleRcPtr exposure = OCIO::DynamicPropertyValue::AsDouble(dynProp); // Update of the dynamic property instance with the new value. exposure->setValue(1.1f); } if (cpuProcessor->hasDynamicProperty(OCIO::DYNAMIC_PROPERTY_GRADING_PRIMARY)) { OCIO::DynamicPropertyRcPtr dynProp = cpuProcessor->getDynamicProperty(OCIO::DYNAMIC_PROPERTY_GRADING_PRIMARY); OCIO::DynamicPropertyGradingPrimaryRcPtr primaryProp = OCIO::DynamicPropertyValue::AsGradingPrimary(dynProp); OCIO::GradingPrimary primary = primaryProp->getValue(); primary.m_saturation += 0.1f; rgbCurveProp->setValue(primary); } if (cpuProcessor->hasDynamicProperty(OCIO::DYNAMIC_PROPERTY_GRADING_RGBCURVE)) { OCIO::DynamicPropertyRcPtr dynProp = cpuProcessor->getDynamicProperty(OCIO::DYNAMIC_PROPERTY_GRADING_RGBCURVE); OCIO::DynamicPropertyGradingRGBCurveRcPtr rgbCurveProp = OCIO::DynamicPropertyValue::AsGradingRGBCurve(dynProp); OCIO::ConstGradingRGBCurveRcPtr rgbCurve = rgbCurveProp->getValue()->createEditableCopy(); OCIO::GradingBSplineCurveRcPtr rCurve = rgbCurve->getCurve(OCIO::RGB_RED); rCurve->getControlPoint(1).m_y += 0.1f; rgbCurveProp->setValue(rgbCurve); }
|
||||
|
||||
|
||||
.. 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
|
||||
|
||||
@@ -55,6 +55,7 @@
|
||||
:value: <DynamicPropertyType.DYNAMIC_PROPERTY_GRADING_TONE: 5>
|
||||
|
||||
|
||||
.. py:property:: DynamicPropertyType.value
|
||||
.. py:method:: DynamicPropertyType.value
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
@@ -32,6 +32,7 @@
|
||||
:value: <EnvironmentMode.ENV_ENVIRONMENT_UNKNOWN: 0>
|
||||
|
||||
|
||||
.. py:property:: EnvironmentMode.value
|
||||
.. py:method:: EnvironmentMode.value
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
@@ -8,6 +8,7 @@
|
||||
|
||||
An exception class to throw for errors detected at runtime.
|
||||
|
||||
|
||||
.. warning::
|
||||
All functions in the :ref:`Config` class can potentially throw this exception.
|
||||
|
||||
|
||||
@@ -8,5 +8,6 @@
|
||||
|
||||
An exception class for errors detected at runtime.
|
||||
|
||||
|
||||
Thrown when OCIO cannot find a file that is expected to exist. This is provided as a custom type to distinguish cases where one wants to continue looking for missing files, but wants to properly fail for other error conditions.
|
||||
|
||||
|
||||
@@ -8,6 +8,7 @@
|
||||
|
||||
Represents exponent transform: pow( clamp(color), value ).
|
||||
|
||||
|
||||
.. note::
|
||||
For configs with version == 1: Negative style is ignored and if the exponent is 1.0, this will not clamp. Otherwise, the input color will be clamped between [0.0, inf]. For configs with version > 1: Negative value handling may be specified via setNegativeStyle.
|
||||
|
||||
@@ -22,6 +23,12 @@
|
||||
2. __init__(self: PyOpenColorIO.ExponentTransform, value: List[float[4]] = [1.0, 1.0, 1.0, 1.0], negativeStyle: PyOpenColorIO.NegativeStyle = <NegativeStyle.NEGATIVE_CLAMP: 0>, direction: PyOpenColorIO.TransformDirection = <TransformDirection.TRANSFORM_DIR_FORWARD: 0>) -> None
|
||||
|
||||
|
||||
.. py:method:: ExponentTransform.__str__()
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Return str(self).
|
||||
|
||||
|
||||
.. py:method:: ExponentTransform.equals(self: PyOpenColorIO.ExponentTransform, other: PyOpenColorIO.ExponentTransform) -> bool
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -25,6 +25,12 @@
|
||||
2. __init__(self: PyOpenColorIO.ExponentWithLinearTransform, gamma: List[float[4]] = [1.0, 1.0, 1.0, 1.0], offset: List[float[4]] = [0.0, 0.0, 0.0, 0.0], negativeStyle: PyOpenColorIO.NegativeStyle = <NegativeStyle.NEGATIVE_LINEAR: 3>, direction: PyOpenColorIO.TransformDirection = <TransformDirection.TRANSFORM_DIR_FORWARD: 0>) -> None
|
||||
|
||||
|
||||
.. py:method:: ExponentWithLinearTransform.__str__()
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Return str(self).
|
||||
|
||||
|
||||
.. py:method:: ExponentWithLinearTransform.equals(self: PyOpenColorIO.ExponentWithLinearTransform, other: PyOpenColorIO.ExponentWithLinearTransform) -> bool
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -34,6 +34,7 @@
|
||||
:value: <ExposureContrastStyle.EXPOSURE_CONTRAST_VIDEO: 1>
|
||||
|
||||
|
||||
.. py:property:: ExposureContrastStyle.value
|
||||
.. py:method:: ExposureContrastStyle.value
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
@@ -19,6 +19,12 @@
|
||||
2. __init__(self: PyOpenColorIO.ExposureContrastTransform, style: PyOpenColorIO.ExposureContrastStyle = <ExposureContrastStyle.EXPOSURE_CONTRAST_LINEAR: 0>, exposure: float = 0.0, contrast: float = 1.0, gamma: float = 1.0, pivot: float = 0.18, logExposureStep: float = 0.088, logMidGray: float = 0.435, dynamicExposure: bool = False, dynamicContrast: bool = False, dynamicGamma: bool = False, direction: PyOpenColorIO.TransformDirection = <TransformDirection.TRANSFORM_DIR_FORWARD: 0>) -> None
|
||||
|
||||
|
||||
.. py:method:: ExposureContrastTransform.__str__()
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Return str(self).
|
||||
|
||||
|
||||
.. py:method:: ExposureContrastTransform.equals(self: PyOpenColorIO.ExposureContrastTransform, other: PyOpenColorIO.ExposureContrastTransform) -> bool
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -6,32 +6,6 @@
|
||||
.. py:class:: FileRules
|
||||
:module: PyOpenColorIO
|
||||
|
||||
The File Rules are a set of filepath to color space mappings that are evaluated from first to last. The first rule to match is what determines which color space is returned. There are four types of rules available. Each rule type has a name key that may be used by applications to refer to that rule. Name values must be unique i.e. using a case insensitive comparison. The other keys depend on the rule type:
|
||||
|
||||
- *Basic Rule*: 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
|
||||
- colorspace: Color space name to be returned.
|
||||
- pattern: Glob pattern to be used for the main part of the name/path.
|
||||
- extension: Glob pattern 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.
|
||||
|
||||
- *Regex Rule*: This is similar to the basic rule but allows additional capabilities for power-users. It contains the keys:
|
||||
- name: Name of the rule
|
||||
- colorspace: Color space name to be returned.
|
||||
- regex: Regular expression to be evaluated.
|
||||
|
||||
- *OCIO v1 style Rule*: This rule allows the use of the OCIO v1 style, where the string is searched for color space 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. StrictParsing is not used. If no color space is found in the path, the rule will not match and the next rule will be considered. see :ref:`insertPathSearchRule`. It has the key:
|
||||
- name: Must be "ColorSpaceNamePathSearch".
|
||||
|
||||
- *Default Rule*: The file_rules must always end with this rule. If no prior rules match, this rule specifies the color space applications will use. see :ref:`setDefaultRuleColorSpace`. It has the keys:
|
||||
- name: must be "Default".
|
||||
- colorspace : Color space name to be returned.
|
||||
|
||||
Custom string keys and associated string values may be used to convey app or workflow-specific information, e.g. whether the color space should be left as is or converted into a working space.
|
||||
|
||||
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
|
||||
@@ -116,6 +90,7 @@
|
||||
|
||||
Helper function to insert a rule.
|
||||
|
||||
|
||||
Uses Config:parseColorSpaceFromString to search the path for any of the color spaces named in the config (as per OCIO v1).
|
||||
|
||||
|
||||
@@ -128,6 +103,7 @@
|
||||
|
||||
Insert a rule at a given ruleIndex.
|
||||
|
||||
|
||||
Rule currently at ruleIndex will be pushed to index: ruleIndex + 1. Name must be unique.
|
||||
- "Default" is a reserved name for the default rule. The default rule is automatically added and can't be removed. (see :ref:`FileRules::setDefaultRuleColorSpace` ).
|
||||
- "ColorSpaceNamePathSearch" is also a reserved name (see :ref:`FileRules::insertPathSearchRule` ).
|
||||
|
||||
@@ -17,6 +17,12 @@
|
||||
2. __init__(self: PyOpenColorIO.FileTransform, src: str = '', cccId: str = '', interpolation: PyOpenColorIO.Interpolation = <Interpolation.INTERP_DEFAULT: 254>, direction: PyOpenColorIO.TransformDirection = <TransformDirection.TRANSFORM_DIR_FORWARD: 0>) -> None
|
||||
|
||||
|
||||
.. py:method:: FileTransform.__str__()
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Return str(self).
|
||||
|
||||
|
||||
.. py:method:: FileTransform.getCCCId(self: PyOpenColorIO.FileTransform) -> str
|
||||
: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 -- NOT IMPLEMENTED YET.
|
||||
|
||||
.. 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
|
||||
@@ -104,6 +104,7 @@
|
||||
:value: <FixedFunctionStyle.FIXED_FUNCTION_XYZ_TO_xyY: 7>
|
||||
|
||||
|
||||
.. py:property:: FixedFunctionStyle.value
|
||||
.. py:method:: FixedFunctionStyle.value
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
@@ -13,6 +13,12 @@
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
.. py:method:: FixedFunctionTransform.__str__()
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Return str(self).
|
||||
|
||||
|
||||
.. py:method:: FixedFunctionTransform.equals(self: PyOpenColorIO.FixedFunctionTransform, other: PyOpenColorIO.FixedFunctionTransform) -> bool
|
||||
: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
|
||||
|
||||
@@ -8,5 +8,6 @@
|
||||
|
||||
Get the global logging level.
|
||||
|
||||
|
||||
You can override this at runtime using the OCIO_LOGGING_LEVEL environment variable. The client application that sets this should use :ref:`SetLoggingLevel`, and not the environment variable. The default value is INFO.
|
||||
|
||||
|
||||
@@ -8,5 +8,6 @@
|
||||
|
||||
Get the version number for the library, as a dot-delimited string (e.g., "1.0.0").
|
||||
|
||||
|
||||
This is also available at compile time as OCIO_VERSION_FULL_STR.
|
||||
|
||||
|
||||
@@ -8,5 +8,6 @@
|
||||
|
||||
Get the version number for the library, as a single 4-byte hex number (e.g., 0x01050200 for "1.5.2"), to be used for numeric comparisons.
|
||||
|
||||
|
||||
This is also at compile time as OCIO_VERSION_HEX.
|
||||
|
||||
|
||||
@@ -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,12 @@
|
||||
: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
|
||||
.. py:method:: GpuLanguage.value
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
@@ -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,87 +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 :cpp:class:`: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.
|
||||
|
||||
**An OCIO shader program could contain:**
|
||||
|
||||
- A declaration part e.g., uniform sampled3D tex3;
|
||||
- Some helper methods
|
||||
- The OCIO shader function may be broken down as:
|
||||
- The function header e.g., void OCIODisplay(in vec4 inColor) {
|
||||
- The function body e.g., vec4 outColor.rgb = texture3D(tex3, inColor.rgb).rgb;
|
||||
- The function footer e.g., return outColor; }
|
||||
|
||||
**Usage Example:**
|
||||
|
||||
Below is a code snippet to highlight the different parts of the OCIO shader program.
|
||||
|
||||
.. code-block:: cpp
|
||||
|
||||
// All global declarations
|
||||
uniform sampled3D tex3;
|
||||
|
||||
// All helper methods
|
||||
vec3 computePosition(vec3 color)
|
||||
{
|
||||
vec3 coords = color;
|
||||
// Some processing...
|
||||
return coords;
|
||||
}
|
||||
|
||||
// The shader function
|
||||
vec4 OCIODisplay(in vec4 inColor) //
|
||||
{ // Function Header
|
||||
vec4 outColor = inColor; //
|
||||
|
||||
outColor.rgb = texture3D(tex3, computePosition(inColor.rgb)).rgb;
|
||||
|
||||
return outColor; // Function Footer
|
||||
} //
|
||||
|
||||
|
||||
.. 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
|
||||
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.
|
||||
|
||||
|
||||
.. py:method:: GpuShaderCreator.addToDeclareShaderCode(self: PyOpenColorIO.GpuShaderCreator, shaderCode: str) -> None
|
||||
@@ -126,8 +48,11 @@
|
||||
|
||||
Create the OCIO shader program.
|
||||
|
||||
|
||||
.. note::
|
||||
The OCIO shader program is decomposed to allow a specific implementation to change some parts. Some product integrations add the color processing within a client shader program, imposing constraints requiring this flexibility.
|
||||
|
||||
|
||||
The OCIO shader program is decomposed to allow a specific implementation to change some parts. Some product integrations add the color processing within a client shader program, imposing constraints requiring this flexibility.
|
||||
|
||||
|
||||
.. py:method:: GpuShaderCreator.end(self: PyOpenColorIO.GpuShaderCreator) -> None
|
||||
@@ -140,10 +65,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 +88,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 +114,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,8 +168,9 @@
|
||||
:value: <TextureType.TEXTURE_RGB_CHANNEL: 1>
|
||||
|
||||
|
||||
.. py:property:: TextureType.value
|
||||
.. py:method:: TextureType.value
|
||||
:module: PyOpenColorIO.GpuShaderCreator
|
||||
:property:
|
||||
|
||||
|
||||
.. py:class:: DynamicPropertyIterator
|
||||
|
||||
@@ -6,137 +6,12 @@
|
||||
.. py:class:: GpuShaderDesc
|
||||
:module: PyOpenColorIO
|
||||
|
||||
This class holds the GPU-related information needed to build a shader program from a specific processor.
|
||||
|
||||
This class defines the interface and there are two implementations provided. The "legacy" mode implements the OCIO v1 approach of baking certain ops in order to have at most one 3D-LUT. The "generic" mode is the v2 default and allows all the ops to be processed as-is, without baking, like the CPU renderer. Custom implementations could be written to accommodate the GPU needs of a specific client app.
|
||||
.. py:method:: GpuShaderDesc.CreateLegacyShaderDesc(edgeLen: int, language: PyOpenColorIO.GpuLanguage = <GpuLanguage.GPU_LANGUAGE_GLSL_1_2: 1>, functionName: str = 'OCIOMain', pixelName: str = 'outColor', resourcePrefix: str = 'ocio', uid: str = '') -> PyOpenColorIO.GpuShaderDesc
|
||||
:module: PyOpenColorIO
|
||||
:staticmethod:
|
||||
|
||||
The complete fragment shader program is decomposed in two main parts: the OCIO shader program for the color processing and the client shader program which consumes the pixel color processing.
|
||||
|
||||
The OCIO shader program is fully described by the :ref:`GpuShaderDesc` independently from the client shader program. The only critical point is the agreement on the OCIO function shader name.
|
||||
|
||||
To summarize, the complete shader program is:
|
||||
|
||||
.. code-block:: cpp
|
||||
|
||||
// //
|
||||
// The complete fragment shader program //
|
||||
// //
|
||||
// //
|
||||
// ////////////////////////////////////////////////////////////// //
|
||||
// // // //
|
||||
// // The OCIO shader program // //
|
||||
// // // //
|
||||
// ////////////////////////////////////////////////////////////// //
|
||||
// // // //
|
||||
// // // All global declarations // //
|
||||
// // uniform sampled3D tex3; // //
|
||||
// // // //
|
||||
// // // All helper methods // //
|
||||
// // vec3 computePos(vec3 color) // //
|
||||
// // { // //
|
||||
// // vec3 coords = color; // //
|
||||
// // ... // //
|
||||
// // return coords; // //
|
||||
// // } // //
|
||||
// // // //
|
||||
// // // The OCIO shader function // //
|
||||
// // vec4 OCIODisplay(in vec4 inColor) // //
|
||||
// // { // //
|
||||
// // vec4 outColor = inColor; // //
|
||||
// // ... // //
|
||||
// // outColor.rbg // //
|
||||
// // = texture3D(tex3, computePos(inColor.rgb)).rgb; // //
|
||||
// // ... // //
|
||||
// // return outColor; // //
|
||||
// // } // //
|
||||
// // // //
|
||||
// ////////////////////////////////////////////////////////////// //
|
||||
// //
|
||||
// ////////////////////////////////////////////////////////////// //
|
||||
// // // //
|
||||
// // The client shader program // //
|
||||
// // // //
|
||||
// ////////////////////////////////////////////////////////////// //
|
||||
// // // //
|
||||
// // uniform sampler2D image; // //
|
||||
// // // //
|
||||
// // void main() // //
|
||||
// // { // //
|
||||
// // vec4 inColor = texture2D(image, gl_TexCoord[0].st); // //
|
||||
// // ... // //
|
||||
// // vec4 outColor = OCIODisplay(inColor); // //
|
||||
// // ... // //
|
||||
// // gl_FragColor = outColor; // //
|
||||
// // } // //
|
||||
// // // //
|
||||
// ////////////////////////////////////////////////////////////// //
|
||||
// //
|
||||
////////////////////////////////////////////////////////////////////////
|
||||
|
||||
**Usage Example:** *Building a GPU shader*
|
||||
|
||||
This example is based on the code in: src/apps/ociodisplay/main.cpp
|
||||
|
||||
.. code-block:: cpp
|
||||
|
||||
// Get the processor
|
||||
//
|
||||
OCIO::ConstConfigRcPtr config = OCIO::Config::CreateFromEnv();
|
||||
OCIO::ConstProcessorRcPtr processor
|
||||
= config->getProcessor("ACES - ACEScg", "Output - sRGB");
|
||||
|
||||
// Step 1: Create a GPU shader description
|
||||
//
|
||||
// The two potential scenarios are:
|
||||
//
|
||||
// 1. 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.
|
||||
//
|
||||
// This is the default OCIO v2 behavior and allows a much better
|
||||
// match between the CPU and GPU renderers.
|
||||
//
|
||||
OCIO::GpuShaderDescRcPtr shaderDesc = OCIO::GpuShaderDesc::Create();
|
||||
//
|
||||
// 2. 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
|
||||
// new class inheriting from the pure virtual class GpuShaderDesc.
|
||||
//
|
||||
// Please refer to the GenericGpuShaderDesc class for an example.
|
||||
//
|
||||
OCIO::GpuShaderDescRcPtr shaderDesc = MyCustomGpuShader::Create();
|
||||
|
||||
shaderDesc->setLanguage(OCIO::GPU_LANGUAGE_GLSL_1_2);
|
||||
shaderDesc->setFunctionName("OCIODisplay");
|
||||
|
||||
// Step 2: Collect the shader program information for a specific processor
|
||||
//
|
||||
processor->extractGpuShaderInfo(shaderDesc);
|
||||
|
||||
// Step 3: Create a helper to build the shader. Here we use a helper for
|
||||
// OpenGL but there will also be helpers for other languages.
|
||||
//
|
||||
OpenGLBuilderRcPtr oglBuilder = OpenGLBuilder::Create(shaderDesc);
|
||||
|
||||
// Step 4: Allocate & upload all the LUTs
|
||||
//
|
||||
oglBuilder->allocateAllTextures();
|
||||
|
||||
// Step 5: Build the complete fragment shader program using
|
||||
// g_fragShaderText which is the client shader program.
|
||||
//
|
||||
g_programId = oglBuilder->buildProgram(g_fragShaderText);
|
||||
|
||||
// Step 6: Enable the fragment shader program, and all needed textures
|
||||
//
|
||||
glUseProgram(g_programId);
|
||||
glUniform1i(glGetUniformLocation(g_programId, "tex1"), 1); // image texture
|
||||
oglBuilder->useAllTextures(g_programId); // LUT textures
|
||||
|
||||
// Step 7: Update uniforms from dynamic property instances.
|
||||
m_oglBuilder->useAllUniforms();
|
||||
Create the legacy shader description.
|
||||
|
||||
|
||||
.. py:method:: GpuShaderDesc.CreateShaderDesc(language: PyOpenColorIO.GpuLanguage = <GpuLanguage.GPU_LANGUAGE_GLSL_1_2: 1>, functionName: str = 'OCIOMain', pixelName: str = 'outColor', resourcePrefix: str = 'ocio', uid: str = '') -> PyOpenColorIO.GpuShaderDesc
|
||||
@@ -146,72 +21,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
|
||||
@@ -248,8 +70,11 @@
|
||||
|
||||
Create the OCIO shader program.
|
||||
|
||||
|
||||
.. note::
|
||||
The OCIO shader program is decomposed to allow a specific implementation to change some parts. Some product integrations add the color processing within a client shader program, imposing constraints requiring this flexibility.
|
||||
|
||||
|
||||
The OCIO shader program is decomposed to allow a specific implementation to change some parts. Some product integrations add the color processing within a client shader program, imposing constraints requiring this flexibility.
|
||||
|
||||
|
||||
.. py:method:: GpuShaderDesc.end(self: PyOpenColorIO.GpuShaderCreator) -> None
|
||||
@@ -266,10 +91,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 +114,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 +154,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 +188,6 @@
|
||||
|
||||
.. py:class:: TextureType
|
||||
:module: PyOpenColorIO.GpuShaderDesc
|
||||
:canonical: PyOpenColorIO.GpuShaderCreator.TextureType
|
||||
|
||||
Members:
|
||||
|
||||
@@ -394,8 +208,9 @@
|
||||
:value: <TextureType.TEXTURE_RGB_CHANNEL: 1>
|
||||
|
||||
|
||||
.. py:property:: TextureType.value
|
||||
.. py:method:: TextureType.value
|
||||
:module: PyOpenColorIO.GpuShaderDesc
|
||||
:property:
|
||||
|
||||
|
||||
.. py:class:: UniformData
|
||||
@@ -422,68 +237,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 +370,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
|
||||
|
||||
@@ -32,6 +32,12 @@
|
||||
Creates an instance of :ref:`GradingPrimaryTransform`.
|
||||
|
||||
|
||||
.. py:method:: GradingPrimaryTransform.__str__()
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Return str(self).
|
||||
|
||||
|
||||
.. py:method:: GradingPrimaryTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -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:
|
||||
|
||||
|
||||
@@ -29,6 +29,12 @@
|
||||
Creates an instance of :ref:`GradingPrimaryTransform`.
|
||||
|
||||
|
||||
.. py:method:: GradingRGBCurveTransform.__str__()
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Return str(self).
|
||||
|
||||
|
||||
.. py:method:: GradingRGBCurveTransform.getBypassLinToLog(self: PyOpenColorIO.GradingRGBCurveTransform) -> bool
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -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:
|
||||
|
||||
|
||||
@@ -34,6 +34,7 @@
|
||||
:value: <GradingStyle.GRADING_VIDEO: 2>
|
||||
|
||||
|
||||
.. py:property:: GradingStyle.value
|
||||
.. py:method:: GradingStyle.value
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
@@ -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:
|
||||
|
||||
|
||||
@@ -40,6 +40,12 @@
|
||||
Creates an instance of :ref:`GradingToneTransform`.
|
||||
|
||||
|
||||
.. py:method:: GradingToneTransform.__str__()
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Return str(self).
|
||||
|
||||
|
||||
.. py:method:: GradingToneTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -22,6 +22,12 @@
|
||||
2. __init__(self: PyOpenColorIO.GroupTransform, transforms: List[PyOpenColorIO.Transform] = [], direction: PyOpenColorIO.TransformDirection = <TransformDirection.TRANSFORM_DIR_FORWARD: 0>) -> None
|
||||
|
||||
|
||||
.. py:method:: GroupTransform.__str__()
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Return str(self).
|
||||
|
||||
|
||||
.. py:method:: GroupTransform.appendTransform(self: PyOpenColorIO.GroupTransform, transform: PyOpenColorIO.Transform) -> None
|
||||
:module: PyOpenColorIO
|
||||
|
||||
@@ -67,15 +73,16 @@
|
||||
|
||||
Write the transforms comprising the group to the stream.
|
||||
|
||||
|
||||
Writing (as opposed to Baking) is a lossless process. An exception is thrown if the processor cannot be losslessly written to the specified file format. Transforms such as :ref:`FileTransform` or :ref:`ColorSpaceTransform` are resolved into write-able simple transforms using the config and context. Supported formats include CTF, CLF, and CDL. All available formats can be listed with the following: .. code-block:: cpp
|
||||
|
||||
// What are the allowed writing output formats?
|
||||
std::ostringstream formats;
|
||||
formats << "Formats to write to: ";
|
||||
for (int i = 0; i < :ref:`GroupTransform::GetNumWriteFormats`(); ++i)
|
||||
for (int i = 0; i < GroupTransform::GetNumWriteFormats(); ++i)
|
||||
{
|
||||
if (i != 0) formats << ", ";
|
||||
formats << :ref:`GroupTransform::GetFormatNameByIndex`(i);
|
||||
formats << GroupTransform::GetFormatNameByIndex(i);
|
||||
formats << " (." << GroupTransform::GetFormatExtensionByIndex(i) << ")";
|
||||
}
|
||||
|
||||
@@ -83,15 +90,16 @@
|
||||
|
||||
Write the transforms comprising the group to the stream.
|
||||
|
||||
|
||||
Writing (as opposed to Baking) is a lossless process. An exception is thrown if the processor cannot be losslessly written to the specified file format. Transforms such as :ref:`FileTransform` or :ref:`ColorSpaceTransform` are resolved into write-able simple transforms using the config and context. Supported formats include CTF, CLF, and CDL. All available formats can be listed with the following: .. code-block:: cpp
|
||||
|
||||
// What are the allowed writing output formats?
|
||||
std::ostringstream formats;
|
||||
formats << "Formats to write to: ";
|
||||
for (int i = 0; i < :ref:`GroupTransform::GetNumWriteFormats`(); ++i)
|
||||
for (int i = 0; i < GroupTransform::GetNumWriteFormats(); ++i)
|
||||
{
|
||||
if (i != 0) formats << ", ";
|
||||
formats << :ref:`GroupTransform::GetFormatNameByIndex`(i);
|
||||
formats << GroupTransform::GetFormatNameByIndex(i);
|
||||
formats << " (." << GroupTransform::GetFormatExtensionByIndex(i) << ")";
|
||||
}
|
||||
|
||||
|
||||
@@ -72,6 +72,7 @@
|
||||
:value: <Interpolation.INTERP_UNKNOWN: 0>
|
||||
|
||||
|
||||
.. py:property:: Interpolation.value
|
||||
.. py:method:: Interpolation.value
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
@@ -87,7 +87,7 @@
|
||||
.. py:method:: LegacyViewingPipeline.setLooksOverride(self: PyOpenColorIO.LegacyViewingPipeline, looks: str) -> None
|
||||
:module: PyOpenColorIO
|
||||
|
||||
A user can optionally override the looks that are, by default, used with the expected display / view combination. A common use case for this functionality is in an image viewing app, where per-shot looks are supported. If for some reason a per-shot look is not defined for the current :ref:`Context`, the :ref:`Config::getProcessor` fcn will not succeed by default. Thus, with this mechanism the viewing app could override to looks = "", and this will allow image display to continue (though hopefully) the interface would reflect this fallback option.
|
||||
A user can optionally override the looks that are, by default, used with the expected display / view combination. A common use case for this functionality is in an image viewing app, where per-shot looks are supported. If for some reason a per-shot look is not defined for the current :ref:`Context`, the Config::getProcessor fcn will not succeed by default. Thus, with this mechanism the viewing app could override to looks = "", and this will allow image display to continue (though hopefully) the interface would reflect this fallback option.
|
||||
|
||||
Looks is a potentially comma (or colon) delimited list of lookNames, where +/- prefixes are optionally allowed to denote forward/inverse look specification (and forward is assumed in the absence of either).
|
||||
|
||||
|
||||
@@ -24,6 +24,12 @@
|
||||
2. __init__(self: PyOpenColorIO.LogAffineTransform, logSideSlope: List[float[3]] = [1.0, 1.0, 1.0], logSideOffset: List[float[3]] = [0.0, 0.0, 0.0], linSideSlope: List[float[3]] = [1.0, 1.0, 1.0], linSideOffset: List[float[3]] = [0.0, 0.0, 0.0], direction: PyOpenColorIO.TransformDirection = <TransformDirection.TRANSFORM_DIR_FORWARD: 0>) -> None
|
||||
|
||||
|
||||
.. py:method:: LogAffineTransform.__str__()
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Return str(self).
|
||||
|
||||
|
||||
.. py:method:: LogAffineTransform.equals(self: PyOpenColorIO.LogAffineTransform, other: PyOpenColorIO.LogAffineTransform) -> bool
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -9,7 +9,6 @@
|
||||
Same as :ref:`LogAffineTransform` but with the addition of a linear segment near black. This formula is used for many camera logs (e.g., LogC) as well as ACEScct.
|
||||
|
||||
- The linSideBreak specifies the point on the linear axis where the log and linear segments meet. It must be set (there is no default).
|
||||
|
||||
- The linearSlope specifies the slope of the linear segment of the forward (linToLog) transform. By default it is set equal to the slope of the log curve at the break point.
|
||||
|
||||
|
||||
@@ -19,6 +18,12 @@
|
||||
LinSideBreak must be set for the transform to be valid (there is no default).
|
||||
|
||||
|
||||
.. py:method:: LogCameraTransform.__str__()
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Return str(self).
|
||||
|
||||
|
||||
.. py:method:: LogCameraTransform.equals(self: PyOpenColorIO.LogCameraTransform, other: PyOpenColorIO.LogCameraTransform) -> bool
|
||||
:module: PyOpenColorIO
|
||||
|
||||
@@ -100,6 +105,7 @@
|
||||
|
||||
Set LinearSlope value.
|
||||
|
||||
|
||||
.. note::
|
||||
You must call setLinSideBreakValue before calling this.
|
||||
|
||||
|
||||
@@ -46,6 +46,7 @@
|
||||
:value: <LoggingLevel.LOGGING_LEVEL_WARNING: 1>
|
||||
|
||||
|
||||
.. py:property:: LoggingLevel.value
|
||||
.. py:method:: LoggingLevel.value
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
@@ -23,6 +23,12 @@
|
||||
2. __init__(self: PyOpenColorIO.LogTransform, base: float = 2.0, direction: PyOpenColorIO.TransformDirection = <TransformDirection.TRANSFORM_DIR_FORWARD: 0>) -> None
|
||||
|
||||
|
||||
.. py:method:: LogTransform.__str__()
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Return str(self).
|
||||
|
||||
|
||||
.. py:method:: LogTransform.equals(self: PyOpenColorIO.LogTransform, other: PyOpenColorIO.LogTransform) -> bool
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -6,8 +6,6 @@
|
||||
.. py:class:: Look
|
||||
:module: PyOpenColorIO
|
||||
|
||||
The *:ref:`Look`* is an 'artistic' image modification, in a specified image state. The processSpace defines the :ref:`ColorSpace` the image is required to be in, for the math to apply correctly.
|
||||
|
||||
|
||||
.. py:method:: Look.__init__(*args, **kwargs)
|
||||
:module: PyOpenColorIO
|
||||
|
||||
@@ -17,6 +17,12 @@
|
||||
2. __init__(self: PyOpenColorIO.LookTransform, src: str, dst: str, looks: str = '', skipColorSpaceConversion: bool = False, direction: PyOpenColorIO.TransformDirection = <TransformDirection.TRANSFORM_DIR_FORWARD: 0>) -> None
|
||||
|
||||
|
||||
.. py:method:: LookTransform.__str__()
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Return str(self).
|
||||
|
||||
|
||||
.. py:method:: LookTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
@@ -34,6 +34,7 @@
|
||||
:value: <Lut1DHueAdjust.HUE_WYPN: 2>
|
||||
|
||||
|
||||
.. py:property:: Lut1DHueAdjust.value
|
||||
.. py:method:: Lut1DHueAdjust.value
|
||||
:module: PyOpenColorIO
|
||||
:property:
|
||||
|
||||
|
||||
@@ -27,6 +27,12 @@
|
||||
Create an identity 1D-LUT with specific length and half-domain setting. Will throw for lengths longer than 1024x1024.
|
||||
|
||||
|
||||
.. py:method:: Lut1DTransform.__str__()
|
||||
:module: PyOpenColorIO
|
||||
|
||||
Return str(self).
|
||||
|
||||
|
||||
.. py:method:: Lut1DTransform.equals(self: PyOpenColorIO.Lut1DTransform, other: PyOpenColorIO.Lut1DTransform) -> bool
|
||||
:module: PyOpenColorIO
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user