IO checks, HiFi-UI and dependencies improvements

cvbsdecode/main.py

@@ -7,14 +7,16 @@
 import lddecode.utils as lddu
 from lddecode.utils_logging import init_logging
 from cvbsdecode.process import CVBSDecode
-import vhsdecode.formats as f
 from vhsdecode.cmdcommons import (
     common_parser,
     select_sample_freq,
     select_system,
     get_basics,
     get_rf_options,
     get_extra_options,
+    IOArgsException,
+    test_input_file,
+    test_output_file,
 )
 
 
@@ -74,7 +76,16 @@ def main(args=None):
     )
 
     args = parser.parse_args(args)
-    filename, outname, firstframe, req_frames = get_basics(args)
+    try:
+        filename, outname, firstframe, req_frames = get_basics(args)
+    except IOArgsException as e:
+        parser.print_help()
+        print(e)
+        print(f"ERROR: input file '{args.infile}' not found" if not test_input_file(args.infile) else "Input file: OK")
+        print(f"ERROR: output file '{args.outfile}' is not writable" if not test_output_file(
+            args.outfile) else "Output file: OK")
+        sys.exit(1)
+
     system = select_system(args)
     sample_freq = select_sample_freq(args)
 

pyproject.toml

@@ -14,7 +14,7 @@ classifiers = [
     "Topic :: Multimedia :: Video",
 ]
 dependencies = [
-    "numpy>=1.17","numba>=0.48","scipy>=1.3","samplerate", "static-ffmpeg", "cython", "soundfile", "sounddevice", "importlib_resources >= 5.0; python_version < '3.10'"
+    "numpy>=1.22","numba>=0.58.1","scipy>=1.10.1","samplerate", "static-ffmpeg", "cython", "soundfile", "sounddevice", "importlib_resources >= 5.0; python_version < '3.10'"
 ]
 dynamic = ["version"]
 # version = "0.2.1dev0"

requirements.txt

@@ -1,8 +1,8 @@
 Cython
 matplotlib
-numba>=0.55.1
-numpy
+numba>=0.58.1
+numpy>=1.22
 samplerate
-scipy
+scipy>=1.10.1
 soundfile
 sounddevice

vhsdecode/cmdcommons.py

@@ -1,4 +1,7 @@
 import argparse
+import os
+from typing import Optional
+
 import lddecode.utils as lddu
 import sys
 
@@ -8,6 +11,88 @@
 CXADC_TENBIT_FREQ = (8 * 315.0) / 88.0 / 2.0  # 14.318181818
 CXADC_TENBIT_FREQ_HIGH = 3150.0 / 88.0 / 2.0  # 17.897727272
 
+DEFAULT_THREADS = 4
+DEFAULT_INPUT_FILENAME = ""
+DEFAULT_OUTPUT_FILENAME = ""
+
+
+# size bytes to human-readable string
+def sizeof_fmt(num: int, suffix: str = "B") -> str:
+    for unit in ["", "Ki", "Mi", "Gi", "Ti", "Pi", "Ei", "Zi"]:
+        if abs(num) < 1024.0:
+            return f"{num:3.1f} {unit}{suffix}"
+        num /= 1024.0
+    return f"{num:.1f} Yi{suffix}"
+
+
+# checks if the input file can be read
+def test_input_file(input_file: Optional[str]) -> bool:
+    if input_file == '-':
+        return True
+
+    if input_file is DEFAULT_INPUT_FILENAME:
+        print("WARN: input file not specified")
+        return False
+
+    try:
+        with open(input_file, "rb") as f:
+            f.close()
+            pass
+    except FileNotFoundError:
+        print(f"WARN: input file '{input_file}' not found")
+        return False
+    return True
+
+
+# checks if the output file can be written
+def test_output_file(output_file: Optional[str]) -> bool:
+
+    # checks for free space on the output file directory
+    output_file_dir = '.' if os.path.dirname(output_file) == '' else os.path.dirname(output_file)
+    if not os.access(output_file_dir, os.W_OK):
+        print(f"Error: output file directory '{output_file_dir}' is not writable")
+        return False
+
+    # get the free space in the output file directory
+    try:
+        statvfs = os.statvfs(output_file_dir)
+        free_space = statvfs.f_frsize * statvfs.f_bavail
+        if free_space < 1024 * 1024 * 1024:
+            print(f"WARN: output file directory {output_file_dir} has {sizeof_fmt(free_space)} free space")
+    except AttributeError:
+        pass
+
+    try:
+        with open(output_file, "ab") as f:
+            f.close()
+            pass
+    except FileNotFoundError:
+        print(f"WARN: output file '{output_file}' not found")
+        return False
+
+    return True
+
+
+# checks if the input file can be read and the output file can be written
+def test_io(input_file: Optional[str], output_file: Optional[str]) -> bool:
+    if not test_input_file(input_file):
+        return False
+    if not test_output_file(output_file):
+        return False
+    return True
+
+
+class TestInputFile(argparse.Action):
+    def __call__(self, parser, namespace, values, option_string=None):
+        if test_input_file(values):
+            setattr(namespace, self.dest, values)
+
+
+class TestOutputFile(argparse.Action):
+    def __call__(self, parser, namespace, values, option_string=None):
+        if test_output_file(values):
+            setattr(namespace, self.dest, values)
+
 
 def add_argument_hidden_in_gui(parser, use_gui, *args, **kwargs):
     if use_gui:
@@ -48,11 +133,25 @@ def common_parser_gui_inner(meta_title):
     return common_parser_gui_inner(meta_title)
 
 
-def common_parser_cli(meta_title, default_threads=5):
+def common_parser_cli(meta_title, default_threads=DEFAULT_THREADS + 1):
     parser = argparse.ArgumentParser(description=meta_title)
-    parser.add_argument("infile", metavar="infile", type=str, help="source file")
     parser.add_argument(
-        "outfile", metavar="outfile", type=str, help="base name for destination files"
+        "infile",
+        metavar="infile",
+        type=str,
+        help="source file",
+        nargs='?',
+        default=DEFAULT_INPUT_FILENAME,
+        action=TestInputFile
+    )
+    parser.add_argument(
+        "outfile",
+        metavar="outfile",
+        type=str,
+        help="base name for destination files",
+        nargs='?',
+        default=DEFAULT_OUTPUT_FILENAME,
+        action=TestOutputFile
     )
     # help="Disable AGC (deprecated, already disabled by default)
     parser.add_argument(
@@ -69,7 +168,7 @@ def common_parser_cli(meta_title, default_threads=5):
     return common_parser_inner(parser, default_threads=default_threads)
 
 
-def common_parser_inner(parser, use_gui=False, default_threads=4):
+def common_parser_inner(parser, use_gui=False, default_threads=DEFAULT_THREADS):
     parser.add_argument(
         "--system",
         metavar="system",
@@ -289,7 +388,15 @@ def select_system(args):
     return system
 
 
+class IOArgsException(Exception):
+    pass
+
+
 def get_basics(args):
+    can_io = test_io(args.infile, args.outfile)
+    if not 'UI' in args:
+        if not can_io:
+            raise IOArgsException("Input/output file error")
     return args.infile, args.outfile, args.start, args.length
 
 

vhsdecode/hifi/HifiUi.py

@@ -494,16 +494,14 @@ def on_input_samplerate_changed(self):
         else:
             self.input_sample_rate = self._input_combo_rates[self.input_samplerate_combo.currentIndex()]
 
-    def on_decode_finished(self, decoded_filename: str = 'input stream'):
-        self.setWindowIcon(QIcon.fromTheme('document-open'))
-        # alerts user that decode is finished
+    def generic_message_box(self, title:str, message:str, type:QMessageBox.Icon=QMessageBox.Information):
         message_box = QMessageBox(
-            QMessageBox.Information,
-            'Decode Finished',
-            f'Decode of {decoded_filename} finished.',
+            type,
+            title,
+            message,
             parent=self
         )
-        message_box.setIcon(QMessageBox.Information)
+        message_box.setIcon(type)
         message_box.setDefaultButton(QMessageBox.Ok)
         # dark mode
         message_box.setStyleSheet("""
@@ -518,6 +516,14 @@ def on_decode_finished(self, decoded_filename: str = 'input stream'):
         """)
         message_box.exec_()
 
+    def on_decode_finished(self, decoded_filename: str = 'input stream'):
+        self.setWindowIcon(QIcon.fromTheme('document-open'))
+        # alerts user that decode is finished
+        self.generic_message_box(
+            "Decode Finished",
+            f'Decode of {decoded_filename} finished.'
+        )
+
 
 class FileOutputDialogUI(HifiUi):
     def __init__(self, params: MainUIParameters, title: str = "HiFi File Output", main_layout_callback=None):

vhsdecode/hifi/main.py

@@ -17,14 +17,16 @@
     select_sample_freq,
     select_system,
     get_basics,
+    test_input_file,
+    test_output_file
 )
 from vhsdecode.hifi.HiFiDecode import HiFiDecode, NoiseReduction, DEFAULT_NR_GAIN_, discard_stereo
 from vhsdecode.hifi.TimeProgressBar import TimeProgressBar
 import io
 import sounddevice as sd
 
 try:
-    from PyQt5.QtWidgets import QApplication
+    from PyQt5.QtWidgets import QApplication, QMessageBox
     from vhsdecode.hifi.HifiUi import ui_parameters_to_decode_options, decode_options_to_ui_parameters, \
         FileIODialogUI, FileOutputDialogUI
     HIFI_UI = True
@@ -704,9 +706,22 @@ def main() -> int:
                     # change to output file directory
                     if os.path.dirname(options["output_file"]) != '':
                         os.chdir(os.path.dirname(options["output_file"]))
-                    decoder_state = run_decoder(args, options, ui_t=ui_t)
-                    ui_t.window.transport_state = 0
-                    ui_t.window.on_decode_finished()
+
+                    # test input and output files
+                    if test_input_file(options["input_file"]) and test_output_file(options["output_file"]):
+                        decoder_state = run_decoder(args, options, ui_t=ui_t)
+                        ui_t.window.transport_state = 0
+                        ui_t.window.on_decode_finished()
+                    else:
+                        message = None
+                        if not test_input_file(options['input_file']):
+                            message = f"Input file '{options['input_file']}' not found"
+                        elif not test_output_file(options['output_file']):
+                            message = f"Output file '{options['output_file']}' cannot be created nor overwritten"
+
+                        ui_t.window.generic_message_box("I/O Error", message, QMessageBox.Critical)
+                        ui_t.window.on_stop_clicked()
+
                 ui_t.app.processEvents()
                 time.sleep(0.01)
             ui_t.window.transport_state = 0
@@ -715,7 +730,12 @@ def main() -> int:
 
         return decoder_state
     else:
-        return run_decoder(args, decode_options)
+        if test_input_file(filename) and test_output_file(outname):
+            return run_decoder(args, decode_options)
+        else:
+            parser.print_help()
+            print("ERROR: input file not found" if not test_input_file(filename) else f"ERROR: output file '{outname}' cannot be created nor overwritten")
+            return 1
 
 
 if __name__ == "__main__":

vhsdecode/main.py

@@ -23,6 +23,9 @@
     get_basics,
     get_rf_options,
     get_extra_options,
+    IOArgsException,
+    test_input_file,
+    test_output_file,
 )
 
 supported_tape_formats = {
@@ -282,7 +285,14 @@ def main(args=None, use_gui=False):
 
     args = parser.parse_args(args)
 
-    filename, outname, firstframe, req_frames = get_basics(args)
+    try:
+        filename, outname, firstframe, req_frames = get_basics(args)
+    except IOArgsException as e:
+        parser.print_help()
+        print(e)
+        print(f"ERROR: input file '{args.infile}' not found" if not test_input_file(args.infile) else "Input file: OK")
+        print(f"ERROR: output file '{args.outfile}' is not writable" if not test_output_file(args.outfile) else "Output file: OK")
+        sys.exit(1)
 
     if not args.overwrite:
         conflicts_ext = [".tbc", "_chroma.tbc", ".log", ".tbc.json"]