From 66158f836335058c433653eec5a7886afe9f62f6 Mon Sep 17 00:00:00 2001 From: Dimitris Apostolou Date: Wed, 15 Jan 2025 02:00:46 +0200 Subject: [PATCH] Fix typos (#1954) Signed-off-by: Dimitris Apostolou --- CONTRIBUTING.md | 50 ++-- SECURITY.md | 37 ++- src/examples/deepExamples.cpp | 2 +- src/examples/deepTiledExamples.cpp | 2 +- src/examples/multipartExamples.cpp | 2 +- src/lib/OpenEXR/ImfChromaticities.cpp | 2 +- src/lib/OpenEXR/ImfChromaticities.h | 2 +- src/lib/OpenEXR/ImfInputFile.h | 2 +- src/lib/OpenEXR/ImfRgbaYca.h | 6 +- src/lib/OpenEXRCore/internal_dwa_encoder.h | 2 +- src/lib/OpenEXRCore/internal_dwa_simd.h | 2 +- src/lib/OpenEXRCore/openexr_context.h | 2 +- .../OpenEXRCoreTest/compressionTables.cpp | 2 +- src/test/OpenEXRTest/testCRgba.cpp | 2 +- .../testDeepScanLineMultipleRead.cpp | 2 +- .../testLargeDataWindowOffsets.cpp | 2 +- .../testOptimizedInterleavePatterns.cpp | 2 +- src/wrappers/python/PyOpenEXR.cpp | 4 +- website/OpenEXRFileLayout.rst | 230 +++++++++--------- website/StandardAttributes.rst | 2 +- website/TheoryDeepPixels.rst | 4 +- website/install.rst | 4 +- website/python.rst | 2 +- website/test_images/index.rst | 4 +- 24 files changed, 184 insertions(+), 187 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1f1011b935..d515daf698 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -192,7 +192,7 @@ remains linear, avoiding the "bubbles" characteristic of the [GitFlow](https://www.endoflineblog.com/gitflow-considered-harmful) workflow. -### Use the Fork, Luke. +### Use the Fork, Luke In a typical workflow, you should **fork** the OpenEXR repository to your account. This creates a copy of the repository under your user @@ -214,7 +214,7 @@ openexr-dev@lists.aswf.io mail list. Contributions should be submitted as GitHub pull requests. See [Creating a pull request](https://help.github.com/articles/creating-a-pull-request/) -if you're unfamiliar with this concept. +if you're unfamiliar with this concept. The development cycle for a code change should follow this protocol: @@ -336,7 +336,7 @@ code. * Function return types go on a separate line: - const float & + const float & Header::pixelAspectRatio () const { ... @@ -452,7 +452,7 @@ each version with three numbers: ``major.minor.patch``, where: * ``major`` - indicates incompatible API changes * ``minor`` - indicates functionality added in a backwards-compatible manner -* ``patch`` - indicates backwards-compatible bug fixes +* ``patch`` - indicates backwards-compatible bug fixes ## Contributing to the Website @@ -474,7 +474,7 @@ Building the website requires that ``sphinx``, ``breathe``, and ``doxygen`` are installed. It further requires the [sphinx-press-theme] (https://pypi.org/project/sphinx-press-theme). Complete dependencies are described in the [requirements.txt](website/requirements.txtg) -file. +file. On Debian/Ubuntu Linux: @@ -498,7 +498,7 @@ browser to preview the resulting website, that is, load ``file:///website/sphinx/index.html`` into your web browser. -Once you submit a PR, a check labled ``docs/readthedocs.org:openexr`` +Once you submit a PR, a check labeled ``docs/readthedocs.org:openexr`` will validate the build. Click on the ``Details`` link to preview. Also, a link to this preview will be added automatically to the PR description. @@ -550,11 +550,11 @@ The preferred workflow is: c. Increment ``OPENEXR_VERSION_PATCH`` in [src/lib/OpenEXRCore/openexr_version.h](src/lib/OpenEXRCore/openexr_version.h) - + d. Update the ``IMATH_TAG`` setting in [cmake/OpenEXRSetup.cmake](cmake/OpenEXRSetup.cmake) to correspond to the proper Imath release. - + e. Add release notes to [CHANGES.md](CHANGES.md): - Generate a list of links to merged pull requests. @@ -589,16 +589,16 @@ The preferred workflow is: - If there are any public CVE's, mention them explicitly with a link to the CVE registry item. - + - Provide an executive summary of the patch changes, in a few sentences as well as bullet points if appropriate. - Choose a proposed release date at least several days in advance. - + f. If there are any public CVE's, reference them in [SECURITY.md](SECURITY.md). - + g. Submit the PR for others to review. The PR should go *to the release branch, not ``main``*, obviously. @@ -611,9 +611,9 @@ The preferred workflow is: i. If further fixes come in that need to go into the release, push them to the PR branch. It's not absolutely essential that all changes to the release branch go in via a PR. The PR is simply a - convient forum for publicly discussing and reviewing the + convenient forum for publicly discussing and reviewing the composition of the release. - + 2. Tag the release with a ``-rc`` "release candidate" tag, e.g. ``v3.1.9-rc``. @@ -636,7 +636,7 @@ The preferred workflow is: Create the release from the latest ``--rc`` tag, and give it a name that begins with ``v``, i.e. ``v3.1.9``. - + Save the release as a "draft". 6. Wait at least 48 hours, to give the community time to discover and @@ -666,16 +666,16 @@ The preferred workflow is: with your GitHub account and git config. b. Create a signed tag with the release name via `git tag -s v3.1.9`. - + c. Push the tag via `git push --tags` - + 8. Publish the release a. Click the "Publish release" button on the GitHub release draft b. Send an email to ``openexr-dev@lists.aswf.io`` officially - annoucing the release. - + announcing the release. + 9. Update the ``release`` branch, which should always point to the most recent patch of the most recent minor release, i.e. the most preferred release. @@ -694,7 +694,7 @@ The preferred workflow is: the associated commit as well. - Also include in this PR edits to [``docs/news.rst``](docs/news.rst) - that add an announcment of the release. + that add an announcement of the release. 11. After review/merge of the updates to ``docs/news.rst``, build the website at https://readthedocs.org/projects/openexr. @@ -740,7 +740,7 @@ To create a new release from the ``main`` branch: - If there are any public CVE's, mention them explicitly with a link to the CVE registry item. - + - Submit this change as a separate PR. 3. Add a mention of the release to [``docs/news.rst``](docs/news.rst) @@ -748,7 +748,7 @@ To create a new release from the ``main`` branch: - Submit this change as a separate PR. 4. Increment the ``OPENEXR_LIB_SOVERSION`` setting in [CMakeLists.txt](CMakeLists.txt). - + - The SO version increases whenever, and only when, the ABI changes in non-backwards-compatible ways. Consistent with the semantic versioning policy, this usually happens at major and minor @@ -770,7 +770,7 @@ To create a new release from the ``main`` branch: of the release with link to the release candidate tag. Include the release notes from [CHANGES.md](CHANGES.md) for review. -9. If additonal fixes need to go in before release: +9. If additional fixes need to go in before release: a. Merge commits to the release branch. Push them directly, no need for a pull request. @@ -790,7 +790,7 @@ To create a new release from the ``main`` branch: - Create the release from the latest ``--rc`` tag, and give it a name that begins with ``v`` and ends in ``0``, e.g. ``v3.2.0``. - + - Save the release as a "draft". 11. Wait at least 48 hours after the email announcement. @@ -800,8 +800,8 @@ To create a new release from the ``main`` branch: a. Click the "Publish release" button on the GitHub release draft b. Send an email to ``openexr-dev@lists.aswf.io`` officially - annoucing the release. - + announcing the release. + 13. Update the ``release`` branch, which should always point to the most recent release. diff --git a/SECURITY.md b/SECURITY.md index 6b26a3ee68..fcaa07698b 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -22,27 +22,27 @@ These vulnerabilities are present in the given versions: * [CVE-2023-5841](https://nvd.nist.gov/vuln/detail/CVE-2023-5841) 3.1.0, 3.1.1, 3.1.2, 3.1.3 3.1.4 3.1.5 3.1.6 3.1.7 3.1.8 3.1.9 3.1.10 3.1.11 3.2.0 3.2.1 * [CVE-2021-45942](https://nvd.nist.gov/vuln/detail/CVE-2021-45942) 3.1.0, 3.1.1, 3.1.2, 3.1.3 -* [CVE-2021-20296](https://nvd.nist.gov/vuln/detail/CVE-2021-20296) 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.5.1, 2.5.2, 2.5.3 -* [CVE-2021-3479](https://nvd.nist.gov/vuln/detail/CVE-2021-3479) 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.5.1, 2.5.2, 2.5.3 -* [CVE-2021-3478](https://nvd.nist.gov/vuln/detail/CVE-2021-3478) 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.5.1, 2.5.2, 2.5.3 -* [CVE-2021-3477](https://nvd.nist.gov/vuln/detail/CVE-2021-3477) 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.5.1, 2.5.2, 2.5.3 -* [CVE-2021-3476](https://nvd.nist.gov/vuln/detail/CVE-2021-3476) 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.5.1, 2.5.2, 2.5.3 -* [CVE-2021-3475](https://nvd.nist.gov/vuln/detail/CVE-2021-3475) 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.5.1, 2.5.2, 2.5.3 -* [CVE-2021-3474](https://nvd.nist.gov/vuln/detail/CVE-2021-3474) 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.5.1, 2.5.2, 2.5.3 +* [CVE-2021-20296](https://nvd.nist.gov/vuln/detail/CVE-2021-20296) 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.5.1, 2.5.2, 2.5.3 +* [CVE-2021-3479](https://nvd.nist.gov/vuln/detail/CVE-2021-3479) 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.5.1, 2.5.2, 2.5.3 +* [CVE-2021-3478](https://nvd.nist.gov/vuln/detail/CVE-2021-3478) 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.5.1, 2.5.2, 2.5.3 +* [CVE-2021-3477](https://nvd.nist.gov/vuln/detail/CVE-2021-3477) 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.5.1, 2.5.2, 2.5.3 +* [CVE-2021-3476](https://nvd.nist.gov/vuln/detail/CVE-2021-3476) 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.5.1, 2.5.2, 2.5.3 +* [CVE-2021-3475](https://nvd.nist.gov/vuln/detail/CVE-2021-3475) 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.5.1, 2.5.2, 2.5.3 +* [CVE-2021-3474](https://nvd.nist.gov/vuln/detail/CVE-2021-3474) 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.5.1, 2.5.2, 2.5.3 * [CVE-2020-16589](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-16589) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0 * [CVE-2020-16588](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-16588) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0 * [CVE-2020-16587](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-16587) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0 * [CVE-2020-15306](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-15306) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0, 2.4.1, 2.5.0, 2.5.1 * [CVE-2020-15305](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-15305) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0, 2.4.1, 2.5.0, 2.5.1 * [CVE-2020-15304](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-15304) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0, 2.4.1, 2.5.0, 2.5.1 -* [CVE-2020-11765](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11765) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0 -* [CVE-2020-11764](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11764) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0 -* [CVE-2020-11763](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11763) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0 -* [CVE-2020-11762](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11762) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0 -* [CVE-2020-11761](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11761) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0 -* [CVE-2020-11760](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11760) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0 -* [CVE-2020-11759](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11759) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0 -* [CVE-2020-11758](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11758) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0 +* [CVE-2020-11765](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11765) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0 +* [CVE-2020-11764](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11764) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0 +* [CVE-2020-11763](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11763) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0 +* [CVE-2020-11762](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11762) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0 +* [CVE-2020-11761](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11761) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0 +* [CVE-2020-11760](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11760) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0 +* [CVE-2020-11759](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11759) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0 +* [CVE-2020-11758](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11758) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0 * [CVE-2018-18444](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2018-18444) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0 * [CVE-2018-18443](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2018-18443) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0 * [CVE-2017-9116](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2017-9116) 2.0.0, 2.0.1, 2.1.0, 2.2.0 @@ -108,7 +108,7 @@ To verify a downloaded release at a given tag: The website implements no interactive features and requires no login credentials. -- The library reads and writes only to file paths specificly requested +- The library reads and writes only to file paths specifically requested via the C/C++ API. The runtime library uses no system configuration files or sidecar data files. Access to data files uses only standard file I/O system calls. @@ -140,7 +140,7 @@ to scan for dependency vulnerability. Potential entry points are images being loaded using the library. Malformed images could caused issues such as heap buffer overflows, out-of-memory faults, or segmentation faults that could be -exploitable as denial-of-service attacks. +exploitable as denial-of-service attacks. ### Hardening @@ -172,6 +172,3 @@ changes are reviewed by multiple TSC members. The library is distributed in binary form via many common package managers across all platforms. - - - diff --git a/src/examples/deepExamples.cpp b/src/examples/deepExamples.cpp index 9452186db6..e334393bf2 100644 --- a/src/examples/deepExamples.cpp +++ b/src/examples/deepExamples.cpp @@ -47,7 +47,7 @@ readDeepScanlineFile ( // - allocate memory for the pixels // - describe the layout of the A, and Z pixel buffers // - read the sample counts from the file - // - allocate the memory requred to store the samples + // - allocate the memory required to store the samples // - read the pixels from the file // diff --git a/src/examples/deepTiledExamples.cpp b/src/examples/deepTiledExamples.cpp index acf04d0520..6fbc6cb945 100644 --- a/src/examples/deepTiledExamples.cpp +++ b/src/examples/deepTiledExamples.cpp @@ -54,7 +54,7 @@ readDeepTiledFile ( // - allocate memory for the pixels // - describe the layout of the A, and Z pixel buffers // - read the sample counts from the file - // - allocate the memory requred to store the samples + // - allocate the memory required to store the samples // - read the pixels from the file // diff --git a/src/examples/multipartExamples.cpp b/src/examples/multipartExamples.cpp index 79ae0c49e3..7009652bfc 100644 --- a/src/examples/multipartExamples.cpp +++ b/src/examples/multipartExamples.cpp @@ -94,7 +94,7 @@ combineFiles () // // Read multiple single-part input files and write them as a multi-part file. // If an input file is multi-part, only one part is copied. - // All input files dimentions must be the same. + // All input files dimensions must be the same. // std::vector inputFiles; diff --git a/src/lib/OpenEXR/ImfChromaticities.cpp b/src/lib/OpenEXR/ImfChromaticities.cpp index 242277909b..bccd6473e6 100644 --- a/src/lib/OpenEXR/ImfChromaticities.cpp +++ b/src/lib/OpenEXR/ImfChromaticities.cpp @@ -6,7 +6,7 @@ //----------------------------------------------------------------------------- // // CIE (x,y) chromaticities, and conversions between -// RGB tiples and CIE XYZ tristimulus values. +// RGB triples and CIE XYZ tristimulus values. // //----------------------------------------------------------------------------- diff --git a/src/lib/OpenEXR/ImfChromaticities.h b/src/lib/OpenEXR/ImfChromaticities.h index b131fd241b..ddea3e47e4 100644 --- a/src/lib/OpenEXR/ImfChromaticities.h +++ b/src/lib/OpenEXR/ImfChromaticities.h @@ -9,7 +9,7 @@ //----------------------------------------------------------------------------- // // CIE (x,y) chromaticities, and conversions between -// RGB tiples and CIE XYZ tristimulus values. +// RGB triples and CIE XYZ tristimulus values. // //----------------------------------------------------------------------------- diff --git a/src/lib/OpenEXR/ImfInputFile.h b/src/lib/OpenEXR/ImfInputFile.h index f5d67ddb32..f71f2ef8aa 100644 --- a/src/lib/OpenEXR/ImfInputFile.h +++ b/src/lib/OpenEXR/ImfInputFile.h @@ -212,7 +212,7 @@ class IMF_EXPORT_TYPE InputFile // in a threadsafe manner (where the only way that was possible // before was to have a larger framebuffer, set the framebuffer // once, then call readPixels by the external threads, although - // that occured with a mutex and so the reads were serialized. + // that occurred with a mutex and so the reads were serialized. // There are reasons why that might still be serialized, such as a // non-threadable stream. //---------------------------------------------- diff --git a/src/lib/OpenEXR/ImfRgbaYca.h b/src/lib/OpenEXR/ImfRgbaYca.h index 93f67bb5dc..f40efa0880 100644 --- a/src/lib/OpenEXR/ImfRgbaYca.h +++ b/src/lib/OpenEXR/ImfRgbaYca.h @@ -47,7 +47,7 @@ // YCA YCA YCA YCA ... YCA YCA // YCA YCA YCA YCA ... YCA YCA // -// Next, decimateChomaHoriz() eliminates the chroma values from +// Next, decimateChromaHoriz() eliminates the chroma values from // the odd-numbered pixels in every scan line: // // YCA YA YCA YA ... YCA YA @@ -152,7 +152,7 @@ void decimateChromaVert (int n, const Rgba* const ycaIn[N], Rgba ycaOut[/*n*/]); // // Round the luminance and chroma channels of an array of YCA // pixels that has already been filtered and subsampled. -// The signifcands of the pixels' luminance and chroma values +// The significands of the pixels' luminance and chroma values // are rounded to roundY and roundC bits respectively. // @@ -175,7 +175,7 @@ reconstructChromaHoriz (int n, const Rgba ycaIn[/*n+N-1*/], Rgba ycaOut[/*n*/]); // // For a scan line that has only luminance and no valid chroma data, -// reconstruct chroma from the surronding N scan lines. +// reconstruct chroma from the surrounding N scan lines. // IMF_EXPORT diff --git a/src/lib/OpenEXRCore/internal_dwa_encoder.h b/src/lib/OpenEXRCore/internal_dwa_encoder.h index 2ad6c5ed73..66ab952996 100644 --- a/src/lib/OpenEXRCore/internal_dwa_encoder.h +++ b/src/lib/OpenEXRCore/internal_dwa_encoder.h @@ -860,7 +860,7 @@ static uint16_t algoQuantize ( // // 99.99% of the time, the mask or round will be a good choice, // but only in a few combinations of tolerance will the truncation - // be needed because the mask trunction will be out of range, + // be needed because the mask truncation will be out of range, // which is not surprising given we're just shifting the // significand of the half-float tolerance, where the tolerance is // against the original 32-bit value, but can be quickly tested diff --git a/src/lib/OpenEXRCore/internal_dwa_simd.h b/src/lib/OpenEXRCore/internal_dwa_simd.h index 11f194c1af..a54d9e5962 100644 --- a/src/lib/OpenEXRCore/internal_dwa_simd.h +++ b/src/lib/OpenEXRCore/internal_dwa_simd.h @@ -1434,7 +1434,7 @@ dctInverse8x8_sse2_7 (float* data) \ /* Sum the M1 (ymm0-3) and M2 (ymm4-7) results to get the * front halves of the results, and difference to get the - * back halves. The front halfs end up in ymm0-3, the back + * back halves. The front halves end up in ymm0-3, the back * halves end up in ymm12-15. */ \ ROW0( IDCT_AVX_EO_TO_ROW_HALVES(0, 4, 0, 12) ) \ diff --git a/src/lib/OpenEXRCore/openexr_context.h b/src/lib/OpenEXRCore/openexr_context.h index ee5d133556..57e0b6be28 100644 --- a/src/lib/OpenEXRCore/openexr_context.h +++ b/src/lib/OpenEXRCore/openexr_context.h @@ -474,7 +474,7 @@ EXR_EXPORT exr_result_t exr_start_inplace_header_update ( * requirement of actual file i/o. * * Note that this creates an defines an initial part for use, so one - * can immediately start definining attributes into part index 0. + * can immediately start defining attributes into part index 0. * * See the initializer context documentation \ref * exr_context_initializer_t to be able to provide allocation diff --git a/src/test/OpenEXRCoreTest/compressionTables.cpp b/src/test/OpenEXRCoreTest/compressionTables.cpp index 950fa09eca..684f8ec806 100644 --- a/src/test/OpenEXRCoreTest/compressionTables.cpp +++ b/src/test/OpenEXRCoreTest/compressionTables.cpp @@ -1312,7 +1312,7 @@ static uint16_t algoQuantize ( // // 99.99% of the time, the mask or round will be a good choice, // but only in a few combinations of tolerance will the truncation - // be needed because the mask trunction will be out of range, + // be needed because the mask truncation will be out of range, // which is not surprising given we're just shifting the // significand of the half-float tolerance, where the tolerance is // against the original 32-bit value, but can be quickly tested diff --git a/src/test/OpenEXRTest/testCRgba.cpp b/src/test/OpenEXRTest/testCRgba.cpp index 174017fe46..cc5fd0a218 100644 --- a/src/test/OpenEXRTest/testCRgba.cpp +++ b/src/test/OpenEXRTest/testCRgba.cpp @@ -94,7 +94,7 @@ writeReadCRGBA ( ImfHeaderSetDataWindow (headerPtr, 0, 0, width - 1, height - 1); ImfHeaderSetDisplayWindow (headerPtr, 0, 0, width - 1, height - 1); - // Get screenWindowCenter for comparision + // Get screenWindowCenter for comparison float xScreenWindowCenterOut, yScreenWindowCenterOut; ImfHeaderScreenWindowCenter (headerPtr, &xScreenWindowCenterOut, &yScreenWindowCenterOut); diff --git a/src/test/OpenEXRTest/testDeepScanLineMultipleRead.cpp b/src/test/OpenEXRTest/testDeepScanLineMultipleRead.cpp index eacab0361b..47d00e08ed 100644 --- a/src/test/OpenEXRTest/testDeepScanLineMultipleRead.cpp +++ b/src/test/OpenEXRTest/testDeepScanLineMultipleRead.cpp @@ -183,7 +183,7 @@ read_file (const char* filename) if (samples[i] != row + 100.f) { cout << " sample " << i << " on row " << row - << " error, shuold be " << 100.f + row << " got " + << " error, should be " << 100.f + row << " got " << samples[i] << endl; cout << flush; } diff --git a/src/test/OpenEXRTest/testLargeDataWindowOffsets.cpp b/src/test/OpenEXRTest/testLargeDataWindowOffsets.cpp index 4973a3fc30..0df8a92ee8 100644 --- a/src/test/OpenEXRTest/testLargeDataWindowOffsets.cpp +++ b/src/test/OpenEXRTest/testLargeDataWindowOffsets.cpp @@ -155,7 +155,7 @@ setupBuffer ( else { readingBuffer.resize (size); } const char* write_ptr = writing ? &writingBuffer[0] : &readingBuffer[0]; - // fill with random halfs, casting to floats for float channels - don't write NaN values + // fill with random halves, casting to floats for float channels - don't write NaN values size_t chan = 0; for (size_t i = 0; i < samples; i++) { diff --git a/src/test/OpenEXRTest/testOptimizedInterleavePatterns.cpp b/src/test/OpenEXRTest/testOptimizedInterleavePatterns.cpp index ae9a27de71..7995865d00 100644 --- a/src/test/OpenEXRTest/testOptimizedInterleavePatterns.cpp +++ b/src/test/OpenEXRTest/testOptimizedInterleavePatterns.cpp @@ -362,7 +362,7 @@ setupBuffer ( else { readingBuffer.resize (size); } const char* write_ptr = writing ? &writingBuffer[0] : &readingBuffer[0]; - // fill with random halfs, casting to floats for float channels + // fill with random halves, casting to floats for float channels int chan = 0; for (int i = 0; i < samples; i++) { diff --git a/src/wrappers/python/PyOpenEXR.cpp b/src/wrappers/python/PyOpenEXR.cpp index 47476b0ba1..cf8e239c02 100644 --- a/src/wrappers/python/PyOpenEXR.cpp +++ b/src/wrappers/python/PyOpenEXR.cpp @@ -1986,7 +1986,7 @@ PyPart::PyPart(const py::dict& header, const py::dict& channels, const std::stri } // - // Validate that all channel dict keys are strings, and initialze the + // Validate that all channel dict keys are strings, and initialize the // channel name field. // @@ -2644,7 +2644,7 @@ PYBIND11_MODULE(OpenEXR, m) py::arg("header"), py::arg("channels"), R"pbdoc( - Initialize a File with metdata and pixels. Creates a single-part EXR file. + Initialize a File with metadata and pixels. Creates a single-part EXR file. Parameters ---------- diff --git a/website/OpenEXRFileLayout.rst b/website/OpenEXRFileLayout.rst index a18080ddbe..9e99e8f4ae 100644 --- a/website/OpenEXRFileLayout.rst +++ b/website/OpenEXRFileLayout.rst @@ -878,121 +878,121 @@ Predefined Attribute Types The OpenEXR library predefines the following attribute types: -+--------------------+----------------------------------------------------------------+ -| type name | data | -+====================+================================================================+ -| ``box2i`` | Four ``int``\ 's: ``xMin``, ``yMin``, ``xMax``, ``yMax`` | -+--------------------+----------------------------------------------------------------+ -| ``box2f`` | Four ``float``\ 's: ``xMin``, ``yMin``, ``xMax``, ``yMax`` | -+--------------------+----------------------------------------------------------------+ -| ``chlist`` | A sequence of channels followed by a null byte (``0x00``). | -| | Channel layout: | -| +----------------+-----------------------------------------------+ -| | name | zero-terminated string, from 1 to 255 bytes | -| | | long | -| +----------------+-----------------------------------------------+ -| | ``pixel type`` | ``int``, possible values are: | -| | | | -| | | * ``UINT`` = 0 | -| | | * ``HALF`` = 1 | -| | | * ``FLOAT`` = 2 | -| | | | -| +----------------+-----------------------------------------------+ -| | ``pLinear`` | ``usigned char``, possible values are 0 and 1 | -| +----------------+-----------------------------------------------+ -| | ``reserved`` | three ``char``, should be zero | -| +----------------+-----------------------------------------------+ -| | ``xSampling`` | ``int`` | -| +----------------+-----------------------------------------------+ -| | ``ySampling`` | ``int`` | -+--------------------+----------------+-----------------------------------------------+ -| ``chromaticities`` | Eight ``float``: ``redX``, ``redY``, ``greenX``, | -| | ``greenY``, ``blueX``, ``blueY``, ``whiteX``, ``whiteY`` | -+--------------------+----------------------------------------------------------------+ -| ``compression`` | ``unsigned char``, possible values are: | -| | | -| | * ``NO_COMPRESSION`` = 0 | -| | * ``RLE_COMPRESSION`` = 1 | -| | * ``ZIPS_COMPRESSION`` = 2 | -| | * ``ZIP_COMPRESSION`` = 3 | -| | * ``PIZ_COMPRESSION`` = 4 | -| | * ``PXR24_COMPRESSION`` = 5 | -| | * ``B44_COMPRESSION`` = 6 | -| | * ``B44A_COMPRESSION`` = 7 | -| | * ``DWAA_COMPRESSION`` = 8 | -| | * ``DWAB_COMPRESSION`` = 9 | -| | | -+--------------------+----------------------------------------------------------------+ -| ``double`` | ``double`` | -+--------------------+----------------------------------------------------------------+ -| ``envmap`` | ``unsigned char``, possible values are: | -| | | -| | * ``ENVMAP_LATLONG`` = 0 | -| | * ``ENVMAP_CUBE`` = 1 | -| | | -+--------------------+----------------------------------------------------------------+ -| ``float`` | ``float`` | -+--------------------+----------------------------------------------------------------+ -| ``int`` | ``int`` | -+--------------------+----------------------------------------------------------------+ -| ``keycode`` | Seven ``int``\ 's: ``filmMfcCode``, ``filmType``, ``prefix``, | -| | ``count``, ``perfOffset``, ``perfsPerFrame``, ``perfsPerCount``| -+--------------------+----------------------------------------------------------------+ -| ``lineOrder`` | ``unsigned char``, possible values are: | -| | | -| | * ``INCREASING_Y`` = 0 | -| | * ``DECREASING_Y`` = 1 | -| | * ``RANDOM_Y`` = 2 | -| | | -+--------------------+----------------------------------------------------------------+ -| ``m33f`` | 9 ``float``\ 's | -+--------------------+----------------------------------------------------------------+ -| ``m44f`` | 16 ``float``\ 's | -+--------------------+----------------------------------------------------------------+ -| ``preview`` | Two ``unsigned int``\ 's, width and height, followed by | -| | 4×width×height ``unsigned char``\ 's of pixel data. | -| | Scan lines are stored top to bottom; within a scan line | -| | pixels are stored from left to right. A pixel consists of | -| | four ``unsigned char``\ 's, ``R``, ``G``, ``B``, ``A``. | -+--------------------+----------------------------------------------------------------+ -| ``rational`` | An ``int``, followed by an ``unsigned int``. | -+--------------------+----------------------------------------------------------------+ -| ``string`` | String length, of type ``int``, followed by a sequence of | -| | ``char``\ 's. | -+--------------------+----------------------------------------------------------------+ -| ``stringvector`` | A sequence of zero or more text strings. Each string is | -| | represented as a string length, of type ``int``, followed by a | -| | sequence of ``chars``. The number of strings can be inferred | -| | from the total attribute size | -| | (see the `Attribute Layout`_ section). | -+--------------------+----------------------------------------------------------------+ -| ``tiledesc`` | Two ``unsigned int``\ 's: ``xSize``, ``ySize``, followed | -| | by ``mode``, of type ``unsigned char``, where | -| | | -| | mode = levelMode + roundingMode×16 | -| | | -| | Possible values for ``levelMode``: | -| | | -| | * ``ONE_LEVEL`` = 0 | -| | * ``MIPMAP_LEVELS`` = 1 | -| | * ``RIPMAP_LEVELS`` = 2 | -| | | -| | Possible values for ``roundingMode``: | -| | | -| | * ``ROUND_DOWN`` = 0 | -| | * ``ROUND_UP`` = 1 | -| | | -+--------------------+----------------------------------------------------------------+ -| ``timecode`` | Two ``unsigned int``\ 's: ``timeAndFlags``, ``userData``. | -+--------------------+----------------------------------------------------------------+ -| ``v2i`` | Two ``int``\ 's | -+--------------------+----------------------------------------------------------------+ -| ``v2f`` | Two ``float``\ 's | -+--------------------+----------------------------------------------------------------+ -| ``v3i`` | Three ``int``\ 's. | -+--------------------+----------------------------------------------------------------+ -| ``v3f`` | Three ``float``\ 's. | -+--------------------+----------------------------------------------------------------+ ++--------------------+-----------------------------------------------------------------+ +| type name | data | ++====================+=================================================================+ +| ``box2i`` | Four ``int``\ 's: ``xMin``, ``yMin``, ``xMax``, ``yMax`` | ++--------------------+-----------------------------------------------------------------+ +| ``box2f`` | Four ``float``\ 's: ``xMin``, ``yMin``, ``xMax``, ``yMax`` | ++--------------------+-----------------------------------------------------------------+ +| ``chlist`` | A sequence of channels followed by a null byte (``0x00``). | +| | Channel layout: | +| +----------------+------------------------------------------------+ +| | name | zero-terminated string, from 1 to 255 bytes | +| | | long | +| +----------------+------------------------------------------------+ +| | ``pixel type`` | ``int``, possible values are: | +| | | | +| | | * ``UINT`` = 0 | +| | | * ``HALF`` = 1 | +| | | * ``FLOAT`` = 2 | +| | | | +| +----------------+------------------------------------------------+ +| | ``pLinear`` | ``unsigned char``, possible values are 0 and 1 | +| +----------------+------------------------------------------------+ +| | ``reserved`` | three ``char``, should be zero | +| +----------------+------------------------------------------------+ +| | ``xSampling`` | ``int`` | +| +----------------+------------------------------------------------+ +| | ``ySampling`` | ``int`` | ++--------------------+----------------+------------------------------------------------+ +| ``chromaticities`` | Eight ``float``: ``redX``, ``redY``, ``greenX``, | +| | ``greenY``, ``blueX``, ``blueY``, ``whiteX``, ``whiteY`` | ++--------------------+-----------------------------------------------------------------+ +| ``compression`` | ``unsigned char``, possible values are: | +| | | +| | * ``NO_COMPRESSION`` = 0 | +| | * ``RLE_COMPRESSION`` = 1 | +| | * ``ZIPS_COMPRESSION`` = 2 | +| | * ``ZIP_COMPRESSION`` = 3 | +| | * ``PIZ_COMPRESSION`` = 4 | +| | * ``PXR24_COMPRESSION`` = 5 | +| | * ``B44_COMPRESSION`` = 6 | +| | * ``B44A_COMPRESSION`` = 7 | +| | * ``DWAA_COMPRESSION`` = 8 | +| | * ``DWAB_COMPRESSION`` = 9 | +| | | ++--------------------+-----------------------------------------------------------------+ +| ``double`` | ``double`` | ++--------------------+-----------------------------------------------------------------+ +| ``envmap`` | ``unsigned char``, possible values are: | +| | | +| | * ``ENVMAP_LATLONG`` = 0 | +| | * ``ENVMAP_CUBE`` = 1 | +| | | ++--------------------+-----------------------------------------------------------------+ +| ``float`` | ``float`` | ++--------------------+-----------------------------------------------------------------+ +| ``int`` | ``int`` | ++--------------------+-----------------------------------------------------------------+ +| ``keycode`` | Seven ``int``\ 's: ``filmMfcCode``, ``filmType``, ``prefix``, | +| | ``count``, ``perfOffset``, ``perfsPerFrame``, ``perfsPerCount`` | ++--------------------+-----------------------------------------------------------------+ +| ``lineOrder`` | ``unsigned char``, possible values are: | +| | | +| | * ``INCREASING_Y`` = 0 | +| | * ``DECREASING_Y`` = 1 | +| | * ``RANDOM_Y`` = 2 | +| | | ++--------------------+-----------------------------------------------------------------+ +| ``m33f`` | 9 ``float``\ 's | ++--------------------+-----------------------------------------------------------------+ +| ``m44f`` | 16 ``float``\ 's | ++--------------------+-----------------------------------------------------------------+ +| ``preview`` | Two ``unsigned int``\ 's, width and height, followed by | +| | 4×width×height ``unsigned char``\ 's of pixel data. | +| | Scan lines are stored top to bottom; within a scan line | +| | pixels are stored from left to right. A pixel consists of | +| | four ``unsigned char``\ 's, ``R``, ``G``, ``B``, ``A``. | ++--------------------+-----------------------------------------------------------------+ +| ``rational`` | An ``int``, followed by an ``unsigned int``. | ++--------------------+-----------------------------------------------------------------+ +| ``string`` | String length, of type ``int``, followed by a sequence of | +| | ``char``\ 's. | ++--------------------+-----------------------------------------------------------------+ +| ``stringvector`` | A sequence of zero or more text strings. Each string is | +| | represented as a string length, of type ``int``, followed by a | +| | sequence of ``chars``. The number of strings can be inferred | +| | from the total attribute size | +| | (see the `Attribute Layout`_ section). | ++--------------------+-----------------------------------------------------------------+ +| ``tiledesc`` | Two ``unsigned int``\ 's: ``xSize``, ``ySize``, followed | +| | by ``mode``, of type ``unsigned char``, where | +| | | +| | mode = levelMode + roundingMode×16 | +| | | +| | Possible values for ``levelMode``: | +| | | +| | * ``ONE_LEVEL`` = 0 | +| | * ``MIPMAP_LEVELS`` = 1 | +| | * ``RIPMAP_LEVELS`` = 2 | +| | | +| | Possible values for ``roundingMode``: | +| | | +| | * ``ROUND_DOWN`` = 0 | +| | * ``ROUND_UP`` = 1 | +| | | ++--------------------+-----------------------------------------------------------------+ +| ``timecode`` | Two ``unsigned int``\ 's: ``timeAndFlags``, ``userData``. | ++--------------------+-----------------------------------------------------------------+ +| ``v2i`` | Two ``int``\ 's | ++--------------------+-----------------------------------------------------------------+ +| ``v2f`` | Two ``float``\ 's | ++--------------------+-----------------------------------------------------------------+ +| ``v3i`` | Three ``int``\ 's. | ++--------------------+-----------------------------------------------------------------+ +| ``v3f`` | Three ``float``\ 's. | ++--------------------+-----------------------------------------------------------------+ Sample File diff --git a/website/StandardAttributes.rst b/website/StandardAttributes.rst index 8cad51fb3e..80dbb1e225 100644 --- a/website/StandardAttributes.rst +++ b/website/StandardAttributes.rst @@ -904,7 +904,7 @@ These attributes describe the lens settings. All are optional. float

- Mumber printed on barrel of a prime lens, or number next to index + Number printed on barrel of a prime lens, or number next to index mark on a zoom lens, in units of millimeters.

diff --git a/website/TheoryDeepPixels.rst b/website/TheoryDeepPixels.rst index 86d657b232..e0b4945762 100644 --- a/website/TheoryDeepPixels.rst +++ b/website/TheoryDeepPixels.rst @@ -17,7 +17,7 @@ Definitions =========== +-----------------------+--------------------------------------------------------------------------+ -| symbol | descripion | +| symbol | description | +=======================+==========================================================================+ | :math:`r` | ratio of length of original sample to a subsample: :math:`0\le r \le 1` | +-----------------------+--------------------------------------------------------------------------+ @@ -33,7 +33,7 @@ Definitions +-----------------------+--------------------------------------------------------------------------+ | :math:`\mathbf{c_i}` | colour per unit length (‘instantaneous colour’) of :math:`i` | +-----------------------+--------------------------------------------------------------------------+ -| :math:`t_i` | transparency per unit length (‘intanstaneous transparency’) of :math:`i` | +| :math:`t_i` | transparency per unit length (‘instantaneous transparency’) of :math:`i` | +-----------------------+--------------------------------------------------------------------------+ Subscripts :math:`_a` and :math:`_b` refer to the input samples; diff --git a/website/install.rst b/website/install.rst index 36d03f2614..ec5f05a412 100644 --- a/website/install.rst +++ b/website/install.rst @@ -280,7 +280,7 @@ You can customize these options three ways: Uninstall ~~~~~~~~~ -If you did a binary instal of OpenEXR via a package manager +If you did a binary install of OpenEXR via a package manager (`apt-get`, `yum`, `port`, `brew`, etc), use the package manager to uninstall. @@ -395,7 +395,7 @@ TBB Dependency OpenEXR can optionally use the TBB library as the default global thread pool as a thread provider. This allows applications which also use TBB for other purposes to lower the number of active threads. With -high core count machines more prevalent, this can signficantly lower +high core count machines more prevalent, this can significantly lower the number of active threads and so the improve available resources especially when compiling with a static library and using plugins which use OpenEXR. diff --git a/website/python.rst b/website/python.rst index d19b6b4d16..a4c8c838a6 100644 --- a/website/python.rst +++ b/website/python.rst @@ -389,7 +389,7 @@ The channel pixel arrays must have a ``dtype`` of ``uint32``, ``float16``, or ``float32``. All channel pixel arrays within a given part must have the same -dimenions. The ``write`` method will throw an exception if they are +dimensions. The ``write`` method will throw an exception if they are not. .. code-block:: diff --git a/website/test_images/index.rst b/website/test_images/index.rst index 32dc7c00f3..baafac855e 100644 --- a/website/test_images/index.rst +++ b/website/test_images/index.rst @@ -1182,8 +1182,8 @@ Note the following about these images: included here merely to illustrate that channels needn't be associated with a view.* -* The **depth** channel is called ``"Z"`` in all cases, in keeping wih - the convention for deep images +* The **depth** channel is called ``"Z"`` in all cases, in keeping with + the convention for deep images. The convention is optional for regular scanline and tile images, but is is practical to maintain it for all image types.