HandBrake/HandBrake-docs
1
0
Fork 0
mirror of https://github.com/HandBrake/HandBrake-docs.git synced 2025-12-10 00:44:52 -06:00
Code Issues Packages Projects Releases 1 Wiki Activity

docs: Many small updates for 1.4.x

Browse Source
This commit is contained in:
sr55 2021-08-27 20:07:09 +01:00
parent ec5522556b
commit 983f843e6a
No known key found for this signature in database
GPG Key ID: ECE911849A3E21A5
19 changed files with 127 additions and 131 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
source/docs/en/images/windows/add-preset-mac-1.4.0.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 21 KiB

BIN
source/docs/en/images/windows/add-preset-win-1.4.0.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 7.3 KiB

BIN
source/docs/en/images/windows/audio-defaults-win-1.4.0.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 30 KiB

BIN
source/docs/en/images/windows/picture-settings-win-1.4.0.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 23 KiB

BIN
source/docs/en/images/windows/preset-controls-mac-1.4.0.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 136 KiB

BIN
source/docs/en/images/windows/preset-controls-win-1.4.0.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 33 KiB

BIN
source/docs/en/images/windows/subtitle-defaults-win-1.4.0.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 15 KiB

BIN
source/docs/en/images/windows/toolbar-win-1.4.0.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 11 KiB

20
source/docs/en/latest/advanced/audio-defaults.markdown
View File

@ -1,20 +0,0 @@
---
Type: article
State: [ draft ]
Title: Audio Defaults
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: []
Copyright: 2021 HandBrake Team
License: Creative Commons Attribution-ShareAlike 4.0 International
License_Abbr: CC BY-SA 4.0
License_URL: https://handbrake.fr/docs/license.html
---
Audio Defaults
=============================
Todo

14
source/docs/en/latest/advanced/audio-subtitle-defaults.markdown
View File

@ -25,7 +25,7 @@ In order to configure the track selection behaviour, click the "Configure Defaul
### Audio Defaults
![Audio Defaults Window](../../images/windows/audio-defaults-1.0.0.png "Audio Defaults Window")
![Audio Defaults Window](../../images/windows/audio-defaults-win-1.4.0.png "Audio Defaults Window")
- Track Selection Behaviour
- None
@ -34,17 +34,23 @@ In order to configure the track selection behaviour, click the "Configure Defaul
- The first track that matches the each of the languages in the "Chosen Languages", otherwise the first track will be selected.
- All matching selected languages
- All the tracks that match the "Chosen Languages".
- Choose Languages
- Move any languages you are interested in into the "Chosen Languages" list in order to have tracks selected based on the track selection behaviour.
- Auto Passthru
- HandBrake can pass thru several different audio formats. There are separate options the audio encoder dropdown for these. When you select "Auto Passthru", it will pass thru any of those supported types. You can limit what it will automatically passthru. For example, if you only ever want AC3 or DTS passthru, but not any of the other choices, untick the relevant checkboxes.
- Fallback Encoder
- When you have a passthru encoder selected, if the source track format does not match this format, HandBrake will automatically re-encode the track. The fallback encoder is the default encoder it will fallback to.
- Track Layout
- You can define the audio tracks you want added for each language in the track entry panel at the bottom of the window.
- When selecting a passthru encoder, the Bitrate, mixdown, samplerate controls apply to the fallback encoder should that be used instead of the passthru option selected.
### Subtitle Defaults
![Subtitle Defaults Window](../../images/windows/subtitle-defaults-1.0.0.png "Subtitle Defaults Window")
![Subtitle Defaults Window](../../images/windows/subtitle-defaults-win-1.4.0.png "Subtitle Defaults Window")
- Track Selection Behaviour
- None
@ -53,14 +59,18 @@ In order to configure the track selection behaviour, click the "Configure Defaul
- The first subtitle track for each "Chosen Language" will be added, where supported by the output container.
- All matching selected languages
- All subtitle track(s) for each "Chosen Language" will be added, where supported by the output container.
- Burn in Behaviour
HandBrake can burn in 1 subtitle track to an encoded file. There are 3 behavioural options you can choose from for this checkbox to be automatically selected.
- Foreign Audio Scan
- First Track
- Foreign Audio Preferred, else first
- Choose Languages
- Move any languages you are interested in into the "Chosen Languages" list in order to have tracks selected based on the track selection behaviour.
- Add Closed Captions when available
- Close captions are text based subtitles supported by both MP4 and MKV. If you select this option, HandBrake will automatically copy them to the output file.
- Add Foreign Audio Scan
- HandBrake can perform a scan of the source title / file to try and detect if there is a portions of a title that are in a foreign language. If it detects one, it will add the subtitle track automatically.

