de.quippy.javamod.multimedia.mod.mixer

Class BasicModMixer

java.lang.Object

de.quippy.javamod.multimedia.mod.mixer.BasicModMixer

Direct Known Subclasses:

ProTrackerMixer, ScreamTrackerMixer

public abstract class BasicModMixer
extends Object

Since:

30.04.2006

Author:

Daniel Becker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	BasicModMixer.ChannelMemory

Field Summary

Fields

Modifier and Type	Field and Description
protected BasicModMixer.ChannelMemory[]	channelMemory
protected int	currentArrangement
protected int	currentBPM
protected Pattern	currentPattern
protected int	currentPatternIndex
protected int	currentRow
protected int	currentTempo
protected int	currentTick
protected boolean	doFadeOut
protected boolean	doFastForward
protected int	doISP
protected int	doNoLoops
protected int	fadeOutFac
protected int	fadeOutSub
protected int	fadeOutValue
protected int	frequencyTableType
protected int	globalTuning
protected int	globalVolume
protected int	globalVolumSlideValue
protected int	jumpLoopPatternIndex
protected int	jumpLoopPatternRow
protected boolean	jumpLoopPositionSet
protected int	jumpLoopRepeatCount
protected static int	MAX_NNA_CHANNELS
protected int	maxChannels
protected Module	mod
protected boolean	modFinished
protected int[]	nvRampL
protected int[]	nvRampR
protected int	patternBreakRowIndex
protected int	patternDelayCount
protected int	patternPosJumpPatternIndex
protected int	patternTicksDelayCount
protected int	samplePerTicks
protected int	sampleRate
protected boolean	useFastSlides
protected int	volRampLen
protected int[]	vRampL
protected int[]	vRampR

Constructor Summary

Constructors

Constructor and Description
BasicModMixer(Module mod, int sampleRate, int doISP, int doNoLoops) Constructor for BasicModMixer

Method Summary

Methods

