com.skratchdot.electribe.model.esx

Interface EsxFile

All Known Implementing Classes:

EsxFileImpl

public interface EsxFile

A representation of the model object 'File'.

Esx File Format:

Address (start)	Address (end)	Total Size	Notes
0x00000000	0x00000020	32 bytes	32 unknown bytes starting with: K O R G . . . 0x71 E S X
0x00000020	0x000000E0	192 bytes	See GlobalParameters
0x000000E0	0x00000200	288 bytes	Unknown / Reserved Bytes
0x00000200	0x0010BA00	1,095,680 bytes	256 patterns at 4280 bytes each See Pattern
0x0010BA00	0x00130000	148,992 bytes	Unknown / Reserved Bytes
0x00130000	0x00138400	33,792 bytes	64 songs at 528 bytes each See Song
0x00138400	0x0015F500	160,000 bytes	Up to 20000 song events at 8 bytes each See SongEvent
0x0015F500	0x001B0000	330,496 Bytes	Unknown / Reserved Bytes
0x001B0000	0x001B0020	32 bytes	32 unknown bytes starting with: K O R G . . . 0x71 B P S
0x001B0020	0x001B0024	4 bytes	Number of mono samples being used
0x001B0024	0x001B0028	4 bytes	Number of stereo samples being used
0x001B0028	0x001B002C	4 bytes	Current Sample Offset
0x001B002C	0x001B0100	212 bytes	Unknown / Reserved Bytes
0x001B0100	0x001B2900	10,240 bytes	256 mono sample headers at 40 bytes each See Sample See initHeaderMono
0x001B2900	0x001B3F00	5,632 bytes	128 stereo sample headers at 44 bytes each See Sample See initHeaderStereo
0x001B3F00	0x001B4200	768 bytes	Unknown / Reserve Bytes
0x001B4200	0x00250000	524,288 bytes	Slice Data: 256 slices at 2048 bytes each See Slice Array
0x00250000	0x01A50010	25,165,824 bytes (max)	Sample Data

The following features are supported:

• Original Non Audio Data
• Global Parameters
• Patterns
• Songs
• Samples
• Empty Pattern
• Empty Song
• Max Sample Offset
• Mem Used In Bytes
• Mem Used In Seconds
• Mem Free In Bytes
• Mem Free In Seconds
• Num Patterns Empty
• Num Patterns Not Empty
• Num Samples Empty
• Num Samples Not Empty
• Num Samples Mono Empty
• Num Samples Mono Not Empty
• Num Samples Stereo Empty
• Num Samples Stereo Not Empty
• Num Songs Empty
• Num Songs Not Empty
• Sync Patterns On Move Enabled
• Sync Samples On Move Enabled

See Also:

EsxPackage.getEsxFile()

Method Summary

Methods

Modifier and Type	Method and Description
Pattern	getEmptyPattern() Returns the value of the 'Empty Pattern' containment reference.
Song	getEmptySong() Returns the value of the 'Empty Song' containment reference.
GlobalParameters	getGlobalParameters() Returns the value of the 'Global Parameters' containment reference.
int	getMaxSampleOffset() Returns the value of the 'Max Sample Offset' attribute.
int	getMemFreeInBytes() Returns the value of the 'Mem Free In Bytes' attribute.
float	getMemFreeInSeconds() Returns the value of the 'Mem Free In Seconds' attribute.
int	getMemUsedInBytes() Returns the value of the 'Mem Used In Bytes' attribute.
float	getMemUsedInSeconds() Returns the value of the 'Mem Used In Seconds' attribute.
int	getNumPatternsEmpty() Returns the value of the 'Num Patterns Empty' attribute.
int	getNumPatternsNotEmpty() Returns the value of the 'Num Patterns Not Empty' attribute.
int	getNumSamplesEmpty() Returns the value of the 'Num Samples Empty' attribute.
int	getNumSamplesMonoEmpty() Returns the value of the 'Num Samples Mono Empty' attribute.
int	getNumSamplesMonoNotEmpty() Returns the value of the 'Num Samples Mono Not Empty' attribute.
int	getNumSamplesNotEmpty() Returns the value of the 'Num Samples Not Empty' attribute.
int	getNumSamplesStereoEmpty() Returns the value of the 'Num Samples Stereo Empty' attribute.
int	getNumSamplesStereoNotEmpty() Returns the value of the 'Num Samples Stereo Not Empty' attribute.
int	getNumSongsEmpty() Returns the value of the 'Num Songs Empty' attribute.
int	getNumSongsNotEmpty() Returns the value of the 'Num Songs Not Empty' attribute.
byte[]	getOriginalNonAudioData() Returns the value of the 'Original Non Audio Data' attribute.
Pattern	getPatternFromPointer(int patternPointer)
	getPatterns() Returns the value of the 'Patterns' containment reference list.
