Send MIDI after mouse up

[bijlevel]

I want to send MIDI (a value change of a parameter) after a mouse up event on a slider, because a drag mouse event, which sounds the way to go, generates too many MIDI events. The device can keep up (so far) with these events, but it takes too long to finish and I only need the last send MIDI message. When I look at the generic slider component mouse properties it seems that a mouse up event is not supported:

but I did a what() call for a slider and this was the result for specific mouse related functions for a slider:

mouseExit: function
mouseMove: function
mouseDown: function
mouseEnter: function
isMouseOver: function
removeMouseListener: function
isMouseButtonDown: function
mouseDrag: function
getInterceptsMouseClicks: function
getMouseXYRelative: function
mouseUp: function

This is for version 5.6.23, which I use at the moment. So it seems that one can detect a mouseUp event on a slider. Even if this is not true, than it might be possible to use "getMouseXYRelative" to know where a mouse pointer is and act accordingly.

Sorry for this elaborate post, but I hope you wizzards can confirm these mouse related functions do indeed exists for a slider, so I don't waist a lot of time trying to write a method that detects for instance a mouseUp event on a slider.

(I know about other rather complicated methods to achieve the same results.)

[damiensellier]

Slider just have mouse over (triggering a load of messages every 5ms), click and double click.
You would either need a timer to send just the last value stored of the component via LUA or use a uICustomComponent.
The right event would be onMouseExit which is in the Misc>uICustomComponent
You would need to put a uICustomComponent placed behind your slider and once you leave its area it sends the slider value or trigger its LUA script.
You can take a look at this post for more info :

#361
And here : #566

Let us know if this is a solution for you
Damien

[bijlevel]

Yes I know about the CustomComponent properties, and I also did study those posts you mention, but what I tried to communicate with my post about my findings of the various mouse functions for a slider, is that it seems a slider does have a mouseUp function (and several more). I did use the "what()" method (as recommended by Atom) to find ALL the available functions for a slider and just selected, from that long list, the specific mouse functions. Or am I total wrong in my thinkings?

[damiensellier]

Oh okay, I did not get it, sorry for that. Sometimes components are bound to functions but the related parameters are not implemented in the GUI. A dropdown for mouseUp would be required here.

I'm going to check in the source code if it's available right now.

Edit :

ctrlr/Source/UIComponents/CtrlrComponents/Sliders/CtrlrSlider.cpp

Line 90 in 8aa00d8

void CtrlrSlider::mouseUp (const MouseEvent& e)

ctrlr/Source/UIComponents/CtrlrComponents/Sliders/CtrlrFixedImageSlider.cpp

Line 98 in 8aa00d8

void CtrlrFixedImageSlider::mouseUp (const MouseEvent& e)

[bijlevel]

It seems that the mouseUp event is (only) used for the Slider spring operation?

[bijlevel]

If this is true (mouseUp for Slider spring) could we use this in a creative way? Just brainstorming: the slider spring needs a value to return to a given value (see CTRLR interface). So if we could dynamically change this value to the value of the slider at the moment we let go of the slider and then send this value to the MIDI-device after the mouseUp "spring"event?

[dnaldoog]

That’s interesting- we should look at that. :)

[dnaldoog]

I tried to find a way to access mouseUp but to no avail.

I found a way to do it with timers - it seems to work well.
There's possibly a better way to do this, but it does work.

At 800ms delay if you go from 0-127 I think it sends out only one interim MIDI message before landing on and sending 127.

If you increase the delay, there is no interim value sent, but it feels slow, so I suggest playing around with that variable local timerDelay = 800.

--
-- Called when a modulator value changes
-- @mod   http://ctrlr.org/api/class_ctrlr_modulator.html
-- @value    new numeric value of the modulator
--
emulateMouseUp = function(--[[ CtrlrModulator --]] mod --[[ number --]], value --[[ number --]], source)
    globvalue = value -- picked up in Timer Callback
    sysexnumber = tonumber(mod:getProperty("modulatorCustomIndex")) or 0 -- keep global
    local timerDelay = 800 -- experiment with this value
    if not timer:isTimerRunning(5) then
        timer:setCallback(6, TimerCallback) -- sends the MIDI
        timer:startTimer(6, timerDelay) -- Timer Id n ms
        timer:setCallback(5, TimerCallback) -- blocks timer 6 until cleared
        timer:startTimer(5, timerDelay) -- Timer Id n ms
    end
