Package org.opensourcephysics.tools

Class DiagnosticsForXuggle

java.lang.Object

org.opensourcephysics.tools.DiagnosticsForXuggle

public class DiagnosticsForXuggle
extends java.lang.Object

Checks to see if Xuggle is installed and working.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	REQUEST_TRACKER
static long	XUGGLE_54_FILE_LENGTH
static java.lang.String	XUGGLE_INSTALLER_URL

Method Summary

Modifier and Type	Method	Description
static void	aboutXuggle()	Displays the About Xuggle dialog.
static void	aboutXuggle(java.lang.String request)	Displays the About Xuggle dialog for Tracker or other requester.
static boolean	copyXuggleJarsTo(java.io.File dir)	Copies Xuggle jar files to a target directory.
static java.lang.String[]	getDiagnosticMessage(int status, java.lang.String requester)	Gets a diagnostic message when Xuggle is not working.
static java.io.File[]	getJavaExtensionJars()	Gets the xuggle jar files in the current VM extensions.
static int	getStatusCode()	Gets a status code that identifies the current state of the Xuggle video engine.
static java.io.File	getXuggleJar()	Gets the xuggle-xuggler.jar from the xuggleHome directory, if it exists.
static java.io.File[]	getXuggleJarFiles(java.lang.String dir)	Gets the xuggle jar files (named in xuggleJarNames) found in a given directory.
static java.lang.String[]	getXuggleJarNames()	Gets the xuggle jar names.
static java.lang.String	getXuggleVersion()	Gets the Xuggle version as a String.
static double	guessXuggleVersion()	Returns the best guess Xuggle version as a double based on file size.
static void	main(java.lang.String[] args)	Tests this class.
static void	setDialogOwner(java.awt.Component owner)	Sets the owner for JOptionPane dialogs.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

XUGGLE_INSTALLER_URL

public static final java.lang.String XUGGLE_INSTALLER_URL

See Also:

Constant Field Values

REQUEST_TRACKER

public static final java.lang.String REQUEST_TRACKER

See Also:

Constant Field Values

XUGGLE_54_FILE_LENGTH

public static final long XUGGLE_54_FILE_LENGTH

See Also:

Constant Field Values

Method Detail

setDialogOwner

public static void setDialogOwner(java.awt.Component owner)

Sets the owner for JOptionPane dialogs.

Parameters:

owner - a JComponent (may be null)

aboutXuggle

public static void aboutXuggle()

Displays the About Xuggle dialog. If working correctly, shows version, etc. If not working, shows a diagnostic message.

aboutXuggle

public static void aboutXuggle(java.lang.String request)

Displays the About Xuggle dialog for Tracker or other requester.

Parameters:

request - currently only "Tracker" is supported

getXuggleJarFiles

public static java.io.File[] getXuggleJarFiles(java.lang.String dir)

Gets the xuggle jar files (named in xuggleJarNames) found in a given directory. Always returns the array, but individual elements may be null.

Parameters:

dir - the directory

Returns:

the array of jar files found

getXuggleJarNames

public static java.lang.String[] getXuggleJarNames()

Gets the xuggle jar names.

Returns:

an array of jar names

getJavaExtensionJars

public static java.io.File[] getJavaExtensionJars()

Gets the xuggle jar files in the current VM extensions. Always returns the array, but individual elements may be null.

Returns:

the array of jar files found

getStatusCode

public static int getStatusCode()

Gets a status code that identifies the current state of the Xuggle video engine. Codes are: 0 working correctly 1 not installed (XUGGLE_HOME==null, no xuggle jars in code base and extensions) 2 can't find xuggle home (XUGGLE_HOME==null but xuggle jars found in code base and/or extensions) 3 XUGGLE_HOME incomplete: missing xuggle jars in XUGGLE_HOME/share/java/jars 4 XUGGLE_HOME OK, but incorrect "PATH", "DYLD_LIBRARY_PATH", or "LD_LIBRARY_PATH" 5 XUGGLE_HOME OK, but no xuggle jars in code base or extensions 6 XUGGLE_HOME OK, but mismatched xuggle versions in code base or extensions 7 XUGGLE_HOME OK, but wrong Java VM bitness 8 unsupported Xuggle 5.4 installed -1 none of the above

Returns:

status code

getDiagnosticMessage

public static java.lang.String[] getDiagnosticMessage(int status,
                                                      java.lang.String requester)

Gets a diagnostic message when Xuggle is not working.

Parameters:

status - the status code from getStatusCode() method

requester - --currently only "Tracker" is supported

Returns:

an array strings containing the message lines

getXuggleVersion

public static java.lang.String getXuggleVersion()

Gets the Xuggle version as a String. Returns "Unknown' if Xuggle is missing or unidentified.

Returns:

Xuggle version

guessXuggleVersion

public static double guessXuggleVersion()

Returns the best guess Xuggle version as a double based on file size. For an exact version number, use DiagnosticsForXuggle (requires Xuggle to be running).

Returns:

3.4 or 5.4 if xuggle installed, otherwise 0.0

getXuggleJar

public static java.io.File getXuggleJar()

Gets the xuggle-xuggler.jar from the xuggleHome directory, if it exists.

Returns:

xuggle-xuggler.jar

copyXuggleJarsTo

public static boolean copyXuggleJarsTo(java.io.File dir)

Copies Xuggle jar files to a target directory. Does nothing if the directory already contains a xuggle-xuggler.jar of the same size.

Parameters:

dir - the directory

Returns:

true if jars are copied

main

public static void main(java.lang.String[] args)

Tests this class.

Parameters:

args - ignored