[docs] @Breakthrough: Generate Documentation

Source: main (85d79b6)

Destination: head

Author: github-actions

docs/head/.doctrees/api.doctree

@@ -9,12 +9,12 @@ The `scenedetect` API is easy to integrate with most application workflows, whil
 
     * :ref:`scenedetect.detectors 🕵️ <scenedetect-detectors>`: detection algorithms:
 
+        * :mod:`AdaptiveDetector <scenedetect.detectors.adaptive_detector>` finds fast cuts using rolling average of HSL changes
+
         * :mod:`ContentDetector <scenedetect.detectors.content_detector>`: detects fast cuts using weighted average of HSV changes
 
         * :mod:`ThresholdDetector <scenedetect.detectors.threshold_detector>`: finds fades in/out using average pixel intensity changes in RGB
 
-        * :mod:`AdaptiveDetector <scenedetect.detectors.adaptive_detector>` finds fast cuts using rolling average of HSL changes
-
         * :mod:`HistogramDetector <scenedetect.detectors.histogram_detector>` finds fast cuts using HSV histogram changes
 
         * :mod:`HashDetector <scenedetect.detectors.hash_detector>`: finds fast cuts using perceptual image hashing

docs/head/.doctrees/api/backends.doctree

@@ -42,9 +42,9 @@ <h1><code class="docutils literal notranslate"><span class="pre">scenedetect</sp
 <li><p><a class="reference internal" href="api/detectors.html#scenedetect-detectors"><span class="std std-ref">scenedetect.detectors 🕵️</span></a>: detection algorithms:</p>
 <blockquote>
 <div><ul class="simple">
+<li><p><a class="reference internal" href="api/detectors.html#module-scenedetect.detectors.adaptive_detector" title="scenedetect.detectors.adaptive_detector"><code class="xref py py-mod docutils literal notranslate"><span class="pre">AdaptiveDetector</span></code></a> finds fast cuts using rolling average of HSL changes</p></li>
 <li><p><a class="reference internal" href="api/detectors.html#module-scenedetect.detectors.content_detector" title="scenedetect.detectors.content_detector"><code class="xref py py-mod docutils literal notranslate"><span class="pre">ContentDetector</span></code></a>: detects fast cuts using weighted average of HSV changes</p></li>
 <li><p><a class="reference internal" href="api/detectors.html#module-scenedetect.detectors.threshold_detector" title="scenedetect.detectors.threshold_detector"><code class="xref py py-mod docutils literal notranslate"><span class="pre">ThresholdDetector</span></code></a>: finds fades in/out using average pixel intensity changes in RGB</p></li>
-<li><p><a class="reference internal" href="api/detectors.html#module-scenedetect.detectors.adaptive_detector" title="scenedetect.detectors.adaptive_detector"><code class="xref py py-mod docutils literal notranslate"><span class="pre">AdaptiveDetector</span></code></a> finds fast cuts using rolling average of HSL changes</p></li>
 <li><p><a class="reference internal" href="api/detectors.html#module-scenedetect.detectors.histogram_detector" title="scenedetect.detectors.histogram_detector"><code class="xref py py-mod docutils literal notranslate"><span class="pre">HistogramDetector</span></code></a> finds fast cuts using HSV histogram changes</p></li>
 <li><p><a class="reference internal" href="api/detectors.html#module-scenedetect.detectors.hash_detector" title="scenedetect.detectors.hash_detector"><code class="xref py py-mod docutils literal notranslate"><span class="pre">HashDetector</span></code></a>: finds fast cuts using perceptual image hashing</p></li>
 </ul>
@@ -256,7 +256,11 @@ <h2>Module Reference<a class="headerlink" href="#module-reference" title="Permal
 <li class="toctree-l2"><a class="reference internal" href="api/common.html#scenedetect.common.FrameTimecode"><code class="docutils literal notranslate"><span class="pre">FrameTimecode</span></code></a><ul>
 <li class="toctree-l3"><a class="reference internal" href="api/common.html#scenedetect.common.FrameTimecode.equal_framerate"><code class="docutils literal notranslate"><span class="pre">FrameTimecode.equal_framerate()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="api/common.html#scenedetect.common.FrameTimecode.get_timecode"><code class="docutils literal notranslate"><span class="pre">FrameTimecode.get_timecode()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/common.html#scenedetect.common.FrameTimecode.frame_num"><code class="docutils literal notranslate"><span class="pre">FrameTimecode.frame_num</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/common.html#scenedetect.common.FrameTimecode.framerate"><code class="docutils literal notranslate"><span class="pre">FrameTimecode.framerate</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/common.html#scenedetect.common.FrameTimecode.pts"><code class="docutils literal notranslate"><span class="pre">FrameTimecode.pts</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="api/common.html#scenedetect.common.FrameTimecode.seconds"><code class="docutils literal notranslate"><span class="pre">FrameTimecode.seconds</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/common.html#scenedetect.common.FrameTimecode.time_base"><code class="docutils literal notranslate"><span class="pre">FrameTimecode.time_base</span></code></a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="api/common.html#scenedetect.common.Interpolation"><code class="docutils literal notranslate"><span class="pre">Interpolation</span></code></a><ul>
