WaveModule (JHOVE WAVE Module HUL 1.8.1 API)

java.lang.Object
- edu.harvard.hul.ois.jhove.ModuleBase
- - edu.harvard.hul.ois.jhove.module.WaveModule

All Implemented Interfaces:

Module
```
public class WaveModule
extends ModuleBase
```
Module for identification and validation of WAVE sound files. There is no published specification for WAVE files; this module is based on several Internet sources. WAVE format is a type of RIFF format. RIFF, in turn, is a variant on EA IFF 85.

Author:

Gary McGath

Field Summary

Fields
Modifier and Type	Field and Description
`protected AESAudioMetadata`	`_aesMetadata` AES audio metadata to go into WAVE metadata
`protected int`	`_blockAlign` Bytes needed to store a file
`protected ExifInfo`	`_exifInfo` Exif data from file
`protected List<Property>`	`_labeledText` List of Labeled Text properties
`protected List<Property>`	`_labels` List of Label properties
`protected Property`	`_metadata` Top-level metadata property
`protected List<Property>`	`_notes` List of Note properties
`protected List<Property>`	`_propList` Top-level property list
`protected List<Property>`	`_samples` List of Sample properties
`protected boolean`	`broadcastExtChunkSeen` Flag to check for not more than one Broadcast Audio Extension chunk
`protected boolean`	`cartChunkSeen` Flag to check for not more than one Cart chunk
`protected boolean`	`cueChunkSeen` Flag to check for not more than one Cue chunk
`protected boolean`	`dataChunkSeen` Flag to check for not more than one Data chunk
`protected boolean`	`dataSize64ChunkSeen` Flag to check for a Data Size 64 chunk
`protected Map<String,Long>`	`extendedChunkSizes` Map of 64-bit chunk sizes found in the Data Size 64 chunk.
`protected long`	`extendedRiffSize` Extended (and unsigned) RIFF size as found in Data Size 64 chunk
`protected long`	`extendedSampleLength` Extended (and unsigned) sample length as found in Data Size 64 chunk
`protected boolean`	`factChunkSeen` Flag to check for presence of a Fact chunk
`protected boolean`	`firstSampleOffsetMarked` Flag to note that first sample offset has been recorded
`protected boolean`	`flagPCMWaveFormat` Profile flag for PCMWAVEFORMAT
`protected boolean`	`flagRF64` Profile flag for RF64
`protected boolean`	`flagWaveFormatEx` Profile flag for WAVEFORMATEX
`protected boolean`	`flagWaveFormatExtensible` Profile flag for WAVEFORMATEXTENSIBLE
`protected boolean`	`formatChunkSeen` Flag to check for exactly one Format chunk
`protected boolean`	`instrumentChunkSeen` Flag to check for not more than one Instrument chunk
`protected boolean`	`linkChunkSeen` Flag to check for not more than one Link chunk
`static long`	`LOOKUP_EXTENDED_DATA_SIZE` Value indicating a required 64-bit data size lookup
`protected boolean`	`mpegChunkSeen` Flag to check for not more than one MPEG chunk
`protected boolean`	`peakChunkSeen` Flag to check for not more than one Peak Envelope chunk
`protected long`	`riffSize` RIFF size as found in the RIFF chunk header.
`protected long`	`sampleCount` Number of samples in the file.
`protected long`	`sampleRate` Sample rate from file
`protected int`	`waveCodec` WAVE codec, used for profile verification

Fields inherited from class edu.harvard.hul.ois.jhove.ModuleBase
_app, _bigEndian, _checksumFinished, _ckSummer, _countStream, _coverage, _crc32, _cstream, _date, _defaultParams, _dstream, _features, _format, _init, _isRandomAccess, _je, _logger, _md5, _mimeType, _name, _nByte, _note, _param, _release, _repInfoNote, _rights, _sha1, _sha256, _signature, _specification, _validityNote, _vendor, _verbosity, _wellFormedNote

Fields inherited from interface edu.harvard.hul.ois.jhove.Module
MAXIMUM_VERBOSITY, MINIMUM_VERBOSITY

Constructor Summary

Constructors
Constructor and Description

WaveModule()
Class constructor.

