Mike-Solar
498669509a
docs/build.md + docs/zh/build.md rewritten for the Rust workspace: project-built FFmpeg 8.1 (.cargo/config.toml presets FFMPEG_DIR), vendored static OCIO on Linux/macOS vs MSYS2 dynamic OCIO on Windows (with the OCIO_INSTALL_DIR/OCIO_RS_LINK env), the Windows GNU toolchain requirements (MSYS2 Rust, RUSTFLAGS=-C link-args=-lmsvcrt for the mingw-w64 _assert forwarding, unset INCLUDE/LIB), Linux audio dev packages and xvfb headless testing, container packaging, and a troubleshooting section. The macOS-only guides gain a deprecation pointer. Also correct two stale comments in tooling/install-deps.sh (FFmpeg is built by tooling/ffmpeg/build-ffmpeg.sh, not by cargo).
106 lines
4.1 KiB
Bash
Executable File
106 lines
4.1 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
# Oak Video Editor - Non-Linear Video Editor
|
|
# Copyright (C) 2026 Oak Team
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
# Installs the system dependencies of the Oak Rust workspace:
|
|
# the free-license external codec/filter libraries FFmpeg is configured
|
|
# with (see crates/oakcodec/Cargo.toml), plus the build tools. FFmpeg
|
|
# itself is built from source by tooling/ffmpeg/build-ffmpeg.sh (which
|
|
# installs into .cache/ffmpeg) and is NOT installed here.
|
|
#
|
|
# Supported: Homebrew (macOS), MSYS2 UCRT64 (Windows), Debian/Ubuntu,
|
|
# Fedora, Arch. Run it yourself — nothing in the build invokes it
|
|
# automatically (it needs sudo on Linux).
|
|
#
|
|
# Usage: tooling/install-deps.sh
|
|
|
|
set -euo pipefail
|
|
|
|
run() { echo "+ $*"; "$@"; }
|
|
|
|
if [[ "$OSTYPE" == msys* || "$OSTYPE" == cygwin* || -n "${MSYSTEM:-}" ]]; then
|
|
if [ "${MSYSTEM:-}" != "UCRT64" ]; then
|
|
echo "Please run this from the MSYS2 UCRT64 shell (MSYSTEM=$MSYSTEM)." >&2
|
|
exit 1
|
|
fi
|
|
# Pacman mirrors occasionally stall mid-download (CI hits "Operation
|
|
# too slow" on .sig retrieval); retry the whole install a few times —
|
|
# --needed makes each retry resume where the last one stopped.
|
|
for attempt in 1 2 3; do
|
|
if run pacman -S --needed --noconfirm \
|
|
make diffutils \
|
|
mingw-w64-ucrt-x86_64-toolchain mingw-w64-ucrt-x86_64-pkgconf \
|
|
mingw-w64-ucrt-x86_64-nasm \
|
|
mingw-w64-ucrt-x86_64-x264 mingw-w64-ucrt-x86_64-x265 \
|
|
mingw-w64-ucrt-x86_64-dav1d mingw-w64-ucrt-x86_64-libvpx \
|
|
mingw-w64-ucrt-x86_64-openh264 mingw-w64-ucrt-x86_64-openjpeg2 \
|
|
mingw-w64-ucrt-x86_64-libtheora mingw-w64-ucrt-x86_64-libwebp \
|
|
mingw-w64-ucrt-x86_64-lame mingw-w64-ucrt-x86_64-opus \
|
|
mingw-w64-ucrt-x86_64-libvorbis mingw-w64-ucrt-x86_64-speex \
|
|
mingw-w64-ucrt-x86_64-snappy mingw-w64-ucrt-x86_64-libass \
|
|
mingw-w64-ucrt-x86_64-freetype mingw-w64-ucrt-x86_64-fribidi \
|
|
mingw-w64-ucrt-x86_64-fontconfig mingw-w64-ucrt-x86_64-gnutls
|
|
then
|
|
exit 0
|
|
fi
|
|
echo "pacman install attempt $attempt failed; retrying" >&2
|
|
sleep 5
|
|
done
|
|
echo "pacman install failed after 3 attempts" >&2
|
|
exit 1
|
|
fi
|
|
|
|
case "$(uname -s)" in
|
|
Darwin)
|
|
run brew install pkg-config nasm \
|
|
x264 x265 dav1d libvpx openh264 openjpeg theora webp \
|
|
lame opus libvorbis speex snappy libass freetype fribidi \
|
|
fontconfig gnutls
|
|
;;
|
|
Linux)
|
|
if command -v apt-get >/dev/null; then
|
|
run sudo apt-get update
|
|
run sudo apt-get install -y build-essential pkg-config nasm \
|
|
libx264-dev libx265-dev libdav1d-dev libvpx-dev \
|
|
libopenh264-dev libopenjp2-7-dev libtheora-dev libwebp-dev \
|
|
libmp3lame-dev libopus-dev libvorbis-dev libspeex-dev \
|
|
libsnappy-dev libass-dev libfreetype-dev libfribidi-dev \
|
|
libfontconfig-dev libgnutls28-dev
|
|
elif command -v dnf >/dev/null; then
|
|
run sudo dnf install -y gcc gcc-c++ pkgconf-pkg-config nasm \
|
|
x264-devel x265-devel dav1d-devel libvpx-devel \
|
|
openh264-devel openjpeg2-devel libtheora-devel libwebp-devel \
|
|
lame-devel opus-devel libvorbis-devel speex-devel \
|
|
snappy-devel libass-devel freetype-devel fribidi-devel \
|
|
fontconfig-devel gnutls-devel
|
|
elif command -v pacman >/dev/null; then
|
|
run sudo pacman -S --needed --noconfirm base-devel pkgconf nasm \
|
|
x264 x265 dav1d libvpx openh264 openjpeg2 libtheora libwebp \
|
|
lame opus libvorbis speex snappy libass freetype2 fribidi \
|
|
fontconfig gnutls
|
|
else
|
|
echo "Unsupported Linux distribution (need apt-get, dnf or pacman)." >&2
|
|
exit 1
|
|
fi
|
|
;;
|
|
*)
|
|
echo "Unsupported platform: $(uname -s)" >&2
|
|
exit 1
|
|
;;
|
|
esac
|
|
|
|
echo "Done. Now run tooling/ffmpeg/build-ffmpeg.sh once, then 'cargo build'."
|