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

docs: Add docs for HandBrake 1.0.0, duplicate of latest.

Browse Source
This commit is contained in:
Bradley Sepos 2016-12-23 05:13:11 -05:00
parent d6c03366fe
commit 0ab4fc1833
65 changed files with 4776 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
source/docs/en/1.0.0/about/history.markdown Normal file
View File

@ -0,0 +1,37 @@
---
Type: article
State: draft
Title: HandBrake History
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Scott (s55) ]
Copyright: 2016 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
---
The History of HandBrake
=============================
HandBrake was started in 2003 by “titer”. He continued to be the primary developer through April 2006, when the last official Subversion revision was checked in.
titer continued to be active on the forums for a short time after that, then contact was lost. Since the May/June? 2006 timeframe, nobody in HandBrake circles was been successful in communicating with titer and no further code changes were officially made.
In early August 2006, development work on HandBrake resumed on an unofficial basis. “Banana” from the HandBrake forums posted a message about “HandBrake Extreme”, an optimized build of HandBrake, platform unknown.
Starting September 2006, Rodney Hester and Chris Long were independently working to reverse-engineer Apple’s new 640×480 H.264 iPod firmware 1.2 format and came together on the forums. Fortunately, their work complemented each other’s, and they banded together to put together an unstable but compilable release of HandBrake supporting the new format (including Apple’s new uuid atom).
Since then, considerable progress has been made in terms of stability, functionality, and look-and-feel. Unfortunately, it was not possible to check changes into the m0k Subversion repository for HandBrake without prior authorization, which couldn’t be obtained without permission and a reply from titer, which we had not received.
As a result, Rodney Hester created a subversion repository mirroring the 0.7.1 and final Subversion trees from the official HandBrake site and we began building our changes on top of that. This site, along with the development forum, were created to support those efforts.
As of January 26, 2007, our HandBrake fork was officially known as MediaFork.
On February 13, 2007, we finally heard from titer, who was fully in support of our work and encouraged us to continue. We laid plans to reintegrate our projects under the HandBrake banner, relocated our web services to m0k.org, and as of March 2, 2007, all developer and end-user servers had returned to m0k.org. The next code release was officially named HandBrake and will remain so going forward.
Today, HandBrake is will hosted by titer the the development team remains in contact however he is not active in the day to day running or development of the project.

18
source/docs/en/1.0.0/about/the-icon.markdown Normal file
View File

@ -0,0 +1,18 @@
---
Type: article
State: draft
Title: Audio and Subtitle Defaults
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: []
Copyright: 2016 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
---
The Icon
=============================

20
source/docs/en/1.0.0/advanced/audio-defaults.markdown Normal file
View File

@ -0,0 +1,20 @@
---
Type: article
State: draft
Title: Audio Defaults
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: []
Copyright: 2016 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

66
source/docs/en/1.0.0/advanced/audio-subtitle-defaults.markdown Normal file
View File

@ -0,0 +1,66 @@
---
Type: article
State: draft
Title: Audio and Subtitle Defaults
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Scott (s55) ]
Copyright: 2016 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 and Subtitle Defaults
=============================
HandBrake does not store Audio and Subtitle tracks in presets.
Instead, we store behaviour rules for automatically selecting audio and subtitle tracks each time you scan a new source or select a title.
In order to configure the track selection behaviour, click the "Configure Defaults" button on the Audio or Subtitle Defaults tab.
### Audio Defaults
![Audio Defaults Window](../../images/windows/audio-defaults-1.0.0.png "Audio Defaults Window")
- Track Selection Behaviour
- None
- No audio tracks will be automatically added.
- First matching selected Language
- 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.
### Subtitle Defaults
![Subtitle Defaults Window](../../images/windows/subtitle-defaults-1.0.0.png "Subtitle Defaults Window")
- Track Selection Behaviour
- None
- No subtitle tracks will be added
- First matching selected Language
- 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.

48
source/docs/en/1.0.0/advanced/chapter-markers.markdown Normal file
View File

@ -0,0 +1,48 @@
---
Type: article
State: draft
Title: Chapter Markers
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Scott (s55) ]
Copyright: 2016 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
---
Chapter Markers
=============================
## Chapters
HandBrake can copy Chatper Markers from your source to the MP4 or MKV 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.
![Chapters Tab](../../images/windows/chapters-1.0.0.png "Chapters Tab")
## Renaming Chapters.
If you wish, you can re-name 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.
Click the Import button to choose a CSV file. The file must be in the following format:
```
1,Chapter Name
2,Chapter 2 Name
3,Chapter 3 Name
....
```
Finally, you can export the current chapter list to CSV format by clicking the 'export' button.
## Sources without chapters
Unfortunatly, HandBrake can not currently add chapter markers if they did not already exist in the source.

31
source/docs/en/1.0.0/advanced/custom-presets.markdown Normal file
View File

@ -0,0 +1,31 @@
---
Type: article
State: draft
Title: Custom Presets
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Scott (s55) ]
Copyright: 2016 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
---
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.
![Preset Controls](../../images/windows/preset-controls-1.0.0.png "Preset Controls")
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")
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".

22
source/docs/en/1.0.0/advanced/managing-audio.markdown Normal file
View File

@ -0,0 +1,22 @@
---
Type: article
State: draft
Title: Managing Audio Tracks
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Scott (s55) ]
Copyright: 2016 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
---
Managing Audio Tracks
=============================
Coming Soon!
## Understanding HandBrake's Audio Track Tab

35
source/docs/en/1.0.0/advanced/point-to-point.markdown Normal file
View File

@ -0,0 +1,35 @@
---
Type: article
State: draft
Title: Point to Point Encoding
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: []
Copyright: 2016 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
---
Point to Point Encoding
=============================
## Understanding your source
DVDs, blu-ray discs and video files can be divided into titles and chapters. Usually a title is a whole feature, like a movie or an episode.
Chapters, then, divide the movie/episode up logically. In a DVD or Blu-ray disc menu, if you use "Scene Selection", you are navigating by chapter.
## Point to Point options
![Point to Point controls](../../images/windows/point-to-point-1.0.0.png "Point to Point controls")
For a given title, you can choose to encode only part of it unstead of the whole thing.
There are three options:
- Chapters,
- Seconds, e.g 60-180 means it will encode 2 minutes of video, starting 1 minute into the title.
- Frames, e.g (25-150) will encode 5 seconds of video if the framerate is 25fps. Starting after the 1st second of video.

20
source/docs/en/1.0.0/advanced/post-processing.markdown Normal file
View File

@ -0,0 +1,20 @@
---
Type: article
State: draft
Title: Post Processing
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: []
Copyright: 2016 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
---
Post Processing
=============================
Todo

177
source/docs/en/1.0.0/advanced/queue.markdown Normal file
View File

@ -0,0 +1,177 @@
---
Type: article
Title: Multiple encodes using the Queue
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS), Scott (s55) ]
Copyright: 2016 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
---
Multiple encodes using the Queue
================================
Encoding videos takes time, and can use a lot of your computer's computational power.
Luckily, you can set up multiple encodes at once by adding them to HandBrake's `Queue`.
## Adding encodes to the Queue
Begin by [opening a Source, selecting a Title](../workflow/open-video-source.html), and [selecting a Preset](../workflow/select-preset.html). Then select the `Add to Queue` button on the toolbar.
<!-- .system-mac -->
![Adding an encode to the Queue](../../images/mac/add-to-queue-button-1.0.0.png "Select the Add to Queue button on the toolbar to add your encode to the queue.")
<!-- /.system-mac -->
<!-- .system-win -->
![HandBrake toolbar on Windows](../../images/windows/toolbar-1.0.0.png "Select the Add to Queue button on the toolbar to add your encode to the queue.")
<!-- /.system-win -->
Select the `Show Queue` button on the toolbar to see the queued encodes, or `Jobs`.
<!-- .system-mac -->
![Opening the Queue window](../../images/mac/queue-button-1.0.0.png "Select the Show Queue button on the toolbar to open the Queue window.")
![Queue window on Mac](../../images/mac/queue-1.0.0.png "The Queue window lists pending Jobs.")
<!-- /.system-mac -->
<!-- .system-win -->
![HandBrake toolbar on Windows](../../images/windows/toolbar-1.0.0.png "Select the Show Queue button on the toolbar to open the Queue window.")
![Queue window on Windows](../../images/windows/queue-1.0.0.png "The Queue window lists pending Jobs.")
<!-- /.system-win -->
You may open additional `Sources` and add them to the `Queue` in the same manner.
## Adding multiple encodes simultaneously
When using the `Queue`, you may find it beneficial to create multiple `Jobs` at one time.
<!-- .system-mac -->
On Mac, first open the `Preferences` window using the `HandBrake` menu. In the `General` section, ensure that the `Automatically name output files` setting is selected and `Title` is part of the `Format` field.
![Opening the Preferences window on Mac](../../images/mac/preferences-menu-1.0.0.png "Open the Preferences window using the HandBrake menu.")
![Selecting the Automatically name output files setting](../../images/mac/preferences-auto-naming-1.0.0.png "Select Automatically name output files to ensure unique file names when adding multiple Titles to the Queue.")
This ensures that each of your `Jobs` will be given a unique file name, and not overwrite each other.
<!-- /.system-mac -->
<!-- .system-win -->
On Windows, first open the `Preferences` window using the `Tools` menu. In the `Output Files` section, ensure that the `Automatically name output files` setting is selected. Set a `Default Path` (where your new videos will be created) and make sure `Title` is part of the `File Format` field.
![Opening the Preferences window on Windows](../../images/windows/preferences-menu-1.0.0.png "Open the Preferences window using the Tools menu.")
![Selecting the Automatically name output files setting](../../images/windows/preferences-auto-naming-1.0.0.png "Set up Automatic File Naming to ensure unique file names when adding multiple Titles to the Queue.")
This ensures that each of your `Jobs` will be given a unique file name, and not overwrite each other.
<!-- /.system-win -->
If your `Source` is a Blu-ray, DVD, or other disc or disc-like format with multiple `Titles`, you may open it with HandBrake and add multiple `Titles` to the `Queue` simultaneously.
Additionally, you may open a folder of multiple single-`Title` videos (excluding discs and disc-like formats) as one virtual `Source` with multiple `Titles` using the `Open Source` dialog, and then add multiple `Titles` to the `Queue`[^batch-scan-subdirectories].
<!-- .system-mac -->
![Opening a folder containing multiple video Sources](../../images/mac/open-source-dialog-folder-1.0.0.png "The Open Source dialog allows you to select a folder containing multiple video files.")
![Selecting a Title](../../images/mac/title-selection-1.0.0.png "The Title control lets you select which video clip you want to use.")
<!-- /.system-mac -->
<!-- .system-lin -->
On Linux, select `Add Multiple` from the `Queue` menu, then select the `Titles` you wish to encode using the presented dialog. Be sure to give each a unique file name.
<!-- /.system-lin -->
<!-- .system-mac -->
On Mac, select `Add Titles to Queue...` from the `File` menu, then select the `Titles` you wish to encode using the presented dialog.
![Add Titles to Queue menu item](../../images/mac/add-titles-to-queue-menu-1.0.0.png "Select Add Titles to Queue... from the File menu to open a selection dialog.")
![Selecting multiple Titles to add to the Queue](../../images/mac/add-titles-to-queue-1.0.0.png "Select the Titles you wish to encode from the Add Titles to Queue dialog.")
<!-- /.system-mac -->
<!-- .system-win -->
On Windows, select `All Selection to Queue` from the `Queue` menu to add all `Titles`.
<!-- /.system-win -->
You may open additional `Sources` and add them to the `Queue` in the same manner.
## Editing Jobs
To make changes to `Jobs` in the `Queue`, first open the `Queue` window by selecting the `Show Queue` button on the toolbar.
<!-- .system-mac -->
![Opening the Queue window](../../images/mac/queue-button-1.0.0.png "Select the Show Queue button on the toolbar to open the Queue window.")
<!-- /.system-mac -->
<!-- .system-win -->
![HandBrake toolbar on Windows](../../images/windows/toolbar-1.0.0.png "Select the Show Queue button on the toolbar to open the Queue window.")
<!-- /.system-win -->
To remove a `Job`, select the `╳` button next to the unwanted `Job`.
<!-- .system-lin -->
On Linux, if you want to make changes to a `Job` already in the `Queue`, select the `Job` and then select `Edit`. Editing a `Job` opens the `Source` in HandBrake's main window and removes the `Job` from the `Queue`.
<!-- /.system-lin -->
<!-- .system-mac -->
On Mac, if you want to make changes to a `Job` already in the `Queue`, control- or right-click on the `Job` and select `Edit`. Editing a `Job` opens the `Source` in HandBrake's main window and removes the `Job` from the `Queue`.
![Editing an encode Job on Mac](../../images/mac/queue-edit-1.0.0.png "Control- or right-click the Job and select Edit to make changes.")
<!-- /.system-mac -->
<!-- .system-win -->
On Windows, if you want to make changes to a `Job` already in the `Queue`, select the edit button next to the `Job`. Editing a `Job` opens the `Source` in HandBrake's main window and removes the `Job` from the `Queue`.
![Editing an encode Job on Windows](../../images/windows/queue-1.0.0.png "Select the edit button, which looks like a sheet of paper, to make changes to a Job.")
<!-- /.system-win -->
When you're finished making changes, again add the encode to the `Queue` by selecting the `Add to Queue` button on the toolbar.
<!-- .system-mac -->
![Adding an encode to the Queue](../../images/mac/add-to-queue-button-1.0.0.png "Select the Add to Queue button on the toolbar to add your encode to the queue.")
<!-- /.system-mac -->
<!-- .system-win -->
![HandBrake toolbar on Windows](../../images/windows/toolbar-1.0.0.png "Select the Add to Queue button on the toolbar to add your encode to the queue.")
<!-- /.system-win -->
## Starting the Queue
When ready, select the `Start` button on the`Queue` window or the `Start Queue` button on the main window to begin encoding the `Jobs` in the `Queue`.
<!-- .system-mac -->
![Starting the Queue](../../images/mac/start-queue-button-1.0.0.png "The Start Queue button begins encoding the Jobs in the Queue.")
<!-- /.system-mac -->
[^batch-scan-subdirectories]: When opening multiple videos in a folder, HandBrake ignores any additional folders inside. Make sure the videos you wish to open are at the top level of the selected folder.

65
source/docs/en/1.0.0/advanced/resizing-video.markdown Normal file
View File

@ -0,0 +1,65 @@
---
Type: article
State: draft
Title: Resizing Video
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Scott (s55) ]
Copyright: 2016 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
---
Resizing Video
=============================
## Picture Settings
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.
### 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.
## Upscaling
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 idea. 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.
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 your using has a problematic or broken scaler.
## Cropping
HandBrake by default will try and detect and crop black bars from the video. Encoding black bars increases the encode time and the amount of disk space required, so it's best to let HandBrake remove them.
HandBrakes auto-crop is not perfect. It's giving you a best guess at what the crop values should be. If you find it gets it wrong, which is not that common, you can adjust them by selecting the "Custom" option.
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")
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.
![Preview window](../../images/windows/preview-window-1.0.0.jpg "Preview window")

20
source/docs/en/1.0.0/advanced/subtitle-defaults.markdown Normal file
View File

@ -0,0 +1,20 @@
---
Type: article
State: draft
Title: Subtitle Defaults
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: []
Copyright: 2016 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
---
Subtitle Defaults
=============================
Todo

82
source/docs/en/1.0.0/advanced/subtitles.markdown Normal file
View File

@ -0,0 +1,82 @@
---
Type: article
State: draft
Title: Subtitles
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: []
Copyright: 2016 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
---
Subtitles
=========
## Supported Subtitle Formats
There are different types of subtitles that exist:
- Bitmaps (Pictures), e.g. DVD VOBSUBs, Bluray PGS
- Text with markup, e.g. Closed Captions and SRT files.
- Styled SSA, e.g. most anime subtitles in MKV files
HandBrake can read subtitles from the following sources:
- From DVD’s – Either embedded VOBSUB or CC tracks.
- From Bluray - PGS Subtitles.
- User supplied SRT files.
- Embedded SSA/SRT/CC within files (such as mkv or mp4)
## Supported Output Formats
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.
The following subtitle types as supported as follows:
- Bluray PGS Subtitles
- With MP4, you can burn ONLY 1 subtitle track into the video.
- You can not pass-through PGS into MP4 as this file format does not support it.
- With MKV, you can pass-through multiple PGS tracks. These are not burned into the video unless you choose to do so however you can only burn 1 subtitle track into the file. The rest must be passed through.
- DVD Bitmap Subtitles (VOBSUB)
- With MP4, you can burn ONLY 1 subtitle track into the video.
- With MKV, you can pass-through multiple VOBSUB tracks. These are not burned into the video unless you choose to do so however you can only burn 1 subtitle track into the file. The rest must be passed through.
- CEA-608 Closed Captions (DVD and some ATSC streams)
- When selected, these will be passed through from your source file to the MKV or MP4 output file.
- Only 1 CC track can be read from the source.
- CC tracks within an MP4 appear as a subtitle track, not a CC track.
- SRT subtitle import – You can import SRT files into HandBrake through the “Subtitles tab”.
- You can import multiple SRT subtitle tracks.
- You can set an offset (measured in milliseconds) to change the start time that the first and subsequent SRT subtitles will appear. Use trial and error encoding a single chapter to obtain the correct offset.
- You should make sure the correct character code is selected from the “Char Code” dropdown. Selecting the wrong code, will result in your output file having no subtitle track, and can cause the player to crash when playing that track.
- SRT Passthru
- SRT Subtitles can also be passed through from input video files.
- SRT are converted to SSA for the output.
- SSA Subtitles
- SSA Subtitles can be passed-thru or burned into the video.
- When burned into the video, all styling (e.g. fonts, colors, etc) is preserved.
- Animated effects (e.g. fade in/out, karaoke) are not currently supported. (Only the middle frame of the animation will be used.)
- When passed-thru as text, only bold/italic/underline styles are preserved. Some players may not support the simultaneous display of multiple passed-thru SSA subtitles.
## Forced Subtitles
With some DVD sources, there is a subtitle track which only displays during foreign language sections of the video. On some titles this is a unique subtitle track in the same language as the main audio track, on others it uses the standard subtitle track in the same language as the main audio track except marks a subset of the subtitles as forced.
In order to select this track, HandBrake can scan the source for subtitles that appear only 10% (or less) of the time in addition to scanning for the presence of any forced subtitles.
To enable this functionality within the HandBrake user interface, from the “Subtitles” tab select the “Foreign Audio Search (Bitmap)” option from the “Track” dropdown menu and click the “Forced” Checkbox.
If you do not get a foreign section only subtitle track in your output file, then you may have to manually find and select the correct subtitle track from the “Track” dropdown menu.

56
source/docs/en/1.0.0/advanced/surround-sound.markdown Normal file
View File

@ -0,0 +1,56 @@
---
Type: article
State: draft
Title: Surround Sound Guide
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Scott (s55) ]
Copyright: 2016 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
---
Surround Sound Guide
=============================
There are many different formats for multi-channel audio which your source may have:
- Dolby Pro Logic
- Dolby Digital Surround
- Digital Theater System (DTS)
- Digital Theater System Master Audio (DTS-HD)
- TrueHD
HandBrake can take these and either pass them through to your source or convert them to another format with a downmix.
## Downmixing
When you are not using a passthru in the codec selection, you can choose the downmix from the "Mixdown" dropdown.
The options you have will depend on what the source track is and how many channels it has.
- Dolby Surround
- Dobly ProLogic II
- 5.1 Surround
- 6.1 Surround
- 7.1 Surround
By default HandBrake will downmix your audio to Dolby ProLogic II which sounds good on both stereo and multi-channel audio systems alike. However, if you want the true experience you can choose the appropriate channel count surround option from the "Mixdown" dropdown.
## Audio passthru
HandBrake also supports passing through the source audio track, bit-for-bit without altering it.
The following source format's can be passed thru.
- AC3
- E-AC3
- DTS (Limited player compatibility in MP4)
- DTS-HD (Limited player compatibility in MP4)
- TrueHD (MKV files only)
- FLAC (MKV files only)
- AAC
- MP3