end

TimerCallback = function(timerId)
    if timerId == 5 then
   -- actually nothing to do here
    elseif timerId == 6 then
	local message={240, 0, sysexnumber, globvalue, 247}
        panel:sendMidiMessageNow(CtrlrMidiMessage(message))
        panel:getLabelComponent("debug"):setText(MemoryBlock(message):toHexString(1):upper())
        timer:stopTimer(5)
        timer:stopTimer(timerId)
    end
end -- f

---

Delay Sysex Send uiSlider_1_0.zip

[bijlevel]

John, thanks a lot! This was exactly the reason of my initial post, find out if indeed mouseUp is available for a slider. From the post of Damien I think, by looking at the code, that CTRLR is (only?) using a mouseUp event to accomplish the Slider spring mode/value operation. Am I right? Anyway I will now use the timer code provided by John. Thanks again!

BTW maybe I will one of these days dive in the CTRLR source code to try and add a mouseUp event to the program. I will do this as an example of trying to add features to CTRLR. If I succeed (personally I think with a low rate of actual success ;-)) we can start a feature request.

[dnaldoog]

That’s great that it is working for you.

I wonder if there isn’t some way of doing it?

I tried all sorts of strange incantations that looked wrong and were.

the addMouseListener method looks promising.

@Tedjuh has a knack of sussing these things out.

Found this post but was unresolved.

[bijlevel]

I still have to implementyour code, but I'm confident it will work!

It seems that this mouseUp "issue" pops up regularly, even 8 years ago! In the meantime a few mouse events have been added to the CTRLR interface, but not the mouseUp event. Given the fact we're dealing a lot with old MIDI-devices which are rather slow in processing MIDI-events, a mouseUp detection would be very welcome!

[dnaldoog]

I’m going to keep mucking around with the code and see if I can find anything - You are exactly right about old devices needing slow transfer rates. :)

[Ted-juh]

Wha? Who me?

Oh, where to start? Most of what is said above is true. It comes down to the fact that you don't have an option to attach a mouseUp to the Slider you want. A while back I had some success calling the properties of a slider by adding it to the function statements as in "mouseUp = function(comp, event, slider)". The last "slider" could have been uiSlider, CtrlrSlider, or getOwnedSlider or just slider. I can't remember exactly. And I can't seem to find the panel between my 1000 test panels.

The addMouseListener might work but I think it is used to differentiate the mouseclick whether it was on the slider or the label part of the component, not to add a mouseUp. Although the mouselistener detects any mouseclick.

-- Sorry, The following statement is "not" true
As far as I know, the drag method ends with a mouseUp. Think about it, how else would it detect that the "drag" ended? I might take a look into that.

In the meantime. Would it work for you, Bijlevel, if you could use a left or a right click on the slider? The left click is to set the correct value, right click to send the value to the synth?

[bijlevel]

Yes, I made one a few years ago for Mac and Windows! Windows was rather complicated, but I succeeded! Look here:https://www.godlike.com.au/index.php?id=361 and here: https://www.godlike.com.au/fileadmin/godlike/techtools/ctrlr/guides/Compiling_Ctrlr_for_Windows_10_v2.1.pdf. So not for Windows 11, but maybe you manage...

[damiensellier]

Hi @bijlevel got an email notification asking about the code source references I posted previously, it's here : #585 (reply in thread)

This can also be implemented in the ImageSlider, CtrlrFixedSlider and CtrlrFixedImageSlider as well :

Slider :

ctrlr/Source/UIComponents/CtrlrComponents/Sliders/CtrlrSlider.cpp

Line 90 in 8aa00d8

void CtrlrSlider::mouseUp (const MouseEvent& e)

ImageSlider :

ctrlr/Source/UIComponents/CtrlrComponents/Sliders/CtrlrImageSlider.cpp

Line 106 in 8aa00d8

