Adds in-band DTMF functionality.

2 files changed, 431 insertions, 0 deletions

diff --git a/src/net/java/sip/communicator/service/neomedia/AudioMediaStream.java b/src/net/java/sip/communicator/service/neomedia/AudioMediaStream.java
index 17dfdf5..841aaa5 100644
--- a/src/net/java/sip/communicator/service/neomedia/AudioMediaStream.java
+++ b/src/net/java/sip/communicator/service/neomedia/AudioMediaStream.java
@@ -85,4 +85,11 @@ public interface AudioMediaStream
      * @param listener the listener that we'd like to unregister
      */
     public void removeDTMFListener(DTMFListener listener);
+
+    /**
+     * Adds a new inband DTMF tone to send.
+     *
+     * @param tone the DTMF tone to send.
+     */
+    public void addInbandDTMF(DTMFInbandTone tone);
 }
diff --git a/src/net/java/sip/communicator/service/neomedia/DTMFInbandTone.java b/src/net/java/sip/communicator/service/neomedia/DTMFInbandTone.java
new file mode 100644
index 0000000..c265563
--- /dev/null
+++ b/src/net/java/sip/communicator/service/neomedia/DTMFInbandTone.java
@@ -0,0 +1,424 @@
+/*
+ * Jitsi, the OpenSource Java VoIP and Instant Messaging client.
+ *
+ * Distributable under LGPL license.
+ * See terms of license at gnu.org.
+ */
+package net.java.sip.communicator.service.neomedia;
+
+/**
+ * Manages the geneation of the inband DMTF signal. A signal is identified by a
+ * value (1, 2, 3, 4, 5, 6, 7, 8, 9, *, #, A, B, C and D) and each signal is
+ * producted by the composition of 2 frequencies (as defined below).
+ * (cf. ITU recommendation Q.23)
+ *
+ * +------------------------------------------------+
+ * |        | 1209 Hz | 1336 Hz | 1477 Hz | 1633 Hz |
+ * +------------------------------------------------+
+ * | 697 Hz |    1    |    2    |    3    |    A    |
+ * | 770 Hz |    4    |    5    |    6    |    B    |
+ * | 852 Hz |    7    |    8    |    9    |    C    |
+ * | 941 Hz |    *    |    0    |    #    |    D    |
+ * +------------------------------------------------+
+ *
+ * @author Vincent Lucas
+ */
+
+public class DTMFInbandTone
+{
+    /**
+     * The first set of frequencies in Hz which composes an inband DTMF.
+     */
+    private static final double[] frequencyList1 =
+    new double[]
+    {
+        697.0, 770.0, 852.0, 941.0
+    };
+
+    /**
+     * The second set of frequencies in Hz which composes an inband DTMF.
+     */
+    private static final double[] frequencyList2 =
+    new double[]
+    {
+        1209.0, 1336.0, 1477.0, 1633.0
+    };
+
+    /**
+     * The "0" DTMF Inband Tone.
+     */
+    public static final DTMFInbandTone DTMF_INBAND_0 = new DTMFInbandTone("0",
+            frequencyList1[3],
+            frequencyList2[1]);
+
+    /**
+     * The "1" DTMF Inband Tone.
+     */
+    public static final DTMFInbandTone DTMF_INBAND_1 = new DTMFInbandTone("1",
+            frequencyList1[0],
+            frequencyList2[0]);
+
+    /**
+     * The "2" DTMF Inband Tone.
+     */
+    public static final DTMFInbandTone DTMF_INBAND_2 = new DTMFInbandTone("2",
+            frequencyList1[0],
+            frequencyList2[1]);
+
+    /**
+     * The "3" DTMF Inband Tone.
+     */
+    public static final DTMFInbandTone DTMF_INBAND_3 = new DTMFInbandTone("3",
+            frequencyList1[0],
+            frequencyList2[2]);
+
+    /**
+     * The "4" DTMF Inband Tone.
+     */
+    public static final DTMFInbandTone DTMF_INBAND_4 = new DTMFInbandTone("4",
+            frequencyList1[1],
+            frequencyList2[0]);
+
+    /**
+     * The "5" DTMF Inband Tone.
+     */
+    public static final DTMFInbandTone DTMF_INBAND_5 = new DTMFInbandTone("5",
+            frequencyList1[1],
+            frequencyList2[1]);
+
+    /**
+     * The "6" DTMF Inband Tone.
+     */
+    public static final DTMFInbandTone DTMF_INBAND_6 = new DTMFInbandTone("6",
+            frequencyList1[1],
+            frequencyList2[2]);
+
+    /**
+     * The "7" DTMF Inband Tone.
+     */
+    public static final DTMFInbandTone DTMF_INBAND_7 = new DTMFInbandTone("7",
+            frequencyList1[2],
+            frequencyList2[0]);
+
+    /**
+     * The "8" DTMF Inband Tone.
+     */
+    public static final DTMFInbandTone DTMF_INBAND_8 = new DTMFInbandTone("8",
+            frequencyList1[2],
+            frequencyList2[1]);
+
+    /**
+     * The "9" DTMF Inband Tone.
+     */
+    public static final DTMFInbandTone DTMF_INBAND_9 = new DTMFInbandTone("9",
+            frequencyList1[2],
+            frequencyList2[2]);
+
+    /**
+     * The "*" DTMF Inband Tone.
+     */
+    public static final DTMFInbandTone DTMF_INBAND_STAR =
+        new DTMFInbandTone("*",
+            frequencyList1[3],
+            frequencyList2[0]);
+
+    /**
+     * The "#" DTMF Inband Tone.
+     */
+    public static final DTMFInbandTone DTMF_INBAND_SHARP =
+        new DTMFInbandTone("#",
+            frequencyList1[3],
+            frequencyList2[2]);
+
+    /**
+     * The "A" DTMF Inband Tone.
+     */
+    public static final DTMFInbandTone DTMF_INBAND_A = new DTMFInbandTone("A",
+            frequencyList1[0],
+            frequencyList2[3]);
+
+    /**
+     * The "B" DTMF Inband Tone.
+     */
+    public static final DTMFInbandTone DTMF_INBAND_B = new DTMFInbandTone("B",
+            frequencyList1[1],
+            frequencyList2[3]);
+
+    /**
+     * The "C" DTMF Inband Tone.
+     */
+    public static final DTMFInbandTone DTMF_INBAND_C = new DTMFInbandTone("C",
+            frequencyList1[2],
+            frequencyList2[3]);
+
+    /**
+     * The "D" DTMF Inband Tone.
+     */
+    public static final DTMFInbandTone DTMF_INBAND_D = new DTMFInbandTone("D",
+            frequencyList1[3],
+            frequencyList2[3]);
+
+    /**
+     * The default duration of an inband DTMF tone in ms.
+     * 50 ms c.f.
+     * http://nemesis.lonestar.org/reference/telecom/signaling/dtmf.html
+     * which cites the norm ANSI T1.401-1988 (but anavailable for me).
+     * But when testing it at 50 ms, the asterisk servers miss some DTMF tone
+     * impulses. Thus, set it up 150 ms.
+     */
+    private static final int toneDuration = 150;
+    
+    /**
+     * The default duration of an inband DTMF tone in ms.
+     * 45 ms c.f.
+     * http://nemesis.lonestar.org/reference/telecom/signaling/dtmf.html
+     * which cites the norm ANSI T1.401-1988 (but anavailable for me).
+     * Moreover the minimum duty cycle (signal tone + silence) for
+     * ANSI-compliance shall be greater or equal to 100 ms.
+     */
+    private static final int interDigitInterval = 45;
+
+    /**
+     * The value which identifies the current inband tone. Available values are
+     * (0, 1, 2, 3, 4, 5, 6, 7, 8, 9, *, #, A, B, C and D).
+     */
+    private String value;
+
+    /**
+     * The first frequency which composes the current inband tone.
+     */
+    private double frequency1;
+
+    /**
+     * The second frequency which composes the current inband tone.
+     */
+    private double frequency2;
+
+    /**
+     * Creates a new instance of an inband tone. The value given is the main
+     * identifier which determines which are the two freequencies to used to
+     * generate this tone.
+     *
+     * @param value The identifier of the tone. Available values are (0, 1, 2,
+     * 3, 4, 5, 6, 7, 8, 9, *, #, A, B, C and D).
+     * @param frequency1 The first frequence which composes the tone. Available
+     * values corresponds to DTMFInbandTone.frequencyList1.
+     * @param frequency2 The second frequence which composes the tone. Available
+     * values corresponds to DTMFInbandTone.frequencyList2.
+     */
+    public DTMFInbandTone(String value, double frequency1, double frequency2)
+    {
+        this.value = value;
+        this.frequency1 = frequency1;
+        this.frequency2 = frequency2;
+    }
+
+    /**
+     * Returns this tone value as a string representation.
+     *
+     * @return this tone value.
+     */ 
+    public String getValue()
+    {
+        return this.value;
+    }
+
+    /**
+     * Returns the first frequency coded by this tone.
+     *
+     * @return the first frequency coded by this tone.
+     */
+    private double getFrequency1()
+    {
+        return this.frequency1;
+    }
+
+    /**
+     * Returns the second frequency coded by this tone.
+     *
+     * @return the second frequency coded by this tone.
+     */
+    private double getFrequency2()
+    {
+        return this.frequency2;
+    }
+
+    /**
+     * Generates a sample for the current tone signal.
+     *
+     * @param samplingFrequency The sampling frequency (codec clock rate) in Hz
+     * of the stream which will encapsulate this signal.
+     * @param sampleNumber The sample number of this signal to be produced. The
+     * sample number corresponds to the abscissa of the signal function.
+     *
+     * @return the sample generated. This sample corresponds to the ordinate of
+     * the signal function
+     */
+    public double getAudioSampleContinuous(
+            double samplingFrequency,
+            int sampleNumber)
+    {
+        double u1 = 2.0 * Math.PI * this.frequency1 / samplingFrequency;
+        double u2 = 2.0 * Math.PI * this.frequency2 / samplingFrequency;
+        double audioSample;
+
+        // The signal generated is composed of 2 sinusoidal signals, which
+        // ampltudes is between -1 and 1 (included).
+        audioSample = Math.sin(u1 * sampleNumber) * 0.5 +
+            Math.sin(u2 * sampleNumber) * 0.5;
+
+        return audioSample;
+    }
+
+    /**
+     * Generates a sample for the current tone signal converted into a discrete
+     * signal.
+     *
+     * @param samplingFrequency The sampling frequency (codec clock rate) in Hz
+     * of the stream which will encapsulate this signal.
+     * @param sampleNumber The sample number of this signal to be produced. The
+     * sample number corresponds to the abscissa of the signal function.
+     * @param sampleSizeInBits The size of each sample (8 for a byte, 16 for a
+     * short and 32 for an int)
+     *
+     * @return the sample generated. This sample corresponds to the ordinate of
+     * the signal function
+     */
+    public int getAudioSampleDiscrete(
+            double samplingFrequency,
+            int sampleNumber,
+            int sampleSizeInBits)
+    {
+        // If the param sampleSizeInBits is equal to 8, then its corresponds to
+        // a Java byte which is 8 bits signed type which contains a number
+        // between -128 and 127. Thus, as the result of the continuous function
+        // is between -1 and 1, we multiply each audioSample by 127.  This
+        // generates a signal between -127 and 127.
+        // Same operation if sampleSizeInBits is equal to 16, this function
+        // generates a signal between -32767 and 32767.
+        // As well as if sampleSizeInBits is equal to 32, this function
+        // generates a signal between -2147483647 and 2147483647.
+        double amplitudeCoefficient = Math.pow(2.0, sampleSizeInBits - 1) - 1.0;
+        double audioSampleContinuous;
+        int audioSampleDiscrete;
+
+        audioSampleContinuous = this.getAudioSampleContinuous(
+                samplingFrequency,
+                sampleNumber);
+        audioSampleDiscrete = (int)
+            (audioSampleContinuous * amplitudeCoefficient);
+
+        return audioSampleDiscrete;
+    }
+
+    /**
+     * Generates a signal sample for the current tone signal and stores it into
+     * the byte data array.
+     *
+     * @param samplingFrequency The sampling frequency (codec clock rate) in Hz
+     * of the stream which will encapsulate this signal.
+     * @param sampleSizeInBits The size of each sample (8 for a byte, 16 for a
+     * short and 32 for an int)
+     *
+     * @return The data array containing the DTMF signal.
+     */
+    public int[] getAudioSamples(
+            double samplingFrequency,
+            int sampleSizeInBits)
+    {
+        int sampleNumber = 0;
+
+        int nbToneSamples = ((int) (samplingFrequency / 1000.0)) *
+            DTMFInbandTone.toneDuration;
+        int nbInterDigitSamples = ((int) (samplingFrequency / 1000.0)) *
+            DTMFInbandTone.interDigitInterval;
+
+        int[] sampleData =
+            new int[nbInterDigitSamples + nbToneSamples + nbInterDigitSamples];
+
+        while(sampleNumber < nbInterDigitSamples)
+        {
+            sampleData[sampleNumber] = 0;
+            ++sampleNumber;
+        }
+        while(sampleNumber < nbInterDigitSamples + nbToneSamples)
+        {
+            sampleData[sampleNumber] = getAudioSampleDiscrete(
+                    samplingFrequency,
+                    sampleNumber,
+                    sampleSizeInBits);
+
+            ++sampleNumber;
+        }
+        while(sampleNumber < sampleData.length)
+        {
+            sampleData[sampleNumber] = 0;
+            ++sampleNumber;
+        }
+
+        return sampleData;
+    }
+
+    /**
+     * Maps between protocol and media inband DTMF objects.
+     * @param tone The DTMF tone as defined in the service protocol, which is
+     * only composed by a value as its identifier.
+     *
+     * @return the corresponding DTMF tone which contains a value as an
+     * identifier and two frequencies composing the inband tone.
+     */
+    public static DTMFInbandTone
+        mapTone(net.java.sip.communicator.service.protocol.DTMFTone tone)
+    {
+        if(tone.equals(
+            net.java.sip.communicator.service.protocol.DTMFTone.DTMF_0))
+            return DTMFInbandTone.DTMF_INBAND_0;
+        else if(tone.equals(
+            net.java.sip.communicator.service.protocol.DTMFTone.DTMF_1))
+            return DTMFInbandTone.DTMF_INBAND_1;
+        else if(tone.equals(
+            net.java.sip.communicator.service.protocol.DTMFTone.DTMF_2))
+            return DTMFInbandTone.DTMF_INBAND_2;
+        else if(tone.equals(
+            net.java.sip.communicator.service.protocol.DTMFTone.DTMF_3))
+            return DTMFInbandTone.DTMF_INBAND_3;
+        else if(tone.equals(
+            net.java.sip.communicator.service.protocol.DTMFTone.DTMF_4))
+            return DTMFInbandTone.DTMF_INBAND_4;
+        else if(tone.equals(
+            net.java.sip.communicator.service.protocol.DTMFTone.DTMF_5))
+            return DTMFInbandTone.DTMF_INBAND_5;
+        else if(tone.equals(
+            net.java.sip.communicator.service.protocol.DTMFTone.DTMF_6))
+            return DTMFInbandTone.DTMF_INBAND_6;
+        else if(tone.equals(
+            net.java.sip.communicator.service.protocol.DTMFTone.DTMF_7))
+            return DTMFInbandTone.DTMF_INBAND_7;
+        else if(tone.equals(
+            net.java.sip.communicator.service.protocol.DTMFTone.DTMF_8))
+            return DTMFInbandTone.DTMF_INBAND_8;
+        else if(tone.equals(
+            net.java.sip.communicator.service.protocol.DTMFTone.DTMF_9))
+            return DTMFInbandTone.DTMF_INBAND_9;
+        else if(tone.equals(
+            net.java.sip.communicator.service.protocol.DTMFTone.DTMF_A))
+            return DTMFInbandTone.DTMF_INBAND_A;
+        else if(tone.equals(
+            net.java.sip.communicator.service.protocol.DTMFTone.DTMF_B))
+            return DTMFInbandTone.DTMF_INBAND_B;
+        else if(tone.equals(
+            net.java.sip.communicator.service.protocol.DTMFTone.DTMF_C))
+            return DTMFInbandTone.DTMF_INBAND_C;
+        else if(tone.equals(
+            net.java.sip.communicator.service.protocol.DTMFTone.DTMF_D))
+            return DTMFInbandTone.DTMF_INBAND_D;
+        else if(tone.equals(
+            net.java.sip.communicator.service.protocol.DTMFTone.DTMF_SHARP))
+            return DTMFInbandTone.DTMF_INBAND_SHARP;
+        else if(tone.equals(
+            net.java.sip.communicator.service.protocol.DTMFTone.DTMF_STAR))
+            return DTMFInbandTone.DTMF_INBAND_STAR;
+
+        return null;
+    }
+}