21
source/docs/en/1.0.0/advanced/video-sources.markdown Normal file
View File

@ -0,0 +1,21 @@
---
Type: article
State: draft
Title: Video Sources
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: []
Copyright: 2016 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

25
source/docs/en/1.0.0/advanced/web-optimised.markdown Normal file
View File

@ -0,0 +1,25 @@
---
Type: article
State: draft
Title: Web Optimised
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Scott (s55) ]
Copyright: 2016 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
---
Web Optimised
=============================
![Web Optimised Checkbox](../../images/windows/web-optimised-1.0.0.png "Web Optimised Checkbox")
If you are encoding for the web and using the MP4 file format, you'll want to turn on "Web Optimised" checkbox.
This places the MP4 container header at the start of the file, optimizing it for streaming across the web.
This is often referred to as MP4 "Fast Start".

551
source/docs/en/1.0.0/cli/cli-guide.markdown Normal file
View File

@ -0,0 +1,551 @@
---
Type: article
State: draft
Title: CLI Guide
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Scott (s55) ]
Copyright: 2016 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
---
CLI Guide
=============================
The following details all the available options in HandBrakeCLI
You can access this information at any time by running the following command:
> HandBrakeCLI --help
### The HandBrakeCLI Help Output
Usage: HandBrakeCLI [options] -i <source> -o <destination>
General Options --------------------------------------------------------------
-h, --help Print help
--version Print version
-v, --verbose[=number] Be verbose (optional argument: logging level)
-Z. --preset <string> Select preset by name (case-sensitive)
Enclose names containing spaces in double quotation
marks (e.g. "Preset Name")
-z, --preset-list List available presets
--preset-import-file <filespec>
Import presets from a json preset file.
'filespec' may be a list of files separated
by spaces, or it may use shell wildcards.
--preset-import-gui Import presets from GUI config preset file.
--preset-export <string>
Create a new preset from command line options and
write a json representation of the preset to the
console or a file if '--preset-export-file' is
specified. The required argument will be the name
of the new preset.
--preset-export-file <filename>
Write new preset generated by '--preset-export'
to file 'filename'.
--preset-export-description <string>
Add a description to the new preset created with
'--preset-export'
--queue-import-file <filename>
Import an encode queue file created by the GUI
--no-dvdnav Do not use dvdnav for reading DVDs
--no-opencl Disable use of OpenCL
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)
--min-duration Set the minimum title duration (in seconds).
Shorter titles will be ignored (default: 10).
--scan Scan selected title only.
--main-feature Detect and select the main feature title.
-c, --chapters <string> Select chapters (e.g. "1-3" for chapters
1 to 3 or "3" for chapter 3 only,
default: all chapters)
--angle <number> Select the video angle (DVD or Blu-ray only)
--previews <number:boolean>
Select how many preview images are generated,
and whether to store to disk (0 or 1).
(default: 10:0)
--start-at-preview <number>
Start encoding at a given preview.
--start-at <string:number>
Start encoding at a given duration (in seconds),
frame, or pts (on a 90kHz clock)
(e.g. duration:10, frame:300, pts:900000)
--stop-at <string:number>
Stop encoding at a given duration (in seconds),
frame, or pts (on a 90kHz clock)
(e.g. duration:10, frame:300, pts:900000)
Destination Options ----------------------------------------------------------
-o, --output <filename> Set destination file name
-f, --format <string> Select container format:
av_mp4
av_mkv
default: auto-detected from destination file name)
-m, --markers Add chapter markers
--no-markers Disable preset chapter markers
-O, --optimize Optimize MP4 files for HTTP streaming (fast start,
s.s. rewrite file to place MOOV atom at beginning)
--no-optimize Disable preset 'optimize'
-I, --ipod-atom Add iPod 5G compatibility atom to MP4 container
--no-ipod-atom Disable iPod 5G atom
-P, --use-opencl Use OpenCL where applicable
Video Options ----------------------------------------------------------------
-e, --encoder <string> Select video encoder:
x264
x265
mpeg4
mpeg2
VP8
VP9
theora
--encoder-preset <string>
Adjust video encoding settings for a particular
speed/efficiency tradeoff (encoder-specific)
--encoder-preset-list <string>
List supported --encoder-preset values for the
specified video encoder
--encoder-tune <string>
Adjust video encoding settings for a particular
type of souce or situation (encoder-specific)
--encoder-tune-list <string>
List supported --encoder-tune values for the
specified video encoder
-x, --encopts <string> Specify advanced encoding options in the same
style as mencoder (all encoders except theora):
option1=value1:option2=value2
--encoder-profile <string>
Ensure compliance with the requested codec
profile (encoder-specific)
--encoder-profile-list <string>
List supported --encoder-profile values for the
specified video encoder
--encoder-level <string>
Ensures compliance with the requested codec
level (encoder-specific)
--encoder-level-list <string>
List supported --encoder-level values for the
specified video encoder
-q, --quality <float> Set video quality (e.g. 22.0)
-b, --vb <number> Set video bitrate in kbit/s (default: 1000)
-2, --two-pass Use two-pass mode
--no-two-pass Disable two-pass mode
-T, --turbo When using 2-pass use "turbo" options on the
first pass to improve speed
(works with x264 and x265)
--no-turbo Disable 2-pass mode's "turbo" first pass
-r, --rate <float> Set video framerate
(5/10/12/15/20/23.976/24/25/29.97/
30/48/50/59.94/60/72/75/90/100/120
or a number between 1 and 1000).
Be aware that not specifying a framerate lets
HandBrake preserve a source's time stamps,
potentially creating variable framerate video
--vfr, --cfr, --pfr Select variable, constant or peak-limited
frame rate control. VFR preserves the source
timing. CFR makes the output constant rate at
the rate given by the -r flag (or the source's
average rate if no -r is given). PFR doesn't
allow the rate to go over the rate specified
with the -r flag but won't change the source
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>
Specifiy a comma separated list of audio
languages you would like to select from the
source title. By default, the first audio
matching each language will be added to your
output. Provide the language's ISO 639-2 code
(e.g. fre, eng, spa, dut, et cetera)
Use code 'und' (Unknown) to match all languages.
--all-audio Select all audio tracks matching languages in
the specified language list (--audio-lang-list).
Any language if list is not specified.
--first-audio Select first audio track matching languages in
the specified language list (--audio-lang-list).
Any language if list is not specified.
-a, --audio <string> Select audio track(s), separated by commas
("none" for no audio, "1,2,3" for multiple
tracks, default: first one).
Multiple output tracks can be used for one input.
-E, --aencoder <string> Select audio encoder(s):
av_aac
copy:aac
ac3
copy:ac3
eac3
copy:eac3
copy:truehd
copy:dts
copy:dtshd
mp3
copy:mp3
vorbis
flac16
flac24
copy:flac
opus
copy
"copy:<type>" will pass through the corresponding
audio track without modification, if pass through
is supported for the audio type.
Separate tracks by commas.
Defaults:
av_mp4 av_aac
av_mkv mp3
--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)
Separated by commas for multiple allowed options.
--audio-fallback <string>
Set audio codec to use when it is not possible
to copy an audio track without re-encoding.
-B, --ab <number> Set audio track bitrate(s) in kbit/s.
(default: determined by the selected codec, mixdown,
and samplerate combination).
Separate tracks by commas.
-Q, --aq <float> Set audio quality metric.
Separate tracks by commas.
-C, --ac <float> Set audio compression metric.
(available depending on selected codec)
Separate tracks by commas.
-6, --mixdown <string> Format(s) for audio downmixing/upmixing:
mono
left_only
right_only
stereo
dpl1
dpl2
5point1
6point1
7point1
5_2_lfe
Separate tracks by commas.
Defaults:
av_aac up to dpl2
ac3 up to 5point1
eac3 up to 5point1
mp3 up to dpl2
vorbis up to dpl2
flac16 up to 7point1
flac24 up to 7point1
opus up to 7point1
--normalize-mix Normalize audio mix levels to prevent clipping.
<string> Separate tracks by commas.
0 = Disable Normalization (default)
1 = Enable Normalization
-R, --arate Set audio samplerate(s)
(8/11.025/12/16/22.05/24/32/44.1/48 kHz)
Separate tracks by commas.
-D, --drc <float> Apply extra dynamic range compression to the
audio, making soft sounds louder. Range is 1.0
to 4.0 (too loud), with 1.5 - 2.5 being a useful
range.
Separate tracks by commas.
--gain <float> Amplify or attenuate audio before encoding. Does
NOT work with audio passthru (copy). Values are
in dB. Negative values attenuate, positive
values amplify. A 1 dB difference is barely
audible.
--adither <string> Select dithering to apply before encoding audio:
auto (default)
none
rectangular
triangular
triangular_hp
triangular_ns
Separate tracks by commas.
Supported by encoder(s):
flac16
-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>
Set picture cropping in pixels
(default: automatically remove black bars)
--loose-crop Always crop to a multiple of the modulus
--no-loose-crop Disable preset 'loose-crop'
-Y, --maxHeight <number>
Set maximum height in pixels
-X, --maxWidth <number>
Set maximum width in pixels
--non-anamorphic Set pixel aspect ratio to 1:1
--strict-anamorphic Store pixel aspect ratio in video stream
--loose-anamorphic Store pixel aspect ratio with specified display width
--custom-anamorphic Store pixel aspect ratio in video stream and
directly control all parameters.
--display-width <number>
Set display width in pixels, for custom anamorphic.
This determines the display aspect during playback,
which may differ from the storage aspect.
--keep-display-aspect Preserve the source's display aspect ratio
when using custom anamorphic
--no-keep-display-aspect
Disable preset 'keep-display-aspect'
--pixel-aspect <par_x:par_y>
Set pixel aspect for custom anamorphic
(--display-width and --pixel-aspect are mutually
exclusive.
--itu-par Use wider ITU pixel aspect values for loose and
custom anamorphic, useful with underscanned sources
--no-itu-par Disable preset 'itu-par'
--modulus <number> Set storage width and height modulus
Dimensions will be made divisible by this number.
Does not affect strict anamorphic mode (always mod 2)
(default: set by preset, typically 2)
-M, --color-matrix <string>
Set the color space signaled by the output:
709
601
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
frame count to the activity log.
If accompanied by the decomb or deinterlace
filters, it causes these filters to selectively
deinterlace only those frames where interlacing
is detected.
Presets:
permissive
fast
Custom Format:
mode=m:spatial-metric=s:motion-thresh=m:
spatial-thresh=s:filter-mode=f:block-thresh=b:
block-width=b:block-height=b:disable=d
Default:
mode=3:spatial-metric=2:motion-thresh=1:
spatial-thresh=1:filter-mode=2:block-thresh=40:
block-width=16:block-height=16
--no-comb-detect Disable preset comb-detect filter
-d, --deinterlace[=string]
Deinterlace video using libav yadif.
Presets:
skip-spatial
bob
Custom Format:
mode=m:parity=p
Default:
mode=3
--no-deinterlace Disable preset deinterlace filter
-5, --decomb[=string] Deinterlace video using a combination of yadif,
blend, cubic, or EEDI2 interpolation.
Presets:
bob
eedi2
eedi2bob
Custom Format:
mode=m:magnitude-thresh=m:variance-thresh=v:
laplacian-thresh=l:dilation-thresh=d:
erosion-thresh=e:noise-thresh=n:
search-distance=s:postproc=p:parity=p
Default:
mode=7
--no-decomb Disable preset decomb filter
-9, --detelecine[=string]
Detelecine (ivtc) video with pullup filter
Note: this filter drops duplicate frames to
restore the pre-telecine framerate, unless you
specify a constant framerate
(--rate 29.97 --cfr)
Custom Format:
skip-left=s:skip-right=s:skip-top=s:
skip-bottom=s:strict-breaks=s:plane=p:parity=p:
disable=d
Default:
skip-left=1:skip-right=1:skip-top=4:
skip-bottom=4:plane=0
--no-detelecine Disable preset detelecine filter
-8, --hqdn3d[=string] Denoise video with hqdn3d filter
Presets:
ultralight
light
medium
strong
Custom Format:
y-spatial=y:cb-spatial=c:cr-spatial=c:
y-temporal=y:cb-temporal=c:cr-temporal=c
Default:
y-spatial=3:cb-spatial=2:cr-spatial=2:
y-temporal=2:cb-temporal=3:cr-temporal=3
--no-hqdn3d Disable preset hqdn3d filter
--denoise[=string] Legacy alias for '--hqdn3d'
--nlmeans[=string] Denoise video with NLMeans filter
Presets:
ultralight
light
medium
strong
Custom Format:
y-strength=y:y-origin-tune=y:y-patch-size=y:
y-range=y:y-frame-count=y:y-prefilter=y:
cb-strength=c:cb-origin-tune=c:cb-patch-size=c:
cb-range=c:cb-frame-count=c:cb-prefilter=c:
cr-strength=c:cr-origin-tune=c:cr-patch-size=c:
cr-range=c:cr-frame-count=c:cr-prefilter=c
Default:
y-strength=6:y-origin-tune=1:y-patch-size=7:
y-range=3:y-frame-count=2:y-prefilter=0:
cb-strength=6:cb-origin-tune=1:cb-patch-size=7:
cb-range=3:cb-frame-count=2:cb-prefilter=0
--no-nlmeans Disable preset NLMeans filter
--nlmeans-tune <string> Tune NLMeans filter to content type
Tunes:
none
film
grain
highmotion
animation
tape
sprite
Applies to NLMeans presets only (does not affect
custom settings)
-7, --deblock[=string] Deblock video with pp7 filter
Custom Format:
qp=q:mode=m:disable=d
Default:
qp=5
--no-deblock Disable preset deblock filter
--rotate[=string] Rotate image or flip its axes.
angle rotates clockwise, can be one of:
0, 90, 180, 270
hflip=1 flips the image on the x axis (horizontally).
Custom Format:
angle=a:hflip=h:disable=d
Default:
angle=180:hflip=0
--pad <string> Pad image with borders (e.g. letterbox).
The padding color may be set (default black).
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
-g, --grayscale Grayscale encoding
--no-grayscale Disable preset 'grayscale'
Subtitles Options ------------------------------------------------------------
--subtitle-lang-list <string>
Specifiy a comma separated list of subtitle
languages you would like to select from the
source title. By default, the first subtitle
matching each language will be added to your
output. Provide the language's ISO 639-2 code
(e.g. fre, eng, spa, dut, et cetera)
--all-subtitles Select all subtitle tracks matching languages in
the specified language list
(--subtitle-lang-list).
Any language if list is not specified.
--first-subtitle Select first subtitle track matching languages in
the specified language list
(--subtitle-lang-list).
Any language if list is not specified.
-s, --subtitle <string> Select subtitle track(s), separated by commas
More than one output track can be used for one
input. "none" for no subtitles.
Example: "1,2,3" for multiple tracks.
A special track name "scan" adds an extra first
pass. This extra pass scans subtitles matching
the language of the first audio or the language
selected by --native-language.
The one that's only used 10 percent of the time
or less is selected. This should locate subtitles
for short foreign language segments. Best used in
conjunction with --subtitle-forced.
-F, --subtitle-forced[=string]
Only display subtitles from the selected stream
if the subtitle has the forced flag set. The
values in 'string' are indexes into the
subtitle list specified with '--subtitle'.
Separate tracks by commas.
Example: "1,2,3" for multiple tracks.
If "string" is omitted, the first track is
forced.
--subtitle-burned[=number]
"Burn" the selected subtitle into the video
track. If "subtitle" is omitted, the first
track is burned. "subtitle" is an index into
the subtitle list specified with '--subtitle'
or "native" to burn the subtitle track that may
be added by the 'native-language' option.
--subtitle-default[=number]
Flag the selected subtitle as the default
subtitle to be displayed upon playback. Setting
no default means no subtitle will be displayed
automatically. 'number' is an index into the
subtitle list specified with '--subtitle'.
-N, --native-language <string>
Specifiy your language preference. When the first
audio track does not match your native language
then select the first subtitle that does. When
used in conjunction with --native-dub the audio
track is changed in preference to subtitles.
Provide the language's ISO 639-2 code
(e.g. fre, eng, spa, dut, et cetera)
--native-dub Used in conjunction with --native-language
requests that if no audio tracks are selected the
default selected audio track will be the first
one that matches the --native-language. If there
are no matching audio tracks then the first
matching subtitle track is used instead.
--srt-file <string> SubRip SRT filename(s), separated by commas.
--srt-codeset <string>
Character codeset(s) that the SRT file(s) are
encoded as, separated by commas.
If not specified, 'latin1' is assumed.
Command 'iconv -l' provides a list of valid codesets.
--srt-offset <string> Offset (in milliseconds) to apply to the SRT
file(s), separated by commas. If not specified,
zero is assumed. Offsets may be negative.
--srt-lang <string> SRT 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.
--srt-default[=number]
Flag the selected SRT 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 SRT is the default.
'number' is a 1-based index into the 'srt-file' list
--srt-burn[=number] "Burn" the selected SRT subtitle into
the video track.
If 'number' is omitted, the first SRT is burned.
'number' is a 1-based index into the 'srt-file' list

74
source/docs/en/1.0.0/cli/cli-options.markdown Normal file
View File

@ -0,0 +1,74 @@
---
Type: article
State: draft
Title: CLI Options
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Scott (s55) ]
Copyright: 2016 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
---
CLI Options
=============================
## Quick Tutorial on the Command Line.
On Windows, you'll want to open the "Command Prompt" app. This is similar to the "Terminal" app on Mac and Linux although the command's to navigate vary a bit.
This guide is not going to go into a lot of detail on using your systems command line as there are differences on various different platforms. Instead it will offer some hints.
We suggest you Google for a tutorial for your given command line of choice.
### Useful Commands
| Command | Platform | Action |
|------------------|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|
| dir | Windows | List the contents of the current directory |
| ls | Mac and Linux | Lists the contents of the current directory |
| cd <folder_name> | Both | Change to the given folder. |
| cd .. | Both | Go up a directory |
| pwd | Mac and Linux | Unlike Windows, the terminal does not show you the full path to your current directory. This command will show you were you are on the file system. |
When you extract HandBrakeCLI, you will need to navigate to where you extracted it on the file system, before trying to execute. You can do so with the above commands.
Typically, a command prompt / terminal will start in your home directory. So, if you download HandBrake and have a source ready, you'd run the following commands:
cd Downloads
HandBrakeCLI -i /path/to/source -o ../Desktop/my_output.mp4
If HandBrake is in a different directory than your in, you can always access it via the full path. i.en
./path/to/HandBrakeCLI -i /path/to/source -o ../Desktop/my_output.mp4
Remember, Linux and Mac can be configured to be case sensitive.
## HandBrake Command Line Basics
First, simple input and output.
> HandBrakeCLI -i source -o destination
That will encode with default "Normal" Preset.
Easy, right? So now you can start customizing those settings. You can pile on all sorts of things, and end up with a monster like:
> HandBrakeCLI -i /Volumes/MyBook/BLURAY_DISC -o /Volumes/MyBook/Bluray.mkv -m -E copy --audio-copy-mask ac3,dts,dtshd --audio-fallback ffac3 -e x264 -q 20 -x level=4.1:ref=4:b-adapt=2:direct=auto:me=umh:subq=8:rc-lookahead=50:psy-rd=1.0,0.15:deblock=-1,-1:vbv-bufsize=30000:vbv-maxrate=40000:slices=4
For now, think about less complex stuff:
> HandBrakeCLI -i VIDEO_TS -o movie.mp4 -e x264 -q 20 -B 160
That will encode a source video located at the path VIDEO_TS to an output file called movie.mp4. It will use x264 with a CRF (Constant Quality) of 20 to encode the video, and encode the audio as 160 Kbps AAC.
If you want to see the full list of available commands, try the following command:
> HandBrakeCLI --help
This will display every command with a brief explanation of what it does and a sample of relevant options you can pass to it.

