Index (dtmf-core 2.1.0 API)

A B C D E F G H K L M N O P R S T V W
All Classes and Interfaces|All Packages

A

accept(double) - Method in class com.tino1b2be.dtmf.internal.AnalysisPipeline: Feed a single sample through the pipeline.
acceptAll(double[], int, int) - Method in class com.tino1b2be.dtmf.internal.AnalysisPipeline: Feed a range of samples through the pipeline.
advanced() - Static method in class com.tino1b2be.dtmf.DtmfConfig: Returns a new DtmfConfig.Advanced builder seeded with the values from DtmfConfig.forTelephony().
ALL_EIGHT - Static variable in class com.tino1b2be.dtmf.internal.FrequencyBins: The eight DTMF frequencies in a single array, ordered as LOW_GROUP ∥ HIGH_GROUP.
analysisBlockSize() - Method in class com.tino1b2be.dtmf.DtmfConfig: Returns the analysis block size in samples.
analysisBlockSize(int) - Method in class com.tino1b2be.dtmf.DtmfConfig.Advanced: Set the analysis block size explicitly.
AnalysisPipeline - Class in com.tino1b2be.dtmf.internal: Block-level DTMF detection engine shared by DtmfDecoder (batch) and DtmfDetector (push).
AnalysisPipeline(DtmfConfig, int, Consumer<DtmfTone>) - Constructor for class com.tino1b2be.dtmf.internal.AnalysisPipeline: Construct a pipeline bound to the given config, channel tag, and tone sink.
applyInPlace(double[], int, int) - Method in enum class com.tino1b2be.dtmf.WindowFunction: Multiply each sample in samples[offset .. offset + length) by the corresponding window coefficient, in place.

B

blockSizeFor(int) - Static method in class com.tino1b2be.dtmf.internal.BlockSizer: Compute the analysis block size for the given sample rate so that the effective Goertzel bin width lies in [40, 60] Hz.
BlockSizer - Class in com.tino1b2be.dtmf.internal: Analysis-block sizing logic for the DTMF detection pipeline.
build() - Method in class com.tino1b2be.dtmf.DtmfConfig.Advanced: Materialize an immutable DtmfConfig from the values set on this builder.

C

channel() - Method in record class com.tino1b2be.dtmf.DtmfTone: Returns the value of the channel record component.
channelMode() - Method in class com.tino1b2be.dtmf.DtmfConfig: Returns the channel mode.
channelMode(ChannelMode) - Method in class com.tino1b2be.dtmf.DtmfConfig.Advanced: Set the channel mode.
ChannelMode - Enum Class in com.tino1b2be.dtmf: How an incoming sample array should be interpreted as one or more audio channels for DTMF detection.
close() - Method in class com.tino1b2be.dtmf.DtmfStream: Flush the underlying detector and release references to the DtmfStream.SampleSource.
com.tino1b2be.dtmf - package com.tino1b2be.dtmf: DTMF detection, generation, and streaming API for DTMF-Decoder v2.
com.tino1b2be.dtmf.internal - package com.tino1b2be.dtmf.internal
compute(double, double, double) - Static method in class com.tino1b2be.dtmf.internal.ConfidenceScorer: Compute the confidence score for a candidate pair.
confidence() - Method in record class com.tino1b2be.dtmf.DtmfTone: Returns the value of the confidence record component.
ConfidenceScorer - Class in com.tino1b2be.dtmf.internal: Confidence scoring for a candidate DTMF tone pair.
confirmationFrames() - Method in class com.tino1b2be.dtmf.DtmfConfig: Returns the number of consecutive analysis blocks required to confirm a tone.
confirmationFrames(int) - Method in class com.tino1b2be.dtmf.DtmfConfig.Advanced: Set the number of consecutive analysis blocks required to confirm a tone.

D

