Module (javamod 2.2 API)

java.lang.Object
- de.quippy.javamod.multimedia.mod.loader.Module

Direct Known Subclasses:

ProTrackerMod, ScreamTrackerMod, ScreamTrackerOldMod
```
public abstract class Module
extends Object
```
Since:

21.04.2006

Author:

Daniel Becker

Field Summary

Fields
Modifier and Type Field and Description

protected int songFlags

Fields
Modifier and Type	Field and Description
`protected int`	`songFlags`

Constructor Summary

Constructors
Modifier Constructor and Description

Module()
Constructor for Module

protected Module(String fileName)
Constructor for Module

Constructors
Modifier	Constructor and Description
	`Module()` Constructor for Module
`protected`	`Module(String fileName)` Constructor for Module

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`allocArrangement(int length)`
`abstract boolean`	`checkLoadingPossible(ModfileInputStream inputStream)` Returns true if the loader thinks this mod can be loaded by him
`void`	`cleanUpArrangement()` Automatically cleans up the arrangement data (if illegal pattnums are in there...)
`abstract boolean`	`doFastSlides()` For s3m this is neccessary!
`int[]`	`getArrangement()`
`int`	`getBaseVolume()`
`int`	`getBPMSpeed()`
`abstract int`	`getChannelVolume(int channel)` Give the channel volume for this channel. 0->64
`abstract String[]`	`getFileExtensionList()` Retrieve the file extension list this loader/player is used for
`String`	`getFileName()`
`abstract int`	`getFrequencyTable()` Return 0: Amiga Mod Frequencytable (like mod, s3m, nst, wow...)
`InstrumentsContainer`	`getInstrumentContainer()`
`String`	`getModID()`
`abstract BasicModMixer`	`getModMixer(int sampleRate, int doISP, int doNoLoops)`
`int`	`getModType()`
`int`	`getNChannels()`
`protected abstract Module`	`getNewInstance(String fileName)` Create an Instance of your own - is used by loadModFile before loadModFileInternal is called
`int`	`getNInstruments()`
`int`	`getNPattern()`
`int`	`getNSamples()`
`abstract int`	`getPanningValue(int channel)` Give panning value 0..256 (128 is center)
`PatternContainer`	`getPatternContainer()`
`int`	`getSongFlags()`
`int`	`getSongLength()`
`String`	`getSongName()`
`int`	`getTempo()`
`String`	`getTrackerName()`
`boolean`	`isArrangementPositionPlayed(int position)`
`Module`	`loadModFile(File file)` Loads a Module.
`Module`	`loadModFile(ModfileInputStream inputStream)`
`Module`	`loadModFile(String fileName)` Loads a Module.
`Module`	`loadModFile(URL url)`
`protected abstract void`	`loadModFileInternal(ModfileInputStream inputStream)`
`protected void`	`readSampleData(Sample current, int flags, ModfileInputStream inputStream)` Loads samples
`void`	`resetLoopRecognition()`
`void`	`setArrangement(int[] arrangement)`
`void`	`setArrangementPositionPlayed(int position)`
`protected void`	`setBaseVolume(int baseVolume)`
`protected void`	`setBPMSpeed(int speed)`
`protected void`	`setInstrumentContainer(InstrumentsContainer instrumentContainer)`
`protected void`	`setModID(String modID)`
`protected void`	`setModType(int modType)`
`protected void`	`setNChannels(int channels)`
`protected void`	`setNInstruments(int instruments)`
`protected void`	`setNPattern(int pattern)`
`protected void`	`setNSamples(int samples)`
`protected void`	`setPatternContainer(PatternContainer patternContainer)`
`protected void`	`setSongFlags(int songFlags)`
`protected void`	`setSongLength(int songLength)`
`protected void`	`setSongName(String songName)`
`protected void`	`setTempo(int tempo)`
`protected void`	`setTrackerName(String trackerName)`
`String`	`toShortInfoString()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - songFlags
```
protected int songFlags
```
- Constructor Detail
  - Module
```
public Module()
```
    Constructor for Module
  - Module
```
protected Module(String fileName)
```
    Constructor for Module
- Method Detail
  - loadModFile
```
public Module loadModFile(String fileName)
                   throws IOException