Sample	getSampleFromPointer(int samplePointer)
	getSamples() Returns the value of the 'Samples' containment reference list.
	getSongs() Returns the value of the 'Songs' containment reference list.
void	init(byte[] b)
void	init(byte[] b, IProgressMonitor monitor)
boolean	isSyncPatternsOnMoveEnabled() Returns the value of the 'Sync Patterns On Move Enabled' attribute.
boolean	isSyncSamplesOnMoveEnabled() Returns the value of the 'Sync Samples On Move Enabled' attribute.
void	setAllOffsets()
void	setEmptyPattern(Pattern value) Sets the value of the 'Empty Pattern' containment reference.
void	setEmptySong(Song value) Sets the value of the 'Empty Song' containment reference.
void	setGlobalParameters(GlobalParameters value) Sets the value of the 'Global Parameters' containment reference.
void	setMaxSampleOffset(int value) Sets the value of the 'Max Sample Offset' attribute.
void	setOriginalNonAudioData(byte[] value) Sets the value of the 'Original Non Audio Data' attribute.
void	setSyncPatternsOnMoveEnabled(boolean value) Sets the value of the 'Sync Patterns On Move Enabled' attribute.
void	setSyncSamplesOnMoveEnabled(boolean value) Sets the value of the 'Sync Samples On Move Enabled' attribute.
byte[]	toByteArray()
byte[]	toByteArray(IProgressMonitor monitor)
boolean	validMemFreeInBytes(DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)

Method Detail

getOriginalNonAudioData

byte[] getOriginalNonAudioData()

Returns the value of the 'Original Non Audio Data' attribute.

If the meaning of the 'Original Non Audio Data' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Original Non Audio Data' attribute.

See Also:

setOriginalNonAudioData(byte[]), EsxPackage.getEsxFile_OriginalNonAudioData()

setOriginalNonAudioData

void setOriginalNonAudioData(byte[] value)

Sets the value of the 'Original Non Audio Data' attribute.

Parameters:

value - the new value of the 'Original Non Audio Data' attribute.

See Also:

getOriginalNonAudioData()

getGlobalParameters

GlobalParameters getGlobalParameters()

Returns the value of the 'Global Parameters' containment reference.

If the meaning of the 'Global Parameters' containment reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Global Parameters' containment reference.

See Also:

setGlobalParameters(GlobalParameters), EsxPackage.getEsxFile_GlobalParameters()

setGlobalParameters

void setGlobalParameters(GlobalParameters value)

Sets the value of the 'Global Parameters' containment reference.

Parameters:

value - the new value of the 'Global Parameters' containment reference.

See Also:

getGlobalParameters()

getPatterns

 getPatterns()

Returns the value of the 'Patterns' containment reference list. The list contents are of type Pattern.

If the meaning of the 'Patterns' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Patterns' containment reference list.

See Also:

EsxPackage.getEsxFile_Patterns()

getSongs

 getSongs()

Returns the value of the 'Songs' containment reference list. The list contents are of type Song.

If the meaning of the 'Songs' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Songs' containment reference list.

See Also:

EsxPackage.getEsxFile_Songs()

getSamples

 getSamples()

Returns the value of the 'Samples' containment reference list. The list contents are of type Sample.

If the meaning of the 'Samples' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Samples' containment reference list.

See Also:

EsxPackage.getEsxFile_Samples()

getEmptyPattern

Pattern getEmptyPattern()

