Module:MOS tuning spectrum: Difference between revisions

Ganaram inukshuk (talk | contribs)
No edit summary
Ganaram inukshuk (talk | contribs)
mNo edit summary
 
(45 intermediate revisions by 2 users not shown)
Line 1: Line 1:
local MOS = require("Module:MOS")
local mos      = require("Module:MOS")
local ET = require("Module:ET")
local rat = require("Module:Rational")
local mediants = require("Module:Mediants")
local mediants = require("Module:Mediants")
local utils = require("Module:Utils")
local tip      = require("Module:Template input parse")
local yesno = require("Module:yesno")
local utils   = require("Module:Utils")
local yesno   = require("Module:yesno")
local getArgs  = require("Module:Arguments").getArgs
 
local p = {}
local p = {}
-- TODO:
-- - Add back old option from previous scale tree: toggle staggering of ratios.
-- - (Low priority): Force-add comments that lie outside searched depth. If such
--  ratios are added, they're added in either the last column or their own
--  column appended after the last one. (to be determined)
-- Split comments into in-range and out-of-range comments.
-- Iterate through the comments and determine whether the key for a comment is
-- in the table of step ratios. If so, add the corresponding key-value pair into
-- the table of in-comments; if not, add to the table of out-comments.
function p.preprocess_comments(comments, step_ratios, depths)
local in_comments  = {}
local out_comments = {}
local out_ratios  = {}
for key, value in pairs(comments) do
local key_found_in_step_ratios = utils.table_contains(step_ratios, key, function(key, ratio)
return key == string.format("%s/%s", ratio[1], ratio[2]) end
)
if key_found_in_step_ratios then
in_comments[key] = value
else
out_comments[key] = value
table.insert(out_ratios, tip.parse_numeric_pair(key, "/", true))
end
end
mediants.sort_ratios(out_ratios)
return in_comments, out_comments, out_ratios
end


