HandBrake/HandBrake-docs
1
0
Fork 0
mirror of https://github.com/HandBrake/HandBrake-docs.git synced 2025-12-11 04:35:53 -06:00
Code Issues Packages Projects Releases 1 Wiki Activity

Technical doc updates

Browse Source
This commit is contained in:
sr55 2025-08-09 13:26:29 +01:00
parent a4473802c4
commit a5dcb3dcf4
No known key found for this signature in database
GPG Key ID: 99C970F83E86C84B
4 changed files with 65 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
source/docs/en/latest/cli/cli-options.markdown
View File

@ -1,6 +1,5 @@
--- ---
Type: article Type: article
State: [ draft ]
Title: CLI Options Title: CLI Options
Project: HandBrake Project: HandBrake
Project_URL: https://handbrake.fr/ Project_URL: https://handbrake.fr/

68
source/docs/en/latest/cli/command-line-reference.markdown
View File

@ -7,7 +7,7 @@ Project_Version: Latest
Language: English Language: English
Language_Code: en Language_Code: en
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS), Scott (s55) ] Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS), Scott (s55) ]
Copyright: 2024 HandBrake Team Copyright: 2025 HandBrake Team
License: Creative Commons Attribution-ShareAlike 4.0 International License: Creative Commons Attribution-ShareAlike 4.0 International
License_Abbr: CC BY-SA 4.0 License_Abbr: CC BY-SA 4.0
License_URL: https://handbrake.fr/docs/license.html License_URL: https://handbrake.fr/docs/license.html
@ -22,6 +22,7 @@ Please run this command on your own system as available options may vary dependi
For reference, the following was generated by the Windows version of HandBrakeCLI. For reference, the following was generated by the Windows version of HandBrakeCLI.
Options may vary slightly depending on hardware / operating system. Run `HandBrakeCLI --help` for valid options for your system. Options may vary slightly depending on hardware / operating system. Run `HandBrakeCLI --help` for valid options for your system.
Usage: HandBrakeCLI [options] -i <source> -o <destination> Usage: HandBrakeCLI [options] -i <source> -o <destination>
General Options -------------------------------------------------------------- General Options --------------------------------------------------------------
@ -31,7 +32,7 @@ Options may vary slightly depending on hardware / operating system. Run `HandBra
--json Log title, progress, and version info in --json Log title, progress, and version info in
JSON format JSON format
-v, --verbose[=number] Be verbose (optional argument: logging level) -v, --verbose[=number] Be verbose (optional argument: logging level)
-Z. --preset <string> Select preset by name (case-sensitive) -Z, --preset <string> Select preset by name (case-sensitive)
Enclose names containing spaces in double quotation Enclose names containing spaces in double quotation
marks (e.g. "Preset Name") marks (e.g. "Preset Name")
-z, --preset-list List available presets -z, --preset-list List available presets
@ -66,6 +67,8 @@ Options may vary slightly depending on hardware / operating system. Run `HandBra
Shorter titles will be ignored (default: 10). Shorter titles will be ignored (default: 10).
--scan Scan selected title only. --scan Scan selected title only.
--main-feature Detect and select the main feature title. --main-feature Detect and select the main feature title.
--keep-duplicate-titles
Keep duplicate titles when scanning (Blu-ray only)
-c, --chapters <string> Select chapters (e.g. "1-3" for chapters -c, --chapters <string> Select chapters (e.g. "1-3" for chapters
1 to 3 or "3" for chapter 3 only, 1 to 3 or "3" for chapter 3 only,
default: all chapters) default: all chapters)
@ -107,6 +110,10 @@ Options may vary slightly depending on hardware / operating system. Run `HandBra
--align-av Add audio silence or black video frames to start --align-av Add audio silence or black video frames to start
of streams so that all streams start at exactly of streams so that all streams start at exactly
the same time the same time
--keep-metadata Preserve the source's common metadata
--no-metadata Disable preset 'keep-metadata'
of streams so that all streams start at exactly
the same time
--inline-parameter-sets Create adaptive streaming compatible output. --inline-parameter-sets Create adaptive streaming compatible output.
Inserts parameter sets (SPS and PPS) inline Inserts parameter sets (SPS and PPS) inline
in the video stream before each IDR. in the video stream before each IDR.
@ -117,12 +124,16 @@ Options may vary slightly depending on hardware / operating system. Run `HandBra
-e, --encoder <string> Select video encoder: -e, --encoder <string> Select video encoder:
svt_av1 svt_av1
svt_av1_10bit svt_av1_10bit
ffv1
x264 x264
x264_10bit x264_10bit
vce_h264
nvenc_h264 nvenc_h264
x265 x265
x265_10bit x265_10bit
x265_12bit x265_12bit
vce_h265
vce_h265_10bit
nvenc_h265 nvenc_h265
nvenc_h265_10bit nvenc_h265_10bit
mpeg4 mpeg4
@ -183,8 +194,15 @@ Options may vary slightly depending on hardware / operating system. Run `HandBra
timing if it's below that rate. timing if it's below that rate.
If none of these flags are given, the default If none of these flags are given, the default
is --pfr when -r is given and --vfr otherwise is --pfr when -r is given and --vfr otherwise
--hdr-dynamic-metadata <string>
Set the kind of HDR dynamic metadata to preserve:
hdr10plus
dolbyvision
all
--no-hdr-dynamic-metadata Disable HDR dynamic metadata passthru
--enable-hw-decoding <string> --enable-hw-decoding <string>
Use 'nvdec' to enable NVDec Use 'nvdec' to enable NVDec
Use 'qsv' to enable QSV decoding
--disable-hw-decoding Disable hardware decoding of the video track, --disable-hw-decoding Disable hardware decoding of the video track,
forcing software decoding instead forcing software decoding instead
@ -217,31 +235,36 @@ Options may vary slightly depending on hardware / operating system. Run `HandBra
copy:ac3 copy:ac3
eac3 eac3
copy:eac3 copy:eac3
truehd
copy:truehd copy:truehd
copy:dts copy:dts
copy:dtshd copy:dtshd
copy:mp2 copy:mp2
mp3 mp3
copy:mp3 copy:mp3
opus
copy:opus
vorbis vorbis
copy:vorbis
flac16 flac16
flac24 flac24
copy:flac copy:flac
opus alac16
copy:opus alac24
copy:alac
copy copy
"copy:<type>" will pass through the corresponding "copy:<type>" will enable passthru of the
audio track without modification, if pass through corresponding audio track without modification
is supported for the audio type. if passthru is supported for the audio type.
Separate tracks by commas. Separate tracks by commas.
Defaults: Defaults:
av_mp4 av_aac av_mp4 av_aac
av_mkv mp3 av_mkv mp3
av_webm vorbis av_webm opus
--audio-copy-mask <string> --audio-copy-mask <string>
Set audio codecs that are permitted when the Set audio codecs that are permitted when the
"copy" audio encoder option is specified "copy" audio encoder option is specified
(aac/ac3/eac3/truehd/dts/dtshd/mp2/mp3/flac/opus) (aac/ac3/eac3/truehd/dts/dtshd/mp2/mp3/opus/vorbis/flac/alac)
Separated by commas for multiple allowed options. Separated by commas for multiple allowed options.
--audio-fallback <string> --audio-fallback <string>
Set audio codec to use when it is not possible Set audio codec to use when it is not possible
@ -272,17 +295,20 @@ Options may vary slightly depending on hardware / operating system. Run `HandBra
av_aac up to 7point1 av_aac up to 7point1
ac3 up to 5point1 ac3 up to 5point1
eac3 up to 5point1 eac3 up to 5point1
truehd up to 5point1
mp3 up to dpl2 mp3 up to dpl2
opus up to 7point1
vorbis up to dpl2 vorbis up to dpl2
flac16 up to 7point1 flac16 up to 7point1
flac24 up to 7point1 flac24 up to 7point1
opus up to 7point1 alac16 up to 7point1
alac24 up to 7point1
--normalize-mix Normalize audio mix levels to prevent clipping. --normalize-mix Normalize audio mix levels to prevent clipping.
<string> Separate tracks by commas. <string> Separate tracks by commas.
0 = Disable Normalization (default) 0 = Disable Normalization (default)
1 = Enable Normalization 1 = Enable Normalization
-R, --arate Set audio samplerate(s) -R, --arate Set audio samplerate(s)
(8/11.025/12/16/22.05/24/32/44.1/48 kHz) (8/11.025/12/16/22.05/24/32/44.1/48/88.2/96/176.4/192 kHz)
or "auto". Separate tracks by commas. or "auto". Separate tracks by commas.
-D, --drc <float> Apply extra dynamic range compression to the -D, --drc <float> Apply extra dynamic range compression to the
audio, making soft sounds louder. Range is 1.0 audio, making soft sounds louder. Range is 1.0
@ -304,6 +330,14 @@ Options may vary slightly depending on hardware / operating system. Run `HandBra
Separate tracks by commas. Separate tracks by commas.
Supported by encoder(s): Supported by encoder(s):
flac16 flac16
--keep-aname Passthru the source audio track(s) name(s).
--no-keep-aname Disable the source audio track(s) name(s) passthru.
--automatic-naming-behaviour
Set the audio track(s) automatic naming behaviour:
off
unnamed
all
Disable the source audio track(s) name(s) passthru.
-A, --aname <string> Set audio track name(s). -A, --aname <string> Set audio track name(s).
Separate tracks by commas. Separate tracks by commas.
@ -355,6 +389,12 @@ Options may vary slightly depending on hardware / operating system. Run `HandBra
--modulus <number> Set storage width and height modulus --modulus <number> Set storage width and height modulus
Dimensions will be made divisible by this number. Dimensions will be made divisible by this number.
(default: set by preset, typically 2) (default: set by preset, typically 2)
--color-range <string>
Set the color range of the output.
auto
limited
full
(default: set by preset, typically limited)
-M, --color-matrix <string> -M, --color-matrix <string>
Set the color space signaled by the output: Set the color space signaled by the output:
Overrides color signalling with no conversion. Overrides color signalling with no conversion.
@ -596,7 +636,7 @@ Options may vary slightly depending on hardware / operating system. Run `HandBra
bt601-6-625 bt601-6-625
Custom Format: Custom Format:
primaries=p:transfer=t:matrix=m:range=r: primaries=p:transfer=t:matrix=m:range=r:
tonemap=t:param=p:desat=d tonemap=t:param=p:desat=d:npl=n
-g, --grayscale Grayscale encoding -g, --grayscale Grayscale encoding
--no-grayscale Disable preset 'grayscale' --no-grayscale Disable preset 'grayscale'
@ -630,6 +670,8 @@ Options may vary slightly depending on hardware / operating system. Run `HandBra
or less is selected. This should locate subtitles or less is selected. This should locate subtitles
for short foreign language segments. Best used in for short foreign language segments. Best used in
conjunction with --subtitle-forced. conjunction with --subtitle-forced.
--keep-subname Passthru the source subtitle track(s) name(s).
--no-keep-subname Disable the source subtitle track(s) name(s) passthru.
-S, --subname <string> Set subtitle track name(s). -S, --subname <string> Set subtitle track name(s).
Separate tracks by commas. Separate tracks by commas.
-F, --subtitle-forced[=string] -F, --subtitle-forced[=string]
@ -714,5 +756,3 @@ Options may vary slightly depending on hardware / operating system. Run `HandBra
the video track. the video track.
If 'number' is omitted, the first SSA is burned. If 'number' is omitted, the first SSA is burned.
'number' is a 1-based index into the 'ssa-file' list 'number' is a 1-based index into the 'ssa-file' list

