Class MUS

java.lang.Object

net.mtrop.doom.sound.MUS

All Implemented Interfaces:

Iterable<MUS.Event>, BinaryObject

public class MUS
extends Object
implements BinaryObject, Iterable<MUS.Event>

Abstraction of MUS formatted music sequence data.

Author:

Matthew Tropiano

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MUS.ControllerChangeEvent	Controller Change event.
static class	MUS.Event	Individual events.
static class	MUS.NotePlayEvent	Note play event.
static class	MUS.NoteReleaseEvent	Note release event.
static class	MUS.PitchEvent	Pitch wheel event.
static class	MUS.ScoreEndEvent	Score ending event.
class	MUS.Sequencer	A MUS Player sequencer.
static interface	MUS.SequencerListener	A listener for the player.
static class	MUS.SystemEvent	System event.

Nested classes/interfaces inherited from interface net.mtrop.doom.object.BinaryObject

BinaryObject.InlineScanner<BO extends BinaryObject>, BinaryObject.Reflect, BinaryObject.Scanner<BO extends BinaryObject>, BinaryObject.Shared, BinaryObject.Transformer<BO extends BinaryObject>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CHANNEL_DRUM
static final String[]	CONTROLLER_NAME
static final String[]	DRUM_INSTRUMENT_NAME
static final String[]	INSTRUMENT_NAME
static final byte[]	MUS_ID
static final String[]	NOTE_NAMES
static final String[]	SYSTEM_EVENT_NAME

Constructor Summary

Constructors

Constructor	Description
MUS()	Creates a blank MUS lump with no events.

Method Summary

Modifier and Type	Method	Description
int	getInstrumentPatch(int index)	Gets an instrument patch to preload.
int	getInstrumentPatchCount()
int	getPrimaryChannelCount()
int	getSecondaryChannelCount()
MUS.Sequencer	getSequencer(MUS.SequencerListener listener)	Gets a new sequencer object for playing through an MUS's event sequence, tic by tic.
Iterator<MUS.Event>	iterator()
void	readBytes(InputStream in)	Reads from an InputStream and sets this object's fields.
void	writeBytes(OutputStream out)	Writes this object to an OutputStream.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.mtrop.doom.object.BinaryObject

fromBytes, readFile, toBytes, writeFile, writeFile

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

MUS_ID

public static final byte[] MUS_ID

NOTE_NAMES

public static final String[] NOTE_NAMES

SYSTEM_EVENT_NAME

public static final String[] SYSTEM_EVENT_NAME

CONTROLLER_NAME

public static final String[] CONTROLLER_NAME

INSTRUMENT_NAME

public static final String[] INSTRUMENT_NAME

DRUM_INSTRUMENT_NAME

public static final String[] DRUM_INSTRUMENT_NAME

CHANNEL_DRUM

public static final int CHANNEL_DRUM

See Also:

• Constant Field Values

Constructor Details

MUS

public MUS()

Creates a blank MUS lump with no events.

Method Details

getPrimaryChannelCount

public int getPrimaryChannelCount()

Returns:

the amount of primary channels (from channel 0).

getSecondaryChannelCount

public int getSecondaryChannelCount()

Returns:

the amount of secondary channels (from channel 10).

getInstrumentPatchCount

public int getInstrumentPatchCount()

Returns:

the amount of instrument patches.

getInstrumentPatch

public int getInstrumentPatch(int index)

Gets an instrument patch to preload.

Parameters:

index - the instrument patch list index.

Returns:

the instrument at the corresponding index.

Throws:

ArrayIndexOutOfBoundsException - of index is < 0 or > getInstrumentPatchCount().

getSequencer

public MUS.Sequencer getSequencer(MUS.SequencerListener listener)

Gets a new sequencer object for playing through an MUS's event sequence, tic by tic.

Parameters:

listener - the listener to emit events to per tic.

Returns:

a new Sequencer.

See Also:

• MUS.Sequencer

iterator

public Iterator<MUS.Event> iterator()

Specified by:

iterator in interface Iterable<MUS.Event>

readBytes

public void readBytes(InputStream in)
               throws IOException

Description copied from interface: BinaryObject

Reads from an InputStream and sets this object's fields. Only reads the amount of bytes that it takes to read a single instance of the object. Note that not every object may have a consistent length!

Specified by:

readBytes in interface BinaryObject

Parameters:

in - the InputStream to read from.

Throws:

IOException - if a read error occurs.

writeBytes

public void writeBytes(OutputStream out)
                throws IOException

Description copied from interface: BinaryObject

Writes this object to an OutputStream.

Specified by:

writeBytes in interface BinaryObject

Parameters:

out - the OutputStream to write to.

Throws:

IOException - if a write error occurs.