Package Acquisition.sud

Class SudAudioFile

java.lang.Object

Acquisition.pamAudio.WavAudioFile

Acquisition.sud.SudAudioFile

All Implemented Interfaces:

PamAudioFileLoader, PamSettings, SettingsNameProvider

public class SudAudioFile
extends WavAudioFile
implements PamSettings

Opens a .sud audio file.

Sud files contain X3 compressed audio data. The sud file reader opens files, creating a map of the file and saving the map as a.sudx file so it can be read more rapidly when the file is next accessed.

The SudioAudioInput stream fully implements AudioInputStream and so sud files can be accessed using much of the same code as .wav files.

Author:

Jamie Macaulay

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	SudAudioFile.SudMapProgress
class	SudAudioFile.SudMapWorker	Opens an sud file on a different thread and adds a listener for a mapping.

Field Summary

Fields inherited from class Acquisition.pamAudio.WavAudioFile

fileExtensions

Constructor Summary

Constructors

Constructor	Description
SudAudioFile()

Method Summary

Modifier and Type	Method	Description
AudioInputStream	getAudioStream(File soundFile)	Get the audio stream for the file
String	getName()	Get the name of the file.
PamAudioSettingsPane	getSettingsPane()	Get a settings pane for the audio loader
Serializable	getSettingsReference()
long	getSettingsVersion()
PamSudParams	getSudParams()
String	getUnitName()
String	getUnitType()
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Methods inherited from class Acquisition.pamAudio.WavAudioFile

getFileExtensions, isSoundFile, loadAudioData

Methods inherited from class java.lang.Object

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

Constructor Details

SudAudioFile

public SudAudioFile()

Method Details

getName

public String getName()

Description copied from interface: PamAudioFileLoader

Get the name of the file.

Specified by:

getName in interface PamAudioFileLoader

Overrides:

getName in class WavAudioFile

Returns:

the name of the file

getAudioStream

public AudioInputStream getAudioStream(File soundFile)

Description copied from interface: PamAudioFileLoader

Get the audio stream for the file

Specified by:

getAudioStream in interface PamAudioFileLoader

Overrides:

getAudioStream in class WavAudioFile

Returns:

the audio input stream.

getSettingsPane

public PamAudioSettingsPane getSettingsPane()

Description copied from interface: PamAudioFileLoader

Get a settings pane for the audio loader

Specified by:

getSettingsPane in interface PamAudioFileLoader

Overrides:

getSettingsPane in class WavAudioFile

Returns:

settings pane for audio loader - can be null.

getUnitName

public String getUnitName()

Specified by:

getUnitName in interface SettingsNameProvider

Returns:

A Name specific to this instance of the particular class, e.g. Sperm whale detector, Beaked whale detector, etc.

getUnitType

public String getUnitType()

Specified by:

getUnitType in interface PamSettings

Returns:

A Name specific to the type, e.g. Click detector

getSettingsReference

public Serializable getSettingsReference()

Specified by:

getSettingsReference in interface PamSettings

Returns:

The serialisable object that will be stored

getSettingsVersion

public long getSettingsVersion()

Specified by:

getSettingsVersion in interface PamSettings

Returns:

An integer version number for the settings

restoreSettings

public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Specified by:

restoreSettings in interface PamSettings

Parameters:

pamControlledUnitSettings -

Returns:

true if successful The object performs final checks (if needed) and then casts the settings data pamcontrolledunitSettings.settings into the correct type and uses as required

getSudParams

public PamSudParams getSudParams()