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

docs: Add WebM documentation.

Browse Source 
Some minor cosmetic cleanup, and update to the latest CLI help output.
This commit is contained in:
Justin Bull 2019-01-29 10:30:38 -05:00 committed by Bradley Sepos
parent 7dc07bc325
commit af4f50f39b
No known key found for this signature in database
GPG Key ID: DEADE2F57D42D9C7
6 changed files with 93 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
source/docs/en/latest/advanced/chapter-markers.markdown
View File

@ -15,21 +15,21 @@ License_URL: https://handbrake.fr/docs/license.html
---
Chapter Markers
=============================
===============
## Chapters
HandBrake can copy Chatper Markers from your source to the MP4 or MKV output file.
HandBrake can copy chapter markers from your source to the MP4, MKV, or WebM output file.
In HandBrake, if you click on the 'Chapters' tab, you'll see a list of detected chapters. HandBrake will automatically generated chapter names in the following format: "Chatper n" where n is the chapter number.
In HandBrake, if you click on the Chapters tab, you'll see a list of detected chapters. HandBrake will automatically generate chapter names in the following format: "Chatper n" where n is the chapter number.
![Chapters Tab](../../images/windows/chapters-1.0.0.png "Chapters Tab")
## Renaming Chapters.
## Renaming chapters
If you wish, you can re-name these by simply simply altering the names shown in the chapters tab.
If you wish, you can rename these by simply simply altering the names shown in the chapters tab.
You can also import or export the set of chapter markers. HandBrake supports importing of CSV (Command seperated Values) files.
You can also import or export the set of chapter markers. HandBrake supports importing of CSV (Command seperated Values) files.
Click the Import button to choose a CSV file. The file must be in the following format:
@ -45,4 +45,4 @@ Finally, you can export the current chapter list to CSV format by clicking the '
## Sources without chapters
Unfortunatly, HandBrake can not currently add chapter markers if they did not already exist in the source.
Unfortunately, HandBrake can not currently add chapter markers if they did not already exist in the source.

2
source/docs/en/latest/advanced/subtitles.markdown
View File

@ -39,6 +39,8 @@ HandBrake has two methods of subtitle OUTPUT:
- Hard Burn: This means the subtitles are written on top of the image permanently. They cannot be turned on or off like on the DVD.
- Soft Subtitles: This means the subtitles will appear as separate selectable tracks in your output file. With the correct playback software, you’ll be able to enable / disable these subtitles as required.
Soft subtitles are currently unsupported in the WebM container.
The following subtitle types as supported as follows:
- Bluray PGS Subtitles

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

