Added 'Labels to Tags' script.
This commit is contained in:
August Schwerdfeger
225
contrib/LabelsToTags.lua
Normal file
225
contrib/LabelsToTags.lua
Normal file
@@ -0,0 +1,225 @@
|
||||
--[[
|
||||
LABELS TO TAGS
|
||||
Allows the mass-application of tags using color labels and ratings
|
||||
as a guide.
|
||||
|
||||
AUTHOR
|
||||
August Schwerdfeger (august@schwerdfeger.name)
|
||||
|
||||
INSTALLATION
|
||||
* Copy this file into $CONFIGDIR/lua/, where CONFIGDIR
|
||||
is your darktable configuration directory
|
||||
* Add the following line in the file $CONFIGDIR/luarc:
|
||||
require "LabelsToTags"
|
||||
|
||||
USAGE
|
||||
In your 'luarc' file or elsewhere, use the function
|
||||
'register_tag_mapping', defined in this module, to specify
|
||||
one or more tag mappings for use by the module.
|
||||
Any mappings so registered will be selectable, according
|
||||
to their given names, in the module's "mapping" combo box.
|
||||
|
||||
A mapping takes the form of a table mapping patterns to
|
||||
lists of tags. A pattern consists of 6 characters, of which
|
||||
the first five represent color labels and the last the rating.
|
||||
Each color label character may be '+', '-', or '*',
|
||||
indicating that for this pattern to match, the corresponding
|
||||
color label, respectively, must be on, must be off, or can be
|
||||
either. Similarly, the rating character may be a numeral
|
||||
between 0 and 5, "R" for rejected, or "*" for "any value."
|
||||
|
||||
An example call to 'register_tag_mapping' is provided in a
|
||||
comment at the end of this file.
|
||||
|
||||
When the "Start" button is pressed, the module will
|
||||
iterate over each selected image and check the state of
|
||||
that image's color labels and rating against each pattern
|
||||
defined in the selected mapping. For each pattern that
|
||||
matches, the corresponding tags will be added to the
|
||||
image. Any such tag not already existing in the database
|
||||
will be created.
|
||||
|
||||
LICENSE
|
||||
LGPLv2+
|
||||
|
||||
]]
|
||||
local darktable = require("darktable")
|
||||
darktable.configuration.check_version(...,{3,0,0},{4,0,0},{5,0,0})
|
||||
|
||||
local LIB_ID = "LabelsToTags"
|
||||
|
||||
-- Helper functions: BEGIN
|
||||
|
||||
local function keySet(t)
|
||||
local rv = {}
|
||||
for k,_ in pairs(t) do
|
||||
table.insert(rv,k)
|
||||
end
|
||||
table.sort(rv)
|
||||
return(rv)
|
||||
end
|
||||
|
||||
local function generateLabelHash(img)
|
||||
local hash = ""
|
||||
hash = hash .. (img.red and "+" or "-")
|
||||
hash = hash .. (img.yellow and "+" or "-")
|
||||
hash = hash .. (img.green and "+" or "-")
|
||||
hash = hash .. (img.blue and "+" or "-")
|
||||
hash = hash .. (img.purple and "+" or "-")
|
||||
hash = hash .. (img.rating == -1 and "R" or tostring(img.rating))
|
||||
return(hash)
|
||||
end
|
||||
|
||||
local function hashMatch(hash,pattern)
|
||||
if #(hash) ~= #(pattern) then return(false) end
|
||||
for i = 0,#hash do
|
||||
if string.sub(hash,i,i) ~= string.sub(pattern,i,i) and
|
||||
string.sub(pattern,i,i) ~= "*" then
|
||||
return(false)
|
||||
end
|
||||
end
|
||||
return(true)
|
||||
end
|
||||
|
||||
-- Helper functions: END
|
||||
|
||||
|
||||
|
||||
|
||||
local initialAvailableMappings = {
|
||||
["Colors"] = { ["+*****"] = { "Red" },
|
||||
["*+****"] = { "Yellow" },
|
||||
["**+***"] = { "Green" },
|
||||
["***+**"] = { "Blue" },
|
||||
["****+*"] = { "Purple" } },
|
||||
["Single colors"] = { ["+----*"] = { "Red", "Only red" },
|
||||
["-+---*"] = { "Yellow", "Only yellow" },
|
||||
["--+--*"] = { "Green", "Only green" },
|
||||
["---+-*"] = { "Blue", "Only blue" },
|
||||
["----+*"] = { "Purple", "Only purple" } },
|
||||
["Ratings"] = { ["*****0"] = { "No stars", "Not rejected" },
|
||||
["*****1"] = { "One star", "Not rejected" },
|
||||
["*****2"] = { "Two stars", "Not rejected" },
|
||||
["*****3"] = { "Three stars", "Not rejected" },
|
||||
["*****4"] = { "Four stars", "Not rejected" },
|
||||
["*****5"] = { "Five stars", "Not rejected" },
|
||||
["*****R"] = { "Rejected" } }
|
||||
}
|
||||
|
||||
local availableMappings = {}
|
||||
|
||||
local function getAvailableMappings()
|
||||
if availableMappings == nil or next(availableMappings) == nil then
|
||||
return(initialAvailableMappings)
|
||||
else
|
||||
return(availableMappings)
|
||||
end
|
||||
end
|
||||
|
||||
local function getComboboxTooltip()
|
||||
if availableMappings == nil or next(availableMappings) == nil then
|
||||
return("No registered mappings -- using defaults")
|
||||
else
|
||||
return("Select a label-to-tag mapping")
|
||||
end
|
||||
end
|
||||
|
||||
local mappingComboBox = darktable.new_widget("combobox"){
|
||||
label = "mapping",
|
||||
value = 1,
|
||||
tooltip = getComboboxTooltip(),
|
||||
reset_callback = function(selfC)
|
||||
if selfC == nil then
|
||||
return
|
||||
end
|
||||
i = 1
|
||||
for _,m in pairs(keySet(getAvailableMappings())) do
|
||||
selfC[i] = m
|
||||
i = i+1
|
||||
end
|
||||
n = #selfC
|
||||
for j = i,n do
|
||||
selfC[i] = nil
|
||||
end
|
||||
selfC.value = 1
|
||||
selfC.tooltip = getComboboxTooltip()
|
||||
end,
|
||||
unpack(keySet(getAvailableMappings()))
|
||||
}
|
||||
|
||||
local function doTagging(selfC)
|
||||
local job = darktable.gui.create_job(string.format("labels to tags (%d image" .. (#(darktable.gui.action_images) == 1 and "" or "s") .. ")",#(darktable.gui.action_images)),true)
|
||||
job.percent = 0.0
|
||||
local pctIncrement = 1.0 / #(darktable.gui.action_images)
|
||||
|
||||
local availableMappings = getAvailableMappings()
|
||||
local memoizedTags = {}
|
||||
for _,img in ipairs(darktable.gui.action_images) do
|
||||
local tagsToApply = {}
|
||||
local hash = generateLabelHash(img)
|
||||
for k,v in pairs(availableMappings[mappingComboBox.value]) do
|
||||
if hashMatch(hash,k) then
|
||||
for _,tag in ipairs(v) do
|
||||
tagsToApply[tag] = true
|
||||
end
|
||||
end
|
||||
end
|
||||
for k,_ in pairs(tagsToApply) do
|
||||
if memoizedTags[k] == nil then
|
||||
memoizedTags[k] = darktable.tags.create(k)
|
||||
end
|
||||
darktable.tags.attach(memoizedTags[k],img)
|
||||
end
|
||||
job.percent = job.percent + pctIncrement
|
||||
end
|
||||
job.valid = false
|
||||
end
|
||||
|
||||
local my_widget = darktable.new_widget("box") {
|
||||
orientation = "vertical",
|
||||
mappingComboBox,
|
||||
darktable.new_widget("button") {
|
||||
label = "start",
|
||||
tooltip = "Tag all selected images",
|
||||
clicked_callback = doTagging
|
||||
}
|
||||
}
|
||||
|
||||
local PATTERN_PATTERN = "^[+*-][+*-][+*-][+*-][+*-][0-5R*]$"
|
||||
|
||||
darktable.register_tag_mapping = function(name, mapping)
|
||||
if availableMappings[name] ~= nil then
|
||||
darktable.print_error("Tag mapping '" .. name .. "' already registered")
|
||||
return
|
||||
end
|
||||
for pattern,tags in pairs(mapping) do
|
||||
if string.match(pattern,PATTERN_PATTERN) == nil then
|
||||
darktable.print_error("In tag mapping '" .. name .. "': Pattern '" .. pattern .. "' invalid")
|
||||
return
|
||||
end
|
||||
for _,tag in ipairs(tags) do
|
||||
if type(tag) ~= "string" then
|
||||
darktable.print_error("In tag mapping '" .. name .. "': All tag mappings must be lists of strings")
|
||||
return
|
||||
end
|
||||
end
|
||||
end
|
||||
availableMappings[name] = mapping
|
||||
mappingComboBox.reset_callback(mappingComboBox)
|
||||
end
|
||||
|
||||
--[[
|
||||
darktable.register_tag_mapping("Example",
|
||||
{ ["+----*"] = { "Red", "Only red" },
|
||||
["-+---*"] = { "Yellow", "Only yellow" },
|
||||
["--+--*"] = { "Green", "Only green" },
|
||||
["---+-*"] = { "Blue", "Only blue" },
|
||||
["****+*"] = { "Purple" },
|
||||
["----+*"] = { "Only purple" },
|
||||
["*****1"] = { "One star" },
|
||||
["*****R"] = { "Rejected" } })
|
||||
]]
|
||||
|
||||
darktable.register_lib(LIB_ID,"labels to tags",true,true,{
|
||||
[darktable.gui.views.lighttable] = {"DT_UI_CONTAINER_PANEL_RIGHT_CENTER",20},
|
||||
},my_widget,nil,nil)
|
||||
Reference in New Issue
Block a user