34
source/docs/en/latest/advanced/custom-presets.markdown
View File

@ -19,13 +19,39 @@ Custom Presets
HandBrake comes with many built-in presets which cover the most common use case scenarios. However there are many scenarios and devices that many not be covered.
You can create your own presets by clicking the "Add" button on the preset pane.
On the main window, below the title selection controls, you can click the "Save New Preset" button to create your own preset.
![Preset Controls](../../images/windows/preset-controls-1.0.0.png "Preset Controls")
<!-- .system-linux -->
<!-- /.system-linux -->
<!-- .system-macos -->
![macOS Preset Controls](../../images/windows/preset-controls-mac-1.4.0.png "Preset Controls (macOS)")
<!-- /.system-macos -->
<!-- .system-windows -->
![Windows Preset Controls](../../images/windows/preset-controls-win-1.4.0.png "Preset Controls (Windows)")
<!-- /.system-windows -->
When you've pressed this button, you'll see the following window appear:
![Preset Add Window](../../images/windows/add-preset-1.0.0.png "Preset Add Window")
<!-- .system-macos -->
![macOS Add Preset](../../images/windows/add-preset-mac-1.4.0.png "Add Preset (macOS)")
<!-- /.system-macos -->
<!-- .system-windows -->
![Windows Add Prese](../../images/windows/add-preset-win-1.4.0.png "Add Preset (Windows)")
<!-- /.system-windows -->
When you press save, HandBrake will use the default behaviour rules you've set and any settings from the main window just before you pressed "Add Preset".
Pressing "add" will save a new preset with the details you've entered based on the settings that are currently on the main window.
## Audio and Subtitles Beavhiours
Audio and Subtitle settings are special. The preset does not store selected audio and subtitle tracks from the main window. It uses rules to automatically select them for each new source or title that you selected.
You can modify these rules by editing the settings on the relevant "selection behaviour" screen.
Please note, these rules do not cover all possible use cases. If the behaviours don't meet your requirements, audio and subtitle tracks will need to be handled manually after you've scanned a source.
For more information, please see [Audio and Subtitle Defaults](../workflow/audio-subtitle-defaults.html).
## Default Preset
If you regularly use the same preset, you can make it the default preset that HandBrake starts with by selecting the "Make Default" (macOS) or "Set Current as Default" (Window) option in the presets menu or by using the preset manager accessed via the toolbar.

32
source/docs/en/latest/advanced/resizing-video.markdown
View File

@ -21,32 +21,22 @@ Resizing Video
The picture settings tab is located on HandBrake's main window and becomes active after you've scanned a source.
![Picture settings tab](../../images/windows/picture-settings-1.0.0.png "Picture settings tab")
### Width and Height
These allow you to adjust the size of the output. When you press the up or down arrows, the number will jump by the number selected in the "Modulus" dropdown.
When anamorphic strict is selected, both the "width" and "height" boxes will be disabled. You will get the maximum source size as output.
When loose is selected, you can downscale with the "width" or leave at the source width.
When none is selected, you can alter both "width" and "height"
### Modulus
The width and height must be divisible by this number. It's best left at 2, but if you have a problematic player, you can try setting it to 16.
![Picture settings tab](../../images/windows/picture-settings-win-1.4.0.png "Picture settings tab")
### Anamorphic
Typically recommended that you leave this on "loose". If your source is not anamorphic, having this set to an anamorphic option will not affect the output. Thus, it is safe to leave on.
Typically recommended that you leave this on "automatic". If your source is not anamorphic, having this set to an anamorphic option will not affect the output. Thus, it is safe to leave on.
## Upscaling
When "Automatic" is selected, HandBrake will maximise the output size of the video, up to the source resolution or set "Resolution Limit".
The HandBrake GUI's do not allow upscaling. Most of the time this is a bad idea as it reduces (not increases) the quality of your source file along with increasing the final file size. This is less than ideal. Most of the time, letting the playback device or software upscale to your screen size is much better. You don't gain anything by upscaling with HandBrake.
When "Off" is selected along with unchecking "Optimal Size", you can alter both "width" and "height". Otherwise, the source size, or resolution limit will be used.
In the very rare cases that this is needed, it can be done with the command line interface with the --width and --height options.
Typically you would only use this if the software or hardware you're using has a problematic or broken scaler.
When "Custom" is selected, you have full control of the output dimensions.
### Upscaling
While upscaling is NOT recommended, there are some instances where it is useful (i.e. uploading to YouTube). To enable this, check the "Allow upscaling" checkbox.
The "Resolution Limit" will still be honoured.
## Cropping
@ -56,7 +46,7 @@ HandBrake's auto-crop is not perfect. It's giving you a best guess at what the c
You can preview the effect of your adjustments by clicking the "Preview" button on the toolbar.
![HandBrake toolbar](../../images/windows/toolbar-1.0.0.png "HandBrake toolbar")
![HandBrake toolbar](../../images/windows/toolbar-win-1.4.0.png "HandBrake toolbar")
The preview window will then appear and will display in real-time any changes you make on the picture settings screen.
If the size of the output exceeds the window size, the preview window will scale it to fit to screen.

