[WIP] Initial commit

kimikage · Apr 14, 2024 · f6f52d7 · f6f52d7
commit f6f52d7
Show file tree

Hide file tree

Showing 40 changed files with 2,531 additions and 0 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,7 @@
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -0,0 +1,83 @@
+name: CI
+on:
+  push:
+    branches: main
+    tags: ['*']
+  pull_request:
+  workflow_dispatch:
+concurrency:
+  # Skip intermediate builds: always.
+  # Cancel intermediate builds: only if it is a pull request build.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+jobs:
+  test:
+    name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 60
+    permissions: # needed to allow julia-actions/cache to proactively delete old caches that it has created
+      actions: write
+      contents: read
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - '1.6'
+          - '1'
+          - 'nightly'
+        os:
+          - ubuntu-latest
+          - windows-latest
+          - macos-latest
+        arch:
+          - x64
+        include:
+          - os: ubuntu-latest
+            version: '1'
+            arch: x86
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: ${{ matrix.version }}
+          arch: ${{ matrix.arch }}
+      - uses: julia-actions/cache@v1
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-runtest@v1
+      - uses: julia-actions/julia-processcoverage@v1
+      - uses: codecov/codecov-action@v4
+        with:
+          files: lcov.info
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    permissions:
+      actions: write # needed to allow julia-actions/cache to proactively delete old caches that it has created
+      contents: write
+      statuses: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: '1'
+      - uses: julia-actions/cache@v1
+      - name: Configure doc environment
+        shell: julia --project=docs --color=yes {0}
+        run: |
+          using Pkg
+          Pkg.develop(PackageSpec(path=pwd()))
+          Pkg.instantiate()
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-docdeploy@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
+      - name: Run doctests
+        shell: julia --project=docs --color=yes {0}
+        run: |
+          using Documenter: DocMeta, doctest
+          using YUVColorTypes
+          DocMeta.setdocmeta!(YUVColorTypes, :DocTestSetup, :(using YUVColorTypes); recursive=true)
+          doctest(YUVColorTypes)
diff --git a/.github/workflows/CompatHelper.yml b/.github/workflows/CompatHelper.yml
@@ -0,0 +1,19 @@
+name: CompatHelper
+on:
+  schedule:
+    - cron: 52 3 * * *
+  workflow_dispatch:
+jobs:
+  CompatHelper:
+    permissions:
+      pull-requests: write
+      contents: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: Pkg.add("CompatHelper")
+        run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
+      - name: CompatHelper.main()
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}
+        run: julia -e 'using CompatHelper; CompatHelper.main()'
diff --git a/.github/workflows/TagBot.yml b/.github/workflows/TagBot.yml
@@ -0,0 +1,31 @@
+name: TagBot
+on:
+  issue_comment:
+    types:
+      - created
+  workflow_dispatch:
+    inputs:
+      lookback:
+        default: "3"
+permissions:
+  actions: read
+  checks: read
+  contents: write
+  deployments: read
+  issues: read
+  discussions: read
+  packages: read
+  pages: read
+  pull-requests: read
+  repository-projects: read
+  security-events: read
+  statuses: read
+jobs:
+  TagBot:
+    if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: JuliaRegistries/TagBot@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          ssh: ${{ secrets.DOCUMENTER_KEY }}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,24 @@
+# Files generated by invoking Julia with --code-coverage
+*.jl.cov
+*.jl.*.cov
+
+# Files generated by invoking Julia with --track-allocation
+*.jl.mem
+
+# System-specific files and directories generated by the BinaryProvider and BinDeps packages
+# They contain absolute paths specific to the host computer, and so should not be committed
+deps/deps.jl
+deps/build.log
+deps/downloads/
+deps/usr/
+deps/src/
+
+# Build artifacts for creating documentation generated by the Documenter package
+docs/build/
+docs/site/
+
+# File generated by Pkg, the package manager, based on a corresponding Project.toml
+# It records a fixed state of all packages used by the project. As such, it should not be
+# committed for packages, but should be committed for applications that require a static
+# environment.
+Manifest.toml
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 kimikage
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/Project.toml b/Project.toml
@@ -0,0 +1,19 @@
+name = "YUVColorTypes"
+uuid = "eba940b6-338b-4313-b123-2632d2e8bfe5"
+version = "0.1.0"
+
+[deps]
+ColorTypes = "3da002f7-5984-5a60-b8a6-cbb66c0b333f"
+
+[compat]
+ColorTypes = "0.11"
+julia = "1"
+
+[extras]
+Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
+FFMPEG = "c87230d0-a227-11e9-1b43-d7ebe4e7570a"
+FixedPointNumbers = "53c48c17-4a7d-5ca2-90c5-79b7896eea93"
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
+[targets]
+test = ["Colors", "FFMPEG", "FixedPointNumbers", "Test"]
diff --git a/README.md b/README.md
@@ -0,0 +1,7 @@
+# YUVColorTypes.jl
+[![Docs Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://kimikage.github.io/YUVColorTypes.jl/stable)
+[![Docs Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://kimikage.github.io/YUVColorTypes.jl/dev)
+[![CI](https://github.com/kimikage/YUVColorTypes.jl/workflows/CI/badge.svg)](https://github.com/kimikage/YUVColorTypes.jl/actions?query=workflow%3ACI)
+[![codecov](https://codecov.io/gh/kimikage/YUVColorTypes.jl/graph/badge.svg?token=L3HJIA02NL)](https://codecov.io/gh/kimikage/YUVColorTypes.jl)
+
+Enhanced support for YUV-like color types
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -0,0 +1,8 @@
+[deps]
+ColorTypes = "3da002f7-5984-5a60-b8a6-cbb66c0b333f"
+Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+FixedPointNumbers = "53c48c17-4a7d-5ca2-90c5-79b7896eea93"
+
+[compat]
+Documenter = "1"
diff --git a/docs/make.jl b/docs/make.jl
@@ -0,0 +1,32 @@
+using Documenter, YUVColorTypes
+using Colors
+
+if :size_threshold in fieldnames(Documenter.HTML)
+    size_th = (
+        example_size_threshold = nothing,
+        size_threshold = nothing,
+    )
+else
+    size_th = ()
+end
+
+makedocs(
+    clean=false,
+    warnonly=true, # FIXME
+    modules=[YUVColorTypes],
+    format=Documenter.HTML(;prettyurls = get(ENV, "CI", nothing) == "true",
+                           size_th...,
+                           assets = []),
+    sitename="YUVColorTypes",
+    pages=[
+        "Introduction" => "index.md",
+        "Supported Profiles" => "profiles.md",
+        "Adding Profiles" => "addingprofiles.md",
+        "API Reference" => "api.md",
+    ]
+)
+
+deploydocs(
+    repo="github.com/kimikage/YUVColorTypes.jl.git",
+    push_preview = true
+)
diff --git a/docs/src/addingprofiles.md b/docs/src/addingprofiles.md
@@ -0,0 +1,35 @@
+# Adding Profiles
+This page describes the internals of YUVColorTypes.jl.
+
+You can implement the conversion methods such as `convert_yuv_to_rgb` directly.
+However, except in the case of nonlinear conversions or speed optimization, the
+conversion processes are completed simply by defining a profile.
+
+## RGB color primaries and whitepoint
+
+```@docs
+YUVColorTypes.primary_r
+YUVColorTypes.primary_g
+YUVColorTypes.primary_b
+YUVColorTypes.whitepoint
+```
+
+## RGB <-> XYZ conversion matrices
+```@docs
+YUVColorTypes.mat_rgb_to_xyz
+YUVColorTypes.mat_xyz_to_rgb
+```
+
+## RGB <-> sRGB conversion matrices
+```@docs
+YUVColorTypes.mat_rgb_to_srgb
+YUVColorTypes.mat_srgb_to_rgb
+```
+
+## YUV <-> RGB conversion matrices
+
+## Transfer functions
+```@docs
+YUVColorTypes.eotf
+YUVColorTypes.ieotf
+```
diff --git a/docs/src/api.md b/docs/src/api.md
@@ -0,0 +1,61 @@
+# API Reference
+```@contents
+Pages = ["api.md"]
+```
+
+## Module
+```@docs
+YUVColorTypes
+```
+
+## Basic Types
+```@docs
+AbstractYUV
+TransparentYUV
+AbstractAYUV
+AbstractYUVA
+AbstractYUVColorant
+
+# AbstractLuma
+# TransparentLuma
+# AbstractALuma
+# AbstractLumaA
+# AbstractLumaColorant
+
+YUVColorTypes.YUV
+YUVColorTypes.AYUV
+YUVColorTypes.YUVA
+YUVColorTypes.Luma
+YUVColorTypes.ALuma
+YUVColorTypes.LumaA
+```
+
+## Specific YCbCr Types (Aliases)
+```@docs
+YCbCrBT601_625
+YCbCr30BT601_625
+YCbCr24BT601_625
+YCbCr36BT601_625
+YCbCr48BT601_625
+YCbCrBT601_525
+YCbCr30BT601_525
+YCbCr24BT601_525
+YCbCr36BT601_525
+YCbCr48BT601_525
+```
+
+
+## Functions
+```@docs
+luma
+chroma_u
+chroma_v
+chroma_b
+chroma_r
+chroma_g
+chroma_o
+rgb_to_yuv
+srgb_to_yuv
+yuv_to_rgb
+yuv_to_srgb
+```
diff --git a/docs/src/assets/logo.svg b/docs/src/assets/logo.svg