kenzuya/unshackle
1
0
Fork 2
mirror of https://github.com/unshackle-dl/unshackle.git synced 2026-11-12 20:15:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Deployed 2873cf4c with MkDocs version: 1.6.1

Browse Source
This commit is contained in:
2026-11-11 00:53:46 +00:00
parent 57fb0d9d87
commit 674572d526
8 changed files with 171 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files
guide/output-and-naming/index.html
+13 -2
View File
@@ -3285,7 +3285,7 @@ Without MP4Box installed the mux stops.</p>
<p>DTS:X Profile 1 is DTS-HD Master Audio and muxes to MKV as usual.</p>
<p>An MP4 title loses:</p>
<ul>
<li>the forced, hearing-impaired and original track flags</li>
<li>the default, forced, hearing-impaired and original track flags</li>
<li>attachments, such as subtitle fonts</li>
<li>SubStation Alpha (<code>.ass</code>) subtitles</li>
<li>container tags (<code>mkvpropedit</code>)</li>
@@ -3333,9 +3333,20 @@ Without MP4Box installed the mux stops.</p>
<td><em>(unset)</em></td>
<td>Preferred language per track type (<code>video</code> / <code>audio</code> / <code>subtitle</code>). A track in the preferred language is flagged as the default track.</td>
</tr>
<tr>
<td><code>default_subtitle_type</code></td>
<td>str or list</td>
<td><em>(unset)</em></td>
<td>The subtitle types that can take the default flag, in order: <code>forced</code>, <code>normal</code>, <code>sdh</code> (CC counts as SDH). The first subtitle track of the first type that the title has gets the flag.</td>
</tr>
</tbody>
</table>
<p>When no track has the preferred language, unshackle applies sensible defaults. The video default falls back to the title language, then the original-language track, then the first track. The audio default is the original-language track. The subtitle default is a forced track in the first audio's language.</p>
<p>When no track has the preferred language, unshackle applies sensible defaults. The video default falls back to the title language, then the original-language track, then the first track. The audio default is the original-language track. The subtitle default is a forced track in the language of the default audio track.</p>
<p>Set <code>default_subtitle_type</code> to give the subtitle default to a different type. <code>default_subtitle_type: normal</code> with <code>default_language.subtitle: pl</code> puts the flag on the full Polish track when the title also has a forced Polish track. Without <code>default_language.subtitle</code>, the first track of the type in file order gets the flag, and a forced track counts only in the language of the default audio track. When the title has no track of a listed type, the rules above apply.</p>
<div class="admonition tip">
<p class="admonition-title">Use <code>normal</code> for players that read the forced flag</p>
<p>A forced track always carries the Matroska forced flag. A player that reads it, such as mpv or Jellyfin in its Smart mode, shows the forced track when the audio is in your subtitle language and the default track when it is not. <code>default_subtitle_type: forced</code> puts the default flag on the forced track, and such a player then shows it in place of the full track.</p>
</div>
<div class="admonition note">
<p class="admonition-title"><code>default_language</code> only sets the default-track flag</p>
<p><code>default_language</code> controls <strong>which track carries the MKV <code>--default-track</code> flag</strong>. Nothing else. It does not change track <em>selection</em> (that stays with <code>-l</code>/<code>--a-lang</code> and friends). It also does not touch which track carries the original flag: <code>--original-flag</code> still tags the <em>true</em> original-audio track. That is the point: you can make your player default to, say, Polish audio on an English-original title without altering the original marker. When the configured language is not present in the manifest, each track type falls back to its normal default rule described above.</p>
guide/subtitles/index.html
+3 -1
View File
@@ -2666,7 +2666,9 @@ with a warning.</p>
flags drive selection, sort order, output filenames, and the Matroska track flags.</p>
<ul>
<li><strong>Forced</strong>: only signs and foreign dialogue, meant to play when the audio language
matches. Off by default. Enable it with <code>--forced-subs</code>.</li>
matches. Off by default. Enable it with <code>--forced-subs</code>. To choose which type gets the
default flag in the file, set
<a href="../../reference/configuration/download/#muxing"><code>muxing.default_subtitle_type</code></a>.</li>
<li><strong>SDH</strong> (Subtitles for the Deaf and Hard-of-Hearing, also called HOH): a full
transcript that includes both dialogue and non-speech sound cues.</li>
<li><strong>CC</strong> (Closed Captions): captions originating from an EIA-608/708 broadcast stream,
objects.inv
BIN
View File
Binary file not shown.
reference/api/tracks/index.html
+97
View File
@@ -2335,6 +2335,17 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.tracks.Subtitle.kind" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code>&nbsp;kind
</span>
</a>
</li>
<li class="md-nav__item">
@@ -3112,6 +3123,17 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.tracks.Tracks.default_subtitle_index" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code>&nbsp;default_subtitle_index
</span>
</a>
</li>
<li class="md-nav__item">
@@ -3885,6 +3907,17 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.tracks.Subtitle.kind" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code>&nbsp;kind
</span>
</a>
</li>
<li class="md-nav__item">
@@ -4662,6 +4695,17 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.tracks.Tracks.default_subtitle_index" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code>&nbsp;default_subtitle_index
</span>
</a>
</li>
<li class="md-nav__item">
@@ -6534,6 +6578,30 @@ explanation list above.</p>
</div>
<div class="doc doc-object doc-attribute">
<h3 id="unshackle.core.tracks.Subtitle.kind" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">kind</span>
<span class="doc doc-labels">
<small class="doc doc-label doc-label-property"><code>property</code></small>
</span>
<a href="#unshackle.core.tracks.Subtitle.kind" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="n">kind</span>
</span></code></pre></div>
<div class="doc doc-contents ">
<p>The subtitle type that the config names: "forced", "sdh" (CC counts as SDH) or "normal".</p>
</div>
</div>
@@ -8926,6 +8994,35 @@ resolutions get a base only when a DV track can give it an RPU, or with <code>ge
<div class="doc doc-object doc-function">
<h3 id="unshackle.core.tracks.Tracks.default_subtitle_index" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">default_subtitle_index</span>
<span class="doc doc-labels">
<small class="doc doc-label doc-label-staticmethod"><code>staticmethod</code></small>
</span>
<a href="#unshackle.core.tracks.Tracks.default_subtitle_index" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">default_subtitle_index</span><span class="p">(</span>
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">subtitles</span><span class="p">,</span> <span class="n">language</span><span class="p">,</span> <span class="n">types</span><span class="p">,</span> <span class="n">audio_language</span><span class="o">=</span><span class="kc">None</span>
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="p">)</span>
</span></code></pre></div>
<div class="doc doc-contents ">
<p>The index of the first subtitle of the first type in <code>types</code> that a track has.</p>
<p><code>language</code> limits the choice to the tracks it asks for. With no <code>types</code>, or no track
of a listed type, the first track in <code>language</code> is the answer. With no <code>language</code>, a
forced track counts only in <code>audio_language</code>, because it adds to that audio alone.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="unshackle.core.tracks.Tracks.mux" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">mux</span>
reference/configuration/download/index.html
+19 -9
View File
@@ -2666,18 +2666,21 @@ it ignores entries that are not valid language tags.</p>
that flag.</p>
</div>
<div class="admonition note">
<p class="admonition-title"><code>type_priority</code> picks the default subtitle only with <code>muxing.default_language</code></p>
<p class="admonition-title"><code>type_priority</code> alone does not pick the default subtitle</p>
<p>At mux time the <code>default</code> flag goes to every forced subtitle whose language matches the
first audio track, so a full dialogue track never becomes default on its own.
<code>type_priority</code> alone does not change that. Name a subtitle language in
<a href="#muxing"><code>muxing.default_language</code></a> and the first track in that language gets the flag
instead, which is where <code>type_priority</code> decides which track that is:</p>
default audio track, so a full dialogue track never becomes default on its own.
<code>type_priority</code> changes the order of the tracks in the file. It decides the flag only
between the tracks of one language, when you set <code>muxing.default_language.subtitle</code>. Set
<a href="#muxing"><code>muxing.default_subtitle_type</code></a> to name the type that gets the flag:</p>
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="nt">muxing</span><span class="p">:</span>
</span><span id="__span-7-2"><a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a><span class="w"> </span><span class="nt">default_language</span><span class="p">:</span>
</span><span id="__span-7-3"><a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a><span class="w"> </span><span class="nt">subtitle</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">en</span>
</span><span id="__span-7-4"><a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a><span class="nt">subtitle</span><span class="p">:</span>
</span><span id="__span-7-5"><a id="__codelineno-7-5" name="__codelineno-7-5" href="#__codelineno-7-5"></a><span class="w"> </span><span class="nt">type_priority</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">normal</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="nv">sdh</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="nv">forced</span><span class="p p-Indicator">]</span>
</span><span id="__span-7-2"><a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a><span class="w"> </span><span class="nt">default_subtitle_type</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">normal</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="nv">sdh</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="nv">forced</span><span class="p p-Indicator">]</span>
</span><span id="__span-7-3"><a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a><span class="w"> </span><span class="nt">default_language</span><span class="p">:</span>
</span><span id="__span-7-4"><a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a><span class="w"> </span><span class="nt">subtitle</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">en</span>
</span></code></pre></div>
<p>Here the flag goes to the full English track, then to the English SDH track when the
title has no full one, then to the forced one. Without <code>default_language.subtitle</code>, the
first track of the type in file order gets the flag, in any language. A forced track is
the exception: it gets the flag only in the language of the default audio track.</p>
</div>
<h2 id="audio"><code>audio</code><a class="headerlink" href="#audio" title="Permanent link">&para;</a></h2>
<ul>
@@ -2731,6 +2734,12 @@ bitrate alone, with those same Atmos/descriptive rules still applied.</p>
<td>Force which language is flagged <em>default</em> per track type, e.g. <code>{audio: en, subtitle: en}</code>. A tag with a region, such as <code>en-US</code>, matches only that variant.</td>
</tr>
<tr>
<td><code>default_subtitle_type</code></td>
<td>str or list</td>
<td>unset</td>
<td>The subtitle types that can take the <em>default</em> flag, in order: <code>forced</code>, <code>normal</code>, <code>sdh</code> (CC counts as SDH, and <code>cc</code> is the same as <code>sdh</code>). The first subtitle track of the first type that the title has gets the flag. With <code>default_language.subtitle</code>, only the tracks in that language count. unshackle ignores a different word with a warning. <code>normal</code> is the value for players that read the forced flag. Read <a href="../../../guide/output-and-naming/#muxing-options">Muxing</a>.</td>
</tr>
<tr>
<td><code>merge_audio</code></td>
<td>bool</td>
<td><code>true</code></td>
@@ -2768,6 +2777,7 @@ bitrate alone, with those same Atmos/descriptive rules still applied.</p>
</span><span id="__span-9-4"><a id="__codelineno-9-4" name="__codelineno-9-4" href="#__codelineno-9-4"></a><span class="w"> </span><span class="nt">default_language</span><span class="p">:</span>
</span><span id="__span-9-5"><a id="__codelineno-9-5" name="__codelineno-9-5" href="#__codelineno-9-5"></a><span class="w"> </span><span class="nt">audio</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">en</span>
</span><span id="__span-9-6"><a id="__codelineno-9-6" name="__codelineno-9-6" href="#__codelineno-9-6"></a><span class="w"> </span><span class="nt">subtitle</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">en</span>
</span><span id="__span-9-7"><a id="__codelineno-9-7" name="__codelineno-9-7" href="#__codelineno-9-7"></a><span class="w"> </span><span class="nt">default_subtitle_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">normal</span>
</span></code></pre></div>
<h2 id="language_tags"><code>language_tags</code><a class="headerlink" href="#language_tags" title="Permanent link">&para;</a></h2>
<ul>
search/search_index.json
+1 -1
View File
File diff suppressed because one or more lines are too long
sitemap.xml
+38 -38
View File
@@ -2,154 +2,154 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://docs.unshackle.dev/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/creating-a-service/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/service-architecture/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/authentication/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/dashboard/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/endpoints/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/errors/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/job-lifecycle/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/quickstart/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/remote-sessions/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/getting-started/configuration-file/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/getting-started/installation/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/getting-started/quickstart/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/cli-reference/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/downloading/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/drm-and-cdm/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/output-and-naming/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/proxies-and-vpn/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/subtitles/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/troubleshooting/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/vaults/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/config/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/drm/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/service/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/titles/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/tracks/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/directories/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/download/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/drm/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/example/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/misc/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/network/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/output/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/post-scripts/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/services/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/vaults/</loc>
<lastmod>2026-11-10</lastmod>
<lastmod>2026-11-11</lastmod>
</url>
</urlset>
sitemap.xml.gz
BIN
View File
Binary file not shown.