Skip to content

Commit ffcfec7

Browse files
author
github-actions
committed
[docs] @Breakthrough: Generate Website
Commit: 523a83f
1 parent eec69d3 commit ffcfec7

6 files changed

Lines changed: 30 additions & 14 deletions

File tree

changelog/index.html

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -924,14 +924,14 @@ <h3 id="01-alpha-june-8-2014">0.1-alpha (June 8, 2014)</h3>
924924
<h1 id="development">Development</h1>
925925
<h2 id="pyscenedetect-07-in-development">PySceneDetect 0.7 (In Development)</h2>
926926
<h3 id="release-notes_12">Release Notes</h3>
927-
<p>PySceneDetect is a major breaking release which overhauls how timestamps are handled throughout the API. This allows PySceneDetect to properly process variable framerate (VFR) videos. A significant amount of technical debt has been addressed, including removal of deprecated or overly complicated APIs.</p>
927+
<p>PySceneDetect 0.7 is a <strong>major breaking release</strong> which overhauls how timestamps are handled. This allows PySceneDetect to properly process variable framerate (VFR) videos. A significant amount of technical debt has been addressed, including removal of deprecated or overly complicated APIs.</p>
928928
<p>Care was taken to minimize changes for most common API uses, however more advanced use cases may run into breaking changes. Please review <a href="https://www.scenedetect.com/docs/0.7/api/migration_guide.html">the Migration Guide</a> when updating from v0.6. Minimum supported Python version is now <strong>Python 3.10</strong>.</p>
929929
<h3 id="cli-changes">CLI Changes</h3>
930930
<ul>
931931
<li>[feature] VFR videos are handled correctly by the OpenCV and PyAV backends, and should work correctly with default parameters</li>
932+
<li>[feature] All CLI options which used to accept frame numbers only now accept seconds (e.g. <code>0.6s</code>) and timecodes (e.g. <code>00:00:00.600</code>) <a href="https://github.com/Breakthrough/PySceneDetect/issues/531">#531</a></li>
932933
<li>[feature] New <code>save-fcp</code> command allows exporting in Final Cut Pro format (FCP7/FCPX) <a href="https://github.com/Breakthrough/PySceneDetect/issues/156">#156</a></li>
933-
<li>[feature] <code>--min-scene-len</code>/<code>-m</code> and <code>save-images --frame-margin</code>/<code>-m</code> now accept seconds (e.g. <code>0.6s</code>) and timecodes (e.g. <code>00:00:00.600</code>) in addition to a frame count <a href="https://github.com/Breakthrough/PySceneDetect/issues/531">#531</a></li>
934-
<li>[feature] <code>save-edl</code> accepts a new <code>--start-timecode</code>/<code>-s</code> flag (SMPTE <code>HH:MM:SS:FF</code> or 8-digit <code>HHMMSSFF</code>) to stamp every event with a custom start timecode so generated EDLs align with the source media's on-screen timecode <a href="https://github.com/Breakthrough/PySceneDetect/issues/515">#515</a></li>
934+
<li>[feature] Add <code>save-edl</code> option <code>--start-timecode</code>/<code>-s</code> to providde a custom start timecode for generated EDLs, supports SMPTE <code>HH:MM:SS:FF</code> or 8-digit <code>HHMMSSFF</code> input <a href="https://github.com/Breakthrough/PySceneDetect/issues/515">#515</a></li>
935935
<li>[bugfix] Fix floating-point precision error in <code>save-otio</code> output where frame values near integer boundaries (e.g. <code>90.00000000000001</code>) were serialized with spurious precision</li>
936936
<li>[bugfix] Add mitigation for transient <code>OSError</code> in the MoviePy backend as it is susceptible to subprocess pipe races on slow or heavily loaded systems <a href="https://github.com/Breakthrough/PySceneDetect/issues/496">#496</a></li>
937937
<li>[bugfix] <code>detect-threshold</code> cut frame numbers are now backend-deterministic; previously the cut could differ by 1 frame between PyAV and OpenCV when the fade midpoint landed on a <code>.5</code> rounding boundary (PyAV uses sub-microsecond PTS, OpenCV uses millisecond-truncated <code>CAP_PROP_POS_MSEC</code>)</li>
@@ -996,6 +996,22 @@ <h3 id="api-changes">API Changes</h3>
996996
<li>Remove <code>advance</code> parameter from <code>VideoStream.read()</code></li>
997997
<li>Remove <code>SceneDetector.stats_manager_required</code> property, no longer required</li>
998998
<li><code>SceneDetector</code> is now a <a href="https://docs.python.org/3/library/abc.html">Python abstract class</a></li>
999+
</ul>
1000+
<h3 id="windows-distribution">Windows Distribution</h3>
1001+
<ul>
1002+
<li>[general] Updates to Windows distributions:<ul>
1003+
<li>av 14.2.0 -&gt; 17.0.1</li>
1004+
<li>click 8.1.8 -&gt; 8.2.1</li>
1005+
<li>imageio-ffmpeg 0.6.0</li>
1006+
<li>moviepy 2.1.2 -&gt; 2.2.1</li>
1007+
<li>numpy 2.2.3 -&gt; 2.4.4</li>
1008+
<li>opencv-python-headless 4.11.0.86 -&gt; 4.13.0.92</li>
1009+
<li>platformdirs 4.3.6 -&gt; 4.9.6</li>
1010+
<li>tqdm 4.67.1 -&gt; 4.67.3</li>
1011+
<li>ffmpeg 8.0 -&gt; 8.1</li>
1012+
</ul>
1013+
</li>
1014+
<li>[general] Reduce size of Windows distribution by requiring <code>imageio_ffmpeg</code> to use non-bundled instance</li>
9991015
</ul>
10001016

