July 2007 - sofaswitch-svn@lists.freeswitch.org

[Sofaswitch-svn] [commit] r351 - sofaswitch/trunk/sound
by SofaSWITCH SVN 05 Jul '07

05 Jul '07

Author: derek Date: Thu Jul 5 18:21:05 2007 New Revision: 351 Modified: sofaswitch/trunk/sound/main.cxx Log: fix English error. Modified: sofaswitch/trunk/sound/main.cxx ============================================================================== --- sofaswitch/trunk/sound/main.cxx (original) +++ sofaswitch/trunk/sound/main.cxx Thu Jul 5 18:21:05 2007 @@ -41,7 +41,7 @@ PConsoleChannel console(PConsoleChannel::StandardInput); - cout << "This program will waits for user commands, and generates DTMF messages as required" << endl; + cout << "This program will waits for user commands, and generate DTMF messages as required" << endl; console.SetReadTimeout(500);

1 0

[Sofaswitch-svn] [commit] r350 - sofaswitch/trunk/callflow/docs
by SofaSWITCH SVN 05 Jul '07

05 Jul '07

Author: derek Date: Wed Jul 4 22:06:38 2007 New Revision: 350 Added: sofaswitch/trunk/callflow/docs/code.sgml Log: Add this chapter, which describes the code style. Added: sofaswitch/trunk/callflow/docs/code.sgml ============================================================================== --- (empty file) +++ sofaswitch/trunk/callflow/docs/code.sgml Wed Jul 4 22:06:38 2007 @@ -0,0 +1,9 @@ +<chapter> +<title>Code structure in &callflow;</title> +<para>The code documentation tool +<ulink url="http://www.stack.nl/~dimitri/doxygen/">Doxygen</ulink> was used +to generated html files which describe the code structure in +&callflow;. All the generated documentation has been linked into this file, and +is available for you to view at <ulink url="html/index.html">code docs</ulink> + </para> +</chapter>

1 0

[Sofaswitch-svn] [commit] r349 - in sofaswitch/trunk/callflow: docs docs/current src
by SofaSWITCH SVN 05 Jul '07

05 Jul '07