Modifier and Type	Method and Description
protected int	calculateSamplesPerTick() Normally you would use the formula (25*samplerate)/(bpm*10) which is (2.5*sampleRate)/bpm.
void	changeDoNoLoops(int newDoNoLoops) Changes the interpolation routine.
void	changeISP(int newISP) Changes the interpolation routine.
void	changeSampleRate(int newSampleRate) BE SHURE TO STOP PLAYBACK!
protected long	cutOffToFrequency(long cutOff, int flt_modifier, boolean isExFilterRange) calc the cut off
protected abstract void	doRowEffects(BasicModMixer.ChannelMemory aktMemo) Do the effects of a row.
protected void	doRowEvent() Do the Events of a new Row!
protected abstract void	doTickEffekts(BasicModMixer.ChannelMemory aktMemo) Do the Effekts during Ticks
protected boolean	doTickEvents() Do the events during a Tick.
protected abstract void	doVolumeColumnRowEffekt(BasicModMixer.ChannelMemory aktMemo) Used to precess the volume column
protected abstract void	doVolumeColumnTickEffekt(BasicModMixer.ChannelMemory aktMemo) do the volume column tick effekts
protected void	fitIntoLoops(BasicModMixer.ChannelMemory actMemo) Add current speed to samplepos and fit currentSamplePos into loop values or signal Sample finished
int	getCurrentPatternPosition()
int	getCurrentUsedChannels()
protected int	getFineTunePeriod(BasicModMixer.ChannelMemory aktMemo) Calls getFineTunePeriod(ChannelMemory, int Period) with the aktual Period assigend.
protected int	getFineTunePeriod(BasicModMixer.ChannelMemory aktMemo, int period) Retrievs a Periodvalue (see Helpers.noteValues) shifted by 4 (*16) XM_LINEAR_TABLE and XM_AMIGA_TABLE is for XM-Mods, AMIGA_TABLE is for ProTrackerMods only (XM_AMIGA_TABLE is about the same though) With Mods the AMIGA_TABLE, IT_AMIGA_TABLE and XM_AMIGA_TABLE result in the approximate same values, but to be purly compatible and correct, we use the protracker fintune period tables!
void	initializeMixer() Call this first!
protected abstract void	initializeMixer(int channel, BasicModMixer.ChannelMemory aktMemo) Do own inits Espezially do the init of the panning depending on ModType
protected boolean	isInfinitLoop(int currentArrangement, int currentRow)
protected boolean	isInfinitLoop(int currentArrangement, PatternRow patternRow)
protected abstract boolean	isNoteDelayEffekt(BasicModMixer.ChannelMemory aktMemo) Returns true, if the Effekt and EffektOp indicate a NoteDelayEffekt
protected abstract boolean	isPortaToNoteEffekt(BasicModMixer.ChannelMemory aktMemo) Returns true, if the Effekt and EffektOp indicate a PortaToNoteEffekt
protected abstract boolean	isSampleOffsetEffekt(BasicModMixer.ChannelMemory aktMemo) Return true, if the effekt and effektop indicate the sample offset effekt
int	mixIntoBuffer(int[] leftBuffer, int[] rightBuffer, int count) Will mix #count 24bit signed samples in stereo into the two buffer.
protected void	processEffekts(boolean inTick, BasicModMixer.ChannelMemory aktMemo)
protected void	processEnvelopes(BasicModMixer.ChannelMemory aktMemo) Processes the Envelopes This function now sets the volume - alwayes!!
protected abstract void	resetAllEffects(BasicModMixer.ChannelMemory aktMemo, PatternElement nextElement, boolean forced) Clear all effekts.
protected void	resetInstrument(BasicModMixer.ChannelMemory aktMemo) Set all index values back to zero!
void	setIsFastForward(boolean newFastForward)
protected void	setNewInstrumentAndPeriod(BasicModMixer.ChannelMemory aktMemo)
protected void	setNewPlayerTuningFor(BasicModMixer.ChannelMemory aktMemo) Set the current tuning for the player
protected void	setNewPlayerTuningFor(BasicModMixer.ChannelMemory aktMemo, int newPeriod) This Method now takes the current Period (e.g. 856<<4) and calculates the playerTuning to be used.
protected void	setupChannelFilter(BasicModMixer.ChannelMemory aktMemo, boolean bReset, int flt_modifier) Simple 2-poles resonant filter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

channelMemory

protected BasicModMixer.ChannelMemory[] channelMemory

maxChannels

protected int maxChannels

MAX_NNA_CHANNELS

protected static final int MAX_NNA_CHANNELS

See Also:

Constant Field Values

currentTempo

protected int currentTempo

currentBPM

protected int currentBPM

globalTuning

protected int globalTuning

globalVolume

protected int globalVolume

globalVolumSlideValue

protected int globalVolumSlideValue

useFastSlides

protected boolean useFastSlides

frequencyTableType

protected int frequencyTableType

currentTick

protected int currentTick

currentRow

protected int currentRow

currentArrangement

protected int currentArrangement

currentPatternIndex

protected int currentPatternIndex

samplePerTicks

protected int samplePerTicks

patternDelayCount

protected int patternDelayCount

patternTicksDelayCount

protected int patternTicksDelayCount

currentPattern

protected Pattern currentPattern

volRampLen

protected int volRampLen

patternBreakRowIndex

protected int patternBreakRowIndex

patternPosJumpPatternIndex

protected int patternPosJumpPatternIndex

jumpLoopPositionSet

protected boolean jumpLoopPositionSet

jumpLoopPatternIndex

protected int jumpLoopPatternIndex

jumpLoopPatternRow

protected int jumpLoopPatternRow

jumpLoopRepeatCount

protected int jumpLoopRepeatCount

mod

protected final Module mod

sampleRate

protected int sampleRate

doISP

protected int doISP

doNoLoops

protected int doNoLoops

doFastForward

protected boolean doFastForward

modFinished

protected boolean modFinished

