SoundUtils

[Fledermaus]

Originally Posted by Rising_Dusk

I dunno, if TimerUtils red can get away with an H2I-MIN_HANDLE_ID approach, I don't think it's a problem. I do see your point here, though, but I'm just not sure.

Red does this though:

JASS:

    private function redInit takes nothing returns nothing
        local integer i=0
        local integer bestoffset=-1

        loop
            exitwhen (i==QUANTITY)
            set tT[i] = CreateTimer()
            if(i==0) then
               set bestoffset=GetHandleId(tT[i])
            endif
            if (GetHandleId(tT[i])-OFFSET>=ARRAY_SIZE) then
                debug call BJDebugMsg("TimerUtils_redInit: Failed a initializing attempt")
                debug call BJDebugMsg("The timer limit is "+I2S(i))
                debug call BJDebugMsg("This is a rare ocurrence, if the timer limit is too low, to change OFFSET to "+I2S(bestoffset) )
                exitwhen true
            endif
            if (GetHandleId(tT[i])-OFFSET>=0)  then
                set i=i+1
            endif
        endloop

        set tN=i
    endfunction

[Anitarf]

Or you could just use Table for all your hashing needs.

Anyway, is using timers really that much of an issue? In all cases, the timer will either match the sound perfectly or take longer than the sound, it will never finish faster than the sound (the ratio is 1:1 at fastest game speed). As such, the sound may not get recycled immediately when it finishes, but will recycle eventually. As such, it is a non-issue unless it's a looping sound, but why would you call ReleaseWhenDone on a non-looping sound?

Also, local player sounds should be a non-issue. You play a sound once, either for all players or a specific player. If you need to play it for another player later, you get a new sound for that; so, the sound will get recycled for all players the moment it finishes for whoever it was played (or later, as mentioned in the above paragraph).

I think the interface for this system could be simplified: a few functions could be merged, since I don't think anyone would ever use them separately anyway (Why would you ask for a sound if you weren't immediately planning on using it?): NewSound, RunSound and RecycleSoundWhenDone. Something like function RunSound takes soundhelper refSound, force playFor returns sound with completely automated recycling.

By the way, what's the point of starting a sound in a new thread?

[Rising_Dusk]

Originally Posted by Anitarf

By the way, what's the point of starting a sound in a new thread?

Well, it's kind of redundant, I just realized. You can start a sound in a new thread to avoid having to initialize the sound by running it first, but since I run it on creation anyways, starting in a new thread is repetitive.

Hrm, you're right about the merging of all of those functions into a single function.. Personally, I like having access to the sound. Sometimes, I will call SetSoundVolume(MySound, 64) for a more quiet sound, and if I merged it all together I'd lose the ability to do that. I could certainly merge RunSound and RecycleSoundWhenDone, that one would make sense.

[ToukoAozaki]

In all cases, the timer will either match the sound perfectly or take longer than the sound, it will never finish faster than the sound (the ratio is 1:1 at fastest game speed).

I didn't know that. I might have inferred the thing from Starcraft... Thx for the info.

By the way, what's the point of starting a sound in a new thread?

AIK the sound won't play for the first time on the thread where it is created.

[Anitarf]

Originally Posted by Rising_Dusk

Hrm, you're right about the merging of all of those functions into a single function.. Personally, I like having access to the sound. Sometimes, I will call SetSoundVolume(MySound, 64) for a more quiet sound, and if I merged it all together I'd lose the ability to do that. I could certainly merge RunSound and RecycleSoundWhenDone, that one would make sense.

Note that my version did return the sound for you to manipulate. I'm pretty sure you can modify the volume as the sound is already playing.

[Rising_Dusk]

Oh, I didn't notice that yours returned the sound. Hrm... Maybe I'll try that..

[Rising_Dusk]

Okay, updated per Anitarf's suggestions. I tested the returned sound on RunSound for edit-ability with the standard sound API and it seems that he was right. You can edit a sound's settings while it is running. Because of that, NewSound, RecycleSoundWhenDone, ReleaseSound, and RunSound have been merged together into just RunSound, simplifying the API greatly. If you want to stop your sound prematurely (before the duration expires), StopSound works for that.

[fX_]

well about those settings, pitch is weird. you should be able to effectively pause a sound by setting its pitch to 0.0, and you can make all sorts of new sounds out of a sound file by changing its pitch, and freaky sounds by playing with the ptich as the sound is playing.

but i did some testing with changing pitch (coz i wanted to be able to pause sounds) and the result is sometihng like:
(result may be different but its somewhat like this as i remember)
you can decrease a sound's pitch before it plays, then increase it;
you cant decrease a sound's pitch when it is playing, then increase it;
you can keep increasing sound a sound's pitch (to the max (2.00?));
you can keep decreasing a sound's pitch.
- something buggy with either decreasing-then-increasing or increasing-then-decreasing (both as a sound is playing), can't remember. the subsequent part doesnt succeed.

[Bobo_The_Kodo]

Uh... an 8190 sized array in that struct means you can only have one sound type ever, no?

[Rising_Dusk]

Originally Posted by Bobo_The_Kodo

Uh... an 8190 sized array in that struct means you can only have one sound type ever, no?

No, because it is static.

[Bobo_The_Kodo]

Oo /fail

[Anitarf]

Won't the current code recycle sounds even if they are looping sounds?

Another issue is the pitch, if it's set to a lower value by the user then the sound could get recycled before it even finishes. You'd need to do some hooking magic to SetSoundPitch as well as attaching timers to sounds to avoid that, though.

[Rising_Dusk]

Originally Posted by Anitarf

Won't the current code recycle sounds even if they are looping sounds?

Haha, that's silly, I guess it will. To fix that, I'll need to bring back ReleaseSound. No big deal, I guess.

[Bobo_The_Kodo]

JASS:

    string  fileName           = ""
    integer duration           = 0
    boolean looping            = false
    boolean is3D               = false
    boolean stopwhenoutofrange = false
    integer fadeInRate         = 0
    integer fadeOutRate        = 0
    string  eaxSetting         = ""

Initializing them there is unnecessary when you're setting them all on creation
->

JASS:

    string  fileName
    integer duration
    boolean looping
    boolean is3D
    boolean stopwhenoutofrange
    integer fadeInRate
    integer fadeOutRate
    string  eaxSetting

Same with soundhelper struct

edit: Also, what does eaxSetting do?

[Mr.Malte]

AIK the sound won't play for the first time on the thread where it is created.

Didnt blizzard fix that with patch 1.23b or something?