Added fail safe delay as some camera drivers ignore the frame rate
[pwlib.git] / ReadMe.txt
blob347173baf56de0346e6a04bc5f89845a878e6458
1                         Portable Windows Libary
2                         =======================
5 Contents
6 --------
8         1.      Introduction
9         2.      Apologies
10         3.      CVS Access
11         4.      Building PWLib
12         5.      Using PWLib
13         6.      IPv6 issues
14         7.      Platform Specific Issues
15         8.      Conclusion
16         9.      Licensing
20 ================================================================================
22 1. Introduction
23 ---------------
25 PWLib is a moderately large class library that has its genesis many years ago as
26 a method to product applications to run on both Microsoft Windows and Unix
27 X-Windows systems. It also was to have a Macintosh port as well but this never
28 eventuated. The parts of the library relating to GUI functions have also been 
29 removed.
31 Since then the system has grown to include many classes that assist in writing
32 complete multi-platform applications. Classes for I/O portability, multi-threading
33 portability, aid in producing unix daemons and NT services portably and all
34 sorts of internet protocols were added over the years.
36 All this over and above basic "container" classes such as arrays, linear lists,
37 sorted lists (RB Tree) and dictionaries (hash tables) which were all created
38 before STL was standardized. Future versions of PWLib will see many of these
39 classes replaced or supplemented by STL.
41 The library was used extensively for all our in-house products. Then we decided
42 to support the open H323 project by throwing in some of the code written for
43 one of our products. Thus, required PWLib so it got thrown into the open source
44 world as well.
48 ================================================================================
50 2. Apologies (not)
51 ------------------
53 As you start using the library, the inevitable question "why did they do it that
54 way?" will come up. The more experienced out there will know that there are
55 several reasons for the way things are:
57    *   Carefully considered design,
58    *   Workarounds for portability and compiler subtleties,
59    *   History, it may be too hard to change an early design decision,
60    *   Complete arbitrariness, the absence of any compelling reason.
62 So, when you ask the next question "why didn't you do it this way?" The answer
63 will be one of the above. The last one being a synonym for "we didn't think of
64 that!"
66 The bottom line is, use the library as is or change it as you require. You can
67 even send in suggestions for improvements (or merely changes) and we may (or may
68 not) include them in the base line code. Just do not send us any mail starting
69 with the words "Why did you..." as the answer is quite likely to be "Because!"
73 ================================================================================
75 3. CVS Access
76 -------------
78 There is a public CVS archive available at cvs.sourceforge.net. To avoid
79 everyone getting all of the code platforms, we have provided CVS "modules"
80 that allow the Windows and Unix source trees to be extracted seperately.
82 The available modules are:
84         pwlib                   This ReadMe.txt file only
85         ptlib_unix              Unix libraries only
86         ptlib_win32             Windows libraries only
87         pwlib_win32             Windows libraries + GUI (no longer supported)
88         openh323                OpenH323 only
90 Note that the ptlib_unix, ptlib_win32 and pwlib_win32 modules all extract 
91 subcomponents of the pwlib directory tree using the CVS modules file - they
92 are not different directories.
94 To extract one of these modules, use a command line like the following:
96         cvs -z3 -d :pserver:anonymous@cvs.sourceforge.net:/cvsroot/openh323 co module
98 where "module" is one of the module names specified above.
100 If you would like see the structure of the CVS, then use the View CVS tool at:
102         http://cvs.sourceforge.net/viewcvs.py/openh323/
105 ================================================================================
107 4. Building PWLib
108 -----------------
110 This library is multi-platform, however there are only two major build systems
111 that are used. The Microsoft DevStudio environment for Windows and the GNU make
112 system for all of the various unix systems.
114 SPECIAL NOTE FOR MSVC 6 USERS:
115 ------------------------------
116 If you are using MSVC 6 then please run the "msvc6_upgrade.bat" script in the 
117 PWLIB top directory before continuing. If you skip this step, you will not
118 be able to compile PWLib on MSVC 6. If you change the build environment to bypass 
119 this step, then DLL versions of PWLib will not function correctly. For more 
120 information, please see:
122 http://www.voxgratia.org/docs/pwlib_windows.html#msvc_headers 
125 4.1. For Windows
126 ----------------
128 Note that more complete instructions can be found at the following URL, but here 
129 are the basics:
131         http://www.voxgratia.org/docs/pwlib_windows.html 
133 1.  Note you will need the bison and flex tools to compile some parts of the
134     system. You can get a copy from http://www.openh323.org/bin/flexbison.zip,
135     follow the instructions included in that package and put the executables
136     somewhere in your path.
138 2.  Start MSVC (v5, v6 or v7 (.NET)). If you have another compiler you are on
139     your own! Add these folders to the Include Files path as follows:
140     
141     In VisualStudio v5/6 go into the Tools menu, Options item, Directories tab.
142     
143     In VisualStudio v7, go into the Tools menu, Options item. In the Options
144     dialog, open the Projects folder, VC++ Directories item. In the 'Show
145     Directories for:' list, select 'Include files'.
146         
147                 C:\PWLib\Include
148                 
149     Add the following to the Lib Files path and the Executable Files path:
150         
151                 C:\PWLib\Lib
152                 
153     The Lib folder is created as parts of PWLib are built. Also add this
154     directory to your PATH environment variable (so the MergeSym tool can 
155     be found).
157 2.  The build should automatically create a file pwlib/include/ptbuildopts.h
158     via the configure.exe program that should be in the pwlib directory. If
159     you have any problems try running the program directly from a command
160     line. Use ".\configure --help" to get information on options such as
161     forcing a feature or library dependency.
163     Note there are additional notes in the "Platform Specific Issues" on how
164     to compile the various libraries in a manner suitable for use by PWLib
165     under Windows.
167 3.  In VisualStudio v5/6 open the pwlib.dsw file in the pwlib top directory.
168     If you have the minimum library it will come up with several requests to
169     find .dsp files, just cancel past these.
170         
171     In VisualStudio v7 open the pwlib.sln file in the pwlib top directory.
173 4.  That's it, now you're on your own!
177 These are the project relationships:
179 project             dependencies                             output
180 -------             ------------                             ------
181 Console             (none)                                   ptlibs.lib
182 MergeSym            ptlibs.lib                               mergesym.exe
183 PTLib               ptlibs.lib, mergesym.exe                 ptlib.dll & lib
184 Console Components  (none)                                   ptclib.lib
185 MSDevWizard         (none)                                   PWLibWizard.awx
186 XMLRPC              ptlibs.lib, ptclib.lib                   xmlrpc.exe
187 PacketVXD           (none)                                   epacket.vxd
189 Debug versions append 'd' to filename, ie: ptlibsd.lib.
191 MSDevWizard will not build in VisualStudio v7 and so is not included as a project.
195 --------------------------------------------------------------------------------
196 4.2. For unix.
197 --------------
199 1.      If you have not put pwlib it into your home directory (~/pwlib) then
200         you will have to defined the environment variable PWLIBDIR to point to
201         the correct directory.
202         Also make sure you have added the $PWLIBDIR/lib directory to your 
203         LD_LIBRARY_PATH environment variable if you intend to use shared 
204         libraries (the default).
206 2.      Build the debug and release versions of the PWLib library as follows:
207                 cd ~/pwlib
208                 ./configure
209                 make
210         This may take some time. Note, you will need bison and flex for this to
211         compile, most unix systems have these. WARNING: there is a bug in most 
212         of the bison.simple files. See below for details.
214         PWLib requires GNU Make. If GNU Make (gmake) is not your default make
215         program (eg FreeBSD users), you will need to install GNU Make first
216         and then use
217                 cd ~/pwlib
218                 ./configure
219                 gmake
222         If you are getting huge numbers of errors during the compile, then it 
223         is likely your platform is not supported, or you have incorrectly set 
224         the OSTYPE and MACHTYPE variables.
226 3.      That's all there is to it, you are now on your own!
230 Bison problem under Unix
232 The bison.simple file on many releases will not compile with the options used 
233 by the PWLib getdate.y grammar. The options are required to make the date 
234 parser thread safe so it is necessary to edit the bison.simple file to fix the 
235 problem.
237 The file is usually at /usr/lib/bison.simple but in the tradition of unix 
238 could actually be anywhere. We leave it up to you to find it.
240 The code:
242         /* Prevent warning if -Wstrict-prototypes. */
243         #ifdef __GNUC__
244         int yyparse (void);
245         #endif
247 should be changed to
249         /* Prevent warning if -Wstrict-prototypes. */
250         #ifdef __GNUC__
251         #ifndef YYPARSE_PARAM
252         int yyparse (void);
253         #endif
254         #endif
256 To prevent the incorrect function prototype from being defined. The getdate.y 
257 should then produce a getdate.tab.c file that will actually compile.
262 ================================================================================
264 5. Using PWLib
265 --------------
267 What documentation there is consists of this document and all of the header
268 files. It was intended that a post processer go through the header files and
269 produces HTML help files, but this never got completed.
272 5.1. Tutorial
273 -------------
275 Detailed tutorials will almost certainly not be forthcoming. However, at least
276 giving you an indication on how to start an application would be usefull, so
277 here is the infamous "Hello world!" program.
280 // hello.cxx
282 #include <ptlib.h>
284 class Hello : public PProcess
286   PCLASSINFO(Hello, PProcess)
287   public:
288     void Main();
291 PCREATE_PROCESS(Hello)
293 void Hello::Main()
295   cout << "Hello world!\n";
298 // End of hello.cxx
301 The CREATE_PROCESS macro actually defines the main() function and creates an
302 instance of Hello. This assures that everything is initialised in the correct
303 order. C++ does initialisation of global statics badly (and destruction is even
304 worse), so try to put everything into your PProcess descedent rather than
305 globals.
307 A GUI application is very similar but is descended off PApplication rather than
308 PProcess, and would create a window as a descendent off the PMainWindow class.
310 The following is a simple Makefile for Unix platforms for the hello world 
311 program.
314 # Simple makefile for PTLib
316 PROG    = hello
317 SOURCES = hello.cxx
319 ifndef PWLIBDIR
320 PWLIBDIR=$(HOME)/pwlib
321 endif
323 include $(PWLIBDIR)/make/ptlib.mak
325 # End of Makefile
329 --------------------------------------------------------------------------------
330 5.2. PWlib Classes
331 ------------------
333 The classes in PWLib fall into the following broad categories
335         Containers
336         I/O
337         Threads & Processes
340 5.2.1. Containers
342 While there are a number of container classes you wourld rarely actually descend
343 off them, you would use macros that declare type safe descendents. These are
344 simply templates instantiations when using a compiler that supports templates
345 in a simple manner (GNU C++ does not qualify in our opinion).
347 5.2.2. I/O
349 There are many classes descendend from a basic primitive call a PChannel, which
350 represents an entity for doing I/O. There are classes for files, serial ports,
351 various types of socket and pipes to sub-processes.
353 5.2.3. Threads & Processes
355 These classes support lightweight threading and functionality to do with the
356 process as a whole (for example argument parsing). The threading will be
357 pre-emptive on platforms that support it (Win32, platforms with pthreads eg
358 Linux and FreeBSD) and cooperative on those that don't.
363 ================================================================================
365 6. IPv6 support in pwlib
366 ------------------------
368 The IPv6 support in pwlib is still experimental. You have to get the latest
369 CVS version to compile it (does work since 7th November 2002). Pwlib can be
370 compiled with or without the IPv6 support.
372 When compiled with the IPv6 support, applications using only IPv4 are still 
373 fully backward compatible. Pwlib is able to manage simultaneously IPv4 and
374 IPv6 connections.
378 --------------------------------------------------------------------------------
379 6.1. Windows platforms
380 ----------------------
382 According to microsoft, IPv6 is not supported under 9x, experimental on Win2000, 
383 supported on XP.
384 You must use a compiler with IPv6 aware includes and libraries:
385   - VC6 must be patched to support RFC 2553 structure. (See 7.1 and 7.2 for patch)
386   - .Net should be ok (to be confirmed)
387 The port as been performed with VC6 patched on a win2000 platform.
389 For more informations about IPv6 support:
390   Microsoft IPv6 support: 
391     http://research.microsoft.com/msripv6/
392   IPv6 for win2000: 
393     http://msdn.microsoft.com/downloads/sdks/platform/tpipv6.asp
394   IPv6 for XP: 
395     http://www.microsoft.com/windowsxp/pro/techinfo/administration/ipv6/default.asp
399 6.1.1. Windows platforms: Win2000
400 ---------------------------------
401 Go to Microsoft win2000 IPv6 tech preview web page.
402 http://msdn.microsoft.com/downloads/sdks/platform/tpipv6.asp
403 Download the 'tpipv6-001205.exe' file and read carrefully the faq.
404 http://msdn.microsoft.com/downloads/sdks/platform/tpipv6/faq.asp
406 This program is designed for win2000 English Service pack 1.
407 To install it on newer Service pack, you have to modify some files.
408 Again, read the Faq.
410 This install the IPv6 driver and the IPv6 includes.
414 6.1.2. Windows platforms: XP
415 ----------------------------
416 Read the IPv6 faq for windows XP
417 http://www.microsoft.com/windowsxp/pro/techinfo/administration/ipv6/default.asp
419 The 'ipv6 install' command installs only the IPv6 drivers.
420 You need to install additionnals IPv6 includes for VC6.
421 .NET should be ready. (to be confirmed ....)
425 6.1.3. Compiling
426 ----------------
427 To compile pwlib and openh323 with the IPv6 support you have to set an 
428 environment variable:
429 IPV6FLAG=1
430 Set it using: [Start]/[Configuration pannel]/[System]/[Environment]
432 Add the IPv6 SDK include path in your Visual C++ 6 environment:
433 [Tools]/[Options]/[Directories]/[Include files]
437 --------------------------------------------------------------------------------
438 6.2. Linux platforms
439 --------------------
441 Recent Linux distributions support IPv6.
442 2.4 kernels are IPv6 aware.
444 Linux IPv6 Faq:
445 http://www.tldp.org/HOWTO/Linux+IPv6-HOWTO/
449 6.2.1. Enabling IPv6 support
450 ----------------------------
451 IPv6 can be compiled statically in the kernel or compiled as a module.
452 To load the IPv6 module, as 'root'
453 #modprobe ipv6
457 6.2.2. Compiling
458 --------------
459 Check that IPv6 is really on
460 #ls /proc/net/if_inet6
461 If this file exists, then IPv6 support is compiled in pwlib and openh323.
465 --------------------------------------------------------------------------------
466 6.3. Testing
467 ------------
469 The test application sources can be found in the directory: openh323/samples/simple
470 Once compiled the binaries are in simple/debug, release, obj_linux_x86_d, or
471 obj_linux_x86_r.
472 Under windows, the test application is simple.exe
473 Under linux, the test application is simh323
474 IPv6 support can be tested on only one machine. Just open two shell/command windows.
478 6.3.1. IPv6 Address and port notation
479 -------------------------------------
480 IPv4 address and port are written in dot notation: xx.xx.xx.xx:4000
481 IPv6 global address are written in semi-colon notation: [xx:xx:xx:xx::xx]:4000
482 IPv6 scoped address ad a field for the scope: [xx:xx:xx:xx::xx%scope]:4000
484 Exemples:
485 Global address
486 [3ffe:0b80:0002:f9c1:0000:0000:500b:0ea5]:4000
487 [3ffe:0b80:0002:f9c1::500b:0ea5]:4000
489 Scoped address
490 [fe80::232:56ff:fe95:315%lnc0]:4000
491 Scoped address are not supported yet.
495 6.3.2. Tests configuration
496 --------------------------
497 Tests 1,2,3 run on a single dual stack machine.
498   IPv4 Address: 127.0.0.1, 10.0.0.6
499   IPv6 Address: ::1, 3ffe:0b80:0002:f9c1:0000:0000:500b:0ea5
501 Tests 4,5,6 run on two dual stack machine.
503   IPv4 Address: 10.0.0.6
504   IPv6 Address: ::1, 3ffe:0b80:0002:f9c1:0000:0000:500b:0ea5
506   IPv4 Address: 10.0.0.8
507   IPv6 Address: ::1, 3ffe:0b80:0002:f9c1:0000:0000:500b:0eb6
511 6.3.3. Test 1: IPv4 <--> IPv4 local call
512 ----------------------------------------
513 This test checks the backward compatibility with IPv4
515 In first shell/command window, listen on 127.0.0.1, wait for a call.
516 simple.exe -tttt -n -i 127.0.0.1 -l -a
517 In second shell/command window, listen on 10.0.0.6, call 127.0.0.1
518 simple.exe -tttt -n -i  10.0.0.6 -n 127.0.0.1
522 6.3.4. Test 2: IPv6 <--> IPv6 local call 
523 ----------------------------------------
524 This test checks the IPv6 support
526 In first shell/command window, listen on ::1, wait for a call.
527 simple.exe -tttt -n -i ::1 -l -a
528 In second shell/command window, listen on IPv6 address, call ::1
529 simple.exe -tttt -n -i 3ffe:0b80:0002:f9c1:0000:0000:500b:0ea5 -n [::1]
532 6.3.5. Test 3: IPv4 <--> IPv6 local call
533 ----------------------------------------
534 This test checks that simultaneous IPv4 and IPv6 calls are supported.
536 In first shell/command window, listen on 127.0.0.1, wait for a call.
537 simple.exe -tttt -n -i 127.0.0.1 -l -a
538 In second shell/command window, listen on IPv6 address, call 127.0.0.1
539 simple.exe -tttt -n -i 3ffe:0b80:0002:f9c1:0000:0000:500b:0ea5 -n 127.0.0.1
543 6.3.6. Test 4: IPv4 <--> IPv4 call between two hosts
544 ----------------------------------------------------
545 This test checks the backward compatibility with IPv4
547 First host, listen on 10.0.0.6, wait for a call.
548 simple.exe -tttt -n -i 127.0.0.1 -l -a
549 Second host, listen on 10.0.0.8, call 10.0.0.6
550 simple.exe -tttt -n -i  10.0.0.8 -n 10.0.0.6
554 6.3.7. Test 5: IPv6 <--> IPv6 call between two hosts
555 ----------------------------------------------------
556 This test checks the IPv6 support
558 First host, listen on 3ffe:0b80:0002:f9c1:0000:0000:500b:0ea5, wait for a call.
559 simple.exe -tttt -n -i 3ffe:0b80:0002:f9c1:0000:0000:500b:0ea5 -l -a
560 Second host, listen on 3ffe:0b80:0002:f9c1:0000:0000:500b:0eb6, call 3ffe:0b80:0002:f9c1:0000:0000:500b:0ea5
561 simple.exe -tttt -n -i 3ffe:0b80:0002:f9c1:0000:0000:500b:0eb6 -n [3ffe:0b80:0002:f9c1:0000:0000:500b:0ea5]
565 6.3.8. Test 6: IPv4 <--> IPv6 call between two hosts
566 ----------------------------------------------------
567 This test checks that simultaneous IPv4 and IPv6 calls are supported.
569 First host, listen on 10.0.0.6, wait for a call.
570 simple.exe -tttt -n -i 10.0.0.6 -l -a
571 Second host, listen on 3ffe:0b80:0002:f9c1:0000:0000:500b:0eb6, call 10.0.0.6
572 simple.exe -tttt -n -i 3ffe:0b80:0002:f9c1:0000:0000:500b:0eb6 -n 10.0.0.6
576 --------------------------------------------------------------------------------
577 6.4. Known limitations
578 --------------------
580 You must use IPv6 address with global scope. Tests with IPv6 local link address
581 fail.
585 --------------------------------------------------------------------------------
586 6.5. Questions
587 --------------
589 6.5.1. How to patch my VC6 includes files ?
590 -----------------------------------------
592 To patch you Developper studio Visual C++ version 6, just edit the file
593 "C:\Program Files\Microsoft Visual Studio\VC98\Include\ws2tcpip.h", and add
594 the sin6_scope_id field in the sockadd_in6 structure.
595 struct sockaddr_in6 {
596           short     sin6_family;         /* AF_INET6 */
597           u_short sin6_port;  /* Transport level port number */
598           u_long    sin6_flowinfo; /* IPv6 flow information */
599           struct in_addr6 sin6_addr; /* IPv6 address */
600           u_long    sin6_scope_id; /* scope id (new in RFC2553) */ <--- Add this one
603 This may have an impact on you system stability, use it only on
604 experimental platforms. Using .NET compiler should be a better solution.
608 6.5.2. Why do I need to modify my Visual C++6 include files ? 
609 -----------------------------------------------------------
611 Visual Studio C++ version 6 implements the old RFC 2133 in file "ws2tcpip.h".
612 RFC 2133 defines a 24 byte sockaddr_in6 structure.
613 struct sockaddr_in6 {
614           short     sin6_family;         /* AF_INET6 */
615           u_short sin6_port;  /* Transport level port number */
616           u_long    sin6_flowinfo; /* IPv6 flow information */
617           struct in_addr6 sin6_addr; /* IPv6 address */
621 This RFC as been replaced by RFC 2553.
622 RFC 2133 defines a 28 byte addsock_in6 structure.
623 struct sockaddr_in6 {
624           short     sin6_family;         /* AF_INET6 */
625           u_short sin6_port;  /* Transport level port number */
626           u_long    sin6_flowinfo; /* IPv6 flow information */
627           struct in_addr6 sin6_addr; /* IPv6 address */
628           u_long    sin6_scope_id; /* scope id (new in RFC2553) */
633 6.5.3. How to get an ipv6 address with a Global scope ?
634 -----------------------------------------------------
636 6.5.3.1. Manually
637 -----------------
639 Set one manually if you're not connected to IPv4 Internet or IPv6 backbone:
640 #ip -6 addr add 3ffe:0b80:0002:f9c1:0000:0000:500b:0ea5 dev eth0
641 (this address is owned by freenet6.net).
643 Check the address is set.
644 #ifconfig
645 eth0      Lien encap:Ethernet  HWaddr 00:08:D5:10:C7:BB
646           inet adr:12.0.0.2  Bcast:12.255.255.255  Masque:255.0.0.0
647           adr inet6: 3ffe:b80:2:f9c1::500b:ea5/128 Scope:Global  <- - - Ok, Global scope
648           adr inet6: fe80::208:c7ff:fe59:bbc7/10 Scope:Lien <- - - [ Can't use this one ]
649           UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
650           RX packets:0 errors:0 dropped:0 overruns:0 frame:0
651           TX packets:9 errors:0 dropped:0 overruns:9 carrier:0
652           collisions:0
653           RX bytes:0 (0.0 b)  TX bytes:534 (534.0 b)
656 6.5.3.2. Tunnel broker
657 ----------------------
659 Get one from a free IPv6 tunnel broker.
660 Exemple: 
661 http://www.freenet6.net : Canadian tunnel broker
662 http://tb.ngnet.it      : Italian tunnel broker (Telecom Italia Research)
665 Note: The current (10/2002) freenet6 windows binary is buggy, use it to get the 
666 values, and set manually your tunnel.
670 --------------------------------------------------------------------------------
671 6.6. Troubles
672 ------------
674 6.6.1. Listen on ::1:1720 failed: Address family not supported by protocol
675 -----------------------------------------------------------------------
676 IPv6 module is not loaded in the kernel.
677 #modprobe ipv6
681 6.6.2. SimpleH323       TCP Could not open H.323 listener port on 1720
682 --------------------------------------------------------------
683 Add some traces: -t on the command line. 
687 6.6.3. SimpleH323       TCP Listen on fe80::2b0:d0ff:fedf:d6bf:1720 failed: Invalid argument
688 ------------------------------------------------------------------------------------
689 This address is a local scope address. As the scope_id field is always set to 0,
690 its value is invalid.
692 Use address with global scope.
697 ================================================================================
699 7. Platform Specific Issues
700 ---------------------------
701 PWLib has been ported to several platforms. However on some systems not all of
702 the functionality has been implemented. This could be due to lack of support
703 at the OS level or simply due to lack of time or documentation when developing
704 the port.
707 --------------------------------------------------------------------------------
708 7.1. FreeBSD Issues
709 -------------------
711 Port Maintained by Roger Hardiman <roger@freebsd.org>
712 GetRouteTable() in socket.cxx has been added. It is used by
713 OenH323Proxy, but is not fully tested.
716 --------------------------------------------------------------------------------
717 7.2. OpenBSD Issues
718 -------------------
720 Port Maintained by Roger Hardiman <roger@freebsd.org>
721 GetRouteTable() in socket.cxx has been added. It is used by
722 OenH323Proxy, but is not fully tested.
725 --------------------------------------------------------------------------------
726 7.3. NetBSD Issues
727 ------------------
729 Port Maintained by Roger Hardiman <roger@freebsd.org>
730 GetRouteTable() in socket.cxx has been added. It is used by
731 OenH323Proxy, but is not fully tested.
733 There are now three ways to do pthreads in NetBSD.
734 a) unproven threads - from the packages tree.
735 b) GNU pth threads - from the packages tree.
736 c) Native pthreads - added to the kernel on 15th January 2003.
738 The choice can be made by editing pwlib/make/unix.mak
739 Native threads is the default and the best solution.
741 --------------------------------------------------------------------------------
742 7.4. Mac OS X (Darwin) Issues
743 -----------------------------
745 Port maintained by Roger Hardiman <roger@freebsd.org> but recently
746 Shawn Pai-Hsiang Hsiao <shawn@eecs.harvard.edu> has been leading
747 development.
748 Threads cannot be suspended once they are running, and trying to Suspend
749 a running thread will generate an Assertion Error.
750 Theads can be created in 'suspended' mode and then started with Resume
751 This is due to a lack of pthread_kill() in Dawrin 1.2
752 See http://www.publicsource.apple.com/bugs/X/Libraries/2686231.html
754 GetRouteTable() in socket.cxx has been added. It is used by
755 OenH323Proxy, but is not fully tested.
757 localtime_r() and gm_time() are missing.
758 So in osutil.cxx I have implemented os_localtime() and os_gmtime()
759 with localtime() and gm_time() which may not be thread safe.
761 There is also no implementation for dynamic library functions.
763 Audio is supported using the coreaudio library.
765 Video support is being added by Shawn and users interested in this should
766 check Shawn's web site at http://sourceforge.net/projects/xmeeting/
768 --------------------------------------------------------------------------------
769 7.5. BeOS Issues
770 ----------------
772 Port Maintained by Yuri Kiryanov <openh323@kiryanov.com>. 
773 Current version supported is BeOS 5.0.2. 
775 Most important issue is lack of variable sample frequency from system sound producer node.
776 I made quite a few attempts to implement sound resampler in code, 
777 even with help of Be engineers, but eventually decided to wait until new Media Kit
778 with resampler built-in. 
779 Also network code needed more things, as OOB, which was promised in BONE. 
780 BONE will allow to make less #defines in network code as well.
781 As update will hit the Net, I'll get back to it ASAP.  
783 Look for more port-related info on http://www.dogsbone.com/be
786 --------------------------------------------------------------------------------
787 7.6. Windows CE Issues
788 ----------------------
790 Port Maintained by Yuri Kiryanov <openh323@kiryanov.com>. 
791 Versions supported is 2.x and 3.x (PocketPC). 
792 Look for more port-related info on http://www.pocketbone.com
794 Detailed how-to provided by Frank Naranjo <frank@mivideo.net>.
795 An html version of this readme is available at ;
796 http://www.mivideo.net/videophone
799 7.6.1. HOW-TO build and test Windows CE OpenH323 Port POCKETBONE
800 ----------------------------------------------------------------
801 March 30 2002, Currently, there is NO source available that compiles
802 and Tx/Rx Video and Audio for pocketbone. Only the released binary
803 10b1 in Oct 2001 works! The current CVS version Mar 30 2002, 
804 is supposed to be 10b1, but its' internaly noted as 0.9beta1. 
806 Since the code in the CVS has not changed much since October when 
807 the 10b1 version was released, maybe with the right #ifdef DEFINES
808 and registry keys configured it might work.
810 We will dig into the diffs, and debug this unfinished release. 
811 But, maybe Yuri Kiryanov might release source and its related binary
812 for a version that works one day, along with all the required
813 configuration parameters to build it. 
815 It would be nice to be in a ZIP file, so it is not subject to changes,
816 as in the CVS. 
818 7.6.2. Collecting the Required Files
819 ------------------------------------
820 There are three source modules required to build Pocketbone, 
821 two of them, openh323 and pwlib libraries and the contributed 
822 pocketbone module. Using WinCVS  u can get the latest sources
823 from CVS at openh323.org . Using CVS you should 'checkout' the
824 'pwlib', 'openh323' and 'contrib' modules. You can save some 
825 time and space and 'checkout' only the 'contrib/pocketbone' module.
826 Make certain when u checkout pwlib and openh323 that the .vcp
827 files are there. If not, u can always access them thru the web 
828 interface for CVS at openh323.org. You will also need the eVC 
829 ( embedded Visual C 3.0) software from Microsoft to build it.
831 The new eVC version 4.0 is available FREE for 120 day trial 
832 now ( since Feb 2002 ). You cannot use MS Visual Studio to
833 build an embedded system. The new eVC 4.0 has not been used 
834 to build pocketbone yet from the CVS or herein. 
836 Place all three source modules in a single directory. i.e.., 
837 contrib,openh323 and pwlib.
838 ( note that pocketbone is in the contrib directory ). Using eVC,
839 open the project workspace located in the contrib/pocketbone
840 (Pocketbone.vcp). It should automatically find the other two
841 modules (openh323 and pwlib ) and load their respective .vcp files. 
843 7.6.3. Steps to Build POCKETBONE
844 --------------------------------
845 To build POCKETBONE you first need to build the two libraries,
846 pwlib and openh323. You should build these two libraries using
847 MS Visual C++, they will need to be built with eVC for the embedded
848 solution. Both PWLIB and OPENH323 directories contain a .VCP file 
849 included within the POCKETBONE sources.
851 Before you can build POCKETBONE however, you will need to configure
852 your eVC so it knows where to find the required include, library 
853 and executable files. A  .VCP  project file is available within
854 each of the three source modules in the CVS or ZIP files. 
856 -When you download the zip files or the versions from the CVS,
857 your source directory tree should look like this: 
859 < Your source dir > \ contrib \ Pocketbone
860 < Your source dir > \ pwlib
861 < Your source dir > \ openh323
863 The pockebone.vcw file expects this configuration. Once you start eVC,
864 all you need to do is open the project file; 
865 < Your source dir> \ contrib \ pocketbone \ pocketbone.vcw 
867 eVC will then find the other project files for PWLIB and OPENH323,
868 otherwise it will ask you. Select which CPU or platform version
869 to create; the emulator version X86EMDbg,or the ARM version. 
870 The ARM versions have a DEBUG and RELEASE version.
871 Select the Platform :"Pocket PC", CPUs:" Win32(WCE ARM)" selection.
873 Set of directories which you have to be defined in eVC regardless
874 of target platform:
876 Tools->Options->Directories, option Include files.
877 -------------------------------------------------
878 < Standard include paths > 
879 < Your source dir > \ pwlib \ include \ ptlib \ wince
880 < Your source dir > \ pwlib \ include \ ptlib \ wince \ sys 
881 < Your source dir > \ pwlib \ include \ pwlib \ mswin 
882 < Your source dir > \ pwlib \ include \ ptlib \ msos 
883 < Your source dir > \ pwlib \ include 
884 < Your source dir > \ openh323 \ include 
885 < Your gapi source dir > \ inc
887 Get  Gapi source files at;
888 http://www.microsoft.com/mobile/downloads/developer/gapi.asp
890 Here are some 'fake' functions to avoid needing Platform 
891 Builder or loading SNMP libraries for gatekeeper functionality.
892 ( thanks to Jehan Bing ) http://www.mivideo.net/jh_snmp_c.txt
894 Platform Builder 3.0 was free under an 120 day evaluation, 
895 just as the new 4.0 platform builder ( since Feb 20002) 
896 which also includes the new 4.0 eVC. It is NOT necessary 
897 to build pocketbone with the SNMP libraries provided you
898 include the 'fake' calls in Jehan Bing's functions file
899 provided above. 
901 Tools->Options->Directories, option Executeable AND Library .
902 ------------------------------------------------------------
903 < Your source dir for location of ptlib.dll >    
904 < Your source dir for location of Gapi files ( gx.dll )  > \ lib 
905 < Your source dir >   PWLIB \ Lib (even if does not exist ) 
906 < Your source dir >   OPENH323 \ Lib ( even if doesn't exist ) 
907 < Your source dir for location of snmpapi.lib and snmp_mibii.lib  >
909 ( if you have Platform builder )   
910 click for Zip file for eVC 4.0 Platform Builder Libraries )
912 Using the BUILD ALL start the build process. The PWLIB library
913 is built first, then the OPENH323 library, then finally the 
914 POCKETBONE executable. the EVC will automatically download the 
915 executable to the iPAQ should you have activeSync and the iPAQ
916 in the cradle.eVC will copy the executeable to the start menu.
918 To run select POCKETBONE from the 'start' menu . Enter an IP 
919 using the keyboard, nit the buttons, since the do not always
920 work right. The keypad buttons only works on the 9a1 version.
922 Make any Option settings required such as gatekeeper, trace,
923 or audio settings. Then press 'Call' to initiate the call. 
924 You should hear and see the other party right away. 
925 On some versions full screen video is displayed.
926 There will be a button to toggle from this full screen in 
927 the future, along with Volume and mute buttons. 
928 You are on your own ! Please test and make any comments 
929 here regarding any problems or suggestions. 
931 In order to build POCKETBONE for other platforms, 
932 all you need to do is select the different platforms. 
933 Although, there will undoubtedly be changes required 
934 in the source for different platforms. These changes can 
935 usually be handled with #ifdef statements in the code. 
936 In order to maintain a single set of source files for 
937 different platforms.
939 7.6.4. Latest CVS version March 20 2002
940 ---------------------------------------
941 PWLIB.zip ( 7,424 Kb)  
942 "http://www.mivideo.net/videophone/cvs 4 20 pwlib.zip"
944 OPENH323.zip ( 22,887 Kb) 
945 "http://www.mivideo.net/videophone/cvs 4 20 openh323.zip"
947 CONTRIB.zip ( 5,034 Kb) 
948 "http://www.mivideo.net/videophone/cvs 4 20 contrib.zip"
949   
950 These zip files contain Complete! BUILT files for ARM and X86em
951 versions using eVC 3.0 and fake SNMP functions file (link above),
952 to avoid using SNMP libraries. 
953 For those who asked for it for comparisons !
955 Noted internally as version 0.9beta1, NOT .10b1 as was stated by
956 Yuri in the archives to be in this CVS version. This version has
957 trace options available along with a ( Remote / Local ) 
958 functionality and different bitmap to reflect it.
959 ARM Dbg ( 4,222 Kb)
960 http://www.mivideo.net/videophone/420DPocketBone.exe
962 ARM Rel ( 2,316 Kb )  
963 http://www.mivideo.net/videophone/420RPocketBone.exe
965 Note this version NOT size similar to 9a1 or 10b1 ! 
966 Yet, its the latest from the CVS as of date shown ! 
967 Other than the different BMPs used in 10b1 what else differs ?
969 testing from 4/22/2002  ;
970 - No Video or Audio Tx/Rx to CuSeeme 5.0.0.43 ( RadVision Stack)
971 - soft reset ! required after calls sometimes to get correct IP
972 - Audio OK when called from Cisco ATA 186
973 - The Remote and Local tabs have no effect.
974 -Talk button appears even though running on a Pocket PC
975  and the 'walkie-talkie is NOT clicked.
978 7.6.5. PocketBone 10b1 Binary zip for iPAQ
979 ------------------------------------------
980 http://www.mivideo.net/videophone/PocketBone10b1.zip
981 ( 2,317,824 bytes 10/24/2001).
983 Screen looks like; 
984 http://www.mivideo.net/videophone/PocketBone.jpg
986 Notes : Video receiving from NetMeeting has no green stripes. 
987 Transmits test video by default. Internally noted as 0.10beta1.
988 Audio and Video works fine. No trace options. If Full screen 
989 option is enabled, there is NO way out of it other than 'soft reset'
991 There is NO known source files for this version ! Neither will 
992 there probably ever be. It is the last release from October 2001
993 before the Open Source version took a back seat to the commercial
994 development of iFON at Tabletmedia.com.
995 http://www.tabletmedia.com/ifon.asp
997 Unpack the binary zip file and copy PocketBone.exe to
998 \Windows\Start Menu and gx.dll to \Windows. 
1000 7.6.6. PocketBone .9a1 binary ARMREl
1001 ------------------------------------
1002 ( 2,257 Kb 8/9/2001 )
1003 The main bitmap for this version looks like;
1004 http://www.mivideo.net/videophone7alpha3b.jpg
1005 The working .9a1 binary version from the link below 
1006 was released as version .9a1. 
1007 Internally it is noted as 0.7alpha3. This version transmits
1008 default H261 video color bar screen. It can receive video
1009 and Tx and Rx audio. There are a few problems with this version.
1010 Calling from CuSeeme 5.0 client sending 160x240 video 
1011 this version displays video full screen and locks up the display,
1012 so you cannot do anything else to restore except a 'soft reset'.
1013 'Your mileage may vary'. Should you have better luck, 
1014 please let me know at nubeus@bellsouth.net.
1016 Also, I have not been able to initiate a call with it. 
1017 The display shows the [Remote / Local ] tabs along with
1018 an [FS] switch at the lower right of the display. 
1019 It also has an early address book non-working icon where
1020 you enter the IP along with icons for [Dialpad / Calls]
1021 which are not functioning. The number buttons do work correctly !
1022  The ZIP sources above does NOT build 
1023 the 0.9a1 version although it was supposed to according to Yuri
1024 and the mailing list. The version it creates is noted internally
1025 only in trace file as 0.7a3. It connects, but does not
1026 transmit video and audio. It crashes when called.
1028 Version .9a1 Binary is at 
1029 http://www.mivideo.net/videophone/PocketBone9a1.zip
1030 ( internally noted as 0.7alpha3 !! ) ( 2,250,240 bytes 8/9/2001) 
1032 Source Zip files which should, but does NOT match binary above !
1034 Pocketbone source Zip (1,952 Kb )
1035 http://www.mivideo.net/pocketbone.zip
1036 ARMREl ( 2,257 Kb )      ARMDbg ( 4,177 Kb )
1038 PwLib source Zip ( 1,830 Kb )
1039 http://www.mivideo.net/pwlib.zip
1041 OpenH323 source Zip (1,692 Kb) 
1042 http://www.mivideo.net/openh323.zip
1044 7.6.7. General Usage Notes
1045 --------------------------
1047 - PocketBone performs best on iPAQ Pocket PC 2002.
1048   An iPAQ 3630 with CE 3.0 and the Pocket PC 2002 
1049   update will do fine ! Pocketbone takes up less than 3mb,
1050   and getting smaller every version.
1052 - By default PocketBone connects to NetMeeting using MS-GSM.
1053   If your NetMeeting does not have GSM codec installed, 
1054   get it here. What Microsoft calls GSM 6.10 is not what
1055   everyone understands as GSM 6.10 compression. NetMeeting
1056   must be set to "GSM 6.10" (MS-GSM), iPAQ to MS-GSM. 
1057   Then they connect. 
1059 - If you are running PocketBone and you found an error 
1060   saying "Missing components", get gx.dll (part of GAPI) 
1061   from here and place it to \Windows directory. 
1063 - To enable gateway call, e.g. through Cisco AS5300, 
1064   set following:
1065   Go to Options/Gates, set gateway IP address, set gatekeeper
1066   address, check "Use Gatekeeper", "Require Gatekeeper". 
1067   Switch to Options/General, set name, e.g. "ipaq" in "User"
1068   field. Add your extension, e.g. "3620" and your cisco id,
1069   e.g."3620!cisco" to "Aliases". Check "Disable fast-start"
1070   to avoid fast-start problems when call connected earlier 
1071   for expense of clarity of first few seconds of call. 
1072   You won't be able to receive calls if you are not registered
1073   on gatekeeper .You have to rearrange audio codecs located
1074   at Options/Audio. Move GSM-06.10 and/or G.711 on top of 
1075   the list and disable MS-GSM codec. MS-GSM codec is 
1076   incompatible with non-MS products. 
1078 - If your connection is good enough, try reduce jitter 
1079   buffer size ( Options / Audio ). It will decrease audio latency. 
1081 - Full-duplex sound driver has been released by Compaq for
1082   Pocket PC 2000. Get it here (look for Full Duplex Driver link).
1083   The off-the-shelf iPaq 2000 is half-duplex. Do not forget to 
1084   uncheck Walkie-Talkie in Options/Audio and restart the app. 
1086 - Should you get link error : LINK : fatal error LNK1181: 
1087   cannot open input file "snmpapi.lib" then the library is not
1088   included in "Object/library modules:" at "Project - Settings -
1089   Link" in eVC. 
1091 - Some people reported problems with building code when compiler
1092   reports some SNMP includes missing. You will need to obtain 
1093   Platform Builder, and then add include and lib directory to 
1094   project settings in order to be able to link snmpapi.lib and 
1095   snmp_mibii.lib from the Platform Builder directory. 
1096   (\PUBLIC\COMMON\OAK\LIB\ARM\SA1100\CE\RETAIL). 
1098 - Video won't work out-of-box on x86 emulator. Get GAPI emulator
1099   and try figuring it out.
1101 - Supports full-screen CIF video. Audio clicking removed 
1103 - If you had installed an old version before, please remove 
1104   old registry settings located at: 
1105   HKEY_CURRENT_USER\Software\OpenH323\PocketBone\CurrentVersion
1107 - To enable video receive with QCIF size, make sure registry
1108   has "VideoSize"=1 and "H261_QCIF"=1. 
1110 - If you have problems on connection, go to registry and disable
1111   video receiving.Find following key in registry:
1112   HKEY_CURRENT_USER\Software\OpenH323\PocketBone\CurrentVersion\Options
1113   Then add DWORD value of 0 with name of "VideoSize". 
1115 - In order to improve UDP performance ( videoconferencing ) 
1116   you have to change registry setting on iPAQ value to 16(maximum)
1117   HKEY_LOCAL_MACHINE\Comm\Afd
1118 On NetMeeting go to Video settings,
1119   choose "Better Image". 
1121 - If you get following when trying to run PocketBone:
1122   "Cannot find PocketBone or one of it's components. Make sure
1123   the path and file name are correct and all the required 
1124   libraries are available...", install GAPI (Game API) gx.h and gx.dll. 
1126 - When in Walkie-Talkie mode, re-assign a recorder button on
1127   your iPAQ to PocketBone. It will allow you to use this 
1128   recorder button as a switch to change PocketBone from "listen"
1129   mode to "talk" mode and back. Only required when iPAQ is used
1130   in half-duplex. Version .9a1 and .10b1 work fine in full 
1131   duplex on a PPC. rfer to;
1132   http://www.mivideo.net/Buttons.jpg
1134 7.6.8. Testing
1135 --------------
1136 Ohphone can be used to test Pocketbone as well as Netmeeting.
1137 Although Netmeeting does not hold up to the H323 standard well.
1138 and has been forsaken for the new Instant Messenger from Microsoft.
1139 CuSeeme 5.0 on the other hand is built with the RadVision H323 stack,
1140 a better implementation of the H323 standard. Pocketbone adheres
1141 thru the work of many contributors of the openh323.org project
1142 to the H323 v4 standard. It does not have patented codecs 
1143 integrated due to licensing restrictions but there are hooks
1144 in it should the codec be recognized in the system. Please refer
1145 to the openh323.org site for details.
1147 Cisco ATA 186 IP phones,
1148 either in H323 or when set to IP phones work quite well . 
1149 Testing has been done on HP Jornada and Casio PDAs. 
1150 Results will soon follow along with configurations, notes and source Zip files.
1152 7.6.9. Links 
1153 ------------
1154 Keep in touch with the PDA global activities thru http://www.infosync.no/
1156 7.6.10. Futures
1157 --------------
1158 Porting to other platforms such as Palm, and other CPUs such as MIPS, SH3,
1159 SH4 are not too difficult.
1161 HOW-TO step-by-step will be provided as new platforms are ported and tested.
1162 If you have ported this to another platform, your configuration info would
1163 be appreciated.
1165 Please forward comments of this how-to page to nubeus@bellsouth.net
1166 an html version of this readme is available at ;
1167 http://www.mivideo.net/videophone
1170 --------------------------------------------------------------------------------
1171 7.7. Solaris Issues
1172 -------------------
1173 On Solaris 8, you need to install GNU Ld (the loader) to get
1174 shared libraries to compile. (otherwise there is an error with -soname)
1175 You can get around this by using the static libraries and
1176 compiling with make optnoshared and make debugnoshared
1178 There is currently no implementation of GetRouteTable() in socket.cxx
1179 so OpenH323Proxy will not work.
1182 --------------------------------------------------------------------------------
1183 7.8. Build libraries under Windows
1184 ----------------------------------
1186 Unfortunately building libraries that were intended for Unix based systems
1187 under Windows can sometimes be difficult. Here are some notes on the subsystems
1188 that PWLib uses.
1190 7.8.1. OpenSSL under Windows
1191 ----------------------------
1192 The standard build for OpenSSL off http://www.openssl.org does work though it
1193 is rather tricky and requires things like Perl to be installed on your
1194 Windows box. However the build does work and is correct for PWlib use. Make
1195 sure you build the non-DLL Debug and Release versions.
1197 7.8.2. EXPAT under Windows
1198 ---------------------------
1199 The easiest way is to get the one in the OpenH323 CVS. This is guranteed to
1200 work. Use the following command to do this:
1202   cvs -d :pserver:anonymous@cvs.sourceforge.net:/cvsroot/openh323 co external/expat
1204 and then use the expat.dsw file to build the Debug and Release libraries.
1206 7.8.3. OpenLDAP under Windows
1207 ---------------------------
1208 To use OpenLDAP with PWLib you have to compile the OpenLDAP library as a DLL.
1209 Unfortunately, the standard distribution does not do this. So there is a file in
1210 PWLib called pwlib/tools/openldap-2.1.12-win32.zip which contains altered build
1211 files for that version of OpenLDAP. Note if you have a different version these
1212 files may not work.
1214 To build the DLL:
1216    1   Get OpenLDAP v 2.1.17 via tar file at
1217          ftp://ftp.openldap.org/pub/OpenLDAP/openldap-release/openldap-2.1.17.tgz
1218        or anonymous CVS using tag at
1219          :pserver:anonymous@cvs.OpenLDAP.org:/repo/OpenLDAP
1220        using tag OPENLDAP_REL_ENG_2_1_17
1221    2   Unpack it somewhere, eg c:\work\openldap
1222    3   Unzip the openldap-2.1.17-win32.zip file that directory
1223    4   Open openldap/build/main.dsw
1224    5   use Batch build to and select the "dll" project and build the "DLL Debug"
1225        and "DLL Release" targets.
1226    6   Put the resulting openldap/DLLRelease/openldap.dll and
1227        openldap/DLLDebug/openldapd.dll files in your path.
1229 7.8.4 SDL under Windows
1230 -----------------------
1231 Version 1.2.5 has support for Windows and MSVC so you just need to download it
1232 from http://www.libsdl.org/ and follow the build instructions.
1234 7.8.5 SASL under Windows
1235 ------------------------
1236 The standard distribution of Cyrus SASL comes with makefiles for Windows and
1237 clear instructions on how to build the library. The current implementation
1238 in PWLib was tested with Cyrus SASL version 2.1.18. Tarballs can be downloaded
1239 from:
1241     http://asg.web.cmu.edu/sasl/sasl-library.html
1244 --------------------------------------------------------------------------------
1245 7.9. ESD (Esound)
1246 -----------------
1248 Most targets come with native sound support.
1249 However there is also support for the ESD (esound) daemon which provides
1250 full duplex audio via network sockets.
1251 To compile pwlib to use ESD, you need to set the ESDDIR environment variable
1252 to point to the directory you have installed ESD into.
1253 Then compile pwlib.
1256 ================================================================================
1258 8. Conclusion
1259 -------------
1261 This package is far from a "product". There is very limited documentation and
1262 support will be on an ad-hoc basis, send us an e-mail and we will probably
1263 answer your question if it isn't too difficult.
1265 It is supplied mainly to support the open H323 project, but that shouldn't stop
1266 you from using it in whatever project you have in mind if you so desire. We like
1267 it and use it all the time, and we don't want to get into any religious wars of
1268 this class library over that one.
1273 ================================================================================
1275 9. Licensing                 
1276 ------------
1278 The bulk of this library is licensed under the MPL (Mozilla Public License)
1279 version 1.0. In simple terms this license allows you to use the library for 
1280 any purpose, commercial or otherwise, provided the library is kept in tact
1281 as a separate entity and any changes made to the library are made publicly
1282 available under the same (MPL) license. It is important to realise that that 
1283 refers to changes to the library and not your application that is merely 
1284 linked to the library.
1286 Note that due to a restriction in the GPL, any application you write that 
1287 uses anything another than GPL, eg our library with MPL, is technically in
1288 breach of the GPL license. However, it should be noted that MPL does not
1289 care about the license of the final application, and as only the author of
1290 the GPL application is in breach of his own license and is unlikely to sue
1291 themselves for that breach, in practice there is no problem with a GPL 
1292 application using an MPL or any other commercial library.
1295 The random number generator is based on code originally by Bob Jenkins.
1298 Portions of this library are from the REGEX library and is under the
1299 following license:
1301 Copyright 1992, 1993, 1994, 1997 Henry Spencer.  All rights reserved.
1302 This software is not subject to any license of the American Telephone
1303 and Telegraph Company or of the Regents of the University of California.
1305 Permission is granted to anyone to use this software for any purpose on
1306 any computer system, and to alter it and redistribute it, subject
1307 to the following restrictions:
1309 1. The author is not responsible for the consequences of use of this
1310    software, no matter how awful, even if they arise from flaws in it.
1312 2. The origin of this software must not be misrepresented, either by
1313    explicit claim or by omission.  Since few users ever read sources,
1314    credits must appear in the documentation.
1316 3. Altered versions must be plainly marked as such, and must not be
1317    misrepresented as being the original software.  Since few users
1318    ever read sources, credits must appear in the documentation.
1320 4. This notice may not be removed or altered.
1323 The in-band DTMF decoding code was taken from FreeBSD's dtmfdecode.c
1324 application written by Poul-Henning Kamp. It has the following
1325 license:
1326  * ----------------------------------------------------------------------------
1327  * "THE BEER-WARE LICENSE" (Revision 42):
1328  * <phk@FreeBSD.org> wrote this file.  As long as you retain this notice you
1329  * can do whatever you want with this stuff. If we meet some day, and you think
1330  * this stuff is worth it, you can buy me a beer in return.   Poul-Henning Kamp
1331  * ----------------------------------------------------------------------------
1335 ================================================================================
1336 Equivalence Pty. Ltd.
1337 Home of OpenH323 and the Open Phone Abstraction Library (OPAL)
1339 support@equival.com.au
1340 http://www.equival.com.au (US Mirror - http://www.equival.com)
1342 ================================================================================