js_ReaScriptAPI extension

[juliansader]

Originally Posted by TabbyCat

It's not clear to me what the purpose of that PassThrough function is, since it has exactly the same number of args as reaper.JS_WindowMessage_Intercept and they both return an integer. I'm not sure if there's any performance/readability difference between trying to set the flag on an existing intercept, vs creating/destroying one outright...so I've just been using the latter function.

Intercept is for setting up new intercepts, and will return an error if the message type is already being intercepted -- perhaps by another script that expects a certain input.
Passthrough forces an existing intercept to change, and returns an error if the message type is not already being intercepted.

I often think about how the WindowMessage functions can be improved so that multiple scripts can more easily intercept the same message type at the same time, but I haven't yet figured out an optimal way.

Originally Posted by Sexan

Are there any changes to WindowMessage_PassThrough API?

if track_part == "LOWER" then
   reaper.JS_WindowMessage_PassThrough(track_window, "WM_LBUTTONDOWN", false)
elseif track_part == "UPPER" then
   reaper.JS_WindowMessage_PassThrough(track_window, "WM_LBUTTONDOWN", true)
end

This does not do anything ? Should be blocking mouse click. Its looped while the mouse is down so not sure why its not working.

There have been no changes to this functions, IIRC. If there is already an intercept for WM_LBUTTONDOWN on track_window, this code should block clicks when track_part == "LOWER". What value does the function return? If success, it should return 1. If there is no existing intercept, it should return 0.

[juliansader]

Originally Posted by Sexan

This code worked as is in my script,not sure if something updated broke it

EDIT:
Really not sure what I'm doing wrong... I cannot do any intercept of any kind (mouse).

Any example how to block LMB ?

This seems to work fine on my system, blocking LBUTTON for 10 seconds:

w = reaper.JS_Window_FromPoint(reaper.GetMousePosition())
iOK = reaper.JS_WindowMessage_Intercept(w, "WM_LBUTTONDOWN", false)
t = reaper.time_precise()

function loop()
    pOK, pass, time = reaper.JS_WindowMessage_Peek(w, "WM_LBUTTONDOWN")
    if pOK and time > t+10 then 
        reaper.JS_WindowMessage_Release(w, "WM_LBUTTONDOWN") 
        return 
    end
    reaper.defer(loop)
end

loop()

[Sexan]

I'm little confused because the code worked before I even have a gif few pages back where I block mouse click when drawing over envelopes (when you introduced mouse cursors), its pretty much the exact same code whats only added is envelope cursors (if cursor == xyz_envelope) ...

Maybe I'm going insane....


What function does is:
Tracks where the mouse is in track (upper or lower half) but it waits for mouse click to return the value. If its in upper half and there is defined cursor to avoid then disable mouse click and after mouse is released enable the mouse button.

Mouse click needs to be blocked BEFORE its clicked?
Mouse click is disabled only in certain conditions and it should be enabled when its released.

EDIT: So if I got it right, mouse needs to be intercepted from the beginning all the time and released when told ?

[TabbyCat]

Originally Posted by juliansader

Intercept is for setting up new intercepts, and will return an error if the message type is already being intercepted -- perhaps by another script that expects a certain input.
Passthrough forces an existing intercept to change, and returns an error if the message type is not already being intercepted.

Ah I see. PassThrough doesn't have an error code list in the auto-generated docs for some reason - assumed it was the same as Intercept and InterceptList (which are both identical).

Helpful, thank you.

[Dafarkias]

Me again, again, again... again?

Any chance you'd consider adding something like this to your ext?

reaper.BR_GetMediaTrackByGUID( proj, guidStringIn )

[juliansader]

I'm not sure I understand -- isn't the SWS function working correctly?

