Module:Listen

-- This module implements .

local mFileLink = require('Module:File link') local mTableTools = require('Module:TableTools') local mSideBox = require('Module:Side box')

local p = {} local hasMidi, hasMissing -- Trackers for categories

function p.main(frame) local origArgs = frame:getParent().args local args = {} for k, v in pairs(origArgs) do v = v:match('^%s*(.-)%s*$') if v ~= then args[k] = v end end return p._main(args) end

function p._main(args) -- Organise the arguments by number. local numArgs = {} do local origNumArgs = mTableTools.numData(args) origNumArgs[1] = origNumArgs.other -- Overwrite args.filename1 etc. with args.filename etc. origNumArgs = mTableTools.compressSparseArray(origNumArgs) for i, t in ipairs(origNumArgs) do -- Check if the files exist. local obj = t.filename and mw.title.new('Media:' .. t.filename) if obj and obj.exists then numArgs[#numArgs + 1] = t else hasMissing = true end end -- Exit early if none exist. if #numArgs == 0 then return p.renderTrackingCategories(args, true) end end

-- Find whether we are outputting a plain or an embedded box. local isPlain = args.plain == 'yes' local isEmbedded = args.embed and true

-- Build the arguments for

local sbargs = {} sbargs.class = 'noprint' sbargs.metadata = 'no' sbargs.position = args.pos

-- Style arguments do local style = {} if isPlain then style[#style + 1] = 'border:none' style[#style + 1] = 'background:transparent' style[#style + 1] = 'float:none' end if isEmbedded then style[#style + 1] = 'border-collapse:collapse' style[#style + 1] = 'border-width:1px 0 0 0' style[#style + 1] = 'background:transparent' style[#style + 1] = 'float:none' style[#style + 1] = 'margin:0 -5px' end if args.pos == 'left' then style[#style + 1] = 'float:left' elseif args.pos == 'center' then style[#style + 1] = 'float:none' style[#style + 1] = 'margin-left:auto' style[#style + 1] = 'margin-right:auto' end

style[#style + 1] = args.style sbargs.style = table.concat(style, '; ') end sbargs.textstyle = 'line-height:1.1em'

-- Image if not isPlain and not isEmbedded then if args.image then sbargs.image = args.image else local images = { speech = 'Audio-input-microphone.svg', music = 'Gnome-mime-audio-openclipart.svg' } local image = args.type and images[args.type] or 'Gnome-mime-sound-openclipart.svg' sbargs.image = mFileLink._main{ file = image, size = '65x50px', location = 'center', link = , alt = } end end

-- Text do local header if args.header then header = mw.html.create('div') header:css{ background = 'transparent', ['text-align'] = 'left', padding = args.embed and '2px 0' or '2px' } :wikitext(args.header) header = tostring(header) header = header .. '\n' else header = end local text = {} for i, t in ipairs(numArgs) do text[#text + 1] = p.renderRow( t.filename, t.title, t.play, t.alt, t.description, t.start ) if numArgs[i + 1] then

text[#text + 1] = '

---

'

end end sbargs.text = header .. table.concat(text) end

-- Below if not isPlain and not isEmbedded and args.help ~= 'no' then sbargs.below = string.format(

'

---

Problems playing %s? See media help.',

#numArgs == 1 and 'this file' or 'these files' ) end

-- Render the side box. local sideBox = mSideBox._main(sbargs)

-- Render the tracking categories. local trackingCategories = p.renderTrackingCategories(args)

return sideBox .. trackingCategories end

function p.renderRow(filename, title, play, alt, description, start) -- Renders the HTML for one file description row. if not filename then return nil end local isMidi, player if play ~= 'no' then if filename:find('%.[Mm][Ii][Dd]$') then isMidi = true hasMidi = true player = p.renderMidi(filename) else player = mFileLink._main{ file = filename, size = '220px', alt = alt, start = start } end end local root = mw.html.create() root:tag('div') :addClass('haudio') :newline() :tag('div') :css('padding', '4px 0') :wikitext(string.format('%s', filename, title or )) :done() :newline() :tag('div') :cssText(isMidi and 'margin-top:-1em;width:220px;overflow:hidden') :wikitext(player) :done() :newline() :tag('div') :css('padding', '2px 0 0 0') :addClass('description') :wikitext(description) :done() :done() return tostring(root) end

function p.renderTrackingCategories(args, isEmpty, titleObj) -- Renders all tracking categories produced by the template. -- args and numArgs are passed through from p._main, -- and the titleObj is only used for testing purposes. local cats = {} local currentTitle = titleObj or mw.title.getCurrentTitle() if currentTitle.namespace == 0 then -- We are in mainspace. if not isEmpty then cats[#cats + 1] = 'Articles with hAudio microformats' end if hasMidi then cats[#cats + 1] = 'Articles with audio generated from MIDI files' end if hasMissing then cats[#cats + 1] = 'Articles with empty listen template' end end if args.plain == 'yes' then cats[#cats + 1] = 'Listen template using plain parameter' end for i, cat in ipairs(cats) do cats[i] = string.format(, cat) end return table.concat(cats) end

function p.renderMidi(filename) return mw.getCurrentFrame():extensionTag( 'score', [[\version "2.18" \new Staff \with { \remove "Staff_symbol_engraver" \omit "Staff.Clef" \omit "Staff.TimeSignature" } % Comment to re-generate (and use fluidsynth) \relative {s1^\markup{" "} }]], { vorbis = '1', override_midi = filename } ) end

return p