44
source/docs/en/1.0.0/developer/build-linux.markdown Normal file
View File

@ -0,0 +1,44 @@
---
Type: article
Title: Building HandBrake for Linux
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS) ]
Copyright: 2016 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
---
Building HandBrake for Linux
============================
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](../get-handbrake/where-to-get-handbrake.html) for more information.
## Installing dependencies
Dependency installation instructions are available for the following distributions.
- [CentOS](install-dependencies-centos.html)
- [Fedora](install-dependencies-fedora.html)
- [Gentoo](install-dependencies-gentoo.html)
- [Ubuntu](install-dependencies-ubuntu.html)
## Building HandBrake
Clone the HandBrake repository.
git clone https://github.com/HandBrake/HandBrake.git && cd HandBrake
Build HandBrake. To build the command line interface only, disable the graphical interface by appending `--disable-gtk`.
./configure --launch-jobs=$(nproc) --launch
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.
cd build && sudo make install

53
source/docs/en/1.0.0/developer/build-mac.markdown Normal file
View File

@ -0,0 +1,53 @@
---
Type: article
Title: Building HandBrake for Mac
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS), Scott (s55) ]
Copyright: 2016 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
---
Building HandBrake for Mac
==========================
Building HandBrake for Mac requires an Apple computer with a 64-bit Intel processor running OS X 10.10.5 Yosemite or later, and the following dependencies.
- [Xcode](https://developer.apple.com/xcode/) 7.2.1 or later
- free Apple Developer registration required, or install from the Mac App Store
- [Command Line Tools for Xcode](https://developer.apple.com/download/more/) (optional)
- free Apple Developer registration required, or install using `xcode-select --install`
Additional dependencies (may be built via included script):
- autoconf
- automake
- cmake (3.3.2 or later recommended)
- libtool
- pkg-config
- yasm 1.2.0 or later (1.3.0 or later recommended)
Install Xcode and open it once. You may quit Xcode after it has finished loading.
Clone the HandBrake repository.
git clone https://github.com/HandBrake/HandBrake.git && cd HandBrake
You may build and install the additional dependencies using the included script. Feel free to choose a different output path, if desired.
scripts/mac-toolchain-build /usr/local
This process will take a few minutes. If necessary, the script will provide you with instructions for adding the resulting binaries location to your environment's `PATH`[^default-path]. Do this now.
Build HandBrake.
./configure --launch-jobs=$(sysctl -n hw.ncpu) --launch
When complete, you will find `HandBrake.app` and `HandBrakeCLI` in the `build/xroot` directory.
[^default-path]: `/usr/local/bin` is included in the system's `PATH` by default. It is not necessary to add it to your environment's `PATH` when installing the additional dependencies to `/usr/local`.

76
source/docs/en/1.0.0/developer/build-windows.markdown Normal file
View File

@ -0,0 +1,76 @@
---
Type: article
Title: Building HandBrake for Windows
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS), Scott (s55) ]
Copyright: 2016 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
---
Building HandBrake for Windows
==============================
## Command line interface and LibHB
Building the HandBrake [CLI](abbr:Command Line Interface) and LibHB (`hb.dll`) for Windows requires Linux and a recent [MinGW-w64](https://mingw-w64.org/) toolchain. Ubuntu 16.04 LTS or later is recommended; other distros may work as well. In all cases, we recommend you build the MinGW-w64 toolchain using our instructions and the included script, as most packaged versions have issues that can produce non-functioning builds.
The following instructions are for Ubuntu 16.04 LTS.
Dependencies:
- cmake
- curl
- gcc
- git
- libtool
- m4
- make
- patch
- python
- tar
- wget
- yasm
Install all dependencies.
sudo apt-get install cmake curl gcc git intltool libtool m4 make patch python tar wget yasm
Clone the HandBrake repository.
git clone https://github.com/HandBrake/HandBrake.git && cd HandBrake
Build the MinGW-w64 toolchain using the included script, where `username` is your user name. Feel free to choose a different output path, if desired.
scripts/mingw-w64-build x86_64 /home/username/toolchains/
This process will take a few minutes, then provide you with instructions for adding the resulting binaries location to your environment's `PATH`. Do this now.
Build HandBrake.
./configure --cross=x86_64-w64-mingw32 --enable-x265 --enable-qsv --launch-jobs=$(nproc) --launch
When complete, you will find `HandBrakeCLI.exe` in the `build` directory and `hb.dll` in `build/libhb`.
## Graphical interface
The following tools are required to build and run the [GUI](abbr:Graphical User Interface).
- [Microsoft Visual Studio Community Edition](https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx)
- [Source Tree](https://www.sourcetreeapp.com) git client (optional)
- Visual Studio 2015 has built-in git support, if you prefer it
- `hb.dll` (see the LibHB build instructions preceding these, or download from [https://handbrake.fr/nightly.php](https://handbrake.fr/nightly.php))
Clone `https://github.com/HandBrake/HandBrake.git` using your git client.
Source code for the GUI resides in the `win\CS` folder and the solution file is named `HandBrake.sln`. Make sure HandBrakeWPF is set as the startup project in the Solution Explorer by right-clicking the name and selecting "Set as startup project".
To build the GUI, select Build Solution from the Build menu.
When complete, locate the output folder where `HandBrake.exe` is created (typically in `win\CS\HandBrakeWPF\bin\...`, depending on the selected build profile). Copy `hb.dll` to this folder. This completes the build process.

67
source/docs/en/1.0.0/developer/flatpak-repo.markdown Normal file
View File

@ -0,0 +1,67 @@
---
Type: article
State: draft
Title: Maintaining a HandBrake flatpak repository
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ John (j45) ]
Copyright: 2016 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
---
Maintaining a HandBrake flatpak repository
==========================================
## Creating a new empty flatpak repository
This would be done once to set up the repo users update their HandBrake
flatpaks from. This repo gets served via http to users.
Initialize a new repository
ostree init --mode=archive-z2 --repo=<repo-dir>
Add the new repository to your flatpak remotes
flatpak --user remote-add --gpg-import=<pub-gpg-key> <repo-name> <repo-dir>
## Create a new HandBrake flatpak bundle
This may be done on a different machine than the repo.
From the HandBrake source tree, update build versions by running configure
./configure --prefix=/app --flatpak
Build flatpaks for GUI and CLI.
Results will be in build/pkg/flatpak/
cd build
make pkg.create.flatpak
## Importing flatpak bundles into the repository
For each build, a GUI and CLI flatpak bundle is imported.
Import a bundle
flatpak build-import-bundle <repo-dir> <flatpak-bundle>
Update the flatpak repo index
flatpak build-update-repo --generate-static-deltas <repo-dir>
Regenerate and gpg-sign ostree summary
ostree summary --repo=<repo-dir> --gpg-sign=<key-id> -u
## Check repo and application
List contents of the repo
flatpak --user remote-ls <repo-name>
Install the application (if you wish to test it)
flatpak --user install <repo-name> <app-name>

123
source/docs/en/1.0.0/developer/install-dependencies-centos.markdown Normal file
View File

@ -0,0 +1,123 @@
---
Type: article
Title: Installing dependencies on CentOS
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS) ]
Copyright: 2016 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
---
Installing dependencies on CentOS
=================================
Instructions are available for installing dependencies on [CentOS](https://centos.org) 6 and 7.
## CentOS 7
The following instructions are for CentOS 7 x86_64 (HandBrake [CLI](abbr:Command Line Interface) only).
Dependencies:
- Development Tools
- Additional Development
- fribidi-devel
- jansson-devel
- libogg-devel
- libsamplerate-devel
- libtheora-devel
- libvorbis-devel
- opus-devel
Additional dependencies not available in the base repository:
- lame-devel [ZMREPO]
- libass-devel [EPEL]
- x264-devel [ZMREPO]
- yasm [EPEL]
Install dependencies.
sudo yum groupinstall "Development Tools" "Additional Development"
sudo yum install fribidi-devel jansson-devel libogg-devel libsamplerate-devel libtheora-devel libvorbis-devel opus-devel
Install the [EPEL](https://fedoraproject.org/wiki/EPEL) repository and related additional dependencies.
sudo yum install epel-release
sudo yum install libass-devel yasm
Install the [ZMREPO](https://zmrepo.zoneminder.com) repository and related additional dependencies.
sudo yum localinstall --nogpgcheck https://zmrepo.zoneminder.com/el/7/x86_64/zmrepo-7-7.el7.centos.noarch.rpm
sudo yum install lame-devel x264-devel
CentOS is now prepared to build the HandBrake [CLI](abbr:Command Line Interface). See [Building HandBrake for Linux](build-linux.html) for further instructions.
## CentOS 6
The following instructions are for CentOS 6 x86_64 (HandBrake [CLI](abbr:Command Line Interface) only).
Dependencies:
- Development tools
- Additional Development
- cmake
- libicu-devel
- libogg-devel
- libsamplerate-devel
- libtheora-devel
- libvorbis-devel
Additional dependencies not available in the base repository:
- fribidi-devel [EPEL]
- harfbuzz-devel [spec file]
- jansson-devel [EPEL]
- lame-devel [RPM Fusion]
- libass-devel [EPEL]
- opus-devel [EPEL]
- python27 [SCL]
- x264-devel [RPM Fusion]
- yasm [EPEL]
Install dependencies.
sudo yum groupinstall "Development tools" "Additional Development"
sudo yum install cmake libicu-devel libogg-devel libsamplerate-devel libtheora-devel libvorbis-devel
Install the [Software Collections (SCL)](https://wiki.centos.org/AdditionalResources/Repositories/SCL) repository and Python 2.7.x[^python-centos-6].
sudo yum install centos-release-scl
sudo yum install python27 python27-python-devel python27-python-setuptools python27-python-tools python27-python-virtualenv
Install the [EPEL](https://fedoraproject.org/wiki/EPEL) repository and related additional dependencies.
sudo yum install epel-release
sudo yum install fribidi-devel jansson-devel libass-devel opus-devel yasm
Install the [RPM Fusion](http://rpmfusion.org) Free repository and related additional dependencies.
sudo yum localinstall --nogpgcheck https://download1.rpmfusion.org/free/el/updates/6/x86_64/rpmfusion-free-release-6-1.noarch.rpm
sudo yum install lame-devel x264-devel
Download the HarfBuzz spec file from the CentOS 7 [rpms/harfbuzz](https://git.centos.org/summary/rpms!harfbuzz.git) git repository and remove the `graphite2-devel` dependency.
sudo mkdir -p /root/rpmbuild/SPECS
sudo curl -o /root/rpmbuild/SPECS/harfbuzz.spec 'https://git.centos.org/raw/rpms!harfbuzz.git/f5bd1f4920ed0fc56cd21547294f7c34deeb4e4f/SPECS!harfbuzz.spec'
sudo sed -i'' -e '/BuildRequires:[ ]*graphite2-devel/d' -e '/%configure/s/ --with-graphite2//' /root/rpmbuild/SPECS/harfbuzz.spec
Download, build, and install HarfBuzz (provides the `harfbuzz-devel` package).
sudo mkdir -p /root/rpmbuild/SOURCES
sudo curl -o /root/rpmbuild/SOURCES/harfbuzz-0.9.36.tar.bz2 'https://www.freedesktop.org/software/harfbuzz/release/harfbuzz-0.9.36.tar.bz2'
sudo rpmbuild -ba /root/rpmbuild/SPECS/harfbuzz.spec
sudo yum localinstall /root/rpmbuild/RPMS/x86_64/harfbuzz-*.rpm
CentOS is now prepared to build the HandBrake [CLI](abbr:Command Line Interface). See [Building HandBrake for Linux](build-linux.html) for further instructions.
[^python-centos-6]: Installing Python from CentOS [SCL](https://wiki.centos.org/AdditionalResources/Repositories/SCL) does not impact the default system Python; newer versions are installed alongside and in addition to the system version.

76
source/docs/en/1.0.0/developer/install-dependencies-fedora.markdown Normal file
View File

@ -0,0 +1,76 @@
---
Type: article
Title: Installing dependencies on Fedora
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS) ]
Copyright: 2016 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
---
Installing dependencies on Fedora
=================================
The following instructions are for [Fedora](https://getfedora.org) 20 and later.
Dependencies:
- Development Tools
- Development Libraries
- bzip2-devel
- cmake
- fontconfig-devel
- freetype-devel
- fribidi-devel
- gcc-c++
- git
- harfbuzz-devel
- jansson-devel
- lame-devel
- libass-devel
- libogg-devel
- libsamplerate-devel
- libtheora-devel
- libtool
- libvorbis-devel
- libxml2-devel
- m4
- make
- opus-devel
- patch
- python
- tar
- x264-devel
- yasm
- zlib-devel
Graphical interface dependencies:
- X Software Development
- GNOME Software Development
- dbus-glib-devel
- gstreamer1-devel
- gstreamer1-plugins-base-devel
- intltool
- libgudev1-devel
- libnotify-devel
- webkitgtk3-devel
Install dependencies.
sudo yum groupinstall "Development Tools" "Development Libraries"
sudo yum install bzip2-devel cmake fontconfig-devel freetype-devel fribidi-devel gcc-c++ git harfbuzz-devel jansson-devel lame-devel libass-devel libogg-devel libsamplerate-devel libtheora-devel libtool libvorbis-devel libxml2-devel m4 make opus-devel patch python tar x264-devel yasm zlib-devel
To build the GTK [GUI](abbr:Graphical User Interface), install the graphical interface dependencies.
sudo yum groupinstall "X Software Development" "GNOME Software Development"
sudo yum install dbus-glib-devel gstreamer1-devel gstreamer1-plugins-base-devel intltool libgudev1-devel libnotify-devel webkitgtk3-devel
Fedora is now prepared to build HandBrake. See [Building HandBrake for Linux](build-linux.html) for further instructions.
[^python-centos-6]: Installing Python from CentOS [SCL](https://wiki.centos.org/AdditionalResources/Repositories/SCL) does not impact the default system Python; newer versions are installed alongside and in addition to the system version.

41
source/docs/en/1.0.0/developer/install-dependencies-gentoo.markdown Normal file
View File

@ -0,0 +1,41 @@
---
Type: article
Title: Installing dependencies on Gentoo
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS) ]
Copyright: 2016 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
---
Installing dependencies on Gentoo
=================================
The following instructions are for [Gentoo](https://gentoo.org) Base System release 2.2 and [GNOME](https://www.gnome.org).
Dependencies[^rebuild]:
- fribidi
- harfbuzz
- jansson
- lame
- libass
- libogg
- libsamplerate
- libtheora
- libvorbis
- opus
- x264
Install dependencies.
sudo emerge --ask fribidi harfbuzz jansson lame libass libogg libsamplerate libtheora libvorbis opus x264
Gentoo is now prepared to build HandBrake. See [Building HandBrake for Linux](build-linux.html) for further instructions.
[^rebuild]: Previously installed dependencies may need to be rebuilt before building HandBrake.

82
source/docs/en/1.0.0/developer/install-dependencies-ubuntu.markdown Normal file
View File

@ -0,0 +1,82 @@
---
Type: article
Title: Installing dependencies on Ubuntu
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS) ]
Copyright: 2016 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
---
Installing dependencies on Ubuntu
=================================
The following instructions are for [Ubuntu](https://www.ubuntu.com) 16.04 LTS (Xenial Xerus) and Ubuntu 14.04 LTS (Trusty Tahr).
Dependencies:
- autoconf
- build-essential
- cmake
- git
- libass-dev
- libbz2-dev
- libfontconfig1-dev
- libfreetype6-dev
- libfribidi-dev
- libharfbuzz-dev
- libjansson-dev
- libmp3lame-dev
- libogg-dev
- libopus-dev
- libsamplerate-dev
- libtheora-dev
- libtool
- libvorbis-dev
- libx264-dev
- libxml2-dev
- m4
- make
- patch
- python
- tar
- yasm
- zlib1g-dev
Additional Ubuntu 16.04 LTS dependencies:
- libtool-bin
Graphical interface dependencies:
- intltool
- libappindicator-dev
- libdbus-glib-1-dev
- libglib2.0-dev
- libgstreamer1.0-dev
- libgstreamer-plugins-base1.0-dev
- libgtk-3-dev
- libgudev-1.0-dev
- libnotify-dev
- libwebkitgtk-3.0-dev
Install dependencies.
sudo apt-get install autoconf build-essential cmake git libass-dev libbz2-dev libfontconfig1-dev libfreetype6-dev libfribidi-dev libharfbuzz-dev libjansson-dev libmp3lame-dev libogg-dev libopus-dev libsamplerate-dev libtheora-dev libtool libvorbis-dev libx264-dev libxml2-dev m4 make patch python tar yasm zlib1g-dev
If you are running Ubuntu 16.04 LTS, install the additional dependencies.
sudo apt-get install libtool-bin
To build the GTK [GUI](abbr:Graphical User Interface), install the graphical interface dependencies.
sudo apt-get install intltool libappindicator-dev libdbus-glib-1-dev libglib2.0-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev libgtk-3-dev libgudev-1.0-dev libnotify-dev libwebkitgtk-3.0-dev
Ubuntu is now prepared to build HandBrake. See [Building HandBrake for Linux](build-linux.html) for further instructions.
[^python-centos-6]: Installing Python from CentOS [SCL](https://wiki.centos.org/AdditionalResources/Repositories/SCL) does not impact the default system Python; newer versions are installed alongside and in addition to the system version.

61
source/docs/en/1.0.0/get-handbrake/check-for-updates.markdown Normal file
View File

@ -0,0 +1,61 @@
---
Type: article
Title: Checking for updates
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS) ]
Copyright: 2016 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
---
Checking for updates
====================
HandBrake can let you know when a newer version is available, and even automatically download and install available updates.
Before updating, please make sure there are no pending encodes in the `Queue`. If you are currently using HandBrake older than version 1.0.0, also make note of any custom `Presets` you have created, as they may not be compatible with newer versions.
<!-- .system-lin -->
## 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.
<!-- /.system-lin -->
<!-- .system-mac -->
## Updating HandBrake on Mac
After you've installed and launched HandBrake more than once, it will ask whether you want to automatically check for updates. Select `Check Automatically` and HandBrake will offer to install future updates as they become available.
![Automatic updates dialog](../../images/mac/check-for-updates-automatically-1.0.0.png "Checking for updates automatically can help you stay up to date with the latest features and bug fixes.")
Automatic update checking may be enabled or disabled in HandBrake's preferences. Using the main menu at the top of your screen, select `HandBrake` and then `Preferences...`. You will find the option in the `General` section.
Manually checking for updates is easy. Using the main menu at the top of your screen, select `HandBrake` and then `Check for Updates...`. If an update is available, HandBrake will offer to install it for you.
![Software update dialog](../../images/mac/software-update-1.0.0.png "If an update is available, HandBrake will offer to install it for you.")
<!-- /.system-mac -->
<!-- .system-win -->
## Updating HandBrake on Windows
Automatic update checking may be enabled or disabled in HandBrake's preferences. From the `Tools` menu select `Preferences`. You will find the option in the `General` section. HandBrake will alert you when a new update is available.
Manually checking for updates is easy. From the `Help` menu, select `Check for Updates...`. If an update is available, HandBrake will offer to install it for you.
<!-- /.system-win -->
<!-- .continue -->
## Next steps
Continue to [Opening a video source](../workflow/open-video-source.html).
<!-- /.continue -->

137
source/docs/en/1.0.0/get-handbrake/download-and-install.markdown Normal file
View File

@ -0,0 +1,137 @@
---
Type: article
Title: Downloading and installing HandBrake
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS), Scott (s55) ]
Copyright: 2016 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
---
Downloading and installing HandBrake
====================================
HandBrake is available for Linux, Mac, and Windows, at the [HandBrake website](https://handbrake.fr/).
This is the *only* official download source for HandBrake. For more information, see [Where to get HandBrake](where-to-get-handbrake.html).
## Downloading
*Most modern computers can run HandBrake. To be sure your system meets the minimum requirements, see [System requirements](../technical/system-requirements.html) in the technical documentation.*
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].
<!-- .system-lin -->
## Installing on Linux
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.
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.
<!-- /.system-lin -->
<!-- .system-mac -->
## Installing on Mac
Once you've downloaded HandBrake for Mac, open the DMG file in your Downloads folder. Your web browser (e.g. Safari, Firefox, or Chrome) may do this for you automatically. Then drag the HandBrake application to your Applications folder.
![Installing HandBrake on Mac](../../images/mac/install-1.0.0.png "Drag HandBrake to your Applications folder to install it on your Mac.")
HandBrake is now installed. You may eject the disk image and move it to the Trash.
### Mac Gatekeeper
The first time you attempt to launch HandBrake, your Mac may present this message to you[^gatekeeper-disabled]:
![Mac Gatekeeper message](../../images/mac/gatekeeper-message-1.0.0.png "Gatekeeper may present this message when launching HandBrake for the first time.")
This message doesn't mean anything is wrong; rather, it indicates that HandBrake is not part of Apple's paid program to validate Mac applications. Select `OK` to dismiss the Gatekeeper message.
Hold down the `Control` key and select the HandBrake icon to bring up the shortcut menu. Select `Open` and your Mac will ask whether you are certain you wish to open HandBrake. Confirm that you want to trust HandBrake by again selecting `Open`.[^gatekeeper-instructions]
![Opening HandBrake using Finder's shortcut menu](../../images/mac/shortcut-menu-open-1.0.0.png "Launching HandBrake using the Open option in the Finder's shortcut menu will bypass the initial Gatekeeper message.")
![Gatekeeper message with Open option](../../images/mac/gatekeeper-message-quarantine-1.0.0.png "Gatekeeper may also present this message when launching HandBrake for the first time. Selecting Open will tell Gatekeeper to trust HandBrake.")
Now HandBrake is up and running. You should not have to repeat this process in the near future.
<!-- /.system-mac -->
<!-- .system-win -->
## Installing on Windows
Once you've downloaded the HandBrake installer, simply double click to run it.
If HandBrake is already installed on your computer, the installer will offer to remove the previous version before installing the current version. Select `OK` to proceed and review HandBrake's license terms.
![HandBrake Windows installer: removing previous versions](../../images/windows/uninstall-1.0.0.png "The HandBrake installer will offer to remove previous versions before installing the current version.")
![HandBrake Windows installer](../../images/windows/install-1-1.0.0.png "HandBrake's Windows installer.")
Next, the installer will ask you where you wish to install HandBrake. Unless you have a specific reason to change this, select `Install` to continue. Once the installation is complete, you may select `Finish` to exit the installer.
![HandBrake for Windows installation progress](../../images/windows/install-2-1.0.0.png "The installer will report its progress.")
![HandBrake for Windows installation complete](../../images/windows/install-finish-1.0.0.png "HandBrake is now installed.")
You will find shortcuts for launching HandBrake placed on both the Windows Desktop and Start Menu.
### Windows SmartScreen
When installing on Windows 8 or 10 with Windows SmartScreen enabled, you may see a message indicating that the HandBrake installer is not recognized by Windows.
![Windows SmartScreen](../../images/windows/smartscreen-1-1.0.0.png "Windows SmartScreen may present this message. Select More info to see more options.")
HandBrake is not "signed" by Microsoft. This message doesn't mean anything is wrong; rather, it indicates that HandBrake is not part of Microsoft's paid program to validate Windows applications.
By selecting `More info`, you will be able to select `Run anyway` to continue the installation.
![Windows SmartScreen - Run Anyway](../../images/windows/smartscreen-2-1.0.0.png "Select Run anyway to dismiss the SmartScreen message and continue installing HandBrake.")
<!-- /.system-win -->
## Launching HandBrake
You may launch HandBrake by quickly clicking twice (double-clicking) on the cocktail & pineapple icon. Depending on your system settings, a single click may suffice.
![HandBrake icon](../../images/icon-1.0.0.png)![Double-clicking HandBrake icon](../../images/icon-click-1.0.0.gif)
<!-- .continue -->
## Next steps
Continue to [Checking for updates](check-for-updates.html).
<!-- /.continue -->
[^nightly-builds]: Nightly builds are based on HandBrake's latest development code, including new and experimental features that may be unstable or significantly different than the latest release version. Although everyone is welcome to try them, nightly builds are best suited for experienced users and developers.
[^gatekeeper-disabled]: If Gatekeeper is disabled on your Mac, you may not see this message.
[^gatekeeper-instructions]: These instructions are taken directly from Apple's Gatekeeper support documents. You can learn more about Gatekeeper [here](https://support.apple.com/kb/PH21769?locale=en_US) and [here](https://support.apple.com/en-us/HT202491).

74
source/docs/en/1.0.0/get-handbrake/where-to-get-handbrake.markdown Normal file
View File

@ -0,0 +1,74 @@
---
Type: article
Title: Where to get HandBrake
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS) ]
Copyright: 2016 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
---
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.
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-lin -->
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. Users of other BSD- and *nix-like distributions may compile from source.
<!-- /.system-lin -->
HandBrake source code is available at the official [HandBrake repository on GitHub](https://github.com/HandBrake/HandBrake).
Other versions obtained via third parties are not supported.
## Warning about scams and fakes
HandBrake is available for *free* at the [HandBrake website](https://handbrake.fr/).[^checksums] This is the *only* official download source for HandBrake.
Beware of third-party websites and peer-to-peer downloads of HandBrake. They may include unwanted extras such as additional applications, [ransomware](https://en.wikipedia.org/wiki/Ransomware), or other forms of [malware](https://en.wikipedia.org/wiki/Malware). The HandBrake Team has no control over these external services. Avoid!
Beware of online marketplaces and auction sites. HandBrake is *free software*.
<!-- .system-lin -->
## Warning about broken third-party builds
Certain Linux distributions and package repositories create their own versions of HandBrake. These modified versions are often crippled (features removed for political reasons) and broken (bugs due to modifications), and should be avoided.
Broken third-party packages/builds include but are not limited to:
- Arch: `handbrake`, `handbrake-cli`
- Arch [AUR](abbr:Arch User Repository): `handbrake-cli-git`, `handbrake-cli-fdkaac`, `handbrake-fdkaac`, `handbrake-gtk-git`, `handbrake-gtk2`
- Debian Multimedia: `handbrake`, `handbrake-cli`, `handbrake-gtk`
- Gentoo: `handbrake`
- openSUSE Packman: `handbrake`, `handbrake-cli`, `handbrake-gtk`
- Ubuntu Universe: `handbrake`, `handbrake-cli`, `handbrake-dbg`
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.
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-lin -->
<!-- .continue -->
## Next steps
Continue to [Downloading and installing HandBrake](download-and-install.html).
<!-- /.continue -->
[^license]: For more information about the license, see the [LICENSE](https://github.com/HandBrake/HandBrake/blob/master/LICENSE) file and a [summary of GPLv2 on TLDRLegal](https://tldrlegal.com/license/gnu-general-public-license-v2).
[^checksums]: Downloaded files should match the [official release checksums](https://handbrake.fr/checksums.php) as published on the official HandBrake website. Downloaded files with unlisted checksums may be tampered with.

163
source/docs/en/1.0.0/help/activity-log.markdown Normal file
View File

@ -0,0 +1,163 @@
---
Type: article
Title: Activity Log
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS), John Stebbins (j45), Scott (s55) ]
Copyright: 2016 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
---
Activity Log
============
When you launch HandBrake, it begins recording information about its operation to an Activity Log. When you open a `Source`, HandBrake scans it and records what it discovers to the log. Likewise, during encoding, HandBrake records its progress—and any issues it encounters—to the log.
Activity Logs can be a good personal reference for the settings you used to make your videos and whether everything went as you expected.
Should you need technical support, providing an Activity Log is **required** and is essential for diagnosing the issue you may be experiencing.
## Why Activity Logs are required for support
Frequently, people ask the HandBrake Team, "Why should I be *required* to provide an Activity Log to receive technical support?" Good question!
For starters, most applications log information about their operation. Your operating system keeps countless logs as well. Logs are often used for informational purposes and to diagnose technical problems with a system or application that isn't behaving as expected.
Here are some questions that may be helpful in diagnosing a problem with HandBrake, that an Activity Log can answer:
- Are you using official HandBrake or an unsupported third-party build?
- Where is HandBrake installed on your system?
- What HandBrake version are you using?
- What operating system and version are you using?
- What type of CPU are you using? Does it support Intel QuickSync Video?
- What type of GPU are you using? What version of OpenCL does it support?
- Is HandBrake able to use your GPU for certain features?
- What is your display resolution?
- What is your system's temporary files directory? Is HandBrake able to use it?
- Is HandBrake using dvdread or dvdnav for reading DVDs?
- Is HandBrake able to open your `Source`?
- Is HandBrake able to detect the media type of your `Source`? What type (DVD, Blu-ray, MKV/MP4, etc.)?
- Is your `Source` a physical DVD or Blu-ray or a file on your computer?
- Is your `Source` unusable due to copy protection?
- What [region](https://en.wikipedia.org/wiki/DVD_region_code) is your DVD and does your DVD drive support this region?
- Does your `Source` contain multiple `Titles`? How many? How long is each one?
- Is HandBrake able to parse and read each `Title`? What errors?
- What video, audio, and subtitle tracks are in each `Title`? What [codecs](https://en.wikipedia.org/wiki/Codec) does each use?
- Is there a video track? What frame rate and resolution is the video?
- Is HandBrake able to detect and automatically remove (crop) black borders around the edges of your video?
- Are there audio tracks? What language, sample rate, channel layout, and bit rate is each audio track?
- Are there subtitles? What types and languages?
- Is HandBrake performing a foreign audio scan to find forced subtitles? Did it find any?
- Are there chapter markers? How many? How long is each one?
- What preset is being used for encoding? Is it an official preset?
- What changes are made to the settings after selecting a preset?
- What are the final settings used for the encode?
- Is HandBrake able to write to your `Destination` file? If not, why not?
- While encoding, is HandBrake able to read your entire `Source` without errors?
- Are there any problems with your `Source`'s timestamps?
- How many frames did HandBrake decode from the `Source` during encoding? More or less than expected?
- Is HandBrake dropping or duplicating frames to enforce a constant frame rate setting? How many frames of each?
- What is the average bitrate of each encoded track in the `Destination`?
- Are HandBrake's work threads finishing and exiting properly?
- Is HandBrake leaking memory during encoding?
Obviously, it would be *laborious* to ask these questions to thousands of people requesting support for HandBrake.
In contrast, providing an Activity Log is an easy way to explain exactly what is going on in a standardized manner, which helps ensure accuracy and prevent confusion. This speeds up the support process significantly, which saves time for everybody.
Despite this, some people refuse to provide logs even after being given the above reasoning. Often times, these people think their question is simple enough that a log shouldn't be required. This is almost never the case in practice, and time is wasted asking and answering questions that Activity Logs are designed for.
While it is the HandBrake Team's goal to help everyone we can, the fact remains that we can't magically infer what may or may not be happening inside your computer. *Without an Activity Log, the HandBrake Team simply cannot provide technical support.*
## Privacy
Activity Logs are stored *only* on your computer. HandBrake does not send these logs anywhere else.
If you are concerned about retaining these logs indefinitely, feel free to delete them periodically. Be sure not to delete any other files important to HandBrake's operation.
To provide an Activity Log for support, you must send us your log(s) manually. If you are concerned about private information an Activity Log may contain and reveal to others, feel free to read through the log and redact the parts that concern you before sharing.
## Sharing
To share your Activity Log publicly—for instance, to request technical support for HandBrake—you may wish to do one of the following:
- Copy and paste the text of the log to a Pastebin site such as [Pastebin.com](http://pastebin.com)
- Upload the log file to a free temporary file sharing service such as [ExpireBox](http://expirebox.com/) or [WeTransfer](https://www.wetransfer.com/)
- Upload the log file to a paid file sharing service such as [Box](https://www.box.com/), [Dropbox](https://www.dropbox.com), or [Jumpshare](https://jumpshare.com/)
Once your log is available publicly, share its link with your intended recipient(s). When using a free service, be sure to note how long the service intends to store your log (typically 1-7 days).
Activity Logs may also be pasted directly into [new support requests on GitHub](https://github.com/HandBrake/HandBrake/issues/new).
## Where to find the logs
**Note:** When scanning a new source during encoding, log messages from the scan may be intermixed with log messages from your currently running encode.
<!-- .system-lin -->
### Activity Logs on Linux
You can access the current log by opening the Activity Log window in HandBrake.
<!-- image, activity log window on linux -->
On Linux, logs are stored at `Datadir/ghb`, where `Datadir` is the system default data directory (typically `$(HOME)/.config`).
The full path to the log directory is shown at the top of the Activity Log window.
Inside, you may find the following files:
- `Activity.log.ProcessID`, where `ProcessID` is the process identifier given to HandBrake by Linux, contains information about the specific app session
- Log files for individual encodes are located in the `EncodeLogs` subdirectory and named according to the pattern `Videoname Date Time.txt`; encode logs are retained until deleted manually
<!-- /.system-lin -->
<!-- .system-mac -->
### Activity Logs on Mac
You can access the current log by opening the Activity Log window in HandBrake.
<!-- image, activity log window on mac -->
On Mac, logs are stored at `~/Library/Application Support/HandBrake/EncodeLogs`, where `~` is your home folder.
You can open this location directly from HandBrake's Activity Log window.
Inside, you may find the following files:
- `HandBrake-activitylog.txt` is overwritten each time HandBrake starts, and contains information about the latest app session
- Log files for individual encodes are named according to the pattern `Videoname Date Time.txt` and are retained until deleted manually
<!-- /.system-mac -->
<!-- .system-win -->
### Activity Logs on Windows
You can access the current log by opening the Activity Log window in HandBrake.
<!-- image, activity log window on windows -->
On Windows, logs are stored at the following locations, where `Username` is your user name:
- `C:\Users\Username\AppData\Roaming\HandBrake\logs` on Windows 7, 8, and 10
- `C:\Users\Username\Application Data\HandBrake\logs` on Windows Vista
Inside, you may find the following files:
- `activity_logProcessID.txt`, where `ProcessID` is the process identifier given to HandBrake by Windows, contains information about the specific app session
- Log files for individual encodes are named according to the pattern `Videoname Date Time.txt` and are retained until deleted manually
<!-- /.system-win -->
### Activity Logs on the command line
HandBrake's command line interface outputs to the standard streams `stdout` and `stderr`, with encode progress information routed to the former and log messages routed to the latter.
To capture HandBrake's log messages to a file, simply redirect `stderr`:
HandBrakeCLI ... 2> my-activity-log.txt

43
source/docs/en/1.0.0/help/community-support.markdown Normal file
View File

@ -0,0 +1,43 @@
---
Type: article
Title: Community support
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS) ]
Copyright: 2016 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
---
Community support
=================
If you run into problems using HandBrake, first take a look at this documentation's [Table of contents](../table-of-contents.html)—the information you need may be just a click away.
Didn't find it? Keep reading.
## Activity Logs
Providing an Activity Log is **required** for all support requests. It is the fastest and most accurate way for the HandBrake Team to understand any potential issues you may be facing. Logs are stored *only* on your computer, so please read more about where to find your [Activity Logs](activity-log.html) and how to share them when requesting support.
You may think you have a simple question for which providing a log seems unnecessary. Please read the section, *Why Activity Logs are required for support* on the [Activity Log](activity-log.html) article. *Without an Activity Log, the HandBrake Team simply cannot provide technical support.*
## Community Forums
The [HandBrake Community Forums](https://forum.handbrake.fr/) are available 24/7. Whether you have a support request or simply want to connect with other HandBrake users, this is the place. Registration is free. Please read and abide by our [Community Rules](https://forum.handbrake.fr/viewtopic.php?f=6&t=6702).
If you need help or have encountered an error while using HandBrake, first take a look at our [Support Forums](https://forum.handbrake.fr/viewforum.php?f=16) or [Search](https://forum.handbrake.fr/search.php) using some words related to your questions. Doing this saves everyone from repeating answers to common questions. If you still haven't found an answer, feel free to start a new support request. Make sure to read [How To Request Support](https://forum.handbrake.fr/viewtopic.php?f=6&t=31236) before posting.
Developers and keen users may report reproducible bugs on the [Bugs Forum](https://forum.handbrake.fr/viewforum.php?f=12). Please read the [bug reporting readme](https://forum.handbrake.fr/viewtopic.php?f=12&t=18906) before posting.
## 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.
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).

59
source/docs/en/1.0.0/help/troubleshooting-common-issues.markdown Normal file
View File

@ -0,0 +1,59 @@
---
Type: article
State: draft
Title: Troubleshooting common issues
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS) ]
Copyright: 2016 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
---
Troubleshooting common issues
=============================
## Common Questions (All Platforms)
## Mac GUI
####*HandBrake won't launch when double clicking on the icon.*
We are not currently able to sign the HandBrake downloads. Since our download is not code signed, OSX will flag the application as from an unidentified developer. To work around this, please read their [Open an app from an unidentified developer](https://support.apple.com/kb/PH18657?locale=en_US) help article.
This is also detailed on the [Downloading and installing HandBrake](../get-handbrake/download-and-install.html) page.
## Linux GUI
## Windows GUI
####*Where can I download the Microsoft .NET framework 4.6.1 or later*
If you are running Windows 7 or 8.x, it is available via Windows update.
Alternatively, you can download it from the ​Microsoft Website.
Windows 10 ships with this out the box so you should not need to install it.
####*HandBrake crashes or won't launch.*
There are a couple of things you can try:
- Make sure you have Microsoft .NET Framework 4.6.1 or later installed on your system
- Delete the config and preset files. You can find these in the following directories.
For 2000/XP
C:\Documents and Settings\<username>\Application Data\HandBrake
C:\Documents and Settings\<username>\Local Settings\Application Data\HandBrake
For Vista
C:\Users\<username>\Application Data\HandBrake
C:\Users\<username>\Local Settings\Application Data\HandBrake
For Windows 7 and later
C:\Users\<username>\AppData\Roaming\HandBrake
and
C:\Users\<username>\AppData\Local\HandBrake
- Reinstall HandBrake.

28
source/docs/en/1.0.0/index.markdown Normal file
View File

@ -0,0 +1,28 @@
---
Type: article
Title: Welcome
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS) ]
Copyright: 2016 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
---
Welcome
=======
Welcome to the English documentation for HandBrake 1.0.0.
Here are some quick links to get you started:
- To quickly get up and running with HandBrake, continue to [Quick start](introduction/quick-start.html)
- To get a copy of HandBrake (*it's free!*), see [Downloading and installing HandBrake](get-handbrake/download-and-install.html)
- A more detailed guide to using HandBrake begins with [Opening a video source](workflow/open-video-source.html)
- Having problems? See [Troubleshooting common issues](help/troubleshooting-common-issues.html)
Continue to the [Table of contents](table-of-contents.html) for a list of all available articles.

68
source/docs/en/1.0.0/introduction/about.markdown Normal file
View File

@ -0,0 +1,68 @@
---
Type: article
Title: About HandBrake
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS) ]
Copyright: 2016 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
---
About HandBrake
===============
## What HandBrake is
HandBrake is an open-source video transcoder available for Linux, Mac, and Windows.
Everyone can use HandBrake to make videos *for free*.
## 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 Libav, x264, and x265 to create new MP4 or MKV video files from these `Sources`.
HandBrake **does**:
- Convert nearly any video to MP4 or MKV
- Crop and resize video
- Restore old and low-quality video
- Remove combing artifacts caused by interlacing and telecine
- Pass-through audio without conversion for certain audio types
- Downmix discrete surround sound to matrixed surround or stereo
- Adjust audio volume levels, and dynamic range for certain audio types
- Preserve existing subtitles, and add or remove soft subtitles (subtitles stored as text)
HandBrake can also make videos that are smaller—taking up less storage space on your device—than the originals.
## What HandBrake does not do
HandBrake **does not**:
- Combine multiple video clips into one
- Pass-through video without conversion (video is *always* converted)
- Create Blu-ray, AVCHD, or DVD discs
- Make cocktails (yet)
HandBrake also does not defeat or circumvent [copy protection](https://en.wikipedia.org/wiki/Copy_protection) of any kind. It does not work with video files employing [Digital Rights Management](https://en.wikipedia.org/wiki/Digital_rights_management) (DRM). This includes but is not limited to, copy protected content from iTunes, Amazon Video, Netflix, or other online providers, and many commercial DVD and Blu-ray discs.
Applications such as [AnyDVD HD](https://en.wikipedia.org/wiki/AnyDVD) for Windows and [MakeMKV](https://www.google.com/search?q=makemkv&ie=utf-8&oe=utf-8) for Linux, Mac, and Windows can create copies of DVD and Blu-ray discs that HandBrake can open, reducing wear on the original discs and often fixing errors due to poorly mastered or otherwise broken discs.[^third-party-apps]
Do not use HandBrake or any other application to copy materials you do not own or have the right to copy. If you are uncertain about your right to copy any material, you should contact your legal advisor.
<!-- .continue -->
## Next steps
Continue to [Where to get HandBrake](../get-handbrake/where-to-get-handbrake.html).
<!-- /.continue -->
[^third-party-apps]: The HandBrake Team has no affiliation with these applications or their creators. If support is needed, please use their respective contact channels directly.

161
source/docs/en/1.0.0/introduction/quick-start.markdown Normal file
View File

@ -0,0 +1,161 @@
---
Type: article
Title: Quick start
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS) ]
Copyright: 2016 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
---
Quick start
===========
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.
This quick start guide assumes you have already downloaded and installed HandBrake. If you do not already have HandBrake, please see [Downloading and installing HandBrake](../get-handbrake/download-and-install.html).
Let's get started.
## Launch HandBrake
Launch HandBrake by quickly clicking twice (double-clicking) on the cocktail & pineapple icon. Depending on your system settings, a single click may suffice.
![HandBrake icon](../../images/icon-1.0.0.png)![Double-clicking HandBrake icon](../../images/icon-click-1.0.0.gif)
## Open your existing video
HandBrake calls the video you already have the `Source`.
Select the `Open Source` button on the toolbar to browse your files for a video to open. You may also drag your `Source` video onto HandBrake's main window.
<!-- .system-lin -->
<!-- TODO: Linux figures. -->
<!-- /.system-lin -->
<!-- .system-mac -->
![Browsing for a video source to open](../../images/mac/open-source-dialog-1.0.0.png "The Open Source dialog allows you to browse your files for a video to open.")
![Opening a video source via drag and drop](../../images/mac/open-source-drag-drop-1.0.0.png "In addition to the Open Source dialog, you may also open a video by dragging it to HandBrake's main window.")
<!-- /.system-mac -->
<!-- .system-win -->
<!-- TODO: Windows figures. -->
<!-- /.system-win -->
## Select a title
Some `Sources` may contain more than one video clip, or a collection of `Titles`. Use HandBrake's `Title` control to select which video clip you want to use.
<!-- .system-lin -->
<!-- TODO: Linux figures. -->
<!-- /.system-lin -->
<!-- .system-mac -->
![Selecting a title](../../images/mac/title-selection-1.0.0.png "Some sources may contain more than one video clip. The title control lets you select which video clip you want to use.")
<!-- /.system-mac -->
<!-- .system-win -->
<!-- TODO: Windows figures. -->
<!-- /.system-win -->
Some `Sources` have only one `Title`. Blu-ray and DVD `Sources` often have multiple `Titles`.
## Select a preset
HandBrake provides a number of settings `Presets` to make your new video work well with your playback devices and software. For instance, if you have a Playstation 4, you may wish to select the `Playstation 1080p30 Surround` preset under `Devices`.
The default `Fast 1080p30` preset is often a good choice because it's fast and compatible with most devices.
<!-- .system-lin -->
<!-- TODO: Linux figures. -->
<!-- /.system-lin -->
<!-- .system-mac -->
![Selecting a preset](../../images/mac/preset-selection-1.0.0.png "Presets are one-click settings to save you time and help ensure compatibility with your devices.")
![Toggling the presets list](../../images/mac/toggle-presets-button-1.0.0.png "If the presets list is not visible, select the Toggle Presets button on the toolbar.")
<!-- /.system-mac -->
<!-- .system-win -->
<!-- TODO: Windows figures. -->
<!-- /.system-win -->
`Presets` can affect compatibility (whether your video will work with your devices and software) and encoding time. Learn more about [Selecting a preset](../workflow/select-preset.html).
## Select a destination
The `Destination` is where your new video will go. You can select the `Browse...` button to choose a different location and name, or type it directly in the box.
<!-- .system-lin -->
<!-- TODO: Linux figures. -->
<!-- /.system-lin -->
<!-- .system-mac -->
![Selecting a destination](../../images/mac/destination-field-1.0.0.png "Destination is where HandBrake will put your new video.")
![Browsing for a destination](../../images/mac/destination-dialog-1.0.0.png "Select the Browse button to choose a different location and name.")
<!-- /.system-mac -->
<!-- .system-win -->
<!-- TODO: Windows figures. -->
<!-- /.system-win -->
Please take special care to *note your destination*. Otherwise, you won't be able to find your new video. You can move it later if you desire.
## Start the encode
Select the `Start` button on the toolbar to make your new video.
HandBrake will report its progress while it's working and alert you when it's finished. Then you will have a new video file at the `Destination` you specified.
<!-- .system-lin -->
<!-- TODO: Linux figures. -->
<!-- /.system-lin -->
<!-- .system-mac -->
![Encode progress](../../images/mac/encode-progress-1.0.0.png "HandBrake reports its progress during encoding.")
![Encoding complete alert](../../images/mac/encode-complete-1.0.0.png "HandBrake shows an alert when finished encoding.")
<!-- /.system-mac -->
<!-- .system-win -->
<!-- TODO: Windows figures. -->
<!-- /.system-win -->
Congratulations! You just encoded your first video using HandBrake. It's now ready to watch on your devices.
<!-- .continue -->
## Next steps
If you didn't get a video file as expected, encountered an error, or had some other trouble, you can continue reading to learn more about how HandBrake works or jump right to [Troubleshooting common issues](../help/troubleshooting-common-issues.html).
Continue to [About HandBrake](about.html).
<!-- /.continue -->

168
source/docs/en/1.0.0/table-of-contents.markdown Normal file
View File

@ -0,0 +1,168 @@
---
Type: article
Title: Table of contents
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS), Scott (s55) ]
Copyright: 2016 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
---
Table of contents
=================
## Introduction
- [Quick start](introduction/quick-start.html)
*Learn how to make your first video in minutes*
- [About HandBrake](introduction/about.html)
*What HandBrake is, does, and does not*
## Getting HandBrake
- [Where to get HandBrake](get-handbrake/where-to-get-handbrake.html)
*The officially supported version*
- [Downloading and installing HandBrake](get-handbrake/download-and-install.html)
*How to get HandBrake onto your computer*
- [Checking for updates](get-handbrake/check-for-updates.html)
*Staying up to date with the latest features and bug fixes*
## Making videos
- [Opening a video source](workflow/open-video-source.html)
*How to get your videos into HandBrake*
- [Selecting a preset](workflow/select-preset.html)
*Tailored settings for instant compatibility with many devices*
- [Adjusting quality](workflow/adjust-quality.html)
*Easily increase visual quality or reduce file size*
- [Previewing your settings](workflow/preview-settings.html)
*See what your new video will look like in a fraction of the time*
- [Starting encoding](workflow/start-encoding.html)
*Start encoding your new video with one click*
## Advanced workflows
- [Multiple encodes using the queue](advanced/queue.html)
*Set up multiple encode jobs at once*
- [Point-to-point encoding](advanced/point-to-point.html)
- [Custom presets](advanced/custom-presets.html)
- [Audio and subtitle defaults](advanced/audio-subtitle-defaults.html)
- [Resizing video](advanced/resizing-video.html)
- [Preserving surround sound](advanced/surround-sound.html)
- [Adding subtitles](advanced/subtitles.html)
- [Adding chapter markers](advanced/chapter-markers.html)
<!-- - [Managing Audio Tracks](advanced/managing-audio.html) -->
<!-- - [Post-processing metadata](advanced/post-processing.html) -->
<!-- ## Restoration and enhancement
- Common video problems
- Cropping, Black bars at top/bottom or sides
- Combing effects caused by interlacing or telecine
- Detelecine filter
- Decomb filter vs. Deinterlace filter
- Bob mode and frame rates, motion
- Noise (grainy appearance and/or color splotches)
- Denoise filters: NLMeans and HQDN3D
- Blocky picture
- Deblock filter
- Stretched picture (too wide or too tall)
- Scaling and anamorphic
- Common audio problems
- Volume level too low
- Dynamics too wide (soft whispers, loud booms)
-->
<!-- ## Advanced workflows part 2
- [Understanding source types](advanced/video-sources.html)
- [Selecting a container format and encoders](advanced/containers.html)
- [Selecting a video angle](advanced/video-angles.html)
- [Working with frame rates](advanced/frame-rates.html)
- [Adjusting audio quality](advanced/audio-quality.html)
- [Progressive download support](advanced/web-optimised.html)
- [Compatibility with legacy devices](advanced/old-ipod-support.html)
- [Automatically naming files](advanced/automatic-file-naming.html)
-->
## Getting help
- [Troubleshooting common issues](help/troubleshooting-common-issues.html)
*What to do if something goes wrong*
- [Community support](help/community-support.html)
*Get help from real people*
- [Activity Log](help/activity-log.html)
*Activity Logs help you receive better support*
## HandBrake lore
- [Project history](about/history.html)
<!-- - [About the cocktail and pineapple icon](about/the-icon.html) -->
## CLI documentation
- [CLI guide](cli/cli-guide.html)
- [CLI options list](cli/cli-options.html)
## Technical documentation
- [System requirements](technical/system-requirements.html)
*Make sure your system can run HandBrake*
- [Supported source formats](technical/source-formats.html)
*Types of video files HandBrake can read*
- [Official presets](technical/official-presets.html)
*Technical summary of the official presets*
- Video
- [Video encoders](technical/video-codecs.html)
- [Video encoding speed](technical/video-encoding-performance.html)
- [Constant quality versus average bit rate](technical/video-cq-vs-abr.html)
- [x264 presets and tunes](technical/video-x264-presets-tunes.html)
- [x264 profile and level](technical/video-x264-profiles-levels.html)
- [Video angles](technical/video-angles.html)
- [Anamorphic video](technical/anamorphic-guide.html)
- [Modulus](technical/modulus.html)
- [Frame rate](technical/frame-rates.html)
- [Intel QuickSync Video (QSV) options](technical/video-qsv-options.html)
- Audio
- [Dynamic range compression](technical/dynamic-range-compression.html)
- [Audio quality](technical/audio-quality.html)
- Files and compatibility
- [Container formats](technical/containers.html)
- [Web optimized](technical/web-optimised.html)
- [iPod 5th Generation support](technical/old-ipod-support.html)
- [Automatic file naming](technical/automatic-file-naming.html)
- Filters
- [Filters summary](technical/filters-summary.html)
<!--
- [Video source type](advanced/video-sources.html)
- Advanced Filter Settings
- Advanced preferences
-->
## Developer documentation
- Building HandBrake
- [Building HandBrake for Linux](developer/build-linux.html)
- Installing dependencies on [CentOS](developer/install-dependencies-centos.html) / [Fedora](developer/install-dependencies-fedora.html) / [Gentoo](developer/install-dependencies-gentoo.html) / [Ubuntu](developer/install-dependencies-ubuntu.html)
- [Building HandBrake for Mac](developer/build-mac.html)
- [Building HandBrake for Windows](developer/build-windows.html)
- Packaging HandBrake
- [Flatpak apps for Linux](developer/flatpak-repo.html)
*Fully-contained applications compatible with multiple Linux distributions*
<!-- TODO: link to contributing guide -->

20
source/docs/en/1.0.0/technical/anamorphic-guide.markdown Normal file
View File

@ -0,0 +1,20 @@
---
Type: article
State: draft
Title: Anamorphic Guide
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: []
Copyright: 2016 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
---
Anamorphic Guide
=============================
Coming Soon!

102
source/docs/en/1.0.0/technical/audio-codecs.markdown Normal file
View File

@ -0,0 +1,102 @@
---
Type: article
State: draft
Title: Audio Codecs
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Scott (s55) ]
Copyright: 2016 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 Codecs
============
 
Encoding vs Passthrough
-----------------------
HandBrake supports two modes of operation for handling audio tracks from the
source.
It can either:
- Re-Encode the track into a new format. For example, AC3 or DTS audio from a
DVD or BluRay into AAC for playback on mobile devices.
- Passthru copies the audio track from the source to the newly encoded file.
 
Audio Encoders
--------------
- AAC:
- Advanced Audio Coding (AAC) is one of the most popular formats available
in HandBrake and is widly supported by media players and mobile devices.
- On Linux and Windows, HandBrake uses the LibAV AAC encoder.
- 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)
- High Efficiency AAC encoder. This encoder is optimized for low-bitrate
applications which may be useful for streaming.
- Available on Mac only.
- MP3:
- HandBrake also offers the MP3 audio codec, for which it uses the very
well-regarded lame encoder.
- Vorbis:
- HandBrake offers Vorbis audio encoding as well, for which it uses the
aoTuV branch that offers quality tweaks.
- AC3:
- HandBrake can encode to AC3 using LibAV.
- This is not the same as Passthru. You can encode any audio track to AC3.
- Flac 16 and 24bit (Libav)
- Loss-less 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"
 
Passthru options.
-----------------
HandBrake supports passthru for a limited number of popular source formats.
These are: AC3, DTS, DTS-HD, TrueHD, MP3 or AAC (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
the output file quite substantially.
 
Auto Passthru
-------------
In the audio encoders list, there is an option called "Auto Passthru". When
encoding, this will automatically passthru any supported format to the source
file. If the source format is not supported, or not supported in the output
container, the fallback encoder will be used. The default is AAC.

52
source/docs/en/1.0.0/technical/audio-drc.markdown Normal file
View File

@ -0,0 +1,52 @@
---
Type: article
State: draft
Title: DRC - Dynamic Range Compression
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Scott (s55) ]
Copyright: 2016 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
---
DRC - Dynamic Range Compression
===============================
 
Dynamic Range Compression
-------------------------
The dynamic range of an audio track is the difference between the softest and
loudest sounds.
Dynamic range compression reduces the gap between those extremes.
On the Audio tab, each track provides an option to set the level of compression
you wish.
- 1.0-2.5 are good values to use.
- 0, the default, turns it off completely.
- 1.0 uses the compression hints embedded in the AC3 track.
Values greater than 1.0 compress the range further by boosting the volume of
soft sound samples while leaving loud samples as they are. This squeezes down
the range between the softest and loudest parts, but should make the softer ones
easier to hear in noisy listening environments. Note, this is not the same as a
gain or volume boost control.
 
Compatibility
-------------
Dynamic range compression only works when the source audio is AC3 and you are
encoding to another format, like AAC. It has no affect on AC3 pass-through or on
DTS or MPEG-2 audio.

20
source/docs/en/1.0.0/technical/audio-gain.markdown Normal file
View File

@ -0,0 +1,20 @@
---
Type: article
State: draft
Title: Audio Gain
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Scott (s55) ]
Copyright: 2016 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 Gain
==========
[TODO]

52
source/docs/en/1.0.0/technical/audio-mixdowns.markdown Normal file
View File

@ -0,0 +1,52 @@
---
Type: article
State: draft
Title: Audio Mixdowns
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Scott (s55) ]
Copyright: 2016 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 Mixdowns
====================================
 
Available Down Mixes
--------------------
HandBrake supports the following downmixes:
- Mono
- Mono (Left Only)
- Mono (Right Only)
- Stereo
- Dolby Surround
- Dobly Pro Logic II
- 5.1 Channels
- 6.1 Channels
- 7.1 Channels
- 7.1 Channels (5F/2R/LFE)
Upmixing
--------
HandBrake does not currently support upmixing audio.

61
source/docs/en/1.0.0/technical/audio-quality.markdown Normal file
View File

@ -0,0 +1,61 @@
---
Type: article
State: draft
Title: Audio Quality
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Scott (s55) ]
Copyright: 2016 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 Quality
=============================
The Audio Tracks quality settings are controlled via the "Audio" tab on the main window.
Each track can be configured to suit your needs.
<!-- .system-win -->
![HandBrake's Audio Track Settings](../../images/windows/audio-quality-1.0.0.png "HandBrake's Audio Track Settings")
<!-- /.system-win -->
There are several different modes HandBrake can operate in.
### Average Bitrate
HandBrake supports average bitrate for all audio encoders except FLAC.
### Quality based Encoding
Quality based encoding is supported for the following codecs:
- AAC
- MP3
- Vorbis
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.
In addition, HandBrake can passthru the following source audio track formats:
- AC3 and E-AC3
- DTS, DTS-HD
- TrueHD
- AAC
- MP3
- FLAC

53
source/docs/en/1.0.0/technical/automatic-file-naming.markdown Normal file
View File

@ -0,0 +1,53 @@
---
Type: article
State: draft
Title: Automatic File Naming
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Scott (s55) ]
Copyright: 2016 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
---
Automatic File Naming
=============================
HandBrake can automatically name your output files for you based on a number of criteria.
If you open the programs Preferences screen, you'll see a section that referes to the "Output Files"
![File output preferences](../../images/windows/output-file-preferences-1.0.0.png "File output preferences")
Here you can define the default path where output files will be stored, and the format the file name will take.
By default, it will be {source}-{title}
You can add in addition to this: {chapters}
### Source Name Handling.
Many sources have awkward names. (i.e all capitals). HandBrake offers a few options to correct this.
The following options will affect the source name:
- "Change to Title case", This is also known as camel case where the first letter of each word is a capital followed by lower case letters.
- "Replace underscores with a space" i.e "_" to " "
- "Remove common punctuation" i.e ( Dash - Period . Commas ,)
### MP4 File Extension Handling
The last option allows you to choose the MP4 file extension handling.
MP4 and M4V are identical files. It's just a different file extension.
For MP4 files, HandBrake will automatically use the extension M4V when you pass-through audio (AC3), use SRT subtitles or have chapter markers enabled.
You can simply change the file extension between .mp4 and .m4v as the file is exactly the same. There are no differences in the content or container itself.

53
source/docs/en/1.0.0/technical/containers.markdown Normal file
View File

@ -0,0 +1,53 @@
---
Type: article
State: draft
Title: Formats / containers
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Scott (s55) ]
Copyright: 2016 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
---
Formats / containers
=============================
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)
## Features
Features and playback compatiblity varies between MKV 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.
- 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.
- MP4 also is capable of storing [VariableFrameRate Variable Frame Rate] video.
- Be aware that chapters and AC3 audio can only be seen by QuickTime 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.
- 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.
- 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
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.
You can simply change the file extension between .mp4 and .m4v as the file is exactly the same. There are no differences in the content or container itself.
You can disable the option to automatically set this in !HandBrakes preferences.
Note: QuickTime or any QT based application will not be able to play a MP4 file with these features enabled, unless it has the extension ".m4v"

