API Functions Request: Get/Set SWS Notes and Subtitles

[X-Raym]

Hi !

SWS come with Regions and Markers notes (subtitles) possibility.
But, we cant reach them at script level.
It would be nice to have a function like GetMarlerNotes(id) so that we can return these notes into ReaScript.

Thanks for listening !

[X-Raym]

A Set function would be handy too. 👍
Or we can consider GetSet functions instead.

Also, extra notes from SWS are not accessible either from API, like :

• Track notes
• Extra project notes

For flexibility, it would be nice to have them too.

[X-Raym]

@nofishonfriday Hi ! Any progress on your investigation about this ? :)

[nofishonfriday]

@X-Raym
Here's a test version for getting / setting region subtitles (for markers may come later if getting to working ok with regions):
https://www.dropbox.com/s/ysl24dy2ftuzq5k/reaper_sws64_GetSetRegionSubs01.dll?dl=1

Example code:

reaper.ClearConsole()

function msg(m)
  return reaper.ShowConsoleMsg(tostring(m) .. "\n")
end

local regionIdx = 1 -- one-based (as how region numbers are displayed in the project / Region/Marker manager)

-- SET REGION SUB --
local fastStringIn = reaper.SNM_CreateFastString("Subtitle text for region " .. regionIdx)

-- set region sub, note: region must in exist in project already that region sub can be set!
-- returns true if region sub is set successfully (ie region exists in project)
regionSubIsSet = reaper.NF_SetRegionSub(fastStringIn, regionIdx) 

reaper.SNM_DeleteFastString(fastStringIn)


-- GET REGION SUB --
local fastStringOut = reaper.SNM_CreateFastString("")

-- get region sub, returns empty string if region not existant or region sub not set
regionSub = reaper.NF_GetRegionSub(fastStringOut, regionIdx) 

msg("Region sub for region " .. regionIdx .. ": " .. regionSub)
reaper.SNM_DeleteFastString(fastStringOut)

Let me know how it goes. :)

[X-Raym]

@nofish Nice you work on that :P

Could it be based on RegionIDX (like parameter of EnumProjectMarker) or on idx (like the retval of EnumProjectMarker) ?

Currently, if there is markers, it is not very handy to plug this function.

Here is demo code with a usual region/marker loop:

https://www.dropbox.com/s/fi8wnguret60a2j/region%20notes.rpp?dl=0

count_markers_and_regions, count_regions = reaper.CountProjectMarkers(0)
for i = 0, count_markers_and_regions - 1 do
  local retval, isrgnOut, posOut, rgnendOut, nameOut, markrgnindexnumberOut =  reaper.EnumProjectMarkers( i )
  local fastStringOut = reaper.SNM_CreateFastString("")
  regionSub = reaper.NF_GetRegionSub(fastStringOut, retval)
  msg("Region sub " .. retval .. " = " .. regionSub)
  reaper.SNM_DeleteFastString(fastStringOut)
  i = i + 1
end

We already have to deal with idx and regionIDX, so a third type of index (the one displayed on the timeline, wich is different that the other two) is a bit confusing. (or maybe I miss something. Which prove it can be confusing haha :P)

Note that it is already generic (it can return both marker and region notes, so the name might be change). IMHO, it it can deal with EnumProjectMarkers( i ) i parameter it would then be more coherent (as this function is also able to return both markers and regions).

What do you think ?

[nofishonfriday]

