numpyimage 3.4.2__tar.gz → 3.5.0__tar.gz

{numpyimage-3.4.2/numpyimage.egg-info → numpyimage-3.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: numpyimage
-Version: 3.4.2
+Version: 3.5.0
 Summary: Load, save, & manipulate image files as numpy arrays
 Author-email: Jasper Phelps <jasper.s.phelps@gmail.com>
 License: MIT License
@@ -36,6 +36,7 @@ Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: numpy
+Requires-Dist: tqdm
 Requires-Dist: pillow
 Requires-Dist: pillow-heif
 Requires-Dist: tifffile
@@ -43,7 +44,6 @@ Requires-Dist: pynrrd
 Requires-Dist: matplotlib
 Requires-Dist: opencv-python-headless
 Provides-Extra: all
-Requires-Dist: tqdm; extra == "all"
 Requires-Dist: av; extra == "all"
 Dynamic: license-file
 

{numpyimage-3.4.2 → numpyimage-3.5.0}/npimage/vidio.py

@@ -25,6 +25,7 @@ import json
 from fractions import Fraction
 
 import numpy as np
+from tqdm import tqdm
 
 from . import utils
 
@@ -44,6 +45,15 @@ codec_aliases = {
 supported_extensions = ['mp4', 'mkv', 'avi', 'mov', 'webm']
 
 
+def _import_av():
+    try:
+        import av
+        return av
+    except ImportError:
+        raise ImportError('Missing optional dependency for video processing,'
+                          ' run `pip install av` and try again')
+
+
 def load_video(filename,
                return_framerate=False,
                progress_bar=True) -> Union[np.ndarray, Tuple[np.ndarray, float]]:
@@ -69,13 +79,7 @@ def load_video(filename,
         framerate : float
             The frame rate of the video in frames per second
     """
-    try:
-        import av
-        from tqdm import tqdm
-    except ImportError:
-        raise ImportError('Missing optional dependency for video processing,'
-                          ' run `pip install av tqdm`')
-
+    av = _import_av()
     with av.open(filename) as container:
         stream = container.streams.video[0]
         num_frames = stream.frames
@@ -132,11 +136,7 @@ def lazy_load_video(filename) -> Iterator[np.ndarray]:
     frame : np.ndarray
         Video frame as a numpy array, shape (height, width, colors).
     """
-    try:
-        import av
-    except ImportError:
-        raise ImportError('Missing optional dependency for video processing,'
-                          ' run `pip install av tqdm`')
+    av = _import_av()
     with av.open(Path(filename).expanduser()) as container:
         stream = container.streams.video[0]
         for frame in container.decode(stream):
@@ -149,19 +149,33 @@ class VideoSeekError(RuntimeError):
 
 
 class VideoStreamer:
-    def __init__(self, filename, verbose: bool = False):
-        try:
-            import av
-            self.av = av
-        except ImportError:
-            raise ImportError('Missing optional dependency for video processing,'
-                              ' run `pip install av tqdm`')
+    def __init__(self,
+                 filename: str,
+                 verbose: bool = False,
+                 cache_index: Literal['auto', True, False] = 'auto'):
+        """
+        Parameters
+        ----------
+        filename : str
+            Path to the video file.
+
+        verbose : bool, default False
+            If True, print progress messages.
+
+        cache_index : 'auto' (default), True, or False
+            **Definitely set this to True in code where speed matters!**
+            Whether to cache the frame timestamp index to a .index file
+            next to the video file for faster loading next time.
+            If 'auto', the index is cached only if building it takes
+            more than 0.5 seconds, which only happens for ~1+ GB videos.
+        """
+        self.av = _import_av()
         self.verbose = verbose
         self.filename = Path(filename).expanduser()
         if not self.filename.exists():
             raise FileNotFoundError(f'File {filename} not found')
 
-        self.container = av.open(str(self.filename))
+        self.container = self.av.open(str(self.filename))
         self.stream = self.container.streams.video[0]
         self.time_base = self.stream.time_base
         self._frame_iterator = self.container.decode(self.stream)
@@ -175,12 +189,17 @@ class VideoStreamer:
         self._lock = threading.Lock()
 
         self.index_filename = self.filename.with_suffix(self.filename.suffix + '.index')
-        self._load_index()
+        self._build_index(cache_index=cache_index)
 
-    def _build_index(self):
+    def _build_index(self, cache_index='auto'):
+        if self.index_filename.exists():
+            return self._load_index()
         if self.verbose:
             print('Building frame timestamp index for fast random frame access...')
 
+        import time
+        start_time = time.time()
+
         frames_pts = []
         # Try getting frame PTS values fast using PyAV
         try:
@@ -255,15 +274,16 @@ class VideoStreamer:
             index['frames_pts'] = frames_pts
         else:
             index['pts0'] = self.pts0
-        with open(self.index_filename, 'w') as f:
-            json.dump(index, f)
-        if self.verbose:
-            print(f'Cached index at "{self.index_filename}"')
+
+        if cache_index is True or (cache_index == 'auto'
+                                   and time.time() - start_time > 0.5):
+            with open(self.index_filename, 'w') as f:
+                json.dump(index, f)
+            if self.verbose:
+                print(f'Cached index at "{self.index_filename}"')
 
     def _load_index(self):
-        if not self.index_filename.exists():
-            self._build_index()
-        elif self.verbose:
+        if self.verbose:
             print(f'Loading frame timestamp index from "{self.index_filename}"')
 
         with open(self.index_filename, 'r') as f:
@@ -517,6 +537,12 @@ class VideoStreamer:
         except Exception:
             pass
 
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        self.close()
+
 
 class AVVideoWriter:
     """
@@ -550,12 +576,7 @@ class AVVideoWriter:
     def __init__(self, filename, framerate=30, crf=23, compression_speed='medium',
                  codec: Literal['libx264', 'libx265'] = 'libx264',
                  overwrite=False):
-        try:
-            import av
-        except ImportError:
-            raise ImportError('Missing optional dependency for video processing,'
-                              ' run `pip install av tqdm`')
-        self.av = av
+        self.av = _import_av()
         filename = Path(filename).expanduser()
         if filename.exists() and not overwrite:
             raise FileExistsError(f'File {filename} already exists. '
@@ -565,7 +586,7 @@ class AVVideoWriter:
         self.crf = crf
         self.compression_speed = compression_speed
         self.codec = codec_aliases[codec.lower()]
-        self.container = av.open(filename, mode='w')
+        self.container = self.av.open(filename, mode='w')
         self.stream = self.container.add_stream(self.codec, rate=self._framerate)
         self.stream.pix_fmt = 'yuv420p'
         self.stream.options = {'crf': str(crf), 'preset': compression_speed}
@@ -849,11 +870,6 @@ def save_video(data, filename, time_axis=0, color_axis=None, overwrite=False,
         The video codec to use for encoding. Can be any of a number of aliases for
         these two codecs, including avc1/h264 vs hevc/hvc1/hev1/h265.
     """
-    try:
-        from tqdm import tqdm
-    except ImportError:
-        raise ImportError('Missing optional dependency for video processing,'
-                          ' run `pip install av tqdm`')
 
     filename = str(filename)
     if filename.split('.')[-1].lower() not in supported_extensions:

{numpyimage-3.4.2 → numpyimage-3.5.0/numpyimage.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: numpyimage
-Version: 3.4.2
+Version: 3.5.0
 Summary: Load, save, & manipulate image files as numpy arrays
 Author-email: Jasper Phelps <jasper.s.phelps@gmail.com>
 License: MIT License
@@ -36,6 +36,7 @@ Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: numpy
+Requires-Dist: tqdm
 Requires-Dist: pillow
 Requires-Dist: pillow-heif
 Requires-Dist: tifffile
@@ -43,7 +44,6 @@ Requires-Dist: pynrrd
 Requires-Dist: matplotlib
 Requires-Dist: opencv-python-headless
 Provides-Extra: all
-Requires-Dist: tqdm; extra == "all"
 Requires-Dist: av; extra == "all"
 Dynamic: license-file
 

{numpyimage-3.4.2 → numpyimage-3.5.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = 'setuptools.build_meta'
 
 [project]
 name = 'numpyimage'
-version = '3.4.2'
+version = '3.5.0'
 description = 'Load, save, & manipulate image files as numpy arrays'
 readme.file = 'README.md'
 readme.content-type = 'text/markdown'
@@ -22,6 +22,7 @@ classifiers = [
 urls = {Repository = 'https://github.com/jasper-tms/npimage'}
 dependencies = [
     'numpy',
+    'tqdm',
     'pillow',
     'pillow-heif',
     'tifffile',
@@ -32,8 +33,7 @@ dependencies = [
 
 [project.optional-dependencies]
 all = [
-    "tqdm",
-    "av"
+    'av'
 ]
 
 [tool.setuptools.packages.find]

{numpyimage-3.4.2 → numpyimage-3.5.0}/numpyimage.egg-info/requires.txt

@@ -1,4 +1,5 @@
 numpy
+tqdm
 pillow
 pillow-heif
 tifffile
@@ -7,5 +8,4 @@ matplotlib
 opencv-python-headless
 
 [all]
-tqdm
 av