How do I Export/Create a list of plugins used in a project

caprenter · September 4, 2020, 8:06pm

I’d like to be able to export or create a list of plugins used in a project so that it’s easy to credit the plugin makers.

This does not have to be ‘in Ardour’ itself, although I could see how either the plugin manager could have a tab of ‘in use’ plugins, or perhaps the DSP Load window could have a text view (It lists everything in use, but I can’t easily copy it). Maybe even the Metadata editing could have a prefilled ‘Credits’ section of data, or the Export options could include a text export of ‘credits/plugins used’

Outside of the program, I looked at the data files created and wondered if parsing the .ttl files (I’ve tried a simple python script) in the ‘plugin’ directory would give me the data, but not all the plugins that are in use are referenced there.

Any ideas about if I could grab the data easily or not?

Thanks in advance, and thanks to everyone working on the project - this really is a great piece of software! All the best.

lordbullingdon · September 4, 2020, 9:58pm

Perhaps the “Mixer Screenshot” button could give you a good overview of the plugins used?

x42 · September 4, 2020, 10:02pm

There’s a Lua action script “List Plugins”.

Easiest is probably binding it to a button top-right (right-click on on of the unused, the “2” or “3” in the screenshot posted by @lordbullingdon), or run it interactively in Menu | Window > Scripting

Those are only LV2 plugins that have custom state.

You could grep the .ardour session file for <Processor.*type="lv2" or similar.

But those will only provide information about the plugin itself, not meta-data (author, etc) about the plugin. If you need those I expect the easiest would be to extend the Lua script.

github.com

Ardour/ardour/blob/master/share/scripts/list_plugins.lua#L18


	local rv = "Plugins used in this session:\n\n"
	local all_plugs = {}

	for r in Session:get_routes ():iter () do
		if r:is_monitor () or r:is_auditioner () then goto nextroute end -- skip special routes
		local i = 0
		while true do
			local proc = r:nth_plugin (i)
			if proc:isnil () then break end
			local pi = proc:to_insert () -- we know it's a plugin-insert (we asked for nth_plugin)
			local pp = pi:plugin (0)
			local id = pi:type() .. "-" .. pp:unique_id()
			local cnt = 0
			if pi:is_channelstrip () then goto nextproc end
			if all_plugs[id] then cnt = all_plugs[id]['cnt'] end
			all_plugs[id] = { name = proc:name(), ["type"] = pi:type(), id = pp:unique_id(), cnt = (cnt + 1) }
			::nextproc::
			i = i + 1
		end
		::nextroute::
	end

there you can use

local pinfo = pp:get_info()  -- PluginInfo struct

and then add that to the table in line 23 { … author = pinfo.creator …} and later print it.

lordbullingdon · September 4, 2020, 10:14pm

Wow, that’s great. I didn’t know it was possible to assign scripts to those buttons. Very handy! Particularly “Delete X Run Markers” and “Bypass Plugins”.

x42 · September 4, 2020, 10:22pm

That’s what those buttons are for, sadly it’s not well documented (although there are tooltips on those buttons). You can also assign keyboard shortcuts to bound actions.

In total 12 slots are available, Preferences > Appearance > Toolbar allows to show more if the default 4 are not sufficient.

end of off-topic,

x42 · September 4, 2020, 10:31pm

PS. Just pushed this upstream:

caprenter · September 5, 2020, 11:20am

Thanks @x42 and @lordbullingdon - this is absolutely brilliant!

It’s opened up a whole new world for me as well.

And thanks to the Robin’s commit I managed to add a slightly modified script to my .config/ardour6/scripts directory so I can easily copy and paste a ‘Credits’ bit of text. (don’t need count, or type, but do want URLs)

I get this by:
Change the name of the script in line 1 so I can see it!
Changing line 49 to:

rv = rv .. "\n<span face=\"mono\">" .. string.format ("%s (by %s) (%s)", v['name'], v['author'], v['id']) .. "</span>"

The ‘id’ is a useful URL in most cases but not all. I couldn’t quite fathom the documentation to get it right every time, but it’s close enough and I can copy and paste a couple of missing URLS.

An example with this line adjusted is:

a-High/Low Pass Filter (by Ardour Team) (3050946fa06312674e9b0ff9dbe519bef1160cd2)
a-Compressor (by Ardour Team) (urn:ardour:a-comp)
Red Zeppelin Drumkit Multi (by Robin Gareus) (http://gareus.org/oss/lv2/avldrums#RedZeppelinMulti)
General MIDI Synth (by Robin Gareus) (http://gareus.org/oss/lv2/gmsynth)
Calf Equalizer 8 Band (by Calf Studio Gear) (http://calf.sourceforge.net/plugins/Equalizer8Band)
MDA De-ess (by MOD Team) (http://moddevices.com/plugins/mda/DeEss)
GxAmplifier-X (by Guitarix team) (http://guitarix.sourceforge.net/plugins/gx_amp#GUITARIX)
Calf Equalizer 30 Band (by Calf Studio Gear) (http://calf.sourceforge.net/plugins/Equalizer30Band)
Noize Mak3r (by TAL-Togu Audio Line) (http://kunz.corrupt.ch/products/tal-noisemaker)
Barry’s Satan Maximiser (by Steve Harris) (1408)
Calf Bass Enhancer (by Calf Studio Gear) (http://calf.sourceforge.net/plugins/BassEnhancer)
Calf Vintage Delay (by Calf Studio Gear) (http://calf.sourceforge.net/plugins/VintageDelay)
GxVoodooFuzz (by Guitarix team) (http://guitarix.sourceforge.net/plugins/gx_voodoo_#voodoo)
Dragonfly Hall Reverb (by Michael Willis and Rob vd Berg) (https://github.com/michaelwillis/dragonfly-reverb)
Nekobi (by Sean Bolton, falkTX) (http://distrho.sf.net/plugins/Nekobi)
MDA SubSynth (by MOD Team) (http://moddevices.com/plugins/mda/SubSynth)

you can see that Steve Harris and Ardour don’t have useful URLs - but I can find them and put them in by hand!

There’s a fair bit of credit due to @x42 !!

So thanks again.

x42 · September 5, 2020, 4:31pm

I’m glad to hear that!

You could also remove the <span face=\"mono\"> then. The monospace font is used to align those.

Only LV2 plugins are identified by an URI (other plugin formats use a numeric ID or UUID).

LV2’s URI can be a URL that resolves, and by convention those point to documentation or source repos.

It looks like you’re using swh’s LADSPA (LV1) plugin, still, you could install swh-lv2.

caprenter · September 5, 2020, 8:10pm

Thanks again for the pointers - appreciate your time spent on this.

Working on it again this evening, I realised that I also wanted them listed alphabetically - my Lua isn’t up to it, so I used a spreadsheet instead! I’ll work on the Lua during the long winter nights… no need to spend any more time on this Robin for my sake.

All the best

system · December 6, 2020, 2:10am

This topic was automatically closed 91 days after the last reply. New replies are no longer allowed.