1
source/docs/en/latest/advanced/surround-sound.markdown
View File

@ -54,3 +54,4 @@ The following source format's can be passed thru.
- FLAC (MKV files only)
- AAC
- MP3
- MP2

21
source/docs/en/latest/advanced/video-sources.markdown
View File

@ -1,21 +0,0 @@
---
Type: article
State: [ draft ]
Title: Video Sources
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: []
Copyright: 2021 HandBrake Team
License: Creative Commons Attribution-ShareAlike 4.0 International
License_Abbr: CC BY-SA 4.0
License_URL: https://handbrake.fr/docs/license.html
---
Video Sources
=============================
- x264 tune
- May affect compatibility

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

@ -17,6 +17,9 @@ Command line reference
======================
The following details all the available options in the command line interface. This information may be accessed at any time by running `HandBrakeCLI --help`.
Please run this command on your own system as available options may vary depending on operating system and system hardware.
For reference, the following was generated by the Windows version of HandBrakeCLI:
Usage: HandBrakeCLI [options] -i <source> -o <destination>
@ -76,11 +79,13 @@ The following details all the available options in the command line interface. T
Start encoding at a given offset in seconds,
frames, or pts (on a 90kHz clock)
(e.g. seconds:10, frames:300, pts:900000).
Units must match --stop-at units, if specified.
--stop-at <string:number>
Stop encoding after a given duration in seconds,
frames, or pts (on a 90kHz clock) has passed
(e.g. seconds:10, frames:300, pts:900000).
Duration is relative to --start-at, if specified.
Units must match --start-at units, if specified.
Destination Options ----------------------------------------------------------
@ -111,9 +116,11 @@ The following details all the available options in the command line interface. T
-e, --encoder <string> Select video encoder:
x264
x264_10bit
nvenc_h264
x265
x265_10bit
x265_12bit
nvenc_h265
mpeg4
mpeg2
VP8
@ -195,8 +202,7 @@ The following details all the available options in the command line interface. T
Multiple output tracks can be used for one input.
-E, --aencoder <string> Select audio encoder(s):
none
ca_aac
ca_haac
av_aac
copy:aac
ac3
copy:ac3
@ -205,6 +211,7 @@ The following details all the available options in the command line interface. T
copy:truehd
copy:dts
copy:dtshd
copy:mp2
mp3
copy:mp3
vorbis
@ -218,13 +225,13 @@ The following details all the available options in the command line interface. T
is supported for the audio type.
Separate tracks by commas.
Defaults:
av_mp4 ca_aac
av_mkv ca_aac
av_mp4 av_aac
av_mkv mp3
av_webm vorbis
--audio-copy-mask <string>
Set audio codecs that are permitted when the
"copy" audio encoder option is specified
(aac/ac3/eac3/truehd/dts/dtshd/mp3/flac)
(aac/ac3/eac3/truehd/dts/dtshd/mp2/mp3/flac)
Separated by commas for multiple allowed options.
--audio-fallback <string>
Set audio codec to use when it is not possible
@ -252,8 +259,7 @@ The following details all the available options in the command line interface. T
Separate tracks by commas.
Defaults:
none up to dpl2
ca_aac up to 7point1
ca_haac up to 7point1
av_aac up to 7point1
ac3 up to 5point1
eac3 up to 5point1
mp3 up to dpl2
@ -287,25 +293,7 @@ The following details all the available options in the command line interface. T
lipshitz_ns
Separate tracks by commas.
Supported by encoder(s):
none
ca_aac
ca_haac
copy:aac
ac3
copy:ac3
eac3
copy:eac3
copy:truehd
copy:dts
copy:dtshd
mp3
copy:mp3
vorbis
flac16
flac24
copy:flac
opus
copy
-A, --aname <string> Set audio track name(s).
Separate tracks by commas.
@ -350,6 +338,7 @@ The following details all the available options in the command line interface. T
(default: set by preset, typically 2)
-M, --color-matrix <string>
Set the color space signaled by the output:
Overrides color signalling with no conversion.
2020
709
601
@ -463,6 +452,29 @@ The following details all the available options in the command line interface. T
sprite
Applies to NLMeans presets only (does not affect
custom settings)
--chroma-smooth[=string] Sharpen video with chroma smooth filter
Presets:
ultralight
light
medium
strong
stronger
verystrong
Custom Format:
cb-strength=c:cb-size=c:cr-strength=c:cr-size=c
Default:
cb-strength=1.2:cb-size=7
--no-chroma-smooth Disable preset chroma smooth filter
--chroma-smooth-tune <string> Tune chroma smooth filter
Tunes:
none
tiny
small
medium
wide
verywide
Applies to chroma smooth presets only (does
not affect custom settings)
--unsharp[=string] Sharpen video with unsharp filter
Presets:
ultralight
@ -513,12 +525,27 @@ The following details all the available options in the command line interface. T
sprite
Applies to lapsharp presets only (does not affect
custom settings)
-7, --deblock[=string] Deblock video with pp7 filter
-7, --deblock[=string] Deblock video with avfilter deblock
Presets:
ultralight
light
medium
strong
stronger
verystrong
Custom Format:
qp=q:mode=m:disable=d
strength=s:thresh=t:blocksize=b:disable=d
Default:
qp=5
strength=strong:thresh=20
--no-deblock Disable preset deblock filter
--deblock-tune <string>
Tune deblock filter
Tunes:
small
medium
large
Applies to deblock presets only (does not affect
custom settings)
--rotate[=string] Rotate image or flip its axes.
angle rotates clockwise, can be one of:
0, 90, 180, 270
@ -532,7 +559,17 @@ The following details all the available options in the command line interface. T
Color may be an HTML color name or RGB value.
The position of image in pad may also be set.
Custom Format:
width=w:height=h:color=c:x=x:y=y
width=w:height=h:color=c:x=x:y=y:top=t:bottom=b:
left=l:right=r
--colorspace <string> Convert colorspace, transfer characteristics or color primaries.
Presets:
bt2020
bt709
bt601-6-525
bt601-6-625
Custom Format:
primaries=p:transfer=t:matrix=m:range=r:
tonemap=t:param=p:desat=d
-g, --grayscale Grayscale encoding
--no-grayscale Disable preset 'grayscale'

