Index (dtmf-io 2.1.0 API)

A B C D E F H I O P R S T U V
All Classes and Interfaces|All Packages|Serialized Form

A

AudioSource - Interface in com.tino1b2be.dtmf.io: Pull-based read interface returned by every AudioSourceProvider and by RawPcmAudioSource.
AudioSourceProvider - Interface in com.tino1b2be.dtmf.io: Service Provider Interface (SPI) for format-specific audio decoders.
AudioSources - Class in com.tino1b2be.dtmf.io: Entry point for opening audio from any source.

B

bitDepth() - Method in interface com.tino1b2be.dtmf.io.AudioSource: Native sample bit depth of the source.
bitDepth() - Method in class com.tino1b2be.dtmf.io.RawPcmAudioSource
BY_SCORE_THEN_PRIORITY - Static variable in record class com.tino1b2be.dtmf.io.internal.ProviderScore: Ordering used to pick the winning provider during dispatch (Requirement 5.6).
byteOrder() - Method in class com.tino1b2be.dtmf.io.RawPcmAudioSource: Return the byte order this source was constructed with.

C

canOpen(InputStream, String) - Method in interface com.tino1b2be.dtmf.io.AudioSourceProvider: Score this provider's confidence that it can open stream (Requirement 4.5).
canOpen(Path) - Method in interface com.tino1b2be.dtmf.io.AudioSourceProvider: Score this provider's confidence that it can open path (Requirement 4.4).
canSeek() - Method in interface com.tino1b2be.dtmf.io.AudioSource: Whether random-access seeking is supported on this source.
canSeek() - Method in class com.tino1b2be.dtmf.io.RawPcmAudioSource
channelCount() - Method in interface com.tino1b2be.dtmf.io.AudioSource: Channel count of the source.
channelCount() - Method in class com.tino1b2be.dtmf.io.RawPcmAudioSource
close() - Method in interface com.tino1b2be.dtmf.io.AudioSource: Release any resources the source owns.
close() - Method in class com.tino1b2be.dtmf.io.RawPcmAudioSource: Release any resources the source owns.
com.tino1b2be.dtmf.io - package com.tino1b2be.dtmf.io: Format-agnostic audio I/O surface for DTMF-Decoder v2.
com.tino1b2be.dtmf.io.internal - package com.tino1b2be.dtmf.io.internal: Package-private implementation details for com.tino1b2be.dtmf.io.
currentFrame() - Method in interface com.tino1b2be.dtmf.io.AudioSource: Zero-based index of the next frame that will be returned by AudioSource.read(double[], int, int) (Requirement 3.13).
currentFrame() - Method in class com.tino1b2be.dtmf.io.RawPcmAudioSource

D