doFadeOut

protected boolean doFadeOut

fadeOutValue

protected int fadeOutValue

fadeOutFac

protected int fadeOutFac

fadeOutSub

protected int fadeOutSub

vRampL

protected int[] vRampL

vRampR

protected int[] vRampR

nvRampL

protected int[] nvRampL

nvRampR

protected int[] nvRampR

Constructor Detail

BasicModMixer

public BasicModMixer(Module mod,
             int sampleRate,
             int doISP,
             int doNoLoops)

Constructor for BasicModMixer

Method Detail

changeSampleRate

public void changeSampleRate(int newSampleRate)

BE SHURE TO STOP PLAYBACK! Changing this during playback may (will!) cause crappy playback!

Parameters:

newSampleRate -

Since:

09.07.2006

changeISP

public void changeISP(int newISP)

Changes the interpolation routine. This can be done at any time

Parameters:

newISP -

Since:

09.07.2006

changeDoNoLoops

public void changeDoNoLoops(int newDoNoLoops)

Changes the interpolation routine. This can be done at any time

Parameters:

newISP -

Since:

09.07.2006

setIsFastForward

public void setIsFastForward(boolean newFastForward)

Parameters:

newFastForward -

Since:

02.04.2010

initializeMixer

protected abstract void initializeMixer(int channel,
                   BasicModMixer.ChannelMemory aktMemo)

Do own inits Espezially do the init of the panning depending on ModType

initializeMixer

public void initializeMixer()

Call this first!

calculateSamplesPerTick

protected int calculateSamplesPerTick()

Normally you would use the formula (25*samplerate)/(bpm*10) which is (2.5*sampleRate)/bpm. But (2.5 * sampleRate) is the same as (sampleRate*2) + (sampleRate/2)

Parameters:

currentBPM -

Returns:

getFineTunePeriod

protected int getFineTunePeriod(BasicModMixer.ChannelMemory aktMemo,
                    int period)

Retrievs a Periodvalue (see Helpers.noteValues) shifted by 4 (*16) XM_LINEAR_TABLE and XM_AMIGA_TABLE is for XM-Mods, AMIGA_TABLE is for ProTrackerMods only (XM_AMIGA_TABLE is about the same though) With Mods the AMIGA_TABLE, IT_AMIGA_TABLE and XM_AMIGA_TABLE result in the approximate same values, but to be purly compatible and correct, we use the protracker fintune period tables! The IT_AMIGA_TABLE is for STM and S3M and IT... Be careful: if XM_* is used, we expect a noteIndex (0..119), no period!

Parameters:

aktMemo -

period - or noteIndex

Returns:

getFineTunePeriod

protected int getFineTunePeriod(BasicModMixer.ChannelMemory aktMemo)

Calls getFineTunePeriod(ChannelMemory, int Period) with the aktual Period assigend. All Effekts changing the period need to call this

Parameters:

aktMemo -

Returns:

setNewPlayerTuningFor

protected void setNewPlayerTuningFor(BasicModMixer.ChannelMemory aktMemo,
                         int newPeriod)

This Method now takes the current Period (e.g. 856<<4) and calculates the playerTuning to be used. I.e. a value like 2, which means every second sample in the current instrument is to be played. A value of 0.5 means, every sample is played twice. As we use int-values, this again is shiftet.

Parameters:

aktMemo -

newPeriod -

setNewPlayerTuningFor

protected void setNewPlayerTuningFor(BasicModMixer.ChannelMemory aktMemo)

Set the current tuning for the player

Parameters:

aktMemo -

cutOffToFrequency

protected long cutOffToFrequency(long cutOff,
                     int flt_modifier,
                     boolean isExFilterRange)

calc the cut off

Parameters:

cutOff -

flt_modifier -

isExFilterRange -

Returns:

setupChannelFilter

protected void setupChannelFilter(BasicModMixer.ChannelMemory aktMemo,
                      boolean bReset,
                      int flt_modifier)

