kenzuya/unshackle
1
0
Fork 2
mirror of https://github.com/unshackle-dl/unshackle.git synced 2026-11-14 04:55:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Deployed ffeb58f with MkDocs version: 1.6.1

Browse Source
This commit is contained in:
2026-10-26 16:31:25 +00:00
parent 08cfcfad70
commit eaba38a33a
7 changed files with 70 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files
dev/service-architecture/index.html
+2 -2
View File
@@ -3004,7 +3004,7 @@ do not give a <code>name</code>, unshackle derives a human-readable name from th
<p><code>Video</code> adds <code>codec</code>, <code>range</code>, <code>bitrate</code>, <code>width</code>, <code>height</code>, <code>fps</code>, <code>scan_type</code>, and
closed-caption descriptors. The relevant enums:</p>
<ul>
<li><strong><code>Video.Codec</code></strong>: <code>AVC</code> (H.264), <code>HEVC</code> (H.265), <code>VC1</code>, <code>VP8</code>, <code>VP9</code>, <code>AV1</code>.</li>
<li><strong><code>Video.Codec</code></strong>: <code>AVC</code> (H.264), <code>HEVC</code> (H.265), <code>VC1</code>, <code>VP8</code>, <code>VP9</code>, <code>AV1</code>, <code>LCEVC</code>.</li>
<li><strong><code>Video.Range</code></strong>: <code>SDR</code>, <code>HLG</code>, <code>HDR10</code>, <code>HDR10P</code> (HDR10+), <code>DV</code> (Dolby Vision), and
<code>HYBRID</code>. <code>HYBRID</code> is special: it tells the pipeline to select both an HDR10(+) base and
a DV track and merge the DV RPU onto the HDR10 track with <code>dovi_tool</code> (see
@@ -3018,7 +3018,7 @@ string form displays kb/s, and <code>--vbitrate</code> and <code>--abitrate</cod
<h3 id="audio"><code>Audio</code><a class="headerlink" href="#audio" title="Permanent link">&para;</a></h3>
<p><code>Audio</code> adds <code>bitrate</code>, <code>channels</code>, <code>joc</code> (Joint Object Coding, the Atmos indicator),
and <code>descriptive</code>. <code>Audio.Codec</code> covers <code>AAC</code>, <code>AC3</code> (<code>DD</code>), <code>EC3</code> (<code>DD+</code>), <code>AC4</code>,
<code>OPUS</code>, <code>OGG</code> (Vorbis), <code>DTS</code>, <code>DTSX</code>, <code>ALAC</code>, and <code>FLAC</code>. The <code>atmos</code> property is <code>True</code> when
<code>OPUS</code>, <code>OGG</code> (Vorbis), <code>DTS</code>, <code>DTSX</code>, <code>DTSHD</code>, <code>MPEGH</code>, <code>ALAC</code>, and <code>FLAC</code>. The <code>atmos</code> property is <code>True</code> when
<code>joc</code> is set (or when <code>extra</code> flags it).</p>
<h3 id="subtitle"><code>Subtitle</code><a class="headerlink" href="#subtitle" title="Permanent link">&para;</a></h3>
<p><code>Subtitle</code> adds three mutually-constrained flags: <code>cc</code> (closed captions), <code>sdh</code>
getting-started/installation/index.html
+3 -3
View File
@@ -2703,7 +2703,7 @@ download. For example, <code>dovi_tool</code> only matters if you download Dolby
<tr>
<td>MP4Box (GPAC)</td>
<td><code>MP4Box</code></td>
<td>Muxing DTS:X Profile 2 (DTS-UHD) audio</td>
<td>Muxing DTS:X Profile 2 (DTS-UHD) and MPEG-H audio</td>
</tr>
<tr>
<td>dovi_tool</td>
@@ -2758,8 +2758,8 @@ download. For example, <code>dovi_tool</code> only matters if you download Dolby
</tbody>
</table>
<div class="admonition info">
<p class="admonition-title">MP4Box is only used for DTS:X Profile 2</p>
<p>Titles with DTS:X Profile 2 (DTS-UHD) audio mux to MP4; everything else muxes to MKV
<p class="admonition-title">MP4Box is only used for DTS:X Profile 2 and MPEG-H</p>
<p>Titles with DTS:X Profile 2 (DTS-UHD) or MPEG-H audio mux to MP4; everything else muxes to MKV
with <code>mkvmerge</code>. Install with <code>apt install gpac</code>.</p>
</div>
<div class="admonition tip">
guide/downloading/index.html
+16
View File
@@ -3252,9 +3252,15 @@ either enum <strong>names</strong> or their <strong>values</strong>, comma-separ
<td><code>AV1</code></td>
<td><code>AV1</code></td>
</tr>
<tr>
<td><code>LCEVC</code></td>
<td><code>LCEVC</code></td>
</tr>
</tbody>
</table>
<p><code>H264</code> and <code>H265</code> are aliases of <code>AVC</code> and <code>HEVC</code>.</p>
<p>An LCEVC (MPEG-5 Part 2) track only adds detail on top of its base video track and cannot play
alone, so unshackle selects it only when you ask for it with <code>-v LCEVC</code>.</p>
<div class="language-shell highlight"><span class="filename">Either spelling works</span><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>unshackle<span class="w"> </span>dl<span class="w"> </span>-v<span class="w"> </span>HEVC<span class="w"> </span>EXAMPLE<span class="w"> </span><span class="m">81234567</span>
</span><span id="__span-6-2"><a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a>unshackle<span class="w"> </span>dl<span class="w"> </span>-v<span class="w"> </span>H.265<span class="w"> </span>EXAMPLE<span class="w"> </span><span class="m">81234567</span>
</span><span id="__span-6-3"><a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a>unshackle<span class="w"> </span>dl<span class="w"> </span>-v<span class="w"> </span>hevc,avc<span class="w"> </span>EXAMPLE<span class="w"> </span><span class="m">81234567</span>
@@ -3502,6 +3508,16 @@ non-fatal: the manifest value stays in place.</p>
<td>DTS:X Profile 2 (DTS-UHD)</td>
</tr>
<tr>
<td><code>DTSHD</code></td>
<td><code>DTS-HD</code></td>
<td>DTS-HD High Resolution, Master Audio and Express</td>
</tr>
<tr>
<td><code>MPEGH</code></td>
<td><code>MPEG-H</code></td>
<td>MPEG-H 3D Audio</td>
</tr>
<tr>
<td><code>ALAC</code></td>
<td><code>ALAC</code></td>
<td>Apple Lossless</td>
guide/output-and-naming/index.html
+10 -9
View File
@@ -1058,10 +1058,10 @@
</li>
<li class="md-nav__item">
<a href="#dtsx-profile-2-output" class="md-nav__link">
<a href="#dtsx-profile-2-and-mpeg-h-output" class="md-nav__link">
<span class="md-ellipsis">
DTS:X Profile 2 output
DTS:X Profile 2 and MPEG-H output
</span>
</a>
@@ -2454,10 +2454,10 @@
</li>
<li class="md-nav__item">
<a href="#dtsx-profile-2-output" class="md-nav__link">
<a href="#dtsx-profile-2-and-mpeg-h-output" class="md-nav__link">
<span class="md-ellipsis">
DTS:X Profile 2 output
DTS:X Profile 2 and MPEG-H output
</span>
</a>
@@ -2605,7 +2605,7 @@
<li><strong>Output directory</strong>: <code>directories.downloads</code> from your config, or whatever you pass to <code>-o/--output</code> on the command line for a single run.</li>
<li><strong>Folder template</strong>: an optional per-title subfolder. unshackle <strong>always</strong> puts TV episodes and songs in a folder. Movies only get one if you define a <code>movies</code> folder template, or a single-string <code>folder</code> template that applies to all title kinds (see <a href="#folder-templates">Folder templates</a>).</li>
<li><strong>Filename template</strong>: the <code>output_template</code> for the title kind (movie, series, or song).</li>
<li><strong>Extension</strong>: chosen by the muxer for a movie or an episode: <code>.mkv</code> for video, <code>.mka</code> for audio-only, <code>.mks</code> for subtitle-only, <code>.mp4</code> for <a href="#dtsx-profile-2-output">DTS:X Profile 2 audio</a>. unshackle does not mux a song. It remuxes a song into the container of its codec, such as <code>.flac</code>, <code>.opus</code>, or <code>.m4a</code>. Read <a href="#music-output-files">Music output files</a>.</li>
<li><strong>Extension</strong>: chosen by the muxer for a movie or an episode: <code>.mkv</code> for video, <code>.mka</code> for audio-only, <code>.mks</code> for subtitle-only, <code>.mp4</code> for <a href="#dtsx-profile-2-and-mpeg-h-output">DTS:X Profile 2 and MPEG-H audio</a>. unshackle does not mux a song. It remuxes a song into the container of its codec, such as <code>.flac</code>, <code>.opus</code>, or <code>.m4a</code>. Read <a href="#music-output-files">Music output files</a>.</li>
</ul>
<div class="admonition example">
<p class="admonition-title">A typical episode path</p>
@@ -3192,10 +3192,11 @@ name already contains the word. It adds none to a subtitle. A label in another l
out the language when the name already contains it, so an English name shows once. A native name
such as <code>日本語</code> shows next to <code>Japanese</code> in an English interface.</p>
</div>
<h3 id="dtsx-profile-2-output">DTS:X Profile 2 output<a class="headerlink" href="#dtsx-profile-2-output" title="Permanent link">&para;</a></h3>
<p>A title whose audio holds a <code>dtsx</code> or <code>dtsy</code> sample entry (DTS:X Profile 2, DTS-UHD) muxes
to MP4 with <a href="../../getting-started/installation/">MP4Box</a>, because Matroska has no CodecID
for it. Without MP4Box installed the mux stops.</p>
<h3 id="dtsx-profile-2-and-mpeg-h-output">DTS:X Profile 2 and MPEG-H output<a class="headerlink" href="#dtsx-profile-2-and-mpeg-h-output" title="Permanent link">&para;</a></h3>
<p>A title whose audio holds a <code>dtsx</code> or <code>dtsy</code> sample entry (DTS:X Profile 2, DTS-UHD), or an
MPEG-H sample entry (<code>mha1</code>, <code>mha2</code>, <code>mhm1</code>, <code>mhm2</code>), muxes to MP4 with
<a href="../../getting-started/installation/">MP4Box</a>, because Matroska has no CodecID for it.
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>
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-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/creating-a-service/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/service-architecture/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/authentication/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/dashboard/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/endpoints/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/errors/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/job-lifecycle/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/quickstart/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/remote-sessions/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/getting-started/configuration-file/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/getting-started/installation/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/getting-started/quickstart/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/cli-reference/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/downloading/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/drm-and-cdm/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/output-and-naming/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/proxies-and-vpn/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/subtitles/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/troubleshooting/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/vaults/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/config/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/drm/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/service/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/titles/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/tracks/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/directories/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/download/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/drm/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/example/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/misc/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/network/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/output/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/post-scripts/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/services/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/vaults/</loc>
<lastmod>2026-10-25</lastmod>
<lastmod>2026-10-26</lastmod>
</url>
</urlset>
sitemap.xml.gz
BIN
View File
Binary file not shown.