X-Git-Url: https://ruin.nu/git/?a=blobdiff_plain;f=MooNote.java;h=fb73341e327f969ff51a50c23fbc5387d9f36b2b;hb=4526e51b70110f7272b0c2a3a5f207657d690029;hp=12e12386cd94e74f597d04a92cf56de65e6dc48e;hpb=dc7477835f6d61c4235b7fbe36f97fec553e2f81;p=moosique.git

diff --git a/MooNote.java b/MooNote.java
index 12e1238..fb73341 100644
--- a/MooNote.java
+++ b/MooNote.java
@@ -1,27 +1,18 @@
 import javax.sound.midi.*;
 
-/*
- * Functional representation of a MIDI note, which contains two MIDI events, note on and note off.
+/**
+ * Functional representation of a MIDI note, which adds functionality to the existent MidiEvent class.
+ * Also provides a reference to the corresponding NoteOff event.
  * 
- * @author  Andersson, Andreen, Lanneskog, Pehrson
- * @version 2.0
+ * @author  Einar Pehrson
  */
  
-public class MooNote extends MidiEvent {
+public class MooNote extends MidiEvent implements Cloneable, Comparable {
 
 	private MidiEvent noteOffEvent;
 	private ShortMessage noteOnMsg, noteOffMsg;
 
-	/* 
-	 * Creates a MooNote from the given NoteOn event in the current track.
-	 * @param noteOnEvent	the NoteOn event of the note
-	 */
-	public MooNote (MidiEvent noteOnEvent) {
-		super(noteOnEvent.getMessage(), noteOnEvent.getTick());
-		noteOnMsg = (ShortMessage)getMessage();
-	}
-
-	/* 
+	/** 
 	 * Creates a MooNote from the given NoteOn event in the current track and creates a reference to
 	 * the corresponding NoteOff event.
 	 * @param noteOnEvent	the NoteOn event of the note
@@ -29,21 +20,20 @@ public class MooNote extends MidiEvent {
 	 */
 	public MooNote (MidiEvent noteOnEvent, MidiEvent noteOffEvent) {
 		super(noteOnEvent.getMessage(), noteOnEvent.getTick());
-		noteOffEvent = new MidiEvent(noteOffEvent.getMessage(), noteOffEvent.getTick());
+		this.noteOffEvent = noteOffEvent;
 		noteOnMsg = (ShortMessage)getMessage();
 		noteOffMsg = (ShortMessage)noteOffEvent.getMessage();
 	}
 
-	/* 
+	/** 
 	 * Creates a MooNote of the given pitch, velocity and duration in the current track.
-	 * @param track		the track to which the MooNote was added
 	 * @param channel	the channel of the note (1-16)
 	 * @param pitch		the pitch of the note (0-127)
 	 * @param velocity	the velocity of the note (0-127)
 	 * @param timestamp	the timestamp of the note in ticks (96 per beat)
 	 * @param duration	the duration of the note in ticks (96 per beat)
 	 */
-	public MooNote (int track, int channel, int pitch, int velocity, long timestamp, int duration) {
+	public MooNote (int channel, int pitch, int velocity, long timestamp, int duration) {
 		super(new ShortMessage(), timestamp);
 		noteOffEvent = new MidiEvent(new ShortMessage(), timestamp + duration);
 		noteOnMsg = (ShortMessage)getMessage();
@@ -51,10 +41,10 @@ public class MooNote extends MidiEvent {
 		try {
 			noteOnMsg.setMessage(ShortMessage.NOTE_ON, channel, pitch, velocity);
 			noteOffMsg.setMessage(ShortMessage.NOTE_OFF, channel, pitch, 0);
-		} catch (InvalidMidiDataException e) {}
+		} catch (InvalidMidiDataException e) {System.out.println("Invalid data!");}
 	}
 
-	/* 
+	/** 
 	 * Sets the channel of the current note.
 	 * @param channel	the channel of the note (1-16)
 	 */
@@ -65,7 +55,7 @@ public class MooNote extends MidiEvent {
 		} catch (InvalidMidiDataException e) {}
 	}
 
-	/* 
+	/** 
 	 * Sets the pitch of the current note.
 	 * @param pitch		the pitch of the note (0-127)
 	 */
@@ -76,7 +66,7 @@ public class MooNote extends MidiEvent {
 		} catch (InvalidMidiDataException e) {}
 	}
 
-	/* 
+	/** 
 	 * Sets the velocity of the current note.
 	 * @param vel	the velocity of the note (0-127)
 	 */
@@ -87,24 +77,32 @@ public class MooNote extends MidiEvent {
 		} catch (InvalidMidiDataException e) {}
 	}
 
