README 8.25 KB
Newer Older
1
This is SFLphone, release 0.7pre0cvs.
yanmorin's avatar
yanmorin committed
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

Copyright (c) Savoir-faire Linux, Inc 2004-2006
  <sflphoneteam@savoirfairelinux.com>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY 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
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

20 21


yanmorin's avatar
yanmorin committed
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
Introduction
------------

SFLPhone is a Voice-over-IP software phone. We want it to be:
- portable (it runs under GNU/Linux, Mac OS X, Win32)
- user friendly (fast, sleek, easy to learn interface)
- corporate grade (transfers, holds, perfect audio quality)
- fully compatible with Asterisk (SIP and IAX protocols)
- customizable (support for custom skins in the QT interface)

As the SIP/audio daemon and the user interface are separate processes,
it is easy to provide different user interfaces. SFLPhone comes with
a QT graphical user interface, an interactive command line interface,
and even scripts to control the daemon from the shell.

SFLPhone is actually used by the support team of Savoir-Faire Linux Inc.

More information is available on the project homepage:
  http://www.sflphone.org/


43

yanmorin's avatar
yanmorin committed
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
Getting the dependencies
------------------------

Required libraries and tools:
- ccRTP >= 1.3.4 (tested with ccrtp 1.4.1)
  and Common C++ 2 >= 1.3.20 (tested with commoncpp2 1.4.1)
    http://sourceforge.net/projects/gnutelephony/
- libeXosip2 >= 2.2.2 (tested with eXosip2 2.2.3)
  and libosip2 >= 2.2.1 (tested with libosip2-2.2.2)
    http://savannah.gnu.org/projects/exosip/
    http://savannah.gnu.org/projects/osip/
- libxml2, libxml2-devel, pkgconfig
    usually available in distribution repositories

Optional libraries:
- zeroconf: (tested with mDNSResponder87)
    http://developer.apple.com/darwin/projects/bonjour/
- QT: required for the graphical user interface
    usually available in distribution repositories
63
- speex: codec for sound
yanmorin's avatar
yanmorin committed
64 65 66 67 68

Some of the required libraries may be downloaded from
  http://www.sflphone.org/#downloads
  or
  http://www.sflphone.org/dev/
69

yanmorin's avatar
yanmorin committed
70
See tools/config.sh for details
jpbl's avatar
jpbl committed
71

yanmorin's avatar
yanmorin committed
72

73 74 75 76 77 78 79

Building the dependencies
-------------------------

If you do not use either the development packages of your distribution or the source packages made by the upstream authors of dependencies, you may want to try our custom dependencies building script in tools/ directory:
1. cd tools/
2. edit config.sh to change the default prefix (/usr/local)
yanmorin's avatar
yanmorin committed
80 81
3. ./download.sh
4. ./install.sh
jpbl's avatar
jpbl committed
82
 
83
You can also compile each dependency, one by one:
jpbl's avatar
jpbl committed
84

yanmorin's avatar
yanmorin committed
85
1/	For commoncpp2
jpbl's avatar
jpbl committed
86 87 88 89
	./configure [option]
	make
	make install

yanmorin's avatar
yanmorin committed
90
2/	For ccrtp
jpbl's avatar
jpbl committed
91 92 93 94
	./configure [option]
	make
	make install

yanmorin's avatar
yanmorin committed
95
3/	For libosip2
jpbl's avatar
jpbl committed
96 97 98 99
	./configure [option]
	make
	make install

yanmorin's avatar
yanmorin committed
100

101

yanmorin's avatar
yanmorin committed
102 103 104 105 106 107 108 109 110 111
Preparing a CVS checkout of SFLPhone to be built
------------------------------------------------

Before building from a CVS checkout, the GNU autotools suite must be used
to generate the configure script and Makefiles. The current version
of SFLPhone has been tested with Automake 1.9 and Autoconf 2.59.

To do so, you may run the following script from the top directory:
  ./tools/autotoolize.sh

112 113


yanmorin's avatar
yanmorin committed
114 115
Building SFLPhone
-----------------
jpbl's avatar
jpbl committed
116

117
./configure
jpbl's avatar
jpbl committed
118 119 120 121
make
make install (as root) 


122

yanmorin's avatar
yanmorin committed
123 124
Using SFLPhone
--------------
jpbl's avatar
jpbl committed
125

126 127
If you have the sflphone 0.3 or 0.4 release, copy the file sflphonerc
to sflphonedrc:
yanmorin's avatar
yanmorin committed
128
  cp ~/.sflphone/sflphonerc ~/.sflphone/sflphonedrc
129 130
If you have an older version, remove your sflphonerc file located in
$HOME/.sflphone
jpbl's avatar
jpbl committed
131 132 133 134 135

1. Install a GUI like sflphone-qt

2. Lauch sflphone interface, a setup window appears. 

yanmorin's avatar
yanmorin committed
136 137
3. If you do have a SIP account, fill the SIP stuff where related. You can
   use STUN too.
jpbl's avatar
jpbl committed
138 139 140 141 142 143 144

4. Save your settings, restart it. You're done.

A user's guide will be available on:
http://www.sflphone.org/doc/


145

yanmorin's avatar
yanmorin committed
146
What if it does not build?
147 148
--------------------------

yanmorin's avatar
yanmorin committed
149
- Try using the same versions of the libraries as we do.
jpbl's avatar
jpbl committed
150 151
  See http://www.sflphone.org in section Downloads.

yanmorin's avatar
yanmorin committed
152 153 154 155 156 157
- Try using the same compilers as ours: gcc 4.1.0 on Fedora Linux Core 5
  is known to work.

- If you have dependencies installed in unusual directories, try setting
  the environment variable CXXFLAGS before building, for example:
  export CXXFLAGS="-I/opt/include"
jpbl's avatar
jpbl committed
158 159 160



yanmorin's avatar
yanmorin committed
161
How to enable IAX support?
162
--------------------------
yanmorin's avatar
yanmorin committed
163

164 165 166
Go inside libs directory and execute ./libiax2.sh script.
Run ./configure with --enable-iax2 option.

yanmorin's avatar
yanmorin committed
167 168 169 170 171 172 173 174 175


Run-time troubleshooting
------------------------

- If errors occured when trying to load shared libraries, check that the
  value of the environment variable LD_LIBRARY_PATH include the
  directories containing the required libraries, eg:
  export LD_LIBRARY_PATH=/path/to/my/lib:${LD_LIBRARY_PATH}
176

jpbl's avatar
jpbl committed
177 178 179
- Portaudio don't detect your sound card because :
  * artsd is running
  * jackd is running 
yanmorin's avatar
yanmorin committed
180 181 182 183 184
    On 2005/11/22, jack wasn't working with these settings: 
    jackd -d alsa -r 8000
  * you use alsa with sflphone and another application, but dmixer isn't
    configurated correctly inside ~/.asoundrc or /etc/alsa/alsa.conf

jpbl's avatar
jpbl committed
185 186 187
- sflphone refuse to start because it's running
  You could have something like: "Exception: could not bind socket"
  Try to close sflphone before 
yanmorin's avatar
yanmorin committed
188
    echo "stop sflphone" | nc localhost 3999
jpbl's avatar
jpbl committed
189
  or
yanmorin's avatar
yanmorin committed
190 191 192
    killall sflphone


jpbl's avatar
jpbl committed
193
  
194
Short description of content of source tree
jpbl's avatar
jpbl committed
195 196 197 198 199
-------------------------------------------

- ringtones/ contains the different ringtones.
- stund/ is an implementation of the protocol STUN used when there is a NAT.
- utilspp/ allows to implement a singleton.
200 201 202 203
- src/ is the core of SFLphone. It contains the main.cpp, managerimpl.cpp
  files, audio and gui directories, and files about signalisation SIP. Later,
  it should be better, when IAX will be implemented, that a directory groups
  these protocols. 
jpbl's avatar
jpbl committed
204
  The ManagerImpl class is the intermediaire between all the layer in the tree.
205 206
- src/audio/ is the audio layer. It contains all about tones, dtmf,
  audiodriver, rtp layer, audio codec ulaw, alaw and gsm.
jpbl's avatar
jpbl committed
207 208 209
- src/audio/gsm/ contains the implementation of gsm audiocodec library.
- src/audio/pacpp/ implements PortAudioCpp, a native C++ binding of 
  PortAudio V19.
210 211 212 213 214
- src/gui/ is the old directory that contains all about different user
  interface.
- src/gui/server is the directory that talk (tcp socket on port 3999) to
  sflphone client. The slfphone client can be a console program or a graphical
  interface.
jpbl's avatar
jpbl committed
215 216


yanmorin's avatar
yanmorin committed
217

jpbl's avatar
jpbl committed
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
How is structured SFLphone (>=0.5)
----------------------------------

		+------------+
		|TCPSessionIO|  
		+------------+
		       |
		+------------+
		| SessionIO  |  
		+------------+
		       |
		+------------+
		| GUI Server |  
		+------------+
  		       |		
		+---------------------------+	
		|      GUI Framework        |
		+---------------------------+
		             |
		+---------------------------+
		|        ManagerImpl        |  
		+---------------------------+
		             |
241 242 243 244
       		+---------------------------+
		|          Account          |
		+---------------------------+
                             |
jpbl's avatar
jpbl committed
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
		+---------------------------+
		|         VoIPLink          |
		+---------------------------+
		      |                |
		+-----------+       +-------+
		|    SIP    |       |  IAX  |
		|    RTP    |       +-------+
		|   STUN    |
		+-----------+

It's in ManagerImpl where we declared Call vector and VoIPLink vector.
VoIPLink vector contains all different VoIP link like SIP, IAX, ...
Call vector contains all the calls according to the kind of VoIP link.



yanmorin's avatar
yanmorin committed
261 262
About Savoir-Faire Linux
------------------------
jpbl's avatar
jpbl committed
263

yanmorin's avatar
yanmorin committed
264
Savoir-Faire Linux is a consulting company based in Montreal, Quebec.
265 266
For more information, please check out our website:
http://www.savoirfairelinux.com/
yanmorin's avatar
yanmorin committed
267 268 269 270 271 272 273 274 275 276



Contributing to SFLPhone
------------------------

Of course we love patches. And contributions. And spring rolls.

The project infrastructure (CVS, bugtracker, MLs) is maintained on: 
http://forge.novell.com/modules/xfmod/project/?sflphone
jpbl's avatar
jpbl committed
277

yanmorin's avatar
yanmorin committed
278 279
Do not hesitate to join us and post comments, suggestions, questions
and general feedback on the forge.novell mailing-list.
jpbl's avatar
jpbl committed
280

yanmorin's avatar
yanmorin committed
281
  -- The SFLPhone Team