From fe942100a40691d3b2250b5125b9984e3231dca5 Mon Sep 17 00:00:00 2001
From: Andy Chien <achien@blueshiftinc.com>
Date: Fri, 23 Feb 2018 10:07:45 -0800
Subject: [PATCH] hugin plugin improvements * added preference requiring user
 to specify the paths for hugin, hugin_executor and pto_gen needed for this
 plguin * added preference to allow user to choose to launch hugin in GUI mode
 * minor fix to the way files are handled; due to some versions of
 hugin_executor not writing out to the path specified in --prefix, assume we
 are working in the tmp directory and then move the file afterwards

---
 contrib/hugin.lua | 105 +++++++++++++++++++++++++++++-----------------
 1 file changed, 66 insertions(+), 39 deletions(-)

diff --git a/contrib/hugin.lua b/contrib/hugin.lua
index 9008b15..477e506 100644
--- a/contrib/hugin.lua
+++ b/contrib/hugin.lua
@@ -28,7 +28,9 @@ ADDITIONAL SOFTWARE NEEDED FOR THIS SCRIPT
 * hugin
 
 USAGE
-* require this file from your main luarc config file.
+* require this file from your main luarc config file
+* set the hugin tool paths in preferences
+* if hugin gui mode is used, save the final result in the tmp directory with the first file name and _pano as suffix for the image to be automatically imported to DT afterwards
 
 This plugin will add a new storage option and calls hugin after export.
 ]]
@@ -37,6 +39,7 @@ local dt = require "darktable"
 local df = require "lib/dtutils.file"
 require "official/yield"
 local gettext = dt.gettext
+local namespace = 'module_hugin'
 
 -- works with darktable API version from 2.0.0 to 5.0.0
 dt.configuration.check_version(...,{2,0,0},{3,0,0},{4,0,0},{5,0,0})
@@ -45,28 +48,33 @@ dt.configuration.check_version(...,{2,0,0},{3,0,0},{4,0,0},{5,0,0})
 gettext.bindtextdomain("hugin",dt.configuration.config_dir.."/lua/locale/")
 
 local function _(msgid)
-    return gettext.dgettext("hugin", msgid)
+  return gettext.dgettext("hugin", msgid)
 end
 
 local function show_status(storage, image, format, filename,
   number, total, high_quality, extra_data)
-  dt.print("Export to Hugin "..tostring(number).."/"..tostring(total))
+  dt.print("exporting to Hugin: "..tostring(number).."/"..tostring(total))
 end
 
 local function create_panorama(storage, image_table, extra_data) --finalize
-  if not df.check_if_bin_exists("hugin") then
-    dt.print_error(_("hugin not found"))
-    return
-  end
-
 -- Since Hugin 2015.0.0 hugin provides a command line tool to start the assistant
 -- http://wiki.panotools.org/Hugin_executor
 -- We need pto_gen to create pto file for hugin_executor
 -- http://hugin.sourceforge.net/docs/manual/Pto_gen.html
 
-  local hugin_executor = false
-  if (df.check_if_bin_exists("hugin_executor") and df.check_if_bin_exists("pto_gen")) then
-    hugin_executor = true
+  local hugin = '"'..dt.preferences.read(namespace, "hugin", "file")..'"'
+  local hugin_executor = '"'..dt.preferences.read(namespace, "hugin_executor", "file")..'"'
+  local pto_gen = '"'..dt.preferences.read(namespace, "pto_gen", "file")..'"'
+  local user_prefer_gui = dt.preferences.read(namespace, "hugin_prefer_gui", "bool")
+
+  local cmd_line_available = false
+  if df.check_if_bin_exists(hugin_executor) and df.check_if_bin_exists(pto_gen) then
+    cmd_line_available = true
+  end
+
+  local gui_available = false
+  if df.check_if_bin_exists(hugin) then
+    gui_available = true
   end
 
   -- list of exported images
@@ -76,58 +84,77 @@ local function create_panorama(storage, image_table, extra_data) --finalize
   -- reset and create image list
   img_list = ""
   for k,v in pairs(image_table) do
-    img_list = img_list ..v.. " "
-	table.insert(img_set, k)
+    img_list = img_list..v..' '
+    table.insert(img_set, k)
   end
 
