refactor: ♻️ change FILE_FORMAT to enum.Enum

src/python/librir/video_io/IRMovie.py

@@ -12,7 +12,6 @@
 from librir.tools.FileAttributes import FileAttributes
 from librir.tools._thermavip import init_thermavip, unbind_thermavip_shared_mem
 from librir.video_io.rir_video_io import (
-    FILE_FORMAT_H264,
     enable_motion_correction,
     load_motion_correction_file,
     motion_correction_enabled,
@@ -21,6 +20,7 @@
 
 from .IRSaver import IRSaver
 from .rir_video_io import (
+    FileFormat,
     calibrate_image,
     calibration_files,
     close_camera,
@@ -536,7 +536,7 @@ def _build_outfile(self) -> str:
         parent, basename = os.path.split(f)
         stem = basename.replace(suffix, "")
 
-        if self.video_file_format != FILE_FORMAT_H264:
+        if self.video_file_format != FileFormat.H264:
             return os.path.abspath((os.path.join(parent, (stem + ".h264"))))
 
         return self.filename

src/python/librir/video_io/__init__.py

@@ -6,11 +6,6 @@
 
 # import useful functions from rir_video_io
 from .rir_video_io import (
-    FILE_FORMAT_H264,
-    FILE_FORMAT_PCR,
-    FILE_FORMAT_PCR_ENCAPSULATED,
-    FILE_FORMAT_WEST,
-    FILE_FORMAT_ZSTD_COMPRESSED,
     correct_PCR_file,
     video_file_format,
     get_filename,
@@ -23,10 +18,6 @@
     "IRMovie",
     "is_ir_file_corrupted",
     "video_file_format",
-    "FILE_FORMAT_PCR",
-    "FILE_FORMAT_WEST",
-    "FILE_FORMAT_PCR_ENCAPSULATED",
-    "FILE_FORMAT_ZSTD_COMPRESSED",
-    "FILE_FORMAT_H264",
+    "FileFormat",
     "get_filename",
 ]

src/python/librir/video_io/rir_video_io.py

@@ -2,21 +2,28 @@
 import logging
 
 import numpy as np
-
+import enum
 from ..low_level.misc import _video_io, toArray, toBytes, toString
 
 logging.basicConfig()
 logger = logging.getLogger(__name__)
 logger.setLevel(logging.INFO)
 
-
 FILE_FORMAT_PCR = 1
 FILE_FORMAT_WEST = 2
 FILE_FORMAT_PCR_ENCAPSULATED = 3
 FILE_FORMAT_ZSTD_COMPRESSED = 4
 FILE_FORMAT_H264 = 5
 
 
+class FileFormat(enum.Enum):
+    PCR = 1
+    WEST = 2
+    PCR_ENCAPSULATED = 3
+    ZSTD_COMPRESSED = 4
+    H264 = 5
+
+
 def open_camera_file(filename):
     """
     Open a video file.

tests/python/test_IRMovie.py

@@ -1,14 +1,14 @@
 from pathlib import Path
 import random
 from typing import Dict
+from librir.video_io.rir_video_io import FileFormat
 from librir.video_io.utils import is_ir_file_corrupted, split_rush
 
 import numpy as np
 import numpy.testing as npt
 import pytest
 from librir import IRMovie
 from librir.video_io.IRMovie import CalibrationNotFound
-from librir.video_io.rir_video_io import FILE_FORMAT_H264
 
 
 @pytest.mark.instantiation
@@ -152,7 +152,7 @@ def test_close(array):
 
 
 def test_video_file_format(movie: IRMovie):
-    assert movie.video_file_format == FILE_FORMAT_H264
+    assert movie.video_file_format == FileFormat.H264.value
 
 
 def test_split_rush(movie: IRMovie):

tests/python/test_video_io.py

@@ -7,8 +7,7 @@
 import pytest
 from librir.video_io import IRMovie, IRSaver
 from librir.video_io.rir_video_io import (
-    FILE_FORMAT_H264,
-    FILE_FORMAT_PCR,
+    FileFormat,
     camera_saturate,
     correct_PCR_file,
     get_emissivity,
@@ -141,15 +140,15 @@ def test_correct_PCR_file(pcr_filename, images):
     data = np.array(images, dtype=np.uint16)
     correct_PCR_file(pcr_filename, data.shape[0], data.shape[1], 50)
     with IRMovie.from_filename(pcr_filename) as mov:
-        assert mov.video_file_format == FILE_FORMAT_PCR
+        assert mov.video_file_format == FileFormat.PCR.value
 
 
 def test_pcr2h264(pcr_filename):
     with IRMovie.from_filename(pcr_filename) as mov:
         res = mov.pcr2h264()
 
     with IRMovie.from_filename(res) as mov:
-        assert mov.video_file_format == FILE_FORMAT_H264
+        assert mov.video_file_format == FileFormat.H264.value
 
 
 def test_get_emissivity(movie: IRMovie):