docs: 1.8 documentation.

HandBrake · Nov 3, 2024 · e5fdbc0 · e5fdbc0
1 parent 56bd281
commit e5fdbc0
Show file tree

Hide file tree

Showing 87 changed files with 7,851 additions and 1 deletion.
diff --git a/source/docs/en/1.8.0/about/history.markdown b/source/docs/en/1.8.0/about/history.markdown
@@ -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:       2023 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 hosted by titer and the development team remains in contact; however, he is not active in the day-to-day running or development of the project.
+
diff --git a/source/docs/en/1.8.0/about/the-icon.markdown b/source/docs/en/1.8.0/about/the-icon.markdown
@@ -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:       2023 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
+=============================
diff --git a/source/docs/en/1.8.0/advanced/audio-subtitle-defaults.markdown b/source/docs/en/1.8.0/advanced/audio-subtitle-defaults.markdown
@@ -0,0 +1,88 @@
+---
+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:       2023 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 "Selection Behaviour" button on the Audio or Subtitle Defaults tab.
+
+![Audio Defaults Access Button](../../images/windows/audio-configure-defaults-button-win-1.4.0.png "Audio Defaults Window")
+
+### Audio Defaults
+
+<!-- .system-macos -->
+![Audio Defaults Window](../../images/mac/audio-defaults-mac-1.4.0.png "Audio Defaults Window")
+<!-- /.system-macos -->
+<!-- .system-windows -->
+![Audio Defaults Window](../../images/windows/audio-defaults-win-1.8.0.png "Audio Defaults Window")
+<!-- /.system-windows -->
+
+- 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".
+
+- Languages
+  - Select the languages you wish to encode. Note that not all sources will have track languages. You may also have to use the "Unknown" option or "Any" options to have tracks added in that case.
+
+- Auto Passthru
+  - HandBrake can pass thru several different audio formats. There are separate options the audio encoder dropdown for these. When you select "Auto Passthru", it will pass thru any of those supported types.  You can limit what it will automatically passthru. For example, if you only ever want AC3 or DTS passthru, but not any of the other choices, untick the relevant checkboxes.
+
+- Fallback Encoder
+  - When you have a passthru encoder selected, if the source track format does not match this format, HandBrake will automatically re-encode the track. The fallback encoder is the default encoder it will fallback to.  
+
+- Track Layout
+  - You can define the audio tracks you want added for each language in the track entry panel at the bottom of the window.
+  - When selecting a passthru encoder, the Bitrate, mixdown, samplerate controls apply to the fallback encoder should that be used instead of the passthru option selected. 
+
+### Subtitle Defaults
+
+<!-- .system-macos -->
+![Subtitle Defaults Window](../../images/mac/subtitle-defaults-mac-1.4.0.png "Audio Defaults Window")
+<!-- /.system-macos -->
+<!-- .system-windows -->
+![Subtitle Defaults Window](../../images/windows/subtitle-defaults-win-1.4.0.png "Subtitle Defaults Window")
+<!-- /.system-windows -->
+
+- 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. 
diff --git a/source/docs/en/1.8.0/advanced/chapter-markers.markdown b/source/docs/en/1.8.0/advanced/chapter-markers.markdown
@@ -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:       2023 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 chapter markers from your source to the MP4, MKV, or WebM output file.
+
+In HandBrake, if you click on the Chapters tab, you'll see a list of detected chapters. HandBrake will automatically generate chapter names in the following format:  "Chapter n" where n is the chapter number.
+
+![Chapters Tab](../../images/windows/chapters-1.8.0.png "Chapters Tab")
+
+## Renaming chapters
+
+If you wish, you can rename these by 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 (Comma Separated Value) 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
+
+Unfortunately, HandBrake can not currently add chapter markers if they did not already exist in the source.
diff --git a/source/docs/en/1.8.0/advanced/custom-presets.markdown b/source/docs/en/1.8.0/advanced/custom-presets.markdown
@@ -0,0 +1,57 @@
+---
+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:       2023 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.
+
+On the main window, below the title selection controls, you can click the "Save New Preset" button to create your own preset.
+
+<!-- .system-linux -->
+<!-- /.system-linux -->
+<!-- .system-macos -->
+![macOS Preset Controls](../../images/windows/preset-controls-mac-1.4.0.png "Preset Controls (macOS)")
+<!-- /.system-macos -->
+<!-- .system-windows -->
+![Windows Preset Controls](../../images/windows/preset-controls-win-1.8.0.png "Preset Controls (Windows)")
+<!-- /.system-windows -->
+
+When you've pressed this button, you'll see the following window appear:
+
+<!-- .system-macos -->
+![macOS Add Preset](../../images/windows/add-preset-mac-1.4.0.png "Add Preset (macOS)")
+<!-- /.system-macos -->
+<!-- .system-windows -->
+![Windows Add Prese](../../images/windows/add-preset-win-1.8.0.png "Add Preset (Windows)")
+<!-- /.system-windows -->
+
+Pressing "add" will save a new preset with the details you've entered based on the settings that are currently on the main window. 
+
+
+## Audio and Subtitles Beavhiours 
+
+Audio and Subtitle settings are special. The preset does not store selected audio and subtitle tracks from the main window. It uses rules to automatically select them for each new source or title that you selected.
+You can modify these rules by editing the settings on the relevant "selection behaviour" screen.
+
+Please note, these rules do not cover all possible use cases. If the behaviours don't meet your requirements, audio and subtitle tracks will need to be handled manually after you've scanned a source. 
+
+For more information, please see [Audio and Subtitle Defaults](../workflow/audio-subtitle-defaults.html).
+
+## Default Preset
+
+If you regularly use the same preset, you can make it the default preset that HandBrake starts with by selecting the "Make Default" (macOS) or "Set Current as Default" (Window) option in the presets menu or by using the preset manager accessed via the toolbar.
+
diff --git a/source/docs/en/1.8.0/advanced/managing-audio.markdown b/source/docs/en/1.8.0/advanced/managing-audio.markdown
@@ -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:       2023 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
diff --git a/source/docs/en/1.8.0/advanced/point-to-point.markdown b/source/docs/en/1.8.0/advanced/point-to-point.markdown
@@ -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:       2023 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 instead 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.
diff --git a/source/docs/en/1.8.0/advanced/post-processing.markdown b/source/docs/en/1.8.0/advanced/post-processing.markdown
@@ -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:       2023 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