Source for javax.sound.sampled.spi.AudioFileReader

   1: /* Audio file reader API
   2:    Copyright (C) 2005 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.sound.sampled.spi;
  40: 
  41: import java.io.File;
  42: import java.io.IOException;
  43: import java.io.InputStream;
  44: import java.net.URL;
  45: 
  46: import javax.sound.sampled.AudioFileFormat;
  47: import javax.sound.sampled.AudioInputStream;
  48: import javax.sound.sampled.UnsupportedAudioFileException;
  49: 
  50: /**
  51:  * This abstract class defines the interface to audio file readers.
  52:  * A concrete provider subclass will implement the methods declared
  53:  * here.  These methods can be used to determine the format of
  54:  * files, and to retrieve an AudioInputStream for a file.
  55:  * @since 1.3
  56:  */
  57: public abstract class AudioFileReader
  58: {
  59:   /**
  60:    * The default constructor.  Note that this class is abstract and
  61:    * thus not directly instantiable.
  62:    */
  63:   public AudioFileReader()
  64:   {
  65:   }
  66: 
  67:   /**
  68:    * Return the format of the given file as deduced by this provider.
  69:    * If the format of the file is not recognized, throws an exception.
  70:    * This will also throw an exception if there is an I/O error when
  71:    * reading the file.
  72:    * @param file the file to examine
  73:    * @return the audio file format
  74:    * @throws UnsupportedAudioFileException if the file's format is not
  75:    * recognized
  76:    * @throws IOException if there is an I/O error while reading the file
  77:    */
  78:   public abstract AudioFileFormat getAudioFileFormat(File file)
  79:     throws UnsupportedAudioFileException, IOException;
  80: 
  81:   /**
  82:    * Return the format of the given input stream as deduced by this provider.
  83:    * If the format of the stream is not recognized, throws an exception.
  84:    * This will also throw an exception if there is an I/O error when
  85:    * reading the stream.  Note that providers typically use mark and reset
  86:    * on the stream when examining the data, and as a result an IOException
  87:    * may be thrown if the stream does not support these.
  88:    * @param is the stream to examine
  89:    * @return the audio file format
  90:    * @throws UnsupportedAudioFileException if the stream's format is not
  91:    * recognized
  92:    * @throws IOException if there is an I/O error while reading the stream
  93:    */
  94:   public abstract AudioFileFormat getAudioFileFormat(InputStream is)
  95:     throws UnsupportedAudioFileException, IOException;
  96: 
  97:   /**
  98:    * Return the format of the given URL as deduced by this provider.
  99:    * 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: }