-- Re-re-rewrite of tuning spectrum
-- Re-re-rewrite of tuning spectrum
function p._mos_tuning_spectrum(args)
function p._mos_tuning_spectrum(args)
-- Find default ratios, if nothing was entered
local default_ratios, default_depths
local default_ratios, default_depths
local default_depth = 5
local default_depth = 5
default_ratios, default_depths = mediants.find_mediants({{1,1}, {1,0}}, default_depth);
default_ratios, default_depths = mediants.find_mediants({{1,1}, {1,0}}, default_depth)
local input_mos  = args["Input MOS"] or MOS.new(5, 2)
-- Extract info from args
local depth      = args["Depth"] or 5
local input_mos  = args["Input MOS" ] or mos.new(5, 2)
local comments    = args["Comments"] or {}
local comments    = args["Comments"   ] or {}
local step_ratios = args["Ratios"] or default_ratios
local step_ratios = args["Step Ratios"] or default_ratios
local depths      = args["Depths"] or default_depths
local depths      = args["Depths"     ] or default_depths
local equave = input_mos.equave
-- Find the deepest searched depth at which ratios were found
local L = input_mos.nL -- Large steps in mos
local deepest = mediants.deepest_depth(depths)
local s = input_mos.ns -- Small steps in mos
local n = utils._gcd(L, s) -- Number of periods
local abstract_bright_gen = MOS.bright_gen(input_mos)
-- What is the equave suffix (edo, edt, edf, ed-p/q)
-- Find mos info
local equave_suffix = ""
local equave      = input_mos.equave
if rat.eq(input_mos.equave, rat.new(2)) then
local large_steps = input_mos.nL -- Large steps in mos
equave_suffix = "o"
local small_steps = input_mos.ns -- Small steps in mos
elseif rat.eq(input_mos.equave, rat.new(3)) then
local periods    = mos.period_count(input_mos) -- Number of periods
equave_suffix = "t"
local et_suffix  = mos.et_suffix(input_mos) -- Mos's ET suffix (edo, edt, edf, ed-p/q, etc)
elseif rat.eq(input_mos.equave, rat.new(3, 2)) then
equave_suffix = "f"
else
equave_suffix = rat.as_ratio(input_mos.equave)
end
-- Default comments for TAMNAMS-named step ratios
-- Default comments for TAMNAMS-named step ratios
local default_comments = {}
local default_comments = {}
local mos_as_string = MOS.as_string(input_mos)
local mos_as_string = mos.as_string(input_mos)
default_comments["1/1"] = string.format("'''Equalized %s'''", mos_as_string)
default_comments["1/1"] = string.format("'''Equalized %s'''", mos_as_string)
default_comments["4/3"] = string.format("'''Supersoft %s'''", mos_as_string)
default_comments["4/3"] = string.format("'''Supersoft %s'''", mos_as_string)
default_comments["3/2"] = string.format("'''Soft %s'''", mos_as_string)
default_comments["3/2"] = string.format("'''Soft %s'''"     , mos_as_string)
default_comments["5/3"] = string.format("'''Semisoft %s'''", mos_as_string)
default_comments["5/3"] = string.format("'''Semisoft %s'''" , mos_as_string)
default_comments["2/1"] = string.format("'''Basic %s'''", mos_as_string)
default_comments["2/1"] = string.format("'''Basic %s'''"   , mos_as_string)
default_comments["5/2"] = string.format("'''Semihard %s'''", mos_as_string)
default_comments["5/2"] = string.format("'''Semihard %s'''" , mos_as_string)
default_comments["3/1"] = string.format("'''Hard %s'''", mos_as_string)
default_comments["3/1"] = string.format("'''Hard %s'''"     , mos_as_string)
default_comments["4/1"] = string.format("'''Superhard %s'''", mos_as_string)
default_comments["4/1"] = string.format("'''Superhard %s'''", mos_as_string)
default_comments["1/0"] = string.format("'''Collapsed %s'''", mos_as_string)
default_comments["1/0"] = string.format("'''Collapsed %s'''", mos_as_string)
Line 53: Line 79:
-- Monosmall mosses and knL ns mosses are always proper, but all other mosses
-- Monosmall mosses and knL ns mosses are always proper, but all other mosses
-- are proper if the step ratio is within the soft-of-basic range
-- are proper if the step ratio is within the soft-of-basic range
if n < s then
if periods < small_steps then
default_comments["2/1"] = default_comments["2/1"] .. "<br />Scales with tunings softer than this are proper"
default_comments["2/1"] = default_comments["2/1"] .. "<br />Scales with tunings softer than this are proper"
end
end
Line 59: Line 85:
-- Produce table header for the comments
-- Produce table header for the comments
local comments_header_text = "Comments"
local comments_header_text = "Comments"
if s == 1 then
if small_steps == 1 then
comments_header_text = comments_header_text .. "<sup><abbr title=\"Every tuning produces a proper scale.\">(always proper)</abbr></sup>"
comments_header_text = comments_header_text .. "<sup><abbr title=\"Every tuning produces a proper scale.\">(always proper)</abbr></sup>"
elseif s == n and n > 1 then
elseif small_steps == periods and periods > 1 then
comments_header_text = comments_header_text .. "<sup><abbr title=\"Every true-MOS tuning produces a proper scale.\">(always proper)</abbr></sup>"
comments_header_text = comments_header_text .. "<sup><abbr title=\"Every true-mos tuning produces a proper scale.\">(always proper)</abbr></sup>"
end
end
Line 71: Line 97:
-- - Step ratio and hardness
-- - Step ratio and hardness
-- - Comments
-- - Comments
local result = "{| class=\"wikitable center-all\"\n"
local result = {}
.. "|+ style=\"font-size: 105%; white-space: nowrap;\" | " .. string.format("Scale tree and tuning spectrum of %s\n", mos_as_string)
table.insert(result, '{| class="wikitable center-all"')
.. "|-\n"
table.insert(result, '|+ style="font-size: 105%; white-space: nowrap;" | Scale tree and tuning spectrum of ' ..  mos_as_string)
.. string.format("! rowspan=\"2\" colspan=\"%d\" | Generator<sup><abbr title=\"In steps of ed%s.\">(ed%s)</abbr></sup>\n", depth + 1, equave_suffix, equave_suffix)
table.insert(result, '|-')
.. "! colspan=\"2\" | Cents\n"
table.insert(result, string.format('! rowspan="2" colspan="%d" | Generator<sup><abbr title="In steps of %s.">(%s)</abbr></sup>', deepest + 1, et_suffix, et_suffix))
.. "! colspan=\"2\" | Step ratio\n"
table.insert(result, '! colspan="2" | Cents')
.. "! rowspan=\"2\" | " .. comments_header_text .. "\n"
table.insert(result, '! colspan="2" | Step ratio')
.. "|-\n"
table.insert(result, string.format('! rowspan="2" | %s', comments_header_text))
.. "! Bright\n"
table.insert(result, '|-')
.. "! Dark\n"
table.insert(result, '! <abbr title="Chroma-positive generator">Bright</abbr>')
.. "! L:s\n"
table.insert(result, '! <abbr title="Chroma-negative generator">Dark</abbr>')
.. "! Hardness\n"
table.insert(result, '! L:s')
table.insert(result, '! Hardness')


