README.md

@@ -7,13 +7,14 @@ A CLI to generate comparison image sets with
 ```
 usage: FrameForge [-h] [-v] [--source SOURCE] [--encode ENCODE] [--frames FRAMES]
                   [--image-dir IMAGE_DIR] [--indexer {lsmash,ffms2}]
-                  [--source-index-path SOURCE_INDEX_PATH]
-                  [--encode-index-path ENCODE_INDEX_PATH] [--sub-size SUB_SIZE]
-                  [--left-crop LEFT_CROP] [--right-crop RIGHT_CROP] [--top-crop TOP_CROP]
+                  [--index-dir INDEX_DIR] [--sub-size SUB_SIZE] [--left-crop LEFT_CROP]
+                  [--right-crop RIGHT_CROP] [--top-crop TOP_CROP]
                   [--bottom-crop BOTTOM_CROP] [--adv-resize-left ADV_RESIZE_LEFT]
-                  [--adv-resize-right ADV_RESIZE_RIGHT] [--adv-resize-top ADV_RESIZE_TOP]
-                  [--adv-resize-bottom ADV_RESIZE_BOTTOM] [--tone-map] [--re-sync RE_SYNC]
-                  [--comparison-count COMPARISON_COUNT] [--subtitle-color SUBTITLE_COLOR]
+                  [--adv-resize-right ADV_RESIZE_RIGHT]
+                  [--adv-resize-top ADV_RESIZE_TOP]
+                  [--adv-resize-bottom ADV_RESIZE_BOTTOM] [--tone-map]
+                  [--re-sync RE_SYNC] [--comparison-count COMPARISON_COUNT]
+                  [--subtitle-color SUBTITLE_COLOR]
                   [--release-sub-title RELEASE_SUB_TITLE]
 
 options:
@@ -21,16 +22,14 @@ options:
   -v, --version         show program's version number and exit
   --source SOURCE       Path to source file
   --encode ENCODE       Path to encode file
-  --frames FRAMES       Only use this if you want to specify the frames to generate, this
-                        disables sync frames
+  --frames FRAMES       Only use this if you want to specify the frames to generate,
+                        this disables sync frames
   --image-dir IMAGE_DIR
                         Path to base image folder
   --indexer {lsmash,ffms2}
                         Indexer choice
-  --source-index-path SOURCE_INDEX_PATH
-                        Path to look/create indexes for source
-  --encode-index-path ENCODE_INDEX_PATH
-                        Path to look/create indexes for encode
+  --index-dir INDEX_DIR
+                        Path to look/create indexes
   --sub-size SUB_SIZE   Size of subtitles
   --left-crop LEFT_CROP
                         Left crop
@@ -52,9 +51,10 @@ options:
   --comparison-count COMPARISON_COUNT
                         Amount of comparisons to generate
   --subtitle-color SUBTITLE_COLOR
-                        Hex color code for subtitle color (i.e. --subtitle-color "#fff000")
+                        Hex color code for subtitle color
   --release-sub-title RELEASE_SUB_TITLE
-                        Release group subtitle name (this will show on the encode images)
+                        Release group subtitle name (this will show on the encode
+                        images)
 ```
 
 ## Supports

frame_forge.py

@@ -7,7 +7,7 @@ from frame_forge.cli_utils import frame_list
 
 
 program_name = "FrameForge"
-__version__ = "1.2.0"
+__version__ = "1.1.0"
 
 
 if __name__ == "__main__":
@@ -30,15 +30,9 @@ if __name__ == "__main__":
         "--indexer",
         type=str,
         choices=["lsmash", "ffms2"],
-        default="lsmash",
         help="Indexer choice",
     )
-    parser.add_argument(
-        "--source-index-path", type=str, help="Path to look/create indexes for source"
-    )
-    parser.add_argument(
-        "--encode-index-path", type=str, help="Path to look/create indexes for encode"
-    )
+    parser.add_argument("--index-dir", type=str, help="Path to look/create indexes")
     parser.add_argument("--sub-size", type=int, default=20, help="Size of subtitles")
     parser.add_argument("--left-crop", type=int, help="Left crop")
     parser.add_argument("--right-crop", type=int, help="Right crop")