decode(byte[], int) - Method in interface com.tino1b2be.dtmf.io.internal.SampleConversion.SampleDecoder: Decode a single PCM sample starting at offset into a normalised double in [-1.0, 1.0].
decode(AudioSource, DtmfConfig) - Static method in class com.tino1b2be.dtmf.io.DtmfFileDecoder: Decode the DTMF tones in an already-opened AudioSource.
decode(InputStream, String, DtmfConfig) - Static method in class com.tino1b2be.dtmf.io.DtmfFileDecoder: Decode the DTMF tones in stream.
decode(URL, DtmfConfig) - Static method in class com.tino1b2be.dtmf.io.DtmfFileDecoder: Decode the DTMF tones in the audio resource at url.
decode(Path, DtmfConfig) - Static method in class com.tino1b2be.dtmf.io.DtmfFileDecoder: Decode the DTMF tones in the audio file at path.
decodeFloat32BE(byte[], int) - Static method in class com.tino1b2be.dtmf.io.internal.SampleConversion: Decode a big-endian IEEE 754 32-bit float sample and widen to double without scaling.
decodeFloat32LE(byte[], int) - Static method in class com.tino1b2be.dtmf.io.internal.SampleConversion: Decode a little-endian IEEE 754 32-bit float sample and widen to double without scaling.
decodeFloat64BE(byte[], int) - Static method in class com.tino1b2be.dtmf.io.internal.SampleConversion: Decode a big-endian IEEE 754 64-bit double sample bit-exactly.
decodeFloat64LE(byte[], int) - Static method in class com.tino1b2be.dtmf.io.internal.SampleConversion: Decode a little-endian IEEE 754 64-bit double sample bit-exactly.
decodePcm16BE(byte[], int) - Static method in class com.tino1b2be.dtmf.io.internal.SampleConversion: Decode a big-endian signed PCM16 sample and normalise by 2^15.
decodePcm16LE(byte[], int) - Static method in class com.tino1b2be.dtmf.io.internal.SampleConversion: Decode a little-endian signed PCM16 sample and normalise by 2^15.
decodePcm24BE(byte[], int) - Static method in class com.tino1b2be.dtmf.io.internal.SampleConversion: Decode a big-endian signed PCM24 sample, sign-extend from bit 23, and normalise by 2^23.
decodePcm24LE(byte[], int) - Static method in class com.tino1b2be.dtmf.io.internal.SampleConversion: Decode a little-endian signed PCM24 sample, sign-extend from bit 23, and normalise by 2^23.
decodePcm32BE(byte[], int) - Static method in class com.tino1b2be.dtmf.io.internal.SampleConversion: Decode a big-endian signed PCM32 sample and normalise by 2^31.
decodePcm32LE(byte[], int) - Static method in class com.tino1b2be.dtmf.io.internal.SampleConversion: Decode a little-endian signed PCM32 sample and normalise by 2^31.
decodePcm64BE(byte[], int) - Static method in class com.tino1b2be.dtmf.io.internal.SampleConversion: Decode a big-endian signed PCM64 sample and normalise by 2^63.
decodePcm64LE(byte[], int) - Static method in class com.tino1b2be.dtmf.io.internal.SampleConversion: Decode a little-endian signed PCM64 sample and normalise by 2^63.
decoderFor(int, ByteOrder, PcmEncoding) - Static method in class com.tino1b2be.dtmf.io.internal.SampleConversion: Return the SampleConversion.SampleDecoder for a given (bitDepth, byteOrder, encoding) tuple.
decodeUnsignedPcm16BE(byte[], int) - Static method in class com.tino1b2be.dtmf.io.internal.SampleConversion: Decode a big-endian unsigned PCM16 sample, subtract the midpoint 2^15, and normalise by 2^15.
decodeUnsignedPcm16LE(byte[], int) - Static method in class com.tino1b2be.dtmf.io.internal.SampleConversion: Decode a little-endian unsigned PCM16 sample, subtract the midpoint 2^15, and normalise by 2^15.
decodeUnsignedPcm24BE(byte[], int) - Static method in class com.tino1b2be.dtmf.io.internal.SampleConversion: Decode a big-endian unsigned PCM24 sample, subtract the midpoint 2^23, and normalise by 2^23.
decodeUnsignedPcm24LE(byte[], int) - Static method in class com.tino1b2be.dtmf.io.internal.SampleConversion: Decode a little-endian unsigned PCM24 sample, subtract the midpoint 2^23, and normalise by 2^23.
decodeUnsignedPcm32BE(byte[], int) - Static method in class com.tino1b2be.dtmf.io.internal.SampleConversion: Decode a big-endian unsigned PCM32 sample, subtract the midpoint 2^31, and normalise by 2^31.
decodeUnsignedPcm32LE(byte[], int) - Static method in class com.tino1b2be.dtmf.io.internal.SampleConversion: Decode a little-endian unsigned PCM32 sample, subtract the midpoint 2^31, and normalise by 2^31.
decodeUnsignedPcm64BE(byte[], int) - Static method in class com.tino1b2be.dtmf.io.internal.SampleConversion: Decode a big-endian unsigned PCM64 sample, subtract the midpoint 2^63, and normalise by 2^63.
decodeUnsignedPcm64LE(byte[], int) - Static method in class com.tino1b2be.dtmf.io.internal.SampleConversion: Decode a little-endian unsigned PCM64 sample, subtract the midpoint 2^63, and normalise by 2^63.
DtmfFileDecoder - Class in com.tino1b2be.dtmf.io: One-call facade over AudioSources and DtmfDecoder.

