[docs] @Breakthrough: Generate Documentation

Source: main (0d12be7)

Destination: head

Author: github-actions

docs/head/.doctrees/api/detectors.doctree

@@ -416,6 +416,12 @@ Options
 
   Default: ``True``
 
+.. option:: --min-out-length TIMECODE
+
+  Minimum time spent faded out before a cut is allowed. Ignores shorter fades even when the minimum scene length is met. Also applies to a final fade-out, including the last processed frame. Zero allows fades of any duration. TIMECODE can be specified in frames (4), seconds with an `s` suffix (0.4s), or timecode (00:00:00.400).
+
+  Default: ``0.1s``. The Python API default remains ``0``.
+
 .. option:: -m TIMECODE, --min-scene-len TIMECODE
 
   Minimum length of any scene. Overrides global option :option:`-m/--min-scene-len <scenedetect -m>`. TIMECODE can be specified in frames (-m 100), in seconds with `s` suffix (-m 3.5s), or timecode (-m 00:01:52.778).

docs/head/.doctrees/api/output.doctree

@@ -479,7 +479,7 @@
 <p>This detector is available from the command-line as the <cite>detect-threshold</cite> command.</p>
 <dl class="py class">
 <dt class="sig sig-object py" id="scenedetect.detectors.threshold_detector.ThresholdDetector">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ThresholdDetector</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">threshold</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">12</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">min_scene_len</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">15</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fade_bias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">add_final_scene</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">method</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">Method.FLOOR</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">block_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#scenedetect.detectors.threshold_detector.ThresholdDetector" title="Permalink to this definition">¶</a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ThresholdDetector</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">threshold</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">12</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">min_scene_len</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">15</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fade_bias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">add_final_scene</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">method</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">Method.FLOOR</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">block_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">min_out_length</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#scenedetect.detectors.threshold_detector.ThresholdDetector" title="Permalink to this definition">¶</a></dt>
 <dd><p>Detects fast cuts/slow fades in from and out to a given threshold level.</p>
 <p>Detects both fast cuts and slow fades so long as an appropriate threshold
 is chosen (especially taking into account the minimum grey/black level).</p>
@@ -499,6 +499,9 @@
 generate an additional scene at this timecode.</p></li>
 <li><p><strong>method</strong> (<a class="reference internal" href="#scenedetect.detectors.threshold_detector.ThresholdDetector.Method" title="scenedetect.detectors.threshold_detector.ThresholdDetector.Method"><em>Method</em></a>) – How to treat <cite>threshold</cite> when detecting fade events.</p></li>
 <li><p><strong>block_size</strong> – [DEPRECATED] DO NOT USE. For backwards compatibility.</p></li>
+<li><p><strong>min_out_length</strong> (<em>int</em><em> | </em><em>float</em><em> | </em><em>str</em><em> | </em><a class="reference internal" href="common.html#scenedetect.common.Timecode" title="scenedetect.common.Timecode"><em>Timecode</em></a><em> | </em><a class="reference internal" href="common.html#scenedetect.common.FrameTimecode" title="scenedetect.common.FrameTimecode"><em>FrameTimecode</em></a>) – Minimum time spent faded out before a cut can be added. Accepts the
+same formats as min_scene_len. Shorter fades are ignored. Defaults to 0,
+allowing fades of any duration.</p></li>
 </ul>
 </dd>
 </dl>
@@ -542,7 +545,8 @@
 <p>Only writes the scene cut if add_final_scene is true, and the last fade
 that was detected was a fade-out.  There is no bias applied to this cut
 (since there is no corresponding fade-in) so it will be located at the
-exact frame where the fade-out crossed the detection threshold.</p>
+exact frame where the fade-out crossed the detection threshold. The fade-out
+must also meet min_out_length, including the last processed frame.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><p><strong>timecode</strong> (<a class="reference internal" href="common.html#scenedetect.common.FrameTimecode" title="scenedetect.common.FrameTimecode"><em>FrameTimecode</em></a>) – </p>

docs/head/.doctrees/api/platform.doctree

