local SCRIPT_TITLE = '.Playing'

--[[

Synthesizer V Studio Pro Script
 
lua file name: PlayingPanel.lua
Show lyrics when lyrics are set to a full phrase (with + or - for subsequent notes)
(Similar karaoke display).

Notice: Works only with script panel 
		introduced with Synthesizer V version >= 2.1.2

Update: 2 - Minor updates and automatic following displaying notes scrolling inside editor view
		3 - Activate current group + scroll arrangement view
		4 - Debug registering views

2025 - JF AVILES
--]]

function getClientInfo()
	return {
		name = SV:T(SCRIPT_TITLE),
		-- category = "_JFA_Panels",
		author = "JFAVILES",
		versionNumber = 4,
		minEditorVersion = 131329,
		type = "SidePanelSection"
	}
end

-- Generated by JFA TranslateScripts.lua
function getTranslations(langCode)
	return getArrayLanguageStrings()[langCode]
end

-- Generated by JFA TranslateScripts.lua
function getArrayLanguageStrings()
	return {
		["en-us"] = {
			{"Play", "Play"},
			{"Version", "Version"},
			{"author", "author"},
			{"minEditorVersion", "minEditorVersion"},
			{"Stop", "Stop"},
			{"Time", "Time"},
			{"Group", "Group"},
			{"Lyrics display: decay", "Lyrics display: decay"},
			{"Auto scale views", "Auto scale views"},
		},
	}
end

-- Define a class  "NotesObject"
NotesObject = {
	playBack = nil,
	playHeadPosition = nil,
	displayVersion = true,			-- display version
	displayAuthor = false,			-- display author
	timeDecay = 0.4,				-- timeDecay to display lyrics before time (similar karaoke)
	autoZoomScales = true,			-- force zoom scale in views
	errorMessages = {},
	hostinfo = nil,
	osType = "",
	osName = "",
	hostName = "",
	languageCode = "", 
	hostVersion = "",
	hostVersionNumber = 0,
	playBackStatus = "",
	currentSeconds = 0,
	noteInfo = nil,
	projectDuration = 0,
	applyButtonValue = nil, 		-- button apply get lyrics
	keyNames = {},
	lyricsException = {},
	lyrics = "",
	labelApply = "",
	verticalRange = {},
	currentNote = 0,
    isPageTurning = false,
	targetPositionLeft = 0,
	isPageTurningVertical = false,
	targetPositionVertical = 0,
	navigEditor = nil,
	navigArrangement = nil,
	groupsSelected = nil
}

-- Constructor method for the NotesObject class
function NotesObject:new()
    local notesObject = {}
    setmetatable(notesObject, self)
    self.__index = self
	
	self.keyNames = {"C", "Db", "D", "Eb", "E", "F", "Gb", "G", "Ab", "A", "Bb", "B"}
	self.lyricsException = {"+", "++", "-", "br", "'", ".cl", ".pau", ".sil"}
	self.labelApply = SV:T("Play")
	
	self:getHostInformations()
	
	self.currentSeconds = 	SV:getPlayback():getPlayhead()
	self.projectDuration = 	self:getProjectDuration()
	
	self.controls = self:getControls()
	
	self:initializeControlsValues()
	self:setControlsCallback()
	
	self.applyButtonValue = SV:create("WidgetValue")
	
	self.statusTextValue = SV:create("WidgetValue")
	self.statusTextValue:setValue("")
	self.statusTextValue:setEnabled(false)

	self.lyricsTextValue = SV:create("WidgetValue")
	self.lyricsTextValue:setValue("")
	self.lyricsTextValue:setEnabled(false)
	
	self:setButtonApplyControlCallback()
	
	self.controls.timeDecay.value:setValue(self.timeDecay)
	self.controls.autoScales.value:setValue(self.autoZoomScales)
	
	local infos = getClientInfo()

	self.infosToDisplay = ""
	if self.displayVersion then
		self.infosToDisplay = self.infosToDisplay .. SV:T("Version") .. ": " ..  infos.versionNumber
		if self.displayAuthor then
			self.infosToDisplay = self.infosToDisplay .. " - " .. SV:T("author") .. ": " .. infos.author
		end
	end
	-- self.infosToDisplay = self.infosToDisplay .. SV:T("minEditorVersion") .. ": " ..  infos.minEditorVersion
	self:addTextPanel(self.infosToDisplay)

	-- Register arrangement selection callback
	self:registerArrangementSelectionCallback()

	-- Register editor view selection callback
	self:registerEditorViewSelectionCallback()

    return 	self
end

