AudioStreaming.js (Plugin to improve RPG Maker MV audio performance)

[RyanBram]

Hi, everyone.
I want to bring good news for you who thinks that RPG Maker MV is takes too much time to load audio, especially for games that require accurate audio timing that will ruin the atmosphere of the story if too much delay in audio playback.

This time, I hope the problem is solved because a wonderful guy named Kuramubon (くらむぼん) created a plug-in that loads audio fast! !
With this plug-in, the audio will be played quickly.
It will affect all RPG Maker MV deployment. PC version, the browser version, and mobile version.

In addition, this plugin has bonus feature that you will like it. The feature to allow only OGG music to be played in any platform that previously not supported it, including iOS and Safari Web Browser. In other words, you can play audio without preparing .m4a files. It is really a time saver especially if you have lots of custom music for your games, you don't have to work twice for setting LOOPSTART and LOOPLENGTH audio tags in every music. It will also give you benefits to reduce the overall size of your project so you can save your PC or server storage space.

Operating Environment
Any RPG Maker MV supported platform, including iOS 10 or higher and web browser.


Download
https://raw.githubusercontent.com/krmbn0576/rpgmakermv/master/js/plugins/AudioStreaming.js
https://raw.githubusercontent.com/krmbn0576/rpgmakermv/master/js/plugins/stbvorbis_stream.js
https://raw.githubusercontent.com/krmbn0576/rpgmakermv/master/js/plugins/stbvorbis_stream_asm.js
(Please right-click and save the above three addresses respectively)

How to use
Put three plugins above: AudioStreaming.js, stbvorbis_stream.js, and stbvorbis_stream_asm.js in plugins folder.
However, only AudioStreaming.js should be turned ON in plugin management.
The other two may be "OFF" or shouldn't be registered in plugin management.

Additional feature

• Visually monitoring your game audio performance by activating "measure performance mode" at plugin option.
• If "Erase m4a file" plugin option is turned on in the plug-in parameter, all m4a files of the game can be deleted at the start of the next test play.

PLEASE MAKE A BACKUP BEFORE USING IT, JUST IN CASE !!!

• Author: Kurambon (くらむぼん)
• License: MIT
• Non-commercial use: free
• Commercial use: free
• Redistribution: OK
• Editing: OK
• Redistribution after editing: OK
• Series: RPG Maker MV

 

[Eliaquim]

WOWWWW!!!
This is huge!!!
I was using RsOnlyOgg.js
But this plugin seems to do the only ogg plus a lot more! I will give it a try!

Thanks for share!
Have you try it yet?

 

[RyanBram]

Yes. I have tried it.
It works so fast in my PC. I can feel the difference in performance even without using any preload manager plugin.

You can also see visual indicator by activating measure performance mode in plugin option.

 

[keizz]

Interesting I will test now, thank you for share.

 

[Oscar92player]

Hi there! I would like to ask you about a problem I've found when this plugin was released, and if there's some kind of solution for it. I requested some help on this thread on the JavaScript/Plugin support forums.

It is about the LOOPSTART and LOOPLENGTH tags used on audio that you want to loop forever on the game, because with the first release, that function stopped to work, and I still don't know if the original author updated the plugin to fix this issue.

Thanks in advance!

 

[RyanBram]

AFAIK, the Author was aware about the problem and already made the fix.

The latest commit in his GitHub page was 2 days ago and it seems you reported it on May.

Please try to update to the latest plugin.

Good luck.

 

[Oscar92player]

AFAIK, the Author was aware about the problem and already made the fix.

The latest commit in his GitHub page was 2 days ago and it seems you reported it on May.

Please try to update to the latest plugin.

Good luck.

I'm afraid that the issue with the LOOPLENGTH and the LOOPSTART is still there. Also, there is a bug when the game tries to play a small audio, and you hear no sound at all. That was on the first release, too.

 

[RyanBram]

Could you tell me the name of MV BGM or SE who doesn't play correctly?

Because I don't find any issue when using this plugin. I am using MV 1.6.1 engine anyway.

 

[Tea++]

Great work, this should be useful to a lot of people.

 

[Oscar92player]

Could you tell me the name of MV BGM or SE who doesn't play correctly?

Because I don't find any issue when using this plugin. I am using MV 1.6.1 engine anyway.

I'm not using the default BGM or SE on the project I've made the test. This are custom audio files in OGG with its own LOOPSTART and LOOPLENGTH tags, and custom sound effects.

 

[RyanBram]

It is a little bit hard to guess the reason as I don't see the file myself.

But just little information for everyone, Kuramubon (くらむぼん) the author of this plugin is one of the contributor of RPG Maker MV Core Scripts. And based on the roadmap ( you can see in MV Development thread in this forum), Corescript version 1.4 goal is to improve loading audio, so I guess this plugin will become part of Core Script in the future. Any bug or input will be appreciate, so don't hesitate to report it to him.

 

[---ytruuytr]

Hmm. I've noticed audio stutter with this plugin. I think it adds a pause after the music ends making looping bgm sound bad. There's always ~3-4 second pause at the end of music.

 

[RyanBram]

Is it custom BGM or original MV BGM?
What platform did you try?
What version of MV Core Script that you use?

And make sure you don't use any performance optimization or pre loader plugin, because there will be compatibility issue.
It will help the fix if you provide more detail

Thanks.

 

[---ytruuytr]

Custom bgm, I use galv preloader, windows rpgm mv 1.6.2 editor.

 

[RyanBram]

Then please try again by removing Galv's.
Or try again in clean project to ensure no plugin interfere with audio routines provided by AudioStreaming.js because internally AudioStreaming.js modify default audio processing from MV Core scripts to use stbvorbis_stream.js instead of browser or nw.js built in codec. Preloader plugin may interrupt this process and make audio process redirection doesn't work as expected.

 

[BreakerZero]

Of all the lag fix plugins I've tried this is the one to beat. Every other possible option I could think of has had the same fatal flaw with loop definitions which has almost forced me to abandon this kind of improvement. I also agree that this should be added straight to MV at a later time 'cause it's that good.... and it's exactly what I was looking for.

EDIT: There is one small annoyance, though - if I tab away from the game with a setup that pauses the action in case of an erroneous task switching it takes a minute for the audio stream to resume. Any chance this can be investigated?

 

[TenTranVN]

good

 

[Jenova]

This is what I have been looking for. Its been a very long time looking too.

Only complaint: Static clicks.

They can be heard, for only a millisecond or so, but it does get a bit annoying after a while.

Can this be investigated? Thanks

 

[BreakerZero]

Another thing I noticed. This seems to interfere with plugins with sound profiles for certain incidence, and also has some delays and restarts under certain conditions as well (in particular with save and resume of sound positions, along with a plugin that I'm using for a reaction trial). Can you investigate this for me?

 

[TenTranVN]

Do you think it improves performance on mobile?