Skip to content

docs: reference split into sections with a table of contents #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Okonai wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: reference split into sections with a table of contents #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/adr/0012-agpl-licence.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@ ever make it closed; running it as a network service counts as distribution, so
| metal-cpp | third_party/metal-cpp | Apache-2.0 | yes |
| nlohmann/json (also our MessagePack encoding) | third_party/nlohmann | MIT | yes |
| doctest | third_party/doctest, tests only | MIT | yes |
| Tracy v0.14.1 | optional profiler build (`-DNOCTURNE_TRACY=ON`, ticket 92), FetchContent; not in the default build | BSD-3-Clause | yes |
| glslang vulkan-sdk-1.4.363.0 | engine, FetchContent (ticket 95): ISF GLSL to SPIR-V | BSD-3 / BSD-2 / MIT / Apache-2.0 (GPL-3 with the Bison exception covers only Bison output) | yes |
| SPIRV-Cross vulkan-sdk-1.4.363.0 | engine, FetchContent (ticket 95): SPIR-V to MSL | Apache-2.0 | yes |
| Curated ISF shaders (ISF-Files, gl-transitions) | third_party/isf, built into the program (ticket 95) | MIT, per shader in `docs/licence-notes.md` | yes |
| AMD FidelityFX Super Resolution 1 (v1.20210629, EASU and RCAS) | shaders ported to Metal in src/engine/fsr_upscaler.cpp (ticket 93), AMD's notice kept in that file | MIT | yes |
| Tracy v0.14.1 | optional profiler build (`-DNOCTURNE_TRACY=ON`), FetchContent; not in the default build | BSD-3-Clause | yes |
| glslang vulkan-sdk-1.4.363.0 | engine, FetchContent: ISF GLSL to SPIR-V | BSD-3 / BSD-2 / MIT / Apache-2.0 (GPL-3 with the Bison exception covers only Bison output) | yes |
| SPIRV-Cross vulkan-sdk-1.4.363.0 | engine, FetchContent: SPIR-V to MSL | Apache-2.0 | yes |
| Curated ISF shaders (ISF-Files, gl-transitions) | third_party/isf, built into the program | MIT, per shader in `docs/licence-notes.md` | yes |
| AMD FidelityFX Super Resolution 1 (v1.20210629, EASU and RCAS) | shaders ported to Metal in src/engine/fsr_upscaler.cpp, AMD's notice kept in that file | MIT | yes |
| Apple frameworks (Metal, AVFoundation, VideoToolbox, CoreAudio, ...) | system | system libraries | yes (system library exception) |
| stb_dxt.h v1.12 | third_party/stb, the HAP encoder's BC block compressor (ticket 94) | MIT / public domain (dual) | yes |
| HAP frame format (Vidvox) and snappy format (Google) | re-implemented from their specifications in src/media/hap.cpp and src/media/snappy.cpp (ticket 94); no code copied | BSD-2-Clause, BSD-3-Clause (the references) | yes |
| ffmpeg, ffprobe (Homebrew, with libx264) | tools/transcode-media.sh and nocturne-upload (ticket 84) run them as separate programs; nothing links them | GPL-2.0-or-later build | yes (not linked; GPL-2.0+ allows GPL-3.0 anyway) |
| stb_dxt.h v1.12 | third_party/stb, the HAP encoder's BC block compressor | MIT / public domain (dual) | yes |
| HAP frame format (Vidvox) and snappy format (Google) | re-implemented from their specifications in src/media/hap.cpp and src/media/snappy.cpp; no code copied | BSD-2-Clause, BSD-3-Clause (the references) | yes |
| ffmpeg, ffprobe (Homebrew, with libx264) | tools/transcode-media.sh and nocturne-upload run them as separate programs; nothing links them | GPL-2.0-or-later build | yes (not linked; GPL-2.0+ allows GPL-3.0 anyway) |

No incompatible dependency was found.

Expand Down
8 changes: 4 additions & 4 deletions docs/licence-notes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ shaders, copied snippets), check its licence here and add a row to ADR 0012's ta
- **Commits** carry `Signed-off-by:` (DCO); no CLA.
- **Unsure:** stop and ask the maintainer before adding it.

