Update BuyOne_Update FX chain at object selection when one FX window at a time enabled.lua (ReaTeam#1174)

* Update BuyOne_Update FX chain at object selection when one FX window at a time enabled.lua

* Update BuyOne_Update FX chain at object selection when one FX window at a time enabled.lua

* Update BuyOne_Update FX chain at object selection when one FX window at a time enabled.lua

* Update BuyOne_Update FX chain at object selection when one FX window at a time enabled.lua

* Update BuyOne_Update FX chain at object selection when one FX window at a time enabled.lua

* Update BuyOne_Update FX chain at object selection when one FX window at a time enabled.lua

* Update BuyOne_Update FX chain at object selection when one FX window at a time enabled.lua

* Update BuyOne_Update FX chain at object selection when one FX window at a time enabled.lua

* Update BuyOne_Update FX chain at object selection when one FX window at a time enabled.lua

* Update BuyOne_Update FX chain at object selection when one FX window at a time enabled.lua

Author: Buy-One

FX/BuyOne_Update FX chain at object selection when one FX window at a time enabled.lua

@@ -2,33 +2,49 @@
 ReaScript name: Update FX chain at object selection when one FX window at a time enabled
 Author: BuyOne
 Website: https://forum.cockos.com/member.php?u=134058
-Version: 1.2
-Changelog: 	#Added option to prevent updating a docked FX chain when the docker is closed
+Version: 1.3
+Changelog: 	#Added support for empty FX chains as a new setting
+		#Added support for ignoring selection if no FX chain window is open, as a new setting
+		#Added a setting to ignore track FX chains
+		#Added a setting to prefer open track FX chain and prevent replacing it with take FX chain
+		#Fixed bug of inability to close Master/Monitoring FX chains
 Licence: WTFPL
 REAPER: at least v5.962
+Extensions: jsReaScriptAPI recommended
 Screenshots: https://git.io/JXjO6
-About:	REAPER stock preferences allow changing open FX chain on track selection when options
+About: 	REAPER stock preferences allow changing open FX chain on track selection when options
 	"Only allow one FX chain window open at a time" and "Open track FX window on track
 	selection change" are enabled at Preferences -> Plug-ins. But they only affect track
-	main FX chain. This sctript additionally covers track input/Monitoring FX chains and
+	main FX chain. This script additionally covers track input/Monitoring FX chains and
 	take FX chain.  
+
 	Meant to be used only when the option "Only allow one FX chain window open at a time" 
 	is enabled at Preferences -> Plug-ins in a global FX chain kind of setup.  
 	Normally when option "Only allow one FX chain window open at a time" is enabled, 
 	to update currently open FX chain window with another FX chain, FX button must be 
 	clicked on the TCP or on the item.  
+
 	This script makes this a bit simpler by allowing to update the window with object 
 	selection, which requires less precision than clicking the tiny FX buttons,
-	besides ensuring that the FX chain is readily accessible.  		   
+	besides ensuring that the FX chain is readily accessible.  
+
+	The script doesn't interfere with the option "Open track FX window on track
+	selection change", it affects track FX chains regardless of whether it's enabled 
+	unless IGNORE_TRACKS setting is enabled in the USER SETTINGS and on top of that 
+	it supports Master, Monitor and input FX chains.
+
 	For best experience FX chain window should be docked, but the updating will work 
 	just as good with a floating FX chain window.  
+
 	To use it in a docker it's usually sufficient to dock any FX chain window, 
 	the rest will stay docked automatically, yet sometimes adjustment of a few
 	individual FX windows may be required.   
+
 	Active take FX chain is always loaded at item selection. The type of track FX chain 
 	to be loaded at track selection is determined by the USER SETTING below, but 
 	you'll still be able to load track FX chain of the other type normally by clicking 
 	FX button of the corresponding track.  
+
 	The currently open FX chain window can be temporarily closed with a click on FX button
 	or a by closing its tab in the docker, until another object is selected.   
 	Clicking FX button is also a way to re-open a closed FX chain of the same selected 
@@ -42,17 +58,16 @@ About:	REAPER stock preferences allow changing open FX chain on track selection
 	FX chain window always becomes focused when updated, which means that if 
 	it's docked and open but not active (hidden) in a tabbed docker it will 
 	become active (visible), if it's docked in a closed docker the docker will
-	open, and if it's floating it will come in front of other windows.
+	open, and if it's floating it will come in front of other windows.   
 
 	When FX chain changes in a docker it flickers because one is closed and another
 	is opened. This is REAPER's behavior which can't be controlled with a script.
 
 	The FX chain of the last selected track which stays selected, can be re-opened 
-	with a click on the TCP after the FX chain was replaced with take FX chain, 
-	however not vice versa. In order to re-open take FX chain of the last selected 
+	with a click on the TCP after the FX chain was replaced with a take FX chain, 
+	however not vice versa. In order to re-open a take FX chain of the last selected 
 	item/active take after it was replaced with a track FX chain such item must be
 	deselected and selected again.
-		
 ]]
 
 -----------------------------------------------------------------------------
