marytts.util.data

Class MaryHeader

java.lang.Object

marytts.util.data.MaryHeader

public class MaryHeader
extends Object

Common helper class to read/write a standard Mary header to/from the various Mary data files.

Author:

sacha

Field Summary

Fields

Modifier and Type	Field and Description
static int	CARTS
static int	DIRECTED_GRAPH
static int	HALFPHONE_UNITFEATS
static int	JOINFEATS
static int	LISTENERFEATS
static int	LISTENERUNITS
static int	PRECOMPUTED_JOINCOSTS
static int	SCOST
static int	TIMELINE
static int	UNITFEATS
static int	UNITS
static int	UNKNOWN

Constructor Summary

Constructors

Constructor and Description
MaryHeader(ByteBuffer input) Construct a MaryHeader by reading from a file.
MaryHeader(DataInput input) Construct a MaryHeader by reading from a file.
MaryHeader(int newType) Consruct a MaryHeader from scratch.

Method Summary

Methods

Modifier and Type	Method and Description
int	getMagic()
int	getType()
int	getVersion()
boolean	hasCurrentVersion()
static int	peekFileType(String fileName) For the given file, look inside and determine the file type.
long	writeTo(DataOutput output) Mary header writer

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN

public static final int UNKNOWN

See Also:

Constant Field Values

CARTS

public static final int CARTS

See Also:

Constant Field Values

DIRECTED_GRAPH

public static final int DIRECTED_GRAPH

See Also:

Constant Field Values

UNITS

public static final int UNITS

See Also:

Constant Field Values

LISTENERUNITS

public static final int LISTENERUNITS

See Also:

Constant Field Values

UNITFEATS

public static final int UNITFEATS

See Also:

Constant Field Values

LISTENERFEATS

public static final int LISTENERFEATS

See Also:

Constant Field Values

HALFPHONE_UNITFEATS

public static final int HALFPHONE_UNITFEATS

See Also:

Constant Field Values

JOINFEATS

public static final int JOINFEATS

See Also:

Constant Field Values

SCOST

public static final int SCOST

See Also:

Constant Field Values

PRECOMPUTED_JOINCOSTS

public static final int PRECOMPUTED_JOINCOSTS

See Also:

Constant Field Values

TIMELINE

public static final int TIMELINE

See Also:

Constant Field Values

Constructor Detail

MaryHeader

public MaryHeader(int newType)

Consruct a MaryHeader from scratch. Fundamental guarantee: after construction, the MaryHeader has a valid magic number and a valid type.

Parameters:

newType - The type of MaryHeader to create. See public final constants in this class.

Throws:

IllegalArgumentException - if the input type is unknown.

MaryHeader

public MaryHeader(DataInput input)
           throws MaryConfigurationException

Construct a MaryHeader by reading from a file. Fundamental guarantee: after construction, the MaryHeader has a valid magic number and a valid type.

Parameters:

input - a DataInputStream or RandomAccessFile to read the header from.

Throws:

MaryConfigurationException - if no mary header can be read from input.

MaryHeader

public MaryHeader(ByteBuffer input)
           throws MaryConfigurationException

Construct a MaryHeader by reading from a file. Fundamental guarantee: after construction, the MaryHeader has a valid magic number and a valid type.

Parameters:

input - a byte buffer to read the header from.

Throws:

MaryConfigurationException - if no mary header can be read from input.

Method Detail

peekFileType

public static int peekFileType(String fileName)
                        throws IOException

For the given file, look inside and determine the file type.

Parameters:

fileName - file name

Returns:

the file type, or -1 if the file does not have a valid MARY header.

Throws:

IOException - if the file cannot be read

writeTo

public long writeTo(DataOutput output)
             throws IOException

Mary header writer

Parameters:

output - The DataOutputStream or RandomAccessFile to write to

Returns:

the number of written bytes.

Throws:

IOException - if the file type is unknown.

getMagic

public int getMagic()

getVersion

public int getVersion()

getType

public int getType()

hasCurrentVersion

public boolean hasCurrentVersion()