Could you do a quick explaination about RegionIDX and idx, what do they specify (what's the difference) ?
I'm currently getting confused by this. :D

[X-Raym]

@nofishonfriday well, the most confusing part is that all of that are called indexes ^^

Ok so I tested with a more complete code snippet. Let's restart from there:

count_markers_and_regions, count_regions = reaper.CountProjectMarkers(0)
for i = 0, count_markers_and_regions - 1 do
  local retval, isrgnOut, posOut, rgnendOut, nameOut, markrgnindexnumberOut =  reaper.EnumProjectMarkers( i )
  markerIdx, regionIdx = reaper.GetLastMarkerAndCurRegion( 0, posOut )
  local fastStringOut = reaper.SNM_CreateFastString("")
  regionSub = reaper.NF_GetRegionSub(fastStringOut, markrgnindexnumberOut)
  msg("i = " .. i)
  msg("retval = " .. retval)
  msg("is_region = " .. tostring(isrgnOut))
  msg("markrgnindexnumberOut = " .. markrgnindexnumberOut)
  msg("NOTES = " .. regionSub)
  msg("")
  reaper.SNM_DeleteFastString(fastStringOut)
  i = i + 1
end

• We have EnumProjectMarkers( i ) index. This can return both Region or Markers. i is zero based.
• The retval of EnumProjectMarkers( i ) is in fact just i + 1.
• the markrgnindexnumber returned value of EnumProjectMarkers( i ) is the number in the arrange view

So it sounds like the markrgnindexnumber should work, according to your comment, but it does not. Something is wrong in the get notes function. I think it is confused by the order of the marker/region.

Here what I got with my RPP:

i = 0
retval = 1
is_region = true
markrgnindexnumberOut = 1
NOTES = Region 1

i = 1
retval = 2
is_region = false
markrgnindexnumberOut = 1
NOTES = Region 1

i = 2
retval = 3
is_region = true
markrgnindexnumberOut = 3
NOTES = Region 3

i = 3
retval = 4
is_region = false
markrgnindexnumberOut = 2
NOTES = Marker 1

i = 4
retval = 5
is_region = true
markrgnindexnumberOut = 2
NOTES = Marker 1

Instead of

i = 0
retval = 1
is_region = true
markrgnindexnumberOut = 1
NOTES = Region 1

i = 1
retval = 2
is_region = false
markrgnindexnumberOut = 1
NOTES = Marker 1

i = 2
retval = 3
is_region = true
markrgnindexnumberOut = 3
NOTES = Region 3

i = 3
retval = 4
is_region = false
markrgnindexnumberOut = 2
NOTES = Marker 2

i = 4
retval = 5
is_region = true
markrgnindexnumberOut = 2
NOTES = Region 2

What I would find useful is the NF_GetRegionSub to be a NF_GetMarkerRegionSub and would work just like the EnumProjectMarkers( i ) with the i parameter. This way, easy to plug in the loop !

[nofishonfriday]

Your provided material helps a lot again Sir! °°
Thanks.

Next version:
https://www.dropbox.com/s/m37shzq1cbhncgk/reaper_sws64_GetSetRegionSubs02.dll?dl=1

updated script:

reaper.ClearConsole()

function msg(m)
  return reaper.ShowConsoleMsg(tostring(m) .. "\n")
end

count_markers_and_regions, count_regions = reaper.CountProjectMarkers(0)
for i = 0, count_markers_and_regions - 1 do
  local retval, isrgnOut, posOut, rgnendOut, nameOut, markrgnindexnumberOut =  reaper.EnumProjectMarkers( i )
  markerIdx, regionIdx = reaper.GetLastMarkerAndCurRegion( 0, posOut )
  local fastStringOut = reaper.SNM_CreateFastString("")
  regionSub = reaper.NF_GetMarkerRegionSub(fastStringOut, i) -- renamed function and works now on i index!
  msg("i = " .. i)
  msg("retval = " .. retval)
  msg("is_region = " .. tostring(isrgnOut))
  msg("markrgnindexnumberOut = " .. markrgnindexnumberOut)
  msg("NOTES = " .. regionSub)
  msg("")
  reaper.SNM_DeleteFastString(fastStringOut)
  i = i + 1
end

Console output I now get with your project:

i = 0
retval = 1
is_region = true
markrgnindexnumberOut = 1
NOTES = Region 1

i = 1
retval = 2
is_region = false
markrgnindexnumberOut = 1
NOTES = Marker 1

i = 2
retval = 3
is_region = true
markrgnindexnumberOut = 3
NOTES = Region 3

i = 3
retval = 4
is_region = false
markrgnindexnumberOut = 2
NOTES = Marker 2

i = 4
retval = 5
is_region = true
markrgnindexnumberOut = 2
NOTES = Region 2

Looks ok ?
(The Set... function is not working correctly yet...)

[X-Raym]

@nofishonfriday This does looks like to be the expected results ! Well done 💃

I assume the setting function is harder, but at least we have a clear idea of how it should behave.

Having these accessible via API will really bring interoperability to Region and Markers.

Good luck !

[nofishonfriday]

Next version for testing the Set function:
https://www.dropbox.com/s/8mrmlkkh4nxclud/reaper_sws64_GetSetRegionSubs03.dll?dl=1

For test code I used this:

reaper.ClearConsole()

function msg(m)
  return reaper.ShowConsoleMsg(tostring(m) .. "\n")
end

-- set subs
count_markers_and_regions, count_regions = reaper.CountProjectMarkers(0)
for i = 0, count_markers_and_regions - 1 do
  local retval, isrgnOut, posOut, rgnendOut, nameOut, markrgnindexnumberOut =  reaper.EnumProjectMarkers( i )
  
  if isrgnOut == true then 
    fastStringIn = reaper.SNM_CreateFastString("new Subtitle text for region " .. markrgnindexnumberOut)
  else
    fastStringIn = reaper.SNM_CreateFastString("new Subtitle text for marker " .. markrgnindexnumberOut)
  end
  
  regionSubIsSet = reaper.NF_SetMarkerRegionSub(fastStringIn, i)
  reaper.SNM_DeleteFastString(fastStringIn)
  i = i + 1
end

-- get subs
count_markers_and_regions, count_regions = reaper.CountProjectMarkers(0)
for i = 0, count_markers_and_regions - 1 do
  local retval, isrgnOut, posOut, rgnendOut, nameOut, markrgnindexnumberOut =  reaper.EnumProjectMarkers( i )
  markerIdx, regionIdx = reaper.GetLastMarkerAndCurRegion( 0, posOut )
  local fastStringOut = reaper.SNM_CreateFastString("")
  regionSub = reaper.NF_GetMarkerRegionSub(fastStringOut, i)
  msg("i = " .. i)
  msg("retval = " .. retval)
  msg("is_region = " .. tostring(isrgnOut))
  msg("markrgnindexnumberOut = " .. markrgnindexnumberOut)
  msg("NOTES = " .. regionSub)
  msg("")
  reaper.SNM_DeleteFastString(fastStringOut)
  i = i + 1
end

What do you think ?

[X-Raym]

@nofishonfriday This seems to works flawlessly, even with non consecutive marker index ! Ready to be merge :P

Note: You can color highlight your code snippet :P https://help.github.com/articles/creating-and-highlighting-code-blocks/

[nofishonfriday]

Cool, thanks for testing.

Some final touches before PR / merge:
https://www.dropbox.com/s/0j6w9yhve6hrj1c/reaper_sws64_GetSetRegionSubs04.dll?dl=1

• Functions have been renamed to NF_Get/SetSWSMarkerRegionSub (to be consistent with already existing NF_Get/SetSWSTrackNotes)

• SetMarkerRegionSub got a new param, see updated ReaScript API doc. (ReaScript: Open reaScript documentation (html)... )

Also it would be nice if you could say what you think about the doc for these functions, if I should change/add anything.
Thanks.

[X-Raym]

@nofishonfriday All good and working fine !

(how much faster it is with the force update set to off ?)