(The purpose of this extension is to give scripts access to C++ functions and capabilities that aren't natively included in the ReaScript API.)

[Dafarkias]

It does.

And actually now that I think it should it, it's very easy to just run a loop through all project media tracks in a project to check whether their GUID's match without the use of Breeder's function.

Once again, I am stupid.

I get into a sort of 'zone' when I'm coding where dumb ideas pop into my head and I think they are brilliant. It's weird

[X-Raym]

Hi !


Just curious, we have reaper.JS_Window_AttachTopmostPin( windowHWND ) but do we have a function to Get Pin State of a window ?


Thx !

[Sexan]

Julian whats your approach with intercepting in multitool?

You change the cursor and then block the mouse?

I'm kind on the dead end with ideas how to block mouse click when I'm on item edge (i need to block on specific part of the track when on item for example block only when on edge of the item and in upper half of the track so the bottom is free for reaper native actions). But for now I cannot make any good implementation (it wont block if the mouse is already clicked)

[nappies]

Originally Posted by Sexan

Julian whats your approach with intercepting in multitool?

You change the cursor and then block the mouse?

I'm kind on the dead end with ideas how to block mouse click when I'm on item edge (i need to block on specific part of the track when on item for example block only when on edge of the item and in upper half of the track so the bottom is free for reaper native actions). But for now I cannot make any good implementation (it wont block if the mouse is already clicked)

Hey Sexan! Unfortunately I can`t to find solution too. How to intercept messages with custom cursors.I have one idea how but we need some new api from devs.

[Sexan]

I would really appreciate some help here IF someone has some idea:

Bypass mouse click when certain condition is met.

Not sure if it can be done WHEN mouse is already clicked.... (I've tried everything but it bypasses it on next click)

If something like this would be possible we are good:
1. Click
2. Condition
3. Bypass
4. Release
5. Remove bypass

I'm open to any ideas here

[juliansader]

I'm not quite sure I understand what you are trying to do, but I suggest:
* Intercept and block WM_LBUTTONDOWN (and perhaps WM_LBUTTONDBLCLK too).
* If you detect a click, and if the click should be passed through, pass it on with JS_WindowMessage_Post or _Send (I'm not sure which of the two would work best).

[juliansader]

Originally Posted by nappies

Hey Sexan! Unfortunately I can`t to find solution too. How to intercept messages with custom cursors.I have one idea how but we need some new api from devs.

Could you explain a bit more what you are trying to do?

[juliansader]

Originally Posted by Sexan

Julian whats your approach with intercepting in multitool?

You change the cursor and then block the mouse?

Changing the cursor and blocking mouse clicks are separate messages that don't affect each other, AFAIK, so I don't think the order in which you do them makes a difference. In the Multi tool, I change the cursor a lot, after the mouse clicks have already been blocked.

[Sexan]

I want to be able to draw area over items and item edges etc. Code is:
1.Track mouse cursors
2.Track mouse position in track
3. CONDITION - Upper half and edge cursor and mouse click?
4.Disable mouse button so we can draw over the item (do not select item,extend the edge, do not do anything to item)

When mouse button is released intercept also needs to be released.

But I'm unable to make this behavoir:
1. It does not block immediatly
2. It blocks on second click
3. It does not releasing the intercept on button release

The script needs to be able to interact with native modifiers

[juliansader]

Try this:
0.Intercept and block clicks
1.Track mouse cursors
2.Track mouse position in track
3.CONDITION - mouse click and NOT (upper half and edge cursor)?
4.Post click to window so that native modifier action is triggered

[Sexan]

In that case how should I trigger release? Since mouse needs to be in normal state 90% of the time to use reaper?

Edit: sorry did not read it right. So this will keep mouse unblocked until we are in codition zone?

[juliansader]

Originally Posted by Sexan

In that case how should I trigger release? Since mouse needs to be in normal state 90% of the time to use reaper?

Are you referring to lifting the mouse button, and the LBUTTONUP message? I don't think that you need to block this message, since extra LBUTTONUP messages don't trigger anything in REAPER, AFAIK. Just intercept with passthrough=true (i.e. just listen to the messages, don't block), and stop the script when it detects an LBUTTONUP.

Originally Posted by Sexan

Edit: sorry did not read it right. So this will keep mouse unblocked until we are in codition zone?

Yes. It manually passes through mouse clicks unless the mouse is in the condition zone.

[juliansader]

It might be easier to initialize Area Select drawing with a keyboard shortcut, though, instead of mouse position.

Similar to how native mouse modifiers are triggered by pressing a mouse modifier and then a mouse click/drag, Area drawing can be triggered by a keyboard shortcut followed by mouse click/drag.

[Sexan]

Edit......

[Sexan]

Got it working!
Not sure why Post works but Send does not...

Anyway you are right it will be much easier if we trigger drawing with shortcut, then I do not need to track cursors etc...

[Dafarkias]

Please pardon my ignorance (and my lack of desire to skim through these 22 pages of thread):

Is there any condensed up-to-date documentation for your extension, JS, possibly even including release/update logs? I know that X-Raym's awesome tool is usually pretty promptly updated, I just didn't know if there was any other location or source that is more current & comprehensive...

[cfillion]

Help > ReaScript documentation is generated on the fly with the extensions you have currently loaded so it is always up-to-date.

You can find every release notes in ReaPack > Browse packages > "js_ReaScript API" > About this package > History.

[Dafarkias]

Originally Posted by cfillion

Help > ReaScript documentation is generated on the fly with the extensions you have currently loaded so it is always up-to-date.

You can find every release notes in ReaPack > Browse packages > "js_ReaScript API" > About this package > History.

Awesome! It never occurred to me to look there!

Thanks again, my friend!

[Edgemeal]

Function 'JS_ReaScriptAPI_Version' is returning '0.996' for the v0.997 x64 dll.

[spk77]

I thought that this was nice, so I post it here

local floor = math.floor

function scroll_to_track(track_id, relative_y_pos, include_envelopes)
  relative_y_pos = relative_y_pos or 0 -- default position is "top"
  local p = "I_WNDH" -- Exclude envelope lane heights
  if not include_envelopes then -- Include envelope lane heights
    p = "I_TCPH"
  end
  -- Ignore hidden tracks
  if not reaper.IsTrackVisible(track_id, true) then
    return false
  end
  local tcp_y = reaper.GetMediaTrackInfo_Value(track_id, "I_TCPY")
  local tcp_h = reaper.GetMediaTrackInfo_Value(track_id, p)
  local arrange_id = reaper.JS_Window_FindChildByID(reaper.GetMainHwnd(), 0x3E8)
  local ok, ar_vsb_position, ar_vsb_page, ar_vsb_min, ar_vsb_max, ar_vsb_trackPos = reaper.JS_Window_GetScrollInfo(arrange_id, "v")
  if ok then
    ok = reaper.JS_Window_SetScrollPos(arrange_id, "v", tcp_y + ar_vsb_position - floor(relative_y_pos*(ar_vsb_page-tcp_h)))
  end
  return ok
end

-- Example: scroll to track #10
local tr = reaper.GetTrack(0, 9) -- Get track 10
if tr then
 -- Desc: scroll_to_track(track_id, relative_y_pos, include_envelopes)
  scroll_to_track(tr)
  --scroll_to_track(tr, 0.5, false)
  --scroll_to_track(tr, 1, false)
  --scroll_to_track(tr, 1, true)
end

[Sexan]

One more question regarding intercept and msg post, it is called defered (30hz)? Because items and movement start laging while LMB is intercepted? On slow movement its kinda ok but on any fast movement items get "stuck" not following mouse cursor as it should.

[Sexan]

There is no way to actually block mouse on demand (rather than block it all the time and pass it to reaper)?

After spending a lot of time with various approaches to mouse intercept its not working as it should (better to say as I've thought it will).

When LMB is intercepted and passthru like:

local WML_intercept = reaper.JS_WindowMessage_Intercept(track_window, "WM_LBUTTONDOWN", false)

function pass_thru()
   local xc, yc = reaper.JS_Window_ScreenToClient(track_window, mouse.x, mouse.y)
   reaper.JS_WindowMessage_Post(track_window, "WM_LBUTTONDOWN", 1, 0, xc, yc)
end

--IN MAIN LOOP
if not AREA and mouse.l_down then
 pass_thru()
end

Script ON (Intercepting LMB)


Script OFF


Which is the right way too do this stuff (as I've understand). Mouse becomes little unresponsive:
1. Movement is not tracked well (I guess because of 30hz defered speed)
2. If you grab the item to move it and your mouse gets over FADE or ITEM EDGE because of issue above, it starts to trigger moving fades and item edges and click stuff around.

Or I'm doing something wrong again?

[cfillion]

The Linux build fails to load here:

swell: dlopen() failed: reaper_js_ReaScriptAPI64.so: undefined symbol: gdk_window_get_effective_toplevel

reaper_js_ReaScriptAPI64.so is not linked against GDK:

$ ldd ~/.config/REAPER/UserPlugins/reaper_js_ReaScriptAPI64.so 
	linux-vdso.so.1 (0x00007ffdcfb54000)
	libstdc++.so.6 => /usr/lib/libstdc++.so.6 (0x00007f6c5cafc000)
	libm.so.6 => /usr/lib/libm.so.6 (0x00007f6c5c9b6000)
	libgcc_s.so.1 => /usr/lib/libgcc_s.so.1 (0x00007f6c5c99c000)
	libpthread.so.0 => /usr/lib/libpthread.so.0 (0x00007f6c5c97a000)
	libc.so.6 => /usr/lib/libc.so.6 (0x00007f6c5c7b3000)
	/usr/lib64/ld-linux-x86-64.so.2 (0x00007f6c5d081000)

[spk77]

Originally Posted by Sexan

There is no way to actually block mouse on demand (rather than block it all the time and pass it to reaper)?

After spending a lot of time with various approaches to mouse intercept its not working as it should (better to say as I've thought it will).

When LMB is intercepted and passthru like:

local WML_intercept = reaper.JS_WindowMessage_Intercept(track_window, "WM_LBUTTONDOWN", false)

function pass_thru()
   local xc, yc = reaper.JS_Window_ScreenToClient(track_window, mouse.x, mouse.y)
   reaper.JS_WindowMessage_Post(track_window, "WM_LBUTTONDOWN", 1, 0, xc, yc)
end

--IN MAIN LOOP
if not AREA and mouse.l_down then
 pass_thru()
end

local WML_intercept = reaper.JS_WindowMessage_Intercept(track_window, "WM_LBUTTONDOWN", false)

function pass_thru()
   local xc, yc = reaper.JS_Window_ScreenToClient(track_window, mouse.x, mouse.y)
   reaper.JS_WindowMessage_Post(track_window, "WM_LBUTTONDOWN", 1, 0, xc, yc)
end

--IN MAIN LOOP
if not AREA and not block and mouse.l_down then
 pass_thru()
end

Maybe you need another flag (block in this example):

1. Set block true when mouse is clicked on AREA.
2. Set block false when LMB is released.

[Sexan]

Originally Posted by spk77

Maybe you need another flag (block in this example):

1. Set block true when mouse is clicked on AREA.
2. Set block false when LMB is released.

I'm doing that with AREA (use it as a flag).

What would be the use of that additional flag in your case ? What would it solve (ff I did not understands something)?

This passes thru the LMB while area is not drawing and its working (to some degree,explained above whats the problem)

[spk77]

Originally Posted by Sexan

I'm doing that with AREA (use it as a flag)

Oh, I thought AREA is some rectangle...then it's weird that it doesn't work properly.

[Sexan]

well it works but it SPAMS LMB down I guess (don't know how to explain it better...), you can see in the GIF above:
I hold LMB and it clicks pretty much everything the mouse is over from item,fade,item buttons,edges etc. And the mouse movement is "lagging" sometimes.
Its just single mouse down,it should be like second gif (which I've expected to be but maybe I'm wrong)

[spk77]

Originally Posted by Sexan

What would be the use of that additional flag in your case ? What would it solve (ff I did not understands something)?)

If AREA would have been a rectangle and lmb click positions would have been stored when clicking on that rectangle, the block flag would have prevented calling pass_thru() until the lmb would have been released.
Then it wouldn't had matter how fast the mouse is moved or which reaper UI-element it's on etc.

[juliansader]

Originally Posted by cfillion

The Linux build fails to load here:

swell: dlopen() failed: reaper_js_ReaScriptAPI64.so: undefined symbol: gdk_window_get_effective_toplevel

reaper_js_ReaScriptAPI64.so is not linked against GDK:

$ ldd ~/.config/REAPER/UserPlugins/reaper_js_ReaScriptAPI64.so 
	linux-vdso.so.1 (0x00007ffdcfb54000)
	libstdc++.so.6 => /usr/lib/libstdc++.so.6 (0x00007f6c5cafc000)
	libm.so.6 => /usr/lib/libm.so.6 (0x00007f6c5c9b6000)
	libgcc_s.so.1 => /usr/lib/libgcc_s.so.1 (0x00007f6c5c99c000)
	libpthread.so.0 => /usr/lib/libpthread.so.0 (0x00007f6c5c97a000)
	libc.so.6 => /usr/lib/libc.so.6 (0x00007f6c5c7b3000)
	/usr/lib64/ld-linux-x86-64.so.2 (0x00007f6c5d081000)

Strangely, the x32 build works fine on my system, even though ldd returns a similarly short list.

Could you please try this new build? I made a small change in the linking command (listing the source cpp before the gdk library) and now the list of dependencies is much longer.

[cfillion]

That one works, thanks!

[juliansader]

Originally Posted by Sexan

Which is the right way too do this stuff (as I've understand). Mouse becomes little unresponsive:
1. Movement is not tracked well (I guess because of 30hz defered speed)
2. If you grab the item to move it and your mouse gets over FADE or ITEM EDGE because of issue above, it starts to trigger moving fades and item edges and click stuff around.

It might work better -- and feel more accurate for the user -- if you pass the original data of each message through unaltered, instead of updating the mouse position:

reaper.JS_WindowMessage_Intercept(w, "WM_LBUTTONDOWN", false)
...
pOK, pass, time, wLow, wHigh, lLow, lHigh = reaper.JS_WindowMessage_Peek(w, "WM_LBUTTONDOWN")
...
reaper.JS_WindowMessage_Post(w, "WM_LBUTTONDOWN", wLow, wHigh, lLow, lHigh)

[Sexan]

like this?

local WML_intercept = reaper.JS_WindowMessage_Intercept(track_window, "WM_LBUTTONDOWN", false)

function pass_thru()
   pOK, pass, time, wLow, wHigh, lLow, lHigh = reaper.JS_WindowMessage_Peek(track_window, "WM_LBUTTONDOWN")
   reaper.JS_WindowMessage_Post(track_window, "WM_LBUTTONDOWN", wLow, wHigh, lLow, lHigh)
end

function Main()
if not mouse.Ctrl() and not mouse.Shift() and mouse.l_down then
            pass_thru()
         end
end

Not working exactly (maybe my bad?)

[juliansader]

It is also crucial to check the timestamp of the message, which will tell you if the message is new, so that you pass each message through only once:

local WML_intercept = reaper.JS_WindowMessage_Intercept(track_window, "WM_LBUTTONDOWN", false)
prevTime = 0 -- or script start time

function pass_thru()
    pOK, pass, time, wLow, wHigh, lLow, lHigh = reaper.JS_WindowMessage_Peek(track_window, "WM_LBUTTONDOWN")
    if pOK and time > prevTime then
        prevTime = time       
        reaper.JS_WindowMessage_Post(track_window, "WM_LBUTTONDOWN", wLow, wHigh, lLow, lHigh)
    end
end

function Main()
if not mouse.Ctrl() and not mouse.Shift() and mouse.l_down then
            pass_thru()
         end
end

[Sexan]

You are a very magical person!