Constructors
Constructor and Description
`WaveModule()` Class constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addExtendedChunkSize(String chunkId, Long chunkSize)` Adds a chunk's extended chunk size to the map of extended sizes.
`void`	`addLabel(Property p)` Adds a Label property
`void`	`addLabeledText(Property p)` Adds a LabeledText property
`void`	`addListInfo(List l)` Adds the ListInfo property, which is a List of String Properties.
`void`	`addNote(Property p)` Adds a Note string
`void`	`addSample(Property p)` Adds a Sample property
`void`	`addSamples(long samples)` Adds to the number of data bytes.
`void`	`addWaveProperty(Property prop)` Adds a Property to the WAVE metadata.
`Property`	`buildBitmaskProperty(int val, String name, String[] oneValueNames, String[] zeroValueNames)` General function for adding a property with a 32-bit value, with two arrays of Strings to interpret 0 and 1 values as a bitmask.
`protected void`	`dupChunkError(RepInfo info, String chunkName)` Reports a duplicate chunk.
`AESAudioMetadata`	`getAESMetadata()` Returns the module's AES metadata.
`int`	`getBlockAlign()` Returns the number of bytes needed per aligned sample.
`ExifInfo`	`getExifInfo()` Returns the ExifInfo object.
`long`	`getExtendedSampleLength()` Returns the extended sample length.
`int`	`getWaveCodec()` Returns the WAVE codec value.
`boolean`	`hasExtendedDataSizes()` Returns whether or not the module has parsed the chunks required to provide extended data sizes, namely RF64's Data Size 64 chunk.
`protected void`	`initParse()` Initializes the state of the module for parsing.
`void`	`markFirstSampleOffset()` Marks the first sample offset as the current byte position, if it hasn't already been marked.
`int`	`parse(InputStream stream, RepInfo info, int parseIndex)` Parses the content of a purported WAVE digital object and stores the results in RepInfo.
`String`	`read4Chars(DataInputStream stream)` Reads 4 bytes and concatenates them into a String.
`protected boolean`	`readChunk(RepInfo info)` Reads a WAVE chunk.
`int`	`readSignedInt(DataInputStream stream)` One-argument version of `readSignedInt`.
`long`	`readSignedLong(DataInputStream stream)` One-argument version of `readSignedLong`.
`int`	`readSignedShort(DataInputStream stream)` One-argument version of `readSignedShort`.
`long`	`readUnsignedInt(DataInputStream stream)` One-argument version of `readUnsignedInt`.
`int`	`readUnsignedShort(DataInputStream stream)` One-argument version of `readUnsignedShort`.
`void`	`setBlockAlign(int align)` Sets the number of bytes that holds an aligned sample.
`void`	`setExifInfo(ExifInfo exifInfo)` Sets an ExifInfo object for the module.
`void`	`setExtendedRiffSize(long size)` Sets the extended RIFF size.
`void`	`setExtendedSampleLength(long length)` Sets the extended sample length.
`void`	`setPCMWaveFormat(boolean b)` Sets the profile flag for PCMWAVEFORMAT.
`void`	`setSampleRate(long rate)` Sets the sample rate.
`void`	`setWaveCodec(int value)` Sets the WAVE codec.
`void`	`setWaveFormatEx(boolean b)` Sets the profile flag for WAVEFORMATEX.
`void`	`setWaveFormatExtensible(boolean b)` Sets the profile flag for WAVEFORMATEXTENSIBLE.

Methods inherited from class edu.harvard.hul.ois.jhove.ModuleBase
addIntegerProperty, addIntegerProperty, applyDefaultParams, calcRAChecksum, checkSignatures, checkSignatures, checksumIfRafNotCopied, getApp, getBase, getBufferedDataStream, getCoverage, getCRC32, getDate, getDefaultParams, getFeatures, getFormat, getMimeType, getName, getNByte, getNote, getRelease, getRepInfoNote, getRights, getSignature, getSpecification, getValidityNote, getVendor, getWellFormedNote, hasFeature, init, initFeatures, initInfo, isBigEndian, isParamInDefaults, isRandomAccess, param, parse, readByteBuf, readDouble, readDouble, readDouble, readFloat, readFloat, readSignedByte, readSignedByte, readSignedByte, readSignedInt, readSignedInt, readSignedInt, readSignedLong, readSignedRational, readSignedRational, readSignedShort, readSignedShort, readSignedShort, readUnsignedByte, readUnsignedByte, readUnsignedByte, readUnsignedInt, readUnsignedInt, readUnsignedInt, readUnsignedRational, readUnsignedRational, readUnsignedRational, readUnsignedShort, readUnsignedShort, readUnsignedShort, resetParams, setApp, setBase, setChecksums, setCRC32, setDefaultParams, setMD5, setNByte, setSHA1, setSHA256, setupDataStream, setValidityNote, setVerbosity, show, skipBytes, skipBytes, skipDstreamToEnd, vectorToPropArray

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOOKUP_EXTENDED_DATA_SIZE
```
public static final long LOOKUP_EXTENDED_DATA_SIZE
```
    Value indicating a required 64-bit data size lookup
    
    See Also:
    
    Constant Field Values
  - extendedChunkSizes
```
protected Map<String,Long> extendedChunkSizes
```
    Map of 64-bit chunk sizes found in the Data Size 64 chunk. Long size values should be treated as unsigned.
  - _metadata
```
protected Property _metadata
```
    Top-level metadata property
  - _propList
```
protected List<Property> _propList
```
    Top-level property list
  - _notes
```
protected List<Property> _notes
```
    List of Note properties
  - _labels
```
protected List<Property> _labels
```
    List of Label properties
  - _labeledText
```
protected List<Property> _labeledText
```
    List of Labeled Text properties
  - _samples
```
protected List<Property> _samples
```
    List of Sample properties
  - _aesMetadata
```
protected AESAudioMetadata _aesMetadata
```
    AES audio metadata to go into WAVE metadata
  - riffSize
```
protected long riffSize
```
    RIFF size as found in the RIFF chunk header.
  - _blockAlign
```
protected int _blockAlign
```
    Bytes needed to store a file
  - _exifInfo
```
protected ExifInfo _exifInfo
```
    Exif data from file
  - waveCodec
```
protected int waveCodec
```
    WAVE codec, used for profile verification
  - extendedRiffSize
```
protected long extendedRiffSize
```
    Extended (and unsigned) RIFF size as found in Data Size 64 chunk
  - extendedSampleLength
```
protected long extendedSampleLength
```
    Extended (and unsigned) sample length as found in Data Size 64 chunk
  - sampleCount
```
protected long sampleCount
```
    Number of samples in the file. Obtained from the Data chunk for uncompressed files, and the Fact chunk for compressed ones. Value should be treated as unsigned.
  - sampleRate
```
protected long sampleRate
```
    Sample rate from file
  - formatChunkSeen
```
protected boolean formatChunkSeen
```
    Flag to check for exactly one Format chunk
  - factChunkSeen
```
protected boolean factChunkSeen
```
    Flag to check for presence of a Fact chunk
  - dataChunkSeen
```
protected boolean dataChunkSeen
```
    Flag to check for not more than one Data chunk
  - dataSize64ChunkSeen
```
protected boolean dataSize64ChunkSeen
```
    Flag to check for a Data Size 64 chunk
  - instrumentChunkSeen
```
protected boolean instrumentChunkSeen
```
    Flag to check for not more than one Instrument chunk
  - mpegChunkSeen
```
protected boolean mpegChunkSeen
```
    Flag to check for not more than one MPEG chunk
  - cartChunkSeen
```
protected boolean cartChunkSeen
```
    Flag to check for not more than one Cart chunk
  - broadcastExtChunkSeen
```
protected boolean broadcastExtChunkSeen
```
    Flag to check for not more than one Broadcast Audio Extension chunk
  - peakChunkSeen
```
protected boolean peakChunkSeen
```
    Flag to check for not more than one Peak Envelope chunk
  - linkChunkSeen
```
protected boolean linkChunkSeen
```
    Flag to check for not more than one Link chunk
  - cueChunkSeen
```
protected boolean cueChunkSeen
```
    Flag to check for not more than one Cue chunk
  - flagPCMWaveFormat
```
protected boolean flagPCMWaveFormat
```
    Profile flag for PCMWAVEFORMAT
  - flagWaveFormatEx
```
protected boolean flagWaveFormatEx
```
    Profile flag for WAVEFORMATEX
  - flagWaveFormatExtensible
```
protected boolean flagWaveFormatExtensible
```
    Profile flag for WAVEFORMATEXTENSIBLE
  - flagRF64
```
protected boolean flagRF64
```
    Profile flag for RF64
  - firstSampleOffsetMarked
```
protected boolean firstSampleOffsetMarked
```
    Flag to note that first sample offset has been recorded
- Constructor Detail
  - WaveModule
```
public WaveModule()
```
    Class constructor. Instantiates a WaveModule object.
- Method Detail
  - parse
```
public int parse(InputStream stream,
                 RepInfo info,
                 int parseIndex)