-- Register arrangement selection callback
function NotesObject:registerArrangementSelectionCallback()
	
	-- Register selection callback to load parameters when selection changes
	SV:getArrangement():getSelection():registerSelectionCallback(function(selectionType, isSelected)
		-- Nothing to do
	end)
	
	-- Register clear selection callback
	SV:getArrangement():getSelection():registerClearCallback(function(selectionType)
		-- No group selected in arrangement view
	end)
end

-- Register editor view selection callback
function NotesObject:registerEditorViewSelectionCallback()
	
	-- Register selection callback to load parameters when selection changes
	SV:getMainEditor():getSelection():registerSelectionCallback(function(selectionType, isSelected)
		-- Nothing to do
	end)
	
	-- Register clear selection callback
	SV:getMainEditor():getSelection():registerClearCallback(function(selectionType)
		-- No group selected in editor view
	end)
end

-- Show message dialog
function NotesObject:show(message)
	SV:showMessageBox(SV:T(SCRIPT_TITLE), message)
end

-- Get current track
function NotesObject:getCurrentTrack()
	return SV:getMainEditor():getCurrentTrack()
end

-- Get timeAxis
function NotesObject:getTimeAxis()
	return self:getProject():getTimeAxis()
end

-- Get project
function NotesObject:getProject()
	return SV:getProject()
end

-- Get filename only
function NotesObject:getFileNameOnly(file)
      return file:match("^.+\\(.+)$")
end

-- Add log into self.logs
function NotesObject:addLogs(message)
	table.insert(self.logs, message)
end

-- Display logs into panel
function NotesObject:addLogsInPanel()
	for i = 1, #self.logs do
		self:addTextPanel(self.logs[i])
	end
end

-- Set lyrics text in panel
function NotesObject:setlyricsTrackTextPanel(lyricsTrack)
	self.lyricsTextValue:setValue(lyricsTrack)
end

-- Display message box in panel
function NotesObject:addTextPanel(message)
	local old = self.statusTextValue:getValue()
	local sepLine = "\r"
	if #old > 0 then
		message = old .. sepLine .. message
	end
	self.statusTextValue:setValue(message)
end

-- Clear display message in panel
function NotesObject:clearTextPanel()
	self.statusTextValue:setValue("")
end

-- Store error message
function NotesObject:error(message)
	table.insert(self.errorMessages, message)
end

-- set project modified
function NotesObject:setProjectUpdated()
	local currentTrack = self:getCurrentTrack()
	currentTrack:setName(currentTrack:getName())	
end

-- Clear user project data
function NotesObject:clearLyricsData()
	self.lyricsTrack = ""
end

-- Get controls panel
function NotesObject:getControls()

	local controls = {
		timeDecay = {								-- Slider: time decay for lyrics display (karaoke)
			value = SV:create("WidgetValue"),
			defaultValue = 0, 
			paramKey = "timeDecay"
		},
		autoScales = {								-- Slider: time decay for lyrics display (karaoke)
			value = SV:create("WidgetValue"),
			defaultValue = self.autoZoomScales, 
			paramKey = "autoScales"
		},
	}
	return controls
end

-- Initialize widget values
function NotesObject:initializeControlsValues()
	-- Initialize widget values
	for key, control in pairs(self.controls) do
		control.value:setValue(control.defaultValue)
		-- self:addLogs(key .. "=" .. tostring(control.defaultValue))
		-- self:addLogs(key .. "=" .. self:getObjectProperties(control))
	end
end

-- Set controls callback
function NotesObject:setControlsCallback()
	for key, control in pairs(self.controls) do
		control.value:setValueChangeCallback(function()
				-- self:addLogsInPanel()
				if control.paramKey == "timeDecay" then
					self.timeDecay = self.controls.timeDecay.value:getValue()
				end
				if control.paramKey == "autoScales" then
					self.autoZoomScales = self.controls.autoScales.value:getValue()
				end
			end
		)
	end
end

-- Set button Apply control callback
function NotesObject:setButtonApplyControlCallback()

	-- Button copy lyrics to clipboard
	self.applyButtonValue:setValueChangeCallback(function()
			self.lyrics = ""
			self.navigEditor = SV:getMainEditor():getNavigation()
			self.navigArrangement = SV:getArrangement():getNavigation()
			if self.autoZoomScales then
				local scaleEditor = self:getScaleEditor()
				self.navigEditor:setTimeScale(scaleEditor)

				local scaleArrangement = self:getScaleArrangement()
				self.navigArrangement:setTimeScale(scaleArrangement)
			end
			
			if SV:getPlayback():getStatus() == "stopped" then
				SV:getPlayback():play()
				self.labelApply = SV:T("Stop")
				SV:setTimeout(5, function() self:setGroupNoteInfos() end)
				SV:setTimeout(10, function() self:setEditorViewPos() end)
			else
				self.currentSeconds = SV:getPlayback():getPlayhead()
				SV:getPlayback():stop()
				SV:getPlayback():seek(self.currentSeconds)
				self.labelApply = SV:T("Play")
			end
			SV:refreshSidePanel()
		end
	)
