Support for using jack midi input #2038

sambler · 2015-05-09T18:40:23Z

While lmms has jack audio support there is currently no support for jack midi connections. On FreeBSD jack midi is the only solution I have found that supports usb midi input. This patch adds jack midi input support.

I originally made these adjustments against 0.4.x and have seen no issues with my low usage, a while back I made a small adjustment to update it for 1.0 release and have now merged against master and run a short test.

Further work - jack midi output is incomplete, an output port is created but no data is sent. I made an attempt to enable multiple input ports but couldn't get it to work. This may be desirable to allow multiple devices to be connected simultaneously as I believe other midi inputs allow. While jack allows multiple devices to be connected to one input, clearly separating them within lmms would be better.

Umcaruje · 2015-05-09T20:31:40Z

include/MidiJack.h

+ *
+ * by Shane Ambler
+ *
+ * This file is part of Linux MultiMedia Studio - http://lmms.sourceforge.net


I think this should be edited to match all our other file descriptions. Example here.

grejppi · 2015-06-13T11:44:13Z

Hi. Thanks for your contribution.

The audio output of LMMS depends on input to the instruments, therefore also any incoming MIDI signals. The order in which JACK clients are run depends on the connections between clients. However, In this design the MIDI and audio clients are separate, and the only connection between them is internal to LMMS, thus invisible to JACK.

There is also no way (that I know of) to set any kind of priority to JACK clients in the same process. Depending on how JACK manages to build the processing order there will be latency of 1-2 periods.

Ideally both the audio and MIDI processing should share the same client. For example, patching MIDI support behaviour into the audio driver, but passing the MIDI data to the MIDI driver, or something like that.

sambler · 2015-07-04T14:43:05Z

I came up with a way to use an existing AudioJack connection.

If jack is not used for audio then midiJack still manages it's own connection, this works better than always creating an AudioJack object to manage the connection as the mixer still sees the jack audio connection and tries to use it, this seemed less work than adjusting the mixer/audioJack relationship.

Umcaruje · 2015-08-03T19:48:51Z

@sambler it seems that your build is failing with Qt5: travis/jobs/69544663

Could you look into that?

grejppi · 2015-08-03T20:10:53Z

src/core/Mixer.cpp