@@ -60,9 +54,7 @@ if __name__ == "__main__":
         "--comparison-count", type=int, help="Amount of comparisons to generate"
     )
     parser.add_argument(
-        "--subtitle-color",
-        type=str,
-        help='Hex color code for subtitle color (i.e. --subtitle-color "#fff000")',
+        "--subtitle-color", type=str, help="Hex color code for subtitle color"
     )
     parser.add_argument(
         "--release-sub-title",
@@ -88,16 +80,6 @@ if __name__ == "__main__":
             1,
         )
 
-    index_suffix = ".lwi" if args.indexer == "lsmash" else ".ffindex"
-    for index_input in [args.source_index_path, args.encode_index_path]:
-        if index_input:
-            if Path(index_input).suffix != index_suffix:
-                exit_application(
-                    f"When using {args.indexer} indexer you must use '{index_suffix}' "
-                    "for your source/encode index path suffix",
-                    1,
-                )
-
     if args.image_dir:
         image_dir = Path(args.image_dir)
     else:
@@ -111,8 +93,7 @@ if __name__ == "__main__":
             frames=args.frames,
             image_dir=image_dir,
             indexer=args.indexer,
-            source_index_path=args.source_index_path,
-            encode_index_path=args.encode_index_path,
+            index_directory=args.index_dir,
             sub_size=args.sub_size,
             left_crop=args.left_crop,
             right_crop=args.right_crop,

frame_forge/__init__.py

@@ -4,7 +4,6 @@ from random import choice
 from pathlib import Path
 from numpy import linspace
 from unidecode import unidecode
-
 import awsmfunc
 import vapoursynth as vs
 from frame_forge.exceptions import FrameForgeError
@@ -19,8 +18,7 @@ class GenerateImages:
         frames: str,
         image_dir: Path,
         indexer: str,
-        source_index_path: None | str,
-        encode_index_path: None | str,
+        index_directory: None | str,
         sub_size: int,
         left_crop: int,
         right_crop: int,
@@ -44,8 +42,7 @@ class GenerateImages:
         self.encode_node = None
         self.image_dir = image_dir
         self.indexer = indexer
-        self.source_index_path = source_index_path
-        self.encode_index_path = encode_index_path
+        self.index_dir = index_directory
         self.sub_size = sub_size
         self.left_crop = left_crop
         self.right_crop = right_crop
@@ -65,8 +62,6 @@ class GenerateImages:
         self.load_plugins()
 
     def process_images(self):
-        self.check_index_paths()
-
         if self.indexer == "lsmash":
             self.index_lsmash()
 
@@ -82,7 +77,7 @@ class GenerateImages:
         # Shadow Depth, Alignment, Left Margin, Right Margin, Vertical Margin, Encoding
 
         # bgr color
-        color = "&H14FF39"
+        color = "&H000ac7f5"
         if self.subtitle_color:
             color = hex_to_bgr(self.subtitle_color)
 
@@ -483,9 +478,10 @@ class GenerateImages:
                 flush=True,
             )
 
-    def _index_source_lsmash(self):
+    def index_lsmash(self):
         print("Indexing source", flush=True)
 
+        # index source file
         # if index is found in the StaxRip temp working directory, attempt to use it
         if (
             Path(str(Path(self.source_file).with_suffix("")) + "_temp/").is_dir()
@@ -495,18 +491,12 @@ class GenerateImages:
         ):
             print("Index found in StaxRip temp, attempting to use", flush=True)
 
+            # define cache path
             lwi_cache_path = Path(
                 str(Path(self.source_file).with_suffix("")) + "_temp/temp.lwi"
             )
 