Author: derek Date: Wed Jul 4 22:06:07 2007 New Revision: 349 Removed: sofaswitch/trunk/callflow/docs/current/eachicon.dxy sofaswitch/trunk/callflow/docs/overview.dxy Modified: sofaswitch/trunk/callflow/docs/callflow.xml sofaswitch/trunk/callflow/docs/chap1.sgml sofaswitch/trunk/callflow/src/callflow.cpp Log: Move more code into the docbook format. Add link to the generated html code from doxygen. Modified: sofaswitch/trunk/callflow/docs/callflow.xml ============================================================================== --- sofaswitch/trunk/callflow/docs/callflow.xml (original) +++ sofaswitch/trunk/callflow/docs/callflow.xml Wed Jul 4 22:06:07 2007 @@ -9,6 +9,7 @@ <!ENTITY chap1 SYSTEM "chap1.sgml"> <!ENTITY chap2 SYSTEM "chap2.sgml"> <!ENTITY chap3 SYSTEM "chap3.sgml"> +<!ENTITY code SYSTEM "code.sgml"> <!ENTITY app1 SYSTEM "app1.sgml"> @@ -51,6 +52,7 @@ &chap3; +&code; &app1; </book> Modified: sofaswitch/trunk/callflow/docs/chap1.sgml ============================================================================== --- sofaswitch/trunk/callflow/docs/chap1.sgml (original) +++ sofaswitch/trunk/callflow/docs/chap1.sgml Wed Jul 4 22:06:07 2007 @@ -1,10 +1,80 @@ <chapter> <title>Introduction</title> + +<para> +This is an Open Source application specifically designed to ease the +development of call control in the &sofaswitch; suite of applications. +</para> + + +<para> +The code is based on <ulink url="http://www.wxwidgets.org">wxWidgets</ulink> (for portability), in C++ (for +functionality and ease of integrating with wxWidgets) and has been released +under the MPL license. +</para> + + +<sect1> +<title> Why do we need &callflow;?</title> +<para> +My (DJS) initial thoughts on the design of &sofaswitch; was that there would +be individual entities (server, voip, am etc) all controlled by a custom +script, written in some scripting language. I wrote the entities first, and +then wrote simple python scripts to test the entities. +</para> + +<para> +The python scripts started to grow quite large. Along the way, I altered the +control protocol, as I realised that there were some aspects missing from the +original design. This had the unfortunate outcome of making those scripts +invalid. A second lesson was learnt - python is not very good on +threads. Things like the global interpreter lock started to get in the +way. Further, the scripts became a maintainence nightmare. This was +discouraging. +</para> + +<para> +At this stage, I was uncertain. Should I change to a different (and more +superior) scripting language? Some thought and discussion showed that python +is the way to go. Choosing an unknown (but superior?) language like XYZ would +indeed solve the above problems, but introduce two new problems: 1)it is now +much harder to get get going in the project and 2)it becomes much harder to +install &sofaswitch;. Minor considerations such as, "we might loose +cross-platform features if we switch to XYZ" were part of the problem space. +</para> + + +<para> +Worse still, by demanding the scripting language is written in Python (or +Perl, or Lua, or C, etc) I was raising the bar for the system administrator +before he/she could use &sofaswitch;. They were now reqired to learn the +scripting language and how &sofaswitch; works. Everyone understands flowcharts - +if only there was a scripting language based on flowcharts. +</para> + +<para> +Clearly, the way ahead was to write a custom utility to write the python +control scripts. Now, we expect that some may wish to write their own python +scripts. This is fine - you are welcome to learn from our current +codebase. Given the modular structure of &sofaswitch;, this is +inevitable. Different modules will be glued together in different ways. +</para> + +<para> +Thus, the design of &callflow; is such that you can create scripts to do very +complex things with the minimum of effort. +</para> +</sect1> + + +<sect1> +<title>&callflow; - synopsis</title> <para>&callflow; is a utility which has been designed to enable the user to control the various entities in the &sofaswitch; system. This utility allows the user to graphically design call setup, connection, and teardown. This utility takes the graphical layout and generates Python code, which implements the -desired operation. </para> +desired operation. +</para> <para>Python is areasonably tidy language, cross platform, straightforward syntax and does not have the dependency hell of perl. Sadly, nothing is easy, and it takes @@ -12,18 +82,16 @@ graphical approach is preferable. </para> -<para> -The user will be exposed to some Python, but at a relatively simple +<para>The user will be exposed to some Python, but at a relatively simple level. These blocks of Python code are regular expressions and label defination. Consequently, it is straightforward, and quite manageable for the novice. The example flow graphs contain many blocks of Python code, which are -a useful guide to the novice. -</para> +a useful guide to the novice.</para> <para>The following section gives an overview of the operation of &callflow;. Subsequent chapters describe the operation of &callflow; by means -of examples, and by a detailed description of each available control structure. -</para> +of examples, and by a detailed description of each available control structure.</para> +</sect1> <sect1> <title>Overview of operation</title> <para>Various items are selected from the tool bar, and placed on the screen. These are connected @@ -84,11 +152,12 @@ thread running in Python is a whole new running interpreter, which consumes system resources. This posed a problem - if the controller is going to handle lots of concurrent calls, it would be poor practice to place each controller -handled call into a separate Python thread. </para> +handled call into a separate Python thread.</para> -<para> We therefore base this code around -<ulink url="http://twistedmatrix.com/trac">Twisted</ulink>, an event driven -network framework written in Python. Using <ulink +<para> +We therefore base this code around <ulink +url="http://twistedmatrix.com/trac">Twisted</ulink>, an event driven network +framework written in Python. Using <ulink url="http://twistedmatrix.com/trac">Twisted</ulink> solved the handling of the any number of asynchronous events.. From a users point of view, we have one thread per call and graph management is simplified. The reality is that there @@ -101,7 +170,6 @@ the end of the current graph. Execution then waits for a event to happen, which move the current point of execution back to the relevant event handler. Thus, a call flow graph in this system will only have one start point, but may -have many termination points. -</para> +have many termination points.</para> </sect1> </chapter> Modified: sofaswitch/trunk/callflow/src/callflow.cpp ============================================================================== --- sofaswitch/trunk/callflow/src/callflow.cpp (original) +++ sofaswitch/trunk/callflow/src/callflow.cpp Wed Jul 4 22:06:07 2007 @@ -594,7 +594,9 @@ callflowHelpWindow->Create(core, wxID_ANY, wxDefaultPosition, GetClientSize(), wxTAB_TRAVERSAL|wxNO_BORDER, wxHF_DEFAULT_STYLE); - callflowHtmlHelp.AddBook(wxFileName(_T("doc.zip"))); + callflowHtmlHelp.AddBook(wxFileName(_T("callflow.zip"))); + callflowHtmlHelp.AddBook(wxFileName(_T("overview.zip"))); + callflowHtmlHelp.AddBook(wxFileName(_T("get_started.zip"))); callflowHtmlHelp.Display(_T("Introduction")); #else //Respond to menu here

1 0

[Sofaswitch-svn] [commit] r348 - sofaswitch/trunk
by SofaSWITCH SVN 04 Jul '07

04 Jul '07

Author: derek Date: Wed Jul 4 18:00:28 2007 New Revision: 348 Removed: sofaswitch/trunk/mcu_layout.jpg Log: Remove this figure format from the repositary. Store it as png the get_started directory.

1 0

[Sofaswitch-svn] [commit] r347 - in sofaswitch/trunk: . get_started
by SofaSWITCH SVN 04 Jul '07

04 Jul '07

Author: derek Date: Wed Jul 4 17:59:31 2007 New Revision: 347 Added: sofaswitch/trunk/get_started/mcu_layout.fig - copied unchanged from r346, /sofaswitch/trunk/mcu_layout.fig Removed: sofaswitch/trunk/mcu_layout.fig Log: Move figure to the correct directory.

1 0

[Sofaswitch-svn] [commit] r346 - in sofaswitch/trunk: . controller get_started
by SofaSWITCH SVN 04 Jul '07

04 Jul '07

Author: derek Date: Wed Jul 4 17:58:25 2007 New Revision: 346 Added: sofaswitch/trunk/get_started/common.sgml Modified: sofaswitch/trunk/controller/testmcu3.py sofaswitch/trunk/controller/testmcu3_time.py sofaswitch/trunk/controller/testmcu3a.py sofaswitch/trunk/controller/testmcu3b.py sofaswitch/trunk/controller/testmcurec.py sofaswitch/trunk/get_started/get_started.xml sofaswitch/trunk/mcu_layout.fig Log: Modify docs, tidy control scripts. Modified: sofaswitch/trunk/controller/testmcu3.py ============================================================================== --- sofaswitch/trunk/controller/testmcu3.py (original) +++ sofaswitch/trunk/controller/testmcu3.py Wed Jul 4 17:58:25 2007 @@ -73,13 +73,12 @@ self.myController.send_message_to('setreceivedmsgfile ' + self.myRxFile, self.oWorkerNodes[self.oNode2]) - print self.oWorkerNodes[self.oNode2], ' plays ', self.mySendFile, ' to ', self.oWorkerNodes[self.oNode1] self.myController.wait_for_finished_file_message(self.oWorkerNodes[self.oNode2], 28) self.myController.send_message_to('hangup', self.oWorkerNodes[self.oNode1]) self.myController.send_message_to('hangup', self.oWorkerNodes[self.oNode2]) - print 'END of play_file_x_times for ', self.oWorkerNodes[self.oNode2], ' and ', self.oWorkerNodes[self.oNode1] + if False: memberA = OneMember("memberaRecord.wav", "../prompts/silence1.wav", controller) Modified: sofaswitch/trunk/controller/testmcu3_time.py ============================================================================== --- sofaswitch/trunk/controller/testmcu3_time.py (original) +++ sofaswitch/trunk/controller/testmcu3_time.py Wed Jul 4 17:58:25 2007 @@ -75,7 +75,6 @@ self.myRxfile = self.myRxFile + str(i) self.myController.send_message_to('setannouncementfile ' + self.mySendFile, self.oWorkerNodes[self.oNode2]) - print self.oWorkerNodes[self.oNode2], ' plays ', self.mySendFile, ' to ', self.oWorkerNodes[self.oNode1] self.myController.wait_for_finished_file_message(self.oWorkerNodes[self.oNode2], 28) self.myController.send_message_to('hangup', self.oWorkerNodes[self.oNode1]) @@ -84,9 +83,9 @@ self.myController.RemoveFromMyActives(self.oWorkerNodes[self.oNode2]) time.sleep(1) os.remove("../am/" + self.myRxFile) - print 'END of play_file_x_times for ', self.oWorkerNodes[self.oNode2], ' and ', self.oWorkerNodes[self.oNode1] -os.system('echo The\ time\ is `date | cut -d \ -f4 ` > time.txt') + +os.system('echo The\ time\ is ` date +%l` hours and `date +%M` minutes > time.txt') os.system('text2wave time.txt -o time.wav -F 8000 -scale 3') memberA = OneMember("../controller/time.wav", controller) Modified: sofaswitch/trunk/controller/testmcu3a.py ============================================================================== --- sofaswitch/trunk/controller/testmcu3a.py (original) +++ sofaswitch/trunk/controller/testmcu3a.py Wed Jul 4 17:58:25 2007 @@ -75,7 +75,6 @@ self.myRxfile = self.myRxFile + str(i) self.myController.send_message_to('setannouncementfile ' + self.mySendFile, self.oWorkerNodes[self.oNode2]) - print self.oWorkerNodes[self.oNode2], ' plays ', self.mySendFile, ' to ', self.oWorkerNodes[self.oNode1] self.myController.wait_for_finished_file_message(self.oWorkerNodes[self.oNode2], 28) self.myController.send_message_to('hangup', self.oWorkerNodes[self.oNode1]) @@ -84,7 +83,7 @@ self.myController.RemoveFromMyActives(self.oWorkerNodes[self.oNode2]) time.sleep(1) os.remove("../am/" + self.myRxFile) - print 'END of play_file_x_times for ', self.oWorkerNodes[self.oNode2], ' and ', self.oWorkerNodes[self.oNode1] + memberA = OneMember("../prompts/silence1.wav", controller) Modified: sofaswitch/trunk/controller/testmcu3b.py ============================================================================== --- sofaswitch/trunk/controller/testmcu3b.py (original) +++ sofaswitch/trunk/controller/testmcu3b.py Wed Jul 4 17:58:25 2007 @@ -75,7 +75,6 @@ self.myRxfile = self.myRxFile + str(i) self.myController.send_message_to('setannouncementfile ' + self.mySendFile, self.oWorkerNodes[self.oNode2]) - print self.oWorkerNodes[self.oNode2], ' plays ', self.mySendFile, ' to ', self.oWorkerNodes[self.oNode1] self.myController.wait_for_finished_file_message(self.oWorkerNodes[self.oNode2], 28) self.myController.send_message_to('hangup', self.oWorkerNodes[self.oNode1]) @@ -84,7 +83,7 @@ self.myController.RemoveFromMyActives(self.oWorkerNodes[self.oNode2]) time.sleep(1) os.remove("../am/" + self.myRxFile) - print 'END of play_file_x_times for ', self.oWorkerNodes[self.oNode2], ' and ', self.oWorkerNodes[self.oNode1] + memberA = OneMember("../prompts/entering.wav", controller) Modified: sofaswitch/trunk/controller/testmcurec.py ============================================================================== --- sofaswitch/trunk/controller/testmcurec.py (original) +++ sofaswitch/trunk/controller/testmcurec.py Wed Jul 4 17:58:25 2007 @@ -74,7 +74,6 @@ for i in range(0, repeats): self.myController.send_message_to('setannouncementfile ' + self.mySendFile, self.oWorkerNodes[self.oNode2]) - print self.oWorkerNodes[self.oNode2], ' plays ', self.mySendFile, ' to ', self.oWorkerNodes[self.oNode1] self.myController.wait_for_finished_file_message(self.oWorkerNodes[self.oNode2], 28) self.myController.send_message_to('hangup', self.oWorkerNodes[self.oNode1]) @@ -82,8 +81,6 @@ self.myController.RemoveFromMyActives(self.oWorkerNodes[self.oNode1]) self.myController.RemoveFromMyActives(self.oWorkerNodes[self.oNode2]) - print 'END of play_file_x_times for ', self.oWorkerNodes[self.oNode2], ' and ', self.oWorkerNodes[self.oNode1] - memberA = OneMember("../prompts/silence2.wav", controller) memberA.play_file_x_times(1) Added: sofaswitch/trunk/get_started/common.sgml ============================================================================== --- (empty file) +++ sofaswitch/trunk/get_started/common.sgml Wed Jul 4 17:58:25 2007 @@ -0,0 +1,31 @@ +<chapter> +<title>Common command options to &sofaswitch; utilities</title> +<titleabbrev>Command options</titleabbrev> + +<para> +There are multiple command options to the different &sofaswitch; +utilities. Many of these utilities share the same options, which are listed below. +<itemizedlist> +<listitem><literal>-h</literal> will always generate a help message on the particular sofa + switch utility. +</listitem> +<listitem><literal>-t</literal> will generate debug information. With more + <literal>t</literal>'s (say <literal>-tttt</literal>) + there will be lots of debug information +</listitem> +<listitem><literal>-o</literal> will send the debug information to the specified file. These + debug information options (<literal>-t</literal>, <literal>-o</literal>) + are only available on the debug build. +</listitem> +<listitem><literal>-s</literal> will specify the server to use for messages. If not specified, it + defaults to localhost. +</listitem> +<listitem><literal>-i</literal> will specify the id this utility uses when connecting to the + message server. Each utility has its own default id. For example, the + voip executable has an id of "voip" +</listitem> +<listitem><literal>-v</literal> report program version info. +</listitem> +</itemizedlist> +</para> +</chapter> Modified: sofaswitch/trunk/get_started/get_started.xml ============================================================================== --- sofaswitch/trunk/get_started/get_started.xml (original) +++ sofaswitch/trunk/get_started/get_started.xml Wed Jul 4 17:58:25 2007 @@ -14,6 +14,7 @@ <!ENTITY sound SYSTEM "sound.sgml"> <!ENTITY am SYSTEM "answeringmachine.sgml"> <!ENTITY mcu SYSTEM "conference.sgml"> +<!ENTITY common SYSTEM "common.sgml"> <!ENTITY app1 SYSTEM "app1.sgml"> @@ -55,7 +56,7 @@ &sound; &am; &mcu; - +&common; &app1; </book> Modified: sofaswitch/trunk/mcu_layout.fig ============================================================================== --- sofaswitch/trunk/mcu_layout.fig (original) +++ sofaswitch/trunk/mcu_layout.fig Wed Jul 4 17:58:25 2007 @@ -66,14 +66,14 @@ 1 0 4.00 240.00 480.00 1 0 4.00 240.00 480.00 2295 3735 4545 3735 -4 0 0 50 -1 0 30 0.0000 4 210 1125 5715 7380 ssmcu\001 -4 0 0 50 -1 0 30 0.0000 4 210 900 9585 7740 ssam\001 -4 0 0 50 -1 0 30 0.0000 4 315 1125 9945 4230 ssam1\001 -4 0 0 50 -1 0 30 0.0000 4 315 1125 9945 6390 ssam2\001 +4 0 0 50 -1 0 30 0.0000 4 210 1125 5715 7380 mcu\001 +4 0 0 50 -1 0 30 0.0000 4 210 900 9585 7740 am\001 +4 0 0 50 -1 0 30 0.0000 4 315 1125 9945 4230 am1\001 +4 0 0 50 -1 0 30 0.0000 4 315 1125 9945 6390 am2\001 4 0 0 50 -1 0 30 0.0000 4 315 1725 855 9090 controller\001 4 0 0 50 -1 0 30 0.0000 4 210 1095 4905 9045 server\001 4 0 0 50 -1 0 30 0.0000 4 315 1080 945 4185 sound\001 -4 0 0 50 -1 0 30 0.0000 4 315 1350 4545 3870 ssmcu3\001 -4 0 0 50 -1 0 30 0.0000 4 315 1350 5895 4455 ssmcu2\001 -4 0 0 50 -1 0 30 0.0000 4 315 1350 5850 6300 ssmcu1\001 +4 0 0 50 -1 0 30 0.0000 4 315 1350 4545 3870 mcu3\001 +4 0 0 50 -1 0 30 0.0000 4 315 1350 5895 4455 mcu2\001 +4 0 0 50 -1 0 30 0.0000 4 315 1350 5850 6300 mcu1\001 4 0 0 50 -1 10 22 0.0000 4 165 900 5670 5265 room\001

1 0

[Sofaswitch-svn] [commit] r345 - sofaswitch/trunk/get_started
by SofaSWITCH SVN 04 Jul '07

04 Jul '07

Author: derek Date: Wed Jul 4 00:08:05 2007 New Revision: 345 Added: sofaswitch/trunk/get_started/mcu_layout.png (contents, props changed) Log: Add this figure, which is required for the docs. Added: sofaswitch/trunk/get_started/mcu_layout.png ============================================================================== Binary file. No diff available.

1 0

[Sofaswitch-svn] [commit] r344 - sofaswitch/trunk/get_started
by SofaSWITCH SVN 04 Jul '07

04 Jul '07

Author: derek Date: Wed Jul 4 00:05:32 2007 New Revision: 344 Modified: sofaswitch/trunk/get_started/answeringmachine.sgml sofaswitch/trunk/get_started/get_started.xml Log: More text to describe what is happening in the conference utility. Modified: sofaswitch/trunk/get_started/answeringmachine.sgml ============================================================================== --- sofaswitch/trunk/get_started/answeringmachine.sgml (original) +++ sofaswitch/trunk/get_started/answeringmachine.sgml Wed Jul 4 00:05:32 2007 @@ -119,7 +119,7 @@ <listitem><para>Advisement notices (call setup, call terminating)</para></listitem> </itemizedlist> You will note that the same file is played twice to the sound entity. This is -correct, and illustrates that the connection of audio between &sofaswitch +correct, and illustrates that the connection of audio between &sofaswitch; entities can be changed at any time. Further, the last two lines in the log above report two message received from the controller which were never sent on to the intended destination. This is because <literal>am1</literal> and Modified: sofaswitch/trunk/get_started/get_started.xml ============================================================================== --- sofaswitch/trunk/get_started/get_started.xml (original) +++ sofaswitch/trunk/get_started/get_started.xml Wed Jul 4 00:05:32 2007 @@ -13,6 +13,7 @@ <!ENTITY server SYSTEM "server.sgml"> <!ENTITY sound SYSTEM "sound.sgml"> <!ENTITY am SYSTEM "answeringmachine.sgml"> +<!ENTITY mcu SYSTEM "conference.sgml"> <!ENTITY app1 SYSTEM "app1.sgml"> @@ -53,6 +54,7 @@ &server; &sound; &am; +&mcu; &app1; </book>

1 0

[Sofaswitch-svn] [commit] r343 - in sofaswitch/trunk: controller get_started
by SofaSWITCH SVN 04 Jul '07

04 Jul '07

Author: derek Date: Tue Jul 3 21:28:06 2007 New Revision: 343 Modified: sofaswitch/trunk/controller/testonesound.py sofaswitch/trunk/controller/testsound.py sofaswitch/trunk/get_started/answeringmachine.sgml Log: updates Modified: sofaswitch/trunk/controller/testonesound.py ============================================================================== --- sofaswitch/trunk/controller/testonesound.py (original) +++ sofaswitch/trunk/controller/testonesound.py Tue Jul 3 21:28:06 2007 @@ -41,7 +41,5 @@ timedelta = time.time() - expstart; -controller.send_message_to('quitnow', 'sound') - controller.terminate_now() Modified: sofaswitch/trunk/controller/testsound.py ============================================================================== --- sofaswitch/trunk/controller/testsound.py (original) +++ sofaswitch/trunk/controller/testsound.py Tue Jul 3 21:28:06 2007 @@ -20,7 +20,7 @@ #thread.start_new_thread(controller.read_incoming,()) -calls = range(1,100) +calls = range(1,3) for i in calls: print 'Iteration ', i Modified: sofaswitch/trunk/get_started/answeringmachine.sgml ============================================================================== --- sofaswitch/trunk/get_started/answeringmachine.sgml (original) +++ sofaswitch/trunk/get_started/answeringmachine.sgml Tue Jul 3 21:28:06 2007 @@ -31,7 +31,7 @@ <para> For the test script to work, we expect that am is launched from a directory -containing a 16bit, 8khz sound file, called "sample_message.wav" +containing a 16bit, 8khz sound file, called <literal>../prompts/sample_message.wav"</literal> </para> <para> @@ -48,16 +48,61 @@ <para> The server reports the following messages. <screen> -controller : am:REQUESTNEWID - am : controller:REQUESTNEWID am1 -controller : am1:transferudp sound - am1 : controller:OutgoingCall am1 - am1 : sound:transferudp sound 10.0.0.5:64000 - sound : am1:transferudp sound 10.0.0.5:61000 done -controller : am1:setannouncementfile sample_message.wav -controller : am1:setreceivedmsgfile derek.wav -controller : am1:hangup - am1 : controller:Terminating + 4/ 7/2007 12:25:27. 10630 Recv New node of am + 4/ 7/2007 12:25:27. 11245 Recv New node of am1 + 4/ 7/2007 12:25:27. 12104 Recv New node of am2 + 4/ 7/2007 12:25:27. 12905 Recv New node of am3 + 4/ 7/2007 12:25:27. 13702 Recv New node of am4 + 4/ 7/2007 12:25:27. 14512 Recv New node of am5 + 4/ 7/2007 12:25:27. 15403 Recv New node of am6 + 4/ 7/2007 12:25:27. 16324 Recv New node of am7 + 4/ 7/2007 12:25:27. 17175 Recv New node of am8 + 4/ 7/2007 12:25:27. 18024 Recv New node of am9 + 4/ 7/2007 12:25:27. 18882 Recv New node of am10 + 4/ 7/2007 12:25:32.628728 Recv New node of controller + 4/ 7/2007 12:25:33.131056 Recv from controller am:REQUESTNEWID + 4/ 7/2007 12:25:33.131179 Send to am controller:REQUESTNEWID + 4/ 7/2007 12:25:33.131714 Recv from am controller:REQUESTNEWID am1 + 4/ 7/2007 12:25:33.131954 Send to controller am:REQUESTNEWID am1 + 4/ 7/2007 12:25:33.132316 Recv from am1 AdviseOnTermination controller + 4/ 7/2007 12:25:33.132846 Recv New node of am11 + 4/ 7/2007 12:25:33.182851 Recv from controller am1:transferudp sound + 4/ 7/2007 12:25:33.182973 Send to am1 controller:transferudp sound + 4/ 7/2007 12:25:33.183001 Recv from controller am1:setannouncementfile ../prompts/sample_message.wav + 4/ 7/2007 12:25:33.183043 Send to am1 controller:setannouncementfile ../prompts/sample_message.wav + 4/ 7/2007 12:25:33.184101 Recv from am1 sound:transferudp sound 192.168.1.109:62000 + 4/ 7/2007 12:25:33.184372 Send to sound am1:transferudp sound 192.168.1.109:62000 + 4/ 7/2007 12:25:33.185435 Recv from sound am1:transferudp sound 192.168.1.108:63000 done + 4/ 7/2007 12:25:33.185512 Send to am1 sound:transferudp sound 192.168.1.108:63000 done + 4/ 7/2007 12:25:33.222891 Recv from controller am1:setreceivedmsgfile derek.wav + 4/ 7/2007 12:25:33.223003 Send to am1 controller:setreceivedmsgfile derek.wav + 4/ 7/2007 12:25:36.758717 Recv from am1 controller:FinishedFile + 4/ 7/2007 12:25:36.758832 Send to controller am1:FinishedFile + 4/ 7/2007 12:25:36.782828 Recv from controller am1:hangup + 4/ 7/2007 12:25:36.782940 Send to am1 controller:hangup + 4/ 7/2007 12:25:37.478655 Send to controller am1:Terminating + 4/ 7/2007 12:25:37.782748 Recv from controller am:REQUESTNEWID + 4/ 7/2007 12:25:37.782974 Send to am controller:REQUESTNEWID + 4/ 7/2007 12:25:37.783350 Recv from am2 AdviseOnTermination controller + 4/ 7/2007 12:25:37.783448 Recv from am controller:REQUESTNEWID am2 + 4/ 7/2007 12:25:37.783587 Send to controller am:REQUESTNEWID am2 + 4/ 7/2007 12:25:37.784109 Recv New node of am12 + 4/ 7/2007 12:25:37.834613 Recv from controller am2:transferudp sound + 4/ 7/2007 12:25:37.834921 Send to am2 controller:transferudp sound + 4/ 7/2007 12:25:37.835046 Recv from controller am2:setannouncementfile ../prompts/sample_message.wav + 4/ 7/2007 12:25:37.835196 Send to am2 controller:setannouncementfile ../prompts/sample_message.wav + 4/ 7/2007 12:25:37.835788 Recv from am2 sound:transferudp sound 192.168.1.109:62001 + 4/ 7/2007 12:25:37.835898 Send to sound am2:transferudp sound 192.168.1.109:62001 + 4/ 7/2007 12:25:37.836975 Recv from sound am2:transferudp sound 192.168.1.108:63000 done + 4/ 7/2007 12:25:37.837022 Send to am2 sound:transferudp sound 192.168.1.108:63000 done + 4/ 7/2007 12:25:37.874580 Recv from controller am2:setreceivedmsgfile derek.wav + 4/ 7/2007 12:25:37.874889 Send to am2 controller:setreceivedmsgfile derek.wav + 4/ 7/2007 12:25:41.406340 Recv from am2 controller:FinishedFile + 4/ 7/2007 12:25:41.406441 Send to controller am2:FinishedFile + 4/ 7/2007 12:25:41.435340 Recv from controller am2:hangup + 4/ 7/2007 12:25:41.435452 Send to am2 controller:hangup + 4/ 7/2007 12:25:42.434595 Recv from controller am1:hangup + 4/ 7/2007 12:25:42.434659 Recv from controller am2:hangup </screen> The messages are in four groups. <itemizedlist> @@ -73,7 +118,15 @@ <listitem><para>Advisement notices (call setup, call terminating)</para></listitem> </itemizedlist> +You will note that the same file is played twice to the sound entity. This is +correct, and illustrates that the connection of audio between &sofaswitch +entities can be changed at any time. Further, the last two lines in the log +above report two message received from the controller which were never sent on +to the intended destination. This is because <literal>am1</literal> and +<literal>am2</literal> were dead and gone by this stage. The messages were +there therefore dropped. No error message is reported back to the controller. </para> + <para> As before, this simple test can be extended by running the <literal>client.py</literal> python script file described above. You can enquire of the answering machine for status information (command <literal>am:status full</literal>) and you @@ -94,7 +147,7 @@ </para> <para> -There are 11 Comms instances currently availble. One is used in an active call (am51), and the +There are 11 Comms instances currently availble. One is used in an active call (<literal>am51</literal>), and the remaining 10 have connected to the message server. These remaining 10 are therefore ready for immediate use, should they be requested by the controller. </para>

1 0

[Sofaswitch-svn] [commit] r342 - sofaswitch/trunk/get_started
by SofaSWITCH SVN 04 Jul '07

04 Jul '07

Author: derek Date: Tue Jul 3 20:17:43 2007 New Revision: 342 Added: sofaswitch/trunk/get_started/answeringmachine.sgml Log: Add this file, which describes the use of the answering machine. Added: sofaswitch/trunk/get_started/answeringmachine.sgml ============================================================================== --- (empty file) +++ sofaswitch/trunk/get_started/answeringmachine.sgml Tue Jul 3 20:17:43 2007 @@ -0,0 +1,165 @@ +<chapter> +<title>Answering machine utility</title> +<titleabbrev>Audio play/record</titleabbrev> + + + +<para> +The sound card (described in previous section) can be utilised in the &sofaswitch; environment, +and it can send/receive audio with any other &sofaswitch; audio +component. The Answering Machine is perhaps the simplest other +audio component, which can play/record audio from/to a wav file. +</para> + +<para> +Build and run the answering machine utility with the commands +<itemizedlist> +<listitem><literal>cd am</literal></listitem> +<listitem><literal>make both</literal></listitem> +<listitem><literal> + ./obj_linux_x86_r/am -s machine_running_server +</literal></listitem> +</itemizedlist> +The options to the answering machine utility specify the name of the machine running the +sofa message server. you will need to adjust the options to correctly specify +the name of the machine running the message server. Thus, if the message server +and the answering machine are on the same computer, you will use the string +<literal>localhost</literal>. +You can see all the available command +options by running the answering machine utility with the command parameter <literal>-h</literal> +</para> + +<para> +For the test script to work, we expect that am is launched from a directory +containing a 16bit, 8khz sound file, called "sample_message.wav" +</para> + +<para> +In the controller directory, there is a python script that will connect the audio +streams from the answering machine and sound executables together. Run this +utility with: +<screen> +python testsound.py machine_running_server +</screen> +Again, you will need to modify this command line to correctly specify the +location of the machine running the server. +</para> + +<para> +The server reports the following messages. +<screen> +controller : am:REQUESTNEWID + am : controller:REQUESTNEWID am1 +controller : am1:transferudp sound + am1 : controller:OutgoingCall am1 + am1 : sound:transferudp sound 10.0.0.5:64000 + sound : am1:transferudp sound 10.0.0.5:61000 done +controller : am1:setannouncementfile sample_message.wav +controller : am1:setreceivedmsgfile derek.wav +controller : am1:hangup + am1 : controller:Terminating +</screen> +The messages are in four groups. +<itemizedlist> +<listitem><para> The controller requests an answering machine entity to send/receive audio from. + The answering machine supervisor sends a message back to the controller, advising + the controller of the new identity. </para></listitem> + +<listitem><para> The controller tells the new identy (<literal>am1</literal>) to connect audio streams with the <literal>sound</literal> + identity. Notice that the controller is not aware of the address used to transfer audio. + </para></listitem> +<listitem><para> The controller tells the answering machine identity to play audio from the file + <literal>sample_message.wav</literal>, and record to the file <literal>derek.wav</literal>.</para></listitem> + +<listitem><para>Advisement notices (call setup, call terminating)</para></listitem> +</itemizedlist> +</para> +<para> +As before, this simple test can be extended by running the <literal>client.py</literal> python script file described above. +You can enquire of the answering machine for status information (command <literal>am:status full</literal>) and you +will see what is available. The answerine machine will reply back +<screen> +am:status full +am:Current Status:----------- +Comms instance count 61 50 11 +Consumer instance count 50 50 0 +pre, active & dead calls 0 1 0 + + Current active nodes: + am51 +</screen> +These figures are designed to provide some diagnostic information about what is going on. +There main purpose is tell you the counts of constructed/allocated class instances, and therefore +provide some guide as to if the system is leaking memory. +</para> + +<para> +There are 11 Comms instances currently availble. One is used in an active call (am51), and the +remaining 10 have connected to the message server. These remaining 10 are therefore ready for +immediate use, should they be requested by the controller. +</para> + +<para> +The Consumer instance count is a class that is very short lived, and designed +to clean up calls after the call has terminated.. In this case, 50 have been +constructed, 50 deleted, and balance is zero. If there are several available +Consumer instances, we have evidence that the calls are not being cleaned up. +Each Consumer instance is a separate thread, created to clean up one call. A +call is cleaned up independently (well, as much as possible) from all other calls. +</para> + +<para> +From running the <literal>client.py</literal> script, while the <literal>testsound.py</literal> script is running, we +can interrogate the message server to see what is happening. We send the command <literal>status full</literal>, +which looks like: +<screen> +status full + Status of the Server +------------------------- +Constructed/Deleted TcpConnections 98 72 26 +Count ready made TcpConnections 10 +Messages Sent Received Dropped Diff 1274 972 108 194 +Current list size 15 + + current nodes + controller + sound + am + am51 + am52 + am53 + am54 + am55 + am56 + am57 + am58 + am59 + am60 + am61 + test +</screen> +</para> + +<para> +The server has reported that there are 26 available <literal>TcpConnection</literal> +class instances. One <literal>TcpConnection</literal> instance is used for each connected +node to the server. The figure of 26 above is correct. +<itemizedlist> +<listitem> 15 are used for the 15 entries in the list</listitem> +<listitem> 10 are stored away, ready for use in connecting nodes</listitem> +<listitem> 1 is on hand, ready to use immediately with the next incoming +connection.</listitem> +</itemizedlist> +</para> + +<para> +The list contains 15 nodes, which is correct. <literal>Controller</literal> is there, who +is running the <literal>testsound.py</literal> script file. Further, <literal>sound</literal> is there, who is +managing the sound card, and is an endpoint for the test. The supervisor +<literal>am</literal> for the answering machine is there. Also, <literal>test</literal> is there, +which is the identity of the node from the <literal>client.py</literal> &python; script. +<literal>am51</literal> is there, who is the current active answering machine node. +Nodes <literal>am52..am61</literal> are the nodes that the answering machine +supervisor has prebuilt, which are ready for use. +</para> +</chapter> \ No newline at end of file

1 0