Changeset 5871 in josm for trunk/src/org/openstreetmap/josm/tools

Timestamp:

2013-04-15T23:12:33+02:00 (12 years ago)

Author:

Don-vip

Message:

fix #8611 (audio slower broken) + update all audio javadoc

Location:

trunk/src/org/openstreetmap/josm/tools

Files:

• AudioPlayer.java (modified) (8 diffs)
• AudioUtil.java (modified) (2 diffs)

trunk/src/org/openstreetmap/josm/tools/AudioPlayer.java

@@ -20 +20 @@
  *
  * @author David Earl <david@frankieandshadow.com>
- *
+ * @since 547
  */
 public class AudioPlayer extends Thread {
@@ -104 +104 @@
      * start at the beginning of the stream
      * @param url The resource to play, which must be a WAV file or stream
-     * @throws audio fault exception, e.g. can't open stream,  unhandleable audio format
+     * @throws Exception audio fault exception, e.g. can't open stream,  unhandleable audio format
      */
     public static void play(URL url) throws Exception {
@@ -114 +114 @@
      * @param url The resource to play, which must be a WAV file or stream
      * @param seconds The number of seconds into the audio to start playing
-     * @throws audio fault exception, e.g. can't open stream,  unhandleable audio format
+     * @throws Exception audio fault exception, e.g. can't open stream,  unhandleable audio format
      */
     public static void play(URL url, double seconds) throws Exception {
@@ -125 +125 @@
      * @param seconds The number of seconds into the audio to start playing
      * @param speed Rate at which audio playes (1.0 = real time, > 1 is faster)
-     * @throws audio fault exception, e.g. can't open stream,  unhandleable audio format
+     * @throws Exception audio fault exception, e.g. can't open stream,  unhandleable audio format
      */
     public static void play(URL url, double seconds, double speed) throws Exception {
@@ -133 +133 @@
     /**
      * Pauses the currently playing audio stream. Does nothing if nothing playing.
-     * @throws audio fault exception, e.g. can't open stream,  unhandleable audio format
+     * @throws Exception audio fault exception, e.g. can't open stream,  unhandleable audio format
      */
     public static void pause() throws Exception {
@@ -194 +194 @@
     }
 
+    /**
+     * Resets the audio player.
+     */
     public static void reset() {
         if(audioPlayer != null)
@@ -208 +211 @@
         command = new Execute();
         playingUrl = null;
-        leadIn = Main.pref.getDouble("audio.leadin", "1.0" /* default, seconds */);
-        calibration = Main.pref.getDouble("audio.calibration", "1.0" /* default, ratio */);
+        leadIn = Main.pref.getDouble("audio.leadin", 1.0 /* default, seconds */);
+        calibration = Main.pref.getDouble("audio.calibration", 1.0 /* default, ratio */);
         start();
         while (state == State.INITIALIZING) { yield(); }
@@ -338 +341 @@
     }
 
+    /**
+     * Shows a popup audio error message for the given exception. 
+     * @param ex The exception used as error reason. Cannot be {@code null}.
+     */
     public static void audioMalfunction(Exception ex) {
         String msg = ex.getMessage();

trunk/src/org/openstreetmap/josm/tools/AudioUtil.java

@@ -12 +12 @@
 
 /**
- * Returns calibrated length of recording in seconds.
+ * Utils functions for audio.
  *
  * @author David Earl <david@frankieandshadow.com>
- *
+ * @since 1462
  */
 public class AudioUtil {
+    
+    /**
+     * Returns calibrated length of recording in seconds.
+     * @param wavFile the recording file (WAV format)
+     * @return the calibrated length of recording in seconds.
+     */
     static public double getCalibratedDuration(File wavFile) {
         try {
@@ -28 +34 @@
             double naturalLength = filesize / bytesPerSecond;
             audioInputStream.close();
-            double calibration = Main.pref.getDouble("audio.calibration", "1.0" /* default, ratio */);
+            double calibration = Main.pref.getDouble("audio.calibration", 1.0 /* default, ratio */);
             return naturalLength / calibration;
         } catch (Exception e) {