Adds DTMF capabilities to the neomedia service intefaces

src/net/java/sip/communicator/service/neomedia/DTMFTone.java

@@ -0,0 +1,156 @@
+/*
+ * SIP Communicator, 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;
+
+/**
+ * Class for representing all the different DTMF tones.
+ *
+ * @author JM HEITZ
+ */
+public final class DTMFTone
+{
+    /**
+     * The "A" DTMF Tone
+     */
+    public static final DTMFTone DTMF_A=new DTMFTone("A");
+
+    /**
+     * The "B" DTMF Tone
+     */
+    public static final DTMFTone DTMF_B=new DTMFTone("B");
+
+    /**
+     * The "C" DTMF Tone
+     */
+    public static final DTMFTone DTMF_C=new DTMFTone("C");
+
+    /**
+     * The "D" DTMF Tone
+     */
+    public static final DTMFTone DTMF_D=new DTMFTone("D");
+
+    /**
+     * The "0" DTMF Tone
+     */
+    public static final DTMFTone DTMF_0=new DTMFTone("0");
+
+    /**
+     * The "1" DTMF Tone
+     */
+    public static final DTMFTone DTMF_1=new DTMFTone("1");
+
+    /**
+     * The "2" DTMF Tone
+     */
+    public static final DTMFTone DTMF_2=new DTMFTone("2");
+
+    /**
+     * The "3" DTMF Tone
+     */
+    public static final DTMFTone DTMF_3=new DTMFTone("3");
+
+    /**
+     * The "4" DTMF Tone
+     */
+    public static final DTMFTone DTMF_4=new DTMFTone("4");
+
+    /**
+     * The "5" DTMF Tone
+     */
+    public static final DTMFTone DTMF_5=new DTMFTone("5");
+
+    /**
+     * The "6" DTMF Tone
+     */
+    public static final DTMFTone DTMF_6=new DTMFTone("6");
+
+    /**
+     * The "7" DTMF Tone
+     */
+    public static final DTMFTone DTMF_7=new DTMFTone("7");
+
+    /**
+     * The "8" DTMF Tone
+     */
+    public static final DTMFTone DTMF_8=new DTMFTone("8");
+
+    /**
+     * The "9" DTMF Tone
+     */
+    public static final DTMFTone DTMF_9=new DTMFTone("9");
+
+    /**
+     * The "*" DTMF Tone
+     */
+    public static final DTMFTone DTMF_STAR=new DTMFTone("*");
+
+    /**
+     * The "#" DTMF Tone
+     */
+    public static final DTMFTone DTMF_SHARP=new DTMFTone("#");
+
+    /**
+     * The value of the DTMF tone
+     */
+    private final String value;
+
+    /**
+     * Creates a DTMF instance with the specified tone value. The method is
+     * private since one would only have to use predefined static instances.
+     *
+     * @param value one of te DTMF_XXX fields, indicating the value of the tone.
+     */
+    private DTMFTone(String value)
+    {
+        this.value = value;
+    }
+
+    /**
+     * Returns the string representation of this DTMF tone.
+     *
+     * @return the <tt>String</tt> representation of this DTMF tone.
+     */
+    public String getValue()
+    {
+        return this.value;
+    }
+
+    /**
+     * Indicates whether some other object is "equal to" this tone.
+     * <p>
+     * @param target the reference object with which to compare.
+     *
+     * @return  <tt>true</tt> if target represents the same tone as this
+     * object.
+     */
+    public boolean equals(Object target)
+    {
+        if(!(target instanceof DTMFTone))
+        {
+            return false;
+        }
+        DTMFTone targetDTMFTone = (DTMFTone)(target);
+
+        return targetDTMFTone.value.equals(this.value);
+    }
+
+    /**
+     * Returns a hash code value for the object. This method is
+     * supported for the benefit of hashtables such as those provided by
+     * <code>java.util.Hashtable</code>. The method would actually return the
+     * hashcode of the string representation of this DTMF tone.
+     * <p>
+     *
+     * @return  a hash code value for this object (same as calling
+     * getValue().hashCode()).
+     */
+    public int hashCode()
+    {
+        return getValue().hashCode();
+    }
+
+}

src/net/java/sip/communicator/service/neomedia/event/DTMFListener.java

@@ -19,13 +19,15 @@ public interface DTMFListener
      * Indicates that we have started receiving a <tt>DTMFTone</tt>.
      *
      * @param event the <tt>DTMFToneEvent</tt> instance containing the
+     * <tt>DTMFTone</tt>
      */
     public void dtmfToneReceptionStarted(DTMFToneEvent event);
 
     /**
-     * Indicates that we have started receiving a <tt>DTMFTone</tt>.
+     * Indicates that reception of a DTMF tone has stopped.
      *
      * @param event the <tt>DTMFToneEvent</tt> instance containing the
+     * <tt>DTMFTone</tt>
      */
     public void dtmfToneReceptionEnded(DTMFToneEvent event);
 }

src/net/java/sip/communicator/service/neomedia/event/DTMFToneEvent.java

@@ -0,0 +1,51 @@
+/*
+ * SIP Communicator, 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.event;
+
+import java.util.*;
+
+import net.java.sip.communicator.service.neomedia.*;
+
+/**
+ * This event represents starting or ending reception of a specific
+ * <tt>DTMFTone</tt>.
+ *
+ * @author Emil Ivov
+ */
+public class DTMFToneEvent extends EventObject
+{
+    /**
+     * The tone that this event is pertaining to.
+     */
+    private DTMFTone dtmfTone = null;
+
+    /**
+     * Creates an instance of this <tt>DTMFToneEvent</tt> with the specified
+     * source stream and dtmf tone.
+     *
+     * @param source the <tt>AudioMediaSteam</tt> instance that received the
+     * tone.
+     * @param tone the tone that we (started/stopped) receing.
+     */
+    public DTMFToneEvent(AudioMediaStream source, DTMFTone tone)
+    {
+        super(source);
+
+        this.dtmfTone = tone;
+    }
+
+    /**
+     * Returns the <tt>DTMFTone</tt> instance that this event is pertaining to.
+     *
+     * @return the <tt>DTMFTone</tt> instance that this event is pertaining to.
+     */
+    public DTMFTone getDtmfTone()
+    {
+        return dtmfTone;
+    }
+
+}

src/net/java/sip/communicator/service/protocol/DTMFTone.java

@@ -99,7 +99,7 @@ public final class DTMFTone
     private final String value;
 
     /**
-     * Creates a DTMF instance with the specified tone value. The metod is
+     * Creates a DTMF instance with the specified tone value. The method is
      * private since one would only have to use predefined static instances.
      *
      * @param value one of te DTMF_XXX fields, indicating the value of the tone.