ardour/scripts/stop_at_marker.lua

ardour {
	["type"]    = "session",
	name        = "Stop at Marker",
	license     = "MIT",
	author      = "Ardour Lua Task Force",
	description = [[An example session script which stops the transport on every location marker when rolling forward.]]
}

function factory ()
	return function (n_samples)
		if (not Session:transport_rolling ()) then
			-- not rolling, nothing to do.
			return
		end

		local pos = Session:transport_sample () -- current playhead position
		local loc = Session:locations () -- all marker locations

		-- find first marker after the current playhead position, ignore loop + punch ranges
		-- (this only works when rolling forward, to extend this example see
		-- http://manual.ardour.org/lua-scripting/class_reference/#ARDOUR:Locations )
		local m = loc:first_mark_after (pos, false)

		if (m == -1) then
			-- no marker was found
			return
		end


		-- transport stop can only happen on a process-cycle boundary.
		-- This callback happens from within the process callback,
		-- so we need to queue it ahead of time.
		local blk = Session:get_block_size ()
		if (pos + blk<= m and pos + blk + n_samples > m ) then
			-- TODO use session event API, schedule stop at marker's time
			Session:request_transport_speed (0.0, true, ARDOUR.TransportRequestSource.TRS_Engine)
		end
	end
end