2
source/docs/en/latest/get-handbrake/check-for-updates.markdown
View File

@ -24,7 +24,7 @@ Before updating, please make sure there are no pending encodes in the `Queue`. I
## Updating HandBrake on Linux
The Linux version of HandBrake does not have a built-in update checking feature. Your Linux distribution's package manager will handle any updates to the official PPA.
The Linux version of HandBrake does not have a built-in update checking feature. Updates are provided via FlatPak bundles.
<!-- /.system-linux -->
<!-- .system-macos -->

24
source/docs/en/latest/get-handbrake/download-and-install.markdown
View File

@ -26,7 +26,7 @@ This is the *only* official download source for HandBrake. For more information,
To download HandBrake to your computer, click the download button on the HandBrake website's [Home page](https://handbrake.fr/). You can also choose a version for a specific operating system from the [Downloads page](https://handbrake.fr/downloads.php).
Experienced users may wish to try HandBrake's [nightly builds](https://handbrake.fr/nightly.php)[^nightly-builds].
Experienced users may wish to try HandBrake's [development snapshot builds](https://github.com/HandBrake/HandBrake-snapshots)[^nightly-builds] that are available via GitHub.
## Verifying your download
@ -72,28 +72,6 @@ The HandBrake Team also publishes [OpenPGP signatures for all downloads on GitHu
If you have installed a HandBrake package from your distribution or other third-party package repository, please remove it before proceeding. See the section, *Warning about broken third-party builds* on [Where to get HandBrake](where-to-get-handbrake.html) for more information.
### Ubuntu PPAs
The following instructions are for Ubuntu. They may also work on other `deb`-compatible distributions. For other Linux, please compile from the [official source code](https://github.com/HandBrake/HandBrake).
From the command line, add the [official releases PPA](https://launchpad.net/~stebbins/+archive/ubuntu/handbrake-releases) to your system.
sudo add-apt-repository ppa:stebbins/handbrake-releases
sudo apt-get update
If you prefer HandBrake's nightly builds, add the [official git-snapshots PPA](https://launchpad.net/~stebbins/+archive/ubuntu/handbrake-git-snapshots).
sudo add-apt-repository ppa:stebbins/handbrake-git-snapshots
sudo apt-get update
Install HandBrake.
sudo apt-get install handbrake-cli handbrake-gtk
Run `HandBrakeCLI` to use HandBrake on the command line.
Run `ghb` to launch HandBrake's graphical user interface. You may wish to right-click on the icon and select "Lock to Launcher" for easy access in the future.
### Flatpak bundles
[Flatpak](https://flatpak.org/) bundles of HandBrake for Linux are available on the [HandBrake website](https://handbrake.fr/) and [Flathub](https://flathub.org/).

10
source/docs/en/latest/get-handbrake/where-to-get-handbrake.markdown
View File

@ -18,15 +18,13 @@ Where to get HandBrake
## HandBrake releases and nightly builds
Official [HandBrake releases](https://handbrake.fr/downloads.php) and [nightly builds](https://handbrake.fr/nightly.php) are available for Linux, Mac, and Windows.
Official [HandBrake releases](https://handbrake.fr/downloads.php) and [nightly builds](https://github.com/HandBrake/HandBrake-snapshots) are available for Linux, Mac, and Windows.
HandBrake is open-source software licensed under the GNU General Public License Version 2 (GPLv2)[^license]. Anyone can download and use HandBrake *for free*.
<!-- .system-linux -->
Ubuntu Linux users should install the [official release PPA](https://launchpad.net/~stebbins/+archive/ubuntu/handbrake-releases) or the [official snapshots PPA](https://launchpad.net/~stebbins/+archive/ubuntu/handbrake-git-snapshots). The PPA may work, but is not tested, on other Debian-compatible distributions.
[Nightly builds](https://handbrake.fr/nightly.php) for Linux are also available as Flatpak bundles.
For linux users, we provide FlatPak bundles which are available for download on our site, or via <a href="https://flathub.org/apps/details/fr.handbrake.ghb">flathub.org</a>
Users of other BSD- and *nix-like distributions may compile from source.
@ -63,10 +61,6 @@ Broken third-party packages/builds include but are not limited to:
Please **do not** request support for these or any other unofficial versions. The HandBrake Team has zero control over them and therefore cannot provide meaningful support.
BSD users should compile from the [official source code](https://github.com/HandBrake/HandBrake).
Linux users should install the [official release PPA](https://launchpad.net/~stebbins/+archive/ubuntu/handbrake-releases), install the [official snapshots PPA](https://launchpad.net/~stebbins/+archive/ubuntu/handbrake-releases), or compile from the [official source code](https://github.com/HandBrake/HandBrake).
<!-- /.system-linux -->
<!-- .continue -->

5
source/docs/en/latest/help/community-support.markdown
View File

@ -36,8 +36,9 @@ Developers and keen users may report bugs on HandBrake's [issue tracker on GitHu
## IRC discussion channels
Real-time chat is available on our [Freenode](http://freenode.net/irc_servers.shtml) IRC channel, [#handbrake](irc://irc.freenode.net/#handbrake). Make sure to provide an [Activity Log](activity-log.html) when requesting support.
Real-time chat is available via #HandBrake on the [Libera.Chat](https://libera.chat/) IRC Network. Make sure to provide an [Activity Log](activity-log.html) when requesting support.
Note that HandBrake's developers are located in various timezones around the world, and have lives and jobs outside of HandBrake and its community. It's possible that nobody will be able to answer your support request on IRC right away. Be patient for awhile or ask on the forums.
Developer discussion happens on [#handbrake-dev](irc://irc.freenode.net/#handbrake-dev), which is moderated for the team's sanity. If you're a developer and would like to speak on [#handbrake-dev](irc://irc.freenode.net/#handbrake-dev), you may ask politely on [#handbrake](irc://irc.freenode.net/#handbrake).
Developer discussion happens on the channel #HandBrake-dev, which is moderated for the team's sanity. If you're a developer and would like to speak on #HandBrake-dev, you may ask politely in #Handbrake