001 /* Audio file writer API
002 Copyright (C) 2005 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038
039 package javax.sound.sampled.spi;
040
041 import java.io.File;
042 import java.io.IOException;
043 import java.io.OutputStream;
044
045 import javax.sound.sampled.AudioFileFormat;
046 import javax.sound.sampled.AudioInputStream;
047
048 /**
049 * This abstract class provides an API for writing audio files. Concrete
050 * subclasses implement the methods declared here.
051 * @since 1.3
052 */
053 public abstract class AudioFileWriter
054 {
055 /**
056 * Creat a new audio file writer.
057 */
058 public AudioFileWriter()
059 {
060 }
061
062 /**
063 * Return an array of all audio file format types supported by this
064 * provider.
065 */
066 public abstract AudioFileFormat.Type[] getAudioFileTypes();
067
068 /**
069 * Return an array of all the audio file format types supported by this
070 * provider, which can be written given the input stream.
071 * @param ais the audio input stream
072 */
073 public abstract AudioFileFormat.Type[] getAudioFileTypes(AudioInputStream ais);
074
075 /**
076 * Return true if the indicated type is supported by this provider.
077 * @param type the audio file format type
078 */
079 public boolean isFileTypeSupported(AudioFileFormat.Type type)
080 {
081 AudioFileFormat.Type[] types = getAudioFileTypes();
082 for (int i = 0; i < types.length; ++i)
083 {
084 if (type.equals(types[i]))
085 return true;
086 }
087 return false;
088 }
089
090 /**
091 * Return true if the indicated type is supported by this provider,
092 * and can be written from the given audio input stream.
093 * @param type the audio file format type
094 * @param ais the audio input stream to write
095 */
096 public boolean isFileTypeSupported(AudioFileFormat.Type type,
097 AudioInputStream ais)
098 {
099 AudioFileFormat.Type[] types = getAudioFileTypes(ais);
100 for (int i = 0; i < types.length; ++i)
101 {
102 if (type.equals(types[i]))
103 return true;
104 }
105 return false;
106 }
107
108 /**
109 * Write audio data to a file.
110 * @param ais the audio input stream to write
111 * @param type the desired audio file format type
112 * @param out the file to write to
113 * @return the number of bytes written
114 * @throws IOException if an I/O error occurs when writing
115 */
116 public abstract int write(AudioInputStream ais, AudioFileFormat.Type type,
117 File out)
118 throws IOException;
119
120 /**
121 * Write audio data to an output stream.
122 * @param ais the audio input stream to write
123 * @param type the desired audio file format type
124 * @param os the output stream
125 * @return the number of bytes written
126 * @throws IOException if an I/O error occurs when writing
127 */
128 public abstract int write(AudioInputStream ais, AudioFileFormat.Type type,
129 OutputStream os)
130 throws IOException;
131 }