@ -19,7 +19,7 @@ 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`.
Usage: HandBrakeCLI [options] -i <source> -o <destination>
General Options --------------------------------------------------------------
-h, --help Print help
@ -51,10 +51,10 @@ The following details all the available options in the command line interface. T
--queue-import-file <filename>
Import an encode queue file created by the GUI
--no-dvdnav Do not use dvdnav for reading DVDs
Source Options ---------------------------------------------------------------
-i, --input <string> Set input file or device ("source")
-t, --title <number> Select a title to encode (0 to scan all titles
only, default: 1)
@ -81,14 +81,15 @@ The following details all the available options in the command line interface. T
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.
Destination Options ----------------------------------------------------------
-o, --output <filename> Set destination file name
-f, --format <string> Select container format:
av_mp4
av_mkv
av_webm
default: auto-detected from destination file name)
-m, --markers Add chapter markers
--no-markers Disable preset chapter markers
@ -103,10 +104,10 @@ The following details all the available options in the command line interface. T
--inline-parameter-sets Create adaptive streaming compatible output.
Inserts parameter sets (SPS and PPS) inline
in the video stream before each IDR.
Video Options ----------------------------------------------------------------
-e, --encoder <string> Select video encoder:
x264
x264_10bit
@ -170,10 +171,10 @@ The following details all the available options in the command line interface. T
timing if it's below that rate.
If none of these flags are given, the default
is --pfr when -r is given and --vfr otherwise
Audio Options ----------------------------------------------------------------
--audio-lang-list <string>
Specify a comma separated list of audio
languages you would like to select from the
@ -219,6 +220,7 @@ The following details all the available options in the command line interface. T
Defaults:
av_mp4 ca_aac
av_mkv ca_aac
av_webm vorbis
--audio-copy-mask <string>
Set audio codecs that are permitted when the
"copy" audio encoder option is specified
@ -250,8 +252,8 @@ 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 dpl2
ca_haac up to dpl2
ca_aac up to 7point1
ca_haac up to 7point1
ac3 up to 5point1
eac3 up to 5point1
mp3 up to dpl2
@ -282,16 +284,34 @@ The following details all the available options in the command line interface. T
rectangular
triangular
triangular_hp
triangular_ns
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.
Picture Options --------------------------------------------------------------
-w, --width <number> Set storage width in pixels
-l, --height <number> Set storage height in pixels
--crop <top:bottom:left:right>
@ -336,10 +356,10 @@ The following details all the available options in the command line interface. T
ntsc (same as 601)
pal
(default: auto-detected from source)
Filters Options --------------------------------------------------------------
--comb-detect[=string] Detect interlace artifacts in frames.
If not accompanied by the decomb or deinterlace
filters, this filter only logs the interlaced
@ -515,10 +535,10 @@ The following details all the available options in the command line interface. T
width=w:height=h:color=c:x=x:y=y
-g, --grayscale Grayscale encoding
--no-grayscale Disable preset 'grayscale'
Subtitles Options ------------------------------------------------------------
--subtitle-lang-list <string>
Specify a comma separated list of subtitle
languages you would like to select from the
@ -555,7 +575,7 @@ The following details all the available options in the command line interface. T
Example: "1,2,3" for multiple tracks.
If "string" is omitted, the first track is
forced.
--subtitle-burned[=number]
--subtitle-burned[=number, "native", or "none"]
"Burn" the selected subtitle into the video
track. If "subtitle" is omitted, the first
track is burned. "subtitle" is an index into
@ -608,3 +628,23 @@ The following details all the available options in the command line interface. T
the video track.
If 'number' is omitted, the first SRT is burned.
'number' is a 1-based index into the 'srt-file' list
--ssa-file <string> SubStationAlpha SSA filename(s), separated by
commas.
--ssa-offset <string> Offset (in milliseconds) to apply to the SSA
file(s), separated by commas. If not specified,
zero is assumed. Offsets may be negative.
--ssa-lang <string> SSA track language as an ISO 639-2 code
(e.g. fre, eng, spa, dut, et cetera)
If not specified, then 'und' is used.
Separate by commas.
--ssa-default[=number]
Flag the selected SSA as the default subtitle
to be displayed during playback.
Setting no default means no subtitle will be
automatically displayed. If 'number' is omitted,
the first SSA is the default.
'number' is a 1-based index into the 'ssa-file' list
--ssa-burn[=number] "Burn" the selected SSA subtitle into
the video track.
If 'number' is omitted, the first SSA is burned.
'number' is a 1-based index into the 'ssa-file' list

6
source/docs/en/latest/introduction/about.markdown
View File

@ -20,18 +20,18 @@ About HandBrake
HandBrake is an open-source video transcoder available for Linux, Mac, and Windows. Everyone can use HandBrake to make videos *for free*.
HandBrake is a post-production tool. Its primary purpose is to convert videos from supported [source formats](../technical/source-formats.html) to MP4 or MKV format. If you wish to make changes to your `Source` video, please use an appropriate [video editing software](https://en.wikipedia.org/wiki/List_of_video_editing_software).
HandBrake is a post-production tool. Its primary purpose is to convert videos from supported [source formats](../technical/source-formats.html) to MP4, MKV, or WebM format. If you wish to make changes to your `Source` video, please use an appropriate [video editing software](https://en.wikipedia.org/wiki/List_of_video_editing_software).
## What HandBrake does
HandBrake takes videos you already have and makes new ones that work on your mobile phone, tablet, TV media player, game console, computer, or web browser—nearly anything that supports modern video formats.
HandBrake works with most common video files and formats, including ones created by consumer and professional video cameras, mobile devices such as phones and tablets, game and computer screen recordings, and DVD and Blu-ray discs. HandBrake leverages tools such as FFmpeg, x264, and x265 to create new MP4 or MKV video files from these `Sources`.
HandBrake works with most common video files and formats, including ones created by consumer and professional video cameras, mobile devices such as phones and tablets, game and computer screen recordings, and DVD and Blu-ray discs. HandBrake leverages tools such as FFmpeg, x264, and x265 to create new MP4, MKV, or WebM video files from these `Sources`.
HandBrake **does**:
- Convert nearly any video to MP4 or MKV
- Convert nearly any video to MP4, MKV, or WebM
- Crop and resize video
- Restore old and low-quality video
- Remove combing artifacts caused by interlacing and telecine

2
source/docs/en/latest/technical/anamorphic-guide.markdown
View File

@ -107,7 +107,7 @@ With this method, you can preserve the full frame on the DVD, without having to
Now, how do we go about doing this?
Vide on a computer is stored in a container file, be it .mp4 or .mkv or .avi or .ogm or something else. Inside that container are tracks or streams. Usually, there will be one video track and one audio track.
Video on a computer is stored in a container file, be it .mp4 or .mkv or .avi or .ogm or something else. Inside that container are tracks or streams. Usually, there will be one video track and one audio track.
The smart way of handling anamorphic is to store the display information in the video track. And this is exactly what HandBrake does:

23
source/docs/en/latest/technical/containers.markdown
View File

@ -1,7 +1,7 @@
---
Type: article
State: [ draft ]
Title: Formats / containers
Title: Container formats
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
@ -14,18 +14,18 @@ License_Abbr: CC BY-SA 4.0
License_URL: https://handbrake.fr/docs/license.html
---
Formats / containers
=============================
Container formats
=================
Containers are files that wrap around video and audio tracks—indexing and organizing the streams for playback—in addition to providing advanced features, like chapters similar to those on DVDs.
HandBrake supports two widely supported formats. MKV and MP4 (Sometimes seen as M4v)
HandBrake creates the widely supported container formats MKV and MP4 (sometimes seen as M4V), in addition to the [WebM](https://www.webmproject.org/) container format, which is subset of MKV.
## Features
Features and playback compatiblity varies between MKV and MP4. The following is a summary of some of these differences:
Features and playback compatiblity varies between MKV, WebM, and MP4. The following is a summary of some of these differences:
- In an MP4 file, you can store MPEG-4 video created by ffmpeg or x264.
- In an MP4 container, you can store MPEG-4 video created by ffmpeg or x264.
- Supports H.264, H.265, MPEG-4, MPEG-2 video.
- It stores audio in the AAC format. It is also possible to pass through Dolby Digital 5.1 Surround Sound (AC3) audio from a DVD in an MP4 file, although it is a new standard and not widely supported. VLC can decode it, and the AppleTV can pass it through to a surround sound receiver.
- MP4 also supports chapters, for which HandBrake uses Apple's chapter format.
@ -34,15 +34,20 @@ Features and playback compatiblity varies between MKV and MP4. The following is
- 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.
- In an MKV, you can store MPEG-4 video created by ffmpeg or x264, or Theora video.
- In an MKV container, you can store MPEG-4 video created by ffmpeg or x264, or Theora video.
- Supports H.264, H.265, MPEG-4, MPEG-2 video and VP3 (Vorbis)
- It stores audio in the AAC, MP3, Vorbis or FLAC formats. It can also pass through the Dolby Digital 5.1 (AC3) and Digital Theater Systems (DTS) surround sound formats used by DVDs.
- 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.
## MP4 vs M4v
- In a WebM container, you can store VP8 or VP9 video.
- Supports VP8 and VP9 video codecs.
- It stores audio in either Vorbis or Opus formats.
- It can include "hard" burned in subtitles. "Soft" subtitles are currently unsupported.
They are the exact same file, the only difference is the extension. MP4 vs M4v.
## MP4 vs M4V
They are the exact same file, the only difference is the extension. MP4 vs M4V.
For MP4 files, HandBrake will automatically use the extension M4V when you pass-through audio (AC3), use SRT subtitles or have chapter markers enabled.