@@ -394,7 +398,6 @@ <h2>Module Reference<a class="headerlink" href="#module-reference" title="Permal
 <li class="toctree-l3"><a class="reference internal" href="api/detector.html#scenedetect.detector.SceneDetector.get_metrics"><code class="docutils literal notranslate"><span class="pre">SceneDetector.get_metrics()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="api/detector.html#scenedetect.detector.SceneDetector.post_process"><code class="docutils literal notranslate"><span class="pre">SceneDetector.post_process()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="api/detector.html#scenedetect.detector.SceneDetector.process_frame"><code class="docutils literal notranslate"><span class="pre">SceneDetector.process_frame()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="api/detector.html#scenedetect.detector.SceneDetector.stats_manager_required"><code class="docutils literal notranslate"><span class="pre">SceneDetector.stats_manager_required()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="api/detector.html#scenedetect.detector.SceneDetector.event_buffer_length"><code class="docutils literal notranslate"><span class="pre">SceneDetector.event_buffer_length</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="api/detector.html#scenedetect.detector.SceneDetector.stats_manager"><code class="docutils literal notranslate"><span class="pre">SceneDetector.stats_manager</span></code></a></li>
 </ul>

docs/head/.doctrees/api/common.doctree

@@ -426,7 +426,7 @@ <h2>Devices / Cameras / Pipes<a class="headerlink" href="#devices-cameras-pipes"
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>path_or_io</strong> (<em>AnyStr</em><em> | </em><em>BinaryIO</em>) – Path to the video, or a file-like object.</p></li>
-<li><p><strong>framerate</strong> (<em>float</em><em> | </em><em>None</em>) – If set, overrides the detected framerate.</p></li>
+<li><p><strong>framerate</strong> (<em>float</em><em> | </em><em>Fraction</em><em> | </em><em>None</em>) – If set, overrides the detected framerate.</p></li>
 <li><p><strong>name</strong> (<em>str</em><em> | </em><em>None</em>) – Overrides the <cite>name</cite> property derived from the video path. Should be set if
 <cite>path_or_io</cite> is a file-like object.</p></li>
 <li><p><strong>threading_mode</strong> (<em>str</em><em> | </em><em>None</em>) – The PyAV video stream <cite>thread_type</cite>. See av.codec.context.ThreadType

docs/head/.doctrees/api/detector.doctree

@@ -93,7 +93,8 @@
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>timecode</strong> (<em>int</em><em> | </em><em>float</em><em> | </em><em>str</em><em> | </em><a class="reference internal" href="#scenedetect.common.Timecode" title="scenedetect.common.Timecode"><em>Timecode</em></a><em> | </em><a class="reference internal" href="#scenedetect.common.FrameTimecode" title="scenedetect.common.FrameTimecode"><em>FrameTimecode</em></a>) – A frame number (<cite>int</cite>), number of seconds (<cite>float</cite>), timecode string in
 the form <cite>‘HH:MM:SS’</cite> or <cite>‘HH:MM:SS.nnn’</cite>, or a <cite>Timecode</cite>.</p></li>
-<li><p><strong>fps</strong> (<em>int</em><em> | </em><em>float</em><em> | </em><em>str</em><em> | </em><a class="reference internal" href="#scenedetect.common.FrameTimecode" title="scenedetect.common.FrameTimecode"><em>FrameTimecode</em></a>) – The framerate or FrameTimecode to use as a time base for all arithmetic.</p></li>
+<li><p><strong>fps</strong> (<em>float</em><em> | </em><a class="reference internal" href="#scenedetect.common.FrameTimecode" title="scenedetect.common.FrameTimecode"><em>FrameTimecode</em></a><em> | </em><em>Fraction</em>) – The framerate to use for distance between frames and to calculate frame numbers.
+For a VFR video, this may just be the average framerate.</p></li>
 </ul>
 </dd>
 <dt class="field-even">Raises<span class="colon">:</span></dt>