E

encoding() - Method in class com.tino1b2be.dtmf.io.RawPcmAudioSource: Return the PCM numeric encoding this source was constructed with.
equals(Object) - Method in record class com.tino1b2be.dtmf.io.internal.ProviderScore: Indicates whether some other object is "equal to" this one.

F

formatName() - Method in interface com.tino1b2be.dtmf.io.AudioSourceProvider: Human-readable identifier for this provider.
fromPcm16LittleEndian(byte[], int, int) - Static method in class com.tino1b2be.dtmf.io.RawPcmAudioSource: Convenience factory for the overwhelmingly common case of 16-bit little-endian signed PCM (Requirement 7.11).

H

hashCode() - Method in record class com.tino1b2be.dtmf.io.internal.ProviderScore: Returns a hash code value for this object.

I

IEEE_FLOAT - Enum constant in enum class com.tino1b2be.dtmf.io.PcmEncoding: IEEE 754 floating-point PCM, already in [-1.0, 1.0] by convention and read without scaling.

O

open(InputStream, String) - Method in interface com.tino1b2be.dtmf.io.AudioSourceProvider: Open an AudioSource for a markable InputStream (Requirement 4.9).
open(InputStream, String) - Static method in class com.tino1b2be.dtmf.io.AudioSources: Open an AudioSource for the given InputStream, scoring every registered provider against it and dispatching to the winner (Requirement 5.3).
open(URL) - Static method in class com.tino1b2be.dtmf.io.AudioSources: Open an AudioSource for the resource at url.
open(Path) - Method in interface com.tino1b2be.dtmf.io.AudioSourceProvider: Open an AudioSource for path (Requirement 4.8).
open(Path) - Static method in class com.tino1b2be.dtmf.io.AudioSources: Open an AudioSource for the file at path by scoring every registered AudioSourceProvider against it and dispatching to the winner (Requirement 5.2).

P

PcmEncoding - Enum Class in com.tino1b2be.dtmf.io: PCM encoding discriminator for RawPcmAudioSource and other linear-PCM carriers in dtmf-io.
priority() - Method in interface com.tino1b2be.dtmf.io.AudioSourceProvider: Tie-breaker priority used when two providers return the same positive score from AudioSourceProvider.canOpen(Path) or AudioSourceProvider.canOpen(InputStream, String) (Requirement 4.3).
priority() - Method in record class com.tino1b2be.dtmf.io.internal.ProviderScore: Returns the value of the priority record component.
provider() - Method in record class com.tino1b2be.dtmf.io.internal.ProviderScore: Returns the value of the provider record component.
providersConsulted() - Method in exception com.tino1b2be.dtmf.io.UnsupportedAudioFormatException: Format names of every AudioSourceProvider that was asked to score the input, in ServiceLoader discovery order (Requirement 6.4).
ProviderScore - Record Class in com.tino1b2be.dtmf.io.internal: Scoring bookkeeping for a single AudioSourceProvider during the content-based dispatch performed by AudioSources.open(...).
ProviderScore(AudioSourceProvider, int, int) - Constructor for record class com.tino1b2be.dtmf.io.internal.ProviderScore: Compact constructor enforcing that provider is non-null.
providerScores() - Method in exception com.tino1b2be.dtmf.io.UnsupportedAudioFormatException: Score returned by each consulted AudioSourceProvider, keyed by formatName() (Requirement 6.5).

R