decode(double[], DtmfConfig) - Static method in class com.tino1b2be.dtmf.DtmfDecoder: Decode a double[] buffer of normalised PCM samples in [-1.0, 1.0].
decode(float[], DtmfConfig) - Static method in class com.tino1b2be.dtmf.DtmfDecoder: Decode a float[] buffer of normalised samples in [-1.0, 1.0].
decode(int[], DtmfConfig) - Static method in class com.tino1b2be.dtmf.DtmfDecoder: Decode an int[] buffer of signed PCM32 samples.
decode(short[], DtmfConfig) - Static method in class com.tino1b2be.dtmf.DtmfDecoder: Decode a short[] buffer of signed PCM16 samples.
decodePcm24(int[], DtmfConfig) - Static method in class com.tino1b2be.dtmf.DtmfDecoder: Decode an int[] buffer where each entry carries a signed PCM24 value in its low 24 bits.
defaults() - Static method in class com.tino1b2be.dtmf.DtmfConfig: Returns a configuration suitable for 8 kHz mono telephony audio with Standard_Twist tolerances.
detectionThreshold() - Method in class com.tino1b2be.dtmf.DtmfConfig: Returns the detection-confidence threshold in [0.0, 1.0].
detectionThreshold(double) - Method in class com.tino1b2be.dtmf.DtmfConfig.Advanced: Set the detection-confidence threshold.
DtmfConfig - Class in com.tino1b2be.dtmf: Immutable configuration for DTMF detection and generation.
DtmfConfig.Advanced - Class in com.tino1b2be.dtmf: Fluent builder for DtmfConfig, exposing every knob and the wider [4000, 192000] sample-rate domain.
DtmfDecoder - Class in com.tino1b2be.dtmf: Batch DTMF decoder: turn a buffer of PCM samples into a list of detected DtmfTone instances.
DtmfDetector - Class in com.tino1b2be.dtmf: Push-based DTMF detector: the caller feeds chunks of audio samples and receives DtmfTone emissions via a registered Consumer callback.
DtmfDetector(DtmfConfig) - Constructor for class com.tino1b2be.dtmf.DtmfDetector: Construct a new detector for the given configuration.
DtmfGenerator - Class in com.tino1b2be.dtmf: DTMF tone generation: turn a key sequence into normalised double PCM samples suitable for feeding back through DtmfDecoder.decode(double[], DtmfConfig) or playing through an audio output.
DtmfStream - Class in com.tino1b2be.dtmf: Pull-based DTMF iteration: expose a DtmfDetector as an Iterator over emitted DtmfTone values.
DtmfStream.SampleSource - Interface in com.tino1b2be.dtmf: A source of double PCM samples for DtmfStream.fromSource(SampleSource, DtmfConfig).
DtmfTone - Record Class in com.tino1b2be.dtmf: Immutable value object describing one detected or generated DTMF tone.
DtmfTone(char, long, long, int, double, int) - Constructor for record class com.tino1b2be.dtmf.DtmfTone: Compact constructor validating every field.
duration() - Method in record class com.tino1b2be.dtmf.DtmfTone: Returns the duration of this tone, equal to endTime().minus(startTime()).

E

endSample() - Method in record class com.tino1b2be.dtmf.DtmfTone: Returns the value of the endSample record component.
endTime() - Method in record class com.tino1b2be.dtmf.DtmfTone: Returns the end position of this tone as a Duration.
equals(Object) - Method in record class com.tino1b2be.dtmf.DtmfTone: Indicates whether some other object is "equal to" this one.

F