end

-- Display message
function NotesObject:displayMessage(message)
	self:clearTextPanel()
	self:addTextPanel(self.infosToDisplay)
	self:addTextPanel(message)
end

-- Simple trim string
function NotesObject:simpleTrim(s)
  return string.gsub(s, '[ \t]+%f[\r\n%z]', '')
end

-- Display error messages
function NotesObject:displayErrors()
	local result = ""
	if #self.errorMessages > 0 then
		for _, m in pairs(self.errorMessages) do
			result = result .. m .. "\r"
		end
	end
	return result
end

-- Get host informations
function NotesObject:getHostInformations()
	self.hostinfo = SV:getHostInfo()
	self.osType = self.hostinfo.osType  -- "macOS", "Linux", "Unknown", "Windows"
	self.osName = self.hostinfo.osName
	self.hostName = self.hostinfo.hostName
	self.languageCode = self.hostinfo.languageCode
	self.hostVersion = self.hostinfo.hostVersion
	self.hostVersionNumber = self.hostinfo.hostVersionNumber
end

-- Get object properties (debug only)
function NotesObject:getObjectProperties(obj, level)
	local result = ""
	local level = level or 0
	local maxLevel = 3
	level = level + 1
	
	for k, v in pairs(obj) do
		if obj[k] ~= nil then
			result = result .. "(level: " .. level .. ") " .. k .. "=" .. tostring(v) .. "\r"
			if type(v) == "table" then
				-- result = result .. ", size:" .. #v .. ": "
				if level < maxLevel then
					result = result .. self:getObjectProperties(v, level) .. "\r"
				else
					result = result .. "\r"
				end
			end
		end
	end
	return result
end

-- Get project duration
function NotesObject:getProjectDuration()
	local maxDuration = 0	
	local iTracks = self:getProject():getNumTracks()
	
	for iTrack = 1, iTracks do
		local trackItem = self:getProject():getTrack(iTrack)
		if trackItem:getDuration() > maxDuration then
			maxDuration = trackItem:getDuration()
		end
	end
	return maxDuration
end

-- Get string format from seconds
function NotesObject:secondsToClock(timestamp)
	return string.format("%02d:%06.3f", 
	  --math.floor(timestamp/3600), 
	  math.floor(timestamp/60)%60, 
	  timestamp%60):gsub("%.",",")
end

-- Set group note infos
function NotesObject:setGroupNoteInfos()
	self.playBackStatus = SV:getPlayback():getStatus()
	self.currentSeconds = SV:getPlayback():getPlayhead()

	local newInfo = self:secondsToClock(self.currentSeconds)
	
	local infos = self:getGroupNotes(newInfo)
	self:setlyricsTrackTextPanel(infos)	-- Display infos on panel
	
	-- Recursive loop
	if SV:getPlayback():getStatus() == "playing" or SV:getPlayback():getStatus() == "looping"  then
		SV:setTimeout(50, function() self:setGroupNoteInfos() end)		
	else
		self.labelApply = SV:T("Play")
		SV:refreshSidePanel()
	end
end

