Add Mud Sound Protocol (MSP) Support #3132

mpconley · 2019-09-29T04:45:06Z

Brief overview of PR changes/additions

Please see the wiki for the best description of what is delivered:

Mud Sound Protocol (MSP) support leveraging QMediaPlayer and QMediaPlayerList for MSP for Lua, MSP via GMCP (Client.Media) and across TELOPT 90.

This MSP implementation is nearly identical to the specification found at the ZMud site.

Mudlet will parse the triggers, download a corresponding sound, store it in the profile for the game in a media folder and categorized subfolders, then play it. This has the capability to use wildcards/randomize, repeat sounds, and continue music as mentioned in the specification.

Motivation for adding to Mudlet

I am rewriting the world for StickMUD and plan to enhance the experience with more sound, such as changing music files per area / terrain / map as an example.

In a similar way that servers could push UIs and maps, this PR will push sounds and let the server guide how those sounds are orchestrated.

Other info (issues closed, discussion etc)

I did not touch stopSounds() or playSound() from mudlet.cpp. Nothing will change for anyone using sound triggers today.
There are two new toggles in the Settings page to enable/disable Client.Media and MSP.
I chose to store the sounds in a folder call media.

Please test Client.Media (GMCP) and MSP by logging into StickMUD at telnet://stickmud.com:7680 with a new character, going east, 2 up and trying out this test plan:

pull lever A with gmcp
pull lever B with gmcp
... through ...
pull lever O with gmcp

delete your media folder under the StickMUD profile

pull lever A with lua
pull lever B with lua
... through ...
pull lever O with lua

delete your media folder under the StickMUD profile

pull lever A with telopt
pull lever B with telopt
... through ...
pull lever O with telopt

add-deployment-links · 2019-09-29T04:45:11Z

Hey there! Thanks for helping Mudlet improve. 🌟

Test versions

You can directly test the changes here:

No need to install anything - just unzip and run.
Let us know if it works well, and if it doesn't, please give details.

demonnic · 2019-09-29T13:50:26Z

I like the sound of this.
Ok, now the pun's out of the way, do you have an easy way to test the functionality?

mpconley · 2019-09-29T14:21:35Z

Coming soon! I will make something nice and simple to test and present the various scenarios.

src/Host.cpp

src/XMLimport.cpp

src/ctelnet.cpp

src/dlgProfilePreferences.cpp

src/mudlet.cpp

mpconley · 2019-10-09T01:23:30Z

I created some tests and have a couple things to resolve.

vadi2 · 2019-10-09T04:21:07Z

Where at?

mpconley · 2019-10-19T13:38:19Z

This pull request is ready for review after reading the specification here: https://www.zuggsoft.com/zmud/msp.htm. Use the PR version of Mudlet, login to StickMUD, create a character, move two rooms to escape the newbie area, then go up into the tree. Use "pull lever A", "pull lever B" through "pull lever I" to do the testing. The only trouble this is having on Mac at least is that the first time the sound is downloaded it makes no sound, until you pull the lever again. Does anyone have ideas on how we could add some delay in the downloadMSPFile to resolve this?

mpconley · 2019-11-30T23:33:27Z

Please review the wiki links:

Please test Client.Media (GMCP) and MSP by logging into StickMUD at telnet://stickmud.com:7680 with a new character, going east, 2 up and trying out this test plan:

pull lever A with gmcp
pull lever B with gmcp
... through ...
pull lever O with gmcp

delete your media folder under the StickMUD profile

pull lever A with lua
pull lever B with lua
... through ...
pull lever O with lua

delete your media folder under the StickMUD profile

pull lever A with telopt
pull lever B with telopt
... through ...
pull lever O with telopt

… development

demonnic · 2019-12-02T17:31:28Z

I am not hearing any sound, using the testing version for 211f7d2 commit. lever B and C with telopt download cow.wav but I do not hear it. lever D crashes Mudlet with a segfault. Ubuntu 18.04.3 LTS

