org.harctoolbox.IrpMaster

Class IrSignal

java.lang.Object

org.harctoolbox.IrpMaster.IrSignal

public class IrSignal
extends Object

This class models a rendered IR signals. It consists of a frequency, a duty cycle, and an intro sequence, a repeat sequence, and an ending sequence. Any of the latter three, but not all, can be empty, but not null.

The "count" semantic: The "count" argument in functions like toModulatedIrSequece(int count) is interpreted like this: If the intro sequence is null, then "count" copies or the repeat sequence are used, otherwise count-1. It is believed that this interpretation is consistent with the heuristic meaning of 'sending a signal "count" times'.

The "repetitions" semantic: "repetition" number of copies of the repeat sequence are used.

This class is immutable.

See Also:

IrSequence

Field Summary

Fields

Modifier and Type	Field and Description
protected double	dutyCycle Duty cycle of the modulation.
protected IrSequence	endingSequence Ending sequence, sent at the end of transmission.
protected double	frequency Modulation frequency in Hz.
protected IrSequence	introSequence Intro sequence, always sent once.
protected EnumMap<Pass,IrSequence>	map "Table" for mapping Pass to intro, repeat, or ending sequence.
protected IrSequence	repeatSequence Repeat sequence, sent after the intro sequence if the signal is repeating.

Constructor Summary

Constructors

Constructor and Description
IrSignal() Constructs an IrSignal of zero length.
IrSignal(double frequency, double dutyCycle, IrSequence introSequence, IrSequence repeatSequence, IrSequence endingSequence) Constructs an IrSignal from its arguments.
IrSignal(double frequency, double dutyCycle, String introSequence, String repeatSequence, String endingSequence) Constructs an IrSignal from its arguments.
IrSignal(int[] ccf) Creates an IrSignal from a CCF array.
IrSignal(int[] durations, int noIntroBursts, int noRepeatBursts, int frequency) Constructs an IrSignal from its arguments.
IrSignal(int[] durations, int noIntroBursts, int noRepeatBursts, int frequency, double dutyCycle) Constructs an IrSignal from its arguments.
IrSignal(IrpMaster irpMaster, String protocolName, HashMap<String,Long> parameters) Constructs an IrSignal from its arguments.
IrSignal(String ccf) Creates an IrSignal from a CCF string.
IrSignal(String[] ccf, int begin) Creates an IrSignal from a CCF array.
IrSignal(String protocolsIniPath, int offset, String... args) Intended to construct an IrSignal from the args of a main-routine, for example for exporting.
IrSignal(String protocolsIniPath, String protocolName, HashMap<String,Long> parameters) Convenience version of the constructor with an IrpMaster instance.
IrSignal(String protocolsIniPath, String protocolName, String parameters) Constructs an IrSignal from its arguments.

Method Summary

Modifier and Type	Method and Description
String	ccfString() Computes the CCF form, if possible.
boolean	containsZeros() Returns true if and only if the sequence contains durations of zero length.
double	getDouble(Pass pass, int i)
double	getDuration() Computes the duration in microseconds of the intro sequence, one repeat sequence, plus the ending sequence.
double	getDuration(int count) Computes the duration in microseconds of the intro sequence, repetitions repeats of the repeat sequence, plus the ending sequence.
double	getDutyCycle()
int	getEndingBursts()
double	getEndingDouble(int i)
int[]	getEndingInts(boolean alternatingSigns)
int	getEndingLength()
int[]	getEndingPulses()
ModulatedIrSequence	getEndingSequence()
double	getFrequency()
double	getGap() Returns max gap of intro- and repeat sequences.
int	getIntroBursts() Returns number of burst pairs in the intro sequence.
double	getIntroDouble(int i) Returns the i'th data in the intro sequence, as double.
int[]	getIntroInts(boolean alternatingSigns) Returns the data in the intro sequence, as a sequence of microsecond durations.
int	getIntroLength() Returns length of Intro sequence, in number of flashes and gaps.
int[]	getIntroPulses() Returns the data in the intro sequence, as a sequence of pulses in the used frequency.
ModulatedIrSequence	getIntroSequence()
int	getLength(Pass pass)
int	getRepeatBursts()
double	getRepeatDouble(int i)
int[]	getRepeatInts(boolean alternatingSigns)
int	getRepeatLength()
int[]	getRepeatPulses()
ModulatedIrSequence	getRepeatSequence()
boolean	isEmpty()
static void	main(String[] args) Just for testing.
int	repeatsPerCountSemantic(int count) Returns the number of repetitions according to the count semantics.
void	replaceZeros(double replacement) Replace all zero durations.
void	replaceZeros(int replacement) Replace all zero durations.
int[]	toIntArray() Equivalent to toIntArray(1)
int[]	toIntArray(int repetitions) Returns an integer array of one intro sequence, repeat number of repeat sequence, followed by one ending sequence.
int[]	toIntArrayCount(int count) Returns an integer array of one intro sequence, count or count-1 number of repeat sequence, dependent on if intro is empty or not, followed by one ending sequence.
ModulatedIrSequence	toModulatedIrSequence(boolean intro, int repetitions, boolean ending) Returns a ModulatedIrSequence consisting of zero or one intro sequence, repetition number of repeat sequence, and zero or one ending sequence.
ModulatedIrSequence	toModulatedIrSequence(int count) Returns a ModulatedIrSequence consisting of one intro sequence, count or count-1 number of repeat sequence, dependent on if intro is empty or not, followed by one ending sequence.
String	toPrintString()
String	toPrintString(boolean alternatingSigns) Analog to the IrSequence toPrintString.
String	toString()
String	toString(boolean alternatingSigns) Generates nice string.