-  -- use first file as basename
+  -- use first file as basename for output file
   table.sort(img_set, function(a,b) return a.filename<b.filename end);
   local first_file
   for _, k in ipairs(img_set) do
-	first_file = k break
+    first_file = k break
   end
 
+  local pto_path = dt.configuration.tmp_dir..'/project.pto'
   local filepath = df.split_filepath(first_file.filename)
-  local output_file = filepath['basename'].."_pano.tif"
-  local output_path = first_file.path.."/"..output_file
-  local pto_path = '"'..dt.configuration.tmp_dir..'/project.pto"'
+  local tmp_filename = filepath['basename'].."_pano.tif"
+-- some versions of hugin_executor don't seem to output the result
+-- to the --prefix location, so assume we are working in the tmp
+-- directory and then move the file to the original file location afterwards
+  local src_path = dt.configuration.tmp_dir.."/"..tmp_filename
+  local dst_path = first_file.path..'/'..tmp_filename
 
-  if df.check_if_file_exists(output_path) then
-	output_path = df.create_unique_filename(output_path)
+  if df.check_if_file_exists(dst_path) then
+    dst_path = df.create_unique_filename(dst_path)
   end
 
-  dt.print(_("Will try to stitch now"))
-  local huginStartCommand
-  if (hugin_executor) then
-    huginStartCommand = "pto_gen "..img_list.." -o "..pto_path
-	dt.print(_("Creating pto file"))
-	dt.control.execute( huginStartCommand)
+  dt.print(_("will try to stitch now"))
+  local huginStartCommand = nil
+  if (cmd_line_available and not user_prefer_gui) then
+    huginStartCommand = pto_gen.." "..img_list.." -o "..pto_path
+    dt.print(_("creating pto file"))
+    dt.control.execute(huginStartCommand)
 
-	dt.print(_("Running Assistent"))
-	huginStartCommand = "hugin_executor --assistant "..pto_path
-	dt.control.execute( huginStartCommand)
+    dt.print(_("running assistent"))
+    huginStartCommand = hugin_executor.." --assistant "..pto_path
+    dt.control.execute(huginStartCommand)
 
-	huginStartCommand = 'hugin_executor --stitching --prefix="'..output_path..'" '..pto_path
+    huginStartCommand = hugin_executor..' --stitching --prefix='..src_path..' '..pto_path
+  elseif gui_available then
+    if (user_prefer_gui) then
+      dt.print(_("launching hugin"))
+    else
+      dt.print(_("unable to find command line tools, launching hugin")
+    end
+    huginStartCommand = hugin..' '..img_list
   else
-	huginStartCommand = "hugin "..img_list
+    dt.print(_("hugin isn't available, please set the paths in preferences."))
   end
 
-  --dt.print_error(huginStartCommand)
-
-  if not dt.control.execute(huginStartCommand) then
-	dt.print(_("Command hugin failed ..."))
-  else
-	dt.database.import(output_path)
+  if not (huginStartCommand==nil) then
+    if not dt.control.execute(huginStartCommand) then
+      dt.print(_("command hugin failed ..."))
+    else
+      if df.check_if_file_exists(src_path) then
+        df.file_move(src_path, dst_path)
+        dt.print(_("importing file "..dst_path))
+        dt.database.import(dst_path)
+      end
+    end
   end
 
   -- cleanup the temp files
   for k,v in pairs(image_table) do
-	os.remove(v)
+    os.remove(v)
   end
 end
 
 -- Register
-dt.register_storage("module_hugin", _("Hugin Panorama"), show_status, create_panorama)
+dt.register_storage(namespace, _("hugin panorama"), show_status, create_panorama)
+dt.preferences.register(namespace, "pto_gen", "file", _("pto_gen location"), "choose the pto_gen executable.", "/usr/bin/pto_gen")
+dt.preferences.register(namespace, "hugin_executor", "file", _("hugin_executor location"), "choose the hugin_executor executable.", "/usr/bin/hugin_executor")
+dt.preferences.register(namespace, "hugin", "file", _("hugin location"), "choose the hugin executable", "/usr/bin/hugin")
+dt.preferences.register(namespace, "hugin_prefer_gui", "bool", _("prefer hugin gui over command line"), "always launches hugin gui instead of automated from command line.", false)
 
 --
 -- vim: shiftwidth=2 expandtab tabstop=2 cindent syntax=lua