+#ifdef LMMS_HAVE_JACK
+	if( client_name == MidiJack::name() || client_name == "" )
+	{
+		MidiJack * moss = new MidiJack;


This is nitpicking, but moss -> mjack because this is not the OSS midi client.

On the other hand, maybe the code for testing all the different backends should just use a generic name for these temporary variables anyway.

Might be nitpicking but better to be consistent with rest of the code.

8tab · 2015-08-04T16:00:52Z

src/core/midi/MidiJack.cpp

+	if( isRunning() )
+	{
+		m_quit = true;
+		wait( 1000 );


why do you need this wait?

That is in the destructor, set m_quit to true, wait a little for thread to stop then terminate, that code was copied from MidiOss.cpp and is also used in MidiAlsaRaw.cpp

Wallacoloo · 2015-09-13T22:53:11Z

Build is passing in Qt5 now. Anything in particular that is holding up this PR?

tresf · 2015-09-18T03:00:53Z

Build is passing in Qt5 now. Anything in particular that is holding up this PR?

Not that I'm aware of although the commits should be squashed down first.

Umcaruje · 2016-01-13T21:57:55Z

@sambler could you please squash the commits so this can be merged?

grejppi · 2016-01-14T03:39:56Z

@sambler I'm curious, why are the port names midi_TX and midi_RX?

sambler · 2016-01-15T02:06:20Z

That would be transmit and receive - I think I picked them as hydrogen uses TX/RX

previous changes updated to compile on master compiles but not tested

to match changes in 697aebc

sambler · 2016-01-15T05:46:45Z

Rebased against master and added changes to match config widget changes in 697aebc

opyate · 2016-01-16T15:56:37Z

Nice one, @sambler - can't wait to see this merged.

Umcaruje · 2016-03-01T11:37:18Z

@grejppi how does this PR look? Could this be merged?

* master: (90 commits) Grey out muted patterns in the BB editor Crash at clearing path in settings manager Clear buffer of dummy instruments. Should fix LMMS#2682 Get rid of another copy constructor call to prevent Qt5 crashes Enables style sheets for knob line colors for all knob types Kicker 'version' 0 on first save Add C++11 compile flag to the carla plugin as well Elide channel names to prevent text overflow in FxLine Replace every use of the foreach macro with a C++11 range-based for loop Compile several plugins with -std=c++0x to support range-based for loops Make lb302 include math.h so we can switch it to C++11 File browser, factory files off by one Fix regression caused by fcec8dd Fix BBtrack updating; Fix the Pattern tooltip Rewrote ProjectVersionTest.cpp to use QVERIFY and indeed fail when it's supposed to fail, and added 2 tests in this test suite. data/locale: zh_CN.ts not zh.ts White-space formatting Add gig player to win32 builds Update Chinese translations Fix locale generation for win32 builds Closes LMMS#2577 ...

…rt has been dropped.

simonvanderveldt · 2016-09-18T18:17:14Z

Is there still something that needs to be done before this can be merged?
Really looking forward to making direct use of Jack midi instead of running something like a2j.

Umcaruje · 2016-09-18T19:10:54Z

Is there still something that needs to be done before this can be merged?

I don't know, as I am not competent enough to review the code. I do think this is an excellent addition to LMMS, and should be accepted.

@LMMS/developers please can someone look at this?

Umcaruje · 2016-09-18T19:11:21Z

Also @sambler the merge conflicts need to be resolved

* master: (213 commits) Update Pattern and AutomationPattern length (LMMS#3037) Refresh i18n strings Hint text update Drop notes with length zero (LMMS#3031) Background tweak Background Update Flanger Exclude .ts files from the Github linguist Redesign Multitap echo (LMMS#3008) Update i18n source strings Extended arpeggiator functions (LMMS#2130) Fix sample track playback in BB tracks (LMMS#3023) Sort plug-in embedded resources (LMMS#3014) Implement version major.minor.release-stage.build (LMMS#3011) Fix regressions on loading broken projects (LMMS#3013) Improved file input validation. (LMMS#2523) Fix sample track view in BB editor (LMMS#3002) Request change in model when dropping a track (LMMS#3000) Add LocklessAllocator and use it in LocklessList (LMMS#2998) Drop forceStep in AutomatableModel (LMMS#3010) ...

sambler · 2016-09-19T04:01:02Z

rebased with master

simonvanderveldt · 2016-09-19T08:05:06Z

@sambler Thanks for rebasing. I'm not that good with C(++) so can't thoroughly review the code, but wouldn't it make sense to have a Jackclient interface which the JackAudio and JackMidi implement? Or a singleton?

Also, what I can do is build and run these changes to give feedback on if/how well it works.
Just to make sure I'm validating the correct things:

A single jack midi in should work
No multiple Jack midi in
No Jack midi out

simonvanderveldt · 2016-09-19T20:31:58Z

Allright, I just built this and tried it out and the MIDI in works perfect! (at least for the +-5 minutes of midi torture I sent through it ;)). Thanks @sambler!

The setup I'm using:

Jack with Alsa raw MIDI as MIDI driver, this takes/converts all Alsa MIDI hardware to a Jack MIDI device
LMMS built from @sambler's jackmidi branch
USB MIDI device for input

I tried to push as many MIDI messages through it and it kept working perfectly. Tried it with a Kicker, Sample, TripleOscillator and ZynAddSubFX.
The velocity is correctly passed as well.
Also tried MIDI cc messages to control a TripleOscillator knob and that worked as well.

Is there any way to get debug message about if there are warnings or errors like buffer overflows or something? I'm not seeing anything in the console, but I don't know if that's because it's working 100% or if I simply have no output of these kinds of messages.

The only minor niggle might be the name of the MIDI ports as presented to JACK:

I've included some other apps + a ladish room for reference. As you can see there are already a lot of different naming schemes :P So I'd like to suggest to adopt one of the existing options :)

sambler · 2016-09-20T07:38:24Z

The jack connection is made in the JackAudio class and used by JackMidi. This could be separated but I'm not sure it would be any benefit as it is only used in two places and the code in those places isn't very big, you would be adding more lines of code to define the new class than is used to make the connection.

There is only one jack midi port open. At first I tried to open multiple ports but at the time I couldn't figure out how to get it working. Jack allows multiple devices to be connected to the one port, so doesn't prevent connecting any number of midi devices. If we could get multiple ports working, I expect that it would allow more complex setups with more than one device using the same midi channel but "wired" into different instruments.

Either jack midi out doesn't work or I didn't set it up right, I was hoping someone would know how to get that working, if no-one knows how to do that then opening the midi out port should be disabled until it is working.

With naming, I only picked rx/tx as hydrogen uses that, I guess LMMS uses in/out for the audio port names so copying that would give some consistency.

simonvanderveldt · 2016-09-20T07:55:03Z

The jack connection is made in the JackAudio class and used by JackMidi. This could be separated but I'm not sure it would be any benefit as it is only used in two places and the code in those places isn't very big, you would be adding more lines of code to define the new class than is used to make the connection.

Makes sense, was just a question without much background knowledge :)

