Started changing compression script to python. Added new functions to disk stats.

Author: ElphaTech

.gitignore

@@ -5,6 +5,7 @@ config.local.json
 .local.env
 *.log
 input*.json
+*.flag
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

README.md

@@ -1,9 +1,13 @@
 # shipper
 **shipper** is a utility with the purpose of making re-encoding and compressing of movies and TV shows easier. While it is built with Plex in mind, it can be used for anything. It is comprised of a daemon which can be run in the background and also acts as a dashboard for current jobs as well as a input script to safely add new jobs to the queue.
 
+
+> [!WARNING]
+> This repository is very much **work in progress**. Most commits will break previous versions. It is likely that many features will only partly work or not work at all.
+
 Requirements
 ---
-- ffmpeg
+- FFmpeg
 
 
 Installation & Usage
@@ -60,25 +64,31 @@ Features
 Todo
 ---
 <details>
-<summary>4/21 Complete</summary>
+<summary>4/27 Complete</summary>
 
+- [ ] Change flags (stop, unstop) to use .flag suffix to avoid committing.
 - [ ] Reorganise file structure to move functions to their own files.
     - [ ] daemon
     - [ ] input
     - [ ] status
 
 - [ ] input.py
-    - [x] Input directory
-    - [x] Output directory
     - [ ] Allow custom output file name formats
     - [ ] Fix ctrl+c throwing 20 lines of error
-- [x] daemon.py
-    - [x] Change daemon printing to log file.
+    - [ ] Potentially make part of status.py TUI
 - [ ] status.py
     - [ ] Consider moving to TUI frontend such as textualize which would allow it to run as webpage.
     - [ ] Running status or input should trigger daemon to start.
 - [ ] compress_file.sh
     - [ ] Turn into python script.
+        - [x] Checks if file exists
+        - [x] Checks valid preset & gets preset values
+        - [x] Check enough disk space
+        - [x] Fail job if output already exists
+        - [ ] If english audio exists, use it
+        - [ ] If english subs exist, use them
+        - [ ] Run ffmpeg
+        - [ ] Warn if output > input
 
 - [ ] Prompt user for missing config.json & .env values when initially running input.py.
 - [ ] Allow editing of current jobs.

functions/compressor.py

@@ -0,0 +1,50 @@
+# == PLAN ==
+# [x] Checks if input and output files exists
+# [x] Checks valid preset & gets preset values
+# [x] Check enough disk space
+# [ ] If english audio exists, use it
+# [ ] If english subs exist, use them
+# [ ] Run ffmpeg
+# [ ] Warn if output > input
+from pathlib import Path
+
+from config import load_config
+import disk_stats as ds
+
+CONFIG = load_config()
+
+
+def create_ffmpeg_cmd(input_path: str, output_path: str, quality_key: str):
+    """
+    Function to start compression of a video.
+    Returns a process when working.
+    Returns a string if error.
+    """
+    # Check input exists and output does not
+    if not Path(input_path).exists():
+        error_message = "Input file does not exist (compressor)"
+        print(error_message)
+        return error_message
+    if Path(output_path).exists():
+        error_message = "Output file already exists (compressor)"
+        print(error_message)
+        return error_message
+
+    # Safely load quality config
+    try:
+        quality = CONFIG.quality_presets[quality_key]
+    except Exception as e:
+        error_message = f"Failed to get quality (compressor): {e}"
+        print(error_message)
+        return error_message
+
+    # Check free space
+    buffer = ds.gib_to_bytes(CONFIG.buffer)
+    if not ds.check_enough_space(input_path, buffer):
+        error_message = f"Not enough free space on disk (compressor)"
+        print(error_message)
+        return error_message
+
+
+if __name__ == '__main__':
+    pass

functions/config.py

@@ -42,7 +42,6 @@ def __init__(self, raw_config: Dict[str, Any]):
 
         # --- 4. Paths (Added default paths if you introduce them) ---
         self.input_dir: Path = Path(raw_config.get('input_dir', '.'))
-        print(raw_config.get('input_dir'))
         self.output_dir: Path = Path(
             raw_config.get('output_dir', './Encoded'))
 

functions/disk_stats.py

@@ -1,29 +1,65 @@
 import shutil
+from pathlib import Path
+
+
+def bytes_to_gib(no_of_bytes: float) -> float:
+    """
+    Function to convert bytes to gigibytes.
+    """
+    return no_of_bytes / 2**30
+
+
+def gib_to_bytes(no_of_gib: float) -> float:
+    """
+    Function to convert gigibytes to bytes.
+    """
+    return no_of_gib * 2**30
+
+
+def get_file_size(path: str) -> float:
+    """
+    Function to get size of a file.
+    Returns answer in bytes.
+    """
+    return Path(path).stat().st_size
 
 
 def get_disk_metrics(path: str = "/") -> tuple[float, float, float]:
     """
-    Calculates and returns total GiB, used GiB, and decimal usage ratio.
+    Calculates and returns total bytes, used bytes, and decimal usage ratio.
     """
     total_bytes, used_bytes, _ = shutil.disk_usage(path)
 
-    gib_divisor = 2**30
-    total_gib = total_bytes / gib_divisor
-    used_gib = used_bytes / gib_divisor
     disk_decimal = used_bytes / total_bytes
 
-    return total_gib, used_gib, disk_decimal
+    return total_bytes, used_bytes, disk_decimal
+
+
+def check_enough_space(path: str, buffer: float = 0) -> bool:
+    """
+    Function to check if duplicating a file will exceed the disk space.
+    Buffer should be in bytes.
+    Buffer is first removed from disk space.
+    Returns boolean (true if there is enough space).
+    """
+    file_size = get_file_size(path)
+    disk_space, used_disk, _ = get_disk_metrics()
+    final_disk_space = disk_space - used_disk - buffer - file_size
+    return final_disk_space > 0
 
 
 def print_disk_usage(
-    total_gib: float,
-    used_gib: float,
+    total_bytes: float,
+    used_bytes: float,
     disk_decimal: float,
     bar_length: int = 50
 ):
     """
     Formats and prints the disk usage progress bar.
     """
+    total_gib = bytes_to_gib(total_bytes)
+    used_gib = bytes_to_gib(used_bytes)
+
     used_disk_count = int(disk_decimal * bar_length)
 
     used_disk_str = '#' * used_disk_count