Deployed 55bed48 with MkDocs version: 1.6.1

dev/rest-api/endpoints/index.html

@@ -3871,7 +3871,7 @@ ignore it safely. See <a href="../../creating-a-service/#split-episodes">Split e
 </tr>
 </tbody>
 </table>
-<p><strong>Validation.</strong> Invalid values return <code>400 INVALID_PARAMETERS</code>. <code>vcodec</code> must be one of H264/H265/H.264/H.265/AVC/HEVC/VC1/VC-1/VP8/VP9/AV1. <code>acodec</code> must be one of AAC/AC3/EC3/EAC3/DD/DD+/AC4/OPUS/FLAC/ALAC/VORBIS/OGG/DTS. <code>range</code> must be one of SDR/HDR10/HDR10P/DV/HLG/HYBRID, and <code>HDR10+</code> is also valid. The bitrate, download worker, and download counts must be positive integers. You may set at most one of the <code>*_only</code> flags. You cannot combine <code>no_subs</code> with <code>subs_only</code>, or <code>no_audio</code> with <code>audio_only</code>.</p>
+<p><strong>Validation.</strong> Invalid values return <code>400 INVALID_PARAMETERS</code>. <code>vcodec</code> must be one of H264/H265/H.264/H.265/AVC/HEVC/VC1/VC-1/VP8/VP9/AV1. <code>acodec</code> must be one of AAC/AC3/EC3/EAC3/DD/DD+/AC4/OPUS/FLAC/ALAC/VORBIS/OGG/DTS/DTSX/DTS-X. <code>range</code> must be one of SDR/HDR10/HDR10P/DV/HLG/HYBRID, and <code>HDR10+</code> is also valid. The bitrate, download worker, and download counts must be positive integers. You may set at most one of the <code>*_only</code> flags. You cannot combine <code>no_subs</code> with <code>subs_only</code>, or <code>no_audio</code> with <code>audio_only</code>.</p>
 <p><strong>Service options.</strong> A service's own CLI options travel in the same body. Send them in a nested
 <code>service_params</code> object, or as flat top-level keys. <code>service_params</code> wins over a flat key of the
 same name. An option you leave out takes the default declared on the service's <code>cli</code> command, so

dev/service-architecture/index.html

@@ -2970,7 +2970,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>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>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

@@ -2466,6 +2466,11 @@ download. For example, <code>dovi_tool</code> only matters if you download Dolby
 <td>Alternative DRM decryptor to shaka-packager</td>
 </tr>
 <tr>
+<td>MP4Box (GPAC)</td>
+<td><code>MP4Box</code></td>
+<td>Muxing DTS:X Profile 2 (DTS-UHD) audio</td>
+</tr>
+<tr>
 <td>dovi_tool</td>
 <td><code>dovi_tool</code></td>
 <td>Dolby Vision metadata handling</td>
@@ -2517,6 +2522,11 @@ download. For example, <code>dovi_tool</code> only matters if you download Dolby
 </tr>
 </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
+with <code>mkvmerge</code>. Install with <code>apt install gpac</code>.</p>
+</div>
 <div class="admonition tip">
 <p class="admonition-title">SubtitleEdit specifics</p>
 <p>unshackle looks for <code>seconv</code> first, the batch CLI shipped with

guide/cli-reference/index.html

@@ -2991,7 +2991,7 @@
 <tr>
 <td><code>-a</code>, <code>--acodec</code></td>
 <td>any</td>
-<td>Audio codec(s), comma-separated. Accepts <code>AAC</code>, <code>AC3</code>/<code>DD</code>, <code>EC3</code>/<code>DD+</code>/<code>eac3</code>/<code>ddp</code>, <code>AC4</code>, <code>OPUS</code>, <code>OGG</code>/<code>vorbis</code>, <code>DTS</code>, <code>ALAC</code>, <code>FLAC</code>.</td>
+<td>Audio codec(s), comma-separated. Accepts <code>AAC</code>, <code>AC3</code>/<code>DD</code>, <code>EC3</code>/<code>DD+</code>/<code>eac3</code>/<code>ddp</code>, <code>AC4</code>, <code>OPUS</code>, <code>OGG</code>/<code>vorbis</code>, <code>DTS</code>, <code>DTSX</code>/<code>DTS-X</code>, <code>ALAC</code>, <code>FLAC</code>.</td>
 </tr>
 <tr>
 <td><code>-vb</code>, <code>--vbitrate</code></td>

