External Music System V.1.5

[Moderator]

16:57, 8th Feb 2016
Tank-Commander: A small system with a lot of use - great for saving map memory space and a good edition to the section. Code looks good from where I'm sat and the API fully explains the system. Well done.

Notes (for users): using it does somewhat make dling from the maps section (with links to tracks for maps) rather necessary (dling a map through bnet won't give the appropriate track)

 

[Arad MNK]

Alright I haven't tested this for desyncs but it shouldn't afais.

 

[BPower]

Zwiebelchen is the master when it comes to sound handles in wc3.
Maybe you're lucky and he drops a comment here.

 

[Arad MNK]

Actually, the main idea came from him
He told us that Warcraft III reads folders like .mpq archives and therefore finding a music in the .mpq archive is the same as finding a music in a custom folder!

 

[Yours Truly]

Nice memory-releasing trigger.I laugh horribly when I see the 'bleh' in your keywords.+rep

(PS,love your avatar)

 

[Arad MNK]

Haha, thanks.
Aw, so you reached this by typing in "Bleh"? The reason it is in there is to attract bored people who type in "Bleh"!

Oh, it's Zed from League of Legends. You can get the GIF avatar(s!) from leagueoflegends.com.

 

[Yours Truly]

Let us hope that this will be approved.

(PS,I doubt that there's more of those LOL GIF avatars since there's only four;which is Garen,Sona,Vi and Zed(which is you))

 

[Arad MNK]

Let us hope that this will be approved.

(PS,I doubt that there's more of those LOL GIF avatars since there's only four;which is Garen,Sona,Vi and Zed(which is you))

Let us hope

Oh all those 4 are on the Hive right now (Zed: Me, Vi: ~Nightmare, Sona: Apheraz, Garen: userid907).

EDIT: There's something wrong with the system. Some weird mistakes (thread crashes!!) by me. Don't review this while I fix them! Done. Ready.
EDIT 2: Another shameful update. Removed BJDebugMsg("hh")!!

 

[Flux]

Made a quick look in the system,

• Why not use a timer instead of call TriggerRegisterTimerEvent(EMS_Trig, (1 / udg_MS_Timeout), true). Read more about TimerStart
• Why not use initializer so you don't have to force users to call InitEMS()?
• Try adding a check in your loop for picking all players like PLAYER_SLOT_STATE_PLAYING and MAP_CONTROL_USER
• You could store (1 / udg_MS_Timeout) to a variable to avoid re-calculating them every loop.
• Why are you not indenting your local variables?
• Feel free to use the and boolean operator instead of putting two if ... endif. You also might wanna use elseif for more readability so you don't have to indent again.
• Do you really have to put a "by Arad MNK" in the name?

 

[Arad MNK]

Made a quick look in the system,

• Why not use a timer instead of call TriggerRegisterTimerEvent(EMS_Trig, (1 / udg_MS_Timeout), true). Read more about TimerStart
• Why not use initializer so you don't have to force users to call InitEMS()?
• Try adding a check in your loop for picking all players like PLAYER_SLOT_STATE_PLAYING and MAP_CONTROL_USER
• You could store (1 / udg_MS_Timeout) to a variable to avoid re-calculating them every loop.
• Why are you not indenting your local variables?
• Feel free to use the and boolean operator instead of putting two if ... endif. You also might wanna use elseif for more readability so you don't have to indent again.
• Do you really have to put a "by Arad MNK" in the name?

• Timers are going to be removed in the system, they stop when a player pauses the game, fucking the timing. I'll just use a periodic timer, and figure it out.
  And I'm the master of TimerStart already, used it in my cinematic system for my Cinematic 1000 times.
• This is going to be GUI friendly, so that the user would use it with any GUI event.
• Well, I gotta check for all AVAILABLE people in all slots... meh. Will do it by forces.
• OK. Will try. (In the new system it no longer exists 2 times)
• Why should I? the readability is still fine.
• If you're talking about the GetLocalPlayer() part then I'm not sure if it will still localize.
• Sure. Will remove it.

Thanks for viewing this!

 

[Flux]

- I mean using TimerStart instead of creating a trigger with a periodic timer event.
- I don't see a disadvantage of using initializer. It prevents users from manually calling InitEMS.
- I mean just adding a condition in the beginning of the loop so it won't execute on empty slots or computer players.
- Ok if you're comfortable with that indention scheme. It was merely a suggestion because it's best to have uniform coding style. Read more here
- I think it will work fine with and though I'm not 100% sure.

 

[LordDz]

Can you add an option to add specific songs from inside the map, to play?

 

[Arad MNK]

Good idea Lord. Though you can use the specific song in the folder itself but I'll consider that.

 

[HaaG]

Dude, It doesn't work for me. I edited the folder name and set random = true, prefix = false.

 

[Arad MNK]

Well I will take a look into it. Thank you!

 

[Skyflash]

Nice idea alas it`s Vjass it would be great if it was in GUI

 

[Arad MNK]

You control the system via GUI (aka it's GUI friendly) although it can be used in JASS and vJASS too.

 

[M1stery]

Can i use this Arad?

Nice system btw

 

[Arad MNK]

This system is open for public. Like, even people not registered on hive.

Although this system currently uses timers, that is inaccurate when somebody pauses the game. Maybe the next update removes this issue.

EDIT:

Tune up for the next update as IT'S COMING SOON!!!

 

[Arad MNK]

System updated.

• 
  Timer issue no longer exists!
• Cooler demo!
• System code improved.
• Whole system changed it's technique. It now uses sounds but you can easily control 'em (it's more configurable).
• The code is now more efficient. Doesn't have leaks or efficiency or desync-related problems as much as I see.
• READY FOR REVIEW!

 

[BPower]

I think /* */ is not a valid type for comment blocks in the standard editor. ( untested )
Only JPNG probably supports /*
The normal editor does only support //

Just saw the system in coded in vJass so the upper comment is pointless.

//just a linebreak without a use, readability improvement
Just a line without use to kill readability... Just leave a whitespace.
Comments should be informative or really great jokes.

 

[Arad MNK]

So if remove that comment, this will be approved?

Removed then.

 

[IcemanBo]

It doesn't seem to work for me. Any idea?
It does detect the file, and prints "Number of Tracks: 1", but the sound does not play.

 

[Arad MNK]

That's really weird. I'm using it and it works perfectly.

Have you set the MuteAtInit to true?

 

[IcemanBo]

No, it's not muted at init. (and my sound is turned on, too)

So I can't really test it, but can't you give user access to play "Track x"? So he has power to decide to play which music.

 

[Arad MNK]

Really absurd.

That'll be easy. It'll be a check, and an update. Will be done once I implement the debug mode.

Hey, next update will include debug mode and more control over the music. The update after that will be the "Soundtracks" update. Using different musics for different situations (dungeons, villages and etc for example).

 

[IcemanBo]

Neat. Please also think to add some lines of code docu!

 

[Arad MNK]

It's not done yet. I'm not on PC, probably tomorrow, or at worst Saturday it'll be done.

EDIT: Updated.

• 
  More control.
• Debug mode added.
• Now you can play a custom Track.

 

[IcemanBo]

I get the debug messages spammed "Next Track: 1", "Next Track: 2", and no sound.
Also there exists a debug mode already, under JASSHelper settings. In code you then
would need to write debug in front of the command/operation.

loop
    call DisplayTimedTextToPlayer(Player(i), 0, 0, 60, s)
    set i = i + 1
    exitwhen i == 12
endloop

-> BJDebugMsg could be used instead, but actually why does it print messages to all players if a player changes sound for example?

The indentation is massed up at certain places. Always use 1x tab for indenting.
For example:

    private function Core takes nothing returns nothing
            if not(GetSoundIsLoading(Track[CurrTrackNum]) or GetSoundIsPlaying(Track[CurrTrackNum])) and Allowed then
                call StopSound(Track[CurrTrackNum], false, false)
                    if udg_MS_PlayingIsRandom then
                        set CurrTrackNum = GetRandomInt(1, TrackNumLocal)
                        call Message("Random Track: " + I2S(CurrTrackNum))
                    else
                        if CurrTrackNum != TrackNumLocal + 1 then
                            set CurrTrackNum = CurrTrackNum + 1
                        elseif CurrTrackNum == TrackNumLocal + 1 then
                            set CurrTrackNum = 1 //start from beginning
                        endif
                        call Message("Next Track: " + I2S(CurrTrackNum))
                    endif
                call StartSound(Track[CurrTrackNum])
            endif
    endfunction

shoudl look like:

    private function Core takes nothing returns nothing
        if not(GetSoundIsLoading(Track[CurrTrackNum]) or GetSoundIsPlaying(Track[CurrTrackNum])) and Allowed then
            call StopSound(Track[CurrTrackNum], false, false)
            if udg_MS_PlayingIsRandom then
                set CurrTrackNum = GetRandomInt(1, TrackNumLocal)
                call Message("Random Track: " + I2S(CurrTrackNum))
            else
                if CurrTrackNum != TrackNumLocal + 1 then
                    set CurrTrackNum = CurrTrackNum + 1
                elseif CurrTrackNum == TrackNumLocal + 1 then
                    set CurrTrackNum = 1 //start from beginning
                endif
                call Message("Next Track: " + I2S(CurrTrackNum))
            endif
            call StartSound(Track[CurrTrackNum])
        endif
    endfunction

And a function's body should always be indented. Doesn't matter if it's declaring and initialisizing locals.
It should follow JPAG

Can you add some more documention for the functions, please?

I'm not very sure a function like "MuteAtInit" is really needed.
I mean the user has fully access to mute/unmute commands,
so if necessariy he can normaly take usage of them instead of
calling the wrapper that might be anyways only used once at all.

 

[Arad MNK]

Not playing sounds: Check your sound options in Warcraft III options. When you see the messages, you MUST hear the music/sound. They are SOUNDS. Don't look for music mutation or etc.

Debug mode: Tell me moar please! Never heard of that ;p Adding a debug before the function, the call, the what?

Indentation: I'll try to follow JPAG. Will be done as soon as possible.

Documentation: Isn't it explaining it correctly?

MuteAtInit: So I'd better remove it? Mkay :$

 

[IcemanBo]

Just add "debug" before the first keyword and then it will run only in debug mode.

Yes, I've told in a previous post already that my sound is on. Idk, why it's not working for me. :s

 

[Narasha]

Can it b open in classic WE or it requires JNPG? Cause its not working for me whn i tried opening it using classic WE.

 

[Arad MNK]

Can it b open in classic WE or it requires JNPG? Cause its not working for me whn i tried opening it using classic WE.

It's in vJASS and vJASS requires JassHelper, which JassHelper is usually got with JNGP. In the end; yes you need JNGP.

 

[Arad MNK]

System updated! New in version 1.4:

• 
  Indenting fixed!
• Documentation added!
• Removed udg_DebugMode! Now uses debug.
• udg_MuteAtInit removed!
• Library now uses an initializer instead of calling within an Initialization trigger!

To do list:

• 
  Soundtrack system

 

[Emm-A-]

great job on your system. This is excellent for saving filesize. It would be great, if you uploaded a spin-off snippet, which would just enable someone to load a sound handle from a specified folder without playing it, so we could use this sound in another sound system

 

[Arad MNK]

That's actually easy, doing it even away from PC:

struct test

    method loadSoundFromFolder takes string path returns sound
        return CreateSound(path, false, false, false, 12700, 12700, "")
    endmethod

//Example:

    private static method onInit takes nothing returns nothing
        call StartSound(.loadSoundFromFolder("Music\\MahTest.mp3"))
    endmethod
endstruct

//First time using structs! Not sure that I'm using it correctly in onInit :p

Save it to a variable and done. Use it. Just note it may be different for different players (handles are different) that's why this is a system, the main point is to control the localizations and not to cause desyncs. Else the whole thing is the code forementioned.

 

[Emm-A-]

That's actually easy, doing it even away from PC:

struct test

    method loadSoundFromFolder takes string path returns sound
        return CreateSound(path, false, false, false, 12700, 12700, "")
    endmethod

//Example:

    private static method onInit takes nothing returns nothing
        call StartSound(.loadSoundFromFolder("Music\\MahTest.mp3"))
    endmethod
endstruct

//First time using structs! Not sure that I'm using it correctly in onInit :p

Save it to a variable and done. Use it. Just note it may be different for different players (handles are different) that's why this is a system, the main point is to control the localizations and not to cause desyncs. Else the whole thing is the code forementioned.

thanks a lot for posting this This is so great, because I use a lot of custom music, and I didn't know, the possibility of outsourcing was there.

This actually brought me to think about directly creating the sound from folders into variables for each player in that map I am talking about.
It uses a custom music system with timers for each player, and anyway sound is only played locally, so it won't desync, right? I mean of course, every player would have to save the music folder and subfolders at the specified location ...

Anyway, your system looks great!

(sry I dont want to spam, but I thought, this might be interresting for others as well)

 

[Arad MNK]

Oh, if you don't want to change tracks you can use this to work with musics not sounds:

function PlayExMusic takes string path, player forPlayer returns nothing
    if GetLocalPlayer() == forPlayer
        if GetSoundFileDuration(path) >= 0
            //music exists
            call StopMusic(false) //Stops the currently playing music
            call PlayMusic(path)
        endif
    endif
endfunction

No desyncs, all safe. Changing tracks is a bit more complicated and requires timers when using musics, but with sounds there is no need for timers (system base). Timers are stopped when the player pauses the game.
Using this system allows you to change tracks safely using sounds with a lot of configurabilities. No need for your own system (I mean I've already created it).

If you want to change between tracks, use this system. Else, use the easy snippet up here. This snippet is used for variabling external .mp3 files.

 

[Emm-A-]

Oh, if you don't want to change tracks you can use this to work with musics not sounds:

function PlayExMusic takes string path, player forPlayer returns nothing
    if GetLocalPlayer() == forPlayer
        if GetSoundFileDuration(path) >= 0
            //music exists
            call StopMusic(false) //Stops the currently playing music
            call PlayMusic(path)
        endif
    endif
endfunction

No desyncs, all safe. Changing tracks is a bit more complicated and requires timers when using musics, but with sounds there is no need for timers (system base). Timers are stopped when the player pauses the game.
Using this system allows you to change tracks safely using sounds with a lot of configurabilities. No need for your own system (I mean I've already created it).

If you want to change between tracks, use this system. Else, use the easy snippet up here. This snippet is used for variabling external .mp3 files.

thanks again.

so to clarify this, in my map I am using a highly artificial mp3 sound system with timers for each player (sry its not music, I am also using mp3 sounds), so that music will be looping. It has to react very individually to all kinds of situations (seasons, events, dayNight etc.) and play local sound for each player according to its individual situation.

I didn't see an easy way to implement your system in exchange for that.

If I used your system and wanted to play a certain track at a specific situation, I could find it via the track number of the system, right? E.g. test-01.mp3 would be that specific sound I needed so I could find it in the system via its track number 1 and so on? Also, I didnt see, whether your system checks, if a requested sound is already played (which is very important for me that it is able to).

Also I would have to adapt your system anyway, so I am currently thinking of a good way or if I will be able to at all (of course I will credit you even if I will only use your idea (and Zwiebelchen as well) )

 

[Arad MNK]

To do list:

• 
  Soundtrack system

This is what you need.

I'm still trying to figure out keywords for the API... Else I woulda upload it today

The demo will include what you want.


Soundtrack update will be released either tomorrow or the day after (EMS v1.5).



When released, with different events you can use:

//register the event you want, GUI friendly as well
call StartSoundtrack("myFolder", "myFilePrefix") //stops the music, changes the folder with the .mp3 files, and starts playing

The demo event will be a peseant that with moving it you'd change track folders (specific songs you need).

EDIT: I had some problems with thread crashes. It'll be released tomorrow, if my time allows that.

EDIT 2: BRUH. Thread crash problem fixed, now when starting another soundtrack the other soundtrack plays the next track, making 2 tracks play at once. (You'll feel like a DJ)

EDIT 3: FINALLY! Managed to find the issue. Preparing to upload.

 

[Arad MNK]

EMS updated! Hopefully it's last update!

• 
  Soundtrack system added!
• Hotter debug messages!
• Removed some variables
• Added some variables.
• Demo now has a unit to control the soundtracks.

 

[Emm-A-]

Unfortunately the system causes havy lag every time I enter one of these regions with the worker in your demo map ... Other than that it is really cool, thanks for creating this system. If I find some time, I will think about this more

 

[Arad MNK]

I've never faced lag in my demo.

Just tell me: did you face a thread crash as well?

 

[Emm-A-]

I've never faced lag in my demo.

Just tell me: did you face a thread crash as well?

nope just lags. maybe its just my computer, otherwise there would have been other posts I guess

 

[Arad MNK]

Note that the sounds can't be preloaded as they are created at call. This might be the reason for your lag. Maybe I'll add a new function to be able to preload sounds.

 

[Emm-A-]

Note that the sounds can't be preloaded as they are created at call. This might be the reason for your lag. Maybe I'll add a new function to be able to preload sounds.

I think this would be important .. I dont really get why my computer has problems with that as it runs wither 3 on max details but lags with that create native here. Might be some stupid special problem and not generally related to your function ..

 

[Arad MNK]

It is for sure handle preloading, if you lag only once.

But if you have a looooooong lag, it may be a hidden leak or that you have over-engineered the system timeout (like setting it to 100).

 

[Emm-A-]

Hey by testing the CreateSound native like in your system, I just figured out, that you have to enable Warcraft to be able to use Local Files. I didnt read this here or I didnt see it, and as I have 2 computers with 2 editors I have been searching for almost 2 days now ...

So I suggest you add this important tip to your description instruction using regedit.exe (or simply tick the "enable local files" in grimoire extensions of JNGP.


@Lag: this laggy problem dissappeared when I changed some thing in my system, so besides a little first lag, there is no problem anymore

 

[Arad MNK]

Added. Thanks a bunch!