improve ofs intigration instructions

Author: arch

contrib/OpenFunscripter/README.md

@@ -4,10 +4,13 @@ A hacky lua script to use the python funscript generator script in Open Funscrip
 
 ## Installation
 
-1. Download the packed Python Funscript Editor from [github release page](https://github.com/michael-mueller-git/Python-Funscript-Editor/releases).
-2. Extract the Archiv.
+1. Download the latest packed Python Funscript Editor from [github release page](https://github.com/michael-mueller-git/Python-Funscript-Editor/releases).
+2. Extract the Archiv to an Path without special character or spaces.
 3. Copy the `funscript_generator.lua` script to `data/lua` in your OFS directory.
 4. Open the `funscript_generator.lua` file and adjust the `Settings.FunscriptGenerator` and `Settings.TmpFile` variable.
-5. Launch OFS.
+   - `Settings.FunscriptGenerator`: point to the extracted Python Funscript Editor program
+   - `Settings.TmpFile`: specifies a temporary file where to store the result (must be a file not a directory!). The file will be overwritten automatically the next time the generator is started!
+5. Now launch OFS.
 6. Navigate to `View : Special functions : Custom Functions` and select the `funscript_generator.lua` entry. Click the Button `Bind Script` (This may trigger the funscript generator, just ignore it for now).
 7. Navigate to `Options : Keys : Dynamic` and insert a shortcut for the funscript generator.
+8. Now you can use the shortcut at any position in the video to start the funscript generator.

contrib/OpenFunscripter/funscript_generator.lua

@@ -1,6 +1,6 @@
 Settings = {}
 Settings.FunscriptGenerator = "C:\\Users\\win10\\Desktop\\funscript-editor\\funscript-editor.exe"
-Settings.TmpFile = "C:\\Users\\win10\\AppData\\Local\\Temp\\funscript_actions.csv"
+Settings.TmpFile = "C:\\Users\\win10\\AppData\\Local\\Temp\\funscript_actions.csv" -- file where to temporary store the result (must be a file not a directory!)
 SetSettings(Settings)
 
 function GetActions(video)

contrib/OpenFunscripter/funscript_generator_linux.lua

@@ -0,0 +1,39 @@
+Settings = {}
+Settings.PythonScript = "/home/arch/repos/python-funscript-editor/funscript-editor.py"
+Settings.TmpFile = "/tmp/funscript_actions.csv"
+SetSettings(Settings)
+
+function GetActions(video)
+    local at = {}
+    local pos = {}
+    local command = 'python3 "'..Settings.PythonScript..'" --generator -s '..tostring(CurrentTimeMs)..' -i "'..video..'" -o "'..Settings.TmpFile..'"'
+    print(command)
+    os.execute(command)
+    local f = io.open(Settings.TmpFile)
+    if not f then
+        print('lua: funscript generator output file not found')
+        return at, pos
+    end
+    local k = 1
+    for line in f:lines() do
+        -- first line is header
+        if k > 1 then
+            for k, v in string.gmatch(line, "(%w+);(%w+)") do
+                at[#at+1] = k
+                pos[#pos+1] = v
+            end
+        end
+        k = k + 1
+    end
+    f:close()
+    return at, pos
+end
+
+print('start funscript generator')
+local video = VideoFilePath -- NOTE: do not use special character in the video path!
+print('video file: ', video)
+local actions = {GetActions(video)}
+for i = 1, #actions[1] do
+    CurrentScript:AddActionUnordered(tonumber(actions[1][i]), tonumber(actions[2][i]), true, 0)
+end
+print('done')

funscript_editor/ui/minimal.py

@@ -25,6 +25,11 @@ class MinimalFunscriptGenerator(QtWidgets.QMainWindow):
     def __init__(self, video_file, start_time, output_file):
         super(MinimalFunscriptGenerator, self).__init__()
 
+        if os.path.isdir(output_file):
+            self.__logger.error("The output TempFile path must be a file not a folder")
+            self.__show_message("The output TempFile path must be a file not a folder")
+            sys.exit()
+
         if os.path.exists(output_file):
             os.remove(output_file)
 
@@ -43,13 +48,12 @@ def __init__(self, video_file, start_time, output_file):
                 logging.info('abort')
                 sys.exit()
 
-        if video_file is None:
+        if video_file is None or video_file == "":
             self.__logger.error("Video file was not specified!")
             self.__show_message("Video file was not specified!")
             sys.exit()
 
         if not os.path.exists(video_file):
-            if video_file == "": video_file = "EMPTY"
             self.__logger.error("Video file not found: %s", video_file)
             self.__show_message("Video file not found ({})".format(video_file))
             sys.exit()