There is only one jack midi port open. At first I tried to open multiple ports but at the time I couldn't figure out how to get it working. Jack allows multiple devices to be connected to the one port, so doesn't prevent connecting any number of midi devices. If we could get multiple ports working, I expect that it would allow more complex setups with more than one device using the same midi channel but "wired" into different instruments.

Having 1 JACK MIDI in port is already infinitely better than having none ;) and should serve the majority of use cases, so I'd suggest to just merge this and only if there are actually people who want/need/use multiple JACK MIDI ports try to fix it in a new change/PR.

Either jack midi out doesn't work or I didn't set it up right, I was hoping someone would know how to get that working, if no-one knows how to do that then opening the midi out port should be disabled until it is working.

👍

With naming, I only picked rx/tx as hydrogen uses that, I guess LMMS uses in/out for the audio port names so copying that would give some consistency.

MIDI in and MIDI out makes sense 👍

* master: Remove remnant WANT_SYSTEM_SR (LMMS#3050) Add Persian and Phrygian dominant scales (LMMS#3045) change automation editor window title on rename automation pattern piano roll title changed on pattern renaming minor changes/code conventions no reason for patternRenamed() is public rename Piano Roll window title on Instrument Track rename/remove adjust window title on rename lfo controller Window title will be changed on rename track, now

Disable jack midi out port until it is functional Add comments about midi out not implemented

zonkmachine · 2016-09-27T13:52:15Z

With naming, I only picked rx/tx as hydrogen uses that...

Rx/Tx labels are industry standards for receiving/transmitting lines and it goes way back, probably 60's, and is also used in the MIDI specifications but isn't very descriptive. Midi in/out is better.

simonvanderveldt · 2016-09-27T20:53:21Z

I've been running this branch for the last 8 days and never had a problem with the MIDI in, so from a functional perspective this PR is working fine (on my machine).

liushuyu · 2016-11-08T05:52:59Z

Seems like this PR go idle?

zonkmachine · 2016-11-08T10:36:21Z

@LMMS/developers Bump! Can someone, competent, please review this. It's been tested and updated on multiple occasions. I vote merge within 48 hours if no one says no...

tresf · 2016-11-08T14:07:20Z

There's a lot of very minor formatting inconsistencies...

For example:

if( m_jackAudio == NULL && m_jackClient == NULL)
+  ^--- space
-                                              ^--- no space

From a code quality perspective, perhaps @jasp00 has some time to chime in or @rageboge (since he recently wrote some Midi support for Apple).

I vote merge within 48 hours if no one says no...

That's fine too. :)

michaelgregorius · 2016-11-08T18:07:48Z

I have given the branch a short test run and the Jack MIDI is working fine on my machine.

zonkmachine · 2016-11-09T23:09:11Z

@sambler Thanks for the PR and your patience! 🐳

* Support jack midi input * If jack is used for audio then use the same connection for midi as well * Remove old FreeBSD adjustment for portaudio as multiple version support has been dropped. * Disable jack midi out port until it is functional

Umcaruje reviewed May 9, 2015
View reviewed changes

sambler force-pushed the jackmidi branch 3 times, most recently from 249032b to 9916fa5 Compare July 4, 2015 14:39

grejppi reviewed Aug 3, 2015
View reviewed changes

sambler force-pushed the jackmidi branch from 9916fa5 to 8aa7573 Compare August 4, 2015 05:42

8tab reviewed Aug 4, 2015
View reviewed changes

tresf force-pushed the master branch 2 times, most recently from 8c45c1f to 4da73f3 Compare September 15, 2015 18:32

sambler added 8 commits January 15, 2016 12:42

Initial commit jack midi input

ca14fb4

previous changes updated to compile on master compiles but not tested

Fix file header to match standard lmms header

9db839b

add a way to share a jack connection for audio and midi

865bc06

If jack is used for audio then use the same connection for midi as well

39877ee

cleanup remove initJackClient call from addMidiClient

e1a8ee1

rename temp variable used

01af994

Remove dir names from qt includes to fix qt5 build

2d79a36

adjust for config widget changes

cc6bf64

to match changes in 697aebc

sambler force-pushed the jackmidi branch from 8aa7573 to cc6bf64 Compare January 15, 2016 05:35

remove includes that were temporary commmented out

76507ef

sambler added 2 commits March 25, 2016 23:21

Remove old FreeBSD adjustment for portaudio as multiple version suppo…

e58c08f

…rt has been dropped.

simonvanderveldt mentioned this pull request Sep 19, 2016

Better JACK support #1467

Open

13 tasks

simonvanderveldt mentioned this pull request Sep 22, 2016

JACK MIDI UI/UX issues amsynth/amsynth#40

Closed

sambler added 2 commits September 27, 2016 15:35

Rename midi ports to MIDI IN MIDI out

71fea8c

Disable jack midi out port until it is functional Add comments about midi out not implemented

zonkmachine merged commit 05ace7e into LMMS:master Nov 9, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support for using jack midi input #2038

Support for using jack midi input #2038

sambler commented May 9, 2015

Umcaruje May 9, 2015

grejppi commented Jun 13, 2015

sambler commented Jul 4, 2015

Umcaruje commented Aug 3, 2015

grejppi Aug 3, 2015

sambler Aug 4, 2015

8tab Aug 4, 2015

sambler Aug 5, 2015

Wallacoloo commented Sep 13, 2015

tresf commented Sep 18, 2015

Umcaruje commented Jan 13, 2016

grejppi commented Jan 14, 2016

sambler commented Jan 15, 2016

sambler commented Jan 15, 2016

opyate commented Jan 16, 2016

Umcaruje commented Mar 1, 2016

simonvanderveldt commented Sep 18, 2016

Umcaruje commented Sep 18, 2016

Umcaruje commented Sep 18, 2016

sambler commented Sep 19, 2016

simonvanderveldt commented Sep 19, 2016 •

edited

Loading

simonvanderveldt commented Sep 19, 2016 •

edited

Loading

sambler commented Sep 20, 2016

simonvanderveldt commented Sep 20, 2016

zonkmachine commented Sep 27, 2016

simonvanderveldt commented Sep 27, 2016

liushuyu commented Nov 8, 2016

zonkmachine commented Nov 8, 2016

tresf commented Nov 8, 2016

michaelgregorius commented Nov 8, 2016

zonkmachine commented Nov 9, 2016

Support for using jack midi input #2038

Support for using jack midi input #2038

Conversation

sambler commented May 9, 2015

Umcaruje May 9, 2015

Choose a reason for hiding this comment

grejppi commented Jun 13, 2015

sambler commented Jul 4, 2015

Umcaruje commented Aug 3, 2015

grejppi Aug 3, 2015

Choose a reason for hiding this comment

sambler Aug 4, 2015

Choose a reason for hiding this comment

8tab Aug 4, 2015

Choose a reason for hiding this comment

sambler Aug 5, 2015

Choose a reason for hiding this comment

Wallacoloo commented Sep 13, 2015

tresf commented Sep 18, 2015

Umcaruje commented Jan 13, 2016

grejppi commented Jan 14, 2016

sambler commented Jan 15, 2016

sambler commented Jan 15, 2016

opyate commented Jan 16, 2016

Umcaruje commented Mar 1, 2016

simonvanderveldt commented Sep 18, 2016

Umcaruje commented Sep 18, 2016

Umcaruje commented Sep 18, 2016

sambler commented Sep 19, 2016

simonvanderveldt commented Sep 19, 2016 • edited Loading

simonvanderveldt commented Sep 19, 2016 • edited Loading

sambler commented Sep 20, 2016

simonvanderveldt commented Sep 20, 2016

zonkmachine commented Sep 27, 2016

simonvanderveldt commented Sep 27, 2016

liushuyu commented Nov 8, 2016

zonkmachine commented Nov 8, 2016

tresf commented Nov 8, 2016

michaelgregorius commented Nov 8, 2016

zonkmachine commented Nov 9, 2016

simonvanderveldt commented Sep 19, 2016 •

edited

Loading

simonvanderveldt commented Sep 19, 2016 •

edited

Loading