33
source/docs/en/1.0.0/technical/dynamic-range-compression.markdown Normal file
View File

@ -0,0 +1,33 @@
---
Type: article
State: draft
Title: Dynamic Range Compression
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Scott (s55) ]
Copyright: 2016 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
---
Dynamic Range Compression
=============================
The dynamic range of an audio track is the difference between the softest and loudest sounds.
Dynamic range compression reduces the gap between those extremes.
- 1.0-2.5 are good values to use.
- 0, the default, turns it off completely.
- 1.0 uses the compression hints embedded in the AC3 track.
- Values greater than 1.0 compress the range further by boosting the volume of soft sound samples while leaving loud samples as they are. This squeezes down the range between the softest and loudest parts, but should make the softer ones easier to hear in noisy listening environments.
Note, this is not the same as a gain or volume boost control.
### Compatibility
Dynamic range compression only works when the source audio is AC3 and you are encoding to another format, like AAC. It has no effect on AC3 pass-through or on DTS or MPEG-2 audio.

30
source/docs/en/1.0.0/technical/filters-summary.markdown Normal file
View File

@ -0,0 +1,30 @@
---
Type: article
State: draft
Title: Summary of Filters
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: []
Copyright: 2016 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
---
Summary of Filters
=============================
Coming Soon!
HandBrake contains the following filters:
- Detelecine
- Deinterlace
- Decomb
- Denoise
- Deblock
- Grayscale
- Rotation