```
    Parses the content of a purported WAVE digital object and stores the results in RepInfo.
    
    Specified by:
    
    parse in interface Module
    
    Overrides:
    
    parse in class ModuleBase
    
    Parameters:
    
    stream - An InputStream, positioned at its beginning, which is generated from the object to be parsed
    
    info - A fresh RepInfo object which will be modified to reflect the results of the parsing
    
    parseIndex - Must be 0 in first call to parse. If parse returns a nonzero value, it must be called again with parseIndex equal to that return value.
  - markFirstSampleOffset
```
public void markFirstSampleOffset()
```
    Marks the first sample offset as the current byte position, if it hasn't already been marked.
  - setExifInfo
```
public void setExifInfo(ExifInfo exifInfo)
```
    Sets an ExifInfo object for the module.
  - setBlockAlign
```
public void setBlockAlign(int align)
```
    Sets the number of bytes that holds an aligned sample.
  - getExifInfo
```
public ExifInfo getExifInfo()
```
    Returns the ExifInfo object. If no ExifInfo object has been set, returns null.
  - getWaveCodec
```
public int getWaveCodec()
```
    Returns the WAVE codec value.
  - getBlockAlign
```
public int getBlockAlign()
```
    Returns the number of bytes needed per aligned sample.
  - addWaveProperty
```
public void addWaveProperty(Property prop)
```
    Adds a Property to the WAVE metadata.
  - addLabel
```
public void addLabel(Property p)
```
    Adds a Label property
  - addLabeledText
```
public void addLabeledText(Property p)
```
    Adds a LabeledText property
  - addSample
```
public void addSample(Property p)
```
    Adds a Sample property
  - addNote
```
public void addNote(Property p)
```
    Adds a Note string
  - addListInfo
```
public void addListInfo(List l)
```
    Adds the ListInfo property, which is a List of String Properties.
  - readSignedLong
```
public long readSignedLong(DataInputStream stream)
                    throws IOException