@@ -49,7 +49,7 @@
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>output_csv_file</strong> (<em>TextIO</em><em> | </em><em>str</em><em> | </em><em>Path</em>) – Handle to open file in write mode, or a filesystem path. A path is
+<li><p><strong>output_csv_file</strong> (<em>str</em><em> | </em><em>PathLike</em><em>[</em><em>str</em><em>] </em><em>| </em><em>bytes</em><em> | </em><em>PathLike</em><em>[</em><em>bytes</em><em>] </em><em>| </em><em>TextIO</em>) – Handle to open file in write mode, or a filesystem path. A path is
 opened with a context manager so the file is closed after writing.</p></li>
 <li><p><strong>scene_list</strong> (<em>list</em><em>[</em><em>tuple</em><em>[</em><a class="reference internal" href="common.html#scenedetect.common.FrameTimecode" title="scenedetect.common.FrameTimecode"><em>FrameTimecode</em></a><em>, </em><a class="reference internal" href="common.html#scenedetect.common.FrameTimecode" title="scenedetect.common.FrameTimecode"><em>FrameTimecode</em></a><em>]</em><em>]</em>) – List of pairs of FrameTimecodes denoting each scene’s start/end FrameTimecode.</p></li>
 <li><p><strong>include_cut_list</strong> (<em>bool</em>) – Bool indicating if the first row should include the timecodes where
@@ -74,7 +74,8 @@
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>output_path</strong> (<em>str</em><em> | </em><em>Path</em>) – Path to write the EDL file to. Parent directories must exist.</p></li>
+<li><p><strong>output_path</strong> (<em>str</em><em> | </em><em>PathLike</em><em>[</em><em>str</em><em>] </em><em>| </em><em>bytes</em><em> | </em><em>PathLike</em><em>[</em><em>bytes</em><em>] </em><em>| </em><em>TextIO</em>) – Open text file or path to write the EDL file to. Parent directories must
+exist. When a path is provided, the file is closed after writing.</p></li>
 <li><p><strong>scene_list</strong> (<em>list</em><em>[</em><em>tuple</em><em>[</em><a class="reference internal" href="common.html#scenedetect.common.FrameTimecode" title="scenedetect.common.FrameTimecode"><em>FrameTimecode</em></a><em>, </em><a class="reference internal" href="common.html#scenedetect.common.FrameTimecode" title="scenedetect.common.FrameTimecode"><em>FrameTimecode</em></a><em>]</em><em>]</em>) – List of scenes as pairs of FrameTimecodes denoting each scene’s start/end.</p></li>
 <li><p><strong>title</strong> (<em>str</em>) – Title header written as <code class="docutils literal notranslate"><span class="pre">TITLE:</span></code> in the EDL.</p></li>
 <li><p><strong>reel</strong> (<em>str</em>) – Reel name used for each event. Typically 2-8 uppercase characters.</p></li>
@@ -96,7 +97,8 @@
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>output_path</strong> (<em>str</em><em> | </em><em>Path</em>) – Path to write the xmeml file to. Parent directories must exist.</p></li>
+<li><p><strong>output_path</strong> (<em>str</em><em> | </em><em>PathLike</em><em>[</em><em>str</em><em>] </em><em>| </em><em>bytes</em><em> | </em><em>PathLike</em><em>[</em><em>bytes</em><em>] </em><em>| </em><em>TextIO</em>) – Open text file or path to write the xmeml file to. Parent directories must
+exist. When a path is provided, the file is closed after writing.</p></li>
 <li><p><strong>scene_list</strong> (<em>list</em><em>[</em><em>tuple</em><em>[</em><a class="reference internal" href="common.html#scenedetect.common.FrameTimecode" title="scenedetect.common.FrameTimecode"><em>FrameTimecode</em></a><em>, </em><a class="reference internal" href="common.html#scenedetect.common.FrameTimecode" title="scenedetect.common.FrameTimecode"><em>FrameTimecode</em></a><em>]</em><em>]</em>) – List of scenes as pairs of FrameTimecodes. Must not be empty.</p></li>
 <li><p><strong>video_path</strong> (<em>str</em><em> | </em><em>Path</em>) – Path to the source video file; written into the output as a <code class="docutils literal notranslate"><span class="pre">file://</span></code> URI.</p></li>
 <li><p><strong>frame_rate</strong> (<em>Fraction</em>) – Source frame rate as a rational <cite>Fraction</cite>.</p></li>