-        elif self.source_index_path.exists():
-            print("Index found, attempting to use", flush=True)
-            lwi_cache_path = self.source_index_path
-
-        # if no existing index is found index source file
-        else:
-            lwi_cache_path = Path(Path(self.source_file).with_suffix(".lwi"))
-
+            # try to use index on source file with the cache path
             try:
                 self.source_node = self.core.lsmas.LWLibavSource(
                     source=self.source_file, cachefile=lwi_cache_path
@@ -515,42 +505,66 @@ class GenerateImages:
                     source=self.source_file, cachefile=lwi_cache_path
                 )
                 print("Using existing index", flush=True)
+            # if index cannot be used
             except vs.Error:
                 print("L-Smash version miss-match, indexing source again", flush=True)
+
+                # index source file
                 self.source_node = self.core.lsmas.LWLibavSource(self.source_file)
-            self.reference_source_file = self.core.lsmas.LWLibavSource(self.source_file)
+                self.reference_source_file = self.core.lsmas.LWLibavSource(
+                    self.source_file
+                )
 
-        print("Source index completed", flush=True)
+        # if no existing index is found index source file
+        else:
+            cache_path = Path(Path(self.source_file).with_suffix(".lwi"))
+            try:
+                # create index
+                self.source_node = self.core.lsmas.LWLibavSource(
+                    self.source_file, cachefile=cache_path
+                )
+                self.reference_source_file = self.core.lsmas.LWLibavSource(
+                    self.source_file, cachefile=cache_path
+                )
+            except vs.Error:
+                # delete index
+                Path(self.source_file).with_suffix(".lwi").unlink(missing_ok=True)
+                # create index
+                self.source_node = self.core.lsmas.LWLibavSource(
+                    self.source_file, cachefile=cache_path
+                )
+                self.reference_source_file = self.core.lsmas.LWLibavSource(
+                    self.source_file, cachefile=cache_path
+                )
 
-    def _index_encode_lsmash(self):
-        print("\nIndexing encode", flush=True)
+        print("Source index completed\n\nIndexing encode", flush=True)
 
-        if self.encode_index_path:
-            cache_path_enc = self.encode_index_path
+        # define a path for encode index to go
+        if self.index_dir:
+            index_base_path = Path(self.index_dir) / Path(self.encode_file).name
+            cache_path_enc = index_base_path.with_suffix(".lwi")
         else:
             cache_path_enc = Path(Path(self.encode_file).with_suffix(".lwi"))
 
         try:
+            # create index
             self.encode_node = self.core.lsmas.LWLibavSource(
                 self.encode_file, cachefile=cache_path_enc
             )
         except vs.Error:
+            # delete index
             cache_path_enc.unlink(missing_ok=True)
+            # create index
             self.encode_node = self.core.lsmas.LWLibavSource(
                 self.encode_file, cachefile=cache_path_enc
             )
 
         print("Encode index completed", flush=True)
 
-    def index_lsmash(self):
-        """Index source/encode with lsmash"""
-
-        self._index_source_lsmash()
-        self._index_encode_lsmash()
-
-    def _index_source_ffms2(self):
+    def index_ffms2(self):
         print("Indexing source", flush=True)
 
+        # index source file
         # if index is found in the StaxRip temp working directory, attempt to use it
         if (
             Path(str(Path(self.source_file).with_suffix("")) + "_temp/").is_dir()
@@ -560,51 +574,57 @@ class GenerateImages:
         ):
             print("Index found in StaxRip temp, attempting to use", flush=True)
 
+            # define cache path
             ffindex_cache_path = Path(
                 str(Path(self.source_file).with_suffix("")) + "_temp/temp.ffindex"
             )
 
-        elif self.source_index_path.exists():
-            print("Index found, attempting to use", flush=True)
-            ffindex_cache_path = self.source_index_path
+            # try to use index on source file with the cache path
+            try:
+                self.source_node = self.core.ffms2.Source(
+                    source=self.source_file, cachefile=ffindex_cache_path
+                )
+                self.reference_source_file = self.core.ffms2.Source(
+                    source=self.source_file, cachefile=ffindex_cache_path
+                )
+                print("Using existing index", flush=True)
+            # if index cannot be used
+            except vs.Error:
+                print("FFMS2 version miss-match, indexing source again", flush=True)
+
+                # index source file
+                self.source_node = self.core.ffms2.Source(self.source_file)
+                self.reference_source_file = self.core.ffms2.Source(self.source_file)
 
         # if no existing index is found index source file
         else:
-            ffindex_cache_path = Path(Path(self.source_file).with_suffix(".ffindex"))
-            print(
-                "FFMS2 library doesn't allow progress, please wait while the index is completed",
-                flush=True,
-            )
-
             try:
-            self.source_node = self.core.ffms2.Source(
-                self.source_file, cachefile=ffindex_cache_path
-            )
-            self.reference_source_file = self.core.ffms2.Source(
-                self.source_file, cachefile=ffindex_cache_path
-            )
-        except vs.Error:
-            Path(self.source_file).with_suffix(".ffindex").unlink(missing_ok=True)
+                # create index
                 print(
                     "FFMS2 library doesn't allow progress, please wait while the index is completed",
                     flush=True,
                 )
-            self.source_node = self.core.ffms2.Source(
-                self.source_file, cachefile=ffindex_cache_path
-            )
-            self.reference_source_file = self.core.ffms2.Source(
-                self.source_file, cachefile=ffindex_cache_path
+                self.source_node = self.core.ffms2.Source(self.source_file)
+                self.reference_source_file = self.core.ffms2.Source(self.source_file)
+            except vs.Error:
+                # delete index
+                Path(self.source_file).with_suffix(".ffindex").unlink(missing_ok=True)
+                # create index
+                print(
+                    "FFMS2 library doesn't allow progress, please wait while the index is completed",
+                    flush=True,
                 )
+                self.source_node = self.core.ffms2.Source(self.source_file)
+                self.reference_source_file = self.core.ffms2.Source(self.source_file)
 
-        print("Source index completed", flush=True)
+        print("Source index completed\n\nIndexing encode", flush=True)
 
-    def _index_encode_ffms2(self):
-        print("\nIndexing encode", flush=True)
-
-        if self.encode_index_path:
-            cache_path_enc = self.encode_index_path
+        # define a path for encode index to go
+        if self.index_dir:
+            index_base_path = Path(self.index_dir) / Path(self.encode_file).name
+            cache_path_enc = Path(str(index_base_path) + ".ffindex")
         else:
-            cache_path_enc = Path(str(self.encode_file) + ".ffindex")
+            cache_path_enc = Path(self.encode_file + ".ffindex")
 
         try:
             self.encode_node = self.core.ffms2.Source(
@@ -618,12 +638,6 @@ class GenerateImages:
 
         print("Encode index completed", flush=True)
 
-    def index_ffms2(self):
-        """Index source/encode with ffms2"""
-
-        self._index_source_ffms2()
-        self._index_encode_ffms2()
-
     def load_plugins(self):
         plugin_path = get_working_dir() / "img_plugins"
         if not plugin_path.is_dir() and not plugin_path.exists():
@@ -631,21 +645,3 @@ class GenerateImages:
         else:
             for plugin in plugin_path.glob("*.dll"):
                 self.core.std.LoadPlugin(Path(plugin).resolve())
-
-    def check_index_paths(self):
-        indexer_ext = ".lwi" if self.indexer == "lsmash" else ".ffindex"
-        if not self.source_index_path or not Path(self.source_index_path).exists():
-            source_path_obj = Path(self.source_file)
-            self.source_index_path = source_path_obj.parent / Path(
-                f"{source_path_obj.stem}{indexer_ext}"
-            )
-        else:
-            self.source_index_path = Path(self.source_index_path)
-
-        if not self.encode_index_path or not Path(self.encode_index_path).exists():
-            encode_path_obj = Path(self.source_file)
-            self.encode_index_path = encode_path_obj.parent / Path(
-                f"{encode_path_obj.stem}{indexer_ext}"
-            )
-        else:
-            self.encode_index_path = Path(self.encode_index_path)