kenzuya/unshackle
1
0
Fork 2
mirror of https://github.com/unshackle-dl/unshackle.git synced 2026-11-13 12:35:05 +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
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>