[dist] Only depend on opencv-contrib-python #251

Author: Breakthrough

dist/requirements_windows.txt

@@ -2,7 +2,6 @@
 # DVR-Scan Requirements for Windows Build
 #
 numpy==2.2.0
-opencv-python==4.10.0.84
 opencv-contrib-python==4.10.0.84
 pillow==11.0.0
 platformdirs==4.3.6

docs/changelog.md

@@ -15,6 +15,7 @@ Includes several critical bugfixes and improvements when processing multiple inp
 
  * [general] Minimum supported Python version is now 3.10 (Python 3.9 is [EOL](https://devguide.python.org/versions/))
  * [general] An error is now displayed when launching the app fails due to an invalid config file [#241](https://github.com/Breakthrough/DVR-Scan/issues/241)
+ * [general] Python package now only depends on `opencv-contrib-python` or `opencv-contrib-python-headless` [#251](https://github.com/Breakthrough/DVR-Scan/issues/251)
  * [bugfix] Fix `quiet-mode` setting (`-q`/`--quiet` flag) still allowing extraneous output [#243](https://github.com/Breakthrough/DVR-Scan/issues/243)
  * [bugfix] Fix loading config from file in UI [#253](https://github.com/Breakthrough/DVR-Scan/issues/253)
  * [bugfix] Fix scan error when enabling "Use PTS" input option with multiple videos [#254](https://github.com/Breakthrough/DVR-Scan/issues/254)

dvr_scan/opencv_loader.py

@@ -26,12 +26,9 @@
         CUDA_BIN_PATH = os.path.abspath(os.path.join(CUDA_PATH, "bin"))
         os.add_dll_directory(CUDA_BIN_PATH)
 
-# OpenCV is a required package, but we don't have it as an explicit dependency since we
-# need to support both opencv-python and opencv-python-headless. Include some additional
-# context with the exception if this is the case.
-
 if not importlib.util.find_spec("cv2"):
     raise ModuleNotFoundError(
-        "OpenCV could not be found, try installing opencv-python:\n\npip install opencv-python",
+        "OpenCV could not be found, try installing opencv-contrib-python:"
+        "\n\npip install opencv-contrib-python",
         name="cv2",
     )

dvr_scan/video_joiner.py

@@ -188,5 +188,5 @@ def _load_input_videos(self, backend: str):
             logger.error(
                 "Unsupported or invalid codec, output may be incorrect. Possible fixes:\n"
                 "  - Re-encode the input video with ffmpeg\n"
-                "  - Update OpenCV (pip install --upgrade opencv-python)"
+                "  - Update OpenCV (pip install --upgrade opencv-contrib-python)"
             )

requirements.txt

@@ -3,7 +3,6 @@
 #
 numpy
 # TODO(#257): Unpin OpenCV versions once we figure out why frame numbers are mismatching in tests.
-opencv-python<4.13
 opencv-contrib-python<4.13
 pillow
 platformdirs

requirements_headless.txt

@@ -3,7 +3,6 @@
 #
 numpy
 # TODO(#257): Unpin OpenCV versions once we figure out why frame numbers are mismatching in tests.
-opencv-python-headless<4.13
 opencv-contrib-python-headless<4.13
 pillow
 platformdirs

setup.cfg

@@ -50,7 +50,6 @@ install_requires =
     screeninfo
     tqdm
 # TODO(#257): Unpin OpenCV versions once we figure out why frame numbers are mismatching in tests.
-    opencv-python<4.13
     opencv-contrib-python<4.13
     pillow
 packages =