Module:Infobox ET

Module documentation[view] [edit] [history] [purge]

Note: Do not invoke this module directly; use the corresponding template instead: Template:Infobox ET.

This module depends on the following other modules: Module: ET Module: Infobox Module: Limits Module: Rational Module: Utils

This module automatically fills in information about a specified equal temperament tuning.

---

local p = {}
local i = require('Module:Interval')
local u = require('Module:Utils')
local rat = require('Module:Rational')
local l = require('Module:Limits')
local ET = require('Module:ET')

-- towards is one of: -1 (floor), 0 (nearest), 1 (ceil)
local function approximation(et, interval, towards, precomputed_approx)
	local approx = ET.approximate(et, interval, towards or 0)
	if precomputed_approx then
		approx = precomputed_approx
	end
	local tuning = et.size
	if not rat.eq(et.equave, 2) then
		tuning = tuning .. et.suffix
	end
	local ratio = rat.new(approx, et.size)
	if rat.as_table(ratio)[1] ~= approx then
		local link = rat.as_table(ratio)[2] .. et.suffix
		ratio = ' (→[[' .. link .. '|' .. rat.as_ratio(ratio, '\\')
		if not rat.eq(et.equave, 2) then
			ratio = ratio .. et.suffix
		end
		ratio = ratio .. ']])'
	else
		ratio = ''
	end
	local cents = u._round(ET.cents(et, approx), 6)
	return approx .. '\\' .. tuning .. ' (' .. cents .. '¢)' .. ratio
end

function p.infobox_ET(frame)
	-- debug mode
	local debug_mode = frame.args['debug'] ~= nil
	
	local tuning = frame.args['tuning']
	local et = ET.parse(tuning) or ET.parse('12edo')
	local prime = ""
	if u.is_prime(et.size) then
		prime = " (prime)"
	end
	
	local prev_one = ''
	if et.size > 0 then
		prev_one = '[[' .. (et.size - 1) .. et.suffix .. '|← ' .. (et.size - 1) .. et.suffix .. ']]'
	end
	local next_one = '[[' .. (et.size + 1) .. et.suffix .. '|' .. (et.size + 1) .. et.suffix .. ' →]]'
	
	local step_size = ET.cents(et, 1)
	local fifth = ET.approximate(et, 3/2)
	local fifth_error = ET.cents(et, fifth) - i._to_cents(3/2)
	local dual_fifth = math.abs(fifth_error) > step_size / 3

	local note_12edo = ''
	if rat.eq(et.equave, 2) and et.size == 12 then
		note_12edo = '<sup>by definition</sup>'
	end
	
	local octave = ET.approximate(et, 2)
	local A1 = 7 * fifth - 4 * octave
	local m2 = 3 * octave - 5 * fifth
	local A1_cents = u._round(ET.cents(et, A1), 4)
	local m2_cents = u._round(ET.cents(et, m2), 4)

	local infobox_data = {}
	table.insert(infobox_data, {
		'Prime factorization',
		u._prime_factorization(et.size) .. prime
	})
	table.insert(infobox_data, {
		'Step size',
		u._round(step_size, 6) .. '¢' .. note_12edo
	})
	if not rat.eq(et.equave, rat.new(3, 2)) then
		table.insert(infobox_data, {
			'Fifth',
			approximation(et, 3/2)
		})
	end
	if not rat.eq(et.equave, 2) then
		table.insert(infobox_data, {
			'Octave',
			approximation(et, 2)
		})
	end
	table.insert(infobox_data, {
		'Semitones (A1:m2)',
		A1 .. ':' .. m2 .. ' (' .. A1_cents .. '¢ : ' .. m2_cents .. '¢)'
	})
	if dual_fifth and et.size > 0 then
		table.insert(infobox_data, {
			'Sharp fifth',
			approximation(et, 3/2, 1)
		})
		table.insert(infobox_data, {
			'Flat fifth',
			approximation(et, 3/2, -1)
		})
		local sharp = ET.approximate(et, 3/2, 1)
		local flat = ET.approximate(et, 3/2, -1)
		table.insert(infobox_data, {
			'Major 2nd',
			approximation(et, 9/8, 0, sharp + flat - octave)
		})
	end
	
	local consistency = tonumber(frame.args['Consistency'])
	if consistency == nil then
		consistency = l.consistency_limit(et, false, 43)
	end
	if consistency == nil then
		consistency = 'at least 43'
	end
	if consistency ~= nil then
		table.insert(infobox_data, {
			'Consistency limit',
			consistency
		})
	end
	local distinct_consistency = tonumber(frame.args['Distinct consistency'])
	if distinct_consistency == nil then
		distinct_consistency = l.consistency_limit(et, consistency or true, 43)
	end
	if distinct_consistency == nil then
		distinct_consistency = 'at least 43'
	end
	if distinct_consistency ~= nil then
		table.insert(infobox_data, {
			'Distinct consistency limit',
			distinct_consistency
		})
	end
	
	if debug_mode then
		if ET.is_highly_melodic(et) then
			table.insert(infobox_data, {
				'Highly melodic?',
				ET.why_highly_melodic(et)
			})
		end
	end

	local header = '<table style="width: 100%; margin: 0"><tr>'
		.. '<td style="width: 15%; text-align: left; white-space: nowrap; font-size: smaller">'
		.. prev_one
		.. '</td>'
		.. '<td style="width: 70%; padding-left: 1em; padding-right: 1em; text-align: center">'
		.. '[[' .. et.suffix .. '|' .. tuning .. ']]'
		.. '</td>'
		.. '<td style="width: 15%; text-align: right; white-space: nowrap; font-size: smaller">'
		.. next_one
		.. '</td>'
		.. '</tr></table>'
	local s = '<div style="\n' ..
		'border: 1px solid #999;\n' ..
		'margin: 0;\n' ..
		'margin-left: 1em;\n' ..
		'margin-bottom: 0.5em;\n' ..
		'padding: 0.5em;\n' ..
		'background-color: #f0f0f0;\n' ..
		'min-width: 15em;\n' ..
		'float: right;\n' ..
		'">\n' ..
		'{| width="100%" style="border-collapse: collapse;"\n' ..
		'|+ style="font-weight: bold" | ' .. header .. '\n'
	for i, entry in ipairs(infobox_data) do
		local caption = entry[1]
		local text = entry[2]
		s = s .. '|-\n' ..
			'| style="text-align:right; padding-right: 0.25em" | ' .. caption .. '\n' ..
			'| style="background-color: white; padding-left: 0.25em; font-weight: bold" | ' .. text .. '\n'
	end
	s = s .. '|}</div>'
	return s
end

return p