@@ -65,21 +80,50 @@ About:	REAPER stock preferences allow changing open FX chain on track selection
 -- otherwise track main FX chain (incl. Master track FX chain) -- default
 TRACK_FX_CHAIN = ""
 
+-- Enable to make the script ignore track FX chains entirely;
+-- in this case TRACK_FX_CHAIN setting above will be ignored 
+-- and track FX chains will only load at track selection 
+-- if the setting "Open track FX window on track selection change"
+-- is enabled at Preferences -> Plug-ins
+IGNORE_TRACKS = ""
+
+-- If enabled, currently open track FX chain will get priority
+-- and item selection won't replace it with take FX chain;
+-- the setting applies regardless of the above settings;
+-- if js_ReaScriptAPI extension is not installed and RESPECT_EMPTY_FX_CHAINS
+-- setting is enabled below, this setting won't apply to open 
+-- empty track FX chains 
+PREFER_OPEN_TRACK_CHAIN = ""
+
 -- To be able to also load take FX chain on item selection,
 -- only active take FX chain in a multi-take item can be loaded
 TAKE_FX_CHAIN = "1"
 
+-- Switch to FX chain of selected object 
+-- even if its FX chain is empty
+RESPECT_EMPTY_FX_CHAINS = ""
+
 -- If enabled, FX chain window can be updated by change in selection performed
--- by means other than mouse click
+-- by means other than mouse click, 
+-- e.g. with actions 'Track: Go to next/previous track',
+-- 'Item navigation: Select and move to next/previous item'
+-- 'Item navigation: Select and move to item in next/previous track'
 CHANGE_IN_SELECTION_CHANGES_FOCUS = ""
 
 -- To only have FX chain updated when the docker is open,
--- meant to prevent opening and updating a docked FX chain window
+-- meant to prevent opening and updating a docked FX chain window 
 -- when the docker is closed
 -- will affect floating FX chain window as well
 -- so only useful when one is docked
 ONLY_WHEN_DOCKER_OPEN = ""
 
+-- Enable to make the script only update FX chain if FX chain window 
+-- is already open, and ignore object selection if none is open;
+-- if js_ReaScriptAPI extension is not installed and RESPECT_EMPTY_FX_CHAINS
+-- setting is enabled above, the script will only update FX chain 
+-- on object selection if currently open chain isn't empty
+ONLY_WHEN_FX_CHAIN_OPEN = ""
+
 -----------------------------------------------------------------------------
 -------------------------- END OF USER SETTINGS -----------------------------
 -----------------------------------------------------------------------------
@@ -104,15 +148,37 @@ f:close()
 return cont:match(key..'=(%d+)')
 end
 
+
+function GetMonFXProps() -- get mon fx accounting for floating window, reaper.GetFocusedFX() doesn't detect mon fx in builds prior to 6.20
+
+-- r.TrackFX_GetOpen(master_tr, integer fx)
+	local master_tr = r.GetMasterTrack(0)
+	local src_mon_fx_idx = r.TrackFX_GetRecChainVisible(master_tr)
+	local is_mon_fx_float
+		if src_mon_fx_idx < 0 then -- fx chain closed or no focused fx -- if this condition is removed floated fx gets priority
+			for i = 0, r.TrackFX_GetRecCount(master_tr) do
+				if r.TrackFX_GetFloatingWindow(master_tr, 0x1000000+i) then
+				src_mon_fx_idx = i; is_mon_fx_float = true break end
+			end
+		end
+	return src_mon_fx_idx, is_mon_fx_float
+end
+
+
 -- Thanks to mespotine for figuring out config variables
 -- https://github.com/mespotine/ultraschall-and-reaper-docs/blob/master/Docs/Reaper-ConfigVariables-Documentation.txt
 
 	if Check_reaper_ini('fxfloat_focus')&2 == 0 then r.MB(space(6)..'The script only makes sense when option\n\n"Only allow one FX chain window open at a time"\n\n'..space(9)..'is enabled at Preferences -> Plug-ins', 'ERROR',0)
-    return r.defer(function() if not bla then  return end end) end
+    return r.defer(function() if not bla then return end end) end
 
 main_ch = #TRACK_FX_CHAIN:gsub(' ','') == 0
+ignore_tr = #IGNORE_TRACKS:gsub(' ','') > 0
+pref_open_tr_ch = #PREFER_OPEN_TRACK_CHAIN:gsub(' ','') > 0
 take_ch = #TAKE_FX_CHAIN:gsub(' ','') > 0
+empty_ch = #RESPECT_EMPTY_FX_CHAINS:gsub(' ','') > 0
 change_focus = #CHANGE_IN_SELECTION_CHANGES_FOCUS:gsub(' ','') > 0
