Wave (musicg 1.4.2.2 API)

java.lang.Object
- com.musicg.wave.Wave

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class Wave
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
```
Read WAVE headers and data from wave input stream

Author:

Jacquet Wong

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`Wave()`	Constructor
`Wave(WaveHeader waveHeader, byte[] data)`	Constructor
`Wave(java.io.InputStream inputStream)`	Constructor
`Wave(java.lang.String filename)`	Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Wave`	`clone()`
`byte[]`	`getBytes()`	Get the wave data in bytes
`byte[]`	`getFingerprint()`
`FingerprintSimilarity`	`getFingerprintSimilarity(Wave wave)`
`float`	`getLengthInSeconds()`	Length of the wave in second
`double[]`	`getNormalizedAmplitudes()`
`short[]`	`getSampleAmplitudes()`	Get the amplitudes of the wave samples (depends on the header)
`Spectrogram`	`getSpectrogram()`	Get the wave spectrogram
`Spectrogram`	`getSpectrogram(int fftSampleSize, int overlapFactor)`	Get the wave spectrogram
`WaveHeader`	`getWaveHeader()`	Get the wave header
`void`	`leftTrim(double second)`	Trim the wave data from beginning
`void`	`leftTrim(int numberOfSample)`	Trim the wave data from beginning
`float`	`length()`	Length of the wave in second
`void`	`rightTrim(double second)`	Trim the wave data from ending
`void`	`rightTrim(int numberOfSample)`	Trim the wave data from ending
`int`	`size()`	Data byte size of the wave excluding header size
`java.lang.String`	`timestamp()`	Timestamp of the wave length
`java.lang.String`	`toString()`
`void`	`trim(double leftTrimSecond, double rightTrimSecond)`	Trim the wave data
`void`	`trim(int leftTrimNumberOfSample, int rightTrimNumberOfSample)`	Trim the wave data

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

- Constructor Detail
  - Wave
```
public Wave()
```
    Constructor
  - Wave
```
public Wave(java.lang.String filename)
```
    Constructor
    
    Parameters:
    
    filename - Wave file
  - Wave
```
public Wave(java.io.InputStream inputStream)
```
    Constructor
    
    Parameters:
    
    inputStream - Wave file input stream
  - Wave
```
public Wave(WaveHeader waveHeader,
            byte[] data)
```
    Constructor
    
    Parameters:
    
    WaveHeader - waveHeader
    
    byte - [] data
- Method Detail
  - trim
```
public void trim(int leftTrimNumberOfSample,
                 int rightTrimNumberOfSample)
```
    Trim the wave data
    
    Parameters:
    
    leftTrimNumberOfSample - Number of sample trimmed from beginning
    
    rightTrimNumberOfSample - Number of sample trimmed from ending
  - leftTrim
```
public void leftTrim(int numberOfSample)
```
    Trim the wave data from beginning
    
    Parameters:
    
    numberOfSample - numberOfSample trimmed from beginning
  - rightTrim
```
public void rightTrim(int numberOfSample)
```
    Trim the wave data from ending
    
    Parameters:
    
    numberOfSample - numberOfSample trimmed from ending
  - trim
```
public void trim(double leftTrimSecond,
                 double rightTrimSecond)
```
    Trim the wave data
    
    Parameters:
    
    leftTrimSecond - Seconds trimmed from beginning
    
    rightTrimSecond - Seconds trimmed from ending
  - leftTrim
```
public void leftTrim(double second)
```
    Trim the wave data from beginning
    
    Parameters:
    
    second - Seconds trimmed from beginning
  - rightTrim
```
public void rightTrim(double second)
```
    Trim the wave data from ending
    
    Parameters:
    
    second - Seconds trimmed from ending
  - getWaveHeader
```
public WaveHeader getWaveHeader()
```
    Get the wave header
    
    Returns:
    
    waveHeader
  - getSpectrogram
```
public Spectrogram getSpectrogram()
```
    Get the wave spectrogram
    
    Returns:
    
    spectrogram
  - getSpectrogram
```
public Spectrogram getSpectrogram(int fftSampleSize,
                                  int overlapFactor)
```
    Get the wave spectrogram
    
    Parameters:
    
    fftSampleSize - number of sample in fft, the value needed to be a number to power of 2
    
    overlapFactor - 1/overlapFactor overlapping, e.g. 1/4=25% overlapping, 0 for no overlapping
    
    Returns:
    
    spectrogram
  - getBytes
```
public byte[] getBytes()
```
    Get the wave data in bytes
    
    Returns:
    
    wave data
  - size
```
public int size()
```
    Data byte size of the wave excluding header size
    
    Returns:
    
    byte size of the wave
  - length
```
public float length()
```
    Length of the wave in second
    
    Returns:
    
    length in second
  - timestamp
```
public java.lang.String timestamp()
```
    Timestamp of the wave length
    
    Returns:
    
    timestamp
  - getSampleAmplitudes
```
public short[] getSampleAmplitudes()
```
    Get the amplitudes of the wave samples (depends on the header)
    
    Returns:
    
    amplitudes array (signed 16-bit)
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getNormalizedAmplitudes
```
public double[] getNormalizedAmplitudes()
```
  - getFingerprint
```
public byte[] getFingerprint()
```
  - getFingerprintSimilarity
```
public FingerprintSimilarity getFingerprintSimilarity(Wave wave)
```
  - getLengthInSeconds
```
public float getLengthInSeconds()
```
    Length of the wave in second
    
    Returns:
    
    length in second
  - clone
```
public Wave clone()
```
    Overrides:
    
    clone in class java.lang.Object

Class Wave

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Wave

Wave

Wave

Wave

Method Detail

trim

leftTrim

rightTrim

trim

leftTrim

rightTrim

getWaveHeader

getSpectrogram

getSpectrogram

getBytes

size

length

timestamp

getSampleAmplitudes

toString

getNormalizedAmplitudes

getFingerprint

getFingerprintSimilarity

getLengthInSeconds

clone