-- Rounding is done using string.format, to 3 decimal places (%.3f)
-- Rounding is done using string.format, to 3 decimal places (%.3f)
Line 88: Line 115:
-- Create each row of the table
-- Create each row of the table
for i = 1, #step_ratios do
for i = 1, #step_ratios do
local step_ratio = step_ratios[i]
-- Simplify step ratio before using it
local steps_per_equave = step_ratio[1] * L + step_ratio[2] * s
local step_ratio = mediants.simplify_ratio(step_ratios[i])
local steps_per_period = steps_per_equave / n
local et = ET.new(steps_per_equave, equave)
-- Produce current ET as a string
local et_as_string = mos.et_string(input_mos, step_ratio)
-- Calculate the bright gen and cent value
-- Calculate the bright gen and cent value
local bright_generator_steps = step_ratio[1] * abstract_bright_gen["L"] + step_ratio[2] * abstract_bright_gen["s"]
local bright_generator_steps = mos.bright_gen_to_et_steps (input_mos, step_ratio)
local bright_generator_cents = ET.cents(et, bright_generator_steps)
local bright_generator_cents  = mos.bright_gen_to_cents    (input_mos, step_ratio)
local bright_generator_string = mos.bright_gen_to_et_string(input_mos, step_ratio, "")
-- Calculate dark generator step count and cent value
-- Calculate dark generator step count and cent value
local dark_generator_steps = steps_per_period - bright_generator_steps
local dark_generator_steps = mos.dark_gen_to_et_steps(input_mos, step_ratio)
local dark_generator_cents = ET.cents(et, dark_generator_steps)
local dark_generator_cents = mos.dark_gen_to_cents  (input_mos, step_ratio)
-- New row
-- New row
result = result .. "|-\n"
table.insert(result, "|-")
-- Cells for bright generator, as steps in et
-- Cells for bright generator, as steps in et
-- Bright gen cell is accompanied by cells to the left and right.
-- The variable current_depth is the number of left cells; the number of
-- right cells is deepest minus current_depth.
local current_depth = depths[i]
local current_depth = depths[i]
for i = 1, depth + 1 do
local num_right_cells = deepest - current_depth
result = result .. "| "
for i = 1, current_depth do
if i == current_depth then
table.insert(result, "|")
result = result .. string.format("[[%s|%d\\%s]]", ET.as_string(et), bright_generator_steps, et.size)
end
end
table.insert(result, string.format("| [[%s|%s]]", et_as_string, bright_generator_string))
result = result .. "\n"
for i = 1, num_right_cells do
table.insert(result, "|")
end
end
-- Cells for generators in cents
-- Cells for generators in cents
result = result .. string.format("| %.3f\n", bright_generator_cents)
table.insert(result, string.format("| %.3f", bright_generator_cents))
result = result .. string.format("| %.3f\n", dark_generator_cents)
table.insert(result, string.format("| %.3f", dark_generator_cents ))
-- Cell for step ratio
-- Cell for step ratio
result = result .. string.format("| %d:%d\n", step_ratio[1], step_ratio[2])
table.insert(result, string.format("| %d:%d", step_ratio[1], step_ratio[2]))
-- Cell for hardness, with divide-by-zero check
-- Cell for hardness, with divide-by-zero check
Line 128: Line 161:
hardness = string.format("%.3f", step_ratio[1] / step_ratio[2])
hardness = string.format("%.3f", step_ratio[1] / step_ratio[2])
end
end
result = result .. string.format("| %s\n", hardness)
table.insert(result, string.format("| %s", hardness))
-- Cell for comment
-- Cell for comment
-- Default comments are on their own line before custom comments
-- Default comments are on their own line before custom comments
local key = step_ratios[i][1] .. "/" .. step_ratios[i][2] -- The step ratio is (literally and figuratively) the key to add comments!
local key = step_ratio[1] .. "/" .. step_ratio[2] -- The step ratio is (literally and figuratively) the key to add comments!
local comment = ""
local comment = ""
local default_comment = default_comments[key] or ""
local default_comment = default_comments[key] or ""
Line 141: Line 174:
comment = default_comment .. "<br />" .. custom_comment
comment = default_comment .. "<br />" .. custom_comment
end
end
result = result .. string.format("| style=\"text-align: left;\" | %s\n", comment)
table.insert(result, string.format("| style=\"text-align: left;\" | %s", comment))
end
end
result = result .. "|}"
table.insert(result, "|}")
return result
return table.concat(result, "\n")
end
end