34
source/docs/en/1.0.0/technical/frame-rates.markdown Normal file
View File

@ -0,0 +1,34 @@
---
Type: article
State: draft
Title: Frame rate
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS) ]
Copyright: 2016 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
---
Frame rate
==========
A video's frame rate is how many still pictures are displayed per second. Common frame rates are 23.976/24 for film, 25/50 for European broadcast standards, and 29.97/59.94 or 30/60 for North American broadcast standards. Modern video formats can be variable frame rate, switching between different frame rates on the fly, e.g. from 23.976 film to 29.97 NTSC and back.
<!-- .system-mac -->
![Frame rate controls on Mac](../../images/mac/frame-rate-controls-1.0.0.png "HandBrake's frame rate controls.")
<!-- /.system-mac -->
Selecting `Same as Source` allows you to select `Variable Frame Rate (VFR)`, which instructs HandBrake to make your new video's frame rate an exact copy of your `Source` frame rate. No frame rate conversion is performed.
`Constant Frame Rate (CFR)` makes your new video exactly one frame rate throughout. When used with `Same as Source`, HandBrake will detect the frame rate of your `Source` and make sure any variable portions are made constant at the same rate. When used with a specific frame rate, HandBrake conforms your entire video to the new frame rate. This method is not recommended except in special circumstances, such as encoding for import into an [NLE](https://en.wikipedia.org/wiki/Non-linear_editing_system) or for extremely old devices.
Selecting a specific frame rate allows you to select `Peak Frame Rate (PFR)`, which is the best of both worlds. Think of it as a threshold or limit. HandBrake will leave portions of your video at or below the peak frame rate you select unchanged, while limiting higher frame rate video to the peak frame rate you select.
HandBrake versions prior to 1.0.0 defaulted to `Same as Source` and `Variable Frame Rate (VFR)`. This was not of a problem with most videos of the past, but the advent of high frame rate video recording for mobile devices, action cams, and more, this method cannot ensure such videos will be compatible with devices having considerable frame rate limitations—including nearly all modern media devices that *do not* create video. To remedy this, the built-in presets in HandBrake 1.0.0 and later use `Peak Frame Rate (PFR)` for broader compatibility.

20
source/docs/en/1.0.0/technical/modulus.markdown Normal file
View File

@ -0,0 +1,20 @@
---
Type: article
State: draft
Title: Modulus
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: []
Copyright: 2016 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
---
Modulus
=============================
Coming Soon!

154
source/docs/en/1.0.0/technical/official-presets.markdown Normal file
View File

@ -0,0 +1,154 @@
---
Type: article
Title: Official presets
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS) ]
Copyright: 2016 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
---
Official presets
================
A `Preset` is a group of settings specifically tailored for the software or device you want your videos to play on. Selecting a `Preset` can go a long way toward ensuring your video works where you want it to.
HandBrake includes a number of official `Presets` that select specific settings to ensure compatibility for specific devices, the web, and for general use. When selecting one of these `Presets`, higher resolution video will be downscaled to a maximum resolution, and higher frame rates will be peak limited to a maximum frame rate. Audio and other settings may also be enforced.
Here are some examples of how `Presets` work in practice:
- When selecting one of the 720p30 `Presets`, a Source with 1080p video at 60 frames per second will be downscaled to 720p resolution and peak limited to 30 frames per second
- When selecting one of the 720p30 `Presets`, a Source with 480p video at 30 frames per second will not be scaled or peak limited
- When selecting a `Preset` that does not include surround sound, only stereo audio is encoded; the discrete surround audio is dropped
- When selecting a `Preset` that includes surround sound, stereo audio is encoded and surround audio is "passed through" if possible (or encoded to a compatible format)
Select a `Preset` and explore which settings have changed. These settings will be used to make your new video.
The default `Fast 1080p30` preset is a good choice if you're just getting started. It's fast and compatible across a wide range of software and devices.
## General presets
HandBrake's General `Presets` use the [MP4 container](https://en.wikipedia.org/wiki/MPEG-4_Part_14) and are intended to be broadly compatible across a wide range of software and devices.[^high-quality-settings-less-compatible]
Each General `Preset` is named according to the quality or speed, maximum resolution, and maximum frame rate it produces.
| Preset | Type | Video | Audio | Picture Quality | Encoding Speed | File Size |
|---------------------------|------|-------|----------------------------------|-----------------|----------------|----------------|
| Very Fast 1080p30 | MP4 | H.264 | AAC stereo | Average | Very fast | Small |
| Very Fast 720p30 | MP4 | H.264 | AAC stereo | Average | Very fast | Small |
| Very Fast 576p25 | MP4 | H.264 | AAC stereo | Average | Very fast | Small |
| Very Fast 480p30 | MP4 | H.264 | AAC stereo | Average | Very fast | Small |
| **Fast 1080p30** | MP4 | H.264 | AAC stereo | Standard | Fast | Average |
| Fast 720p30 | MP4 | H.264 | AAC stereo | Standard | Fast | Average |
| Fast 576p25 | MP4 | H.264 | AAC stereo | Standard | Fast | Average |
| Fast 480p30 | MP4 | H.264 | AAC stereo | Standard | Fast | Average |
| HQ 1080p30 Surround | MP4 | H.264 | AAC stereo; Dolby Digital (AC-3) | High | Slow | Large |
| HQ 720p30 Surround | MP4 | H.264 | AAC stereo; Dolby Digital (AC-3) | High | Slow | Large |
| HQ 576p25 Surround | MP4 | H.264 | AAC stereo; Dolby Digital (AC-3) | High | Slow | Large |
| HQ 480p30 Surround | MP4 | H.264 | AAC stereo; Dolby Digital (AC-3) | High | Slow | Large |
| Super HQ 1080p30 Surround | MP4 | H.264 | AAC stereo; Dolby Digital (AC-3) | Super high | **Very slow** | **Very large** |
| Super HQ 720p30 Surround | MP4 | H.264 | AAC stereo; Dolby Digital (AC-3) | Super high | **Very slow** | **Very large** |
| Super HQ 576p25 Surround | MP4 | H.264 | AAC stereo; Dolby Digital (AC-3) | Super high | **Very slow** | **Very large** |
| Super HQ 480p30 Surround | MP4 | H.264 | AAC stereo; Dolby Digital (AC-3) | Super high | **Very slow** | **Very large** |
## Web presets
HandBrake's Web `Presets` use the broadly compatible [MP4 container](https://en.wikipedia.org/wiki/MPEG-4_Part_14) and are tailored for sharing videos on the Internet.
Gmail `Presets` are designed to guarantee video up to a certain duration will produce a file less than 25 [MB](abbr:megabytes) for attaching to an email.[^email-size-limit] The maximum duration is part of each `Preset` name. Audio quality is slightly reduced, and visually noisy/grainy or high motion scenes may show a reduction in quality in order to achieve the target file size.
| Preset | Type | Video | Audio | Picture Quality | Encoding Speed | File Size |
|-------------------------------|------|-------|------------|-------------------|----------------|---------------|
| Gmail Large 3 Minutes 720p30 | MP4 | H.264 | AAC stereo | Depends on source | Fast | 25 MB or less |
| Gmail Medium 5 Minutes 480p30 | MP4 | H.264 | AAC stereo | Depends on source | Fast | 25 MB or less |
| Gmail Small 10 Minutes 288p30 | MP4 | H.264 | AAC mono | Depends on source | Fast | 25 MB or less |
## Devices presets
HandBrake's Devices `Presets` target specific devices and classes of devices, such as mobile phones, tablets, TV media players, and game consoles.
Most Devices `Presets` use the broadly compatible [MP4 container](https://en.wikipedia.org/wiki/MPEG-4_Part_14), while a select few use the [Matroska Multimedia Container](https://en.wikipedia.org/wiki/Matroska) to support advanced features such as [Ultra HD 4K resolution](https://en.wikipedia.org/wiki/4K_resolution) and additional audio types compatible with target devices.
Each Devices `Preset` is named according to the device name or class, maximum resolution, and maximum frame rate it produces.
| Preset | Type | Video | Audio | Encoding Speed |
|------------------------------|-------|-------|----------------------------------|----------------|
| Android 1080p30 | MP4 | H.264 | AAC stereo | Medium |
| Android 720p30 | MP4 | H.264 | AAC stereo | Medium |
| Android 576p25 | MP4 | H.264 | AAC stereo | Medium |
| Android 480p30 | MP4 | H.264 | AAC stereo | Medium |
| Apple 1080p60 Surround | MP4 | H.264 | AAC stereo; Dolby Digital (AC-3) | Medium |
| Apple 1080p30 Surround | MP4 | H.264 | AAC stereo; Dolby Digital (AC-3) | Medium |
| Apple 720p30 Surround | MP4 | H.264 | AAC stereo; Dolby Digital (AC-3) | Medium |
| Apple 540p30 Surround | MP4 | H.264 | AAC stereo; Dolby Digital (AC-3) | Medium |
| Apple 240p30 | MP4 | H.264 | AAC stereo | Medium |
| Chromecast 1080p30 Surround | MP4 | H.264 | AAC stereo; Dolby Digital (AC-3) | Medium |
| Fire TV 1080p30 Surround | MP4 | H.264 | AAC stereo; Dolby Digital (AC-3) | Medium |
| Playstation 1080p30 Surround | MP4 | H.264 | AAC stereo; Dolby Digital (AC-3) | Medium |
| Playstation 720p30 | MP4 | H.264 | AAC stereo | Medium |
| Playstation 540p30 | MP4 | H.264 | AAC stereo | Medium |
| Roku 2160p60 4K Surround | **MKV** | **H.265** | AAC stereo; AAC, Dolby Digital (AC-3), Dolby Digital Plus (E-AC-3), DTS, or MP3 | **Very slow** |
| Roku 2160p30 4K Surround | **MKV** | **H.265** | AAC stereo; AAC, Dolby Digital (AC-3), Dolby Digital Plus (E-AC-3), DTS, or MP3 | **Very slow** |
| Roku 1080p30 Surround | MP4 | H.264 | AAC stereo; Dolby Digital (AC-3) | Medium |
| Roku 720p30 Surround | MP4 | H.264 | AAC stereo; Dolby Digital (AC-3) | Medium |
| Roku 576p25 | MP4 | H.264 | AAC stereo | Medium |
| Roku 480p30 | MP4 | H.264 | AAC stereo | Medium |
| Windows Mobile 1080p30 | MP4 | H.264 | AAC stereo | Medium |
| Windows Mobile 720p30 | MP4 | H.264 | AAC stereo | Medium |
| Windows Mobile 540p30 | MP4 | H.264 | AAC stereo | Medium |
| Windows Mobile 480p30 | MP4 | H.264 | AAC stereo | Medium |
| Xbox 1080p30 Surround | MP4 | H.264 | AAC stereo; Dolby Digital (AC-3) | Medium |
| Xbox Legacy 1080p30 Surround | MP4 | H.264 | AAC stereo; Dolby Digital (AC-3) | Medium |
## Matroska presets
HandBrake's Matroska `Presets` target software and devices supporting the [Matroska Multimedia Container](https://en.wikipedia.org/wiki/Matroska). MKV files support virtually all video and audio types, including many that the [MP4 container](https://en.wikipedia.org/wiki/MPEG-4_Part_14) does not.
Each Matroska `Preset` is named according to the video type, maximum resolution, and maximum frame rate it produces.
| Preset | Type | Video | Audio | Encoding Speed |
|-------------------|------|-------|---------------|----------------|
| H.264 MKV 1080p30 | MKV | H.264 | AAC stereo | Standard |
| H.264 MKV 720p30 | MKV | H.264 | AAC stereo | Standard |
| H.264 MKV 576p25 | MKV | H.264 | AAC stereo | Standard |
| H.264 MKV 480p30 | MKV | H.264 | AAC stereo | Standard |
| H.265 MKV 1080p30 | MKV | H.265 | AAC stereo | **Very slow** |
| H.265 MKV 720p30 | MKV | H.265 | AAC stereo | **Very slow** |
| H.265 MKV 576p25 | MKV | H.265 | AAC stereo | **Very slow** |
| H.265 MKV 480p30 | MKV | H.265 | AAC stereo | **Very slow** |
| VP8 MKV 1080p30 | MKV | VP8 | Vorbis stereo | **Ultra slow** |
| VP8 MKV 720p30 | MKV | VP8 | Vorbis stereo | **Ultra slow** |
| VP8 MKV 576p25 | MKV | VP8 | Vorbis stereo | **Ultra slow** |
| VP8 MKV 480p30 | MKV | VP8 | Vorbis stereo | **Ultra slow** |
| VP9 MKV 1080p30 | MKV | VP9 | Opus stereo | **Ultra slow** |
| VP9 MKV 720p30 | MKV | VP9 | Opus stereo | **Ultra slow** |
| VP9 MKV 576p25 | MKV | VP9 | Opus stereo | **Ultra slow** |
| VP9 MKV 480p30 | MKV | VP9 | Opus stereo | **Ultra slow** |
## Legacy presets
HandBrake's Legacy `Presets` are retained from previous HandBrake releases for compatibility with existing workflows and scripts.
| Preset | Type | Video | Audio | Max Resolution | Encoding Speed |
|---------------------|------|-------|----------------------------------|----------------|----------------|
| Normal | MP4 | H.264 | AAC stereo | 1080p | Very fast |
| High Profile | MP4 | H.264 | AAC stereo; Dolby Digital (AC-3) | 1080p | Medium |
| Universal | MP4 | H.264 | AAC stereo; Dolby Digital (AC-3) | 576p/480p | Very fast |
| iPod | MP4 | H.264 | AAC stereo | 240p | Ultra fast |
| iPhone & iPod touch | MP4 | H.264 | AAC stereo | 540p | Medium |
| iPad | MP4 | H.264 | AAC stereo | 720p | Medium |
| AppleTV | MP4 | H.264 | AAC stereo; Dolby Digital (AC-3) | 540p | Medium |
| AppleTV 2 | MP4 | H.264 | AAC stereo; Dolby Digital (AC-3) | 720p | Medium |
| AppleTV 3 | MP4 | H.264 | AAC stereo; Dolby Digital (AC-3) | 1080p | Medium |
| Android | MP4 | H.264 | AAC stereo | 480p | Medium |
| Android Tablet | MP4 | H.264 | AAC stereo | 720p | Medium |
| Windows Phone 8 | MP4 | H.264 | AAC stereo | 720p | Medium |
[^high-quality-settings-less-compatible]: Higher quality General `Presets` may include settings that are incompatible with older or slower devices.
[^email-size-limit]: The 25 [MB](abbr:megabytes) per message size limit for email attachments is specific to the [Gmail](https://www.google.com/gmail/) service and may change in the future. Other email services may set different limits. It is generally recommended to use a [file hosting service](https://en.wikipedia.org/wiki/Comparison_of_file_hosting_services) when sharing large or long videos.

27
source/docs/en/1.0.0/technical/old-ipod-support.markdown Normal file
View File

@ -0,0 +1,27 @@
---
Type: article
State: draft
Title: iPod 5G Support
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Scott (s55) ]
Copyright: 2016 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
---
iPod 5G Support
=============================
![iPod 5G Checkbox](../../images/windows/ipod-5g-1.0.0.png "iPod 5G Checkbox")
Older classic iPods require a special atom to be written to the MP4 file before they will play back on the device or be transferable in iTunes.
HandBrake doesn't add this by default, but if you have an older classic iPod, you can turn it on by selecting the "iPod 5G Support" checkbox located under the Destination chooser.
This is only available for MP4 files

63
source/docs/en/1.0.0/technical/source-formats.markdown Normal file
View File

@ -0,0 +1,63 @@
---
Type: article
Title: Source formats
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS) ]
Copyright: 2016 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
---
Source formats
==============
One of HandBrake's strengths is its ability to open a wide variety of video formats. HandBrake uses [Libav](https://libav.org/) under the hood and generally can open whatever Libav will, in addition to disc-based formats like DVD and Blu-ray.
**Note:** HandBrake does not defeat or circumvent [copy protection](https://en.wikipedia.org/wiki/Copy_protection) of any kind. It does not work with video files employing [Digital Rights Management](https://en.wikipedia.org/wiki/Digital_rights_management) (DRM). See [About HandBrake](../about.html) for more information about what HandBrake *does* and *does not*.
## Videos made by mobile phones, tablets, and many video cameras and DSLRs
Typically, each video will be a single file that you can copy to your computer, and later open using HandBrake. Common video file types are MP4 or M4V, MOV, MPG or MPEG, and AVI.
Some cameras store multiple videos in a folder structure with a playlist similar to Blu-ray discs, specifically cameras that record in AVCHD or AVCHD Lite. HandBrake may be able to open individual video files from the Stream folder inside the BDMV folder. In some cases this is not reliable, e.g. where a single video stream spans multiple files.
## Screen and game recordings, web videos, video editing projects, and other computer-related sources
Some screen recording softwares can export or record directly to video files HandBrake can open. Common video file types are MP4 or M4V, MKV, MPG or MPEG, AVI, and WMV.
HandBrake can open web videos in FLV, WEBM, MP4, and many other formats.
Videos made using consumer video editing software such as [iMovie](https://www.apple.com/mac/imovie/) must first be exported to a common video format for compatibility with HandBrake.
## Professional video production formats
HandBrake can open a number of production formats produced by professional video cameras and [NLE](abbr:Non-linear editing system)s, including [ProRes](https://en.wikipedia.org/wiki/Apple_ProRes) and [DNxHD](https://en.wikipedia.org/wiki/DNxHD_codec).
## DVD, Blu-ray, AVCHD/AVCHD Lite[^avchd-partial-support], and HD-DVD[^hddvd-partial-support] discs or disc backups
HandBrake can directly open DVD and Blu-ray discs. In most situations it is better to first copy the contents to your computer's hard drive[^uncopyable]. Common folders are VIDEO_TS and BDMV. Common video file types are VOB, EVO, and MTS or M2TS.
Certain third-party disc copy tools such as MakeMKV commonly make... wait for it... MKV video files. Other tools create ISO (sometimes labeled CDR) images of DVD and Blu-ray discs. HandBrake usually can open these directly.
BIN+CUE, MDF+MDS, and Toast images must first be mounted. Open the image using your operating system or appropriate software, and then open the virtual disc with HandBrake.
## Broadcast TV recordings
HandBrake can open common video file types produced by TV recording hardware and software such as TS/MTS/M2TS, MP4 or M4V, and MPG or MPEG.
Recordings made by TV-to-DVD recorders are generally supported, but do note that some recorders are known for poorly making discs. Some discs may not work due to mastering errors.
## Digital recordings of VHS, Beta, Video8/Hi8, LaserDisc, and other analog sources
First convert your analog video to digital using a computer-based hardware recording device such as the [Blackmagic Design Intensity](https://www.blackmagicdesign.com/products/intensity). It is important to choose a recording device and software that allows recording to or exporting to common video formats. HandBrake can open many common video files produced by recording software, including but not limited to TS/MTS/M2TS, MP4 or M4V, MOV, MKV, MPG or MPEG, and AVI.
[^avchd-partial-support]: AVCHD and AVCHD Lite playlists are not fully supported. Individual files/streams may work.
[^hddvd-partial-support]: HD-DVD playlists are not fully supported. Individual files/streams may work.
[^uncopyable]: Without special software, it is not possible to directly copy VIDEO_TS and BDMV folders from copy-protected discs.

109
source/docs/en/1.0.0/technical/system-requirements.markdown Normal file
View File

@ -0,0 +1,109 @@
---
Type: article
Title: System requirements
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Scott (s55), Bradley Sepos <bradley@bradleysepos.com> (BradleyS) ]
Copyright: 2016 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
---
System requirements
===================
## Hardware
The following is the minimum level of hardware that HandBrake supports. While it may be technically possible to run HandBrake on hardware older than this, it is neither recommended nor supported.
<!-- .system-lin -->
### Linux
- Processor: Intel Core 2 Duo, AMD Athlon X2, or better
- Free Memory:
- 256 MB for transcoding standard definition video
- 1 GB for transcoding high definition video
- 2 GB or more for transcoding 4K video
- Screen Resolution: 1024x768 or better
- System Storage:
- 50 MB for the HandBrake app
- 2 GB or more recommended for processing and storing your new videos
<!-- /.system-lin -->
<!-- .system-mac -->
### Mac
- 64-bit Intel Mac (Intel Core 2 Duo "Merom" or later)
- 32-bit Intel Macs (2007 and earlier) cannot run recent 64-bit HandBrake releases
- 2010 models and newer are recommended, as older Macs are often quite slow for processing video
- Free Memory:
- 256 MB for transcoding standard definition video
- 1 GB for transcoding high definition video
- 2 GB or more for transcoding 4K video
- Screen Resolution: 1024x768 or better
- System Storage:
- 50 MB for the HandBrake app
- 2 GB or more recommended for processing and storing your new videos
<!-- /.system-mac -->
<!-- .system-win -->
### Windows
- Processor: Intel Core 2 Duo, AMD Athlon X2, or better
- Free Memory:
- 256 MB for transcoding standard definition video
- 1 GB for transcoding high definition video
- 2 GB or more for transcoding 4K video
- Screen Resolution: 1024x768 or better (higher if running in High-DPI Mode, above 96 DPI or 100%)
- System Storage:
- 50 MB for the HandBrake app
- 2 GB or more recommended for processing and storing your new videos
- Intel QuickSync requires a 2nd generation or newer Intel Core Ix Series processor with integrated Intel HD Graphics enabled and a directly connected display
- OpenCL scaling is experimental and requires an AMD or Intel GPU with OpenCL 1.2 or later
<!-- /.system-win -->
HandBrake's QuickSync and OpenCL features are only supported on Windows.
## Software
<!-- .system-lin -->
### Linux
#### Ubuntu (Official PPA)
Several major versions are supported, see [Where to get HandBrake](../get-handbrake/where-to-get-handbrake.html) for PPA details.
#### Other Linux
For any other distribution, you must [compile from source](../developer/build-linux.html).
<!-- /.system-lin -->
<!-- .system-mac -->
### Mac
- OS X 10.7 Lion or later
- [VLC](https://www.videolan.org/vlc/) is recommended for previewing/playing MKV (Matroska) media files
<!-- /.system-mac -->
<!-- .system-win -->
### Windows
- Windows Vista (64-bit) with Service Pack 1 or later
- Microsoft .NET Framework 4.6 or later
- [VLC](https://www.videolan.org/vlc/) is recommended for previewing/playing media files
<!-- /.system-win -->

32
source/docs/en/1.0.0/technical/video-angles.markdown Normal file
View File

@ -0,0 +1,32 @@
---
Type: article
State: draft
Title: Source Angles
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Scott (s55) ]
Copyright: 2016 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
---
Source Angles
=============================
Some videos or movies have "multiple angles". This is where the same scene is shot from different camera angles.
HandBrake can read multiple video tracks from DVD and BluRay sources.
Under the source section, you will see a dropdown with the label "Angle" if your source type supports it.
You can choose which angle to encode to your output file.
HandBrake does not currently support multi-angle output.
<!-- .system-win -->
![Frame rate controls on Windows](../../images/windows/point-to-point-1.0.0.png "HandBrake's Angle Control.")
<!-- /.system-win -->

78
source/docs/en/1.0.0/technical/video-codecs.markdown Normal file
View File

@ -0,0 +1,78 @@
---
Type: article
State: draft
Title: Video Codecs
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Scott (s55) ]
Copyright: 2016 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 Codecs
============
 
- H.264 (x264): For MPEG-4 part 10, also known as H.264/AVC.
- This is HandBrakes default encoder. It provides excellent performance,
filesizes and quality.
- It is widely supported by players and mobile devices.
- H.264 (Intel QuickSync): For MPEG-4 part 10, also known as H.264/AVC.
- Available on Intel processors with Intel HD Graphics.
- QuickSync is a hardware based H.264 encoder so is very fast, with
significantly lower CPU usage than x264.
- Intel Haswell or newer CPU's are recommended as these offer the best
results in terms of Quality and Filesize.
- You can typically expect larger (but usually not significantly larger)
file sizes and slightly lower quality to an equivilent x264 encode. This
is a trade off that is fine for most.
- H.265 (x265): Also known as HEVC
- This is the next generation of encoder that offers even higher quality
encodes and better filesizes over H.264
- Note, encoding to H.265 is a significantly more complicated process, so
it is expected to be slower than HandBrake's H.264 encoders.
- Playback support is rather limited at the moment, particularly with
mobile devices but this should improve drastically throughout 2015/16
- MPEG-4 (ffmpeg): HandBrake offers FFmpeg's MPEG-4 part 2 encoder for fast,
low quality encoding.
- Better support from older devices such as DVD players and cheap "MP4
Players"
- Lower quality than the H.264 encode option but typically faster encodes.
- MPEG-2 (ffmpeg): HandBrake offers FFmpeg's MPEG-2 part 2 encoder for fast,
low quality encoding.
- Fast Encoding, but requires larger files than MPEG-4 for the same
quality level. Useful for testing but not much else.
- VP8 (Libvpx):
- A free and open video codec which offers significant improvements over
Theora.
- VP3 (Theora): HandBrake can also encode Theora video. Theora video with
Vorbis audio in the Matroska container represents a truly free option for
multimedia encoding.
- However, Theora has yet to reach maturity when measured by quality at a
given bitrate.

125
source/docs/en/1.0.0/technical/video-cq-vs-abr.markdown Normal file
View File

@ -0,0 +1,125 @@
---
Type: article
State: draft
Title: Constant Quality vs Average Bit Rate
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Scott (s55) ]
Copyright: 2016 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
---
Constant Quality vs Average Bit Rate
====================================
HandBrake supports two modes of encoding video.
- With the average bitrate, you control the size of the output file but give
up control over the video's quality.
- Constant quality mode does the opposite; you specify a quality level and
HandBrake adjusts the bitrate (that is, the size) to meet it.
## Constant Quality
### Benefits over Average Bitrate
- Faster Encoding - No need to do 2-Pass encoding (thus almost halving the
encode time.) Constant Quality can produce the same quality as a 2 pass
encode.
- Reduced file sizes Videos usually have a mix of complex and less complex
frames. (The latter requiring less bitrate to achieve a set quality level)
If less complex frames do not have bits wasted on them, your overall output
filesize is reduced without any loss of quality.
### Output File Sizes
Because it takes a different bitrate to reach a given quality level for any
given part of any movie, the output size is unpredictable and varies from source
to source.
Example: Given 2 sources of the same length, one could turn out to be 1.2GB, the
other 1.9GB. The difference can be more or less depending on the source. If your
source material is consistent, you will get roughly the same file sizes out for
each.
In particular, grainy sources tend to come out larger as they require a higher
bit-rate to maintain all that extra detail in the video. In this case, you may
try turning on the "Denoise" filter or reduce the RF value a few points.
You should also note that even if a file size is significantly smaller than a
counterpart encoded with target filesize, it does not mean it is any lower
quality. It's simply encoded more efficiently.
### x264 Recommended Quality RF Values
The Quality slider ranges from (Low Quality) 51 to 0 (High Quality) For good
quality output at reasonable file sizes, the following values are recommended:
Recommended settings for x264 are:
- Standard Definition (e.g DVD's) Use an RF value of around 20 +/- 1 As an
example using the AppleTV2 preset at RF20, with 20 different sources, the
average size was 925MB per hour of video. (Min: 625MB/h Max:1,503MB/hr)
- High Definition (e.g Blurays 720/1080) Use an RF value of 22 +/- 1 Since HD
sources are typically quality, you can get away with a slightly higher RF
value than SD content without any perceived difference in quality.
You should note that the quality slider is not linear for x264. It is
logarithmic (like the Richter or pH scales.) This means small movements in the
numbers can have large results. You can control the granularity of the slider in
the preferences / options.
You can encode a few chapters of a source to experiment with different quality
values if the above recommendations are not suitable. Encoding a 10minute sample
in the middle of your source should give you a good idea of what to expect.
### x264 and RF 0
RF 0 applies no compression. It is lossless: it compresses the source without
throwing away practically any detail.
So should you use RF 0 to perfectly preserve the source? Nope. Not at all. In
fact, you'll end up with video that's way larger than the DVD, but doesn't look
any better.
See, DVDs use lossy compression to squeeze down the raw video the studios use to
make them -- sort of like a quality level of RF 20. It throws away detail. When
HandBrake uncompresses the video prior to conversion, the quality lost when the
DVD was made is still gone. When you use RF 0 quality with x264, you're telling
it to losslessly preserve the decoded, uncompressed video feed, not to
losslessly preserve the DVD. Both have the same picture quality, but the
uncompressed feed takes up a lot more space.
To sum up: when converting from a DVD source, there is no reason to go above an
RF of \~19, which is roughly equivalent to how heavily the DVD is compressed. If
you do go higher, your output will be larger than your input!
### Recommended values for other encoders
[TODO]
## Average Bitrate
Unless you really need to aim for a target filesize (which we recommend
against), it is highly recommended that you use Constant Quality.
Bitrate is the number of bits dedicated to the video in a second. And remember,
that gets split between \~24-30 frames. When you set an average bitrate, the
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.
- 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
quality. Most of the time this loss is minimal and not appreciable by
the viewer.
- The downside is it can take up to twice as long to encode a file.

68
source/docs/en/1.0.0/technical/video-encoding-performance.markdown Normal file
View File

@ -0,0 +1,68 @@
---
Type: article
State: draft
Title: Video Encoding Speed
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Scott (s55) ]
Copyright: 2016 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 Encoding Speed
=============================
## How is encoding speed measured?
The speed at which your source is encoded is measured in frames per second (fps). That is, how many still images from your video are encoded each second?
So for example, if your encode is running at 100fps, and your source is a 25fps PAL DVD, then your encoding at 4x real time.
## What affects encoding speed?
There are many factors what affect encode performance. The hardware you are running on, the encoder settings you choose and source file itself.
### Hardware
The hardware you run on can have a large effect on performance. HandBrake can scale well up to 6 CPU cores with diminishing returns thereafter.
So a 4 Core CPU can be nearly twice as fast as a Dual Core equivalent.
HandBrake also supports encoding in Hardware with Intel QuickSync. This uses dedicated ASIC hardware on the processor to encode the video which leaves much of the CPU free for other tasks. This offers very high performance encoding at a reasonable quality if you have a Haswell or newer Intel Processor with HD Graphics on-board.
See our [System Requirements](../technical/system-requirements.html) for details on recommended hardware for running HandBrake.
### Settings
Settings play a large part in encoding performance. Most of the encoders expose many configuration options which allow you to tune the encoders. In HandBrake we've simplified this to a "Video Preset" slider. This offers a range of presets from Ultrafast to Placebo (which is very slow). This slider trades off speed vs quality and file size. Using faster presets and reduces quality OR increase file size. Using slower presets uses more complex algorithms to compress the video which takes more time offering an overall better result.
For x264 and x265, the Medium preset is a good trade off between quality, file size and speed but you can adjust this slider to suit your needs.
<!-- .system-win -->
![HandBrake's Video Quality Settings](../../images/windows/video-quality-1.0.0.png "HandBrake's Video Quality Settings")
<!-- /.system-win -->
Filters are another thing that has a big effect. Particularly if you use Denoise NLMeans. This is a very memory intensive operation so can drastically slow your encodes down. Again, there are settings for the filters that tune them for speed vs quality so you can see widely different results depending on what preset / tune you use.
<!-- .system-win -->
![HandBrake's Video Filter Settings](../../images/windows/video-quality-1.0.0.png "HandBrake's Video Filter Settings")
<!-- /.system-win -->
### Source
Your source will have an effect on performance in several ways.
For example, a 1080P HD video will take longer to encode using the same settings and hardware than a 576P file. This is because there are 5 times as many pixels to process in the 1080P file.
Another aspect that can affect performance is what the format of the input file is. For example the H.254 decoder is highly optimised but lesser used codecs may not be so well optimised. Within a codec, Baseline H.264 will be far quicker and less CPU intensive to decode than High Profile H.264. This is because the decoding algorithms used are simpler, this, you have more CPU time to spend on encoding.

149
source/docs/en/1.0.0/technical/video-qsv-options.markdown Normal file
View File

@ -0,0 +1,149 @@
---
Type: article
State: draft
Title: Intel QuickSync Encoder Options
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Scott (s55) ]
Copyright: 2016 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
---
Intel Quick Sync Video Advanced Configuration
==========================
Using the Advanced Options
--------------
From the command line, you can use the --encopts paramater as follows:
--encopts="option1=value1:option2=value2"
From the graphical user interface, just set the options in the dedicated text box:
option1=value1:option2=value2
Option Types
--------------
The following value types are supported (each option only accepts one value type):
- integer
A number that can be written without a fractional or decimal component.
- float
The finite decimal representation of a real number.
- boolean
0 means off (or disabled).
1 means on (or enabled).
Available Options
--------------
- target-usage (or tu) <integer>
- Sets the trade-off between quality and speed, from 1 (best quality) to 7 (best speed).
- Default: 2
- num-ref-frame (or ref) <integer>
- Number of reference frames, from 1 to 16.
- 0 means unspecified (set at runtime by the implementation).
- Default: 0 (unspecified)
- gop-ref-dist <integer>
- Distance between I or P reference frames, from 1 to 16.
- -1 means automatic (4 in constant QP mode, 3 otherwise).
- 0 means unspecified (set at runtime by the implementation).
- 1 means B-frames will not be used.
- Default: -1 (automatic)
- Note: may be sanitized to a lower value in some cases to avoid hangs.
- gop-pic-size (or keyint) <integer>
- Number of pictures within the current GOP (aka "keyframe interval").
- -1 means automatic (32 in constant QP mode, 1 second long otherwise).
- 0 means unspecified (set at runtime by the implementation).
- 1 means only I-frames will be used.
- 2 means B-frames will not be used.
- Default: -1 (automatic)
- cavlc <boolean>
- Use CAVLC instead of CABAC entropy coding. Reduces compression efficiency.
- It may improve encoding performance slightly, especially on older hardware.
- Note: you can also use ''cabac'' (same as ''cavlc'' with reversed meaning).
- Default: 0 (CAVLC off, CABAC on)
- b-pyramid <integer>
- Enables or disables "Pyramidal B-frames" which can improve compression efficiency.
- It may be incompatible with some playback devices (such as the first generation AppleTV).
- Note that this options modifies other parameters (gop-ref-dist, num-ref-frame, gop-pic-size).
- -1 means automatic (on in constant QP mode, off otherwise).
- 0 means off (disabled).
- 1 means on (enabled).
- Default: -1 (automatic)
- Caveats: requires hardware support (4th gen. Intel Core processor or equivalent), and driver support for version 1.6 of the Media SDK API.
- mbbrc <boolean>
- Enables macroblock-level bitrate control that generally improves subjective visual quality.
- It may have a negative impact on performance and objective visual quality metrics.
- Default: 1 (on)
- Note: not compatible with Constant QP or !LookAhead rate control methods (ignored).
- Caveats: requires hardware support (4th gen. Intel Core processor or equivalent), and driver support for version 1.6 of the Media SDK API.
- extbrc <boolean>
- Use extended bitrate control algorithms.
- It generally improves objective visual quality metrics and subjective visual quality,
- but can also lead to violation of HRD conformance and may significantly reduce performance.
- Default: 0 (off)
- Note: not compatible with Constant QP or !LookAhead rate control methods (ignored).
- Caveats: requires driver support for version 1.6 of the Media SDK API.
- trellis <integer>
- Enables trellis quantization.
- 0 means trellis is disabled.
- 1 means trellis is enabled for I-frames only.
- 2 means trellis is enabled for I and P-frames.
- 3 means trellis is enabled for all frames (I, P and B).
- Default: 0 (disabled)
- Note: ignored if the target-usage is too low (usually, only works in combination with tu=1).
- Caveats: requires hardware support (4th gen. Intel Core processor or equivalent), and driver support for version 1.7 of the Media SDK API.
- lookahead (or la) <boolean>
- Use the !LookAhead (LA or LA_ICQ) bitrate control algorithm.
- Default: 1 (on)
- Caveats: requires hardware support (4th gen. Intel Core processor or equivalent), and driver support for version 1.7 (1.8 for LA_ICQ) of the Media SDK API.
- lookahead-depth (or la-depth) <integer>
- If !LookAhead bitrate control is enabled, number of frames that are analyzed before encoding, from 11 to 60.
- Default: 40
- Note: may be sanitized to a lower value in some cases to avoid hangs.
- Caveats: requires hardware support (4th gen. Intel Core processor or equivalent), and driver support for version 1.7 of the Media SDK API.
- force-cqp <boolean>
- In Constant Quality mode, use Constant QP rate control, even if Intelligent Constant Quality is available.
- Default: 0 (ICQ enabled if available)
- cqp-offset-i <integer> | cqp-offset-p <integer> | cqp-offset-b <integer>
- In constant QP (CQP) bitrate control mode, specify offset from the global quality/QP value for I, P and B-frames.
- Defaults are 0, 2 and 4, respectively.
- vbv-maxrate <integer>
- Sets the maximum rate the VBV buffer should be assumed to refill at, in kilobits per second (Kbps).
- Default: 0 (set at runtime by the implementation)
- Note: not compatible with Constant QP, Intelligent Constant Quality or !LookAhead rate control methods (ignored).
- vbv-bufsize <integer>
- Sets the size of the VBV buffer in kilobits (Kb).
- Default: 0 (set at runtime by the implementation)
- Note: not compatible with Constant QP, Intelligent Constant Quality or !LookAhead rate control methods (ignored).
- vbv-init <float>
- Sets how full the VBV Buffer must be before playback starts.
- If it is less than 1, then the initial fill is: vbv-init * vbv-bufsize.
- Otherwise it is interpreted as the initial fill in kilobits (Kb).
- Default: 0 (set at runtime by the implementation)
- Note: not compatible with Constant QP, Intelligent Constant Quality or !LookAhead rate control methods (ignored).

58
source/docs/en/1.0.0/technical/video-x264-presets-tunes.markdown Normal file
View File

@ -0,0 +1,58 @@
---
Type: article
State: draft
Title: x264 Presets and Tunes
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Scott (s55) ]
Copyright: 2016 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
---
x264 Presets and Tunes
======================
## x264 Presets
x264 exposes a preset and tune system. Presets range from:
- UltraFast - Very high speed encoding, but requires much higher bit-rates to
maintain quality. This means you can expect much larger file sizes.
- Placebo - Extremely slow encoding but provides the best Quality and/or
filesize for a given source. - This option is often considered a placebo
because it offers diminishing returns in terms of quality and filesize.
Typically, it's recommended to use the Very Fast to Slow settings range for best
results, or one of the slower options if you don't mind the speed loss. Medium
is a good balance and most of HandBrakes presets use this option.
## x264 Tunes
The x264 tune options assign some additional options which will optimize the
encoder for certain types of content.
If you are unsure or your content doesn't really fit into one of the following
tunes, you can simply leave this option at "None".
- Film
- Real life footage, films etc may benefit. (Not Cartoons or Anime).
Typically won't do any harm to if left on for most content.
- Animation
- Used for hand-drawn animated content.
- Grain
- Typically used for very grainy or old content.
- Still Image
- Can be used for Slideshows, Presentations etc where there is very little
moving content.
- PSNR
- Used for benchmarking quality. Should not be used for normal use.
- SSIM
- Used for benchmarking quality. Should not be used for normal use.
- Fast Decode
- Optimise for faster decoding. Useful for low power devices that struggle
to decode the video.

71
source/docs/en/1.0.0/technical/video-x264-profiles-levels.markdown Normal file
View File

@ -0,0 +1,71 @@
---
Type: article
State: draft
Title: x264 Profiles and Levels
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Scott (s55) ]
Copyright: 2016 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
---
Profiles and Levels
==========================
H.264 profiles
--------------
Define the features / capabilities that the encoder can use.
HandBrake exposes 3 profiles for H.264 Encodes. You can think of the profile as
the level of complexity required in encode / decode. The higher the complexity,
the more CPU power is needed to encode/decode. Setting a profile, constrains the
encode to using settings that are allowed for that profile level.
Typically, devices will advertise that they are compatible for a particular
profile and level, so you can simply set the option that matches your device for
the best chance of compatibility.
- Auto (Recommended)
- This will automatically set the profile based on all the options that
have been selected.
- It is recommended that you use this option unless you need to set a
profile to ensure compatibility for a particular device.
- Baseline
- Baseline encodes are the most basic form of encoding. While decoding is
much easier, it may also require much higher bit-rates to maintain the
same level of quality.
- Main
- The middle ground. Most modern / current devices will support this
profile.
- High Profile
- For best quality and filesize at the expense of CPU time in both decode
and encode.
Note that setting a profile does not mean your encoded file will end up being
that profile. It simply prevents options being used that would breach that
profile constraint.
H.264 Levels
------------
The levels are another form of constraints that define things like maximum
bitrates, framerates and resolution etc. The wikipedia article lists the
relevant information for each level.
https://en.wikipedia.org/wiki/H.264/MPEG-4_AVC#Levels
Most devices (and sometimes, software decoders) support a "maximum" level. When
the video's specifications exceed that level's constraints, the decoder won't be
able to decode the video properly (it may simply refuse to play the file).
HandBrake's H.264 encoder, x264, sets the appropriate level automatically based
on all the other settings. To make sure your video doesn't exceed a specific
level, you simply have to make sure the other parameters fit within the
constraints imposed by the level.
It is recommended that you leave this setting on "Auto" unless you require to
set it for device compatibility.

72
source/docs/en/1.0.0/workflow/adjust-quality.markdown Normal file
View File

@ -0,0 +1,72 @@
---
Type: article
Title: Adjusting quality
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS) ]
Copyright: 2016 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
---
Adjusting quality
=================
HandBrake's default settings and most of the official `Presets` use a constant quality encoding method. This makes your new video look consistent from start to finish. Always use constant quality unless you have a specific reason not to.
You can use the default setting for the `Preset` you selected, or adjust the quality control higher or lower depending on your tastes. Increasing quality will make your new video take up more space on your computer or playback device, whereas reducing quality will typically make your new video take up less space.
## Using the quality control
Most of HandBrake's official `Presets` use the x264 video encoder and a constant quality setting between [RF](abbr:Rate Factor) 18 and 24. A lower RF number means *higher* quality.
To increase video quality, adjust the quality control toward the right. To reduce video quality, adjust the quality control toward the left.
<!-- .system-mac -->
![Using the constant quality control](../../images/mac/quality-control-1.0.0.png "Adjust the quality control toward the right to increase quality, or toward the left to lower it.")
<!-- /.system-mac -->
Begin by making small adjustments. Plus or minus 1-2 RF is usually noticeable.
## Recommended quality settings
Recommended settings for **x264** and **x265** encoders:
- RF 18-22 for 480p/576p Standard Definition[^SD]
- RF 19-23 for 720p High Definition[^720p]
- RF 20-24 for 1080p Full High Definition[^1080p]
- RF 22-28 for 2160p 4K Ultra High Definition[^2160p]
Raising quality minus 1-2 RF may produce better results when encoding animated `Sources` (anime, cartoons). Lower quality settings may be used to produce smaller files. Drastically lower settings may show significant loss of detail.
Using higher than recommended quality settings can lead to *extremely large files* that may not be compatible with your devices. When in doubt, stick to the recommended range or use the default setting for the `Preset` you selected.
## Display size and viewing distance
Imperfections tend to be more noticeable at larger display sizes and closer viewing distances. This is especially true for lower resolution videos (less than 720p), which are typically scaled or "blown up" to fill your display, magnifying even minor imperfections in quality.
You may wish to slightly increase quality for viewing on larger displays (50 inches / 125 cm diagonal or greater), or where viewing from closer than average distances[^viewing-distance]. Reduced quality may be acceptable for viewing on smaller screens or where storage space is limited, e.g. mobile devices.
<!-- .continue -->
## Next steps
Continue to [Previewing your settings](preview-settings.html).
<!-- /.continue -->
[^SD]: [SD](abbr:Standard Definition) video has a resolution of 720x480 or fewer pixels (720x576 for PAL). DVDs, small web videos, and most analog sources are SD.
[^720p]: 720p [HD](abbr:High Definition) video has a resolution of 1280x720 pixels. With three times the resolution of SD, and about half that of 1080p HD, 720p HD is commonly used by consumer video cameras, web videos, and broadcast TV sports.
[^1080p]: 1080p [HD](abbr:High Definition) video has a resolution of 1920x1080 pixels—twice the resolution of 720p and six times the resolution of 480p. 1080p HD video is commonly used by mobile phones and tablets, consumer and professional video cameras, and Blu-ray.
[^2160p]: 2160p [UHD](abbr:Ultra High Definition) video has a resolution of 3840x2160 pixels and is four times the resolution of 1080p. 4K video is used by high-end mobile phones and tablets, consumer and professional video cameras, and 4K Blu-ray.
[^viewing-distance]: Learn more about [optimum viewing distances for high definition TV displays](https://en.wikipedia.org/wiki/Optimum_HDTV_viewing_distance).

132
source/docs/en/1.0.0/workflow/open-video-source.markdown Normal file
View File

@ -0,0 +1,132 @@
---
Type: article
Title: Opening a video source
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS) ]
Copyright: 2016 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
---
Opening a video source
======================
Once you've [downloaded and installed HandBrake](../get-handbrake/download-and-install.html), it's time to open a video for encoding.
## About sources
In HandBrake terms, the video you already have is called the `Source`. One of HandBrake's strengths is its ability to open `Sources` in a wide variety of video formats, including but not limited to:
- Videos made by mobile phones, tablets, and many video cameras and DSLRs
- Screen and game recordings, web videos, video editing projects[^consumer-editor-export], and other computer-related sources
- Professional video production formats including ProRes and DNxHD
- DVD, Blu-ray, AVCHD/AVCHD Lite[^avchd-partial-support], and HD-DVD[^hddvd-partial-support] discs or disc backups
- Broadcast TV recordings
- Digital recordings of VHS, Beta, Video8/Hi8, LaserDisc, and other analog sources
You can learn more about [Source formats](../technical/source-formats.html) in the technical documentation.
**Note:** HandBrake does not defeat or circumvent [copy protection](https://en.wikipedia.org/wiki/Copy_protection) of any kind. It does not work with video files employing [[DRM](https://en.wikipedia.org/wiki/Digital_rights_management)](abbr:Digital Rights Management). See [About HandBrake](../introduction/about.html) for more information about what HandBrake *does* and *does not*.
## Ways to open a video source
By default, HandBrake presents the `Open Source` dialog on launch. It is also accessable from the `Toolbar` at the top of HandBrake's main window.
<!-- .system-lin -->
<!-- TODO: Linux figures. -->
<!-- /.system-lin -->
<!-- .system-mac -->
![Main window toolbar](../../images/mac/toolbar-1.0.0.png "The Toolbar provides easy access to HandBrake's most common functions.")
![Open Source button](../../images/mac/open-source-button-1.0.0.png "The Open Source button opens the Open Source dialog.")
<!-- /.system-mac -->
<!-- .system-win -->
<!-- TODO: Windows figures. -->
<!-- /.system-win -->
Select the `Open Source` button to select the video you want to open.
You can also drag and drop a video `Source` onto HandBrake's main window.
<!-- .system-lin -->
<!-- TODO: Linux figures. -->
<!-- /.system-lin -->
<!-- .system-mac -->
![Open Source dialog](../../images/mac/open-source-dialog-1.0.0.png "The Open Source dialog allows you to browse your files for a video to open.")
![Opening a video source via drag and drop](../../images/mac/open-source-drag-drop-1.0.0.png "In addition to the Open Source dialog, you may also open a video by dragging it to HandBrake's main window.")
<!-- /.system-mac -->
<!-- .system-win -->
<!-- TODO: Windows figures. -->
<!-- /.system-win -->
HandBrake will scan your selection and after a few moments, the main window will show the file name of the `Source` you opened along with some additional information.
<!-- .system-lin -->
<!-- TODO: Linux figures. -->
<!-- /.system-lin -->
<!-- .system-mac -->
![Successfully opened source](../../images/mac/open-source-success-1.0.0.png "HandBrake's main window after sucessfully opening a source.")
<!-- /.system-mac -->
<!-- .system-win -->
<!-- TODO: Windows figures. -->
<!-- /.system-win -->
Some `Sources` may contain more than one video clip, or a collection of `Titles`. Blu-ray and DVD `Sources` often have multiple `Titles`. Use HandBrake's `Title` control to select which video clip you want to use.
<!-- .system-lin -->
<!-- TODO: Linux figures. -->
<!-- /.system-lin -->
<!-- .system-mac -->
![Selecting a title](../../images/mac/title-selection-1.0.0.png "Some sources may contain more than one video clip. The title control lets you select which video clip you want to use.")
<!-- /.system-mac -->
<!-- .system-win -->
<!-- TODO: Windows figures. -->
<!-- /.system-win -->
Great! At this point, HandBrake knows which video you want to use.
<!-- .continue -->
## Next steps
If HandBrake didn't open your video as as expected or you had some other trouble, you can continue reading to learn more about how HandBrake works or jump right to [Troubleshooting common issues](../help/troubleshooting-common-issues.html).
Continue to [Selecting a preset](select-preset.html).
<!-- /.continue -->
[^consumer-editor-export]: Videos made using consumer video editing software such as [iMovie](https://www.apple.com/mac/imovie/) must first be exported to a common video format for compatibility with HandBrake.
[^avchd-partial-support]: AVCHD and AVCHD Lite playlists are not fully supported. Individual files/streams may work.
[^hddvd-partial-support]: HD-DVD playlists are not fully supported. Individual files/streams may work.

81
source/docs/en/1.0.0/workflow/preview-settings.markdown Normal file
View File

@ -0,0 +1,81 @@
---
Type: article
Title: Previewing your settings
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS) ]
Copyright: 2016 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
---
Previewing your settings
========================
Video encoding requires a lot of computer resources and can take awhile to complete.
HandBrake's `Preview` feature allows you to perform a test run on a small portion of your `Source`, so you can see what your new video will look like without encoding all of it.
## Opening the Preview window
At the top of HandBrake's main window, you'll see a toolbar with various buttons.
<!-- .system-mac -->
![Main window toolbar](../../images/mac/toolbar-1.0.0.png "The Toolbar provides easy access to HandBrake's most common functions.")
![Opening the Preview window](../../images/mac/preview-button-1.0.0.png "The Preview button opens a window where you can test your settings.")
<!-- /.system-mac -->
Select the `Preview` button to open the `Preview` window.
## Adjusting Preview settings
Move your mouse cursor over the `Preview` window, and some controls will appear.
<!-- .system-mac -->
![Preview window](../../images/mac/preview-window-1.0.0.jpg "HandBrake's Preview feature lets you test your settings on a small portion of your Source.")
![Preview controls](../../images/mac/preview-controls-1.0.0.png "You can set the starting position and duration of your Preview.")
<!-- /.system-mac -->
Set the starting position by dragging the `Position` control left or right, and choose how many seconds of video you want to encode using the `Duration` control.
## Starting a Preview encode
When you're satisfied with your starting position and duration, select `Live Preview` and be patient. HandBrake will report its progress while it works.
<!-- .system-mac -->
![Preview progress indicator](../../images/mac/preview-progress-1.0.0.png "HandBrake will report its progress while encoding your Preview.")
![Preview playback controls](../../images/mac/preview-controls-playback-1.0.0.png "Playback controls allow you to interact with your Preview when it's ready.")
<!-- /.system-mac -->
When your `Preview` is ready, the controls are updated to let you play, pause, and rewind your video. You can also adjust the audio volume, and in some cases, choose which audio track plays.
<!-- .system-mac -->
To create a new `Preview`, select the `╳` button to start over.
<!-- /.system-mac -->
When you're finished previewing your work, you may close the `Preview` window.
<!-- .continue -->
## Next steps
If the `Preview` you created was lacking in quality or otherwise not as expected, you may need to [adjust quality](adjust-quality.html) or select a different [Preset](select-preset.html), after which you can create another `Preview` to see any changes.
Once you are satisfied, continue to [Starting encoding](start-encoding.html).
<!-- /.continue -->