## ISF import (ticket 95), checked 2026-10-18
## ISF import, checked 2026-10-18

| Component | Version | Licence | Use | Compatible |
|---|---|---|---|---|
Expand Down Expand Up @@ -64,14 +64,14 @@ Every other shader in ISF-Files 395072d, and why it is not vendored. The first g
- gl-transitions, BSD with its author: licence fine, not picked (three transitions were enough; many sample away from their pixel) (2): Inverted Page Curl, Stereo Viewer.
- credited to Vidvox: left out for what the importer cannot run yet (multi-pass, persistent buffers, custom vertex shaders, audio, extra image inputs) or as not needed; each gets its own header check before it is added (134): Apply Alpha, Auto Color Tone, Auto Colors Histogram, Bad TV, Basic Shape, Bloom, Bordered Box, Broken LCD, Checkerboard, Chroma Desaturation Mask, Chroma Mask, Circle Splash Distortion, Circle Warp, Circle Wrap Distortion, Circular Feedback Mask, Circular Screen, City Lights, Collage, Color Bars, Color Blowout, Color History, Color Levels, Color Relookup, Color Replacement, Color Schemes, Color Test Grid, ConstantAlpha, Corner Color Tint, Corner Colors, Cursor Overlay, Cursor, Diagonal Blur, Diagonalize, Dilate-Fast, Dilate, Doodler Overlay, Doodler, Dot Screen (needs its own vertex shader), Double Vision, Duotone From Histogram, Echo Trace, Edge Blowout, Edge Distort, Edge Trace, Edges, Emboss, Erode-Fast, Erode, Etch-a-Sketch, FFT Color Lines, FFT Filled Waveform, FFT Spectrogram, FastMosh, Flip H, Flip V, Flipbook, Freeze Frame, Ghosting, Glitch Shifter, Gloom, Glow-Fast, Glow, Grid Warp, Hatch Blur, Highlighter Overlay, Histogram Viewer, Hyperspace, JPEG Block Corruption, LGG, Life, Line Screen, Lines, Long Exposure, Micro Buffer RGB, Micro Buffer, Mirror Edge, Motion Heat Map, Motion Mask, Multi-Pixellate, MultiFrame 2x2, MultiFrame 3x3, Night Vision, Noise Adapt, Noise Displace, Noise Pixellate, Noise, Pattern Glitch, Pixel Shifter, Poly Glitch, RGB Invert, RGB Strobe, RGBA Swap, Random Checkerboard, Random Freeze, Random Lines, Random Shape Blast, Random Shape, Random Squares Mask, Random Stripes, Resize Glitch, Ridgelines, Rotate, Set Alpha, Shake, Shape Mask, Sharpen Luminance, Sharpen RGB, Shockwave Pulse, Shockwave, Show Alpha, Simplex Noise, Sine Warp Tile, Sketch, Slit Scan Mask, Slit Scan, Soft Blur, Soft Flip, Sorting Smear, Sphere Map, Strobe, Time Glitch RGB, Trail Mask, Trapezoid Distortion, Triangle Warp, Triangles, Triple Rotate, Unsharp Mask, VU Meter, Vertex Manipulator, Vertical Tearing, Video Snake, XYZoom, Zoom.

### User ISF shaders (ticket 116)
### User ISF shaders

The engine also reads ISF shaders from its machine's user folder (`<state>/isf-user/`). Those files are the user's own:
they are never vendored into this repository, never uploaded or synced by us (the media sync and the media upload do
not see the folder), and only go to the engine's own clients so a UI can show their parameters. Their licence is the
user's responsibility.

## Pro DJ Link references (tickets 89 and 112, checked 2026-10-18)
## Pro DJ Link references (checked 2026-10-18)

| Project | Licence | Compatible | Used how |
|---|---|---|---|
Expand All @@ -82,7 +82,7 @@ user's responsibility.
The DJ link receiver and the simulator (`tools/djlink-sim`) are written from the documented layouts; nothing from these
projects is vendored, so ADR 0012's dependency tables do not change.

## HAP playback and transcode (ticket 94, checked 2026-10-18)
## HAP playback and transcode (checked 2026-10-18)

| Project | Licence | Compatible | Used how |
|---|---|---|---|
Expand Down
Loading
Loading