```
    One-argument version of readSignedLong. WAVE is always little-endian, so we can unambiguously drop its endian argument.
    
    Throws:
    
    IOException
  - readUnsignedInt
```
public long readUnsignedInt(DataInputStream stream)
                     throws IOException
```
    One-argument version of readUnsignedInt. WAVE is always little-endian, so we can unambiguously drop its endian argument.
    
    Throws:
    
    IOException
  - readSignedInt
```
public int readSignedInt(DataInputStream stream)
                  throws IOException
```
    One-argument version of readSignedInt. WAVE is always little-endian, so we can unambiguously drop its endian argument.
    
    Throws:
    
    IOException
  - readUnsignedShort
```
public int readUnsignedShort(DataInputStream stream)
                      throws IOException
```
    One-argument version of readUnsignedShort. WAVE is always little-endian, so we can unambiguously drop its endian argument.
    
    Throws:
    
    IOException
  - readSignedShort
```
public int readSignedShort(DataInputStream stream)
                    throws IOException
```
    One-argument version of readSignedShort. WAVE is always little-endian, so we can unambiguously drop its endian argument.
    
    Throws:
    
    IOException
  - read4Chars
```
public String read4Chars(DataInputStream stream)
                  throws IOException
```
    Reads 4 bytes and concatenates them into a String. This pattern is used for ID's of various kinds.
    
    Throws:
    
    IOException
  - setWaveCodec
```
public void setWaveCodec(int value)
```
    Sets the WAVE codec.
  - addSamples
```
public void addSamples(long samples)
```
    Adds to the number of data bytes. This may be called multiple times to give a cumulative total.
  - setSampleRate
```
public void setSampleRate(long rate)
```
    Sets the sample rate.
  - setPCMWaveFormat
```
public void setPCMWaveFormat(boolean b)
```
    Sets the profile flag for PCMWAVEFORMAT.
  - setWaveFormatEx
```
public void setWaveFormatEx(boolean b)
```
    Sets the profile flag for WAVEFORMATEX.
  - setWaveFormatExtensible
```
public void setWaveFormatExtensible(boolean b)
```
    Sets the profile flag for WAVEFORMATEXTENSIBLE.
  - initParse
```
protected void initParse()
```
    Initializes the state of the module for parsing.
    
    Overrides:
    
    initParse in class ModuleBase
  - readChunk
```
protected boolean readChunk(RepInfo info)
                     throws IOException
