Class AbstractLineOutAmplitudeWriter<S extends SoundAmplitude, B extends LineOutAmplitudeWriter<S,B>>

java.lang.Object

org.refcodes.audio.AbstractLineOutAmplitudeWriter<S,B>

Type Parameters:

S - The SoundAmplitude (sub-)type on which the AmplitudeWriter implementation is to operate on.

B - The AmplitudeWriter implementing this AbstractLineOutAmplitudeWriter.

All Implemented Interfaces:

AutoCloseable, AmplitudeWriter<S,B>, BitsPerAmplitudeAccessor, BitsPerAmplitudeAccessor.BitsPerAmplitudeBuilder<B>, BitsPerAmplitudeAccessor.BitsPerAmplitudeMutator, BitsPerAmplitudeAccessor.BitsPerAmplitudeProperty, LineOutAmplitudeWriter<S,B>, SamplingRateAccessor, SamplingRateAccessor.SamplingRateBuilder<B>, SamplingRateAccessor.SamplingRateMutator, SamplingRateAccessor.SamplingRateProperty, org.refcodes.io.RowWriter<S>

Direct Known Subclasses:

LineOutMonoAmplitudeWriter, LineOutSoundAmplitudeWriter

public abstract class AbstractLineOutAmplitudeWriter<S extends SoundAmplitude, B extends LineOutAmplitudeWriter<S,B>>
extends Object
implements LineOutAmplitudeWriter<S,B>

The AbstractLineOutAmplitudeWriter provides a foundation means to write sound samples to a line-out device.

Nested Class Summary

Nested classes/interfaces inherited from interface BitsPerAmplitudeAccessor

BitsPerAmplitudeAccessor.BitsPerAmplitudeBuilder<B>, BitsPerAmplitudeAccessor.BitsPerAmplitudeMutator, BitsPerAmplitudeAccessor.BitsPerAmplitudeProperty

Nested classes/interfaces inherited from interface SamplingRateAccessor

SamplingRateAccessor.SamplingRateBuilder<B>, SamplingRateAccessor.SamplingRateMutator, SamplingRateAccessor.SamplingRateProperty

Field Summary

Fields

Modifier and Type	Field	Description
protected BitsPerAmplitude	_bitsPerSample
protected static final long	MAX_16_BIT
protected static final long	MAX_8_BIT

Constructor Summary

Constructors

Constructor	Description
AbstractLineOutAmplitudeWriter()	Constructs an AbstractLineOutAmplitudeWriter.
AbstractLineOutAmplitudeWriter(BitsPerAmplitude aBitsPerAmplitude)	Constructs an AbstractLineOutAmplitudeWriter with the given BitsPerAmplitude to use.

Method Summary

Modifier and Type	Method	Description
BitsPerAmplitude	getBitsPerAmplitude()	Retrieves the bits/amplitude per channel from the bits/amplitude per channel property.
void	setBitsPerAmplitude(BitsPerAmplitude aBitsPerAmplitude)	Sets the bits/amplitude per channel for the bits/amplitude per channel property.
protected static SourceDataLine	toLineOut(int aChannelCount, int aSamplingRate, BitsPerAmplitude aBitsPerAmplitude)	Produces a line-out SourceDataLine instance for writing samples to.
protected static SourceDataLine	toLineOut(SoundAmplitude aSoundAmplitude, BitsPerAmplitude aBitsPerAmplitude)	Produces a line-out SourceDataLine instance for writing samples to.
protected long	toWavSample(double eSampleData)	To wav sample.

Methods inherited from class Object

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

Methods inherited from interface AmplitudeWriter

close, writeNext

Methods inherited from interface BitsPerAmplitudeAccessor.BitsPerAmplitudeBuilder

withBitsPerAmplitude

Methods inherited from interface BitsPerAmplitudeAccessor.BitsPerAmplitudeProperty

letBitsPerAmplitude

Methods inherited from interface SamplingRateAccessor

getSamplingRate

Methods inherited from interface SamplingRateAccessor.SamplingRateBuilder

withSamplingRate

Methods inherited from interface SamplingRateAccessor.SamplingRateMutator

setSamplingRate

Methods inherited from interface SamplingRateAccessor.SamplingRateProperty

letSamplingRate

Field Details

MAX_16_BIT

protected static final long MAX_16_BIT

See Also:

• Constant Field Values

MAX_8_BIT

protected static final long MAX_8_BIT

See Also:

• Constant Field Values

_bitsPerSample

protected BitsPerAmplitude _bitsPerSample

Constructor Details

AbstractLineOutAmplitudeWriter

public AbstractLineOutAmplitudeWriter()

Constructs an AbstractLineOutAmplitudeWriter.

AbstractLineOutAmplitudeWriter

public AbstractLineOutAmplitudeWriter(BitsPerAmplitude aBitsPerAmplitude)

Constructs an AbstractLineOutAmplitudeWriter with the given BitsPerAmplitude to use.

Parameters:

aBitsPerAmplitude - The bits/amplitude to use when doing audio playback.

Method Details

setBitsPerAmplitude

public void setBitsPerAmplitude(BitsPerAmplitude aBitsPerAmplitude)

Sets the bits/amplitude per channel for the bits/amplitude per channel property.

Specified by:

setBitsPerAmplitude in interface BitsPerAmplitudeAccessor.BitsPerAmplitudeMutator

Parameters:

aBitsPerAmplitude - The bits/amplitude per channel to be stored by the sampling rate property.

getBitsPerAmplitude

public BitsPerAmplitude getBitsPerAmplitude()

Retrieves the bits/amplitude per channel from the bits/amplitude per channel property.

Specified by:

getBitsPerAmplitude in interface BitsPerAmplitudeAccessor

Returns:

The bits/amplitude per channel stored by the bits/amplitude per channel property.

toWavSample

protected long toWavSample(double eSampleData)

To wav sample.

Parameters:

eSampleData - the e sample data

Returns:

the long

toLineOut

protected static SourceDataLine toLineOut(SoundAmplitude aSoundAmplitude,
 BitsPerAmplitude aBitsPerAmplitude)
                                   throws LineUnavailableException

Produces a line-out SourceDataLine instance for writing samples to.

Parameters:

aSoundAmplitude - The SoundAmplitude from which to get the according metrics.

aBitsPerAmplitude - The preferred bits/amplitude.

Returns:

An instance of the SourceDataLine to which to write data.

Throws:

LineUnavailableException - thrown in case the audio-line cannot be acquired.

toLineOut

protected static SourceDataLine toLineOut(int aChannelCount,
 int aSamplingRate,
 BitsPerAmplitude aBitsPerAmplitude)
                                   throws LineUnavailableException

Produces a line-out SourceDataLine instance for writing samples to.

Parameters:

aChannelCount - The channel count to use (1 = mono, 2 = stereo)

aSamplingRate - The sampling rate to use

aBitsPerAmplitude - The preferred bits/amplitude.

Returns:

An instance of the SourceDataLine to which to write data.

Throws:

LineUnavailableException - thrown in case the audio-line cannot be acquired.