```
    Loads a Module. This Method will delegate the task to loadModFile(InputStream)
    
    Parameters:
    fileName -
    
    Returns:
    
    Throws:
    
    IOException
  - loadModFile
```
public Module loadModFile(File file)
                   throws IOException
```
    Loads a Module. This Method will delegate the task to loadModFile(URL)
    
    Parameters:
    file -
    
    Returns:
    
    Throws:
    
    IOException
  - loadModFile
```
public Module loadModFile(URL url)
                   throws IOException
```
    Parameters:
    url -
    
    Returns:
    
    Throws:
    
    IOException
    Since:
    
    12.10.2007
  - loadModFile
```
public Module loadModFile(ModfileInputStream inputStream)
                   throws IOException
```
    Parameters:
    inputStream -
    
    Returns:
    
    Throws:
    
    IOException
    Since:
    
    31.12.2007
  - checkLoadingPossible
```
public abstract boolean checkLoadingPossible(ModfileInputStream inputStream)
                                      throws IOException
```
    Returns true if the loader thinks this mod can be loaded by him
    
    Parameters:
    inputStream -
    
    Returns:
    
    Throws:
    
    IOException
    Since:
    
    10.01.2010
  - getNewInstance
```
protected abstract Module getNewInstance(String fileName)
```
    Create an Instance of your own - is used by loadModFile before loadModFileInternal is called
    
    Returns:
    Since:
    
    10.01.2010
  - loadModFileInternal
```
protected abstract void loadModFileInternal(ModfileInputStream inputStream)
                                     throws IOException
```
    Parameters:
    inputStream -
    
    Throws:
    
    IOException
    Since:
    
    31.12.2007
  - getModMixer
```
public abstract BasicModMixer getModMixer(int sampleRate,
                        int doISP,
                        int doNoLoops)