@@ -121,7 +123,8 @@
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>output_path</strong> (<em>str</em><em> | </em><em>Path</em>) – Path to write the FCPXML file to. Parent directories must exist.</p></li>
+<li><p><strong>output_path</strong> (<em>str</em><em> | </em><em>PathLike</em><em>[</em><em>str</em><em>] </em><em>| </em><em>bytes</em><em> | </em><em>PathLike</em><em>[</em><em>bytes</em><em>] </em><em>| </em><em>TextIO</em>) – Open text file or path to write the FCPXML file to. Parent directories must
+exist. When a path is provided, the file is closed after writing.</p></li>
 <li><p><strong>scene_list</strong> (<em>list</em><em>[</em><em>tuple</em><em>[</em><a class="reference internal" href="common.html#scenedetect.common.FrameTimecode" title="scenedetect.common.FrameTimecode"><em>FrameTimecode</em></a><em>, </em><a class="reference internal" href="common.html#scenedetect.common.FrameTimecode" title="scenedetect.common.FrameTimecode"><em>FrameTimecode</em></a><em>]</em><em>]</em>) – List of scenes as pairs of FrameTimecodes. Must not be empty.</p></li>
 <li><p><strong>video_path</strong> (<em>str</em><em> | </em><em>Path</em>) – Path to the source video file; written into the output as a <code class="docutils literal notranslate"><span class="pre">file://</span></code> URI.</p></li>
 <li><p><strong>frame_rate</strong> (<em>Fraction</em>) – Source frame rate as a rational <cite>Fraction</cite> (e.g. <code class="docutils literal notranslate"><span class="pre">Fraction(24000,</span> <span class="pre">1001)</span></code>).</p></li>
@@ -164,7 +167,8 @@
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>output_path</strong> (<em>str</em><em> | </em><em>Path</em>) – Path to write the OTIO file to. Parent directories must exist.</p></li>
+<li><p><strong>output_path</strong> (<em>str</em><em> | </em><em>PathLike</em><em>[</em><em>str</em><em>] </em><em>| </em><em>bytes</em><em> | </em><em>PathLike</em><em>[</em><em>bytes</em><em>] </em><em>| </em><em>TextIO</em>) – Open text file or path to write the OTIO file to. Parent directories must
+exist. When a path is provided, the file is closed after writing.</p></li>
 <li><p><strong>scene_list</strong> (<em>list</em><em>[</em><em>tuple</em><em>[</em><a class="reference internal" href="common.html#scenedetect.common.FrameTimecode" title="scenedetect.common.FrameTimecode"><em>FrameTimecode</em></a><em>, </em><a class="reference internal" href="common.html#scenedetect.common.FrameTimecode" title="scenedetect.common.FrameTimecode"><em>FrameTimecode</em></a><em>]</em><em>]</em>) – List of scenes as pairs of FrameTimecodes.</p></li>
 <li><p><strong>video_path</strong> (<em>str</em><em> | </em><em>Path</em>) – Path to the source video file; written into the output as an absolute path.</p></li>
 <li><p><strong>frame_rate</strong> (<em>Fraction</em>) – Source frame rate as a rational <cite>Fraction</cite>. Exported as a float, as the

docs/head/.doctrees/cli.doctree

@@ -249,6 +249,13 @@
 </dl>
 </dd></dl>
 
+<dl class="py data">
+<dt class="sig sig-object py" id="scenedetect.platform.BytePath">
+<span class="sig-name descname"><span class="pre">BytePath</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">bytes</span> <span class="pre">|</span> <span class="pre">os.PathLike[bytes]</span></em><a class="headerlink" href="#scenedetect.platform.BytePath" title="Permalink to this definition">¶</a></dt>
+<dd><p>Type hint for byte-based filesystem paths. Accepts <cite>bytes</cite> or any object implementing
+<code class="xref py py-class docutils literal notranslate"><span class="pre">os.PathLike</span></code> that returns <cite>bytes</cite>.</p>
+</dd></dl>
+
 <dl class="py data">
 <dt class="sig sig-object py" id="scenedetect.platform.DEBUG_MODE">
 <span class="sig-name descname"><span class="pre">DEBUG_MODE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#scenedetect.platform.DEBUG_MODE" title="Permalink to this definition">¶</a></dt>
@@ -351,6 +358,7 @@ <h3>Navigation</h3>
 <li class="toctree-l2"><a class="reference internal" href="#scenedetect.platform.get_system_version_info"><code class="docutils literal notranslate"><span class="pre">get_system_version_info()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="#scenedetect.platform.init_logger"><code class="docutils literal notranslate"><span class="pre">init_logger()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="#scenedetect.platform.invoke_command"><code class="docutils literal notranslate"><span class="pre">invoke_command()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="#scenedetect.platform.BytePath"><code class="docutils literal notranslate"><span class="pre">BytePath</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="#scenedetect.platform.DEBUG_MODE"><code class="docutils literal notranslate"><span class="pre">DEBUG_MODE</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="#scenedetect.platform.StrPath"><code class="docutils literal notranslate"><span class="pre">StrPath</span></code></a></li>
 </ul>