guide/downloading/index.html

@@ -3384,6 +3384,11 @@ non-fatal: the manifest value stays in place.</p>
 <td>DTS</td>
 </tr>
 <tr>
+<td><code>DTSX</code></td>
+<td><code>DTS-X</code></td>
+<td>DTS:X Profile 2 (DTS-UHD)</td>
+</tr>
+<tr>
 <td><code>ALAC</code></td>
 <td><code>ALAC</code></td>
 <td>Apple Lossless</td>

guide/output-and-naming/index.html

@@ -1041,6 +1041,23 @@
     </span>
   </a>
   
+    <nav class="md-nav" aria-label="Muxing options">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#dtsx-profile-2-output" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        DTS:X Profile 2 output
+      
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
       
         <li class="md-nav__item">
@@ -2398,6 +2415,23 @@
     </span>
   </a>
   
+    <nav class="md-nav" aria-label="Muxing options">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#dtsx-profile-2-output" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        DTS:X Profile 2 output
+      
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
       
         <li class="md-nav__item">
@@ -2525,7 +2559,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. 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-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>
 </ul>
 <div class="admonition example">
 <p class="admonition-title">A typical episode path</p>
@@ -2797,17 +2831,17 @@ For an episode with no on-screen name, <code>{episode_name?}</code> and its adja
 <tr>
 <td><code>audio</code></td>
 <td>Audio codec</td>
-<td><code>DDP</code>, <code>DD</code>, <code>AAC</code></td>
+<td><code>DDP</code>, <code>DD</code>, <code>AAC</code>, <code>DTS-X</code></td>
 </tr>
 <tr>
 <td><code>audio_channels</code></td>
-<td>Channel layout</td>
-<td><code>5.1</code>, <code>2.0</code></td>
+<td>Channel layout; bed.LFE.heights when the track has height channels</td>
+<td><code>5.1</code>, <code>2.0</code>, <code>5.1.4</code></td>
 </tr>
 <tr>
 <td><code>audio_full</code></td>
 <td>Codec + channels combined</td>
-<td><code>DDP5.1</code></td>
+<td><code>DDP5.1</code>, <code>DTS-X.5.1.4</code></td>
 </tr>
 <tr>
 <td><code>atmos</code></td>
@@ -2976,6 +3010,22 @@ warning and continues.</p>
 <p><a href="../cli-reference/#output-muxing-files"><code>--no-mux</code></a> moves each downloaded track file to the output path without the tagging step. A music file from such a run holds only the metadata that the service put in it.</p>
 </div>
 <h2 id="muxing-options">Muxing options<a class="headerlink" href="#muxing-options" title="Permanent link">&para;</a></h2>
+<div class="admonition note">
+<p class="admonition-title">Height channels</p>
+<p>A track with height channels is named bed.LFE.heights, such as <code>5.1.4</code>.</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>
+<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>attachments, such as subtitle fonts</li>
+<li>SubStation Alpha (<code>.ass</code>) subtitles</li>
+<li>container tags (<code>mkvpropedit</code>)</li>
+</ul>
 <p>You configure muxing (the combination of video, audio, subtitle, chapter and attachment tracks into a single Matroska file with <code>mkvmerge</code>) under the <code>muxing</code> config key. unshackle muxes only movies and episodes. Read <a href="#music-output-files">Music output files</a> for what a music download does instead.</p>
 <div class="language-yaml highlight"><span class="filename">unshackle.yaml</span><pre><span></span><code><span id="__span-13-1"><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a><span class="nt">muxing</span><span class="p">:</span>
 </span><span id="__span-13-2"><a id="__codelineno-13-2" name="__codelineno-13-2" href="#__codelineno-13-2"></a><span class="w">  </span><span class="nt">set_title</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>

index.html

@@ -2141,7 +2141,7 @@ at a title and it will:</p>
 </tr>
 <tr>
 <td>Audio</td>
-<td>AAC, AC-3, E-AC-3, AC-4, Opus, Vorbis, DTS, ALAC, FLAC; Dolby Atmos handling; per-channel-layout selection</td>
+<td>AAC, AC-3, E-AC-3, AC-4, Opus, Vorbis, DTS, DTS-X, ALAC, FLAC; Dolby Atmos handling; per-channel-layout selection</td>
 </tr>
 <tr>
 <td>Subtitles</td>