Skip to content

Commit

Permalink
docs: Updates to build guides and system requirements.
Browse files Browse the repository at this point in the history
  • Loading branch information
sr55 committed Dec 21, 2024
1 parent 74be285 commit 549691e
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 63 deletions.
2 changes: 1 addition & 1 deletion source/docs/en/latest/developer/build-bsd.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Clone the HandBrake repository.

git clone https://github.com/HandBrake/HandBrake.git && cd HandBrake

Build HandBrake. To enable experimental support for Intel Quick Sync Video (FreeBSD only), append `--enable-qsv`. To build the command line interface only, disable the graphical interface by appending `--disable-gtk`.
Build HandBrake. To enable support for Intel Quick Sync Video (FreeBSD only), append `--enable-qsv`. To build the command line interface only, disable the graphical interface by appending `--disable-gtk`.

For FreeBSD

Expand Down
17 changes: 15 additions & 2 deletions source/docs/en/latest/developer/build-linux.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,31 @@ Dependency installation instructions are available for the following distributio
- [Ubuntu](install-dependencies-ubuntu.html)
- [Void](install-dependencies-void.html)

HandBrake’s optional experimental support for Intel Quick Sync Video on Linux requires installing the Intel Media SDK and its dependencies. See the [Intel Media SDK Releases](https://github.com/Intel-Media-SDK/MediaSDK/releases) page and [Intel Media SDK Build Instructions](https://github.com/Intel-Media-SDK/MediaSDK#how-to-build).

## Building HandBrake

Clone the HandBrake repository.

git clone https://github.com/HandBrake/HandBrake.git && cd HandBrake

Build HandBrake. To enable experimental support for Intel Quick Sync Video, append `--enable-qsv`. To build the command line interface only, disable the graphical interface by appending `--disable-gtk`.
Build HandBrake.

./configure --launch-jobs=$(nproc) --launch

The following optional parameters are commonly used:

| Parameter | Description |
|------------------|---------------------|
| --enable-qsv | Enable support for the Intel QuickSync Video Decoder and Encoder |
| --enable-nvdec | Enable support for the Nvidia NVDec Decoder |
| --enable-vce | Enable support for the AMD VCN video encoder |
| --enable-libdovi | Enable support for Dolby Vision |
| --disable-gtk | Build only HandBrakeCLI on Linux |

For a full listing of options, use the command:

./configure --help

When complete, you will find `HandBrakeCLI` in the `build` directory. If the graphical interface is enabled, you will also find `ghb` in the `build/gtk/src` directory.

Install HandBrake (optional). When installing the graphical interface, icon and desktop files for the Applications menu will be also installed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,64 +22,10 @@ Basic requirements to run commands:

- sudo (for normal user accounts)

Dependencies:

- autoconf
- automake
- build-essential
- cmake
- git
- libass-dev
- libbz2-dev
- libfontconfig-dev
- libfreetype-dev
- libfribidi-dev
- libharfbuzz-dev
- libjansson-dev
- liblzma-dev
- libmp3lame-dev
- libnuma-dev
- libogg-dev
- libopus-dev
- libsamplerate0-dev
- libspeex-dev
- libtheora-dev
- libtool
- libtool-bin
- libturbojpeg0-dev
- libvorbis-dev
- libx264-dev
- libxml2-dev
- libvpx-dev
- m4
- make
- meson
- nasm
- ninja-build
- patch
- pkg-config
- tar
- zlib1g-dev

Intel Quick Sync Video dependencies (optional):

- libva-dev
- libdrm-dev

Graphical interface dependencies:

- appstream
- desktop-file-utils
- gettext
- gstreamer1.0-libav
- gstreamer1.0-plugins-good
- libgstreamer-plugins-base1.0-dev
- libgtk-4-dev

Install dependencies.

sudo apt-get update
sudo apt-get install autoconf automake build-essential cmake git libass-dev libbz2-dev libfontconfig-dev libfreetype-dev libfribidi-dev libharfbuzz-dev libjansson-dev liblzma-dev libmp3lame-dev libnuma-dev libogg-dev libopus-dev libsamplerate0-dev libspeex-dev libtheora-dev libtool libtool-bin libturbojpeg0-dev libvorbis-dev libx264-dev libxml2-dev libvpx-dev m4 make meson nasm ninja-build patch pkg-config tar zlib1g-dev
sudo apt-get install autoconf automake build-essential cmake git libass-dev libbz2-dev libfontconfig-dev libfreetype-dev libfribidi-dev libharfbuzz-dev libjansson-dev liblzma-dev libmp3lame-dev libnuma-dev libogg-dev libopus-dev libsamplerate0-dev libspeex-dev libtheora-dev libtool libtool-bin libturbojpeg0-dev libvorbis-dev libx264-dev libxml2-dev libvpx-dev m4 make meson nasm ninja-build patch pkg-config tar zlib1g-dev curl libssl-dev clang

For libdovi, you will also need rust, cargoc and associated dependencies:

Expand Down
8 changes: 3 additions & 5 deletions source/docs/en/latest/technical/system-requirements.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,9 @@ The following is the minimum level of hardware HandBrake formally supports.
- AMD Ryzen, Threadripper, or Epyc
- Intel Core (6th generation and newer) i3, i5, i7, i9, or equivalent Xeon
- Apple Silicon M1 and newer, recent Intel Macs supported per the above
- Free memory:
- Depends on settings used but as a general guide:
- 1 GB for transcoding standard definition video (480p/576p)
- 2 to 8 GB for transcoding high definition video (720p/1080p)
- 6 to 16 GB or more for transcoding ultra high definition video (2160p 4K)
- Minimum System Memory:
- 16 GB for transcoding standard and high definition video (480p/576p/720p)
- 32 GB for transcoding 4K Ultra HD video (2160p)
- System storage:
- 150 MB for the HandBrake app
- Display resolution:
Expand Down

0 comments on commit 549691e

Please sign in to comment.