Revision: 16120
Author: oleg.kulikoff
Date: Thu Dec 30 01:33:17 2010
Log: Issue 1976: Advanced audio package, PlayCollect signal
http://code.google.com/p/mobicents/source/detail?r=16120

Added:
/trunk/servers/media/core/controllers/mgcp/src/main/java/org/mobicents/media/server/ctrl/mgcp/pkg/au/PlayCollect.java
Modified:
/trunk/servers/media/core/controllers/mgcp/src/main/java/org/mobicents/media/server/ctrl/mgcp/pkg/au/Options.java /trunk/servers/media/core/controllers/mgcp/src/main/java/org/mobicents/media/server/ctrl/mgcp/signal/MgcpPackages.java /trunk/servers/media/core/controllers/mgcp/src/main/java/org/mobicents/media/server/ctrl/mgcp/signal/Signals.java /trunk/servers/media/core/controllers/mgcp/src/test/java/org/mobicents/media/server/ctrl/mgcp/pkg/au/OptionsTest.java

=======================================
--- /dev/null
+++ /trunk/servers/media/core/controllers/mgcp/src/main/java/org/mobicents/media/server/ctrl/mgcp/pkg/au/PlayCollect.java Thu Dec 30 01:33:17 2010
@@ -0,0 +1,214 @@
+/*
+ * JBoss, Home of Professional Open Source
+ * Copyright XXXX, Red Hat Middleware LLC, and individual contributors as indicated
+ * by the @authors tag. All rights reserved.
+ * See the copyright.txt in the distribution for a full listing
+ * of individual contributors.
+ * This copyrighted material is made available to anyone wishing to use,
+ * modify, copy, or redistribute it subject to the terms and conditions
+ * of the GNU General Public License, v. 2.0.
+ * This program is distributed in the hope that it will be useful, but WITHOUT A + * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * PARTICULAR PURPOSE. See the GNU General Public License for more details.
+ * You should have received a copy of the GNU General Public License,
+ * v. 2.0 along with this distribution; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301, USA.
+ */
+package org.mobicents.media.server.ctrl.mgcp.pkg.au;
+
+import jain.protocol.ip.mgcp.message.parms.EventName;
+import jain.protocol.ip.mgcp.message.parms.RequestedEvent;
+import jain.protocol.ip.mgcp.pkg.MgcpEvent;
+import jain.protocol.ip.mgcp.pkg.PackageName;
+import org.apache.log4j.Logger;
+import org.mobicents.media.MediaSink;
+import org.mobicents.media.MediaSource;
+import org.mobicents.media.server.ctrl.mgcp.signal.Comparator;
+import org.mobicents.media.server.ctrl.mgcp.signal.Signal;
+import org.mobicents.media.server.spi.Connection;
+import org.mobicents.media.server.spi.MediaType;
+import org.mobicents.media.server.spi.NotificationListener;
+import org.mobicents.media.server.spi.dtmf.DtmfEvent;
+import org.mobicents.media.server.spi.events.NotifyEvent;
+import org.mobicents.media.server.spi.resource.DtmfDetector;
+import org.mobicents.media.server.spi.resource.Player;
+
+/**
+ * Implements play announcement signal.
+ *
+ * Plays a prompt and collects DTMF digits entered by a user.  If no
+ * digits are entered or an invalid digit pattern is entered, the
+ * user may be reprompted and given another chance to enter a correct
+ * pattern of digits.  The following digits are supported:  0-9, *,
+ * #, A, B, C, D.  By default PlayCollect does not play an initial
+ * prompt, makes only one attempt to collect digits, and therefore
+ * functions as a simple Collect operation.  Various special purpose
+ * keys, key sequences, and key sets can be defined for use during
+ * the PlayCollect operation.
+ *
+ *
+ * @author kulikov
+ */
+public class PlayCollect extends Signal implements NotificationListener {
+
+ private EventName oc = new EventName(PackageName.factory("AU"), MgcpEvent.factory("oc")); + private EventName of = new EventName(PackageName.factory("AU"), MgcpEvent.factory("of"));
+
+    private Player player;
+    private DtmfDetector dtmfDetector;
+
+    private Options options;
+
+ private final static Logger logger = Logger.getLogger(PlayCollect.class);
+
+    public PlayCollect(String name) {
+        super(name);
+    }
+
+    @Override
+    public void execute() {
+        logger.info("Executing...");
+
+        //get dtmf detector
+        dtmfDetector = this.getDetector();
+        if (dtmfDetector == null) {
+            this.sendEvent(of);
+            return;
+        }
+
+        //start dtmf detector
+        dtmfDetector.addListener(this);
+        dtmfDetector.start();
+
+        //play prompt if present
+        if (options.getPrompt() == null) {
+            return;
+        }
+
+        player = this.getPlayer();
+
+        //if player is not available send failure and break execution
+        if (player == null) {
+            this.sendEvent(of);
+            return;
+        }
+
+        player.addListener(this);
+
+        //get options of the request
+ options = new Options(getTrigger().getEventIdentifier().getParms());
+
+        try {
+            player.setURL(options.getPrompt());
+        } catch (Exception e) {
+            this.sendEvent(of);
+            return;
+        }
+
+        logger.info("Starting player...");
+        player.start();
+    }
+
+    @Override
+    public boolean doAccept(RequestedEvent event) {
+        if (Comparator.matches(event, oc)) {
+            return true;
+        }
+        if (Comparator.matches(event, of)) {
+            return true;
+        }
+        return false;
+    }
+
+    @Override
+    public void cancel() {
+        if (player != null) {
+            player.removeListener(this);
+            player.stop();
+        }
+    }
+
+    public void update(NotifyEvent event) {
+        switch (event.getEventID()) {
+            case NotifyEvent.COMPLETED :
+                break;
+            case NotifyEvent.RX_FAILED :
+            case NotifyEvent.TX_FAILED :
+                this.sendEvent(of);
+                this.complete();
+                break;
+            case DtmfEvent.DTMF_0 :
+            case DtmfEvent.DTMF_1 :
+            case DtmfEvent.DTMF_2 :
+            case DtmfEvent.DTMF_3 :
+            case DtmfEvent.DTMF_4 :
+            case DtmfEvent.DTMF_5 :
+            case DtmfEvent.DTMF_6 :
+            case DtmfEvent.DTMF_7 :
+            case DtmfEvent.DTMF_8 :
+            case DtmfEvent.DTMF_9 :
+            case DtmfEvent.DTMF_A :
+            case DtmfEvent.DTMF_B :
+            case DtmfEvent.DTMF_C :
+            case DtmfEvent.DTMF_D :
+            case DtmfEvent.DTMF_HASH :
+            case DtmfEvent.DTMF_STAR :
+                logger.info("Detected event....");
+                this.sendEvent(oc);
+                this.complete();
+        }
+    }
+
+    private Player getPlayer() {
+        if (getTrigger().getConnectionIdentifier() == null) {
+            MediaSource source = getEndpoint().getSource(MediaType.AUDIO);
+            return source.getInterface(Player.class);
+        }
+
+ String connectionID = getTrigger().getConnectionIdentifier().toString();
+        Connection connection = getConnection(connectionID);
+
+        logger.info("Connection = " + connection);
+        if (connection == null) {
+            return null;
+        }
+
+ MediaSource source = (MediaSource) connection.getComponent(MediaType.AUDIO, Player.class);
+        if (source == null) {
+            return null;
+        }
+
+        return source.getInterface(Player.class);
+    }
+
+    private DtmfDetector getDetector() {
+        if (getTrigger().getConnectionIdentifier() == null) {
+            MediaSink sink = getEndpoint().getSink(MediaType.AUDIO);
+            return sink.getInterface(DtmfDetector.class);
+        }
+
+ String connectionID = getTrigger().getConnectionIdentifier().toString();
+        Connection connection = getConnection(connectionID);
+
+        logger.info("Connection = " + connection);
+        if (connection == null) {
+            return null;
+        }
+
+ MediaSink sink = (MediaSink) connection.getComponent(MediaType.AUDIO, DtmfDetector.class);
+        if (sink == null) {
+            return null;
+        }
+
+        return sink.getInterface(DtmfDetector.class);
+    }
+
+    @Override
+    public void reset() {
+        super.reset();
+        if (player != null) {
+            player.removeListener(this);
+        }
+    }
+}
=======================================
--- /trunk/servers/media/core/controllers/mgcp/src/main/java/org/mobicents/media/server/ctrl/mgcp/pkg/au/Options.java Wed Dec 29 12:00:40 2010 +++ /trunk/servers/media/core/controllers/mgcp/src/main/java/org/mobicents/media/server/ctrl/mgcp/pkg/au/Options.java Thu Dec 30 01:33:17 2010
@@ -24,8 +24,9 @@
  */
 public class Options {

-    private String uri;
+    private String prompt;
     private String[] segments;
+
     private int cursor;

     //max duration in milliseconds
@@ -61,6 +62,8 @@
                 this.repeatCount = Integer.parseInt(val);
             } else if (param.equalsIgnoreCase("iv")) {
                 this.interval = Integer.parseInt(val);
+            } else if (param.equalsIgnoreCase("ip")) {
+                this.prompt = val;
             }
         }
     }