57
source/docs/en/1.0.0/workflow/select-preset.markdown Normal file
View File

@ -0,0 +1,57 @@
---
Type: article
Title: Selecting a preset
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS) ]
Copyright: 2016 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
---
Selecting a preset
==================
A `Preset` is a group of settings specifically tailored for the software or device you want your videos to play on. Selecting a `Preset` can go a long way toward ensuring your video works where you want it to.
## Official presets
HandBrake includes a number of official `Presets` for specific devices and for general use.
Once you've opened a `Source`, select the `Preset` that most closely describes the device you want your videos to work on. For instance, if you want to play your videos on a Roku that supports 1080p High Definition, choose the `Roku 1080p30 Surround` preset under `Devices`. See the technical documentation for more information about [official presets](../technical/official-presets.html).
<!-- .system-lin -->
<!-- TODO: Linux figures. -->
<!-- /.system-lin -->
<!-- .system-mac -->
![Selecting a preset](../../images/mac/preset-selection-1.0.0.png "Presets are one-click settings to save you time and help ensure compatibility with your devices.")
<!-- /.system-mac -->
<!-- .system-win -->
<!-- TODO: Windows figures. -->
<!-- /.system-win -->
If your device is not listed, or you wish to play your videos on a computer, the default `Fast 1080p30` preset is a good choice. It's fast and compatible across a wide range of software and devices.
## Custom presets
If you've previously saved one of your own `Presets`, you may select it in the same way as the official `Presets`.
You can learn more about [Custom presets](../advanced/custom-presets.html) in the advanced features section.
<!-- .continue -->
## Next steps
Continue to [Adjusting quality](adjust-quality.html).
<!-- /.continue -->