Methods inherited from class java.lang.Object

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

Field Detail

introSequence

protected IrSequence introSequence

Intro sequence, always sent once. Can be empty, but not null.

repeatSequence

protected IrSequence repeatSequence

Repeat sequence, sent after the intro sequence if the signal is repeating. Can be empty, but not null.

endingSequence

protected IrSequence endingSequence

Ending sequence, sent at the end of transmission. Can be empty (but not null), actually, most often is.

map

protected EnumMap<Pass,IrSequence> map

"Table" for mapping Pass to intro, repeat, or ending sequence.

frequency

protected double frequency

Modulation frequency in Hz. Use 0 for not modulated.

dutyCycle

protected double dutyCycle

Duty cycle of the modulation. Between 0 and 1. Use -1 for not assigned.

Constructor Detail

IrSignal

public IrSignal(double frequency,
                double dutyCycle,
                IrSequence introSequence,
                IrSequence repeatSequence,
                IrSequence endingSequence)

Constructs an IrSignal from its arguments.

Parameters:

frequency -

dutyCycle -

introSequence -

repeatSequence -

endingSequence -

IrSignal

public IrSignal(int[] durations,
                int noIntroBursts,
                int noRepeatBursts,
                int frequency)

Constructs an IrSignal from its arguments.

Parameters:

durations -

noIntroBursts -

noRepeatBursts -

frequency -

IrSignal

public IrSignal(double frequency,
                double dutyCycle,
                String introSequence,
                String repeatSequence,
                String endingSequence)
         throws IncompatibleArgumentException

Constructs an IrSignal from its arguments.

Parameters:

frequency -

dutyCycle -

introSequence -

repeatSequence -

endingSequence -

Throws:

IncompatibleArgumentException

IrSignal

public IrSignal(int[] durations,
                int noIntroBursts,
                int noRepeatBursts,
                int frequency,
                double dutyCycle)

Constructs an IrSignal from its arguments. The first 2*noIntroBursts durations belong to the Intro signal, the next 2*noRepeatBursts to the repetition part, and the remaining to the ending sequence.

Parameters:

durations - Integer array of durations. Signs of the entries are ignored,

noIntroBursts - Number of bursts (half the number of entries) belonging to the intro sequence.

noRepeatBursts - Number of bursts (half the number of entries) belonging to the intro sequence.

frequency - Modulation frequency in Hz.

dutyCycle - Duty cycle of modulation pulse, between 0 and 1. Use -1 for not specified.

IrSignal

public IrSignal()

Constructs an IrSignal of zero length.

IrSignal

public IrSignal(String ccf)
         throws IrpMasterException

Creates an IrSignal from a CCF string. Also some "short formats" of CCF are recognized.

Parameters:

ccf - String supposed to represent a valid CCF signal.

Throws:

IrpMasterException - Error in CCF

See Also:

Pronto

IrSignal

public IrSignal(int[] ccf)
         throws IrpMasterException

Creates an IrSignal from a CCF array. Also some "short formats" of CCF are recognized.

Parameters:

ccf - Integer array supposed to represent a valid CCF signal.