-- Set editor view pos
function NotesObject:setEditorViewPos()
    local margin = SV.QUARTER * 5	

	-- Horizontal range
	local viewRange = self.navigEditor:getTimeViewRange()
	local position = self:getTimeAxis():getBlickFromSeconds(SV:getPlayback():getPlayhead())
	
	local realTimeFollowingDisplayActive = true
	
	-- Real time following scroll display
	if realTimeFollowingDisplayActive then
		-- Position left=1.5, 1 , right=0.5, Take care of [0:2] range
		local multiplier = 0.9
		local newTime = position + ((viewRange[2] - viewRange[1])/2) * multiplier

		self.navigEditor:setTimeRight(position+((viewRange[2]-viewRange[1])/2)*multiplier)
		self.navigArrangement:setTimeRight(position+((viewRange[2]-viewRange[1])/2)*multiplier)
	else
		-- Scroll on right margin only
		if (self.isPageTurning and viewRange[1] < self.targetPositionLeft - margin) then
			-- self.navigEditor:setTimeLeft(viewRange[1] * 1 + self.targetPositionLeft * 0.004)
			self.navigEditor:setTimeLeft(viewRange[1] * 1 + self.targetPositionLeft * 0.004)
		else
			if (position > viewRange[2] - margin) then
				self.isPageTurning = true
				self.targetPositionLeft = viewRange[2]
			else
				self.isPageTurning = false
			end
		end
	end

	if self.currentNote > 0 then
		-- self.verticalRange = self.navigEditor:getValueViewRange()
		local diffNotes = math.abs(self.targetPositionVertical - self.currentNote)

		if self.isPageTurningVertical and diffNotes > 5 then
			if self.targetPositionVertical >= self.currentNote then
				self.isPageTurningVertical = false
				self.targetPositionVertical = self.currentNote
			else
				self.targetPositionVertical = self.targetPositionVertical + 1
			end
		else
			if (self.targetPositionVertical <= self.currentNote) then
				self.isPageTurningVertical = true
				if self.targetPositionVertical == 0 then
					self.targetPositionVertical = self.currentNote
				end
			else
				self.isPageTurningVertical = false
				self.targetPositionVertical = self.currentNote
			end
		end 
		self.navigEditor:setValueCenter(self.targetPositionVertical + 2) -- +2 to display phoneme above notes
	end
	
	if SV:getPlayback():getStatus() == "playing" or SV:getPlayback():getStatus() == "looping"  then
		SV:setTimeout(20, function() self:setEditorViewPos() end)
	end
end

-- Get scale Arrangement zoom display
function NotesObject:getScaleArrangement()
	local scaleArrangement = self.navigArrangement:getTimePxPerUnit()
	-- scaleArrangement: 0.0000001417
	-- max 1417 min 47 0.0000000047
	-- self:displayMessage("scaleArrangement: " .. string.format("%03.10f", scaleArrangement))
	
	-- If view=1417/6= 236 =>  0.0000000236
	local minZoom = 1417	-- 0.0000001417
	local factor = 6		-- 6
	local zoom = scaleArrangement * 100000000	-- 0.0000001417 to 1417
	zoom = (minZoom / factor) / 10000000000 -- 1417 to 0.0000001417
	return zoom
end

-- Get scale editor zoom display
function NotesObject:getScaleEditor()
	local scaleEditor = self.navigEditor:getTimePxPerUnit()
	-- scaleEditor: 0.0000007086
	-- max 7086 min 142
	-- self:displayMessage("scaleEditor: " .. string.format("%03.10f", scaleEditor))
	
	-- If view=7086/6=1181 =>  0.0000001181
	local minZoom = 7086	-- 0.0000007086
	local factor = 6		-- 6
	local zoom = scaleEditor * 100000000	-- 0.0000001181 to 1181
	zoom = (minZoom / factor) / 10000000000 -- 1181 to 0.0000001181
	return zoom
end

-- Play again from at beginning song
function NotesObject:playfromStart()
	SV:getPlayback():seek(0)
	SV:getPlayback():play()
end

-- Get the corresponding key note from pitch
function NotesObject:getKeyNote(pitch)
	local keyNote = self.keyNames[(pitch % 12) + 1]
	return keyNote
end

-- Is lyrics is a text accepted
function NotesObject:isTextAccepted(lyrics)
	local result = true
	
	-- Filter char '+' & '++' & '-' & 'br' & .cl & .pau & .sil
	for i, lyricsExcept in pairs(self.lyricsException) do
		if  lyrics == lyricsExcept then
			result = false
			break
		end
	end

	return result
end

