src/share/classes/javax/sound/sampled/AudioSystem.java
Print this page
*** 48,218 ****
* - consistent usage of (typed) collections
*/
/**
! * The <code>AudioSystem</code> class acts as the entry point to the
! * sampled-audio system resources. This class lets you query and
! * access the mixers that are installed on the system.
! * <code>AudioSystem</code> includes a number of
! * methods for converting audio data between different formats, and for
! * translating between audio files and streams. It also provides a method
! * for obtaining a <code>{@link Line}</code> directly from the
! * <code>AudioSystem</code> without dealing explicitly
* with mixers.
! *
! * <p>Properties can be used to specify the default mixer
! * for specific line types.
! * Both system properties and a properties file are considered.
! * The <code>sound.properties</code> properties file is read from
! * an implementation-specific location (typically it is the <code>lib</code>
! * directory in the Java installation directory).
! * If a property exists both as a system property and in the
! * properties file, the system property takes precedence. If none is
! * specified, a suitable default is chosen among the available devices.
! * The syntax of the properties file is specified in
! * {@link java.util.Properties#load(InputStream) Properties.load}. The
! * following table lists the available property keys and which methods
! * consider them:
*
* <table border=0>
* <caption>Audio System Property Keys</caption>
* <tr>
* <th>Property Key</th>
* <th>Interface</th>
* <th>Affected Method(s)</th>
* </tr>
* <tr>
! * <td><code>javax.sound.sampled.Clip</code></td>
* <td>{@link Clip}</td>
* <td>{@link #getLine}, {@link #getClip}</td>
* </tr>
* <tr>
! * <td><code>javax.sound.sampled.Port</code></td>
* <td>{@link Port}</td>
* <td>{@link #getLine}</td>
* </tr>
* <tr>
! * <td><code>javax.sound.sampled.SourceDataLine</code></td>
* <td>{@link SourceDataLine}</td>
* <td>{@link #getLine}, {@link #getSourceDataLine}</td>
* </tr>
* <tr>
! * <td><code>javax.sound.sampled.TargetDataLine</code></td>
* <td>{@link TargetDataLine}</td>
* <td>{@link #getLine}, {@link #getTargetDataLine}</td>
* </tr>
* </table>
*
! * The property value consists of the provider class name
! * and the mixer name, separated by the hash mark ("#").
! * The provider class name is the fully-qualified
! * name of a concrete {@link javax.sound.sampled.spi.MixerProvider
! * mixer provider} class. The mixer name is matched against
! * the <code>String</code> returned by the <code>getName</code>
! * method of <code>Mixer.Info</code>.
! * Either the class name, or the mixer name may be omitted.
! * If only the class name is specified, the trailing hash mark
! * is optional.
! *
! * <p>If the provider class is specified, and it can be
! * successfully retrieved from the installed providers, the list of
! * <code>Mixer.Info</code> objects is retrieved
! * from the provider. Otherwise, or when these mixers
! * do not provide a subsequent match, the list is retrieved
! * from {@link #getMixerInfo} to contain
! * all available <code>Mixer.Info</code> objects.
! *
! * <p>If a mixer name is specified, the resulting list of
! * <code>Mixer.Info</code> objects is searched:
! * the first one with a matching name, and whose
! * <code>Mixer</code> provides the
* respective line interface, will be returned.
! * If no matching <code>Mixer.Info</code> object
! * is found, or the mixer name is not specified,
! * the first mixer from the resulting
! * list, which provides the respective line
! * interface, will be returned.
! *
! * For example, the property <code>javax.sound.sampled.Clip</code>
! * with a value
! * <code>"com.sun.media.sound.MixerProvider#SunClip"</code>
! * will have the following consequences when
! * <code>getLine</code> is called requesting a <code>Clip</code>
! * instance:
! * if the class <code>com.sun.media.sound.MixerProvider</code> exists
! * in the list of installed mixer providers,
! * the first <code>Clip</code> from the first mixer with name
! * <code>"SunClip"</code> will be returned. If it cannot
! * be found, the first <code>Clip</code> from the first mixer
! * of the specified provider will be returned, regardless of name.
! * If there is none, the first <code>Clip</code> from the first
! * <code>Mixer</code> with name
! * <code>"SunClip"</code> in the list of all mixers
! * (as returned by <code>getMixerInfo</code>) will be returned,
! * or, if not found, the first <code>Clip</code> of the first
! * <code>Mixer</code>that can be found in the list of all
! * mixers is returned.
! * If that fails, too, an <code>IllegalArgumentException</code>
! * is thrown.
*
* @author Kara Kytle
* @author Florian Bomers
* @author Matthias Pfisterer
* @author Kevin P. Smith
- *
* @see AudioFormat
* @see AudioInputStream
* @see Mixer
* @see Line
* @see Line.Info
* @since 1.3
*/
public class AudioSystem {
/**
! * An integer that stands for an unknown numeric value.
! * This value is appropriate only for signed quantities that do not
! * normally take negative values. Examples include file sizes, frame
! * sizes, buffer sizes, and sample rates.
! * A number of Java Sound constructors accept
! * a value of <code>NOT_SPECIFIED</code> for such parameters. Other
! * methods may also accept or return this value, as documented.
*/
public static final int NOT_SPECIFIED = -1;
/**
* Private no-args constructor for ensuring against instantiation.
*/
private AudioSystem() {
}
-
/**
! * Obtains an array of mixer info objects that represents
! * the set of audio mixers that are currently installed on the system.
! * @return an array of info objects for the currently installed mixers. If no mixers
! * are available on the system, an array of length 0 is returned.
* @see #getMixer
*/
public static Mixer.Info[] getMixerInfo() {
List infos = getMixerInfoList();
Mixer.Info[] allInfos = (Mixer.Info[]) infos.toArray(new Mixer.Info[infos.size()]);
return allInfos;
}
-
/**
* Obtains the requested audio mixer.
! * @param info a <code>Mixer.Info</code> object representing the desired
! * mixer, or <code>null</code> for the system default mixer
* @return the requested mixer
! * @throws SecurityException if the requested mixer
! * is unavailable because of security restrictions
! * @throws IllegalArgumentException if the info object does not represent
! * a mixer installed on the system
* @see #getMixerInfo
*/
public static Mixer getMixer(Mixer.Info info) {
Mixer mixer = null;
--- 48,197 ----
* - consistent usage of (typed) collections
*/
/**
! * The {@code AudioSystem} class acts as the entry point to the sampled-audio
! * system resources. This class lets you query and access the mixers that are
! * installed on the system. {@code AudioSystem} includes a number of methods for
! * converting audio data between different formats, and for translating between
! * audio files and streams. It also provides a method for obtaining a
! * {@link Line} directly from the {@code AudioSystem} without dealing explicitly
* with mixers.
! * <p>
! * Properties can be used to specify the default mixer for specific line types.
! * Both system properties and a properties file are considered. The
! * {@code sound.properties} properties file is read from an
! * implementation-specific location (typically it is the {@code lib} directory
! * in the Java installation directory). If a property exists both as a system
! * property and in the properties file, the system property takes precedence.
! * If none is specified, a suitable default is chosen among the available
! * devices. The syntax of the properties file is specified in
! * {@link java.util.Properties#load(InputStream) Properties.load}. The following
! * table lists the available property keys and which methods consider them:
*
* <table border=0>
* <caption>Audio System Property Keys</caption>
* <tr>
* <th>Property Key</th>
* <th>Interface</th>
* <th>Affected Method(s)</th>
* </tr>
* <tr>
! * <td>{@code javax.sound.sampled.Clip}</td>
* <td>{@link Clip}</td>
* <td>{@link #getLine}, {@link #getClip}</td>
* </tr>
* <tr>
! * <td>{@code javax.sound.sampled.Port}</td>
* <td>{@link Port}</td>
* <td>{@link #getLine}</td>
* </tr>
* <tr>
! * <td>{@code javax.sound.sampled.SourceDataLine}</td>
* <td>{@link SourceDataLine}</td>
* <td>{@link #getLine}, {@link #getSourceDataLine}</td>
* </tr>
* <tr>
! * <td>{@code javax.sound.sampled.TargetDataLine}</td>
* <td>{@link TargetDataLine}</td>
* <td>{@link #getLine}, {@link #getTargetDataLine}</td>
* </tr>
* </table>
*
! * The property value consists of the provider class name and the mixer name,
! * separated by the hash mark ("#"). The provider class name is the
! * fully-qualified name of a concrete
! * {@link javax.sound.sampled.spi.MixerProvider mixer provider} class. The mixer
! * name is matched against the {@code String} returned by the {@code getName}
! * method of {@code Mixer.Info}. Either the class name, or the mixer name may be
! * omitted. If only the class name is specified, the trailing hash mark is
! * optional.
! * <p>
! * If the provider class is specified, and it can be successfully retrieved from
! * the installed providers, the list of {@code Mixer.Info} objects is retrieved
! * from the provider. Otherwise, or when these mixers do not provide a
! * subsequent match, the list is retrieved from {@link #getMixerInfo} to contain
! * all available {@code Mixer.Info} objects.
! * <p>
! * If a mixer name is specified, the resulting list of {@code Mixer.Info}
! * objects is searched: the first one with a matching name, and whose
! * {@code Mixer} provides the respective line interface, will be returned. If no
! * matching {@code Mixer.Info} object is found, or the mixer name is not
! * specified, the first mixer from the resulting list, which provides the
* respective line interface, will be returned.
! *
! * For example, the property {@code javax.sound.sampled.Clip} with a value
! * {@code "com.sun.media.sound.MixerProvider#SunClip"}
! * will have the following consequences when {@code getLine} is called
! * requesting a {@code Clip} instance: if the class
! * {@code com.sun.media.sound.MixerProvider} exists in the list of installed
! * mixer providers, the first {@code Clip} from the first mixer with name
! * {@code "SunClip"} will be returned. If it cannot be found, the
! * first {@code Clip} from the first mixer of the specified provider will be
! * returned, regardless of name. If there is none, the first {@code Clip} from
! * the first {@code Mixer} with name {@code "SunClip"} in the list of
! * all mixers (as returned by {@code getMixerInfo}) will be returned, or, if not
! * found, the first {@code Clip} of the first {@code Mixer} that can be found in
! * the list of all mixers is returned. If that fails, too, an
! * {@code IllegalArgumentException} is thrown.
*
* @author Kara Kytle
* @author Florian Bomers
* @author Matthias Pfisterer
* @author Kevin P. Smith
* @see AudioFormat
* @see AudioInputStream
* @see Mixer
* @see Line
* @see Line.Info
* @since 1.3
*/
public class AudioSystem {
/**
! * An integer that stands for an unknown numeric value. This value is
! * appropriate only for signed quantities that do not normally take negative
! * values. Examples include file sizes, frame sizes, buffer sizes, and
! * sample rates. A number of Java Sound constructors accept a value of
! * {@code NOT_SPECIFIED} for such parameters. Other methods may also accept
! * or return this value, as documented.
*/
public static final int NOT_SPECIFIED = -1;
/**
* Private no-args constructor for ensuring against instantiation.
*/
private AudioSystem() {
}
/**
! * Obtains an array of mixer info objects that represents the set of audio
! * mixers that are currently installed on the system.
! *
! * @return an array of info objects for the currently installed mixers. If
! * no mixers are available on the system, an array of length 0 is
! * returned.
* @see #getMixer
*/
public static Mixer.Info[] getMixerInfo() {
List infos = getMixerInfoList();
Mixer.Info[] allInfos = (Mixer.Info[]) infos.toArray(new Mixer.Info[infos.size()]);
return allInfos;
}
/**
* Obtains the requested audio mixer.
! *
! * @param info a {@code Mixer.Info} object representing the desired mixer,
! * or {@code null} for the system default mixer
* @return the requested mixer
! * @throws SecurityException if the requested mixer is unavailable because
! * of security restrictions
! * @throws IllegalArgumentException if the info object does not represent a
! * mixer installed on the system
* @see #getMixerInfo
*/
public static Mixer getMixer(Mixer.Info info) {
Mixer mixer = null;
*** 257,277 ****
throw new IllegalArgumentException("Mixer not supported: "
+ (info!=null?info.toString():"null"));
}
-
//$$fb 2002-11-26: fix for 4757930: DOC: AudioSystem.getTarget/SourceLineInfo() is ambiguous
/**
! * Obtains information about all source lines of a particular type that are supported
! * by the installed mixers.
! * @param info a <code>Line.Info</code> object that specifies the kind of
! * lines about which information is requested
! * @return an array of <code>Line.Info</code> objects describing source lines matching
! * the type requested. If no matching source lines are supported, an array of length 0
! * is returned.
*
* @see Mixer#getSourceLineInfo(Line.Info)
*/
public static Line.Info[] getSourceLineInfo(Line.Info info) {
Vector vector = new Vector();
--- 236,256 ----
throw new IllegalArgumentException("Mixer not supported: "
+ (info!=null?info.toString():"null"));
}
//$$fb 2002-11-26: fix for 4757930: DOC: AudioSystem.getTarget/SourceLineInfo() is ambiguous
+
/**
! * Obtains information about all source lines of a particular type that are
! * supported by the installed mixers.
*
+ * @param info a {@code Line.Info} object that specifies the kind of lines
+ * about which information is requested
+ * @return an array of {@code Line.Info} objects describing source lines
+ * matching the type requested. If no matching source lines are
+ * supported, an array of length 0 is returned.
* @see Mixer#getSourceLineInfo(Line.Info)
*/
public static Line.Info[] getSourceLineInfo(Line.Info info) {
Vector vector = new Vector();
*** 298,317 ****
}
return returnedArray;
}
-
/**
! * Obtains information about all target lines of a particular type that are supported
! * by the installed mixers.
! * @param info a <code>Line.Info</code> object that specifies the kind of
! * lines about which information is requested
! * @return an array of <code>Line.Info</code> objects describing target lines matching
! * the type requested. If no matching target lines are supported, an array of length 0
! * is returned.
*
* @see Mixer#getTargetLineInfo(Line.Info)
*/
public static Line.Info[] getTargetLineInfo(Line.Info info) {
Vector vector = new Vector();
--- 277,295 ----
}
return returnedArray;
}
/**
! * Obtains information about all target lines of a particular type that are
! * supported by the installed mixers.
*
+ * @param info a {@code Line.Info} object that specifies the kind of lines
+ * about which information is requested
+ * @return an array of {@code Line.Info} objects describing target lines
+ * matching the type requested. If no matching target lines are
+ * supported, an array of length 0 is returned.
* @see Mixer#getTargetLineInfo(Line.Info)
*/
public static Line.Info[] getTargetLineInfo(Line.Info info) {
Vector vector = new Vector();
*** 338,356 ****
}
return returnedArray;
}
-
/**
! * Indicates whether the system supports any lines that match
! * the specified <code>Line.Info</code> object. A line is supported if
! * any installed mixer supports it.
! * @param info a <code>Line.Info</code> object describing the line for which support is queried
! * @return <code>true</code> if at least one matching line is
! * supported, otherwise <code>false</code>
! *
* @see Mixer#isLineSupported(Line.Info)
*/
public static boolean isLineSupported(Line.Info info) {
Mixer mixer;
--- 316,334 ----
}
return returnedArray;
}
/**
! * Indicates whether the system supports any lines that match the specified
! * {@code Line.Info} object. A line is supported if any installed mixer
! * supports it.
! *
! * @param info a {@code Line.Info} object describing the line for which
! * support is queried
! * @return {@code true} if at least one matching line is supported,
! * otherwise {@code false}
* @see Mixer#isLineSupported(Line.Info)
*/
public static boolean isLineSupported(Line.Info info) {
Mixer mixer;
*** 369,412 ****
return false;
}
/**
* Obtains a line that matches the description in the specified
! * <code>Line.Info</code> object.
! *
! * <p>If a <code>DataLine</code> is requested, and <code>info</code>
! * is an instance of <code>DataLine.Info</code> specifying at least
! * one fully qualified audio format, the last one
! * will be used as the default format of the returned
! * <code>DataLine</code>.
! *
! * <p>If system properties
! * <code>javax.sound.sampled.Clip</code>,
! * <code>javax.sound.sampled.Port</code>,
! * <code>javax.sound.sampled.SourceDataLine</code> and
! * <code>javax.sound.sampled.TargetDataLine</code> are defined
! * or they are defined in the file "sound.properties",
! * they are used to retrieve default lines.
! * For details, refer to the {@link AudioSystem class description}.
! *
! * If the respective property is not set, or the mixer
! * requested in the property is not installed or does not provide the
! * requested line, all installed mixers are queried for the
! * requested line type. A Line will be returned from the first mixer
! * providing the requested line type.
*
! * @param info a <code>Line.Info</code> object describing the desired kind of line
* @return a line of the requested kind
! *
! * @throws LineUnavailableException if a matching line
! * is not available due to resource restrictions
! * @throws SecurityException if a matching line
! * is not available due to security restrictions
! * @throws IllegalArgumentException if the system does not
! * support at least one line matching the specified
! * <code>Line.Info</code> object
! * through any installed mixer
*/
public static Line getLine(Line.Info info) throws LineUnavailableException {
LineUnavailableException lue = null;
List providers = getMixerProviders();
--- 347,386 ----
return false;
}
/**
* Obtains a line that matches the description in the specified
! * {@code Line.Info} object.
! * <p>
! * If a {@code DataLine} is requested, and {@code info} is an instance of
! * {@code DataLine.Info} specifying at least one fully qualified audio
! * format, the last one will be used as the default format of the returned
! * {@code DataLine}.
! * <p>
! * If system properties
! * {@code javax.sound.sampled.Clip},
! * {@code javax.sound.sampled.Port},
! * {@code javax.sound.sampled.SourceDataLine} and
! * {@code javax.sound.sampled.TargetDataLine} are defined or they are
! * defined in the file "sound.properties", they are used to retrieve default
! * lines. For details, refer to the {@link AudioSystem class description}.
! *
! * If the respective property is not set, or the mixer requested in the
! * property is not installed or does not provide the requested line, all
! * installed mixers are queried for the requested line type. A Line will be
! * returned from the first mixer providing the requested line type.
*
! * @param info a {@code Line.Info} object describing the desired kind of
! * line
* @return a line of the requested kind
! * @throws LineUnavailableException if a matching line is not available due
! * to resource restrictions
! * @throws SecurityException if a matching line is not available due to
! * security restrictions
! * @throws IllegalArgumentException if the system does not support at least
! * one line matching the specified {@code Line.Info} object through
! * any installed mixer
*/
public static Line getLine(Line.Info info) throws LineUnavailableException {
LineUnavailableException lue = null;
List providers = getMixerProviders();
*** 477,517 ****
// an Illegal argument exception
throw new IllegalArgumentException("No line matching " +
info.toString() + " is supported.");
}
-
/**
! * Obtains a clip that can be used for playing back
! * an audio file or an audio stream. The returned clip
! * will be provided by the default system mixer, or,
! * if not possible, by any other mixer installed in the
! * system that supports a <code>Clip</code>
! * object.
! *
! * <p>The returned clip must be opened with the
! * <code>open(AudioFormat)</code> or
! * <code>open(AudioInputStream)</code> method.
! *
! * <p>This is a high-level method that uses <code>getMixer</code>
! * and <code>getLine</code> internally.
! *
! * <p>If the system property
! * <code>javax.sound.sampled.Clip</code>
! * is defined or it is defined in the file "sound.properties",
! * it is used to retrieve the default clip.
! * For details, refer to the {@link AudioSystem class description}.
*
* @return the desired clip object
! *
! * @throws LineUnavailableException if a clip object
! * is not available due to resource restrictions
! * @throws SecurityException if a clip object
! * is not available due to security restrictions
! * @throws IllegalArgumentException if the system does not
! * support at least one clip instance through any installed mixer
! *
* @see #getClip(Mixer.Info)
* @since 1.5
*/
public static Clip getClip() throws LineUnavailableException{
AudioFormat format = new AudioFormat(AudioFormat.Encoding.PCM_SIGNED,
--- 451,484 ----
// an Illegal argument exception
throw new IllegalArgumentException("No line matching " +
info.toString() + " is supported.");
}
/**
! * Obtains a clip that can be used for playing back an audio file or an
! * audio stream. The returned clip will be provided by the default system
! * mixer, or, if not possible, by any other mixer installed in the system
! * that supports a {@code Clip} object.
! * <p>
! * The returned clip must be opened with the {@code open(AudioFormat)} or
! * {@code open(AudioInputStream)} method.
! * <p>
! * This is a high-level method that uses {@code getMixer} and
! * {@code getLine} internally.
! * <p>
! * If the system property {@code javax.sound.sampled.Clip} is defined or it
! * is defined in the file "sound.properties", it is used to retrieve the
! * default clip. For details, refer to the
! * {@link AudioSystem class description}.
*
* @return the desired clip object
! * @throws LineUnavailableException if a clip object is not available due to
! * resource restrictions
! * @throws SecurityException if a clip object is not available due to
! * security restrictions
! * @throws IllegalArgumentException if the system does not support at least
! * one clip instance through any installed mixer
* @see #getClip(Mixer.Info)
* @since 1.5
*/
public static Clip getClip() throws LineUnavailableException{
AudioFormat format = new AudioFormat(AudioFormat.Encoding.PCM_SIGNED,
*** 520,552 ****
AudioSystem.NOT_SPECIFIED, true);
DataLine.Info info = new DataLine.Info(Clip.class, format);
return (Clip) AudioSystem.getLine(info);
}
-
/**
! * Obtains a clip from the specified mixer that can be
! * used for playing back an audio file or an audio stream.
*
! * <p>The returned clip must be opened with the
! * <code>open(AudioFormat)</code> or
! * <code>open(AudioInputStream)</code> method.
! *
! * <p>This is a high-level method that uses <code>getMixer</code>
! * and <code>getLine</code> internally.
! *
! * @param mixerInfo a <code>Mixer.Info</code> object representing the
! * desired mixer, or <code>null</code> for the system default mixer
* @return a clip object from the specified mixer
*
! * @throws LineUnavailableException if a clip
! * is not available from this mixer due to resource restrictions
! * @throws SecurityException if a clip
! * is not available from this mixer due to security restrictions
! * @throws IllegalArgumentException if the system does not
! * support at least one clip through the specified mixer
! *
* @see #getClip()
* @since 1.5
*/
public static Clip getClip(Mixer.Info mixerInfo) throws LineUnavailableException{
AudioFormat format = new AudioFormat(AudioFormat.Encoding.PCM_SIGNED,
--- 487,516 ----
AudioSystem.NOT_SPECIFIED, true);
DataLine.Info info = new DataLine.Info(Clip.class, format);
return (Clip) AudioSystem.getLine(info);
}
/**
! * Obtains a clip from the specified mixer that can be used for playing back
! * an audio file or an audio stream.
! * <p>
! * The returned clip must be opened with the {@code open(AudioFormat)} or
! * {@code open(AudioInputStream)} method.
! * <p>
! * This is a high-level method that uses {@code getMixer} and
! * {@code getLine} internally.
*
! * @param mixerInfo a {@code Mixer.Info} object representing the desired
! * mixer, or {@code null} for the system default mixer
* @return a clip object from the specified mixer
*
! * @throws LineUnavailableException if a clip is not available from this
! * mixer due to resource restrictions
! * @throws SecurityException if a clip is not available from this mixer due
! * to security restrictions
! * @throws IllegalArgumentException if the system does not support at least
! * one clip through the specified mixer
* @see #getClip()
* @since 1.5
*/
public static Clip getClip(Mixer.Info mixerInfo) throws LineUnavailableException{
AudioFormat format = new AudioFormat(AudioFormat.Encoding.PCM_SIGNED,
*** 556,648 ****
DataLine.Info info = new DataLine.Info(Clip.class, format);
Mixer mixer = AudioSystem.getMixer(mixerInfo);
return (Clip) mixer.getLine(info);
}
-
/**
! * Obtains a source data line that can be used for playing back
! * audio data in the format specified by the
! * <code>AudioFormat</code> object. The returned line
! * will be provided by the default system mixer, or,
! * if not possible, by any other mixer installed in the
! * system that supports a matching
! * <code>SourceDataLine</code> object.
! *
! * <p>The returned line should be opened with the
! * <code>open(AudioFormat)</code> or
! * <code>open(AudioFormat, int)</code> method.
! *
! * <p>This is a high-level method that uses <code>getMixer</code>
! * and <code>getLine</code> internally.
! *
! * <p>The returned <code>SourceDataLine</code>'s default
! * audio format will be initialized with <code>format</code>.
! *
! * <p>If the system property
! * <code>javax.sound.sampled.SourceDataLine</code>
! * is defined or it is defined in the file "sound.properties",
! * it is used to retrieve the default source data line.
! * For details, refer to the {@link AudioSystem class description}.
! *
! * @param format an <code>AudioFormat</code> object specifying
! * the supported audio format of the returned line,
! * or <code>null</code> for any audio format
! * @return the desired <code>SourceDataLine</code> object
! *
! * @throws LineUnavailableException if a matching source data line
! * is not available due to resource restrictions
! * @throws SecurityException if a matching source data line
! * is not available due to security restrictions
! * @throws IllegalArgumentException if the system does not
! * support at least one source data line supporting the
! * specified audio format through any installed mixer
! *
* @see #getSourceDataLine(AudioFormat, Mixer.Info)
* @since 1.5
*/
public static SourceDataLine getSourceDataLine(AudioFormat format)
throws LineUnavailableException{
DataLine.Info info = new DataLine.Info(SourceDataLine.class, format);
return (SourceDataLine) AudioSystem.getLine(info);
}
-
/**
! * Obtains a source data line that can be used for playing back
! * audio data in the format specified by the
! * <code>AudioFormat</code> object, provided by the mixer
! * specified by the <code>Mixer.Info</code> object.
! *
! * <p>The returned line should be opened with the
! * <code>open(AudioFormat)</code> or
! * <code>open(AudioFormat, int)</code> method.
! *
! * <p>This is a high-level method that uses <code>getMixer</code>
! * and <code>getLine</code> internally.
! *
! * <p>The returned <code>SourceDataLine</code>'s default
! * audio format will be initialized with <code>format</code>.
! *
! * @param format an <code>AudioFormat</code> object specifying
! * the supported audio format of the returned line,
! * or <code>null</code> for any audio format
! * @param mixerinfo a <code>Mixer.Info</code> object representing
! * the desired mixer, or <code>null</code> for the system
! * default mixer
! * @return the desired <code>SourceDataLine</code> object
! *
! * @throws LineUnavailableException if a matching source data
! * line is not available from the specified mixer due
! * to resource restrictions
! * @throws SecurityException if a matching source data line
! * is not available from the specified mixer due to
! * security restrictions
! * @throws IllegalArgumentException if the specified mixer does
! * not support at least one source data line supporting
! * the specified audio format
! *
* @see #getSourceDataLine(AudioFormat)
* @since 1.5
*/
public static SourceDataLine getSourceDataLine(AudioFormat format,
Mixer.Info mixerinfo)
--- 520,597 ----
DataLine.Info info = new DataLine.Info(Clip.class, format);
Mixer mixer = AudioSystem.getMixer(mixerInfo);
return (Clip) mixer.getLine(info);
}
/**
! * Obtains a source data line that can be used for playing back audio data
! * in the format specified by the {@code AudioFormat} object. The returned
! * line will be provided by the default system mixer, or, if not possible,
! * by any other mixer installed in the system that supports a matching
! * {@code SourceDataLine} object.
! * <p>
! * The returned line should be opened with the {@code open(AudioFormat)} or
! * {@code open(AudioFormat, int)} method.
! * <p>
! * This is a high-level method that uses {@code getMixer} and
! * {@code getLine} internally.
! * <p>
! * The returned {@code SourceDataLine}'s default audio format will be
! * initialized with {@code format}.
! * <p>
! * If the system property {@code javax.sound.sampled.SourceDataLine} is
! * defined or it is defined in the file "sound.properties", it is used to
! * retrieve the default source data line. For details, refer to the
! * {@link AudioSystem class description}.
! *
! * @param format an {@code AudioFormat} object specifying the supported
! * audio format of the returned line, or {@code null} for any audio
! * format
! * @return the desired {@code SourceDataLine} object
! * @throws LineUnavailableException if a matching source data line is not
! * available due to resource restrictions
! * @throws SecurityException if a matching source data line is not available
! * due to security restrictions
! * @throws IllegalArgumentException if the system does not support at least
! * one source data line supporting the specified audio format
! * through any installed mixer
* @see #getSourceDataLine(AudioFormat, Mixer.Info)
* @since 1.5
*/
public static SourceDataLine getSourceDataLine(AudioFormat format)
throws LineUnavailableException{
DataLine.Info info = new DataLine.Info(SourceDataLine.class, format);
return (SourceDataLine) AudioSystem.getLine(info);
}
/**
! * Obtains a source data line that can be used for playing back audio data
! * in the format specified by the {@code AudioFormat} object, provided by
! * the mixer specified by the {@code Mixer.Info} object.
! * <p>
! * The returned line should be opened with the {@code open(AudioFormat)} or
! * {@code open(AudioFormat, int)} method.
! * <p>
! * This is a high-level method that uses {@code getMixer} and
! * {@code getLine} internally.
! * <p>
! * The returned {@code SourceDataLine}'s default audio format will be
! * initialized with {@code format}.
! *
! * @param format an {@code AudioFormat} object specifying the supported
! * audio format of the returned line, or {@code null} for any audio
! * format
! * @param mixerinfo a {@code Mixer.Info} object representing the desired
! * mixer, or {@code null} for the system default mixer
! * @return the desired {@code SourceDataLine} object
! * @throws LineUnavailableException if a matching source data line is not
! * available from the specified mixer due to resource restrictions
! * @throws SecurityException if a matching source data line is not available
! * from the specified mixer due to security restrictions
! * @throws IllegalArgumentException if the specified mixer does not support
! * at least one source data line supporting the specified audio
! * format
* @see #getSourceDataLine(AudioFormat)
* @since 1.5
*/
public static SourceDataLine getSourceDataLine(AudioFormat format,
Mixer.Info mixerinfo)
*** 650,698 ****
DataLine.Info info = new DataLine.Info(SourceDataLine.class, format);
Mixer mixer = AudioSystem.getMixer(mixerinfo);
return (SourceDataLine) mixer.getLine(info);
}
-
/**
! * Obtains a target data line that can be used for recording
! * audio data in the format specified by the
! * <code>AudioFormat</code> object. The returned line
! * will be provided by the default system mixer, or,
! * if not possible, by any other mixer installed in the
! * system that supports a matching
! * <code>TargetDataLine</code> object.
! *
! * <p>The returned line should be opened with the
! * <code>open(AudioFormat)</code> or
! * <code>open(AudioFormat, int)</code> method.
! *
! * <p>This is a high-level method that uses <code>getMixer</code>
! * and <code>getLine</code> internally.
! *
! * <p>The returned <code>TargetDataLine</code>'s default
! * audio format will be initialized with <code>format</code>.
! *
! * <p>If the system property
! * {@code javax.sound.sampled.TargetDataLine}
! * is defined or it is defined in the file "sound.properties",
! * it is used to retrieve the default target data line.
! * For details, refer to the {@link AudioSystem class description}.
! *
! * @param format an <code>AudioFormat</code> object specifying
! * the supported audio format of the returned line,
! * or <code>null</code> for any audio format
! * @return the desired <code>TargetDataLine</code> object
! *
! * @throws LineUnavailableException if a matching target data line
! * is not available due to resource restrictions
! * @throws SecurityException if a matching target data line
! * is not available due to security restrictions
! * @throws IllegalArgumentException if the system does not
! * support at least one target data line supporting the
! * specified audio format through any installed mixer
! *
* @see #getTargetDataLine(AudioFormat, Mixer.Info)
* @see AudioPermission
* @since 1.5
*/
public static TargetDataLine getTargetDataLine(AudioFormat format)
--- 599,640 ----
DataLine.Info info = new DataLine.Info(SourceDataLine.class, format);
Mixer mixer = AudioSystem.getMixer(mixerinfo);
return (SourceDataLine) mixer.getLine(info);
}
/**
! * Obtains a target data line that can be used for recording audio data in
! * the format specified by the {@code AudioFormat} object. The returned line
! * will be provided by the default system mixer, or, if not possible, by any
! * other mixer installed in the system that supports a matching
! * {@code TargetDataLine} object.
! * <p>
! * The returned line should be opened with the {@code open(AudioFormat)} or
! * {@code open(AudioFormat, int)} method.
! * <p>
! * This is a high-level method that uses {@code getMixer} and
! * {@code getLine} internally.
! * <p>
! * The returned {@code TargetDataLine}'s default audio format will be
! * initialized with {@code format}.
! * <p>
! * If the system property {@code javax.sound.sampled.TargetDataLine} is
! * defined or it is defined in the file "sound.properties", it is used to
! * retrieve the default target data line. For details, refer to the
! * {@link AudioSystem class description}.
! *
! * @param format an {@code AudioFormat} object specifying the supported
! * audio format of the returned line, or {@code null} for any audio
! * format
! * @return the desired {@code TargetDataLine} object
! * @throws LineUnavailableException if a matching target data line is not
! * available due to resource restrictions
! * @throws SecurityException if a matching target data line is not available
! * due to security restrictions
! * @throws IllegalArgumentException if the system does not support at least
! * one target data line supporting the specified audio format
! * through any installed mixer
* @see #getTargetDataLine(AudioFormat, Mixer.Info)
* @see AudioPermission
* @since 1.5
*/
public static TargetDataLine getTargetDataLine(AudioFormat format)
*** 700,744 ****
DataLine.Info info = new DataLine.Info(TargetDataLine.class, format);
return (TargetDataLine) AudioSystem.getLine(info);
}
-
-
/**
! * Obtains a target data line that can be used for recording
! * audio data in the format specified by the
! * <code>AudioFormat</code> object, provided by the mixer
! * specified by the <code>Mixer.Info</code> object.
! *
! * <p>The returned line should be opened with the
! * <code>open(AudioFormat)</code> or
! * <code>open(AudioFormat, int)</code> method.
! *
! * <p>This is a high-level method that uses <code>getMixer</code>
! * and <code>getLine</code> internally.
! *
! * <p>The returned <code>TargetDataLine</code>'s default
! * audio format will be initialized with <code>format</code>.
! *
! * @param format an <code>AudioFormat</code> object specifying
! * the supported audio format of the returned line,
! * or <code>null</code> for any audio format
! * @param mixerinfo a <code>Mixer.Info</code> object representing the
! * desired mixer, or <code>null</code> for the system default mixer
! * @return the desired <code>TargetDataLine</code> object
! *
! * @throws LineUnavailableException if a matching target data
! * line is not available from the specified mixer due
! * to resource restrictions
! * @throws SecurityException if a matching target data line
! * is not available from the specified mixer due to
! * security restrictions
! * @throws IllegalArgumentException if the specified mixer does
! * not support at least one target data line supporting
! * the specified audio format
! *
* @see #getTargetDataLine(AudioFormat)
* @see AudioPermission
* @since 1.5
*/
public static TargetDataLine getTargetDataLine(AudioFormat format,
--- 642,678 ----
DataLine.Info info = new DataLine.Info(TargetDataLine.class, format);
return (TargetDataLine) AudioSystem.getLine(info);
}
/**
! * Obtains a target data line that can be used for recording audio data in
! * the format specified by the {@code AudioFormat} object, provided by the
! * mixer specified by the {@code Mixer.Info} object.
! * <p>
! * The returned line should be opened with the {@code open(AudioFormat)} or
! * {@code open(AudioFormat, int)} method.
! * <p>
! * This is a high-level method that uses {@code getMixer} and
! * {@code getLine} internally.
! * <p>
! * The returned {@code TargetDataLine}'s default audio format will be
! * initialized with {@code format}.
! *
! * @param format an {@code AudioFormat} object specifying the supported
! * audio format of the returned line, or {@code null} for any audio
! * format
! * @param mixerinfo a {@code Mixer.Info} object representing the desired
! * mixer, or {@code null} for the system default mixer
! * @return the desired {@code TargetDataLine} object
! * @throws LineUnavailableException if a matching target data line is not
! * available from the specified mixer due to resource restrictions
! * @throws SecurityException if a matching target data line is not available
! * from the specified mixer due to security restrictions
! * @throws IllegalArgumentException if the specified mixer does not support
! * at least one target data line supporting the specified audio
! * format
* @see #getTargetDataLine(AudioFormat)
* @see AudioPermission
* @since 1.5
*/
public static TargetDataLine getTargetDataLine(AudioFormat format,
*** 748,768 ****
DataLine.Info info = new DataLine.Info(TargetDataLine.class, format);
Mixer mixer = AudioSystem.getMixer(mixerinfo);
return (TargetDataLine) mixer.getLine(info);
}
-
// $$fb 2002-04-12: fix for 4662082: behavior of AudioSystem.getTargetEncodings() methods doesn't match the spec
/**
! * Obtains the encodings that the system can obtain from an
! * audio input stream with the specified encoding using the set
! * of installed format converters.
! * @param sourceEncoding the encoding for which conversion support
! * is queried
! * @return array of encodings. If <code>sourceEncoding</code>is not supported,
! * an array of length 0 is returned. Otherwise, the array will have a length
! * of at least 1, representing <code>sourceEncoding</code> (no conversion).
*/
public static AudioFormat.Encoding[] getTargetEncodings(AudioFormat.Encoding sourceEncoding) {
List codecs = getFormatConversionProviders();
Vector encodings = new Vector();
--- 682,704 ----
DataLine.Info info = new DataLine.Info(TargetDataLine.class, format);
Mixer mixer = AudioSystem.getMixer(mixerinfo);
return (TargetDataLine) mixer.getLine(info);
}
// $$fb 2002-04-12: fix for 4662082: behavior of AudioSystem.getTargetEncodings() methods doesn't match the spec
+
/**
! * Obtains the encodings that the system can obtain from an audio input
! * stream with the specified encoding using the set of installed format
! * converters.
! *
! * @param sourceEncoding the encoding for which conversion support is
! * queried
! * @return array of encodings. If {@code sourceEncoding}is not supported, an
! * array of length 0 is returned. Otherwise, the array will have a
! * length of at least 1, representing {@code sourceEncoding}
! * (no conversion).
*/
public static AudioFormat.Encoding[] getTargetEncodings(AudioFormat.Encoding sourceEncoding) {
List codecs = getFormatConversionProviders();
Vector encodings = new Vector();
*** 781,802 ****
}
AudioFormat.Encoding encs2[] = (AudioFormat.Encoding[]) encodings.toArray(new AudioFormat.Encoding[0]);
return encs2;
}
-
-
// $$fb 2002-04-12: fix for 4662082: behavior of AudioSystem.getTargetEncodings() methods doesn't match the spec
/**
! * Obtains the encodings that the system can obtain from an
! * audio input stream with the specified format using the set
! * of installed format converters.
! * @param sourceFormat the audio format for which conversion
! * is queried
! * @return array of encodings. If <code>sourceFormat</code>is not supported,
! * an array of length 0 is returned. Otherwise, the array will have a length
! * of at least 1, representing the encoding of <code>sourceFormat</code> (no conversion).
*/
public static AudioFormat.Encoding[] getTargetEncodings(AudioFormat sourceFormat) {
List codecs = getFormatConversionProviders();
--- 717,738 ----
}
AudioFormat.Encoding encs2[] = (AudioFormat.Encoding[]) encodings.toArray(new AudioFormat.Encoding[0]);
return encs2;
}
// $$fb 2002-04-12: fix for 4662082: behavior of AudioSystem.getTargetEncodings() methods doesn't match the spec
+
/**
! * Obtains the encodings that the system can obtain from an audio input
! * stream with the specified format using the set of installed format
! * converters.
! *
! * @param sourceFormat the audio format for which conversion is queried
! * @return array of encodings. If {@code sourceFormat}is not supported, an
! * array of length 0 is returned. Otherwise, the array will have a
! * length of at least 1, representing the encoding of
! * {@code sourceFormat} (no conversion).
*/
public static AudioFormat.Encoding[] getTargetEncodings(AudioFormat sourceFormat) {
List codecs = getFormatConversionProviders();
*** 824,842 ****
}
}
return encs2;
}
-
/**
! * Indicates whether an audio input stream of the specified encoding
! * can be obtained from an audio input stream that has the specified
! * format.
* @param targetEncoding the desired encoding after conversion
* @param sourceFormat the audio format before conversion
! * @return <code>true</code> if the conversion is supported,
! * otherwise <code>false</code>
*/
public static boolean isConversionSupported(AudioFormat.Encoding targetEncoding, AudioFormat sourceFormat) {
List codecs = getFormatConversionProviders();
--- 760,777 ----
}
}
return encs2;
}
/**
! * Indicates whether an audio input stream of the specified encoding can be
! * obtained from an audio input stream that has the specified format.
! *
* @param targetEncoding the desired encoding after conversion
* @param sourceFormat the audio format before conversion
! * @return {@code true} if the conversion is supported, otherwise
! * {@code false}
*/
public static boolean isConversionSupported(AudioFormat.Encoding targetEncoding, AudioFormat sourceFormat) {
List codecs = getFormatConversionProviders();
*** 848,861 ****
}
}
return false;
}
-
/**
! * Obtains an audio input stream of the indicated encoding, by converting the
! * provided audio input stream.
* @param targetEncoding the desired encoding after conversion
* @param sourceStream the stream to be converted
* @return an audio input stream of the indicated encoding
* @throws IllegalArgumentException if the conversion is not supported
* @see #getTargetEncodings(AudioFormat.Encoding)
--- 783,796 ----
}
}
return false;
}
/**
! * Obtains an audio input stream of the indicated encoding, by converting
! * the provided audio input stream.
! *
* @param targetEncoding the desired encoding after conversion
* @param sourceStream the stream to be converted
* @return an audio input stream of the indicated encoding
* @throws IllegalArgumentException if the conversion is not supported
* @see #getTargetEncodings(AudioFormat.Encoding)
*** 876,894 ****
}
// we ran out of options, throw an exception
throw new IllegalArgumentException("Unsupported conversion: " + targetEncoding + " from " + sourceStream.getFormat());
}
-
/**
! * Obtains the formats that have a particular encoding and that the system can
! * obtain from a stream of the specified format using the set of
* installed format converters.
* @param targetEncoding the desired encoding after conversion
* @param sourceFormat the audio format before conversion
! * @return array of formats. If no formats of the specified
! * encoding are supported, an array of length 0 is returned.
*/
public static AudioFormat[] getTargetFormats(AudioFormat.Encoding targetEncoding, AudioFormat sourceFormat) {
List codecs = getFormatConversionProviders();
Vector formats = new Vector();
--- 811,829 ----
}
// we ran out of options, throw an exception
throw new IllegalArgumentException("Unsupported conversion: " + targetEncoding + " from " + sourceStream.getFormat());
}
/**
! * Obtains the formats that have a particular encoding and that the system
! * can obtain from a stream of the specified format using the set of
* installed format converters.
+ *
* @param targetEncoding the desired encoding after conversion
* @param sourceFormat the audio format before conversion
! * @return array of formats. If no formats of the specified encoding are
! * supported, an array of length 0 is returned.
*/
public static AudioFormat[] getTargetFormats(AudioFormat.Encoding targetEncoding, AudioFormat sourceFormat) {
List codecs = getFormatConversionProviders();
Vector formats = new Vector();
*** 916,935 ****
}
}
return fmts2;
}
-
/**
! * Indicates whether an audio input stream of a specified format
! * can be obtained from an audio input stream of another specified format.
* @param targetFormat the desired audio format after conversion
* @param sourceFormat the audio format before conversion
! * @return <code>true</code> if the conversion is supported,
! * otherwise <code>false</code>
*/
-
public static boolean isConversionSupported(AudioFormat targetFormat, AudioFormat sourceFormat) {
List codecs = getFormatConversionProviders();
for(int i=0; i<codecs.size(); i++ ) {
--- 851,869 ----
}
}
return fmts2;
}
/**
! * Indicates whether an audio input stream of a specified format can be
! * obtained from an audio input stream of another specified format.
! *
* @param targetFormat the desired audio format after conversion
* @param sourceFormat the audio format before conversion
! * @return {@code true} if the conversion is supported, otherwise
! * {@code false}
*/
public static boolean isConversionSupported(AudioFormat targetFormat, AudioFormat sourceFormat) {
List codecs = getFormatConversionProviders();
for(int i=0; i<codecs.size(); i++ ) {
*** 939,957 ****
}
}
return false;
}
-
/**
* Obtains an audio input stream of the indicated format, by converting the
* provided audio input stream.
* @param targetFormat the desired audio format after conversion
* @param sourceStream the stream to be converted
* @return an audio input stream of the indicated format
* @throws IllegalArgumentException if the conversion is not supported
! * #see #getTargetEncodings(AudioFormat)
* @see #getTargetFormats(AudioFormat.Encoding, AudioFormat)
* @see #isConversionSupported(AudioFormat, AudioFormat)
* @see #getAudioInputStream(AudioFormat.Encoding, AudioInputStream)
*/
public static AudioInputStream getAudioInputStream(AudioFormat targetFormat,
--- 873,891 ----
}
}
return false;
}
/**
* Obtains an audio input stream of the indicated format, by converting the
* provided audio input stream.
+ *
* @param targetFormat the desired audio format after conversion
* @param sourceStream the stream to be converted
* @return an audio input stream of the indicated format
* @throws IllegalArgumentException if the conversion is not supported
! * @see #getTargetEncodings(AudioFormat)
* @see #getTargetFormats(AudioFormat.Encoding, AudioFormat)
* @see #isConversionSupported(AudioFormat, AudioFormat)
* @see #getAudioInputStream(AudioFormat.Encoding, AudioInputStream)
*/
public static AudioInputStream getAudioInputStream(AudioFormat targetFormat,
*** 972,995 ****
// we ran out of options...
throw new IllegalArgumentException("Unsupported conversion: " + targetFormat + " from " + sourceStream.getFormat());
}
-
/**
! * Obtains the audio file format of the provided input stream. The stream must
! * point to valid audio file data. The implementation of this method may require
! * multiple parsers to examine the stream to determine whether they support it.
! * These parsers must be able to mark the stream, read enough data to determine whether they
! * support the stream, and, if not, reset the stream's read pointer to its original
! * position. If the input stream does not support these operations, this method may fail
! * with an <code>IOException</code>.
! * @param stream the input stream from which file format information should be
! * extracted
! * @return an <code>AudioFileFormat</code> object describing the stream's audio file format
! * @throws UnsupportedAudioFileException if the stream does not point to valid audio
! * file data recognized by the system
* @throws IOException if an input/output exception occurs
* @see InputStream#markSupported
* @see InputStream#mark
*/
public static AudioFileFormat getAudioFileFormat(InputStream stream)
--- 906,931 ----
// we ran out of options...
throw new IllegalArgumentException("Unsupported conversion: " + targetFormat + " from " + sourceStream.getFormat());
}
/**
! * Obtains the audio file format of the provided input stream. The stream
! * must point to valid audio file data. The implementation of this method
! * may require multiple parsers to examine the stream to determine whether
! * they support it. These parsers must be able to mark the stream, read
! * enough data to determine whether they support the stream, and, if not,
! * reset the stream's read pointer to its original position. If the input
! * stream does not support these operations, this method may fail with an
! * {@code IOException}.
! *
! * @param stream the input stream from which file format information should
! * be extracted
! * @return an {@code AudioFileFormat} object describing the stream's audio
! * file format
! * @throws UnsupportedAudioFileException if the stream does not point to
! * valid audio file data recognized by the system
* @throws IOException if an input/output exception occurs
* @see InputStream#markSupported
* @see InputStream#mark
*/
public static AudioFileFormat getAudioFileFormat(InputStream stream)
*** 1014,1030 ****
return format;
}
}
/**
! * Obtains the audio file format of the specified URL. The URL must
! * point to valid audio file data.
* @param url the URL from which file format information should be
* extracted
! * @return an <code>AudioFileFormat</code> object describing the audio file format
! * @throws UnsupportedAudioFileException if the URL does not point to valid audio
! * file data recognized by the system
* @throws IOException if an input/output exception occurs
*/
public static AudioFileFormat getAudioFileFormat(URL url)
throws UnsupportedAudioFileException, IOException {
--- 950,968 ----
return format;
}
}
/**
! * Obtains the audio file format of the specified URL. The URL must point to
! * valid audio file data.
! *
* @param url the URL from which file format information should be
* extracted
! * @return an {@code AudioFileFormat} object describing the audio file
! * format
! * @throws UnsupportedAudioFileException if the URL does not point to valid
! * audio file data recognized by the system
* @throws IOException if an input/output exception occurs
*/
public static AudioFileFormat getAudioFileFormat(URL url)
throws UnsupportedAudioFileException, IOException {
*** 1047,1063 ****
return format;
}
}
/**
! * Obtains the audio file format of the specified <code>File</code>. The <code>File</code> must
! * point to valid audio file data.
! * @param file the <code>File</code> from which file format information should be
! * extracted
! * @return an <code>AudioFileFormat</code> object describing the audio file format
! * @throws UnsupportedAudioFileException if the <code>File</code> does not point to valid audio
! * file data recognized by the system
* @throws IOException if an I/O exception occurs
*/
public static AudioFileFormat getAudioFileFormat(File file)
throws UnsupportedAudioFileException, IOException {
--- 985,1003 ----
return format;
}
}
/**
! * Obtains the audio file format of the specified {@code File}. The
! * {@code File} must point to valid audio file data.
! *
! * @param file the {@code File} from which file format information should
! * be extracted
! * @return an {@code AudioFileFormat} object describing the audio file
! * format
! * @throws UnsupportedAudioFileException if the {@code File} does not point
! * to valid audio file data recognized by the system
* @throws IOException if an I/O exception occurs
*/
public static AudioFileFormat getAudioFileFormat(File file)
throws UnsupportedAudioFileException, IOException {
*** 1079,1104 ****
} else {
return format;
}
}
-
/**
! * Obtains an audio input stream from the provided input stream. The stream must
! * point to valid audio file data. The implementation of this method may
! * require multiple parsers to
! * examine the stream to determine whether they support it. These parsers must
! * be able to mark the stream, read enough data to determine whether they
! * support the stream, and, if not, reset the stream's read pointer to its original
! * position. If the input stream does not support these operation, this method may fail
! * with an <code>IOException</code>.
! * @param stream the input stream from which the <code>AudioInputStream</code> should be
! * constructed
! * @return an <code>AudioInputStream</code> object based on the audio file data contained
! * in the input stream.
! * @throws UnsupportedAudioFileException if the stream does not point to valid audio
! * file data recognized by the system
* @throws IOException if an I/O exception occurs
* @see InputStream#markSupported
* @see InputStream#mark
*/
public static AudioInputStream getAudioInputStream(InputStream stream)
--- 1019,1044 ----
} else {
return format;
}
}
/**
! * Obtains an audio input stream from the provided input stream. The stream
! * must point to valid audio file data. The implementation of this method
! * may require multiple parsers to examine the stream to determine whether
! * they support it. These parsers must be able to mark the stream, read
! * enough data to determine whether they support the stream, and, if not,
! * reset the stream's read pointer to its original position. If the input
! * stream does not support these operation, this method may fail with an
! * {@code IOException}.
! *
! * @param stream the input stream from which the {@code AudioInputStream}
! * should be constructed
! * @return an {@code AudioInputStream} object based on the audio file data
! * contained in the input stream
! * @throws UnsupportedAudioFileException if the stream does not point to
! * valid audio file data recognized by the system
* @throws IOException if an I/O exception occurs
* @see InputStream#markSupported
* @see InputStream#mark
*/
public static AudioInputStream getAudioInputStream(InputStream stream)
*** 1123,1140 ****
return audioStream;
}
}
/**
! * Obtains an audio input stream from the URL provided. The URL must
! * point to valid audio file data.
! * @param url the URL for which the <code>AudioInputStream</code> should be
* constructed
! * @return an <code>AudioInputStream</code> object based on the audio file data pointed
! * to by the URL
! * @throws UnsupportedAudioFileException if the URL does not point to valid audio
! * file data recognized by the system
* @throws IOException if an I/O exception occurs
*/
public static AudioInputStream getAudioInputStream(URL url)
throws UnsupportedAudioFileException, IOException {
--- 1063,1081 ----
return audioStream;
}
}
/**
! * Obtains an audio input stream from the URL provided. The URL must point
! * to valid audio file data.
! *
! * @param url the URL for which the {@code AudioInputStream} should be
* constructed
! * @return an {@code AudioInputStream} object based on the audio file data
! * pointed to by the URL
! * @throws UnsupportedAudioFileException if the URL does not point to valid
! * audio file data recognized by the system
* @throws IOException if an I/O exception occurs
*/
public static AudioInputStream getAudioInputStream(URL url)
throws UnsupportedAudioFileException, IOException {
*** 1157,1174 ****
return audioStream;
}
}
/**
! * Obtains an audio input stream from the provided <code>File</code>. The <code>File</code> must
! * point to valid audio file data.
! * @param file the <code>File</code> for which the <code>AudioInputStream</code> should be
! * constructed
! * @return an <code>AudioInputStream</code> object based on the audio file data pointed
! * to by the <code>File</code>
! * @throws UnsupportedAudioFileException if the <code>File</code> does not point to valid audio
! * file data recognized by the system
* @throws IOException if an I/O exception occurs
*/
public static AudioInputStream getAudioInputStream(File file)
throws UnsupportedAudioFileException, IOException {
--- 1098,1116 ----
return audioStream;
}
}
/**
! * Obtains an audio input stream from the provided {@code File}. The
! * {@code File} must point to valid audio file data.
! *
! * @param file the {@code File} for which the {@code AudioInputStream}
! * should be constructed
! * @return an {@code AudioInputStream} object based on the audio file data
! * pointed to by the {@code File}
! * @throws UnsupportedAudioFileException if the {@code File} does not point
! * to valid audio file data recognized by the system
* @throws IOException if an I/O exception occurs
*/
public static AudioInputStream getAudioInputStream(File file)
throws UnsupportedAudioFileException, IOException {
*** 1190,1204 ****
} else {
return audioStream;
}
}
-
/**
! * Obtains the file types for which file writing support is provided by the system.
! * @return array of unique file types. If no file types are supported,
! * an array of length 0 is returned.
*/
public static AudioFileFormat.Type[] getAudioFileTypes() {
List providers = getAudioFileWriters();
Set returnTypesSet = new HashSet();
--- 1132,1147 ----
} else {
return audioStream;
}
}
/**
! * Obtains the file types for which file writing support is provided by the
! * system.
! *
! * @return array of unique file types. If no file types are supported, an
! * array of length 0 is returned.
*/
public static AudioFileFormat.Type[] getAudioFileTypes() {
List providers = getAudioFileWriters();
Set returnTypesSet = new HashSet();
*** 1212,1228 ****
AudioFileFormat.Type returnTypes[] = (AudioFileFormat.Type[])
returnTypesSet.toArray(new AudioFileFormat.Type[0]);
return returnTypes;
}
-
/**
! * Indicates whether file writing support for the specified file type is provided
! * by the system.
* @param fileType the file type for which write capabilities are queried
! * @return <code>true</code> if the file type is supported,
! * otherwise <code>false</code>
*/
public static boolean isFileTypeSupported(AudioFileFormat.Type fileType) {
List providers = getAudioFileWriters();
--- 1155,1171 ----
AudioFileFormat.Type returnTypes[] = (AudioFileFormat.Type[])
returnTypesSet.toArray(new AudioFileFormat.Type[0]);
return returnTypes;
}
/**
! * Indicates whether file writing support for the specified file type is
! * provided by the system.
! *
* @param fileType the file type for which write capabilities are queried
! * @return {@code true} if the file type is supported, otherwise
! * {@code false}
*/
public static boolean isFileTypeSupported(AudioFileFormat.Type fileType) {
List providers = getAudioFileWriters();
*** 1233,1250 ****
}
}
return false;
}
-
/**
! * Obtains the file types that the system can write from the
! * audio input stream specified.
! * @param stream the audio input stream for which audio file type support
! * is queried
! * @return array of file types. If no file types are supported,
! * an array of length 0 is returned.
*/
public static AudioFileFormat.Type[] getAudioFileTypes(AudioInputStream stream) {
List providers = getAudioFileWriters();
Set returnTypesSet = new HashSet();
--- 1176,1193 ----
}
}
return false;
}
/**
! * Obtains the file types that the system can write from the audio input
! * stream specified.
! *
! * @param stream the audio input stream for which audio file type
! * support is queried
! * @return array of file types. If no file types are supported, an array of
! * length 0 is returned.
*/
public static AudioFileFormat.Type[] getAudioFileTypes(AudioInputStream stream) {
List providers = getAudioFileWriters();
Set returnTypesSet = new HashSet();
*** 1258,1275 ****
AudioFileFormat.Type returnTypes[] = (AudioFileFormat.Type[])
returnTypesSet.toArray(new AudioFileFormat.Type[0]);
return returnTypes;
}
-
/**
* Indicates whether an audio file of the specified file type can be written
* from the indicated audio input stream.
* @param fileType the file type for which write capabilities are queried
* @param stream the stream for which file-writing support is queried
! * @return <code>true</code> if the file type is supported for this audio input stream,
! * otherwise <code>false</code>
*/
public static boolean isFileTypeSupported(AudioFileFormat.Type fileType,
AudioInputStream stream) {
List providers = getAudioFileWriters();
--- 1201,1218 ----
AudioFileFormat.Type returnTypes[] = (AudioFileFormat.Type[])
returnTypesSet.toArray(new AudioFileFormat.Type[0]);
return returnTypes;
}
/**
* Indicates whether an audio file of the specified file type can be written
* from the indicated audio input stream.
+ *
* @param fileType the file type for which write capabilities are queried
* @param stream the stream for which file-writing support is queried
! * @return {@code true} if the file type is supported for this audio input
! * stream, otherwise {@code false}
*/
public static boolean isFileTypeSupported(AudioFileFormat.Type fileType,
AudioInputStream stream) {
List providers = getAudioFileWriters();
*** 1281,1307 ****
}
}
return false;
}
-
/**
! * Writes a stream of bytes representing an audio file of the specified file type
! * to the output stream provided. Some file types require that
! * the length be written into the file header; such files cannot be written from
! * start to finish unless the length is known in advance. An attempt
! * to write a file of such a type will fail with an IOException if the length in
! * the audio file type is <code>AudioSystem.NOT_SPECIFIED</code>.
*
! * @param stream the audio input stream containing audio data to be
! * written to the file
* @param fileType the kind of audio file to write
* @param out the stream to which the file data should be written
* @return the number of bytes written to the output stream
* @throws IOException if an input/output exception occurs
! * @throws IllegalArgumentException if the file type is not supported by
! * the system
* @see #isFileTypeSupported
* @see #getAudioFileTypes
*/
public static int write(AudioInputStream stream, AudioFileFormat.Type fileType,
OutputStream out) throws IOException {
--- 1224,1249 ----
}
}
return false;
}
/**
! * Writes a stream of bytes representing an audio file of the specified file
! * type to the output stream provided. Some file types require that the
! * length be written into the file header; such files cannot be written from
! * start to finish unless the length is known in advance. An attempt to
! * write a file of such a type will fail with an IOException if the length
! * in the audio file type is {@code AudioSystem.NOT_SPECIFIED}.
*
! * @param stream the audio input stream containing audio data to be written
! * to the file
* @param fileType the kind of audio file to write
* @param out the stream to which the file data should be written
* @return the number of bytes written to the output stream
* @throws IOException if an input/output exception occurs
! * @throws IllegalArgumentException if the file type is not supported by the
! * system
* @see #isFileTypeSupported
* @see #getAudioFileTypes
*/
public static int write(AudioInputStream stream, AudioFileFormat.Type fileType,
OutputStream out) throws IOException {
*** 1326,1347 ****
} else {
return bytesWritten;
}
}
-
/**
! * Writes a stream of bytes representing an audio file of the specified file type
! * to the external file provided.
! * @param stream the audio input stream containing audio data to be
! * written to the file
* @param fileType the kind of audio file to write
* @param out the external file to which the file data should be written
* @return the number of bytes written to the file
* @throws IOException if an I/O exception occurs
! * @throws IllegalArgumentException if the file type is not supported by
! * the system
* @see #isFileTypeSupported
* @see #getAudioFileTypes
*/
public static int write(AudioInputStream stream, AudioFileFormat.Type fileType,
File out) throws IOException {
--- 1268,1289 ----
} else {
return bytesWritten;
}
}
/**
! * Writes a stream of bytes representing an audio file of the specified file
! * type to the external file provided.
! *
! * @param stream the audio input stream containing audio data to be written
! * to the file
* @param fileType the kind of audio file to write
* @param out the external file to which the file data should be written
* @return the number of bytes written to the file
* @throws IOException if an I/O exception occurs
! * @throws IllegalArgumentException if the file type is not supported by the
! * system
* @see #isFileTypeSupported
* @see #getAudioFileTypes
*/
public static int write(AudioInputStream stream, AudioFileFormat.Type fileType,
File out) throws IOException {
*** 1366,1434 ****
} else {
return bytesWritten;
}
}
-
// METHODS FOR INTERNAL IMPLEMENTATION USE
/**
* Obtains the set of MixerProviders on the system.
*/
private static List getMixerProviders() {
return getProviders(MixerProvider.class);
}
-
/**
! * Obtains the set of format converters (codecs, transcoders, etc.)
! * that are currently installed on the system.
! * @return an array of
! * {@link javax.sound.sampled.spi.FormatConversionProvider
! * FormatConversionProvider}
! * objects representing the available format converters. If no format
! * converters readers are available on the system, an array of length 0 is
! * returned.
*/
private static List getFormatConversionProviders() {
return getProviders(FormatConversionProvider.class);
}
-
/**
! * Obtains the set of audio file readers that are currently installed on the system.
! * @return a List of
! * {@link javax.sound.sampled.spi.AudioFileReader
! * AudioFileReader}
! * objects representing the installed audio file readers. If no audio file
! * readers are available on the system, an empty List is returned.
*/
private static List getAudioFileReaders() {
return getProviders(AudioFileReader.class);
}
-
/**
! * Obtains the set of audio file writers that are currently installed on the system.
! * @return a List of
! * {@link javax.sound.samples.spi.AudioFileWriter AudioFileWriter}
! * objects representing the available audio file writers. If no audio file
! * writers are available on the system, an empty List is returned.
*/
private static List getAudioFileWriters() {
return getProviders(AudioFileWriter.class);
}
!
!
! /** Attempts to locate and return a default Mixer that provides lines
! * of the specified type.
*
* @param providers the installed mixer providers
! * @param info The requested line type
! * TargetDataLine.class, Clip.class or Port.class.
! * @return a Mixer that matches the requirements, or null if no default mixer found
*/
private static Mixer getDefaultMixer(List providers, Line.Info info) {
Class lineClass = info.getLineClass();
String providerClassName = JDK13Services.getDefaultProviderClassName(lineClass);
String instanceName = JDK13Services.getDefaultInstanceName(lineClass);
--- 1308,1374 ----
} else {
return bytesWritten;
}
}
// METHODS FOR INTERNAL IMPLEMENTATION USE
/**
* Obtains the set of MixerProviders on the system.
*/
private static List getMixerProviders() {
return getProviders(MixerProvider.class);
}
/**
! * Obtains the set of format converters (codecs, transcoders, etc.) that are
! * currently installed on the system.
! *
! * @return an array of {@link javax.sound.sampled.spi.FormatConversionProvider
! * FormatConversionProvider} objects representing the available
! * format converters. If no format converters readers are available
! * on the system, an array of length 0 is returned.
*/
private static List getFormatConversionProviders() {
return getProviders(FormatConversionProvider.class);
}
/**
! * Obtains the set of audio file readers that are currently installed on the
! * system.
! *
! * @return a List of {@link javax.sound.sampled.spi.AudioFileReader
! * AudioFileReader} objects representing the installed audio file
! * readers. If no audio file readers are available on the system, an
! * empty List is returned.
*/
private static List getAudioFileReaders() {
return getProviders(AudioFileReader.class);
}
/**
! * Obtains the set of audio file writers that are currently installed on the
! * system.
! *
! * @return a List of {@link javax.sound.sampled.spi.AudioFileWriter
! * AudioFileWriter} objects representing the available audio file
! * writers. If no audio file writers are available on the system, an
! * empty List is returned.
*/
private static List getAudioFileWriters() {
return getProviders(AudioFileWriter.class);
}
! /**
! * Attempts to locate and return a default Mixer that provides lines of the
! * specified type.
*
* @param providers the installed mixer providers
! * @param info The requested line type TargetDataLine.class, Clip.class or
! * Port.class
! * @return a Mixer that matches the requirements, or null if no default
! * mixer found
*/
private static Mixer getDefaultMixer(List providers, Line.Info info) {
Class lineClass = info.getLineClass();
String providerClassName = JDK13Services.getDefaultProviderClassName(lineClass);
String instanceName = JDK13Services.getDefaultInstanceName(lineClass);
*** 1467,1486 ****
/* No default are specified, or if something is specified, everything
failed. */
return null;
}
!
!
! /** Return a MixerProvider of a given class from the list of
! MixerProviders.
!
! This method never requires the returned Mixer to do mixing.
! @param providerClassName The class name of the provider to be returned.
! @param providers The list of MixerProviders that is searched.
! @return A MixerProvider of the requested class, or null if none is
! found.
*/
private static MixerProvider getNamedProvider(String providerClassName,
List providers) {
for(int i = 0; i < providers.size(); i++) {
MixerProvider provider = (MixerProvider) providers.get(i);
--- 1407,1423 ----
/* No default are specified, or if something is specified, everything
failed. */
return null;
}
! /**
! * Return a MixerProvider of a given class from the list of MixerProviders.
! * This method never requires the returned Mixer to do mixing.
! *
! * @param providerClassName The class name of the provider to be returned
! * @param providers The list of MixerProviders that is searched
! * @return A MixerProvider of the requested class, or null if none is found
*/
private static MixerProvider getNamedProvider(String providerClassName,
List providers) {
for(int i = 0; i < providers.size(); i++) {
MixerProvider provider = (MixerProvider) providers.get(i);
*** 1489,1507 ****
}
}
return null;
}
!
! /** Return a Mixer with a given name from a given MixerProvider.
! This method never requires the returned Mixer to do mixing.
! @param mixerName The name of the Mixer to be returned.
! @param provider The MixerProvider to check for Mixers.
! @param info The type of line the returned Mixer is required to
! support.
!
! @return A Mixer matching the requirements, or null if none is found.
*/
private static Mixer getNamedMixer(String mixerName,
MixerProvider provider,
Line.Info info) {
Mixer.Info[] infos = provider.getMixerInfo();
--- 1426,1443 ----
}
}
return null;
}
! /**
! * Return a Mixer with a given name from a given MixerProvider. This method
! * never requires the returned Mixer to do mixing.
! *
! * @param mixerName The name of the Mixer to be returned
! * @param provider The MixerProvider to check for Mixers
! * @param info The type of line the returned Mixer is required to support
! * @return A Mixer matching the requirements, or null if none is found
*/
private static Mixer getNamedMixer(String mixerName,
MixerProvider provider,
Line.Info info) {
Mixer.Info[] infos = provider.getMixerInfo();
*** 1514,1531 ****
}
}
return null;
}
!
! /** From a List of MixerProviders, return a Mixer with a given name.
! This method never requires the returned Mixer to do mixing.
! @param mixerName The name of the Mixer to be returned.
! @param providers The List of MixerProviders to check for Mixers.
! @param info The type of line the returned Mixer is required to
! support.
! @return A Mixer matching the requirements, or null if none is found.
*/
private static Mixer getNamedMixer(String mixerName,
List providers,
Line.Info info) {
for(int i = 0; i < providers.size(); i++) {
--- 1450,1467 ----
}
}
return null;
}
! /**
! * From a List of MixerProviders, return a Mixer with a given name. This
! * method never requires the returned Mixer to do mixing.
! *
! * @param mixerName The name of the Mixer to be returned
! * @param providers The List of MixerProviders to check for Mixers
! * @param info The type of line the returned Mixer is required to support
! * @return A Mixer matching the requirements, or null if none is found
*/
private static Mixer getNamedMixer(String mixerName,
List providers,
Line.Info info) {
for(int i = 0; i < providers.size(); i++) {
*** 1536,1555 ****
}
}
return null;
}
!
! /** From a given MixerProvider, return the first appropriate Mixer.
! @param provider The MixerProvider to check for Mixers.
! @param info The type of line the returned Mixer is required to
! support.
! @param isMixingRequired If true, only Mixers that support mixing are
! returned for line types of SourceDataLine and Clip.
!
! @return A Mixer that is considered appropriate, or null
! if none is found.
*/
private static Mixer getFirstMixer(MixerProvider provider,
Line.Info info,
boolean isMixingRequired) {
Mixer.Info[] infos = provider.getMixerInfo();
--- 1472,1489 ----
}
}
return null;
}
! /**
! * From a given MixerProvider, return the first appropriate Mixer.
! *
! * @param provider The MixerProvider to check for Mixers
! * @param info The type of line the returned Mixer is required to support
! * @param isMixingRequired If true, only Mixers that support mixing are
! * returned for line types of SourceDataLine and Clip
! * @return A Mixer that is considered appropriate, or null if none is found
*/
private static Mixer getFirstMixer(MixerProvider provider,
Line.Info info,
boolean isMixingRequired) {
Mixer.Info[] infos = provider.getMixerInfo();
*** 1560,1578 ****
}
}
return null;
}
!
! /** Checks if a Mixer is appropriate.
! A Mixer is considered appropriate if it support the given line type.
! If isMixingRequired is true and the line type is an output one
! (SourceDataLine, Clip), the mixer is appropriate if it supports
! at least 2 (concurrent) lines of the given type.
!
! @return true if the mixer is considered appropriate according to the
! rules given above, false otherwise.
*/
private static boolean isAppropriateMixer(Mixer mixer,
Line.Info lineInfo,
boolean isMixingRequired) {
if (! mixer.isLineSupported(lineInfo)) {
--- 1494,1511 ----
}
}
return null;
}
! /**
! * Checks if a Mixer is appropriate. A Mixer is considered appropriate if it
! * support the given line type. If isMixingRequired is true and the line
! * type is an output one (SourceDataLine, Clip), the mixer is appropriate if
! * it supports at least 2 (concurrent) lines of the given type.
! *
! * @return {@code true} if the mixer is considered appropriate according to
! * the rules given above, {@code false} otherwise
*/
private static boolean isAppropriateMixer(Mixer mixer,
Line.Info lineInfo,
boolean isMixingRequired) {
if (! mixer.isLineSupported(lineInfo)) {
*** 1586,1608 ****
return ((maxLines == NOT_SPECIFIED) || (maxLines > 1));
}
return true;
}
-
-
/**
! * Like getMixerInfo, but return List
*/
private static List getMixerInfoList() {
List providers = getMixerProviders();
return getMixerInfoList(providers);
}
-
/**
! * Like getMixerInfo, but return List
*/
private static List getMixerInfoList(List providers) {
List infos = new ArrayList();
Mixer.Info[] someInfos; // per-mixer
--- 1519,1538 ----
return ((maxLines == NOT_SPECIFIED) || (maxLines > 1));
}
return true;
}
/**
! * Like getMixerInfo, but return List.
*/
private static List getMixerInfoList() {
List providers = getMixerProviders();
return getMixerInfoList(providers);
}
/**
! * Like getMixerInfo, but return List.
*/
private static List getMixerInfoList(List providers) {
List infos = new ArrayList();
Mixer.Info[] someInfos; // per-mixer
*** 1617,1632 ****
}
return infos;
}
-
/**
! * Obtains the set of services currently installed on the system
! * using the SPI mechanism in 1.3.
! * @return a List of instances of providers for the requested service.
! * If no providers are available, a vector of length 0 will be returned.
*/
private static List getProviders(Class providerClass) {
return JDK13Services.getProviders(providerClass);
}
}
--- 1547,1562 ----
}
return infos;
}
/**
! * Obtains the set of services currently installed on the system using the
! * SPI mechanism in 1.3.
! *
! * @return a List of instances of providers for the requested service. If no
! * providers are available, a vector of length 0 will be returned.
*/
private static List getProviders(Class providerClass) {
return JDK13Services.getProviders(providerClass);
}
}