flush() - Method in class com.tino1b2be.dtmf.DtmfDetector: Finalise any tone still in flight.
flush() - Method in class com.tino1b2be.dtmf.internal.AnalysisPipeline: Finalise any in-progress tone.
forNoisyAudio() - Static method in class com.tino1b2be.dtmf.DtmfConfig: Returns a configuration tuned for noisy audio.
forTelephony() - Static method in class com.tino1b2be.dtmf.DtmfConfig: Returns a configuration tuned for ITU-T Q.24 telephony audio.
forVoip() - Static method in class com.tino1b2be.dtmf.DtmfConfig: Returns a configuration tuned for VoIP audio.
forwardTwistDb() - Method in class com.tino1b2be.dtmf.DtmfConfig: Returns the forward-twist tolerance in dB.
forwardTwistDb(double) - Method in class com.tino1b2be.dtmf.DtmfConfig.Advanced: Set the forward-twist tolerance in dB.
frequenciesFor(char) - Static method in class com.tino1b2be.dtmf.internal.FrequencyBins: Look up the (lowHz, highHz) frequency pair for a DTMF key symbol.
FrequencyBins - Class in com.tino1b2be.dtmf.internal: ITU-T Q.23 DTMF frequency tables.
fromFloat(float[]) - Static method in class com.tino1b2be.dtmf.internal.SampleConverter: Convert normalized float samples to double in a new array via direct widening.
fromFloatInto(float[], double[]) - Static method in class com.tino1b2be.dtmf.internal.SampleConverter: Copy normalized float samples into a caller-supplied double[] destination via direct widening, starting at index 0.
fromInt(int[]) - Static method in class com.tino1b2be.dtmf.internal.SampleConverter: Convert signed PCM32 samples to normalized double in a new array.
fromIntInto(int[], double[]) - Static method in class com.tino1b2be.dtmf.internal.SampleConverter: Convert signed PCM32 samples into a caller-supplied destination starting at index 0.
fromPcm24(int[]) - Static method in class com.tino1b2be.dtmf.internal.SampleConverter: Convert signed PCM24 samples packed into the low 24 bits of each int to normalized double in a new array.
fromSamples(double[], DtmfConfig) - Static method in class com.tino1b2be.dtmf.DtmfStream: Create a DtmfStream over a pre-existing double[] sample buffer.
fromShort(short[]) - Static method in class com.tino1b2be.dtmf.internal.SampleConverter: Convert signed PCM16 samples to normalized double in a new array.
fromShortInto(short[], double[]) - Static method in class com.tino1b2be.dtmf.internal.SampleConverter: Convert signed PCM16 samples into a caller-supplied destination starting at index 0.
fromSource(DtmfStream.SampleSource, DtmfConfig) - Static method in class com.tino1b2be.dtmf.DtmfStream: Create a DtmfStream that pulls samples from source.

G

generate(String, DtmfConfig) - Static method in class com.tino1b2be.dtmf.DtmfGenerator: Generate a fresh double[] holding the PCM samples for sequence.
generateInto(String, DtmfConfig, double[], int) - Static method in class com.tino1b2be.dtmf.DtmfGenerator: Generate PCM samples for sequence into a caller-supplied buffer starting at offset.

H

HAMMING - Enum constant in enum class com.tino1b2be.dtmf.WindowFunction: Hamming window: 0.54 - 0.46 · cos(2π · n / (N - 1)).
HANN - Enum constant in enum class com.tino1b2be.dtmf.WindowFunction: Hann window: 0.5 · (1 - cos(2π · n / (N - 1))).
hashCode() - Method in record class com.tino1b2be.dtmf.DtmfTone: Returns a hash code value for this object.
hasNext() - Method in class com.tino1b2be.dtmf.DtmfStream
HIGH_GROUP - Static variable in class com.tino1b2be.dtmf.internal.FrequencyBins: High-group DTMF frequencies in Hz, indexed 0..3.

K

key() - Method in record class com.tino1b2be.dtmf.DtmfTone: Returns the value of the key record component.
KEY_MATRIX - Static variable in class com.tino1b2be.dtmf.internal.FrequencyBins: The 4×4 key matrix: KEY_MATRIX[lowIndex][highIndex] is the DTMF symbol for the tone pair (LOW_GROUP[lowIndex], HIGH_GROUP[highIndex]).
keyFor(int, int) - Static method in class com.tino1b2be.dtmf.internal.FrequencyBins: Look up the DTMF symbol for the given low-group / high-group peak indices.

L

LOW_GROUP - Static variable in class com.tino1b2be.dtmf.internal.FrequencyBins: Low-group DTMF frequencies in Hz, indexed 0..3.

M

minimumGapDuration() - Method in class com.tino1b2be.dtmf.DtmfConfig: Returns the minimum inter-tone gap duration.
minimumGapDuration(Duration) - Method in class com.tino1b2be.dtmf.DtmfConfig.Advanced: Set the minimum inter-tone gap duration.
minimumToneDuration() - Method in class com.tino1b2be.dtmf.DtmfConfig: Returns the minimum tone duration.
minimumToneDuration(Duration) - Method in class com.tino1b2be.dtmf.DtmfConfig.Advanced: Set the minimum tone duration.
MONO - Enum constant in enum class com.tino1b2be.dtmf.ChannelMode: Single-channel input; all emitted tones carry channel = 0.