10011017
</div>

download/index.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -142,13 +142,13 @@ <h1 id="download">Download</h1>
142142
<p>PySceneDetect requires at least Python 3.10 or higher.</p>
143143
<h2 id="install-via-pip">Install via pip &nbsp; <span class="wy-text-neutral"><span class="fa fa-windows"></span> &nbsp; <span class="fa fa-linux"></span> &nbsp; <span class="fa fa-apple"></span></span></h3></h2>
144144
<div class="important">
145-
<h4 class="wy-text-neutral"><span class="fa fa-angle-double-down wy-text-info"></span> Including OpenCV (recommended):</h4>
146-
<h3 class="wy-text-neutral"><tt>pip install --upgrade scenedetect[opencv]</tt></h3>
147-
<h4 class="wy-text-neutral"><span class="fa fa-angle-down wy-text-info"></span> Including Headless OpenCV (servers):</h4>
148-
<h3 class="wy-text-neutral"><tt>pip install --upgrade scenedetect[opencv-headless]</tt></h3>
145+
<h4 class="wy-text-neutral"><span class="fa fa-angle-double-down wy-text-info"></span> Standard install (recommended):</h4>
146+
<h3 class="wy-text-neutral"><tt>pip install --upgrade scenedetect</tt></h3>
147+
<h4 class="wy-text-neutral"><span class="fa fa-angle-down wy-text-info"></span> Headless install (servers, no GUI libs):</h4>
148+
<h3 class="wy-text-neutral"><tt>pip install --upgrade scenedetect-headless</tt></h3>
149149
</div>
150150

151-
<p>PySceneDetect is available via <code>pip</code> as <a href="https://pypi.org/project/scenedetect/">the <code>scenedetect</code> package</a>.</p>
151+
<p>PySceneDetect is available via <code>pip</code> as either <a href="https://pypi.org/project/scenedetect/"><code>scenedetect</code></a> (depends on <code>opencv-python</code>) or <a href="https://pypi.org/project/scenedetect-headless/"><code>scenedetect-headless</code></a> (depends on <code>opencv-python-headless</code>). Both ship the same <code>scenedetect</code> Python module -- install whichever OpenCV variant suits your environment.</p>
152152
<h2 id="windows-build-64-bit-only">Windows Build (64-bit Only) &nbsp; <span class="wy-text-neutral"><span class="fa fa-windows"></span></span></h2>
153153
<div class="important">
154154
<h3 class="wy-text-neutral"><span class="fa fa-forward wy-text-info"></span> Latest Release: <b class="wy-text-neutral">v0.6.7</b></h3>

faq/index.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -129,13 +129,13 @@
129129

130130
<h2 id="frequently-asked-questions"><span class="fa fa-question-circle"></span>&nbsp; Frequently Asked Questions</h2>
131131
<h4 id="how-can-i-fix-importerror-no-module-named-cv2">How can I fix <code>ImportError: No module named cv2</code>?</h4>
132-
<p>You need to install OpenCV for PySceneDetect to properly work. If you're using <code>pip</code>, you can install it as follows:</p>
133-
<pre><code class="language-md">pip install scenedetect[opencv]
132+
<p>As of PySceneDetect 0.7, the OpenCV dependency is bundled with the install. The standard <code>scenedetect</code> package depends on <code>opencv-python</code>:</p>
133+
<pre><code class="language-md">pip install scenedetect
134134
</code></pre>
135-
<p>Note that you may need to use a different/older version depending on your Python version. You can also use the headless package if you're running a server:</p>
136-
<pre><code class="language-md">pip install scenedetect[opencv-headless]
135+
<p>For server environments without GUI libraries, install the headless variant instead, which depends on <code>opencv-python-headless</code>:</p>
136+
<pre><code class="language-md">pip install scenedetect-headless
137137
</code></pre>
138-
<p>Unlike calling <code>pip install opencv-python</code>, the above commands will download and install the correct OpenCV version based on the Python version you are running.</p>
138+
<p>Both packages ship the same <code>scenedetect</code> Python module -- you only need one.</p>
139139
<h4 id="how-can-i-enable-video-splitting-support">How can I enable video splitting support?</h4>
140140
<p>Video splitting is performed by <code>ffmpeg</code> (<a href="https://ffmpeg.org/download.html">https://ffmpeg.org/download.html</a>) or <code>mkvmerge</code> (https://mkvtoolnix.download/downloads.html) depending on which command line arguments are used. Ensure the tool is available and somewhere in your system's PATH folder.</p>
141141
<h4 id="how-can-i-fix-the-error-cannot-split-video-due-to-too-many-scenes">How can I fix the error <code>Cannot split video due to too many scenes</code>?</h4>

img/favicon.ico

1.06 KB
Binary file not shown.

search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

sitemap.xml.gz

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)