(gdb) backtrace
#0  0x00007ffff7f034b4 in QMediaPlayer::setMedia(QMediaContent const&, QIODevice*) () from /tmp/.mount_InsighFyodKJ/lib/libQt5Multimedia.so.5
#1  0x00007ffff7f036e2 in QMediaPlayer::setPlaylist(QMediaPlaylist*) () from /tmp/.mount_InsighFyodKJ/lib/libQt5Multimedia.so.5
#2  0x00000000008397ad in TMedia::play(TMediaData&) ()
#3  0x000000000083ad35 in TMedia::playMedia(TMediaData&) ()
#4  0x00000000005c2a01 in cTelnet::setMSPVariables(QByteArray const&) ()
#5  0x00000000005c96ec in cTelnet::processTelnetCommand(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&) ()
#6  0x00000000005cc51a in cTelnet::processSocketData(char*, int) ()
#7  0x00000000005cca6e in cTelnet::handle_socket_signal_readyRead() ()
#8  0x00007ffff58e1996 in QMetaObject::activate(QObject*, int, int, void**) () from /tmp/.mount_InsighFyodKJ/lib/libQt5Core.so.5
#9  0x00007ffff5dc4d41 in ?? () from /tmp/.mount_InsighFyodKJ/lib/libQt5Network.so.5
#10 0x00007ffff58e1669 in QMetaObject::activate(QObject*, int, int, void**) () from /tmp/.mount_InsighFyodKJ/lib/libQt5Core.so.5
#11 0x00007ffff5d8dff3 in ?? () from /tmp/.mount_InsighFyodKJ/lib/libQt5Network.so.5
#12 0x00007ffff5d8e0ac in ?? () from /tmp/.mount_InsighFyodKJ/lib/libQt5Network.so.5
#13 0x00007ffff5da1691 in ?? () from /tmp/.mount_InsighFyodKJ/lib/libQt5Network.so.5
#14 0x00007ffff65d059c in QApplicationPrivate::notify_helper(QObject*, QEvent*) () from /tmp/.mount_InsighFyodKJ/lib/libQt5Widgets.so.5
#15 0x00007ffff65d7c20 in QApplication::notify(QObject*, QEvent*) () from /tmp/.mount_InsighFyodKJ/lib/libQt5Widgets.so.5
#16 0x00007ffff58b3d28 in QCoreApplication::notifyInternal2(QObject*, QEvent*) () from /tmp/.mount_InsighFyodKJ/lib/libQt5Core.so.5
#17 0x00007ffff590ecf8 in ?? () from /tmp/.mount_InsighFyodKJ/lib/libQt5Core.so.5
#18 0x00007ffff6b31417 in g_main_context_dispatch () from /usr/lib/x86_64-linux-gnu/libglib-2.0.so.0
#19 0x00007ffff6b31650 in ?? () from /usr/lib/x86_64-linux-gnu/libglib-2.0.so.0
#20 0x00007ffff6b316dc in g_main_context_iteration () from /usr/lib/x86_64-linux-gnu/libglib-2.0.so.0
#21 0x00007ffff590e05f in QEventDispatcherGlib::processEvents(QFlags<QEventLoop::ProcessEventsFlag>) () from /tmp/.mount_InsighFyodKJ/lib/libQt5Core.so.5
#22 0x00007ffff58b20ba in QEventLoop::exec(QFlags<QEventLoop::ProcessEventsFlag>) () from /tmp/.mount_InsighFyodKJ/lib/libQt5Core.so.5
#23 0x00007ffff58bb174 in QCoreApplication::exec() () from /tmp/.mount_InsighFyodKJ/lib/libQt5Core.so.5
#24 0x000000000045a6d1 in main ()

… development

mpconley · 2019-12-03T02:59:37Z

I found a Windows 10 machine to test on an also had issues playing the cow, lightning and death sounds. The city and water sounds played fine. This could be due to differences in how memory is managed on the other OS's - so I am going to try to harden the code with some more checks. If I could get Windows working 100% perhaps the odds will be in my favor that Linux will be healthy again too.

demonnic · 2019-12-04T02:23:37Z

tested the latest version, it downloads the files as it should for all three options, but I'm still not hearing any sounds playing with any of them. no longer crashes.

mpconley · 2019-12-04T04:40:30Z

I removed a lot of unnecessary pointers to make direct references. The only pointers needed were for external resources like QMediaPlayer. I am not sure if that will help this play on more OS yet or not.

There is still one known bug where something with a lower priority than what is already playing is being allowed to play (which should not because it is a lower priority). There is a List of TMediaPlayer, which is a wrapper class holding TMediaData and the QMediaPlayer. It looks like the references are getting wiped out after something plays, so it is not possible to compare things right. More troubleshooting needed.

mpconley · 2019-12-05T02:13:08Z

I resolved the issue with priority and now everything tests out with MSP on Mac. The issue was that I was storing TMediaPlayer objects in the (session) List that were low priority and were never played. By moving that code back to not save the playing TMediaPlayer until the time it was used to start playing something the problem was resolved and now GMCP, lua and telopt MSP are working fine on Mac. I am going to try a Windows run as soon as the build is ready.

mpconley · 2019-12-05T03:01:58Z