```
    Reads a WAVE chunk.
    
    Throws:
    
    IOException
  - getAESMetadata
```
public AESAudioMetadata getAESMetadata()
```
    Returns the module's AES metadata.
  - dupChunkError
```
protected void dupChunkError(RepInfo info,
                             String chunkName)
```
    Reports a duplicate chunk.
  - buildBitmaskProperty
```
public Property buildBitmaskProperty(int val,
                                     String name,
                                     String[] oneValueNames,
                                     String[] zeroValueNames)
```
    General function for adding a property with a 32-bit value, with two arrays of Strings to interpret 0 and 1 values as a bitmask.
    
    Parameters:
    
    val - The bitmask
    
    name - The name for the Property
    
    oneValueNames - Array of names to use for '1' values
    
    zeroValueNames - Array of names to use for '0' values
  - hasExtendedDataSizes
```
public boolean hasExtendedDataSizes()
```
    Returns whether or not the module has parsed the chunks required to provide extended data sizes, namely RF64's Data Size 64 chunk.
  - setExtendedRiffSize
```
public void setExtendedRiffSize(long size)
```
    Sets the extended RIFF size.
  - setExtendedSampleLength
```
public void setExtendedSampleLength(long length)
```
    Sets the extended sample length.
  - getExtendedSampleLength
```
public long getExtendedSampleLength()
```
    Returns the extended sample length.
  - addExtendedChunkSize
```
public void addExtendedChunkSize(String chunkId,
                                 Long chunkSize)
```
    Adds a chunk's extended chunk size to the map of extended sizes. If a chunk has previously been mapped, its chunk size will be replaced.

Class WaveModule

Field Summary

Fields inherited from class edu.harvard.hul.ois.jhove.ModuleBase

Fields inherited from interface edu.harvard.hul.ois.jhove.Module

Constructor Summary

Method Summary

Methods inherited from class edu.harvard.hul.ois.jhove.ModuleBase

Methods inherited from class java.lang.Object

Field Detail

LOOKUP_EXTENDED_DATA_SIZE

extendedChunkSizes

_metadata

_propList

_notes

_labels

_labeledText

_samples

_aesMetadata

riffSize

_blockAlign

_exifInfo

waveCodec

extendedRiffSize

extendedSampleLength

sampleCount

sampleRate

formatChunkSeen

factChunkSeen

dataChunkSeen

dataSize64ChunkSeen

instrumentChunkSeen

mpegChunkSeen

cartChunkSeen

broadcastExtChunkSeen

peakChunkSeen

linkChunkSeen

cueChunkSeen

flagPCMWaveFormat

flagWaveFormatEx

flagWaveFormatExtensible

flagRF64

firstSampleOffsetMarked

Constructor Detail

WaveModule

Method Detail

parse

markFirstSampleOffset

setExifInfo

setBlockAlign

getExifInfo

getWaveCodec

getBlockAlign

addWaveProperty

addLabel

addLabeledText

addSample

addNote

addListInfo

readSignedLong

readUnsignedInt

readSignedInt

readUnsignedShort

readSignedShort

read4Chars

setWaveCodec

addSamples

setSampleRate

setPCMWaveFormat

setWaveFormatEx

setWaveFormatExtensible

initParse

readChunk

getAESMetadata

dupChunkError

buildBitmaskProperty

hasExtendedDataSizes

setExtendedRiffSize

setExtendedSampleLength

getExtendedSampleLength

addExtendedChunkSize