```
    Returns:
    Returns the mixer.
  - getFileExtensionList
```
public abstract String[] getFileExtensionList()
```
    Retrieve the file extension list this loader/player is used for
  - getPanningValue
```
public abstract int getPanningValue(int channel)
```
    Give panning value 0..256 (128 is center)
    
    Parameters:
    channel -
    
    Returns:
  - getChannelVolume
```
public abstract int getChannelVolume(int channel)
```
    Give the channel volume for this channel. 0->64
    
    Parameters:
    channel -
    
    Returns:
    Since:
    
    25.06.2006
  - getFrequencyTable
```
public abstract int getFrequencyTable()
```
    Return 0: Amiga Mod Frequencytable (like mod, s3m, nst, wow...) Return 1: XM IT AmigaMod Table Return 2: XM IT Linear Frequency Table
    
    Returns:
  - doFastSlides
```
public abstract boolean doFastSlides()
```
    For s3m this is neccessary!
    
    Returns:
  - toShortInfoString
```
public String toShortInfoString()
```
    Returns:
    Since:
    
    29.03.2010
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    Returns:
    See Also:
    Object.toString()
  - allocArrangement
```
protected void allocArrangement(int length)
```
  - getArrangement
```
public int[] getArrangement()
```
    Returns:
    Returns the arrangement.
  - setArrangement
```
public void setArrangement(int[] arrangement)
```
    Parameters:
    arrangement - The arrangement to set.
  - cleanUpArrangement
```
public void cleanUpArrangement()
```
    Automatically cleans up the arrangement data (if illegal pattnums are in there...)
    
    Since:
    
    03.10.2010
  - resetLoopRecognition
```
public void resetLoopRecognition()
```
  - isArrangementPositionPlayed
```
public boolean isArrangementPositionPlayed(int position)
```
  - setArrangementPositionPlayed
```
public void setArrangementPositionPlayed(int position)
```
  - getBPMSpeed
```
public int getBPMSpeed()
```
    Returns:
    Returns the bPMSpeed.
  - setBPMSpeed
```
protected void setBPMSpeed(int speed)
```
    Parameters:
    speed - The bPMSpeed to set.
  - getInstrumentContainer
```
public InstrumentsContainer getInstrumentContainer()
```
    Returns:
    Returns the instruments.
  - setInstrumentContainer
```
protected void setInstrumentContainer(InstrumentsContainer instrumentContainer)
```
    Parameters:
    instruments - The instruments to set.
  - getNChannels
```
public int getNChannels()
```
    Returns:
    Returns the nChannels.
  - setNChannels
```
protected void setNChannels(int channels)
```
    Parameters:
    channels - The nChannels to set.
  - getNPattern
```
public int getNPattern()
```
    Returns:
    Returns the nPattern.
  - setNPattern
```
protected void setNPattern(int pattern)
```
    Parameters:
    pattern - The nPattern to set.
  - getNInstruments
```
public int getNInstruments()
```
    Returns:
    Returns the nInstruments.
  - setNInstruments
```
protected void setNInstruments(int instruments)
```
    Parameters:
    samples - The nInstruments to set.
  - getNSamples
```
public int getNSamples()
```
    Returns:
    Returns the nSamples.
  - setNSamples
```
protected void setNSamples(int samples)
```
    Parameters:
    samples - The nSamples to set.
  - getSongLength
```
public int getSongLength()
```
    Returns:
    Returns the songLength.
  - setSongLength
```
protected void setSongLength(int songLength)
```
    Parameters:
    songLength - The songLength to set.
  - getSongName
```
public String getSongName()
```
    Returns:
    Returns the songName.
  - setSongName
```
protected void setSongName(String songName)
```
    Parameters:
    songName - The songName to set.
  - getTempo
```
public int getTempo()
```
    Returns:
    Returns the tempo.
  - setTempo
```
protected void setTempo(int tempo)
```
    Parameters:
    tempo - The tempo to set.
  - getTrackerName
```
public String getTrackerName()
```
    Returns:
    Returns the trackerName.
  - setTrackerName
```
protected void setTrackerName(String trackerName)
```
    Parameters:
    trackerName - The trackerName to set.
  - getPatternContainer
```
public PatternContainer getPatternContainer()
```
    Returns:
    Returns the patternContainer.
  - setPatternContainer
```
protected void setPatternContainer(PatternContainer patternContainer)
```
    Parameters:
    patternContainer - The patternContainer to set.
  - getFileName
```
public String getFileName()
```
    Returns:
    the fileName
  - getModID
```
public String getModID()
```
    Returns:
    Returns the modID.
  - setModID
```
protected void setModID(String modID)
```
    Parameters:
    modID - The modID to set.
  - getBaseVolume
```
public int getBaseVolume()
```
    Returns:
    Returns the baseVolume.
  - setBaseVolume
```
protected void setBaseVolume(int baseVolume)
```
    Parameters:
    baseVolume - The baseVolume to set.
  - getSongFlags
```
public int getSongFlags()
```
    Returns:
    the songFlags
  - setSongFlags
```
protected void setSongFlags(int songFlags)
```
    Parameters:
    songFlags - the songFlags to set
  - getModType
```
public int getModType()
```
    Returns:
    Returns the modType.
  - setModType
```
protected void setModType(int modType)
```
    Parameters:
    modType - The modType to set.
  - readSampleData
```
protected void readSampleData(Sample current,
                  int flags,
                  ModfileInputStream inputStream)
                       throws IOException
```
    Loads samples
    
    Parameters:
    current -
    flags -
    input -
    offset -
    
    Throws:
    
    IOException
    Since:
    
    03.11.2007

Class Module

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

songFlags

Constructor Detail

Module

Module

Method Detail

loadModFile

loadModFile

loadModFile

loadModFile

checkLoadingPossible

getNewInstance

loadModFileInternal

getModMixer

getFileExtensionList

getPanningValue

getChannelVolume

getFrequencyTable

doFastSlides

toShortInfoString

toString

allocArrangement

getArrangement

setArrangement

cleanUpArrangement

resetLoopRecognition

isArrangementPositionPlayed

setArrangementPositionPlayed

getBPMSpeed

setBPMSpeed

getInstrumentContainer

setInstrumentContainer

getNChannels

setNChannels

getNPattern

setNPattern

getNInstruments

setNInstruments

getNSamples

setNSamples

getSongLength

setSongLength

getSongName

setSongName

getTempo

setTempo

getTrackerName

setTrackerName

getPatternContainer

setPatternContainer

getFileName

getModID

setModID

getBaseVolume

setBaseVolume

getSongFlags

setSongFlags

getModType

setModType

readSampleData