1.1 --- a/src/com/aurellem/capture/Capture.java	Sat Dec 03 13:54:47 2011 -0600
     1.2 +++ b/src/com/aurellem/capture/Capture.java	Sat Dec 03 19:15:43 2011 -0600
     1.3 @@ -18,20 +18,53 @@
     1.4  import com.jme3.system.JmeSystem;
     1.5  
     1.6  /**
     1.7 + * Use the methods in this class for capturing consistent, high quality video and audio from a 
     1.8 + * jMonkeyEngine3 application.  To capture audio or video do the following:
     1.9   * 
    1.10 + * 1.) Set your application's timer to an IsoTimer. Create the IsoTimer with the desired video
    1.11 + *     frames-per-second.
    1.12 + * 2.) Call captureAudio and/or captureVideo on the Application as desired.
    1.13 + *
    1.14   * @author Robert McIntyre
    1.15 - *
    1.16   */
    1.17  
    1.18  public class Capture {
    1.19  
    1.20 +	/**
    1.21 +	 * Use this function to capture video from your application.  You specify the framerate at which
    1.22 +	 * the video will be recording by setting the Application's timer to an IsoTimer created with the 
    1.23 +	 * desired frames-per-second. 
    1.24 +	 * 
    1.25 +	 * There are three ways to record and they are selected by the properties of the file that you 
    1.26 +	 * specify.
    1.27 +	 * 
    1.28 +	 * 1.) (Preferred)
    1.29 +	 *     If you supply an empty directory as the file, then the video will
    1.30 +	 *     be saved as a sequence of .png files, one file per frame.  The files start at
    1.31 +	 *     0000000.png and increment from there.  You can then combine the frames into your  
    1.32 +	 *     preferred container/codec. If the directory is not empty, then writing video frames
    1.33 +	 *     to it will fail, and nothing will be written.
    1.34 +	 *     
    1.35 +	 * 2.) If the filename ends in ".avi" then the frames will be encoded as a RAW stream
    1.36 +	 *     inside an AVI 1.0 container.  The resulting file will be quite large and you will
    1.37 +	 *     probably want to re-encode it to your preferred container/codec format.  Be advised
    1.38 +	 *     that some video payers cannot process AVI with a RAW stream, and that AVI 1.0 files
    1.39 +	 *     generated by this method that exceed 2.0GB are invalid according to the AVI 1.0 spec
    1.40 +	 *     (but many programs can still deal with them.)  Thanks to Werner Randelshofer for his 
    1.41 +	 *     excellent work which made AVI file writer option possible.
    1.42 +	 *  
    1.43 +	 * 3.) Any non-directory file ending in anything other than ".avi" will be processed through 
    1.44 +	 *     Xuggle.  Xuggle provides the option to use many codecs/containers, but you will have to 
    1.45 +	 *     install it on your system yourself in order to use this option. Please visit 
    1.46 +	 *     http://www.xuggle.com/ to learn how to do this.
    1.47 +	 * 
    1.48 +	 * @param app The Application from which you wish to record Video.
    1.49 +	 * @param file The file to which the video will be captured. 
    1.50 +	 * @throws IOException
    1.51 +	 */
    1.52 +	
    1.53  	public static void captureVideo(final Application app, final File file) throws IOException{
    1.54 -
    1.55  		final AbstractVideoRecorder videoRecorder;
    1.56 -		// The XuggleVideoRecorder is better than the AVIVideoRecorder in every way
    1.57 -		// except for ease of installation.  The excellent work by Werner Randelshofer
    1.58 -		// is used as a fallback option.  Please visit http://www.xuggle.com/ to learn
    1.59 -		// how to set up the XuggleVideoRecorder.
    1.60  
    1.61  		if (file.getCanonicalPath().endsWith(".avi")){
    1.62  			videoRecorder = new AVIVideoRecorder(file);}
    1.63 @@ -61,6 +94,21 @@
    1.64  		app.enqueue(thunk);
    1.65  	}
    1.66  
    1.67 +
    1.68 +	/**
    1.69 +	 * Use this function to capture audio from your application.  Audio data will be saved in linear
    1.70 +	 * PCM format at 44,100 hertz in the wav container format to the file that you specify.  
    1.71 +	 * 
    1.72 +	 * Note that you *have* to use an IsoTimer for your Application's timer while recording audio or 
    1.73 +	 * the recording will fail. Also ensure that your IsoTimer obeys the following constraints: 
    1.74 +	 * 
    1.75 +	 *  - The frames-per-second value of the IsoTimer cannot be lower than 10 frames-per-second.
    1.76 +	 *  - The frames-per-second value of the IsoTimer must evenly divide 44,100.  
    1.77 +	 * 
    1.78 +	 * @param app The Application from which you wish to record Audio.
    1.79 +	 * @param file the target file to which you want to record audio data.
    1.80 +	 * @throws IOException
    1.81 +	 */
    1.82  	
    1.83  	public static void captureAudio(final Application app, final File file) throws IOException{
    1.84  		AppSettings settings = null;
    1.85 @@ -70,7 +118,6 @@
    1.86  		app.setSettings(settings);
    1.87  
    1.88  		JmeSystem.setSystemDelegate(new AurellemSystemDelegate());
    1.89 -				
    1.90  		
    1.91  		final WaveFileWriter writer = new WaveFileWriter(file);
    1.92  
    1.93 @@ -84,7 +131,6 @@
    1.94  				return null;
    1.95  			}
    1.96  		};
    1.97 -		
    1.98  		app.enqueue(thunk);
    1.99  	}		
   1.100  }