+chain_op = #ONLY_WHEN_FX_CHAIN_OPEN:gsub(' ','') > 0
+jsAPI = r.APIExists('JS_Window_Find')
 
 local init_tr
 local init_take = r.GetSelectedMediaItem(0,0) and r.GetActiveTake(r.GetSelectedMediaItem(0,0)) -- ensures that track selection gets priority and there's no competition between track and take fx chains of selected objects when the script is launched because act_take ~= init_take condition won't be true
@@ -131,20 +197,22 @@ local act_take = item and r.GetActiveTake(item)
 local curr_ctx = r.GetCursorContext()
 local curr_ctx = change_focus and sel_tr ~= init_tr and r.SetCursorContext(0)
 or change_focus and act_take ~= init_take and r.SetCursorContext(1) or curr_ctx
-
-	if sel_tr and (sel_tr ~= init_tr or curr_ctx ~= init_ctx) and curr_ctx == 0 -- curr_ctx ~= init_ctx makes sure track and take fx chains can be switched even if object selection hasn't changed
+local chain_op = chain_op and (r.GetFocusedFX() > 0 or GetMonFXProps() >= 0 or jsAPI and r.JS_Window_GetTitle(r.JS_Window_Find('FX: ', false)):match('FX: [ItemMonigsTrack]+')) or not chain_op -- empty FX chains are ignored by GetFocusedFX() so have to be detected via window props search
+local pref_open_tr_ch = pref_open_tr_ch and (r.GetFocusedFX() == 1 or GetMonFXProps() >= 0 or jsAPI and r.JS_Window_GetTitle(r.JS_Window_Find('FX: ', false)):match('FX: [TrackMonigste]+')) -- see prev comment
+	
+	if not ignore_tr and sel_tr and (sel_tr ~= init_tr or curr_ctx ~= init_ctx) and curr_ctx == 0 and DOCKER_STATE and chain_op -- curr_ctx ~= init_ctx makes sure track and take fx chains can be switched even if object selection hasn't changed
 	then
-	local master, track -- specifically declared, otherwise empty fx chains get opened, because the vars become global and don't depend on the below condition any longer
-		if main_ch and r.TrackFX_GetCount(sel_tr) > 0 then
+	local master, track -- specifically declared, otherwise empty fx chains get opened even if not enabled, because the vars become global and don't depend on the below condition any longer
+		if main_ch and (empty_ch or not empty_ch and r.TrackFX_GetCount(sel_tr) > 0) then
 		master, track = 40846, 40291 -- Track: View FX chain for master track /  Track: View FX chain for current/last touched track
-		elseif r.TrackFX_GetRecCount(sel_tr) > 0 then
+		elseif not main_ch and (empty_ch or not empty_ch and r.TrackFX_GetRecCount(sel_tr) > 0) then
 		master, track = 41882, 40844 -- View: Show monitoring FX chain / Track: View input FX chain for current/last touched track
 		end
 	local upd = master and tr_name[2] == 'MASTER' and r.Main_OnCommand(master,0) or track and r.Main_OnCommand(track,0)
 	init_tr = sel_tr
 	init_ctx = curr_ctx
 	end
-	if take_ch and act_take and act_take ~= init_take and r.TakeFX_GetCount(act_take) > 0 and curr_ctx == 1 -- curr_ctx ~= init_ctx condition isn't used so take FX chain doesn't compete with track FX chain completely preventing it from loading in tabbed dock layout
+	if not pref_open_tr_ch and take_ch and act_take and act_take ~= init_take and (empty_ch or not empty_ch and r.TakeFX_GetCount(act_take) > 0) and curr_ctx == 1 and DOCKER_STATE and chain_op -- curr_ctx ~= init_ctx condition isn't used so take FX chain doesn't compete with track FX chain completely preventing it from loading in tabbed dock layout
 	then
 	r.Main_OnCommand(40638,0) -- Item: Show FX chain for item take
 	init_take = act_take
@@ -153,7 +221,7 @@ or change_focus and act_take ~= init_take and r.SetCursorContext(1) or curr_ctx
 
 	if r.CountSelectedMediaItems(0) == 0 then init_take = nil end -- reset, ensures that FX chain of the last selected item can be re-opened after the item was deselected and selected again
 	--[needed when curr_ctx ~= init_ctx isn't used as a condition to switch to take fx chain since it's commented out in the track fx chain selection routine to prevent auto-switching to take fx chain in tabbed docker layout]
-	if r.CountSelectedTracks(0) == 0 then init_tr = nil end -- reset, ensures that FX chain of the last selected track can be re-opened after the track was deselected and selected again
+	if r.CountSelectedTracks2(0, true) == 0 then init_tr = nil end -- wantmaster true; reset, ensures that FX chain of the last selected track can be re-opened after the track was deselected and selected again;
 
 r.defer(UPDATE_FX_CHAIN)