diff options
Diffstat (limited to 'packaging/win/README.md')
| -rw-r--r-- | packaging/win/README.md | 35 |
1 files changed, 27 insertions, 8 deletions
diff --git a/packaging/win/README.md b/packaging/win/README.md index 7bbec13..b5ab1cd 100644 --- a/packaging/win/README.md +++ b/packaging/win/README.md @@ -17,7 +17,9 @@ Linux). `meshbay-common` rides along inside the node runtime. │ └─ node-runtime\ │ ├─ meshbay-node.exe frozen daemon (PyInstaller onedir) │ ├─ _internal\ … its Python + deps (aiortc, av, aioquic, …) -│ └─ ffmpeg.exe, ffprobe.exe only if built with -FfmpegDir +│ ├─ ffmpeg.exe, ffprobe.exe bundled by default, see Video (ffmpeg) below +│ ├─ av*.dll, swscale/swresample*.dll what those two link against +│ └─ LICENSE-ffmpeg.txt GPLv3 notice + where the source is └─ Uninstall MeshBay.exe ``` @@ -91,18 +93,35 @@ That runs [`build-win.ps1`](build-win.ps1): | 5 | [`build-node-runtime.ps1`](build-node-runtime.ps1) — PyInstaller freeze → `packages/meshbay-client/node-runtime/` | | 6 | `electron-builder --win nsis` → `packages/meshbay-client/dist/MeshBay-Setup-<version>.exe` | -### ffmpeg +### Video (ffmpeg) -Not bundled by default — the node resolves `ffmpeg`/`ffprobe` from `PATH` at -startup, and video streaming needs them. To make the installer self-contained: +**Bundled by default** — [`fetch-ffmpeg.ps1`](fetch-ffmpeg.ps1) downloads, +checksum-verifies and stages it into `node-runtime/` on every build, ~161 MB. +Not optional in practice: MeshBay transcodes browser-incompatible video to +H.264 (`-c:v libx264`, a real encode, not remux), and no LGPL-only ffmpeg +build includes an H.264 *encoder* — libx264 itself is GPL. Asking an end user +to separately run `winget install ffmpeg` was considered and rejected: it +needs network access and `winget`/App Installer present at that exact moment, +and its failure mode is silent — video just does not stream, with nothing +pointing back at ffmpeg. + +Source: [BtbN/FFmpeg-Builds](https://github.com/BtbN/FFmpeg-Builds), the +Windows x86_64 **gpl-shared** preset — `ffmpeg.exe`/`ffprobe.exe` plus the +DLLs they both link against, rather than two independent static binaries +(the "full" static build many devs already have via `winget install ffmpeg` +is ~220 MB *per executable*; the equivalent Linux install used a shared +build for the same reason). `ffplay.exe` (an SDL2 player, ~17 MB) is dropped +— the daemon never invokes it. Pinned to one dated release tag, not the +`latest` alias BtbN repoints on every auto-build; both the tag and the sha256 +are hardcoded in the script and re-pinning is a deliberate edit, not +automatic. `LICENSE-ffmpeg.txt` (GPLv3 notice + where the source is) rides +along in the same directory — required, since this redistributes a GPL +binary even though it is unmodified and invoked only as a subprocess. ```powershell -npm run dist:win -- -FfmpegDir "C:\path\to\ffmpeg\bin" -# or: $env:MESHBAY_FFMPEG_DIR = "C:\path\to\ffmpeg\bin"; npm run dist:win +npm run dist:win -- -SkipFfmpeg # smaller, streaming-less build for local iteration only ``` -They are copied beside `meshbay-node.exe`, which is on the daemon's search path. - ### Iterating ```powershell |