-- Wrapper function; to be called by template
-- Wrapper function; to be called by template; preprocesses args
function p.scale_tree(frame)
-- Unprocessed args:
-- - Scale Signature (textual scalesig)
-- - Depth (how deep to search for mediants)
-- - Int Limit (if present, overrides depth-based search for int-limit search)
-- - X/Y (comments for individual step ratios)
-- - First/Last Step Ratio (initial ratios for mediant search; default is
--  1/1 and 1/0 respectively)
-- Processed args:
-- - Input MOS (processed from textual scalesig)
-- - Step Ratios (table of step ratios found)
-- - Depths (table of how deep each step ratio was found at)
-- - Comments (step ratio comments placed in their own table)
function p.mos_tuning_spectrum(frame)
local args = getArgs(frame)
local args = getArgs(frame)
-- Parse scalesig
-- Parse scalesig as input mos, then remove scalesig
local input_mos = MOS.parse(args["Scale Signature"])
local input_mos = mos.parse(args["Scale Signature"])
args["Input MOS"] = input_mos
args["Input MOS"] = input_mos
args["Scale Signature"] = nil
args["Scale Signature"] = nil
-- Parse depth
-- Parse initial ratios
local depth = tonumber(args["Depth"])
local initial_ratios_unparsed = args["Initial Ratios"]
frame.args["Depth"] = tonumber(args["Depth"])
local initial_ratios = {}
if initial_ratios_unparsed ~= nil then
-- Parse initial ratios, then sort by ascending
initial_ratios = tip.parse_numeric_pairs(initial_ratios_unparsed, ";", "/", true)
mediants.sort_ratios(initial_ratios)
else
-- If no initial ratios were passed in, default to 1/1 and 1/0
initial_ratios = {{1,1}, {1,0}}
end
-- Generate mediants and depths
-- Then generate mediants and depths
local ratios, depths
-- If using depth-based search, parse the depth, then remove it from args
ratios, depths = mediants.find_mediants({{1,1}, {1,0}}, depth)
-- If using int-limit search, parse the int limit, then remove it from args,
frame.args["Ratios"] = ratios
-- and remove depth in case it was present.
frame.args["Depths"] = depths
local step_ratios, depths
local use_int_limit = args["Int Limit"] ~= nil
if use_int_limit then
-- Int-limit search; parse int-limit
local int_limit = tonumber(args["Int Limit"])
args["Int Limit"] = nil
-- Find ratios and depths found
step_ratios, depths = mediants.find_mediants_by_int_limit(initial_ratios, int_limit)
else
-- Depth-based search; parse depth
local depth = tonumber(args["Depth"]) or 5
-- Find ratios and depths found
step_ratios, depths = mediants.find_mediants(initial_ratios, depth)
end
args["Depth"      ] = nil
args["Step Ratios"] = step_ratios
args["Depths"     ] = depths
-- Transfer comments from args to comments
-- Transfer comments from args to comments
local comments = {}
local comments = {}
for i = 1, #ratios do
for i = 1, #step_ratios do
local key = string.format("%d/%d", ratios[i][1], ratios[i][2])
local key = step_ratios[i][1] .. "/" .. step_ratios[i][2]
if args[key] ~= nil then
if args[key] ~= nil then
comments[key] = args[key]
comments[key] = args[key]
Line 177: Line 248:
end
end
end
end
args["Comments"] = comments
-- Parse debug option
-- Parse debug option
Line 182: Line 254:
-- Output
-- Output
local out_str = p._scale_tree(args)
local result = p._mos_tuning_spectrum(args)
return frame:preprocess(debugg == true and "<pre>" .. out_str .. "</pre>" or out_str)
if debugg == true then
result = "<syntaxhighlight lang=\"wikitext\">" .. result .. "</syntaxhighlight>"
end
return frame:preprocess(result)
end
 
function p.tester()
--local args = {}
--return p._mos_tuning_spectrum(args)
 
local comments = {
["5/4"] = "aaa",
["2/1"] = "bbb"
}
local step_ratios = {
{1,1},
{5,4},
{4,3}
}
local in_comments = {}
local out_comments = {}
in_comments, out_comments, out_ratios = p.preprocess_comments(comments, step_ratios)
 
local args = {}
--return out_comments
return p._mos_tuning_spectrum(args)
end
end


return p
return p