001/* Audio file reader API
002   Copyright (C) 2005 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package javax.sound.sampled.spi;
040
041import java.io.File;
042import java.io.IOException;
043import java.io.InputStream;
044import java.net.URL;
045
046import javax.sound.sampled.AudioFileFormat;
047import javax.sound.sampled.AudioInputStream;
048import javax.sound.sampled.UnsupportedAudioFileException;
049
050/**
051 * This abstract class defines the interface to audio file readers.
052 * A concrete provider subclass will implement the methods declared
053 * here.  These methods can be used to determine the format of
054 * files, and to retrieve an AudioInputStream for a file. 
055 * @since 1.3
056 */
057public abstract class AudioFileReader
058{
059  /**
060   * The default constructor.  Note that this class is abstract and
061   * thus not directly instantiable.
062   */
063  public AudioFileReader()
064  {
065  }
066
067  /**
068   * Return the format of the given file as deduced by this provider.
069   * If the format of the file is not recognized, throws an exception.
070   * This will also throw an exception if there is an I/O error when
071   * reading the file.
072   * @param file the file to examine
073   * @return the audio file format
074   * @throws UnsupportedAudioFileException if the file's format is not
075   * recognized
076   * @throws IOException if there is an I/O error while reading the file
077   */
078  public abstract AudioFileFormat getAudioFileFormat(File file)
079    throws UnsupportedAudioFileException, IOException;
080
081  /**
082   * Return the format of the given input stream as deduced by this provider.
083   * If the format of the stream is not recognized, throws an exception.
084   * This will also throw an exception if there is an I/O error when
085   * reading the stream.  Note that providers typically use mark and reset
086   * on the stream when examining the data, and as a result an IOException
087   * may be thrown if the stream does not support these.
088   * @param is the stream to examine
089   * @return the audio file format
090   * @throws UnsupportedAudioFileException if the stream's format is not
091   * recognized
092   * @throws IOException if there is an I/O error while reading the stream
093   */
094  public abstract AudioFileFormat getAudioFileFormat(InputStream is)
095    throws UnsupportedAudioFileException, IOException;
096
097  /**
098   * Return the format of the given URL as deduced by this provider.
099   * If the format of the URL is not recognized, throws an exception.
100   * This will also throw an exception if there is an I/O error when
101   * reading the URL.
102   * @param url the URL to examine
103   * @return the audio file format
104   * @throws UnsupportedAudioFileException if the URL's format is not
105   * recognized
106   * @throws IOException if there is an I/O error while reading the URL
107   */
108  public abstract AudioFileFormat getAudioFileFormat(URL url)
109    throws UnsupportedAudioFileException, IOException;
110
111  /**
112   * Return an AudioInputStream for the given file.  The file is assumed
113   * to hold valid audio data.  
114   * @param file the file to read
115   * @return an AudioInputStream for the file
116   * @throws UnsupportedAudioFileException if the file's type is not
117   * recognized
118   * @throws IOException if there is an error while reading the file 
119   */
120  public abstract AudioInputStream getAudioInputStream(File file)
121    throws UnsupportedAudioFileException, IOException;
122
123  /**
124   * Return an AudioInputStream wrapping the given input stream.  The stream
125   * is assumed to hold valid audio data.  
126   * @param is the input stream to wrap
127   * @return an AudioInputStream for the stream
128   * @throws UnsupportedAudioFileException if the stream's type is not
129   * recognized
130   * @throws IOException if there is an error while reading the stream 
131   */
132  public abstract AudioInputStream getAudioInputStream(InputStream is)
133    throws UnsupportedAudioFileException, IOException;
134
135  /**
136   * Return an AudioInputStream for the given URL.  The URL is assumed
137   * to hold valid audio data.  
138   * @param url the URL to read
139   * @return an AudioInputStream for the URL
140   * @throws UnsupportedAudioFileException if the URL's type is not
141   * recognized
142   * @throws IOException if there is an error while reading the URL 
143   */
144  public abstract AudioInputStream getAudioInputStream(URL url)
145    throws UnsupportedAudioFileException, IOException;
146}