Client.Media, lua and telopt MSP are working now as intended on Mac and Windows! Linux still needs some help, but I believe that is a platform problem and not this PR.

mpconley · 2019-12-05T12:05:15Z

Latest (hopefully last) changes are good on MacOS and Windows

demonnic · 2019-12-07T02:02:20Z

I have checked this on Windows 10 as well and it all functions as described.

vadi2

I haven't finished review and there's a few coding improvements I'd like to see, but it works and has been tested, and that is enough for the experimental preview in Mudlet!

vadi2 · 2019-12-01T09:58:09Z

src/TLuaInterpreter.cpp

@@ -6678,6 +6678,30 @@ int TLuaInterpreter::sendATCP(lua_State* L)
    return 1;
 }

+// Documentation: https://wiki.mudlet.org/w/Manual:Lua_Functions#receiveMSP
+int TLuaInterpreter::receiveMSP(lua_State* L)


Would handleMSP be better name for this?

There is sendGMCP, so I made receiveMSP - if we have a handleXXX example elsewhere, then for consistency perhaps yes.

src/TMedia.cpp

src/ctelnet.cpp

vadi2 · 2019-12-03T19:03:05Z

src/TMedia.cpp

+    return fileUrl;
+}
+
+bool TMedia::processUrl(TMediaData& mediaData)


The function name is pretty generic and on my first read through, I had no clue what it did except modify state of the host (and for some reason this is done on every MSP call) - confusing :O

This handling could be reconsidered after the dust settles. A couple other functions have Url in the name, and most are bound inside processUrl, so there is a good bit going on within its scope. For the MSP protocol, every call, when combined with "Off" as a fileName, could need some handling. It's not the end of the world, but what we'll see here for games that advertise MSP as a TELOPT, and the player has not downloaded the files manually from their game that only supports zip files, there could be some output in the error log about not being to download a file from www.<thegame.com>/media. Like was done with map downloads, we're suggesting a default Url (undocumented) where one was not set, to try and download the file from.

src/Host.h

* Add Mud Sound Protocol (MSP) Support * Adjust URL to http, remove extra return * Resolving code compliance checks * Resolving code compliance checks * Resolving code compliance checks * Resolving code compliance checks * Resolving code compliance checks * Wildcards, CLAZY, slashes, break, nullptr and paths * Resolved directory creation issue, downloads working * Enhanced MSP with QAudio::CustomRole * Backed out QAudio, Possible final revisions * Updated Protocol Preferences in Settings * Code compliance * Code compliance * Code compliance * Trigger Windows & Linux builds * Updated download methodology * Code compliance * Code compliance * Resolving conflict * Code compliance * Introducing TMedia * Code Compliance * Code Compliance * Sets .wav and .mid correctly * Typo resolved * Security checks * GMCP Support * Code compliance * Added lua receiveMSP() * Code compliance * Resolving conflict * Updated CMakeLists.txt * Updated CMakeLists.txt * Updated CMakeLists.txt * Code compliance * Registered receiveMSP * Code compliance * Undo missing GNU * Refined code * Enhance GMCP Support * Enhance GMCP Support * Enhance GMCP Support * Code compliance * Added Suppression * Code compliance * Enhanced suppression * Implemented Priority * Added Validation * Code compliance * Resolved bug * Introducing GMCP.Media * Code compliance * Code compliance * GMCP volume bug resolved * mediaLocation by protocol * List fix * MediaKey constraints * matchMediaKeyAndStopMediaVariants * Code dedupe * Code dedupe * Resolving priority bug * Bug fixes * bool mediaContinue * Trialing Video * Untrialed video * Untrialed video * Removed target (no video) * Minor update * Documentation links * Code compliance * Wiki reference update * Resolve bug in XMLImport.cpp * Fix unintialised TMediaPlayer * Removed pointers * Fixed priority * Removed folder making from tag * Changed sub-directory generation * Adjust label names in preferences

Add Mud Sound Protocol (MSP) Support

90577a0

mpconley requested a review from a team as a code owner September 29, 2019 04:45

mpconley requested a review from a team September 29, 2019 04:45

vadi2 assigned demonnic, vadi2, keneanung and SlySven Sep 29, 2019

mpconley added 6 commits October 5, 2019 08:15

Adjust URL to http, remove extra return

0670271

Resolving code compliance checks

8433df0

Resolving code compliance checks

ef00a43

Resolving code compliance checks

ac71d7a

Resolving code compliance checks

dd100b7

Resolving code compliance checks

a6b1ab5

SlySven reviewed Oct 5, 2019

View reviewed changes

mpconley added 3 commits October 6, 2019 00:27