void CtrlrImageSlider::mouseUp (const MouseEvent& e)

CtrlrFixedSlider :

ctrlr/Source/UIComponents/CtrlrComponents/Sliders/CtrlrFixedSlider.cpp

Line 89 in 8aa00d8

void CtrlrFixedSlider::mouseUp (const MouseEvent& e)

CtrlrFixedImageSlider :

ctrlr/Source/UIComponents/CtrlrComponents/Sliders/CtrlrFixedImageSlider.cpp

Line 98 in 8aa00d8

void CtrlrFixedImageSlider::mouseUp (const MouseEvent& e)

Good luck!

(EDIT: links were pointing to my own ctrlr fork, now fixed)

[Ted-juh]

I could be wrong but aren't the mouse options in the component class? Or are those "virtual void" lines to move the component itself with those mouse options? Could only find a mouseUp in ctrlrSlider but that's the one that controls the springback.

See line 93/94/95 in ctrlrComponent.h. which should mean the code from the custom component should be added to ctrlrComponent.cpp. Or copy one of the callbacks for mousedown etc.

So, in other words,.does the slider inherit from the component?

[bijlevel]

I have no idea yet how everything is coded. I think it is just trial and error for me. Luckily I managed to build CTRLR on my new Mac Studio, which means things compile much faster, so experimenting is not so time consuming anymore.

[bijlevel]

@damiensellier Thanks!

[dnaldoog]

Actually, this was discussed here previously:

• m.tarenskeen’s PSS-480/-580 panel - update on mouse release? #411

In that post I came up with a solution where there is a uiComponent sitting in a layer below the uiSlider so when the mouse is moved off the uiSlider a midi send is triggered by a repaint of the uiComponent. It's not ideal but also works well!

[bijlevel]

@dnaldoog Yes, I did read/study all those related posts. Again, if implementing a mouseUp in CTRLR does fail, I will use one of those ways to "emulate" a mouseUp in my panel. We did it ( minimise the MIDI data stream) even in our Kurzweil panel, well actually Jason (aka The Puppeteer) did. I never really understood the workings of his code...

[damiensellier]

Hi,
I took a look at the core and everything is happening from the CtrlrComponent.cpp and CtrlrCOmponent.h files .
I explained the modification to add the mouseUp event callback Properties for the different generic components in the following post :
#565 (reply in thread)

[Ted-juh]

Damien, thank you for your (tremendous) effort. Some of them will be very convenient. The longer I think about it, the more user-case scenarios come to mind.

The key press is "sort of" already in Ctrlr as the uiSliderVelocityModeKeyTrigger. But I might try to add that one myself because I just can :)

On another note, the reason Bijlevel started the topic, was already possible in Juce by adding "setNotificationOnlyOnRelease(bool)" to the Slider. So, long story short, I added it to Ctrlr with a nifty tickbox and can confirm it is working the way it should.

[bijlevel]

Looks like you found a short cut to our "problem" ;-). How does one actually add in Jucer this "setNotificationOnlyOnRelease(bool)"?

[bijlevel]

If I read your post better ;-), it is possible in Jucer, but one has to add the actual code in the source of CTRLR. I'm I right?

[Ted-juh]

Sorry, that was a typo. I just meant "Juce". As in: It was already an option in the Slider Class.

I'm going over more missing methods.. but it takes a lot of searching/ comparing in the ctrlr properties.

I'll post the steps necessary later today. Some obligations prevent me from being in front of a pc in the next few hours.

[bijlevel]

@damiensellier I did add/replace the 9 files you have listed above. It turns out that in all the 'slider.h' files you still need to declare the mouseEnter and mousExit, like this:

void mouseEnter (const MouseEvent& e);
void mouseExit (const MouseEvent& e);

Once I added this, the build succeeded. I hope you understand what I mean ;-).

For my (personal ;-)) copy I did also change myself the version to 5.6.24 and in English, because I'm not sure if you did that already in your CTRLRX fork.

[Ted-juh]

Ok, the steps to take:

Open the Ctrlr.jucer file in the Projucer. Then open your IDE.