Returns the value of the 'Empty Pattern' containment reference.

If the meaning of the 'Empty Pattern' containment reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Empty Pattern' containment reference.

See Also:

setEmptyPattern(Pattern), EsxPackage.getEsxFile_EmptyPattern()

setEmptyPattern

void setEmptyPattern(Pattern value)

Sets the value of the 'Empty Pattern' containment reference.

Parameters:

value - the new value of the 'Empty Pattern' containment reference.

See Also:

getEmptyPattern()

getEmptySong

Song getEmptySong()

Returns the value of the 'Empty Song' containment reference.

If the meaning of the 'Empty Song' containment reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Empty Song' containment reference.

See Also:

setEmptySong(Song), EsxPackage.getEsxFile_EmptySong()

setEmptySong

void setEmptySong(Song value)

Sets the value of the 'Empty Song' containment reference.

Parameters:

value - the new value of the 'Empty Song' containment reference.

See Also:

getEmptySong()

getMaxSampleOffset

int getMaxSampleOffset()

Returns the value of the 'Max Sample Offset' attribute. The default value is "0".

If the meaning of the 'Max Sample Offset' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Max Sample Offset' attribute.

See Also:

setMaxSampleOffset(int), EsxPackage.getEsxFile_MaxSampleOffset()

setMaxSampleOffset

void setMaxSampleOffset(int value)

Sets the value of the 'Max Sample Offset' attribute.

Parameters:

value - the new value of the 'Max Sample Offset' attribute.

See Also:

getMaxSampleOffset()

getMemUsedInBytes

int getMemUsedInBytes()

Returns the value of the 'Mem Used In Bytes' attribute. The default value is "0".

If the meaning of the 'Mem Used In Bytes' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Mem Used In Bytes' attribute.

See Also:

EsxPackage.getEsxFile_MemUsedInBytes()

getMemUsedInSeconds

float getMemUsedInSeconds()

Returns the value of the 'Mem Used In Seconds' attribute. The default value is "0".

If the meaning of the 'Mem Used In Seconds' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Mem Used In Seconds' attribute.

See Also:

EsxPackage.getEsxFile_MemUsedInSeconds()

getMemFreeInBytes

int getMemFreeInBytes()

Returns the value of the 'Mem Free In Bytes' attribute. The default value is "0".

If the meaning of the 'Mem Free In Bytes' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Mem Free In Bytes' attribute.

See Also:

EsxPackage.getEsxFile_MemFreeInBytes()

getMemFreeInSeconds

float getMemFreeInSeconds()

Returns the value of the 'Mem Free In Seconds' attribute. The default value is "0".

If the meaning of the 'Mem Free In Seconds' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Mem Free In Seconds' attribute.

See Also:

EsxPackage.getEsxFile_MemFreeInSeconds()

getNumPatternsEmpty

int getNumPatternsEmpty()

Returns the value of the 'Num Patterns Empty' attribute. The default value is "0".

If the meaning of the 'Num Patterns Empty' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Num Patterns Empty' attribute.

See Also:

EsxPackage.getEsxFile_NumPatternsEmpty()

getNumPatternsNotEmpty

int getNumPatternsNotEmpty()

Returns the value of the 'Num Patterns Not Empty' attribute. The default value is "0".

If the meaning of the 'Num Patterns Not Empty' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Num Patterns Not Empty' attribute.

See Also:

EsxPackage.getEsxFile_NumPatternsNotEmpty()

getNumSamplesEmpty

int getNumSamplesEmpty()

Returns the value of the 'Num Samples Empty' attribute. The default value is "0".

If the meaning of the 'Num Samples Empty' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Num Samples Empty' attribute.

See Also:

EsxPackage.getEsxFile_NumSamplesEmpty()

getNumSamplesNotEmpty

int getNumSamplesNotEmpty()

Returns the value of the 'Num Samples Not Empty' attribute. The default value is "0".

If the meaning of the 'Num Samples Not Empty' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Num Samples Not Empty' attribute.

See Also:

EsxPackage.getEsxFile_NumSamplesNotEmpty()

getNumSamplesMonoEmpty

int getNumSamplesMonoEmpty()