Wildcards, CLAZY, slashes, break, nullptr and paths

360e1b4

Resolved directory creation issue, downloads working

4e39da5

Enhanced MSP with QAudio::CustomRole

d76f0de

vadi2 mentioned this pull request Oct 16, 2019

Update CONTRIBUTING.md #3164

Merged

Mike Conley and others added 6 commits October 17, 2019 23:02

Backed out QAudio, Possible final revisions

e651ece

Updated Protocol Preferences in Settings

976cb98

Code compliance

ce3f5a8

Code compliance

f90d916

Code compliance

36a228a

Trigger Windows & Linux builds

5bdbcd7

mpconley added 3 commits November 30, 2019 03:34

Minor update

f961631

Documentation links

b97be6d

Code compliance

dff64e2

vadi2 and others added 3 commits December 1, 2019 11:08

Merge remote-tracking branch 'origin/development' into add-msp

211f7d2

Wiki reference update

f506f2e

Merge branch 'development' of https://github.com/mpconley/Mudlet into…

160bcc0

… development

vadi2 and others added 3 commits December 2, 2019 18:36

Merge remote-tracking branch 'SlySven/development' into add-msp

70d9676

Resolve bug in XMLImport.cpp

b24ae1e

Merge branch 'development' of https://github.com/mpconley/Mudlet into…

8804114

… development

Fix unintialised TMediaPlayer

bd4107f

Removed pointers

89112a4

Fixed priority

a6e93ec

mpconley added 2 commits December 4, 2019 22:34

Removed folder making from tag

910df5d

Changed sub-directory generation

46b1821

demonnic approved these changes Dec 7, 2019

View reviewed changes

Adjust label names in preferences

d662259

vadi2 approved these changes Dec 7, 2019

View reviewed changes

vadi2 merged commit a2248a3 into Mudlet:development Dec 7, 2019

mpconley mentioned this pull request Dec 8, 2019

MSP Includes for WITH_UPDATER set to NO #3263

Merged

SlySven mentioned this pull request Apr 12, 2020

Enhance: add support for CP437 encoding #3579

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Mud Sound Protocol (MSP) Support #3132

Add Mud Sound Protocol (MSP) Support #3132

mpconley commented Sep 29, 2019 •

edited

Loading

add-deployment-links bot commented Sep 29, 2019 •

edited

Loading

demonnic commented Sep 29, 2019

mpconley commented Sep 29, 2019

mpconley commented Oct 9, 2019

vadi2 commented Oct 9, 2019

mpconley commented Oct 19, 2019

mpconley commented Nov 30, 2019 •

edited

Loading

demonnic commented Dec 2, 2019

mpconley commented Dec 3, 2019

demonnic commented Dec 4, 2019

mpconley commented Dec 4, 2019

mpconley commented Dec 5, 2019

mpconley commented Dec 5, 2019

mpconley commented Dec 5, 2019

demonnic commented Dec 7, 2019

vadi2 left a comment

vadi2 Dec 1, 2019

mpconley Dec 7, 2019

vadi2 Dec 3, 2019

mpconley Dec 7, 2019

Add Mud Sound Protocol (MSP) Support #3132

Add Mud Sound Protocol (MSP) Support #3132

Conversation

mpconley commented Sep 29, 2019 • edited Loading

Brief overview of PR changes/additions

Motivation for adding to Mudlet

Other info (issues closed, discussion etc)

add-deployment-links bot commented Sep 29, 2019 • edited Loading

Test versions

demonnic commented Sep 29, 2019

mpconley commented Sep 29, 2019

mpconley commented Oct 9, 2019

vadi2 commented Oct 9, 2019

mpconley commented Oct 19, 2019

mpconley commented Nov 30, 2019 • edited Loading

demonnic commented Dec 2, 2019

mpconley commented Dec 3, 2019

demonnic commented Dec 4, 2019

mpconley commented Dec 4, 2019

mpconley commented Dec 5, 2019

mpconley commented Dec 5, 2019

mpconley commented Dec 5, 2019

demonnic commented Dec 7, 2019

vadi2 left a comment

Choose a reason for hiding this comment

vadi2 Dec 1, 2019

Choose a reason for hiding this comment

mpconley Dec 7, 2019

Choose a reason for hiding this comment

vadi2 Dec 3, 2019

Choose a reason for hiding this comment

mpconley Dec 7, 2019

Choose a reason for hiding this comment

mpconley commented Sep 29, 2019 •

edited

Loading

add-deployment-links bot commented Sep 29, 2019 •

edited

Loading

mpconley commented Nov 30, 2019 •

edited

Loading