@@ -123,14 +124,16 @@
 
 <dl class="py method">
 <dt class="sig sig-object py" id="scenedetect.common.FrameTimecode.get_timecode">
-<span class="sig-name descname"><span class="pre">get_timecode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">precision</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_rounding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#scenedetect.common.FrameTimecode.get_timecode" title="Permalink to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">get_timecode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">precision</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_rounding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nearest_frame</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#scenedetect.common.FrameTimecode.get_timecode" title="Permalink to this definition">¶</a></dt>
 <dd><p>Get a formatted timecode string of the form HH:MM:SS[.nnn].</p>
 <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>precision</strong> (<em>int</em>) – The number of decimal places to include in the output <code class="docutils literal notranslate"><span class="pre">[.nnn]</span></code>.</p></li>
 <li><p><strong>use_rounding</strong> (<em>bool</em>) – Rounds the output to the desired precision. If False, the value
 will be truncated to the specified precision.</p></li>
+<li><p><strong>nearest_frame</strong> (<em>bool</em>) – Ensures that the timecode is moved to the nearest frame boundary if this
+object has a defined framerate, otherwise has no effect.</p></li>
 </ul>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
@@ -142,12 +145,38 @@
 </dl>
 </dd></dl>
 
+<dl class="py property">
+<dt class="sig sig-object py" id="scenedetect.common.FrameTimecode.frame_num">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">frame_num</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#scenedetect.common.FrameTimecode.frame_num" title="Permalink to this definition">¶</a></dt>
+<dd><p>The frame number. This value will be an estimate if the video is VFR. Prefer using the
+<cite>pts</cite> property.</p>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="scenedetect.common.FrameTimecode.framerate">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">framerate</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="headerlink" href="#scenedetect.common.FrameTimecode.framerate" title="Permalink to this definition">¶</a></dt>
+<dd><p>The framerate to use for distance between frames and to calculate frame numbers.
+For a VFR video, this may just be the average framerate.</p>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="scenedetect.common.FrameTimecode.pts">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">pts</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#scenedetect.common.FrameTimecode.pts" title="Permalink to this definition">¶</a></dt>
+<dd><p>The presentation timestamp of the frame in units of <cite>time_base</cite>.</p>
+</dd></dl>
+
 <dl class="py property">
 <dt class="sig sig-object py" id="scenedetect.common.FrameTimecode.seconds">
 <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">seconds</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="headerlink" href="#scenedetect.common.FrameTimecode.seconds" title="Permalink to this definition">¶</a></dt>
 <dd><p>The frame’s position in number of seconds.</p>
 </dd></dl>
 
+<dl class="py property">
+<dt class="sig sig-object py" id="scenedetect.common.FrameTimecode.time_base">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">time_base</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Fraction</span></em><a class="headerlink" href="#scenedetect.common.FrameTimecode.time_base" title="Permalink to this definition">¶</a></dt>
+<dd><p>The time base in which presentation time is calculated.</p>
+</dd></dl>
+
 </dd></dl>
 
 <dl class="py class">
@@ -229,8 +258,8 @@
 
 <dl class="py data">
 <dt class="sig sig-object py" id="scenedetect.common.MAX_FPS_DELTA">
-<span class="sig-prename descclassname"><span class="pre">scenedetect.common.</span></span><span class="sig-name descname"><span class="pre">MAX_FPS_DELTA</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1e-05</span></em><a class="headerlink" href="#scenedetect.common.MAX_FPS_DELTA" title="Permalink to this definition">¶</a></dt>
-<dd><p>Maximum amount two framerates can differ by for equality testing.</p>
+<span class="sig-prename descclassname"><span class="pre">scenedetect.common.</span></span><span class="sig-name descname"><span class="pre">MAX_FPS_DELTA</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1e-09</span></em><a class="headerlink" href="#scenedetect.common.MAX_FPS_DELTA" title="Permalink to this definition">¶</a></dt>
+<dd><p>Maximum amount two framerates can differ by for equality testing. Currently 1 frame/nanosec.</p>
 </dd></dl>
 
 <dl class="py data">