numpyimage 3.8.0__tar.gz → 3.8.2__tar.gz

{numpyimage-3.8.0 → numpyimage-3.8.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: numpyimage
-Version: 3.8.0
+Version: 3.8.2
 Summary: Load, save, & manipulate image files as numpy arrays
 Author-email: Jasper Phelps <jasper.s.phelps@gmail.com>
 License: MIT License

{numpyimage-3.8.0 → numpyimage-3.8.2}/npimage/vidio.py

@@ -21,6 +21,8 @@ Class list:
 from typing import Union, Tuple, Iterator, Literal
 from pathlib import Path
 import subprocess
+import shutil
+import sys
 import threading
 import json
 import math
@@ -70,6 +72,43 @@ def _import_av():
                           ' run `pip install av` and try again')
 
 
+def _check_ffmpeg_available(program: Literal['ffmpeg', 'ffprobe'] = 'ffmpeg'):
+    """
+    Check that ffmpeg or ffprobe is on PATH, and raise a
+    FileNotFoundError with installation instructions if not.
+    """
+    if shutil.which(program) is not None:
+        return
+    if sys.platform.startswith('linux'):
+        install_hint = (
+            'On Debian/Ubuntu:  sudo apt install ffmpeg\n'
+            '  On Fedora/RHEL:    sudo dnf install ffmpeg\n'
+            '  On Arch:           sudo pacman -S ffmpeg'
+        )
+    elif sys.platform == 'darwin':
+        install_hint = (
+            'With Homebrew:     brew install ffmpeg\n'
+            '  With MacPorts:     sudo port install ffmpeg'
+        )
+    elif sys.platform.startswith('win'):
+        install_hint = (
+            'With winget:       winget install ffmpeg\n'
+            '  With Chocolatey:   choco install ffmpeg\n'
+            '  Or download a static build from https://ffmpeg.org/download.html'
+            ' and add it to your PATH.'
+        )
+    else:
+        install_hint = (
+            'See https://ffmpeg.org/download.html for installation'
+            ' instructions for your platform.'
+        )
+    raise FileNotFoundError(
+        f"`{program}` was not found on PATH. npimage.vidio needs the ffmpeg"
+        f" suite installed to read and write video files.\n\n"
+        f"Install ffmpeg:\n  {install_hint}"
+    )
+
+
 def load_video(filename,
                return_framerate=False,
                progress_bar=True) -> Union[np.ndarray, Tuple[np.ndarray, float]]:
@@ -285,6 +324,7 @@ class VideoStreamer:
                 print('Falling back to ffprobe...')
             frames_pts = []
             # Fallback to ffprobe if PyAV didn't work
+            _check_ffmpeg_available('ffprobe')
             cmd = ['ffprobe',
                    '-select_streams', 'v:0',
                    '-show_frames',
@@ -885,6 +925,8 @@ class FFmpegVideoWriter:
         # Initialize process state
         self._process = None
         self._stdin = None
+        self._stderr_thread = None
+        self._stderr_buffer = b''
         self._closed = False
         self._width = None
         self._height = None
@@ -945,6 +987,7 @@ class FFmpegVideoWriter:
         command.append(str(self.filename))
 
         # Start FFmpeg process
+        _check_ffmpeg_available('ffmpeg')
         self._process = subprocess.Popen(
             command,
             stdin=subprocess.PIPE,
@@ -953,6 +996,15 @@ class FFmpegVideoWriter:
         )
         self._stdin = self._process.stdin
 
+        # Drain ffmpeg's stderr in a background thread so a verbose or
+        # erroring ffmpeg can't fill the pipe buffer (~64 KB on Linux, smaller
+        # on Windows) and deadlock our writes to stdin.
+        def _drain_stderr():
+            self._stderr_buffer = self._process.stderr.read()
+        self._stderr_thread = threading.Thread(target=_drain_stderr,
+                                               daemon=True)
+        self._stderr_thread.start()
+
     def write(self, frame):
         """Write a frame to the video file"""
         if self._closed:
@@ -1013,8 +1065,10 @@ class FFmpegVideoWriter:
 
             # Wait for FFmpeg to finish
             if self._process:
-                stderr_data = self._process.stderr.read()
                 return_code = self._process.wait()
+                if self._stderr_thread is not None:
+                    self._stderr_thread.join()
+                stderr_data = self._stderr_buffer
 
                 # Check for errors
                 if return_code != 0:
@@ -1024,6 +1078,7 @@ class FFmpegVideoWriter:
             # Clean up process references
             self._process = None
             self._stdin = None
+            self._stderr_thread = None
             self._closed = True
 
     def __enter__(self):
@@ -1176,6 +1231,8 @@ def _get_rotation_from_metadata(filename):
     We could use PyAV to do this perhaps faster, but for an already fast operation
     like this, we stick with ffprobe to avoid the memory leaks in PyAV.
     """
+    if shutil.which('ffprobe') is None:
+        return None
     cmd = ['ffprobe',
            '-v', 'quiet',
            '-select_streams', 'v:0',

{numpyimage-3.8.0 → numpyimage-3.8.2}/numpyimage.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: numpyimage
-Version: 3.8.0
+Version: 3.8.2
 Summary: Load, save, & manipulate image files as numpy arrays
 Author-email: Jasper Phelps <jasper.s.phelps@gmail.com>
 License: MIT License

{numpyimage-3.8.0 → numpyimage-3.8.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = 'setuptools.build_meta'
 
 [project]
 name = 'numpyimage'
-version = '3.8.0'
+version = '3.8.2'
 description = 'Load, save, & manipulate image files as numpy arrays'
 readme.file = 'README.md'
 readme.content-type = 'text/markdown'