GetSoundFFTData: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
{{Needs Example}}
This function gets the fast fourier transform data for an audio stream which is a table of floats representing the current audio frame.
This function gets the fast fourier transform data for an audio stream which is a table of floats representing the current audio frame.
This allows things like visualisations.
This allows things like visualisations.
Line 18: Line 17:
===Required Arguments===  
===Required Arguments===  
*'''sound:''' A sound element that is created using [[playSound]] or [[playSound3D]]. Streams are also supported
*'''sound:''' A sound element that is created using [[playSound]] or [[playSound3D]]. Streams are also supported
*'''iSamples:''' Allowed samples are 128, 256, 512, 1024, 2048, 4096, 8192 and 16384
*'''iSamples:''' Allowed samples are 256, 512, 1024, 2048, 4096, 8192 and 16384


===Optional Arguments===
===Optional Arguments===
*'''iBands:''' Post processing option allows you to split the samples into the desired amount of bands or bars so if you only need 5 bars this saves a lot of cpu power compared to trying to do it in Lua
*'''iBands:''' Post processing option allows you to split the samples into the desired amount of bands or bars so if you only need 5 bars this saves a lot of cpu power compared to trying to do it in Lua. Using it function returns '''iBands'''-1 floats.


===Returns===
===Returns===
Line 29: Line 28:


==Example==  
==Example==  
This code creates bands in center of screen from top to bottom. Key '''9''' - start, key '''0''' - stop.
<section name="Client" class="client" show="true">
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- not done yet
local handl = nil
local sx,sy = guiGetScreenSize()
 
function clientRenderFunc()
    if(handl) then
        local bt = getSoundFFTData(handl,2048,33)
        for i=1,32 do
            bt[i] = math.sqrt(bt[i])*3*128 --scale it (sqrt to make low values more visible)
            if(bt[i] > 128) then
                bt[i] = 128
            end
            dxDrawRectangle(sx/2-bt[i]/2,10*(i-1),bt[i],10,tocolor(255,255,255,255))
        end
    end
end
 
function musicStartFunc()
    if(not handl) then
        handl = playSound('btr.mp3')
        addEventHandler("onClientRender",root,clientRenderFunc)
    end
end
 
function musicStopFunc()
    if(handl) then
        stopSound(handl)
        handl = nil
        removeEventHandler("onClientRender",root,clientRenderFunc)
    end
end
 
bindKey("9","down",musicStartFunc)
bindKey("0","down",musicStopFunc)
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>

Revision as of 12:07, 14 December 2013

This function gets the fast fourier transform data for an audio stream which is a table of floats representing the current audio frame. This allows things like visualisations.

a fast fourier transform generates a table of all the frequencies of the current audio frame which starts at the bass end of the spectrum to mids to highs in that order

Should you have any problems there is an example resource located on the resource svn here: Visualiser

just type "startmusic mystreamurl" in your console and it will play on the cinema billboard near A51 If the element is a player, this function will use the players voice.

Syntax

table getSoundFFTData ( element sound, int iSamples [, int iBands = 0 ] )

Required Arguments

  • sound: A sound element that is created using playSound or playSound3D. Streams are also supported
  • iSamples: Allowed samples are 256, 512, 1024, 2048, 4096, 8192 and 16384

Optional Arguments

  • iBands: Post processing option allows you to split the samples into the desired amount of bands or bars so if you only need 5 bars this saves a lot of cpu power compared to trying to do it in Lua. Using it function returns iBands-1 floats.

Returns

Returns a table of floats representing the current audio frame. Returns false if the sound is not playing yet or hasn't buffered in the case of streams.

Example

This code creates bands in center of screen from top to bottom. Key 9 - start, key 0 - stop.

Click to collapse [-]
Client
local handl = nil
local sx,sy = guiGetScreenSize()

function clientRenderFunc()
    if(handl) then
        local bt = getSoundFFTData(handl,2048,33)
        for i=1,32 do
            bt[i] = math.sqrt(bt[i])*3*128 --scale it (sqrt to make low values more visible)
            if(bt[i] > 128) then
                bt[i] = 128
            end
            dxDrawRectangle(sx/2-bt[i]/2,10*(i-1),bt[i],10,tocolor(255,255,255,255))
        end
    end
end

function musicStartFunc()
    if(not handl) then
        handl = playSound('btr.mp3')
        addEventHandler("onClientRender",root,clientRenderFunc)
    end
end

function musicStopFunc()
    if(handl) then
        stopSound(handl)
        handl = nil
        removeEventHandler("onClientRender",root,clientRenderFunc)
    end
end

bindKey("9","down",musicStartFunc)
bindKey("0","down",musicStopFunc)

Changelog

Version Description
1.3.2 Added player element to use a players voice

See Also