Add contrib/fujifilm_auto_settings script

README.md

@@ -48,6 +48,7 @@ dbmaint|Yes|LMW|find and remove database entries for missing film rolls and imag
 [exportLUT](https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/exportlut)|Yes|LMW|Create a LUT from a style and export it
 [ext_editor](https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/ext_editor)|No|LW|Export pictures to collection and edit them with up to nine user-defined external editors
 [face_recognition](https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/face_recognition)|No|LM|Identify and tag images using facial recognition
+[fujifilm_auto_settings](https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/fujifilm_auto_settings)|No|LMW|Apply fujifilm film emulations on import. [See here](https://bastibe.de/2022-05-04-customizing-darktable-for-fujifilm-cameras.html) for more information.
 [fujifilm_dynamic_range](https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/fujifilm_dynamic_range)|No|LMW|Correct fujifilm exposure based on exposure bias camera setting
 [fujifilm_ratings](https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/fujifilm_ratings)|No|LM|Support importing Fujifilm ratings
 [geoJSON_export](https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/geojson_export)|No|L|Create a geo JSON script with thumbnails for use in ...

contrib/fujifilm_auto_settings.lua

@@ -0,0 +1,310 @@
+--[[ fujifilm_auto_settings-0.4
+
+Apply Fujifilm film simulations, in-camera crop mode, and dynamic range.
+
+Copyright (C) 2022 Bastian Bechtold <bastibe.dev@mailbox.org>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+--]]
+
+--[[About this Plugin
+Automatically applies styles that load Fujifilm film simulation LUTs,
+copy crop ratios from the JPG, and correct exposure according to the
+chosen dynamic range setting in camera.
+
+Dependencies:
+- exiftool (https://www.sno.phy.queensu.ca/~phil/exiftool/)
+
+Based on fujifim_dynamic_range by Dan Torop.
+
+  Film Simulations
+  ----------------
+
+Fujifilm cameras are famous for their film simulations, such as Provia
+or Velvia or Classic Chrome. Indeed it is my experience that they rely
+on these film simulations for accurate colors.
+
+Darktable however does not know about or implement these film
+simulations. But I created a set of LUTs that emulate them. The LUTs
+were created from a set of training images on an X-T3, and generated
+using https://github.com/bastibe/LUT-Maker.
+
+In order to apply the film simulations, this plugin loads one of a
+number of styles, which are available for download as part of this
+repository:
+- provia
+- astia
+- velvia
+- classic_chrome
+- pro_neg_standard
+- pro_neg_high
+- eterna
+- acros_green
+- acros_red
+- acros_yellow
+- acros
+- mono_green
+- mono_red
+- mono_yellow
+- mono
+- sepia
+
+These styles apply the chosen film simulation by loading one of the
+supplied LUTs. You can replace them with styles of the same name that
+implement the film simulations in some other way.
+
+This plugin checks the image's "Film Mode" EXIF parameter for the
+color film simulation, and "Saturation" for the black-and-white film
+simulation, and applies the appropriate style. If no matching style
+exists, no action is taken and no harm is done.
+
+  Crop Factor
+  -----------
+
+Fujifilm cameras allow in-camera cropping to one of three aspect
+ratios: 2:3 (default), 16:9, and 1:1.
+
+This plugin checks the image's "Raw Image Aspect Ratio" exif
+parameter, and applies the appropriate style.
+
+To use, the repository contains another set of styles:
+- square_crop_portrait
+- square_crop_landscape
+- sixteen_by_nine_crop_portrait
+- sixteen_by_nine_crop_landscape
+
+These styles should apply a square crop and a 16:9 crop. If no
+matching style exists, no action is taken and no harm is done.
+
+  Dynamic Range
+  -------------
+
+Fujifilm cameras have a built-in dynamic range compensation, which
+(optionally automatically) reduce exposure by one or two stops, and
+compensate by raising the tone curve by one or two stops. These modes
+are called DR200 and DR400, respectively.
+
+The plugin reads the raw file's "Auto Dynamic Range" or "Development
+Dynamic Range" parameter, and applies one of two styles:
+- DR200
+- DR400
+
+These styles should raise exposure by one and two stops, respectively,
+and expand highlight latitude to make room for additional highlights.
+I like to implement them with the tone equalizer in eigf mode, raising
+exposure by one/two stops over the lower half of the sliders, then
+ramping to zero at 0 EV. If no matching styles exist, no action is
+taken and no harm is done.
+
+These tags have been checked on a Fujifilm X-A5, X-T3, X-T20 and
+X-Pro2. Other cameras may behave in other ways.
+
+--]]
+
+local dt = require("darktable")
+local du = require("lib/dtutils")
+local df = require("lib/dtutils.file")
+
+du.check_min_api_version("7.0.0", "fujifilm_auto_settings")
+
+-- return data structure for script_manager
+
+local script_data = {}
+
+script_data.destroy = nil -- function to destory the script
+script_data.destroy_method = nil -- set to hide for libs since we can't destroy them completely yet, otherwise leave as nil
+script_data.restart = nil -- how to restart the (lib) script after it's been hidden - i.e. make it visible again
+
+local function exiftool(RAF_filename)
+	local exiftool_command = df.check_if_bin_exists("exiftool")
+	assert(exiftool_command, "[fujifilm_auto_settings] exiftool not found")
+	local command = exiftool_command .. " -t " .. RAF_filename
+	-- on Windows, wrap the command in another pair of quotes:
+	if exiftool_command:find(".exe") then
+		command = '"' .. command .. '"'
+	end
+	dt.print_log("[fujifilm_auto_settings] executing " .. command)
+
+	-- parse the output of exiftool into a table:
+	local output = io.popen(command)
+	local exifdata = {}
+	for line in output:lines("l") do
+		local key, value = line:match("^%s*(.-)\t(.-)%s*$")
+		if key ~= nil and value ~= nil then
+			exifdata[key] = value
+		end
+	end
+	output:close()
+
+	assert(next(exifdata) ~= nil, "[fujifilm_auto_settings] no output returned by exiftool")
+	return exifdata
+end
+
+local function apply_style(image, style_name)
+	for _, s in ipairs(dt.styles) do
+		if s.name == style_name then
+			dt.styles.apply(s, image)
+			return
+		end
+	end
+	dt.print_error("[fujifilm_auto_settings] could not find style " .. style_name)
+end
+
+local function apply_tag(image, tag_name)
+	local tagnum = dt.tags.find(tag_name)
+	if tagnum == nil then
+		-- create tag if it doesn't exist
+		tagnum = dt.tags.create(tag_name)
+		dt.print_log("[fujifilm_auto_settings] creating tag " .. tag_name)
+	end
+	dt.tags.attach(tagnum, image)
+end
+
+local function detect_auto_settings(event, image)
+	if image.exif_maker ~= "FUJIFILM" then
+		dt.print_log("[fujifilm_auto_settings] ignoring non-Fujifilm image")
+		return
+	end
+	-- it would be nice to check image.is_raw but this appears to not yet be set
+	if not string.match(image.filename, "%.RAF$") then
+		dt.print_log("[fujifilm_auto_settings] ignoring non-raw image")
+		return
+	end
+	local RAF_filename = df.sanitize_filename(tostring(image))
+
+	local exifdata = exiftool(RAF_filename)
+
+	-- dynamic range mode
+	-- if in DR Auto, the value is saved to Auto Dynamic Range, with a % suffix:
+	local auto_dynamic_range = exifdata["Auto Dynamic Range"]
+	-- if manually chosen DR, the value is saved to Development Dynamic Range:
+	if auto_dynamic_range == nil then
+		auto_dynamic_range = exifdata["Development Dynamic Range"] .. "%"
+	end
+	if auto_dynamic_range == "100%" then
+		apply_tag(image, "DR100")
+		-- default; no need to change style
+	elseif auto_dynamic_range == "200%" then
+		apply_style(image, "DR200")
+		apply_tag(image, "DR200")
+		dt.print_log("[fujifilm_auto_settings] applying DR200")
+	elseif auto_dynamic_range == "400%" then
+		apply_style(image, "DR400")
+		apply_tag(image, "DR400")
+		dt.print_log("[fujifilm_auto_settings] applying DR400")
+	end
+
+	-- cropmode
+	local raw_aspect_ratio = exifdata["Raw Image Aspect Ratio"]
+	local raw_orientation = exifdata["Orientation"]
+	if raw_aspect_ratio == "3:2" then
+		apply_tag(image, "3:2")
+		-- default; no need to apply style
+	elseif raw_aspect_ratio == "1:1" then
+		if raw_orientation == "Horizontal (normal)" or raw_orientation == "Rotate 180" then
+			apply_style(image, "square_crop_landscape")
+		else
+			apply_style(image, "square_crop_portrait")
+		end
+		apply_tag(image, "1:1")
+		dt.print_log("[fujifilm_auto_settings] applying square crop")
+	elseif raw_aspect_ratio == "16:9" then
+		if raw_orientation == "Horizontal (normal)" or raw_orientation == "Rotate 180" then
+			apply_style(image, "sixteen_by_nine_crop_landscape")
+		else
+			apply_style(image, "sixteen_by_nine_crop_portrait")
+		end
+		apply_tag(image, "16:9")
+		dt.print_log("[fujifilm_auto_settings] applying 16:9 crop")
+	end
+
+	-- filmmode
+	local raw_filmmode = exifdata["Film Mode"]
+	local raw_saturation = exifdata["Saturation"]
+	-- Check if it's a color film mode
+	if raw_filmmode then
+		local style_map = {
+			["Provia"] = "provia",
+			["Astia"] = "astia",
+			["Classic Chrome"] = "classic_chrome",
+			["Eterna"] = "eterna",
+			["Pro Neg. Hi"] = "pro_neg_high",
+			["Pro Neg. Std"] = "pro_neg_standard",
+			["Velvia"] = "velvia",
+		}
+		for key, value in pairs(style_map) do
+			if string.find(raw_filmmode, key) then
+				apply_style(image, value)
+				apply_tag(image, key)
+				dt.print_log("[fujifilm_auto_settings] applying film simulation " .. key)
+				break
+			end
+		end
+	-- else check if it's a b&w film mode
+	elseif raw_saturation then
+		local style_map = {
+			["Acros Green Filter"] = "acros_green",
+			["Acros Red Filter"] = "acros_red",
+			["Acros Yellow Filter"] = "acros_yellow",
+			["Acros"] = "acros",
+			["None (B&W)"] = "mono",
+			["B&W Green Filter"] = "mono_green",
+			["B&W Red Filter"] = "mono_red",
+			["B&W Yellow Filter"] = "mono_yellow",
+			["B&W Sepia"] = "sepia",
+		}
+		for key, value in pairs(style_map) do
+			if raw_saturation == key then
+				apply_style(image, value)
+				apply_tag(image, key)
+				dt.print_log("[fujifilm_auto_settings] applying B&W film simulation " .. key)
+				break
+			end
+		end
+	else
+		dt.print_log("[fujifilm_auto_settings] neither Film Mode or Saturation EXIF info was found")
+	end
+end
+
+local function detect_auto_settings_multi(event, shortcut)
+	local images = dt.gui.selection()
+	if #images == 0 then
+		dt.print(_("Please select an image"))
+	else
+		for _, image in ipairs(images) do
+			detect_auto_settings(event, image)
+		end
+	end
+end
+
+local function destroy()
+	dt.destroy_event("fujifilm_auto_settings", "post-import-image")
+	dt.destroy_event("fujifilm_auto_settings", "shortcut")
+end
+
+if not df.check_if_bin_exists("exiftool") then
+	dt.print_log("Please install exiftool to use fujifilm_auto_settings")
+	error("[fujifilm_auto_settings] exiftool not found")
+end
+
+dt.register_event("fujifilm_auto_settings", "post-import-image", detect_auto_settings)
+
+dt.register_event("fujifilm_auto_settings", "shortcut", detect_auto_settings_multi, "fujifilm_auto_settings")
+
+dt.print_log("[fujifilm_auto_settings] loaded")
+
+script_data.destroy = destroy
+
+return script_data