Simple 2-poles resonant filter

Parameters:

aktMemo -

bReset -

flt_modifier -

Since:

31.03.2010

doRowEffects

protected abstract void doRowEffects(BasicModMixer.ChannelMemory aktMemo)

Do the effects of a row. This is mostly the setting of effekts

Parameters:

aktMemo -

doTickEffekts

protected abstract void doTickEffekts(BasicModMixer.ChannelMemory aktMemo)

Do the Effekts during Ticks

Parameters:

aktMemo -

doVolumeColumnRowEffekt

protected abstract void doVolumeColumnRowEffekt(BasicModMixer.ChannelMemory aktMemo)

Used to precess the volume column

Parameters:

aktMemo -

doVolumeColumnTickEffekt

protected abstract void doVolumeColumnTickEffekt(BasicModMixer.ChannelMemory aktMemo)

do the volume column tick effekts

Parameters:

aktMemo -

resetAllEffects

protected abstract void resetAllEffects(BasicModMixer.ChannelMemory aktMemo,
                   PatternElement nextElement,
                   boolean forced)

Clear all effekts. Sometimes, if Effekts do continue, they are not stopped.

Parameters:

aktMemo -

nextElement -

isNoteDelayEffekt

protected abstract boolean isNoteDelayEffekt(BasicModMixer.ChannelMemory aktMemo)

Returns true, if the Effekt and EffektOp indicate a NoteDelayEffekt

Parameters:

effekt -

effektOp -

Returns:

isPortaToNoteEffekt

protected abstract boolean isPortaToNoteEffekt(BasicModMixer.ChannelMemory aktMemo)

Returns true, if the Effekt and EffektOp indicate a PortaToNoteEffekt

Parameters:

effekt -

effektOp -

Returns:

isSampleOffsetEffekt

protected abstract boolean isSampleOffsetEffekt(BasicModMixer.ChannelMemory aktMemo)

Return true, if the effekt and effektop indicate the sample offset effekt

Parameters:

effekt -

effektParam -

Returns:

Since:

19.06.2006

processEnvelopes

protected void processEnvelopes(BasicModMixer.ChannelMemory aktMemo)

Processes the Envelopes This function now sets the volume - alwayes!!

Parameters:

aktMemo -

Since:

19.06.2006

resetInstrument

protected void resetInstrument(BasicModMixer.ChannelMemory aktMemo)

Set all index values back to zero!

Parameters:

aktMemo -

Since:

19.06.2006

getCurrentPatternPosition

public int getCurrentPatternPosition()

getCurrentUsedChannels

public int getCurrentUsedChannels()

Returns:

Since:

30.03.2010

setNewInstrumentAndPeriod

protected void setNewInstrumentAndPeriod(BasicModMixer.ChannelMemory aktMemo)

processEffekts

protected void processEffekts(boolean inTick,
                  BasicModMixer.ChannelMemory aktMemo)

Parameters:

aktMemo -

Since:

18.09.2010

isInfinitLoop

protected boolean isInfinitLoop(int currentArrangement,
                    PatternRow patternRow)

isInfinitLoop

protected boolean isInfinitLoop(int currentArrangement,
                    int currentRow)

doRowEvent

protected void doRowEvent()

Do the Events of a new Row!

doTickEvents

protected boolean doTickEvents()

Do the events during a Tick.

Returns:

true, if finished!

fitIntoLoops

protected void fitIntoLoops(BasicModMixer.ChannelMemory actMemo)

Add current speed to samplepos and fit currentSamplePos into loop values or signal Sample finished

Parameters:

aktMemo -

Since:

18.06.2006

mixIntoBuffer

public int mixIntoBuffer(int[] leftBuffer,
                int[] rightBuffer,
                int count)

Will mix #count 24bit signed samples in stereo into the two buffer. The buffers will contain 24Bit signed samples.

Parameters:

leftBuffer -

rightBuffer -

count -

Returns:

#of samples mixed, -1 if mixing finished