simba-uw-tf-dev 4.5.8__py3-none-any.whl → 4.7.1__py3-none-any.whl

simba/video_processors/videos_to_frames.py

@@ -6,16 +6,17 @@ except:
     from typing_extensions import Literal
 
 import functools
-import multiprocessing
 import os
+from datetime import datetime
 
 import cv2
 
 from simba.utils.checks import (check_if_dir_exists, check_int, check_str,
                                 check_valid_boolean)
+from simba.utils.data import get_cpu_pool, terminate_cpu_pool
 from simba.utils.printing import SimbaTimer, stdout_success
-from simba.utils.read_write import (find_core_cnt, get_video_meta_data,
-                                    read_frm_of_video)
+from simba.utils.read_write import (find_core_cnt, get_fn_ext,
+                                    get_video_meta_data, read_frm_of_video)
 
 JPEG, PNG, WEBP = 'jpeg', 'png', 'webp'
 
@@ -39,7 +40,7 @@ def _video_to_frms_helper(img_batch: Tuple[int, List[int]],
         else:
             save_path = os.path.join(save_dir, f'{frm_idx}.{img_format}')
         if verbose:
-            print(f"Saving image {save_path} ...")
+            print(f"Saving image {save_path} ({frm_idx}/{video_meta_data['frame_count']})...")
         img = read_frm_of_video(video_path=cap, frame_index=frm_idx, greyscale=greyscale, clahe=clahe, black_and_white=black_and_white)
         if img_format == WEBP:
             cv2.imwrite(save_path, img, [cv2.IMWRITE_WEBP_QUALITY, quality])
@@ -50,7 +51,7 @@ def _video_to_frms_helper(img_batch: Tuple[int, List[int]],
     return batch_cnt
 
 def video_to_frames(video_path: Union[str, os.PathLike],
-                    save_dir: Union[str, os.PathLike],
+                    save_dir: Optional[Union[str, os.PathLike]] = None,
                     quality: Optional[int] = 95,
                     img_format: Literal['png', 'webp'] = 'png',
                     verbose: bool = True,
@@ -60,10 +61,16 @@ def video_to_frames(video_path: Union[str, os.PathLike],
                     black_and_white: bool = False,
                     include_video_name_in_filename: bool = True):
 
-
     """
     Extract all frames from a video file and save them as individual image files.
 
+    .. csv-table::
+       :header: EXPECTED RUNTIMES
+       :file: ../../docs/tables/video_to_frames.csv
+       :widths: 10, 45, 45
+       :align: center
+       :header-rows: 1
+
     .. note::
        Uses multiprocessing for faster frame extraction. Frames are saved with sequential numbering (0, 1, 2, ...).
 
@@ -80,8 +87,8 @@ def video_to_frames(video_path: Union[str, os.PathLike],
     :return: None. Frames are saved to disk in the specified directory.
 
     :example:
-    >>> video_to_frames(video_path=r"C:\troubleshooting\SDS_pre_post\project_folder\videos\SDI100 x ALR2 post_d7.mp4", 
-    ...                save_dir=r'C:\troubleshooting\SDS_pre_post\project_folder\videos\test', 
+    >>> video_to_frames(video_path=r"C:/troubleshooting/SDS_pre_post/project_folder/videos/SDI100 x ALR2 post_d7.mp4", 
+    ...                save_dir=r'C:/troubleshooting/SDS_pre_post/project_folder/videos/test', 
     ...                black_and_white=False, 
     ...                verbose=True, 
     ...                img_format='webp', 
@@ -90,7 +97,11 @@ def video_to_frames(video_path: Union[str, os.PathLike],
 
     timer = SimbaTimer(start=True)
     video_meta_data = get_video_meta_data(video_path=video_path)
-    check_if_dir_exists(in_dir=save_dir, source=video_to_frames.__name__, raise_error=True)
+    if save_dir is not None:
+        check_if_dir_exists(in_dir=save_dir, source=video_to_frames.__name__, raise_error=True)
+    else:
+        save_dir = os.path.join(get_fn_ext(filepath=video_path)[0], f'{video_meta_data["video_name"]}_frames_{datetime.now().strftime("%Y%m%d%H%M%S")}')
+        os.makedirs(save_dir)
     check_valid_boolean(value=verbose, source=f'{video_to_frames.__name__} verbose')
     check_valid_boolean(value=clahe, source=f'{video_to_frames.__name__} clahe')
     check_valid_boolean(value=greyscale, source=f'{video_to_frames.__name__} greyscale')
@@ -98,35 +109,35 @@ def video_to_frames(video_path: Union[str, os.PathLike],
     check_valid_boolean(value=include_video_name_in_filename, source=f'{video_to_frames.__name__} include_video_name_in_filename')
     check_int(name=f'{video_to_frames.__name__} core_cnt', value=core_cnt, min_value=-1, unaccepted_vals=[0], raise_error=True)
     check_int(name=f'{video_to_frames.__name__} quality', value=quality, min_value=1, max_value=100, raise_error=True)
-    core_cnt = find_core_cnt()[0] if core_cnt -1 or core_cnt > find_core_cnt()[0] else core_cnt
+    core_cnt = find_core_cnt()[0] if core_cnt == -1 or core_cnt > find_core_cnt()[0] else core_cnt
     check_str(name=f'{video_to_frames.__name__} img_format', value=img_format, options=('jpeg', 'png', 'webp'))
     frm_ids = list(range(0, video_meta_data['frame_count']))
     frm_ids = [frm_ids[i * len(frm_ids) // core_cnt: (i + 1) * len(frm_ids) // core_cnt] for i in range(core_cnt)]
     frm_ids = [(i, j) for i, j in enumerate(frm_ids)]
-    with multiprocessing.Pool(core_cnt, maxtasksperchild=100) as pool:
-        constants = functools.partial(_video_to_frms_helper,
-                                          verbose=verbose,
-                                          img_format=img_format,
-                                          quality=quality,
-                                          greyscale=greyscale,
-                                          black_and_white=black_and_white,
-                                          include_video_name_in_filename=include_video_name_in_filename,
-                                          video_path=video_path,
-                                          clahe=clahe,
-                                          save_dir=save_dir)
-        for cnt, batch_id in enumerate(pool.imap(constants, frm_ids, chunksize=1)):
-            if verbose:
-                print(f'Video frame batch {batch_id} (of {core_cnt}) complete...')
-    pool.join()
-    pool.terminate()
+    pool = get_cpu_pool(core_cnt=core_cnt, source=video_to_frames.__name__)
+    constants = functools.partial(_video_to_frms_helper,
+                                      verbose=verbose,
+                                      img_format=img_format,
+                                      quality=quality,
+                                      greyscale=greyscale,
+                                      black_and_white=black_and_white,
+                                      include_video_name_in_filename=include_video_name_in_filename,
+                                      video_path=video_path,
+                                      clahe=clahe,
+                                      save_dir=save_dir)
+    for cnt, batch_id in enumerate(pool.imap(constants, frm_ids, chunksize=1)):
+        if verbose:
+            print(f'Video frame batch {batch_id} (of {core_cnt}) complete...')
+
+    terminate_cpu_pool(pool=pool, force=True, source=video_to_frames.__name__)
     timer.stop_timer()
-    if verbose:
-        stdout_success(msg=f'All frames for video {video_path} saved in {save_dir}', elapsed_time=timer.elapsed_time_str)
+    if verbose: stdout_success(msg=f'All frames ({video_meta_data["frame_count"]}) for video {video_path} saved in {save_dir}', elapsed_time=timer.elapsed_time_str)
 
 # if __name__ == "__main__":
-#     video_to_frames(video_path=r"C:\troubleshooting\SDS_pre_post\project_folder\videos\SDI100 x ALR2 post_d7.mp4",
-#                     save_dir=r'C:\troubleshooting\SDS_pre_post\project_folder\videos\test',
+#     video_to_frames(video_path=r"D:\troubleshooting\mitra\project_folder\videos\average_cpu_test\15min.mp4",
+#                     save_dir=None,
 #                     black_and_white=False,
 #                     verbose=True,
-#                     img_format='webp',
-#                     clahe=True)
+#                     img_format='png',
+#                     clahe=False,
+#                     core_cnt=18)

{simba_uw_tf_dev-4.5.8.dist-info → simba_uw_tf_dev-4.7.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: simba-uw-tf-dev
-Version: 4.5.8
+Version: 4.7.1
 Summary: Toolkit for computer classification and analysis of behaviors in experimental animals
 Home-page: https://github.com/sgoldenlab/simba
 Author: Simon Nilsson, Jia Jie Choong, Sophia Hwang
@@ -79,7 +79,7 @@ Requires-Dist: yellowbrick (==1.5.0) ; python_version >= "3.9"
 Requires-Dist: kaleido ; python_version >= "3.9"
 Requires-Dist: psutil ; python_version >= "3.9"
 Requires-Dist: h5py (==3.11.0) ; python_version >= "3.9"
-Requires-Dist: numba (==0.59.1) ; python_version >= "3.9"
+Requires-Dist: numba (==0.63.1) ; python_version >= "3.9"
 Requires-Dist: numexpr (==2.10.0) ; python_version >= "3.9"
 Requires-Dist: statsmodels (==0.14.2) ; python_version >= "3.9"
 Requires-Dist: shap (==0.42.0) ; python_version >= "3.9"
@@ -138,11 +138,12 @@ Requires-Dist: numexpr (==2.10.0) ; (python_version >= "3.9") and extra == 'arm'
 Requires-Dist: statsmodels (==0.14.2) ; (python_version >= "3.9") and extra == 'arm'
 Requires-Dist: tables (==3.9.2) ; (python_version >= "3.9") and extra == 'arm'
 Provides-Extra: gpu
-Requires-Dist: cupy-cuda12x (==13.3.0) ; extra == 'gpu'
+Requires-Dist: cupy-cuda12x (>=13.6.0) ; extra == 'gpu'
 Requires-Dist: shap (==0.46.1.dev78) ; extra == 'gpu'
 Requires-Dist: cuml-cu12 (==24.12.0) ; extra == 'gpu'
 Requires-Dist: torch (==2.5.0) ; extra == 'gpu'
 Requires-Dist: ultralytics (==8.3.156) ; extra == 'gpu'
+Requires-Dist: nvidia-cuda-runtime-cu12 ; extra == 'gpu'
 
 # SimBA (Simple Behavioral Analysis)
 ![SimBA Splash](https://raw.githubusercontent.com/sgoldenlab/simba/master/docs/tutorials_rst/img/index/landing_page_1.png)