Throws:

IrpMasterException - Error in CCF

See Also:

Pronto

IrSignal

public IrSignal(String[] ccf,
                int begin)
         throws IrpMasterException

Creates an IrSignal from a CCF array. Also some "short formats" of CCF are recognized.

Parameters:

begin - starting index

ccf - String array supposed to represent a valid CCF signal.

Throws:

IrpMasterException - Error in CCF

See Also:

Pronto

IrSignal

public IrSignal(String protocolsIniPath,
                int offset,
                String... args)
         throws IrpMasterException,
                FileNotFoundException,
                UnassignedException

Intended to construct an IrSignal from the args of a main-routine, for example for exporting. It can be used to decode the non-option arguments. Either the arguments are hexadecimal numbers to be interpreted as a CCF type signal, or it is expected to be a protocol name followed by a number of parameters. The parameters can be given either as name=value pairs, and/or as unnamed parameters, whereas one parameter is taken to be F, two parameters are taken to be D and F, three parameters D, S, and F, while four parameters are interpreted as D, S, F, and T.

Parameters:

protocolsIniPath - Path to Protocols.ini of the IrpMaster. There is no default.

offset - How many initial elements of the argument vector to ignore.

args - String array, typically the arguments of main.

Throws:

IrpMasterException

FileNotFoundException

UnassignedException

See Also:

IrpMaster, Protocol

IrSignal

public IrSignal(String protocolsIniPath,
                String protocolName,
                HashMap<String,Long> parameters)
         throws FileNotFoundException,
                IrpMasterException

Convenience version of the constructor with an IrpMaster instance. Equivalent to IrSignal(new IrpMaster(protocolsIniPath), protocolName, parameters).

Parameters:

protocolsIniPath - Path to IrpProtocols.ini

protocolName - name of protocol

parameters - Dictionary of parameter values

Throws:

FileNotFoundException

IrpMasterException

IrSignal

public IrSignal(IrpMaster irpMaster,
                String protocolName,
                HashMap<String,Long> parameters)
         throws IrpMasterException

Constructs an IrSignal from its arguments.

Parameters:

irpMaster -

protocolName - name of protocol

parameters - Dictionary of parameter values

Throws:

IrpMasterException

IrSignal

public IrSignal(String protocolsIniPath,
                String protocolName,
                String parameters)
         throws FileNotFoundException,
                IrpMasterException

Constructs an IrSignal from its arguments.

Parameters:

protocolsIniPath - Path to IrpProtocols.ini

protocolName - name of protocol

parameters - String of parameter assignments like "D=12 F=34"

Throws:

FileNotFoundException

IrpMasterException

Method Detail

getFrequency

public double getFrequency()

getDutyCycle

public double getDutyCycle()

getIntroLength

public int getIntroLength()

Returns length of Intro sequence, in number of flashes and gaps.

Returns:

length of intro

See Also:

IrSequence

getIntroBursts

public int getIntroBursts()

Returns number of burst pairs in the intro sequence.

Returns:

number of burst pairs in intro sequence

See Also:

IrSequence

getIntroInts

public int[] getIntroInts(boolean alternatingSigns)

Returns the data in the intro sequence, as a sequence of microsecond durations.

Parameters:

alternatingSigns -

Returns:

integer sequence of durations in microseconds, possibly with sign.

See Also:

IrSequence

getIntroPulses

public int[] getIntroPulses()

Returns the data in the intro sequence, as a sequence of pulses in the used frequency.

Returns:

integer array of pulses

See Also:

IrSequence

getIntroDouble

public double getIntroDouble(int i)

Returns the i'th data in the intro sequence, as double.

Parameters:

i - index

Returns:

duration, possibly with sign.

See Also:

IrSequence

getRepeatLength

public int getRepeatLength()

getRepeatBursts

public int getRepeatBursts()

getRepeatInts

public int[] getRepeatInts(boolean alternatingSigns)

getRepeatPulses

public int[] getRepeatPulses()

getRepeatDouble

public double getRepeatDouble(int i)

getEndingLength

public int getEndingLength()

getEndingBursts

public int getEndingBursts()

getEndingInts

public int[] getEndingInts(boolean alternatingSigns)

getEndingPulses

public int[] getEndingPulses()

getEndingDouble

public double getEndingDouble(int i)

getDuration

public double getDuration()

Computes the duration in microseconds of the intro sequence, one repeat sequence, plus the ending sequence.

