1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
/* * @(#)Sequence.java 1.28 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.sound.midi; import java.util.Vector; import com.sun.media.sound.MidiUtils; /** * A <code>Sequence</code> is a data structure containing musical * information (often an entire song or composition) that can be played * back by a <code>{@link Sequencer}</code> object. Specifically, the * <code>Sequence</code> contains timing * information and one or more tracks. Each <code>{@link Track track}</code> consists of a * series of MIDI events (such as note-ons, note-offs, program changes, and meta-events). * The sequence's timing information specifies the type of unit that is used * to time-stamp the events in the sequence. * <p> * A <code>Sequence</code> can be created from a MIDI file by reading the file * into an input stream and invoking one of the <code>getSequence</code> methods of * {@link MidiSystem}. A sequence can also be built from scratch by adding new * <code>Tracks</code> to an empty <code>Sequence</code>, and adding * <code>{@link MidiEvent}</code> objects to these <code>Tracks</code>. * * @see Sequencer#setSequence(java.io.InputStream stream) * @see Sequencer#setSequence(Sequence sequence) * @see Track#add(MidiEvent) * @see MidiFileFormat * * @version 1.28, 05/11/17 * @author Kara Kytle */ public class Sequence { // Timing types /** * The tempo-based timing type, for which the resolution is expressed in pulses (ticks) per quarter note. * @see #Sequence(float, int) */ public static final float PPQ = 0.0f; /** * The SMPTE-based timing type with 24 frames per second (resolution is expressed in ticks per frame). * @see #Sequence(float, int) */ public static final float SMPTE_24 = 24.0f; /** * The SMPTE-based timing type with 25 frames per second (resolution is expressed in ticks per frame). * @see #Sequence(float, int) */ public static final float SMPTE_25 = 25.0f; /** * The SMPTE-based timing type with 29.97 frames per second (resolution is expressed in ticks per frame). * @see #Sequence(float, int) */ public static final float SMPTE_30DROP = 29.97f; /** * The SMPTE-based timing type with 30 frames per second (resolution is expressed in ticks per frame). * @see #Sequence(float, int) */ public static final float SMPTE_30 = 30.0f; // Variables /** * The timing division type of the sequence. * @see #PPQ * @see #SMPTE_24 * @see #SMPTE_25 * @see #SMPTE_30DROP * @see #SMPTE_30 * @see #getDivisionType */ protected float divisionType; /** * The timing resolution of the sequence. * @see #getResolution */ protected int resolution; /** * The MIDI tracks in this sequence. * @see #getTracks */ protected Vector<Track> tracks = new Vector<Track>(); /** * Constructs a new MIDI sequence with the specified timing division * type and timing resolution. The division type must be one of the * recognized MIDI timing types. For tempo-based timing, * <code>divisionType</code> is PPQ (pulses per quarter note) and * the resolution is specified in ticks per beat. For SMTPE timing, * <code>divisionType</code> specifies the number of frames per * second and the resolution is specified in ticks per frame. * The sequence will contain no initial tracks. Tracks may be * added to or removed from the sequence using <code>{@link #createTrack}</code> * and <code>{@link #deleteTrack}</code>. * * @param divisionType the timing division type (PPQ or one of the SMPTE types) * @param resolution the timing resolution * @throws InvalidMidiDataException if <code>divisionType</code> is not valid * * @see #PPQ * @see #SMPTE_24 * @see #SMPTE_25 * @see #SMPTE_30DROP * @see #SMPTE_30 * @see #getDivisionType * @see #getResolution * @see #getTracks */ public Sequence(float divisionType, int resolution) throws InvalidMidiDataException { if (divisionType == PPQ) this.divisionType = PPQ; else if (divisionType == SMPTE_24) this.divisionType = SMPTE_24; else if (divisionType == SMPTE_25) this.divisionType = SMPTE_25; else if (divisionType == SMPTE_30DROP) this.divisionType = SMPTE_30DROP; else if (divisionType == SMPTE_30) this.divisionType = SMPTE_30; else throw new InvalidMidiDataException("Unsupported division type: " + divisionType); this.resolution = resolution; } /** * Constructs a new MIDI sequence with the specified timing division * type, timing resolution, and number of tracks. The division type must be one of the * recognized MIDI timing types. For tempo-based timing, * <code>divisionType</code> is PPQ (pulses per quarter note) and * the resolution is specified in ticks per beat. For SMTPE timing, * <code>divisionType</code> specifies the number of frames per * second and the resolution is specified in ticks per frame. * The sequence will be initialized with the number of tracks specified by * <code>numTracks</code>. These tracks are initially empty (i.e. * they contain only the meta-event End of Track). * The tracks may be retrieved for editing using the <code>{@link #getTracks}</code> * method. Additional tracks may be added, or existing tracks removed, * using <code>{@link #createTrack}</code> and <code>{@link #deleteTrack}</code>. * * @param divisionType the timing division type (PPQ or one of the SMPTE types) * @param resolution the timing resolution * @param numTracks the initial number of tracks in the sequence. * @throws InvalidMidiDataException if <code>divisionType</code> is not valid * * @see #PPQ * @see #SMPTE_24 * @see #SMPTE_25 * @see #SMPTE_30DROP * @see #SMPTE_30 * @see #getDivisionType * @see #getResolution */ public Sequence(float divisionType, int resolution, int numTracks) throws InvalidMidiDataException { if (divisionType == PPQ) this.divisionType = PPQ; else if (divisionType == SMPTE_24) this.divisionType = SMPTE_24; else if (divisionType == SMPTE_25) this.divisionType = SMPTE_25; else if (divisionType == SMPTE_30DROP) this.divisionType = SMPTE_30DROP; else if (divisionType == SMPTE_30) this.divisionType = SMPTE_30; else throw new InvalidMidiDataException("Unsupported division type: " + divisionType); this.resolution = resolution; for (int i = 0; i < numTracks; i++) { tracks.addElement(new Track()); } } /** * Obtains the timing division type for this sequence. * @return the division type (PPQ or one of the SMPTE types) * * @see #PPQ * @see #SMPTE_24 * @see #SMPTE_25 * @see #SMPTE_30DROP * @see #SMPTE_30 * @see #Sequence(float, int) * @see MidiFileFormat#getDivisionType() */ public float getDivisionType() { return divisionType; } /** * Obtains the timing resolution for this sequence. * If the sequence's division type is PPQ, the resolution is specified in ticks per beat. * For SMTPE timing, the resolution is specified in ticks per frame. * * @return the number of ticks per beat (PPQ) or per frame (SMPTE) * @see #getDivisionType * @see #Sequence(float, int) * @see MidiFileFormat#getResolution() */ public int getResolution() { return resolution; } /** * Creates a new, initially empty track as part of this sequence. * The track initially contains the meta-event End of Track. * The newly created track is returned. All tracks in the sequence * may be retrieved using <code>{@link #getTracks}</code>. Tracks may be * removed from the sequence using <code>{@link #deleteTrack}</code>. * @return the newly created track */ public Track createTrack() { Track track = new Track(); tracks.addElement(track); return track; } /** * Removes the specified track from the sequence. * @param track the track to remove * @return <code>true</code> if the track existed in the track and was removed, * otherwise <code>false</code>. * * @see #createTrack * @see #getTracks */ public boolean deleteTrack(Track track) { synchronized(tracks) { return tracks.removeElement(track); } } /** * Obtains an array containing all the tracks in this sequence. * If the sequence contains no tracks, an array of length 0 is returned. * @return the array of tracks * * @see #createTrack * @see #deleteTrack */ public Track[] getTracks() { return (Track[]) tracks.toArray(new Track[tracks.size()]); } /** * Obtains the duration of this sequence, expressed in microseconds. * @return this sequence's duration in microseconds. */ public long getMicrosecondLength() { return com.sun.media.sound.MidiUtils.tick2microsecond(this, getTickLength(), null); } /** * Obtains the duration of this sequence, expressed in MIDI ticks. * * @return this sequence's length in ticks * * @see #getMicrosecondLength */ public long getTickLength() { long length = 0; synchronized(tracks) { for(int i=0; i<tracks.size(); i++ ) { long temp = ((Track)tracks.elementAt(i)).ticks(); if( temp>length ) { length = temp; } } return length; } } /** * Obtains a list of patches referenced in this sequence. * This patch list may be used to load the required * <code>{@link Instrument}</code> objects * into a <code>{@link Synthesizer}</code>. * * @return an array of <code>{@link Patch}</code> objects used in this sequence * * @see Synthesizer#loadInstruments(Soundbank, Patch[]) */ public Patch[] getPatchList() { // $$kk: 04.09.99: need to implement!! return new Patch[0]; } }