-	/* 
+	/** 
 	 * Sets the duration of the current note (or rather moves the note off event).
 	 * @param n	the duration of the note in ticks (96 per beat)
 	 */
 	public void setDuration(int ticks) {
-		if (hasNoteOffEvent()) noteOffEvent.setTick(getTick() + ticks);
+		noteOffEvent.setTick(getTick() + ticks);
 	}
 
-	/* 
+	/** 
 	 * Sets the timestamp of the current note.
 	 * @param tick	the timestamp of the note in ticks (96 per beat)
 	 */
 	public void setTick(long tick) {
-		if (hasNoteOffEvent()) noteOffEvent.setTick(tick +  getDuration());
+		noteOffEvent.setTick(tick + getDuration());
 		super.setTick(tick);
 	}
 
-	/* 
+	/** 
+	 * Transposes the current note the given number of halftones.
+	 * @param halftones	the number of halftones to transpose - positive for up, negative for down
+	 */
+	public void transpose(int halftones) {
+		setPitch(getPitch() + halftones);
+	}
+
+	/** 
 	 * Returns the channel of the current note.
 	 * @return the channel of the note (1-16)
 	 */
@@ -112,7 +110,7 @@ public class MooNote extends MidiEvent {
 		return noteOnMsg.getChannel();
 	}
 
-	/* 
+	/** 
 	 * Returns the pitch of the current note.
 	 * @return the pitch of the note (0-127)
 	 */
@@ -120,7 +118,7 @@ public class MooNote extends MidiEvent {
 		return noteOnMsg.getData1();
 	}
 
-	/* 
+	/** 
 	 * Returns the velocity of the current note.
 	 * @return the velocity of the note (0-127)
 	 */
@@ -128,20 +126,48 @@ public class MooNote extends MidiEvent {
 		return noteOnMsg.getData2();
 	}
 
-	/* 
+	/** 
 	 * Returns the duration of the current note.
 	 * @return the duration of the note (in ticks)
 	 */
 	public int getDuration() {
-		if (!hasNoteOffEvent()) return 0;
-		return (int)(getTick() - noteOffEvent.getTick());
+		return (int)(noteOffEvent.getTick() - getTick());
 	}
 
-	/* 
-	 * Returns whether the NoteOff event was found.
-	 * @return	the note off MidiEvent
+	/**
+	 * Adds this note (both noteOn and noteOffEvents) to a track.
+	 * @param track the track it'll be added to.
 	 */
-	public boolean hasNoteOffEvent() {
-		return noteOffEvent == null;
+	public void addTo(Track track) {
+		track.add(this);
+		track.add(noteOffEvent);
 	}
-}
\ No newline at end of file
+	
+	/**
+	 * Removes this note (both noteOn and noteOffEvents) from a track.
+	 * @param track the track it'll be removed from.
+	 */
+	public void removeFrom(Track track) {
+		track.remove(this);
+		track.remove(noteOffEvent);
+	}
+
+	/**
+	 * Returns a clone of this note.
+	 */
+	public Object clone() {
+		return new MooNote(
+			new MidiEvent((ShortMessage)getMessage().clone(), getTick()), 
+			new MidiEvent((ShortMessage)noteOffEvent.getMessage().clone(), noteOffEvent.getTick())
+		);
+	}
+
+	/** 
+	 * Compares this note to another note.
+	 * @return a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object
+	 */
+	public int compareTo(Object o) {
+		return (int)(((MidiEvent)o).getTick() - getTick());
+	}
+
+}