Deployed ee38477 with MkDocs version: 1.6.1

This commit is contained in:
2026-10-05 21:30:39 +00:00
parent bf550ee6ef
commit 3762e45ae4
9 changed files with 190 additions and 46 deletions
+5 -1
View File
@@ -3065,7 +3065,7 @@
<tr>
<td><code>--best-available</code>, <code>--warn-only</code></td>
<td>off</td>
<td>Warn and continue when a requested resolution, range, or language is absent, instead of failing.</td>
<td>Warn and continue when a requested resolution, range, or language is absent, instead of failing. With <code>--all-drm</code>, also when one DRM system does not license.</td>
</tr>
<tr>
<td><code>-rvb</code>, <code>--real-video-bitrate</code></td>
@@ -3370,6 +3370,10 @@ and keeps the service's numbering unchanged. Pick an order that covers the whole
<td>Skip the download but still retrieve keys.</td>
</tr>
<tr>
<td><code>--all-drm</code></td>
<td>License each track with both Widevine and PlayReady. Needs a CDM for each DRM system. Not for use with <code>--vaults-only</code> or <code>--cdm</code>.</td>
</tr>
<tr>
<td><code>--export</code></td>
<td>Export track info and keys to a <code>mediaexport</code> JSON file in the exports directory.</td>
</tr>
+12 -4
View File
@@ -3172,7 +3172,7 @@ therefore keeps its <code>3840×1920</code> HDR10 track, even when another range
<tbody>
<tr>
<td><code>--best-available</code> (<code>--warn-only</code>)</td>
<td>If the requested resolution(s) are not present, continue with the best that <em>is</em> available instead of failing. Also softens missing video/audio/subtitle languages and hybrid fallbacks.</td>
<td>If the requested resolution(s) are not present, continue with the best that <em>is</em> available instead of failing. Also softens missing video/audio/subtitle languages and hybrid fallbacks, and with <code>--all-drm</code> a DRM system that does not license.</td>
</tr>
<tr>
<td><code>--worst</code></td>
@@ -3838,6 +3838,10 @@ are always kept.</p>
<td><code>--skip-dl</code></td>
<td>Skip downloading but still acquire the decryption keys.</td>
</tr>
<tr>
<td><code>--all-drm</code></td>
<td>License each track with both Widevine and PlayReady. See <a href="../drm-and-cdm/#widevine-and-playready-on-the-same-title">Widevine and PlayReady on the same title</a>.</td>
</tr>
</tbody>
</table>
<div class="language-shell highlight"><span class="filename">See the track selection without downloading</span><pre><span></span><code><span id="__span-35-1"><a id="__codelineno-35-1" name="__codelineno-35-1" href="#__codelineno-35-1"></a>unshackle<span class="w"> </span>dl<span class="w"> </span>-q<span class="w"> </span><span class="m">1080</span><span class="w"> </span>-v<span class="w"> </span>H.265<span class="w"> </span>-r<span class="w"> </span>HDR10<span class="w"> </span>--list<span class="w"> </span>EXAMPLE<span class="w"> </span><span class="m">81234567</span>
@@ -3992,6 +3996,10 @@ each track only the content keys for its KIDs. The importer also reads the
older unshackle <code>version: 2</code> files and unidl's own export files.</p>
<div class="language-shell highlight"><span class="filename">Export track info and keys</span><pre><span></span><code><span id="__span-44-1"><a id="__codelineno-44-1" name="__codelineno-44-1" href="#__codelineno-44-1"></a>unshackle<span class="w"> </span>dl<span class="w"> </span>--skip-dl<span class="w"> </span>--export<span class="w"> </span>EXAMPLE<span class="w"> </span><span class="m">81234567</span>
</span></code></pre></div>
<p>Add <code>--all-drm</code> to send a challenge for each DRM system the title offers. The export then
holds the DRM init data of both.</p>
<div class="language-shell highlight"><span class="filename">License with Widevine and PlayReady, no download</span><pre><span></span><code><span id="__span-45-1"><a id="__codelineno-45-1" name="__codelineno-45-1" href="#__codelineno-45-1"></a>unshackle<span class="w"> </span>dl<span class="w"> </span>--skip-dl<span class="w"> </span>--all-drm<span class="w"> </span>--export<span class="w"> </span>EXAMPLE<span class="w"> </span><span class="m">81234567</span>
</span></code></pre></div>
<p>The file name tells what the file holds, in the form
<code>{title}.{scope}.{resolutions}.{codecs}.{ranges}.{manifests}.{audio}-{SERVICE}.json</code>:</p>
<table>
@@ -4114,9 +4122,9 @@ lookups but keep the IDs you give, set
</tr>
</tbody>
</table>
<div class="language-shell highlight"><span class="filename">Force the right IMDb match, and keep the service&#x27;s own naming</span><pre><span></span><code><span id="__span-45-1"><a id="__codelineno-45-1" name="__codelineno-45-1" href="#__codelineno-45-1"></a>unshackle<span class="w"> </span>dl<span class="w"> </span>--imdb<span class="w"> </span>tt1375666<span class="w"> </span>EXAMPLE<span class="w"> </span><span class="m">81234567</span>
<div class="language-shell highlight"><span class="filename">Force the right IMDb match, and keep the service&#x27;s own naming</span><pre><span></span><code><span id="__span-46-1"><a id="__codelineno-46-1" name="__codelineno-46-1" href="#__codelineno-46-1"></a>unshackle<span class="w"> </span>dl<span class="w"> </span>--imdb<span class="w"> </span>tt1375666<span class="w"> </span>EXAMPLE<span class="w"> </span><span class="m">81234567</span>
</span></code></pre></div>
<div class="language-shell highlight"><span class="filename">Force the match and take IMDb&#x27;s title, year and language too</span><pre><span></span><code><span id="__span-46-1"><a id="__codelineno-46-1" name="__codelineno-46-1" href="#__codelineno-46-1"></a>unshackle<span class="w"> </span>dl<span class="w"> </span>--imdb<span class="w"> </span>tt1375666<span class="w"> </span>--enrich<span class="w"> </span>EXAMPLE<span class="w"> </span><span class="m">81234567</span>
<div class="language-shell highlight"><span class="filename">Force the match and take IMDb&#x27;s title, year and language too</span><pre><span></span><code><span id="__span-47-1"><a id="__codelineno-47-1" name="__codelineno-47-1" href="#__codelineno-47-1"></a>unshackle<span class="w"> </span>dl<span class="w"> </span>--imdb<span class="w"> </span>tt1375666<span class="w"> </span>--enrich<span class="w"> </span>EXAMPLE<span class="w"> </span><span class="m">81234567</span>
</span></code></pre></div>
<h3 id="what-each-metadata-provider-supplies">What each metadata provider supplies<a class="headerlink" href="#what-each-metadata-provider-supplies" title="Permanent link">&para;</a></h3>
<p>Metadata providers differ in what they answer with, so the fields <code>--enrich</code> can replace
@@ -4234,7 +4242,7 @@ selection.</p>
TVDB's <code>alternate</code> (Streaming) order for Futurama, for example, while TVDB's <code>official</code> order
holds back four season-one episodes to the start of season two. <code>--tvdb-order</code> works out which
order the service used, then renumbers the episodes into the order you asked for:</p>
<div class="language-shell highlight"><span class="filename">Download Futurama in DVD order</span><pre><span></span><code><span id="__span-47-1"><a id="__codelineno-47-1" name="__codelineno-47-1" href="#__codelineno-47-1"></a>unshackle<span class="w"> </span>dl<span class="w"> </span>--tvdb-order<span class="w"> </span>dvd<span class="w"> </span>EXAMPLE<span class="w"> </span><span class="m">81234567</span>
<div class="language-shell highlight"><span class="filename">Download Futurama in DVD order</span><pre><span></span><code><span id="__span-48-1"><a id="__codelineno-48-1" name="__codelineno-48-1" href="#__codelineno-48-1"></a>unshackle<span class="w"> </span>dl<span class="w"> </span>--tvdb-order<span class="w"> </span>dvd<span class="w"> </span>EXAMPLE<span class="w"> </span><span class="m">81234567</span>
</span></code></pre></div>
<p>Available orders are <code>official</code> (aired), <code>dvd</code>, <code>absolute</code>, <code>alternate</code>, and <code>regional</code>. Set
<code>tvdb_order</code> in your config to apply one by default.</p>
+72 -2
View File
@@ -1026,6 +1026,23 @@
</span>
</a>
<nav class="md-nav" aria-label="Widevine and PlayReady on the same title">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#license-both-systems-with-all-drm" class="md-nav__link">
<span class="md-ellipsis">
License both systems with --all-drm
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@@ -2473,6 +2490,23 @@
</span>
</a>
<nav class="md-nav" aria-label="Widevine and PlayReady on the same title">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#license-both-systems-with-all-drm" class="md-nav__link">
<span class="md-ellipsis">
License both systems with --all-drm
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@@ -3001,6 +3035,42 @@ mapping. If it cannot find a matching device, it fails with a clear message such
<p>Use the <code>cdm</code> mapping's <a href="#advanced-selection-by-quality-drm-or-profile">DRM-based selection</a>
to configure a device for each system. unshackle selects the right one per track
automatically.</p>
<h3 id="license-both-systems-with-all-drm">License both systems with <code>--all-drm</code><a class="headerlink" href="#license-both-systems-with-all-drm" title="Permanent link">&para;</a></h3>
<p>By default a track licenses with one DRM system. <code>--all-drm</code> sends a challenge for
Widevine and for PlayReady on each track that offers both. Use it with <code>--skip-dl</code> and
<code>--export</code> to keep the content keys and the DRM init data of both systems. The two
systems can return different sets of KIDs, and unshackle keeps the content keys of both.</p>
<div class="language-shell highlight"><pre><span></span><code><span id="__span-22-1"><a id="__codelineno-22-1" name="__codelineno-22-1" href="#__codelineno-22-1"></a>unshackle<span class="w"> </span>dl<span class="w"> </span>--skip-dl<span class="w"> </span>--all-drm<span class="w"> </span>--export<span class="w"> </span>EXAMPLE<span class="w"> </span><span class="m">81234567</span>
</span></code></pre></div>
<ul>
<li>The <code>cdm</code> mapping must name a device for each system. A single device name, or <code>--cdm</code>,
stops the run with an error that names the missing system.</li>
<li>Each DRM system sends one challenge for a set of KIDs in a run. A content key in a
Key Vault does not stop the challenge, so <code>--vaults-only</code> is refused.</li>
<li>A service with a Widevine licence function only gets the PlayReady challenge through that
function. If its licence server refuses the challenge, that DRM system does not license.</li>
<li>If one DRM system does not license, the title fails. With <code>--best-available</code> unshackle
shows a warning and continues, if the other system gave the content key of the track.
unshackle does not send the challenge again for the same KIDs in that run.</li>
<li>A track gets its DRM systems from the manifest. For a DASH track or a direct URL,
unshackle also reads the init segment for a system that the manifest does not carry.</li>
<li>The service gets a challenge from each DRM system for each set of KIDs. A licence server
that limits the request rate can answer <code>429</code>, and unshackle then tries again.</li>
</ul>
<div class="admonition note">
<p class="admonition-title">Where <code>--all-drm</code> licenses one system only</p>
<ul>
<li>A service that gets a different manifest for each DRM system. unshackle shows a
warning one time when a track offers one system only.</li>
<li>A service that fetched its playback for one DRM system and refuses the other. That
system does not license, so the title fails unless you use <code>--best-available</code>.</li>
<li>An HLS playlist that changes its <code>EXT-X-KEY</code> entries part-way: only the first set
licenses with the second system.</li>
<li>A remote session that the server CDM licenses, and <code>unshackle import</code>. unshackle
shows a warning and ignores the flag.</li>
<li>A remote CDM that stores content keys can answer without a challenge to the service.</li>
</ul>
</div>
<h2 id="keys-vaults-and-caching">Keys, vaults, and caching<a class="headerlink" href="#keys-vaults-and-caching" title="Permanent link">&para;</a></h2>
<p>Fetching a license is comparatively slow and, for some services, rate-limited.
unshackle therefore resolves each key ID in this order before ever contacting a
@@ -3065,8 +3135,8 @@ control this trade-off on the <code>dl</code> command:</p>
</tr>
</tbody>
</table>
<div class="language-yaml highlight"><span class="filename">unshackle.yaml</span><pre><span></span><code><span id="__span-22-1"><a id="__codelineno-22-1" name="__codelineno-22-1" href="#__codelineno-22-1"></a><span class="nt">debug_keys</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
</span><span id="__span-22-2"><a id="__codelineno-22-2" name="__codelineno-22-2" href="#__codelineno-22-2"></a><span class="nt">debug_requests</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
<div class="language-yaml highlight"><span class="filename">unshackle.yaml</span><pre><span></span><code><span id="__span-23-1"><a id="__codelineno-23-1" name="__codelineno-23-1" href="#__codelineno-23-1"></a><span class="nt">debug_keys</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
</span><span id="__span-23-2"><a id="__codelineno-23-2" name="__codelineno-23-2" href="#__codelineno-23-2"></a><span class="nt">debug_requests</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
</span></code></pre></div>
<div class="admonition warning">
<p class="admonition-title">Keys and paths in logs</p>