Class WavStreamReader

Wave audio Stream wrapper. This class is NOT thread safe.

Inheritance
Object
WavStreamReader
Implements
Inherited Members
Namespace: Acoustics.Tools.Wav
Assembly: Acoustics.Tools.dll
Syntax
public class WavStreamReader : IWavReader, IDisposable
Remarks

useful links: https://ccrma.stanford.edu/courses/422/projects/WaveFormat/ http://www.sonicspot.com/guide/wavefiles.html http://codeidol.com/java/swing/Audio/Build-an-Audio-Waveform-Display/

AudioTools WavReader just reads the first channel.

Constructors

| Improve this Doc View Source

WavStreamReader(Byte[])

Initializes a new instance of the WavStreamReader class. Create a wave audio stream from a byte array.

Declaration
public WavStreamReader(byte[] bytes)
Parameters
Type Name Description
Byte[] bytes

Byte array containing audio.
Exceptions
Type Condition
ArgumentNullException

Argument is null.
| Improve this Doc View Source

WavStreamReader(FileInfo)

Initializes a new instance of the WavStreamReader class. Create a wave audio stream from a file.

Declaration
public WavStreamReader(FileInfo file)
Parameters
Type Name Description
FileInfo file

File containing audio.
Exceptions
Type Condition
ArgumentNullException

file is null.
ArgumentException

file.
| Improve this Doc View Source

WavStreamReader(Stream)

Initializes a new instance of the WavStreamReader class. Create a wave audio stream from an existing stream.

Declaration
public WavStreamReader(Stream stream)
Parameters
Type Name Description
Stream stream

Stream contaiing audio.
Exceptions
Type Condition
ArgumentNullException

stream is null.
| Improve this Doc View Source

WavStreamReader(String)

Initializes a new instance of the WavStreamReader class. Create a wave audio stream from a file.

Declaration
public WavStreamReader(string filePath)
Parameters
Type Name Description
String filePath

File containing audio.

Properties

| Improve this Doc View Source

AudioInfo

Gets Info about the audio stream.

Declaration
public WavAudioInfo AudioInfo { get; }
Property Value
Type Description
WavAudioInfo
| Improve this Doc View Source

Chunks

Gets chunks in wav audio stream.

Declaration
public IEnumerable<WavChunk> Chunks { get; }
Property Value
Type Description
IEnumerable<WavChunk>
| Improve this Doc View Source

GetDataChunk

Gets GetDataChunk.

Declaration
public WavChunk GetDataChunk { get; }
Property Value
Type Description
WavChunk
| Improve this Doc View Source

Samples

Gets all samples.

Declaration
public double[] Samples { get; }
Property Value
Type Description
Double[]
| Improve this Doc View Source

SampleStream

Gets Samples. Make no assumptions about the position of the stream. Use this.Chunks to position the stream at the start of the chunk you want.

Declaration
public Stream SampleStream { get; }
Property Value
Type Description
Stream

Methods

| Improve this Doc View Source

Dispose()

Dispose Wave audio stream by disposing underlying Sample stream.

Declaration
public void Dispose()
| Improve this Doc View Source

GetSample(Int64)

Get a single sample. Do not use this method in a loop.

Declaration
public double GetSample(long sampleIndex)
Parameters
Type Name Description
Int64 sampleIndex

The sample index (zero-based).
Returns
Type Description
Double

Read sample.
| Improve this Doc View Source

GetSamples(Int64, Int64)

Get samples from the wav stream. Start from firstSampleIndex (zero indexed), and read numberOfSamplesToRead.

Declaration
public double[] GetSamples(long firstSampleIndex, long numberOfSamplesToRead)
Parameters
Type Name Description
Int64 firstSampleIndex

The first Sample Index.
Int64 numberOfSamplesToRead

The number Of Samples To Read.
Returns
Type Description
Double[]

numberOfSamplesToRead starting from firstSampleIndex.
| Improve this Doc View Source

GetSamples(Stream, WavChunk, WavAudioInfo, Int64, Int64)

Get samples from the wav stream. Start from firstSampleIndex (zero indexed), and read numberOfSamplesToRead.

Declaration
public static double[] GetSamples(Stream wavStream, WavChunk dataChunk, WavAudioInfo wavInfo, long firstSampleIndex, long numberOfSamplesToRead)
Parameters
Type Name Description
Stream wavStream

The wav Stream.
WavChunk dataChunk

The data Chunk.
WavAudioInfo wavInfo

The wav Info.
Int64 firstSampleIndex

The first Sample Index.
Int64 numberOfSamplesToRead

The number Of Samples To Read.
Returns
Type Description
Double[]

numberOfSamplesToRead starting from firstSampleIndex.

Implements

Extension Methods