N

next() - Method in class com.tino1b2be.dtmf.DtmfStream

O

onTone(Consumer<DtmfTone>) - Method in class com.tino1b2be.dtmf.DtmfDetector: Register the callback that receives every emitted DtmfTone.

P

process(double[]) - Method in class com.tino1b2be.dtmf.DtmfDetector: Feed a full chunk of double[] samples through the detector.
process(double[], int, int) - Method in class com.tino1b2be.dtmf.DtmfDetector: Feed a sub-range of a double[] through the detector.
process(float[]) - Method in class com.tino1b2be.dtmf.DtmfDetector: Feed a chunk of normalised float samples through the detector.
process(int[]) - Method in class com.tino1b2be.dtmf.DtmfDetector: Feed a chunk of signed PCM32 samples through the detector.
process(short[]) - Method in class com.tino1b2be.dtmf.DtmfDetector: Feed a chunk of signed PCM16 samples through the detector.

R

readInto(double[], int, int) - Method in interface com.tino1b2be.dtmf.DtmfStream.SampleSource: Read up to length samples into buffer[offset .. offset + length).
RECTANGULAR - Enum constant in enum class com.tino1b2be.dtmf.WindowFunction: No window; samples pass through unchanged.
reverseTwistDb() - Method in class com.tino1b2be.dtmf.DtmfConfig: Returns the reverse-twist tolerance in dB.
reverseTwistDb(double) - Method in class com.tino1b2be.dtmf.DtmfConfig.Advanced: Set the reverse-twist tolerance in dB.

S

SampleConverter - Class in com.tino1b2be.dtmf.internal: Sample-format normalization for the DTMF detection pipeline.
sampleRate() - Method in class com.tino1b2be.dtmf.DtmfConfig: Returns the sample rate in Hz.
sampleRate() - Method in record class com.tino1b2be.dtmf.DtmfTone: Returns the value of the sampleRate record component.
sampleRate(int) - Method in class com.tino1b2be.dtmf.DtmfConfig.Advanced: Set the sample rate.
samplesProcessed() - Method in class com.tino1b2be.dtmf.DtmfDetector: Returns the cumulative number of samples passed to any process overload since construction.
samplesProcessed() - Method in class com.tino1b2be.dtmf.internal.AnalysisPipeline: Returns the cumulative number of samples that have been fed to AnalysisPipeline.accept(double) since this pipeline was constructed.
startSample() - Method in record class com.tino1b2be.dtmf.DtmfTone: Returns the value of the startSample record component.
startTime() - Method in record class com.tino1b2be.dtmf.DtmfTone: Returns the start position of this tone as a Duration.
STEREO_DOWNMIX - Enum constant in enum class com.tino1b2be.dtmf.ChannelMode: Interleaved stereo input averaged into a single mono stream before detection.
STEREO_INDEPENDENT - Enum constant in enum class com.tino1b2be.dtmf.ChannelMode: Interleaved stereo input decoded as two independent channels.

T

toString() - Method in record class com.tino1b2be.dtmf.DtmfTone: Returns a string representation of this record class.
twistDb(double, double) - Static method in class com.tino1b2be.dtmf.internal.TwistEvaluator: Compute the twist in decibels for a candidate DTMF pair.
TwistEvaluator - Class in com.tino1b2be.dtmf.internal: Twist computation and tolerance check for a candidate DTMF tone pair.

V

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

W

windowFunction() - Method in class com.tino1b2be.dtmf.DtmfConfig: Returns the window function applied to each analysis block.
windowFunction(WindowFunction) - Method in class com.tino1b2be.dtmf.DtmfConfig.Advanced: Set the window function.
WindowFunction - Enum Class in com.tino1b2be.dtmf: Window function applied to each analysis block before the Goertzel bank computes magnitudes.
withinTolerance(double, DtmfConfig) - Static method in class com.tino1b2be.dtmf.internal.TwistEvaluator: Returns whether the given twist in dB lies within the tolerance band configured on cfg.

A B C D E F G H K L M N O P R S T V W
All Classes and Interfaces|All Packages