RawPcmAudioSource - Class in com.tino1b2be.dtmf.io: AudioSource wrapping an in-memory byte[] of raw linear PCM bytes with caller-supplied format metadata.
RawPcmAudioSource(byte[], int, int, ByteOrder, int, PcmEncoding) - Constructor for class com.tino1b2be.dtmf.io.RawPcmAudioSource: Wrap a caller-supplied byte buffer of raw linear PCM bytes.
read(double[]) - Method in interface com.tino1b2be.dtmf.io.AudioSource: Read up to buffer.length / channelCount() frames into buffer, starting at index 0.
read(double[], int, int) - Method in interface com.tino1b2be.dtmf.io.AudioSource: Read up to length sample frames into buffer starting at offset.
read(double[], int, int) - Method in class com.tino1b2be.dtmf.io.RawPcmAudioSource: Read up to length sample frames into buffer starting at offset.
registeredFormats() - Static method in class com.tino1b2be.dtmf.io.AudioSources: Names of every loaded AudioSourceProvider in ServiceLoader discovery order (Requirement 5.11).

S

SampleConversion - Class in com.tino1b2be.dtmf.io.internal: Shared PCM sample normalisation helper for the dtmf-io family of modules.
SampleConversion.SampleDecoder - Interface in com.tino1b2be.dtmf.io.internal: Primitive functional interface for a single-frame PCM decoder.
sampleRate() - Method in interface com.tino1b2be.dtmf.io.AudioSource: Sample rate of the source in Hertz.
sampleRate() - Method in class com.tino1b2be.dtmf.io.RawPcmAudioSource
score() - Method in record class com.tino1b2be.dtmf.io.internal.ProviderScore: Returns the value of the score record component.
seek(long) - Method in interface com.tino1b2be.dtmf.io.AudioSource: Reposition the read cursor so the next AudioSource.read(double[], int, int) returns frames starting at frameIndex from the start of the source (Requirement 3.10).
seek(long) - Method in class com.tino1b2be.dtmf.io.RawPcmAudioSource: Reposition the read cursor so the next AudioSource.read(double[], int, int) returns frames starting at frameIndex from the start of the source (Requirement 3.10).
SIGNED_INT - Enum constant in enum class com.tino1b2be.dtmf.io.PcmEncoding: Two's-complement signed integer PCM.

T

toString() - Method in record class com.tino1b2be.dtmf.io.internal.ProviderScore: Returns a string representation of this record class.
totalFrames() - Method in interface com.tino1b2be.dtmf.io.AudioSource: Total number of sample frames available from the source, or -1L if the total is unknown.
totalFrames() - Method in class com.tino1b2be.dtmf.io.RawPcmAudioSource

U

UNSIGNED_INT - Enum constant in enum class com.tino1b2be.dtmf.io.PcmEncoding: Unsigned integer PCM; the midpoint 2^(bitDepth - 1) represents silence.
UnsupportedAudioFormatException - Exception in com.tino1b2be.dtmf.io: Thrown when no AudioSourceProvider can open a given input, or when a provider that scored non-negative on AudioSourceProvider.canOpen(java.nio.file.Path) cannot in fact decode the file once it opens it (structural mismatch, unsupported compression code, malformed header after the magic-byte prefix, etc.).
UnsupportedAudioFormatException(String) - Constructor for exception com.tino1b2be.dtmf.io.UnsupportedAudioFormatException: Construct an UnsupportedAudioFormatException with the given detail message and no cause.
UnsupportedAudioFormatException(String, Throwable) - Constructor for exception com.tino1b2be.dtmf.io.UnsupportedAudioFormatException: Construct an UnsupportedAudioFormatException wrapping an underlying cause.

V

valueOf(String) - Static method in enum class com.tino1b2be.dtmf.io.PcmEncoding: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.tino1b2be.dtmf.io.PcmEncoding: Returns an array containing the constants of this enum class, in the order they are declared.

A B C D E F H I O P R S T U V
All Classes and Interfaces|All Packages|Serialized Form