@@ -81,8 +84,8 @@
         return s.split(";");
     }

-    public String getUri() {
-        return uri;
+    public String getPrompt() {
+        return prompt;
     }

     public int getDuration() {
=======================================
--- /trunk/servers/media/core/controllers/mgcp/src/main/java/org/mobicents/media/server/ctrl/mgcp/signal/MgcpPackages.java Wed Dec 29 12:00:40 2010 +++ /trunk/servers/media/core/controllers/mgcp/src/main/java/org/mobicents/media/server/ctrl/mgcp/signal/MgcpPackages.java Thu Dec 30 01:33:17 2010
@@ -39,7 +39,7 @@

         //Advanced audio
         defs.put("AU", new String[]{
-            "pa"
+            "pa", "pc"
         });
     }

=======================================
--- /trunk/servers/media/core/controllers/mgcp/src/main/java/org/mobicents/media/server/ctrl/mgcp/signal/Signals.java Wed Dec 29 12:00:40 2010 +++ /trunk/servers/media/core/controllers/mgcp/src/main/java/org/mobicents/media/server/ctrl/mgcp/signal/Signals.java Thu Dec 30 01:33:17 2010
@@ -45,6 +45,7 @@

         //Advanced audio
signals.put("AU/pa", "org.mobicents.media.server.ctrl.mgcp.pkg.au.Play"); + signals.put("AU/pc", "org.mobicents.media.server.ctrl.mgcp.pkg.au.PlayCollect");
     }
     /**
      * Adds definition of the event;
=======================================
--- /trunk/servers/media/core/controllers/mgcp/src/test/java/org/mobicents/media/server/ctrl/mgcp/pkg/au/OptionsTest.java Wed Dec 29 12:00:40 2010 +++ /trunk/servers/media/core/controllers/mgcp/src/test/java/org/mobicents/media/server/ctrl/mgcp/pkg/au/OptionsTest.java Thu Dec 30 01:33:17 2010
@@ -18,7 +18,7 @@
  */
 public class OptionsTest {

-    private String s = "an=file du=1000 of=10 iv=20";
+    private String s = "an=file du=1000 of=10 iv=20 ip=xxx";
     private Options params;

     public OptionsTest() {
@@ -69,5 +69,10 @@
     public void testGetInterval() {
         assertEquals(20, params.getInterval());
     }
+
+    @Test
+    public void testPrompt() {
+        assertEquals("xxx", params.getPrompt());
+    }

 }

Reply via email to