4
source/docs/en/latest/developer/flatpak-repo.markdown
View File

@ -37,8 +37,8 @@ Install flatpak freedesktop runtime platform.
Install flatpak gnome. Install flatpak gnome.
flatpak install flathub org.gnome.Platform//47 flatpak install flathub org.gnome.Platform//48
flatpak install flathub org.gnome.Sdk//47 flatpak install flathub org.gnome.Sdk//48
Install Compilers Install Compilers

16
source/docs/en/latest/technical/system-requirements.markdown
View File

@ -22,10 +22,10 @@ The following is the minimum level of hardware HandBrake formally supports.
- Processor: - Processor:
- AMD Ryzen, Threadripper, or Epyc - AMD Ryzen, Threadripper, or Epyc
- Intel Core (6th generation and newer) i3, i5, i7, i9, or equivalent Xeon - Intel Core (9th generation and newer) i3, i5, i7, i9, Ultra or equivalent Xeon
- Apple Silicon M1 and newer, recent Intel Macs supported per the above - Apple Silicon M1 and newer
- Minimum System Memory: - Minimum System Memory:
- 16 GB for transcoding standard and high definition video (480p/576p/720p) - 16 GB for transcoding standard and high definition video (480p/576p/720p/1080p)
- 32 GB for transcoding 4K Ultra HD video (2160p) - 32 GB for transcoding 4K Ultra HD video (2160p)
- System storage: - System storage:
- 150 MB for the HandBrake app - 150 MB for the HandBrake app
@ -85,9 +85,11 @@ HandBrake is supported on Fedora stable and maintenance versions until their end
| Fedora Version | Status | Last Compatible Version | Notes | | Fedora Version | Status | Last Compatible Version | Notes |
|----------------|---------------------|-------------------------|-------------------------------| |----------------|---------------------|-------------------------|-------------------------------|
| Fedora 40 | Supported | | | | Fedora 42 | Supported | | |
| Fedora 39 | Supported | | | | Fedora 41 | Supported | | |
| Fedora 38 | Supported | | | | Fedora 40 | Unsupported | HandBrake 1.9.2 | |
| Fedora 39 | Unsupported | HandBrake 1.9.2 | |
| Fedora 38 | Unsupported | HandBrake 1.9.2 | |
| Fedora 37 | Unsupported | HandBrake 1.6.1 | End of life. | | Fedora 37 | Unsupported | HandBrake 1.6.1 | End of life. |
| Fedora 36 | Unsupported | HandBrake 1.6.1 | End of life. | | Fedora 36 | Unsupported | HandBrake 1.6.1 | End of life. |
| Fedora 35 | Unsupported | HandBrake 1.5.1 | End of life. | | Fedora 35 | Unsupported | HandBrake 1.5.1 | End of life. |
@ -109,7 +111,7 @@ Interim (non-LTS) versions are typically supported until their end of life.
|---------------------------|---------------------|-------------------------|------------------------------------| |---------------------------|---------------------|-------------------------|------------------------------------|
| 24.04 LTS Noble Numbat | Supported | | Flatpak, and source. | | 24.04 LTS Noble Numbat | Supported | | Flatpak, and source. |
| 22.04 LTS Jammy Jellyfish | Supported | | Flatpak, and source. | | 22.04 LTS Jammy Jellyfish | Supported | | Flatpak, and source. |
| 20.04 LTS Focal Fossa | Deprecated | | Flatpak, and source. | | 20.04 LTS Focal Fossa | Unsupported | HandBrake 1.9.2 | Flatpak, and source. |
| 18.04 LTS Bionic Beaver | Unsupported | HandBrake 1.3.3 | Flatpak only. | | 18.04 LTS Bionic Beaver | Unsupported | HandBrake 1.3.3 | Flatpak only. |
| 16.04 LTS Xenial Xerus | Unsupported | HandBrake 1.1.2 | End of life (standard support). | | 16.04 LTS Xenial Xerus | Unsupported | HandBrake 1.1.2 | End of life (standard support). |
| 14.04 LTS Trusty Tahr | Unsupported | HandBrake 1.1.2 | End of life (standard support). | | 14.04 LTS Trusty Tahr | Unsupported | HandBrake 1.1.2 | End of life (standard support). |