Returns:

duration in microseconds.

getDuration

public double getDuration(int count)

Computes the duration in microseconds of the intro sequence, repetitions repeats of the repeat sequence, plus the ending sequence. Uses the count semantic.

Parameters:

count - Uses count semantic.

Returns:

duration in microseconds.

getDouble

public double getDouble(Pass pass,
                        int i)

getLength

public int getLength(Pass pass)

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(boolean alternatingSigns)

Generates nice string. Generate alternating signs according to the parameter.

Parameters:

alternatingSigns - if true generate alternating signs, otherwise remove signs.

Returns:

nice string.

toPrintString

public String toPrintString(boolean alternatingSigns)

Analog to the IrSequence toPrintString.

Parameters:

alternatingSigns - If true, generated signs will have alternating signs, ignoring original signs, otherwise signs are preserved.

Returns:

Nicely formatted string.

See Also:

IrSequence

toPrintString

public String toPrintString()

repeatsPerCountSemantic

public int repeatsPerCountSemantic(int count)

Returns the number of repetitions according to the count semantics.

Parameters:

count -

Returns:

introSequence.isEmpty() ? count : count - 1

toIntArray

public int[] toIntArray(int repetitions)

Returns an integer array of one intro sequence, repeat number of repeat sequence, followed by one ending sequence. The sizes can be obtained with the get*Length()- or get*Bursts()-functions.

Parameters:

repetitions - Number of times of to include the repeat sequence.

Returns:

integer array as copy.

toIntArray

public int[] toIntArray()

Equivalent to toIntArray(1)

Returns:

toIntArrayCount

public int[] toIntArrayCount(int count)

Returns an integer array of one intro sequence, count or count-1 number of repeat sequence, dependent on if intro is empty or not, followed by one ending sequence. The sizes can be obtained with the get*Length()- or get*Bursts()-functions.

Parameters:

count - Number of times of the "signal" to send, according to the count semantic.

Returns:

integer array as copy.

isEmpty

public boolean isEmpty()

Returns:

Emptyness of the signal.

containsZeros

public boolean containsZeros()

Returns true if and only if the sequence contains durations of zero length.

Returns:

existence of zero durations.

replaceZeros

public void replaceZeros(double replacement)

Replace all zero durations. Changes the signal in-place.

Parameters:

replacement - Duration in micro seconds to replace zero durations with.

replaceZeros

public void replaceZeros(int replacement)

Replace all zero durations. Changes the signal in-place.

Parameters:

replacement - Duration in pulses to replace zero durations with. If frequency == 0, interpret as microseconds instead.

getGap

public double getGap()

Returns max gap of intro- and repeat sequences.

Returns:

toModulatedIrSequence

public ModulatedIrSequence toModulatedIrSequence(int count)

Returns a ModulatedIrSequence consisting of one intro sequence, count or count-1 number of repeat sequence, dependent on if intro is empty or not, followed by one ending sequence.

Parameters:

count - Number of times to send signal. Must be > 0.

Returns:

ModulatedIrSequence.

toModulatedIrSequence

public ModulatedIrSequence toModulatedIrSequence(boolean intro,
                                                 int repetitions,
                                                 boolean ending)

Returns a ModulatedIrSequence consisting of zero or one intro sequence, repetition number of repeat sequence, and zero or one ending sequence.

Parameters:

intro - inclusion of intro sequence?

repetitions - number of repetitions (repeat semantic)

ending - inclusion of ending sequence.

Returns:

ModulatedIrSequence.

getIntroSequence

public ModulatedIrSequence getIntroSequence()

Returns:

the intro sequence, as ModulatedIrSequence

getRepeatSequence

public ModulatedIrSequence getRepeatSequence()

Returns:

the repeat sequence, as ModulatedIrSequence

getEndingSequence

public ModulatedIrSequence getEndingSequence()

Returns:

the ending sequence, as ModulatedIrSequence

ccfString

public String ccfString()
                 throws IncompatibleArgumentException

Computes the CCF form, if possible. Since a CCF does not have an ending sequence, a nonempty ending sequence will be ignored.

Returns:

CCF as string.

Throws:

IncompatibleArgumentException

See Also:

Pronto

main

public static void main(String[] args)

Just for testing. Invokes the IrSignal(String ProtocolsIniPath, int offset, String[] args) and tests the result.

Parameters:

args -