C# Class NScumm.Core.Audio.Tfmx

Inheritance: Paula
Datei anzeigen Open project: scemino/nscumm Class Usage Examples

Public Methods

Method Description
AdvancePatterns ( ) : void
DoSfx ( ushort sfxIndex, bool unlockChannel = false ) : int

Plays an effect from the sfx-table, does not start audio-playback.

DoSong ( int songPos, bool stopAudio = false ) : void

Stops currently playing Song (if any) and cues up a new one. if stopAudio is specified, the player gets reset before starting the new song

Effects ( ChannelContext channel ) : void
FreeResourceDataImpl ( ) : void
FreeResources ( ) : void
InitFadeCommand ( byte fadeTempo, sbyte endVol ) : void
InitPattern ( PatternContext pattern, byte cmd, sbyte expose, uint offset ) : void
Load ( Stream musicData, Stream sampleData, bool autoDelete ) : bool
MacroRun ( ChannelContext channel ) : void
NoteCommand ( byte note, byte param1, byte param2, byte param3 ) : void
SetModuleData ( MdatResource resource, byte sampleData, bool autoDelete ) : void
SetModuleData ( Tfmx otherPlayer ) : void
SetNoteMacro ( ChannelContext channel, int note, int fineTune ) : void
SetSignalAction ( ushort>.Action action ) : void
StopMacroEffect ( int channel ) : void
StopSong ( bool stopAudio = true ) : void

Stops a playing Song (but leaves macros running) and optionally also stops the player

StopSongImpl ( bool stopAudio = true ) : void
Tfmx ( int rate, bool stereo ) : System.Diagnostics

Protected Methods

Method Description
Dispose ( bool disposing ) : void
Interrupt ( ) : void

Private Methods

Method Description
ClearEffects ( ChannelContext channel ) : void
CreateChannelContexts ( ) : ChannelContext[]
CreatePatternContext ( ) : PatternContext[]
GetSamplePtr ( int offset ) : byte[]
HaltMacroProgramm ( ChannelContext channel ) : void
HasResources ( ) : bool
InitMacroProgramm ( ChannelContext channel ) : void
LoadMdatFile ( Stream musicData ) : MdatResource
LoadSampleFile ( Stream sampleStream ) : byte[]
PatternRun ( PatternContext pattern ) : bool
TrackRun ( bool incStep = false ) : bool
UnlockMacroChannel ( ChannelContext channel ) : void

Method Details

AdvancePatterns() public method

public AdvancePatterns ( ) : void
return void

Dispose() protected method

protected Dispose ( bool disposing ) : void
disposing bool
return void

DoSfx() public method

Plays an effect from the sfx-table, does not start audio-playback.
public DoSfx ( ushort sfxIndex, bool unlockChannel = false ) : int
sfxIndex ushort index of effect to play.
unlockChannel bool If set to true overwrite higher priority effects.
return int

DoSong() public method

Stops currently playing Song (if any) and cues up a new one. if stopAudio is specified, the player gets reset before starting the new song
public DoSong ( int songPos, bool stopAudio = false ) : void
songPos int index of Song to play.
stopAudio bool If set to true stops player and audio output.
return void

Effects() public method

public Effects ( ChannelContext channel ) : void
channel ChannelContext
return void

FreeResourceDataImpl() public method

public FreeResourceDataImpl ( ) : void
return void

FreeResources() public method

public FreeResources ( ) : void
return void

InitFadeCommand() public method

public InitFadeCommand ( byte fadeTempo, sbyte endVol ) : void
fadeTempo byte
endVol sbyte
return void

InitPattern() public method

public InitPattern ( PatternContext pattern, byte cmd, sbyte expose, uint offset ) : void
pattern PatternContext
cmd byte
expose sbyte
offset uint
return void

Interrupt() protected method

protected Interrupt ( ) : void
return void

Load() public method

public Load ( Stream musicData, Stream sampleData, bool autoDelete ) : bool
musicData Stream
sampleData Stream
autoDelete bool
return bool

MacroRun() public method

public MacroRun ( ChannelContext channel ) : void
channel ChannelContext
return void

NoteCommand() public method

public NoteCommand ( byte note, byte param1, byte param2, byte param3 ) : void
note byte
param1 byte
param2 byte
param3 byte
return void

SetModuleData() public method

public SetModuleData ( MdatResource resource, byte sampleData, bool autoDelete ) : void
resource MdatResource
sampleData byte
autoDelete bool
return void

SetModuleData() public method

public SetModuleData ( Tfmx otherPlayer ) : void
otherPlayer Tfmx
return void

SetNoteMacro() public method

public SetNoteMacro ( ChannelContext channel, int note, int fineTune ) : void
channel ChannelContext
note int
fineTune int
return void

SetSignalAction() public method

public SetSignalAction ( ushort>.Action action ) : void
action ushort>.Action
return void

StopMacroEffect() public method

public StopMacroEffect ( int channel ) : void
channel int
return void

StopSong() public method

Stops a playing Song (but leaves macros running) and optionally also stops the player
public StopSong ( bool stopAudio = true ) : void
stopAudio bool If set to true stops player and audio output.
return void

StopSongImpl() public method

public StopSongImpl ( bool stopAudio = true ) : void
stopAudio bool
return void

Tfmx() public method

public Tfmx ( int rate, bool stereo ) : System.Diagnostics
rate int
stereo bool
return System.Diagnostics