1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
/* * @(#)FormatConversionProvider.java 1.30 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.sound.sampled.spi; import java.io.InputStream; import javax.sound.sampled.AudioFormat; import javax.sound.sampled.AudioInputStream; /** * A format conversion provider provides format conversion services * from one or more input formats to one or more output formats. * Converters include codecs, which encode and/or decode audio data, * as well as transcoders, etc. Format converters provide methods for * determining what conversions are supported and for obtaining an audio * stream from which converted data can be read. * <p> * The source format represents the format of the incoming * audio data, which will be converted. * <p> * The target format represents the format of the processed, converted * audio data. This is the format of the data that can be read from * the stream returned by one of the <code>getAudioInputStream</code> methods. * * @author Kara Kytle * @version 1.30, 05/11/17 * @since 1.3 */ public abstract class FormatConversionProvider { // NEW METHODS /** * Obtains the set of source format encodings from which format * conversion services are provided by this provider. * @return array of source format encodings. The array will always * have a length of at least 1. */ public abstract AudioFormat.Encoding[] getSourceEncodings(); /** * Obtains the set of target format encodings to which format * conversion services are provided by this provider. * @return array of target format encodings. The array will always * have a length of at least 1. */ public abstract AudioFormat.Encoding[] getTargetEncodings(); /** * Indicates whether the format converter supports conversion from the * specified source format encoding. * @param sourceEncoding the source format encoding for which support is queried * @return <code>true</code> if the encoding is supported, otherwise <code>false</code> */ public boolean isSourceEncodingSupported(AudioFormat.Encoding sourceEncoding){ AudioFormat.Encoding sourceEncodings[] = getSourceEncodings(); for(int i=0; i<sourceEncodings.length; i++) { if( sourceEncoding.equals( sourceEncodings[i]) ) { return true; } } return false; } /** * Indicates whether the format converter supports conversion to the * specified target format encoding. * @param targetEncoding the target format encoding for which support is queried * @return <code>true</code> if the encoding is supported, otherwise <code>false</code> */ public boolean isTargetEncodingSupported(AudioFormat.Encoding targetEncoding){ AudioFormat.Encoding targetEncodings[] = getTargetEncodings(); for(int i=0; i<targetEncodings.length; i++) { if( targetEncoding.equals( targetEncodings[i]) ) { return true; } } return false; } /** * Obtains the set of target format encodings supported by the format converter * given a particular source format. * If no target format encodings are supported for this source format, * an array of length 0 is returned. * @return array of supported target format encodings. */ public abstract AudioFormat.Encoding[] getTargetEncodings(AudioFormat sourceFormat); /** * Indicates whether the format converter supports conversion to a particular encoding * from a particular format. * @param targetEncoding desired encoding of the outgoing data * @param sourceFormat format of the incoming data * @return <code>true</code> if the conversion is supported, otherwise <code>false</code> */ public boolean isConversionSupported(AudioFormat.Encoding targetEncoding, AudioFormat sourceFormat){ AudioFormat.Encoding targetEncodings[] = getTargetEncodings(sourceFormat); for(int i=0; i<targetEncodings.length; i++) { if( targetEncoding.equals( targetEncodings[i]) ) { return true; } } return false; } /** * Obtains the set of target formats with the encoding specified * supported by the format converter * If no target formats with the specified encoding are supported * for this source format, an array of length 0 is returned. * @return array of supported target formats. */ public abstract AudioFormat[] getTargetFormats(AudioFormat.Encoding targetEncoding, AudioFormat sourceFormat); /** * Indicates whether the format converter supports conversion to one * particular format from another. * @param targetFormat desired format of outgoing data * @param sourceFormat format of the incoming data * @return <code>true</code> if the conversion is supported, otherwise <code>false</code> */ public boolean isConversionSupported(AudioFormat targetFormat, AudioFormat sourceFormat){ AudioFormat targetFormats[] = getTargetFormats( targetFormat.getEncoding(), sourceFormat ); for(int i=0; i<targetFormats.length; i++) { if( targetFormat.matches( targetFormats[i] ) ) { return true; } } return false; } /** * Obtains an audio input stream with the specified encoding from the given audio * input stream. * @param targetEncoding desired encoding of the stream after processing * @param sourceStream stream from which data to be processed should be read * @return stream from which processed data with the specified target encoding may be read * @throws IllegalArgumentException if the format combination supplied is * not supported. */ public abstract AudioInputStream getAudioInputStream(AudioFormat.Encoding targetEncoding, AudioInputStream sourceStream); /** * Obtains an audio input stream with the specified format from the given audio * input stream. * @param targetFormat desired data format of the stream after processing * @param sourceStream stream from which data to be processed should be read * @return stream from which processed data with the specified format may be read * @throws IllegalArgumentException if the format combination supplied is * not supported. */ public abstract AudioInputStream getAudioInputStream(AudioFormat targetFormat, AudioInputStream sourceStream); }