Skip to content

Commit

Permalink
docs: minor updates to codec and filter lists
Browse files Browse the repository at this point in the history
  • Loading branch information
galad87 committed Nov 26, 2024
1 parent 9f85b18 commit 42e498e
Show file tree
Hide file tree
Showing 10 changed files with 52 additions and 38 deletions.
8 changes: 5 additions & 3 deletions source/docs/en/latest/advanced/surround-sound.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,10 @@ The following source format's can be passed thru.
- DTS (Limited player compatibility in MP4)
- DTS-HD (Limited player compatibility in MP4)
- TrueHD (Limited player compatibility in MP4)
- FLAC (MKV files only)
- FLAC
- ALAC
- AAC
- MP3
- MP2
- MP3 (Limited player compatibility in MP4)
- MP2 (Limited player compatibility in MP4)
- Opus
- Vorbis
1 change: 1 addition & 0 deletions source/docs/en/latest/developer/build-mac.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Optional dependencies (required by libdovi)
- `rustup target add aarch64-apple-darwin` for cross-compiling for Apple Silicon on an Intel Mac
- `rustup target add x86_64-apple-darwin` for cross-compiling for Intel on an Apple Silicon Mac
- [openssl](https://www.openssl.org)
- may be built via included script
- [cargo-c](https://github.com/lu-zero/cargo-c)
- Can be installed by running `cargo install cargo-c`

Expand Down
2 changes: 1 addition & 1 deletion source/docs/en/latest/help/activity-log.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ You can access the current log by opening the Activity Log window in HandBrake.

On Mac, logs are stored at the following locations, where `Username` is your user name:

- `/Users/Username/Library/Containers/fr.handbrake.HandBrake/Data/Library/Application Support/HandBrake/EncodeLogs` for HandBrake 1.3.0 and later, sandboxed nightly/snapshot builds, and sandboxed personal builds
- `/Users/Username/Library/Containers/fr.handbrake.HandBrake/Data/Library/Application Support/HandBrake/EncodeLogs` for HandBrake 1.3.0 and later, sandboxed nightly/snapshot builds, and sandboxed personal builds (the fr.handbrake.HandBrake folder is shown as HandBrake in Finder)
- `/Users/Username/Library/Application Support/HandBrake/EncodeLogs` for HandBrake 1.2.2 and earlier, older non-sandboxed nightly/snapshot builds, and non-sandboxed personal builds

You can open the applicable location directly from HandBrake’s Activity Log window.
Expand Down
16 changes: 9 additions & 7 deletions source/docs/en/latest/technical/audio-codecs.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Audio Encoders
- On Mac, HandBrake uses Apple's CoreAudio AAC encoder. It's known to be
much better quality and is the default option for Mac users.

- HE-AAC (Mac Only)
- HE-AAC (Mac Only):

- High Efficiency AAC encoder. This encoder is optimized for low-bitrate
applications which may be useful for streaming.
Expand All @@ -63,32 +63,34 @@ Audio Encoders

- HandBrake offers Vorbis audio encoding as well.

- Opus
- Opus:

- Available in MKV files, Opus is the successor to Vorbis. HandBrake uses libopus for encoding.
- Opus is the successor to Vorbis. HandBrake uses libopus for encoding.

- AC3 and E-AC3:

- HandBrake can encode to AC3 using FFmpeg.

- This is not the same as Passthru. You can encode any audio track to AC3.

- Flac 16 and 24bit (FFmpeg)
- Flac 16 and 24bit (FFmpeg):

- Lossless audio compression.

- Available in MKV files.

- It is not currently possible to passthru the compression level to the
ffmpeg encoder which is currently defaulted to "5"

- ALAC 16 and 24bit:

- Lossless audio compression.



Passthru options.
-----------------

HandBrake supports passthru for a limited number of popular source formats.
These are: AC3, E-AC3, DTS, DTS-HD, TrueHD, MP3, MP2, AAC or flac (Passthru)
These are: AC3, E-AC3, DTS, DTS-HD, TrueHD, Opus, Vorbis, MP3, MP2, AAC, FLAC or ALAC (Passthru)

This copies the audio bit-for-bit from the source so offers no loss in audio
quality. These audio tracks can be quite large so can impact the final size of
Expand Down
14 changes: 8 additions & 6 deletions source/docs/en/latest/technical/audio-quality.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -31,20 +31,22 @@ There are several different modes HandBrake can operate in.

### Average Bitrate

HandBrake supports average bitrate for all audio encoders except FLAC.
HandBrake supports average bitrate for all audio encoders except FLAC, ALAC, and TrueHD.

### Quality based Encoding

Quality based encoding is supported for the following codecs:

- AAC
- MP3
- Vorbis
- Opus

The scale of the quality if much less pronounced compared to the video quality slider, so changes do not have nearly as big an impact on file size.

### Lossless

HandBrake supports FLAC (both 16 and 24bit) when the output format is MKV.
HandBrake supports FLAC and ALAC (both 16 and 24bit) when the output format is MKV or MP4.

In addition, HandBrake can passthru the following source audio track formats:

Expand All @@ -53,9 +55,9 @@ In addition, HandBrake can passthru the following source audio track formats:
- TrueHD
- AAC
- MP3
- Opus
- Vorbis
- TrueHD
- FLAC




- ALAC

8 changes: 4 additions & 4 deletions source/docs/en/latest/technical/containers.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,17 @@ HandBrake creates the widely supported container formats MKV and MP4 (sometimes
Features and playback compatiblity varies between MKV, WebM, and MP4. The following is a summary of some of these differences:

- MP4 container.
- Supports H.264, H.265, MPEG-4, MPEG-2, AV1 video.
- It stores audio in the AAC, MP3, AC3, E-AC3, and Opus format. AAC is recommended for better compatibility on most players. It is also possible to pass through Dolby Digital 5.1 Surround Sound (AC3) audio from a DVD or Blu-ray, and E-AC3 and TrueHD.
- Supports H.264, H.265, MPEG-4, MPEG-2, VP9, AV1 video.
- It stores audio in the AAC, MP3, AC3, E-AC3, TrueHD, Opus, FLAC, and ALAC format. AAC is recommended for better compatibility on most players. It is also possible to pass through Dolby Digital 5.1 Surround Sound (AC3) audio from a DVD or Blu-ray, and E-AC3 and TrueHD.
- MP4 also supports chapters, for which HandBrake uses Apple's chapter format.
- MP4 also is capable of storing [VariableFrameRate Variable Frame Rate] video.
- Be aware that chapters and AC3 audio can only be seen by QuickTime 7 and earlier if you change the file extension from .mp4 to .m4v. HandBrake will do this for you automatically when you enable those features, although this can be disabled in the preferences if you really want .mp4 at the end of the name. QuickTime X and later don't require the extension change.
- The MP4 format can also be optimized for "fast start" progressive downloads over the Web.
- It can also include "soft" text subtitles that can be turned on or off, instead of always being hard burned into the video frames.

- MKV container.
- Supports H.264, H.265, MPEG-4, MPEG-2, VP8, VP9, AV1, Theora video.
- It stores audio in the AAC, MP3, AC3, E-AC3, Vorbis, Opus, or FLAC formats. It can also pass through the Dolby Digital 5.1 (AC3), Digital Theater Systems (DTS), and TrueHD surround sound formats used by DVDs and Blu-rays.
- Supports H.264, H.265, MPEG-4, MPEG-2, VP8, VP9, AV1, Theora, FFV1 video.
- It stores audio in the AAC, MP3, AC3, E-AC3, TrueHD, Vorbis, Opus, FLAC or ALAC formats. It can also pass through the Dolby Digital 5.1 (AC3), Digital Theater Systems (DTS), and TrueHD surround sound formats used by DVDs and Blu-rays.
- It supports chapters, as well as [VariableFrameRate Variable Frame Rate] video.
- It can include "soft" subtitles that can be turned on or off, instead of always being hard burned into the video frame. These can either be bitmap images of the subtitles included on a DVD (known as vobsub) or text.

Expand Down
35 changes: 20 additions & 15 deletions source/docs/en/latest/technical/filters-summary.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,17 @@ Summary of Filters
HandBrake contains the following filters:

- Detelecine
- Deinterlace
- Comb Detect
- Deinterlace
- Yadif
- Decomb
- Denoise
- Bwdif
- Deblock
- Denoise
- Chroma Smooth
- Grayscale
- Sharpen
- Colorspace
- Grayscale


Detelecine
Expand All @@ -41,6 +45,7 @@ Deinterlace

Deinterlace removes comb artifacts from the picture.
Yadif is a popular and fast deinterlacer.
Bwdif is a motion adaptive deinterlacing based on yadif with the use of w3fdif and cubic interpolation algorithms.
Decomb switches between multiple interpolation algorithms for speed and quality.

The following Deinterlace tunes are available:
Expand All @@ -51,6 +56,12 @@ The following Deinterlace tunes are available:
- Bob: Attempts to better preserve motion for a slight penalty to perceived resolution.


Deblock
-------

Deblock reduces blocky artifacts caused by low quality video compression.


Denoise
-------

Expand All @@ -71,24 +82,12 @@ For NLMeans the following Denoise tunes are available:
- Sprite: Is useful for 1-/4-/8-/16-bit 2-dimensional games. Sprite is not designed for high definition video.


Deblock
-------

Deblock reduces blocky artifacts caused by low quality video compression.


Chroma Smooth
-------------

Reduces chroma noise, rainbows, and other prominent visual artifacts. Useful for resolving various color-related issues, especially with lower resolution content from analog sources, e.g. poor quality DVD and VHS sources. The blurring/smoothing algorithm is the same as used by the unsharp filter.


Grayscale
---------

Grayscale removes the color component of the video. Often referred to as Black & White video.


Colorspace
----------

Expand All @@ -100,3 +99,9 @@ Colorspace + tonemap filter. Can change/tonemap the colorspace of the video into
- BT.601 EBU

If this set to "Off" then HandBrake will keep the colorspace of the video.


Grayscale
---------

Grayscale removes the color component of the video. Often referred to as Black & White video.
2 changes: 1 addition & 1 deletion source/docs/en/latest/technical/preferences.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The Preferences menu can be accessed via the "Tools" Menu -> "Preferences" optio


<!-- .system-macos -->
The Preferences menu can be accessed via the "HandBrake" Menu -> "Preferences" option.
The Preferences menu can be accessed via the "HandBrake" Menu -> "Settings" option.
<!-- /.system-macos -->


Expand Down
2 changes: 2 additions & 0 deletions source/docs/en/latest/technical/video-bit-depth.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ The follow encoders support higher than 8-bit.
| Nvidia NVEnc |
| Apple Video Toolbox |
| SVT-AV1 |
| VP9 |
| FFV1 |

Please note, you must select a "10-bit" or "12-bit" encoder from the "Video Encoder" dropdown on the "Video" tab to enable this feature.
For hardware encoders, the option will only be shown if the system supports it.
2 changes: 1 addition & 1 deletion source/docs/en/latest/technical/video-cq-vs-abr.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ encoder will vary the number of bits given to any one portion of the video, but
try to keep everything at the average you set.

- The video bitrate can be set on the "Video Tab"
- It is recommended that you use 2-Pass encoding.
- It is recommended that you use multi-pass encoding.
- This will provide better quality and better bit-rate distribution. A single
pass will lead to sub-optimal results.
- The "Turbo" checkbox will make the first pass quicker at the expense of
Expand Down

0 comments on commit 42e498e

Please sign in to comment.