001 /*
002 * Copyright 1999-2002 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package javax.sound.midi.spi;
027
028 import java.io.File;
029 import java.io.InputStream;
030 import java.io.IOException;
031 import java.net.URL;
032
033 import javax.sound.midi.MidiFileFormat;
034 import javax.sound.midi.Sequence;
035 import javax.sound.midi.InvalidMidiDataException;
036
037 /**
038 * A <code>MidiFileReader</code> supplies MIDI file-reading services. Classes implementing this
039 * interface can parse the format information from one or more types of
040 * MIDI file, and can produce a <code>Sequence</code> object from files of these types.
041 *
042 * @author Kara Kytle
043 * @version 1.20 07/05/05
044 * @since 1.3
045 */
046 public abstract class MidiFileReader {
047
048 /**
049 * Obtains the MIDI file format of the input stream provided. The stream must
050 * point to valid MIDI file data. In general, MIDI file readers may
051 * need to read some data from the stream before determining whether they
052 * support it. These parsers must
053 * be able to mark the stream, read enough data to determine whether they
054 * support the stream, and, if not, reset the stream's read pointer to its original
055 * position. If the input stream does not support this, this method may fail
056 * with an <code>IOException</code>.
057 * @param stream the input stream from which file format information should be
058 * extracted
059 * @return a <code>MidiFileFormat</code> object describing the MIDI file format
060 * @throws InvalidMidiDataException if the stream does not point to valid MIDI
061 * file data recognized by the system
062 * @throws IOException if an I/O exception occurs
063 * @see InputStream#markSupported
064 * @see InputStream#mark
065 */
066 public abstract MidiFileFormat getMidiFileFormat(InputStream stream)
067 throws InvalidMidiDataException, IOException;
068
069 /**
070 * Obtains the MIDI file format of the URL provided. The URL must
071 * point to valid MIDI file data.
072 * @param url the URL from which file format information should be
073 * extracted
074 * @return a <code>MidiFileFormat</code> object describing the MIDI file format
075 * @throws InvalidMidiDataException if the URL does not point to valid MIDI
076 * file data recognized by the system
077 * @throws IOException if an I/O exception occurs
078 */
079 public abstract MidiFileFormat getMidiFileFormat(URL url)
080 throws InvalidMidiDataException, IOException;
081
082 /**
083 * Obtains the MIDI file format of the <code>File</code> provided.
084 * The <code>File</code> must point to valid MIDI file data.
085 * @param file the <code>File</code> from which file format information should be
086 * extracted
087 * @return a <code>MidiFileFormat</code> object describing the MIDI file format
088 * @throws InvalidMidiDataException if the <code>File</code> does not point to valid MIDI
089 * file data recognized by the system
090 * @throws IOException if an I/O exception occurs
091 */
092 public abstract MidiFileFormat getMidiFileFormat(File file)
093 throws InvalidMidiDataException, IOException;
094
095 /**
096 * Obtains a MIDI sequence from the input stream provided. The stream must
097 * point to valid MIDI file data. In general, MIDI file readers may
098 * need to read some data from the stream before determining whether they
099 * support it. These parsers must
100 * be able to mark the stream, read enough data to determine whether they
101 * support the stream, and, if not, reset the stream's read pointer to its original
102 * position. If the input stream does not support this, this method may fail
103 * with an IOException.
104 * @param stream the input stream from which the <code>Sequence</code> should be
105 * constructed
106 * @return a <code>Sequence</code> object based on the MIDI file data contained
107 * in the input stream.
108 * @throws InvalidMidiDataException if the stream does not point to valid MIDI
109 * file data recognized by the system
110 * @throws IOException if an I/O exception occurs
111 * @see InputStream#markSupported
112 * @see InputStream#mark
113 */
114 public abstract Sequence getSequence(InputStream stream)
115 throws InvalidMidiDataException, IOException;
116
117 /**
118 * Obtains a MIDI sequence from the URL provided. The URL must
119 * point to valid MIDI file data.
120 * @param url the URL for which the <code>Sequence</code> should be
121 * constructed
122 * @return a <code>Sequence</code> object based on the MIDI file data pointed
123 * to by the URL
124 * @throws InvalidMidiDataException if the URL does not point to valid MIDI
125 * file data recognized by the system
126 * @throws IOException if an I/O exception occurs
127 */
128 public abstract Sequence getSequence(URL url)
129 throws InvalidMidiDataException, IOException;
130
131 /**
132 * Obtains a MIDI sequence from the <code>File</code> provided. The <code>File</code> must
133 * point to valid MIDI file data.
134 * @param file the <code>File</code> from which the <code>Sequence</code> should be
135 * constructed
136 * @return a <code>Sequence</code> object based on the MIDI file data pointed
137 * to by the <code>File</code>
138 * @throws InvalidMidiDataException if the <code>File</code> does not point to valid MIDI
139 * file data recognized by the system
140 * @throws IOException if an I/O exception occurs
141 */
142 public abstract Sequence getSequence(File file)
143 throws InvalidMidiDataException, IOException;
144 }
|