Package org.openhab.core.audio.utils

Class ToneSynthesizer

java.lang.Object

org.openhab.core.audio.utils.ToneSynthesizer

@NonNullByDefault
public class ToneSynthesizer
extends Object

An audio tone synthesizer. A utility to sent tone melodies to audio sinks. Limited to wav little endian streams.

Author:

Miguel Álvarez - Initial contribution

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ToneSynthesizer.Note
static class	ToneSynthesizer.Tone

Constructor Summary

Constructors

Constructor	Description
ToneSynthesizer(AudioFormat audioFormat)

Method Summary

Modifier and Type	Method	Description
AudioStream	getStream(List<ToneSynthesizer.Tone> tones)	Synthesize a list of ToneSynthesizer.Tone into a wav audio stream
static Set<AudioFormat>	getSupportedFormats()
static ToneSynthesizer.Tone	noteTone(ToneSynthesizer.Note note, long millis)
static ToneSynthesizer.Tone	noteTone(ToneSynthesizer.Note note, long millis, int octaves)
static List<ToneSynthesizer.Tone>	parseMelody(String melody)	Parses a tone melody into a list of ToneSynthesizer.Tone instances.
static ToneSynthesizer.Tone	silenceTone(long millis)

Methods inherited from class java.lang.Object

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

Constructor Details

ToneSynthesizer

public ToneSynthesizer(AudioFormat audioFormat)

Method Details

getSupportedFormats

public static Set<AudioFormat> getSupportedFormats()

parseMelody

public static List<ToneSynthesizer.Tone> parseMelody(String melody)
                                              throws ParseException

Parses a tone melody into a list of ToneSynthesizer.Tone instances. The melody should be a spaced separated list of note names or silences (character 0 or O). You can optionally add the character "'" to increase the note one octave. You can optionally add ":ms" where ms is an int value to customize the note/silence milliseconds duration (defaults to 200ms).

Parameters:

melody - to be parsed.

Returns:

list of ToneSynthesizer.Tone instances.

Throws:

ParseException - if melody can not be played.

noteTone

public static ToneSynthesizer.Tone noteTone(ToneSynthesizer.Note note,
 long millis)

noteTone

public static ToneSynthesizer.Tone noteTone(ToneSynthesizer.Note note,
 long millis,
 int octaves)

silenceTone

public static ToneSynthesizer.Tone silenceTone(long millis)

getStream

public AudioStream getStream(List<ToneSynthesizer.Tone> tones)
                      throws IOException

Synthesize a list of ToneSynthesizer.Tone into a wav audio stream

Parameters:

tones - the list of ToneSynthesizer.Tone

Returns:

an audio stream with the synthesized tones

Throws:

IOException - in case of problems writing the audio stream