Returns the value of the 'Num Samples Mono Empty' attribute. The default value is "0".

If the meaning of the 'Num Samples Mono Empty' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Num Samples Mono Empty' attribute.

See Also:

EsxPackage.getEsxFile_NumSamplesMonoEmpty()

getNumSamplesMonoNotEmpty

int getNumSamplesMonoNotEmpty()

Returns the value of the 'Num Samples Mono Not Empty' attribute. The default value is "0".

If the meaning of the 'Num Samples Mono Not Empty' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Num Samples Mono Not Empty' attribute.

See Also:

EsxPackage.getEsxFile_NumSamplesMonoNotEmpty()

getNumSamplesStereoEmpty

int getNumSamplesStereoEmpty()

Returns the value of the 'Num Samples Stereo Empty' attribute. The default value is "0".

If the meaning of the 'Num Samples Stereo Empty' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Num Samples Stereo Empty' attribute.

See Also:

EsxPackage.getEsxFile_NumSamplesStereoEmpty()

getNumSamplesStereoNotEmpty

int getNumSamplesStereoNotEmpty()

Returns the value of the 'Num Samples Stereo Not Empty' attribute. The default value is "0".

If the meaning of the 'Num Samples Stereo Not Empty' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Num Samples Stereo Not Empty' attribute.

See Also:

EsxPackage.getEsxFile_NumSamplesStereoNotEmpty()

getNumSongsEmpty

int getNumSongsEmpty()

Returns the value of the 'Num Songs Empty' attribute. The default value is "0".

If the meaning of the 'Num Songs Empty' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Num Songs Empty' attribute.

See Also:

EsxPackage.getEsxFile_NumSongsEmpty()

getNumSongsNotEmpty

int getNumSongsNotEmpty()

Returns the value of the 'Num Songs Not Empty' attribute. The default value is "0".

If the meaning of the 'Num Songs Not Empty' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Num Songs Not Empty' attribute.

See Also:

EsxPackage.getEsxFile_NumSongsNotEmpty()

isSyncPatternsOnMoveEnabled

boolean isSyncPatternsOnMoveEnabled()

Returns the value of the 'Sync Patterns On Move Enabled' attribute. The default value is "true".

If the meaning of the 'Sync Patterns On Move Enabled' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Sync Patterns On Move Enabled' attribute.

See Also:

setSyncPatternsOnMoveEnabled(boolean), EsxPackage.getEsxFile_SyncPatternsOnMoveEnabled()

setSyncPatternsOnMoveEnabled

void setSyncPatternsOnMoveEnabled(boolean value)

Sets the value of the 'Sync Patterns On Move Enabled' attribute.

Parameters:

value - the new value of the 'Sync Patterns On Move Enabled' attribute.

See Also:

isSyncPatternsOnMoveEnabled()

isSyncSamplesOnMoveEnabled

boolean isSyncSamplesOnMoveEnabled()

Returns the value of the 'Sync Samples On Move Enabled' attribute. The default value is "true".

If the meaning of the 'Sync Samples On Move Enabled' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Sync Samples On Move Enabled' attribute.

See Also:

setSyncSamplesOnMoveEnabled(boolean), EsxPackage.getEsxFile_SyncSamplesOnMoveEnabled()

setSyncSamplesOnMoveEnabled

void setSyncSamplesOnMoveEnabled(boolean value)

Sets the value of the 'Sync Samples On Move Enabled' attribute.

Parameters:

value - the new value of the 'Sync Samples On Move Enabled' attribute.

See Also:

isSyncSamplesOnMoveEnabled()

getPatternFromPointer

Pattern getPatternFromPointer(int patternPointer)

getSampleFromPointer

Sample getSampleFromPointer(int samplePointer)

init

void init(byte[] b)

init

void init(byte[] b,
        IProgressMonitor monitor)

setAllOffsets

void setAllOffsets()

toByteArray

byte[] toByteArray()

toByteArray

byte[] toByteArray(IProgressMonitor monitor)

validMemFreeInBytes

boolean validMemFreeInBytes(DiagnosticChain diagnostics,
                          java.util.Map<java.lang.Object,java.lang.Object> context)