edu.cmu.sphinx.frontend.util

Class WavWriter

java.lang.Object

edu.cmu.sphinx.util.props.ConfigurableAdapter

edu.cmu.sphinx.frontend.BaseDataProcessor

edu.cmu.sphinx.frontend.util.WavWriter

All Implemented Interfaces:

DataProcessor, Configurable

public class WavWriter
extends BaseDataProcessor

Stores audio data into numbered (MS-)wav files. TODO: currently the WavWriter buffers all audio data until a DataEndSignal occurs.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	captureUtts
static java.lang.String	PROP_BITS_PER_SAMPLE The property for the number of bits per value.
static java.lang.String	PROP_CAPTURE_UTTERANCES The property specifying whether the input data is signed.
static java.lang.String	PROP_IS_COMPLETE_PATH
static java.lang.String	PROP_OUT_FILE_NAME_PATTERN The pathname which must obey the pattern: pattern + i + .wav.
static java.lang.String	PROP_SIGNED_DATA The property specifying whether the input data is signed.

Fields inherited from class edu.cmu.sphinx.util.props.ConfigurableAdapter

logger

Constructor Summary

Constructors

Constructor and Description
WavWriter()
WavWriter(java.lang.String dumpFilePath, boolean isCompletePath, int bitsPerSample, boolean isSigned, boolean captureUtts)

Method Summary

Modifier and Type	Method and Description
Data	getData() Returns the processed Data output.
void	initialize() Initializes this DataProcessor.
void	newProperties(PropertySheet ps) This method is called when this configurable component needs to be reconfigured.
void	setOutFilePattern(java.lang.String outFileNamePattern) Sets the pattern for the output file name.
static byte[]	valuesToBytes(double[] values, int bytesPerValue, boolean signedData) Converts a big-endian byte array into an array of doubles.
protected void	writeFile(java.lang.String wavName) Writes the current stream to disc; override this method if you want to take additional action on file writes

Methods inherited from class edu.cmu.sphinx.frontend.BaseDataProcessor

getPredecessor, setPredecessor

Methods inherited from class edu.cmu.sphinx.util.props.ConfigurableAdapter

getName, initLogger, toString

Methods inherited from class java.lang.Object

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

Field Detail

PROP_OUT_FILE_NAME_PATTERN

@S4String(defaultValue="seg000000")
public static final java.lang.String PROP_OUT_FILE_NAME_PATTERN

The pathname which must obey the pattern: pattern + i + .wav. After each DataEndSignal the smallest unused 'i' is determined. Pattern is padded to create result file with fixed name lenght.

See Also:

Constant Field Values

PROP_IS_COMPLETE_PATH

@S4Boolean(defaultValue=false)
public static final java.lang.String PROP_IS_COMPLETE_PATH

See Also:

Constant Field Values

PROP_BITS_PER_SAMPLE

@S4Integer(defaultValue=16)
public static final java.lang.String PROP_BITS_PER_SAMPLE

The property for the number of bits per value.

See Also:

Constant Field Values

PROP_SIGNED_DATA

@S4Boolean(defaultValue=true)
public static final java.lang.String PROP_SIGNED_DATA

The property specifying whether the input data is signed.

See Also:

Constant Field Values

PROP_CAPTURE_UTTERANCES

@S4Boolean(defaultValue=false)
public static final java.lang.String PROP_CAPTURE_UTTERANCES

The property specifying whether the input data is signed.

See Also:

Constant Field Values

captureUtts

protected boolean captureUtts

Constructor Detail

WavWriter

public WavWriter(java.lang.String dumpFilePath,
                 boolean isCompletePath,
                 int bitsPerSample,
                 boolean isSigned,
                 boolean captureUtts)

WavWriter

public WavWriter()

Method Detail

newProperties

public void newProperties(PropertySheet ps)
                   throws PropertyException

Description copied from interface: Configurable

This method is called when this configurable component needs to be reconfigured.

Specified by:

newProperties in interface Configurable

Overrides:

newProperties in class ConfigurableAdapter

Parameters:

ps - a property sheet holding the new data

Throws:

PropertyException - if there is a problem with the properties.

getData

public Data getData()
             throws DataProcessingException

Description copied from class: BaseDataProcessor

Returns the processed Data output.

Specified by:

getData in interface DataProcessor

Specified by:

getData in class BaseDataProcessor

Returns:

an Data object that has been processed by this DataProcessor

Throws:

DataProcessingException - if a data processor error occurs

initialize

public void initialize()

Initializes this DataProcessor. This is typically called after the DataProcessor has been configured.

Specified by:

initialize in interface DataProcessor

Overrides:

initialize in class BaseDataProcessor

setOutFilePattern

public void setOutFilePattern(java.lang.String outFileNamePattern)

Sets the pattern for the output file name. Useful to change the output beside the properties

Parameters:

outFileNamePattern - file name

valuesToBytes

public static byte[] valuesToBytes(double[] values,
                                   int bytesPerValue,
                                   boolean signedData)
                            throws java.lang.ArrayIndexOutOfBoundsException

Converts a big-endian byte array into an array of doubles. Each consecutive bytes in the byte array are converted into a double, and becomes the next element in the double array. The size of the returned array is (length/bytesPerValue). Currently, only 1 byte (8-bit) or 2 bytes (16-bit) samples are supported.

Parameters:

values - source values

bytesPerValue - the number of bytes per value

signedData - whether the data is signed

Returns:

a double array, or null if byteArray is of zero length

Throws:

java.lang.ArrayIndexOutOfBoundsException - if boundary fails

writeFile

protected void writeFile(java.lang.String wavName)

Writes the current stream to disc; override this method if you want to take additional action on file writes

Parameters:

wavName - name of the file to be written