-- Get the group notes name title with the current playing note infos
function NotesObject:getGroupNotes(infoTime)
	local infoNote = ""
	local lyrics = ""
	local note = nil
	local groupName = ""	
	local positionBlick = self:getTimeAxis():getBlickFromSeconds(SV:getPlayback():getPlayhead() + self.timeDecay)
	local isGroupNotesExists = self:getCurrentTrack():getNumGroups() > 1
	local result = ""
	local resultLyrics = ""
	
	self.currentNote = 0	
	for iGroupNote = 1, self:getCurrentTrack():getNumGroups() do
		groupRef = self:getCurrentTrack():getGroupReference(iGroupNote)
		local timeOffset = groupRef:getTimeOffset()
		local group = groupRef:getTarget()	
		
		if (groupRef:getOnset()) <= positionBlick and (groupRef:getEnd()) >= positionBlick then
			groupName = self:simpleTrim(group:getName())
			
			-- Force display current group (hack available with registered arrangement/editor view)
			SV:getMainEditor():setCurrentGroup(groupRef)
			
			infoNote, lyrics, note = self:getCurrentNoteInfo(group, positionBlick, timeOffset)
			infoNote = self:simpleTrim(infoNote)
			lyrics = self:simpleTrim(lyrics)

			if note ~= nil then
				-- if new note
				if self.currentNote ~= note:getPitch() then
					self.currentNote = note:getPitch()
				end
			else
				self.currentNote = 0
			end

			if #infoNote > 0 then
				if #lyrics > 0 then
					if self:isTextAccepted(lyrics) then
						resultLyrics = resultLyrics .. lyrics
						self.lyrics = resultLyrics
					end
				end
				
				local iGroup = iGroupNote
				if isGroupNotesExists and iGroupNote > 1 then
					iGroup = iGroupNote - 1
				end
				if #self:simpleTrim(groupName) > 0 then
					result = result .. SV:T("Time") .. ": " .. infoTime .. " " .. SV:T("Group") .. " " .. iGroup .. "\r"
					break
				end
			end
		end
		
	end

	if #self:simpleTrim(result) == 0 then
		result = result .. SV:T("Time") .. ": " .. infoTime .. "\r"
	end
	result = result .. self.lyrics .. "\r"
	
	return result
end

-- Get the current playing note infos
function NotesObject:getCurrentNoteInfo(group, position, timeOffset)
	local infoNote = ""
	local lyrics = ""
	local note = nil
	for iNote = 1, group:getNumNotes() do
		note = group:getNote(iNote)
		if note ~= nil then
			if (timeOffset + note:getOnset()) <= position 
				and (note:getEnd() + timeOffset) >= position then		
				infoNote, lyrics, note = self:getNoteContent(note)
				break
			end
		end
	end
	return infoNote, lyrics, note
end

-- Get the note content information
function NotesObject:getNoteContent(note)
	
	local infoNote = "Note: " .. self:getKeyNote(note:getPitch()) .. " (" .. string.format("%03d", note:getPitch()) .. ")"
	local lyrics = ""
	if note:getLyrics() ~= nil and string.len(note:getLyrics()) > 0 then
		lyrics = note:getLyrics()
	end
	if note:getPhonemes() ~= nil and string.len(note:getPhonemes()) > 0 then
		lyrics = lyrics .. " (" .. note:getPhonemes() .. ")"
	end						
	return infoNote, lyrics, note
end

-- Get section
function NotesObject:getSection()
	local timeDecayMinValue = 0
	local timeDecayMaxValue = 0.5
	local timeDecayInterval = 0.1

	local timeDecayChoice = 
		{
			type = "Container",
			columns = {
				{
					type = "Slider",
					text = SV:T("Lyrics display: decay"),
					format = "%0.1f decay",
					minValue = timeDecayMinValue, 
					maxValue = timeDecayMaxValue, 
					interval = timeDecayInterval,
					value = self.controls.timeDecay.value,
					width = 1
				}
			}
		}
	
	local autoScalesChoice = {
				type = "Container",
				columns = {
					{
					type = "CheckBox",
					text = SV:T("Auto scale views"),
					value = self.controls.autoScales.value,
					width = 1.0
					}
				}
			}

	-- Define CheckBox & button & textarea
	local section = {
		title = SV:T(SCRIPT_TITLE),
		rows = {
			timeDecayChoice,
			{
				type = "Container",
				columns = {
					{
						type = "TextArea",
						value = self.lyricsTextValue,
						height = 100,
						width = 1.0,
						readOnly = false
					}
				}
			},
			autoScalesChoice,
			{
				type = "Container",
				columns = {
					{
						type = "Button",
						text = self.labelApply,
						width = 1.0,
						value = self.applyButtonValue
					}
				}
			},
			{
				type = "Container",
				columns = {
					{
						type = "TextArea",
						value = self.statusTextValue,
						height = 40,
						width = 1.0,
						readOnly = true
					}
				}
			}
		}
	}
	return section
end

-- Get panel section state
function NotesObject:getPanelSectionState()

	self.applyButtonValue:setEnabled(true)
	local errors = self:displayErrors()
	if #errors > 0 then
		self:addTextPanel(errors)
	end
	
	-- Get section data
	local section = self:getSection()

	return section
end

-- Initialize main internal object	
local notesObject = NotesObject:new()

-- Get panel section state called by Synthesizer V internal system
function getSidePanelSectionState()

	local section = notesObject:getPanelSectionState()

	return section
end
