1 /* Audio file writer 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.OutputStream; 44 45 import javax.sound.sampled.AudioFileFormat; 46 import javax.sound.sampled.AudioInputStream; 47 48 /** 49 * This abstract class provides an API for writing audio files. Concrete 50 * subclasses implement the methods declared here. 51 * @since 1.3 52 */ 53 public abstract class AudioFileWriter 54 { 55 /** 56 * Creat a new audio file writer. 57 */ AudioFileWriter()58 public AudioFileWriter() 59 { 60 } 61 62 /** 63 * Return an array of all audio file format types supported by this 64 * provider. 65 */ getAudioFileTypes()66 public abstract AudioFileFormat.Type[] getAudioFileTypes(); 67 68 /** 69 * Return an array of all the audio file format types supported by this 70 * provider, which can be written given the input stream. 71 * @param ais the audio input stream 72 */ getAudioFileTypes(AudioInputStream ais)73 public abstract AudioFileFormat.Type[] getAudioFileTypes(AudioInputStream ais); 74 75 /** 76 * Return true if the indicated type is supported by this provider. 77 * @param type the audio file format type 78 */ isFileTypeSupported(AudioFileFormat.Type type)79 public boolean isFileTypeSupported(AudioFileFormat.Type type) 80 { 81 AudioFileFormat.Type[] types = getAudioFileTypes(); 82 for (int i = 0; i < types.length; ++i) 83 { 84 if (type.equals(types[i])) 85 return true; 86 } 87 return false; 88 } 89 90 /** 91 * Return true if the indicated type is supported by this provider, 92 * and can be written from the given audio input stream. 93 * @param type the audio file format type 94 * @param ais the audio input stream to write 95 */ isFileTypeSupported(AudioFileFormat.Type type, AudioInputStream ais)96 public boolean isFileTypeSupported(AudioFileFormat.Type type, 97 AudioInputStream ais) 98 { 99 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 */ write(AudioInputStream ais, AudioFileFormat.Type type, File out)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 */ write(AudioInputStream ais, AudioFileFormat.Type type, OutputStream os)128 public abstract int write(AudioInputStream ais, AudioFileFormat.Type type, 129 OutputStream os) 130 throws IOException; 131 } 132