In CtrlrIDs.h :
(Try to maintain the same order for declaring ID's as where you want to place them in the menu structure. Or in a logic order where all the ID's are for the Slider.)
DECLARE_ID (uiSliderSetNotificationOnlyOnRelease);

In CtrlrIDs.xml :
<id name="uiSliderSetNotificationOnlyOnRelease" text="Send Value only on release" type="Bool"/>

In CtrlrSlider.cpp :
(The setProperty list starts at line 26, see my remark as with declaring ID's, but this time the order defines where it resides in the menu.)
setProperty (Ids::uiSliderSetNotificationOnlyOnRelease, false);

In CtrlrSlider.cpp:

else if (property == Ids::uiSliderSetNotificationOnlyOnRelease)
{
	ctrlrSlider.setChangeNotificationOnlyOnRelease((bool)getProperty(Ids::uiSliderSetNotificationOnlyOnRelease));
}

This was only possible because:
.def("setChangeNotificationOnlyOnRelease", &Slider::setChangeNotificationOnlyOnRelease)
was already present in LComponents.cpp. Which is. I think, what attaches it to the Juce Slider Class.

Now save it all in your IDE, close the IDE and save the project in the Projucer. I noticed I had to close the Projucer and reopen it, open the IDE again to do a rebuild/ build of the Ctrlr_Sharedcode and a rebuild/ build of the Ctrlr_StandalonePlugin for it to show up properly.

How to compile this with CMAKE? Because the Projucer way is getting kind of tedious.

[bijlevel]

Thanks Ted-juh, seems doable! I don't know about CMAKE (yet), sorry.

[damiensellier]

It turns out that in all the 'slider.h' files you still need to declare the mouseEnter and mousExit, like this:

void mouseEnter (const MouseEvent& e); void mouseExit (const MouseEvent& e);

Yes you are right, I forgot them in the list I'll edit my post to add them. Xcode will give warnings anyway if it's forgotten.

As a side note, there's no need to add the mouse events in both the sliders/button individual .cpp, it should work only with the extra function in CtrlrComponent.cpp

I recommand adding this NotificationOnlyOnRelease in the Component Generic part of CtrlrComponent.cpp so that you don't have to add it in every slider type, buttons etc

When I added the functions in the different sliders .cpp (CtrlrFixedImageSlider.cpp, CtrlrFixedSlider.cpp etc) it was because there was already an override applied for the "slider spring" function, so it was required in this particular case to update it there too. But it's not required if the individual component don't already have a specific mouse event in their own .cpp

[Ted-juh]

I recommend adding this NotificationOnlyOnRelease in the Component Generic part of CtrlrComponent.cpp so that you don't have to add it in every slider type, buttons etc

I suggest leaving it in the Slider Class. It's not inherited from the Component Class, whereas the mouse options are. It's a public type from the Slider Class which isn't available for Buttons, Labels, etc, and for a good reason, because they don't make use of that feature. It's the reason why, for instance, double-click is in the component section and the spring mode. I think the setNotificationOnlyOnRelease fits perfectly in that section. Although it means a little bit more code, I get that.

[damiensellier]

@Ted-juh It makes sense, i didn't think about that.
Then I'll put it in all the sliders.
have a nice evening
Damien

[damiensellier]

@Ted-juh I added setChangeNotificationOnlyOnRelease for all types of sliders.
It's working great! Thanks for your help.

The branch on my fork is there if it can help : https://github.com/damiensellier/CtrlrX/tree/setChangeNotificationOnlyOnRelease-added-to-sliders

[damiensellier]

In CtrlrIDs.xml :
<id name="uiSliderSetNotificationOnlyOnRelease" text="Send Value only on release" type="Bool" defaults="enabled/Disabled"/>

[dnaldoog]

For CtrlrX 5.6.34/35 it is now trivial to send MIDI on mouseUp to avoid sending sysex on every value change.

In onMouseUp

function sendMessageOnMouseUp(comp,event)
local value=comp:getOwner():getModulatorValue()
panel:sendMidiMessageNow(CtrlrMidiMessage(string.format("F0 00 00 %.2x F7",value)))
end

And include this function in onDoubleClick if you want to send MIDI when resetting modulator to default value.

---

Demo - panel