77
source/docs/en/1.0.0/workflow/start-encoding.markdown Normal file
View File

@ -0,0 +1,77 @@
---
Type: article
Title: Starting encoding
Project: HandBrake
Project_URL: https://handbrake.fr/
Project_Version: Latest
Language: English
Language_Code: en
Authors: [ Bradley Sepos <bradley@bradleysepos.com> (BradleyS) ]
Copyright: 2016 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
---
Starting encoding
=================
Now that you've got all your settings just right, it's time to make your new video!
## Selecting a destination
`Destination` is where your new video will go. You can select the `Browse...` button to choose a new location and name, or type it directly in the box.
<!-- .system-mac -->
![Selecting a destination](../../images/mac/destination-field-1.0.0.png "Destination is where HandBrake will put your new video.")
![Browsing for a destination](../../images/mac/destination-dialog-1.0.0.png "Select the Browse button to choose a different location and name.")
<!-- /.system-mac -->
Please take special care to *note your destination*. Otherwise, you won't be able to find your new video. You can move it later if you desire.
## Starting the encode
Select the `Start` button on the toolbar to make your new video.
<!-- .system-mac -->
![Main window toolbar](../../images/mac/toolbar-1.0.0.png "The Toolbar provides easy access to HandBrake's most common functions.")
![Starting an encode](../../images/mac/start-button-1.0.0.png "The Start button begins encoding your new video.")
<!-- /.system-mac -->
Video encoding requires a lot of computer resources and can take awhile to complete. Some videos may take minutes to create; others may take hours.[^encoding-time]
<!-- .system-mac -->
![Encode progress](../../images/mac/encode-progress-1.0.0.png "HandBrake reports its progress during encoding.")
![Encoding complete alert](../../images/mac/encode-complete-1.0.0.png "HandBrake shows an alert when finished encoding.")
<!-- /.system-mac -->
HandBrake will report its progress while it's working and alert you when it's finished. Then you will have a new video file at the `Destination` you specified.
<!-- .system-mac -->
![Destination in Finder](../../images/mac/destination-finder-1.0.0.png "Your new video is located at the Destination you specified.")
<!-- /.system-mac -->
Congratulations! You just encoded your first video using HandBrake. It's now ready to watch on your devices.
<!-- .continue -->
## Next steps
If you didn't get a video file as expected, encountered an error, or had some other trouble, you can continue reading to learn more about how HandBrake works or jump right to [Troubleshooting common issues](../help/troubleshooting-common-issues.html).
Continue to [Multiple encodes using the Queue](../advanced/queue.html).
<!-- /.continue -->
[^encoding-time]: Encoding time depends on multiple factors, including the duration, resolution, and complexity of your `Source`; the settings used to make your new video; and the speed and computation power of your machine.

2
source/docs/en/index.markdown
View File

@ -20,7 +20,7 @@ English documentation is currently available for the following HandBrake version
Releases:
- None (in progress)
- [HandBrake 1.0.0](1.0.0/)
Nightly and snapshot builds: