README 4.53 KB
Newer Older
llea's avatar
llea committed
1
This is SFLPhone-0.4.1-rc1 release.
savoirfairelinux's avatar
savoirfairelinux committed
2

3

llea's avatar
llea committed
4
You need ccrtp-1.3.0 which needs commoncpp2>=1.3.0
llea's avatar
llea committed
5
libeXosip2-1.9.1-pre15 needs libosip2-2.2.0
jpbl's avatar
jpbl committed
6
You also need PortAudio_v19
llea's avatar
llea committed
7
See http://www.sflphone.org/#downloads to download required libraries.
savoirfairelinux's avatar
savoirfairelinux committed
8

llea's avatar
llea committed
9 10
Dependencies build instructions:
--------------------------------
savoirfairelinux's avatar
savoirfairelinux committed
11

llea's avatar
llea committed
12 13 14 15
1/	For commoncpp2-1.3.6
	./configure [option]
	make
	make install
savoirfairelinux's avatar
savoirfairelinux committed
16

llea's avatar
llea committed
17 18 19 20 21 22 23 24 25 26
2/	For ccrtp-1.3.0
	./configure [option]
	make
	make install

3/	For libosip2-2.2.0
	./configure [option]
	make
	make install

llea's avatar
llea committed
27
4/ 	For libeXosip2-1.9.1-pre15
llea's avatar
llea committed
28 29 30 31
	./configure --disable-josua [option]
	make
	make install

jpbl's avatar
jpbl committed
32 33 34 35 36
5/  For PortAudio_v19
	./configure [option]
	make
	make install
	
llea's avatar
llea committed
37

llea's avatar
llea committed
38 39 40
How to compile SFLphone ?
-------------------------

jpbl's avatar
jpbl committed
41
./configure [option]
savoirfairelinux's avatar
savoirfairelinux committed
42
make
jpbl's avatar
jpbl committed
43
make install (as root) 
savoirfairelinux's avatar
savoirfairelinux committed
44 45 46 47 48
  ( Be sure you have the correct permissions).


How to use it ?
---------------
llea's avatar
llea committed
49 50 51

If you have old version, remove your sflphonerc file located in $HOME/.sflphone

llea's avatar
llea committed
52
1. Lauch it, a setup window appears. 
savoirfairelinux's avatar
savoirfairelinux committed
53 54 55 56 57 58

2. If you do have a SIP account, fill the SIP stuff where related. You can use
   STUN too.

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

llea's avatar
llea committed
59 60 61
A user's guide will be available on:
http://www.sflphone.org/doc/SFLphoneDocEnglish.pdf
http://www.sflphone.org/doc/SFLphoneDocFrancais.pdf
savoirfairelinux's avatar
savoirfairelinux committed
62 63 64 65


Why does it not compile ?
-------------------------
llea's avatar
Cleanup  
llea committed
66

savoirfairelinux's avatar
savoirfairelinux committed
67 68 69 70 71 72 73
	- You don't have the same library versions as we do.
	  See http://www.sflphone.org in section Downloads.

	- You don't have the same compiler (some libraries dislike
	  some compilers). We are using  gcc 3.3.3 on
	  Fedora Core 2 Linux. Someone reported it works on gcc 3.4.

llea's avatar
llea committed
74
	- If error occured while loading shared libraries,
jpbl's avatar
jpbl committed
75
	  you have to export LD_LIBRARY_PATH with your lib directory.
llea's avatar
llea committed
76 77
	  ( example: export LD_LIBRARY_PATH=/opt/lib:${LD_LIBRARY_PATH} )

jpbl's avatar
jpbl committed
78 79 80 81
	- If you don't install dependencies in classic install directories,
	  you have to export CXXFLAGS. 
	  ( example: export CXXFLAGS="-I/opt/include" )

llea's avatar
llea committed
82 83 84

Short description of content of source tree:
-------------------------------------------
llea's avatar
Cleanup  
llea committed
85

llea's avatar
llea committed
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
- skins/ contains the different available skins in separated directories.
- pixmaps/ contains all the pixmaps used in the configuration window.
- rings/ contains the different ringtones.
- stund/ is an implementation of the protocol STUN used when there is a NAT.
- utilspp/ allows to implement a singleton.

- 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. 
  The ManagerImpl class is the intermediaire between all the layer in the tree.

- src/audio/ is the audio layer. It contains all about tones, dtmf, audiodriver,  rtp layer, audio codec ulaw, alaw and gsm.
- src/audio/gsm/ contains the implementation of gsm audiocodec library.
- src/audio/pacpp/ implements PortAudioCpp, a native C++ binding of 
  PortAudio V19.

- src/gui/ is the directory that contains all about different user interface.
  The GuiFramework class is the base class of all user interface objects. It
  receives mouse, keyboard events from GUI child class and calls ManagerImpl 
  functions which correspond. GuiFramework receives also events from ManagerImpl
  and handle them according to the GUI chosen by the user, with virtual 
  functions.
- src/gui/qt is the implementation of QT user interface.


llea's avatar
Cleanup  
llea committed
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
How is structured SFLphone (>=0.4)
----------------------------------

		+------+	+--------+
		|GUI Qt|	|GUI text|	...  
		+------+ 	+--------+
			|			|		
		+---------------------------+	
		|		GUI Framework		|
		+---------------------------+
					|
		+---------------------------+
		|		ManagerImpl			|  
		+---------------------------+
					|
		+---------------------------+
		|		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.


Misc.
-----

savoirfairelinux's avatar
savoirfairelinux committed
144
Of course we love patches. And contribution. See http://www.sflphone.org/ .    
llea's avatar
llea committed
145 146 147 148 149 150
The project infrastructure (CVS, bugtraqer, MLs) is maintained on : 
http://forge.novell.com/modules/xfmod/project/?sflphone

Don't hesitate to post your comments/suggestions/questions on the 
forge.novell mailing-list.

savoirfairelinux's avatar
savoirfairelinux committed
151

152 153
Jean-Philippe Barette-LaPierre 
(jean-philippe.barrette-lapierre@savoirfairelinux.com)
savoirfairelinux's avatar
savoirfairelinux committed
154
Laurielle Lea (laurielle.lea@savoirfairelinux.com)
jpbl's avatar
jpbl committed
155
Jerome Oufella (jerome.oufella@savoirfairelinux.com)
savoirfairelinux's avatar
savoirfairelinux committed
156